aboutsummaryrefslogtreecommitdiff
path: root/examples/boot/README.md
diff options
context:
space:
mode:
authorUlf Lilleengen <[email protected]>2022-01-24 12:54:09 +0100
committerUlf Lilleengen <[email protected]>2022-02-09 10:50:29 +0100
commited2a87a262e0e8c091627c96ced981dd3a97a6a1 (patch)
treee4202eb8044b534215aa9aa68b79ab83b9e9afc4 /examples/boot/README.md
parentd91bd0b9a69b8411f2a1d58bfad5d4dce51e7110 (diff)
Add embassy-boot
Embassy-boot is a simple bootloader that works together with an application to provide firmware update capabilities with a minimal risk. The bootloader consists of a platform-independent part, which implements the swap algorithm, and a platform-dependent part (currently only for nRF) that provides addition functionality such as watchdog timers softdevice support.
Diffstat (limited to 'examples/boot/README.md')
-rw-r--r--examples/boot/README.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/examples/boot/README.md b/examples/boot/README.md
new file mode 100644
index 000000000..b97513a9d
--- /dev/null
+++ b/examples/boot/README.md
@@ -0,0 +1,31 @@
1# Examples using bootloader
2
3Example for nRF52 demonstrating the bootloader. The example consists of application binaries, 'a'
4which allows you to press a button to start the DFU process, and 'b' which is the updated
5application.
6
7
8## Prerequisites
9
10* `cargo-binutils`
11* `cargo-flash`
12* `embassy-boot-nrf`
13
14## Usage
15
16
17
18```
19# Flash bootloader
20cargo flash --manifest-path ../../embassy-boot/nrf/Cargo.toml --release --features embassy-nrf/nrf52840 --chip nRF52840_xxAA
21# Build 'b'
22cargo build --release --features embassy-nrf/nrf52840 --bin b
23# Generate binary for 'b'
24cargo objcopy --release --features embassy-nrf/nrf52840 --bin b -- -O binary b.bin
25```
26
27# Flash `a` (which includes b.bin)
28
29```
30cargo flash --release --features embassy-nrf/nrf52840 --bin a --chip nRF52840_xxAA
31```