blob: fc211c369545305fa601c4217e13c8c3ee396c65 [file] [log] [blame]
David Vincze03368b82020-04-01 12:53:53 +02001# Copyright (c) 2017-2020 Linaro Limited
David Vinczec3084132020-02-18 14:50:47 +01002# Copyright (c) 2020 Arm Limited
Mateusz Michalekc3a72e92024-01-09 08:30:58 +01003# Copyright (c) 2023 Nordic Semiconductor ASA
Andrzej Puzdrowski64ad0922017-09-22 11:33:41 +02004#
5# SPDX-License-Identifier: Apache-2.0
6#
7
Marti Bolivar0e091c92018-04-12 11:23:16 -04008mainmenu "MCUboot configuration"
Andrzej Puzdrowski64ad0922017-09-22 11:33:41 +02009
Marti Bolivar0e091c92018-04-12 11:23:16 -040010comment "MCUboot-specific configuration options"
Andrzej Puzdrowski64ad0922017-09-22 11:33:41 +020011
Emanuele Di Santo865777d2018-11-08 11:28:15 +010012# Hidden option to mark a project as MCUboot
13config MCUBOOT
14 default y
15 bool
Rajavardhan Gundi07ba28f2018-12-10 15:44:48 +053016 select MPU_ALLOW_FLASH_WRITE if ARM_MPU
Marcin Niestrojc6be76a2020-03-22 14:39:35 +010017 select USE_DT_CODE_PARTITION if HAS_FLASH_LOAD_OFFSET
Andrzej Puzdrowskif573b392020-11-10 14:35:15 +010018 select MCUBOOT_BOOTUTIL_LIB
Emanuele Di Santo865777d2018-11-08 11:28:15 +010019
Marti Bolivarbc2fa4e2018-04-12 12:18:32 -040020config BOOT_USE_MBEDTLS
21 bool
22 # Hidden option
23 default n
24 help
25 Use mbedTLS for crypto primitives.
26
27config BOOT_USE_TINYCRYPT
28 bool
29 # Hidden option
30 default n
Sebastian Bøe913a3852019-01-22 13:53:12 +010031 # When building for ECDSA, we use our own copy of mbedTLS, so the
32 # Zephyr one must not be enabled or the MBEDTLS_CONFIG_FILE macros
33 # will collide.
Xudong Zheng8cee3552023-12-26 21:28:38 -050034 select MBEDTLS_PROMPTLESS if ZEPHYR_MBEDTLS_MODULE
Marti Bolivarbc2fa4e2018-04-12 12:18:32 -040035 help
36 Use TinyCrypt for crypto primitives.
37
Sigvart Hovlandebd05032019-03-21 10:47:32 +010038config BOOT_USE_CC310
39 bool
40 # Hidden option
41 default n
42 # When building for ECDSA, we use our own copy of mbedTLS, so the
43 # Zephyr one must not be enabled or the MBEDTLS_CONFIG_FILE macros
44 # will collide.
Sigvart Hovlandebd05032019-03-21 10:47:32 +010045 help
46 Use cc310 for crypto primitives.
47
48config BOOT_USE_NRF_CC310_BL
49 bool
50 default n
51
52config NRFXLIB_CRYPTO
53 bool
54 default n
55
56config NRF_CC310_BL
57 bool
58 default n
59
Andrzej Puzdrowski97543282018-04-12 15:16:56 +020060menu "MCUBoot settings"
61
Andrzej Puzdrowskifdff3e12020-09-15 08:23:25 +020062config SINGLE_APPLICATION_SLOT
63 bool "Single slot bootloader"
Dominik Ermel4dc3f442020-05-26 08:45:14 +000064 default n
65 help
66 Single image area is used for application which means that
67 uploading a new application overwrites the one that previously
68 occupied the area.
69
Håkon Øye Amundsen21f03762021-11-12 08:21:31 +000070choice BOOT_SIGNATURE_TYPE
Marti Bolivarbc2fa4e2018-04-12 12:18:32 -040071 prompt "Signature type"
72 default BOOT_SIGNATURE_TYPE_RSA
73
Arvin Farahmandfb5ec182020-05-05 11:44:12 -040074config BOOT_SIGNATURE_TYPE_NONE
75 bool "No signature; use only hash check"
76 select BOOT_USE_TINYCRYPT
77
Marti Bolivarbc2fa4e2018-04-12 12:18:32 -040078config BOOT_SIGNATURE_TYPE_RSA
79 bool "RSA signatures"
80 select BOOT_USE_MBEDTLS
Marti Bolivara4818a52018-04-12 13:02:38 -040081 select MBEDTLS
Jamie McCrae25d2f2c2023-07-17 14:17:53 +010082 select BOOT_ENCRYPTION_SUPPORT
Marti Bolivarbc2fa4e2018-04-12 12:18:32 -040083
Fabio Utzig105b59a2019-05-13 15:08:12 -070084if BOOT_SIGNATURE_TYPE_RSA
85config BOOT_SIGNATURE_TYPE_RSA_LEN
86 int "RSA signature length"
87 range 2048 3072
88 default 2048
89endif
90
Marti Bolivarbc2fa4e2018-04-12 12:18:32 -040091config BOOT_SIGNATURE_TYPE_ECDSA_P256
92 bool "Elliptic curve digital signatures with curve P-256"
Jamie McCrae25d2f2c2023-07-17 14:17:53 +010093 select BOOT_ENCRYPTION_SUPPORT
Marti Bolivarbc2fa4e2018-04-12 12:18:32 -040094
Sigvart Hovlandebd05032019-03-21 10:47:32 +010095if BOOT_SIGNATURE_TYPE_ECDSA_P256
Håkon Øye Amundsen21f03762021-11-12 08:21:31 +000096choice BOOT_ECDSA_IMPLEMENTATION
Sigvart Hovlandebd05032019-03-21 10:47:32 +010097 prompt "Ecdsa implementation"
Fabio Utzig34e93a52020-02-03 09:59:53 -030098 default BOOT_ECDSA_TINYCRYPT
Håkon Øye Amundsenee7282d2020-09-28 09:48:29 +000099
Fabio Utzig34e93a52020-02-03 09:59:53 -0300100config BOOT_ECDSA_TINYCRYPT
Sigvart Hovlandebd05032019-03-21 10:47:32 +0100101 bool "Use tinycrypt"
102 select BOOT_USE_TINYCRYPT
Håkon Øye Amundsenee7282d2020-09-28 09:48:29 +0000103
104config BOOT_ECDSA_CC310
Sigvart Hovlandebd05032019-03-21 10:47:32 +0100105 bool "Use CC310"
Håkon Øye Amundsenee7282d2020-09-28 09:48:29 +0000106 depends on HAS_HW_NRF_CC310
107 select BOOT_USE_NRF_CC310_BL
108 select NRF_CC310_BL
109 select NRFXLIB_CRYPTO
Sigvart Hovlandebd05032019-03-21 10:47:32 +0100110 select BOOT_USE_CC310
Håkon Øye Amundsenee7282d2020-09-28 09:48:29 +0000111endchoice # Ecdsa implementation
Sigvart Hovlandebd05032019-03-21 10:47:32 +0100112endif
Fabio Utzig34e93a52020-02-03 09:59:53 -0300113
114config BOOT_SIGNATURE_TYPE_ED25519
115 bool "Edwards curve digital signatures using ed25519"
Jamie McCrae25d2f2c2023-07-17 14:17:53 +0100116 select BOOT_ENCRYPTION_SUPPORT
Fabio Utzig34e93a52020-02-03 09:59:53 -0300117
118if BOOT_SIGNATURE_TYPE_ED25519
Håkon Øye Amundsen21f03762021-11-12 08:21:31 +0000119choice BOOT_ED25519_IMPLEMENTATION
Fabio Utzig34e93a52020-02-03 09:59:53 -0300120 prompt "Ecdsa implementation"
121 default BOOT_ED25519_TINYCRYPT
122config BOOT_ED25519_TINYCRYPT
123 bool "Use tinycrypt"
124 select BOOT_USE_TINYCRYPT
125config BOOT_ED25519_MBEDTLS
126 bool "Use mbedTLS"
127 select BOOT_USE_MBEDTLS
128 select MBEDTLS
129endchoice
130endif
131
Marti Bolivarbc2fa4e2018-04-12 12:18:32 -0400132endchoice
133
Fabio Utzigc690c762018-04-26 10:51:09 -0300134config BOOT_SIGNATURE_KEY_FILE
135 string "PEM key file"
Håkon Øye Amundsen705c6c22020-09-28 09:45:40 +0000136 default "root-ec-p256.pem" if BOOT_SIGNATURE_TYPE_ECDSA_P256
137 default "root-ed25519.pem" if BOOT_SIGNATURE_TYPE_ED25519
138 default "root-rsa-3072.pem" if BOOT_SIGNATURE_TYPE_RSA && BOOT_SIGNATURE_TYPE_RSA_LEN=3072
139 default "root-rsa-2048.pem" if BOOT_SIGNATURE_TYPE_RSA && BOOT_SIGNATURE_TYPE_RSA_LEN=2048
Fabio Utzigc690c762018-04-26 10:51:09 -0300140 default ""
141 help
Marek Pietabdcfc852020-08-04 02:22:55 -0700142 You can use either absolute or relative path.
143 In case relative path is used, the build system assumes that it starts
144 from the directory where the MCUBoot KConfig configuration file is
145 located. If the key file is not there, the build system uses relative
146 path that starts from the MCUBoot repository root directory.
Fabio Utzigc690c762018-04-26 10:51:09 -0300147 The key file will be parsed by imgtool's getpub command and a .c source
148 with the public key information will be written in a format expected by
149 MCUboot.
150
Andrzej Puzdrowski9a605b62020-03-16 13:34:30 +0100151config MCUBOOT_CLEANUP_ARM_CORE
152 bool "Perform core cleanup before chain-load the application"
153 depends on CPU_CORTEX_M
Jamie McCrae9e8eddc2023-02-27 12:51:09 +0000154 default y
Ioannis Glaropoulos518d93a2020-10-22 14:22:14 +0200155 help
156 This option instructs MCUboot to perform a clean-up of a set of
Marcin Niestroj9ced4592023-05-17 14:50:57 +0200157 architecture core HW registers before jumping to the application
Ioannis Glaropoulos518d93a2020-10-22 14:22:14 +0200158 firmware. The clean-up sets these registers to their warm-reset
159 values as specified by the architecture.
160
Jamie McCrae9e8eddc2023-02-27 12:51:09 +0000161 This option is enabled by default to prevent possible problems when
162 booting zephyr (or other) applications whereby e.g. a MPU stack guard
163 may be initialised in RAM which is then used by the application
164 start-up code which can cause a module fault and potentially make the
165 module irrecoverable.
Andrzej Puzdrowski9a605b62020-03-16 13:34:30 +0100166
Marti Bolivara4818a52018-04-12 13:02:38 -0400167config MBEDTLS_CFG_FILE
168 default "mcuboot-mbedtls-cfg.h"
169
David Vincze03368b82020-04-01 12:53:53 +0200170config BOOT_HW_KEY
171 bool "Use HW key for image verification"
172 default n
173 help
174 Use HW key for image verification, otherwise the public key is embedded
175 in MCUBoot. If enabled the public key is appended to the signed image
176 and requires the hash of the public key to be provisioned to the device
177 beforehand.
178
Marti Bolivarbc2fa4e2018-04-12 12:18:32 -0400179config BOOT_VALIDATE_SLOT0
David Vincze2d736ad2019-02-18 11:50:22 +0100180 bool "Validate image in the primary slot on every boot"
Marti Bolivarbc2fa4e2018-04-12 12:18:32 -0400181 default y
182 help
David Vincze2d736ad2019-02-18 11:50:22 +0100183 If y, the bootloader attempts to validate the signature of the
184 primary slot every boot. This adds the signature check time to
Marti Bolivarbc2fa4e2018-04-12 12:18:32 -0400185 every boot, but can mitigate against some changes that are
186 able to modify the flash image itself.
187
Wouter Cappellebb7a39d2021-05-03 16:44:44 +0200188config BOOT_VALIDATE_SLOT0_ONCE
189 bool "Validate image in the primary slot just once after after upgrade"
190 depends on !BOOT_VALIDATE_SLOT0 && SINGLE_APPLICATION_SLOT
191 default n
192 help
193 If y, the bootloader attempts to validate the signature of the
194 primary slot only once after an upgrade of the main slot.
195 It caches the result in the magic area, which makes it an unsecure
196 method. This option is usefull for lowering the boot up time for
197 low end devices with as a compromise lowering the security level.
198 If unsure, leave at the default value.
199
David Brown08a30a42022-04-26 14:49:51 -0600200config BOOT_PREFER_SWAP_MOVE
201 bool "Prefer the newer swap move algorithm"
202 default y if SOC_FAMILY_NRF
Thomas Strangeraa217e22022-10-28 21:17:55 +0200203 default y if !$(dt_nodelabel_enabled,scratch_partition)
David Brown08a30a42022-04-26 14:49:51 -0600204 help
205 If y, the BOOT_IMAGE_UPGRADE_MODE will default to using
206 "move" instead of "scratch". This is a separate bool config
207 option, because Kconfig doesn't allow defaults to be
208 overridden in choice options. Most devices should be using
209 swap move.
210
Andrzej Puzdrowskifdff3e12020-09-15 08:23:25 +0200211if !SINGLE_APPLICATION_SLOT
Håkon Øye Amundsen21f03762021-11-12 08:21:31 +0000212choice BOOT_IMAGE_UPGRADE_MODE
David Vincze5a6e1812020-06-29 13:34:42 +0200213 prompt "Image upgrade modes"
David Brown08a30a42022-04-26 14:49:51 -0600214 default BOOT_SWAP_USING_MOVE if BOOT_PREFER_SWAP_MOVE
David Vincze5a6e1812020-06-29 13:34:42 +0200215 default BOOT_SWAP_USING_SCRATCH
216
217config BOOT_SWAP_USING_SCRATCH
218 bool "Swap mode that run with the scratch partition"
219 help
220 This is the most conservative swap mode but it can work even on
221 devices with heterogeneous flash page layout.
222
Marti Bolivarbc2fa4e2018-04-12 12:18:32 -0400223config BOOT_UPGRADE_ONLY
224 bool "Overwrite image updates instead of swapping"
Marti Bolivarbc2fa4e2018-04-12 12:18:32 -0400225 help
David Vincze2d736ad2019-02-18 11:50:22 +0100226 If y, overwrite the primary slot with the upgrade image instead
227 of swapping them. This prevents the fallback recovery, but
Marti Bolivarbc2fa4e2018-04-12 12:18:32 -0400228 uses a much simpler code path.
229
Fabio Utzigc58842e2019-11-28 10:30:01 -0300230config BOOT_SWAP_USING_MOVE
Fabio Utzigdd2b6802020-01-06 09:10:45 -0300231 bool "Swap mode that can run without a scratch partition"
Fabio Utzigc58842e2019-11-28 10:30:01 -0300232 help
233 If y, the swap upgrade is done in two steps, where first every
234 sector of the primary slot is moved up one sector, then for
235 each sector X in the secondary slot, it is moved to index X in
236 the primary slot, then the sector at X+1 in the primary is
237 moved to index X in the secondary.
238 This allows a swap upgrade without using a scratch partition,
239 but is currently limited to all sectors in both slots being of
240 the same size.
David Vincze5a6e1812020-06-29 13:34:42 +0200241
242config BOOT_DIRECT_XIP
243 bool "Run the latest image directly from its slot"
244 help
245 If y, mcuboot selects the newest valid image based on the image version
246 numbers, thereafter the selected image can run directly from its slot
247 without having to move/copy it into the primary slot. For this reason the
248 images must be linked to be executed from the given image slot. Using this
249 mode results in a simpler code path and smaller code size.
250
Johan Öhmanb5889072022-04-01 09:10:28 +0200251config BOOT_RAM_LOAD
252 bool "RAM load"
253 help
254 If y, mcuboot selects the newest valid image based on the image version
255 numbers, thereafter the selected image is copied to RAM and executed from
256 there. For this reason, the image has to be linked to be executed from RAM.
257 The address that the image is copied to is specified using the load-addr
258 argument to the imgtool.py script which writes it to the image header.
259
Jamie McCrae215345f2023-08-16 07:37:18 +0100260config BOOT_FIRMWARE_LOADER
261 bool "Firmware loader"
262 help
263 If y, mcuboot will have a single application slot, and the secondary
264 slot will be for a non-upgradeable firmware loaded image (e.g. for
265 loading firmware via Bluetooth). The main application will boot by
266 default unless there is an error with it or the boot mode has been
267 forced to the firmware loader.
268
269 Note: The firmware loader image must be signed with the same signing
270 key as the primary image.
271
David Vincze5a6e1812020-06-29 13:34:42 +0200272endchoice
Fabio Utzigc58842e2019-11-28 10:30:01 -0300273
Johan Öhmanb5889072022-04-01 09:10:28 +0200274# Workaround for not being able to have commas in macro arguments
275DT_CHOSEN_Z_SRAM := zephyr,sram
276
277if BOOT_RAM_LOAD
278config BOOT_IMAGE_EXECUTABLE_RAM_START
279 hex "Boot image executable ram start"
280 default $(dt_chosen_reg_addr_hex,$(DT_CHOSEN_Z_SRAM))
281
282config BOOT_IMAGE_EXECUTABLE_RAM_SIZE
283 int "Boot image executable base size"
284 default $(dt_chosen_reg_size_int,$(DT_CHOSEN_Z_SRAM),0)
285endif
286
David Vincze505fba22020-10-22 13:53:29 +0200287config BOOT_DIRECT_XIP_REVERT
288 bool "Enable the revert mechanism in direct-xip mode"
Andrzej Puzdrowski32342e72020-11-18 17:04:44 +0100289 depends on BOOT_DIRECT_XIP
David Vincze505fba22020-10-22 13:53:29 +0200290 default n
291 help
292 If y, enables the revert mechanism in direct-xip similar to the one in
293 swap mode. It requires the trailer magic to be added to the signed image.
294 When a reboot happens without the image being confirmed at runtime, the
295 bootloader considers the image faulty and erases it. After this it will
296 attempt to boot the previous image. The images can also be made permanent
297 (marked as confirmed in advance) just like in swap mode.
298
Fabio Utzigd0533ed2018-12-19 07:56:33 -0200299config BOOT_BOOTSTRAP
Sam Bristowd0ca0ff2019-10-30 20:51:35 +1300300 bool "Bootstrap erased the primary slot from the secondary slot"
Fabio Utzigd0533ed2018-12-19 07:56:33 -0200301 default n
302 help
303 If y, enables bootstraping support. Bootstrapping allows an erased
David Vincze2d736ad2019-02-18 11:50:22 +0100304 primary slot to be initialized from a valid image in the secondary slot.
Fabio Utzigd0533ed2018-12-19 07:56:33 -0200305 If unsure, leave at the default value.
306
Fabio Utzigca8ead22019-12-20 07:06:04 -0300307config BOOT_SWAP_SAVE_ENCTLV
308 bool "Save encrypted key TLVs instead of plaintext keys in swap metadata"
309 default n
Jamie McCraee9131ee2023-10-31 09:54:35 +0000310 depends on BOOT_ENCRYPT_IMAGE
Fabio Utzigca8ead22019-12-20 07:06:04 -0300311 help
312 If y, instead of saving the encrypted image keys in plaintext in the
313 swap resume metadata, save the encrypted image TLVs. This should be used
314 when there is no security mechanism protecting the data in the primary
315 slot from being dumped. If n is selected (default), the keys are written
316 after being decrypted from the image TLVs and could be read by an
317 attacker who has access to the flash contents of the primary slot (eg
318 JTAG/SWD or primary slot in external flash).
319 If unsure, leave at the default value.
320
David Vincze505fba22020-10-22 13:53:29 +0200321endif # !SINGLE_APPLICATION_SLOT
Fabio Utzigb6f014c2020-04-02 13:25:01 -0300322
Jamie McCrae25d2f2c2023-07-17 14:17:53 +0100323config BOOT_ENCRYPTION_SUPPORT
324 bool
325 help
326 Hidden option used to check if image encryption is supported.
327
328config BOOT_ENCRYPT_IMAGE
329 bool "Support for encrypted image updates"
330 depends on BOOT_ENCRYPTION_SUPPORT
331 select BOOT_ENCRYPT_RSA if BOOT_SIGNATURE_TYPE_RSA
332 select BOOT_ENCRYPT_EC256 if BOOT_SIGNATURE_TYPE_ECDSA_P256
333 select BOOT_ENCRYPT_X25519 if BOOT_SIGNATURE_TYPE_ED25519
334 depends on !SINGLE_APPLICATION_SLOT || MCUBOOT_SERIAL
335 help
336 If y, images in the secondary slot can be encrypted and are decrypted
337 on the fly when upgrading to the primary slot, as well as encrypted
338 back when swapping from the primary slot to the secondary slot. The
339 encryption mechanism must match the same type as the signature type,
340 supported types include:
341 - RSA-OAEP (2048 bits).
342 - ECIES using primitives described under "ECIES-P256 encryption" in
343 docs/encrypted_images.md.
344 - ECIES using primitives described under "ECIES-X25519 encryption"
345 in docs/encrypted_images.md.
346
347 Note that for single slot operation, this can still be used to allow
348 loading encrypted images via serial recovery which are then
349 decrypted on-the-fly without needing a second slot.
350
351config BOOT_ENCRYPT_RSA
352 bool
353 help
354 Hidden option selecting RSA encryption.
355
356config BOOT_ENCRYPT_EC256
357 bool
358 help
359 Hidden option selecting EC256 encryption.
360
361config BOOT_ENCRYPT_X25519
362 bool
363 help
364 Hidden option selecting x25519 encryption.
365
Wouter Cappelle953a7612021-05-03 16:53:05 +0200366config BOOT_ENCRYPTION_KEY_FILE
Jamie McCrae25d2f2c2023-07-17 14:17:53 +0100367 string "Encryption key file"
368 depends on BOOT_ENCRYPT_IMAGE
369 default "enc-rsa2048-priv.pem" if BOOT_ENCRYPT_RSA
370 default "enc-ec256-priv.pem" if BOOT_ENCRYPT_EC256
371 default "enc-x25519-priv.pem" if BOOT_ENCRYPT_X25519
Wouter Cappelle953a7612021-05-03 16:53:05 +0200372 default ""
373 help
374 You can use either absolute or relative path.
375 In case relative path is used, the build system assumes that it starts
376 from the directory where the MCUBoot KConfig configuration file is
377 located. If the key file is not there, the build system uses relative
378 path that starts from the MCUBoot repository root directory.
379 The key file will be parsed by imgtool's getpriv command and a .c source
380 with the public key information will be written in a format expected by
381 MCUboot.
382
Marti Bolivar0e091c92018-04-12 11:23:16 -0400383config BOOT_MAX_IMG_SECTORS
384 int "Maximum number of sectors per image slot"
385 default 128
386 help
387 This option controls the maximum number of sectors that each of
388 the two image areas can contain. Smaller values reduce MCUboot's
389 memory usage; larger values allow it to support larger images.
390 If unsure, leave at the default value.
391
Jamie McCrae4da51012023-08-03 16:23:02 +0100392config BOOT_SHARE_BACKEND_AVAILABLE
393 bool
David Vincze1cf11b52020-03-24 07:51:09 +0100394 default n
395 help
Jamie McCrae4da51012023-08-03 16:23:02 +0100396 Hidden open which indicates if there is a sharing backend available.
397
398# Workaround for not being able to have commas in macro arguments
399DT_CHOSEN_BOOTLOADER_INFO := zephyr,bootloader-info
400
401config BOOT_SHARE_BACKEND_AVAILABLE
402 bool
403 default n
404 help
405 Hidden open which indicates if there is a sharing backend available.
406
407choice BOOT_SHARE_BACKEND
408 prompt "Shared data backend"
409 default BOOT_SHARE_BACKEND_DISABLED
410
411config BOOT_SHARE_BACKEND_DISABLED
412 bool "Disabled"
413 help
414 No data sharing support.
415
416config BOOT_SHARE_BACKEND_RETENTION
417 bool "Retention"
418 depends on RETENTION
419 depends on $(dt_chosen_enabled,$(DT_CHOSEN_BOOTLOADER_INFO))
420 select BOOT_SHARE_BACKEND_AVAILABLE
421 help
422 Use retention to share data with application. Requires:
423 - Retained memory area
424 - Retention partition of retained memory area
425 - Chosen node "zephyr,bootloader-info" to be set to the retention
426 partition
427
428config BOOT_SHARE_BACKEND_EXTERNAL
429 bool "External (user-provided code)"
430 select BOOT_SHARE_BACKEND_AVAILABLE
431 help
432 Use a custom user-specified storage.
433
434endchoice
435
436menuconfig BOOT_SHARE_DATA
437 bool "Save application specific data"
438 default n
439 depends on BOOT_SHARE_BACKEND_AVAILABLE
440 help
441 This will allow data to be shared between MCUboot and an application,
442 it does not include any informatiom by default.
443
444 Note: This requires a backend to function, see
445 BOOT_SHARE_BACKEND_RETENTION for details on using the retention
446 subsystem as a backend.
447
448config BOOT_SHARE_DATA_BOOTINFO
449 bool "Save boot information data"
450 default n
451 depends on BOOT_SHARE_DATA
452 help
453 This will place information about the MCUboot configuration and
454 running application into a shared memory area.
455
456menuconfig MEASURED_BOOT
457 bool "Store the boot state/measurements in shared memory area"
458 default n
459 depends on BOOT_SHARE_BACKEND_AVAILABLE
460 help
David Vincze1cf11b52020-03-24 07:51:09 +0100461 If enabled, the bootloader will store certain boot measurements such as
462 the hash of the firmware image in a shared memory area. This data can
463 be used later by runtime services (e.g. by a device attestation service).
464
Jamie McCrae4da51012023-08-03 16:23:02 +0100465 Note: This requires a backend to function, see
466 BOOT_SHARE_BACKEND_RETENTION for details on using the retention
467 subsystem as a backend.
468
469config MEASURED_BOOT_MAX_CBOR_SIZE
470 int "Maximum CBOR size of boot state/measurements"
471 default 64
472 range 0 256
473 depends on MEASURED_BOOT
474 help
475 The maximum size of the CBOR message which stores boot
476 state/measurements.
David Vincze1cf11b52020-03-24 07:51:09 +0100477
Håkon Øye Amundsen21f03762021-11-12 08:21:31 +0000478choice BOOT_FAULT_INJECTION_HARDENING_PROFILE
Tamas Banfce87332020-07-10 12:40:11 +0100479 prompt "Fault injection hardening profile"
480 default BOOT_FIH_PROFILE_OFF
481
482config BOOT_FIH_PROFILE_OFF
483 bool "No hardening against hardware level fault injection"
484 help
485 No hardening in SW against hardware level fault injection: power or
486 clock glitching, etc.
487
488config BOOT_FIH_PROFILE_LOW
489 bool "Moderate level hardening against hardware level fault injection"
490 help
491 Moderate level hardening: Long global fail loop to avoid break out,
492 control flow integrity check to discover discrepancy in expected code
493 flow.
494
495config BOOT_FIH_PROFILE_MEDIUM
496 bool "Medium level hardening against hardware level fault injection"
497 help
498 Medium level hardening: Long global fail loop to avoid break out,
499 control flow integrity check to discover discrepancy in expected code
500 flow, double variables to discover register or memory corruption.
501
502config BOOT_FIH_PROFILE_HIGH
503 bool "Maximum level hardening against hardware level fault injection"
504 select MBEDTLS
505 help
506 Maximum level hardening: Long global fail loop to avoid break out,
507 control flow integrity check to discover discrepancy in expected code
508 flow, double variables to discover register or memory corruption, random
509 delays to make code execution less predictable. Random delays requires an
510 entropy source.
511
512endchoice
513
Josh Gao837cf882020-11-13 18:51:27 -0800514choice BOOT_USB_DFU
515 prompt "USB DFU"
516 default BOOT_USB_DFU_NO
517
518config BOOT_USB_DFU_NO
519 prompt "Disabled"
520
521config BOOT_USB_DFU_WAIT
Rajavardhan Gundi51c9d702019-02-20 14:08:52 +0530522 bool "Wait for a prescribed duration to see if USB DFU is invoked"
Johann Fischer25852972021-08-02 13:20:09 +0200523 select USB_DEVICE_STACK
Rajavardhan Gundi51c9d702019-02-20 14:08:52 +0530524 select USB_DFU_CLASS
525 select IMG_MANAGER
Dominik Ermel143485e2023-03-17 11:33:42 +0000526 select STREAM_FLASH
527 select MULTITHREADING
Rajavardhan Gundi51c9d702019-02-20 14:08:52 +0530528 help
529 If y, MCUboot waits for a prescribed duration of time to allow
530 for USB DFU to be invoked. Please note DFU always updates the
531 slot1 image.
532
Josh Gao837cf882020-11-13 18:51:27 -0800533config BOOT_USB_DFU_GPIO
534 bool "Use GPIO to detect whether to trigger DFU mode"
Johann Fischer25852972021-08-02 13:20:09 +0200535 select USB_DEVICE_STACK
Josh Gao837cf882020-11-13 18:51:27 -0800536 select USB_DFU_CLASS
537 select IMG_MANAGER
Dominik Ermel143485e2023-03-17 11:33:42 +0000538 select STREAM_FLASH
539 select MULTITHREADING
Josh Gao837cf882020-11-13 18:51:27 -0800540 help
541 If y, MCUboot uses GPIO to detect whether to invoke USB DFU.
542
543endchoice
544
545config BOOT_USB_DFU_WAIT_DELAY_MS
546 int "USB DFU wait duration"
547 depends on BOOT_USB_DFU_WAIT
548 default 12000
549 help
550 Milliseconds to wait for USB DFU to be invoked.
551
552if BOOT_USB_DFU_GPIO
553
Josh Gao837cf882020-11-13 18:51:27 -0800554config BOOT_USB_DFU_DETECT_DELAY
555 int "Serial detect pin detection delay time [ms]"
556 default 0
557 help
558 Used to prevent the bootloader from loading on button press.
559 Useful for powering on when using the same button as
560 the one used to place the device in bootloader mode.
561
562endif # BOOT_USB_DFU_GPIO
563
David Brownf6d14c22019-12-10 15:36:36 -0700564config BOOT_USE_BENCH
565 bool "Enable benchmark code"
566 default n
567 help
568 If y, adds support for simple benchmarking that can record
569 time intervals between two calls. The time printed depends
570 on the particular Zephyr target, and is generally ticks of a
571 specific board-specific timer.
572
Michael Scott74ceae52019-02-01 14:01:09 -0800573module = MCUBOOT
Piotr Mienkowski15aa6ef2019-04-08 22:48:15 +0200574module-str = MCUBoot bootloader
Michael Scott74ceae52019-02-01 14:01:09 -0800575source "subsys/logging/Kconfig.template.log_config"
Michael Scott74ceae52019-02-01 14:01:09 -0800576
Andrzej Puzdrowskiaf148532020-02-25 12:51:26 +0100577config MCUBOOT_LOG_THREAD_STACK_SIZE
578 int "Stack size for the MCUBoot log processing thread"
579 depends on LOG && !LOG_IMMEDIATE
580 default 2048 if COVERAGE_GCOV
581 default 1024 if NO_OPTIMIZATIONS
582 default 1024 if XTENSA
583 default 4096 if (X86 && X86_64)
584 default 4096 if ARM64
585 default 768
586 help
587 Set the internal stack size for MCUBoot log processing thread.
588
Andrzej Puzdrowski6c00b5e2022-04-01 16:51:27 +0200589config MCUBOOT_INDICATION_LED
590 bool "Turns on LED indication when device is in DFU"
Jamie McCrae2c867552023-07-27 14:18:47 +0100591 select GPIO
Andrzej Puzdrowski6c00b5e2022-04-01 16:51:27 +0200592 help
593 Device device activates the LED while in bootloader mode.
Jeppe Odgaard1dbe0cf2023-05-17 11:09:10 +0200594 mcuboot-led0 alias must be set in the device's .dts
Andrzej Puzdrowski6c00b5e2022-04-01 16:51:27 +0200595 definitions for this to work.
596
Andrzej Puzdrowski35f61d32022-04-01 17:00:08 +0200597rsource "Kconfig.serial_recovery"
Andrzej Puzdrowski64ad0922017-09-22 11:33:41 +0200598
Jamie McCrae215345f2023-08-16 07:37:18 +0100599rsource "Kconfig.firmware_loader"
600
Rafał Kuźniad854bb62020-06-17 15:06:47 +0200601config BOOT_INTR_VEC_RELOC
602 bool "Relocate the interrupt vector to the application"
603 default n
604 depends on SW_VECTOR_RELAY || CPU_CORTEX_M_HAS_VTOR
605 help
606 Relocate the interrupt vector to the application before it is started.
607 Select this option if application requires vector relocation,
608 but it doesn't relocate vector in its reset handler.
609
Andrzej Puzdrowski16b6d152020-06-01 14:16:54 +0200610config UPDATEABLE_IMAGE_NUMBER
611 int "Number of updateable images"
612 default 1
Andrzej Puzdrowskifdff3e12020-09-15 08:23:25 +0200613 range 1 1 if SINGLE_APPLICATION_SLOT
Andrzej Puzdrowski16b6d152020-06-01 14:16:54 +0200614 help
615 Enables support of multi image update.
616
Marek Pietaa95a41b2023-04-21 14:03:19 +0200617config BOOT_VERSION_CMP_USE_BUILD_NUMBER
618 bool "Use build number while comparing image version"
619 depends on (UPDATEABLE_IMAGE_NUMBER > 1) || BOOT_DIRECT_XIP || \
620 BOOT_RAM_LOAD || MCUBOOT_DOWNGRADE_PREVENTION
621 help
622 By default, the image version comparison relies only on version major,
623 minor and revision. Enable this option to take into account the build
624 number as well.
625
Håkon Øye Amundsen21f03762021-11-12 08:21:31 +0000626choice BOOT_DOWNGRADE_PREVENTION_CHOICE
Andrzej Puzdrowski16b6d152020-06-01 14:16:54 +0200627 prompt "Downgrade prevention"
628 optional
629
630config MCUBOOT_DOWNGRADE_PREVENTION
631 bool "SW based downgrade prevention"
Jerzy Kasenbergb8801fc2022-06-29 15:54:37 +0200632 depends on !BOOT_DIRECT_XIP
Andrzej Puzdrowski16b6d152020-06-01 14:16:54 +0200633 help
634 Prevent downgrades by enforcing incrementing version numbers.
635 When this option is set, any upgrade must have greater major version
636 or greater minor version with equal major version. This mechanism
637 only protects against some attacks against version downgrades (for
638 example, a JTAG could be used to write an older version).
639
Jerzy Kasenbergb8801fc2022-06-29 15:54:37 +0200640config MCUBOOT_DOWNGRADE_PREVENTION_SECURITY_COUNTER
641 bool "Use image security counter instead of version number"
642 depends on MCUBOOT_DOWNGRADE_PREVENTION
643 depends on (BOOT_SWAP_USING_MOVE || BOOT_SWAP_USING_SCRATCH)
644 help
645 Security counter is used for version eligibility check instead of pure
646 version. When this option is set, any upgrade must have greater or
647 equal security counter value.
648 Because of the acceptance of equal values it allows for software
649 downgrades to some extent.
650
Andrzej Puzdrowski16b6d152020-06-01 14:16:54 +0200651config MCUBOOT_HW_DOWNGRADE_PREVENTION
652 bool "HW based downgrade prevention"
653 help
654 Prevent undesirable/malicious software downgrades. When this option is
655 set, any upgrade must have greater or equal security counter value.
656 Because of the acceptance of equal values it allows for software
657 downgrade to some extent.
658
659endchoice
660
Andrzej Puzdrowskid21442a2020-10-12 16:47:28 +0200661config BOOT_WATCHDOG_FEED
662 bool "Feed the watchdog while doing swap"
Andrzej Puzdrowskib25ba4b2022-09-28 15:58:19 +0200663 default y if WATCHDOG
664 default y if SOC_FAMILY_NRF
665 # for nRF nrfx based implementation is available
Bartosz Bilasa1c8c8e2022-08-30 21:50:28 +0200666 imply NRFX_WDT if SOC_FAMILY_NRF
667 imply NRFX_WDT0 if SOC_FAMILY_NRF
668 imply NRFX_WDT1 if SOC_FAMILY_NRF
Mateusz Michalekc3a72e92024-01-09 08:30:58 +0100669 imply NRFX_WDT30 if SOC_FAMILY_NRF
670 imply NRFX_WDT31 if SOC_FAMILY_NRF
Andrzej Puzdrowskid21442a2020-10-12 16:47:28 +0200671 help
672 Enables implementation of MCUBOOT_WATCHDOG_FEED() macro which is
673 used to feed watchdog while doing time consuming operations.
674
Andrzej Puzdrowski914204d2021-07-09 19:20:46 +0200675config BOOT_IMAGE_ACCESS_HOOKS
676 bool "Enable hooks for overriding MCUboot's native routines"
677 help
678 Allow to provide procedures for override or extend native
679 MCUboot's routines required for access the image data and the image
Andrzej Puzdrowski1c150c62022-07-07 14:55:22 +0200680 update. It is up to the project customization to add required source
681 files to the build.
Andrzej Puzdrowski914204d2021-07-09 19:20:46 +0200682
Jamie McCrae56cb6102022-03-23 11:57:03 +0000683config MCUBOOT_ACTION_HOOKS
684 bool "Enable hooks for responding to MCUboot status changes"
685 help
686 This will call a handler when the MCUboot status changes which allows
687 for some level of user feedback, for instance to change LED status to
688 indicate a failure, using the callback:
689 'void mcuboot_status_change(mcuboot_status_type_t status)' where
690 'mcuboot_status_type_t' is listed in
691 boot/bootutil/include/bootutil/mcuboot_status.h
692
Andrzej Puzdrowski97543282018-04-12 15:16:56 +0200693endmenu
694
Carles Cufi84ede582018-01-29 15:12:00 +0100695config MCUBOOT_DEVICE_SETTINGS
696 # Hidden selector for device-specific settings
697 bool
698 default y
699 # CPU options
700 select MCUBOOT_DEVICE_CPU_CORTEX_M0 if CPU_CORTEX_M0
Carles Cufi67c792e2018-01-29 15:14:31 +0100701 # Enable flash page layout if available
702 select FLASH_PAGE_LAYOUT if FLASH_HAS_PAGE_LAYOUT
Andrzej Puzdrowskib788c712018-04-12 12:42:49 +0200703 # Enable flash_map module as flash I/O back-end
704 select FLASH_MAP
Carles Cufi84ede582018-01-29 15:12:00 +0100705
706config MCUBOOT_DEVICE_CPU_CORTEX_M0
707 # Hidden selector for Cortex-M0 settings
708 bool
709 default n
710 select SW_VECTOR_RELAY if !CPU_CORTEX_M0_HAS_VECTOR_TABLE_REMAP
711
Marti Bolivar0e091c92018-04-12 11:23:16 -0400712comment "Zephyr configuration options"
Andrzej Puzdrowski64ad0922017-09-22 11:33:41 +0200713
Marti Bolivarf84cc4b2019-08-20 16:06:56 -0700714# Disabling MULTITHREADING provides a code size advantage, but
715# it requires peripheral drivers (particularly a flash driver)
716# that works properly with the option enabled.
717#
718# If you know for sure that your hardware will work, you can default
719# it to n here. Otherwise, having it on by default makes the most
720# hardware work.
721config MULTITHREADING
Andrzej Puzdrowski9a4946c2020-02-20 12:39:12 +0100722 default y if BOOT_SERIAL_CDC_ACM #usb driver requires MULTITHREADING
Josh Gao837cf882020-11-13 18:51:27 -0800723 default y if BOOT_USB_DFU_GPIO || BOOT_USB_DFU_WAIT
Marti Bolivarf84cc4b2019-08-20 16:06:56 -0700724 default n if SOC_FAMILY_NRF
Sylvio Alvesb794d332024-03-04 10:08:30 -0300725 default n if SOC_FAMILY_ESPRESSIF_ESP32 && MCUBOOT
Marti Bolivarf84cc4b2019-08-20 16:06:56 -0700726 default y
727
Andrzej Puzdrowski3f092bd2020-02-17 13:25:32 +0100728config LOG_PROCESS_THREAD
729 default n # mcuboot has its own log processing thread
730
731# override USB device name
732config USB_DEVICE_PRODUCT
733 default "MCUBOOT"
Andrzej Puzdrowski9a4946c2020-02-20 12:39:12 +0100734
Andrzej Puzdrowskif573b392020-11-10 14:35:15 +0100735# use MCUboot's own log configuration
736config MCUBOOT_BOOTUTIL_LIB_OWN_LOG
737 bool
738 default n
739
Håkon Øye Amundsene829e9d2021-11-12 14:01:01 +0000740config MCUBOOT_VERIFY_IMG_ADDRESS
741 bool "Verify reset address of image in secondary slot"
742 depends on UPDATEABLE_IMAGE_NUMBER > 1
743 depends on !BOOT_ENCRYPT_IMAGE
744 depends on ARM
745 default y if BOOT_UPGRADE_ONLY
746 help
747 Verify that the reset address in the image located in the secondary slot
748 is contained within the corresponding primary slot. This is recommended
749 if swapping is not used (that is, BOOT_UPGRADE_ONLY is set). If a user
750 incorrectly uploads an update for image 1 to image 0's secondary slot
751 MCUboot will overwrite image 0's primary slot with this image even
752 though it will not boot. If swapping is enabled this will be handled
753 since the image will not confirm itself. If, however, swapping is not
754 enabled then the only mitigation is serial recovery. This feature can
755 also be useful when BOOT_DIRECT_XIP is enabled, to ensure that the image
756 linked at the correct address is loaded.
757
Robert Lubos1b19d2a2020-01-31 14:05:35 +0100758source "Kconfig.zephyr"