Skip to content

Commit f48f635

Browse files
committed
Add sketch description
1 parent 6892504 commit f48f635

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

libraries/MCUboot/examples/enableSecurity/enableSecurity.ino

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,24 @@
1+
/*
2+
This example enables secuity features of the MCUboot bootloader writing encryption
3+
and signing key into the microcontroller flash memory.
4+
5+
Once the keys are loaded you need to build and upload the future sketches enabling
6+
the Security Settings -> "Signing + Encryption" in the tools menu of the IDE. This
7+
will create an encrypted and signed binary conforming to the MCUboot image format
8+
using imgtool. See https://docs.mcuboot.com/design.html#image-format for more details
9+
about image format.
10+
11+
Writing the keys will also enable MCUboot image swap using a scratch area. This will
12+
increase the sketch update time after the upload, but also adds the possibility to
13+
revert to the previous image version if the update is not confirmed.
14+
See ConfirmSketch example for more details about setting the confirmed flag.
15+
16+
Circuit:
17+
- Arduino Portenta H7 board
18+
19+
This example code is in the public domain.
20+
*/
21+
122
#include "FlashIAP.h"
223
#include "QSPIFBlockDevice.h"
324
#include "MBRBlockDevice.h"

0 commit comments

Comments
 (0)