Skip to content

Commit accbd5e

Browse files
author
Amanda Butler
authored
Revert "Add unmanaged bootloader documentation"
1 parent cce6819 commit accbd5e

File tree

1 file changed

+2
-21
lines changed

1 file changed

+2
-21
lines changed

docs/advanced/bootloader.md

Lines changed: 2 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,7 @@ This guide explains how to create a bootloader, how to create a main program to
66

77
A target requires flash HAL functionality in order to support the bootloader. Please follow [the bootloader porting guide](https://docs.mbed.com/docs/mbed-os-handbook/en/latest/advanced/flash/) for more details.
88

9-
## mbed OS managed bootloader
10-
11-
The tools of mbed OS know how to manage some bootloader projects. The tools can manage bootloader projects where the bootlodoader comes before the application in ROM and the application starts immediately after the bootloader. If your bootloader does not meet both of these requirements, then please read the [unmanaged bootloader section](bootloader.md#unmanaged-bootloader). A managed bootloader project automatically merge the bootloader image with the application image as part of the application image build process.
12-
13-
### Creating the bootloader
9+
## Creating the bootloader
1410

1511
Creating a bootloader is similar to creating a regular application. The only additional step you need is to specify the size of the bootloader as a target override in mbed_app.json in the target field "target.restrict_size":
1612

@@ -57,7 +53,7 @@ mbed_start_application(POST_APPLICATION_ADDR);
5753

5854
For an example showing how to create a bootloader, see the [mbed-os-example-bootloader](https://github.com/armmbed/mbed-os-example-bootloader) repository.
5955

60-
### Creating the main program
56+
## Creating the main program
6157

6258
To create an application using a bootloader, you must first have created the bootloader binary and added it to the current project. You must then specify the bootloader image in mbed_app.json in the target_override section:
6359

@@ -98,18 +94,3 @@ It produces the following ROM layout:
9894
```
9995

10096
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.
101-
102-
## Unmanaged bootloader
103-
104-
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 unmananged 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 there own set of scripts built atop the `mbed compile` primitive to perform bootloader and application merging.
105-
106-
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`.
107-
108-
### `target.mbed_app_start`
109-
110-
111-
The configuration option `target.mbed_app_start` sets the starting address of the linker script by defining the `MBED_APP_START` macro for the linker script. You may only define this configuration option within the `target_overrides` section of an mbed application configuration, and you may not define it for the meta-target `*`. When you do not define this configuration option, it defaults to the start of a target's ROM. This configuration option must be an address within ROM.
112-
113-
### `target.mbed_app_size`
114-
115-
The configuration option `target.mbed_app_size` defines the size of an application image in ROM by defining the `MBED_APP_SIZE` macro for the linker script. You may only define this configuration option on a per-target basis defined within the `target_overrides` section of an mbed application configuration, and you may not define it for the meta-target `*`. When you do not define this configuration option, it defaults to the remaining ROM, which the mbed OS tools calculate by subtracting the image's offset into ROM from the total size of ROM. Together with `target.mbed_app_start`, these configuration options define a continuous region of memory that an image may use. The tools verify that this region of memory is in ROM, but the tools do not perform any other checks for consistency or validity.

0 commit comments

Comments
 (0)