Add small RIOT bootloader and multislot management #7457

kYc0o · 2017-08-07T18:02:12Z

Another approach tackling the need of a bootloader. It's based on @kaspar030 work and #7396, without all the cryptographic tools embedded in the bootloader.

In this approach, the security checks will be relayed to the OTA update module, which will come in a subsequent PR.

The instructions to use the RIOT bootloader are the same as in the previous PR a bit more simplified:

make combined: Creates Ready-To-Send images for both slots, including metadata and signatures.
make verify: Verifies if the image's signature is valid, using the provided public key.
make flash-multislot: Builds, links, signs and flashes an image including the bootloader and the application on the first slot. Flashing the bootlaoder with the application in slot 2 is not supported.
make multislot-clean: Deletes all the files created by any of the previous targets

A small difference on the created files:

<application_name>-slot<slot>-<appid>-<version>.img: The binary file linked for the given
slot, with its corresponding metadata ready to be sent over the air.
<application_name>.combined.bin: The binary containing both the bootloader and the application on the first slot. It is used to flash it directly on the board.
<application_name>.slot<slot>.elf: The ELF file linked for the specified slot. Very useful for debugging purposes.

You can find these files in the binary folder of your application.

The signature checks are not done by the bootloader, but the build system generates valid and signed images with the provided keys (or creates new keys if none are provided).

kYc0o · 2017-08-07T18:05:52Z

@kaspar030 I rebased and adapted your branch in this PR. I decided to dissociate the bootloader and multislot stuff from the OTA module. I'm working on that and I think I can submit it soon.

If you can review this soon it would be great, as I'm going on vacations soon.

kaspar030 · 2017-08-08T09:28:43Z

sings and flashes an image

How does it sound? :)

kYc0o · 2017-08-08T10:07:48Z

How does it sound? :)

A beautiful melody ;)

kaspar030

initial round...

kaspar030 · 2017-08-08T09:30:36Z

boards/iotlab-common/Makefile.include

 include $(RIOTMAKE)/tools/serial.inc.mk

+# export ROM partitions
+export ROM_SIZE = 0x80000


why export these variables?

They're used in several places not only in Makefiles but also in flashing scripts and in subsequent linking operations, but I can modify this to export only those really needed. Does it harm?

kaspar030 · 2017-08-08T09:31:23Z

boards/samr21-xpro/Makefile.include

+export ROM_SIZE = 0x40000
+export SLOT0_ADDR = 0x0
+export SLOT0_SIZE = 0x4000
+CFLAGS +=-DSLOT0_SIZE=$(SLOT0_SIZE)


I'm seeing these defines the second time. Maybe find a common place?

Yes, maybe we can add them to the exported variables in the main makefile intended for this.

They're already there, right? (in sys/firmware/Makefile)

Oh yeah, I didn't remember that. So then I guess there they're ok?

kaspar030 · 2017-08-08T09:32:02Z

bootloader/main.c

@@ -0,0 +1,59 @@
+/*
+ * Copyright (C) 2017 Kaspar Schleiser


please add my email address to the copyright

kaspar030 · 2017-08-08T09:32:36Z

bootloader/Makefile

@@ -0,0 +1,12 @@
+APPLICATION = bootloader


I'm not entirely happy with adding another top-level folder for the bootloader...

Well, I also don't think that adding it to examples is the good place... For me it looks good here because it states an essential part of RIOT, though it's optional...

I'll ask on the mailing list

kaspar030 · 2017-08-08T09:38:10Z

dist/tools/firmware/genmeta.c

+#include "firmware.h"
+#include "common.h"
+
+const char genmeta_usage[] = "genmeta <BINFILE> <VERSION> <APPID> <START-ADDR> <seckey> <outfile>";


"firmware genmeta ..." (I knew where to look. ;) )

kaspar030 · 2017-08-08T09:42:37Z

makefiles/multislot.mk

+bootloader-clean:
+	@env -i PATH=$(PATH) BOARD=$(BOARD) make -C $(RIOTBASE)/bootloader clean
+
+multislot-clean: firmware-tools-clean bootloader-clean


maybe rename to clean-multislot (so it is consistent with "flash-multislot")?

kaspar030 · 2017-08-09T08:13:22Z

tests/bootloader_test/README.md

@@ -0,0 +1,31 @@
+Hello Bootloader!
+============


more equal signs (match string above)

kaspar030 · 2017-08-09T08:13:54Z

tests/bootloader_test/Makefile

+APP_ID = 0xBB8
+APP_VERSION = 0x1
+
+BOARD_WHITELIST := samr21-xpro iotlab-m3 fox iotlab-a8-m3


How about FEATURE_MULTISLOT, which is set to true when the corresponding variables are set?

It sounds good to me, but to "whom" does this feature belong? board? cpu?

Probably the CPU?

Well, I think this feature can also belong to the board, since some development boards come with a pre-flashed bootloader, which I think we don't aim to overwrite (until we have a nice solution to flash all the boards using this bootloader through serial or USB), so maybe is better to put it as a board feature.

kaspar030 · 2017-08-09T08:16:40Z

makefiles/multislot.mk

+
+.PHONY: flash-multislot verify firmware-tools-clean
+
+ifneq (, $(filter $(BOARD),iotlab-m3))


why is there a board specific define needed here? need to get rid of it.

It's because I'm relying on the FFLAGS to avoid modifying more the flashing process. I didn't find a place or another way to only do a flash-bin without affecting the FFLAGS for other platforms (it happened to me that without this the normal flashing failed since it tried to always do flash-bin).

Still, it can't be here. If we add board-specific stuff in this makefile, we'll end up with hundreds of exceptions.

Yes I know, it was an initial way to avoid the error. We maybe need to decide which kind of files we prefer to flash in a board. We can start to put binary by default in boards on which the bootloader can be used.

BTW, I think is incorrect to send a binary file as a HEXFILE variable, so that can also be fixed.

kYc0o · 2017-08-09T22:05:09Z

Addressed comments.

kYc0o · 2018-05-30T15:07:49Z

Same as #7396.

kYc0o requested a review from kaspar030 August 7, 2017 18:02

kYc0o assigned kaspar030 and ghost Aug 7, 2017

kYc0o added the Type: new feature The issue requests / The PR implemements a new feature for RIOT label Aug 7, 2017

kYc0o added this to the Release 2017.10 milestone Aug 7, 2017

kYc0o added the CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR label Aug 7, 2017

This was referenced Aug 7, 2017

Firmware swapping #6450

Closed

dist/tools: add firmware metadata generator #6919

Closed

Add RIOT bootloader to manage firmware slots #6922

Closed

kaspar030 requested changes Aug 9, 2017

View reviewed changes

kYc0o force-pushed the multislots_small_bootloader branch from a74999c to cfa70e7 Compare August 9, 2017 22:04

kYc0o force-pushed the multislots_small_bootloader branch from 390c385 to ea014d8 Compare September 20, 2017 22:10

kaspar030 and others added 12 commits September 27, 2017 15:56

sys/hashes/sha256: add missing unistd.h include

dcab135

make: initial multislot support

1261165

bootloader: add initial minimal bootloader

9dc2637

cpu/cortexm_common: initial multislot support

32fcc03

boards/samr21-xpro: initial multislot support

c772fca

cpu/sam0-common/ldscripts: initial multislot support

b3a15af

sys/firmware: initial import of firmware management functions

effbc63

dist/tools/firmware: initial import of firmware metadata tools

1cf5d53

tests: add bootloader test

fdea659

boards/iotlab-common: initial multislot support

c1a9ed3

cpu/stm32f1/ldscripts: inital multislot support

8aa1bad

dist/tools/openocd: add flash-bin option

3aa7a50

kYc0o force-pushed the multislots_small_bootloader branch from ea014d8 to 3aa7a50 Compare September 27, 2017 13:56

kYc0o removed this from the Release 2017.10 milestone Oct 16, 2017

kYc0o mentioned this pull request Oct 29, 2017

Software Updates #7890

Closed

8 tasks

aabadie mentioned this pull request Jan 2, 2018

[WIP] Add ota_update module (second attempt) #7398

Closed

kaspar030 mentioned this pull request Apr 9, 2018

sys: provide over-the-air update mechanism #8902

Closed

kYc0o closed this May 30, 2018


		.PHONY: flash-multislot verify firmware-tools-clean

		ifneq (, $(filter $(BOARD),iotlab-m3))

Add small RIOT bootloader and multislot management #7457

Add small RIOT bootloader and multislot management #7457

Uh oh!

Conversation

kYc0o commented Aug 7, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kYc0o commented Aug 7, 2017

Uh oh!

kaspar030 commented Aug 8, 2017

Uh oh!

kYc0o commented Aug 8, 2017

Uh oh!

kaspar030 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kYc0o Aug 9, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kYc0o Aug 9, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kYc0o commented Aug 9, 2017

Uh oh!

kYc0o commented May 30, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

kYc0o commented Aug 7, 2017 •

edited

Loading

kYc0o Aug 9, 2017 •

edited

Loading

kYc0o Aug 9, 2017 •

edited

Loading