blob: ed84a12375ec45af3b8dac1b996935012e48c790 [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
Andrzej Puzdrowski64ad0922017-09-22 11:33:41 +02003#
4# SPDX-License-Identifier: Apache-2.0
5#
6
Marti Bolivar0e091c92018-04-12 11:23:16 -04007mainmenu "MCUboot configuration"
Andrzej Puzdrowski64ad0922017-09-22 11:33:41 +02008
Marti Bolivar0e091c92018-04-12 11:23:16 -04009comment "MCUboot-specific configuration options"
Andrzej Puzdrowski64ad0922017-09-22 11:33:41 +020010
Emanuele Di Santo865777d2018-11-08 11:28:15 +010011# Hidden option to mark a project as MCUboot
12config MCUBOOT
13 default y
14 bool
Rajavardhan Gundi07ba28f2018-12-10 15:44:48 +053015 select MPU_ALLOW_FLASH_WRITE if ARM_MPU
Marcin Niestrojc6be76a2020-03-22 14:39:35 +010016 select USE_DT_CODE_PARTITION if HAS_FLASH_LOAD_OFFSET
Andrzej Puzdrowskif573b392020-11-10 14:35:15 +010017 select MCUBOOT_BOOTUTIL_LIB
Emanuele Di Santo865777d2018-11-08 11:28:15 +010018
Marti Bolivarbc2fa4e2018-04-12 12:18:32 -040019config BOOT_USE_MBEDTLS
20 bool
21 # Hidden option
22 default n
23 help
24 Use mbedTLS for crypto primitives.
25
26config BOOT_USE_TINYCRYPT
27 bool
28 # Hidden option
29 default n
Sebastian Bøe913a3852019-01-22 13:53:12 +010030 # When building for ECDSA, we use our own copy of mbedTLS, so the
31 # Zephyr one must not be enabled or the MBEDTLS_CONFIG_FILE macros
32 # will collide.
Marti Bolivarbc2fa4e2018-04-12 12:18:32 -040033 help
34 Use TinyCrypt for crypto primitives.
35
Sigvart Hovlandebd05032019-03-21 10:47:32 +010036config BOOT_USE_CC310
37 bool
38 # Hidden option
39 default n
40 # When building for ECDSA, we use our own copy of mbedTLS, so the
41 # Zephyr one must not be enabled or the MBEDTLS_CONFIG_FILE macros
42 # will collide.
Sigvart Hovlandebd05032019-03-21 10:47:32 +010043 help
44 Use cc310 for crypto primitives.
45
46config BOOT_USE_NRF_CC310_BL
47 bool
48 default n
49
50config NRFXLIB_CRYPTO
51 bool
52 default n
53
54config NRF_CC310_BL
55 bool
56 default n
57
Andrzej Puzdrowski97543282018-04-12 15:16:56 +020058menu "MCUBoot settings"
59
Andrzej Puzdrowskifdff3e12020-09-15 08:23:25 +020060config SINGLE_APPLICATION_SLOT
61 bool "Single slot bootloader"
Dominik Ermel4dc3f442020-05-26 08:45:14 +000062 default n
63 help
64 Single image area is used for application which means that
65 uploading a new application overwrites the one that previously
66 occupied the area.
67
Håkon Øye Amundsen21f03762021-11-12 08:21:31 +000068choice BOOT_SIGNATURE_TYPE
Marti Bolivarbc2fa4e2018-04-12 12:18:32 -040069 prompt "Signature type"
70 default BOOT_SIGNATURE_TYPE_RSA
71
Arvin Farahmandfb5ec182020-05-05 11:44:12 -040072config BOOT_SIGNATURE_TYPE_NONE
73 bool "No signature; use only hash check"
74 select BOOT_USE_TINYCRYPT
75
Marti Bolivarbc2fa4e2018-04-12 12:18:32 -040076config BOOT_SIGNATURE_TYPE_RSA
77 bool "RSA signatures"
78 select BOOT_USE_MBEDTLS
Marti Bolivara4818a52018-04-12 13:02:38 -040079 select MBEDTLS
Marti Bolivarbc2fa4e2018-04-12 12:18:32 -040080
Fabio Utzig105b59a2019-05-13 15:08:12 -070081if BOOT_SIGNATURE_TYPE_RSA
82config BOOT_SIGNATURE_TYPE_RSA_LEN
83 int "RSA signature length"
84 range 2048 3072
85 default 2048
86endif
87
Marti Bolivarbc2fa4e2018-04-12 12:18:32 -040088config BOOT_SIGNATURE_TYPE_ECDSA_P256
89 bool "Elliptic curve digital signatures with curve P-256"
Marti Bolivarbc2fa4e2018-04-12 12:18:32 -040090
Sigvart Hovlandebd05032019-03-21 10:47:32 +010091if BOOT_SIGNATURE_TYPE_ECDSA_P256
Håkon Øye Amundsen21f03762021-11-12 08:21:31 +000092choice BOOT_ECDSA_IMPLEMENTATION
Sigvart Hovlandebd05032019-03-21 10:47:32 +010093 prompt "Ecdsa implementation"
Fabio Utzig34e93a52020-02-03 09:59:53 -030094 default BOOT_ECDSA_TINYCRYPT
Håkon Øye Amundsenee7282d2020-09-28 09:48:29 +000095
Fabio Utzig34e93a52020-02-03 09:59:53 -030096config BOOT_ECDSA_TINYCRYPT
Sigvart Hovlandebd05032019-03-21 10:47:32 +010097 bool "Use tinycrypt"
98 select BOOT_USE_TINYCRYPT
Håkon Øye Amundsenee7282d2020-09-28 09:48:29 +000099
100config BOOT_ECDSA_CC310
Sigvart Hovlandebd05032019-03-21 10:47:32 +0100101 bool "Use CC310"
Håkon Øye Amundsenee7282d2020-09-28 09:48:29 +0000102 depends on HAS_HW_NRF_CC310
103 select BOOT_USE_NRF_CC310_BL
104 select NRF_CC310_BL
105 select NRFXLIB_CRYPTO
Sigvart Hovlandebd05032019-03-21 10:47:32 +0100106 select BOOT_USE_CC310
Håkon Øye Amundsenee7282d2020-09-28 09:48:29 +0000107endchoice # Ecdsa implementation
Sigvart Hovlandebd05032019-03-21 10:47:32 +0100108endif
Fabio Utzig34e93a52020-02-03 09:59:53 -0300109
110config BOOT_SIGNATURE_TYPE_ED25519
111 bool "Edwards curve digital signatures using ed25519"
112
113if BOOT_SIGNATURE_TYPE_ED25519
Håkon Øye Amundsen21f03762021-11-12 08:21:31 +0000114choice BOOT_ED25519_IMPLEMENTATION
Fabio Utzig34e93a52020-02-03 09:59:53 -0300115 prompt "Ecdsa implementation"
116 default BOOT_ED25519_TINYCRYPT
117config BOOT_ED25519_TINYCRYPT
118 bool "Use tinycrypt"
119 select BOOT_USE_TINYCRYPT
120config BOOT_ED25519_MBEDTLS
121 bool "Use mbedTLS"
122 select BOOT_USE_MBEDTLS
123 select MBEDTLS
124endchoice
125endif
126
Marti Bolivarbc2fa4e2018-04-12 12:18:32 -0400127endchoice
128
Fabio Utzigc690c762018-04-26 10:51:09 -0300129config BOOT_SIGNATURE_KEY_FILE
130 string "PEM key file"
Håkon Øye Amundsen705c6c22020-09-28 09:45:40 +0000131 default "root-ec-p256.pem" if BOOT_SIGNATURE_TYPE_ECDSA_P256
132 default "root-ed25519.pem" if BOOT_SIGNATURE_TYPE_ED25519
133 default "root-rsa-3072.pem" if BOOT_SIGNATURE_TYPE_RSA && BOOT_SIGNATURE_TYPE_RSA_LEN=3072
134 default "root-rsa-2048.pem" if BOOT_SIGNATURE_TYPE_RSA && BOOT_SIGNATURE_TYPE_RSA_LEN=2048
Fabio Utzigc690c762018-04-26 10:51:09 -0300135 default ""
136 help
Marek Pietabdcfc852020-08-04 02:22:55 -0700137 You can use either absolute or relative path.
138 In case relative path is used, the build system assumes that it starts
139 from the directory where the MCUBoot KConfig configuration file is
140 located. If the key file is not there, the build system uses relative
141 path that starts from the MCUBoot repository root directory.
Fabio Utzigc690c762018-04-26 10:51:09 -0300142 The key file will be parsed by imgtool's getpub command and a .c source
143 with the public key information will be written in a format expected by
144 MCUboot.
145
Andrzej Puzdrowski9a605b62020-03-16 13:34:30 +0100146config MCUBOOT_CLEANUP_ARM_CORE
147 bool "Perform core cleanup before chain-load the application"
148 depends on CPU_CORTEX_M
Jamie McCrae9e8eddc2023-02-27 12:51:09 +0000149 default y
Ioannis Glaropoulos518d93a2020-10-22 14:22:14 +0200150 help
151 This option instructs MCUboot to perform a clean-up of a set of
152 architecture core HW registers before junping to the application
153 firmware. The clean-up sets these registers to their warm-reset
154 values as specified by the architecture.
155
Jamie McCrae9e8eddc2023-02-27 12:51:09 +0000156 This option is enabled by default to prevent possible problems when
157 booting zephyr (or other) applications whereby e.g. a MPU stack guard
158 may be initialised in RAM which is then used by the application
159 start-up code which can cause a module fault and potentially make the
160 module irrecoverable.
Andrzej Puzdrowski9a605b62020-03-16 13:34:30 +0100161
Marti Bolivara4818a52018-04-12 13:02:38 -0400162config MBEDTLS_CFG_FILE
163 default "mcuboot-mbedtls-cfg.h"
164
David Vincze03368b82020-04-01 12:53:53 +0200165config BOOT_HW_KEY
166 bool "Use HW key for image verification"
167 default n
168 help
169 Use HW key for image verification, otherwise the public key is embedded
170 in MCUBoot. If enabled the public key is appended to the signed image
171 and requires the hash of the public key to be provisioned to the device
172 beforehand.
173
Marti Bolivarbc2fa4e2018-04-12 12:18:32 -0400174config BOOT_VALIDATE_SLOT0
David Vincze2d736ad2019-02-18 11:50:22 +0100175 bool "Validate image in the primary slot on every boot"
Marti Bolivarbc2fa4e2018-04-12 12:18:32 -0400176 default y
177 help
David Vincze2d736ad2019-02-18 11:50:22 +0100178 If y, the bootloader attempts to validate the signature of the
179 primary slot every boot. This adds the signature check time to
Marti Bolivarbc2fa4e2018-04-12 12:18:32 -0400180 every boot, but can mitigate against some changes that are
181 able to modify the flash image itself.
182
Wouter Cappellebb7a39d2021-05-03 16:44:44 +0200183config BOOT_VALIDATE_SLOT0_ONCE
184 bool "Validate image in the primary slot just once after after upgrade"
185 depends on !BOOT_VALIDATE_SLOT0 && SINGLE_APPLICATION_SLOT
186 default n
187 help
188 If y, the bootloader attempts to validate the signature of the
189 primary slot only once after an upgrade of the main slot.
190 It caches the result in the magic area, which makes it an unsecure
191 method. This option is usefull for lowering the boot up time for
192 low end devices with as a compromise lowering the security level.
193 If unsure, leave at the default value.
194
David Brown08a30a42022-04-26 14:49:51 -0600195config BOOT_PREFER_SWAP_MOVE
196 bool "Prefer the newer swap move algorithm"
197 default y if SOC_FAMILY_NRF
Thomas Strangeraa217e22022-10-28 21:17:55 +0200198 default y if !$(dt_nodelabel_enabled,scratch_partition)
David Brown08a30a42022-04-26 14:49:51 -0600199 help
200 If y, the BOOT_IMAGE_UPGRADE_MODE will default to using
201 "move" instead of "scratch". This is a separate bool config
202 option, because Kconfig doesn't allow defaults to be
203 overridden in choice options. Most devices should be using
204 swap move.
205
Andrzej Puzdrowskifdff3e12020-09-15 08:23:25 +0200206if !SINGLE_APPLICATION_SLOT
Håkon Øye Amundsen21f03762021-11-12 08:21:31 +0000207choice BOOT_IMAGE_UPGRADE_MODE
David Vincze5a6e1812020-06-29 13:34:42 +0200208 prompt "Image upgrade modes"
David Brown08a30a42022-04-26 14:49:51 -0600209 default BOOT_SWAP_USING_MOVE if BOOT_PREFER_SWAP_MOVE
David Vincze5a6e1812020-06-29 13:34:42 +0200210 default BOOT_SWAP_USING_SCRATCH
211
212config BOOT_SWAP_USING_SCRATCH
213 bool "Swap mode that run with the scratch partition"
214 help
215 This is the most conservative swap mode but it can work even on
216 devices with heterogeneous flash page layout.
217
Marti Bolivarbc2fa4e2018-04-12 12:18:32 -0400218config BOOT_UPGRADE_ONLY
219 bool "Overwrite image updates instead of swapping"
Marti Bolivarbc2fa4e2018-04-12 12:18:32 -0400220 help
David Vincze2d736ad2019-02-18 11:50:22 +0100221 If y, overwrite the primary slot with the upgrade image instead
222 of swapping them. This prevents the fallback recovery, but
Marti Bolivarbc2fa4e2018-04-12 12:18:32 -0400223 uses a much simpler code path.
224
Fabio Utzigc58842e2019-11-28 10:30:01 -0300225config BOOT_SWAP_USING_MOVE
Fabio Utzigdd2b6802020-01-06 09:10:45 -0300226 bool "Swap mode that can run without a scratch partition"
Fabio Utzigc58842e2019-11-28 10:30:01 -0300227 help
228 If y, the swap upgrade is done in two steps, where first every
229 sector of the primary slot is moved up one sector, then for
230 each sector X in the secondary slot, it is moved to index X in
231 the primary slot, then the sector at X+1 in the primary is
232 moved to index X in the secondary.
233 This allows a swap upgrade without using a scratch partition,
234 but is currently limited to all sectors in both slots being of
235 the same size.
David Vincze5a6e1812020-06-29 13:34:42 +0200236
237config BOOT_DIRECT_XIP
238 bool "Run the latest image directly from its slot"
239 help
240 If y, mcuboot selects the newest valid image based on the image version
241 numbers, thereafter the selected image can run directly from its slot
242 without having to move/copy it into the primary slot. For this reason the
243 images must be linked to be executed from the given image slot. Using this
244 mode results in a simpler code path and smaller code size.
245
Johan Öhmanb5889072022-04-01 09:10:28 +0200246config BOOT_RAM_LOAD
247 bool "RAM load"
248 help
249 If y, mcuboot selects the newest valid image based on the image version
250 numbers, thereafter the selected image is copied to RAM and executed from
251 there. For this reason, the image has to be linked to be executed from RAM.
252 The address that the image is copied to is specified using the load-addr
253 argument to the imgtool.py script which writes it to the image header.
254
David Vincze5a6e1812020-06-29 13:34:42 +0200255endchoice
Fabio Utzigc58842e2019-11-28 10:30:01 -0300256
Johan Öhmanb5889072022-04-01 09:10:28 +0200257# Workaround for not being able to have commas in macro arguments
258DT_CHOSEN_Z_SRAM := zephyr,sram
259
260if BOOT_RAM_LOAD
261config BOOT_IMAGE_EXECUTABLE_RAM_START
262 hex "Boot image executable ram start"
263 default $(dt_chosen_reg_addr_hex,$(DT_CHOSEN_Z_SRAM))
264
265config BOOT_IMAGE_EXECUTABLE_RAM_SIZE
266 int "Boot image executable base size"
267 default $(dt_chosen_reg_size_int,$(DT_CHOSEN_Z_SRAM),0)
268endif
269
David Vincze505fba22020-10-22 13:53:29 +0200270config BOOT_DIRECT_XIP_REVERT
271 bool "Enable the revert mechanism in direct-xip mode"
Andrzej Puzdrowski32342e72020-11-18 17:04:44 +0100272 depends on BOOT_DIRECT_XIP
David Vincze505fba22020-10-22 13:53:29 +0200273 default n
274 help
275 If y, enables the revert mechanism in direct-xip similar to the one in
276 swap mode. It requires the trailer magic to be added to the signed image.
277 When a reboot happens without the image being confirmed at runtime, the
278 bootloader considers the image faulty and erases it. After this it will
279 attempt to boot the previous image. The images can also be made permanent
280 (marked as confirmed in advance) just like in swap mode.
281
Fabio Utzigd0533ed2018-12-19 07:56:33 -0200282config BOOT_BOOTSTRAP
Sam Bristowd0ca0ff2019-10-30 20:51:35 +1300283 bool "Bootstrap erased the primary slot from the secondary slot"
Fabio Utzigd0533ed2018-12-19 07:56:33 -0200284 default n
285 help
286 If y, enables bootstraping support. Bootstrapping allows an erased
David Vincze2d736ad2019-02-18 11:50:22 +0100287 primary slot to be initialized from a valid image in the secondary slot.
Fabio Utzigd0533ed2018-12-19 07:56:33 -0200288 If unsure, leave at the default value.
289
Fabio Utzigca8ead22019-12-20 07:06:04 -0300290config BOOT_SWAP_SAVE_ENCTLV
291 bool "Save encrypted key TLVs instead of plaintext keys in swap metadata"
292 default n
293 help
294 If y, instead of saving the encrypted image keys in plaintext in the
295 swap resume metadata, save the encrypted image TLVs. This should be used
296 when there is no security mechanism protecting the data in the primary
297 slot from being dumped. If n is selected (default), the keys are written
298 after being decrypted from the image TLVs and could be read by an
299 attacker who has access to the flash contents of the primary slot (eg
300 JTAG/SWD or primary slot in external flash).
301 If unsure, leave at the default value.
302
Håkon Øye Amundsene829e9d2021-11-12 14:01:01 +0000303config BOOT_ENCRYPT_IMAGE
304 bool
305 help
306 Hidden option used to check if any image encryption is enabled.
307
Fabio Utzig5fe874c2018-08-31 07:41:50 -0300308config BOOT_ENCRYPT_RSA
Fabio Utzig42cc29a2019-11-05 07:54:41 -0300309 bool "Support for encrypted upgrade images using RSA"
Håkon Øye Amundsene829e9d2021-11-12 14:01:01 +0000310 select BOOT_ENCRYPT_IMAGE
Fabio Utzig5fe874c2018-08-31 07:41:50 -0300311 help
David Vincze2d736ad2019-02-18 11:50:22 +0100312 If y, images in the secondary slot can be encrypted and are decrypted
313 on the fly when upgrading to the primary slot, as well as encrypted
Fabio Utzig42cc29a2019-11-05 07:54:41 -0300314 back when swapping from the primary slot to the secondary slot. The
315 encryption mechanism used in this case is RSA-OAEP (2048 bits).
316
317config BOOT_ENCRYPT_EC256
318 bool "Support for encrypted upgrade images using ECIES-P256"
Håkon Øye Amundsene829e9d2021-11-12 14:01:01 +0000319 select BOOT_ENCRYPT_IMAGE
Fabio Utzig42cc29a2019-11-05 07:54:41 -0300320 help
321 If y, images in the secondary slot can be encrypted and are decrypted
322 on the fly when upgrading to the primary slot, as well as encrypted
323 back when swapping from the primary slot to the secondary slot. The
324 encryption mechanism used in this case is ECIES using primitives
325 described under "ECIES-P256 encryption" in docs/encrypted_images.md.
Fabio Utzig5fe874c2018-08-31 07:41:50 -0300326
Fabio Utzigb6f014c2020-04-02 13:25:01 -0300327config BOOT_ENCRYPT_X25519
328 bool "Support for encrypted upgrade images using ECIES-X25519"
Håkon Øye Amundsene829e9d2021-11-12 14:01:01 +0000329 select BOOT_ENCRYPT_IMAGE
Fabio Utzigb6f014c2020-04-02 13:25:01 -0300330 help
331 If y, images in the secondary slot can be encrypted and are decrypted
332 on the fly when upgrading to the primary slot, as well as encrypted
333 back when swapping from the primary slot to the secondary slot. The
334 encryption mechanism used in this case is ECIES using primitives
335 described under "ECIES-X25519 encryption" in docs/encrypted_images.md.
David Vincze505fba22020-10-22 13:53:29 +0200336endif # !SINGLE_APPLICATION_SLOT
Fabio Utzigb6f014c2020-04-02 13:25:01 -0300337
Wouter Cappelle953a7612021-05-03 16:53:05 +0200338config BOOT_ENCRYPTION_KEY_FILE
339 string "encryption key file"
340 depends on BOOT_ENCRYPT_EC256 || BOOT_SERIAL_ENCRYPT_EC256
341 default "enc-ec256-priv.pem" if BOOT_SIGNATURE_TYPE_ECDSA_P256
342 default ""
343 help
344 You can use either absolute or relative path.
345 In case relative path is used, the build system assumes that it starts
346 from the directory where the MCUBoot KConfig configuration file is
347 located. If the key file is not there, the build system uses relative
348 path that starts from the MCUBoot repository root directory.
349 The key file will be parsed by imgtool's getpriv command and a .c source
350 with the public key information will be written in a format expected by
351 MCUboot.
352
Marti Bolivar0e091c92018-04-12 11:23:16 -0400353config BOOT_MAX_IMG_SECTORS
354 int "Maximum number of sectors per image slot"
355 default 128
356 help
357 This option controls the maximum number of sectors that each of
358 the two image areas can contain. Smaller values reduce MCUboot's
359 memory usage; larger values allow it to support larger images.
360 If unsure, leave at the default value.
361
David Vincze1cf11b52020-03-24 07:51:09 +0100362config MEASURED_BOOT
363 bool "Store the boot state/measurements in shared memory"
364 default n
365 help
366 If enabled, the bootloader will store certain boot measurements such as
367 the hash of the firmware image in a shared memory area. This data can
368 be used later by runtime services (e.g. by a device attestation service).
369
370config BOOT_SHARE_DATA
371 bool "Save application specific data in shared memory area"
372 default n
373
Håkon Øye Amundsen21f03762021-11-12 08:21:31 +0000374choice BOOT_FAULT_INJECTION_HARDENING_PROFILE
Tamas Banfce87332020-07-10 12:40:11 +0100375 prompt "Fault injection hardening profile"
376 default BOOT_FIH_PROFILE_OFF
377
378config BOOT_FIH_PROFILE_OFF
379 bool "No hardening against hardware level fault injection"
380 help
381 No hardening in SW against hardware level fault injection: power or
382 clock glitching, etc.
383
384config BOOT_FIH_PROFILE_LOW
385 bool "Moderate level hardening against hardware level fault injection"
386 help
387 Moderate level hardening: Long global fail loop to avoid break out,
388 control flow integrity check to discover discrepancy in expected code
389 flow.
390
391config BOOT_FIH_PROFILE_MEDIUM
392 bool "Medium level hardening against hardware level fault injection"
393 help
394 Medium level hardening: Long global fail loop to avoid break out,
395 control flow integrity check to discover discrepancy in expected code
396 flow, double variables to discover register or memory corruption.
397
398config BOOT_FIH_PROFILE_HIGH
399 bool "Maximum level hardening against hardware level fault injection"
400 select MBEDTLS
401 help
402 Maximum level hardening: Long global fail loop to avoid break out,
403 control flow integrity check to discover discrepancy in expected code
404 flow, double variables to discover register or memory corruption, random
405 delays to make code execution less predictable. Random delays requires an
406 entropy source.
407
408endchoice
409
Josh Gao837cf882020-11-13 18:51:27 -0800410choice BOOT_USB_DFU
411 prompt "USB DFU"
412 default BOOT_USB_DFU_NO
413
414config BOOT_USB_DFU_NO
415 prompt "Disabled"
416
417config BOOT_USB_DFU_WAIT
Rajavardhan Gundi51c9d702019-02-20 14:08:52 +0530418 bool "Wait for a prescribed duration to see if USB DFU is invoked"
Johann Fischer25852972021-08-02 13:20:09 +0200419 select USB_DEVICE_STACK
Rajavardhan Gundi51c9d702019-02-20 14:08:52 +0530420 select USB_DFU_CLASS
421 select IMG_MANAGER
422 help
423 If y, MCUboot waits for a prescribed duration of time to allow
424 for USB DFU to be invoked. Please note DFU always updates the
425 slot1 image.
426
Josh Gao837cf882020-11-13 18:51:27 -0800427config BOOT_USB_DFU_GPIO
428 bool "Use GPIO to detect whether to trigger DFU mode"
Johann Fischer25852972021-08-02 13:20:09 +0200429 select USB_DEVICE_STACK
Josh Gao837cf882020-11-13 18:51:27 -0800430 select USB_DFU_CLASS
431 select IMG_MANAGER
432 help
433 If y, MCUboot uses GPIO to detect whether to invoke USB DFU.
434
435endchoice
436
437config BOOT_USB_DFU_WAIT_DELAY_MS
438 int "USB DFU wait duration"
439 depends on BOOT_USB_DFU_WAIT
440 default 12000
441 help
442 Milliseconds to wait for USB DFU to be invoked.
443
444if BOOT_USB_DFU_GPIO
445
446config BOOT_USB_DFU_DETECT_PORT
Andrzej Puzdrowskic5faf432022-04-09 13:34:23 +0200447 string "GPIO device to trigger USB DFU mode (DEPRECATED)"
Josh Gao837cf882020-11-13 18:51:27 -0800448 default GPIO_0 if SOC_FAMILY_NRF
449 help
450 Zephyr GPIO device that contains the pin used to trigger
451 USB DFU.
452
453config BOOT_USB_DFU_DETECT_PIN
Andrzej Puzdrowskic5faf432022-04-09 13:34:23 +0200454 int "Pin to trigger USB DFU mode (DEPRECATED)"
Josh Gao837cf882020-11-13 18:51:27 -0800455 default 6 if BOARD_NRF9160DK_NRF9160
456 default 11 if BOARD_NRF52840DK_NRF52840
457 default 13 if BOARD_NRF52DK_NRF52832
Martí Bolívar994816d2021-07-28 12:16:06 -0700458 default 23 if BOARD_NRF5340_DK_NRF5340_CPUAPP || BOARD_NRF5340_DK_NRF5340_CPUAPP_NS
459 default 43 if BOARD_BL5340_DVK_CPUAPP || BOARD_BL5340_DVK_CPUAPP_NS
Marek Pieta2fa11902022-09-13 11:31:30 +0200460 default -1
Josh Gao837cf882020-11-13 18:51:27 -0800461 help
462 Pin on the DFU detect port that triggers DFU mode.
463
464config BOOT_USB_DFU_DETECT_PIN_VAL
Andrzej Puzdrowskic5faf432022-04-09 13:34:23 +0200465 int "USB DFU detect pin trigger value (DEPRECATED)"
Josh Gao837cf882020-11-13 18:51:27 -0800466 default 0
467 range 0 1
468 help
469 Logic value of the detect pin that triggers USB DFU mode.
470
471config BOOT_USB_DFU_DETECT_DELAY
472 int "Serial detect pin detection delay time [ms]"
473 default 0
474 help
475 Used to prevent the bootloader from loading on button press.
476 Useful for powering on when using the same button as
477 the one used to place the device in bootloader mode.
478
479endif # BOOT_USB_DFU_GPIO
480
Marti Bolivarbc2fa4e2018-04-12 12:18:32 -0400481config ZEPHYR_TRY_MASS_ERASE
Jamie McCrae93156542023-01-11 09:33:45 +0000482 bool "Try to mass erase flash when flashing MCUboot image (DEPRECATED)"
483 select DEPRECATED
Marti Bolivarbc2fa4e2018-04-12 12:18:32 -0400484 help
485 If y, attempt to configure the Zephyr build system's "flash"
486 target to mass-erase the flash device before flashing the
487 MCUboot image. This ensures the scratch and other partitions
488 are in a consistent state.
489
490 This is not available for all targets.
491
Jamie McCrae93156542023-01-11 09:33:45 +0000492 This option has been deprecated, to perform a mass erase when
493 flashing a board, `west flash --erase` should be used instead.
494
David Brownf6d14c22019-12-10 15:36:36 -0700495config BOOT_USE_BENCH
496 bool "Enable benchmark code"
497 default n
498 help
499 If y, adds support for simple benchmarking that can record
500 time intervals between two calls. The time printed depends
501 on the particular Zephyr target, and is generally ticks of a
502 specific board-specific timer.
503
Michael Scott74ceae52019-02-01 14:01:09 -0800504module = MCUBOOT
Piotr Mienkowski15aa6ef2019-04-08 22:48:15 +0200505module-str = MCUBoot bootloader
Michael Scott74ceae52019-02-01 14:01:09 -0800506source "subsys/logging/Kconfig.template.log_config"
Michael Scott74ceae52019-02-01 14:01:09 -0800507
Andrzej Puzdrowskiaf148532020-02-25 12:51:26 +0100508config MCUBOOT_LOG_THREAD_STACK_SIZE
509 int "Stack size for the MCUBoot log processing thread"
510 depends on LOG && !LOG_IMMEDIATE
511 default 2048 if COVERAGE_GCOV
512 default 1024 if NO_OPTIMIZATIONS
513 default 1024 if XTENSA
514 default 4096 if (X86 && X86_64)
515 default 4096 if ARM64
516 default 768
517 help
518 Set the internal stack size for MCUBoot log processing thread.
519
Andrzej Puzdrowski6c00b5e2022-04-01 16:51:27 +0200520config MCUBOOT_INDICATION_LED
521 bool "Turns on LED indication when device is in DFU"
522 default n
523 help
524 Device device activates the LED while in bootloader mode.
525 bootloader-led0 alias must be set in the device's .dts
526 definitions for this to work.
527
Andrzej Puzdrowski35f61d32022-04-01 17:00:08 +0200528rsource "Kconfig.serial_recovery"
Andrzej Puzdrowski64ad0922017-09-22 11:33:41 +0200529
Rafał Kuźniad854bb62020-06-17 15:06:47 +0200530config BOOT_INTR_VEC_RELOC
531 bool "Relocate the interrupt vector to the application"
532 default n
533 depends on SW_VECTOR_RELAY || CPU_CORTEX_M_HAS_VTOR
534 help
535 Relocate the interrupt vector to the application before it is started.
536 Select this option if application requires vector relocation,
537 but it doesn't relocate vector in its reset handler.
538
Andrzej Puzdrowski16b6d152020-06-01 14:16:54 +0200539config UPDATEABLE_IMAGE_NUMBER
540 int "Number of updateable images"
541 default 1
Andrzej Puzdrowskifdff3e12020-09-15 08:23:25 +0200542 range 1 1 if SINGLE_APPLICATION_SLOT
Andrzej Puzdrowski16b6d152020-06-01 14:16:54 +0200543 help
544 Enables support of multi image update.
545
Håkon Øye Amundsen21f03762021-11-12 08:21:31 +0000546choice BOOT_DOWNGRADE_PREVENTION_CHOICE
Andrzej Puzdrowski16b6d152020-06-01 14:16:54 +0200547 prompt "Downgrade prevention"
548 optional
549
550config MCUBOOT_DOWNGRADE_PREVENTION
551 bool "SW based downgrade prevention"
Jerzy Kasenbergb8801fc2022-06-29 15:54:37 +0200552 depends on !BOOT_DIRECT_XIP
Andrzej Puzdrowski16b6d152020-06-01 14:16:54 +0200553 help
554 Prevent downgrades by enforcing incrementing version numbers.
555 When this option is set, any upgrade must have greater major version
556 or greater minor version with equal major version. This mechanism
557 only protects against some attacks against version downgrades (for
558 example, a JTAG could be used to write an older version).
559
Jerzy Kasenbergb8801fc2022-06-29 15:54:37 +0200560config MCUBOOT_DOWNGRADE_PREVENTION_SECURITY_COUNTER
561 bool "Use image security counter instead of version number"
562 depends on MCUBOOT_DOWNGRADE_PREVENTION
563 depends on (BOOT_SWAP_USING_MOVE || BOOT_SWAP_USING_SCRATCH)
564 help
565 Security counter is used for version eligibility check instead of pure
566 version. When this option is set, any upgrade must have greater or
567 equal security counter value.
568 Because of the acceptance of equal values it allows for software
569 downgrades to some extent.
570
Andrzej Puzdrowski16b6d152020-06-01 14:16:54 +0200571config MCUBOOT_HW_DOWNGRADE_PREVENTION
572 bool "HW based downgrade prevention"
573 help
574 Prevent undesirable/malicious software downgrades. When this option is
575 set, any upgrade must have greater or equal security counter value.
576 Because of the acceptance of equal values it allows for software
577 downgrade to some extent.
578
579endchoice
580
Andrzej Puzdrowskid21442a2020-10-12 16:47:28 +0200581config BOOT_WATCHDOG_FEED
582 bool "Feed the watchdog while doing swap"
Andrzej Puzdrowskib25ba4b2022-09-28 15:58:19 +0200583 default y if WATCHDOG
584 default y if SOC_FAMILY_NRF
585 # for nRF nrfx based implementation is available
Bartosz Bilasa1c8c8e2022-08-30 21:50:28 +0200586 imply NRFX_WDT if SOC_FAMILY_NRF
587 imply NRFX_WDT0 if SOC_FAMILY_NRF
588 imply NRFX_WDT1 if SOC_FAMILY_NRF
Andrzej Puzdrowskid21442a2020-10-12 16:47:28 +0200589 help
590 Enables implementation of MCUBOOT_WATCHDOG_FEED() macro which is
591 used to feed watchdog while doing time consuming operations.
592
Andrzej Puzdrowski914204d2021-07-09 19:20:46 +0200593config BOOT_IMAGE_ACCESS_HOOKS
594 bool "Enable hooks for overriding MCUboot's native routines"
595 help
596 Allow to provide procedures for override or extend native
597 MCUboot's routines required for access the image data and the image
Andrzej Puzdrowski1c150c62022-07-07 14:55:22 +0200598 update. It is up to the project customization to add required source
599 files to the build.
Andrzej Puzdrowski914204d2021-07-09 19:20:46 +0200600
Jamie McCrae56cb6102022-03-23 11:57:03 +0000601config MCUBOOT_ACTION_HOOKS
602 bool "Enable hooks for responding to MCUboot status changes"
603 help
604 This will call a handler when the MCUboot status changes which allows
605 for some level of user feedback, for instance to change LED status to
606 indicate a failure, using the callback:
607 'void mcuboot_status_change(mcuboot_status_type_t status)' where
608 'mcuboot_status_type_t' is listed in
609 boot/bootutil/include/bootutil/mcuboot_status.h
610
Andrzej Puzdrowski97543282018-04-12 15:16:56 +0200611endmenu
612
Carles Cufi84ede582018-01-29 15:12:00 +0100613config MCUBOOT_DEVICE_SETTINGS
614 # Hidden selector for device-specific settings
615 bool
616 default y
617 # CPU options
618 select MCUBOOT_DEVICE_CPU_CORTEX_M0 if CPU_CORTEX_M0
Carles Cufi67c792e2018-01-29 15:14:31 +0100619 # Enable flash page layout if available
620 select FLASH_PAGE_LAYOUT if FLASH_HAS_PAGE_LAYOUT
Andrzej Puzdrowskib788c712018-04-12 12:42:49 +0200621 # Enable flash_map module as flash I/O back-end
622 select FLASH_MAP
Carles Cufi84ede582018-01-29 15:12:00 +0100623
624config MCUBOOT_DEVICE_CPU_CORTEX_M0
625 # Hidden selector for Cortex-M0 settings
626 bool
627 default n
628 select SW_VECTOR_RELAY if !CPU_CORTEX_M0_HAS_VECTOR_TABLE_REMAP
629
Marti Bolivar0e091c92018-04-12 11:23:16 -0400630comment "Zephyr configuration options"
Andrzej Puzdrowski64ad0922017-09-22 11:33:41 +0200631
Marti Bolivarf84cc4b2019-08-20 16:06:56 -0700632# Disabling MULTITHREADING provides a code size advantage, but
633# it requires peripheral drivers (particularly a flash driver)
634# that works properly with the option enabled.
635#
636# If you know for sure that your hardware will work, you can default
637# it to n here. Otherwise, having it on by default makes the most
638# hardware work.
639config MULTITHREADING
Andrzej Puzdrowski9a4946c2020-02-20 12:39:12 +0100640 default y if BOOT_SERIAL_CDC_ACM #usb driver requires MULTITHREADING
Josh Gao837cf882020-11-13 18:51:27 -0800641 default y if BOOT_USB_DFU_GPIO || BOOT_USB_DFU_WAIT
Marti Bolivarf84cc4b2019-08-20 16:06:56 -0700642 default n if SOC_FAMILY_NRF
643 default y
644
Andrzej Puzdrowski3f092bd2020-02-17 13:25:32 +0100645config LOG_PROCESS_THREAD
646 default n # mcuboot has its own log processing thread
647
648# override USB device name
649config USB_DEVICE_PRODUCT
650 default "MCUBOOT"
Andrzej Puzdrowski9a4946c2020-02-20 12:39:12 +0100651
Andrzej Puzdrowskif573b392020-11-10 14:35:15 +0100652# use MCUboot's own log configuration
653config MCUBOOT_BOOTUTIL_LIB_OWN_LOG
654 bool
655 default n
656
Håkon Øye Amundsene829e9d2021-11-12 14:01:01 +0000657config MCUBOOT_VERIFY_IMG_ADDRESS
658 bool "Verify reset address of image in secondary slot"
659 depends on UPDATEABLE_IMAGE_NUMBER > 1
660 depends on !BOOT_ENCRYPT_IMAGE
661 depends on ARM
662 default y if BOOT_UPGRADE_ONLY
663 help
664 Verify that the reset address in the image located in the secondary slot
665 is contained within the corresponding primary slot. This is recommended
666 if swapping is not used (that is, BOOT_UPGRADE_ONLY is set). If a user
667 incorrectly uploads an update for image 1 to image 0's secondary slot
668 MCUboot will overwrite image 0's primary slot with this image even
669 though it will not boot. If swapping is enabled this will be handled
670 since the image will not confirm itself. If, however, swapping is not
671 enabled then the only mitigation is serial recovery. This feature can
672 also be useful when BOOT_DIRECT_XIP is enabled, to ensure that the image
673 linked at the correct address is loaded.
674
Robert Lubos1b19d2a2020-01-31 14:05:35 +0100675source "Kconfig.zephyr"