blob: 99dcedcc8409b7763430a8a8976bf4a9645e8d8a [file] [log] [blame]
Simon Glassb45b1632020-09-10 20:21:13 -06001menu "Boot options"
2
Ilias Apalodimas17aea462024-08-30 14:45:27 +03003source "lib/efi_loader/Kconfig"
4
Simon Glassb45b1632020-09-10 20:21:13 -06005menu "Boot images"
6
Tom Rini793921e2024-04-18 08:29:35 -06007config ANDROID_BOOT_IMAGE
8 bool "Android Boot Images"
9 default y if FASTBOOT
10 help
11 This enables support for booting images which use the Android
12 image format header.
13
14config TIMESTAMP
15 bool "Show image date and time when displaying image information"
16 default y if CMD_DATE
17 help
18 When CONFIG_TIMESTAMP is selected, the timestamp (date and time) of
19 an image is printed by image commands like bootm or iminfo. This
20 is shown as 'Timestamp: xxx' and 'Created: xxx'. If this option is
21 enabled, then U-Boot requires FITs to have a timestamp. If a FIT is
22 loaded that does not, the message 'Wrong FIT format: no timestamp'
23 is shown.
24
25config BUTTON_CMD
26 bool "Support for running a command if a button is held during boot"
27 depends on CMDLINE
28 depends on BUTTON
29 help
30 For many embedded devices it's useful to enter a special flashing mode
31 such as fastboot mode when a button is held during boot. This option
32 allows arbitrary commands to be assigned to specific buttons. These will
33 be run after "preboot" if the button is held. Configuration is done via
34 the environment variables "button_cmd_N_name" and "button_cmd_N" where n is
35 the button number (starting from 0). e.g:
36
37 "button_cmd_0_name=vol_down"
38 "button_cmd_0=fastboot usb 0"
39
Simon Glasse9a089a2023-09-14 10:55:49 -060040menuconfig FIT
41 bool "Flattened Image Tree (FIT)"
Alexandru Gagniuc650b7862021-09-02 19:54:21 -050042 select HASH
Simon Glassb45b1632020-09-10 20:21:13 -060043 select MD5
44 select SHA1
Alexandru Gagniuc8d310ef2021-09-02 19:54:17 -050045 imply SHA256
Simon Glassb45b1632020-09-10 20:21:13 -060046 help
47 This option allows you to boot the new uImage structure,
48 Flattened Image Tree. FIT is formally a FDT, which can include
49 images of various types (kernel, FDT blob, ramdisk, etc.)
50 in a single blob. To boot this new uImage structure,
51 pass the address of the blob to the "bootm" command.
52 FIT is very flexible, supporting compression, multiple images,
53 multiple configurations, verification through hashing and also
54 verified boot (secure boot using RSA).
55
Simon Glasse9a089a2023-09-14 10:55:49 -060056if FIT
Simon Glass65831d92021-12-18 11:27:50 -070057
Simon Glassb45b1632020-09-10 20:21:13 -060058config FIT_EXTERNAL_OFFSET
59 hex "FIT external data offset"
60 default 0x0
61 help
62 This specifies a data offset in fit image.
63 The offset is from data payload offset to the beginning of
64 fit image header. When specifies a offset, specific data
65 could be put in the hole between data payload and fit image
66 header, such as CSF data on i.MX platform.
67
Simon Glass244705b2021-02-15 17:08:10 -070068config FIT_FULL_CHECK
69 bool "Do a full check of the FIT before using it"
70 default y
71 help
72 Enable this do a full check of the FIT to make sure it is valid. This
73 helps to protect against carefully crafted FITs which take advantage
74 of bugs or omissions in the code. This includes a bad structure,
75 multiple root nodes and the like.
76
Simon Glassb45b1632020-09-10 20:21:13 -060077config FIT_SIGNATURE
78 bool "Enable signature verification of FIT uImages"
Simon Glasse9a089a2023-09-14 10:55:49 -060079 depends on DM
Simon Glassb45b1632020-09-10 20:21:13 -060080 select HASH
Alexandru Gagniuc1f2e2312021-07-29 11:47:18 -050081 imply RSA
82 imply RSA_VERIFY
Simon Glassb45b1632020-09-10 20:21:13 -060083 select IMAGE_SIGN_INFO
Simon Glass244705b2021-02-15 17:08:10 -070084 select FIT_FULL_CHECK
Simon Glassb45b1632020-09-10 20:21:13 -060085 help
86 This option enables signature verification of FIT uImages,
87 using a hash signed and verified using RSA. If
88 CONFIG_SHA_PROG_HW_ACCEL is defined, i.e support for progressive
89 hashing is available using hardware, then the RSA library will use
Heinrich Schuchardtb72eb352024-06-18 08:23:17 +020090 it. See doc/usage/fit/signature.rst for more details.
Simon Glassb45b1632020-09-10 20:21:13 -060091
92 WARNING: When relying on signed FIT images with a required signature
93 check the legacy image format is disabled by default, so that
94 unsigned images cannot be loaded. If a board needs the legacy image
95 format support in this case, enable it using
96 CONFIG_LEGACY_IMAGE_FORMAT.
97
98config FIT_SIGNATURE_MAX_SIZE
99 hex "Max size of signed FIT structures"
100 depends on FIT_SIGNATURE
101 default 0x10000000
102 help
103 This option sets a max size in bytes for verified FIT uImages.
104 A sane value of 256MB protects corrupted DTB structures from overlapping
105 device memory. Assure this size does not extend past expected storage
106 space.
107
Simon Glass66b00c82021-07-14 17:05:31 -0500108config FIT_RSASSA_PSS
Simon Glassb45b1632020-09-10 20:21:13 -0600109 bool "Support rsassa-pss signature scheme of FIT image contents"
110 depends on FIT_SIGNATURE
Simon Glassb45b1632020-09-10 20:21:13 -0600111 help
112 Enable this to support the pss padding algorithm as described
113 in the rfc8017 (https://tools.ietf.org/html/rfc8017).
114
115config FIT_CIPHER
116 bool "Enable ciphering data in a FIT uImages"
Simon Glasse9a089a2023-09-14 10:55:49 -0600117 depends on DM
Simon Glassb45b1632020-09-10 20:21:13 -0600118 select AES
119 help
120 Enable the feature of data ciphering/unciphering in the tool mkimage
121 and in the u-boot support of the FIT image.
122
123config FIT_VERBOSE
124 bool "Show verbose messages when FIT images fail"
125 help
126 Generally a system will have valid FIT images so debug messages
127 are a waste of code space. If you are debugging your images then
128 you can enable this option to get more verbose information about
129 failures.
130
131config FIT_BEST_MATCH
132 bool "Select the best match for the kernel device tree"
133 help
134 When no configuration is explicitly selected, default to the
135 one whose fdt's compatibility field best matches that of
136 U-Boot itself. A match is considered "best" if it matches the
137 most specific compatibility entry of U-Boot's fdt's root node.
138 The order of entries in the configuration's fdt is ignored.
139
140config FIT_IMAGE_POST_PROCESS
141 bool "Enable post-processing of FIT artifacts after loading by U-Boot"
Manorit Chawdhryf65cdf72023-07-14 11:22:40 +0530142 depends on SOCFPGA_SECURE_VAB_AUTH
Simon Glassb45b1632020-09-10 20:21:13 -0600143 help
144 Allows doing any sort of manipulation to blobs after they got extracted
145 from FIT images like stripping off headers or modifying the size of the
146 blob, verification, authentication, decryption etc. in a platform or
147 board specific way. In order to use this feature a platform or board-
148 specific implementation of board_fit_image_post_process() must be
149 provided. Also, anything done during this post-processing step would
150 need to be comprehended in how the images were prepared before being
151 injected into the FIT creation (i.e. the blobs would have been pre-
152 processed before being added to the FIT image).
153
Ravik Hasija11dac412021-01-27 14:01:48 -0800154config FIT_PRINT
Anand Moon6c368f42024-06-23 23:10:21 +0530155 bool "Support FIT printing"
156 default y
157 help
158 Support printing the content of the fitImage in a verbose manner.
Ravik Hasija11dac412021-01-27 14:01:48 -0800159
Simon Glassb45b1632020-09-10 20:21:13 -0600160config SPL_FIT
161 bool "Support Flattened Image Tree within SPL"
Simon Glass2289ca92023-09-14 10:55:52 -0600162 depends on SPL
Alexandru Gagniuc650b7862021-09-02 19:54:21 -0500163 select SPL_HASH
Simon Glassb45b1632020-09-10 20:21:13 -0600164 select SPL_OF_LIBFDT
165
166config SPL_FIT_PRINT
167 bool "Support FIT printing within SPL"
168 depends on SPL_FIT
169 help
170 Support printing the content of the fitImage in a verbose manner in SPL.
171
Simon Glass244705b2021-02-15 17:08:10 -0700172config SPL_FIT_FULL_CHECK
173 bool "Do a full check of the FIT before using it"
Tom Rini0f3d1de2022-12-04 10:14:20 -0500174 depends on SPL_FIT
Simon Glass244705b2021-02-15 17:08:10 -0700175 help
176 Enable this do a full check of the FIT to make sure it is valid. This
177 helps to protect against carefully crafted FITs which take advantage
178 of bugs or omissions in the code. This includes a bad structure,
179 multiple root nodes and the like.
180
Simon Glassb45b1632020-09-10 20:21:13 -0600181config SPL_FIT_SIGNATURE
182 bool "Enable signature verification of FIT firmware within SPL"
183 depends on SPL_DM
Klaus Heinrich Kiwiae5073f2021-02-09 15:41:54 -0300184 depends on SPL_LOAD_FIT || SPL_LOAD_FIT_FULL
Klaus Heinrich Kiwic9796e62021-02-09 15:41:53 -0300185 select FIT_SIGNATURE
Simon Glassb45b1632020-09-10 20:21:13 -0600186 select SPL_FIT
Simon Glassa8437ce2021-07-10 21:14:25 -0600187 select SPL_CRYPTO
Alexandru Gagniuc97464ff2021-09-02 19:54:19 -0500188 select SPL_HASH
Alexandru Gagniuc1f2e2312021-07-29 11:47:18 -0500189 imply SPL_RSA
190 imply SPL_RSA_VERIFY
Simon Glassb45b1632020-09-10 20:21:13 -0600191 select SPL_IMAGE_SIGN_INFO
Simon Glass244705b2021-02-15 17:08:10 -0700192 select SPL_FIT_FULL_CHECK
Simon Glassb45b1632020-09-10 20:21:13 -0600193
Simon Glassc0cabbc2021-09-25 19:43:39 -0600194config SPL_FIT_SIGNATURE_MAX_SIZE
195 hex "Max size of signed FIT structures in SPL"
196 depends on SPL_FIT_SIGNATURE
197 default 0x10000000
198 help
199 This option sets a max size in bytes for verified FIT uImages.
200 A sane value of 256MB protects corrupted DTB structures from overlapping
201 device memory. Assure this size does not extend past expected storage
202 space.
203
Philippe Reynes47f3eb22021-10-15 11:35:03 +0200204config SPL_FIT_RSASSA_PSS
205 bool "Support rsassa-pss signature scheme of FIT image contents in SPL"
206 depends on SPL_FIT_SIGNATURE
207 help
208 Enable this to support the pss padding algorithm as described
209 in the rfc8017 (https://tools.ietf.org/html/rfc8017) in SPL.
210
Simon Glassb45b1632020-09-10 20:21:13 -0600211config SPL_LOAD_FIT
212 bool "Enable SPL loading U-Boot as a FIT (basic fitImage features)"
Simon Glass2289ca92023-09-14 10:55:52 -0600213 depends on SPL
Simon Glassb45b1632020-09-10 20:21:13 -0600214 select SPL_FIT
215 help
216 Normally with the SPL framework a legacy image is generated as part
217 of the build. This contains U-Boot along with information as to
218 where it should be loaded. This option instead enables generation
219 of a FIT (Flat Image Tree) which provides more flexibility. In
220 particular it can handle selecting from multiple device tree
221 and passing the correct one to U-Boot.
222
Alexandru Gagniuc064c9c22021-03-29 12:05:15 -0500223 This path has the following limitations:
224
Bin Meng91cdcb92021-05-10 20:23:29 +0800225 1. "loadables" images, other than FDTs, which do not have a "load"
Alexandru Gagniuc064c9c22021-03-29 12:05:15 -0500226 property will not be loaded. This limitation also applies to FPGA
227 images with the correct "compatible" string.
Heinrich Schuchardtb72eb352024-06-18 08:23:17 +0200228 2. For FPGA images, the supported "compatible" list may be found in
229 https://fitspec.osfw.foundation/.
Alexandru Gagniuc064c9c22021-03-29 12:05:15 -0500230 3. FDTs are only loaded for images with an "os" property of "u-boot".
231 "linux" images are also supported with Falcon boot mode.
232
Simon Glassb45b1632020-09-10 20:21:13 -0600233config SPL_LOAD_FIT_ADDRESS
234 hex "load address of fit image"
Simon Glassdfcedda2023-09-14 10:55:51 -0600235 depends on SPL_LOAD_FIT
Rasmus Villemoesd1bb9532024-10-24 12:01:45 +0200236 default 0x44000000 if ARCH_IMX8M
Simon Glassb45b1632020-09-10 20:21:13 -0600237 default 0x0
238 help
239 Specify the load address of the fit image that will be loaded
240 by SPL.
241
242config SPL_LOAD_FIT_APPLY_OVERLAY
243 bool "Enable SPL applying DT overlays from FIT"
244 depends on SPL_LOAD_FIT
245 select OF_LIBFDT_OVERLAY
246 help
Hugo Villeneuve5c1c6cc2023-04-24 16:51:12 -0400247 The device tree is loaded from the FIT image. Allow the SPL to
Simon Glassb45b1632020-09-10 20:21:13 -0600248 also load device-tree overlays from the FIT image an apply them
249 over the device tree.
250
251config SPL_LOAD_FIT_APPLY_OVERLAY_BUF_SZ
252 depends on SPL_LOAD_FIT_APPLY_OVERLAY
253 default 0x10000
254 hex "size of temporary buffer used to load the overlays"
255 help
256 The size of the area where the overlays will be loaded and
257 uncompress. Must be at least as large as biggest overlay
258 (uncompressed)
259
260config SPL_LOAD_FIT_FULL
261 bool "Enable SPL loading U-Boot as a FIT (full fitImage features)"
262 select SPL_FIT
263 help
264 Normally with the SPL framework a legacy image is generated as part
265 of the build. This contains U-Boot along with information as to
266 where it should be loaded. This option instead enables generation
267 of a FIT (Flat Image Tree) which provides more flexibility. In
268 particular it can handle selecting from multiple device tree
269 and passing the correct one to U-Boot.
270
271config SPL_FIT_IMAGE_POST_PROCESS
272 bool "Enable post-processing of FIT artifacts after loading by the SPL"
273 depends on SPL_LOAD_FIT
Andrew Davis4ba9e6e2022-05-04 15:52:28 -0500274 default y if TI_SECURE_DEVICE
Simon Glassb45b1632020-09-10 20:21:13 -0600275 help
276 Allows doing any sort of manipulation to blobs after they got extracted
277 from the U-Boot FIT image like stripping off headers or modifying the
278 size of the blob, verification, authentication, decryption etc. in a
279 platform or board specific way. In order to use this feature a platform
280 or board-specific implementation of board_fit_image_post_process() must
281 be provided. Also, anything done during this post-processing step would
282 need to be comprehended in how the images were prepared before being
283 injected into the FIT creation (i.e. the blobs would have been pre-
284 processed before being added to the FIT image).
285
Simon Glassbc993e52022-10-20 18:23:13 -0600286if VPL
287
288config VPL_FIT
289 bool "Support Flattened Image Tree within VPL"
290 depends on VPL
291 default y
292 select VPL_HASH
293 select VPL_OF_LIBFDT
294
295config VPL_FIT_PRINT
296 bool "Support FIT printing within VPL"
297 depends on VPL_FIT
298 default y
299 help
300 Support printing the content of the fitImage in a verbose manner in VPL.
301
302config VPL_FIT_FULL_CHECK
303 bool "Do a full check of the FIT before using it"
304 default y
305 help
306 Enable this do a full check of the FIT to make sure it is valid. This
307 helps to protect against carefully crafted FITs which take advantage
308 of bugs or omissions in the code. This includes a bad structure,
309 multiple root nodes and the like.
310
311config VPL_FIT_SIGNATURE
312 bool "Enable signature verification of FIT firmware within VPL"
313 depends on VPL_DM
Simon Glassbc993e52022-10-20 18:23:13 -0600314 default y
315 select FIT_SIGNATURE
316 select VPL_FIT
317 select VPL_CRYPTO
318 select VPL_HASH
319 imply VPL_RSA
320 imply VPL_RSA_VERIFY
321 select VPL_IMAGE_SIGN_INFO
322 select VPL_FIT_FULL_CHECK
323
324config VPL_FIT_SIGNATURE_MAX_SIZE
325 hex "Max size of signed FIT structures in VPL"
326 depends on VPL_FIT_SIGNATURE
327 default 0x10000000
328 help
329 This option sets a max size in bytes for verified FIT uImages.
330 A sane value of 256MB protects corrupted DTB structures from overlapping
331 device memory. Assure this size does not extend past expected storage
332 space.
333
334endif # VPL
335
Simon Glass2289ca92023-09-14 10:55:52 -0600336endif # FIT
337
John Keeping9b60a172022-07-28 11:19:15 +0100338config PXE_UTILS
339 bool
340 select MENU
341 help
342 Utilities for parsing PXE file formats.
343
Tom Rini984bfdc2023-10-26 14:31:24 -0400344config BOOT_DEFAULTS_FEATURES
345 bool
346 select SUPPORT_RAW_INITRD
347 select ENV_VARS_UBOOT_CONFIG
348 imply USB_STORAGE
349 imply EFI_PARTITION
350 imply ISO_PARTITION
351
352config BOOT_DEFAULTS_CMDS
353 bool
Simon Glass054d0182023-03-24 16:58:13 -0400354 imply USE_BOOTCOMMAND
355 select CMD_ENV_EXISTS
356 select CMD_EXT2
357 select CMD_EXT4
358 select CMD_FAT
359 select CMD_FS_GENERIC
360 select CMD_PART if PARTITIONS
361 select CMD_DHCP if CMD_NET
362 select CMD_PING if CMD_NET
363 select CMD_PXE if CMD_NET
Simon Glass054d0182023-03-24 16:58:13 -0400364 select CMD_BOOTI if ARM64
365 select CMD_BOOTZ if ARM && !ARM64
366 imply CMD_MII if NET
Tom Rini984bfdc2023-10-26 14:31:24 -0400367
368config BOOT_DEFAULTS
369 bool # Common defaults for standard boot and distroboot
370 select BOOT_DEFAULTS_FEATURES
371 select BOOT_DEFAULTS_CMDS if CMDLINE
Simon Glass054d0182023-03-24 16:58:13 -0400372 help
373 These are not required but are commonly needed to support a good
374 selection of booting methods. Enable this to improve the capability
375 of U-Boot to boot various images. Currently much functionality is
376 tied to enabling the command that exercises it.
377
Simon Glass6cfb0022023-09-14 10:55:53 -0600378menuconfig BOOTSTD
379 bool "Standard boot"
Simon Glass08ad13e2022-04-24 23:31:06 -0600380 default y
381 depends on DM && OF_CONTROL && BLK
382 help
383 U-Boot supports a standard way of locating something to boot,
384 typically an Operating System such as Linux, provided by a distro such
385 as Arch Linux or Debian. Enable this to support iterating through
386 available bootdevs and using bootmeths to find bootflows suitable for
387 booting.
388
389 Standard boot is not a standard way of booting, just a framework
390 within U-Boot for supporting all the different ways that exist.
391
392 Terminology:
393
394 - bootdev - a device which can hold a distro (e.g. MMC)
395 - bootmeth - a method to scan a bootdev to find bootflows (owned by
396 U-Boot)
397 - bootflow - a description of how to boot (owned by the distro)
398
Simon Glass6cfb0022023-09-14 10:55:53 -0600399if BOOTSTD
400
Simon Glassbc993e52022-10-20 18:23:13 -0600401config SPL_BOOTSTD
Simon Glass4aa874f2023-02-22 09:33:58 -0700402 bool "Standard boot support in SPL"
Simon Glassbc993e52022-10-20 18:23:13 -0600403 depends on SPL && SPL_DM && SPL_OF_CONTROL && SPL_BLK
404 default y if VPL
405 help
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200406 This enables standard boot in SPL. This is needed so that VBE
Simon Glassbc993e52022-10-20 18:23:13 -0600407 (Verified Boot for Embedded) can be used, since it depends on standard
408 boot. It is enabled by default since the main purpose of VPL is to
409 handle the firmware part of VBE.
410
411config VPL_BOOTSTD
412 bool "Standard boot support in VPL"
413 depends on VPL && VPL_DM && VPL_OF_CONTROL && VPL_BLK
414 default y
415 help
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200416 This enables standard boot in SPL. This is needed so that VBE
Simon Glassbc993e52022-10-20 18:23:13 -0600417 (Verified Boot for Embedded) can be used, since it depends on standard
418 boot. It is enabled by default since the main purpose of VPL is to
419 handle the firmware part of VBE.
420
Simon Glass78c79dd2023-02-22 14:06:23 -0700421config BOOTSTD_FULL
422 bool "Enhanced features for standard boot"
423 default y if SANDBOX
Shantur Rathore19b54342023-12-23 06:51:59 +0000424 imply BOOTSTD_DEFAULTS
Simon Glass78c79dd2023-02-22 14:06:23 -0700425 help
426 This enables various useful features for standard boot, which are not
427 essential for operation:
428
429 - bootdev, bootmeth commands
430 - extra features in the bootflow command
431 - support for selecting the ordering of bootmeths ("bootmeth order")
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200432 - support for selecting the ordering of bootdevs using the Device Tree
Simon Glass78c79dd2023-02-22 14:06:23 -0700433 as well as the "boot_targets" environment variable
434
Simon Glass2e5161eb2023-01-28 15:00:21 -0700435config BOOTSTD_DEFAULTS
436 bool "Select some common defaults for standard boot"
437 depends on BOOTSTD
Simon Glass054d0182023-03-24 16:58:13 -0400438 select BOOT_DEFAULTS
Simon Glassdb92e782023-05-10 16:34:47 -0600439 select BOOTMETH_DISTRO
Simon Glass2e5161eb2023-01-28 15:00:21 -0700440 help
441 These are not required but are commonly needed to support a good
442 selection of booting methods. Enable this to improve the capability
443 of U-Boot to boot various images.
444
Simon Glassbe661cb2022-04-24 23:31:27 -0600445config BOOTSTD_BOOTCOMMAND
446 bool "Use bootstd to boot"
447 default y if !DISTRO_DEFAULTS
448 help
449 Enable this to select a default boot-command suitable for booting
450 with standard boot. This can be overridden by the board if needed,
451 but the default command should be enough for most boards which use
452 standard boot.
453
454 For now this is only selected if distro boot is NOT used, since
455 standard boot does not support all of the features of distro boot
456 yet.
457
Marek Vasutabb772a2024-10-20 17:43:12 +0200458config BOOTSTD_MENU
459 bool "Provide a menu of available bootflows for standard boot"
460 depends on BOOTSTD_FULL && EXPO
461 default y
462 help
463 Provide a menu of available bootflows and related options.
464
Simon Glass92368522023-11-18 14:05:19 -0700465config BOOTSTD_PROG
466 bool "Use programmatic boot"
467 depends on !CMDLINE
468 default y
469 help
470 Enable this to provide a board_run_command() function which can boot
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200471 a system without using commands. If the boot fails, then U-Boot will
Simon Glass92368522023-11-18 14:05:19 -0700472 panic.
473
474 Note: This currently has many limitations and is not a useful booting
475 solution. Future work will eventually make this a viable option.
476
Simon Glass4f8633d2022-07-30 15:52:21 -0600477config BOOTMETH_GLOBAL
478 bool
479 help
480 Add support for global bootmeths. This feature is used by VBE and
481 EFI bootmgr, since they take full control over which bootdevs are
482 selected to boot.
483
Mattijs Korpershoekb30baa92024-07-10 10:40:05 +0200484config BOOTMETH_ANDROID
485 bool "Bootdev support for Android"
486 depends on X86 || ARM || SANDBOX
487 depends on CMDLINE
Mattijs Korpershoekb30baa92024-07-10 10:40:05 +0200488 select ANDROID_BOOT_IMAGE
489 select CMD_BCB
Jerome Forissiere0f95512024-10-16 12:03:59 +0200490 imply CMD_FASTBOOT
491 imply FASTBOOT if !NET_LWIP
Mattijs Korpershoekb30baa92024-07-10 10:40:05 +0200492 select PARTITION_TYPE_GUID
493 select PARTITION_UUIDS
494 help
495 Enables support for booting Android using bootstd. Android requires
496 multiple partitions (misc, boot, vbmeta, ...) in storage for booting.
497
498 Note that only MMC bootdevs are supported at present. This is caused
499 by AVB being limited to MMC devices only.
500
Simon Glassd74e62a2023-07-12 09:04:45 -0600501config BOOTMETH_CROS
502 bool "Bootdev support for Chromium OS"
Simon Glass18700262023-07-30 11:17:02 -0600503 depends on X86 || ARM || SANDBOX
504 default y if !ARM
Simon Glassd7d3a972023-08-24 13:55:45 -0600505 select EFI_PARTITION
506 select PARTITION_TYPE_GUID
507 select PARTITION_UUIDS
Simon Glassd74e62a2023-07-12 09:04:45 -0600508 help
509 Enables support for booting Chromium OS using bootdevs. This uses the
510 kernel A slot and obtains the kernel command line from the parameters
511 provided there.
512
513 Note that only x86 devices are supported at present.
514
Simon Glassb71d7f72023-05-10 16:34:46 -0600515config BOOTMETH_EXTLINUX
516 bool "Bootdev support for extlinux boot"
John Keeping9b60a172022-07-28 11:19:15 +0100517 select PXE_UTILS
Simon Glassad8ec372022-04-24 23:31:13 -0600518 default y
519 help
Simon Glassb71d7f72023-05-10 16:34:46 -0600520 Enables support for extlinux boot using bootdevs. This makes the
Simon Glassad8ec372022-04-24 23:31:13 -0600521 bootdevs look for a 'extlinux/extlinux.conf' on each filesystem
522 they scan.
523
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200524 The specification for this file is here:
Simon Glassb71d7f72023-05-10 16:34:46 -0600525
526 https://uapi-group.org/specifications/specs/boot_loader_specification/
527
Simon Glassad8ec372022-04-24 23:31:13 -0600528 This provides a way to try out standard boot on an existing boot flow.
529
Simon Glassb71d7f72023-05-10 16:34:46 -0600530config BOOTMETH_EXTLINUX_PXE
531 bool "Bootdev support for extlinux boot over network"
Simon Glass83144612022-04-24 23:31:16 -0600532 depends on CMD_PXE && CMD_NET && DM_ETH
533 default y
534 help
Simon Glassb71d7f72023-05-10 16:34:46 -0600535 Enables support for extlinux boot using bootdevs. This makes the
Simon Glass83144612022-04-24 23:31:16 -0600536 bootdevs look for a 'extlinux/extlinux.conf' on the tftp server.
537
Simon Glassb71d7f72023-05-10 16:34:46 -0600538 The specification for this file is here:
539
540 https://uapi-group.org/specifications/specs/boot_loader_specification/
541
Simon Glass83144612022-04-24 23:31:16 -0600542 This provides a way to try out standard boot on an existing boot flow.
543
Simon Glass66f62552022-04-24 23:31:17 -0600544config BOOTMETH_EFILOADER
545 bool "Bootdev support for EFI boot"
AKASHI Takahiro9b08b9a2024-01-17 13:39:41 +0900546 depends on EFI_BINARY_EXEC
Jerome Forissiere0f95512024-10-16 12:03:59 +0200547 imply CMD_TFTPBOOT if CMD_NET
Simon Glass66f62552022-04-24 23:31:17 -0600548 default y
549 help
550 Enables support for EFI boot using bootdevs. This makes the
551 bootdevs look for a 'boot<arch>.efi' on each filesystem
552 they scan. The resulting file is booted after enabling U-Boot's
553 EFI loader support.
554
555 The <arch> depends on the architecture of the board:
556
557 aa64 - aarch64 (ARM 64-bit)
558 arm - ARM 32-bit
559 ia32 - x86 32-bit
560 x64 - x86 64-bit
561 riscv32 - RISC-V 32-bit
562 riscv64 - RISC-V 64-bit
563
564 This provides a way to try out standard boot on an existing boot flow.
565
Heinrich Schuchardt72bca1a2024-04-03 20:05:17 +0200566config BOOTMETH_EFI_BOOTMGR
567 bool "Bootdev support for EFI boot manager"
568 depends on EFI_BOOTMGR
569 select BOOTMETH_GLOBAL
570 default y
571 help
572 Enable booting via the UEFI boot manager. Based on the EFI variables
573 the EFI binary to be launched is determined. To set the EFI variables
574 use the eficonfig command.
575
Heinrich Schuchardt1cd3ec92024-07-16 10:35:34 +0200576config BOOTMETH_QFW
577 bool "Boot method using QEMU parameters"
578 depends on QFW
579 default y
580 help
581 Use QEMU parameters -kernel, -initrd, -append to determine the kernel,
582 initial RAM disk, and kernel command line parameters to boot an
583 operating system. U-Boot's control device-tree is passed to the kernel.
584
Simon Glass0a9f4262022-07-30 15:52:32 -0600585config BOOTMETH_VBE
586 bool "Bootdev support for Verified Boot for Embedded"
587 depends on FIT
588 default y
589 select BOOTMETH_GLOBAL
Tom Rini7d3684a2023-01-16 15:46:49 -0500590 select EVENT
Simon Glass0a9f4262022-07-30 15:52:32 -0600591 help
592 Enables support for VBE boot. This is a standard boot method which
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200593 supports selection of various firmware components, selection of an OS to
Simon Glass0a9f4262022-07-30 15:52:32 -0600594 boot as well as updating these using fwupd.
595
Simon Glassdb92e782023-05-10 16:34:47 -0600596config BOOTMETH_DISTRO
597 bool # Options needed to boot any distro
Tom Rini9bf470a2023-10-26 14:31:27 -0400598 select BOOTMETH_SCRIPT if CMDLINE # E.g. Armbian uses scripts
Simon Glassdb92e782023-05-10 16:34:47 -0600599 select BOOTMETH_EXTLINUX # E.g. Debian uses these
600 select BOOTMETH_EXTLINUX_PXE if CMD_PXE && CMD_NET && DM_ETH
AKASHI Takahiro9b08b9a2024-01-17 13:39:41 +0900601 select BOOTMETH_EFILOADER if EFI_BINARY_EXEC # E.g. Ubuntu uses this
Simon Glassdb92e782023-05-10 16:34:47 -0600602
Simon Glassbc993e52022-10-20 18:23:13 -0600603config SPL_BOOTMETH_VBE
604 bool "Bootdev support for Verified Boot for Embedded (SPL)"
605 depends on SPL && FIT
Tom Rini7d3684a2023-01-16 15:46:49 -0500606 select EVENT
Simon Glassbc993e52022-10-20 18:23:13 -0600607 default y if VPL
608 help
609 Enables support for VBE boot. This is a standard boot method which
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200610 supports selection of various firmware components, selection of an OS to
Simon Glassbc993e52022-10-20 18:23:13 -0600611 boot as well as updating these using fwupd.
612
613config VPL_BOOTMETH_VBE
614 bool "Bootdev support for Verified Boot for Embedded (VPL)"
615 depends on VPL && FIT
Tom Rini7d3684a2023-01-16 15:46:49 -0500616 select EVENT
Simon Glassbc993e52022-10-20 18:23:13 -0600617 default y
618 help
619 Enables support for VBE boot. This is a standard boot method which
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200620 supports selection of various firmware components, selection of an OS to
Simon Glassbc993e52022-10-20 18:23:13 -0600621 boot as well as updating these using fwupd.
622
Simon Glassd0af04c2022-07-30 15:52:33 -0600623if BOOTMETH_VBE
624
Simon Glass513eeed2023-02-22 09:33:52 -0700625config BOOTMETH_VBE_REQUEST
626 bool "Support for serving VBE OS requests"
627 default y
628 help
629 Enables support for looking that the requests made by the
630 Operating System being booted. These requests result in additions to
631 the device tree /chosen node, added during the device tree fixup
632 phase.
633
634config SPL_BOOTMETH_VBE_REQUEST
635 bool "Support for serving VBE OS requests (SPL)"
636 depends on SPL
637 help
638 Enables support for looking that the requests made by the
639 Operating System being booted. These requests result in additions to
640 the device tree /chosen node, added during the device tree fixup
641 phase.
642
643 This is only useful if you are booting an OS direct from SPL.
644
Simon Glassd0af04c2022-07-30 15:52:33 -0600645config BOOTMETH_VBE_SIMPLE
646 bool "Bootdev support for VBE 'simple' method"
647 default y
648 help
649 Enables support for VBE 'simple' boot. This allows updating a single
650 firmware image in boot media such as MMC. It does not support any sort
651 of rollback, recovery or A/B boot.
652
Simon Glassbc993e52022-10-20 18:23:13 -0600653config BOOTMETH_VBE_SIMPLE_OS
654 bool "Bootdev support for VBE 'simple' method OS phase"
655 default y
656 help
657 Enables support for the OS parts of VBE 'simple' boot. This includes
658 fixing up the device tree with the required VBE information, ready
659 for booting into the OS. This option is only enabled for U-Boot
660 proper, since it is the phase where device tree fixups happen.
661
662config SPL_BOOTMETH_VBE_SIMPLE
663 bool "Bootdev support for VBE 'simple' method (SPL)"
664 depends on SPL
665 default y if VPL
666 help
667 Enables support for VBE 'simple' boot. This allows updating a single
668 firmware image in boot media such as MMC. It does not support any sort
669 of rollback, recovery or A/B boot.
670
671config VPL_BOOTMETH_VBE_SIMPLE
672 bool "Bootdev support for VBE 'simple' method (VPL)"
673 depends on VPL
674 default y
675 help
676 Enables support for VBE 'simple' boot. This allows updating a single
677 firmware image in boot media such as MMC. It does not support any sort
678 of rollback, recovery or A/B boot.
679
680config SPL_BOOTMETH_VBE_SIMPLE_FW
681 bool "Bootdev support for VBE 'simple' method firmware phase (SPL)"
682 depends on VPL
683 default y
684 help
685 Enables support for the firmware parts of VBE 'simple' boot. This
686 includes an SPL loader which locates the correct U-Boot to boot into.
687 This option should really only be enabled for VPL, since it is the
688 phase where the SPL + U-Boot decision should be made. But for now,
689 SPL does its own FIT-configuration selection.
690
691config VPL_BOOTMETH_VBE_SIMPLE_FW
692 bool "Bootdev support for VBE 'simple' method firmware phase (VPL)"
693 depends on VPL
694 default y
695 help
696 Enables support for the firmware parts of VBE 'simple' boot. This
697 includes an SPL loader which locates the correct SPL to boot into.
698 This option enabled for VPL, since it is the phase where the SPL
699 decision is made.
700
Tom Rini7082a0d2024-12-12 21:07:26 -0600701endif # BOOTMETH_VBE
Simon Glassd0af04c2022-07-30 15:52:33 -0600702
Simon Glassd8adbe92023-01-06 08:52:36 -0600703config EXPO
704 bool "Support for expos - groups of scenes displaying a UI"
Simon Glass389a4582023-01-28 15:00:18 -0700705 depends on VIDEO
Simon Glassd8adbe92023-01-06 08:52:36 -0600706 default y if BOOTMETH_VBE
707 help
708 An expo is a way of presenting and collecting information from the
709 user. It consists of a collection of 'scenes' of which only one is
710 presented at a time. An expo is typically used to show a boot menu
711 and allow settings to be changed.
712
713 The expo can be presented in graphics form using a vidconsole, or in
714 text form on a serial console.
715
Simon Glass423994e2022-04-24 23:31:20 -0600716config BOOTMETH_SANDBOX
717 def_bool y
718 depends on SANDBOX
719 help
720 This is a sandbox bootmeth driver used for testing. It always returns
721 -ENOTSUPP when attempting to boot.
722
Simon Glass7e03e742022-04-24 23:31:22 -0600723config BOOTMETH_SCRIPT
724 bool "Bootdev support for U-Boot scripts"
725 default y if BOOTSTD_FULL
Tom Rini9bf470a2023-10-26 14:31:27 -0400726 depends on CMDLINE
Simon Glassb4b7ebe2023-05-05 20:03:05 -0600727 select HUSH_PARSER
Simon Glass7e03e742022-04-24 23:31:22 -0600728 help
729 Enables support for booting a distro via a U-Boot script. This makes
730 the bootdevs look for a 'boot/boot.scr' file which can be used to
731 boot the distro.
732
733 This provides a way to try out standard boot on an existing boot flow.
734 It is not enabled by default to save space.
735
Simon Glass77459f42024-08-07 16:47:27 -0600736config UPL
737 bool "upl - Universal Payload Specification"
Simon Glass3a028c22024-08-07 16:47:30 -0600738 imply CMD_UPL
Simon Glass77459f42024-08-07 16:47:27 -0600739 imply UPL_READ
Simon Glassb9474a82024-08-07 16:47:28 -0600740 imply UPL_WRITE
Simon Glassbc3ec002024-08-07 16:47:31 -0600741 imply SPL_UPL if SPL
Simon Glass77459f42024-08-07 16:47:27 -0600742 help
743 Provides support for UPL payloads and handoff information. U-Boot
744 supports generating and accepting handoff information. The mkimage
745 tool will eventually support creating payloads.
746
747if UPL
748
749config UPL_READ
750 bool "upl - Support reading a Universal Payload handoff"
751 help
752 Provides support for decoding a UPL-format payload into a C structure
753 which can be used elsewhere in U-Boot. This is just the reading
Simon Glass45aec8e2024-08-07 16:47:34 -0600754 implementation, useful for trying it out. See UPL_IN for how
755 to tell U-Boot to actually read it on startup and use it for memory
756 and device information, etc.
Simon Glass77459f42024-08-07 16:47:27 -0600757
Simon Glassb9474a82024-08-07 16:47:28 -0600758config UPL_WRITE
759 bool "upl - Support writing a Universal Payload handoff"
760 help
761 Provides support for encoding a UPL-format payload from a C structure
762 so it can be passed to another program. This is just the writing
Simon Glassbc3ec002024-08-07 16:47:31 -0600763 implementation, useful for trying it out. See SPL_UPL_OUT
764 for how to tell U-Boot SPL to actually write it before jumping to
765 the next phase.
766
Simon Glass45aec8e2024-08-07 16:47:34 -0600767config UPL_IN
768 bool "upl - Read the UPL handoff on startup"
769 select UPL_READ
770 help
771 Read an SPL handoff when U-Boot starts and use it to provide
772 devices, memory layout, etc. required by U-Boot. This allows U-Boot
773 to function as a payload in the meaning of the specification.
774
Simon Glassbc3ec002024-08-07 16:47:31 -0600775if SPL
776
777config SPL_UPL
778 bool "Write a UPL handoff in SPL"
779 imply SPL_UPL_OUT
780 help
781 This tells SPL to write a UPL handoff and pass it to the next phase
782 (e.g. to U-Boot or another program which SPL loads and runs). THis
783 provides information to help that program run correctly and
784 efficiently on the machine.
785
786config SPL_UPL_WRITE
787 bool # upl - Support writing a Universal Payload handoff in SPL
788 select SPL_BLOBLIST
789 help
790 Provides support for encoding a UPL-format payload from a C structure
791 so it can be passed to another program. This is just the writing
Simon Glassb9474a82024-08-07 16:47:28 -0600792 implementation, useful for trying it out.
793
Simon Glassbc3ec002024-08-07 16:47:31 -0600794config SPL_UPL_OUT
795 bool "upl - Support writing a Universal Payload handoff in SPL"
796 select SPL_UPL_WRITE
797 help
798 Provides support for encoding a UPL-format payload and passing it to
799 the next firmware phase. This allows U-Boot SPL to function as
800 Platform Init in the meaning of the specification.
801
802endif # SPL
803
Simon Glass77459f42024-08-07 16:47:27 -0600804endif # UPL
805
Simon Glass6cfb0022023-09-14 10:55:53 -0600806endif # BOOTSTD
Simon Glassad8ec372022-04-24 23:31:13 -0600807
Simon Glassb45b1632020-09-10 20:21:13 -0600808config LEGACY_IMAGE_FORMAT
809 bool "Enable support for the legacy image format"
Andrew Davis98a22d02022-05-04 15:52:27 -0500810 default y if !FIT_SIGNATURE && !TI_SECURE_DEVICE
Simon Glassb45b1632020-09-10 20:21:13 -0600811 help
812 This option enables the legacy image format. It is enabled by
813 default for backward compatibility, unless FIT_SIGNATURE is
814 set where it is disabled so that unsigned images cannot be
815 loaded. If a board needs the legacy image format support in this
816 case, enable it here.
817
Eddie James32401ba2023-10-24 10:43:50 -0500818config MEASURED_BOOT
819 bool "Measure boot images and configuration when booting without EFI"
820 depends on HASH && TPM_V2
Ilias Apalodimas1e665f92024-06-23 14:48:18 +0300821 select SHA1
822 select SHA256
823 select SHA384
824 select SHA512
Eddie James32401ba2023-10-24 10:43:50 -0500825 help
826 This option enables measurement of the boot process when booting
827 without UEFI . Measurement involves creating cryptographic hashes
828 of the binary images that are booting and storing them in the TPM.
829 In addition, a log of these hashes is stored in memory for the OS
830 to verify the booted images and configuration. Enable this if the
831 OS has configured some memory area for the event log and you intend
832 to use some attestation tools on your system.
833
834if MEASURED_BOOT
835 config MEASURE_DEVICETREE
836 bool "Measure the devicetree image"
837 default y if MEASURED_BOOT
838 help
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200839 On some platforms, the Device Tree is not static as it may contain
Eddie James32401ba2023-10-24 10:43:50 -0500840 random MAC addresses or other such data that changes each boot.
841 Therefore, it should not be measured into the TPM. In that case,
842 disable the measurement here.
843
844 config MEASURE_IGNORE_LOG
845 bool "Ignore the existing event log"
Eddie James32401ba2023-10-24 10:43:50 -0500846 help
847 On platforms that use an event log memory region that persists
848 through system resets and are the first stage bootloader, then
849 this option should be enabled to ignore any existing data in the
850 event log memory region.
851endif # MEASURED_BOOT
852
Tom Riniec8d1602023-10-26 14:31:25 -0400853config SYS_BOOTM_LEN
854 hex "Maximum size of a decompresed OS image"
Tom Rini793921e2024-04-18 08:29:35 -0600855 depends on CMD_BOOTM || CMD_BOOTI || CMD_BOOTZ || \
Tom Riniec8d1602023-10-26 14:31:25 -0400856 LEGACY_IMAGE_FORMAT || SPL_LEGACY_IMAGE_FORMAT
857 default 0x4000000 if PPC || ARM64
858 default 0x1000000 if X86 || ARCH_MX6 || ARCH_MX7
859 default 0x800000
860 help
861 This is the maximum size of the buffer that is used to decompress the OS
862 image in to if attempting to boot a compressed image.
863
Simon Glassf11d6132020-09-10 20:21:19 -0600864config SUPPORT_RAW_INITRD
865 bool "Enable raw initrd images"
866 help
867 Note, defining the SUPPORT_RAW_INITRD allows user to supply
868 kernel with raw initrd images. The syntax is slightly different, the
869 address of the initrd must be augmented by it's size, in the following
870 format: "<initrd address>:<initrd size>".
871
Simon Glassd81f07f2020-11-04 09:57:35 -0700872config CHROMEOS
873 bool "Support booting Chrome OS"
874 help
875 Chrome OS requires U-Boot to set up a table indicating the boot mode
876 (e.g. Developer mode) and a few other things. Enable this if you are
877 booting on a Chromebook to avoid getting an error about an invalid
878 firmware ID.
879
880config CHROMEOS_VBOOT
881 bool "Support Chrome OS verified boot"
882 help
883 This is intended to enable the full Chrome OS verified boot support
884 in U-Boot. It is not actually implemented in the U-Boot source code
885 at present, so this option is always set to 'n'. It allows
886 distinguishing between booting Chrome OS in a basic way (developer
887 mode) and a full boot.
888
Tom Rinieb4f2de2022-06-25 11:02:44 -0400889config SYS_RAMBOOT
890 bool
891
Tom Rini9ff815a2021-08-24 23:11:49 -0400892config RAMBOOT_PBL
893 bool "Freescale PBL(pre-boot loader) image format support"
Tom Rinieb4f2de2022-06-25 11:02:44 -0400894 select SYS_RAMBOOT if PPC
Tom Rini9ff815a2021-08-24 23:11:49 -0400895 help
896 Some SoCs use PBL to load RCW and/or pre-initialization instructions.
897 For more details refer to doc/README.pblimage
898
Tom Rini886e6e32022-03-23 17:20:03 -0400899choice
Tom Rini489f4022022-12-28 10:52:51 -0500900 prompt "Freescale PBL (or predecessor) load location"
Tom Rini886e6e32022-03-23 17:20:03 -0400901 depends on RAMBOOT_PBL || ((TARGET_P1010RDB_PA || TARGET_P1010RDB_PB \
902 || TARGET_P1020RDB_PC || TARGET_P1020RDB_PD || TARGET_P2020RDB) \
Pali Rohár6763ff82024-06-06 18:33:26 +0200903 && !CMD_NAND) || (TARGET_TURRIS_1X && SYS_MPC85XX_NO_RESETVEC)
Tom Rini886e6e32022-03-23 17:20:03 -0400904
905config SDCARD
Tom Rini489f4022022-12-28 10:52:51 -0500906 bool "Freescale PBL (or similar) is found on SD card"
Tom Rini886e6e32022-03-23 17:20:03 -0400907
908config SPIFLASH
Tom Rini489f4022022-12-28 10:52:51 -0500909 bool "Freescale PBL (or similar) is found on SPI flash"
910
911config NO_PBL
912 bool "Freescale PBL (or similar) is not used in this case"
Tom Rini886e6e32022-03-23 17:20:03 -0400913
914endchoice
915
Tom Rini5989fd42022-06-20 08:07:42 -0400916config FSL_FIXED_MMC_LOCATION
917 bool "PBL MMC is at a fixed location"
918 depends on SDCARD && !RAMBOOT_PBL
919
920config ESDHC_HC_BLK_ADDR
921 def_bool y
922 depends on FSL_FIXED_MMC_LOCATION && (ARCH_BSC9131 || ARCH_BSC9132 || ARCH_P1010)
923 help
924 In High Capacity SD Cards (> 2 GBytes), the 32-bit source address and
925 code length of these soc specify the memory address in block address
926 format. Block length is fixed to 512 bytes as per the SD High
927 Capacity specification.
928
Tom Rini9ff815a2021-08-24 23:11:49 -0400929config SYS_FSL_PBL_PBI
930 string "PBI(pre-boot instructions) commands for the PBL image"
931 depends on RAMBOOT_PBL
932 help
933 PBI commands can be used to configure SoC before it starts the execution.
934 Please refer doc/README.pblimage for more details.
935
936config SYS_FSL_PBL_RCW
937 string "Aadditional RCW (Power on reset configuration) for the PBL image"
938 depends on RAMBOOT_PBL
939 help
940 Enables addition of RCW (Power on reset configuration) in built image.
941 Please refer doc/README.pblimage for more details.
942
Tom Rini94b4fec2022-06-25 11:02:46 -0400943config SYS_BOOT_RAMDISK_HIGH
944 depends on CMD_BOOTM || CMD_BOOTI || CMD_BOOTZ
945 depends on !(NIOS2 || SANDBOX || SH || XTENSA)
946 def_bool y
Simon Glass65edcd32023-03-24 16:58:12 -0400947 select LMB
Tom Rini94b4fec2022-06-25 11:02:46 -0400948 help
949 Enable initrd_high functionality. If defined then the initrd_high
950 feature is enabled and the boot* ramdisk subcommand is enabled.
951
Simon Glassb45b1632020-09-10 20:21:13 -0600952endmenu # Boot images
953
Simon Glassf111bf72023-03-24 16:58:11 -0400954config DISTRO_DEFAULTS
Simon Glasse27d7df2023-09-14 10:55:55 -0600955 bool "(deprecated) Script-based booting of Linux distributions"
Tom Rini045245b2023-10-26 14:31:23 -0400956 select CMDLINE
Simon Glass054d0182023-03-24 16:58:13 -0400957 select BOOT_DEFAULTS
Simon Glassf111bf72023-03-24 16:58:11 -0400958 select AUTO_COMPLETE
959 select CMDLINE_EDITING
Simon Glassf111bf72023-03-24 16:58:11 -0400960 select CMD_SYSBOOT
Simon Glassf111bf72023-03-24 16:58:11 -0400961 select HUSH_PARSER
Simon Glassf111bf72023-03-24 16:58:11 -0400962 select SYS_LONGHELP
Simon Glassf111bf72023-03-24 16:58:11 -0400963 help
Simon Glasse27d7df2023-09-14 10:55:55 -0600964 Note: These scripts have been replaced by Standard Boot. Do not use
965 them on new boards. See 'Migrating from distro_boot' at
966 doc/develop/bootstd.rst
967
Simon Glassf111bf72023-03-24 16:58:11 -0400968 Select this to enable various options and commands which are suitable
969 for building u-boot for booting general purpose Linux distributions.
970
Simon Glassd02ddcf2020-09-10 20:21:14 -0600971menu "Boot timing"
972
973config BOOTSTAGE
974 bool "Boot timing and reporting"
975 help
976 Enable recording of boot time while booting. To use it, insert
977 calls to bootstage_mark() with a suitable BOOTSTAGE_ID from
978 bootstage.h. Only a single entry is recorded for each ID. You can
979 give the entry a name with bootstage_mark_name(). You can also
980 record elapsed time in a particular stage using bootstage_start()
981 before starting and bootstage_accum() when finished. Bootstage will
982 add up all the accumulated time and report it.
983
984 Normally, IDs are defined in bootstage.h but a small number of
985 additional 'user' IDs can be used by passing BOOTSTAGE_ID_ALLOC
986 as the ID.
987
988 Calls to show_boot_progress() will also result in log entries but
989 these will not have names.
990
991config SPL_BOOTSTAGE
992 bool "Boot timing and reported in SPL"
Tom Rini0a83cc22022-06-10 23:03:09 -0400993 depends on BOOTSTAGE && SPL
Simon Glassd02ddcf2020-09-10 20:21:14 -0600994 help
995 Enable recording of boot time in SPL. To make this visible to U-Boot
996 proper, enable BOOTSTAGE_STASH as well. This will stash the timing
997 information when SPL finishes and load it when U-Boot proper starts
998 up.
999
1000config TPL_BOOTSTAGE
1001 bool "Boot timing and reported in TPL"
Tom Rini36a4ca02022-06-08 08:24:39 -04001002 depends on BOOTSTAGE && TPL
Simon Glassd02ddcf2020-09-10 20:21:14 -06001003 help
1004 Enable recording of boot time in SPL. To make this visible to U-Boot
1005 proper, enable BOOTSTAGE_STASH as well. This will stash the timing
1006 information when TPL finishes and load it when U-Boot proper starts
1007 up.
1008
1009config BOOTSTAGE_REPORT
1010 bool "Display a detailed boot timing report before booting the OS"
1011 depends on BOOTSTAGE
1012 help
1013 Enable output of a boot time report just before the OS is booted.
1014 This shows how long it took U-Boot to go through each stage of the
1015 boot process. The report looks something like this:
1016
1017 Timer summary in microseconds:
1018 Mark Elapsed Stage
1019 0 0 reset
1020 3,575,678 3,575,678 board_init_f start
1021 3,575,695 17 arch_cpu_init A9
1022 3,575,777 82 arch_cpu_init done
1023 3,659,598 83,821 board_init_r start
1024 3,910,375 250,777 main_loop
1025 29,916,167 26,005,792 bootm_start
1026 30,361,327 445,160 start_kernel
1027
1028config BOOTSTAGE_RECORD_COUNT
1029 int "Number of boot stage records to store"
Simon Glass051ddfb2021-02-03 06:00:49 -07001030 depends on BOOTSTAGE
Simon Glassd02ddcf2020-09-10 20:21:14 -06001031 default 30
1032 help
1033 This is the size of the bootstage record list and is the maximum
1034 number of bootstage records that can be recorded.
1035
1036config SPL_BOOTSTAGE_RECORD_COUNT
1037 int "Number of boot stage records to store for SPL"
Simon Glass051ddfb2021-02-03 06:00:49 -07001038 depends on SPL_BOOTSTAGE
Simon Glassd02ddcf2020-09-10 20:21:14 -06001039 default 5
1040 help
1041 This is the size of the bootstage record list and is the maximum
1042 number of bootstage records that can be recorded.
1043
1044config TPL_BOOTSTAGE_RECORD_COUNT
1045 int "Number of boot stage records to store for TPL"
Simon Glass051ddfb2021-02-03 06:00:49 -07001046 depends on TPL_BOOTSTAGE
Simon Glassd02ddcf2020-09-10 20:21:14 -06001047 default 5
1048 help
1049 This is the size of the bootstage record list and is the maximum
1050 number of bootstage records that can be recorded.
1051
1052config BOOTSTAGE_FDT
1053 bool "Store boot timing information in the OS device tree"
1054 depends on BOOTSTAGE
1055 help
1056 Stash the bootstage information in the FDT. A root 'bootstage'
1057 node is created with each bootstage id as a child. Each child
1058 has a 'name' property and either 'mark' containing the
1059 mark time in microseconds, or 'accum' containing the
1060 accumulated time for that bootstage id in microseconds.
1061 For example:
1062
1063 bootstage {
1064 154 {
1065 name = "board_init_f";
1066 mark = <3575678>;
1067 };
1068 170 {
1069 name = "lcd";
1070 accum = <33482>;
1071 };
1072 };
1073
1074 Code in the Linux kernel can find this in /proc/devicetree.
1075
1076config BOOTSTAGE_STASH
1077 bool "Stash the boot timing information in memory before booting OS"
1078 depends on BOOTSTAGE
1079 help
1080 Some OSes do not support device tree. Bootstage can instead write
1081 the boot timing information in a binary format at a given address.
1082 This happens through a call to bootstage_stash(), typically in
1083 the CPU's cleanup_before_linux() function. You can use the
1084 'bootstage stash' and 'bootstage unstash' commands to do this on
1085 the command line.
1086
1087config BOOTSTAGE_STASH_ADDR
1088 hex "Address to stash boot timing information"
Tom Rinid78c9bd2024-07-15 12:42:00 +01001089 depends on BOOTSTAGE_STASH
1090 default 0xC3000000 if STM32MP13X || STM32MP15X
1091 default 0x87000000 if STM32MP25X
1092 default 0x0 if SANDBOX
Simon Glassd02ddcf2020-09-10 20:21:14 -06001093 help
1094 Provide an address which will not be overwritten by the OS when it
1095 starts, so that it can read this information when ready.
1096
1097config BOOTSTAGE_STASH_SIZE
1098 hex "Size of boot timing stash region"
Tom Rinid78c9bd2024-07-15 12:42:00 +01001099 depends on BOOTSTAGE_STASH
Simon Glassd02ddcf2020-09-10 20:21:14 -06001100 default 0x1000
1101 help
1102 This should be large enough to hold the bootstage stash. A value of
1103 4096 (4KiB) is normally plenty.
1104
1105config SHOW_BOOT_PROGRESS
1106 bool "Show boot progress in a board-specific manner"
1107 help
1108 Defining this option allows to add some board-specific code (calling
1109 a user-provided function show_boot_progress(int) that enables you to
1110 show the system's boot progress on some display (for example, some
1111 LEDs) on your board. At the moment, the following checkpoints are
1112 implemented:
1113
1114 Legacy uImage format:
1115
1116 Arg Where When
1117 1 common/cmd_bootm.c before attempting to boot an image
1118 -1 common/cmd_bootm.c Image header has bad magic number
1119 2 common/cmd_bootm.c Image header has correct magic number
1120 -2 common/cmd_bootm.c Image header has bad checksum
1121 3 common/cmd_bootm.c Image header has correct checksum
1122 -3 common/cmd_bootm.c Image data has bad checksum
1123 4 common/cmd_bootm.c Image data has correct checksum
1124 -4 common/cmd_bootm.c Image is for unsupported architecture
1125 5 common/cmd_bootm.c Architecture check OK
1126 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
1127 6 common/cmd_bootm.c Image Type check OK
1128 -6 common/cmd_bootm.c gunzip uncompression error
1129 -7 common/cmd_bootm.c Unimplemented compression type
1130 7 common/cmd_bootm.c Uncompression OK
1131 8 common/cmd_bootm.c No uncompress/copy overwrite error
1132 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
1133
1134 9 common/image.c Start initial ramdisk verification
1135 -10 common/image.c Ramdisk header has bad magic number
1136 -11 common/image.c Ramdisk header has bad checksum
1137 10 common/image.c Ramdisk header is OK
1138 -12 common/image.c Ramdisk data has bad checksum
1139 11 common/image.c Ramdisk data has correct checksum
1140 12 common/image.c Ramdisk verification complete, start loading
1141 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
1142 13 common/image.c Start multifile image verification
1143 14 common/image.c No initial ramdisk, no multifile, continue.
1144
1145 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
1146
1147 -30 arch/powerpc/lib/board.c Fatal error, hang the system
1148 -31 post/post.c POST test failed, detected by post_output_backlog()
1149 -32 post/post.c POST test failed, detected by post_run_single()
1150
1151 34 common/cmd_doc.c before loading a Image from a DOC device
1152 -35 common/cmd_doc.c Bad usage of "doc" command
1153 35 common/cmd_doc.c correct usage of "doc" command
1154 -36 common/cmd_doc.c No boot device
1155 36 common/cmd_doc.c correct boot device
1156 -37 common/cmd_doc.c Unknown Chip ID on boot device
1157 37 common/cmd_doc.c correct chip ID found, device available
1158 -38 common/cmd_doc.c Read Error on boot device
1159 38 common/cmd_doc.c reading Image header from DOC device OK
1160 -39 common/cmd_doc.c Image header has bad magic number
1161 39 common/cmd_doc.c Image header has correct magic number
1162 -40 common/cmd_doc.c Error reading Image from DOC device
1163 40 common/cmd_doc.c Image header has correct magic number
1164 41 common/cmd_ide.c before loading a Image from a IDE device
1165 -42 common/cmd_ide.c Bad usage of "ide" command
1166 42 common/cmd_ide.c correct usage of "ide" command
1167 -43 common/cmd_ide.c No boot device
1168 43 common/cmd_ide.c boot device found
1169 -44 common/cmd_ide.c Device not available
1170 44 common/cmd_ide.c Device available
1171 -45 common/cmd_ide.c wrong partition selected
1172 45 common/cmd_ide.c partition selected
1173 -46 common/cmd_ide.c Unknown partition table
1174 46 common/cmd_ide.c valid partition table found
1175 -47 common/cmd_ide.c Invalid partition type
1176 47 common/cmd_ide.c correct partition type
1177 -48 common/cmd_ide.c Error reading Image Header on boot device
1178 48 common/cmd_ide.c reading Image Header from IDE device OK
1179 -49 common/cmd_ide.c Image header has bad magic number
1180 49 common/cmd_ide.c Image header has correct magic number
1181 -50 common/cmd_ide.c Image header has bad checksum
1182 50 common/cmd_ide.c Image header has correct checksum
1183 -51 common/cmd_ide.c Error reading Image from IDE device
1184 51 common/cmd_ide.c reading Image from IDE device OK
1185 52 common/cmd_nand.c before loading a Image from a NAND device
1186 -53 common/cmd_nand.c Bad usage of "nand" command
1187 53 common/cmd_nand.c correct usage of "nand" command
1188 -54 common/cmd_nand.c No boot device
1189 54 common/cmd_nand.c boot device found
1190 -55 common/cmd_nand.c Unknown Chip ID on boot device
1191 55 common/cmd_nand.c correct chip ID found, device available
1192 -56 common/cmd_nand.c Error reading Image Header on boot device
1193 56 common/cmd_nand.c reading Image Header from NAND device OK
1194 -57 common/cmd_nand.c Image header has bad magic number
1195 57 common/cmd_nand.c Image header has correct magic number
1196 -58 common/cmd_nand.c Error reading Image from NAND device
1197 58 common/cmd_nand.c reading Image from NAND device OK
1198
1199 -60 common/env_common.c Environment has a bad CRC, using default
1200
1201 64 net/eth.c starting with Ethernet configuration.
1202 -64 net/eth.c no Ethernet found.
1203 65 net/eth.c Ethernet found.
1204
1205 -80 common/cmd_net.c usage wrong
1206 80 common/cmd_net.c before calling net_loop()
1207 -81 common/cmd_net.c some error in net_loop() occurred
1208 81 common/cmd_net.c net_loop() back without error
1209 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
1210 82 common/cmd_net.c trying automatic boot
1211 83 common/cmd_net.c running "source" command
1212 -83 common/cmd_net.c some error in automatic boot or "source" command
1213 84 common/cmd_net.c end without errors
1214
1215 FIT uImage format:
1216
1217 Arg Where When
1218 100 common/cmd_bootm.c Kernel FIT Image has correct format
1219 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
1220 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
1221 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
1222 102 common/cmd_bootm.c Kernel unit name specified
1223 -103 common/cmd_bootm.c Can't get kernel subimage node offset
1224 103 common/cmd_bootm.c Found configuration node
1225 104 common/cmd_bootm.c Got kernel subimage node offset
1226 -104 common/cmd_bootm.c Kernel subimage hash verification failed
1227 105 common/cmd_bootm.c Kernel subimage hash verification OK
1228 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
1229 106 common/cmd_bootm.c Architecture check OK
1230 -106 common/cmd_bootm.c Kernel subimage has wrong type
1231 107 common/cmd_bootm.c Kernel subimage type OK
1232 -107 common/cmd_bootm.c Can't get kernel subimage data/size
1233 108 common/cmd_bootm.c Got kernel subimage data/size
1234 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
1235 -109 common/cmd_bootm.c Can't get kernel subimage type
1236 -110 common/cmd_bootm.c Can't get kernel subimage comp
1237 -111 common/cmd_bootm.c Can't get kernel subimage os
1238 -112 common/cmd_bootm.c Can't get kernel subimage load address
1239 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
1240
1241 120 common/image.c Start initial ramdisk verification
1242 -120 common/image.c Ramdisk FIT image has incorrect format
1243 121 common/image.c Ramdisk FIT image has correct format
1244 122 common/image.c No ramdisk subimage unit name, using configuration
1245 -122 common/image.c Can't get configuration for ramdisk subimage
1246 123 common/image.c Ramdisk unit name specified
1247 -124 common/image.c Can't get ramdisk subimage node offset
1248 125 common/image.c Got ramdisk subimage node offset
1249 -125 common/image.c Ramdisk subimage hash verification failed
1250 126 common/image.c Ramdisk subimage hash verification OK
1251 -126 common/image.c Ramdisk subimage for unsupported architecture
1252 127 common/image.c Architecture check OK
1253 -127 common/image.c Can't get ramdisk subimage data/size
1254 128 common/image.c Got ramdisk subimage data/size
1255 129 common/image.c Can't get ramdisk load address
1256 -129 common/image.c Got ramdisk load address
1257
1258 -130 common/cmd_doc.c Incorrect FIT image format
1259 131 common/cmd_doc.c FIT image format OK
1260
1261 -140 common/cmd_ide.c Incorrect FIT image format
1262 141 common/cmd_ide.c FIT image format OK
1263
1264 -150 common/cmd_nand.c Incorrect FIT image format
1265 151 common/cmd_nand.c FIT image format OK
1266
Marek Vasut98154342021-10-23 03:06:03 +02001267config SPL_SHOW_BOOT_PROGRESS
Jan Kiszka5780edb2021-11-03 15:09:36 +01001268 bool "Show boot progress in a board-specific manner in SPL"
Marek Vasut98154342021-10-23 03:06:03 +02001269 depends on SPL
1270 help
1271 Defining this option allows to add some board-specific code (calling
1272 a user-provided function show_boot_progress(int) that enables you to
1273 show the system's boot progress on some display (for example, some
1274 LEDs) on your board. For details see SHOW_BOOT_PROGRESS.
1275
Simon Glassd02ddcf2020-09-10 20:21:14 -06001276endmenu
1277
Simon Glasseebed782020-09-10 20:21:15 -06001278menu "Boot media"
1279
1280config NOR_BOOT
1281 bool "Support for booting from NOR flash"
1282 depends on NOR
1283 help
1284 Enabling this will make a U-Boot binary that is capable of being
1285 booted via NOR. In this case we will enable certain pinmux early
1286 as the ROM only partially sets up pinmux. We also default to using
1287 NOR for environment.
1288
1289config NAND_BOOT
1290 bool "Support for booting from NAND flash"
Simon Glasseebed782020-09-10 20:21:15 -06001291 imply MTD_RAW_NAND
1292 help
1293 Enabling this will make a U-Boot binary that is capable of being
1294 booted via NAND flash. This is not a must, some SoCs need this,
1295 some not.
1296
1297config ONENAND_BOOT
1298 bool "Support for booting from ONENAND"
Simon Glasseebed782020-09-10 20:21:15 -06001299 imply MTD_RAW_NAND
1300 help
1301 Enabling this will make a U-Boot binary that is capable of being
1302 booted via ONENAND. This is not a must, some SoCs need this,
1303 some not.
1304
1305config QSPI_BOOT
1306 bool "Support for booting from QSPI flash"
Simon Glasseebed782020-09-10 20:21:15 -06001307 help
1308 Enabling this will make a U-Boot binary that is capable of being
1309 booted via QSPI flash. This is not a must, some SoCs need this,
1310 some not.
1311
1312config SATA_BOOT
1313 bool "Support for booting from SATA"
Simon Glasseebed782020-09-10 20:21:15 -06001314 help
1315 Enabling this will make a U-Boot binary that is capable of being
1316 booted via SATA. This is not a must, some SoCs need this,
1317 some not.
1318
1319config SD_BOOT
1320 bool "Support for booting from SD/EMMC"
Simon Glasseebed782020-09-10 20:21:15 -06001321 help
1322 Enabling this will make a U-Boot binary that is capable of being
1323 booted via SD/EMMC. This is not a must, some SoCs need this,
1324 some not.
1325
Tom Rinia43bf4e2021-12-11 14:55:50 -05001326config SD_BOOT_QSPI
1327 bool "Support for booting from SD/EMMC and enable QSPI"
1328 help
1329 Enabling this will make a U-Boot binary that is capable of being
1330 booted via SD/EMMC while enabling QSPI on the platform as well. This
1331 is not a must, some SoCs need this, some not.
1332
Simon Glasseebed782020-09-10 20:21:15 -06001333config SPI_BOOT
1334 bool "Support for booting from SPI flash"
Simon Glasseebed782020-09-10 20:21:15 -06001335 help
1336 Enabling this will make a U-Boot binary that is capable of being
1337 booted via SPI flash. This is not a must, some SoCs need this,
1338 some not.
1339
1340endmenu
1341
Simon Glasse9d54d72020-09-10 20:21:16 -06001342menu "Autoboot options"
1343
1344config AUTOBOOT
1345 bool "Autoboot"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001346 depends on CMDLINE
Simon Glasse9d54d72020-09-10 20:21:16 -06001347 default y
1348 help
1349 This enables the autoboot. See doc/README.autoboot for detail.
1350
Simon Glass7dee9dc2023-10-26 14:31:22 -04001351if AUTOBOOT
1352
Simon Glass1b6cbaa2020-09-10 20:21:17 -06001353config BOOTDELAY
1354 int "delay in seconds before automatically booting"
1355 default 2
Simon Glass1b6cbaa2020-09-10 20:21:17 -06001356 help
1357 Delay before automatically running bootcmd;
1358 set to 0 to autoboot with no delay, but you can stop it by key input.
1359 set to -1 to disable autoboot.
1360 set to -2 to autoboot with no delay and not check for abort
1361
1362 If this value is >= 0 then it is also used for the default delay
1363 before starting the default entry in bootmenu. If it is < 0 then
1364 a default value of 10s is used.
1365
1366 See doc/README.autoboot for details.
1367
Simon Glasse9d54d72020-09-10 20:21:16 -06001368config AUTOBOOT_KEYED
1369 bool "Stop autobooting via specific input key / string"
Simon Glasse9d54d72020-09-10 20:21:16 -06001370 help
1371 This option enables stopping (aborting) of the automatic
1372 boot feature only by issuing a specific input key or
1373 string. If not enabled, any input key will abort the
1374 U-Boot automatic booting process and bring the device
1375 to the U-Boot prompt for user input.
1376
Simon Glass7dee9dc2023-10-26 14:31:22 -04001377if AUTOBOOT_KEYED
1378
Steffen Jaeckeldfc97322021-07-08 15:57:38 +02001379config AUTOBOOT_FLUSH_STDIN
1380 bool "Enable flushing stdin before starting to read the password"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001381 depends on !SANDBOX
Steffen Jaeckeldfc97322021-07-08 15:57:38 +02001382 help
1383 When this option is enabled stdin buffer will be flushed before
1384 starting to read the password.
1385 This can't be enabled for the sandbox as flushing stdin would
1386 break the autoboot unit tests.
1387
Simon Glasse9d54d72020-09-10 20:21:16 -06001388config AUTOBOOT_PROMPT
1389 string "Autoboot stop prompt"
Simon Glasse9d54d72020-09-10 20:21:16 -06001390 default "Autoboot in %d seconds\\n"
1391 help
1392 This string is displayed before the boot delay selected by
1393 CONFIG_BOOTDELAY starts. If it is not defined there is no
1394 output indicating that autoboot is in progress.
1395
1396 Note that this define is used as the (only) argument to a
1397 printf() call, so it may contain '%' format specifications,
Quentin Schulzc0a7ae02024-06-12 16:58:47 +02001398 provided that it also includes, separated by commas exactly
Simon Glasse9d54d72020-09-10 20:21:16 -06001399 like in a printf statement, the required arguments. It is
1400 the responsibility of the user to select only such arguments
1401 that are valid in the given context.
1402
1403config AUTOBOOT_ENCRYPTION
1404 bool "Enable encryption in autoboot stopping"
Simon Glasse9d54d72020-09-10 20:21:16 -06001405 help
1406 This option allows a string to be entered into U-Boot to stop the
Steffen Jaeckel6aa6bfb2021-07-08 15:57:35 +02001407 autoboot.
1408 The behavior depends whether CONFIG_CRYPT_PW from lib is enabled
1409 or not.
1410 In case CONFIG_CRYPT_PW is enabled, the string will be forwarded
1411 to the crypt-based functionality and be compared against the
1412 string in the environment variable 'bootstopkeycrypt'.
1413 In case CONFIG_CRYPT_PW is disabled the string itself is hashed
1414 and compared against the hash in the environment variable
1415 'bootstopkeysha256'.
1416 If it matches in either case then boot stops and
1417 a command-line prompt is presented.
Simon Glasse9d54d72020-09-10 20:21:16 -06001418 This provides a way to ship a secure production device which can also
1419 be accessed at the U-Boot command line.
1420
Steffen Jaeckel28be70d2021-07-08 15:57:39 +02001421config AUTOBOOT_SHA256_FALLBACK
1422 bool "Allow fallback from crypt-hashed password to sha256"
1423 depends on AUTOBOOT_ENCRYPTION && CRYPT_PW
1424 help
1425 This option adds support to fall back from crypt-hashed
1426 passwords to checking a SHA256 hashed password in case the
1427 'bootstopusesha256' environment variable is set to 'true'.
1428
Simon Glasse9d54d72020-09-10 20:21:16 -06001429config AUTOBOOT_DELAY_STR
1430 string "Delay autobooting via specific input key / string"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001431 depends on !AUTOBOOT_ENCRYPTION
Simon Glasse9d54d72020-09-10 20:21:16 -06001432 help
1433 This option delays the automatic boot feature by issuing
1434 a specific input key or string. If CONFIG_AUTOBOOT_DELAY_STR
1435 or the environment variable "bootdelaykey" is specified
1436 and this string is received from console input before
1437 autoboot starts booting, U-Boot gives a command prompt. The
1438 U-Boot prompt will time out if CONFIG_BOOT_RETRY_TIME is
1439 used, otherwise it never times out.
1440
1441config AUTOBOOT_STOP_STR
1442 string "Stop autobooting via specific input key / string"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001443 depends on !AUTOBOOT_ENCRYPTION
Simon Glasse9d54d72020-09-10 20:21:16 -06001444 help
1445 This option enables stopping (aborting) of the automatic
1446 boot feature only by issuing a specific input key or
1447 string. If CONFIG_AUTOBOOT_STOP_STR or the environment
1448 variable "bootstopkey" is specified and this string is
1449 received from console input before autoboot starts booting,
1450 U-Boot gives a command prompt. The U-Boot prompt never
1451 times out, even if CONFIG_BOOT_RETRY_TIME is used.
1452
1453config AUTOBOOT_KEYED_CTRLC
1454 bool "Enable Ctrl-C autoboot interruption"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001455 depends on !AUTOBOOT_ENCRYPTION
Simon Glasse9d54d72020-09-10 20:21:16 -06001456 help
1457 This option allows for the boot sequence to be interrupted
1458 by ctrl-c, in addition to the "bootdelaykey" and "bootstopkey".
1459 Setting this variable provides an escape sequence from the
1460 limited "password" strings.
1461
Steffen Jaeckel792a13f2021-07-08 15:57:37 +02001462config AUTOBOOT_NEVER_TIMEOUT
1463 bool "Make the password entry never time-out"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001464 depends on AUTOBOOT_ENCRYPTION && CRYPT_PW
Steffen Jaeckel792a13f2021-07-08 15:57:37 +02001465 help
1466 This option removes the timeout from the password entry
1467 when the user first presses the <Enter> key before entering
1468 any other character.
1469
Steffen Jaeckel6aa6bfb2021-07-08 15:57:35 +02001470config AUTOBOOT_STOP_STR_ENABLE
1471 bool "Enable fixed string to stop autobooting"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001472 depends on AUTOBOOT_ENCRYPTION
Steffen Jaeckel6aa6bfb2021-07-08 15:57:35 +02001473 help
1474 This option enables the feature to add a fixed stop
1475 string that is defined at compile time.
1476 In every case it will be tried to load the stop
1477 string from the environment.
1478 In case this is enabled and there is no stop string
1479 in the environment, this will be used as default value.
1480
1481config AUTOBOOT_STOP_STR_CRYPT
1482 string "Stop autobooting via crypt-hashed password"
1483 depends on AUTOBOOT_STOP_STR_ENABLE && CRYPT_PW
1484 help
1485 This option adds the feature to only stop the autobooting,
1486 and therefore boot into the U-Boot prompt, when the input
1487 string / password matches a values that is hashed via
1488 one of the supported crypt-style password hashing options
1489 and saved in the environment variable "bootstopkeycrypt".
1490
Simon Glasse9d54d72020-09-10 20:21:16 -06001491config AUTOBOOT_STOP_STR_SHA256
Steffen Jaeckele1788f92021-07-08 15:57:40 +02001492 string "Stop autobooting via SHA256 hashed password"
Steffen Jaeckel6aa6bfb2021-07-08 15:57:35 +02001493 depends on AUTOBOOT_STOP_STR_ENABLE
Simon Glasse9d54d72020-09-10 20:21:16 -06001494 help
1495 This option adds the feature to only stop the autobooting,
1496 and therefore boot into the U-Boot prompt, when the input
Quentin Schulzc0a7ae02024-06-12 16:58:47 +02001497 string / password matches a values that is encrypted via
Joel Peshkin8b7bf532020-11-21 17:18:59 -08001498 a SHA256 hash and saved in the environment variable
1499 "bootstopkeysha256". If the value in that variable
1500 includes a ":", the portion prior to the ":" will be treated
1501 as a salt value.
Simon Glasse9d54d72020-09-10 20:21:16 -06001502
Simon Glass7dee9dc2023-10-26 14:31:22 -04001503endif # AUTOBOOT_KEYED
1504
1505if !AUTOBOOT_KEYED
1506
Simon Glasse9d54d72020-09-10 20:21:16 -06001507config AUTOBOOT_USE_MENUKEY
1508 bool "Allow a specify key to run a menu from the environment"
Simon Glasse9d54d72020-09-10 20:21:16 -06001509 help
1510 If a specific key is pressed to stop autoboot, then the commands in
1511 the environment variable 'menucmd' are executed before boot starts.
1512
1513config AUTOBOOT_MENUKEY
1514 int "ASCII value of boot key to show a menu"
1515 default 0
1516 depends on AUTOBOOT_USE_MENUKEY
1517 help
1518 If this key is pressed to stop autoboot, then the commands in the
1519 environment variable 'menucmd' will be executed before boot starts.
1520 For example, 33 means "!" in ASCII, so pressing ! at boot would take
1521 this action.
1522
Simon Glass7dee9dc2023-10-26 14:31:22 -04001523endif
1524
1525endif # AUTOBOOT
1526
Simon Glasse9d54d72020-09-10 20:21:16 -06001527config AUTOBOOT_MENU_SHOW
1528 bool "Show a menu on boot"
1529 depends on CMD_BOOTMENU
1530 help
1531 This enables the boot menu, controlled by environment variables
1532 defined by the board. The menu starts after running the 'preboot'
1533 environmnent variable (if enabled) and before handling the boot delay.
Peter Robinson16e0b8f2023-08-18 15:54:10 +01001534 See doc/usage/cmd/bootmenu.rst for more details.
Simon Glasse9d54d72020-09-10 20:21:16 -06001535
Masahisa Kojima97cbcc42022-05-26 19:09:38 +09001536config BOOTMENU_DISABLE_UBOOT_CONSOLE
1537 bool "Disallow bootmenu to enter the U-Boot console"
1538 depends on AUTOBOOT_MENU_SHOW
1539 help
1540 If this option is enabled, user can not enter the U-Boot console from
1541 bootmenu. It increases the system security.
1542
Tom Rinia45a3ef2022-03-11 09:12:04 -05001543config BOOT_RETRY
1544 bool "Boot retry feature"
1545 help
1546 Allow for having the U-Boot command prompt time out and attempt
1547 to boot again. If the environment variable "bootretry" is found then
1548 its value is used, otherwise the retry timeout is
1549 CONFIG_BOOT_RETRY_TIME. CONFIG_BOOT_RETRY_MIN is optional and
1550 defaults to CONFIG_BOOT_RETRY_TIME. All times are in seconds.
1551
1552config BOOT_RETRY_TIME
1553 int "Timeout in seconds before attempting to boot again"
1554 depends on BOOT_RETRY
1555 help
1556 Time in seconds before the U-Boot prompt will timeout and boot will
1557 be attempted again.
1558
1559config BOOT_RETRY_MIN
1560 int "Minimum timeout in seconds for 'bootretry'"
1561 depends on BOOT_RETRY
1562 default BOOT_RETRY_TIME
1563 help
1564 The minimum time in seconds that "bootretry" can be set to.
1565
1566config RESET_TO_RETRY
1567 bool "Reset the board to retry autoboot"
1568 depends on BOOT_RETRY
1569 help
1570 After the countdown timed out, the board will be reset to restart
1571 again.
1572
Simon Glasse9d54d72020-09-10 20:21:16 -06001573endmenu
1574
Philippe Reynesd28484e2022-03-28 22:56:59 +02001575menu "Image support"
1576
1577config IMAGE_PRE_LOAD
1578 bool "Image pre-load support"
1579 help
1580 Enable an image pre-load stage in the SPL.
1581 This pre-load stage allows to do some manipulation
1582 or check (for example signature check) on an image
1583 before launching it.
1584
1585config SPL_IMAGE_PRE_LOAD
1586 bool "Image pre-load support within SPL"
1587 depends on SPL && IMAGE_PRE_LOAD
1588 help
1589 Enable an image pre-load stage in the SPL.
1590 This pre-load stage allows to do some manipulation
1591 or check (for example signature check) on an image
1592 before launching it.
1593
1594config IMAGE_PRE_LOAD_SIG
1595 bool "Image pre-load signature support"
1596 depends on IMAGE_PRE_LOAD
1597 select FIT_SIGNATURE
1598 select RSA
1599 select RSA_VERIFY_WITH_PKEY
1600 help
1601 Enable signature check support in the pre-load stage.
1602 For this feature a very simple header is added before
1603 the image with few fields:
1604 - a magic
1605 - the image size
1606 - the signature
1607 All other information (header size, type of signature,
1608 ...) are provided in the node /image/pre-load/sig of
1609 u-boot.
1610
1611config SPL_IMAGE_PRE_LOAD_SIG
1612 bool "Image pre-load signature support witin SPL"
1613 depends on SPL_IMAGE_PRE_LOAD && IMAGE_PRE_LOAD_SIG
1614 select SPL_FIT_SIGNATURE
1615 select SPL_RSA
1616 select SPL_RSA_VERIFY_WITH_PKEY
1617 help
1618 Enable signature check support in the pre-load stage in the SPL.
1619 For this feature a very simple header is added before
1620 the image with few fields:
1621 - a magic
1622 - the image size
1623 - the signature
1624 All other information (header size, type of signature,
1625 ...) are provided in the node /image/pre-load/sig of
1626 u-boot.
1627
1628endmenu
1629
Simon Glass27367192023-09-14 10:55:46 -06001630if OF_LIBFDT
1631
1632menu "Devicetree fixup"
1633
Matthias Schiffere908fec2023-12-11 12:03:17 +01001634config OF_ENV_SETUP
1635 bool "Run a command from environment to set up device tree before boot"
1636 depends on CMD_FDT
1637 help
1638 This causes U-Boot to run a command from the environment variable
1639 fdt_fixup before booting into the operating system, which can use the
1640 fdt command to modify the device tree. The device tree is then passed
1641 to the OS.
1642
Simon Glass48e6d3d2023-09-14 10:55:47 -06001643config OF_BOARD_SETUP
1644 bool "Set up board-specific details in device tree before boot"
1645 help
1646 This causes U-Boot to call ft_board_setup() before booting into
1647 the Operating System. This function can set up various
1648 board-specific information in the device tree for use by the OS.
1649 The device tree is then passed to the OS.
1650
1651config OF_SYSTEM_SETUP
1652 bool "Set up system-specific details in device tree before boot"
1653 help
1654 This causes U-Boot to call ft_system_setup() before booting into
1655 the Operating System. This function can set up various
1656 system-specific information in the device tree for use by the OS.
1657 The device tree is then passed to the OS.
1658
1659config OF_STDOUT_VIA_ALIAS
1660 bool "Update the device-tree stdout alias from U-Boot"
1661 help
1662 This uses U-Boot's serial alias from the aliases node to update
1663 the device tree passed to the OS. The "linux,stdout-path" property
1664 in the chosen node is set to point to the correct serial node.
1665 This option currently references CONFIG_CONS_INDEX, which is
1666 incorrect when used with device tree as this option does not
1667 exist / should not be used.
1668
Simon Glassb7b7f162023-09-14 10:55:57 -06001669config FDT_FIXUP_PARTITIONS
Simon Glass1a5bcc12023-09-14 10:55:58 -06001670 bool "Overwrite MTD partitions in DTS through defined in 'mtdparts'"
Simon Glassb7b7f162023-09-14 10:55:57 -06001671 help
1672 Allow overwriting defined partitions in the device tree blob
1673 using partition info defined in the 'mtdparts' environment
1674 variable.
1675
Simon Glass27367192023-09-14 10:55:46 -06001676config FDT_SIMPLEFB
1677 bool "FDT tools for simplefb support"
Devarsh Thakkaree3dad42024-09-25 20:43:52 +05301678 depends on VIDEO
Simon Glass27367192023-09-14 10:55:46 -06001679 help
1680 Enable the fdt tools to manage the simple fb nodes in device tree.
1681 These functions can be used by board to indicate to the OS
1682 the presence of the simple frame buffer with associated reserved
1683 memory
1684
Simon Glass624c0e52023-09-14 10:55:59 -06001685config ARCH_FIXUP_FDT_MEMORY
Baruch Siachcfd5a552024-10-28 18:44:35 +02001686 bool "Enable fdt_fixup_memory_banks() call"
Simon Glass624c0e52023-09-14 10:55:59 -06001687 default y
1688 help
1689 Enable FDT memory map syncup before OS boot. This feature can be
1690 used for booting OS with different memory setup where the part of
1691 the memory location should be used for different purpose.
1692
Simon Glass27367192023-09-14 10:55:46 -06001693endmenu
1694
1695endif # OF_LIBFDT
1696
Simon Glass5e958642020-09-10 20:21:18 -06001697config USE_BOOTARGS
1698 bool "Enable boot arguments"
1699 help
1700 Provide boot arguments to bootm command. Boot arguments are specified
1701 in CONFIG_BOOTARGS option. Enable this option to be able to specify
1702 CONFIG_BOOTARGS string. If this option is disabled, CONFIG_BOOTARGS
1703 will be undefined and won't take any space in U-Boot image.
1704
1705config BOOTARGS
1706 string "Boot arguments"
1707 depends on USE_BOOTARGS && !USE_DEFAULT_ENV_FILE
1708 help
1709 This can be used to pass arguments to the bootm command. The value of
1710 CONFIG_BOOTARGS goes into the environment value "bootargs". Note that
1711 this value will also override the "chosen" node in FDT blob.
1712
Simon Glass529e2082020-11-05 10:33:48 -07001713config BOOTARGS_SUBST
1714 bool "Support substituting strings in boot arguments"
1715 help
1716 This allows substituting string values in the boot arguments. These
1717 are applied after the commandline has been built.
1718
1719 One use for this is to insert the root-disk UUID into the command
1720 line where bootargs contains "root=${uuid}"
1721
1722 setenv bootargs "console= root=${uuid}"
1723 # Set the 'uuid' environment variable
1724 part uuid mmc 2:2 uuid
1725
1726 # Command-line substitution will put the real uuid into the
1727 # kernel command line
1728 bootm
1729
Simon Glass5e958642020-09-10 20:21:18 -06001730config USE_BOOTCOMMAND
1731 bool "Enable a default value for bootcmd"
Tom Rinidc3bf2d2023-10-26 14:31:28 -04001732 depends on CMDLINE
Simon Glass5e958642020-09-10 20:21:18 -06001733 help
1734 Provide a default value for the bootcmd entry in the environment. If
1735 autoboot is enabled this is what will be run automatically. Enable
1736 this option to be able to specify CONFIG_BOOTCOMMAND as a string. If
1737 this option is disabled, CONFIG_BOOTCOMMAND will be undefined and
1738 won't take any space in U-Boot image.
1739
1740config BOOTCOMMAND
1741 string "bootcmd value"
1742 depends on USE_BOOTCOMMAND && !USE_DEFAULT_ENV_FILE
Simon Glass2d5a8e12023-05-06 08:27:09 -06001743 default "bootflow scan -lb" if BOOTSTD_DEFAULTS && CMD_BOOTFLOW_FULL
1744 default "bootflow scan" if BOOTSTD_DEFAULTS && !CMD_BOOTFLOW_FULL
Simon Glassbe661cb2022-04-24 23:31:27 -06001745 default "run distro_bootcmd" if !BOOTSTD_BOOTCOMMAND && DISTRO_DEFAULTS
Simon Glass5e958642020-09-10 20:21:18 -06001746 help
1747 This is the string of commands that will be used as bootcmd and if
1748 AUTOBOOT is set, automatically run.
1749
1750config USE_PREBOOT
1751 bool "Enable preboot"
Tom Rinidc3bf2d2023-10-26 14:31:28 -04001752 depends on CMDLINE
Simon Glass5e958642020-09-10 20:21:18 -06001753 help
1754 When this option is enabled, the existence of the environment
1755 variable "preboot" will be checked immediately before starting the
1756 CONFIG_BOOTDELAY countdown and/or running the auto-boot command resp.
1757 entering interactive mode.
1758
1759 This feature is especially useful when "preboot" is automatically
1760 generated or modified. For example, the boot code can modify the
1761 "preboot" when a user holds down a certain combination of keys.
1762
1763config PREBOOT
1764 string "preboot default value"
1765 depends on USE_PREBOOT && !USE_DEFAULT_ENV_FILE
Patrick Delaunaybb15d402020-10-12 09:47:50 +02001766 default "usb start" if USB_KEYBOARD
Simon Glass5e958642020-09-10 20:21:18 -06001767 default ""
1768 help
1769 This is the default of "preboot" environment variable.
1770
Pali Rohár39c43c32022-07-10 13:42:55 +02001771config PREBOOT_DEFINED
1772 bool
1773 default y if PREBOOT != ""
1774
Simon Glassc10ddfd2020-09-10 20:21:20 -06001775config DEFAULT_FDT_FILE
1776 string "Default fdt file"
1777 help
1778 This option is used to set the default fdt file to boot OS.
1779
Dzmitry Sankouskia3463062022-02-22 21:49:52 +03001780config SAVE_PREV_BL_FDT_ADDR
1781 depends on ARM
1782 bool "Saves fdt address, passed by the previous bootloader, to env var"
1783 help
1784 When u-boot is used as a chain-loaded bootloader (replacing OS kernel),
1785 enable this option to save fdt address, passed by the
1786 previous bootloader for future use.
1787 Address is saved to `prevbl_fdt_addr` environment variable.
1788
1789 If no fdt was provided by previous bootloader, no env variables
1790 will be created.
1791
1792config SAVE_PREV_BL_INITRAMFS_START_ADDR
1793 depends on ARM
1794 bool "Saves initramfs address, passed by the previous bootloader, to env var"
1795 help
1796 When u-boot is used as a chain-loaded bootloader(replacing OS kernel),
1797 enable this option to save initramfs address, passed by the
1798 previous bootloader for future use.
1799 Address is saved to `prevbl_initrd_start_addr` environment variable.
1800
1801 If no initramfs was provided by previous bootloader, no env variables
1802 will be created.
1803
Simon Glassc8925112023-06-01 10:23:02 -06001804menu "Configuration editor"
1805
1806config CEDIT
1807 bool "Configuration editor"
Heinrich Schuchardtef97f7c2023-12-16 16:38:36 +01001808 depends on EXPO
Simon Glassc8925112023-06-01 10:23:02 -06001809 help
1810 Provides a way to deal with board configuration and present it to
1811 the user for adjustment.
1812
1813 This is intended to provide both graphical and text-based user
1814 interfaces, but only graphical is support at present.
1815
1816endmenu # Configuration editor
1817
Simon Glassb45b1632020-09-10 20:21:13 -06001818endmenu # Booting