blob: d8d4cff2818eaf7caaff163156ebe8a1f34d8145 [file] [log] [blame]
David Brown5153bd62017-01-06 11:16:53 -07001/*
2 * Copyright (c) 2012-2014 Wind River Systems, Inc.
Tamas Banee6615d2020-09-30 07:58:48 +01003 * Copyright (c) 2020 Arm Limited
Jamie McCraeb3e3ce32023-02-22 09:11:57 +00004 * Copyright (c) 2021-2023 Nordic Semiconductor ASA
David Brown5153bd62017-01-06 11:16:53 -07005 *
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 */
18
Marti Bolivareb940802017-05-01 23:15:29 -040019#include <assert.h>
Gerard Marull-Paretas34dd9e72022-05-09 12:13:12 +020020#include <zephyr/kernel.h>
Gerard Marull-Paretas3cd2cec2022-05-09 12:10:05 +020021#include <zephyr/devicetree.h>
22#include <zephyr/drivers/gpio.h>
23#include <zephyr/sys/__assert.h>
24#include <zephyr/drivers/flash.h>
25#include <zephyr/drivers/timer/system_timer.h>
26#include <zephyr/usb/usb_device.h>
Evan Gates4632d8d2018-06-28 13:27:40 -070027#include <soc.h>
Gerard Marull-Paretas3cd2cec2022-05-09 12:10:05 +020028#include <zephyr/linker/linker-defs.h>
David Brown5153bd62017-01-06 11:16:53 -070029
Yonatan Schachterb22eb6a2022-07-29 18:16:09 +030030#if defined(CONFIG_CPU_AARCH32_CORTEX_A) || defined(CONFIG_CPU_AARCH32_CORTEX_R)
31#include <zephyr/arch/arm/aarch32/cortex_a_r/cmsis.h>
32#elif defined(CONFIG_CPU_CORTEX_M)
33#include <zephyr/arch/arm/aarch32/cortex_m/cmsis.h>
34#endif
35
Marti Bolivar51181cf2017-03-20 11:03:41 -040036#include "target.h"
37
Marti Bolivar4a97b4c2017-01-31 18:20:02 -050038#include "bootutil/bootutil_log.h"
Ricardo Salveti3a2c1242017-01-19 10:22:35 -020039#include "bootutil/image.h"
40#include "bootutil/bootutil.h"
Tamas Banee6615d2020-09-30 07:58:48 +010041#include "bootutil/fault_injection_hardening.h"
Jamie McCrae56cb6102022-03-23 11:57:03 +000042#include "bootutil/mcuboot_status.h"
Andrzej Puzdrowskib788c712018-04-12 12:42:49 +020043#include "flash_map_backend/flash_map_backend.h"
Ricardo Salveti3a2c1242017-01-19 10:22:35 -020044
Marek Matej67693442023-01-23 17:54:36 +010045/* Check if Espressif target is supported */
46#ifdef CONFIG_SOC_FAMILY_ESP32
47
48#include <bootloader_init.h>
49#include <esp_loader.h>
50
51#define IMAGE_INDEX_0 0
52#define IMAGE_INDEX_1 1
53
54#define PRIMARY_SLOT 0
55#define SECONDARY_SLOT 1
56
57#define IMAGE0_PRIMARY_START_ADDRESS \
58 DT_PROP_BY_IDX(DT_NODE_BY_FIXED_PARTITION_LABEL(image_0), reg, 0)
59#define IMAGE0_PRIMARY_SIZE \
60 DT_PROP_BY_IDX(DT_NODE_BY_FIXED_PARTITION_LABEL(image_0), reg, 1)
61
62#define IMAGE1_PRIMARY_START_ADDRESS \
63 DT_PROP_BY_IDX(DT_NODE_BY_FIXED_PARTITION_LABEL(image_1), reg, 0)
64#define IMAGE1_PRIMARY_SIZE \
65 DT_PROP_BY_IDX(DT_NODE_BY_FIXED_PARTITION_LABEL(image_1), reg, 1)
66
67#endif /* CONFIG_SOC_FAMILY_ESP32 */
68
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +020069#ifdef CONFIG_MCUBOOT_SERIAL
Marko Kiiskila149b4572018-06-06 14:18:54 +030070#include "boot_serial/boot_serial.h"
71#include "serial_adapter/serial_adapter.h"
72
73const struct boot_uart_funcs boot_funcs = {
74 .read = console_read,
75 .write = console_write
76};
Andrzej Puzdrowski8e96b832017-09-08 16:49:14 +020077#endif
78
Jamie McCraeb3e3ce32023-02-22 09:11:57 +000079#ifdef CONFIG_BOOT_SERIAL_BOOT_MODE
80#include <zephyr/retention/bootmode.h>
81#endif
82
Josh Gao837cf882020-11-13 18:51:27 -080083#if defined(CONFIG_BOOT_USB_DFU_WAIT) || defined(CONFIG_BOOT_USB_DFU_GPIO)
Gerard Marull-Paretas3cd2cec2022-05-09 12:10:05 +020084#include <zephyr/usb/class/usb_dfu.h>
Rajavardhan Gundi51c9d702019-02-20 14:08:52 +053085#endif
86
Andrzej Puzdrowski9a605b62020-03-16 13:34:30 +010087#if CONFIG_MCUBOOT_CLEANUP_ARM_CORE
88#include <arm_cleanup.h>
89#endif
90
Jamie McCrae35941fe2023-03-28 10:04:18 +010091#ifdef CONFIG_BOOT_SERIAL_PIN_RESET
92#include <zephyr/drivers/hwinfo.h>
93#endif
94
Gerard Marull-Paretasa513b8e2021-01-26 22:50:38 +010095/* CONFIG_LOG_MINIMAL is the legacy Kconfig property,
96 * replaced by CONFIG_LOG_MODE_MINIMAL.
97 */
Dominik Ermel5b7ed6a2021-02-26 14:26:48 +000098#if (defined(CONFIG_LOG_MODE_MINIMAL) || defined(CONFIG_LOG_MINIMAL))
99#define ZEPHYR_LOG_MODE_MINIMAL 1
100#endif
Gerard Marull-Paretasa513b8e2021-01-26 22:50:38 +0100101
Marek Pietafb47d2e2022-03-11 14:24:07 +0100102/* CONFIG_LOG_IMMEDIATE is the legacy Kconfig property,
103 * replaced by CONFIG_LOG_MODE_IMMEDIATE.
104 */
105#if (defined(CONFIG_LOG_MODE_IMMEDIATE) || defined(CONFIG_LOG_IMMEDIATE))
106#define ZEPHYR_LOG_MODE_IMMEDIATE 1
107#endif
108
109#if defined(CONFIG_LOG) && !defined(ZEPHYR_LOG_MODE_IMMEDIATE) && \
Dominik Ermel5b7ed6a2021-02-26 14:26:48 +0000110 !defined(ZEPHYR_LOG_MODE_MINIMAL)
Andrzej Puzdrowski3f092bd2020-02-17 13:25:32 +0100111#ifdef CONFIG_LOG_PROCESS_THREAD
112#warning "The log internal thread for log processing can't transfer the log"\
113 "well for MCUBoot."
114#else
Gerard Marull-Paretas3cd2cec2022-05-09 12:10:05 +0200115#include <zephyr/logging/log_ctrl.h>
Andrzej Puzdrowski3f092bd2020-02-17 13:25:32 +0100116
Krzysztof Chruscinski821214e2020-03-24 07:50:32 +0100117#define BOOT_LOG_PROCESSING_INTERVAL K_MSEC(30) /* [ms] */
Andrzej Puzdrowski3f092bd2020-02-17 13:25:32 +0100118
119/* log are processing in custom routine */
Andrzej Puzdrowskiaf148532020-02-25 12:51:26 +0100120K_THREAD_STACK_DEFINE(boot_log_stack, CONFIG_MCUBOOT_LOG_THREAD_STACK_SIZE);
Andrzej Puzdrowski3f092bd2020-02-17 13:25:32 +0100121struct k_thread boot_log_thread;
Andrzej Puzdrowski84591632020-02-24 11:50:19 +0100122volatile bool boot_log_stop = false;
123K_SEM_DEFINE(boot_log_sem, 1, 1);
Andrzej Puzdrowski3f092bd2020-02-17 13:25:32 +0100124
125/* log processing need to be initalized by the application */
126#define ZEPHYR_BOOT_LOG_START() zephyr_boot_log_start()
Andrzej Puzdrowski84591632020-02-24 11:50:19 +0100127#define ZEPHYR_BOOT_LOG_STOP() zephyr_boot_log_stop()
Andrzej Puzdrowski3f092bd2020-02-17 13:25:32 +0100128#endif /* CONFIG_LOG_PROCESS_THREAD */
129#else
130/* synchronous log mode doesn't need to be initalized by the application */
131#define ZEPHYR_BOOT_LOG_START() do { } while (false)
Andrzej Puzdrowski84591632020-02-24 11:50:19 +0100132#define ZEPHYR_BOOT_LOG_STOP() do { } while (false)
Marek Pietafb47d2e2022-03-11 14:24:07 +0100133#endif /* defined(CONFIG_LOG) && !defined(ZEPHYR_LOG_MODE_IMMEDIATE) && \
134 * !defined(ZEPHYR_LOG_MODE_MINIMAL)
135 */
Andrzej Puzdrowski3f092bd2020-02-17 13:25:32 +0100136
Jon Helge Nistade58f9bd2019-11-25 15:59:52 +0100137#ifdef CONFIG_SOC_FAMILY_NRF
Radoslaw Koppel72006692021-12-06 16:15:21 +0100138#include <helpers/nrfx_reset_reason.h>
Jon Helge Nistade58f9bd2019-11-25 15:59:52 +0100139
140static inline bool boot_skip_serial_recovery()
141{
Radoslaw Koppel72006692021-12-06 16:15:21 +0100142 uint32_t rr = nrfx_reset_reason_get();
Jon Helge Nistade58f9bd2019-11-25 15:59:52 +0100143
Radoslaw Koppel72006692021-12-06 16:15:21 +0100144 return !(rr == 0 || (rr & NRFX_RESET_REASON_RESETPIN_MASK));
Jon Helge Nistade58f9bd2019-11-25 15:59:52 +0100145}
146#else
147static inline bool boot_skip_serial_recovery()
148{
149 return false;
150}
151#endif
152
Carlos Falgueras Garcíaa4b4b0f2021-06-22 10:00:22 +0200153BOOT_LOG_MODULE_REGISTER(mcuboot);
Emanuele Di Santo9f1933d2018-11-20 10:59:59 +0100154
Jamie McCraeb3e3ce32023-02-22 09:11:57 +0000155/* Validate serial recovery configuration */
156#ifdef CONFIG_MCUBOOT_SERIAL
157#if !defined(CONFIG_BOOT_SERIAL_ENTRANCE_GPIO) && \
158 !defined(CONFIG_BOOT_SERIAL_WAIT_FOR_DFU) && \
Jamie McCraefd79db32023-03-10 11:19:36 +0000159 !defined(CONFIG_BOOT_SERIAL_BOOT_MODE) && \
Jamie McCrae35941fe2023-03-28 10:04:18 +0100160 !defined(CONFIG_BOOT_SERIAL_NO_APPLICATION) && \
161 !defined(CONFIG_BOOT_SERIAL_PIN_RESET)
Jamie McCraeb3e3ce32023-02-22 09:11:57 +0000162#error "Serial recovery selected without an entrance mode set"
163#endif
164#endif
165
Jared Wolff8e4d7912021-01-21 19:34:05 -0500166#ifdef CONFIG_MCUBOOT_INDICATION_LED
Jared Wolff8e4d7912021-01-21 19:34:05 -0500167
168/*
169 * The led0 devicetree alias is optional. If present, we'll use it
170 * to turn on the LED whenever the button is pressed.
171 */
Andrzej Puzdrowski2f545b82022-05-26 14:28:07 +0200172#if DT_NODE_EXISTS(DT_ALIAS(mcuboot_led0))
Andrzej Puzdrowski5f317e42022-05-26 15:30:14 +0200173#define LED0_NODE DT_ALIAS(mcuboot_led0)
Andrzej Puzdrowski2f545b82022-05-26 14:28:07 +0200174#elif DT_NODE_EXISTS(DT_ALIAS(bootloader_led0))
175#warning "bootloader-led0 alias is deprecated; use mcuboot-led0 instead"
Jared Wolff8e4d7912021-01-21 19:34:05 -0500176#define LED0_NODE DT_ALIAS(bootloader_led0)
Andrzej Puzdrowski2f545b82022-05-26 14:28:07 +0200177#endif
Jared Wolff8e4d7912021-01-21 19:34:05 -0500178
179#if DT_NODE_HAS_STATUS(LED0_NODE, okay) && DT_NODE_HAS_PROP(LED0_NODE, gpios)
Andrzej Puzdrowski5f317e42022-05-26 15:30:14 +0200180static const struct gpio_dt_spec led0 = GPIO_DT_SPEC_GET(LED0_NODE, gpios);
Josh Gao837cf882020-11-13 18:51:27 -0800181#else
Jared Wolff8e4d7912021-01-21 19:34:05 -0500182/* A build error here means your board isn't set up to drive an LED. */
183#error "Unsupported board: led0 devicetree alias is not defined"
184#endif
185
Jared Wolff8e4d7912021-01-21 19:34:05 -0500186void led_init(void)
187{
Martin Jäger477ed812022-07-21 11:45:45 +0200188 if (!device_is_ready(led0.port)) {
189 BOOT_LOG_ERR("Didn't find LED device referred by the LED0_NODE\n");
190 return;
191 }
Josh Gao837cf882020-11-13 18:51:27 -0800192
Martin Jäger477ed812022-07-21 11:45:45 +0200193 gpio_pin_configure_dt(&led0, GPIO_OUTPUT);
194 gpio_pin_set_dt(&led0, 0);
Jared Wolff8e4d7912021-01-21 19:34:05 -0500195}
Andrzej Puzdrowski5f317e42022-05-26 15:30:14 +0200196#endif /* CONFIG_MCUBOOT_INDICATION_LED */
Jared Wolff8e4d7912021-01-21 19:34:05 -0500197
Andrew Boie7238f512017-03-02 13:39:06 -0800198void os_heap_init(void);
199
200#if defined(CONFIG_ARM)
Rafał Kuźniad854bb62020-06-17 15:06:47 +0200201
Rafał Kuźniad854bb62020-06-17 15:06:47 +0200202#ifdef CONFIG_SW_VECTOR_RELAY
203extern void *_vector_table_pointer;
Rafał Kuźniad854bb62020-06-17 15:06:47 +0200204#endif
205
Andrew Boie7238f512017-03-02 13:39:06 -0800206struct arm_vector_table {
David Brown0d0652a2017-04-11 17:33:30 -0600207 uint32_t msp;
208 uint32_t reset;
David Brown5153bd62017-01-06 11:16:53 -0700209};
210
Andrew Boie7238f512017-03-02 13:39:06 -0800211static void do_boot(struct boot_rsp *rsp)
212{
David Brown0d0652a2017-04-11 17:33:30 -0600213 struct arm_vector_table *vt;
Andrew Boie7238f512017-03-02 13:39:06 -0800214
David Brown0d0652a2017-04-11 17:33:30 -0600215 /* The beginning of the image is the ARM vector table, containing
216 * the initial stack pointer address and the reset vector
217 * consecutively. Manually set the stack pointer and jump into the
218 * reset vector
219 */
Daniel DeGrassee4574442022-09-01 15:47:01 -0500220#ifdef CONFIG_BOOT_RAM_LOAD
221 /* Get ram address for image */
222 vt = (struct arm_vector_table *)(rsp->br_hdr->ih_load_addr + rsp->br_hdr->ih_hdr_size);
223#else
224 uintptr_t flash_base;
225 int rc;
226
227 /* Jump to flash image */
Marti Bolivareb940802017-05-01 23:15:29 -0400228 rc = flash_device_base(rsp->br_flash_dev_id, &flash_base);
229 assert(rc == 0);
230
231 vt = (struct arm_vector_table *)(flash_base +
232 rsp->br_image_off +
David Brown0d0652a2017-04-11 17:33:30 -0600233 rsp->br_hdr->ih_hdr_size);
Daniel DeGrassee4574442022-09-01 15:47:01 -0500234#endif
Arvid Rosén9ed399c2020-08-19 08:57:11 +0200235
Joakim Andersson90b8f692022-12-21 15:52:53 +0100236 if (IS_ENABLED(CONFIG_SYSTEM_TIMER_HAS_DISABLE_SUPPORT)) {
237 sys_clock_disable();
238 }
Andrzej Puzdrowskie9c6b4d2021-12-14 14:09:02 +0100239
Johann Fischerd2e87aa2021-08-27 13:30:07 +0200240#ifdef CONFIG_USB_DEVICE_STACK
Emanuele Di Santoc4bf7802018-07-20 11:39:57 +0200241 /* Disable the USB to prevent it from firing interrupts */
242 usb_disable();
243#endif
Andrzej Puzdrowski9a605b62020-03-16 13:34:30 +0100244#if CONFIG_MCUBOOT_CLEANUP_ARM_CORE
245 cleanup_arm_nvic(); /* cleanup NVIC registers */
Ioannis Glaropoulos70af7082020-10-22 15:14:48 +0200246
Ryan McClelland179d8fa2022-05-20 23:53:35 -0700247#ifdef CONFIG_CPU_CORTEX_M_HAS_CACHE
Ioannis Glaropoulos70af7082020-10-22 15:14:48 +0200248 /* Disable instruction cache and data cache before chain-load the application */
249 SCB_DisableDCache();
250 SCB_DisableICache();
251#endif
252
Henrik Brix Andersen008f4a72020-12-08 14:40:19 +0100253#if CONFIG_CPU_HAS_ARM_MPU || CONFIG_CPU_HAS_NXP_MPU
Ioannis Glaropoulos70af7082020-10-22 15:14:48 +0200254 z_arm_clear_arm_mpu_config();
Andrzej Puzdrowski9a605b62020-03-16 13:34:30 +0100255#endif
Rafał Kuźniad854bb62020-06-17 15:06:47 +0200256
Håkon Øye Amundsen6a8dbba2020-10-01 12:52:38 +0000257#if defined(CONFIG_BUILTIN_STACK_GUARD) && \
258 defined(CONFIG_CPU_CORTEX_M_HAS_SPLIM)
259 /* Reset limit registers to avoid inflicting stack overflow on image
260 * being booted.
261 */
262 __set_PSPLIM(0);
263 __set_MSPLIM(0);
264#endif
265
Sigvart Hovland9647c462021-08-20 16:33:55 +0200266#else
267 irq_lock();
Ioannis Glaropoulos70af7082020-10-22 15:14:48 +0200268#endif /* CONFIG_MCUBOOT_CLEANUP_ARM_CORE */
269
Rafał Kuźniad854bb62020-06-17 15:06:47 +0200270#ifdef CONFIG_BOOT_INTR_VEC_RELOC
Rafał Kuźnia505c6e62020-07-17 13:18:15 +0200271#if defined(CONFIG_SW_VECTOR_RELAY)
272 _vector_table_pointer = vt;
273#ifdef CONFIG_CPU_CORTEX_M_HAS_VTOR
274 SCB->VTOR = (uint32_t)__vector_relay_table;
Rafał Kuźniad854bb62020-06-17 15:06:47 +0200275#endif
Rafał Kuźnia505c6e62020-07-17 13:18:15 +0200276#elif defined(CONFIG_CPU_CORTEX_M_HAS_VTOR)
277 SCB->VTOR = (uint32_t)vt;
278#endif /* CONFIG_SW_VECTOR_RELAY */
279#else /* CONFIG_BOOT_INTR_VEC_RELOC */
280#if defined(CONFIG_CPU_CORTEX_M_HAS_VTOR) && defined(CONFIG_SW_VECTOR_RELAY)
281 _vector_table_pointer = _vector_start;
282 SCB->VTOR = (uint32_t)__vector_relay_table;
283#endif
284#endif /* CONFIG_BOOT_INTR_VEC_RELOC */
Rafał Kuźniad854bb62020-06-17 15:06:47 +0200285
David Brown57837b92018-03-13 15:56:38 -0600286 __set_MSP(vt->msp);
Andrzej Puzdrowski9a605b62020-03-16 13:34:30 +0100287#if CONFIG_MCUBOOT_CLEANUP_ARM_CORE
288 __set_CONTROL(0x00); /* application will configures core on its own */
Andrzej Puzdrowski56c15e72020-10-29 09:16:50 +0100289 __ISB();
Andrzej Puzdrowski9a605b62020-03-16 13:34:30 +0100290#endif
David Brown0d0652a2017-04-11 17:33:30 -0600291 ((void (*)(void))vt->reset)();
Andrew Boie7238f512017-03-02 13:39:06 -0800292}
Rajavardhan Gundi40c28e32018-12-09 13:32:01 +0530293
Marek Matej67693442023-01-23 17:54:36 +0100294#elif defined(CONFIG_XTENSA) || defined(CONFIG_RISCV)
295
296#ifndef CONFIG_SOC_FAMILY_ESP32
297
Rajavardhan Gundi40c28e32018-12-09 13:32:01 +0530298#define SRAM_BASE_ADDRESS 0xBE030000
299
300static void copy_img_to_SRAM(int slot, unsigned int hdr_offset)
301{
302 const struct flash_area *fap;
303 int area_id;
304 int rc;
305 unsigned char *dst = (unsigned char *)(SRAM_BASE_ADDRESS + hdr_offset);
306
307 BOOT_LOG_INF("Copying image to SRAM");
308
309 area_id = flash_area_id_from_image_slot(slot);
310 rc = flash_area_open(area_id, &fap);
311 if (rc != 0) {
Fabio Utzigcac58f62019-09-06 08:52:35 -0300312 BOOT_LOG_ERR("flash_area_open failed with %d\n", rc);
Rajavardhan Gundi40c28e32018-12-09 13:32:01 +0530313 goto done;
314 }
315
316 rc = flash_area_read(fap, hdr_offset, dst, fap->fa_size - hdr_offset);
317 if (rc != 0) {
Fabio Utzigcac58f62019-09-06 08:52:35 -0300318 BOOT_LOG_ERR("flash_area_read failed with %d\n", rc);
Rajavardhan Gundi40c28e32018-12-09 13:32:01 +0530319 goto done;
320 }
321
322done:
323 flash_area_close(fap);
324}
Marek Matej67693442023-01-23 17:54:36 +0100325#endif /* !CONFIG_SOC_FAMILY_ESP32 */
Rajavardhan Gundi40c28e32018-12-09 13:32:01 +0530326
327/* Entry point (.ResetVector) is at the very beginning of the image.
328 * Simply copy the image to a suitable location and jump there.
329 */
330static void do_boot(struct boot_rsp *rsp)
331{
332 void *start;
333
334 BOOT_LOG_INF("br_image_off = 0x%x\n", rsp->br_image_off);
335 BOOT_LOG_INF("ih_hdr_size = 0x%x\n", rsp->br_hdr->ih_hdr_size);
336
Marek Matej67693442023-01-23 17:54:36 +0100337#ifdef CONFIG_SOC_FAMILY_ESP32
338 int slot = (rsp->br_image_off == IMAGE0_PRIMARY_START_ADDRESS) ?
339 PRIMARY_SLOT : SECONDARY_SLOT;
340 /* Load memory segments and start from entry point */
341 start_cpu0_image(IMAGE_INDEX_0, slot, rsp->br_hdr->ih_hdr_size);
342#else
Rajavardhan Gundi40c28e32018-12-09 13:32:01 +0530343 /* Copy from the flash to HP SRAM */
344 copy_img_to_SRAM(0, rsp->br_hdr->ih_hdr_size);
345
346 /* Jump to entry point */
347 start = (void *)(SRAM_BASE_ADDRESS + rsp->br_hdr->ih_hdr_size);
348 ((void (*)(void))start)();
Marek Matej67693442023-01-23 17:54:36 +0100349#endif /* CONFIG_SOC_FAMILY_ESP32 */
Rajavardhan Gundi40c28e32018-12-09 13:32:01 +0530350}
351
Andrew Boie7238f512017-03-02 13:39:06 -0800352#else
353/* Default: Assume entry point is at the very beginning of the image. Simply
354 * lock interrupts and jump there. This is the right thing to do for X86 and
355 * possibly other platforms.
356 */
357static void do_boot(struct boot_rsp *rsp)
358{
David Brown0d0652a2017-04-11 17:33:30 -0600359 void *start;
Martin Jäger477ed812022-07-21 11:45:45 +0200360
Jim Tanee1b7b92022-04-07 11:26:28 +0800361#if defined(MCUBOOT_RAM_LOAD)
362 start = (void *)(rsp->br_hdr->ih_load_addr + rsp->br_hdr->ih_hdr_size);
363#else
364 uintptr_t flash_base;
Marti Bolivareb940802017-05-01 23:15:29 -0400365 int rc;
Andrew Boie7238f512017-03-02 13:39:06 -0800366
Marti Bolivareb940802017-05-01 23:15:29 -0400367 rc = flash_device_base(rsp->br_flash_dev_id, &flash_base);
368 assert(rc == 0);
369
370 start = (void *)(flash_base + rsp->br_image_off +
371 rsp->br_hdr->ih_hdr_size);
Jim Tanee1b7b92022-04-07 11:26:28 +0800372#endif
Andrew Boie7238f512017-03-02 13:39:06 -0800373
David Brown0d0652a2017-04-11 17:33:30 -0600374 /* Lock interrupts and dive into the entry point */
375 irq_lock();
376 ((void (*)(void))start)();
Andrew Boie7238f512017-03-02 13:39:06 -0800377}
378#endif
David Brown5153bd62017-01-06 11:16:53 -0700379
Marek Pietafb47d2e2022-03-11 14:24:07 +0100380#if defined(CONFIG_LOG) && !defined(ZEPHYR_LOG_MODE_IMMEDIATE) && \
Dominik Ermel5b7ed6a2021-02-26 14:26:48 +0000381 !defined(CONFIG_LOG_PROCESS_THREAD) && !defined(ZEPHYR_LOG_MODE_MINIMAL)
Andrzej Puzdrowski3f092bd2020-02-17 13:25:32 +0100382/* The log internal thread for log processing can't transfer log well as has too
383 * low priority.
384 * Dedicated thread for log processing below uses highest application
385 * priority. This allows to transmit all logs without adding k_sleep/k_yield
386 * anywhere else int the code.
387 */
388
389/* most simple log processing theread */
390void boot_log_thread_func(void *dummy1, void *dummy2, void *dummy3)
391{
392 (void)dummy1;
393 (void)dummy2;
394 (void)dummy3;
395
Martin Jäger477ed812022-07-21 11:45:45 +0200396 log_init();
Andrzej Puzdrowski3f092bd2020-02-17 13:25:32 +0100397
Martin Jäger477ed812022-07-21 11:45:45 +0200398 while (1) {
Martin Jäger31751822022-07-21 11:49:32 +0200399#if defined(CONFIG_LOG1) || defined(CONFIG_LOG2)
400 /* support Zephyr legacy logging implementation before commit c5f2cde */
Martin Jäger477ed812022-07-21 11:45:45 +0200401 if (log_process(false) == false) {
Martin Jäger31751822022-07-21 11:49:32 +0200402#else
403 if (log_process() == false) {
404#endif
Martin Jäger477ed812022-07-21 11:45:45 +0200405 if (boot_log_stop) {
406 break;
407 }
408 k_sleep(BOOT_LOG_PROCESSING_INTERVAL);
409 }
410 }
Andrzej Puzdrowski84591632020-02-24 11:50:19 +0100411
Martin Jäger477ed812022-07-21 11:45:45 +0200412 k_sem_give(&boot_log_sem);
Andrzej Puzdrowski3f092bd2020-02-17 13:25:32 +0100413}
414
415void zephyr_boot_log_start(void)
416{
Martin Jäger477ed812022-07-21 11:45:45 +0200417 /* start logging thread */
418 k_thread_create(&boot_log_thread, boot_log_stack,
419 K_THREAD_STACK_SIZEOF(boot_log_stack),
420 boot_log_thread_func, NULL, NULL, NULL,
421 K_HIGHEST_APPLICATION_THREAD_PRIO, 0,
422 BOOT_LOG_PROCESSING_INTERVAL);
Andrzej Puzdrowski3f092bd2020-02-17 13:25:32 +0100423
Martin Jäger477ed812022-07-21 11:45:45 +0200424 k_thread_name_set(&boot_log_thread, "logging");
Andrzej Puzdrowski3f092bd2020-02-17 13:25:32 +0100425}
Andrzej Puzdrowski84591632020-02-24 11:50:19 +0100426
427void zephyr_boot_log_stop(void)
428{
429 boot_log_stop = true;
430
431 /* wait until log procesing thread expired
432 * This can be reworked using a thread_join() API once a such will be
433 * available in zephyr.
434 * see https://github.com/zephyrproject-rtos/zephyr/issues/21500
435 */
436 (void)k_sem_take(&boot_log_sem, K_FOREVER);
437}
Marek Pietafb47d2e2022-03-11 14:24:07 +0100438#endif /* defined(CONFIG_LOG) && !defined(ZEPHYR_LOG_MODE_IMMEDIATE) && \
439 * !defined(CONFIG_LOG_PROCESS_THREAD) && !defined(ZEPHYR_LOG_MODE_MINIMAL)
440 */
Andrzej Puzdrowski3f092bd2020-02-17 13:25:32 +0100441
Jamie McCraeb3e3ce32023-02-22 09:11:57 +0000442#if defined(CONFIG_BOOT_SERIAL_ENTRANCE_GPIO) || defined(CONFIG_BOOT_USB_DFU_GPIO)
Andrzej Puzdrowski2ab49872022-04-09 13:03:58 +0200443
444#ifdef CONFIG_MCUBOOT_SERIAL
Andrzej Puzdrowski7ed0e6d2022-04-09 13:25:35 +0200445#define BUTTON_0_DETECT_DELAY CONFIG_BOOT_SERIAL_DETECT_DELAY
446#else
447#define BUTTON_0_DETECT_DELAY CONFIG_BOOT_USB_DFU_DETECT_DELAY
448#endif
449
Andrzej Puzdrowski7ed0e6d2022-04-09 13:25:35 +0200450#define BUTTON_0_NODE DT_ALIAS(mcuboot_button0)
451
452#if DT_NODE_EXISTS(BUTTON_0_NODE) && DT_NODE_HAS_PROP(BUTTON_0_NODE, gpios)
Andrzej Puzdrowski7ed0e6d2022-04-09 13:25:35 +0200453static const struct gpio_dt_spec button0 = GPIO_DT_SPEC_GET(BUTTON_0_NODE, gpios);
Jamie McCraeb3e3ce32023-02-22 09:11:57 +0000454#else
Jamie McCrae9551b6e2023-02-28 15:47:42 +0000455#error "Serial recovery/USB DFU button must be declared in device tree as 'mcuboot_button0'"
Andrzej Puzdrowski2ab49872022-04-09 13:03:58 +0200456#endif
457
458static bool detect_pin(void)
Josh Gao837cf882020-11-13 18:51:27 -0800459{
460 int rc;
Andrzej Puzdrowski2ab49872022-04-09 13:03:58 +0200461 int pin_active;
Josh Gao837cf882020-11-13 18:51:27 -0800462
Andrzej Puzdrowski7ed0e6d2022-04-09 13:25:35 +0200463 if (!device_is_ready(button0.port)) {
464 __ASSERT(false, "GPIO device is not ready.\n");
465 return false;
466 }
Josh Gao837cf882020-11-13 18:51:27 -0800467
Andrzej Puzdrowski7ed0e6d2022-04-09 13:25:35 +0200468 rc = gpio_pin_configure_dt(&button0, GPIO_INPUT);
Josh Gao837cf882020-11-13 18:51:27 -0800469 __ASSERT(rc == 0, "Failed to initialize boot detect pin.\n");
470
Andrzej Puzdrowski7ed0e6d2022-04-09 13:25:35 +0200471 rc = gpio_pin_get_dt(&button0);
Andrzej Puzdrowski2ab49872022-04-09 13:03:58 +0200472 pin_active = rc;
Andrzej Puzdrowski8bd30812021-03-22 08:19:41 +0100473
Josh Gao837cf882020-11-13 18:51:27 -0800474 __ASSERT(rc >= 0, "Failed to read boot detect pin.\n");
475
Andrzej Puzdrowski2ab49872022-04-09 13:03:58 +0200476 if (pin_active) {
477 if (BUTTON_0_DETECT_DELAY > 0) {
Andrzej Puzdrowski9b974562021-05-17 11:37:00 +0200478#ifdef CONFIG_MULTITHREADING
Josh Gao837cf882020-11-13 18:51:27 -0800479 k_sleep(K_MSEC(50));
Andrzej Puzdrowski9b974562021-05-17 11:37:00 +0200480#else
481 k_busy_wait(50000);
482#endif
Josh Gao837cf882020-11-13 18:51:27 -0800483
484 /* Get the uptime for debounce purposes. */
485 int64_t timestamp = k_uptime_get();
486
487 for(;;) {
Andrzej Puzdrowski7ed0e6d2022-04-09 13:25:35 +0200488 rc = gpio_pin_get_dt(&button0);
Andrzej Puzdrowski2ab49872022-04-09 13:03:58 +0200489 pin_active = rc;
Josh Gao837cf882020-11-13 18:51:27 -0800490 __ASSERT(rc >= 0, "Failed to read boot detect pin.\n");
491
492 /* Get delta from when this started */
493 uint32_t delta = k_uptime_get() - timestamp;
494
495 /* If not pressed OR if pressed > debounce period, stop. */
Andrzej Puzdrowski2ab49872022-04-09 13:03:58 +0200496 if (delta >= BUTTON_0_DETECT_DELAY || !pin_active) {
Josh Gao837cf882020-11-13 18:51:27 -0800497 break;
498 }
499
500 /* Delay 1 ms */
Andrzej Puzdrowski9b974562021-05-17 11:37:00 +0200501#ifdef CONFIG_MULTITHREADING
Josh Gao837cf882020-11-13 18:51:27 -0800502 k_sleep(K_MSEC(1));
Andrzej Puzdrowski9b974562021-05-17 11:37:00 +0200503#else
504 k_busy_wait(1000);
505#endif
Josh Gao837cf882020-11-13 18:51:27 -0800506 }
507 }
508 }
509
Andrzej Puzdrowski2ab49872022-04-09 13:03:58 +0200510 return (bool)pin_active;
Josh Gao837cf882020-11-13 18:51:27 -0800511}
512#endif
513
Jamie McCrae6902abb2023-04-04 13:50:43 +0100514#ifdef CONFIG_MCUBOOT_SERIAL
515static void boot_serial_enter()
516{
517 int rc;
518
519#ifdef CONFIG_MCUBOOT_INDICATION_LED
520 gpio_pin_set_dt(&led0, 1);
521#endif
522
523 mcuboot_status_change(MCUBOOT_STATUS_SERIAL_DFU_ENTERED);
524
525 BOOT_LOG_INF("Enter the serial recovery mode");
526 rc = boot_console_init();
527 __ASSERT(rc == 0, "Error initializing boot console.\n");
528 boot_serial_start(&boot_funcs);
529 __ASSERT(0, "Bootloader serial process was terminated unexpectedly.\n");
530}
531#endif
532
Keith Packardec2ac822023-04-27 09:56:10 -0700533int main(void)
David Brown5153bd62017-01-06 11:16:53 -0700534{
David Brown0d0652a2017-04-11 17:33:30 -0600535 struct boot_rsp rsp;
536 int rc;
Michael Grand5047f032022-11-24 16:49:56 +0100537 FIH_DECLARE(fih_rc, FIH_FAILURE);
David Brown5153bd62017-01-06 11:16:53 -0700538
Jamie McCraeb3e3ce32023-02-22 09:11:57 +0000539#ifdef CONFIG_BOOT_SERIAL_BOOT_MODE
540 int32_t boot_mode;
541#endif
542
Jamie McCrae35941fe2023-03-28 10:04:18 +0100543#ifdef CONFIG_BOOT_SERIAL_PIN_RESET
544 uint32_t reset_cause;
545#endif
546
Jeppe Odgaard4420bb62023-04-11 09:43:10 +0200547 MCUBOOT_WATCHDOG_SETUP();
Andrzej Puzdrowski210b3182020-10-13 13:52:15 +0200548 MCUBOOT_WATCHDOG_FEED();
549
Dominik Ermelcd07ed32021-02-17 15:18:01 +0000550#if !defined(MCUBOOT_DIRECT_XIP)
David Brown0d0652a2017-04-11 17:33:30 -0600551 BOOT_LOG_INF("Starting bootloader");
Dominik Ermelcd07ed32021-02-17 15:18:01 +0000552#else
553 BOOT_LOG_INF("Starting Direct-XIP bootloader");
554#endif
Ricardo Salveti7cf3d9e2017-01-18 16:38:22 -0200555
Jared Wolff8e4d7912021-01-21 19:34:05 -0500556#ifdef CONFIG_MCUBOOT_INDICATION_LED
557 /* LED init */
558 led_init();
559#endif
560
David Brown0d0652a2017-04-11 17:33:30 -0600561 os_heap_init();
David Brown5153bd62017-01-06 11:16:53 -0700562
Andrzej Puzdrowski3f092bd2020-02-17 13:25:32 +0100563 ZEPHYR_BOOT_LOG_START();
564
Tamas Banee6615d2020-09-30 07:58:48 +0100565 (void)rc;
566
Jamie McCrae56cb6102022-03-23 11:57:03 +0000567 mcuboot_status_change(MCUBOOT_STATUS_STARTUP);
568
Jamie McCraeb3e3ce32023-02-22 09:11:57 +0000569#ifdef CONFIG_BOOT_SERIAL_ENTRANCE_GPIO
Andrzej Puzdrowski2ab49872022-04-09 13:03:58 +0200570 if (detect_pin() &&
Josh Gao837cf882020-11-13 18:51:27 -0800571 !boot_skip_serial_recovery()) {
Jamie McCrae6902abb2023-04-04 13:50:43 +0100572 boot_serial_enter();
Josh Gao837cf882020-11-13 18:51:27 -0800573 }
574#endif
575
Jamie McCrae35941fe2023-03-28 10:04:18 +0100576#ifdef CONFIG_BOOT_SERIAL_PIN_RESET
577 rc = hwinfo_get_reset_cause(&reset_cause);
578
579 if (rc == 0 && reset_cause == RESET_PIN) {
Jamie McCrae35941fe2023-03-28 10:04:18 +0100580 (void)hwinfo_clear_reset_cause();
Jamie McCrae6902abb2023-04-04 13:50:43 +0100581 boot_serial_enter();
Jamie McCrae35941fe2023-03-28 10:04:18 +0100582 }
583#endif
584
Josh Gao837cf882020-11-13 18:51:27 -0800585#if defined(CONFIG_BOOT_USB_DFU_GPIO)
Andrzej Puzdrowski2ab49872022-04-09 13:03:58 +0200586 if (detect_pin()) {
Josh Gao837cf882020-11-13 18:51:27 -0800587#ifdef CONFIG_MCUBOOT_INDICATION_LED
Andrzej Puzdrowski5f317e42022-05-26 15:30:14 +0200588 gpio_pin_set_dt(&led0, 1);
Josh Gao837cf882020-11-13 18:51:27 -0800589#endif
Jamie McCrae56cb6102022-03-23 11:57:03 +0000590
591 mcuboot_status_change(MCUBOOT_STATUS_USB_DFU_ENTERED);
592
Josh Gao837cf882020-11-13 18:51:27 -0800593 rc = usb_enable(NULL);
594 if (rc) {
595 BOOT_LOG_ERR("Cannot enable USB");
596 } else {
597 BOOT_LOG_INF("Waiting for USB DFU");
598 wait_for_usb_dfu(K_FOREVER);
599 BOOT_LOG_INF("USB DFU wait time elapsed");
600 }
601 }
602#elif defined(CONFIG_BOOT_USB_DFU_WAIT)
Andrzej Puzdrowskiac1f1ff2020-02-05 08:40:12 +0100603 rc = usb_enable(NULL);
604 if (rc) {
605 BOOT_LOG_ERR("Cannot enable USB");
606 } else {
607 BOOT_LOG_INF("Waiting for USB DFU");
Jamie McCrae56cb6102022-03-23 11:57:03 +0000608
609 mcuboot_status_change(MCUBOOT_STATUS_USB_DFU_WAITING);
610
Josh Gao837cf882020-11-13 18:51:27 -0800611 wait_for_usb_dfu(K_MSEC(CONFIG_BOOT_USB_DFU_WAIT_DELAY_MS));
Andrzej Puzdrowskiac1f1ff2020-02-05 08:40:12 +0100612 BOOT_LOG_INF("USB DFU wait time elapsed");
Jamie McCrae56cb6102022-03-23 11:57:03 +0000613
614 mcuboot_status_change(MCUBOOT_STATUS_USB_DFU_TIMED_OUT);
Andrzej Puzdrowskiac1f1ff2020-02-05 08:40:12 +0100615 }
Rajavardhan Gundi51c9d702019-02-20 14:08:52 +0530616#endif
617
Wouter Cappellee3822f82022-01-19 15:39:43 +0100618#ifdef CONFIG_BOOT_SERIAL_WAIT_FOR_DFU
619 /* Initialize the boot console, so we can already fill up our buffers while
620 * waiting for the boot image check to finish. This image check, can take
621 * some time, so it's better to reuse thistime to already receive the
622 * initial mcumgr command(s) into our buffers
623 */
624 rc = boot_console_init();
625 int timeout_in_ms = CONFIG_BOOT_SERIAL_WAIT_FOR_DFU_TIMEOUT;
626 uint32_t start = k_uptime_get_32();
627#endif
628
Tamas Banee6615d2020-09-30 07:58:48 +0100629 FIH_CALL(boot_go, fih_rc, &rsp);
Wouter Cappellee3822f82022-01-19 15:39:43 +0100630
Jamie McCraeb3e3ce32023-02-22 09:11:57 +0000631#ifdef CONFIG_BOOT_SERIAL_BOOT_MODE
632 boot_mode = bootmode_check(BOOT_MODE_TYPE_BOOTLOADER);
633
634 if (boot_mode == 1) {
635 /* Boot mode to stay in bootloader, clear status and enter serial
636 * recovery mode
637 */
Jamie McCraeb3e3ce32023-02-22 09:11:57 +0000638 bootmode_clear();
Jamie McCrae6902abb2023-04-04 13:50:43 +0100639 boot_serial_enter();
Jamie McCraeb3e3ce32023-02-22 09:11:57 +0000640 }
641#endif
642
Wouter Cappellee3822f82022-01-19 15:39:43 +0100643#ifdef CONFIG_BOOT_SERIAL_WAIT_FOR_DFU
644 timeout_in_ms -= (k_uptime_get_32() - start);
645 if( timeout_in_ms <= 0 ) {
646 /* at least one check if time was expired */
647 timeout_in_ms = 1;
648 }
Jamie McCrae254714b2022-04-07 09:00:31 +0100649 boot_serial_check_start(&boot_funcs,timeout_in_ms);
Wouter Cappellee3822f82022-01-19 15:39:43 +0100650#endif
651
Michael Grand5047f032022-11-24 16:49:56 +0100652 if (FIH_NOT_EQ(fih_rc, FIH_SUCCESS)) {
David Brown0d0652a2017-04-11 17:33:30 -0600653 BOOT_LOG_ERR("Unable to find bootable image");
Jamie McCrae56cb6102022-03-23 11:57:03 +0000654
655 mcuboot_status_change(MCUBOOT_STATUS_NO_BOOTABLE_IMAGE_FOUND);
656
Jamie McCraefd79db32023-03-10 11:19:36 +0000657#ifdef CONFIG_BOOT_SERIAL_NO_APPLICATION
658 /* No bootable image and configuration set to remain in serial
659 * recovery mode
660 */
Jamie McCrae6902abb2023-04-04 13:50:43 +0100661 boot_serial_enter();
Jamie McCraefd79db32023-03-10 11:19:36 +0000662#endif
663
Tamas Banee6615d2020-09-30 07:58:48 +0100664 FIH_PANIC;
David Brown0d0652a2017-04-11 17:33:30 -0600665 }
David Brown5153bd62017-01-06 11:16:53 -0700666
Marti Bolivar88f48d92017-05-01 22:30:02 -0400667 BOOT_LOG_INF("Bootloader chainload address offset: 0x%x",
668 rsp.br_image_off);
Andrzej Puzdrowskib788c712018-04-12 12:42:49 +0200669
Dominik Ermelcd07ed32021-02-17 15:18:01 +0000670#if defined(MCUBOOT_DIRECT_XIP)
671 BOOT_LOG_INF("Jumping to the image slot");
672#else
David Brown0d0652a2017-04-11 17:33:30 -0600673 BOOT_LOG_INF("Jumping to the first image slot");
Dominik Ermelcd07ed32021-02-17 15:18:01 +0000674#endif
Jamie McCrae56cb6102022-03-23 11:57:03 +0000675
676 mcuboot_status_change(MCUBOOT_STATUS_BOOTABLE_IMAGE_FOUND);
677
Andrzej Puzdrowski84591632020-02-24 11:50:19 +0100678 ZEPHYR_BOOT_LOG_STOP();
David Brown0d0652a2017-04-11 17:33:30 -0600679 do_boot(&rsp);
David Brown5153bd62017-01-06 11:16:53 -0700680
Jamie McCrae56cb6102022-03-23 11:57:03 +0000681 mcuboot_status_change(MCUBOOT_STATUS_BOOT_FAILED);
682
David Brown0d0652a2017-04-11 17:33:30 -0600683 BOOT_LOG_ERR("Never should get here");
684 while (1)
685 ;
David Brown5153bd62017-01-06 11:16:53 -0700686}