blob: 30106291e6b4c7a895ab88139ae56742309cf996 [file] [log] [blame]
Simon Glasscf298162020-09-10 20:21:13 -06001menu "Boot options"
2
3menu "Boot images"
4
Tom Rinicdd20e32024-04-18 08:29:35 -06005config ANDROID_BOOT_IMAGE
6 bool "Android Boot Images"
7 default y if FASTBOOT
8 help
9 This enables support for booting images which use the Android
10 image format header.
11
12config TIMESTAMP
13 bool "Show image date and time when displaying image information"
14 default y if CMD_DATE
15 help
16 When CONFIG_TIMESTAMP is selected, the timestamp (date and time) of
17 an image is printed by image commands like bootm or iminfo. This
18 is shown as 'Timestamp: xxx' and 'Created: xxx'. If this option is
19 enabled, then U-Boot requires FITs to have a timestamp. If a FIT is
20 loaded that does not, the message 'Wrong FIT format: no timestamp'
21 is shown.
22
23config BUTTON_CMD
24 bool "Support for running a command if a button is held during boot"
25 depends on CMDLINE
26 depends on BUTTON
27 help
28 For many embedded devices it's useful to enter a special flashing mode
29 such as fastboot mode when a button is held during boot. This option
30 allows arbitrary commands to be assigned to specific buttons. These will
31 be run after "preboot" if the button is held. Configuration is done via
32 the environment variables "button_cmd_N_name" and "button_cmd_N" where n is
33 the button number (starting from 0). e.g:
34
35 "button_cmd_0_name=vol_down"
36 "button_cmd_0=fastboot usb 0"
37
Simon Glass12a7ea02023-09-14 10:55:49 -060038menuconfig FIT
39 bool "Flattened Image Tree (FIT)"
Alexandru Gagniuc92055e12021-09-02 19:54:21 -050040 select HASH
Simon Glasscf298162020-09-10 20:21:13 -060041 select MD5
42 select SHA1
Alexandru Gagniuceb5171d2021-09-02 19:54:17 -050043 imply SHA256
Simon Glasscf298162020-09-10 20:21:13 -060044 help
45 This option allows you to boot the new uImage structure,
46 Flattened Image Tree. FIT is formally a FDT, which can include
47 images of various types (kernel, FDT blob, ramdisk, etc.)
48 in a single blob. To boot this new uImage structure,
49 pass the address of the blob to the "bootm" command.
50 FIT is very flexible, supporting compression, multiple images,
51 multiple configurations, verification through hashing and also
52 verified boot (secure boot using RSA).
53
Simon Glass12a7ea02023-09-14 10:55:49 -060054if FIT
Simon Glassd6b318d2021-12-18 11:27:50 -070055
Simon Glasscf298162020-09-10 20:21:13 -060056config FIT_EXTERNAL_OFFSET
57 hex "FIT external data offset"
58 default 0x0
59 help
60 This specifies a data offset in fit image.
61 The offset is from data payload offset to the beginning of
62 fit image header. When specifies a offset, specific data
63 could be put in the hole between data payload and fit image
64 header, such as CSF data on i.MX platform.
65
Simon Glass6f3c2d82021-02-15 17:08:10 -070066config FIT_FULL_CHECK
67 bool "Do a full check of the FIT before using it"
68 default y
69 help
70 Enable this do a full check of the FIT to make sure it is valid. This
71 helps to protect against carefully crafted FITs which take advantage
72 of bugs or omissions in the code. This includes a bad structure,
73 multiple root nodes and the like.
74
Simon Glasscf298162020-09-10 20:21:13 -060075config FIT_SIGNATURE
76 bool "Enable signature verification of FIT uImages"
Simon Glass12a7ea02023-09-14 10:55:49 -060077 depends on DM
Simon Glasscf298162020-09-10 20:21:13 -060078 select HASH
Alexandru Gagniuc61416fe2021-07-29 11:47:18 -050079 imply RSA
80 imply RSA_VERIFY
Simon Glasscf298162020-09-10 20:21:13 -060081 select IMAGE_SIGN_INFO
Simon Glass6f3c2d82021-02-15 17:08:10 -070082 select FIT_FULL_CHECK
Simon Glasscf298162020-09-10 20:21:13 -060083 help
84 This option enables signature verification of FIT uImages,
85 using a hash signed and verified using RSA. If
86 CONFIG_SHA_PROG_HW_ACCEL is defined, i.e support for progressive
87 hashing is available using hardware, then the RSA library will use
Heinrich Schuchardt3fc9de42024-06-18 08:23:17 +020088 it. See doc/usage/fit/signature.rst for more details.
Simon Glasscf298162020-09-10 20:21:13 -060089
90 WARNING: When relying on signed FIT images with a required signature
91 check the legacy image format is disabled by default, so that
92 unsigned images cannot be loaded. If a board needs the legacy image
93 format support in this case, enable it using
94 CONFIG_LEGACY_IMAGE_FORMAT.
95
96config FIT_SIGNATURE_MAX_SIZE
97 hex "Max size of signed FIT structures"
98 depends on FIT_SIGNATURE
99 default 0x10000000
100 help
101 This option sets a max size in bytes for verified FIT uImages.
102 A sane value of 256MB protects corrupted DTB structures from overlapping
103 device memory. Assure this size does not extend past expected storage
104 space.
105
Simon Glassad74aed2021-07-14 17:05:31 -0500106config FIT_RSASSA_PSS
Simon Glasscf298162020-09-10 20:21:13 -0600107 bool "Support rsassa-pss signature scheme of FIT image contents"
108 depends on FIT_SIGNATURE
Simon Glasscf298162020-09-10 20:21:13 -0600109 help
110 Enable this to support the pss padding algorithm as described
111 in the rfc8017 (https://tools.ietf.org/html/rfc8017).
112
113config FIT_CIPHER
114 bool "Enable ciphering data in a FIT uImages"
Simon Glass12a7ea02023-09-14 10:55:49 -0600115 depends on DM
Simon Glasscf298162020-09-10 20:21:13 -0600116 select AES
117 help
118 Enable the feature of data ciphering/unciphering in the tool mkimage
119 and in the u-boot support of the FIT image.
120
121config FIT_VERBOSE
122 bool "Show verbose messages when FIT images fail"
123 help
124 Generally a system will have valid FIT images so debug messages
125 are a waste of code space. If you are debugging your images then
126 you can enable this option to get more verbose information about
127 failures.
128
129config FIT_BEST_MATCH
130 bool "Select the best match for the kernel device tree"
131 help
132 When no configuration is explicitly selected, default to the
133 one whose fdt's compatibility field best matches that of
134 U-Boot itself. A match is considered "best" if it matches the
135 most specific compatibility entry of U-Boot's fdt's root node.
136 The order of entries in the configuration's fdt is ignored.
137
138config FIT_IMAGE_POST_PROCESS
139 bool "Enable post-processing of FIT artifacts after loading by U-Boot"
Manorit Chawdhry86fab112023-07-14 11:22:40 +0530140 depends on SOCFPGA_SECURE_VAB_AUTH
Simon Glasscf298162020-09-10 20:21:13 -0600141 help
142 Allows doing any sort of manipulation to blobs after they got extracted
143 from FIT images like stripping off headers or modifying the size of the
144 blob, verification, authentication, decryption etc. in a platform or
145 board specific way. In order to use this feature a platform or board-
146 specific implementation of board_fit_image_post_process() must be
147 provided. Also, anything done during this post-processing step would
148 need to be comprehended in how the images were prepared before being
149 injected into the FIT creation (i.e. the blobs would have been pre-
150 processed before being added to the FIT image).
151
Ravik Hasija7a018822021-01-27 14:01:48 -0800152config FIT_PRINT
Anand Moon608a88c2024-06-23 23:10:21 +0530153 bool "Support FIT printing"
154 default y
155 help
156 Support printing the content of the fitImage in a verbose manner.
Ravik Hasija7a018822021-01-27 14:01:48 -0800157
Simon Glasscf298162020-09-10 20:21:13 -0600158config SPL_FIT
159 bool "Support Flattened Image Tree within SPL"
Simon Glass4d8ea262023-09-14 10:55:52 -0600160 depends on SPL
Alexandru Gagniuc92055e12021-09-02 19:54:21 -0500161 select SPL_HASH
Simon Glasscf298162020-09-10 20:21:13 -0600162 select SPL_OF_LIBFDT
163
164config SPL_FIT_PRINT
165 bool "Support FIT printing within SPL"
166 depends on SPL_FIT
167 help
168 Support printing the content of the fitImage in a verbose manner in SPL.
169
Simon Glass6f3c2d82021-02-15 17:08:10 -0700170config SPL_FIT_FULL_CHECK
171 bool "Do a full check of the FIT before using it"
Tom Rini90c78882022-12-04 10:14:20 -0500172 depends on SPL_FIT
Simon Glass6f3c2d82021-02-15 17:08:10 -0700173 help
174 Enable this do a full check of the FIT to make sure it is valid. This
175 helps to protect against carefully crafted FITs which take advantage
176 of bugs or omissions in the code. This includes a bad structure,
177 multiple root nodes and the like.
178
Simon Glasscf298162020-09-10 20:21:13 -0600179config SPL_FIT_SIGNATURE
180 bool "Enable signature verification of FIT firmware within SPL"
181 depends on SPL_DM
Klaus Heinrich Kiwibdb7f262021-02-09 15:41:54 -0300182 depends on SPL_LOAD_FIT || SPL_LOAD_FIT_FULL
Klaus Heinrich Kiwi6ce28132021-02-09 15:41:53 -0300183 select FIT_SIGNATURE
Simon Glasscf298162020-09-10 20:21:13 -0600184 select SPL_FIT
Simon Glass0c6bdbb2021-07-10 21:14:25 -0600185 select SPL_CRYPTO
Alexandru Gagniuc07212092021-09-02 19:54:19 -0500186 select SPL_HASH
Alexandru Gagniuc61416fe2021-07-29 11:47:18 -0500187 imply SPL_RSA
188 imply SPL_RSA_VERIFY
Simon Glasscf298162020-09-10 20:21:13 -0600189 select SPL_IMAGE_SIGN_INFO
Simon Glass6f3c2d82021-02-15 17:08:10 -0700190 select SPL_FIT_FULL_CHECK
Simon Glasscf298162020-09-10 20:21:13 -0600191
Simon Glassb53541f2021-09-25 19:43:39 -0600192config SPL_FIT_SIGNATURE_MAX_SIZE
193 hex "Max size of signed FIT structures in SPL"
194 depends on SPL_FIT_SIGNATURE
195 default 0x10000000
196 help
197 This option sets a max size in bytes for verified FIT uImages.
198 A sane value of 256MB protects corrupted DTB structures from overlapping
199 device memory. Assure this size does not extend past expected storage
200 space.
201
Philippe Reynes5d39c932021-10-15 11:35:03 +0200202config SPL_FIT_RSASSA_PSS
203 bool "Support rsassa-pss signature scheme of FIT image contents in SPL"
204 depends on SPL_FIT_SIGNATURE
205 help
206 Enable this to support the pss padding algorithm as described
207 in the rfc8017 (https://tools.ietf.org/html/rfc8017) in SPL.
208
Simon Glasscf298162020-09-10 20:21:13 -0600209config SPL_LOAD_FIT
210 bool "Enable SPL loading U-Boot as a FIT (basic fitImage features)"
Simon Glass4d8ea262023-09-14 10:55:52 -0600211 depends on SPL
Simon Glasscf298162020-09-10 20:21:13 -0600212 select SPL_FIT
213 help
214 Normally with the SPL framework a legacy image is generated as part
215 of the build. This contains U-Boot along with information as to
216 where it should be loaded. This option instead enables generation
217 of a FIT (Flat Image Tree) which provides more flexibility. In
218 particular it can handle selecting from multiple device tree
219 and passing the correct one to U-Boot.
220
Alexandru Gagniucdf51ae72021-03-29 12:05:15 -0500221 This path has the following limitations:
222
Bin Meng6e847f62021-05-10 20:23:29 +0800223 1. "loadables" images, other than FDTs, which do not have a "load"
Alexandru Gagniucdf51ae72021-03-29 12:05:15 -0500224 property will not be loaded. This limitation also applies to FPGA
225 images with the correct "compatible" string.
Heinrich Schuchardt3fc9de42024-06-18 08:23:17 +0200226 2. For FPGA images, the supported "compatible" list may be found in
227 https://fitspec.osfw.foundation/.
Alexandru Gagniucdf51ae72021-03-29 12:05:15 -0500228 3. FDTs are only loaded for images with an "os" property of "u-boot".
229 "linux" images are also supported with Falcon boot mode.
230
Simon Glasscf298162020-09-10 20:21:13 -0600231config SPL_LOAD_FIT_ADDRESS
232 hex "load address of fit image"
Simon Glass815f8d32023-09-14 10:55:51 -0600233 depends on SPL_LOAD_FIT
Simon Glasscf298162020-09-10 20:21:13 -0600234 default 0x0
235 help
236 Specify the load address of the fit image that will be loaded
237 by SPL.
238
239config SPL_LOAD_FIT_APPLY_OVERLAY
240 bool "Enable SPL applying DT overlays from FIT"
241 depends on SPL_LOAD_FIT
242 select OF_LIBFDT_OVERLAY
243 help
Hugo Villeneuveb4230372023-04-24 16:51:12 -0400244 The device tree is loaded from the FIT image. Allow the SPL to
Simon Glasscf298162020-09-10 20:21:13 -0600245 also load device-tree overlays from the FIT image an apply them
246 over the device tree.
247
248config SPL_LOAD_FIT_APPLY_OVERLAY_BUF_SZ
249 depends on SPL_LOAD_FIT_APPLY_OVERLAY
250 default 0x10000
251 hex "size of temporary buffer used to load the overlays"
252 help
253 The size of the area where the overlays will be loaded and
254 uncompress. Must be at least as large as biggest overlay
255 (uncompressed)
256
257config SPL_LOAD_FIT_FULL
258 bool "Enable SPL loading U-Boot as a FIT (full fitImage features)"
259 select SPL_FIT
260 help
261 Normally with the SPL framework a legacy image is generated as part
262 of the build. This contains U-Boot along with information as to
263 where it should be loaded. This option instead enables generation
264 of a FIT (Flat Image Tree) which provides more flexibility. In
265 particular it can handle selecting from multiple device tree
266 and passing the correct one to U-Boot.
267
268config SPL_FIT_IMAGE_POST_PROCESS
269 bool "Enable post-processing of FIT artifacts after loading by the SPL"
270 depends on SPL_LOAD_FIT
Andrew Davis042e87e2022-05-04 15:52:28 -0500271 default y if TI_SECURE_DEVICE
Simon Glasscf298162020-09-10 20:21:13 -0600272 help
273 Allows doing any sort of manipulation to blobs after they got extracted
274 from the U-Boot FIT image like stripping off headers or modifying the
275 size of the blob, verification, authentication, decryption etc. in a
276 platform or board specific way. In order to use this feature a platform
277 or board-specific implementation of board_fit_image_post_process() must
278 be provided. Also, anything done during this post-processing step would
279 need to be comprehended in how the images were prepared before being
280 injected into the FIT creation (i.e. the blobs would have been pre-
281 processed before being added to the FIT image).
282
283config SPL_FIT_SOURCE
284 string ".its source file for U-Boot FIT image"
285 depends on SPL_FIT
286 help
287 Specifies a (platform specific) FIT source file to generate the
288 U-Boot FIT image. This could specify further image to load and/or
289 execute.
290
291config USE_SPL_FIT_GENERATOR
292 bool "Use a script to generate the .its script"
Tom Rini90c78882022-12-04 10:14:20 -0500293 depends on SPL_FIT
Simon Glass31f35e82023-01-07 14:07:19 -0700294 default y if SPL_FIT && ARCH_ZYNQMP
Simon Glasscf298162020-09-10 20:21:13 -0600295
296config SPL_FIT_GENERATOR
297 string ".its file generator script for U-Boot FIT image"
298 depends on USE_SPL_FIT_GENERATOR
Simon Glasscf298162020-09-10 20:21:13 -0600299 default "arch/arm/mach-zynqmp/mkimage_fit_atf.sh" if SPL_LOAD_FIT && ARCH_ZYNQMP
Simon Glasscf298162020-09-10 20:21:13 -0600300 help
301 Specifies a (platform specific) script file to generate the FIT
302 source file used to build the U-Boot FIT image file. This gets
303 passed a list of supported device tree file stub names to
304 include in the generated image.
305
Simon Glass42184562022-10-20 18:23:13 -0600306if VPL
307
308config VPL_FIT
309 bool "Support Flattened Image Tree within VPL"
310 depends on VPL
311 default y
312 select VPL_HASH
313 select VPL_OF_LIBFDT
314
315config VPL_FIT_PRINT
316 bool "Support FIT printing within VPL"
317 depends on VPL_FIT
318 default y
319 help
320 Support printing the content of the fitImage in a verbose manner in VPL.
321
322config VPL_FIT_FULL_CHECK
323 bool "Do a full check of the FIT before using it"
324 default y
325 help
326 Enable this do a full check of the FIT to make sure it is valid. This
327 helps to protect against carefully crafted FITs which take advantage
328 of bugs or omissions in the code. This includes a bad structure,
329 multiple root nodes and the like.
330
331config VPL_FIT_SIGNATURE
332 bool "Enable signature verification of FIT firmware within VPL"
333 depends on VPL_DM
Simon Glass42184562022-10-20 18:23:13 -0600334 default y
335 select FIT_SIGNATURE
336 select VPL_FIT
337 select VPL_CRYPTO
338 select VPL_HASH
339 imply VPL_RSA
340 imply VPL_RSA_VERIFY
341 select VPL_IMAGE_SIGN_INFO
342 select VPL_FIT_FULL_CHECK
343
344config VPL_FIT_SIGNATURE_MAX_SIZE
345 hex "Max size of signed FIT structures in VPL"
346 depends on VPL_FIT_SIGNATURE
347 default 0x10000000
348 help
349 This option sets a max size in bytes for verified FIT uImages.
350 A sane value of 256MB protects corrupted DTB structures from overlapping
351 device memory. Assure this size does not extend past expected storage
352 space.
353
354endif # VPL
355
Simon Glass4d8ea262023-09-14 10:55:52 -0600356endif # FIT
357
John Keepingbe43a352022-07-28 11:19:15 +0100358config PXE_UTILS
359 bool
360 select MENU
361 help
362 Utilities for parsing PXE file formats.
363
Tom Rini2180a452023-10-26 14:31:24 -0400364config BOOT_DEFAULTS_FEATURES
365 bool
366 select SUPPORT_RAW_INITRD
367 select ENV_VARS_UBOOT_CONFIG
368 imply USB_STORAGE
369 imply EFI_PARTITION
370 imply ISO_PARTITION
371
372config BOOT_DEFAULTS_CMDS
373 bool
Simon Glassa0c739c2023-03-24 16:58:13 -0400374 imply USE_BOOTCOMMAND
375 select CMD_ENV_EXISTS
376 select CMD_EXT2
377 select CMD_EXT4
378 select CMD_FAT
379 select CMD_FS_GENERIC
380 select CMD_PART if PARTITIONS
381 select CMD_DHCP if CMD_NET
382 select CMD_PING if CMD_NET
383 select CMD_PXE if CMD_NET
Simon Glassa0c739c2023-03-24 16:58:13 -0400384 select CMD_BOOTI if ARM64
385 select CMD_BOOTZ if ARM && !ARM64
386 imply CMD_MII if NET
Tom Rini2180a452023-10-26 14:31:24 -0400387
388config BOOT_DEFAULTS
389 bool # Common defaults for standard boot and distroboot
390 select BOOT_DEFAULTS_FEATURES
391 select BOOT_DEFAULTS_CMDS if CMDLINE
Simon Glassa0c739c2023-03-24 16:58:13 -0400392 help
393 These are not required but are commonly needed to support a good
394 selection of booting methods. Enable this to improve the capability
395 of U-Boot to boot various images. Currently much functionality is
396 tied to enabling the command that exercises it.
397
Simon Glass4a8fcb62023-09-14 10:55:53 -0600398menuconfig BOOTSTD
399 bool "Standard boot"
Simon Glassef5e3892022-04-24 23:31:06 -0600400 default y
401 depends on DM && OF_CONTROL && BLK
402 help
403 U-Boot supports a standard way of locating something to boot,
404 typically an Operating System such as Linux, provided by a distro such
405 as Arch Linux or Debian. Enable this to support iterating through
406 available bootdevs and using bootmeths to find bootflows suitable for
407 booting.
408
409 Standard boot is not a standard way of booting, just a framework
410 within U-Boot for supporting all the different ways that exist.
411
412 Terminology:
413
414 - bootdev - a device which can hold a distro (e.g. MMC)
415 - bootmeth - a method to scan a bootdev to find bootflows (owned by
416 U-Boot)
417 - bootflow - a description of how to boot (owned by the distro)
418
Simon Glass4a8fcb62023-09-14 10:55:53 -0600419if BOOTSTD
420
Simon Glass42184562022-10-20 18:23:13 -0600421config SPL_BOOTSTD
Simon Glass1c419582023-02-22 09:33:58 -0700422 bool "Standard boot support in SPL"
Simon Glass42184562022-10-20 18:23:13 -0600423 depends on SPL && SPL_DM && SPL_OF_CONTROL && SPL_BLK
424 default y if VPL
425 help
Quentin Schulzb88950f2024-06-12 16:58:47 +0200426 This enables standard boot in SPL. This is needed so that VBE
Simon Glass42184562022-10-20 18:23:13 -0600427 (Verified Boot for Embedded) can be used, since it depends on standard
428 boot. It is enabled by default since the main purpose of VPL is to
429 handle the firmware part of VBE.
430
431config VPL_BOOTSTD
432 bool "Standard boot support in VPL"
433 depends on VPL && VPL_DM && VPL_OF_CONTROL && VPL_BLK
434 default y
435 help
Quentin Schulzb88950f2024-06-12 16:58:47 +0200436 This enables standard boot in SPL. This is needed so that VBE
Simon Glass42184562022-10-20 18:23:13 -0600437 (Verified Boot for Embedded) can be used, since it depends on standard
438 boot. It is enabled by default since the main purpose of VPL is to
439 handle the firmware part of VBE.
440
Simon Glassbcb1d262023-02-22 14:06:23 -0700441config BOOTSTD_FULL
442 bool "Enhanced features for standard boot"
443 default y if SANDBOX
Shantur Rathorefea3efb2023-12-23 06:51:59 +0000444 imply BOOTSTD_DEFAULTS
Simon Glassbcb1d262023-02-22 14:06:23 -0700445 help
446 This enables various useful features for standard boot, which are not
447 essential for operation:
448
449 - bootdev, bootmeth commands
450 - extra features in the bootflow command
451 - support for selecting the ordering of bootmeths ("bootmeth order")
Quentin Schulzb88950f2024-06-12 16:58:47 +0200452 - support for selecting the ordering of bootdevs using the Device Tree
Simon Glassbcb1d262023-02-22 14:06:23 -0700453 as well as the "boot_targets" environment variable
454
Simon Glass22353fa2023-01-28 15:00:21 -0700455config BOOTSTD_DEFAULTS
456 bool "Select some common defaults for standard boot"
457 depends on BOOTSTD
Simon Glassa0c739c2023-03-24 16:58:13 -0400458 select BOOT_DEFAULTS
Simon Glassfba0e732023-05-10 16:34:47 -0600459 select BOOTMETH_DISTRO
Simon Glass22353fa2023-01-28 15:00:21 -0700460 help
461 These are not required but are commonly needed to support a good
462 selection of booting methods. Enable this to improve the capability
463 of U-Boot to boot various images.
464
Simon Glassa91492b2022-04-24 23:31:27 -0600465config BOOTSTD_BOOTCOMMAND
466 bool "Use bootstd to boot"
467 default y if !DISTRO_DEFAULTS
468 help
469 Enable this to select a default boot-command suitable for booting
470 with standard boot. This can be overridden by the board if needed,
471 but the default command should be enough for most boards which use
472 standard boot.
473
474 For now this is only selected if distro boot is NOT used, since
475 standard boot does not support all of the features of distro boot
476 yet.
477
Simon Glass1047b532023-11-18 14:05:19 -0700478config BOOTSTD_PROG
479 bool "Use programmatic boot"
480 depends on !CMDLINE
481 default y
482 help
483 Enable this to provide a board_run_command() function which can boot
Quentin Schulzb88950f2024-06-12 16:58:47 +0200484 a system without using commands. If the boot fails, then U-Boot will
Simon Glass1047b532023-11-18 14:05:19 -0700485 panic.
486
487 Note: This currently has many limitations and is not a useful booting
488 solution. Future work will eventually make this a viable option.
489
Simon Glassbc06aa02022-07-30 15:52:21 -0600490config BOOTMETH_GLOBAL
491 bool
492 help
493 Add support for global bootmeths. This feature is used by VBE and
494 EFI bootmgr, since they take full control over which bootdevs are
495 selected to boot.
496
Mattijs Korpershoek125d9f32024-07-10 10:40:05 +0200497config BOOTMETH_ANDROID
498 bool "Bootdev support for Android"
499 depends on X86 || ARM || SANDBOX
500 depends on CMDLINE
501 select ANDROID_AB
502 select ANDROID_BOOT_IMAGE
503 select CMD_BCB
504 select CMD_FASTBOOT
505 select PARTITION_TYPE_GUID
506 select PARTITION_UUIDS
507 help
508 Enables support for booting Android using bootstd. Android requires
509 multiple partitions (misc, boot, vbmeta, ...) in storage for booting.
510
511 Note that only MMC bootdevs are supported at present. This is caused
512 by AVB being limited to MMC devices only.
513
Simon Glassc88d67d2023-07-12 09:04:45 -0600514config BOOTMETH_CROS
515 bool "Bootdev support for Chromium OS"
Simon Glassdaffb0b2023-07-30 11:17:02 -0600516 depends on X86 || ARM || SANDBOX
517 default y if !ARM
Simon Glass71f634b2023-08-24 13:55:45 -0600518 select EFI_PARTITION
519 select PARTITION_TYPE_GUID
520 select PARTITION_UUIDS
Simon Glassc88d67d2023-07-12 09:04:45 -0600521 help
522 Enables support for booting Chromium OS using bootdevs. This uses the
523 kernel A slot and obtains the kernel command line from the parameters
524 provided there.
525
526 Note that only x86 devices are supported at present.
527
Simon Glass79f66352023-05-10 16:34:46 -0600528config BOOTMETH_EXTLINUX
529 bool "Bootdev support for extlinux boot"
John Keepingbe43a352022-07-28 11:19:15 +0100530 select PXE_UTILS
Simon Glass31aefaf2022-04-24 23:31:13 -0600531 default y
532 help
Simon Glass79f66352023-05-10 16:34:46 -0600533 Enables support for extlinux boot using bootdevs. This makes the
Simon Glass31aefaf2022-04-24 23:31:13 -0600534 bootdevs look for a 'extlinux/extlinux.conf' on each filesystem
535 they scan.
536
Quentin Schulzb88950f2024-06-12 16:58:47 +0200537 The specification for this file is here:
Simon Glass79f66352023-05-10 16:34:46 -0600538
539 https://uapi-group.org/specifications/specs/boot_loader_specification/
540
Simon Glass31aefaf2022-04-24 23:31:13 -0600541 This provides a way to try out standard boot on an existing boot flow.
542
Simon Glass79f66352023-05-10 16:34:46 -0600543config BOOTMETH_EXTLINUX_PXE
544 bool "Bootdev support for extlinux boot over network"
Simon Glassdab2c282022-04-24 23:31:16 -0600545 depends on CMD_PXE && CMD_NET && DM_ETH
546 default y
547 help
Simon Glass79f66352023-05-10 16:34:46 -0600548 Enables support for extlinux boot using bootdevs. This makes the
Simon Glassdab2c282022-04-24 23:31:16 -0600549 bootdevs look for a 'extlinux/extlinux.conf' on the tftp server.
550
Simon Glass79f66352023-05-10 16:34:46 -0600551 The specification for this file is here:
552
553 https://uapi-group.org/specifications/specs/boot_loader_specification/
554
Simon Glassdab2c282022-04-24 23:31:16 -0600555 This provides a way to try out standard boot on an existing boot flow.
556
Simon Glassacfa9bd2022-04-24 23:31:17 -0600557config BOOTMETH_EFILOADER
558 bool "Bootdev support for EFI boot"
AKASHI Takahiro64228202024-01-17 13:39:41 +0900559 depends on EFI_BINARY_EXEC
Simon Glassacfa9bd2022-04-24 23:31:17 -0600560 default y
561 help
562 Enables support for EFI boot using bootdevs. This makes the
563 bootdevs look for a 'boot<arch>.efi' on each filesystem
564 they scan. The resulting file is booted after enabling U-Boot's
565 EFI loader support.
566
567 The <arch> depends on the architecture of the board:
568
569 aa64 - aarch64 (ARM 64-bit)
570 arm - ARM 32-bit
571 ia32 - x86 32-bit
572 x64 - x86 64-bit
573 riscv32 - RISC-V 32-bit
574 riscv64 - RISC-V 64-bit
575
576 This provides a way to try out standard boot on an existing boot flow.
577
Heinrich Schuchardt8f319292024-04-03 20:05:17 +0200578config BOOTMETH_EFI_BOOTMGR
579 bool "Bootdev support for EFI boot manager"
580 depends on EFI_BOOTMGR
581 select BOOTMETH_GLOBAL
582 default y
583 help
584 Enable booting via the UEFI boot manager. Based on the EFI variables
585 the EFI binary to be launched is determined. To set the EFI variables
586 use the eficonfig command.
587
Heinrich Schuchardt4f658512024-07-16 10:35:34 +0200588config BOOTMETH_QFW
589 bool "Boot method using QEMU parameters"
590 depends on QFW
591 default y
592 help
593 Use QEMU parameters -kernel, -initrd, -append to determine the kernel,
594 initial RAM disk, and kernel command line parameters to boot an
595 operating system. U-Boot's control device-tree is passed to the kernel.
596
Simon Glass4c7418f2022-07-30 15:52:32 -0600597config BOOTMETH_VBE
598 bool "Bootdev support for Verified Boot for Embedded"
599 depends on FIT
600 default y
601 select BOOTMETH_GLOBAL
Tom Rini448e2b62023-01-16 15:46:49 -0500602 select EVENT
Simon Glass4c7418f2022-07-30 15:52:32 -0600603 help
604 Enables support for VBE boot. This is a standard boot method which
Quentin Schulzb88950f2024-06-12 16:58:47 +0200605 supports selection of various firmware components, selection of an OS to
Simon Glass4c7418f2022-07-30 15:52:32 -0600606 boot as well as updating these using fwupd.
607
Simon Glassfba0e732023-05-10 16:34:47 -0600608config BOOTMETH_DISTRO
609 bool # Options needed to boot any distro
Tom Rini558787f2023-10-26 14:31:27 -0400610 select BOOTMETH_SCRIPT if CMDLINE # E.g. Armbian uses scripts
Simon Glassfba0e732023-05-10 16:34:47 -0600611 select BOOTMETH_EXTLINUX # E.g. Debian uses these
612 select BOOTMETH_EXTLINUX_PXE if CMD_PXE && CMD_NET && DM_ETH
AKASHI Takahiro64228202024-01-17 13:39:41 +0900613 select BOOTMETH_EFILOADER if EFI_BINARY_EXEC # E.g. Ubuntu uses this
Simon Glassfba0e732023-05-10 16:34:47 -0600614
Simon Glass42184562022-10-20 18:23:13 -0600615config SPL_BOOTMETH_VBE
616 bool "Bootdev support for Verified Boot for Embedded (SPL)"
617 depends on SPL && FIT
Tom Rini448e2b62023-01-16 15:46:49 -0500618 select EVENT
Simon Glass42184562022-10-20 18:23:13 -0600619 default y if VPL
620 help
621 Enables support for VBE boot. This is a standard boot method which
Quentin Schulzb88950f2024-06-12 16:58:47 +0200622 supports selection of various firmware components, selection of an OS to
Simon Glass42184562022-10-20 18:23:13 -0600623 boot as well as updating these using fwupd.
624
625config VPL_BOOTMETH_VBE
626 bool "Bootdev support for Verified Boot for Embedded (VPL)"
627 depends on VPL && FIT
Tom Rini448e2b62023-01-16 15:46:49 -0500628 select EVENT
Simon Glass42184562022-10-20 18:23:13 -0600629 default y
630 help
631 Enables support for VBE boot. This is a standard boot method which
Quentin Schulzb88950f2024-06-12 16:58:47 +0200632 supports selection of various firmware components, selection of an OS to
Simon Glass42184562022-10-20 18:23:13 -0600633 boot as well as updating these using fwupd.
634
Simon Glasscb47e212022-07-30 15:52:33 -0600635if BOOTMETH_VBE
636
Simon Glassda900e52023-02-22 09:33:52 -0700637config BOOTMETH_VBE_REQUEST
638 bool "Support for serving VBE OS requests"
639 default y
640 help
641 Enables support for looking that the requests made by the
642 Operating System being booted. These requests result in additions to
643 the device tree /chosen node, added during the device tree fixup
644 phase.
645
646config SPL_BOOTMETH_VBE_REQUEST
647 bool "Support for serving VBE OS requests (SPL)"
648 depends on SPL
649 help
650 Enables support for looking that the requests made by the
651 Operating System being booted. These requests result in additions to
652 the device tree /chosen node, added during the device tree fixup
653 phase.
654
655 This is only useful if you are booting an OS direct from SPL.
656
Simon Glasscb47e212022-07-30 15:52:33 -0600657config BOOTMETH_VBE_SIMPLE
658 bool "Bootdev support for VBE 'simple' method"
659 default y
660 help
661 Enables support for VBE 'simple' boot. This allows updating a single
662 firmware image in boot media such as MMC. It does not support any sort
663 of rollback, recovery or A/B boot.
664
Simon Glass42184562022-10-20 18:23:13 -0600665config BOOTMETH_VBE_SIMPLE_OS
666 bool "Bootdev support for VBE 'simple' method OS phase"
667 default y
668 help
669 Enables support for the OS parts of VBE 'simple' boot. This includes
670 fixing up the device tree with the required VBE information, ready
671 for booting into the OS. This option is only enabled for U-Boot
672 proper, since it is the phase where device tree fixups happen.
673
674config SPL_BOOTMETH_VBE_SIMPLE
675 bool "Bootdev support for VBE 'simple' method (SPL)"
676 depends on SPL
677 default y if VPL
678 help
679 Enables support for VBE 'simple' boot. This allows updating a single
680 firmware image in boot media such as MMC. It does not support any sort
681 of rollback, recovery or A/B boot.
682
683config VPL_BOOTMETH_VBE_SIMPLE
684 bool "Bootdev support for VBE 'simple' method (VPL)"
685 depends on VPL
686 default y
687 help
688 Enables support for VBE 'simple' boot. This allows updating a single
689 firmware image in boot media such as MMC. It does not support any sort
690 of rollback, recovery or A/B boot.
691
692config SPL_BOOTMETH_VBE_SIMPLE_FW
693 bool "Bootdev support for VBE 'simple' method firmware phase (SPL)"
694 depends on VPL
695 default y
696 help
697 Enables support for the firmware parts of VBE 'simple' boot. This
698 includes an SPL loader which locates the correct U-Boot to boot into.
699 This option should really only be enabled for VPL, since it is the
700 phase where the SPL + U-Boot decision should be made. But for now,
701 SPL does its own FIT-configuration selection.
702
703config VPL_BOOTMETH_VBE_SIMPLE_FW
704 bool "Bootdev support for VBE 'simple' method firmware phase (VPL)"
705 depends on VPL
706 default y
707 help
708 Enables support for the firmware parts of VBE 'simple' boot. This
709 includes an SPL loader which locates the correct SPL to boot into.
710 This option enabled for VPL, since it is the phase where the SPL
711 decision is made.
712
Simon Glasscb47e212022-07-30 15:52:33 -0600713endif # BOOTMETH_VBE
714
Simon Glass87c6f8a2023-01-06 08:52:36 -0600715config EXPO
716 bool "Support for expos - groups of scenes displaying a UI"
Simon Glass0041b1c2023-01-28 15:00:18 -0700717 depends on VIDEO
Simon Glass87c6f8a2023-01-06 08:52:36 -0600718 default y if BOOTMETH_VBE
719 help
720 An expo is a way of presenting and collecting information from the
721 user. It consists of a collection of 'scenes' of which only one is
722 presented at a time. An expo is typically used to show a boot menu
723 and allow settings to be changed.
724
725 The expo can be presented in graphics form using a vidconsole, or in
726 text form on a serial console.
727
Simon Glass126947b2022-04-24 23:31:20 -0600728config BOOTMETH_SANDBOX
729 def_bool y
730 depends on SANDBOX
731 help
732 This is a sandbox bootmeth driver used for testing. It always returns
733 -ENOTSUPP when attempting to boot.
734
Simon Glassd9409242022-04-24 23:31:22 -0600735config BOOTMETH_SCRIPT
736 bool "Bootdev support for U-Boot scripts"
737 default y if BOOTSTD_FULL
Tom Rini558787f2023-10-26 14:31:27 -0400738 depends on CMDLINE
Simon Glassab16a3d2023-05-05 20:03:05 -0600739 select HUSH_PARSER
Simon Glassd9409242022-04-24 23:31:22 -0600740 help
741 Enables support for booting a distro via a U-Boot script. This makes
742 the bootdevs look for a 'boot/boot.scr' file which can be used to
743 boot the distro.
744
745 This provides a way to try out standard boot on an existing boot flow.
746 It is not enabled by default to save space.
747
Simon Glass90469da2024-08-07 16:47:27 -0600748config UPL
749 bool "upl - Universal Payload Specification"
750 imply UPL_READ
751 help
752 Provides support for UPL payloads and handoff information. U-Boot
753 supports generating and accepting handoff information. The mkimage
754 tool will eventually support creating payloads.
755
756if UPL
757
758config UPL_READ
759 bool "upl - Support reading a Universal Payload handoff"
760 help
761 Provides support for decoding a UPL-format payload into a C structure
762 which can be used elsewhere in U-Boot. This is just the reading
763 implementation, useful for trying it out.
764
765endif # UPL
766
Simon Glass4a8fcb62023-09-14 10:55:53 -0600767endif # BOOTSTD
Simon Glass31aefaf2022-04-24 23:31:13 -0600768
Simon Glasscf298162020-09-10 20:21:13 -0600769config LEGACY_IMAGE_FORMAT
770 bool "Enable support for the legacy image format"
Andrew Davis52dc3342022-05-04 15:52:27 -0500771 default y if !FIT_SIGNATURE && !TI_SECURE_DEVICE
Simon Glasscf298162020-09-10 20:21:13 -0600772 help
773 This option enables the legacy image format. It is enabled by
774 default for backward compatibility, unless FIT_SIGNATURE is
775 set where it is disabled so that unsigned images cannot be
776 loaded. If a board needs the legacy image format support in this
777 case, enable it here.
778
Eddie Jamesdec166d2023-10-24 10:43:50 -0500779config MEASURED_BOOT
780 bool "Measure boot images and configuration when booting without EFI"
781 depends on HASH && TPM_V2
Ilias Apalodimase7505b32024-06-23 14:48:18 +0300782 select SHA1
783 select SHA256
784 select SHA384
785 select SHA512
Eddie Jamesdec166d2023-10-24 10:43:50 -0500786 help
787 This option enables measurement of the boot process when booting
788 without UEFI . Measurement involves creating cryptographic hashes
789 of the binary images that are booting and storing them in the TPM.
790 In addition, a log of these hashes is stored in memory for the OS
791 to verify the booted images and configuration. Enable this if the
792 OS has configured some memory area for the event log and you intend
793 to use some attestation tools on your system.
794
795if MEASURED_BOOT
796 config MEASURE_DEVICETREE
797 bool "Measure the devicetree image"
798 default y if MEASURED_BOOT
799 help
Quentin Schulzb88950f2024-06-12 16:58:47 +0200800 On some platforms, the Device Tree is not static as it may contain
Eddie Jamesdec166d2023-10-24 10:43:50 -0500801 random MAC addresses or other such data that changes each boot.
802 Therefore, it should not be measured into the TPM. In that case,
803 disable the measurement here.
804
805 config MEASURE_IGNORE_LOG
806 bool "Ignore the existing event log"
Eddie Jamesdec166d2023-10-24 10:43:50 -0500807 help
808 On platforms that use an event log memory region that persists
809 through system resets and are the first stage bootloader, then
810 this option should be enabled to ignore any existing data in the
811 event log memory region.
812endif # MEASURED_BOOT
813
Tom Rini9d298c92023-10-26 14:31:25 -0400814config SYS_BOOTM_LEN
815 hex "Maximum size of a decompresed OS image"
Tom Rinicdd20e32024-04-18 08:29:35 -0600816 depends on CMD_BOOTM || CMD_BOOTI || CMD_BOOTZ || \
Tom Rini9d298c92023-10-26 14:31:25 -0400817 LEGACY_IMAGE_FORMAT || SPL_LEGACY_IMAGE_FORMAT
818 default 0x4000000 if PPC || ARM64
819 default 0x1000000 if X86 || ARCH_MX6 || ARCH_MX7
820 default 0x800000
821 help
822 This is the maximum size of the buffer that is used to decompress the OS
823 image in to if attempting to boot a compressed image.
824
Simon Glassaefa34f2020-09-10 20:21:19 -0600825config SUPPORT_RAW_INITRD
826 bool "Enable raw initrd images"
827 help
828 Note, defining the SUPPORT_RAW_INITRD allows user to supply
829 kernel with raw initrd images. The syntax is slightly different, the
830 address of the initrd must be augmented by it's size, in the following
831 format: "<initrd address>:<initrd size>".
832
Simon Glass96d0aa92020-11-04 09:57:35 -0700833config CHROMEOS
834 bool "Support booting Chrome OS"
835 help
836 Chrome OS requires U-Boot to set up a table indicating the boot mode
837 (e.g. Developer mode) and a few other things. Enable this if you are
838 booting on a Chromebook to avoid getting an error about an invalid
839 firmware ID.
840
841config CHROMEOS_VBOOT
842 bool "Support Chrome OS verified boot"
843 help
844 This is intended to enable the full Chrome OS verified boot support
845 in U-Boot. It is not actually implemented in the U-Boot source code
846 at present, so this option is always set to 'n'. It allows
847 distinguishing between booting Chrome OS in a basic way (developer
848 mode) and a full boot.
849
Tom Rini5a446182022-06-25 11:02:44 -0400850config SYS_RAMBOOT
851 bool
852
Tom Rinid8ef01e2021-08-24 23:11:49 -0400853config RAMBOOT_PBL
854 bool "Freescale PBL(pre-boot loader) image format support"
Tom Rini5a446182022-06-25 11:02:44 -0400855 select SYS_RAMBOOT if PPC
Tom Rinid8ef01e2021-08-24 23:11:49 -0400856 help
857 Some SoCs use PBL to load RCW and/or pre-initialization instructions.
858 For more details refer to doc/README.pblimage
859
Tom Rinid433c742022-03-23 17:20:03 -0400860choice
Tom Riniec9efcf2022-12-28 10:52:51 -0500861 prompt "Freescale PBL (or predecessor) load location"
Tom Rinid433c742022-03-23 17:20:03 -0400862 depends on RAMBOOT_PBL || ((TARGET_P1010RDB_PA || TARGET_P1010RDB_PB \
863 || TARGET_P1020RDB_PC || TARGET_P1020RDB_PD || TARGET_P2020RDB) \
Pali Rohárf4158202024-06-06 18:33:26 +0200864 && !CMD_NAND) || (TARGET_TURRIS_1X && SYS_MPC85XX_NO_RESETVEC)
Tom Rinid433c742022-03-23 17:20:03 -0400865
866config SDCARD
Tom Riniec9efcf2022-12-28 10:52:51 -0500867 bool "Freescale PBL (or similar) is found on SD card"
Tom Rinid433c742022-03-23 17:20:03 -0400868
869config SPIFLASH
Tom Riniec9efcf2022-12-28 10:52:51 -0500870 bool "Freescale PBL (or similar) is found on SPI flash"
871
872config NO_PBL
873 bool "Freescale PBL (or similar) is not used in this case"
Tom Rinid433c742022-03-23 17:20:03 -0400874
875endchoice
876
Tom Rinid8e84612022-06-20 08:07:42 -0400877config FSL_FIXED_MMC_LOCATION
878 bool "PBL MMC is at a fixed location"
879 depends on SDCARD && !RAMBOOT_PBL
880
881config ESDHC_HC_BLK_ADDR
882 def_bool y
883 depends on FSL_FIXED_MMC_LOCATION && (ARCH_BSC9131 || ARCH_BSC9132 || ARCH_P1010)
884 help
885 In High Capacity SD Cards (> 2 GBytes), the 32-bit source address and
886 code length of these soc specify the memory address in block address
887 format. Block length is fixed to 512 bytes as per the SD High
888 Capacity specification.
889
Tom Rinid8ef01e2021-08-24 23:11:49 -0400890config SYS_FSL_PBL_PBI
891 string "PBI(pre-boot instructions) commands for the PBL image"
892 depends on RAMBOOT_PBL
893 help
894 PBI commands can be used to configure SoC before it starts the execution.
895 Please refer doc/README.pblimage for more details.
896
897config SYS_FSL_PBL_RCW
898 string "Aadditional RCW (Power on reset configuration) for the PBL image"
899 depends on RAMBOOT_PBL
900 help
901 Enables addition of RCW (Power on reset configuration) in built image.
902 Please refer doc/README.pblimage for more details.
903
Tom Rinibb20a102022-06-25 11:02:46 -0400904config SYS_BOOT_RAMDISK_HIGH
905 depends on CMD_BOOTM || CMD_BOOTI || CMD_BOOTZ
906 depends on !(NIOS2 || SANDBOX || SH || XTENSA)
907 def_bool y
Simon Glassfebb9852023-03-24 16:58:12 -0400908 select LMB
Tom Rinibb20a102022-06-25 11:02:46 -0400909 help
910 Enable initrd_high functionality. If defined then the initrd_high
911 feature is enabled and the boot* ramdisk subcommand is enabled.
912
Simon Glasscf298162020-09-10 20:21:13 -0600913endmenu # Boot images
914
Simon Glassc9d4abe2023-03-24 16:58:11 -0400915config DISTRO_DEFAULTS
Simon Glass3b58de42023-09-14 10:55:55 -0600916 bool "(deprecated) Script-based booting of Linux distributions"
Tom Rinifc97d932023-10-26 14:31:23 -0400917 select CMDLINE
Simon Glassa0c739c2023-03-24 16:58:13 -0400918 select BOOT_DEFAULTS
Simon Glassc9d4abe2023-03-24 16:58:11 -0400919 select AUTO_COMPLETE
920 select CMDLINE_EDITING
Simon Glassc9d4abe2023-03-24 16:58:11 -0400921 select CMD_SYSBOOT
Simon Glassc9d4abe2023-03-24 16:58:11 -0400922 select HUSH_PARSER
Simon Glassc9d4abe2023-03-24 16:58:11 -0400923 select SYS_LONGHELP
Simon Glassc9d4abe2023-03-24 16:58:11 -0400924 help
Simon Glass3b58de42023-09-14 10:55:55 -0600925 Note: These scripts have been replaced by Standard Boot. Do not use
926 them on new boards. See 'Migrating from distro_boot' at
927 doc/develop/bootstd.rst
928
Simon Glassc9d4abe2023-03-24 16:58:11 -0400929 Select this to enable various options and commands which are suitable
930 for building u-boot for booting general purpose Linux distributions.
931
Simon Glass75e65cc2020-09-10 20:21:14 -0600932menu "Boot timing"
933
934config BOOTSTAGE
935 bool "Boot timing and reporting"
936 help
937 Enable recording of boot time while booting. To use it, insert
938 calls to bootstage_mark() with a suitable BOOTSTAGE_ID from
939 bootstage.h. Only a single entry is recorded for each ID. You can
940 give the entry a name with bootstage_mark_name(). You can also
941 record elapsed time in a particular stage using bootstage_start()
942 before starting and bootstage_accum() when finished. Bootstage will
943 add up all the accumulated time and report it.
944
945 Normally, IDs are defined in bootstage.h but a small number of
946 additional 'user' IDs can be used by passing BOOTSTAGE_ID_ALLOC
947 as the ID.
948
949 Calls to show_boot_progress() will also result in log entries but
950 these will not have names.
951
952config SPL_BOOTSTAGE
953 bool "Boot timing and reported in SPL"
Tom Rinib3401992022-06-10 23:03:09 -0400954 depends on BOOTSTAGE && SPL
Simon Glass75e65cc2020-09-10 20:21:14 -0600955 help
956 Enable recording of boot time in SPL. To make this visible to U-Boot
957 proper, enable BOOTSTAGE_STASH as well. This will stash the timing
958 information when SPL finishes and load it when U-Boot proper starts
959 up.
960
961config TPL_BOOTSTAGE
962 bool "Boot timing and reported in TPL"
Tom Rini8bea4bf2022-06-08 08:24:39 -0400963 depends on BOOTSTAGE && TPL
Simon Glass75e65cc2020-09-10 20:21:14 -0600964 help
965 Enable recording of boot time in SPL. To make this visible to U-Boot
966 proper, enable BOOTSTAGE_STASH as well. This will stash the timing
967 information when TPL finishes and load it when U-Boot proper starts
968 up.
969
970config BOOTSTAGE_REPORT
971 bool "Display a detailed boot timing report before booting the OS"
972 depends on BOOTSTAGE
973 help
974 Enable output of a boot time report just before the OS is booted.
975 This shows how long it took U-Boot to go through each stage of the
976 boot process. The report looks something like this:
977
978 Timer summary in microseconds:
979 Mark Elapsed Stage
980 0 0 reset
981 3,575,678 3,575,678 board_init_f start
982 3,575,695 17 arch_cpu_init A9
983 3,575,777 82 arch_cpu_init done
984 3,659,598 83,821 board_init_r start
985 3,910,375 250,777 main_loop
986 29,916,167 26,005,792 bootm_start
987 30,361,327 445,160 start_kernel
988
989config BOOTSTAGE_RECORD_COUNT
990 int "Number of boot stage records to store"
Simon Glass939b04e2021-02-03 06:00:49 -0700991 depends on BOOTSTAGE
Simon Glass75e65cc2020-09-10 20:21:14 -0600992 default 30
993 help
994 This is the size of the bootstage record list and is the maximum
995 number of bootstage records that can be recorded.
996
997config SPL_BOOTSTAGE_RECORD_COUNT
998 int "Number of boot stage records to store for SPL"
Simon Glass939b04e2021-02-03 06:00:49 -0700999 depends on SPL_BOOTSTAGE
Simon Glass75e65cc2020-09-10 20:21:14 -06001000 default 5
1001 help
1002 This is the size of the bootstage record list and is the maximum
1003 number of bootstage records that can be recorded.
1004
1005config TPL_BOOTSTAGE_RECORD_COUNT
1006 int "Number of boot stage records to store for TPL"
Simon Glass939b04e2021-02-03 06:00:49 -07001007 depends on TPL_BOOTSTAGE
Simon Glass75e65cc2020-09-10 20:21:14 -06001008 default 5
1009 help
1010 This is the size of the bootstage record list and is the maximum
1011 number of bootstage records that can be recorded.
1012
1013config BOOTSTAGE_FDT
1014 bool "Store boot timing information in the OS device tree"
1015 depends on BOOTSTAGE
1016 help
1017 Stash the bootstage information in the FDT. A root 'bootstage'
1018 node is created with each bootstage id as a child. Each child
1019 has a 'name' property and either 'mark' containing the
1020 mark time in microseconds, or 'accum' containing the
1021 accumulated time for that bootstage id in microseconds.
1022 For example:
1023
1024 bootstage {
1025 154 {
1026 name = "board_init_f";
1027 mark = <3575678>;
1028 };
1029 170 {
1030 name = "lcd";
1031 accum = <33482>;
1032 };
1033 };
1034
1035 Code in the Linux kernel can find this in /proc/devicetree.
1036
1037config BOOTSTAGE_STASH
1038 bool "Stash the boot timing information in memory before booting OS"
1039 depends on BOOTSTAGE
1040 help
1041 Some OSes do not support device tree. Bootstage can instead write
1042 the boot timing information in a binary format at a given address.
1043 This happens through a call to bootstage_stash(), typically in
1044 the CPU's cleanup_before_linux() function. You can use the
1045 'bootstage stash' and 'bootstage unstash' commands to do this on
1046 the command line.
1047
1048config BOOTSTAGE_STASH_ADDR
1049 hex "Address to stash boot timing information"
Tom Rinib81e31a2024-07-15 12:42:00 +01001050 depends on BOOTSTAGE_STASH
1051 default 0xC3000000 if STM32MP13X || STM32MP15X
1052 default 0x87000000 if STM32MP25X
1053 default 0x0 if SANDBOX
Simon Glass75e65cc2020-09-10 20:21:14 -06001054 help
1055 Provide an address which will not be overwritten by the OS when it
1056 starts, so that it can read this information when ready.
1057
1058config BOOTSTAGE_STASH_SIZE
1059 hex "Size of boot timing stash region"
Tom Rinib81e31a2024-07-15 12:42:00 +01001060 depends on BOOTSTAGE_STASH
Simon Glass75e65cc2020-09-10 20:21:14 -06001061 default 0x1000
1062 help
1063 This should be large enough to hold the bootstage stash. A value of
1064 4096 (4KiB) is normally plenty.
1065
1066config SHOW_BOOT_PROGRESS
1067 bool "Show boot progress in a board-specific manner"
1068 help
1069 Defining this option allows to add some board-specific code (calling
1070 a user-provided function show_boot_progress(int) that enables you to
1071 show the system's boot progress on some display (for example, some
1072 LEDs) on your board. At the moment, the following checkpoints are
1073 implemented:
1074
1075 Legacy uImage format:
1076
1077 Arg Where When
1078 1 common/cmd_bootm.c before attempting to boot an image
1079 -1 common/cmd_bootm.c Image header has bad magic number
1080 2 common/cmd_bootm.c Image header has correct magic number
1081 -2 common/cmd_bootm.c Image header has bad checksum
1082 3 common/cmd_bootm.c Image header has correct checksum
1083 -3 common/cmd_bootm.c Image data has bad checksum
1084 4 common/cmd_bootm.c Image data has correct checksum
1085 -4 common/cmd_bootm.c Image is for unsupported architecture
1086 5 common/cmd_bootm.c Architecture check OK
1087 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
1088 6 common/cmd_bootm.c Image Type check OK
1089 -6 common/cmd_bootm.c gunzip uncompression error
1090 -7 common/cmd_bootm.c Unimplemented compression type
1091 7 common/cmd_bootm.c Uncompression OK
1092 8 common/cmd_bootm.c No uncompress/copy overwrite error
1093 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
1094
1095 9 common/image.c Start initial ramdisk verification
1096 -10 common/image.c Ramdisk header has bad magic number
1097 -11 common/image.c Ramdisk header has bad checksum
1098 10 common/image.c Ramdisk header is OK
1099 -12 common/image.c Ramdisk data has bad checksum
1100 11 common/image.c Ramdisk data has correct checksum
1101 12 common/image.c Ramdisk verification complete, start loading
1102 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
1103 13 common/image.c Start multifile image verification
1104 14 common/image.c No initial ramdisk, no multifile, continue.
1105
1106 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
1107
1108 -30 arch/powerpc/lib/board.c Fatal error, hang the system
1109 -31 post/post.c POST test failed, detected by post_output_backlog()
1110 -32 post/post.c POST test failed, detected by post_run_single()
1111
1112 34 common/cmd_doc.c before loading a Image from a DOC device
1113 -35 common/cmd_doc.c Bad usage of "doc" command
1114 35 common/cmd_doc.c correct usage of "doc" command
1115 -36 common/cmd_doc.c No boot device
1116 36 common/cmd_doc.c correct boot device
1117 -37 common/cmd_doc.c Unknown Chip ID on boot device
1118 37 common/cmd_doc.c correct chip ID found, device available
1119 -38 common/cmd_doc.c Read Error on boot device
1120 38 common/cmd_doc.c reading Image header from DOC device OK
1121 -39 common/cmd_doc.c Image header has bad magic number
1122 39 common/cmd_doc.c Image header has correct magic number
1123 -40 common/cmd_doc.c Error reading Image from DOC device
1124 40 common/cmd_doc.c Image header has correct magic number
1125 41 common/cmd_ide.c before loading a Image from a IDE device
1126 -42 common/cmd_ide.c Bad usage of "ide" command
1127 42 common/cmd_ide.c correct usage of "ide" command
1128 -43 common/cmd_ide.c No boot device
1129 43 common/cmd_ide.c boot device found
1130 -44 common/cmd_ide.c Device not available
1131 44 common/cmd_ide.c Device available
1132 -45 common/cmd_ide.c wrong partition selected
1133 45 common/cmd_ide.c partition selected
1134 -46 common/cmd_ide.c Unknown partition table
1135 46 common/cmd_ide.c valid partition table found
1136 -47 common/cmd_ide.c Invalid partition type
1137 47 common/cmd_ide.c correct partition type
1138 -48 common/cmd_ide.c Error reading Image Header on boot device
1139 48 common/cmd_ide.c reading Image Header from IDE device OK
1140 -49 common/cmd_ide.c Image header has bad magic number
1141 49 common/cmd_ide.c Image header has correct magic number
1142 -50 common/cmd_ide.c Image header has bad checksum
1143 50 common/cmd_ide.c Image header has correct checksum
1144 -51 common/cmd_ide.c Error reading Image from IDE device
1145 51 common/cmd_ide.c reading Image from IDE device OK
1146 52 common/cmd_nand.c before loading a Image from a NAND device
1147 -53 common/cmd_nand.c Bad usage of "nand" command
1148 53 common/cmd_nand.c correct usage of "nand" command
1149 -54 common/cmd_nand.c No boot device
1150 54 common/cmd_nand.c boot device found
1151 -55 common/cmd_nand.c Unknown Chip ID on boot device
1152 55 common/cmd_nand.c correct chip ID found, device available
1153 -56 common/cmd_nand.c Error reading Image Header on boot device
1154 56 common/cmd_nand.c reading Image Header from NAND device OK
1155 -57 common/cmd_nand.c Image header has bad magic number
1156 57 common/cmd_nand.c Image header has correct magic number
1157 -58 common/cmd_nand.c Error reading Image from NAND device
1158 58 common/cmd_nand.c reading Image from NAND device OK
1159
1160 -60 common/env_common.c Environment has a bad CRC, using default
1161
1162 64 net/eth.c starting with Ethernet configuration.
1163 -64 net/eth.c no Ethernet found.
1164 65 net/eth.c Ethernet found.
1165
1166 -80 common/cmd_net.c usage wrong
1167 80 common/cmd_net.c before calling net_loop()
1168 -81 common/cmd_net.c some error in net_loop() occurred
1169 81 common/cmd_net.c net_loop() back without error
1170 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
1171 82 common/cmd_net.c trying automatic boot
1172 83 common/cmd_net.c running "source" command
1173 -83 common/cmd_net.c some error in automatic boot or "source" command
1174 84 common/cmd_net.c end without errors
1175
1176 FIT uImage format:
1177
1178 Arg Where When
1179 100 common/cmd_bootm.c Kernel FIT Image has correct format
1180 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
1181 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
1182 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
1183 102 common/cmd_bootm.c Kernel unit name specified
1184 -103 common/cmd_bootm.c Can't get kernel subimage node offset
1185 103 common/cmd_bootm.c Found configuration node
1186 104 common/cmd_bootm.c Got kernel subimage node offset
1187 -104 common/cmd_bootm.c Kernel subimage hash verification failed
1188 105 common/cmd_bootm.c Kernel subimage hash verification OK
1189 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
1190 106 common/cmd_bootm.c Architecture check OK
1191 -106 common/cmd_bootm.c Kernel subimage has wrong type
1192 107 common/cmd_bootm.c Kernel subimage type OK
1193 -107 common/cmd_bootm.c Can't get kernel subimage data/size
1194 108 common/cmd_bootm.c Got kernel subimage data/size
1195 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
1196 -109 common/cmd_bootm.c Can't get kernel subimage type
1197 -110 common/cmd_bootm.c Can't get kernel subimage comp
1198 -111 common/cmd_bootm.c Can't get kernel subimage os
1199 -112 common/cmd_bootm.c Can't get kernel subimage load address
1200 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
1201
1202 120 common/image.c Start initial ramdisk verification
1203 -120 common/image.c Ramdisk FIT image has incorrect format
1204 121 common/image.c Ramdisk FIT image has correct format
1205 122 common/image.c No ramdisk subimage unit name, using configuration
1206 -122 common/image.c Can't get configuration for ramdisk subimage
1207 123 common/image.c Ramdisk unit name specified
1208 -124 common/image.c Can't get ramdisk subimage node offset
1209 125 common/image.c Got ramdisk subimage node offset
1210 -125 common/image.c Ramdisk subimage hash verification failed
1211 126 common/image.c Ramdisk subimage hash verification OK
1212 -126 common/image.c Ramdisk subimage for unsupported architecture
1213 127 common/image.c Architecture check OK
1214 -127 common/image.c Can't get ramdisk subimage data/size
1215 128 common/image.c Got ramdisk subimage data/size
1216 129 common/image.c Can't get ramdisk load address
1217 -129 common/image.c Got ramdisk load address
1218
1219 -130 common/cmd_doc.c Incorrect FIT image format
1220 131 common/cmd_doc.c FIT image format OK
1221
1222 -140 common/cmd_ide.c Incorrect FIT image format
1223 141 common/cmd_ide.c FIT image format OK
1224
1225 -150 common/cmd_nand.c Incorrect FIT image format
1226 151 common/cmd_nand.c FIT image format OK
1227
Marek Vasutb55881d2021-10-23 03:06:03 +02001228config SPL_SHOW_BOOT_PROGRESS
Jan Kiszkac1df3d52021-11-03 15:09:36 +01001229 bool "Show boot progress in a board-specific manner in SPL"
Marek Vasutb55881d2021-10-23 03:06:03 +02001230 depends on SPL
1231 help
1232 Defining this option allows to add some board-specific code (calling
1233 a user-provided function show_boot_progress(int) that enables you to
1234 show the system's boot progress on some display (for example, some
1235 LEDs) on your board. For details see SHOW_BOOT_PROGRESS.
1236
Simon Glass75e65cc2020-09-10 20:21:14 -06001237endmenu
1238
Simon Glass7b6baa32020-09-10 20:21:15 -06001239menu "Boot media"
1240
1241config NOR_BOOT
1242 bool "Support for booting from NOR flash"
1243 depends on NOR
1244 help
1245 Enabling this will make a U-Boot binary that is capable of being
1246 booted via NOR. In this case we will enable certain pinmux early
1247 as the ROM only partially sets up pinmux. We also default to using
1248 NOR for environment.
1249
1250config NAND_BOOT
1251 bool "Support for booting from NAND flash"
Simon Glass7b6baa32020-09-10 20:21:15 -06001252 imply MTD_RAW_NAND
1253 help
1254 Enabling this will make a U-Boot binary that is capable of being
1255 booted via NAND flash. This is not a must, some SoCs need this,
1256 some not.
1257
1258config ONENAND_BOOT
1259 bool "Support for booting from ONENAND"
Simon Glass7b6baa32020-09-10 20:21:15 -06001260 imply MTD_RAW_NAND
1261 help
1262 Enabling this will make a U-Boot binary that is capable of being
1263 booted via ONENAND. This is not a must, some SoCs need this,
1264 some not.
1265
1266config QSPI_BOOT
1267 bool "Support for booting from QSPI flash"
Simon Glass7b6baa32020-09-10 20:21:15 -06001268 help
1269 Enabling this will make a U-Boot binary that is capable of being
1270 booted via QSPI flash. This is not a must, some SoCs need this,
1271 some not.
1272
1273config SATA_BOOT
1274 bool "Support for booting from SATA"
Simon Glass7b6baa32020-09-10 20:21:15 -06001275 help
1276 Enabling this will make a U-Boot binary that is capable of being
1277 booted via SATA. This is not a must, some SoCs need this,
1278 some not.
1279
1280config SD_BOOT
1281 bool "Support for booting from SD/EMMC"
Simon Glass7b6baa32020-09-10 20:21:15 -06001282 help
1283 Enabling this will make a U-Boot binary that is capable of being
1284 booted via SD/EMMC. This is not a must, some SoCs need this,
1285 some not.
1286
Tom Rini66e0e2b2021-12-11 14:55:50 -05001287config SD_BOOT_QSPI
1288 bool "Support for booting from SD/EMMC and enable QSPI"
1289 help
1290 Enabling this will make a U-Boot binary that is capable of being
1291 booted via SD/EMMC while enabling QSPI on the platform as well. This
1292 is not a must, some SoCs need this, some not.
1293
Simon Glass7b6baa32020-09-10 20:21:15 -06001294config SPI_BOOT
1295 bool "Support for booting from SPI flash"
Simon Glass7b6baa32020-09-10 20:21:15 -06001296 help
1297 Enabling this will make a U-Boot binary that is capable of being
1298 booted via SPI flash. This is not a must, some SoCs need this,
1299 some not.
1300
1301endmenu
1302
Simon Glass98eed0d2020-09-10 20:21:16 -06001303menu "Autoboot options"
1304
1305config AUTOBOOT
1306 bool "Autoboot"
Simon Glass5bcfc7a2023-10-26 14:31:22 -04001307 depends on CMDLINE
Simon Glass98eed0d2020-09-10 20:21:16 -06001308 default y
1309 help
1310 This enables the autoboot. See doc/README.autoboot for detail.
1311
Simon Glass5bcfc7a2023-10-26 14:31:22 -04001312if AUTOBOOT
1313
Simon Glass95fd4f32020-09-10 20:21:17 -06001314config BOOTDELAY
1315 int "delay in seconds before automatically booting"
1316 default 2
Simon Glass95fd4f32020-09-10 20:21:17 -06001317 help
1318 Delay before automatically running bootcmd;
1319 set to 0 to autoboot with no delay, but you can stop it by key input.
1320 set to -1 to disable autoboot.
1321 set to -2 to autoboot with no delay and not check for abort
1322
1323 If this value is >= 0 then it is also used for the default delay
1324 before starting the default entry in bootmenu. If it is < 0 then
1325 a default value of 10s is used.
1326
1327 See doc/README.autoboot for details.
1328
Simon Glass98eed0d2020-09-10 20:21:16 -06001329config AUTOBOOT_KEYED
1330 bool "Stop autobooting via specific input key / string"
Simon Glass98eed0d2020-09-10 20:21:16 -06001331 help
1332 This option enables stopping (aborting) of the automatic
1333 boot feature only by issuing a specific input key or
1334 string. If not enabled, any input key will abort the
1335 U-Boot automatic booting process and bring the device
1336 to the U-Boot prompt for user input.
1337
Simon Glass5bcfc7a2023-10-26 14:31:22 -04001338if AUTOBOOT_KEYED
1339
Steffen Jaeckeld199c3a2021-07-08 15:57:38 +02001340config AUTOBOOT_FLUSH_STDIN
1341 bool "Enable flushing stdin before starting to read the password"
Simon Glass5bcfc7a2023-10-26 14:31:22 -04001342 depends on !SANDBOX
Steffen Jaeckeld199c3a2021-07-08 15:57:38 +02001343 help
1344 When this option is enabled stdin buffer will be flushed before
1345 starting to read the password.
1346 This can't be enabled for the sandbox as flushing stdin would
1347 break the autoboot unit tests.
1348
Simon Glass98eed0d2020-09-10 20:21:16 -06001349config AUTOBOOT_PROMPT
1350 string "Autoboot stop prompt"
Simon Glass98eed0d2020-09-10 20:21:16 -06001351 default "Autoboot in %d seconds\\n"
1352 help
1353 This string is displayed before the boot delay selected by
1354 CONFIG_BOOTDELAY starts. If it is not defined there is no
1355 output indicating that autoboot is in progress.
1356
1357 Note that this define is used as the (only) argument to a
1358 printf() call, so it may contain '%' format specifications,
Quentin Schulzb88950f2024-06-12 16:58:47 +02001359 provided that it also includes, separated by commas exactly
Simon Glass98eed0d2020-09-10 20:21:16 -06001360 like in a printf statement, the required arguments. It is
1361 the responsibility of the user to select only such arguments
1362 that are valid in the given context.
1363
1364config AUTOBOOT_ENCRYPTION
1365 bool "Enable encryption in autoboot stopping"
Simon Glass98eed0d2020-09-10 20:21:16 -06001366 help
1367 This option allows a string to be entered into U-Boot to stop the
Steffen Jaeckel1a4a7782021-07-08 15:57:35 +02001368 autoboot.
1369 The behavior depends whether CONFIG_CRYPT_PW from lib is enabled
1370 or not.
1371 In case CONFIG_CRYPT_PW is enabled, the string will be forwarded
1372 to the crypt-based functionality and be compared against the
1373 string in the environment variable 'bootstopkeycrypt'.
1374 In case CONFIG_CRYPT_PW is disabled the string itself is hashed
1375 and compared against the hash in the environment variable
1376 'bootstopkeysha256'.
1377 If it matches in either case then boot stops and
1378 a command-line prompt is presented.
Simon Glass98eed0d2020-09-10 20:21:16 -06001379 This provides a way to ship a secure production device which can also
1380 be accessed at the U-Boot command line.
1381
Steffen Jaeckel33198742021-07-08 15:57:39 +02001382config AUTOBOOT_SHA256_FALLBACK
1383 bool "Allow fallback from crypt-hashed password to sha256"
1384 depends on AUTOBOOT_ENCRYPTION && CRYPT_PW
1385 help
1386 This option adds support to fall back from crypt-hashed
1387 passwords to checking a SHA256 hashed password in case the
1388 'bootstopusesha256' environment variable is set to 'true'.
1389
Simon Glass98eed0d2020-09-10 20:21:16 -06001390config AUTOBOOT_DELAY_STR
1391 string "Delay autobooting via specific input key / string"
Simon Glass5bcfc7a2023-10-26 14:31:22 -04001392 depends on !AUTOBOOT_ENCRYPTION
Simon Glass98eed0d2020-09-10 20:21:16 -06001393 help
1394 This option delays the automatic boot feature by issuing
1395 a specific input key or string. If CONFIG_AUTOBOOT_DELAY_STR
1396 or the environment variable "bootdelaykey" is specified
1397 and this string is received from console input before
1398 autoboot starts booting, U-Boot gives a command prompt. The
1399 U-Boot prompt will time out if CONFIG_BOOT_RETRY_TIME is
1400 used, otherwise it never times out.
1401
1402config AUTOBOOT_STOP_STR
1403 string "Stop autobooting via specific input key / string"
Simon Glass5bcfc7a2023-10-26 14:31:22 -04001404 depends on !AUTOBOOT_ENCRYPTION
Simon Glass98eed0d2020-09-10 20:21:16 -06001405 help
1406 This option enables stopping (aborting) of the automatic
1407 boot feature only by issuing a specific input key or
1408 string. If CONFIG_AUTOBOOT_STOP_STR or the environment
1409 variable "bootstopkey" is specified and this string is
1410 received from console input before autoboot starts booting,
1411 U-Boot gives a command prompt. The U-Boot prompt never
1412 times out, even if CONFIG_BOOT_RETRY_TIME is used.
1413
1414config AUTOBOOT_KEYED_CTRLC
1415 bool "Enable Ctrl-C autoboot interruption"
Simon Glass5bcfc7a2023-10-26 14:31:22 -04001416 depends on !AUTOBOOT_ENCRYPTION
Simon Glass98eed0d2020-09-10 20:21:16 -06001417 help
1418 This option allows for the boot sequence to be interrupted
1419 by ctrl-c, in addition to the "bootdelaykey" and "bootstopkey".
1420 Setting this variable provides an escape sequence from the
1421 limited "password" strings.
1422
Steffen Jaeckel6c0ce6d2021-07-08 15:57:37 +02001423config AUTOBOOT_NEVER_TIMEOUT
1424 bool "Make the password entry never time-out"
Simon Glass5bcfc7a2023-10-26 14:31:22 -04001425 depends on AUTOBOOT_ENCRYPTION && CRYPT_PW
Steffen Jaeckel6c0ce6d2021-07-08 15:57:37 +02001426 help
1427 This option removes the timeout from the password entry
1428 when the user first presses the <Enter> key before entering
1429 any other character.
1430
Steffen Jaeckel1a4a7782021-07-08 15:57:35 +02001431config AUTOBOOT_STOP_STR_ENABLE
1432 bool "Enable fixed string to stop autobooting"
Simon Glass5bcfc7a2023-10-26 14:31:22 -04001433 depends on AUTOBOOT_ENCRYPTION
Steffen Jaeckel1a4a7782021-07-08 15:57:35 +02001434 help
1435 This option enables the feature to add a fixed stop
1436 string that is defined at compile time.
1437 In every case it will be tried to load the stop
1438 string from the environment.
1439 In case this is enabled and there is no stop string
1440 in the environment, this will be used as default value.
1441
1442config AUTOBOOT_STOP_STR_CRYPT
1443 string "Stop autobooting via crypt-hashed password"
1444 depends on AUTOBOOT_STOP_STR_ENABLE && CRYPT_PW
1445 help
1446 This option adds the feature to only stop the autobooting,
1447 and therefore boot into the U-Boot prompt, when the input
1448 string / password matches a values that is hashed via
1449 one of the supported crypt-style password hashing options
1450 and saved in the environment variable "bootstopkeycrypt".
1451
Simon Glass98eed0d2020-09-10 20:21:16 -06001452config AUTOBOOT_STOP_STR_SHA256
Steffen Jaeckel25c8b9f2021-07-08 15:57:40 +02001453 string "Stop autobooting via SHA256 hashed password"
Steffen Jaeckel1a4a7782021-07-08 15:57:35 +02001454 depends on AUTOBOOT_STOP_STR_ENABLE
Simon Glass98eed0d2020-09-10 20:21:16 -06001455 help
1456 This option adds the feature to only stop the autobooting,
1457 and therefore boot into the U-Boot prompt, when the input
Quentin Schulzb88950f2024-06-12 16:58:47 +02001458 string / password matches a values that is encrypted via
Joel Peshkin652b5042020-11-21 17:18:59 -08001459 a SHA256 hash and saved in the environment variable
1460 "bootstopkeysha256". If the value in that variable
1461 includes a ":", the portion prior to the ":" will be treated
1462 as a salt value.
Simon Glass98eed0d2020-09-10 20:21:16 -06001463
Simon Glass5bcfc7a2023-10-26 14:31:22 -04001464endif # AUTOBOOT_KEYED
1465
1466if !AUTOBOOT_KEYED
1467
Simon Glass98eed0d2020-09-10 20:21:16 -06001468config AUTOBOOT_USE_MENUKEY
1469 bool "Allow a specify key to run a menu from the environment"
Simon Glass98eed0d2020-09-10 20:21:16 -06001470 help
1471 If a specific key is pressed to stop autoboot, then the commands in
1472 the environment variable 'menucmd' are executed before boot starts.
1473
1474config AUTOBOOT_MENUKEY
1475 int "ASCII value of boot key to show a menu"
1476 default 0
1477 depends on AUTOBOOT_USE_MENUKEY
1478 help
1479 If this key is pressed to stop autoboot, then the commands in the
1480 environment variable 'menucmd' will be executed before boot starts.
1481 For example, 33 means "!" in ASCII, so pressing ! at boot would take
1482 this action.
1483
Simon Glass5bcfc7a2023-10-26 14:31:22 -04001484endif
1485
1486endif # AUTOBOOT
1487
Simon Glass98eed0d2020-09-10 20:21:16 -06001488config AUTOBOOT_MENU_SHOW
1489 bool "Show a menu on boot"
1490 depends on CMD_BOOTMENU
1491 help
1492 This enables the boot menu, controlled by environment variables
1493 defined by the board. The menu starts after running the 'preboot'
1494 environmnent variable (if enabled) and before handling the boot delay.
Peter Robinsond1670622023-08-18 15:54:10 +01001495 See doc/usage/cmd/bootmenu.rst for more details.
Simon Glass98eed0d2020-09-10 20:21:16 -06001496
Masahisa Kojima83f73632022-05-26 19:09:38 +09001497config BOOTMENU_DISABLE_UBOOT_CONSOLE
1498 bool "Disallow bootmenu to enter the U-Boot console"
1499 depends on AUTOBOOT_MENU_SHOW
1500 help
1501 If this option is enabled, user can not enter the U-Boot console from
1502 bootmenu. It increases the system security.
1503
Tom Rini69c8a812022-03-11 09:12:04 -05001504config BOOT_RETRY
1505 bool "Boot retry feature"
1506 help
1507 Allow for having the U-Boot command prompt time out and attempt
1508 to boot again. If the environment variable "bootretry" is found then
1509 its value is used, otherwise the retry timeout is
1510 CONFIG_BOOT_RETRY_TIME. CONFIG_BOOT_RETRY_MIN is optional and
1511 defaults to CONFIG_BOOT_RETRY_TIME. All times are in seconds.
1512
1513config BOOT_RETRY_TIME
1514 int "Timeout in seconds before attempting to boot again"
1515 depends on BOOT_RETRY
1516 help
1517 Time in seconds before the U-Boot prompt will timeout and boot will
1518 be attempted again.
1519
1520config BOOT_RETRY_MIN
1521 int "Minimum timeout in seconds for 'bootretry'"
1522 depends on BOOT_RETRY
1523 default BOOT_RETRY_TIME
1524 help
1525 The minimum time in seconds that "bootretry" can be set to.
1526
1527config RESET_TO_RETRY
1528 bool "Reset the board to retry autoboot"
1529 depends on BOOT_RETRY
1530 help
1531 After the countdown timed out, the board will be reset to restart
1532 again.
1533
Simon Glass98eed0d2020-09-10 20:21:16 -06001534endmenu
1535
Philippe Reynes98220742022-03-28 22:56:59 +02001536menu "Image support"
1537
1538config IMAGE_PRE_LOAD
1539 bool "Image pre-load support"
1540 help
1541 Enable an image pre-load stage in the SPL.
1542 This pre-load stage allows to do some manipulation
1543 or check (for example signature check) on an image
1544 before launching it.
1545
1546config SPL_IMAGE_PRE_LOAD
1547 bool "Image pre-load support within SPL"
1548 depends on SPL && IMAGE_PRE_LOAD
1549 help
1550 Enable an image pre-load stage in the SPL.
1551 This pre-load stage allows to do some manipulation
1552 or check (for example signature check) on an image
1553 before launching it.
1554
1555config IMAGE_PRE_LOAD_SIG
1556 bool "Image pre-load signature support"
1557 depends on IMAGE_PRE_LOAD
1558 select FIT_SIGNATURE
1559 select RSA
1560 select RSA_VERIFY_WITH_PKEY
1561 help
1562 Enable signature check support in the pre-load stage.
1563 For this feature a very simple header is added before
1564 the image with few fields:
1565 - a magic
1566 - the image size
1567 - the signature
1568 All other information (header size, type of signature,
1569 ...) are provided in the node /image/pre-load/sig of
1570 u-boot.
1571
1572config SPL_IMAGE_PRE_LOAD_SIG
1573 bool "Image pre-load signature support witin SPL"
1574 depends on SPL_IMAGE_PRE_LOAD && IMAGE_PRE_LOAD_SIG
1575 select SPL_FIT_SIGNATURE
1576 select SPL_RSA
1577 select SPL_RSA_VERIFY_WITH_PKEY
1578 help
1579 Enable signature check support in the pre-load stage in the SPL.
1580 For this feature a very simple header is added before
1581 the image with few fields:
1582 - a magic
1583 - the image size
1584 - the signature
1585 All other information (header size, type of signature,
1586 ...) are provided in the node /image/pre-load/sig of
1587 u-boot.
1588
1589endmenu
1590
Simon Glassddc5f9b2023-09-14 10:55:46 -06001591if OF_LIBFDT
1592
1593menu "Devicetree fixup"
1594
Matthias Schiffere91d6602023-12-11 12:03:17 +01001595config OF_ENV_SETUP
1596 bool "Run a command from environment to set up device tree before boot"
1597 depends on CMD_FDT
1598 help
1599 This causes U-Boot to run a command from the environment variable
1600 fdt_fixup before booting into the operating system, which can use the
1601 fdt command to modify the device tree. The device tree is then passed
1602 to the OS.
1603
Simon Glass96095e12023-09-14 10:55:47 -06001604config OF_BOARD_SETUP
1605 bool "Set up board-specific details in device tree before boot"
1606 help
1607 This causes U-Boot to call ft_board_setup() before booting into
1608 the Operating System. This function can set up various
1609 board-specific information in the device tree for use by the OS.
1610 The device tree is then passed to the OS.
1611
1612config OF_SYSTEM_SETUP
1613 bool "Set up system-specific details in device tree before boot"
1614 help
1615 This causes U-Boot to call ft_system_setup() before booting into
1616 the Operating System. This function can set up various
1617 system-specific information in the device tree for use by the OS.
1618 The device tree is then passed to the OS.
1619
1620config OF_STDOUT_VIA_ALIAS
1621 bool "Update the device-tree stdout alias from U-Boot"
1622 help
1623 This uses U-Boot's serial alias from the aliases node to update
1624 the device tree passed to the OS. The "linux,stdout-path" property
1625 in the chosen node is set to point to the correct serial node.
1626 This option currently references CONFIG_CONS_INDEX, which is
1627 incorrect when used with device tree as this option does not
1628 exist / should not be used.
1629
Simon Glass040a6042023-09-14 10:55:57 -06001630config FDT_FIXUP_PARTITIONS
Simon Glass400a6a32023-09-14 10:55:58 -06001631 bool "Overwrite MTD partitions in DTS through defined in 'mtdparts'"
Simon Glass040a6042023-09-14 10:55:57 -06001632 help
1633 Allow overwriting defined partitions in the device tree blob
1634 using partition info defined in the 'mtdparts' environment
1635 variable.
1636
Simon Glassddc5f9b2023-09-14 10:55:46 -06001637config FDT_SIMPLEFB
1638 bool "FDT tools for simplefb support"
1639 help
1640 Enable the fdt tools to manage the simple fb nodes in device tree.
1641 These functions can be used by board to indicate to the OS
1642 the presence of the simple frame buffer with associated reserved
1643 memory
1644
Simon Glassc0e5b0e2023-09-14 10:55:59 -06001645config ARCH_FIXUP_FDT_MEMORY
1646 bool "Enable arch_fixup_memory_banks() call"
1647 default y
1648 help
1649 Enable FDT memory map syncup before OS boot. This feature can be
1650 used for booting OS with different memory setup where the part of
1651 the memory location should be used for different purpose.
1652
Simon Glassddc5f9b2023-09-14 10:55:46 -06001653endmenu
1654
1655endif # OF_LIBFDT
1656
Simon Glassfe5db252020-09-10 20:21:18 -06001657config USE_BOOTARGS
1658 bool "Enable boot arguments"
1659 help
1660 Provide boot arguments to bootm command. Boot arguments are specified
1661 in CONFIG_BOOTARGS option. Enable this option to be able to specify
1662 CONFIG_BOOTARGS string. If this option is disabled, CONFIG_BOOTARGS
1663 will be undefined and won't take any space in U-Boot image.
1664
1665config BOOTARGS
1666 string "Boot arguments"
1667 depends on USE_BOOTARGS && !USE_DEFAULT_ENV_FILE
1668 help
1669 This can be used to pass arguments to the bootm command. The value of
1670 CONFIG_BOOTARGS goes into the environment value "bootargs". Note that
1671 this value will also override the "chosen" node in FDT blob.
1672
Simon Glass51bb3382020-11-05 10:33:48 -07001673config BOOTARGS_SUBST
1674 bool "Support substituting strings in boot arguments"
1675 help
1676 This allows substituting string values in the boot arguments. These
1677 are applied after the commandline has been built.
1678
1679 One use for this is to insert the root-disk UUID into the command
1680 line where bootargs contains "root=${uuid}"
1681
1682 setenv bootargs "console= root=${uuid}"
1683 # Set the 'uuid' environment variable
1684 part uuid mmc 2:2 uuid
1685
1686 # Command-line substitution will put the real uuid into the
1687 # kernel command line
1688 bootm
1689
Simon Glassfe5db252020-09-10 20:21:18 -06001690config USE_BOOTCOMMAND
1691 bool "Enable a default value for bootcmd"
Tom Rinidbdb4b32023-10-26 14:31:28 -04001692 depends on CMDLINE
Simon Glassfe5db252020-09-10 20:21:18 -06001693 help
1694 Provide a default value for the bootcmd entry in the environment. If
1695 autoboot is enabled this is what will be run automatically. Enable
1696 this option to be able to specify CONFIG_BOOTCOMMAND as a string. If
1697 this option is disabled, CONFIG_BOOTCOMMAND will be undefined and
1698 won't take any space in U-Boot image.
1699
1700config BOOTCOMMAND
1701 string "bootcmd value"
1702 depends on USE_BOOTCOMMAND && !USE_DEFAULT_ENV_FILE
Simon Glassd8d40bc2023-05-06 08:27:09 -06001703 default "bootflow scan -lb" if BOOTSTD_DEFAULTS && CMD_BOOTFLOW_FULL
1704 default "bootflow scan" if BOOTSTD_DEFAULTS && !CMD_BOOTFLOW_FULL
Simon Glassa91492b2022-04-24 23:31:27 -06001705 default "run distro_bootcmd" if !BOOTSTD_BOOTCOMMAND && DISTRO_DEFAULTS
Simon Glassfe5db252020-09-10 20:21:18 -06001706 help
1707 This is the string of commands that will be used as bootcmd and if
1708 AUTOBOOT is set, automatically run.
1709
1710config USE_PREBOOT
1711 bool "Enable preboot"
Tom Rinidbdb4b32023-10-26 14:31:28 -04001712 depends on CMDLINE
Simon Glassfe5db252020-09-10 20:21:18 -06001713 help
1714 When this option is enabled, the existence of the environment
1715 variable "preboot" will be checked immediately before starting the
1716 CONFIG_BOOTDELAY countdown and/or running the auto-boot command resp.
1717 entering interactive mode.
1718
1719 This feature is especially useful when "preboot" is automatically
1720 generated or modified. For example, the boot code can modify the
1721 "preboot" when a user holds down a certain combination of keys.
1722
1723config PREBOOT
1724 string "preboot default value"
1725 depends on USE_PREBOOT && !USE_DEFAULT_ENV_FILE
Patrick Delaunay87459da2020-10-12 09:47:50 +02001726 default "usb start" if USB_KEYBOARD
Simon Glassfe5db252020-09-10 20:21:18 -06001727 default ""
1728 help
1729 This is the default of "preboot" environment variable.
1730
Pali Rohár2827c2f2022-07-10 13:42:55 +02001731config PREBOOT_DEFINED
1732 bool
1733 default y if PREBOOT != ""
1734
Simon Glass832876a2020-09-10 20:21:20 -06001735config DEFAULT_FDT_FILE
1736 string "Default fdt file"
1737 help
1738 This option is used to set the default fdt file to boot OS.
1739
Dzmitry Sankouski12a3e1a2022-02-22 21:49:52 +03001740config SAVE_PREV_BL_FDT_ADDR
1741 depends on ARM
1742 bool "Saves fdt address, passed by the previous bootloader, to env var"
1743 help
1744 When u-boot is used as a chain-loaded bootloader (replacing OS kernel),
1745 enable this option to save fdt address, passed by the
1746 previous bootloader for future use.
1747 Address is saved to `prevbl_fdt_addr` environment variable.
1748
1749 If no fdt was provided by previous bootloader, no env variables
1750 will be created.
1751
1752config SAVE_PREV_BL_INITRAMFS_START_ADDR
1753 depends on ARM
1754 bool "Saves initramfs address, passed by the previous bootloader, to env var"
1755 help
1756 When u-boot is used as a chain-loaded bootloader(replacing OS kernel),
1757 enable this option to save initramfs address, passed by the
1758 previous bootloader for future use.
1759 Address is saved to `prevbl_initrd_start_addr` environment variable.
1760
1761 If no initramfs was provided by previous bootloader, no env variables
1762 will be created.
1763
Simon Glassa0874dc2023-06-01 10:23:02 -06001764menu "Configuration editor"
1765
1766config CEDIT
1767 bool "Configuration editor"
Heinrich Schuchardt64c67b62023-12-16 16:38:36 +01001768 depends on EXPO
Simon Glassa0874dc2023-06-01 10:23:02 -06001769 help
1770 Provides a way to deal with board configuration and present it to
1771 the user for adjustment.
1772
1773 This is intended to provide both graphical and text-based user
1774 interfaces, but only graphical is support at present.
1775
1776endmenu # Configuration editor
1777
Simon Glasscf298162020-09-10 20:21:13 -06001778endmenu # Booting