blob: 2a2d14a9ab9165806ce7f34b6d93f85561fab90e [file] [log] [blame]
Christopher Collins92ea77f2016-12-12 15:59:26 -08001/*
David Brownaac71112020-02-03 16:13:42 -07002 * SPDX-License-Identifier: Apache-2.0
3 *
4 * Copyright (c) 2016-2020 Linaro LTD
5 * Copyright (c) 2016-2019 JUUL Labs
Mark Horvathccaf7f82021-01-04 18:16:42 +01006 * Copyright (c) 2019-2021 Arm Limited
David Brownaac71112020-02-03 16:13:42 -07007 *
8 * Original license:
9 *
Christopher Collins92ea77f2016-12-12 15:59:26 -080010 * Licensed to the Apache Software Foundation (ASF) under one
11 * or more contributor license agreements. See the NOTICE file
12 * distributed with this work for additional information
13 * regarding copyright ownership. The ASF licenses this file
14 * to you under the Apache License, Version 2.0 (the
15 * "License"); you may not use this file except in compliance
16 * with the License. You may obtain a copy of the License at
17 *
18 * http://www.apache.org/licenses/LICENSE-2.0
19 *
20 * Unless required by applicable law or agreed to in writing,
21 * software distributed under the License is distributed on an
22 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
23 * KIND, either express or implied. See the License for the
24 * specific language governing permissions and limitations
25 * under the License.
26 */
27
28/**
29 * This file provides an interface to the boot loader. Functions defined in
30 * this file should only be called while the boot loader is running.
31 */
32
Christopher Collins92ea77f2016-12-12 15:59:26 -080033#include <stddef.h>
David Brown52eee562017-07-05 11:25:09 -060034#include <stdbool.h>
Christopher Collins92ea77f2016-12-12 15:59:26 -080035#include <inttypes.h>
36#include <stdlib.h>
37#include <string.h>
Christopher Collins92ea77f2016-12-12 15:59:26 -080038#include <os/os_malloc.h>
39#include "bootutil/bootutil.h"
40#include "bootutil/image.h"
41#include "bootutil_priv.h"
Fabio Utzig12d59162019-11-28 10:01:59 -030042#include "swap_priv.h"
Marti Bolivarfd20c762017-02-07 16:52:50 -050043#include "bootutil/bootutil_log.h"
David Vinczec3084132020-02-18 14:50:47 +010044#include "bootutil/security_cnt.h"
David Vincze1cf11b52020-03-24 07:51:09 +010045#include "bootutil/boot_record.h"
Raef Colese8fe6cf2020-05-26 13:07:40 +010046#include "bootutil/fault_injection_hardening.h"
Mark Horvathccaf7f82021-01-04 18:16:42 +010047#include "bootutil/ramload.h"
Marti Bolivarfd20c762017-02-07 16:52:50 -050048
Fabio Utzigba829042018-09-18 08:29:34 -030049#ifdef MCUBOOT_ENC_IMAGES
50#include "bootutil/enc_key.h"
51#endif
52
Fabio Utzigba1fbe62017-07-21 14:01:20 -030053#include "mcuboot_config/mcuboot_config.h"
Fabio Utzigeed80b62017-06-10 08:03:05 -030054
Emanuele Di Santo9f1933d2018-11-20 10:59:59 +010055MCUBOOT_LOG_MODULE_DECLARE(mcuboot);
56
Marti Bolivar9b1f8bb2017-06-12 15:24:13 -040057static struct boot_loader_state boot_data;
Christopher Collins92ea77f2016-12-12 15:59:26 -080058
Fabio Utzigabec0732019-07-31 08:40:22 -030059#if (BOOT_IMAGE_NUMBER > 1)
60#define IMAGES_ITER(x) for ((x) = 0; (x) < BOOT_IMAGE_NUMBER; ++(x))
61#else
62#define IMAGES_ITER(x)
63#endif
64
Mark Horvathccaf7f82021-01-04 18:16:42 +010065#if defined(MCUBOOT_DIRECT_XIP) || defined(MCUBOOT_RAM_LOAD)
66struct slot_usage_t {
67 /* Index of the slot chosen to be loaded */
68 uint32_t active_slot;
69 bool slot_available[BOOT_NUM_SLOTS];
David Vincze1c456242021-06-29 15:25:24 +020070#if defined(MCUBOOT_RAM_LOAD)
Mark Horvathccaf7f82021-01-04 18:16:42 +010071 /* Image destination and size for the active slot */
72 uint32_t img_dst;
73 uint32_t img_sz;
David Vincze1c456242021-06-29 15:25:24 +020074#elif defined(MCUBOOT_DIRECT_XIP_REVERT)
Mark Horvathccaf7f82021-01-04 18:16:42 +010075 /* Swap status for the active slot */
Carlos Falgueras Garcíaafb424d2021-06-21 17:05:44 +020076 struct boot_swap_state swap_state;
Mark Horvathccaf7f82021-01-04 18:16:42 +010077#endif
David Vincze1c456242021-06-29 15:25:24 +020078};
79#endif /* MCUBOOT_DIRECT_XIP || MCUBOOT_RAM_LOAD */
Mark Horvathccaf7f82021-01-04 18:16:42 +010080
Fabio Utzig10ee6482019-08-01 12:04:52 -030081/*
82 * This macro allows some control on the allocation of local variables.
83 * When running natively on a target, we don't want to allocated huge
84 * variables on the stack, so make them global instead. For the simulator
85 * we want to run as many threads as there are tests, and it's safer
86 * to just make those variables stack allocated.
87 */
88#if !defined(__BOOTSIM__)
89#define TARGET_STATIC static
90#else
91#define TARGET_STATIC
92#endif
93
David Vinczee574f2d2020-07-10 11:42:03 +020094static int
95boot_read_image_headers(struct boot_loader_state *state, bool require_all,
96 struct boot_status *bs)
97{
98 int rc;
99 int i;
100
101 for (i = 0; i < BOOT_NUM_SLOTS; i++) {
102 rc = boot_read_image_header(state, i, boot_img_hdr(state, i), bs);
103 if (rc != 0) {
104 /* If `require_all` is set, fail on any single fail, otherwise
105 * if at least the first slot's header was read successfully,
106 * then the boot loader can attempt a boot.
107 *
108 * Failure to read any headers is a fatal error.
109 */
110 if (i > 0 && !require_all) {
111 return 0;
112 } else {
113 return rc;
114 }
115 }
116 }
117
118 return 0;
119}
120
Mark Horvathccaf7f82021-01-04 18:16:42 +0100121/**
122 * Saves boot status and shared data for current image.
123 *
124 * @param state Boot loader status information.
125 * @param active_slot Index of the slot will be loaded for current image.
126 *
127 * @return 0 on success; nonzero on failure.
128 */
129static int
130boot_add_shared_data(struct boot_loader_state *state,
131 uint32_t active_slot)
132{
133#if defined(MCUBOOT_MEASURED_BOOT) || defined(MCUBOOT_DATA_SHARING)
134 int rc;
135
136#ifdef MCUBOOT_MEASURED_BOOT
137 rc = boot_save_boot_status(BOOT_CURR_IMG(state),
138 boot_img_hdr(state, active_slot),
139 BOOT_IMG_AREA(state, active_slot));
140 if (rc != 0) {
141 BOOT_LOG_ERR("Failed to add image data to shared area");
142 return rc;
143 }
144#endif /* MCUBOOT_MEASURED_BOOT */
145
146#ifdef MCUBOOT_DATA_SHARING
147 rc = boot_save_shared_data(boot_img_hdr(state, active_slot),
148 BOOT_IMG_AREA(state, active_slot));
149 if (rc != 0) {
150 BOOT_LOG_ERR("Failed to add data to shared memory area.");
151 return rc;
152 }
153#endif /* MCUBOOT_DATA_SHARING */
154
155 return 0;
156
157#else /* MCUBOOT_MEASURED_BOOT || MCUBOOT_DATA_SHARING */
158 (void) (state);
159 (void) (active_slot);
160
161 return 0;
162#endif
163}
164
165/**
166 * Fills rsp to indicate how booting should occur.
167 *
168 * @param state Boot loader status information.
169 * @param slot_usage Information about the active and available slots.
170 * Only used in MCUBOOT_DIRECT_XIP and MCUBOOT_RAM_LOAD
171 * @param rsp boot_rsp struct to fill.
172 */
173static void
174fill_rsp(struct boot_loader_state *state, void *slot_usage,
175 struct boot_rsp *rsp)
176{
177 uint32_t active_slot;
178
179#if (BOOT_IMAGE_NUMBER > 1)
180 /* Always boot from Image 0. */
181 BOOT_CURR_IMG(state) = 0;
182#endif
183
184#if defined(MCUBOOT_DIRECT_XIP) || defined(MCUBOOT_RAM_LOAD)
185 active_slot = ((struct slot_usage_t *)slot_usage)[BOOT_CURR_IMG(state)].active_slot;
186#else
187 (void) (slot_usage);
188 active_slot = BOOT_PRIMARY_SLOT;
189#endif
190
191 rsp->br_flash_dev_id = BOOT_IMG_AREA(state, active_slot)->fa_device_id;
192 rsp->br_image_off = boot_img_slot_off(state, active_slot);
193 rsp->br_hdr = boot_img_hdr(state, active_slot);
194}
195
196/**
197 * Closes all flash areas.
198 *
199 * @param state Boot loader status information.
200 */
201static void
202close_all_flash_areas(struct boot_loader_state *state)
203{
204 uint32_t slot;
205
206 IMAGES_ITER(BOOT_CURR_IMG(state)) {
207#if MCUBOOT_SWAP_USING_SCRATCH
208 flash_area_close(BOOT_SCRATCH_AREA(state));
209#endif
210 for (slot = 0; slot < BOOT_NUM_SLOTS; slot++) {
211 flash_area_close(BOOT_IMG_AREA(state, BOOT_NUM_SLOTS - 1 - slot));
212 }
213 }
214}
215
Tamas Banfe031092020-09-10 17:32:39 +0200216#if !defined(MCUBOOT_DIRECT_XIP)
David Brownf5b33d82017-09-01 10:58:27 -0600217/*
218 * Compute the total size of the given image. Includes the size of
219 * the TLVs.
220 */
Tamas Banfe031092020-09-10 17:32:39 +0200221#if !defined(MCUBOOT_OVERWRITE_ONLY) || defined(MCUBOOT_OVERWRITE_ONLY_FAST)
David Brownf5b33d82017-09-01 10:58:27 -0600222static int
Fabio Utzigd638b172019-08-09 10:38:05 -0300223boot_read_image_size(struct boot_loader_state *state, int slot, uint32_t *size)
David Brownf5b33d82017-09-01 10:58:27 -0600224{
225 const struct flash_area *fap;
Fabio Utzig61fd8882019-09-14 20:00:20 -0300226 struct image_tlv_info info;
Fabio Utzig233af7d2019-08-26 12:06:16 -0300227 uint32_t off;
Fabio Utzige52c08e2019-09-11 19:32:00 -0300228 uint32_t protect_tlv_size;
David Brownf5b33d82017-09-01 10:58:27 -0600229 int area_id;
230 int rc;
231
Fabio Utzig10ee6482019-08-01 12:04:52 -0300232#if (BOOT_IMAGE_NUMBER == 1)
233 (void)state;
234#endif
235
236 area_id = flash_area_id_from_multi_image_slot(BOOT_CURR_IMG(state), slot);
David Brownf5b33d82017-09-01 10:58:27 -0600237 rc = flash_area_open(area_id, &fap);
238 if (rc != 0) {
239 rc = BOOT_EFLASH;
240 goto done;
241 }
242
Fabio Utzig61fd8882019-09-14 20:00:20 -0300243 off = BOOT_TLV_OFF(boot_img_hdr(state, slot));
244
245 if (flash_area_read(fap, off, &info, sizeof(info))) {
246 rc = BOOT_EFLASH;
David Brownf5b33d82017-09-01 10:58:27 -0600247 goto done;
248 }
Fabio Utzig61fd8882019-09-14 20:00:20 -0300249
Fabio Utzige52c08e2019-09-11 19:32:00 -0300250 protect_tlv_size = boot_img_hdr(state, slot)->ih_protect_tlv_size;
251 if (info.it_magic == IMAGE_TLV_PROT_INFO_MAGIC) {
252 if (protect_tlv_size != info.it_tlv_tot) {
253 rc = BOOT_EBADIMAGE;
254 goto done;
255 }
256
257 if (flash_area_read(fap, off + info.it_tlv_tot, &info, sizeof(info))) {
258 rc = BOOT_EFLASH;
259 goto done;
260 }
261 } else if (protect_tlv_size != 0) {
262 rc = BOOT_EBADIMAGE;
263 goto done;
264 }
265
Fabio Utzig61fd8882019-09-14 20:00:20 -0300266 if (info.it_magic != IMAGE_TLV_INFO_MAGIC) {
267 rc = BOOT_EBADIMAGE;
268 goto done;
269 }
270
Fabio Utzige52c08e2019-09-11 19:32:00 -0300271 *size = off + protect_tlv_size + info.it_tlv_tot;
David Brownf5b33d82017-09-01 10:58:27 -0600272 rc = 0;
273
274done:
275 flash_area_close(fap);
Fabio Utzig2eebf112017-09-04 15:25:08 -0300276 return rc;
David Brownf5b33d82017-09-01 10:58:27 -0600277}
Fabio Utzig36ec0e72017-09-05 08:10:33 -0300278#endif /* !MCUBOOT_OVERWRITE_ONLY */
David Brownf5b33d82017-09-01 10:58:27 -0600279
Tamas Banfe031092020-09-10 17:32:39 +0200280#if !defined(MCUBOOT_RAM_LOAD)
David Brownab449182019-11-15 09:32:52 -0700281static uint32_t
Fabio Utzig10ee6482019-08-01 12:04:52 -0300282boot_write_sz(struct boot_loader_state *state)
Christopher Collins92ea77f2016-12-12 15:59:26 -0800283{
David Brownab449182019-11-15 09:32:52 -0700284 uint32_t elem_sz;
Fabio Utzig12d59162019-11-28 10:01:59 -0300285#if MCUBOOT_SWAP_USING_SCRATCH
David Brownab449182019-11-15 09:32:52 -0700286 uint32_t align;
Fabio Utzig12d59162019-11-28 10:01:59 -0300287#endif
Christopher Collins92ea77f2016-12-12 15:59:26 -0800288
289 /* Figure out what size to write update status update as. The size depends
290 * on what the minimum write size is for scratch area, active image slot.
291 * We need to use the bigger of those 2 values.
292 */
Fabio Utzig10ee6482019-08-01 12:04:52 -0300293 elem_sz = flash_area_align(BOOT_IMG_AREA(state, BOOT_PRIMARY_SLOT));
Fabio Utzig12d59162019-11-28 10:01:59 -0300294#if MCUBOOT_SWAP_USING_SCRATCH
Fabio Utzig10ee6482019-08-01 12:04:52 -0300295 align = flash_area_align(BOOT_SCRATCH_AREA(state));
Christopher Collins92ea77f2016-12-12 15:59:26 -0800296 if (align > elem_sz) {
297 elem_sz = align;
298 }
Fabio Utzig12d59162019-11-28 10:01:59 -0300299#endif
Christopher Collins92ea77f2016-12-12 15:59:26 -0800300
301 return elem_sz;
302}
303
Fabio Utzig10ee6482019-08-01 12:04:52 -0300304static int
305boot_initialize_area(struct boot_loader_state *state, int flash_area)
306{
Dominik Ermel51c8d762021-05-24 15:34:01 +0000307 uint32_t num_sectors = BOOT_MAX_IMG_SECTORS;
308 boot_sector_t *out_sectors;
309 uint32_t *out_num_sectors;
Fabio Utzig10ee6482019-08-01 12:04:52 -0300310 int rc;
311
312 num_sectors = BOOT_MAX_IMG_SECTORS;
313
314 if (flash_area == FLASH_AREA_IMAGE_PRIMARY(BOOT_CURR_IMG(state))) {
315 out_sectors = BOOT_IMG(state, BOOT_PRIMARY_SLOT).sectors;
316 out_num_sectors = &BOOT_IMG(state, BOOT_PRIMARY_SLOT).num_sectors;
317 } else if (flash_area == FLASH_AREA_IMAGE_SECONDARY(BOOT_CURR_IMG(state))) {
318 out_sectors = BOOT_IMG(state, BOOT_SECONDARY_SLOT).sectors;
319 out_num_sectors = &BOOT_IMG(state, BOOT_SECONDARY_SLOT).num_sectors;
Fabio Utzig12d59162019-11-28 10:01:59 -0300320#if MCUBOOT_SWAP_USING_SCRATCH
Fabio Utzig10ee6482019-08-01 12:04:52 -0300321 } else if (flash_area == FLASH_AREA_IMAGE_SCRATCH) {
322 out_sectors = state->scratch.sectors;
323 out_num_sectors = &state->scratch.num_sectors;
Fabio Utzig12d59162019-11-28 10:01:59 -0300324#endif
Fabio Utzig10ee6482019-08-01 12:04:52 -0300325 } else {
326 return BOOT_EFLASH;
327 }
328
Dominik Ermel51c8d762021-05-24 15:34:01 +0000329#ifdef MCUBOOT_USE_FLASH_AREA_GET_SECTORS
Fabio Utzig10ee6482019-08-01 12:04:52 -0300330 rc = flash_area_get_sectors(flash_area, &num_sectors, out_sectors);
Dominik Ermel51c8d762021-05-24 15:34:01 +0000331#else
332 _Static_assert(sizeof(int) <= sizeof(uint32_t), "Fix needed");
333 rc = flash_area_to_sectors(flash_area, (int *)&num_sectors, out_sectors);
334#endif /* defined(MCUBOOT_USE_FLASH_AREA_GET_SECTORS) */
Fabio Utzig10ee6482019-08-01 12:04:52 -0300335 if (rc != 0) {
336 return rc;
337 }
338 *out_num_sectors = num_sectors;
339 return 0;
340}
Fabio Utzig10ee6482019-08-01 12:04:52 -0300341
Christopher Collins92ea77f2016-12-12 15:59:26 -0800342/**
343 * Determines the sector layout of both image slots and the scratch area.
344 * This information is necessary for calculating the number of bytes to erase
345 * and copy during an image swap. The information collected during this
Fabio Utzig10ee6482019-08-01 12:04:52 -0300346 * function is used to populate the state.
Christopher Collins92ea77f2016-12-12 15:59:26 -0800347 */
348static int
Fabio Utzig10ee6482019-08-01 12:04:52 -0300349boot_read_sectors(struct boot_loader_state *state)
Christopher Collins92ea77f2016-12-12 15:59:26 -0800350{
Fabio Utzigb0f04732019-07-31 09:49:19 -0300351 uint8_t image_index;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800352 int rc;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800353
Fabio Utzig10ee6482019-08-01 12:04:52 -0300354 image_index = BOOT_CURR_IMG(state);
Fabio Utzigb0f04732019-07-31 09:49:19 -0300355
356 rc = boot_initialize_area(state, FLASH_AREA_IMAGE_PRIMARY(image_index));
Christopher Collins92ea77f2016-12-12 15:59:26 -0800357 if (rc != 0) {
358 return BOOT_EFLASH;
359 }
360
Fabio Utzig10ee6482019-08-01 12:04:52 -0300361 rc = boot_initialize_area(state, FLASH_AREA_IMAGE_SECONDARY(image_index));
Christopher Collins92ea77f2016-12-12 15:59:26 -0800362 if (rc != 0) {
363 return BOOT_EFLASH;
364 }
365
Fabio Utzig12d59162019-11-28 10:01:59 -0300366#if MCUBOOT_SWAP_USING_SCRATCH
Fabio Utzig10ee6482019-08-01 12:04:52 -0300367 rc = boot_initialize_area(state, FLASH_AREA_IMAGE_SCRATCH);
Fabio Utzig2bd980a2018-11-26 10:38:17 -0200368 if (rc != 0) {
369 return BOOT_EFLASH;
370 }
Fabio Utzig12d59162019-11-28 10:01:59 -0300371#endif
Fabio Utzig2bd980a2018-11-26 10:38:17 -0200372
Fabio Utzig10ee6482019-08-01 12:04:52 -0300373 BOOT_WRITE_SZ(state) = boot_write_sz(state);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800374
375 return 0;
376}
377
Fabio Utzig12d59162019-11-28 10:01:59 -0300378void
379boot_status_reset(struct boot_status *bs)
Christopher Collins92ea77f2016-12-12 15:59:26 -0800380{
Fabio Utzig4741c452019-12-19 15:32:41 -0300381#ifdef MCUBOOT_ENC_IMAGES
382 memset(&bs->enckey, 0xff, BOOT_NUM_SLOTS * BOOT_ENC_KEY_SIZE);
383#if MCUBOOT_SWAP_SAVE_ENCTLV
384 memset(&bs->enctlv, 0xff, BOOT_NUM_SLOTS * BOOT_ENC_TLV_ALIGN_SIZE);
385#endif
386#endif /* MCUBOOT_ENC_IMAGES */
387
388 bs->use_scratch = 0;
389 bs->swap_size = 0;
390 bs->source = 0;
391
Fabio Utzig74aef312019-11-28 11:05:34 -0300392 bs->op = BOOT_STATUS_OP_MOVE;
Fabio Utzig39000012018-07-30 12:40:20 -0300393 bs->idx = BOOT_STATUS_IDX_0;
394 bs->state = BOOT_STATUS_STATE_0;
Christopher Collinsa1c12042019-05-23 14:00:28 -0700395 bs->swap_type = BOOT_SWAP_TYPE_NONE;
Fabio Utzig12d59162019-11-28 10:01:59 -0300396}
Christopher Collins92ea77f2016-12-12 15:59:26 -0800397
Fabio Utzig12d59162019-11-28 10:01:59 -0300398bool
399boot_status_is_reset(const struct boot_status *bs)
400{
Fabio Utzig74aef312019-11-28 11:05:34 -0300401 return (bs->op == BOOT_STATUS_OP_MOVE &&
402 bs->idx == BOOT_STATUS_IDX_0 &&
403 bs->state == BOOT_STATUS_STATE_0);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800404}
405
406/**
407 * Writes the supplied boot status to the flash file system. The boot status
408 * contains the current state of an in-progress image copy operation.
409 *
410 * @param bs The boot status to write.
411 *
412 * @return 0 on success; nonzero on failure.
413 */
414int
Fabio Utzig12d59162019-11-28 10:01:59 -0300415boot_write_status(const struct boot_loader_state *state, struct boot_status *bs)
Christopher Collins92ea77f2016-12-12 15:59:26 -0800416{
417 const struct flash_area *fap;
418 uint32_t off;
419 int area_id;
420 int rc;
Fabio Utziga0bc9b52017-06-28 09:19:55 -0300421 uint8_t buf[BOOT_MAX_ALIGN];
David Brown9d725462017-01-23 15:50:58 -0700422 uint8_t align;
Fabio Utzig39000012018-07-30 12:40:20 -0300423 uint8_t erased_val;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800424
Fabio Utzig7ebb7c22017-04-26 10:59:31 -0300425 /* NOTE: The first sector copied (that is the last sector on slot) contains
David Vincze2d736ad2019-02-18 11:50:22 +0100426 * the trailer. Since in the last step the primary slot is erased, the
427 * first two status writes go to the scratch which will be copied to
428 * the primary slot!
Fabio Utzig7ebb7c22017-04-26 10:59:31 -0300429 */
430
Fabio Utzig12d59162019-11-28 10:01:59 -0300431#if MCUBOOT_SWAP_USING_SCRATCH
Fabio Utzig2473ac02017-05-02 12:45:02 -0300432 if (bs->use_scratch) {
Christopher Collins92ea77f2016-12-12 15:59:26 -0800433 /* Write to scratch. */
434 area_id = FLASH_AREA_IMAGE_SCRATCH;
435 } else {
Fabio Utzig12d59162019-11-28 10:01:59 -0300436#endif
David Vincze2d736ad2019-02-18 11:50:22 +0100437 /* Write to the primary slot. */
Fabio Utzig10ee6482019-08-01 12:04:52 -0300438 area_id = FLASH_AREA_IMAGE_PRIMARY(BOOT_CURR_IMG(state));
Fabio Utzig12d59162019-11-28 10:01:59 -0300439#if MCUBOOT_SWAP_USING_SCRATCH
Christopher Collins92ea77f2016-12-12 15:59:26 -0800440 }
Fabio Utzig12d59162019-11-28 10:01:59 -0300441#endif
Christopher Collins92ea77f2016-12-12 15:59:26 -0800442
443 rc = flash_area_open(area_id, &fap);
444 if (rc != 0) {
445 rc = BOOT_EFLASH;
446 goto done;
447 }
448
449 off = boot_status_off(fap) +
Fabio Utzig12d59162019-11-28 10:01:59 -0300450 boot_status_internal_off(bs, BOOT_WRITE_SZ(state));
Andrzej Puzdrowskib788c712018-04-12 12:42:49 +0200451 align = flash_area_align(fap);
Fabio Utzig39000012018-07-30 12:40:20 -0300452 erased_val = flash_area_erased_val(fap);
453 memset(buf, erased_val, BOOT_MAX_ALIGN);
David Brown9d725462017-01-23 15:50:58 -0700454 buf[0] = bs->state;
455
456 rc = flash_area_write(fap, off, buf, align);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800457 if (rc != 0) {
458 rc = BOOT_EFLASH;
459 goto done;
460 }
461
462 rc = 0;
463
464done:
465 flash_area_close(fap);
466 return rc;
467}
Tamas Banfe031092020-09-10 17:32:39 +0200468#endif /* !MCUBOOT_RAM_LOAD */
David Vinczee574f2d2020-07-10 11:42:03 +0200469#endif /* !MCUBOOT_DIRECT_XIP */
Christopher Collins92ea77f2016-12-12 15:59:26 -0800470
471/*
David Vinczec3084132020-02-18 14:50:47 +0100472 * Validate image hash/signature and optionally the security counter in a slot.
Christopher Collins92ea77f2016-12-12 15:59:26 -0800473 */
Raef Colese8fe6cf2020-05-26 13:07:40 +0100474static fih_int
Fabio Utzig10ee6482019-08-01 12:04:52 -0300475boot_image_check(struct boot_loader_state *state, struct image_header *hdr,
476 const struct flash_area *fap, struct boot_status *bs)
Christopher Collins92ea77f2016-12-12 15:59:26 -0800477{
Fabio Utzig10ee6482019-08-01 12:04:52 -0300478 TARGET_STATIC uint8_t tmpbuf[BOOT_TMPBUF_SZ];
Fabio Utzigb0f04732019-07-31 09:49:19 -0300479 uint8_t image_index;
Fabio Utzigba829042018-09-18 08:29:34 -0300480 int rc;
Raef Colese8fe6cf2020-05-26 13:07:40 +0100481 fih_int fih_rc = FIH_FAILURE;
Fabio Utzigba829042018-09-18 08:29:34 -0300482
Fabio Utzig10ee6482019-08-01 12:04:52 -0300483#if (BOOT_IMAGE_NUMBER == 1)
484 (void)state;
485#endif
486
Fabio Utzigba829042018-09-18 08:29:34 -0300487 (void)bs;
488 (void)rc;
Fabio Utzigbc077932019-08-26 11:16:34 -0300489
490 image_index = BOOT_CURR_IMG(state);
491
492#ifdef MCUBOOT_ENC_IMAGES
493 if (MUST_DECRYPT(fap, image_index, hdr)) {
Fabio Utzig4741c452019-12-19 15:32:41 -0300494 rc = boot_enc_load(BOOT_CURR_ENC(state), image_index, hdr, fap, bs);
Fabio Utzigba829042018-09-18 08:29:34 -0300495 if (rc < 0) {
Raef Colese8fe6cf2020-05-26 13:07:40 +0100496 FIH_RET(fih_rc);
Fabio Utzigba829042018-09-18 08:29:34 -0300497 }
Fabio Utzig4741c452019-12-19 15:32:41 -0300498 if (rc == 0 && boot_enc_set_key(BOOT_CURR_ENC(state), 1, bs)) {
Raef Colese8fe6cf2020-05-26 13:07:40 +0100499 FIH_RET(fih_rc);
Fabio Utzigba829042018-09-18 08:29:34 -0300500 }
501 }
Fabio Utzigbc077932019-08-26 11:16:34 -0300502#endif
503
Raef Colese8fe6cf2020-05-26 13:07:40 +0100504 FIH_CALL(bootutil_img_validate, fih_rc, BOOT_CURR_ENC(state), image_index,
505 hdr, fap, tmpbuf, BOOT_TMPBUF_SZ, NULL, 0, NULL);
Fabio Utzig10ee6482019-08-01 12:04:52 -0300506
Raef Colese8fe6cf2020-05-26 13:07:40 +0100507 FIH_RET(fih_rc);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800508}
509
Tamas Banfe031092020-09-10 17:32:39 +0200510#if !defined(MCUBOOT_DIRECT_XIP) && !defined(MCUBOOT_RAM_LOAD)
Raef Colese8fe6cf2020-05-26 13:07:40 +0100511static fih_int
Christopher Collins92ea77f2016-12-12 15:59:26 -0800512split_image_check(struct image_header *app_hdr,
513 const struct flash_area *app_fap,
514 struct image_header *loader_hdr,
515 const struct flash_area *loader_fap)
516{
517 static void *tmpbuf;
518 uint8_t loader_hash[32];
Raef Colese8fe6cf2020-05-26 13:07:40 +0100519 fih_int fih_rc = FIH_FAILURE;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800520
521 if (!tmpbuf) {
522 tmpbuf = malloc(BOOT_TMPBUF_SZ);
523 if (!tmpbuf) {
Raef Colese8fe6cf2020-05-26 13:07:40 +0100524 goto out;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800525 }
526 }
527
Raef Colese8fe6cf2020-05-26 13:07:40 +0100528 FIH_CALL(bootutil_img_validate, fih_rc, NULL, 0, loader_hdr, loader_fap,
529 tmpbuf, BOOT_TMPBUF_SZ, NULL, 0, loader_hash);
530 if (fih_not_eq(fih_rc, FIH_SUCCESS)) {
531 FIH_RET(fih_rc);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800532 }
533
Raef Colese8fe6cf2020-05-26 13:07:40 +0100534 FIH_CALL(bootutil_img_validate, fih_rc, NULL, 0, app_hdr, app_fap,
535 tmpbuf, BOOT_TMPBUF_SZ, loader_hash, 32, NULL);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800536
Raef Colese8fe6cf2020-05-26 13:07:40 +0100537out:
538 FIH_RET(fih_rc);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800539}
Tamas Banfe031092020-09-10 17:32:39 +0200540#endif /* !MCUBOOT_DIRECT_XIP && !MCUBOOT_RAM_LOAD */
Christopher Collins92ea77f2016-12-12 15:59:26 -0800541
Fabio Utzig338a19f2018-12-03 08:37:08 -0200542/*
David Brown9bf95af2019-10-10 15:36:36 -0600543 * Check that this is a valid header. Valid means that the magic is
544 * correct, and that the sizes/offsets are "sane". Sane means that
545 * there is no overflow on the arithmetic, and that the result fits
546 * within the flash area we are in.
547 */
548static bool
549boot_is_header_valid(const struct image_header *hdr, const struct flash_area *fap)
550{
551 uint32_t size;
552
553 if (hdr->ih_magic != IMAGE_MAGIC) {
554 return false;
555 }
556
557 if (!boot_u32_safe_add(&size, hdr->ih_img_size, hdr->ih_hdr_size)) {
558 return false;
559 }
560
561 if (size >= fap->fa_size) {
562 return false;
563 }
564
565 return true;
566}
567
568/*
Fabio Utzig338a19f2018-12-03 08:37:08 -0200569 * Check that a memory area consists of a given value.
570 */
571static inline bool
572boot_data_is_set_to(uint8_t val, void *data, size_t len)
Fabio Utzig39000012018-07-30 12:40:20 -0300573{
574 uint8_t i;
Fabio Utzig338a19f2018-12-03 08:37:08 -0200575 uint8_t *p = (uint8_t *)data;
576 for (i = 0; i < len; i++) {
577 if (val != p[i]) {
578 return false;
Fabio Utzig39000012018-07-30 12:40:20 -0300579 }
580 }
Fabio Utzig338a19f2018-12-03 08:37:08 -0200581 return true;
582}
583
584static int
Fabio Utzig10ee6482019-08-01 12:04:52 -0300585boot_check_header_erased(struct boot_loader_state *state, int slot)
Fabio Utzig338a19f2018-12-03 08:37:08 -0200586{
587 const struct flash_area *fap;
588 struct image_header *hdr;
589 uint8_t erased_val;
Fabio Utzigb0f04732019-07-31 09:49:19 -0300590 int area_id;
Fabio Utzig338a19f2018-12-03 08:37:08 -0200591 int rc;
592
Fabio Utzig10ee6482019-08-01 12:04:52 -0300593 area_id = flash_area_id_from_multi_image_slot(BOOT_CURR_IMG(state), slot);
Fabio Utzigb0f04732019-07-31 09:49:19 -0300594 rc = flash_area_open(area_id, &fap);
Fabio Utzig338a19f2018-12-03 08:37:08 -0200595 if (rc != 0) {
596 return -1;
597 }
598
599 erased_val = flash_area_erased_val(fap);
600 flash_area_close(fap);
601
Fabio Utzig10ee6482019-08-01 12:04:52 -0300602 hdr = boot_img_hdr(state, slot);
Fabio Utzig338a19f2018-12-03 08:37:08 -0200603 if (!boot_data_is_set_to(erased_val, &hdr->ih_magic, sizeof(hdr->ih_magic))) {
604 return -1;
605 }
606
607 return 0;
Fabio Utzig39000012018-07-30 12:40:20 -0300608}
609
Håkon Øye Amundsen2d1bac12020-01-03 13:08:09 +0000610#if (BOOT_IMAGE_NUMBER > 1) || \
David Vinczee574f2d2020-07-10 11:42:03 +0200611 defined(MCUBOOT_DIRECT_XIP) || \
Tamas Banfe031092020-09-10 17:32:39 +0200612 defined(MCUBOOT_RAM_LOAD) || \
Håkon Øye Amundsen2d1bac12020-01-03 13:08:09 +0000613 (defined(MCUBOOT_OVERWRITE_ONLY) && defined(MCUBOOT_DOWNGRADE_PREVENTION))
614/**
David Vincze8b0b6372020-05-20 19:54:44 +0200615 * Compare image version numbers not including the build number
Håkon Øye Amundsen2d1bac12020-01-03 13:08:09 +0000616 *
David Vincze8b0b6372020-05-20 19:54:44 +0200617 * @param ver1 Pointer to the first image version to compare.
618 * @param ver2 Pointer to the second image version to compare.
Håkon Øye Amundsen2d1bac12020-01-03 13:08:09 +0000619 *
David Vincze8b0b6372020-05-20 19:54:44 +0200620 * @retval -1 If ver1 is strictly less than ver2.
621 * @retval 0 If the image version numbers are equal,
622 * (not including the build number).
623 * @retval 1 If ver1 is strictly greater than ver2.
Håkon Øye Amundsen2d1bac12020-01-03 13:08:09 +0000624 */
625static int
David Vincze8b0b6372020-05-20 19:54:44 +0200626boot_version_cmp(const struct image_version *ver1,
627 const struct image_version *ver2)
Håkon Øye Amundsen2d1bac12020-01-03 13:08:09 +0000628{
David Vincze8b0b6372020-05-20 19:54:44 +0200629 if (ver1->iv_major > ver2->iv_major) {
630 return 1;
Håkon Øye Amundsen2d1bac12020-01-03 13:08:09 +0000631 }
David Vincze8b0b6372020-05-20 19:54:44 +0200632 if (ver1->iv_major < ver2->iv_major) {
633 return -1;
Håkon Øye Amundsen2d1bac12020-01-03 13:08:09 +0000634 }
David Vincze8b0b6372020-05-20 19:54:44 +0200635 /* The major version numbers are equal, continue comparison. */
636 if (ver1->iv_minor > ver2->iv_minor) {
637 return 1;
Håkon Øye Amundsen2d1bac12020-01-03 13:08:09 +0000638 }
David Vincze8b0b6372020-05-20 19:54:44 +0200639 if (ver1->iv_minor < ver2->iv_minor) {
640 return -1;
Håkon Øye Amundsen2d1bac12020-01-03 13:08:09 +0000641 }
David Vincze8b0b6372020-05-20 19:54:44 +0200642 /* The minor version numbers are equal, continue comparison. */
643 if (ver1->iv_revision > ver2->iv_revision) {
644 return 1;
645 }
646 if (ver1->iv_revision < ver2->iv_revision) {
647 return -1;
Håkon Øye Amundsen2d1bac12020-01-03 13:08:09 +0000648 }
649
650 return 0;
651}
652#endif
653
Dominik Ermel0c8c8d52021-02-17 14:45:02 +0000654#if defined(MCUBOOT_DIRECT_XIP)
655/**
656 * Check if image in slot has been set with specific ROM address to run from
657 * and whether the slot starts at that address.
658 *
659 * @returns 0 if IMAGE_F_ROM_FIXED flag is not set;
660 * 0 if IMAGE_F_ROM_FIXED flag is set and ROM address specified in
661 * header matches the slot address;
662 * 1 if IMF_F_ROM_FIXED flag is set but ROM address specified in header
663 * does not match the slot address.
664 */
665static bool
Mark Horvathccaf7f82021-01-04 18:16:42 +0100666boot_rom_address_check(struct boot_loader_state *state,
667 struct slot_usage_t slot_usage[])
Dominik Ermel0c8c8d52021-02-17 14:45:02 +0000668{
Mark Horvathccaf7f82021-01-04 18:16:42 +0100669 uint32_t active_slot;
670 const struct image_header *hdr;
671 uint32_t f_off;
672
673 active_slot = slot_usage[BOOT_CURR_IMG(state)].active_slot;
674 hdr = boot_img_hdr(state, active_slot);
675 f_off = boot_img_slot_off(state, active_slot);
676
Dominik Ermel0c8c8d52021-02-17 14:45:02 +0000677 if (hdr->ih_flags & IMAGE_F_ROM_FIXED && hdr->ih_load_addr != f_off) {
678 BOOT_LOG_WRN("Image in %s slot at 0x%x has been built for offset 0x%x"\
Mark Horvathccaf7f82021-01-04 18:16:42 +0100679 ", skipping",
680 active_slot == 0 ? "primary" : "secondary", f_off,
Dominik Ermel0c8c8d52021-02-17 14:45:02 +0000681 hdr->ih_load_addr);
682
683 /* If there is address mismatch, the image is not bootable from this
684 * slot.
685 */
686 return 1;
687 }
688 return 0;
689}
690#endif
691
Fabio Utzigb1adb1e2019-09-11 11:42:53 -0300692/*
693 * Check that there is a valid image in a slot
694 *
695 * @returns
Raef Colese8fe6cf2020-05-26 13:07:40 +0100696 * FIH_SUCCESS if image was successfully validated
697 * 1 (or its fih_int encoded form) if no bootloable image was found
698 * FIH_FAILURE on any errors
Fabio Utzigb1adb1e2019-09-11 11:42:53 -0300699 */
Raef Colese8fe6cf2020-05-26 13:07:40 +0100700static fih_int
Fabio Utzig10ee6482019-08-01 12:04:52 -0300701boot_validate_slot(struct boot_loader_state *state, int slot,
702 struct boot_status *bs)
Christopher Collins92ea77f2016-12-12 15:59:26 -0800703{
704 const struct flash_area *fap;
Marti Bolivarf804f622017-06-12 15:41:48 -0400705 struct image_header *hdr;
Fabio Utzigb0f04732019-07-31 09:49:19 -0300706 int area_id;
Raef Colese8fe6cf2020-05-26 13:07:40 +0100707 fih_int fih_rc = FIH_FAILURE;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800708 int rc;
Fabio Utzig7ebb7c22017-04-26 10:59:31 -0300709
Fabio Utzig10ee6482019-08-01 12:04:52 -0300710 area_id = flash_area_id_from_multi_image_slot(BOOT_CURR_IMG(state), slot);
Fabio Utzigb0f04732019-07-31 09:49:19 -0300711 rc = flash_area_open(area_id, &fap);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800712 if (rc != 0) {
Raef Colese8fe6cf2020-05-26 13:07:40 +0100713 FIH_RET(fih_rc);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800714 }
715
Fabio Utzig10ee6482019-08-01 12:04:52 -0300716 hdr = boot_img_hdr(state, slot);
717 if (boot_check_header_erased(state, slot) == 0 ||
718 (hdr->ih_flags & IMAGE_F_NON_BOOTABLE)) {
Fabio Utzig260ec452020-07-09 18:40:07 -0300719
720#if defined(MCUBOOT_SWAP_USING_SCRATCH) || defined(MCUBOOT_SWAP_USING_MOVE)
721 /*
722 * This fixes an issue where an image might be erased, but a trailer
723 * be left behind. It can happen if the image is in the secondary slot
724 * and did not pass validation, in which case the whole slot is erased.
725 * If during the erase operation, a reset occurs, parts of the slot
726 * might have been erased while some did not. The concerning part is
727 * the trailer because it might disable a new image from being loaded
728 * through mcumgr; so we just get rid of the trailer here, if the header
729 * is erased.
730 */
731 if (slot != BOOT_PRIMARY_SLOT) {
732 swap_erase_trailer_sectors(state, fap);
733 }
734#endif
735
David Vincze2d736ad2019-02-18 11:50:22 +0100736 /* No bootable image in slot; continue booting from the primary slot. */
Raef Colese8fe6cf2020-05-26 13:07:40 +0100737 fih_rc = fih_int_encode(1);
Fabio Utzig338a19f2018-12-03 08:37:08 -0200738 goto out;
Fabio Utzig39000012018-07-30 12:40:20 -0300739 }
740
Håkon Øye Amundsen2d1bac12020-01-03 13:08:09 +0000741#if defined(MCUBOOT_OVERWRITE_ONLY) && defined(MCUBOOT_DOWNGRADE_PREVENTION)
742 if (slot != BOOT_PRIMARY_SLOT) {
743 /* Check if version of secondary slot is sufficient */
David Vincze8b0b6372020-05-20 19:54:44 +0200744 rc = boot_version_cmp(
745 &boot_img_hdr(state, BOOT_SECONDARY_SLOT)->ih_ver,
746 &boot_img_hdr(state, BOOT_PRIMARY_SLOT)->ih_ver);
747 if (rc < 0 && boot_check_header_erased(state, BOOT_PRIMARY_SLOT)) {
Håkon Øye Amundsen2d1bac12020-01-03 13:08:09 +0000748 BOOT_LOG_ERR("insufficient version in secondary slot");
749 flash_area_erase(fap, 0, fap->fa_size);
750 /* Image in the secondary slot does not satisfy version requirement.
751 * Erase the image and continue booting from the primary slot.
752 */
Raef Colese8fe6cf2020-05-26 13:07:40 +0100753 fih_rc = fih_int_encode(1);
Håkon Øye Amundsen2d1bac12020-01-03 13:08:09 +0000754 goto out;
755 }
756 }
757#endif
758
Raef Colese8fe6cf2020-05-26 13:07:40 +0100759 FIH_CALL(boot_image_check, fih_rc, state, hdr, fap, bs);
760 if (!boot_is_header_valid(hdr, fap) || fih_not_eq(fih_rc, FIH_SUCCESS)) {
Tamas Banfe031092020-09-10 17:32:39 +0200761 if ((slot != BOOT_PRIMARY_SLOT) || ARE_SLOTS_EQUIVALENT()) {
David Brownb38e0442017-02-24 13:57:12 -0700762 flash_area_erase(fap, 0, fap->fa_size);
David Vinczee574f2d2020-07-10 11:42:03 +0200763 /* Image is invalid, erase it to prevent further unnecessary
764 * attempts to validate and boot it.
David Brownb38e0442017-02-24 13:57:12 -0700765 */
766 }
David Brown098de832019-12-10 11:58:01 -0700767#if !defined(__BOOTSIM__)
David Vincze2d736ad2019-02-18 11:50:22 +0100768 BOOT_LOG_ERR("Image in the %s slot is not valid!",
769 (slot == BOOT_PRIMARY_SLOT) ? "primary" : "secondary");
David Brown098de832019-12-10 11:58:01 -0700770#endif
Raef Colese8fe6cf2020-05-26 13:07:40 +0100771 fih_rc = fih_int_encode(1);
Fabio Utzig338a19f2018-12-03 08:37:08 -0200772 goto out;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800773 }
774
Fabio Utzig338a19f2018-12-03 08:37:08 -0200775out:
776 flash_area_close(fap);
Raef Colese8fe6cf2020-05-26 13:07:40 +0100777
778 FIH_RET(fih_rc);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800779}
780
David Vinczec3084132020-02-18 14:50:47 +0100781#ifdef MCUBOOT_HW_ROLLBACK_PROT
782/**
783 * Updates the stored security counter value with the image's security counter
784 * value which resides in the given slot, only if it's greater than the stored
785 * value.
786 *
787 * @param image_index Index of the image to determine which security
788 * counter to update.
789 * @param slot Slot number of the image.
790 * @param hdr Pointer to the image header structure of the image
791 * that is currently stored in the given slot.
792 *
793 * @return 0 on success; nonzero on failure.
794 */
795static int
796boot_update_security_counter(uint8_t image_index, int slot,
797 struct image_header *hdr)
798{
799 const struct flash_area *fap = NULL;
800 uint32_t img_security_cnt;
801 int rc;
802
803 rc = flash_area_open(flash_area_id_from_multi_image_slot(image_index, slot),
804 &fap);
805 if (rc != 0) {
806 rc = BOOT_EFLASH;
807 goto done;
808 }
809
810 rc = bootutil_get_img_security_cnt(hdr, fap, &img_security_cnt);
811 if (rc != 0) {
812 goto done;
813 }
814
815 rc = boot_nv_security_counter_update(image_index, img_security_cnt);
816 if (rc != 0) {
817 goto done;
818 }
819
820done:
821 flash_area_close(fap);
822 return rc;
823}
824#endif /* MCUBOOT_HW_ROLLBACK_PROT */
825
Tamas Banfe031092020-09-10 17:32:39 +0200826#if !defined(MCUBOOT_DIRECT_XIP) && !defined(MCUBOOT_RAM_LOAD)
David Vinczee574f2d2020-07-10 11:42:03 +0200827/**
828 * Determines which swap operation to perform, if any. If it is determined
829 * that a swap operation is required, the image in the secondary slot is checked
830 * for validity. If the image in the secondary slot is invalid, it is erased,
831 * and a swap type of "none" is indicated.
832 *
833 * @return The type of swap to perform (BOOT_SWAP_TYPE...)
834 */
835static int
836boot_validated_swap_type(struct boot_loader_state *state,
837 struct boot_status *bs)
838{
839 int swap_type;
Raef Colese8fe6cf2020-05-26 13:07:40 +0100840 fih_int fih_rc = FIH_FAILURE;
David Vinczee574f2d2020-07-10 11:42:03 +0200841
842 swap_type = boot_swap_type_multi(BOOT_CURR_IMG(state));
843 if (BOOT_IS_UPGRADE(swap_type)) {
844 /* Boot loader wants to switch to the secondary slot.
845 * Ensure image is valid.
846 */
Raef Colese8fe6cf2020-05-26 13:07:40 +0100847 FIH_CALL(boot_validate_slot, fih_rc, state, BOOT_SECONDARY_SLOT, bs);
848 if (fih_not_eq(fih_rc, FIH_SUCCESS)) {
849 if (fih_eq(fih_rc, fih_int_encode(1))) {
850 swap_type = BOOT_SWAP_TYPE_NONE;
851 } else {
852 swap_type = BOOT_SWAP_TYPE_FAIL;
853 }
David Vinczee574f2d2020-07-10 11:42:03 +0200854 }
855 }
856
857 return swap_type;
858}
859
Christopher Collins92ea77f2016-12-12 15:59:26 -0800860/**
Christopher Collins92ea77f2016-12-12 15:59:26 -0800861 * Erases a region of flash.
862 *
Fabio Utzigba829042018-09-18 08:29:34 -0300863 * @param flash_area The flash_area containing the region to erase.
Christopher Collins92ea77f2016-12-12 15:59:26 -0800864 * @param off The offset within the flash area to start the
865 * erase.
866 * @param sz The number of bytes to erase.
867 *
868 * @return 0 on success; nonzero on failure.
869 */
Fabio Utzig12d59162019-11-28 10:01:59 -0300870int
Fabio Utzigc28005b2019-09-10 12:18:29 -0300871boot_erase_region(const struct flash_area *fap, uint32_t off, uint32_t sz)
Christopher Collins92ea77f2016-12-12 15:59:26 -0800872{
Fabio Utzigba829042018-09-18 08:29:34 -0300873 return flash_area_erase(fap, off, sz);
Christopher Collins92ea77f2016-12-12 15:59:26 -0800874}
875
876/**
877 * Copies the contents of one flash region to another. You must erase the
878 * destination region prior to calling this function.
879 *
880 * @param flash_area_id_src The ID of the source flash area.
881 * @param flash_area_id_dst The ID of the destination flash area.
882 * @param off_src The offset within the source flash area to
883 * copy from.
884 * @param off_dst The offset within the destination flash area to
885 * copy to.
886 * @param sz The number of bytes to copy.
887 *
888 * @return 0 on success; nonzero on failure.
889 */
Fabio Utzig12d59162019-11-28 10:01:59 -0300890int
Fabio Utzigc28005b2019-09-10 12:18:29 -0300891boot_copy_region(struct boot_loader_state *state,
Fabio Utzig10ee6482019-08-01 12:04:52 -0300892 const struct flash_area *fap_src,
Fabio Utzigba829042018-09-18 08:29:34 -0300893 const struct flash_area *fap_dst,
Christopher Collins92ea77f2016-12-12 15:59:26 -0800894 uint32_t off_src, uint32_t off_dst, uint32_t sz)
895{
Christopher Collins92ea77f2016-12-12 15:59:26 -0800896 uint32_t bytes_copied;
897 int chunk_sz;
898 int rc;
Fabio Utzigba829042018-09-18 08:29:34 -0300899#ifdef MCUBOOT_ENC_IMAGES
900 uint32_t off;
Fabio Utziga87cc7d2019-08-26 11:21:45 -0300901 uint32_t tlv_off;
Fabio Utzigba829042018-09-18 08:29:34 -0300902 size_t blk_off;
903 struct image_header *hdr;
904 uint16_t idx;
905 uint32_t blk_sz;
Fabio Utzigb0f04732019-07-31 09:49:19 -0300906 uint8_t image_index;
Fabio Utzigba829042018-09-18 08:29:34 -0300907#endif
Christopher Collins92ea77f2016-12-12 15:59:26 -0800908
Fabio Utzig10ee6482019-08-01 12:04:52 -0300909 TARGET_STATIC uint8_t buf[1024];
910
911#if !defined(MCUBOOT_ENC_IMAGES)
912 (void)state;
913#endif
Christopher Collins92ea77f2016-12-12 15:59:26 -0800914
Christopher Collins92ea77f2016-12-12 15:59:26 -0800915 bytes_copied = 0;
916 while (bytes_copied < sz) {
917 if (sz - bytes_copied > sizeof buf) {
918 chunk_sz = sizeof buf;
919 } else {
920 chunk_sz = sz - bytes_copied;
921 }
922
923 rc = flash_area_read(fap_src, off_src + bytes_copied, buf, chunk_sz);
924 if (rc != 0) {
Fabio Utzigba829042018-09-18 08:29:34 -0300925 return BOOT_EFLASH;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800926 }
927
Fabio Utzigba829042018-09-18 08:29:34 -0300928#ifdef MCUBOOT_ENC_IMAGES
Fabio Utzig10ee6482019-08-01 12:04:52 -0300929 image_index = BOOT_CURR_IMG(state);
Fabio Utzig74aef312019-11-28 11:05:34 -0300930 if ((fap_src->fa_id == FLASH_AREA_IMAGE_SECONDARY(image_index) ||
931 fap_dst->fa_id == FLASH_AREA_IMAGE_SECONDARY(image_index)) &&
932 !(fap_src->fa_id == FLASH_AREA_IMAGE_SECONDARY(image_index) &&
933 fap_dst->fa_id == FLASH_AREA_IMAGE_SECONDARY(image_index))) {
David Vincze2d736ad2019-02-18 11:50:22 +0100934 /* assume the secondary slot as src, needs decryption */
Fabio Utzig10ee6482019-08-01 12:04:52 -0300935 hdr = boot_img_hdr(state, BOOT_SECONDARY_SLOT);
Fabio Utzig74aef312019-11-28 11:05:34 -0300936#if !defined(MCUBOOT_SWAP_USING_MOVE)
Fabio Utzigba829042018-09-18 08:29:34 -0300937 off = off_src;
Fabio Utzigb0f04732019-07-31 09:49:19 -0300938 if (fap_dst->fa_id == FLASH_AREA_IMAGE_SECONDARY(image_index)) {
David Vincze2d736ad2019-02-18 11:50:22 +0100939 /* might need encryption (metadata from the primary slot) */
Fabio Utzig10ee6482019-08-01 12:04:52 -0300940 hdr = boot_img_hdr(state, BOOT_PRIMARY_SLOT);
Fabio Utzigba829042018-09-18 08:29:34 -0300941 off = off_dst;
942 }
Fabio Utzig74aef312019-11-28 11:05:34 -0300943#else
944 off = off_dst;
945 if (fap_dst->fa_id == FLASH_AREA_IMAGE_SECONDARY(image_index)) {
946 hdr = boot_img_hdr(state, BOOT_PRIMARY_SLOT);
947 }
948#endif
Fabio Utzig2fc80df2018-12-14 06:47:38 -0200949 if (IS_ENCRYPTED(hdr)) {
Fabio Utzigba829042018-09-18 08:29:34 -0300950 blk_sz = chunk_sz;
951 idx = 0;
952 if (off + bytes_copied < hdr->ih_hdr_size) {
953 /* do not decrypt header */
954 blk_off = 0;
955 blk_sz = chunk_sz - hdr->ih_hdr_size;
956 idx = hdr->ih_hdr_size;
957 } else {
958 blk_off = ((off + bytes_copied) - hdr->ih_hdr_size) & 0xf;
959 }
Fabio Utziga87cc7d2019-08-26 11:21:45 -0300960 tlv_off = BOOT_TLV_OFF(hdr);
961 if (off + bytes_copied + chunk_sz > tlv_off) {
Fabio Utzigba829042018-09-18 08:29:34 -0300962 /* do not decrypt TLVs */
Fabio Utziga87cc7d2019-08-26 11:21:45 -0300963 if (off + bytes_copied >= tlv_off) {
Fabio Utzigba829042018-09-18 08:29:34 -0300964 blk_sz = 0;
965 } else {
Fabio Utziga87cc7d2019-08-26 11:21:45 -0300966 blk_sz = tlv_off - (off + bytes_copied);
Fabio Utzigba829042018-09-18 08:29:34 -0300967 }
968 }
Fabio Utzig1e4284b2019-08-23 11:55:27 -0300969 boot_encrypt(BOOT_CURR_ENC(state), image_index, fap_src,
Fabio Utzigb0f04732019-07-31 09:49:19 -0300970 (off + bytes_copied + idx) - hdr->ih_hdr_size, blk_sz,
971 blk_off, &buf[idx]);
Fabio Utzigba829042018-09-18 08:29:34 -0300972 }
973 }
974#endif
975
Christopher Collins92ea77f2016-12-12 15:59:26 -0800976 rc = flash_area_write(fap_dst, off_dst + bytes_copied, buf, chunk_sz);
977 if (rc != 0) {
Fabio Utzigba829042018-09-18 08:29:34 -0300978 return BOOT_EFLASH;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800979 }
980
981 bytes_copied += chunk_sz;
Fabio Utzig853657c2019-05-07 08:06:07 -0300982
983 MCUBOOT_WATCHDOG_FEED();
Christopher Collins92ea77f2016-12-12 15:59:26 -0800984 }
985
Fabio Utzigba829042018-09-18 08:29:34 -0300986 return 0;
Christopher Collins92ea77f2016-12-12 15:59:26 -0800987}
988
Christopher Collins92ea77f2016-12-12 15:59:26 -0800989/**
David Vincze2d736ad2019-02-18 11:50:22 +0100990 * Overwrite primary slot with the image contained in the secondary slot.
991 * If a prior copy operation was interrupted by a system reset, this function
992 * redos the copy.
Christopher Collins92ea77f2016-12-12 15:59:26 -0800993 *
994 * @param bs The current boot status. This function reads
995 * this struct to determine if it is resuming
996 * an interrupted swap operation. This
997 * function writes the updated status to this
998 * function on return.
999 *
1000 * @return 0 on success; nonzero on failure.
1001 */
Fabio Utzig338a19f2018-12-03 08:37:08 -02001002#if defined(MCUBOOT_OVERWRITE_ONLY) || defined(MCUBOOT_BOOTSTRAP)
David Brown17609d82017-05-05 09:41:34 -06001003static int
Fabio Utzig10ee6482019-08-01 12:04:52 -03001004boot_copy_image(struct boot_loader_state *state, struct boot_status *bs)
David Brown17609d82017-05-05 09:41:34 -06001005{
Marti Bolivard3269fd2017-06-12 16:31:12 -04001006 size_t sect_count;
1007 size_t sect;
David Brown17609d82017-05-05 09:41:34 -06001008 int rc;
Fabio Utzig13d9e352017-10-05 20:32:31 -03001009 size_t size;
Marti Bolivard3269fd2017-06-12 16:31:12 -04001010 size_t this_size;
Fabio Utzig13d9e352017-10-05 20:32:31 -03001011 size_t last_sector;
David Vincze2d736ad2019-02-18 11:50:22 +01001012 const struct flash_area *fap_primary_slot;
1013 const struct flash_area *fap_secondary_slot;
Fabio Utzigb0f04732019-07-31 09:49:19 -03001014 uint8_t image_index;
David Vincze2d736ad2019-02-18 11:50:22 +01001015
Fabio Utzigb4f88102020-10-04 10:16:24 -03001016#if defined(MCUBOOT_OVERWRITE_ONLY_FAST)
1017 uint32_t sector;
1018 uint32_t trailer_sz;
1019 uint32_t off;
1020 uint32_t sz;
1021#endif
1022
Fabio Utzigaaf767c2017-12-05 10:22:46 -02001023 (void)bs;
1024
Fabio Utzig13d9e352017-10-05 20:32:31 -03001025#if defined(MCUBOOT_OVERWRITE_ONLY_FAST)
1026 uint32_t src_size = 0;
Fabio Utzigd638b172019-08-09 10:38:05 -03001027 rc = boot_read_image_size(state, BOOT_SECONDARY_SLOT, &src_size);
Fabio Utzig13d9e352017-10-05 20:32:31 -03001028 assert(rc == 0);
1029#endif
David Brown17609d82017-05-05 09:41:34 -06001030
David Vincze2d736ad2019-02-18 11:50:22 +01001031 BOOT_LOG_INF("Image upgrade secondary slot -> primary slot");
1032 BOOT_LOG_INF("Erasing the primary slot");
David Brown17609d82017-05-05 09:41:34 -06001033
Fabio Utzigb0f04732019-07-31 09:49:19 -03001034 image_index = BOOT_CURR_IMG(state);
1035
1036 rc = flash_area_open(FLASH_AREA_IMAGE_PRIMARY(image_index),
1037 &fap_primary_slot);
Fabio Utzigba829042018-09-18 08:29:34 -03001038 assert (rc == 0);
1039
Fabio Utzigb0f04732019-07-31 09:49:19 -03001040 rc = flash_area_open(FLASH_AREA_IMAGE_SECONDARY(image_index),
1041 &fap_secondary_slot);
Fabio Utzigba829042018-09-18 08:29:34 -03001042 assert (rc == 0);
1043
Fabio Utzig10ee6482019-08-01 12:04:52 -03001044 sect_count = boot_img_num_sectors(state, BOOT_PRIMARY_SLOT);
Fabio Utzig13d9e352017-10-05 20:32:31 -03001045 for (sect = 0, size = 0; sect < sect_count; sect++) {
Fabio Utzig10ee6482019-08-01 12:04:52 -03001046 this_size = boot_img_sector_size(state, BOOT_PRIMARY_SLOT, sect);
Fabio Utzigc28005b2019-09-10 12:18:29 -03001047 rc = boot_erase_region(fap_primary_slot, size, this_size);
David Brown17609d82017-05-05 09:41:34 -06001048 assert(rc == 0);
1049
Fabio Utzig13d9e352017-10-05 20:32:31 -03001050#if defined(MCUBOOT_OVERWRITE_ONLY_FAST)
Fabio Utzigb4f88102020-10-04 10:16:24 -03001051 if ((size + this_size) >= src_size) {
1052 size += src_size - size;
1053 size += BOOT_WRITE_SZ(state) - (size % BOOT_WRITE_SZ(state));
Fabio Utzig13d9e352017-10-05 20:32:31 -03001054 break;
1055 }
1056#endif
Fabio Utzigb4f88102020-10-04 10:16:24 -03001057
1058 size += this_size;
David Brown17609d82017-05-05 09:41:34 -06001059 }
1060
Fabio Utzigb4f88102020-10-04 10:16:24 -03001061#if defined(MCUBOOT_OVERWRITE_ONLY_FAST)
1062 trailer_sz = boot_trailer_sz(BOOT_WRITE_SZ(state));
1063 sector = boot_img_num_sectors(state, BOOT_PRIMARY_SLOT) - 1;
1064 sz = 0;
1065 do {
1066 sz += boot_img_sector_size(state, BOOT_PRIMARY_SLOT, sector);
1067 off = boot_img_sector_off(state, BOOT_PRIMARY_SLOT, sector);
1068 sector--;
1069 } while (sz < trailer_sz);
1070
1071 rc = boot_erase_region(fap_primary_slot, off, sz);
1072 assert(rc == 0);
1073#endif
1074
Fabio Utzigba829042018-09-18 08:29:34 -03001075#ifdef MCUBOOT_ENC_IMAGES
Fabio Utzig10ee6482019-08-01 12:04:52 -03001076 if (IS_ENCRYPTED(boot_img_hdr(state, BOOT_SECONDARY_SLOT))) {
Fabio Utzig1e4284b2019-08-23 11:55:27 -03001077 rc = boot_enc_load(BOOT_CURR_ENC(state), image_index,
Fabio Utzig10ee6482019-08-01 12:04:52 -03001078 boot_img_hdr(state, BOOT_SECONDARY_SLOT),
Fabio Utzig4741c452019-12-19 15:32:41 -03001079 fap_secondary_slot, bs);
David Vincze2d736ad2019-02-18 11:50:22 +01001080
Fabio Utzigba829042018-09-18 08:29:34 -03001081 if (rc < 0) {
1082 return BOOT_EBADIMAGE;
1083 }
Fabio Utzig4741c452019-12-19 15:32:41 -03001084 if (rc == 0 && boot_enc_set_key(BOOT_CURR_ENC(state), 1, bs)) {
Fabio Utzigba829042018-09-18 08:29:34 -03001085 return BOOT_EBADIMAGE;
1086 }
1087 }
1088#endif
1089
David Vincze2d736ad2019-02-18 11:50:22 +01001090 BOOT_LOG_INF("Copying the secondary slot to the primary slot: 0x%zx bytes",
1091 size);
Fabio Utzigc28005b2019-09-10 12:18:29 -03001092 rc = boot_copy_region(state, fap_secondary_slot, fap_primary_slot, 0, 0, size);
Fabio Utzigb4f88102020-10-04 10:16:24 -03001093 if (rc != 0) {
1094 return rc;
1095 }
1096
1097#if defined(MCUBOOT_OVERWRITE_ONLY_FAST)
1098 rc = boot_write_magic(fap_primary_slot);
1099 if (rc != 0) {
1100 return rc;
1101 }
1102#endif
David Brown17609d82017-05-05 09:41:34 -06001103
David Vinczec3084132020-02-18 14:50:47 +01001104#ifdef MCUBOOT_HW_ROLLBACK_PROT
1105 /* Update the stored security counter with the new image's security counter
1106 * value. Both slots hold the new image at this point, but the secondary
1107 * slot's image header must be passed since the image headers in the
1108 * boot_data structure have not been updated yet.
1109 */
1110 rc = boot_update_security_counter(BOOT_CURR_IMG(state), BOOT_PRIMARY_SLOT,
1111 boot_img_hdr(state, BOOT_SECONDARY_SLOT));
1112 if (rc != 0) {
1113 BOOT_LOG_ERR("Security counter update failed after image upgrade.");
1114 return rc;
1115 }
1116#endif /* MCUBOOT_HW_ROLLBACK_PROT */
1117
Fabio Utzig13d9e352017-10-05 20:32:31 -03001118 /*
1119 * Erases header and trailer. The trailer is erased because when a new
1120 * image is written without a trailer as is the case when using newt, the
1121 * trailer that was left might trigger a new upgrade.
1122 */
Christopher Collins2c88e692019-05-22 15:10:14 -07001123 BOOT_LOG_DBG("erasing secondary header");
Fabio Utzigc28005b2019-09-10 12:18:29 -03001124 rc = boot_erase_region(fap_secondary_slot,
Fabio Utzig10ee6482019-08-01 12:04:52 -03001125 boot_img_sector_off(state, BOOT_SECONDARY_SLOT, 0),
1126 boot_img_sector_size(state, BOOT_SECONDARY_SLOT, 0));
David Brown17609d82017-05-05 09:41:34 -06001127 assert(rc == 0);
Fabio Utzig10ee6482019-08-01 12:04:52 -03001128 last_sector = boot_img_num_sectors(state, BOOT_SECONDARY_SLOT) - 1;
Christopher Collins2c88e692019-05-22 15:10:14 -07001129 BOOT_LOG_DBG("erasing secondary trailer");
Fabio Utzigc28005b2019-09-10 12:18:29 -03001130 rc = boot_erase_region(fap_secondary_slot,
Fabio Utzig10ee6482019-08-01 12:04:52 -03001131 boot_img_sector_off(state, BOOT_SECONDARY_SLOT,
1132 last_sector),
1133 boot_img_sector_size(state, BOOT_SECONDARY_SLOT,
1134 last_sector));
Fabio Utzig13d9e352017-10-05 20:32:31 -03001135 assert(rc == 0);
1136
David Vincze2d736ad2019-02-18 11:50:22 +01001137 flash_area_close(fap_primary_slot);
1138 flash_area_close(fap_secondary_slot);
Fabio Utzigba829042018-09-18 08:29:34 -03001139
David Vincze2d736ad2019-02-18 11:50:22 +01001140 /* TODO: Perhaps verify the primary slot's signature again? */
David Brown17609d82017-05-05 09:41:34 -06001141
1142 return 0;
1143}
Fabio Utzig338a19f2018-12-03 08:37:08 -02001144#endif
Fabio Utzigba829042018-09-18 08:29:34 -03001145
Christopher Collinsa1c12042019-05-23 14:00:28 -07001146#if !defined(MCUBOOT_OVERWRITE_ONLY)
Fabio Utzigba829042018-09-18 08:29:34 -03001147/**
1148 * Swaps the two images in flash. If a prior copy operation was interrupted
1149 * by a system reset, this function completes that operation.
1150 *
1151 * @param bs The current boot status. This function reads
1152 * this struct to determine if it is resuming
1153 * an interrupted swap operation. This
1154 * function writes the updated status to this
1155 * function on return.
1156 *
1157 * @return 0 on success; nonzero on failure.
1158 */
Christopher Collins92ea77f2016-12-12 15:59:26 -08001159static int
Fabio Utzig10ee6482019-08-01 12:04:52 -03001160boot_swap_image(struct boot_loader_state *state, struct boot_status *bs)
Christopher Collins92ea77f2016-12-12 15:59:26 -08001161{
Fabio Utzig2473ac02017-05-02 12:45:02 -03001162 struct image_header *hdr;
Fabio Utzigba829042018-09-18 08:29:34 -03001163#ifdef MCUBOOT_ENC_IMAGES
1164 const struct flash_area *fap;
1165 uint8_t slot;
1166 uint8_t i;
Fabio Utzigba829042018-09-18 08:29:34 -03001167#endif
Fabio Utzig2473ac02017-05-02 12:45:02 -03001168 uint32_t size;
1169 uint32_t copy_size;
Fabio Utzigb0f04732019-07-31 09:49:19 -03001170 uint8_t image_index;
Fabio Utzig2473ac02017-05-02 12:45:02 -03001171 int rc;
1172
1173 /* FIXME: just do this if asked by user? */
1174
1175 size = copy_size = 0;
Fabio Utzig10ee6482019-08-01 12:04:52 -03001176 image_index = BOOT_CURR_IMG(state);
Fabio Utzig2473ac02017-05-02 12:45:02 -03001177
Fabio Utzig12d59162019-11-28 10:01:59 -03001178 if (boot_status_is_reset(bs)) {
Fabio Utzig46490722017-09-04 15:34:32 -03001179 /*
1180 * No swap ever happened, so need to find the largest image which
1181 * will be used to determine the amount of sectors to swap.
1182 */
Fabio Utzig10ee6482019-08-01 12:04:52 -03001183 hdr = boot_img_hdr(state, BOOT_PRIMARY_SLOT);
Fabio Utzig2473ac02017-05-02 12:45:02 -03001184 if (hdr->ih_magic == IMAGE_MAGIC) {
Fabio Utzigd638b172019-08-09 10:38:05 -03001185 rc = boot_read_image_size(state, BOOT_PRIMARY_SLOT, &copy_size);
David Brownf5b33d82017-09-01 10:58:27 -06001186 assert(rc == 0);
Fabio Utzig2473ac02017-05-02 12:45:02 -03001187 }
Fabio Utzig2473ac02017-05-02 12:45:02 -03001188
Fabio Utzigba829042018-09-18 08:29:34 -03001189#ifdef MCUBOOT_ENC_IMAGES
Fabio Utzig2fc80df2018-12-14 06:47:38 -02001190 if (IS_ENCRYPTED(hdr)) {
Fabio Utzig10ee6482019-08-01 12:04:52 -03001191 fap = BOOT_IMG_AREA(state, BOOT_PRIMARY_SLOT);
Fabio Utzig4741c452019-12-19 15:32:41 -03001192 rc = boot_enc_load(BOOT_CURR_ENC(state), image_index, hdr, fap, bs);
Fabio Utzigba829042018-09-18 08:29:34 -03001193 assert(rc >= 0);
1194
1195 if (rc == 0) {
Fabio Utzig4741c452019-12-19 15:32:41 -03001196 rc = boot_enc_set_key(BOOT_CURR_ENC(state), 0, bs);
Fabio Utzigba829042018-09-18 08:29:34 -03001197 assert(rc == 0);
1198 } else {
1199 rc = 0;
1200 }
1201 } else {
1202 memset(bs->enckey[0], 0xff, BOOT_ENC_KEY_SIZE);
1203 }
1204#endif
1205
Fabio Utzig10ee6482019-08-01 12:04:52 -03001206 hdr = boot_img_hdr(state, BOOT_SECONDARY_SLOT);
Fabio Utzig46490722017-09-04 15:34:32 -03001207 if (hdr->ih_magic == IMAGE_MAGIC) {
Fabio Utzigd638b172019-08-09 10:38:05 -03001208 rc = boot_read_image_size(state, BOOT_SECONDARY_SLOT, &size);
Fabio Utzig46490722017-09-04 15:34:32 -03001209 assert(rc == 0);
1210 }
1211
Fabio Utzigba829042018-09-18 08:29:34 -03001212#ifdef MCUBOOT_ENC_IMAGES
Fabio Utzig10ee6482019-08-01 12:04:52 -03001213 hdr = boot_img_hdr(state, BOOT_SECONDARY_SLOT);
Fabio Utzig2fc80df2018-12-14 06:47:38 -02001214 if (IS_ENCRYPTED(hdr)) {
Fabio Utzig10ee6482019-08-01 12:04:52 -03001215 fap = BOOT_IMG_AREA(state, BOOT_SECONDARY_SLOT);
Fabio Utzig4741c452019-12-19 15:32:41 -03001216 rc = boot_enc_load(BOOT_CURR_ENC(state), image_index, hdr, fap, bs);
Fabio Utzigba829042018-09-18 08:29:34 -03001217 assert(rc >= 0);
1218
1219 if (rc == 0) {
Fabio Utzig4741c452019-12-19 15:32:41 -03001220 rc = boot_enc_set_key(BOOT_CURR_ENC(state), 1, bs);
Fabio Utzigba829042018-09-18 08:29:34 -03001221 assert(rc == 0);
1222 } else {
1223 rc = 0;
1224 }
1225 } else {
1226 memset(bs->enckey[1], 0xff, BOOT_ENC_KEY_SIZE);
1227 }
1228#endif
1229
Fabio Utzig46490722017-09-04 15:34:32 -03001230 if (size > copy_size) {
1231 copy_size = size;
1232 }
1233
1234 bs->swap_size = copy_size;
1235 } else {
1236 /*
1237 * If a swap was under way, the swap_size should already be present
1238 * in the trailer...
1239 */
Fabio Utzigb0f04732019-07-31 09:49:19 -03001240 rc = boot_read_swap_size(image_index, &bs->swap_size);
Fabio Utzig46490722017-09-04 15:34:32 -03001241 assert(rc == 0);
1242
1243 copy_size = bs->swap_size;
Fabio Utzigba829042018-09-18 08:29:34 -03001244
1245#ifdef MCUBOOT_ENC_IMAGES
Fabio Utzig4741c452019-12-19 15:32:41 -03001246 for (slot = 0; slot < BOOT_NUM_SLOTS; slot++) {
1247 rc = boot_read_enc_key(image_index, slot, bs);
Fabio Utzigba829042018-09-18 08:29:34 -03001248 assert(rc == 0);
1249
1250 for (i = 0; i < BOOT_ENC_KEY_SIZE; i++) {
Fabio Utzig1c7d9592018-12-03 10:35:56 -02001251 if (bs->enckey[slot][i] != 0xff) {
Fabio Utzigba829042018-09-18 08:29:34 -03001252 break;
1253 }
1254 }
1255
1256 if (i != BOOT_ENC_KEY_SIZE) {
Fabio Utzig4741c452019-12-19 15:32:41 -03001257 boot_enc_set_key(BOOT_CURR_ENC(state), slot, bs);
Fabio Utzigba829042018-09-18 08:29:34 -03001258 }
1259 }
1260#endif
Fabio Utzig2473ac02017-05-02 12:45:02 -03001261 }
1262
Fabio Utzig12d59162019-11-28 10:01:59 -03001263 swap_run(state, bs, copy_size);
Christopher Collins92ea77f2016-12-12 15:59:26 -08001264
David Vincze2d736ad2019-02-18 11:50:22 +01001265#ifdef MCUBOOT_VALIDATE_PRIMARY_SLOT
Fabio Utzig12d59162019-11-28 10:01:59 -03001266 extern int boot_status_fails;
Fabio Utziga0e1cce2017-11-23 20:04:01 -02001267 if (boot_status_fails > 0) {
Christopher Collins2c88e692019-05-22 15:10:14 -07001268 BOOT_LOG_WRN("%d status write fails performing the swap",
1269 boot_status_fails);
Fabio Utziga0e1cce2017-11-23 20:04:01 -02001270 }
1271#endif
1272
Christopher Collins92ea77f2016-12-12 15:59:26 -08001273 return 0;
1274}
David Brown17609d82017-05-05 09:41:34 -06001275#endif
Christopher Collins92ea77f2016-12-12 15:59:26 -08001276
David Vinczee32483f2019-06-13 10:46:24 +02001277#if (BOOT_IMAGE_NUMBER > 1)
1278/**
1279 * Check the image dependency whether it is satisfied and modify
1280 * the swap type if necessary.
1281 *
1282 * @param dep Image dependency which has to be verified.
1283 *
1284 * @return 0 on success; nonzero on failure.
1285 */
1286static int
Fabio Utzig298913b2019-08-28 11:22:45 -03001287boot_verify_slot_dependency(struct boot_loader_state *state,
1288 struct image_dependency *dep)
David Vinczee32483f2019-06-13 10:46:24 +02001289{
1290 struct image_version *dep_version;
1291 size_t dep_slot;
1292 int rc;
David Browne6ab34c2019-09-03 12:24:21 -06001293 uint8_t swap_type;
David Vinczee32483f2019-06-13 10:46:24 +02001294
1295 /* Determine the source of the image which is the subject of
1296 * the dependency and get it's version. */
David Browne6ab34c2019-09-03 12:24:21 -06001297 swap_type = state->swap_type[dep->image_id];
Barry Solomon04075532020-03-18 09:33:32 -04001298 dep_slot = BOOT_IS_UPGRADE(swap_type) ? BOOT_SECONDARY_SLOT
1299 : BOOT_PRIMARY_SLOT;
Fabio Utzig10ee6482019-08-01 12:04:52 -03001300 dep_version = &state->imgs[dep->image_id][dep_slot].hdr.ih_ver;
David Vinczee32483f2019-06-13 10:46:24 +02001301
David Vincze8b0b6372020-05-20 19:54:44 +02001302 rc = boot_version_cmp(dep_version, &dep->image_min_version);
1303 if (rc < 0) {
David Vinczee32483f2019-06-13 10:46:24 +02001304 /* Dependency not satisfied.
1305 * Modify the swap type to decrease the version number of the image
1306 * (which will be located in the primary slot after the boot process),
1307 * consequently the number of unsatisfied dependencies will be
1308 * decreased or remain the same.
1309 */
Fabio Utzig10ee6482019-08-01 12:04:52 -03001310 switch (BOOT_SWAP_TYPE(state)) {
David Vinczee32483f2019-06-13 10:46:24 +02001311 case BOOT_SWAP_TYPE_TEST:
1312 case BOOT_SWAP_TYPE_PERM:
Fabio Utzig10ee6482019-08-01 12:04:52 -03001313 BOOT_SWAP_TYPE(state) = BOOT_SWAP_TYPE_NONE;
David Vinczee32483f2019-06-13 10:46:24 +02001314 break;
1315 case BOOT_SWAP_TYPE_NONE:
Fabio Utzig10ee6482019-08-01 12:04:52 -03001316 BOOT_SWAP_TYPE(state) = BOOT_SWAP_TYPE_REVERT;
David Vinczee32483f2019-06-13 10:46:24 +02001317 break;
1318 default:
1319 break;
1320 }
David Vincze8b0b6372020-05-20 19:54:44 +02001321 } else {
1322 /* Dependency satisfied. */
1323 rc = 0;
David Vinczee32483f2019-06-13 10:46:24 +02001324 }
1325
1326 return rc;
1327}
1328
1329/**
1330 * Read all dependency TLVs of an image from the flash and verify
1331 * one after another to see if they are all satisfied.
1332 *
1333 * @param slot Image slot number.
1334 *
1335 * @return 0 on success; nonzero on failure.
1336 */
1337static int
Fabio Utzig298913b2019-08-28 11:22:45 -03001338boot_verify_slot_dependencies(struct boot_loader_state *state, uint32_t slot)
David Vinczee32483f2019-06-13 10:46:24 +02001339{
1340 const struct flash_area *fap;
Fabio Utzig61fd8882019-09-14 20:00:20 -03001341 struct image_tlv_iter it;
David Vinczee32483f2019-06-13 10:46:24 +02001342 struct image_dependency dep;
1343 uint32_t off;
Fabio Utzig61fd8882019-09-14 20:00:20 -03001344 uint16_t len;
Fabio Utzigb0f04732019-07-31 09:49:19 -03001345 int area_id;
David Vinczee32483f2019-06-13 10:46:24 +02001346 int rc;
1347
Fabio Utzig10ee6482019-08-01 12:04:52 -03001348 area_id = flash_area_id_from_multi_image_slot(BOOT_CURR_IMG(state), slot);
Fabio Utzigb0f04732019-07-31 09:49:19 -03001349 rc = flash_area_open(area_id, &fap);
David Vinczee32483f2019-06-13 10:46:24 +02001350 if (rc != 0) {
1351 rc = BOOT_EFLASH;
1352 goto done;
1353 }
1354
Fabio Utzig61fd8882019-09-14 20:00:20 -03001355 rc = bootutil_tlv_iter_begin(&it, boot_img_hdr(state, slot), fap,
1356 IMAGE_TLV_DEPENDENCY, true);
David Vinczee32483f2019-06-13 10:46:24 +02001357 if (rc != 0) {
David Vinczee32483f2019-06-13 10:46:24 +02001358 goto done;
1359 }
1360
Fabio Utzig61fd8882019-09-14 20:00:20 -03001361 while (true) {
1362 rc = bootutil_tlv_iter_next(&it, &off, &len, NULL);
1363 if (rc < 0) {
1364 return -1;
1365 } else if (rc > 0) {
1366 rc = 0;
David Vinczee32483f2019-06-13 10:46:24 +02001367 break;
1368 }
Fabio Utzig61fd8882019-09-14 20:00:20 -03001369
1370 if (len != sizeof(dep)) {
1371 rc = BOOT_EBADIMAGE;
1372 goto done;
1373 }
1374
1375 rc = flash_area_read(fap, off, &dep, len);
1376 if (rc != 0) {
1377 rc = BOOT_EFLASH;
1378 goto done;
1379 }
1380
1381 if (dep.image_id >= BOOT_IMAGE_NUMBER) {
1382 rc = BOOT_EBADARGS;
1383 goto done;
1384 }
1385
1386 /* Verify dependency and modify the swap type if not satisfied. */
1387 rc = boot_verify_slot_dependency(state, &dep);
1388 if (rc != 0) {
1389 /* Dependency not satisfied. */
1390 goto done;
1391 }
David Vinczee32483f2019-06-13 10:46:24 +02001392 }
1393
1394done:
1395 flash_area_close(fap);
1396 return rc;
1397}
1398
1399/**
David Vinczee32483f2019-06-13 10:46:24 +02001400 * Iterate over all the images and verify whether the image dependencies in the
1401 * TLV area are all satisfied and update the related swap type if necessary.
1402 */
Fabio Utzig298913b2019-08-28 11:22:45 -03001403static int
1404boot_verify_dependencies(struct boot_loader_state *state)
David Vinczee32483f2019-06-13 10:46:24 +02001405{
Erik Johnson49063752020-02-06 09:59:31 -06001406 int rc = -1;
Fabio Utzig298913b2019-08-28 11:22:45 -03001407 uint8_t slot;
David Vinczee32483f2019-06-13 10:46:24 +02001408
Fabio Utzig10ee6482019-08-01 12:04:52 -03001409 BOOT_CURR_IMG(state) = 0;
1410 while (BOOT_CURR_IMG(state) < BOOT_IMAGE_NUMBER) {
Fabio Utzig298913b2019-08-28 11:22:45 -03001411 if (BOOT_SWAP_TYPE(state) != BOOT_SWAP_TYPE_NONE &&
1412 BOOT_SWAP_TYPE(state) != BOOT_SWAP_TYPE_FAIL) {
1413 slot = BOOT_SECONDARY_SLOT;
1414 } else {
1415 slot = BOOT_PRIMARY_SLOT;
1416 }
1417
1418 rc = boot_verify_slot_dependencies(state, slot);
Fabio Utzigabec0732019-07-31 08:40:22 -03001419 if (rc == 0) {
David Vinczee32483f2019-06-13 10:46:24 +02001420 /* All dependencies've been satisfied, continue with next image. */
Fabio Utzig10ee6482019-08-01 12:04:52 -03001421 BOOT_CURR_IMG(state)++;
David Vincze8b0b6372020-05-20 19:54:44 +02001422 } else {
Fabio Utzig298913b2019-08-28 11:22:45 -03001423 /* Cannot upgrade due to non-met dependencies, so disable all
1424 * image upgrades.
1425 */
1426 for (int idx = 0; idx < BOOT_IMAGE_NUMBER; idx++) {
1427 BOOT_CURR_IMG(state) = idx;
1428 BOOT_SWAP_TYPE(state) = BOOT_SWAP_TYPE_NONE;
1429 }
1430 break;
David Vinczee32483f2019-06-13 10:46:24 +02001431 }
1432 }
Fabio Utzig298913b2019-08-28 11:22:45 -03001433 return rc;
David Vinczee32483f2019-06-13 10:46:24 +02001434}
1435#endif /* (BOOT_IMAGE_NUMBER > 1) */
1436
Christopher Collins92ea77f2016-12-12 15:59:26 -08001437/**
David Vinczeba3bd602019-06-17 16:01:43 +02001438 * Performs a clean (not aborted) image update.
Christopher Collins0ff3c6c2016-12-21 12:04:17 -08001439 *
David Vinczeba3bd602019-06-17 16:01:43 +02001440 * @param bs The current boot status.
Christopher Collins0ff3c6c2016-12-21 12:04:17 -08001441 *
1442 * @return 0 on success; nonzero on failure.
1443 */
1444static int
Fabio Utzig10ee6482019-08-01 12:04:52 -03001445boot_perform_update(struct boot_loader_state *state, struct boot_status *bs)
Christopher Collins0ff3c6c2016-12-21 12:04:17 -08001446{
Christopher Collins0ff3c6c2016-12-21 12:04:17 -08001447 int rc;
Fabio Utzig10ee6482019-08-01 12:04:52 -03001448#ifndef MCUBOOT_OVERWRITE_ONLY
1449 uint8_t swap_type;
1450#endif
Christopher Collins0ff3c6c2016-12-21 12:04:17 -08001451
David Vinczeba3bd602019-06-17 16:01:43 +02001452 /* At this point there are no aborted swaps. */
1453#if defined(MCUBOOT_OVERWRITE_ONLY)
Fabio Utzig10ee6482019-08-01 12:04:52 -03001454 rc = boot_copy_image(state, bs);
David Vinczeba3bd602019-06-17 16:01:43 +02001455#elif defined(MCUBOOT_BOOTSTRAP)
1456 /* Check if the image update was triggered by a bad image in the
1457 * primary slot (the validity of the image in the secondary slot had
1458 * already been checked).
1459 */
Raef Colese8fe6cf2020-05-26 13:07:40 +01001460 fih_int fih_rc = FIH_FAILURE;
1461 rc = boot_check_header_erased(state, BOOT_PRIMARY_SLOT);
1462 FIH_CALL(boot_validate_slot, fih_rc, state, BOOT_PRIMARY_SLOT, bs);
1463 if (rc == 0 || fih_not_eq(fih_rc, FIH_SUCCESS)) {
Fabio Utzig10ee6482019-08-01 12:04:52 -03001464 rc = boot_copy_image(state, bs);
David Vinczeba3bd602019-06-17 16:01:43 +02001465 } else {
Fabio Utzig10ee6482019-08-01 12:04:52 -03001466 rc = boot_swap_image(state, bs);
David Vinczeba3bd602019-06-17 16:01:43 +02001467 }
1468#else
Fabio Utzig10ee6482019-08-01 12:04:52 -03001469 rc = boot_swap_image(state, bs);
David Vinczeba3bd602019-06-17 16:01:43 +02001470#endif
Fabio Utzig7ebb7c22017-04-26 10:59:31 -03001471 assert(rc == 0);
David Vinczeba3bd602019-06-17 16:01:43 +02001472
1473#ifndef MCUBOOT_OVERWRITE_ONLY
1474 /* The following state needs image_ok be explicitly set after the
1475 * swap was finished to avoid a new revert.
1476 */
Fabio Utzig10ee6482019-08-01 12:04:52 -03001477 swap_type = BOOT_SWAP_TYPE(state);
1478 if (swap_type == BOOT_SWAP_TYPE_REVERT ||
1479 swap_type == BOOT_SWAP_TYPE_PERM) {
Fabio Utzig12d59162019-11-28 10:01:59 -03001480 rc = swap_set_image_ok(BOOT_CURR_IMG(state));
David Vinczeba3bd602019-06-17 16:01:43 +02001481 if (rc != 0) {
Fabio Utzig10ee6482019-08-01 12:04:52 -03001482 BOOT_SWAP_TYPE(state) = swap_type = BOOT_SWAP_TYPE_PANIC;
David Vinczeba3bd602019-06-17 16:01:43 +02001483 }
Christopher Collins0ff3c6c2016-12-21 12:04:17 -08001484 }
1485
David Vinczec3084132020-02-18 14:50:47 +01001486#ifdef MCUBOOT_HW_ROLLBACK_PROT
1487 if (swap_type == BOOT_SWAP_TYPE_PERM) {
1488 /* Update the stored security counter with the new image's security
1489 * counter value. The primary slot holds the new image at this point,
1490 * but the secondary slot's image header must be passed since image
1491 * headers in the boot_data structure have not been updated yet.
1492 *
1493 * In case of a permanent image swap mcuboot will never attempt to
1494 * revert the images on the next reboot. Therefore, the security
1495 * counter must be increased right after the image upgrade.
1496 */
1497 rc = boot_update_security_counter(
1498 BOOT_CURR_IMG(state),
1499 BOOT_PRIMARY_SLOT,
1500 boot_img_hdr(state, BOOT_SECONDARY_SLOT));
1501 if (rc != 0) {
1502 BOOT_LOG_ERR("Security counter update failed after "
1503 "image upgrade.");
1504 BOOT_SWAP_TYPE(state) = BOOT_SWAP_TYPE_PANIC;
1505 }
1506 }
1507#endif /* MCUBOOT_HW_ROLLBACK_PROT */
1508
Fabio Utzige575b0b2019-09-11 12:34:23 -03001509 if (BOOT_IS_UPGRADE(swap_type)) {
Fabio Utzig12d59162019-11-28 10:01:59 -03001510 rc = swap_set_copy_done(BOOT_CURR_IMG(state));
David Vinczeba3bd602019-06-17 16:01:43 +02001511 if (rc != 0) {
Fabio Utzig10ee6482019-08-01 12:04:52 -03001512 BOOT_SWAP_TYPE(state) = BOOT_SWAP_TYPE_PANIC;
Christopher Collinsa1c12042019-05-23 14:00:28 -07001513 }
David Vinczeba3bd602019-06-17 16:01:43 +02001514 }
1515#endif /* !MCUBOOT_OVERWRITE_ONLY */
Fabio Utzig338a19f2018-12-03 08:37:08 -02001516
David Vinczeba3bd602019-06-17 16:01:43 +02001517 return rc;
1518}
1519
1520/**
1521 * Completes a previously aborted image swap.
1522 *
1523 * @param bs The current boot status.
1524 *
1525 * @return 0 on success; nonzero on failure.
1526 */
1527#if !defined(MCUBOOT_OVERWRITE_ONLY)
1528static int
Fabio Utzig10ee6482019-08-01 12:04:52 -03001529boot_complete_partial_swap(struct boot_loader_state *state,
1530 struct boot_status *bs)
David Vinczeba3bd602019-06-17 16:01:43 +02001531{
1532 int rc;
1533
1534 /* Determine the type of swap operation being resumed from the
1535 * `swap-type` trailer field.
1536 */
Fabio Utzig10ee6482019-08-01 12:04:52 -03001537 rc = boot_swap_image(state, bs);
David Vinczeba3bd602019-06-17 16:01:43 +02001538 assert(rc == 0);
1539
Fabio Utzig10ee6482019-08-01 12:04:52 -03001540 BOOT_SWAP_TYPE(state) = bs->swap_type;
David Vinczeba3bd602019-06-17 16:01:43 +02001541
1542 /* The following states need image_ok be explicitly set after the
1543 * swap was finished to avoid a new revert.
1544 */
1545 if (bs->swap_type == BOOT_SWAP_TYPE_REVERT ||
1546 bs->swap_type == BOOT_SWAP_TYPE_PERM) {
Fabio Utzig12d59162019-11-28 10:01:59 -03001547 rc = swap_set_image_ok(BOOT_CURR_IMG(state));
David Vinczeba3bd602019-06-17 16:01:43 +02001548 if (rc != 0) {
Fabio Utzig10ee6482019-08-01 12:04:52 -03001549 BOOT_SWAP_TYPE(state) = BOOT_SWAP_TYPE_PANIC;
David Vinczeba3bd602019-06-17 16:01:43 +02001550 }
1551 }
1552
Fabio Utzige575b0b2019-09-11 12:34:23 -03001553 if (BOOT_IS_UPGRADE(bs->swap_type)) {
Fabio Utzig12d59162019-11-28 10:01:59 -03001554 rc = swap_set_copy_done(BOOT_CURR_IMG(state));
David Vinczeba3bd602019-06-17 16:01:43 +02001555 if (rc != 0) {
Fabio Utzig10ee6482019-08-01 12:04:52 -03001556 BOOT_SWAP_TYPE(state) = BOOT_SWAP_TYPE_PANIC;
David Vinczeba3bd602019-06-17 16:01:43 +02001557 }
1558 }
1559
Fabio Utzig10ee6482019-08-01 12:04:52 -03001560 if (BOOT_SWAP_TYPE(state) == BOOT_SWAP_TYPE_PANIC) {
David Vinczeba3bd602019-06-17 16:01:43 +02001561 BOOT_LOG_ERR("panic!");
1562 assert(0);
1563
1564 /* Loop forever... */
1565 while (1) {}
1566 }
1567
1568 return rc;
1569}
1570#endif /* !MCUBOOT_OVERWRITE_ONLY */
1571
1572#if (BOOT_IMAGE_NUMBER > 1)
1573/**
1574 * Review the validity of previously determined swap types of other images.
1575 *
1576 * @param aborted_swap The current image upgrade is a
1577 * partial/aborted swap.
1578 */
1579static void
Fabio Utzig10ee6482019-08-01 12:04:52 -03001580boot_review_image_swap_types(struct boot_loader_state *state,
1581 bool aborted_swap)
David Vinczeba3bd602019-06-17 16:01:43 +02001582{
1583 /* In that case if we rebooted in the middle of an image upgrade process, we
1584 * must review the validity of swap types, that were previously determined
1585 * for other images. The image_ok flag had not been set before the reboot
1586 * for any of the updated images (only the copy_done flag) and thus falsely
1587 * the REVERT swap type has been determined for the previous images that had
1588 * been updated before the reboot.
1589 *
1590 * There are two separate scenarios that we have to deal with:
1591 *
1592 * 1. The reboot has happened during swapping an image:
1593 * The current image upgrade has been determined as a
1594 * partial/aborted swap.
1595 * 2. The reboot has happened between two separate image upgrades:
1596 * In this scenario we must check the swap type of the current image.
1597 * In those cases if it is NONE or REVERT we cannot certainly determine
1598 * the fact of a reboot. In a consistent state images must move in the
1599 * same direction or stay in place, e.g. in practice REVERT and TEST
1600 * swap types cannot be present at the same time. If the swap type of
1601 * the current image is either TEST, PERM or FAIL we must review the
1602 * already determined swap types of other images and set each false
1603 * REVERT swap types to NONE (these images had been successfully
1604 * updated before the system rebooted between two separate image
1605 * upgrades).
1606 */
1607
Fabio Utzig10ee6482019-08-01 12:04:52 -03001608 if (BOOT_CURR_IMG(state) == 0) {
David Vinczeba3bd602019-06-17 16:01:43 +02001609 /* Nothing to do */
1610 return;
1611 }
1612
1613 if (!aborted_swap) {
Fabio Utzig10ee6482019-08-01 12:04:52 -03001614 if ((BOOT_SWAP_TYPE(state) == BOOT_SWAP_TYPE_NONE) ||
1615 (BOOT_SWAP_TYPE(state) == BOOT_SWAP_TYPE_REVERT)) {
David Vinczeba3bd602019-06-17 16:01:43 +02001616 /* Nothing to do */
1617 return;
1618 }
1619 }
1620
Fabio Utzig10ee6482019-08-01 12:04:52 -03001621 for (uint8_t i = 0; i < BOOT_CURR_IMG(state); i++) {
1622 if (state->swap_type[i] == BOOT_SWAP_TYPE_REVERT) {
1623 state->swap_type[i] = BOOT_SWAP_TYPE_NONE;
David Vinczeba3bd602019-06-17 16:01:43 +02001624 }
1625 }
1626}
1627#endif
1628
1629/**
1630 * Prepare image to be updated if required.
1631 *
1632 * Prepare image to be updated if required with completing an image swap
1633 * operation if one was aborted and/or determining the type of the
1634 * swap operation. In case of any error set the swap type to NONE.
1635 *
Fabio Utzig10ee6482019-08-01 12:04:52 -03001636 * @param state TODO
David Vinczeba3bd602019-06-17 16:01:43 +02001637 * @param bs Pointer where the read and possibly updated
1638 * boot status can be written to.
1639 */
1640static void
Fabio Utzig10ee6482019-08-01 12:04:52 -03001641boot_prepare_image_for_update(struct boot_loader_state *state,
1642 struct boot_status *bs)
David Vinczeba3bd602019-06-17 16:01:43 +02001643{
1644 int rc;
Raef Colese8fe6cf2020-05-26 13:07:40 +01001645 fih_int fih_rc = FIH_FAILURE;
David Vinczeba3bd602019-06-17 16:01:43 +02001646
1647 /* Determine the sector layout of the image slots and scratch area. */
Fabio Utzig10ee6482019-08-01 12:04:52 -03001648 rc = boot_read_sectors(state);
David Vinczeba3bd602019-06-17 16:01:43 +02001649 if (rc != 0) {
1650 BOOT_LOG_WRN("Failed reading sectors; BOOT_MAX_IMG_SECTORS=%d"
1651 " - too small?", BOOT_MAX_IMG_SECTORS);
1652 /* Unable to determine sector layout, continue with next image
1653 * if there is one.
1654 */
Fabio Utzig10ee6482019-08-01 12:04:52 -03001655 BOOT_SWAP_TYPE(state) = BOOT_SWAP_TYPE_NONE;
David Vinczeba3bd602019-06-17 16:01:43 +02001656 return;
1657 }
1658
1659 /* Attempt to read an image header from each slot. */
Fabio Utzig12d59162019-11-28 10:01:59 -03001660 rc = boot_read_image_headers(state, false, NULL);
David Vinczeba3bd602019-06-17 16:01:43 +02001661 if (rc != 0) {
1662 /* Continue with next image if there is one. */
Fabio Utzigb0f04732019-07-31 09:49:19 -03001663 BOOT_LOG_WRN("Failed reading image headers; Image=%u",
Fabio Utzig10ee6482019-08-01 12:04:52 -03001664 BOOT_CURR_IMG(state));
1665 BOOT_SWAP_TYPE(state) = BOOT_SWAP_TYPE_NONE;
David Vinczeba3bd602019-06-17 16:01:43 +02001666 return;
1667 }
1668
1669 /* If the current image's slots aren't compatible, no swap is possible.
1670 * Just boot into primary slot.
1671 */
Fabio Utzig10ee6482019-08-01 12:04:52 -03001672 if (boot_slots_compatible(state)) {
Fabio Utzig12d59162019-11-28 10:01:59 -03001673 boot_status_reset(bs);
1674
1675#ifndef MCUBOOT_OVERWRITE_ONLY
1676 rc = swap_read_status(state, bs);
David Vinczeba3bd602019-06-17 16:01:43 +02001677 if (rc != 0) {
1678 BOOT_LOG_WRN("Failed reading boot status; Image=%u",
Fabio Utzig10ee6482019-08-01 12:04:52 -03001679 BOOT_CURR_IMG(state));
David Vinczeba3bd602019-06-17 16:01:43 +02001680 /* Continue with next image if there is one. */
Fabio Utzig10ee6482019-08-01 12:04:52 -03001681 BOOT_SWAP_TYPE(state) = BOOT_SWAP_TYPE_NONE;
David Vinczeba3bd602019-06-17 16:01:43 +02001682 return;
1683 }
Fabio Utzig12d59162019-11-28 10:01:59 -03001684#endif
David Vinczeba3bd602019-06-17 16:01:43 +02001685
Fabio Utzig74aef312019-11-28 11:05:34 -03001686#ifdef MCUBOOT_SWAP_USING_MOVE
1687 /*
1688 * Must re-read image headers because the boot status might
1689 * have been updated in the previous function call.
1690 */
1691 rc = boot_read_image_headers(state, !boot_status_is_reset(bs), bs);
Fabio Utzig32afe852020-10-04 10:36:02 -03001692#ifdef MCUBOOT_BOOTSTRAP
1693 /* When bootstrapping it's OK to not have image magic in the primary slot */
1694 if (rc != 0 && (BOOT_CURR_IMG(state) != BOOT_PRIMARY_SLOT ||
1695 boot_check_header_erased(state, BOOT_PRIMARY_SLOT) != 0)) {
1696#else
Fabio Utzig74aef312019-11-28 11:05:34 -03001697 if (rc != 0) {
Fabio Utzig32afe852020-10-04 10:36:02 -03001698#endif
1699
Fabio Utzig74aef312019-11-28 11:05:34 -03001700 /* Continue with next image if there is one. */
1701 BOOT_LOG_WRN("Failed reading image headers; Image=%u",
1702 BOOT_CURR_IMG(state));
1703 BOOT_SWAP_TYPE(state) = BOOT_SWAP_TYPE_NONE;
1704 return;
1705 }
1706#endif
1707
David Vinczeba3bd602019-06-17 16:01:43 +02001708 /* Determine if we rebooted in the middle of an image swap
1709 * operation. If a partial swap was detected, complete it.
1710 */
Fabio Utzig12d59162019-11-28 10:01:59 -03001711 if (!boot_status_is_reset(bs)) {
David Vinczeba3bd602019-06-17 16:01:43 +02001712
1713#if (BOOT_IMAGE_NUMBER > 1)
Fabio Utzig10ee6482019-08-01 12:04:52 -03001714 boot_review_image_swap_types(state, true);
David Vinczeba3bd602019-06-17 16:01:43 +02001715#endif
1716
1717#ifdef MCUBOOT_OVERWRITE_ONLY
1718 /* Should never arrive here, overwrite-only mode has
1719 * no swap state.
1720 */
1721 assert(0);
1722#else
1723 /* Determine the type of swap operation being resumed from the
1724 * `swap-type` trailer field.
1725 */
Fabio Utzig10ee6482019-08-01 12:04:52 -03001726 rc = boot_complete_partial_swap(state, bs);
David Vinczeba3bd602019-06-17 16:01:43 +02001727 assert(rc == 0);
1728#endif
1729 /* Attempt to read an image header from each slot. Ensure that
1730 * image headers in slots are aligned with headers in boot_data.
1731 */
Fabio Utzig12d59162019-11-28 10:01:59 -03001732 rc = boot_read_image_headers(state, false, bs);
David Vinczeba3bd602019-06-17 16:01:43 +02001733 assert(rc == 0);
1734
1735 /* Swap has finished set to NONE */
Fabio Utzig10ee6482019-08-01 12:04:52 -03001736 BOOT_SWAP_TYPE(state) = BOOT_SWAP_TYPE_NONE;
David Vinczeba3bd602019-06-17 16:01:43 +02001737 } else {
1738 /* There was no partial swap, determine swap type. */
1739 if (bs->swap_type == BOOT_SWAP_TYPE_NONE) {
Fabio Utzig10ee6482019-08-01 12:04:52 -03001740 BOOT_SWAP_TYPE(state) = boot_validated_swap_type(state, bs);
David Vinczeba3bd602019-06-17 16:01:43 +02001741 } else {
Raef Colese8fe6cf2020-05-26 13:07:40 +01001742 FIH_CALL(boot_validate_slot, fih_rc,
1743 state, BOOT_SECONDARY_SLOT, bs);
1744 if (fih_not_eq(fih_rc, FIH_SUCCESS)) {
1745 BOOT_SWAP_TYPE(state) = BOOT_SWAP_TYPE_FAIL;
1746 } else {
1747 BOOT_SWAP_TYPE(state) = bs->swap_type;
1748 }
David Vinczeba3bd602019-06-17 16:01:43 +02001749 }
1750
1751#if (BOOT_IMAGE_NUMBER > 1)
Fabio Utzig10ee6482019-08-01 12:04:52 -03001752 boot_review_image_swap_types(state, false);
David Vinczeba3bd602019-06-17 16:01:43 +02001753#endif
1754
1755#ifdef MCUBOOT_BOOTSTRAP
Fabio Utzig10ee6482019-08-01 12:04:52 -03001756 if (BOOT_SWAP_TYPE(state) == BOOT_SWAP_TYPE_NONE) {
David Vinczeba3bd602019-06-17 16:01:43 +02001757 /* Header checks are done first because they are
1758 * inexpensive. Since overwrite-only copies starting from
1759 * offset 0, if interrupted, it might leave a valid header
1760 * magic, so also run validation on the primary slot to be
1761 * sure it's not OK.
1762 */
Raef Colese8fe6cf2020-05-26 13:07:40 +01001763 rc = boot_check_header_erased(state, BOOT_PRIMARY_SLOT);
1764 FIH_CALL(boot_validate_slot, fih_rc,
1765 state, BOOT_PRIMARY_SLOT, bs);
1766
1767 if (rc == 0 || fih_not_eq(fih_rc, FIH_SUCCESS)) {
1768
Fabio Utzig3d77c952020-10-04 10:23:17 -03001769 rc = (boot_img_hdr(state, BOOT_SECONDARY_SLOT)->ih_magic == IMAGE_MAGIC) ? 1: 0;
Raef Colese8fe6cf2020-05-26 13:07:40 +01001770 FIH_CALL(boot_validate_slot, fih_rc,
1771 state, BOOT_SECONDARY_SLOT, bs);
1772
Fabio Utzig3d77c952020-10-04 10:23:17 -03001773 if (rc == 1 && fih_eq(fih_rc, FIH_SUCCESS)) {
David Vinczeba3bd602019-06-17 16:01:43 +02001774 /* Set swap type to REVERT to overwrite the primary
1775 * slot with the image contained in secondary slot
1776 * and to trigger the explicit setting of the
1777 * image_ok flag.
1778 */
Fabio Utzig59b63e52019-09-10 12:22:35 -03001779 BOOT_SWAP_TYPE(state) = BOOT_SWAP_TYPE_REVERT;
David Vinczeba3bd602019-06-17 16:01:43 +02001780 }
Fabio Utzig338a19f2018-12-03 08:37:08 -02001781 }
1782 }
Fabio Utzig338a19f2018-12-03 08:37:08 -02001783#endif
Christopher Collins0ff3c6c2016-12-21 12:04:17 -08001784 }
David Vinczeba3bd602019-06-17 16:01:43 +02001785 } else {
1786 /* In that case if slots are not compatible. */
Fabio Utzig10ee6482019-08-01 12:04:52 -03001787 BOOT_SWAP_TYPE(state) = BOOT_SWAP_TYPE_NONE;
Christopher Collins0ff3c6c2016-12-21 12:04:17 -08001788 }
Christopher Collins0ff3c6c2016-12-21 12:04:17 -08001789}
1790
Mark Horvathccaf7f82021-01-04 18:16:42 +01001791/**
1792 * Updates the security counter for the current image.
1793 *
1794 * @param state Boot loader status information.
1795 *
1796 * @return 0 on success; nonzero on failure.
1797 */
1798static int
1799boot_update_hw_rollback_protection(struct boot_loader_state *state)
1800{
1801#ifdef MCUBOOT_HW_ROLLBACK_PROT
1802 int rc;
1803
1804 /* Update the stored security counter with the active image's security
1805 * counter value. It will only be updated if the new security counter is
1806 * greater than the stored value.
1807 *
1808 * In case of a successful image swapping when the swap type is TEST the
1809 * security counter can be increased only after a reset, when the swap
1810 * type is NONE and the image has marked itself "OK" (the image_ok flag
1811 * has been set). This way a "revert" can be performed when it's
1812 * necessary.
1813 */
1814 if (BOOT_SWAP_TYPE(state) == BOOT_SWAP_TYPE_NONE) {
1815 rc = boot_update_security_counter(
1816 BOOT_CURR_IMG(state),
1817 BOOT_PRIMARY_SLOT,
1818 boot_img_hdr(state, BOOT_PRIMARY_SLOT));
1819 if (rc != 0) {
1820 BOOT_LOG_ERR("Security counter update failed after image "
1821 "validation.");
1822 return rc;
1823 }
1824 }
1825
1826 return 0;
1827
1828#else /* MCUBOOT_HW_ROLLBACK_PROT */
1829 (void) (state);
1830
1831 return 0;
1832#endif
1833}
1834
Raef Colese8fe6cf2020-05-26 13:07:40 +01001835fih_int
Fabio Utzig10ee6482019-08-01 12:04:52 -03001836context_boot_go(struct boot_loader_state *state, struct boot_rsp *rsp)
Christopher Collins92ea77f2016-12-12 15:59:26 -08001837{
Marti Bolivar84898652017-06-13 17:20:22 -04001838 size_t slot;
David Vinczeba3bd602019-06-17 16:01:43 +02001839 struct boot_status bs;
David Vincze9015a5d2020-05-18 14:43:11 +02001840 int rc = -1;
Raef Colese8fe6cf2020-05-26 13:07:40 +01001841 fih_int fih_rc = FIH_FAILURE;
Marti Bolivarc0b47912017-06-13 17:18:09 -04001842 int fa_id;
Fabio Utzigb0f04732019-07-31 09:49:19 -03001843 int image_index;
Fabio Utzig298913b2019-08-28 11:22:45 -03001844 bool has_upgrade;
Christopher Collins92ea77f2016-12-12 15:59:26 -08001845
1846 /* The array of slot sectors are defined here (as opposed to file scope) so
1847 * that they don't get allocated for non-boot-loader apps. This is
1848 * necessary because the gcc option "-fdata-sections" doesn't seem to have
Christopher Collins0ff3c6c2016-12-21 12:04:17 -08001849 * any effect in older gcc versions (e.g., 4.8.4).
Christopher Collins92ea77f2016-12-12 15:59:26 -08001850 */
Fabio Utzig10ee6482019-08-01 12:04:52 -03001851 TARGET_STATIC boot_sector_t primary_slot_sectors[BOOT_IMAGE_NUMBER][BOOT_MAX_IMG_SECTORS];
1852 TARGET_STATIC boot_sector_t secondary_slot_sectors[BOOT_IMAGE_NUMBER][BOOT_MAX_IMG_SECTORS];
Fabio Utzig12d59162019-11-28 10:01:59 -03001853#if MCUBOOT_SWAP_USING_SCRATCH
Fabio Utzig10ee6482019-08-01 12:04:52 -03001854 TARGET_STATIC boot_sector_t scratch_sectors[BOOT_MAX_IMG_SECTORS];
Fabio Utzig12d59162019-11-28 10:01:59 -03001855#endif
Christopher Collins92ea77f2016-12-12 15:59:26 -08001856
Fabio Utzig10ee6482019-08-01 12:04:52 -03001857 memset(state, 0, sizeof(struct boot_loader_state));
Fabio Utzig298913b2019-08-28 11:22:45 -03001858 has_upgrade = false;
1859
1860#if (BOOT_IMAGE_NUMBER == 1)
1861 (void)has_upgrade;
1862#endif
Fabio Utzigba829042018-09-18 08:29:34 -03001863
David Vinczeba3bd602019-06-17 16:01:43 +02001864 /* Iterate over all the images. By the end of the loop the swap type has
1865 * to be determined for each image and all aborted swaps have to be
1866 * completed.
Christopher Collins0ff3c6c2016-12-21 12:04:17 -08001867 */
Fabio Utzig10ee6482019-08-01 12:04:52 -03001868 IMAGES_ITER(BOOT_CURR_IMG(state)) {
Fabio Utzigdb5bd3c2017-07-13 22:20:22 -03001869
David Vinczeba3bd602019-06-17 16:01:43 +02001870#if defined(MCUBOOT_ENC_IMAGES) && (BOOT_IMAGE_NUMBER > 1)
1871 /* The keys used for encryption may no longer be valid (could belong to
1872 * another images). Therefore, mark them as invalid to force their reload
1873 * by boot_enc_load().
Fabio Utzigdb5bd3c2017-07-13 22:20:22 -03001874 */
Fabio Utzig1e4284b2019-08-23 11:55:27 -03001875 boot_enc_zeroize(BOOT_CURR_ENC(state));
David Brown554c52e2017-06-30 16:01:07 -06001876#endif
1877
Fabio Utzig10ee6482019-08-01 12:04:52 -03001878 image_index = BOOT_CURR_IMG(state);
Fabio Utzigb0f04732019-07-31 09:49:19 -03001879
Fabio Utzig10ee6482019-08-01 12:04:52 -03001880 BOOT_IMG(state, BOOT_PRIMARY_SLOT).sectors =
Fabio Utzigb0f04732019-07-31 09:49:19 -03001881 primary_slot_sectors[image_index];
Fabio Utzig10ee6482019-08-01 12:04:52 -03001882 BOOT_IMG(state, BOOT_SECONDARY_SLOT).sectors =
Fabio Utzigb0f04732019-07-31 09:49:19 -03001883 secondary_slot_sectors[image_index];
Fabio Utzig12d59162019-11-28 10:01:59 -03001884#if MCUBOOT_SWAP_USING_SCRATCH
Fabio Utzig10ee6482019-08-01 12:04:52 -03001885 state->scratch.sectors = scratch_sectors;
Fabio Utzig12d59162019-11-28 10:01:59 -03001886#endif
David Vinczeba3bd602019-06-17 16:01:43 +02001887
1888 /* Open primary and secondary image areas for the duration
1889 * of this call.
1890 */
1891 for (slot = 0; slot < BOOT_NUM_SLOTS; slot++) {
Fabio Utzigb0f04732019-07-31 09:49:19 -03001892 fa_id = flash_area_id_from_multi_image_slot(image_index, slot);
Fabio Utzig10ee6482019-08-01 12:04:52 -03001893 rc = flash_area_open(fa_id, &BOOT_IMG_AREA(state, slot));
David Vinczeba3bd602019-06-17 16:01:43 +02001894 assert(rc == 0);
1895 }
Fabio Utzig12d59162019-11-28 10:01:59 -03001896#if MCUBOOT_SWAP_USING_SCRATCH
David Vinczeba3bd602019-06-17 16:01:43 +02001897 rc = flash_area_open(FLASH_AREA_IMAGE_SCRATCH,
Fabio Utzig10ee6482019-08-01 12:04:52 -03001898 &BOOT_SCRATCH_AREA(state));
David Vinczeba3bd602019-06-17 16:01:43 +02001899 assert(rc == 0);
Fabio Utzig12d59162019-11-28 10:01:59 -03001900#endif
David Vinczeba3bd602019-06-17 16:01:43 +02001901
1902 /* Determine swap type and complete swap if it has been aborted. */
Fabio Utzig10ee6482019-08-01 12:04:52 -03001903 boot_prepare_image_for_update(state, &bs);
Fabio Utzig298913b2019-08-28 11:22:45 -03001904
Fabio Utzige575b0b2019-09-11 12:34:23 -03001905 if (BOOT_IS_UPGRADE(BOOT_SWAP_TYPE(state))) {
Fabio Utzig298913b2019-08-28 11:22:45 -03001906 has_upgrade = true;
1907 }
David Vinczeba3bd602019-06-17 16:01:43 +02001908 }
1909
David Vinczee32483f2019-06-13 10:46:24 +02001910#if (BOOT_IMAGE_NUMBER > 1)
Fabio Utzig298913b2019-08-28 11:22:45 -03001911 if (has_upgrade) {
1912 /* Iterate over all the images and verify whether the image dependencies
1913 * are all satisfied and update swap type if necessary.
1914 */
1915 rc = boot_verify_dependencies(state);
David Vincze8b0b6372020-05-20 19:54:44 +02001916 if (rc != 0) {
Fabio Utzig298913b2019-08-28 11:22:45 -03001917 /*
1918 * It was impossible to upgrade because the expected dependency version
1919 * was not available. Here we already changed the swap_type so that
1920 * instead of asserting the bootloader, we continue and no upgrade is
1921 * performed.
1922 */
1923 rc = 0;
1924 }
1925 }
David Vinczee32483f2019-06-13 10:46:24 +02001926#endif
1927
David Vinczeba3bd602019-06-17 16:01:43 +02001928 /* Iterate over all the images. At this point there are no aborted swaps
1929 * and the swap types are determined for each image. By the end of the loop
1930 * all required update operations will have been finished.
1931 */
Fabio Utzig10ee6482019-08-01 12:04:52 -03001932 IMAGES_ITER(BOOT_CURR_IMG(state)) {
David Vinczeba3bd602019-06-17 16:01:43 +02001933
1934#if (BOOT_IMAGE_NUMBER > 1)
1935#ifdef MCUBOOT_ENC_IMAGES
1936 /* The keys used for encryption may no longer be valid (could belong to
1937 * another images). Therefore, mark them as invalid to force their reload
1938 * by boot_enc_load().
1939 */
Fabio Utzig1e4284b2019-08-23 11:55:27 -03001940 boot_enc_zeroize(BOOT_CURR_ENC(state));
David Vinczeba3bd602019-06-17 16:01:43 +02001941#endif /* MCUBOOT_ENC_IMAGES */
1942
1943 /* Indicate that swap is not aborted */
Fabio Utzig12d59162019-11-28 10:01:59 -03001944 boot_status_reset(&bs);
David Vinczeba3bd602019-06-17 16:01:43 +02001945#endif /* (BOOT_IMAGE_NUMBER > 1) */
1946
1947 /* Set the previously determined swap type */
Fabio Utzig10ee6482019-08-01 12:04:52 -03001948 bs.swap_type = BOOT_SWAP_TYPE(state);
David Vinczeba3bd602019-06-17 16:01:43 +02001949
Fabio Utzig10ee6482019-08-01 12:04:52 -03001950 switch (BOOT_SWAP_TYPE(state)) {
David Vinczeba3bd602019-06-17 16:01:43 +02001951 case BOOT_SWAP_TYPE_NONE:
1952 break;
1953
1954 case BOOT_SWAP_TYPE_TEST: /* fallthrough */
1955 case BOOT_SWAP_TYPE_PERM: /* fallthrough */
1956 case BOOT_SWAP_TYPE_REVERT:
Fabio Utzig10ee6482019-08-01 12:04:52 -03001957 rc = boot_perform_update(state, &bs);
David Vinczeba3bd602019-06-17 16:01:43 +02001958 assert(rc == 0);
1959 break;
1960
1961 case BOOT_SWAP_TYPE_FAIL:
1962 /* The image in secondary slot was invalid and is now erased. Ensure
1963 * we don't try to boot into it again on the next reboot. Do this by
1964 * pretending we just reverted back to primary slot.
1965 */
1966#ifndef MCUBOOT_OVERWRITE_ONLY
1967 /* image_ok needs to be explicitly set to avoid a new revert. */
Fabio Utzig12d59162019-11-28 10:01:59 -03001968 rc = swap_set_image_ok(BOOT_CURR_IMG(state));
David Vinczeba3bd602019-06-17 16:01:43 +02001969 if (rc != 0) {
Fabio Utzig10ee6482019-08-01 12:04:52 -03001970 BOOT_SWAP_TYPE(state) = BOOT_SWAP_TYPE_PANIC;
David Vinczeba3bd602019-06-17 16:01:43 +02001971 }
1972#endif /* !MCUBOOT_OVERWRITE_ONLY */
1973 break;
1974
1975 default:
Fabio Utzig10ee6482019-08-01 12:04:52 -03001976 BOOT_SWAP_TYPE(state) = BOOT_SWAP_TYPE_PANIC;
David Vinczeba3bd602019-06-17 16:01:43 +02001977 }
1978
Fabio Utzig10ee6482019-08-01 12:04:52 -03001979 if (BOOT_SWAP_TYPE(state) == BOOT_SWAP_TYPE_PANIC) {
David Vinczeba3bd602019-06-17 16:01:43 +02001980 BOOT_LOG_ERR("panic!");
1981 assert(0);
1982
1983 /* Loop forever... */
Raef Colese8fe6cf2020-05-26 13:07:40 +01001984 FIH_PANIC;
David Vinczeba3bd602019-06-17 16:01:43 +02001985 }
1986 }
1987
1988 /* Iterate over all the images. At this point all required update operations
1989 * have finished. By the end of the loop each image in the primary slot will
1990 * have been re-validated.
1991 */
Fabio Utzig10ee6482019-08-01 12:04:52 -03001992 IMAGES_ITER(BOOT_CURR_IMG(state)) {
1993 if (BOOT_SWAP_TYPE(state) != BOOT_SWAP_TYPE_NONE) {
David Vinczeba3bd602019-06-17 16:01:43 +02001994 /* Attempt to read an image header from each slot. Ensure that image
1995 * headers in slots are aligned with headers in boot_data.
1996 */
Fabio Utzig12d59162019-11-28 10:01:59 -03001997 rc = boot_read_image_headers(state, false, &bs);
David Vinczeba3bd602019-06-17 16:01:43 +02001998 if (rc != 0) {
1999 goto out;
2000 }
2001 /* Since headers were reloaded, it can be assumed we just performed
2002 * a swap or overwrite. Now the header info that should be used to
2003 * provide the data for the bootstrap, which previously was at
2004 * secondary slot, was updated to primary slot.
2005 */
2006 }
2007
2008#ifdef MCUBOOT_VALIDATE_PRIMARY_SLOT
Raef Colese8fe6cf2020-05-26 13:07:40 +01002009 FIH_CALL(boot_validate_slot, fih_rc, state, BOOT_PRIMARY_SLOT, NULL);
2010 if (fih_not_eq(fih_rc, FIH_SUCCESS)) {
David Vinczeba3bd602019-06-17 16:01:43 +02002011 goto out;
2012 }
2013#else
2014 /* Even if we're not re-validating the primary slot, we could be booting
2015 * onto an empty flash chip. At least do a basic sanity check that
2016 * the magic number on the image is OK.
2017 */
Fabio Utzig10ee6482019-08-01 12:04:52 -03002018 if (BOOT_IMG(state, BOOT_PRIMARY_SLOT).hdr.ih_magic != IMAGE_MAGIC) {
David Vinczeba3bd602019-06-17 16:01:43 +02002019 BOOT_LOG_ERR("bad image magic 0x%lx; Image=%u", (unsigned long)
Fabio Utzig10ee6482019-08-01 12:04:52 -03002020 &boot_img_hdr(state,BOOT_PRIMARY_SLOT)->ih_magic,
2021 BOOT_CURR_IMG(state));
David Vinczeba3bd602019-06-17 16:01:43 +02002022 rc = BOOT_EBADIMAGE;
2023 goto out;
2024 }
David Vinczec3084132020-02-18 14:50:47 +01002025#endif /* MCUBOOT_VALIDATE_PRIMARY_SLOT */
2026
Mark Horvathccaf7f82021-01-04 18:16:42 +01002027 rc = boot_update_hw_rollback_protection(state);
David Vincze1cf11b52020-03-24 07:51:09 +01002028 if (rc != 0) {
Raef Colese8fe6cf2020-05-26 13:07:40 +01002029 goto out;
David Vincze1cf11b52020-03-24 07:51:09 +01002030 }
David Vincze1cf11b52020-03-24 07:51:09 +01002031
Mark Horvathccaf7f82021-01-04 18:16:42 +01002032 rc = boot_add_shared_data(state, BOOT_PRIMARY_SLOT);
David Vincze1cf11b52020-03-24 07:51:09 +01002033 if (rc != 0) {
Raef Colese8fe6cf2020-05-26 13:07:40 +01002034 goto out;
David Vincze1cf11b52020-03-24 07:51:09 +01002035 }
David Vinczeba3bd602019-06-17 16:01:43 +02002036 }
2037
Fabio Utzigf616c542019-12-19 15:23:32 -03002038 /*
2039 * Since the boot_status struct stores plaintext encryption keys, reset
2040 * them here to avoid the possibility of jumping into an image that could
2041 * easily recover them.
2042 */
2043 memset(&bs, 0, sizeof(struct boot_status));
2044
Mark Horvathccaf7f82021-01-04 18:16:42 +01002045 fill_rsp(state, NULL, rsp);
Christopher Collins92ea77f2016-12-12 15:59:26 -08002046
Raef Colese8fe6cf2020-05-26 13:07:40 +01002047 fih_rc = FIH_SUCCESS;
Fabio Utzig298913b2019-08-28 11:22:45 -03002048out:
Mark Horvathccaf7f82021-01-04 18:16:42 +01002049 close_all_flash_areas(state);
Raef Colese8fe6cf2020-05-26 13:07:40 +01002050
2051 if (rc) {
2052 fih_rc = fih_int_encode(rc);
2053 }
2054
2055 FIH_RET(fih_rc);
Christopher Collins92ea77f2016-12-12 15:59:26 -08002056}
2057
Raef Colese8fe6cf2020-05-26 13:07:40 +01002058fih_int
Christopher Collins92ea77f2016-12-12 15:59:26 -08002059split_go(int loader_slot, int split_slot, void **entry)
2060{
Marti Bolivarc50926f2017-06-14 09:35:40 -04002061 boot_sector_t *sectors;
Christopher Collins034a6202017-01-11 12:19:37 -08002062 uintptr_t entry_val;
Christopher Collins92ea77f2016-12-12 15:59:26 -08002063 int loader_flash_id;
Marti Bolivarc0b47912017-06-13 17:18:09 -04002064 int split_flash_id;
Christopher Collins92ea77f2016-12-12 15:59:26 -08002065 int rc;
Raef Colese8fe6cf2020-05-26 13:07:40 +01002066 fih_int fih_rc = FIH_FAILURE;
Christopher Collins92ea77f2016-12-12 15:59:26 -08002067
Christopher Collins92ea77f2016-12-12 15:59:26 -08002068 sectors = malloc(BOOT_MAX_IMG_SECTORS * 2 * sizeof *sectors);
2069 if (sectors == NULL) {
Raef Colese8fe6cf2020-05-26 13:07:40 +01002070 FIH_RET(FIH_FAILURE);
Christopher Collins92ea77f2016-12-12 15:59:26 -08002071 }
David Vinczeba3bd602019-06-17 16:01:43 +02002072 BOOT_IMG(&boot_data, loader_slot).sectors = sectors + 0;
2073 BOOT_IMG(&boot_data, split_slot).sectors = sectors + BOOT_MAX_IMG_SECTORS;
Marti Bolivarc0b47912017-06-13 17:18:09 -04002074
2075 loader_flash_id = flash_area_id_from_image_slot(loader_slot);
2076 rc = flash_area_open(loader_flash_id,
Alvaro Prieto63a2bdb2019-07-04 12:18:49 -07002077 &BOOT_IMG_AREA(&boot_data, loader_slot));
Marti Bolivarc0b47912017-06-13 17:18:09 -04002078 assert(rc == 0);
2079 split_flash_id = flash_area_id_from_image_slot(split_slot);
2080 rc = flash_area_open(split_flash_id,
2081 &BOOT_IMG_AREA(&boot_data, split_slot));
2082 assert(rc == 0);
Christopher Collins92ea77f2016-12-12 15:59:26 -08002083
2084 /* Determine the sector layout of the image slots and scratch area. */
Fabio Utzig10ee6482019-08-01 12:04:52 -03002085 rc = boot_read_sectors(&boot_data);
Christopher Collins92ea77f2016-12-12 15:59:26 -08002086 if (rc != 0) {
2087 rc = SPLIT_GO_ERR;
2088 goto done;
2089 }
2090
Fabio Utzig12d59162019-11-28 10:01:59 -03002091 rc = boot_read_image_headers(&boot_data, true, NULL);
Christopher Collins92ea77f2016-12-12 15:59:26 -08002092 if (rc != 0) {
2093 goto done;
2094 }
2095
Christopher Collins92ea77f2016-12-12 15:59:26 -08002096 /* Don't check the bootable image flag because we could really call a
2097 * bootable or non-bootable image. Just validate that the image check
2098 * passes which is distinct from the normal check.
2099 */
Raef Colese8fe6cf2020-05-26 13:07:40 +01002100 FIH_CALL(split_image_check, fih_rc,
2101 boot_img_hdr(&boot_data, split_slot),
2102 BOOT_IMG_AREA(&boot_data, split_slot),
2103 boot_img_hdr(&boot_data, loader_slot),
2104 BOOT_IMG_AREA(&boot_data, loader_slot));
2105 if (fih_not_eq(fih_rc, FIH_SUCCESS)) {
Christopher Collins92ea77f2016-12-12 15:59:26 -08002106 goto done;
2107 }
2108
Marti Bolivarea088872017-06-12 17:10:49 -04002109 entry_val = boot_img_slot_off(&boot_data, split_slot) +
Marti Bolivarf804f622017-06-12 15:41:48 -04002110 boot_img_hdr(&boot_data, split_slot)->ih_hdr_size;
Christopher Collins034a6202017-01-11 12:19:37 -08002111 *entry = (void *) entry_val;
Christopher Collins92ea77f2016-12-12 15:59:26 -08002112 rc = SPLIT_GO_OK;
2113
2114done:
Marti Bolivarc0b47912017-06-13 17:18:09 -04002115 flash_area_close(BOOT_IMG_AREA(&boot_data, split_slot));
2116 flash_area_close(BOOT_IMG_AREA(&boot_data, loader_slot));
Christopher Collins92ea77f2016-12-12 15:59:26 -08002117 free(sectors);
Raef Colese8fe6cf2020-05-26 13:07:40 +01002118
2119 if (rc) {
2120 fih_rc = fih_int_encode(rc);
2121 }
2122
2123 FIH_RET(fih_rc);
Christopher Collins92ea77f2016-12-12 15:59:26 -08002124}
David Vinczee574f2d2020-07-10 11:42:03 +02002125
Tamas Banfe031092020-09-10 17:32:39 +02002126#else /* MCUBOOT_DIRECT_XIP || MCUBOOT_RAM_LOAD */
David Vinczee574f2d2020-07-10 11:42:03 +02002127
Mark Horvathccaf7f82021-01-04 18:16:42 +01002128#define NO_ACTIVE_SLOT UINT32_MAX
2129
David Vinczee574f2d2020-07-10 11:42:03 +02002130/**
Mark Horvathccaf7f82021-01-04 18:16:42 +01002131 * Opens all flash areas and checks which contain an image with a valid header.
David Vinczee574f2d2020-07-10 11:42:03 +02002132 *
Mark Horvathccaf7f82021-01-04 18:16:42 +01002133 * @param state Boot loader status information.
2134 * @param slot_usage Structure to fill with information about the available
2135 * slots.
David Vinczee574f2d2020-07-10 11:42:03 +02002136 *
Mark Horvathccaf7f82021-01-04 18:16:42 +01002137 * @return 0 on success; nonzero on failure.
2138 */
2139static int
2140boot_get_slot_usage(struct boot_loader_state *state,
2141 struct slot_usage_t slot_usage[])
2142{
2143 uint32_t slot;
2144 int fa_id;
2145 int rc;
2146 struct image_header *hdr = NULL;
2147
2148 IMAGES_ITER(BOOT_CURR_IMG(state)) {
2149 /* Open all the slots */
2150 for (slot = 0; slot < BOOT_NUM_SLOTS; slot++) {
2151 fa_id = flash_area_id_from_multi_image_slot(
2152 BOOT_CURR_IMG(state), slot);
2153 rc = flash_area_open(fa_id, &BOOT_IMG_AREA(state, slot));
2154 assert(rc == 0);
2155 }
2156
2157 /* Attempt to read an image header from each slot. */
2158 rc = boot_read_image_headers(state, false, NULL);
2159 if (rc != 0) {
2160 BOOT_LOG_WRN("Failed reading image headers.");
2161 return rc;
2162 }
2163
2164 /* Check headers in all slots */
2165 for (slot = 0; slot < BOOT_NUM_SLOTS; slot++) {
2166 hdr = boot_img_hdr(state, slot);
2167
2168 if (boot_is_header_valid(hdr, BOOT_IMG_AREA(state, slot))) {
2169 slot_usage[BOOT_CURR_IMG(state)].slot_available[slot] = true;
2170 BOOT_LOG_IMAGE_INFO(slot, hdr);
2171 } else {
2172 slot_usage[BOOT_CURR_IMG(state)].slot_available[slot] = false;
2173 BOOT_LOG_INF("Image %d %s slot: Image not found",
2174 BOOT_CURR_IMG(state),
2175 (slot == BOOT_PRIMARY_SLOT)
2176 ? "Primary" : "Secondary");
2177 }
2178 }
2179
2180 slot_usage[BOOT_CURR_IMG(state)].active_slot = NO_ACTIVE_SLOT;
2181 }
2182
2183 return 0;
2184}
2185
2186/**
2187 * Finds the slot containing the image with the highest version number for the
2188 * current image.
2189 *
2190 * @param state Boot loader status information.
2191 * @param slot_usage Information about the active and available slots.
2192 *
2193 * @return NO_ACTIVE_SLOT if no available slot found, number of
2194 * the found slot otherwise.
David Vinczee574f2d2020-07-10 11:42:03 +02002195 */
2196static uint32_t
Mark Horvathccaf7f82021-01-04 18:16:42 +01002197find_slot_with_highest_version(struct boot_loader_state *state,
2198 struct slot_usage_t slot_usage[])
David Vinczee574f2d2020-07-10 11:42:03 +02002199{
David Vinczee574f2d2020-07-10 11:42:03 +02002200 uint32_t slot;
Mark Horvathccaf7f82021-01-04 18:16:42 +01002201 uint32_t candidate_slot = NO_ACTIVE_SLOT;
2202 int rc;
David Vinczee574f2d2020-07-10 11:42:03 +02002203
Mark Horvathccaf7f82021-01-04 18:16:42 +01002204 for (slot = 0; slot < BOOT_NUM_SLOTS; slot++) {
2205 if (slot_usage[BOOT_CURR_IMG(state)].slot_available[slot]) {
2206 if (candidate_slot == NO_ACTIVE_SLOT) {
2207 candidate_slot = slot;
2208 } else {
2209 rc = boot_version_cmp(
2210 &boot_img_hdr(state, slot)->ih_ver,
2211 &boot_img_hdr(state, candidate_slot)->ih_ver);
2212 if (rc == 1) {
2213 /* The version of the image being examined is greater than
2214 * the version of the current candidate.
2215 */
2216 candidate_slot = slot;
2217 }
2218 }
David Vinczee574f2d2020-07-10 11:42:03 +02002219 }
2220 }
2221
Mark Horvathccaf7f82021-01-04 18:16:42 +01002222 return candidate_slot;
David Vinczee574f2d2020-07-10 11:42:03 +02002223}
2224
Mark Horvathccaf7f82021-01-04 18:16:42 +01002225#ifdef MCUBOOT_HAVE_LOGGING
2226/**
2227 * Prints the state of the loaded images.
2228 *
2229 * @param state Boot loader status information.
2230 * @param slot_usage Information about the active and available slots.
2231 */
2232static void
2233print_loaded_images(struct boot_loader_state *state,
2234 struct slot_usage_t slot_usage[])
2235{
2236 uint32_t active_slot;
2237
2238 IMAGES_ITER(BOOT_CURR_IMG(state)) {
2239 active_slot = slot_usage[BOOT_CURR_IMG(state)].active_slot;
2240
2241 BOOT_LOG_INF("Image %d loaded from the %s slot",
2242 BOOT_CURR_IMG(state),
2243 (active_slot == BOOT_PRIMARY_SLOT) ?
2244 "primary" : "secondary");
2245 }
2246}
2247#endif
2248
David Vincze1c456242021-06-29 15:25:24 +02002249#if defined(MCUBOOT_DIRECT_XIP) && defined(MCUBOOT_DIRECT_XIP_REVERT)
David Vincze505fba22020-10-22 13:53:29 +02002250/**
Mark Horvathccaf7f82021-01-04 18:16:42 +01002251 * Checks whether the active slot of the current image was previously selected
2252 * to run. Erases the image if it was selected but its execution failed,
2253 * otherwise marks it as selected if it has not been before.
David Vincze505fba22020-10-22 13:53:29 +02002254 *
Mark Horvathccaf7f82021-01-04 18:16:42 +01002255 * @param state Boot loader status information.
2256 * @param slot_usage Information about the active and available slots.
David Vincze505fba22020-10-22 13:53:29 +02002257 *
Mark Horvathccaf7f82021-01-04 18:16:42 +01002258 * @return 0 on success; nonzero on failure.
David Vincze505fba22020-10-22 13:53:29 +02002259 */
2260static int
Mark Horvathccaf7f82021-01-04 18:16:42 +01002261boot_select_or_erase(struct boot_loader_state *state,
2262 struct slot_usage_t slot_usage[])
David Vincze505fba22020-10-22 13:53:29 +02002263{
2264 const struct flash_area *fap;
2265 int fa_id;
2266 int rc;
Mark Horvathccaf7f82021-01-04 18:16:42 +01002267 uint32_t active_slot;
2268 struct boot_swap_state* active_swap_state;
David Vincze505fba22020-10-22 13:53:29 +02002269
Mark Horvathccaf7f82021-01-04 18:16:42 +01002270 active_slot = slot_usage[BOOT_CURR_IMG(state)].active_slot;
2271
2272 fa_id = flash_area_id_from_multi_image_slot(BOOT_CURR_IMG(state), active_slot);
David Vincze505fba22020-10-22 13:53:29 +02002273 rc = flash_area_open(fa_id, &fap);
2274 assert(rc == 0);
2275
Mark Horvathccaf7f82021-01-04 18:16:42 +01002276 active_swap_state = &(slot_usage[BOOT_CURR_IMG(state)].swap_state);
2277
2278 memset(active_swap_state, 0, sizeof(struct boot_swap_state));
2279 rc = boot_read_swap_state(fap, active_swap_state);
David Vincze505fba22020-10-22 13:53:29 +02002280 assert(rc == 0);
2281
Mark Horvathccaf7f82021-01-04 18:16:42 +01002282 if (active_swap_state->magic != BOOT_MAGIC_GOOD ||
2283 (active_swap_state->copy_done == BOOT_FLAG_SET &&
2284 active_swap_state->image_ok != BOOT_FLAG_SET)) {
David Vincze505fba22020-10-22 13:53:29 +02002285 /*
2286 * A reboot happened without the image being confirmed at
2287 * runtime or its trailer is corrupted/invalid. Erase the image
2288 * to prevent it from being selected again on the next reboot.
2289 */
2290 BOOT_LOG_DBG("Erasing faulty image in the %s slot.",
Carlos Falgueras Garcíaae13c3c2021-06-21 17:20:31 +02002291 (active_slot == BOOT_PRIMARY_SLOT) ? "primary" : "secondary");
David Vincze505fba22020-10-22 13:53:29 +02002292 rc = flash_area_erase(fap, 0, fap->fa_size);
2293 assert(rc == 0);
2294
2295 flash_area_close(fap);
2296 rc = -1;
2297 } else {
Mark Horvathccaf7f82021-01-04 18:16:42 +01002298 if (active_swap_state->copy_done != BOOT_FLAG_SET) {
2299 if (active_swap_state->copy_done == BOOT_FLAG_BAD) {
David Vincze505fba22020-10-22 13:53:29 +02002300 BOOT_LOG_DBG("The copy_done flag had an unexpected value. Its "
2301 "value was neither 'set' nor 'unset', but 'bad'.");
2302 }
2303 /*
2304 * Set the copy_done flag, indicating that the image has been
2305 * selected to boot. It can be set in advance, before even
2306 * validating the image, because in case the validation fails, the
2307 * entire image slot will be erased (including the trailer).
2308 */
2309 rc = boot_write_copy_done(fap);
2310 if (rc != 0) {
2311 BOOT_LOG_WRN("Failed to set copy_done flag of the image in "
Carlos Falgueras Garcíaae13c3c2021-06-21 17:20:31 +02002312 "the %s slot.", (active_slot == BOOT_PRIMARY_SLOT) ?
David Vincze505fba22020-10-22 13:53:29 +02002313 "primary" : "secondary");
2314 rc = 0;
2315 }
2316 }
2317 flash_area_close(fap);
2318 }
2319
2320 return rc;
2321}
David Vincze1c456242021-06-29 15:25:24 +02002322#endif /* MCUBOOT_DIRECT_XIP && MCUBOOT_DIRECT_XIP_REVERT */
David Vincze505fba22020-10-22 13:53:29 +02002323
Tamas Banfe031092020-09-10 17:32:39 +02002324#ifdef MCUBOOT_RAM_LOAD
2325
Mark Horvathccaf7f82021-01-04 18:16:42 +01002326#ifndef MULTIPLE_EXECUTABLE_RAM_REGIONS
Tamas Banfe031092020-09-10 17:32:39 +02002327#if !defined(IMAGE_EXECUTABLE_RAM_START) || !defined(IMAGE_EXECUTABLE_RAM_SIZE)
2328#error "Platform MUST define executable RAM bounds in case of RAM_LOAD"
2329#endif
Mark Horvathccaf7f82021-01-04 18:16:42 +01002330#endif
Tamas Banfe031092020-09-10 17:32:39 +02002331
2332/**
Mark Horvathccaf7f82021-01-04 18:16:42 +01002333 * Verifies that the active slot of the current image can be loaded within the
2334 * predefined bounds that are allowed to be used by executable images.
Tamas Banfe031092020-09-10 17:32:39 +02002335 *
Mark Horvathccaf7f82021-01-04 18:16:42 +01002336 * @param state Boot loader status information.
2337 * @param slot_usage Information about the active and available slots.
Tamas Banfe031092020-09-10 17:32:39 +02002338 *
Mark Horvathccaf7f82021-01-04 18:16:42 +01002339 * @return 0 on success; nonzero on failure.
Tamas Banfe031092020-09-10 17:32:39 +02002340 */
2341static int
Mark Horvathccaf7f82021-01-04 18:16:42 +01002342boot_verify_ram_load_address(struct boot_loader_state *state,
2343 struct slot_usage_t slot_usage[])
Tamas Banfe031092020-09-10 17:32:39 +02002344{
Mark Horvathccaf7f82021-01-04 18:16:42 +01002345 uint32_t img_dst;
2346 uint32_t img_sz;
Tamas Banfe031092020-09-10 17:32:39 +02002347 uint32_t img_end_addr;
Mark Horvathccaf7f82021-01-04 18:16:42 +01002348 uint32_t exec_ram_start;
2349 uint32_t exec_ram_size;
2350#ifdef MULTIPLE_EXECUTABLE_RAM_REGIONS
2351 int rc;
Tamas Banfe031092020-09-10 17:32:39 +02002352
Mark Horvathccaf7f82021-01-04 18:16:42 +01002353 rc = boot_get_image_exec_ram_info(BOOT_CURR_IMG(state), &exec_ram_start,
2354 &exec_ram_size);
2355 if (rc != 0) {
2356 return BOOT_EBADSTATUS;
2357 }
2358#else
2359 exec_ram_start = IMAGE_EXECUTABLE_RAM_START;
2360 exec_ram_size = IMAGE_EXECUTABLE_RAM_SIZE;
2361#endif
2362
2363 img_dst = slot_usage[BOOT_CURR_IMG(state)].img_dst;
2364 img_sz = slot_usage[BOOT_CURR_IMG(state)].img_sz;
2365
2366 if (img_dst < exec_ram_start) {
Tamas Banfe031092020-09-10 17:32:39 +02002367 return BOOT_EBADIMAGE;
2368 }
2369
2370 if (!boot_u32_safe_add(&img_end_addr, img_dst, img_sz)) {
2371 return BOOT_EBADIMAGE;
2372 }
2373
Mark Horvathccaf7f82021-01-04 18:16:42 +01002374 if (img_end_addr > (exec_ram_start + exec_ram_size)) {
Tamas Banfe031092020-09-10 17:32:39 +02002375 return BOOT_EBADIMAGE;
2376 }
2377
2378 return 0;
2379}
2380
2381/**
Mark Horvathccaf7f82021-01-04 18:16:42 +01002382 * Copies a slot of the current image into SRAM.
Tamas Banfe031092020-09-10 17:32:39 +02002383 *
Mark Horvathccaf7f82021-01-04 18:16:42 +01002384 * @param state Boot loader status information.
Tamas Banfe031092020-09-10 17:32:39 +02002385 * @param slot The flash slot of the image to be copied to SRAM.
2386 * @param img_dst The address at which the image needs to be copied to
2387 * SRAM.
2388 * @param img_sz The size of the image that needs to be copied to SRAM.
2389 *
2390 * @return 0 on success; nonzero on failure.
2391 */
2392static int
Mark Horvathccaf7f82021-01-04 18:16:42 +01002393boot_copy_image_to_sram(struct boot_loader_state *state, int slot,
2394 uint32_t img_dst, uint32_t img_sz)
Tamas Banfe031092020-09-10 17:32:39 +02002395{
2396 int rc;
2397 const struct flash_area *fap_src = NULL;
Mark Horvathccaf7f82021-01-04 18:16:42 +01002398 int area_id;
Tamas Banfe031092020-09-10 17:32:39 +02002399
Mark Horvathccaf7f82021-01-04 18:16:42 +01002400#if (BOOT_IMAGE_NUMBER == 1)
2401 (void)state;
2402#endif
2403
2404 area_id = flash_area_id_from_multi_image_slot(BOOT_CURR_IMG(state), slot);
2405
2406 rc = flash_area_open(area_id, &fap_src);
Tamas Banfe031092020-09-10 17:32:39 +02002407 if (rc != 0) {
2408 return BOOT_EFLASH;
2409 }
2410
2411 /* Direct copy from flash to its new location in SRAM. */
2412 rc = flash_area_read(fap_src, 0, (void *)img_dst, img_sz);
2413 if (rc != 0) {
2414 BOOT_LOG_INF("Error whilst copying image from Flash to SRAM: %d", rc);
2415 }
2416
2417 flash_area_close(fap_src);
2418
2419 return rc;
2420}
2421
Mark Horvathccaf7f82021-01-04 18:16:42 +01002422#if (BOOT_IMAGE_NUMBER > 1)
Tamas Banfe031092020-09-10 17:32:39 +02002423/**
Mark Horvathccaf7f82021-01-04 18:16:42 +01002424 * Checks if two memory regions (A and B) are overlap or not.
Tamas Banfe031092020-09-10 17:32:39 +02002425 *
Mark Horvathccaf7f82021-01-04 18:16:42 +01002426 * @param start_a Start of the A region.
2427 * @param end_a End of the A region.
2428 * @param start_b Start of the B region.
2429 * @param end_b End of the B region.
Tamas Banfe031092020-09-10 17:32:39 +02002430 *
Mark Horvathccaf7f82021-01-04 18:16:42 +01002431 * @return true if there is overlap; false otherwise.
2432 */
2433static bool
2434do_regions_overlap(uint32_t start_a, uint32_t end_a,
2435 uint32_t start_b, uint32_t end_b)
2436{
2437 if (start_b > end_a) {
2438 return false;
2439 } else if (start_b >= start_a) {
2440 return true;
2441 } else if (end_b > start_a) {
2442 return true;
2443 }
2444
2445 return false;
2446}
2447
2448/**
2449 * Checks if the image we want to load to memory overlap with an already
2450 * ramloaded image.
2451 *
2452 * @param slot_usage Information about the active and available slots.
2453 * @param image_id_to_check The ID of the image we would like to load.
2454 *
2455 * @return 0 if there is no overlap; nonzero otherwise.
Tamas Banfe031092020-09-10 17:32:39 +02002456 */
2457static int
Mark Horvathccaf7f82021-01-04 18:16:42 +01002458boot_check_ram_load_overlapping(struct slot_usage_t slot_usage[],
2459 uint32_t image_id_to_check)
Tamas Banfe031092020-09-10 17:32:39 +02002460{
Mark Horvathccaf7f82021-01-04 18:16:42 +01002461 uint32_t i;
2462
2463 uint32_t start_a;
2464 uint32_t end_a;
2465 uint32_t start_b;
2466 uint32_t end_b;
2467
2468 start_a = slot_usage[image_id_to_check].img_dst;
2469 /* Safe to add here, values are already verified in
2470 * boot_verify_ram_load_address() */
2471 end_a = start_a + slot_usage[image_id_to_check].img_sz;
2472
2473 for (i = 0; i < BOOT_IMAGE_NUMBER; i++) {
2474 if (slot_usage[i].active_slot == NO_ACTIVE_SLOT
2475 || i == image_id_to_check) {
2476 continue;
2477 }
2478
2479 start_b = slot_usage[i].img_dst;
2480 /* Safe to add here, values are already verified in
2481 * boot_verify_ram_load_address() */
2482 end_b = start_b + slot_usage[i].img_sz;
2483
2484 if (do_regions_overlap(start_a, end_a, start_b, end_b)) {
2485 return -1;
2486 }
2487 }
2488
2489 return 0;
2490}
2491#endif
2492
2493/**
2494 * Loads the active slot of the current image into SRAM. The load address and
2495 * image size is extracted from the image header.
2496 *
2497 * @param state Boot loader status information.
2498 * @param slot_usage Information about the active and available slots.
2499 *
2500 * @return 0 on success; nonzero on failure.
2501 */
2502static int
2503boot_load_image_to_sram(struct boot_loader_state *state,
2504 struct slot_usage_t slot_usage[])
2505{
2506 uint32_t active_slot;
2507 struct image_header *hdr = NULL;
2508 uint32_t img_dst;
2509 uint32_t img_sz;
Tamas Banfe031092020-09-10 17:32:39 +02002510 int rc;
2511
Mark Horvathccaf7f82021-01-04 18:16:42 +01002512 active_slot = slot_usage[BOOT_CURR_IMG(state)].active_slot;
2513 hdr = boot_img_hdr(state, active_slot);
2514
Tamas Banfe031092020-09-10 17:32:39 +02002515 if (hdr->ih_flags & IMAGE_F_RAM_LOAD) {
2516
Mark Horvathccaf7f82021-01-04 18:16:42 +01002517 img_dst = hdr->ih_load_addr;
Tamas Banfe031092020-09-10 17:32:39 +02002518
Mark Horvathccaf7f82021-01-04 18:16:42 +01002519 rc = boot_read_image_size(state, active_slot, &img_sz);
Tamas Banfe031092020-09-10 17:32:39 +02002520 if (rc != 0) {
2521 return rc;
2522 }
2523
Mark Horvathccaf7f82021-01-04 18:16:42 +01002524 slot_usage[BOOT_CURR_IMG(state)].img_dst = img_dst;
2525 slot_usage[BOOT_CURR_IMG(state)].img_sz = img_sz;
2526
2527 rc = boot_verify_ram_load_address(state, slot_usage);
Tamas Banfe031092020-09-10 17:32:39 +02002528 if (rc != 0) {
Mark Horvathccaf7f82021-01-04 18:16:42 +01002529 BOOT_LOG_INF("Image RAM load address 0x%x is invalid.", img_dst);
Tamas Banfe031092020-09-10 17:32:39 +02002530 return rc;
2531 }
2532
Mark Horvathccaf7f82021-01-04 18:16:42 +01002533#if (BOOT_IMAGE_NUMBER > 1)
2534 rc = boot_check_ram_load_overlapping(slot_usage, BOOT_CURR_IMG(state));
2535 if (rc != 0) {
2536 BOOT_LOG_INF("Image RAM loading to address 0x%x would overlap with\
2537 another image.", img_dst);
2538 return rc;
2539 }
2540#endif
2541
Tamas Banfe031092020-09-10 17:32:39 +02002542 /* Copy image to the load address from where it currently resides in
2543 * flash.
2544 */
Mark Horvathccaf7f82021-01-04 18:16:42 +01002545 rc = boot_copy_image_to_sram(state, active_slot, img_dst, img_sz);
Tamas Banfe031092020-09-10 17:32:39 +02002546 if (rc != 0) {
Mark Horvathccaf7f82021-01-04 18:16:42 +01002547 BOOT_LOG_INF("RAM loading to 0x%x is failed.", img_dst);
Tamas Banfe031092020-09-10 17:32:39 +02002548 } else {
Mark Horvathccaf7f82021-01-04 18:16:42 +01002549 BOOT_LOG_INF("RAM loading to 0x%x is succeeded.", img_dst);
Tamas Banfe031092020-09-10 17:32:39 +02002550 }
2551 } else {
2552 /* Only images that support IMAGE_F_RAM_LOAD are allowed if
2553 * MCUBOOT_RAM_LOAD is set.
2554 */
2555 rc = BOOT_EBADIMAGE;
2556 }
2557
Mark Horvathccaf7f82021-01-04 18:16:42 +01002558 if (rc != 0) {
2559 slot_usage[BOOT_CURR_IMG(state)].img_dst = 0;
2560 slot_usage[BOOT_CURR_IMG(state)].img_sz = 0;
2561 }
2562
Tamas Banfe031092020-09-10 17:32:39 +02002563 return rc;
2564}
2565
2566/**
2567 * Removes an image from SRAM, by overwriting it with zeros.
2568 *
Mark Horvathccaf7f82021-01-04 18:16:42 +01002569 * @param state Boot loader status information.
2570 * @param slot_usage Information about the active and available slots.
2571 *
2572 * @return 0 on success; nonzero on failure.
2573 */
2574static inline int
2575boot_remove_image_from_sram(struct boot_loader_state *state,
2576 struct slot_usage_t slot_usage[])
2577{
2578 BOOT_LOG_INF("Removing image from SRAM at address 0x%x",
2579 slot_usage[BOOT_CURR_IMG(state)].img_dst);
2580
2581 memset((void*)slot_usage[BOOT_CURR_IMG(state)].img_dst, 0,
2582 slot_usage[BOOT_CURR_IMG(state)].img_sz);
2583
2584 slot_usage[BOOT_CURR_IMG(state)].img_dst = 0;
2585 slot_usage[BOOT_CURR_IMG(state)].img_sz = 0;
2586
2587 return 0;
2588}
2589
2590/**
2591 * Removes an image from flash by erasing the corresponding flash area
2592 *
2593 * @param state Boot loader status information.
2594 * @param slot The flash slot of the image to be erased.
Tamas Banfe031092020-09-10 17:32:39 +02002595 *
2596 * @return 0 on success; nonzero on failure.
2597 */
2598static inline int
Mark Horvathccaf7f82021-01-04 18:16:42 +01002599boot_remove_image_from_flash(struct boot_loader_state *state, uint32_t slot)
Tamas Banfe031092020-09-10 17:32:39 +02002600{
Mark Horvathccaf7f82021-01-04 18:16:42 +01002601 int area_id;
2602 int rc;
2603 const struct flash_area *fap;
Tamas Banfe031092020-09-10 17:32:39 +02002604
Mark Horvathccaf7f82021-01-04 18:16:42 +01002605 BOOT_LOG_INF("Removing image %d slot %d from flash", BOOT_CURR_IMG(state),
2606 slot);
2607 area_id = flash_area_id_from_multi_image_slot(BOOT_CURR_IMG(state), slot);
2608 rc = flash_area_open(area_id, &fap);
2609 if (rc == 0) {
2610 flash_area_erase(fap, 0, fap->fa_size);
2611 }
2612
2613 return rc;
Tamas Banfe031092020-09-10 17:32:39 +02002614}
2615#endif /* MCUBOOT_RAM_LOAD */
2616
Mark Horvathccaf7f82021-01-04 18:16:42 +01002617#if (BOOT_IMAGE_NUMBER > 1)
2618/**
2619 * Checks the image dependency whether it is satisfied.
2620 *
2621 * @param state Boot loader status information.
2622 * @param slot_usage Information about the active and available slots.
2623 * @param dep Image dependency which has to be verified.
2624 *
2625 * @return 0 if dependencies are met; nonzero otherwise.
2626 */
2627static int
2628boot_verify_slot_dependency(struct boot_loader_state *state,
2629 struct slot_usage_t slot_usage[],
2630 struct image_dependency *dep)
David Vinczee574f2d2020-07-10 11:42:03 +02002631{
Mark Horvathccaf7f82021-01-04 18:16:42 +01002632 struct image_version *dep_version;
2633 uint32_t dep_slot;
David Vinczee574f2d2020-07-10 11:42:03 +02002634 int rc;
2635
Mark Horvathccaf7f82021-01-04 18:16:42 +01002636 /* Determine the source of the image which is the subject of
2637 * the dependency and get it's version.
David Vinczee574f2d2020-07-10 11:42:03 +02002638 */
Mark Horvathccaf7f82021-01-04 18:16:42 +01002639 dep_slot = slot_usage[dep->image_id].active_slot;
2640 dep_version = &state->imgs[dep->image_id][dep_slot].hdr.ih_ver;
2641
2642 rc = boot_version_cmp(dep_version, &dep->image_min_version);
2643 if (rc >= 0) {
2644 /* Dependency satisfied. */
2645 rc = 0;
David Vinczee574f2d2020-07-10 11:42:03 +02002646 }
2647
Mark Horvathccaf7f82021-01-04 18:16:42 +01002648 return rc;
2649}
2650
2651/**
2652 * Reads all dependency TLVs of an image and verifies one after another to see
2653 * if they are all satisfied.
2654 *
2655 * @param state Boot loader status information.
2656 * @param slot_usage Information about the active and available slots.
2657 *
2658 * @return 0 if dependencies are met; nonzero otherwise.
2659 */
2660static int
2661boot_verify_slot_dependencies(struct boot_loader_state *state,
2662 struct slot_usage_t slot_usage[])
2663{
2664 uint32_t active_slot;
2665 const struct flash_area *fap;
2666 struct image_tlv_iter it;
2667 struct image_dependency dep;
2668 uint32_t off;
2669 uint16_t len;
2670 int area_id;
2671 int rc;
2672
2673 active_slot = slot_usage[BOOT_CURR_IMG(state)].active_slot;
2674
2675 area_id = flash_area_id_from_multi_image_slot(BOOT_CURR_IMG(state),
2676 active_slot);
2677 rc = flash_area_open(area_id, &fap);
David Vinczee574f2d2020-07-10 11:42:03 +02002678 if (rc != 0) {
Mark Horvathccaf7f82021-01-04 18:16:42 +01002679 rc = BOOT_EFLASH;
2680 goto done;
David Vinczee574f2d2020-07-10 11:42:03 +02002681 }
2682
Mark Horvathccaf7f82021-01-04 18:16:42 +01002683 rc = bootutil_tlv_iter_begin(&it, boot_img_hdr(state, active_slot), fap,
2684 IMAGE_TLV_DEPENDENCY, true);
2685 if (rc != 0) {
2686 goto done;
2687 }
David Vinczee574f2d2020-07-10 11:42:03 +02002688
Mark Horvathccaf7f82021-01-04 18:16:42 +01002689 while (true) {
2690 rc = bootutil_tlv_iter_next(&it, &off, &len, NULL);
2691 if (rc < 0) {
2692 return -1;
2693 } else if (rc > 0) {
2694 rc = 0;
2695 break;
2696 }
David Vinczee574f2d2020-07-10 11:42:03 +02002697
Mark Horvathccaf7f82021-01-04 18:16:42 +01002698 if (len != sizeof(dep)) {
2699 rc = BOOT_EBADIMAGE;
2700 goto done;
2701 }
2702
2703 rc = LOAD_IMAGE_DATA(boot_img_hdr(state, active_slot),
2704 fap, off, &dep, len);
2705 if (rc != 0) {
2706 rc = BOOT_EFLASH;
2707 goto done;
2708 }
2709
2710 if (dep.image_id >= BOOT_IMAGE_NUMBER) {
2711 rc = BOOT_EBADARGS;
2712 goto done;
2713 }
2714
2715 rc = boot_verify_slot_dependency(state, slot_usage, &dep);
2716 if (rc != 0) {
2717 /* Dependency not satisfied. */
2718 goto done;
2719 }
2720 }
2721
2722done:
2723 flash_area_close(fap);
2724 return rc;
2725}
2726
2727/**
2728 * Checks the dependency of all the active slots. If an image found with
2729 * invalid or not satisfied dependencies the image is removed from SRAM (in
2730 * case of MCUBOOT_RAM_LOAD strategy) and its slot is set to unavailable.
2731 *
2732 * @param state Boot loader status information.
2733 * @param slot_usage Information about the active and available slots.
2734 *
2735 * @return 0 if dependencies are met; nonzero otherwise.
2736 */
2737static int
2738boot_verify_dependencies(struct boot_loader_state *state,
2739 struct slot_usage_t slot_usage[])
2740{
2741 int rc = -1;
2742 uint32_t active_slot;
2743
2744 IMAGES_ITER(BOOT_CURR_IMG(state)) {
2745 rc = boot_verify_slot_dependencies(state, slot_usage);
2746 if (rc != 0) {
2747 /* Dependencies not met or invalid dependencies. */
2748
2749#ifdef MCUBOOT_RAM_LOAD
2750 boot_remove_image_from_sram(state, slot_usage);
2751#endif /* MCUBOOT_RAM_LOAD */
2752
2753 active_slot = slot_usage[BOOT_CURR_IMG(state)].active_slot;
2754 slot_usage[BOOT_CURR_IMG(state)].slot_available[active_slot] = false;
2755 slot_usage[BOOT_CURR_IMG(state)].active_slot = NO_ACTIVE_SLOT;
2756
2757 return rc;
2758 }
2759 }
2760
2761 return rc;
2762}
2763#endif /* (BOOT_IMAGE_NUMBER > 1) */
2764
2765/**
2766 * Tries to load a slot for all the images with validation.
2767 *
2768 * @param state Boot loader status information.
2769 * @param slot_usage Information about the active and available slots.
2770 *
2771 * @return 0 on success; nonzero on failure.
2772 */
2773fih_int
2774boot_load_and_validate_images(struct boot_loader_state *state,
2775 struct slot_usage_t slot_usage[])
2776{
2777 uint32_t active_slot;
2778 int rc;
2779 fih_int fih_rc;
2780
2781 /* Go over all the images and try to load one */
2782 IMAGES_ITER(BOOT_CURR_IMG(state)) {
2783 /* All slots tried until a valid image found. Breaking from this loop
2784 * means that a valid image found or already loaded. If no slot is
2785 * found the function returns with error code. */
2786 while (true) {
2787
2788 /* Go over all the slots and try to load one */
2789 active_slot = slot_usage[BOOT_CURR_IMG(state)].active_slot;
2790 if (active_slot != NO_ACTIVE_SLOT){
2791 /* A slot is already active, go to next image. */
2792 break;
David Vinczee574f2d2020-07-10 11:42:03 +02002793 }
David Vincze505fba22020-10-22 13:53:29 +02002794
Mark Horvathccaf7f82021-01-04 18:16:42 +01002795 active_slot = find_slot_with_highest_version(state,
2796 slot_usage);
2797 if (active_slot == NO_ACTIVE_SLOT) {
2798 BOOT_LOG_INF("No slot to load for image %d",
2799 BOOT_CURR_IMG(state));
2800 FIH_RET(FIH_FAILURE);
2801 }
2802
2803 /* Save the number of the active slot. */
2804 slot_usage[BOOT_CURR_IMG(state)].active_slot = active_slot;
2805
2806#ifdef MCUBOOT_DIRECT_XIP
2807 rc = boot_rom_address_check(state, slot_usage);
2808 if (rc != 0) {
2809 /* The image is placed in an unsuitable slot. */
2810 slot_usage[BOOT_CURR_IMG(state)].slot_available[active_slot] = false;
2811 slot_usage[BOOT_CURR_IMG(state)].active_slot = NO_ACTIVE_SLOT;
2812 continue;
2813 }
George Becksteind4d90f82021-05-11 02:00:00 -04002814
David Vincze505fba22020-10-22 13:53:29 +02002815#ifdef MCUBOOT_DIRECT_XIP_REVERT
Mark Horvathccaf7f82021-01-04 18:16:42 +01002816 rc = boot_select_or_erase(state, slot_usage);
David Vincze505fba22020-10-22 13:53:29 +02002817 if (rc != 0) {
2818 /* The selected image slot has been erased. */
Mark Horvathccaf7f82021-01-04 18:16:42 +01002819 slot_usage[BOOT_CURR_IMG(state)].slot_available[active_slot] = false;
2820 slot_usage[BOOT_CURR_IMG(state)].active_slot = NO_ACTIVE_SLOT;
David Vincze505fba22020-10-22 13:53:29 +02002821 continue;
2822 }
2823#endif /* MCUBOOT_DIRECT_XIP_REVERT */
David Vincze1c456242021-06-29 15:25:24 +02002824#endif /* MCUBOOT_DIRECT_XIP */
David Vincze505fba22020-10-22 13:53:29 +02002825
Tamas Banfe031092020-09-10 17:32:39 +02002826#ifdef MCUBOOT_RAM_LOAD
2827 /* Image is first loaded to RAM and authenticated there in order to
2828 * prevent TOCTOU attack during image copy. This could be applied
2829 * when loading images from external (untrusted) flash to internal
2830 * (trusted) RAM and image is authenticated before copying.
2831 */
Mark Horvathccaf7f82021-01-04 18:16:42 +01002832 rc = boot_load_image_to_sram(state, slot_usage);
Tamas Banfe031092020-09-10 17:32:39 +02002833 if (rc != 0 ) {
Mark Horvathccaf7f82021-01-04 18:16:42 +01002834 /* Image cannot be ramloaded. */
2835 boot_remove_image_from_flash(state, active_slot);
2836 slot_usage[BOOT_CURR_IMG(state)].slot_available[active_slot] = false;
2837 slot_usage[BOOT_CURR_IMG(state)].active_slot = NO_ACTIVE_SLOT;
Tamas Banfe031092020-09-10 17:32:39 +02002838 continue;
Tamas Banfe031092020-09-10 17:32:39 +02002839 }
2840#endif /* MCUBOOT_RAM_LOAD */
Mark Horvathccaf7f82021-01-04 18:16:42 +01002841
2842 FIH_CALL(boot_validate_slot, fih_rc, state, active_slot, NULL);
2843 if (fih_not_eq(fih_rc, FIH_SUCCESS)) {
2844 /* Image is invalid. */
Tamas Banfe031092020-09-10 17:32:39 +02002845#ifdef MCUBOOT_RAM_LOAD
Mark Horvathccaf7f82021-01-04 18:16:42 +01002846 boot_remove_image_from_sram(state, slot_usage);
Tamas Banfe031092020-09-10 17:32:39 +02002847#endif /* MCUBOOT_RAM_LOAD */
Mark Horvathccaf7f82021-01-04 18:16:42 +01002848 slot_usage[BOOT_CURR_IMG(state)].slot_available[active_slot] = false;
2849 slot_usage[BOOT_CURR_IMG(state)].active_slot = NO_ACTIVE_SLOT;
2850 continue;
David Vincze505fba22020-10-22 13:53:29 +02002851 }
Mark Horvathccaf7f82021-01-04 18:16:42 +01002852
2853 /* Valid image loaded from a slot, go to next image. */
2854 break;
2855 }
2856 }
2857
2858 FIH_RET(FIH_SUCCESS);
2859}
2860
2861/**
2862 * Updates the security counter for the current image.
2863 *
2864 * @param state Boot loader status information.
2865 * @param active_slot Index of the slot will be loaded for current image.
2866 *
2867 * @return 0 on success; nonzero on failure.
2868 */
2869static int
2870boot_update_hw_rollback_protection(struct boot_loader_state *state,
2871 uint32_t active_slot)
2872{
2873#ifdef MCUBOOT_HW_ROLLBACK_PROT
2874 int rc;
2875
2876 /* Update the stored security counter with the newer (active) image's
2877 * security counter value.
2878 */
David Vincze1c456242021-06-29 15:25:24 +02002879#if defined(MCUBOOT_DIRECT_XIP) && defined(MCUBOOT_DIRECT_XIP_REVERT)
Mark Horvathccaf7f82021-01-04 18:16:42 +01002880 /* When the 'revert' mechanism is enabled in direct-xip mode, the
2881 * security counter can be increased only after reboot, if the image
2882 * has been confirmed at runtime (the image_ok flag has been set).
2883 * This way a 'revert' can be performed when it's necessary.
2884 */
2885 if (slot_usage[BOOT_CURR_IMG(state)].swap_state.image_ok == BOOT_FLAG_SET) {
David Vincze505fba22020-10-22 13:53:29 +02002886#endif
Mark Horvathccaf7f82021-01-04 18:16:42 +01002887 rc = boot_update_security_counter(BOOT_CURR_IMG(state), active_slot,
2888 boot_img_hdr(state, active_slot));
David Vinczee574f2d2020-07-10 11:42:03 +02002889 if (rc != 0) {
Mark Horvathccaf7f82021-01-04 18:16:42 +01002890 BOOT_LOG_ERR("Security counter update failed after image "
2891 "validation.");
2892 return rc;
David Vinczee574f2d2020-07-10 11:42:03 +02002893 }
David Vincze1c456242021-06-29 15:25:24 +02002894#if defined(MCUBOOT_DIRECT_XIP) && defined(MCUBOOT_DIRECT_XIP_REVERT)
Mark Horvathccaf7f82021-01-04 18:16:42 +01002895 }
2896#endif
David Vinczee574f2d2020-07-10 11:42:03 +02002897
Mark Horvathccaf7f82021-01-04 18:16:42 +01002898 return 0;
David Vinczee574f2d2020-07-10 11:42:03 +02002899
Mark Horvathccaf7f82021-01-04 18:16:42 +01002900#else /* MCUBOOT_HW_ROLLBACK_PROT */
2901 (void) (state);
2902 (void) (active_slot);
David Vinczee574f2d2020-07-10 11:42:03 +02002903
Mark Horvathccaf7f82021-01-04 18:16:42 +01002904 return 0;
2905#endif
2906}
2907
2908fih_int
2909context_boot_go(struct boot_loader_state *state, struct boot_rsp *rsp)
2910{
2911 struct slot_usage_t slot_usage[BOOT_IMAGE_NUMBER];
2912 int rc;
2913 fih_int fih_rc;
2914 uint32_t active_slot;
2915
2916 memset(state, 0, sizeof(struct boot_loader_state));
2917 memset(slot_usage, 0, sizeof(struct slot_usage_t) * BOOT_IMAGE_NUMBER);
2918
2919 rc = boot_get_slot_usage(state, slot_usage);
2920 if (rc != 0) {
David Vinczee574f2d2020-07-10 11:42:03 +02002921 goto out;
2922 }
2923
Mark Horvathccaf7f82021-01-04 18:16:42 +01002924#if (BOOT_IMAGE_NUMBER > 1)
2925 while (true) {
2926#endif
2927 FIH_CALL(boot_load_and_validate_images, fih_rc, state, slot_usage);
2928 if (fih_not_eq(fih_rc, FIH_SUCCESS)) {
2929 goto out;
2930 }
2931
2932#if (BOOT_IMAGE_NUMBER > 1)
2933 rc = boot_verify_dependencies(state, slot_usage);
2934 if (rc != 0) {
2935 /* Dependency check failed for an image, it has been removed from
2936 * SRAM in case of MCUBOOT_RAM_LOAD strategy, and set to
2937 * unavailable. Try to load an image from another slot.
2938 */
2939 continue;
2940 }
2941 /* Dependency check was successful. */
2942 break;
2943 }
2944#endif
2945
2946 IMAGES_ITER(BOOT_CURR_IMG(state)) {
2947
2948 active_slot = slot_usage[BOOT_CURR_IMG(state)].active_slot;
2949
2950 rc = boot_update_hw_rollback_protection(state, active_slot);
2951 if (rc != 0) {
2952 goto out;
2953 }
2954
2955 rc = boot_add_shared_data(state, active_slot);
2956 if (rc != 0) {
2957 goto out;
2958 }
2959 }
2960
2961 /* All image loaded successfully. */
2962#ifdef MCUBOOT_HAVE_LOGGING
2963 print_loaded_images(state, slot_usage);
2964#endif
2965
2966 fill_rsp(state, slot_usage, rsp);
2967
David Vinczee574f2d2020-07-10 11:42:03 +02002968out:
Mark Horvathccaf7f82021-01-04 18:16:42 +01002969 close_all_flash_areas(state);
Raef Colese8fe6cf2020-05-26 13:07:40 +01002970
Mark Horvathccaf7f82021-01-04 18:16:42 +01002971 if (fih_eq(fih_rc, FIH_SUCCESS)) {
2972 fih_rc = fih_int_encode(rc);
2973 }
Raef Colese8fe6cf2020-05-26 13:07:40 +01002974
Mark Horvathccaf7f82021-01-04 18:16:42 +01002975 FIH_RET(fih_rc);
David Vinczee574f2d2020-07-10 11:42:03 +02002976}
Tamas Banfe031092020-09-10 17:32:39 +02002977#endif /* MCUBOOT_DIRECT_XIP || MCUBOOT_RAM_LOAD */
David Vinczee574f2d2020-07-10 11:42:03 +02002978
2979/**
Raef Colese8fe6cf2020-05-26 13:07:40 +01002980 * Prepares the booting process. This function moves images around in flash as
David Vinczee574f2d2020-07-10 11:42:03 +02002981 * appropriate, and tells you what address to boot from.
2982 *
2983 * @param rsp On success, indicates how booting should occur.
2984 *
Raef Colese8fe6cf2020-05-26 13:07:40 +01002985 * @return FIH_SUCCESS on success; nonzero on failure.
David Vinczee574f2d2020-07-10 11:42:03 +02002986 */
Raef Colese8fe6cf2020-05-26 13:07:40 +01002987fih_int
David Vinczee574f2d2020-07-10 11:42:03 +02002988boot_go(struct boot_rsp *rsp)
2989{
Raef Colese8fe6cf2020-05-26 13:07:40 +01002990 fih_int fih_rc = FIH_FAILURE;
2991 FIH_CALL(context_boot_go, fih_rc, &boot_data, rsp);
2992 FIH_RET(fih_rc);
David Vinczee574f2d2020-07-10 11:42:03 +02002993}