Skip to content

Commit e86f575

Browse files
nvlsianpunvlsianpu
authored
Synch to upstream aa041a2
merge using GH web GUI Synch up to upstream mcu-tools/mcuboot@aa041a2 - Added workflow verifying integration with the Zephyr - removed deprecated DT_CHOSEN_ZEPHYR_FLASH_CONTROLLER_LABEL - Fixed usage of CONFIG_LOG_IMMEDIATE Signed-off-by: Marek Pieta <Marek.Pieta@nordicsemi.no>
2 parents 7b9e4ee + aa041a2 commit e86f575

30 files changed

+643
-75
lines changed

‎.github/workflows/zephyr_build.yaml

+103
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
# Copyright (c) 2022 Nordic Semiconductor ASA
2+
# SPDX-License-Identifier: Apache-2.0
3+
4+
name: Build Zephyr samples with Twister
5+
6+
# Workflow triggers on PRs, pushes to main, once per day at midnight and can be started manually.
7+
on:
8+
# By default, pull_request includes: opened, synchronize, or reopened
9+
pull_request:
10+
branches:
11+
- main
12+
push:
13+
branches:
14+
- main
15+
schedule:
16+
- cron: 0 0 * * *
17+
# When triggered manually, ask for Zephyr and MCUBoot versions to check out
18+
workflow_dispatch:
19+
inputs:
20+
version_zephyr:
21+
description: 'Which Zephyr version to checkout?'
22+
required: true
23+
default: 'main'
24+
version_mcuboot:
25+
description: 'Which MCUBoot version to checkout?'
26+
required: true
27+
default: 'main'
28+
29+
env:
30+
ZEPHYR_VERSION: 'main'
31+
MCUBOOT_VERSION: 'main'
32+
33+
# Only cancel ongoing runs for PRs
34+
concurrency:
35+
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
36+
cancel-in-progress: true
37+
38+
jobs:
39+
build_zephyr_with_twister:
40+
runs-on: ubuntu-latest
41+
# Docker image from the zephyr upstream. Includes SDK and other required tools
42+
container:
43+
image: zephyrprojectrtos/ci:v0.21.0
44+
options: '--entrypoint /bin/bash'
45+
volumes:
46+
- /home/runners/zephyrproject:/github/cache/zephyrproject
47+
env:
48+
ZEPHYR_SDK_INSTALL_DIR: /opt/toolchains/zephyr-sdk-0.13.2
49+
50+
steps:
51+
- name: Set versions when workflow_dispatch
52+
if: github.event_name == 'workflow_dispatch'
53+
run: |
54+
echo "ZEPHYR_VERSION=${{ github.event.inputs.version_zephyr }}" >> $GITHUB_ENV
55+
echo "MCUBOOT_VERSION=${{ github.event.inputs.version_mcuboot }}" >> $GITHUB_ENV
56+
57+
- name: Set versions when pull_request
58+
if: github.event_name == 'pull_request'
59+
run: |
60+
echo "MCUBOOT_VERSION=${{ github.event.pull_request.head.sha }}" >> $GITHUB_ENV
61+
62+
- name: Checkout Zephyr
63+
uses: actions/checkout@v2
64+
with:
65+
repository: 'zephyrproject-rtos/zephyr'
66+
ref: ${{ env.ZEPHYR_VERSION }}
67+
path: 'repos/zephyr'
68+
69+
- name: Setup Zephyr
70+
working-directory: repos/zephyr
71+
run: |
72+
west init -l .
73+
west update
74+
75+
- name: Checkout MCUBoot
76+
uses: actions/checkout@v2
77+
with:
78+
repository: 'mcu-tools/mcuboot'
79+
ref: ${{ env.MCUBOOT_VERSION }}
80+
path: 'repos/bootloader/mcuboot'
81+
82+
- name: Run Twister tests
83+
working-directory: repos/zephyr
84+
env:
85+
test_paths: >
86+
-T ../bootloader/mcuboot/boot/zephyr
87+
-T ./tests/subsys/dfu
88+
-T ./samples/subsys/mgmt/mcumgr/smp_svr
89+
run: |
90+
export ZEPHYR_BASE=${PWD}
91+
export ZEPHYR_TOOLCHAIN_VARIANT=zephyr
92+
echo "Using Zephyr version: ${{ env.ZEPHYR_VERSION }}"
93+
echo "Using Mcuboot version: ${{ env.MCUBOOT_VERSION }}"
94+
./scripts/twister --inline-logs -v -N -M --integration --overflow-as-errors --retry-failed 2 ${test_paths}
95+
96+
- name: Upload Tests Results
97+
uses: actions/upload-artifact@v2
98+
if: always()
99+
with:
100+
name: Tests Results
101+
if-no-files-found: ignore
102+
path: |
103+
repos/zephyr/twister-out/twister.xml

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
[travis]: https://travis-ci.org/mcu-tools/mcuboot
1717
[license]: https://github.com/mcu-tools/mcuboot/blob/main/LICENSE
1818

19-
This is MCUboot version 1.9.0
19+
This is MCUboot version 1.10.0-dev
2020

2121
MCUboot is a secure bootloader for 32-bits microcontrollers. It defines a
2222
common infrastructure for the bootloader and the system flash layout on

‎boot/espressif/bootloader.conf

+22-2
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,33 @@
33
# SPDX-License-Identifier: Apache-2.0
44

55
CONFIG_ESP_BOOTLOADER_SIZE=0xF000
6-
CONFIG_ESP_APPLICATION_PRIMARY_START_ADDRESS=0x10000
6+
CONFIG_ESP_IMAGE0_PRIMARY_START_ADDRESS=0x10000
77
CONFIG_ESP_APPLICATION_SIZE=0x100000
8-
CONFIG_ESP_APPLICATION_SECONDARY_START_ADDRESS=0x110000
8+
CONFIG_ESP_IMAGE0_SECONDARY_START_ADDRESS=0x110000
99
CONFIG_ESP_MCUBOOT_WDT_ENABLE=y
1010
CONFIG_ESP_SCRATCH_OFFSET=0x210000
1111
CONFIG_ESP_SCRATCH_SIZE=0x40000
1212

13+
# Enables multi image, if it is not defined, it is assumed
14+
# only one updatable image
15+
# CONFIG_ESP_IMAGE_NUMBER=2
16+
17+
# Enables multi image boot on independent processors
18+
# (main host OS is not responsible for booting the second image)
19+
# Use only with CONFIG_ESP_IMAGE_NUMBER=2
20+
# CONFIG_ESP_MULTI_PROCESSOR_BOOT=y
21+
22+
# Example of values to be used when multi image is enabled
23+
# Notice that the OS layer and update agent must be aware
24+
# of these regions
25+
# CONFIG_ESP_APPLICATION_SIZE=0x50000
26+
# CONFIG_ESP_IMAGE0_PRIMARY_START_ADDRESS=0x10000
27+
# CONFIG_ESP_IMAGE0_SECONDARY_START_ADDRESS=0x60000
28+
# CONFIG_ESP_IMAGE1_PRIMARY_START_ADDRESS=0xB0000
29+
# CONFIG_ESP_IMAGE1_SECONDARY_START_ADDRESS=0x100000
30+
# CONFIG_ESP_SCRATCH_OFFSET=0x150000
31+
# CONFIG_ESP_SCRATCH_SIZE=0x40000
32+
1333
# CONFIG_ESP_SIGN_EC256=y
1434
# CONFIG_ESP_SIGN_ED25519=n
1535
# CONFIG_ESP_SIGN_RSA=n

‎boot/espressif/hal/CMakeLists.txt

+1
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ set(hal_srcs
5656
${src_dir}/flash_encrypt.c
5757
${src_dir}/${MCUBOOT_TARGET}/bootloader_init.c
5858
${esp_idf_dir}/components/hal/mpu_hal.c
59+
${esp_idf_dir}/components/hal/soc_hal.c
5960
${esp_idf_dir}/components/bootloader_support/src/bootloader_common_loader.c
6061
${esp_idf_dir}/components/bootloader_support/src/bootloader_console_loader.c
6162
${esp_idf_dir}/components/bootloader_support/src/bootloader_flash.c

‎boot/espressif/hal/include/app_cpu_start.h

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
/*
2+
* Copyright (c) 2022 Espressif Systems (Shanghai) Co., Ltd.
3+
*
4+
* SPDX-License-Identifier: Apache-2.0
5+
*/
6+
7+
#pragma once
8+
9+
#include <stdint.h>
10+
11+
void appcpu_start(uint32_t entry_addr);

‎boot/espressif/hal/include/esp32/esp32.cmake

+6
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@ list(APPEND hal_srcs
1010
${esp_idf_dir}/components/efuse/src/esp_efuse_api_key_esp32.c
1111
)
1212

13+
if (DEFINED CONFIG_ESP_MULTI_PROCESSOR_BOOT)
14+
list(APPEND hal_srcs
15+
${src_dir}/${MCUBOOT_TARGET}/app_cpu_start.c
16+
)
17+
endif()
18+
1319
list(APPEND LINKER_SCRIPTS
1420
-T${esp_idf_dir}/components/esp_rom/${MCUBOOT_TARGET}/ld/${MCUBOOT_TARGET}.rom.newlib-funcs.ld
1521
-T${esp_idf_dir}/components/esp_rom/${MCUBOOT_TARGET}/ld/${MCUBOOT_TARGET}.rom.eco3.ld

‎boot/espressif/hal/include/mcuboot_config/mcuboot_config.h

+4
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,11 @@
9898

9999
/* Default number of separately updateable images; change in case of
100100
* multiple images. */
101+
#if defined(CONFIG_ESP_IMAGE_NUMBER)
102+
#define MCUBOOT_IMAGE_NUMBER CONFIG_ESP_IMAGE_NUMBER
103+
#else
101104
#define MCUBOOT_IMAGE_NUMBER 1
105+
#endif
102106

103107
/*
104108
* Logging

‎boot/espressif/hal/src/esp32/app_cpu_start.c

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
/*
2+
* SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD
3+
*
4+
* SPDX-License-Identifier: Apache-2.0
5+
*/
6+
7+
#include "app_cpu_start.h"
8+
9+
#include "soc/dport_reg.h"
10+
#include "soc/gpio_periph.h"
11+
#include "soc/rtc_periph.h"
12+
#include "soc/rtc_cntl_reg.h"
13+
#include "esp32/rom/cache.h"
14+
#include "esp32/rom/uart.h"
15+
#include "esp_cpu.h"
16+
#include "esp_log.h"
17+
18+
static const char *TAG = "app_cpu_start";
19+
20+
void appcpu_start(uint32_t entry_addr)
21+
{
22+
ESP_LOGI(TAG, "Starting APPCPU");
23+
24+
Cache_Flush(1);
25+
Cache_Read_Enable(1);
26+
27+
esp_cpu_unstall(1);
28+
29+
DPORT_SET_PERI_REG_MASK(DPORT_APPCPU_CTRL_B_REG, DPORT_APPCPU_CLKGATE_EN);
30+
DPORT_CLEAR_PERI_REG_MASK(DPORT_APPCPU_CTRL_C_REG, DPORT_APPCPU_RUNSTALL);
31+
DPORT_SET_PERI_REG_MASK(DPORT_APPCPU_CTRL_A_REG, DPORT_APPCPU_RESETTING);
32+
DPORT_CLEAR_PERI_REG_MASK(DPORT_APPCPU_CTRL_A_REG, DPORT_APPCPU_RESETTING);
33+
34+
ets_set_appcpu_boot_addr(entry_addr);
35+
ets_delay_us(10000);
36+
uart_tx_wait_idle(0);
37+
ESP_LOGI(TAG, "APPCPU start sequence complete");
38+
}

‎boot/espressif/hal/src/flash_encrypt.c

+40-4
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
#include "esp_efuse_table.h"
1616
#include "esp_log.h"
1717
#include "hal/wdt_hal.h"
18+
#include "soc/soc_caps.h"
1819

1920
#include "esp_mcuboot_image.h"
2021

@@ -167,6 +168,26 @@ static esp_err_t initialise_flash_encryption(void)
167168
return err;
168169
}
169170

171+
#if defined(SOC_SUPPORTS_SECURE_DL_MODE) && defined(CONFIG_SECURE_ENABLE_SECURE_ROM_DL_MODE)
172+
ESP_LOGI(TAG, "Enabling Secure Download mode...");
173+
err = esp_efuse_enable_rom_secure_download_mode();
174+
if (err != ESP_OK) {
175+
ESP_LOGE(TAG, "Could not enable Secure Download mode...");
176+
esp_efuse_batch_write_cancel();
177+
return err;
178+
}
179+
#elif CONFIG_SECURE_DISABLE_ROM_DL_MODE
180+
ESP_LOGI(TAG, "Disable ROM Download mode...");
181+
err = esp_efuse_disable_rom_download_mode();
182+
if (err != ESP_OK) {
183+
ESP_LOGE(TAG, "Could not disable ROM Download mode...");
184+
esp_efuse_batch_write_cancel();
185+
return err;
186+
}
187+
#else
188+
ESP_LOGW(TAG, "UART ROM Download mode kept enabled - SECURITY COMPROMISED");
189+
#endif
190+
170191
err = esp_efuse_batch_write_commit();
171192
if (err != ESP_OK) {
172193
ESP_LOGE(TAG, "Error programming security eFuses (err=0x%x).", err);
@@ -213,7 +234,7 @@ static esp_err_t encrypt_flash_contents(uint32_t flash_crypt_cnt, bool flash_cry
213234
* This will need changes when implementing multi-slot support
214235
*/
215236
ESP_LOGI(TAG, "Encrypting remaining flash...");
216-
uint32_t region_addr = CONFIG_ESP_APPLICATION_SECONDARY_START_ADDRESS;
237+
uint32_t region_addr = CONFIG_ESP_IMAGE0_SECONDARY_START_ADDRESS;
217238
size_t region_size = CONFIG_ESP_APPLICATION_SIZE;
218239
err = esp_flash_encrypt_region(region_addr, region_size);
219240
if (err != ESP_OK) {
@@ -226,6 +247,21 @@ static esp_err_t encrypt_flash_contents(uint32_t flash_crypt_cnt, bool flash_cry
226247
return err;
227248
}
228249

250+
#if defined(CONFIG_ESP_IMAGE_NUMBER) && (CONFIG_ESP_IMAGE_NUMBER == 2)
251+
region_addr = CONFIG_ESP_IMAGE1_PRIMARY_START_ADDRESS;
252+
region_size = CONFIG_ESP_APPLICATION_SIZE;
253+
err = esp_flash_encrypt_region(region_addr, region_size);
254+
if (err != ESP_OK) {
255+
return err;
256+
}
257+
region_addr = CONFIG_ESP_IMAGE1_SECONDARY_START_ADDRESS;
258+
region_size = CONFIG_ESP_APPLICATION_SIZE;
259+
err = esp_flash_encrypt_region(region_addr, region_size);
260+
if (err != ESP_OK) {
261+
return err;
262+
}
263+
#endif
264+
229265
#ifdef CONFIG_SECURE_FLASH_ENCRYPTION_MODE_RELEASE
230266
// Go straight to max, permanently enabled
231267
ESP_LOGI(TAG, "Setting CRYPT_CNT for permanent encryption");
@@ -288,20 +324,20 @@ static esp_err_t encrypt_primary_slot(void)
288324
/* Check if the slot is plaintext or encrypted, 0x20 offset is for skipping
289325
* MCUboot header
290326
*/
291-
err = bootloader_flash_read(CONFIG_ESP_APPLICATION_PRIMARY_START_ADDRESS + 0x20,
327+
err = bootloader_flash_read(CONFIG_ESP_IMAGE0_PRIMARY_START_ADDRESS + 0x20,
292328
&img_header, sizeof(esp_image_load_header_t), true);
293329
if (err != ESP_OK) {
294330
ESP_LOGE(TAG, "Failed to read slot img header");
295331
return err;
296332
} else {
297-
err = verify_img_header(CONFIG_ESP_APPLICATION_PRIMARY_START_ADDRESS,
333+
err = verify_img_header(CONFIG_ESP_IMAGE0_PRIMARY_START_ADDRESS,
298334
&img_header, true);
299335
}
300336

301337
if (err == ESP_OK) {
302338
ESP_LOGI(TAG, "Encrypting primary slot...");
303339

304-
err = esp_flash_encrypt_region(CONFIG_ESP_APPLICATION_PRIMARY_START_ADDRESS,
340+
err = esp_flash_encrypt_region(CONFIG_ESP_IMAGE0_PRIMARY_START_ADDRESS,
305341
CONFIG_ESP_APPLICATION_SIZE);
306342
if (err != ESP_OK) {
307343
ESP_LOGE(TAG, "Failed to encrypt slot in place: 0x%x", err);

‎boot/espressif/include/esp_loader.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@
66

77
#pragma once
88

9-
void esp_app_image_load(int slot, unsigned int hdr_offset);
9+
void esp_app_image_load(int image_index, int slot, unsigned int hdr_offset, unsigned int *entry_addr);

‎boot/espressif/include/sysflash/sysflash.h

+33-8
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@
44
* SPDX-License-Identifier: Apache-2.0
55
*/
66

7+
#pragma once
8+
9+
#include <mcuboot_config/mcuboot_config.h>
10+
711
//! A user-defined identifier for different storage mediums
812
//! (i.e internal flash, external NOR flash, eMMC, etc)
913
#define FLASH_DEVICE_INTERNAL_FLASH 0
@@ -12,14 +16,35 @@
1216
//! there is not slot
1317
#define FLASH_SLOT_DOES_NOT_EXIST 255
1418

15-
//! NB: MCUboot expects this define to exist but it's only used
16-
//! if MCUBOOT_SWAP_USING_SCRATCH=1 is set
17-
#define FLASH_AREA_IMAGE_SCRATCH FLASH_SLOT_DOES_NOT_EXIST
18-
1919
//! The slot we will use to track the bootloader allocation
2020
#define FLASH_AREA_BOOTLOADER 0
2121

22-
//! A mapping to primary and secondary/upgrade slot
23-
//! given an image_index. We'll plan to use
24-
#define FLASH_AREA_IMAGE_PRIMARY(i) ((i == 0) ? 1 : 255)
25-
#define FLASH_AREA_IMAGE_SECONDARY(i) ((i == 0) ? 2 : 255)
22+
#define FLASH_AREA_IMAGE_0_PRIMARY 1
23+
#define FLASH_AREA_IMAGE_0_SECONDARY 2
24+
#define FLASH_AREA_IMAGE_SCRATCH 3
25+
#define FLASH_AREA_IMAGE_1_PRIMARY 4
26+
#define FLASH_AREA_IMAGE_1_SECONDARY 5
27+
28+
#if (MCUBOOT_IMAGE_NUMBER == 1)
29+
#define FLASH_AREA_IMAGE_PRIMARY(x) (((x) == 0) ? \
30+
FLASH_AREA_IMAGE_0_PRIMARY : \
31+
FLASH_SLOT_DOES_NOT_EXIST)
32+
#define FLASH_AREA_IMAGE_SECONDARY(x) (((x) == 0) ? \
33+
FLASH_AREA_IMAGE_0_SECONDARY : \
34+
FLASH_SLOT_DOES_NOT_EXIST)
35+
36+
#elif (MCUBOOT_IMAGE_NUMBER == 2)
37+
#define FLASH_AREA_IMAGE_PRIMARY(x) (((x) == 0) ? \
38+
FLASH_AREA_IMAGE_0_PRIMARY : \
39+
((x) == 1) ? \
40+
FLASH_AREA_IMAGE_1_PRIMARY : \
41+
FLASH_SLOT_DOES_NOT_EXIST)
42+
#define FLASH_AREA_IMAGE_SECONDARY(x) (((x) == 0) ? \
43+
FLASH_AREA_IMAGE_0_SECONDARY : \
44+
((x) == 1) ? \
45+
FLASH_AREA_IMAGE_1_SECONDARY : \
46+
FLASH_SLOT_DOES_NOT_EXIST)
47+
48+
#else
49+
#warning "Image slot and flash area mapping is not defined"
50+
#endif

0 commit comments

Comments
 (0)