blob: e37b08bf3912713893203c6febf28a783bd05966 [file] [log] [blame]
Simon Glassb45b1632020-09-10 20:21:13 -06001menu "Boot options"
2
3menu "Boot images"
4
Tom Rini793921e2024-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 Glasse9a089a2023-09-14 10:55:49 -060038menuconfig FIT
39 bool "Flattened Image Tree (FIT)"
Alexandru Gagniuc650b7862021-09-02 19:54:21 -050040 select HASH
Simon Glassb45b1632020-09-10 20:21:13 -060041 select MD5
42 select SHA1
Alexandru Gagniuc8d310ef2021-09-02 19:54:17 -050043 imply SHA256
Simon Glassb45b1632020-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 Glasse9a089a2023-09-14 10:55:49 -060054if FIT
Simon Glass65831d92021-12-18 11:27:50 -070055
Simon Glassb45b1632020-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 Glass244705b2021-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 Glassb45b1632020-09-10 20:21:13 -060075config FIT_SIGNATURE
76 bool "Enable signature verification of FIT uImages"
Simon Glasse9a089a2023-09-14 10:55:49 -060077 depends on DM
Simon Glassb45b1632020-09-10 20:21:13 -060078 select HASH
Alexandru Gagniuc1f2e2312021-07-29 11:47:18 -050079 imply RSA
80 imply RSA_VERIFY
Simon Glassb45b1632020-09-10 20:21:13 -060081 select IMAGE_SIGN_INFO
Simon Glass244705b2021-02-15 17:08:10 -070082 select FIT_FULL_CHECK
Simon Glassb45b1632020-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 Schuchardtb72eb352024-06-18 08:23:17 +020088 it. See doc/usage/fit/signature.rst for more details.
Simon Glassb45b1632020-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 Glass66b00c82021-07-14 17:05:31 -0500106config FIT_RSASSA_PSS
Simon Glassb45b1632020-09-10 20:21:13 -0600107 bool "Support rsassa-pss signature scheme of FIT image contents"
108 depends on FIT_SIGNATURE
Simon Glassb45b1632020-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 Glasse9a089a2023-09-14 10:55:49 -0600115 depends on DM
Simon Glassb45b1632020-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 Chawdhryf65cdf72023-07-14 11:22:40 +0530140 depends on SOCFPGA_SECURE_VAB_AUTH
Simon Glassb45b1632020-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 Hasija11dac412021-01-27 14:01:48 -0800152config FIT_PRINT
Anand Moon6c368f42024-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 Hasija11dac412021-01-27 14:01:48 -0800157
Simon Glassb45b1632020-09-10 20:21:13 -0600158config SPL_FIT
159 bool "Support Flattened Image Tree within SPL"
Simon Glass2289ca92023-09-14 10:55:52 -0600160 depends on SPL
Alexandru Gagniuc650b7862021-09-02 19:54:21 -0500161 select SPL_HASH
Simon Glassb45b1632020-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 Glass244705b2021-02-15 17:08:10 -0700170config SPL_FIT_FULL_CHECK
171 bool "Do a full check of the FIT before using it"
Tom Rini0f3d1de2022-12-04 10:14:20 -0500172 depends on SPL_FIT
Simon Glass244705b2021-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 Glassb45b1632020-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 Kiwiae5073f2021-02-09 15:41:54 -0300182 depends on SPL_LOAD_FIT || SPL_LOAD_FIT_FULL
Klaus Heinrich Kiwic9796e62021-02-09 15:41:53 -0300183 select FIT_SIGNATURE
Simon Glassb45b1632020-09-10 20:21:13 -0600184 select SPL_FIT
Simon Glassa8437ce2021-07-10 21:14:25 -0600185 select SPL_CRYPTO
Alexandru Gagniuc97464ff2021-09-02 19:54:19 -0500186 select SPL_HASH
Alexandru Gagniuc1f2e2312021-07-29 11:47:18 -0500187 imply SPL_RSA
188 imply SPL_RSA_VERIFY
Simon Glassb45b1632020-09-10 20:21:13 -0600189 select SPL_IMAGE_SIGN_INFO
Simon Glass244705b2021-02-15 17:08:10 -0700190 select SPL_FIT_FULL_CHECK
Simon Glassb45b1632020-09-10 20:21:13 -0600191
Simon Glassc0cabbc2021-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 Reynes47f3eb22021-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 Glassb45b1632020-09-10 20:21:13 -0600209config SPL_LOAD_FIT
210 bool "Enable SPL loading U-Boot as a FIT (basic fitImage features)"
Simon Glass2289ca92023-09-14 10:55:52 -0600211 depends on SPL
Simon Glassb45b1632020-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 Gagniuc064c9c22021-03-29 12:05:15 -0500221 This path has the following limitations:
222
Bin Meng91cdcb92021-05-10 20:23:29 +0800223 1. "loadables" images, other than FDTs, which do not have a "load"
Alexandru Gagniuc064c9c22021-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 Schuchardtb72eb352024-06-18 08:23:17 +0200226 2. For FPGA images, the supported "compatible" list may be found in
227 https://fitspec.osfw.foundation/.
Alexandru Gagniuc064c9c22021-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 Glassb45b1632020-09-10 20:21:13 -0600231config SPL_LOAD_FIT_ADDRESS
232 hex "load address of fit image"
Simon Glassdfcedda2023-09-14 10:55:51 -0600233 depends on SPL_LOAD_FIT
Simon Glassb45b1632020-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 Villeneuve5c1c6cc2023-04-24 16:51:12 -0400244 The device tree is loaded from the FIT image. Allow the SPL to
Simon Glassb45b1632020-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 Davis4ba9e6e2022-05-04 15:52:28 -0500271 default y if TI_SECURE_DEVICE
Simon Glassb45b1632020-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 Rini0f3d1de2022-12-04 10:14:20 -0500293 depends on SPL_FIT
Simon Glassbd7694f2023-01-07 14:07:19 -0700294 default y if SPL_FIT && ARCH_ZYNQMP
Simon Glassb45b1632020-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 Glassb45b1632020-09-10 20:21:13 -0600299 default "arch/arm/mach-zynqmp/mkimage_fit_atf.sh" if SPL_LOAD_FIT && ARCH_ZYNQMP
Simon Glassb45b1632020-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 Glassbc993e52022-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 Glassbc993e52022-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 Glass2289ca92023-09-14 10:55:52 -0600356endif # FIT
357
John Keeping9b60a172022-07-28 11:19:15 +0100358config PXE_UTILS
359 bool
360 select MENU
361 help
362 Utilities for parsing PXE file formats.
363
Tom Rini984bfdc2023-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 Glass054d0182023-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 Glass054d0182023-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 Rini984bfdc2023-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 Glass054d0182023-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 Glass6cfb0022023-09-14 10:55:53 -0600398menuconfig BOOTSTD
399 bool "Standard boot"
Simon Glass08ad13e2022-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 Glass6cfb0022023-09-14 10:55:53 -0600419if BOOTSTD
420
Simon Glassbc993e52022-10-20 18:23:13 -0600421config SPL_BOOTSTD
Simon Glass4aa874f2023-02-22 09:33:58 -0700422 bool "Standard boot support in SPL"
Simon Glassbc993e52022-10-20 18:23:13 -0600423 depends on SPL && SPL_DM && SPL_OF_CONTROL && SPL_BLK
424 default y if VPL
425 help
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200426 This enables standard boot in SPL. This is needed so that VBE
Simon Glassbc993e52022-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 Schulzc0a7ae02024-06-12 16:58:47 +0200436 This enables standard boot in SPL. This is needed so that VBE
Simon Glassbc993e52022-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 Glass78c79dd2023-02-22 14:06:23 -0700441config BOOTSTD_FULL
442 bool "Enhanced features for standard boot"
443 default y if SANDBOX
Shantur Rathore19b54342023-12-23 06:51:59 +0000444 imply BOOTSTD_DEFAULTS
Simon Glass78c79dd2023-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 Schulzc0a7ae02024-06-12 16:58:47 +0200452 - support for selecting the ordering of bootdevs using the Device Tree
Simon Glass78c79dd2023-02-22 14:06:23 -0700453 as well as the "boot_targets" environment variable
454
Simon Glass2e5161eb2023-01-28 15:00:21 -0700455config BOOTSTD_DEFAULTS
456 bool "Select some common defaults for standard boot"
457 depends on BOOTSTD
Simon Glass054d0182023-03-24 16:58:13 -0400458 select BOOT_DEFAULTS
Simon Glassdb92e782023-05-10 16:34:47 -0600459 select BOOTMETH_DISTRO
Simon Glass2e5161eb2023-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 Glassbe661cb2022-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 Glass92368522023-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 Schulzc0a7ae02024-06-12 16:58:47 +0200484 a system without using commands. If the boot fails, then U-Boot will
Simon Glass92368522023-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 Glass4f8633d2022-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 Korpershoekb30baa92024-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 Glassd74e62a2023-07-12 09:04:45 -0600514config BOOTMETH_CROS
515 bool "Bootdev support for Chromium OS"
Simon Glass18700262023-07-30 11:17:02 -0600516 depends on X86 || ARM || SANDBOX
517 default y if !ARM
Simon Glassd7d3a972023-08-24 13:55:45 -0600518 select EFI_PARTITION
519 select PARTITION_TYPE_GUID
520 select PARTITION_UUIDS
Simon Glassd74e62a2023-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 Glassb71d7f72023-05-10 16:34:46 -0600528config BOOTMETH_EXTLINUX
529 bool "Bootdev support for extlinux boot"
John Keeping9b60a172022-07-28 11:19:15 +0100530 select PXE_UTILS
Simon Glassad8ec372022-04-24 23:31:13 -0600531 default y
532 help
Simon Glassb71d7f72023-05-10 16:34:46 -0600533 Enables support for extlinux boot using bootdevs. This makes the
Simon Glassad8ec372022-04-24 23:31:13 -0600534 bootdevs look for a 'extlinux/extlinux.conf' on each filesystem
535 they scan.
536
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200537 The specification for this file is here:
Simon Glassb71d7f72023-05-10 16:34:46 -0600538
539 https://uapi-group.org/specifications/specs/boot_loader_specification/
540
Simon Glassad8ec372022-04-24 23:31:13 -0600541 This provides a way to try out standard boot on an existing boot flow.
542
Simon Glassb71d7f72023-05-10 16:34:46 -0600543config BOOTMETH_EXTLINUX_PXE
544 bool "Bootdev support for extlinux boot over network"
Simon Glass83144612022-04-24 23:31:16 -0600545 depends on CMD_PXE && CMD_NET && DM_ETH
546 default y
547 help
Simon Glassb71d7f72023-05-10 16:34:46 -0600548 Enables support for extlinux boot using bootdevs. This makes the
Simon Glass83144612022-04-24 23:31:16 -0600549 bootdevs look for a 'extlinux/extlinux.conf' on the tftp server.
550
Simon Glassb71d7f72023-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 Glass83144612022-04-24 23:31:16 -0600555 This provides a way to try out standard boot on an existing boot flow.
556
Simon Glass66f62552022-04-24 23:31:17 -0600557config BOOTMETH_EFILOADER
558 bool "Bootdev support for EFI boot"
AKASHI Takahiro9b08b9a2024-01-17 13:39:41 +0900559 depends on EFI_BINARY_EXEC
Simon Glass66f62552022-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 Schuchardt72bca1a2024-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 Schuchardt1cd3ec92024-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 Glass0a9f4262022-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 Rini7d3684a2023-01-16 15:46:49 -0500602 select EVENT
Simon Glass0a9f4262022-07-30 15:52:32 -0600603 help
604 Enables support for VBE boot. This is a standard boot method which
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200605 supports selection of various firmware components, selection of an OS to
Simon Glass0a9f4262022-07-30 15:52:32 -0600606 boot as well as updating these using fwupd.
607
Simon Glassdb92e782023-05-10 16:34:47 -0600608config BOOTMETH_DISTRO
609 bool # Options needed to boot any distro
Tom Rini9bf470a2023-10-26 14:31:27 -0400610 select BOOTMETH_SCRIPT if CMDLINE # E.g. Armbian uses scripts
Simon Glassdb92e782023-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 Takahiro9b08b9a2024-01-17 13:39:41 +0900613 select BOOTMETH_EFILOADER if EFI_BINARY_EXEC # E.g. Ubuntu uses this
Simon Glassdb92e782023-05-10 16:34:47 -0600614
Simon Glassbc993e52022-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 Rini7d3684a2023-01-16 15:46:49 -0500618 select EVENT
Simon Glassbc993e52022-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 Schulzc0a7ae02024-06-12 16:58:47 +0200622 supports selection of various firmware components, selection of an OS to
Simon Glassbc993e52022-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 Rini7d3684a2023-01-16 15:46:49 -0500628 select EVENT
Simon Glassbc993e52022-10-20 18:23:13 -0600629 default y
630 help
631 Enables support for VBE boot. This is a standard boot method which
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200632 supports selection of various firmware components, selection of an OS to
Simon Glassbc993e52022-10-20 18:23:13 -0600633 boot as well as updating these using fwupd.
634
Simon Glassd0af04c2022-07-30 15:52:33 -0600635if BOOTMETH_VBE
636
Simon Glass513eeed2023-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 Glassd0af04c2022-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 Glassbc993e52022-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 Glassd0af04c2022-07-30 15:52:33 -0600713endif # BOOTMETH_VBE
714
Simon Glassd8adbe92023-01-06 08:52:36 -0600715config EXPO
716 bool "Support for expos - groups of scenes displaying a UI"
Simon Glass389a4582023-01-28 15:00:18 -0700717 depends on VIDEO
Simon Glassd8adbe92023-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 Glass423994e2022-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 Glass7e03e742022-04-24 23:31:22 -0600735config BOOTMETH_SCRIPT
736 bool "Bootdev support for U-Boot scripts"
737 default y if BOOTSTD_FULL
Tom Rini9bf470a2023-10-26 14:31:27 -0400738 depends on CMDLINE
Simon Glassb4b7ebe2023-05-05 20:03:05 -0600739 select HUSH_PARSER
Simon Glass7e03e742022-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 Glass77459f42024-08-07 16:47:27 -0600748config UPL
749 bool "upl - Universal Payload Specification"
Simon Glass3a028c22024-08-07 16:47:30 -0600750 imply CMD_UPL
Simon Glass77459f42024-08-07 16:47:27 -0600751 imply UPL_READ
Simon Glassb9474a82024-08-07 16:47:28 -0600752 imply UPL_WRITE
Simon Glass77459f42024-08-07 16:47:27 -0600753 help
754 Provides support for UPL payloads and handoff information. U-Boot
755 supports generating and accepting handoff information. The mkimage
756 tool will eventually support creating payloads.
757
758if UPL
759
760config UPL_READ
761 bool "upl - Support reading a Universal Payload handoff"
762 help
763 Provides support for decoding a UPL-format payload into a C structure
764 which can be used elsewhere in U-Boot. This is just the reading
765 implementation, useful for trying it out.
766
Simon Glassb9474a82024-08-07 16:47:28 -0600767config UPL_WRITE
768 bool "upl - Support writing a Universal Payload handoff"
769 help
770 Provides support for encoding a UPL-format payload from a C structure
771 so it can be passed to another program. This is just the writing
772 implementation, useful for trying it out.
773
Simon Glass77459f42024-08-07 16:47:27 -0600774endif # UPL
775
Simon Glass6cfb0022023-09-14 10:55:53 -0600776endif # BOOTSTD
Simon Glassad8ec372022-04-24 23:31:13 -0600777
Simon Glassb45b1632020-09-10 20:21:13 -0600778config LEGACY_IMAGE_FORMAT
779 bool "Enable support for the legacy image format"
Andrew Davis98a22d02022-05-04 15:52:27 -0500780 default y if !FIT_SIGNATURE && !TI_SECURE_DEVICE
Simon Glassb45b1632020-09-10 20:21:13 -0600781 help
782 This option enables the legacy image format. It is enabled by
783 default for backward compatibility, unless FIT_SIGNATURE is
784 set where it is disabled so that unsigned images cannot be
785 loaded. If a board needs the legacy image format support in this
786 case, enable it here.
787
Eddie James32401ba2023-10-24 10:43:50 -0500788config MEASURED_BOOT
789 bool "Measure boot images and configuration when booting without EFI"
790 depends on HASH && TPM_V2
Ilias Apalodimas1e665f92024-06-23 14:48:18 +0300791 select SHA1
792 select SHA256
793 select SHA384
794 select SHA512
Eddie James32401ba2023-10-24 10:43:50 -0500795 help
796 This option enables measurement of the boot process when booting
797 without UEFI . Measurement involves creating cryptographic hashes
798 of the binary images that are booting and storing them in the TPM.
799 In addition, a log of these hashes is stored in memory for the OS
800 to verify the booted images and configuration. Enable this if the
801 OS has configured some memory area for the event log and you intend
802 to use some attestation tools on your system.
803
804if MEASURED_BOOT
805 config MEASURE_DEVICETREE
806 bool "Measure the devicetree image"
807 default y if MEASURED_BOOT
808 help
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200809 On some platforms, the Device Tree is not static as it may contain
Eddie James32401ba2023-10-24 10:43:50 -0500810 random MAC addresses or other such data that changes each boot.
811 Therefore, it should not be measured into the TPM. In that case,
812 disable the measurement here.
813
814 config MEASURE_IGNORE_LOG
815 bool "Ignore the existing event log"
Eddie James32401ba2023-10-24 10:43:50 -0500816 help
817 On platforms that use an event log memory region that persists
818 through system resets and are the first stage bootloader, then
819 this option should be enabled to ignore any existing data in the
820 event log memory region.
821endif # MEASURED_BOOT
822
Tom Riniec8d1602023-10-26 14:31:25 -0400823config SYS_BOOTM_LEN
824 hex "Maximum size of a decompresed OS image"
Tom Rini793921e2024-04-18 08:29:35 -0600825 depends on CMD_BOOTM || CMD_BOOTI || CMD_BOOTZ || \
Tom Riniec8d1602023-10-26 14:31:25 -0400826 LEGACY_IMAGE_FORMAT || SPL_LEGACY_IMAGE_FORMAT
827 default 0x4000000 if PPC || ARM64
828 default 0x1000000 if X86 || ARCH_MX6 || ARCH_MX7
829 default 0x800000
830 help
831 This is the maximum size of the buffer that is used to decompress the OS
832 image in to if attempting to boot a compressed image.
833
Simon Glassf11d6132020-09-10 20:21:19 -0600834config SUPPORT_RAW_INITRD
835 bool "Enable raw initrd images"
836 help
837 Note, defining the SUPPORT_RAW_INITRD allows user to supply
838 kernel with raw initrd images. The syntax is slightly different, the
839 address of the initrd must be augmented by it's size, in the following
840 format: "<initrd address>:<initrd size>".
841
Simon Glassd81f07f2020-11-04 09:57:35 -0700842config CHROMEOS
843 bool "Support booting Chrome OS"
844 help
845 Chrome OS requires U-Boot to set up a table indicating the boot mode
846 (e.g. Developer mode) and a few other things. Enable this if you are
847 booting on a Chromebook to avoid getting an error about an invalid
848 firmware ID.
849
850config CHROMEOS_VBOOT
851 bool "Support Chrome OS verified boot"
852 help
853 This is intended to enable the full Chrome OS verified boot support
854 in U-Boot. It is not actually implemented in the U-Boot source code
855 at present, so this option is always set to 'n'. It allows
856 distinguishing between booting Chrome OS in a basic way (developer
857 mode) and a full boot.
858
Tom Rinieb4f2de2022-06-25 11:02:44 -0400859config SYS_RAMBOOT
860 bool
861
Tom Rini9ff815a2021-08-24 23:11:49 -0400862config RAMBOOT_PBL
863 bool "Freescale PBL(pre-boot loader) image format support"
Tom Rinieb4f2de2022-06-25 11:02:44 -0400864 select SYS_RAMBOOT if PPC
Tom Rini9ff815a2021-08-24 23:11:49 -0400865 help
866 Some SoCs use PBL to load RCW and/or pre-initialization instructions.
867 For more details refer to doc/README.pblimage
868
Tom Rini886e6e32022-03-23 17:20:03 -0400869choice
Tom Rini489f4022022-12-28 10:52:51 -0500870 prompt "Freescale PBL (or predecessor) load location"
Tom Rini886e6e32022-03-23 17:20:03 -0400871 depends on RAMBOOT_PBL || ((TARGET_P1010RDB_PA || TARGET_P1010RDB_PB \
872 || TARGET_P1020RDB_PC || TARGET_P1020RDB_PD || TARGET_P2020RDB) \
Pali Rohár6763ff82024-06-06 18:33:26 +0200873 && !CMD_NAND) || (TARGET_TURRIS_1X && SYS_MPC85XX_NO_RESETVEC)
Tom Rini886e6e32022-03-23 17:20:03 -0400874
875config SDCARD
Tom Rini489f4022022-12-28 10:52:51 -0500876 bool "Freescale PBL (or similar) is found on SD card"
Tom Rini886e6e32022-03-23 17:20:03 -0400877
878config SPIFLASH
Tom Rini489f4022022-12-28 10:52:51 -0500879 bool "Freescale PBL (or similar) is found on SPI flash"
880
881config NO_PBL
882 bool "Freescale PBL (or similar) is not used in this case"
Tom Rini886e6e32022-03-23 17:20:03 -0400883
884endchoice
885
Tom Rini5989fd42022-06-20 08:07:42 -0400886config FSL_FIXED_MMC_LOCATION
887 bool "PBL MMC is at a fixed location"
888 depends on SDCARD && !RAMBOOT_PBL
889
890config ESDHC_HC_BLK_ADDR
891 def_bool y
892 depends on FSL_FIXED_MMC_LOCATION && (ARCH_BSC9131 || ARCH_BSC9132 || ARCH_P1010)
893 help
894 In High Capacity SD Cards (> 2 GBytes), the 32-bit source address and
895 code length of these soc specify the memory address in block address
896 format. Block length is fixed to 512 bytes as per the SD High
897 Capacity specification.
898
Tom Rini9ff815a2021-08-24 23:11:49 -0400899config SYS_FSL_PBL_PBI
900 string "PBI(pre-boot instructions) commands for the PBL image"
901 depends on RAMBOOT_PBL
902 help
903 PBI commands can be used to configure SoC before it starts the execution.
904 Please refer doc/README.pblimage for more details.
905
906config SYS_FSL_PBL_RCW
907 string "Aadditional RCW (Power on reset configuration) for the PBL image"
908 depends on RAMBOOT_PBL
909 help
910 Enables addition of RCW (Power on reset configuration) in built image.
911 Please refer doc/README.pblimage for more details.
912
Tom Rini94b4fec2022-06-25 11:02:46 -0400913config SYS_BOOT_RAMDISK_HIGH
914 depends on CMD_BOOTM || CMD_BOOTI || CMD_BOOTZ
915 depends on !(NIOS2 || SANDBOX || SH || XTENSA)
916 def_bool y
Simon Glass65edcd32023-03-24 16:58:12 -0400917 select LMB
Tom Rini94b4fec2022-06-25 11:02:46 -0400918 help
919 Enable initrd_high functionality. If defined then the initrd_high
920 feature is enabled and the boot* ramdisk subcommand is enabled.
921
Simon Glassb45b1632020-09-10 20:21:13 -0600922endmenu # Boot images
923
Simon Glassf111bf72023-03-24 16:58:11 -0400924config DISTRO_DEFAULTS
Simon Glasse27d7df2023-09-14 10:55:55 -0600925 bool "(deprecated) Script-based booting of Linux distributions"
Tom Rini045245b2023-10-26 14:31:23 -0400926 select CMDLINE
Simon Glass054d0182023-03-24 16:58:13 -0400927 select BOOT_DEFAULTS
Simon Glassf111bf72023-03-24 16:58:11 -0400928 select AUTO_COMPLETE
929 select CMDLINE_EDITING
Simon Glassf111bf72023-03-24 16:58:11 -0400930 select CMD_SYSBOOT
Simon Glassf111bf72023-03-24 16:58:11 -0400931 select HUSH_PARSER
Simon Glassf111bf72023-03-24 16:58:11 -0400932 select SYS_LONGHELP
Simon Glassf111bf72023-03-24 16:58:11 -0400933 help
Simon Glasse27d7df2023-09-14 10:55:55 -0600934 Note: These scripts have been replaced by Standard Boot. Do not use
935 them on new boards. See 'Migrating from distro_boot' at
936 doc/develop/bootstd.rst
937
Simon Glassf111bf72023-03-24 16:58:11 -0400938 Select this to enable various options and commands which are suitable
939 for building u-boot for booting general purpose Linux distributions.
940
Simon Glassd02ddcf2020-09-10 20:21:14 -0600941menu "Boot timing"
942
943config BOOTSTAGE
944 bool "Boot timing and reporting"
945 help
946 Enable recording of boot time while booting. To use it, insert
947 calls to bootstage_mark() with a suitable BOOTSTAGE_ID from
948 bootstage.h. Only a single entry is recorded for each ID. You can
949 give the entry a name with bootstage_mark_name(). You can also
950 record elapsed time in a particular stage using bootstage_start()
951 before starting and bootstage_accum() when finished. Bootstage will
952 add up all the accumulated time and report it.
953
954 Normally, IDs are defined in bootstage.h but a small number of
955 additional 'user' IDs can be used by passing BOOTSTAGE_ID_ALLOC
956 as the ID.
957
958 Calls to show_boot_progress() will also result in log entries but
959 these will not have names.
960
961config SPL_BOOTSTAGE
962 bool "Boot timing and reported in SPL"
Tom Rini0a83cc22022-06-10 23:03:09 -0400963 depends on BOOTSTAGE && SPL
Simon Glassd02ddcf2020-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 SPL finishes and load it when U-Boot proper starts
968 up.
969
970config TPL_BOOTSTAGE
971 bool "Boot timing and reported in TPL"
Tom Rini36a4ca02022-06-08 08:24:39 -0400972 depends on BOOTSTAGE && TPL
Simon Glassd02ddcf2020-09-10 20:21:14 -0600973 help
974 Enable recording of boot time in SPL. To make this visible to U-Boot
975 proper, enable BOOTSTAGE_STASH as well. This will stash the timing
976 information when TPL finishes and load it when U-Boot proper starts
977 up.
978
979config BOOTSTAGE_REPORT
980 bool "Display a detailed boot timing report before booting the OS"
981 depends on BOOTSTAGE
982 help
983 Enable output of a boot time report just before the OS is booted.
984 This shows how long it took U-Boot to go through each stage of the
985 boot process. The report looks something like this:
986
987 Timer summary in microseconds:
988 Mark Elapsed Stage
989 0 0 reset
990 3,575,678 3,575,678 board_init_f start
991 3,575,695 17 arch_cpu_init A9
992 3,575,777 82 arch_cpu_init done
993 3,659,598 83,821 board_init_r start
994 3,910,375 250,777 main_loop
995 29,916,167 26,005,792 bootm_start
996 30,361,327 445,160 start_kernel
997
998config BOOTSTAGE_RECORD_COUNT
999 int "Number of boot stage records to store"
Simon Glass051ddfb2021-02-03 06:00:49 -07001000 depends on BOOTSTAGE
Simon Glassd02ddcf2020-09-10 20:21:14 -06001001 default 30
1002 help
1003 This is the size of the bootstage record list and is the maximum
1004 number of bootstage records that can be recorded.
1005
1006config SPL_BOOTSTAGE_RECORD_COUNT
1007 int "Number of boot stage records to store for SPL"
Simon Glass051ddfb2021-02-03 06:00:49 -07001008 depends on SPL_BOOTSTAGE
Simon Glassd02ddcf2020-09-10 20:21:14 -06001009 default 5
1010 help
1011 This is the size of the bootstage record list and is the maximum
1012 number of bootstage records that can be recorded.
1013
1014config TPL_BOOTSTAGE_RECORD_COUNT
1015 int "Number of boot stage records to store for TPL"
Simon Glass051ddfb2021-02-03 06:00:49 -07001016 depends on TPL_BOOTSTAGE
Simon Glassd02ddcf2020-09-10 20:21:14 -06001017 default 5
1018 help
1019 This is the size of the bootstage record list and is the maximum
1020 number of bootstage records that can be recorded.
1021
1022config BOOTSTAGE_FDT
1023 bool "Store boot timing information in the OS device tree"
1024 depends on BOOTSTAGE
1025 help
1026 Stash the bootstage information in the FDT. A root 'bootstage'
1027 node is created with each bootstage id as a child. Each child
1028 has a 'name' property and either 'mark' containing the
1029 mark time in microseconds, or 'accum' containing the
1030 accumulated time for that bootstage id in microseconds.
1031 For example:
1032
1033 bootstage {
1034 154 {
1035 name = "board_init_f";
1036 mark = <3575678>;
1037 };
1038 170 {
1039 name = "lcd";
1040 accum = <33482>;
1041 };
1042 };
1043
1044 Code in the Linux kernel can find this in /proc/devicetree.
1045
1046config BOOTSTAGE_STASH
1047 bool "Stash the boot timing information in memory before booting OS"
1048 depends on BOOTSTAGE
1049 help
1050 Some OSes do not support device tree. Bootstage can instead write
1051 the boot timing information in a binary format at a given address.
1052 This happens through a call to bootstage_stash(), typically in
1053 the CPU's cleanup_before_linux() function. You can use the
1054 'bootstage stash' and 'bootstage unstash' commands to do this on
1055 the command line.
1056
1057config BOOTSTAGE_STASH_ADDR
1058 hex "Address to stash boot timing information"
Tom Rinid78c9bd2024-07-15 12:42:00 +01001059 depends on BOOTSTAGE_STASH
1060 default 0xC3000000 if STM32MP13X || STM32MP15X
1061 default 0x87000000 if STM32MP25X
1062 default 0x0 if SANDBOX
Simon Glassd02ddcf2020-09-10 20:21:14 -06001063 help
1064 Provide an address which will not be overwritten by the OS when it
1065 starts, so that it can read this information when ready.
1066
1067config BOOTSTAGE_STASH_SIZE
1068 hex "Size of boot timing stash region"
Tom Rinid78c9bd2024-07-15 12:42:00 +01001069 depends on BOOTSTAGE_STASH
Simon Glassd02ddcf2020-09-10 20:21:14 -06001070 default 0x1000
1071 help
1072 This should be large enough to hold the bootstage stash. A value of
1073 4096 (4KiB) is normally plenty.
1074
1075config SHOW_BOOT_PROGRESS
1076 bool "Show boot progress in a board-specific manner"
1077 help
1078 Defining this option allows to add some board-specific code (calling
1079 a user-provided function show_boot_progress(int) that enables you to
1080 show the system's boot progress on some display (for example, some
1081 LEDs) on your board. At the moment, the following checkpoints are
1082 implemented:
1083
1084 Legacy uImage format:
1085
1086 Arg Where When
1087 1 common/cmd_bootm.c before attempting to boot an image
1088 -1 common/cmd_bootm.c Image header has bad magic number
1089 2 common/cmd_bootm.c Image header has correct magic number
1090 -2 common/cmd_bootm.c Image header has bad checksum
1091 3 common/cmd_bootm.c Image header has correct checksum
1092 -3 common/cmd_bootm.c Image data has bad checksum
1093 4 common/cmd_bootm.c Image data has correct checksum
1094 -4 common/cmd_bootm.c Image is for unsupported architecture
1095 5 common/cmd_bootm.c Architecture check OK
1096 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
1097 6 common/cmd_bootm.c Image Type check OK
1098 -6 common/cmd_bootm.c gunzip uncompression error
1099 -7 common/cmd_bootm.c Unimplemented compression type
1100 7 common/cmd_bootm.c Uncompression OK
1101 8 common/cmd_bootm.c No uncompress/copy overwrite error
1102 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
1103
1104 9 common/image.c Start initial ramdisk verification
1105 -10 common/image.c Ramdisk header has bad magic number
1106 -11 common/image.c Ramdisk header has bad checksum
1107 10 common/image.c Ramdisk header is OK
1108 -12 common/image.c Ramdisk data has bad checksum
1109 11 common/image.c Ramdisk data has correct checksum
1110 12 common/image.c Ramdisk verification complete, start loading
1111 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
1112 13 common/image.c Start multifile image verification
1113 14 common/image.c No initial ramdisk, no multifile, continue.
1114
1115 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
1116
1117 -30 arch/powerpc/lib/board.c Fatal error, hang the system
1118 -31 post/post.c POST test failed, detected by post_output_backlog()
1119 -32 post/post.c POST test failed, detected by post_run_single()
1120
1121 34 common/cmd_doc.c before loading a Image from a DOC device
1122 -35 common/cmd_doc.c Bad usage of "doc" command
1123 35 common/cmd_doc.c correct usage of "doc" command
1124 -36 common/cmd_doc.c No boot device
1125 36 common/cmd_doc.c correct boot device
1126 -37 common/cmd_doc.c Unknown Chip ID on boot device
1127 37 common/cmd_doc.c correct chip ID found, device available
1128 -38 common/cmd_doc.c Read Error on boot device
1129 38 common/cmd_doc.c reading Image header from DOC device OK
1130 -39 common/cmd_doc.c Image header has bad magic number
1131 39 common/cmd_doc.c Image header has correct magic number
1132 -40 common/cmd_doc.c Error reading Image from DOC device
1133 40 common/cmd_doc.c Image header has correct magic number
1134 41 common/cmd_ide.c before loading a Image from a IDE device
1135 -42 common/cmd_ide.c Bad usage of "ide" command
1136 42 common/cmd_ide.c correct usage of "ide" command
1137 -43 common/cmd_ide.c No boot device
1138 43 common/cmd_ide.c boot device found
1139 -44 common/cmd_ide.c Device not available
1140 44 common/cmd_ide.c Device available
1141 -45 common/cmd_ide.c wrong partition selected
1142 45 common/cmd_ide.c partition selected
1143 -46 common/cmd_ide.c Unknown partition table
1144 46 common/cmd_ide.c valid partition table found
1145 -47 common/cmd_ide.c Invalid partition type
1146 47 common/cmd_ide.c correct partition type
1147 -48 common/cmd_ide.c Error reading Image Header on boot device
1148 48 common/cmd_ide.c reading Image Header from IDE device OK
1149 -49 common/cmd_ide.c Image header has bad magic number
1150 49 common/cmd_ide.c Image header has correct magic number
1151 -50 common/cmd_ide.c Image header has bad checksum
1152 50 common/cmd_ide.c Image header has correct checksum
1153 -51 common/cmd_ide.c Error reading Image from IDE device
1154 51 common/cmd_ide.c reading Image from IDE device OK
1155 52 common/cmd_nand.c before loading a Image from a NAND device
1156 -53 common/cmd_nand.c Bad usage of "nand" command
1157 53 common/cmd_nand.c correct usage of "nand" command
1158 -54 common/cmd_nand.c No boot device
1159 54 common/cmd_nand.c boot device found
1160 -55 common/cmd_nand.c Unknown Chip ID on boot device
1161 55 common/cmd_nand.c correct chip ID found, device available
1162 -56 common/cmd_nand.c Error reading Image Header on boot device
1163 56 common/cmd_nand.c reading Image Header from NAND device OK
1164 -57 common/cmd_nand.c Image header has bad magic number
1165 57 common/cmd_nand.c Image header has correct magic number
1166 -58 common/cmd_nand.c Error reading Image from NAND device
1167 58 common/cmd_nand.c reading Image from NAND device OK
1168
1169 -60 common/env_common.c Environment has a bad CRC, using default
1170
1171 64 net/eth.c starting with Ethernet configuration.
1172 -64 net/eth.c no Ethernet found.
1173 65 net/eth.c Ethernet found.
1174
1175 -80 common/cmd_net.c usage wrong
1176 80 common/cmd_net.c before calling net_loop()
1177 -81 common/cmd_net.c some error in net_loop() occurred
1178 81 common/cmd_net.c net_loop() back without error
1179 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
1180 82 common/cmd_net.c trying automatic boot
1181 83 common/cmd_net.c running "source" command
1182 -83 common/cmd_net.c some error in automatic boot or "source" command
1183 84 common/cmd_net.c end without errors
1184
1185 FIT uImage format:
1186
1187 Arg Where When
1188 100 common/cmd_bootm.c Kernel FIT Image has correct format
1189 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
1190 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
1191 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
1192 102 common/cmd_bootm.c Kernel unit name specified
1193 -103 common/cmd_bootm.c Can't get kernel subimage node offset
1194 103 common/cmd_bootm.c Found configuration node
1195 104 common/cmd_bootm.c Got kernel subimage node offset
1196 -104 common/cmd_bootm.c Kernel subimage hash verification failed
1197 105 common/cmd_bootm.c Kernel subimage hash verification OK
1198 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
1199 106 common/cmd_bootm.c Architecture check OK
1200 -106 common/cmd_bootm.c Kernel subimage has wrong type
1201 107 common/cmd_bootm.c Kernel subimage type OK
1202 -107 common/cmd_bootm.c Can't get kernel subimage data/size
1203 108 common/cmd_bootm.c Got kernel subimage data/size
1204 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
1205 -109 common/cmd_bootm.c Can't get kernel subimage type
1206 -110 common/cmd_bootm.c Can't get kernel subimage comp
1207 -111 common/cmd_bootm.c Can't get kernel subimage os
1208 -112 common/cmd_bootm.c Can't get kernel subimage load address
1209 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
1210
1211 120 common/image.c Start initial ramdisk verification
1212 -120 common/image.c Ramdisk FIT image has incorrect format
1213 121 common/image.c Ramdisk FIT image has correct format
1214 122 common/image.c No ramdisk subimage unit name, using configuration
1215 -122 common/image.c Can't get configuration for ramdisk subimage
1216 123 common/image.c Ramdisk unit name specified
1217 -124 common/image.c Can't get ramdisk subimage node offset
1218 125 common/image.c Got ramdisk subimage node offset
1219 -125 common/image.c Ramdisk subimage hash verification failed
1220 126 common/image.c Ramdisk subimage hash verification OK
1221 -126 common/image.c Ramdisk subimage for unsupported architecture
1222 127 common/image.c Architecture check OK
1223 -127 common/image.c Can't get ramdisk subimage data/size
1224 128 common/image.c Got ramdisk subimage data/size
1225 129 common/image.c Can't get ramdisk load address
1226 -129 common/image.c Got ramdisk load address
1227
1228 -130 common/cmd_doc.c Incorrect FIT image format
1229 131 common/cmd_doc.c FIT image format OK
1230
1231 -140 common/cmd_ide.c Incorrect FIT image format
1232 141 common/cmd_ide.c FIT image format OK
1233
1234 -150 common/cmd_nand.c Incorrect FIT image format
1235 151 common/cmd_nand.c FIT image format OK
1236
Marek Vasut98154342021-10-23 03:06:03 +02001237config SPL_SHOW_BOOT_PROGRESS
Jan Kiszka5780edb2021-11-03 15:09:36 +01001238 bool "Show boot progress in a board-specific manner in SPL"
Marek Vasut98154342021-10-23 03:06:03 +02001239 depends on SPL
1240 help
1241 Defining this option allows to add some board-specific code (calling
1242 a user-provided function show_boot_progress(int) that enables you to
1243 show the system's boot progress on some display (for example, some
1244 LEDs) on your board. For details see SHOW_BOOT_PROGRESS.
1245
Simon Glassd02ddcf2020-09-10 20:21:14 -06001246endmenu
1247
Simon Glasseebed782020-09-10 20:21:15 -06001248menu "Boot media"
1249
1250config NOR_BOOT
1251 bool "Support for booting from NOR flash"
1252 depends on NOR
1253 help
1254 Enabling this will make a U-Boot binary that is capable of being
1255 booted via NOR. In this case we will enable certain pinmux early
1256 as the ROM only partially sets up pinmux. We also default to using
1257 NOR for environment.
1258
1259config NAND_BOOT
1260 bool "Support for booting from NAND flash"
Simon Glasseebed782020-09-10 20:21:15 -06001261 imply MTD_RAW_NAND
1262 help
1263 Enabling this will make a U-Boot binary that is capable of being
1264 booted via NAND flash. This is not a must, some SoCs need this,
1265 some not.
1266
1267config ONENAND_BOOT
1268 bool "Support for booting from ONENAND"
Simon Glasseebed782020-09-10 20:21:15 -06001269 imply MTD_RAW_NAND
1270 help
1271 Enabling this will make a U-Boot binary that is capable of being
1272 booted via ONENAND. This is not a must, some SoCs need this,
1273 some not.
1274
1275config QSPI_BOOT
1276 bool "Support for booting from QSPI flash"
Simon Glasseebed782020-09-10 20:21:15 -06001277 help
1278 Enabling this will make a U-Boot binary that is capable of being
1279 booted via QSPI flash. This is not a must, some SoCs need this,
1280 some not.
1281
1282config SATA_BOOT
1283 bool "Support for booting from SATA"
Simon Glasseebed782020-09-10 20:21:15 -06001284 help
1285 Enabling this will make a U-Boot binary that is capable of being
1286 booted via SATA. This is not a must, some SoCs need this,
1287 some not.
1288
1289config SD_BOOT
1290 bool "Support for booting from SD/EMMC"
Simon Glasseebed782020-09-10 20:21:15 -06001291 help
1292 Enabling this will make a U-Boot binary that is capable of being
1293 booted via SD/EMMC. This is not a must, some SoCs need this,
1294 some not.
1295
Tom Rinia43bf4e2021-12-11 14:55:50 -05001296config SD_BOOT_QSPI
1297 bool "Support for booting from SD/EMMC and enable QSPI"
1298 help
1299 Enabling this will make a U-Boot binary that is capable of being
1300 booted via SD/EMMC while enabling QSPI on the platform as well. This
1301 is not a must, some SoCs need this, some not.
1302
Simon Glasseebed782020-09-10 20:21:15 -06001303config SPI_BOOT
1304 bool "Support for booting from SPI flash"
Simon Glasseebed782020-09-10 20:21:15 -06001305 help
1306 Enabling this will make a U-Boot binary that is capable of being
1307 booted via SPI flash. This is not a must, some SoCs need this,
1308 some not.
1309
1310endmenu
1311
Simon Glasse9d54d72020-09-10 20:21:16 -06001312menu "Autoboot options"
1313
1314config AUTOBOOT
1315 bool "Autoboot"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001316 depends on CMDLINE
Simon Glasse9d54d72020-09-10 20:21:16 -06001317 default y
1318 help
1319 This enables the autoboot. See doc/README.autoboot for detail.
1320
Simon Glass7dee9dc2023-10-26 14:31:22 -04001321if AUTOBOOT
1322
Simon Glass1b6cbaa2020-09-10 20:21:17 -06001323config BOOTDELAY
1324 int "delay in seconds before automatically booting"
1325 default 2
Simon Glass1b6cbaa2020-09-10 20:21:17 -06001326 help
1327 Delay before automatically running bootcmd;
1328 set to 0 to autoboot with no delay, but you can stop it by key input.
1329 set to -1 to disable autoboot.
1330 set to -2 to autoboot with no delay and not check for abort
1331
1332 If this value is >= 0 then it is also used for the default delay
1333 before starting the default entry in bootmenu. If it is < 0 then
1334 a default value of 10s is used.
1335
1336 See doc/README.autoboot for details.
1337
Simon Glasse9d54d72020-09-10 20:21:16 -06001338config AUTOBOOT_KEYED
1339 bool "Stop autobooting via specific input key / string"
Simon Glasse9d54d72020-09-10 20:21:16 -06001340 help
1341 This option enables stopping (aborting) of the automatic
1342 boot feature only by issuing a specific input key or
1343 string. If not enabled, any input key will abort the
1344 U-Boot automatic booting process and bring the device
1345 to the U-Boot prompt for user input.
1346
Simon Glass7dee9dc2023-10-26 14:31:22 -04001347if AUTOBOOT_KEYED
1348
Steffen Jaeckeldfc97322021-07-08 15:57:38 +02001349config AUTOBOOT_FLUSH_STDIN
1350 bool "Enable flushing stdin before starting to read the password"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001351 depends on !SANDBOX
Steffen Jaeckeldfc97322021-07-08 15:57:38 +02001352 help
1353 When this option is enabled stdin buffer will be flushed before
1354 starting to read the password.
1355 This can't be enabled for the sandbox as flushing stdin would
1356 break the autoboot unit tests.
1357
Simon Glasse9d54d72020-09-10 20:21:16 -06001358config AUTOBOOT_PROMPT
1359 string "Autoboot stop prompt"
Simon Glasse9d54d72020-09-10 20:21:16 -06001360 default "Autoboot in %d seconds\\n"
1361 help
1362 This string is displayed before the boot delay selected by
1363 CONFIG_BOOTDELAY starts. If it is not defined there is no
1364 output indicating that autoboot is in progress.
1365
1366 Note that this define is used as the (only) argument to a
1367 printf() call, so it may contain '%' format specifications,
Quentin Schulzc0a7ae02024-06-12 16:58:47 +02001368 provided that it also includes, separated by commas exactly
Simon Glasse9d54d72020-09-10 20:21:16 -06001369 like in a printf statement, the required arguments. It is
1370 the responsibility of the user to select only such arguments
1371 that are valid in the given context.
1372
1373config AUTOBOOT_ENCRYPTION
1374 bool "Enable encryption in autoboot stopping"
Simon Glasse9d54d72020-09-10 20:21:16 -06001375 help
1376 This option allows a string to be entered into U-Boot to stop the
Steffen Jaeckel6aa6bfb2021-07-08 15:57:35 +02001377 autoboot.
1378 The behavior depends whether CONFIG_CRYPT_PW from lib is enabled
1379 or not.
1380 In case CONFIG_CRYPT_PW is enabled, the string will be forwarded
1381 to the crypt-based functionality and be compared against the
1382 string in the environment variable 'bootstopkeycrypt'.
1383 In case CONFIG_CRYPT_PW is disabled the string itself is hashed
1384 and compared against the hash in the environment variable
1385 'bootstopkeysha256'.
1386 If it matches in either case then boot stops and
1387 a command-line prompt is presented.
Simon Glasse9d54d72020-09-10 20:21:16 -06001388 This provides a way to ship a secure production device which can also
1389 be accessed at the U-Boot command line.
1390
Steffen Jaeckel28be70d2021-07-08 15:57:39 +02001391config AUTOBOOT_SHA256_FALLBACK
1392 bool "Allow fallback from crypt-hashed password to sha256"
1393 depends on AUTOBOOT_ENCRYPTION && CRYPT_PW
1394 help
1395 This option adds support to fall back from crypt-hashed
1396 passwords to checking a SHA256 hashed password in case the
1397 'bootstopusesha256' environment variable is set to 'true'.
1398
Simon Glasse9d54d72020-09-10 20:21:16 -06001399config AUTOBOOT_DELAY_STR
1400 string "Delay autobooting via specific input key / string"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001401 depends on !AUTOBOOT_ENCRYPTION
Simon Glasse9d54d72020-09-10 20:21:16 -06001402 help
1403 This option delays the automatic boot feature by issuing
1404 a specific input key or string. If CONFIG_AUTOBOOT_DELAY_STR
1405 or the environment variable "bootdelaykey" is specified
1406 and this string is received from console input before
1407 autoboot starts booting, U-Boot gives a command prompt. The
1408 U-Boot prompt will time out if CONFIG_BOOT_RETRY_TIME is
1409 used, otherwise it never times out.
1410
1411config AUTOBOOT_STOP_STR
1412 string "Stop autobooting via specific input key / string"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001413 depends on !AUTOBOOT_ENCRYPTION
Simon Glasse9d54d72020-09-10 20:21:16 -06001414 help
1415 This option enables stopping (aborting) of the automatic
1416 boot feature only by issuing a specific input key or
1417 string. If CONFIG_AUTOBOOT_STOP_STR or the environment
1418 variable "bootstopkey" is specified and this string is
1419 received from console input before autoboot starts booting,
1420 U-Boot gives a command prompt. The U-Boot prompt never
1421 times out, even if CONFIG_BOOT_RETRY_TIME is used.
1422
1423config AUTOBOOT_KEYED_CTRLC
1424 bool "Enable Ctrl-C autoboot interruption"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001425 depends on !AUTOBOOT_ENCRYPTION
Simon Glasse9d54d72020-09-10 20:21:16 -06001426 help
1427 This option allows for the boot sequence to be interrupted
1428 by ctrl-c, in addition to the "bootdelaykey" and "bootstopkey".
1429 Setting this variable provides an escape sequence from the
1430 limited "password" strings.
1431
Steffen Jaeckel792a13f2021-07-08 15:57:37 +02001432config AUTOBOOT_NEVER_TIMEOUT
1433 bool "Make the password entry never time-out"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001434 depends on AUTOBOOT_ENCRYPTION && CRYPT_PW
Steffen Jaeckel792a13f2021-07-08 15:57:37 +02001435 help
1436 This option removes the timeout from the password entry
1437 when the user first presses the <Enter> key before entering
1438 any other character.
1439
Steffen Jaeckel6aa6bfb2021-07-08 15:57:35 +02001440config AUTOBOOT_STOP_STR_ENABLE
1441 bool "Enable fixed string to stop autobooting"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001442 depends on AUTOBOOT_ENCRYPTION
Steffen Jaeckel6aa6bfb2021-07-08 15:57:35 +02001443 help
1444 This option enables the feature to add a fixed stop
1445 string that is defined at compile time.
1446 In every case it will be tried to load the stop
1447 string from the environment.
1448 In case this is enabled and there is no stop string
1449 in the environment, this will be used as default value.
1450
1451config AUTOBOOT_STOP_STR_CRYPT
1452 string "Stop autobooting via crypt-hashed password"
1453 depends on AUTOBOOT_STOP_STR_ENABLE && CRYPT_PW
1454 help
1455 This option adds the feature to only stop the autobooting,
1456 and therefore boot into the U-Boot prompt, when the input
1457 string / password matches a values that is hashed via
1458 one of the supported crypt-style password hashing options
1459 and saved in the environment variable "bootstopkeycrypt".
1460
Simon Glasse9d54d72020-09-10 20:21:16 -06001461config AUTOBOOT_STOP_STR_SHA256
Steffen Jaeckele1788f92021-07-08 15:57:40 +02001462 string "Stop autobooting via SHA256 hashed password"
Steffen Jaeckel6aa6bfb2021-07-08 15:57:35 +02001463 depends on AUTOBOOT_STOP_STR_ENABLE
Simon Glasse9d54d72020-09-10 20:21:16 -06001464 help
1465 This option adds the feature to only stop the autobooting,
1466 and therefore boot into the U-Boot prompt, when the input
Quentin Schulzc0a7ae02024-06-12 16:58:47 +02001467 string / password matches a values that is encrypted via
Joel Peshkin8b7bf532020-11-21 17:18:59 -08001468 a SHA256 hash and saved in the environment variable
1469 "bootstopkeysha256". If the value in that variable
1470 includes a ":", the portion prior to the ":" will be treated
1471 as a salt value.
Simon Glasse9d54d72020-09-10 20:21:16 -06001472
Simon Glass7dee9dc2023-10-26 14:31:22 -04001473endif # AUTOBOOT_KEYED
1474
1475if !AUTOBOOT_KEYED
1476
Simon Glasse9d54d72020-09-10 20:21:16 -06001477config AUTOBOOT_USE_MENUKEY
1478 bool "Allow a specify key to run a menu from the environment"
Simon Glasse9d54d72020-09-10 20:21:16 -06001479 help
1480 If a specific key is pressed to stop autoboot, then the commands in
1481 the environment variable 'menucmd' are executed before boot starts.
1482
1483config AUTOBOOT_MENUKEY
1484 int "ASCII value of boot key to show a menu"
1485 default 0
1486 depends on AUTOBOOT_USE_MENUKEY
1487 help
1488 If this key is pressed to stop autoboot, then the commands in the
1489 environment variable 'menucmd' will be executed before boot starts.
1490 For example, 33 means "!" in ASCII, so pressing ! at boot would take
1491 this action.
1492
Simon Glass7dee9dc2023-10-26 14:31:22 -04001493endif
1494
1495endif # AUTOBOOT
1496
Simon Glasse9d54d72020-09-10 20:21:16 -06001497config AUTOBOOT_MENU_SHOW
1498 bool "Show a menu on boot"
1499 depends on CMD_BOOTMENU
1500 help
1501 This enables the boot menu, controlled by environment variables
1502 defined by the board. The menu starts after running the 'preboot'
1503 environmnent variable (if enabled) and before handling the boot delay.
Peter Robinson16e0b8f2023-08-18 15:54:10 +01001504 See doc/usage/cmd/bootmenu.rst for more details.
Simon Glasse9d54d72020-09-10 20:21:16 -06001505
Masahisa Kojima97cbcc42022-05-26 19:09:38 +09001506config BOOTMENU_DISABLE_UBOOT_CONSOLE
1507 bool "Disallow bootmenu to enter the U-Boot console"
1508 depends on AUTOBOOT_MENU_SHOW
1509 help
1510 If this option is enabled, user can not enter the U-Boot console from
1511 bootmenu. It increases the system security.
1512
Tom Rinia45a3ef2022-03-11 09:12:04 -05001513config BOOT_RETRY
1514 bool "Boot retry feature"
1515 help
1516 Allow for having the U-Boot command prompt time out and attempt
1517 to boot again. If the environment variable "bootretry" is found then
1518 its value is used, otherwise the retry timeout is
1519 CONFIG_BOOT_RETRY_TIME. CONFIG_BOOT_RETRY_MIN is optional and
1520 defaults to CONFIG_BOOT_RETRY_TIME. All times are in seconds.
1521
1522config BOOT_RETRY_TIME
1523 int "Timeout in seconds before attempting to boot again"
1524 depends on BOOT_RETRY
1525 help
1526 Time in seconds before the U-Boot prompt will timeout and boot will
1527 be attempted again.
1528
1529config BOOT_RETRY_MIN
1530 int "Minimum timeout in seconds for 'bootretry'"
1531 depends on BOOT_RETRY
1532 default BOOT_RETRY_TIME
1533 help
1534 The minimum time in seconds that "bootretry" can be set to.
1535
1536config RESET_TO_RETRY
1537 bool "Reset the board to retry autoboot"
1538 depends on BOOT_RETRY
1539 help
1540 After the countdown timed out, the board will be reset to restart
1541 again.
1542
Simon Glasse9d54d72020-09-10 20:21:16 -06001543endmenu
1544
Philippe Reynesd28484e2022-03-28 22:56:59 +02001545menu "Image support"
1546
1547config IMAGE_PRE_LOAD
1548 bool "Image pre-load support"
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 SPL_IMAGE_PRE_LOAD
1556 bool "Image pre-load support within SPL"
1557 depends on SPL && IMAGE_PRE_LOAD
1558 help
1559 Enable an image pre-load stage in the SPL.
1560 This pre-load stage allows to do some manipulation
1561 or check (for example signature check) on an image
1562 before launching it.
1563
1564config IMAGE_PRE_LOAD_SIG
1565 bool "Image pre-load signature support"
1566 depends on IMAGE_PRE_LOAD
1567 select FIT_SIGNATURE
1568 select RSA
1569 select RSA_VERIFY_WITH_PKEY
1570 help
1571 Enable signature check support in the pre-load stage.
1572 For this feature a very simple header is added before
1573 the image with few fields:
1574 - a magic
1575 - the image size
1576 - the signature
1577 All other information (header size, type of signature,
1578 ...) are provided in the node /image/pre-load/sig of
1579 u-boot.
1580
1581config SPL_IMAGE_PRE_LOAD_SIG
1582 bool "Image pre-load signature support witin SPL"
1583 depends on SPL_IMAGE_PRE_LOAD && IMAGE_PRE_LOAD_SIG
1584 select SPL_FIT_SIGNATURE
1585 select SPL_RSA
1586 select SPL_RSA_VERIFY_WITH_PKEY
1587 help
1588 Enable signature check support in the pre-load stage in the SPL.
1589 For this feature a very simple header is added before
1590 the image with few fields:
1591 - a magic
1592 - the image size
1593 - the signature
1594 All other information (header size, type of signature,
1595 ...) are provided in the node /image/pre-load/sig of
1596 u-boot.
1597
1598endmenu
1599
Simon Glass27367192023-09-14 10:55:46 -06001600if OF_LIBFDT
1601
1602menu "Devicetree fixup"
1603
Matthias Schiffere908fec2023-12-11 12:03:17 +01001604config OF_ENV_SETUP
1605 bool "Run a command from environment to set up device tree before boot"
1606 depends on CMD_FDT
1607 help
1608 This causes U-Boot to run a command from the environment variable
1609 fdt_fixup before booting into the operating system, which can use the
1610 fdt command to modify the device tree. The device tree is then passed
1611 to the OS.
1612
Simon Glass48e6d3d2023-09-14 10:55:47 -06001613config OF_BOARD_SETUP
1614 bool "Set up board-specific details in device tree before boot"
1615 help
1616 This causes U-Boot to call ft_board_setup() before booting into
1617 the Operating System. This function can set up various
1618 board-specific information in the device tree for use by the OS.
1619 The device tree is then passed to the OS.
1620
1621config OF_SYSTEM_SETUP
1622 bool "Set up system-specific details in device tree before boot"
1623 help
1624 This causes U-Boot to call ft_system_setup() before booting into
1625 the Operating System. This function can set up various
1626 system-specific information in the device tree for use by the OS.
1627 The device tree is then passed to the OS.
1628
1629config OF_STDOUT_VIA_ALIAS
1630 bool "Update the device-tree stdout alias from U-Boot"
1631 help
1632 This uses U-Boot's serial alias from the aliases node to update
1633 the device tree passed to the OS. The "linux,stdout-path" property
1634 in the chosen node is set to point to the correct serial node.
1635 This option currently references CONFIG_CONS_INDEX, which is
1636 incorrect when used with device tree as this option does not
1637 exist / should not be used.
1638
Simon Glassb7b7f162023-09-14 10:55:57 -06001639config FDT_FIXUP_PARTITIONS
Simon Glass1a5bcc12023-09-14 10:55:58 -06001640 bool "Overwrite MTD partitions in DTS through defined in 'mtdparts'"
Simon Glassb7b7f162023-09-14 10:55:57 -06001641 help
1642 Allow overwriting defined partitions in the device tree blob
1643 using partition info defined in the 'mtdparts' environment
1644 variable.
1645
Simon Glass27367192023-09-14 10:55:46 -06001646config FDT_SIMPLEFB
1647 bool "FDT tools for simplefb support"
1648 help
1649 Enable the fdt tools to manage the simple fb nodes in device tree.
1650 These functions can be used by board to indicate to the OS
1651 the presence of the simple frame buffer with associated reserved
1652 memory
1653
Simon Glass624c0e52023-09-14 10:55:59 -06001654config ARCH_FIXUP_FDT_MEMORY
1655 bool "Enable arch_fixup_memory_banks() call"
1656 default y
1657 help
1658 Enable FDT memory map syncup before OS boot. This feature can be
1659 used for booting OS with different memory setup where the part of
1660 the memory location should be used for different purpose.
1661
Simon Glass27367192023-09-14 10:55:46 -06001662endmenu
1663
1664endif # OF_LIBFDT
1665
Simon Glass5e958642020-09-10 20:21:18 -06001666config USE_BOOTARGS
1667 bool "Enable boot arguments"
1668 help
1669 Provide boot arguments to bootm command. Boot arguments are specified
1670 in CONFIG_BOOTARGS option. Enable this option to be able to specify
1671 CONFIG_BOOTARGS string. If this option is disabled, CONFIG_BOOTARGS
1672 will be undefined and won't take any space in U-Boot image.
1673
1674config BOOTARGS
1675 string "Boot arguments"
1676 depends on USE_BOOTARGS && !USE_DEFAULT_ENV_FILE
1677 help
1678 This can be used to pass arguments to the bootm command. The value of
1679 CONFIG_BOOTARGS goes into the environment value "bootargs". Note that
1680 this value will also override the "chosen" node in FDT blob.
1681
Simon Glass529e2082020-11-05 10:33:48 -07001682config BOOTARGS_SUBST
1683 bool "Support substituting strings in boot arguments"
1684 help
1685 This allows substituting string values in the boot arguments. These
1686 are applied after the commandline has been built.
1687
1688 One use for this is to insert the root-disk UUID into the command
1689 line where bootargs contains "root=${uuid}"
1690
1691 setenv bootargs "console= root=${uuid}"
1692 # Set the 'uuid' environment variable
1693 part uuid mmc 2:2 uuid
1694
1695 # Command-line substitution will put the real uuid into the
1696 # kernel command line
1697 bootm
1698
Simon Glass5e958642020-09-10 20:21:18 -06001699config USE_BOOTCOMMAND
1700 bool "Enable a default value for bootcmd"
Tom Rinidc3bf2d2023-10-26 14:31:28 -04001701 depends on CMDLINE
Simon Glass5e958642020-09-10 20:21:18 -06001702 help
1703 Provide a default value for the bootcmd entry in the environment. If
1704 autoboot is enabled this is what will be run automatically. Enable
1705 this option to be able to specify CONFIG_BOOTCOMMAND as a string. If
1706 this option is disabled, CONFIG_BOOTCOMMAND will be undefined and
1707 won't take any space in U-Boot image.
1708
1709config BOOTCOMMAND
1710 string "bootcmd value"
1711 depends on USE_BOOTCOMMAND && !USE_DEFAULT_ENV_FILE
Simon Glass2d5a8e12023-05-06 08:27:09 -06001712 default "bootflow scan -lb" if BOOTSTD_DEFAULTS && CMD_BOOTFLOW_FULL
1713 default "bootflow scan" if BOOTSTD_DEFAULTS && !CMD_BOOTFLOW_FULL
Simon Glassbe661cb2022-04-24 23:31:27 -06001714 default "run distro_bootcmd" if !BOOTSTD_BOOTCOMMAND && DISTRO_DEFAULTS
Simon Glass5e958642020-09-10 20:21:18 -06001715 help
1716 This is the string of commands that will be used as bootcmd and if
1717 AUTOBOOT is set, automatically run.
1718
1719config USE_PREBOOT
1720 bool "Enable preboot"
Tom Rinidc3bf2d2023-10-26 14:31:28 -04001721 depends on CMDLINE
Simon Glass5e958642020-09-10 20:21:18 -06001722 help
1723 When this option is enabled, the existence of the environment
1724 variable "preboot" will be checked immediately before starting the
1725 CONFIG_BOOTDELAY countdown and/or running the auto-boot command resp.
1726 entering interactive mode.
1727
1728 This feature is especially useful when "preboot" is automatically
1729 generated or modified. For example, the boot code can modify the
1730 "preboot" when a user holds down a certain combination of keys.
1731
1732config PREBOOT
1733 string "preboot default value"
1734 depends on USE_PREBOOT && !USE_DEFAULT_ENV_FILE
Patrick Delaunaybb15d402020-10-12 09:47:50 +02001735 default "usb start" if USB_KEYBOARD
Simon Glass5e958642020-09-10 20:21:18 -06001736 default ""
1737 help
1738 This is the default of "preboot" environment variable.
1739
Pali Rohár39c43c32022-07-10 13:42:55 +02001740config PREBOOT_DEFINED
1741 bool
1742 default y if PREBOOT != ""
1743
Simon Glassc10ddfd2020-09-10 20:21:20 -06001744config DEFAULT_FDT_FILE
1745 string "Default fdt file"
1746 help
1747 This option is used to set the default fdt file to boot OS.
1748
Dzmitry Sankouskia3463062022-02-22 21:49:52 +03001749config SAVE_PREV_BL_FDT_ADDR
1750 depends on ARM
1751 bool "Saves fdt address, passed by the previous bootloader, to env var"
1752 help
1753 When u-boot is used as a chain-loaded bootloader (replacing OS kernel),
1754 enable this option to save fdt address, passed by the
1755 previous bootloader for future use.
1756 Address is saved to `prevbl_fdt_addr` environment variable.
1757
1758 If no fdt was provided by previous bootloader, no env variables
1759 will be created.
1760
1761config SAVE_PREV_BL_INITRAMFS_START_ADDR
1762 depends on ARM
1763 bool "Saves initramfs address, passed by the previous bootloader, to env var"
1764 help
1765 When u-boot is used as a chain-loaded bootloader(replacing OS kernel),
1766 enable this option to save initramfs address, passed by the
1767 previous bootloader for future use.
1768 Address is saved to `prevbl_initrd_start_addr` environment variable.
1769
1770 If no initramfs was provided by previous bootloader, no env variables
1771 will be created.
1772
Simon Glassc8925112023-06-01 10:23:02 -06001773menu "Configuration editor"
1774
1775config CEDIT
1776 bool "Configuration editor"
Heinrich Schuchardtef97f7c2023-12-16 16:38:36 +01001777 depends on EXPO
Simon Glassc8925112023-06-01 10:23:02 -06001778 help
1779 Provides a way to deal with board configuration and present it to
1780 the user for adjustment.
1781
1782 This is intended to provide both graphical and text-based user
1783 interfaces, but only graphical is support at present.
1784
1785endmenu # Configuration editor
1786
Simon Glassb45b1632020-09-10 20:21:13 -06001787endmenu # Booting