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

Merge pull request #11568 from fjmolinas/pr_bootlader_typo

Browse Source 
bootloader/README: fix typos
This commit is contained in:
Alexandre Abadie 2019-05-23 15:38:31 +02:00 committed by GitHub
commit 9018f7e859
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
bootloaders/riotboot/README.md
View File

@ -2,7 +2,7 @@
This folder contains a simple bootloader called "riotboot". This folder contains a simple bootloader called "riotboot".
A header with metadata of length `RIOTBOOT_HDR_LEN` precedes A header with metadata of length `RIOTBOOT_HDR_LEN` precedes
the RIOT firmware. The header contains "RIOT" as a magic the RIOT firmware. The header contains "RIOT" as a magic
number to recognise a RIOT firmware image, a checksum, and number to recognize a RIOT firmware image, a checksum, and
the version of the RIOT firmware `APP_VER`. the version of the RIOT firmware `APP_VER`.
This bootloader verifies the checksum of the header which is located This bootloader verifies the checksum of the header which is located
at an offset (`ROM_OFFSET`) with respect to the `ROM_START_ADDR` at an offset (`ROM_OFFSET`) with respect to the `ROM_START_ADDR`
@ -14,7 +14,7 @@ valid headers and boots the newest image.
riotboot consists of: riotboot consists of:
- This application which serves as minimal bootloader, - This application which serves as minimal bootloader,
- the module "riotboot_hdr" used to recognise RIOT firmware which riotboot - the module "riotboot_hdr" used to recognize RIOT firmware which riotboot
can boot, can boot,
- the module "riotboot_slot" used to manage the partitions (slots) with a - the module "riotboot_slot" used to manage the partitions (slots) with a
RIOT header attached to them, RIOT header attached to them,
@ -53,7 +53,7 @@ A board capable to use riotboot must meet the following requirements:
- Use cpu/cortexm_common/ldscripts/cortexm.ld ld script - Use cpu/cortexm_common/ldscripts/cortexm.ld ld script
- Pass the cortexm_common_ldscript test in tests/ - Pass the cortexm_common_ldscript test in tests/
- Being able to execute startup code at least twice (`board_init()`) - Being able to execute startup code at least twice (`board_init()`)
- Declare `FEATURES_PROVIDED += riotboot` to pull the rigth dependencies - Declare `FEATURES_PROVIDED += riotboot` to pull the right dependencies
- Being able to flash binary files, if integration with the build - Being able to flash binary files, if integration with the build
system is required for flashing system is required for flashing
@ -70,7 +70,7 @@ optionally set (0 by default) in your makefile.
The image can be flashed using `riotboot/flash` which also flashes The image can be flashed using `riotboot/flash` which also flashes
the bootloader. Below a concrete example: the bootloader. Below a concrete example:
`BOARD=samr21-xpro FEATURES_REQUIRED+=riotboot APP_VER=$(date +%s) make -C examples/hello-world flash-combined-slot0` `BOARD=samr21-xpro FEATURES_REQUIRED+=riotboot APP_VER=$(date +%s) make -C examples/hello-world riotboot/flash-combined-slot0`
The above compiles a hello world binary and a bootloader, then flashes the The above compiles a hello world binary and a bootloader, then flashes the
combined binary comprising of: bootloader + slot 0 header + slot 0 image. combined binary comprising of: bootloader + slot 0 header + slot 0 image.