doc/README.android-fastboot

   1 Android Fastboot
   2 ~~~~~~~~~~~~~~~~
   3
   4 Overview
   5 ========
   6 The protocol that is used over USB is described in
   7 README.android-fastboot-protocol in same directory.
   8
   9 The current implementation is a minimal support of the erase command,the
  10 "oem format" command and flash command;it only supports eMMC devices.
  11
  12 Client installation
  13 ===================
  14 The counterpart to this gadget is the fastboot client which can
  15 be found in Android's platform/system/core repository in the fastboot
  16 folder. It runs on Windows, Linux and even OSX. Linux user are lucky since
  17 they only need libusb.
  18 Windows users need to bring some time until they have Android SDK (currently
  19 http://dl.google.com/android/installer_r12-windows.exe) installed. You
  20 need to install ADB package which contains the required glue libraries for
  21 accessing USB. Also you need "Google USB driver package" and "SDK platform
  22 tools". Once installed the usb driver is placed in your SDK folder under
  23 extras\google\usb_driver. The android_winusb.inf needs a line like
  24
  25    %SingleBootLoaderInterface% = USB_Install, USB\VID_0451&PID_D022
  26
  27 either in the [Google.NTx86] section for 32bit Windows or [Google.NTamd64]
  28 for 64bit Windows. VID and PID should match whatever the fastboot is
  29 advertising.
  30
  31 Board specific
  32 ==============
  33 The fastboot gadget relies on the USB download gadget, so the following
  34 options must be configured:
  35
  36 CONFIG_USB_GADGET_DOWNLOAD
  37 CONFIG_G_DNL_VENDOR_NUM
  38 CONFIG_G_DNL_PRODUCT_NUM
  39 CONFIG_G_DNL_MANUFACTURER
  40
  41 NOTE: The CONFIG_G_DNL_VENDOR_NUM must be one of the numbers supported by
  42 the fastboot client. The list of vendor IDs supported can be found in the
  43 fastboot client source code (fastboot.c) mentioned above.
  44
  45 The fastboot function is enabled by defining CONFIG_USB_FUNCTION_FASTBOOT,
  46 CONFIG_CMD_FASTBOOT and CONFIG_ANDROID_BOOT_IMAGE.
  47
  48 The fastboot protocol requires a large memory buffer for downloads. This
  49 buffer should be as large as possible for a platform. The location of the
  50 buffer and size are set with CONFIG_FASTBOOT_BUF_ADDR and
  51 CONFIG_FASTBOOT_BUF_SIZE.
  52
  53 Fastboot partition aliases can also be defined for devices where GPT
  54 limitations prevent user-friendly partition names such as "boot", "system"
  55 and "cache".  Or, where the actual partition name doesn't match a standard
  56 partition name used commonly with fastboot.  Current implentation checks
  57 aliases when accessing partitions by name (flash_write and erase functions).
  58 To define a partition alias add an environment variable similar to:
  59 fastboot_partition_alias_<alias partition name>=<actual partition name>
  60 Example: fastboot_partition_alias_boot=LNX
  61
  62 In Action
  63 =========
  64 Enter into fastboot by executing the fastboot command in u-boot and you
  65 should see:
  66 |GADGET DRIVER: usb_dnl_fastboot
  67
  68 On the client side you can fetch the bootloader version for instance:
  69 |>fastboot getvar bootloader-version
  70 |bootloader-version: U-Boot 2014.04-00005-gd24cabc
  71 |finished. total time: 0.000s
  72
  73 or initiate a reboot:
  74 |>fastboot reboot
  75
  76 and once the client comes back, the board should reset.
  77
  78 You can also specify a kernel image to boot. You have to either specify
  79 the an image in Android format _or_ pass a binary kernel and let the
  80 fastboot client wrap the Android suite around it. On OMAP for instance you
  81 take zImage kernel and pass it to the fastboot client:
  82
  83 |>fastboot -b 0x80000000 -c "console=ttyO2 earlyprintk root=/dev/ram0
  84 |       mem=128M" boot zImage
  85 |creating boot image...
  86 |creating boot image - 1847296 bytes
  87 |downloading 'boot.img'...
  88 |OKAY [  2.766s]
  89 |booting...
  90 |OKAY [ -0.000s]
  91 |finished. total time: 2.766s
  92
  93 and on the gadget side you should see:
  94 |Starting download of 1847296 bytes
  95 |........................................................
  96 |downloading of 1847296 bytes finished
  97 |Booting kernel..
  98 |## Booting Android Image at 0x81000000 ...
  99 |Kernel load addr 0x80008000 size 1801 KiB
 100 |Kernel command line: console=ttyO2 earlyprintk root=/dev/ram0 mem=128M
 101 |   Loading Kernel Image ... OK
 102 |OK
 103 |
 104 |Starting kernel ...