Skip to content

Commit 03f1017

Browse files
author
Amanda Butler
authored
Edit bootloader.md
Copy edit new text, and combine two sections to avoid duplication.
1 parent 94b2568 commit 03f1017

File tree

1 file changed

+13
-16
lines changed

1 file changed

+13
-16
lines changed

docs/tutorials/bootloader.md

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ Creating a bootloader is similar to creating a regular application. The only add
2121

2222
Adding this field:
2323

24-
* Restricts the bootloader code from growing larger than the specified size.
25-
* Pads the output image to exactly the size specified.
26-
* Defines the symbols `APPLICATION_ADDR`, `APPLICATION_SIZE`, `POST_APPLICATION_ADDR`, `POST_APPLICATION_SIZE`.
24+
- Restricts the bootloader code from growing larger than the specified size.
25+
- Pads the output image to exactly the size specified.
26+
- Defines the symbols `APPLICATION_ADDR`, `APPLICATION_SIZE`, `POST_APPLICATION_ADDR`, `POST_APPLICATION_SIZE`.
2727

2828
It produces the following ROM layout:
2929

@@ -95,25 +95,22 @@ It produces the following ROM layout:
9595

9696
For an example showing how to create an application that uses a bootloader, see the [Mbed OS bootloader example](https://github.com/armmbed/mbed-os-example-bootloader-blinky) repository.
9797

98-
#### Exporter limitations
99-
100-
While the exporters can export a project using the configuration parameters above, there are some limitations.
101-
102-
The exporters do not interpret Mbed OS Configuration, and any changes to configuration parameters, especially boot loader parameter, require you to re-run the `mbed export` command.
103-
104-
Further, The exporters do not implement the post build merge used in managed boot loader builds. After exporting a project with the `target.bootloader_img` setting, you are responsible for flashing the binary mentioned in the configuration parameter. Without flashing this boot loader image, the device will not boot correctly.
105-
10698
### Unmanaged bootloader
10799

108100
You want to have an unmanaged bootloader when your bootloader's requirements conflict with the requirements of the managed bootloader. You need an unmanaged bootloader when your bootloader does not come before your application in ROM or your application does not start immediately after your bootloader. Unlike a managed bootloader, an unmanaged bootloader does not automatically merge the bootloader image with the application image after building the application. We expect users of an unmanaged bootloader build to construct their own set of scripts built atop the `mbed compile` primitive to perform bootloader and application merging.
109101

110-
An unmanaged bootloader build is a method for controlling the link location of a program within Mbed OS. There are two configuration options available for changing the link location: `target.mbed_app_start` and `target.mbed_app_size`. Please see [Boot Loader Configuration](../tools/bootloader.md) for complete descriptions of these options.
102+
An unmanaged bootloader build is a method of controlling the link location of a program within Mbed OS. There are two configuration options available for changing the link location: `target.mbed_app_start` and `target.mbed_app_size`. Please see [bootloader configuration](docs/v5.7/tools/bootloader.html) for complete descriptions of these options.
103+
104+
### Exporter limitations
111105

106+
Although the exporters can export bootloader projects using the bootloader parameters, there are some limitations.
112107

113-
#### Exporter limitations
108+
The exporters do not interpret Mbed OS configuration, and any changes to configuration parameters, especially bootloader parameters, require you to rerun the `mbed export` command.
114109

115-
While the exporters can export an Unmanaged bootloader project using, there are some limitations.
110+
Further, the exporters do not implement the postbuild merge that bootloader builds use.
116111

117-
The exporters do not interpret Mbed OS Configuration, and any changes to configuration parameters, especially boot loader parameter, require you to re-run the `mbed export` command.
112+
For a managed bootloader:
113+
After exporting a project with the `target.mbed_app_start` setting, you are responsible for ensuring that a boot loader is present, if needed. Without flashing this boot loader image, the device will not boot correctly.
118114

119-
Further, The exporters do not implement the post build merge used in managed boot loader builds. After exporting a project with the `target.mbed_app_start` setting, you are responsible for ensuring that a boot loader is present, if needed. Without flashing this boot loader image, the device will not boot correctly.
115+
For an unmanaged bootloader:
116+
After exporting a project with the `target.bootloader_img` setting, you are responsible for flashing the binary mentioned in the configuration parameter. Without flashing this bootloader image, the device will not boot correctly.

0 commit comments

Comments
 (0)