RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

riotboot: update documentation to match automatic use

Browse Source 
FLASHFILE is now set to RIOTBOOT_EXTENDED_BIN, changing the meaning of
make all`, `flash`, `flash-only`.
This commits updates the documentation accordingly.
This commit is contained in:
Kaspar Schleiser 2019-06-13 13:46:00 +02:00
parent bb71e979f3
commit 8624d3dac4
1 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
bootloaders/riotboot/README.md
View File

@ -61,13 +61,18 @@ The above requirements are usually met if the board succeeds to execute
the riotboot test in tests/.
# Single Slot
Just compile your application using the target `riotboot`. The header
is generated automatically according to your `APP_VER`, which can be
optionally set (0 by default) in your makefile.
Just compile your application with `FEATURES_REQUIRED += riotboot`. The header
is generated automatically according to your `APP_VER`, which can be optionally
set (0 by default) in your makefile.
## Flashing example
The image can be flashed using `riotboot/flash` which also flashes
If your application is using the riotboot feature, the usual targets (`all`,
`flash`, `flash-only`) will automatically compile and/or flash both the
bootloader and slot0, while ensuring that slot 1 is invalidated so slot 0 will
be booted.
The image can also be flashed using `riotboot/flash` which also flashes
the bootloader. Below a concrete example:
`BOARD=samr21-xpro FEATURES_REQUIRED+=riotboot APP_VER=$(date +%s) make -C examples/hello-world riotboot/flash-combined-slot0`
@ -94,7 +99,8 @@ Dedicated make targets are available to build and flash several slots:
In particular, if one wants to be sure to boot a particular image, using the
target `riotboot/flash-extended-slot0` is the way to go (resulting in only
slot 0 being valid, thus being booted).
slot 0 being valid, thus being booted). This is done automatically by `make
flash` if the `riotboot` feature is used.
## Flashing examples