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_USBDOWNLOAD_GADGET
  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_CMD_FASTBOOT and
  46 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_USB_FASTBOOT_BUF_ADDR and
  51 CONFIG_USB_FASTBOOT_BUF_SIZE.
  52
  53 In Action
  54 =========
  55 Enter into fastboot by executing the fastboot command in u-boot and you
  56 should see:
  57 |GADGET DRIVER: usb_dnl_fastboot
  58
  59 On the client side you can fetch the bootloader version for instance:
  60 |>fastboot getvar bootloader-version
  61 |bootloader-version: U-Boot 2014.04-00005-gd24cabc
  62 |finished. total time: 0.000s
  63
  64 or initiate a reboot:
  65 |>fastboot reboot
  66
  67 and once the client comes back, the board should reset.
  68
  69 You can also specify a kernel image to boot. You have to either specify
  70 the an image in Android format _or_ pass a binary kernel and let the
  71 fastboot client wrap the Android suite around it. On OMAP for instance you
  72 take zImage kernel and pass it to the fastboot client:
  73
  74 |>fastboot -b 0x80000000 -c "console=ttyO2 earlyprintk root=/dev/ram0
  75 |       mem=128M" boot zImage
  76 |creating boot image...
  77 |creating boot image - 1847296 bytes
  78 |downloading 'boot.img'...
  79 |OKAY [  2.766s]
  80 |booting...
  81 |OKAY [ -0.000s]
  82 |finished. total time: 2.766s
  83
  84 and on the gadget side you should see:
  85 |Starting download of 1847296 bytes
  86 |........................................................
  87 |downloading of 1847296 bytes finished
  88 |Booting kernel..
  89 |## Booting Android Image at 0x81000000 ...
  90 |Kernel load addr 0x80008000 size 1801 KiB
  91 |Kernel command line: console=ttyO2 earlyprintk root=/dev/ram0 mem=128M
  92 |   Loading Kernel Image ... OK
  93 |OK
  94 |
  95 |Starting kernel ...