blob: 2c3ee7810a4fc8940e93e87e972f13fbac1a2423 [file] [log] [blame]
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001Android Fastboot
2~~~~~~~~~~~~~~~~
3
4Overview
5========
6The protocol that is used over USB is described in
7README.android-fastboot-protocol in same directory.
8
Dileep Katta89792382015-02-17 18:48:23 +05309The current implementation is a minimal support of the erase command,the
10"oem format" command and flash command;it only supports eMMC devices.
Sebastian Siewior3aab70a2014-05-05 15:08:10 -050011
12Client installation
13===================
14The counterpart to this gadget is the fastboot client which can
15be found in Android's platform/system/core repository in the fastboot
16folder. It runs on Windows, Linux and even OSX. Linux user are lucky since
17they only need libusb.
18Windows users need to bring some time until they have Android SDK (currently
19http://dl.google.com/android/installer_r12-windows.exe) installed. You
20need to install ADB package which contains the required glue libraries for
21accessing USB. Also you need "Google USB driver package" and "SDK platform
22tools". Once installed the usb driver is placed in your SDK folder under
23extras\google\usb_driver. The android_winusb.inf needs a line like
24
25 %SingleBootLoaderInterface% = USB_Install, USB\VID_0451&PID_D022
26
27either in the [Google.NTx86] section for 32bit Windows or [Google.NTamd64]
28for 64bit Windows. VID and PID should match whatever the fastboot is
29advertising.
30
31Board specific
32==============
33The fastboot gadget relies on the USB download gadget, so the following
34options must be configured:
35
Paul Kocialkowski01acd6a2015-06-12 19:56:58 +020036CONFIG_USB_GADGET_DOWNLOAD
Maxime Riparda95aee62017-09-07 08:58:08 +020037CONFIG_USB_GADGET_VENDOR_NUM
38CONFIG_USB_GADGET_PRODUCT_NUM
39CONFIG_USB_GADGET_MANUFACTURER
Sebastian Siewior3aab70a2014-05-05 15:08:10 -050040
Maxime Riparda95aee62017-09-07 08:58:08 +020041NOTE: The CONFIG_USB_GADGET_VENDOR_NUM must be one of the numbers supported by
Barnes, Clifton A183cbff2014-07-22 11:23:56 -040042the fastboot client. The list of vendor IDs supported can be found in the
43fastboot client source code (fastboot.c) mentioned above.
44
Paul Kocialkowski17da3c02015-06-12 19:56:59 +020045The fastboot function is enabled by defining CONFIG_USB_FUNCTION_FASTBOOT,
46CONFIG_CMD_FASTBOOT and CONFIG_ANDROID_BOOT_IMAGE.
Sebastian Siewior3aab70a2014-05-05 15:08:10 -050047
48The fastboot protocol requires a large memory buffer for downloads. This
49buffer should be as large as possible for a platform. The location of the
Paul Kocialkowskia588d992015-07-20 12:38:22 +020050buffer and size are set with CONFIG_FASTBOOT_BUF_ADDR and
51CONFIG_FASTBOOT_BUF_SIZE.
Sebastian Siewior3aab70a2014-05-05 15:08:10 -050052
Michael Scott8a418022015-03-11 10:02:31 -070053Fastboot partition aliases can also be defined for devices where GPT
54limitations prevent user-friendly partition names such as "boot", "system"
55and "cache". Or, where the actual partition name doesn't match a standard
56partition name used commonly with fastboot. Current implentation checks
57aliases when accessing partitions by name (flash_write and erase functions).
58To define a partition alias add an environment variable similar to:
59fastboot_partition_alias_<alias partition name>=<actual partition name>
60Example: fastboot_partition_alias_boot=LNX
61
Petr Kulhavyb6dd69a2016-09-09 10:27:16 +020062Partition Names
63===============
64The Fastboot implementation in U-boot allows to write images into disk
65partitions (currently on eMMC). Target partitions are referred on the host
66computer by their names.
67
68For GPT/EFI the respective partition name is used.
69
70For MBR the partitions are referred by generic names according to the
71following schema:
72
73 <device type> <device index letter> <partition index>
74
75Example: hda3, sdb1, usbda1
76
77The device type is as follows:
78
79 * IDE, ATAPI and SATA disks: hd
80 * SCSI disks: sd
81 * USB media: usbd
Petr Kulhavyda2ee242016-09-09 10:27:17 +020082 * MMC and SD cards: mmcsd
Petr Kulhavyb6dd69a2016-09-09 10:27:16 +020083 * Disk on chip: docd
84 * other: xx
85
86The device index starts from 'a' and refers to the interface (e.g. USB
87controller, SD/MMC controller) or disk index. The partition index starts
88from 1 and describes the partition number on the particular device.
89
90Writing Partition Table
91=======================
92Fastboot also allows to write the partition table to the media. This can be
93done by writing the respective partition table image to a special target
94"gpt" or "mbr". These names can be customized by defining the following
95configuration options:
96
97CONFIG_FASTBOOT_GPT_NAME
98CONFIG_FASTBOOT_MBR_NAME
99
Sebastian Siewior3aab70a2014-05-05 15:08:10 -0500100In Action
101=========
102Enter into fastboot by executing the fastboot command in u-boot and you
103should see:
104|GADGET DRIVER: usb_dnl_fastboot
105
106On the client side you can fetch the bootloader version for instance:
107|>fastboot getvar bootloader-version
108|bootloader-version: U-Boot 2014.04-00005-gd24cabc
109|finished. total time: 0.000s
110
111or initiate a reboot:
112|>fastboot reboot
113
114and once the client comes back, the board should reset.
115
116You can also specify a kernel image to boot. You have to either specify
117the an image in Android format _or_ pass a binary kernel and let the
118fastboot client wrap the Android suite around it. On OMAP for instance you
119take zImage kernel and pass it to the fastboot client:
120
121|>fastboot -b 0x80000000 -c "console=ttyO2 earlyprintk root=/dev/ram0
122| mem=128M" boot zImage
123|creating boot image...
124|creating boot image - 1847296 bytes
125|downloading 'boot.img'...
126|OKAY [ 2.766s]
127|booting...
128|OKAY [ -0.000s]
129|finished. total time: 2.766s
130
131and on the gadget side you should see:
132|Starting download of 1847296 bytes
133|........................................................
134|downloading of 1847296 bytes finished
135|Booting kernel..
136|## Booting Android Image at 0x81000000 ...
137|Kernel load addr 0x80008000 size 1801 KiB
138|Kernel command line: console=ttyO2 earlyprintk root=/dev/ram0 mem=128M
139| Loading Kernel Image ... OK
140|OK
141|
142|Starting kernel ...