🎉 (boot): Add bootloader

🚧 (boot): Use default main of mcuboot
👽 (boot): Add QSPIF as default block device mandatory by MCUBoot
👽 (boot): Add signing keys
Public key of bootloader is associated with private key used with the application

CMakeLists.txt

@@ -76,13 +76,14 @@ if(CMAKE_EXPORT_COMPILE_COMMANDS)
 endif()
 
 # For convenience you can define useful variables
-set(OS_DIR      ${ROOT_DIR}/src)
-set(LIBS_DIR    ${ROOT_DIR}/libs)
-set(TESTS_DIR   ${ROOT_DIR}/tests)
-set(SPIKES_DIR  ${ROOT_DIR}/spikes)
-set(DRIVERS_DIR ${ROOT_DIR}/drivers)
-set(TARGETS_DIR ${ROOT_DIR}/targets)
-set(INCLUDE_DIR ${ROOT_DIR}/include)
+set(OS_DIR         ${ROOT_DIR}/src)
+set(LIBS_DIR       ${ROOT_DIR}/libs)
+set(TESTS_DIR      ${ROOT_DIR}/tests)
+set(SPIKES_DIR     ${ROOT_DIR}/spikes)
+set(DRIVERS_DIR    ${ROOT_DIR}/drivers)
+set(TARGETS_DIR    ${ROOT_DIR}/targets)
+set(INCLUDE_DIR    ${ROOT_DIR}/include)
+set(BOOTLOADER_DIR ${ROOT_DIR}/bootloader)
 
 # Add custom target subdirectory
 set(AVAILABLE_CUSTOM_TARGETS DISCO_ORIGINAL LEKA_V1_0_DEV LEKA_V1_1_DEV LEKA_V1_2_DEV)
@@ -130,6 +131,9 @@ add_subdirectory(${LIBS_DIR})
 add_subdirectory(${SPIKES_DIR})
 add_subdirectory(${TESTS_DIR}/functional)
 
+# Add bootloader
+add_subdirectory(${BOOTLOADER_DIR})
+
 # Add LekaOS
 add_subdirectory(${OS_DIR})
 

bootloader/CMakeLists.txt

@@ -0,0 +1,23 @@
+# Leka - LekaOS
+# Copyright 2021 APF France handicap
+# SPDX-License-Identifier: Apache-2.0
+
+add_mbed_executable(bootloader)
+
+target_include_directories(bootloader
+	PRIVATE
+		.
+)
+
+target_sources(bootloader
+	PRIVATE
+		main.cpp
+		default_bd.cpp
+		signing_keys.c
+)
+
+target_link_libraries(bootloader
+	bootutil
+)
+
+target_link_custom_leka_targets(bootloader)

bootloader/default_bd.cpp

@@ -0,0 +1,18 @@
+// Leka - LekaOS
+// Copyright 2021 APF France handicap
+// SPDX-License-Identifier: Apache-2.0
+
+#include "QSPIFBlockDevice.h"
+#include "SlicingBlockDevice.h"
+
+auto get_secondary_bd() -> mbed::BlockDevice *
+{
+	// In this case, our flash is much larger than a single image so
+	// slice it into the size of an image slot
+
+	static auto _bd = QSPIFBlockDevice {};
+
+	static auto sliced_bd = mbed::SlicingBlockDevice {&_bd, 0x0, MCUBOOT_SLOT_SIZE};
+
+	return &sliced_bd;
+}

bootloader/main.cpp

@@ -0,0 +1,62 @@
+/*
+ * Copyright (c) 2020 Embedded Planet
+ * Copyright (c) 2020 ARM Limited
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License
+ */
+
+#include "mbed_application.h"
+#include "mbedtls/platform.h"
+
+#include "drivers/BufferedSerial.h"
+
+#include "LogKit.h"
+#include "bootutil/bootutil.h"
+#include "bootutil/image.h"
+#include "hal/serial_api.h"
+
+static auto serial = mbed::BufferedSerial(USBTX, USBRX, 115200);
+
+auto main() -> int
+{
+	int rc;
+
+	log_info("Starting MCUboot");
+
+	// Initialize mbedtls crypto for use by MCUboot
+	mbedtls_platform_context unused_ctx;
+	rc = mbedtls_platform_setup(&unused_ctx);
+	if (rc != 0) {
+		log_error("Failed to setup Mbed TLS, error: %d", rc);
+		exit(rc);
+	}
+
+	struct boot_rsp rsp;
+	rc = boot_go(&rsp);
+	if (rc != 0) {
+		log_error("Failed to locate firmware image, error: %d", rc);
+		exit(rc);
+	}
+
+	uint32_t address = rsp.br_image_off + rsp.br_hdr->ih_hdr_size;
+
+	// Workaround: The extra \n ensures the last trace gets flushed
+	// before mbed_start_application() destroys the stack and jumps
+	// to the application
+	log_info("Booting firmware image at 0x%x\n", address);
+
+	// Run the application in the primary slot
+	// Add header size offset to calculate the actual start address of application
+	mbed_start_application(address);
+}

bootloader/signing_keys.c

@@ -0,0 +1,38 @@
+/* Autogenerated by imgtool.py, do not edit. */
+const unsigned char rsa_pub_key[] = {
+    0x30, 0x82, 0x01, 0x0a, 0x02, 0x82, 0x01, 0x01,
+    0x00, 0xc1, 0x3c, 0x9a, 0x1b, 0xd5, 0x96, 0x02,
+    0xdc, 0xdc, 0xc2, 0x5a, 0xf7, 0x31, 0x81, 0x84,
+    0x46, 0xe6, 0xb5, 0x63, 0x73, 0x51, 0x76, 0xea,
+    0x94, 0xf7, 0x3d, 0x81, 0xb4, 0x48, 0xa2, 0x9c,
+    0x00, 0xab, 0x7d, 0x66, 0x9c, 0xcc, 0x84, 0x9c,
+    0x15, 0x5d, 0x7f, 0x5f, 0x7c, 0x46, 0xb1, 0x6d,
+    0x8b, 0x5d, 0x47, 0x26, 0x68, 0xff, 0x50, 0xb7,
+    0x8d, 0x34, 0xa5, 0x25, 0xc6, 0x0f, 0x62, 0xc8,
+    0x1f, 0xa5, 0x93, 0xcb, 0xc9, 0x21, 0x7e, 0xe6,
+    0xc2, 0xae, 0x20, 0xc2, 0xaf, 0x85, 0x4f, 0xaa,
+    0xef, 0xac, 0x16, 0xd8, 0x79, 0xac, 0xc1, 0x02,
+    0x65, 0x45, 0x23, 0x53, 0xee, 0x7d, 0x8e, 0x8b,
+    0x87, 0xaa, 0x97, 0x3e, 0xb4, 0xc0, 0xdd, 0xe5,
+    0xd9, 0xb0, 0xd4, 0x0d, 0x38, 0x67, 0x29, 0x2d,
+    0xb9, 0xf7, 0xfa, 0x8c, 0x06, 0xd9, 0xb4, 0x29,
+    0xc2, 0x13, 0x7c, 0xce, 0xcd, 0x2e, 0x48, 0xce,
+    0x87, 0x0f, 0xb0, 0x61, 0x19, 0x44, 0x71, 0x7c,
+    0xe9, 0xef, 0x5f, 0x65, 0x16, 0xf9, 0x94, 0xa3,
+    0x46, 0x17, 0x85, 0xb7, 0x68, 0xb0, 0xc2, 0x9e,
+    0xe5, 0xd6, 0x56, 0xd6, 0xc8, 0xc6, 0xcc, 0x0b,
+    0x5f, 0x63, 0xf7, 0x0c, 0x4f, 0xf2, 0xd4, 0xd9,
+    0xd5, 0x1d, 0x40, 0x5b, 0x6e, 0x73, 0x2f, 0x4d,
+    0xc7, 0x4a, 0xe5, 0xae, 0x74, 0xaa, 0x35, 0x9a,
+    0x05, 0xa7, 0x24, 0xd3, 0xba, 0x3a, 0x7c, 0xe9,
+    0x55, 0x67, 0x35, 0x63, 0xb2, 0x6a, 0x14, 0x6f,
+    0xfa, 0x5f, 0x1e, 0xc7, 0x71, 0xc9, 0xf7, 0x5a,
+    0x0b, 0x2c, 0x51, 0xab, 0xdc, 0x11, 0x65, 0x4e,
+    0xec, 0x10, 0x0e, 0x2e, 0x0e, 0x41, 0x6f, 0x56,
+    0x64, 0xf5, 0x5c, 0x8f, 0xfa, 0xb4, 0x0b, 0x3b,
+    0xe0, 0xb0, 0xba, 0x28, 0xb2, 0x48, 0x8c, 0xe0,
+    0x59, 0xd7, 0x3b, 0xbf, 0x5e, 0x7f, 0x4b, 0xc9,
+    0x98, 0xdd, 0x03, 0xbd, 0xd2, 0xdc, 0xc8, 0x3e,
+    0xf1, 0x02, 0x03, 0x01, 0x00, 0x01,
+};
+const unsigned int rsa_pub_key_len = 270;

signing-keys.pem

@@ -0,0 +1,28 @@
+-----BEGIN PRIVATE KEY-----
+MIIEvAIBADANBgkqhkiG9w0BAQEFAASCBKYwggSiAgEAAoIBAQDBPJob1ZYC3NzC
+WvcxgYRG5rVjc1F26pT3PYG0SKKcAKt9ZpzMhJwVXX9ffEaxbYtdRyZo/1C3jTSl
+JcYPYsgfpZPLySF+5sKuIMKvhU+q76wW2HmswQJlRSNT7n2Oi4eqlz60wN3l2bDU
+DThnKS259/qMBtm0KcITfM7NLkjOhw+wYRlEcXzp719lFvmUo0YXhbdosMKe5dZW
+1sjGzAtfY/cMT/LU2dUdQFtucy9Nx0rlrnSqNZoFpyTTujp86VVnNWOyahRv+l8e
+x3HJ91oLLFGr3BFlTuwQDi4OQW9WZPVcj/q0CzvgsLooskiM4FnXO79ef0vJmN0D
+vdLcyD7xAgMBAAECggEAIv4yei/nhoUwhRGsCg8GQUCuQGA1tG8uosdEob01lUKZ
+y4+1fWPWUBgqZMRAmQjZX/7ueb0ihNrRWcbJYyfkTbbSWOkHY8+uGZJdLyPZFX9p
+jomNHzekk2o9x4k8u3+RBdd1x43VoTYWy4/JUwUl/rNlb84dxn55YsYLPSTQknWa
+PjDBfajflbfq2KD1xNGD0Kb9CBwWobzXYkFUh9SpQwEjziGFtAoSRSfe+P+o80gf
+foWYc1lXm4hlnTpdYj2ObsCBgllNXk5jUaU8vxzya8PzpkwUhJqkzq7bXtBc18z1
+p0pTi5FEwVSvKPWCmBbmZzYpJwtE4s2DE3g+Vvp18QKBgQDpvvaHsmzXHkfuaz9U
+uE8QTWfnvrlAdHit3XmIkNqU4q22AqOj0+cwl9QoK6erSkSHW7i+05M3ebu1WaV7
+Gibc0VPXtkAX2558YDoIzJ5lRYf4cqzHa9pnxeRnVBDNH/CEgznJz62djRhfC1x4
+BBkInzhgBvfVo5fwWr33y/XcDwKBgQDTolEfR8OmbgxhLKq5s+DAI8oqzDJhVsl0
+xGoiErbafudJxJ5VnR+3848kULdIloNO0/d1R13mMdc4etuomBrlYYfOtL9vFbOZ
+k3xGS+oM1FhYqDxt8H/2PXymP8LNsg8HD7HvMLVGQyuhI/bp3eg5L83elSAu1Z94
+ls77F+E0/wKBgC54NYDSuwqlTX2burJ4FdfS27ZZ13B190vxfOjmi14QFqLZsXiv
+dwXVGWuHCkVmdWtHk9n0LA9aVzP9h4WKtHEv+HApHmLf2Yk2hDMdotvVT+vXuHvI
++FmrIPZd4x00nVdq00FI1WY+F7tFgfOmNOfe55FHsVu6s0kocR3jYZSHAoGANnoj
+869fd6oAWctLrz3UbuFHmzixB0l11i7xOxAiLaBZHS4Vq+gkUA/MGwcEBxVne5Uo
+r/HNBAJ0aj+F56Iv2jf+44C3fnrRnojOhrHn76GBlGDKHWq5JcOyIIFtPdHF+IVb
+wjyBjTKhOnuthYnvyzi4/8DXZfbrc/kuEoiVGjUCgYBr23h89MFnfAzYvEa1eI9O
+DtXhQ2Z4Cx+lHkTXDpwA0G+Wm4/efJCZ+7UWM53GEILQTLXao9/UBNjb+OO3/uGR
+7UEBNfGFbaaLLmsRQ0yMWhqlRmy3R8tiMT0NT2MFkBe2UM336PddafrytfiYCGsq
+A7/6ZBUz5gbc2lYA1FUSMw==
+-----END PRIVATE KEY-----