mbed-os-examples
/
mbed-os-example-mbed5-bootloader
.
Diff: README.md
- Revision:
- 4:0daf612a367a
- Parent:
- 3:01d11bcf86eb
- Child:
- 5:d57adfa16284
--- a/README.md Mon Mar 27 18:45:23 2017 +0100 +++ b/README.md Tue Mar 28 10:30:24 2017 +0100 @@ -1,12 +1,12 @@ # Getting started with bootloader on mbed OS -This example shows how to create a bootloader. For steps on how to create an application which uses this bootloader, see [mbed-os-example-bootloader-blinky](https://github.com/ARMmbed/mbed-os-example-bootloader-blinky). +This example shows how to create a bootloader. For steps on how to create an application that uses this bootloader, see [mbed-os-example-bootloader-blinky](https://github.com/ARMmbed/mbed-os-example-bootloader-blinky). To read more about the bootloader, please visit [bootloader tutorial](https://docs.mbed.com/docs/mbed-os-handbook/en/latest/advanced/bootloader/). ## Required hardware * A supported board - [u-blox EVK-ODIN-W2](https://developer.mbed.org/platforms/ublox-EVK-ODIN-W2/), [Nucleo F429ZI](https://developer.mbed.org/platforms/ST-Nucleo-F429ZI/) or [K64F](https://developer.mbed.org/platforms/FRDM-K64F/). -* CI Test shield. +* CI test shield. * SD card. ## Import the example application @@ -21,7 +21,8 @@ ## Set up application to be a bootloader All supported boards mentioned above are set up to build as a bootloader image. To add support for a new board, you must specify the size of the bootloader. -To do this, set the target (replace ``<TARGET_NAME>`` with your target name) value `restrict_size` to the maximum bootloader size in mbed_app.json: + +To do this, set the target (replace `<TARGET_NAME>` with your target name) value `restrict_size` to the maximum bootloader size in mbed_app.json: ``` "target_overrides": { @@ -73,15 +74,15 @@ Image: .\BUILD\<TARGET_NAME>\ARM\mbed-os-example-bootloader.bin ``` -It creates two binary files. The original uncombined image is in the output directory: <project-name>_application.bin and the bootloader image is <project-name>.bin. +It creates two binary files. The original uncombined image is in the output directory, <project-name>_application.bin, and the bootloader image is <project-name>.bin. -When the build succeeds, you have created a bootloader for your target. This bootloader defines the update file to be located at ``"/sd/mbed-os-example-bootloader-blinky_application.bin"``. This is the binary bootloader flashes and then jumps to. +When the build succeeds, you have created a bootloader for your target. This bootloader defines the update file to be located at `/sd/mbed-os-example-bootloader-blinky_application.bin`. This is the binary bootloader flashes and then jumps to. ## Set up application to use bootloader The next step is to build an application you can combine with your bootloader to create a loadable image. -1. Update your board to use the newly created bootloader image. To do this, set the target (replace ``<TARGET_NAME>`` with your target name) value `bootloader_img` to the file path of the bootloader image. +1. Update your board to use the newly created bootloader image. To do this, set the target (replace `<TARGET_NAME>` with your target name) value `bootloader_img` to the file path of the bootloader image. ``` "target_overrides": {