doc/README.dfu

   1 # SPDX-License-Identifier: GPL-2.0+
   2
   3 Device Firmware Upgrade (DFU)
   4
   5 Overview:
   6
   7   The Device Firmware Upgrade (DFU) allows to download and upload firmware
   8   to/from U-Boot connected over USB.
   9
  10   U-boot follows the Universal Serial Bus Device Class Specification for
  11   Device Firmware Upgrade Version 1.1 the USB forum (DFU v1.1 in www.usb.org).
  12
  13   U-Boot implements this DFU capability (CONFIG_DFU) with the command dfu
  14   (cmd/dfu.c / CONFIG_CMD_DFU) based on:
  15   - the DFU stack (common/dfu.c and common/spl/spl_dfu.c), based on the
  16     USB DFU download gadget (drivers/usb/gadget/f_dfu.c)
  17   - The access to mediums is done in DFU backends (driver/dfu)
  18
  19   Today the supported DFU backends are:
  20   - MMC (RAW or FAT / EXT2 / EXT3 / EXT4 file system)
  21   - NAND
  22   - RAM
  23   - SF (serial flash)
  24   - MTD (all MTD device: NAND, SPI-NOR, SPI-NAND,...)
  25   - virtual
  26
  27   These DFU backends are also used by
  28   - the dfutftp (see README.dfutftp)
  29   - the thordown command (cmd/thordown.c and gadget/f_thor.c)
  30
  31   The "virtual" backend is a generic DFU backend to support a board specific
  32   target (for example OTP), only based on the weak functions:
  33   - dfu_write_medium_virt
  34   - dfu_get_medium_size_virt
  35   - dfu_read_medium_virt
  36
  37 Configuration Options:
  38   CONFIG_DFU
  39   CONFIG_DFU_OVER_USB
  40   CONFIG_DFU_MMC
  41   CONFIG_DFU_MTD
  42   CONFIG_DFU_NAND
  43   CONFIG_DFU_RAM
  44   CONFIG_DFU_SF
  45   CONFIG_DFU_SF_PART
  46   CONFIG_DFU_VIRTUAL
  47   CONFIG_CMD_DFU
  48
  49 Environment variables:
  50   the dfu command use 3 environments variables:
  51   "dfu_alt_info" : the DFU setting for the USB download gadget with a comma
  52                    separated string of information on each alternate:
  53                    dfu_alt_info="<alt1>;<alt2>;....;<altN>"
  54
  55                    when only several device are used, the format is:
  56                    - <interface> <dev>'='alternate list (';' separated)
  57                    - each interface is separated by '&'
  58                 dfu_alt_info=\
  59                    "<interface1> <dev1>=<alt1>;....;<altN>&"\
  60                    "<interface2> <dev2>=<altN+1>;....;<altM>&"\
  61                    ...\
  62                    "<interfaceI> <devI>=<altY+1>;....;<altZ>&"
  63
  64   "dfu_bufsiz" : size of the DFU buffer, when absent, use
  65                  CONFIG_SYS_DFU_DATA_BUF_SIZE (8MiB by default)
  66
  67   "dfu_hash_algo" : name of the hash algorithm to use
  68
  69 Commands:
  70   dfu <USB_controller> [<interface> <dev>] list
  71     list the alternate device defined in "dfu_alt_info"
  72
  73   dfu <USB_controller> [<interface> <dev>]
  74     start the dfu stack on the USB instance with the selected medium
  75     backend and use the "dfu_alt_info" variable to configure the
  76     alternate setting and link each one with the medium
  77     The dfu command continue until receive a ^C in console or
  78     a DFU detach transaction from HOST.
  79
  80   The possible values of <interface> are :
  81   (with <USB controller> = 0 in the dfu command example)
  82
  83   "mmc" (for eMMC and SD card)
  84     cmd: dfu 0 mmc <dev>
  85     each element in "dfu_alt_info" =
  86       <name> raw <offset> <size>   raw access to mmc device
  87       <name> part <dev> <part_id>  raw acces to partition
  88       <name> fat <dev> <part_id>   file in FAT partition
  89       <name> ext4 <dev> <part_id>  file in EXT4 partition
  90
  91       with <partid> is the GPT or DOS partition index
  92
  93   "nand" (raw slc nand device)
  94     cmd: dfu 0 nand <dev>
  95     each element in "dfu_alt_info" =
  96       <name> raw <offset> <size>   raw access to mmc device
  97       <name> part <dev> <part_id>  raw acces to partition
  98       <name> partubi <dev> <part_id>  raw acces to ubi partition
  99
 100       with <partid> is the MTD partition index
 101
 102   "ram"
 103     cmd: dfu 0 ram <dev>
 104     (<dev> is not used for RAM target)
 105     each element in "dfu_alt_info" =
 106       <name> ram <offset> <size>  raw access to ram
 107
 108   "sf" (serial flash : NOR)
 109     cmd: dfu 0 sf <dev>
 110     each element in "dfu_alt_info" =
 111       <name> ram <offset> <size>  raw access to sf device
 112       <name> part <dev> <part_id>  raw acces to partition
 113       <name> partubi <dev> <part_id>  raw acces to ubi partition
 114
 115       with <partid> is the MTD partition index
 116
 117   "mtd" (all MTD device: NAND, SPI-NOR, SPI-NAND,...)
 118     cmd: dfu 0 mtd <dev>
 119       with <dev> the mtd identifier as defined in mtd command
 120       (nand0, nor0, spi-nand0,...)
 121     each element in "dfu_alt_info" =
 122       <name> raw <offset> <size>  raw access to mtd device
 123       <name> part <dev> <part_id>  raw acces to partition
 124       <name> partubi <dev> <part_id>  raw acces to ubi partition
 125
 126       with <partid> is the MTD partition index
 127
 128   "virt"
 129     cmd: dfu 0 virt <dev>
 130     each element in "dfu_alt_info" =
 131       <name>
 132
 133   <interface> and <dev> are absent:
 134     the dfu command to use multiple devices
 135     cmd: dfu 0 list
 136     cmd: dfu 0
 137    "dfu_alt_info" variable provides the list of <interface> <dev> with
 138    alternate list separated by '&' with the same format for each <alt>
 139        mmc <dev>=<alt1>;....;<altN>
 140        nand <dev>=<alt1>;....;<altN>
 141        ram <dev>=<alt1>;....;<altN>
 142        sf <dev>=<alt1>;....;<altN>
 143        mtd <dev>=<alt1>;....;<altN>
 144        virt <dev>=<alt1>;....;<altN>
 145
 146 Callbacks:
 147   The weak callback functions can be implemented to manage specific behavior
 148   - dfu_initiated_callback  : called when the DFU transaction is started,
 149                               used to initiase the device
 150   - dfu_flush_callback      : called at the end of the DFU write after DFU
 151                               manifestation, used to manage the device when
 152                               DFU transaction is closed
 153
 154 Host tools:
 155   When U-Boot runs the dfu stack, the DFU host tools can be used
 156   to send/receive firmwares on each configurated alternate.
 157
 158   For example dfu-util is a host side implementation of the DFU 1.1
 159   specifications(http://dfu-util.sourceforge.net/) which works with U-Boot.
 160
 161 Usage:
 162   Example 1: firmware located in eMMC or SD card, with:
 163   - alternate 1 (alt=1) for SPL partition (GPT partition 1)
 164   - alternate 2 (alt=2) for U-Boot partition (GPT partition 2)
 165
 166   The U-Boot configuration is:
 167
 168   U-Boot> env set dfu_alt_info "spl part 0 1;u-boot part 0 2"
 169
 170   U-Boot> dfu 0 mmc 0 list
 171   DFU alt settings list:
 172   dev: eMMC alt: 0 name: spl layout: RAW_ADDR
 173   dev: eMMC alt: 1 name: u-boot layout: RAW_ADDR
 174
 175   Boot> dfu 0 mmc 0
 176
 177   On the Host side:
 178
 179   list the available alternate setting:
 180
 181   $> dfu-util -l
 182   dfu-util 0.9
 183
 184   Copyright 2005-2009 Weston Schmidt, Harald Welte and OpenMoko Inc.
 185   Copyright 2010-2016 Tormod Volden and Stefan Schmidt
 186   This program is Free Software and has ABSOLUTELY NO WARRANTY
 187   Please report bugs to http://sourceforge.net/p/dfu-util/tickets/
 188
 189   Found DFU: [0483:5720] ver=0200, devnum=45, cfg=1, intf=0, path="3-1.3.1", \
 190      alt=1, name="u-boot", serial="003A00203438510D36383238"
 191   Found DFU: [0483:5720] ver=0200, devnum=45, cfg=1, intf=0, path="3-1.3.1", \
 192      alt=0, name="spl", serial="003A00203438510D36383238"
 193
 194   To download to U-Boot, use -D option
 195
 196   $> dfu-util -a 0 -D u-boot-spl.bin
 197   $> dfu-util -a 1 -D u-boot.bin
 198
 199   To upload from U-Boot, use -U option
 200
 201   $> dfu-util -a 0 -U u-boot-spl.bin
 202   $> dfu-util -a 1 -U u-boot.bin
 203
 204   To request a DFU detach and reset the USB connection:
 205   $> dfu-util -a 0 -e  -R
 206
 207
 208   Example 2: firmware located in NOR (sf) and NAND, with:
 209   - alternate 1 (alt=1) for SPL partition (NOR GPT partition 1)
 210   - alternate 2 (alt=2) for U-Boot partition (NOR GPT partition 2)
 211   - alternate 3 (alt=3) for U-Boot-env partition (NOR GPT partition 3)
 212   - alternate 4 (alt=4) for UBI partition (NAND GPT partition 1)
 213
 214   U-Boot> env set dfu_alt_info \
 215   "sf 0:0:10000000:0=spl part 0 1;u-boot part 0 2; \
 216   u-boot-env part 0 3&nand 0=UBI partubi 0,1"
 217
 218   U-Boot> dfu 0 list
 219
 220   DFU alt settings list:
 221   dev: SF alt: 0 name: spl layout: RAW_ADDR
 222   dev: SF alt: 1 name: ssbl layout: RAW_ADDR
 223   dev: SF alt: 2 name: u-boot-env layout: RAW_ADDR
 224   dev: NAND alt: 3 name: UBI layout: RAW_ADDR
 225
 226   U-Boot> dfu 0
 227
 228   $> dfu-util -l
 229   Found DFU: [0483:5720] ver=9999, devnum=96, cfg=1,\
 230      intf=0, alt=3, name="UBI", serial="002700333338511934383330"
 231   Found DFU: [0483:5720] ver=9999, devnum=96, cfg=1,\
 232      intf=0, alt=2, name="u-boot-env", serial="002700333338511934383330"
 233   Found DFU: [0483:5720] ver=9999, devnum=96, cfg=1,\
 234      intf=0, alt=1, name="u-boot", serial="002700333338511934383330"
 235   Found DFU: [0483:5720] ver=9999, devnum=96, cfg=1,\
 236      intf=0, alt=0, name="spl", serial="002700333338511934383330"
 237
 238   Same example with MTD backend
 239
 240    U-Boot> env set dfu_alt_info \
 241       "mtd nor0=spl part 1;u-boot part 2;u-boot-env part 3&"\
 242       "mtd nand0=UBI partubi 1"
 243
 244   U-Boot> dfu 0 list
 245   using id 'nor0,0'
 246   using id 'nor0,1'
 247   using id 'nor0,2'
 248   using id 'nand0,0'
 249   DFU alt settings list:
 250   dev: MTD alt: 0 name: spl layout: RAW_ADDR
 251   dev: MTD alt: 1 name: u-boot layout: RAW_ADDR
 252   dev: MTD alt: 2 name: u-boot-env layout: RAW_ADDR
 253   dev: MTD alt: 3 name: UBI layout: RAW_ADDR
 254
 255   Example 3: firmware located in SD Card (mmc) and virtual partition on
 256              OTP and PMIC not volatile memory
 257   - alternate 1 (alt=1) for scard
 258   - alternate 2 (alt=2) for OTP (virtual)
 259   - alternate 3 (alt=3) for PMIC NVM (virtual)
 260
 261    U-Boot> env set dfu_alt_info \
 262       "mmc 0=sdcard raw 0 0x100000&"\
 263       "virt 0=otp" \
 264       "virt 1=pmic"
 265
 266    U-Boot> dfu 0 list
 267    DFU alt settings list:
 268    dev: eMMC alt: 0 name: sdcard layout: RAW_ADDR
 269    dev: VIRT alt: 1 name: otp layout: RAW_ADDR
 270    dev: VIRT alt: 2 name: pmic layout: RAW_ADDR