kaspar/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-12-26 06:53:52 +01:00
Code Releases Activity

bootloaders/riotboot_dfu: improve documentation of usage

Browse Source 
The `dfu-util` command uses `--device $(DFU_USB_ID)`, where `DFU_USB_ID` is derived from `USB_VID` and `USB_PID` to specify the DFU device to use. Without specifying `USB_VID` and `USB_PID` in the make command, `dfu-util` is called with `--device :`, which only works if there is only one DFU device. Also, the STM32 make system forbids the use of `dfu-util` as programmer without setting the variable `DFU_USB_ID`. Therefore, the documentation is changed to use `USB_VID`/`USB_PID` or `DFU_USB_ID` in the make command.
This commit is contained in:
Gunar Schorcht 2022-11-24 08:19:26 +01:00
parent 4af5175b9d
commit 421cbc5c29
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
bootloaders/riotboot_dfu/doc.txt
View File

@ -51,12 +51,24 @@ When the device is attached and in DFU mode (or the current firmware uses the `u
new firmware can be flashed to slot 0 using:
```
$ FEATURES_REQUIRED+=riotboot USEMODULE+=usbus_dfu make -C examples/saul BOARD=particle-xenon PROGRAMMER=dfu-util all riotboot/flash-slot0
$ FEATURES_REQUIRED+=riotboot USEMODULE+=usbus_dfu make -C examples/saul BOARD=particle-xenon \
PROGRAMMER=dfu-util all riotboot/flash-slot0
```
By default, the VID/PID pair 1209:7d02 is used for the device to be flashed
in riotboot DFU mode. If necessary, this VID/PID pair can be overwritten with
the variable `DFU_USB_ID`, e.g. if the RIOT DFU bootloader was compiled for
a different VID/PID pair.
```
$ FEATURES_REQUIRED+=riotboot USEMODULE+=usbus_dfu make -C examples/saul BOARD=particle-xenon \
PROGRAMMER=dfu-util DFU_USB_ID=1209:7d02 all riotboot/flash-slot0
```
Note that when building and flashing a different slot (eg. `flash-slot1`),
not only is the image built for that slot, but also dfu-util gets passed
`--alt 1` (via the `DFU_ALT` build variable) to store it in the right place.
# Entering DFU mode
When RIOT applications are built with `USEMODULE+=usbus_dfu`,