blob: 7ac34574079a4e6c3820966d5407925661f1a733 [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 Glassbc3ec002024-08-07 16:47:31 -0600753 imply SPL_UPL if SPL
Simon Glass77459f42024-08-07 16:47:27 -0600754 help
755 Provides support for UPL payloads and handoff information. U-Boot
756 supports generating and accepting handoff information. The mkimage
757 tool will eventually support creating payloads.
758
759if UPL
760
761config UPL_READ
762 bool "upl - Support reading a Universal Payload handoff"
763 help
764 Provides support for decoding a UPL-format payload into a C structure
765 which can be used elsewhere in U-Boot. This is just the reading
Simon Glass45aec8e2024-08-07 16:47:34 -0600766 implementation, useful for trying it out. See UPL_IN for how
767 to tell U-Boot to actually read it on startup and use it for memory
768 and device information, etc.
Simon Glass77459f42024-08-07 16:47:27 -0600769
Simon Glassb9474a82024-08-07 16:47:28 -0600770config UPL_WRITE
771 bool "upl - Support writing a Universal Payload handoff"
772 help
773 Provides support for encoding a UPL-format payload from a C structure
774 so it can be passed to another program. This is just the writing
Simon Glassbc3ec002024-08-07 16:47:31 -0600775 implementation, useful for trying it out. See SPL_UPL_OUT
776 for how to tell U-Boot SPL to actually write it before jumping to
777 the next phase.
778
Simon Glass45aec8e2024-08-07 16:47:34 -0600779config UPL_IN
780 bool "upl - Read the UPL handoff on startup"
781 select UPL_READ
782 help
783 Read an SPL handoff when U-Boot starts and use it to provide
784 devices, memory layout, etc. required by U-Boot. This allows U-Boot
785 to function as a payload in the meaning of the specification.
786
Simon Glassbc3ec002024-08-07 16:47:31 -0600787if SPL
788
789config SPL_UPL
790 bool "Write a UPL handoff in SPL"
791 imply SPL_UPL_OUT
792 help
793 This tells SPL to write a UPL handoff and pass it to the next phase
794 (e.g. to U-Boot or another program which SPL loads and runs). THis
795 provides information to help that program run correctly and
796 efficiently on the machine.
797
798config SPL_UPL_WRITE
799 bool # upl - Support writing a Universal Payload handoff in SPL
800 select SPL_BLOBLIST
801 help
802 Provides support for encoding a UPL-format payload from a C structure
803 so it can be passed to another program. This is just the writing
Simon Glassb9474a82024-08-07 16:47:28 -0600804 implementation, useful for trying it out.
805
Simon Glassbc3ec002024-08-07 16:47:31 -0600806config SPL_UPL_OUT
807 bool "upl - Support writing a Universal Payload handoff in SPL"
808 select SPL_UPL_WRITE
809 help
810 Provides support for encoding a UPL-format payload and passing it to
811 the next firmware phase. This allows U-Boot SPL to function as
812 Platform Init in the meaning of the specification.
813
814endif # SPL
815
Simon Glass77459f42024-08-07 16:47:27 -0600816endif # UPL
817
Simon Glass6cfb0022023-09-14 10:55:53 -0600818endif # BOOTSTD
Simon Glassad8ec372022-04-24 23:31:13 -0600819
Simon Glassb45b1632020-09-10 20:21:13 -0600820config LEGACY_IMAGE_FORMAT
821 bool "Enable support for the legacy image format"
Andrew Davis98a22d02022-05-04 15:52:27 -0500822 default y if !FIT_SIGNATURE && !TI_SECURE_DEVICE
Simon Glassb45b1632020-09-10 20:21:13 -0600823 help
824 This option enables the legacy image format. It is enabled by
825 default for backward compatibility, unless FIT_SIGNATURE is
826 set where it is disabled so that unsigned images cannot be
827 loaded. If a board needs the legacy image format support in this
828 case, enable it here.
829
Eddie James32401ba2023-10-24 10:43:50 -0500830config MEASURED_BOOT
831 bool "Measure boot images and configuration when booting without EFI"
832 depends on HASH && TPM_V2
Ilias Apalodimas1e665f92024-06-23 14:48:18 +0300833 select SHA1
834 select SHA256
835 select SHA384
836 select SHA512
Eddie James32401ba2023-10-24 10:43:50 -0500837 help
838 This option enables measurement of the boot process when booting
839 without UEFI . Measurement involves creating cryptographic hashes
840 of the binary images that are booting and storing them in the TPM.
841 In addition, a log of these hashes is stored in memory for the OS
842 to verify the booted images and configuration. Enable this if the
843 OS has configured some memory area for the event log and you intend
844 to use some attestation tools on your system.
845
846if MEASURED_BOOT
847 config MEASURE_DEVICETREE
848 bool "Measure the devicetree image"
849 default y if MEASURED_BOOT
850 help
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200851 On some platforms, the Device Tree is not static as it may contain
Eddie James32401ba2023-10-24 10:43:50 -0500852 random MAC addresses or other such data that changes each boot.
853 Therefore, it should not be measured into the TPM. In that case,
854 disable the measurement here.
855
856 config MEASURE_IGNORE_LOG
857 bool "Ignore the existing event log"
Eddie James32401ba2023-10-24 10:43:50 -0500858 help
859 On platforms that use an event log memory region that persists
860 through system resets and are the first stage bootloader, then
861 this option should be enabled to ignore any existing data in the
862 event log memory region.
863endif # MEASURED_BOOT
864
Tom Riniec8d1602023-10-26 14:31:25 -0400865config SYS_BOOTM_LEN
866 hex "Maximum size of a decompresed OS image"
Tom Rini793921e2024-04-18 08:29:35 -0600867 depends on CMD_BOOTM || CMD_BOOTI || CMD_BOOTZ || \
Tom Riniec8d1602023-10-26 14:31:25 -0400868 LEGACY_IMAGE_FORMAT || SPL_LEGACY_IMAGE_FORMAT
869 default 0x4000000 if PPC || ARM64
870 default 0x1000000 if X86 || ARCH_MX6 || ARCH_MX7
871 default 0x800000
872 help
873 This is the maximum size of the buffer that is used to decompress the OS
874 image in to if attempting to boot a compressed image.
875
Simon Glassf11d6132020-09-10 20:21:19 -0600876config SUPPORT_RAW_INITRD
877 bool "Enable raw initrd images"
878 help
879 Note, defining the SUPPORT_RAW_INITRD allows user to supply
880 kernel with raw initrd images. The syntax is slightly different, the
881 address of the initrd must be augmented by it's size, in the following
882 format: "<initrd address>:<initrd size>".
883
Simon Glassd81f07f2020-11-04 09:57:35 -0700884config CHROMEOS
885 bool "Support booting Chrome OS"
886 help
887 Chrome OS requires U-Boot to set up a table indicating the boot mode
888 (e.g. Developer mode) and a few other things. Enable this if you are
889 booting on a Chromebook to avoid getting an error about an invalid
890 firmware ID.
891
892config CHROMEOS_VBOOT
893 bool "Support Chrome OS verified boot"
894 help
895 This is intended to enable the full Chrome OS verified boot support
896 in U-Boot. It is not actually implemented in the U-Boot source code
897 at present, so this option is always set to 'n'. It allows
898 distinguishing between booting Chrome OS in a basic way (developer
899 mode) and a full boot.
900
Tom Rinieb4f2de2022-06-25 11:02:44 -0400901config SYS_RAMBOOT
902 bool
903
Tom Rini9ff815a2021-08-24 23:11:49 -0400904config RAMBOOT_PBL
905 bool "Freescale PBL(pre-boot loader) image format support"
Tom Rinieb4f2de2022-06-25 11:02:44 -0400906 select SYS_RAMBOOT if PPC
Tom Rini9ff815a2021-08-24 23:11:49 -0400907 help
908 Some SoCs use PBL to load RCW and/or pre-initialization instructions.
909 For more details refer to doc/README.pblimage
910
Tom Rini886e6e32022-03-23 17:20:03 -0400911choice
Tom Rini489f4022022-12-28 10:52:51 -0500912 prompt "Freescale PBL (or predecessor) load location"
Tom Rini886e6e32022-03-23 17:20:03 -0400913 depends on RAMBOOT_PBL || ((TARGET_P1010RDB_PA || TARGET_P1010RDB_PB \
914 || TARGET_P1020RDB_PC || TARGET_P1020RDB_PD || TARGET_P2020RDB) \
Pali Rohár6763ff82024-06-06 18:33:26 +0200915 && !CMD_NAND) || (TARGET_TURRIS_1X && SYS_MPC85XX_NO_RESETVEC)
Tom Rini886e6e32022-03-23 17:20:03 -0400916
917config SDCARD
Tom Rini489f4022022-12-28 10:52:51 -0500918 bool "Freescale PBL (or similar) is found on SD card"
Tom Rini886e6e32022-03-23 17:20:03 -0400919
920config SPIFLASH
Tom Rini489f4022022-12-28 10:52:51 -0500921 bool "Freescale PBL (or similar) is found on SPI flash"
922
923config NO_PBL
924 bool "Freescale PBL (or similar) is not used in this case"
Tom Rini886e6e32022-03-23 17:20:03 -0400925
926endchoice
927
Tom Rini5989fd42022-06-20 08:07:42 -0400928config FSL_FIXED_MMC_LOCATION
929 bool "PBL MMC is at a fixed location"
930 depends on SDCARD && !RAMBOOT_PBL
931
932config ESDHC_HC_BLK_ADDR
933 def_bool y
934 depends on FSL_FIXED_MMC_LOCATION && (ARCH_BSC9131 || ARCH_BSC9132 || ARCH_P1010)
935 help
936 In High Capacity SD Cards (> 2 GBytes), the 32-bit source address and
937 code length of these soc specify the memory address in block address
938 format. Block length is fixed to 512 bytes as per the SD High
939 Capacity specification.
940
Tom Rini9ff815a2021-08-24 23:11:49 -0400941config SYS_FSL_PBL_PBI
942 string "PBI(pre-boot instructions) commands for the PBL image"
943 depends on RAMBOOT_PBL
944 help
945 PBI commands can be used to configure SoC before it starts the execution.
946 Please refer doc/README.pblimage for more details.
947
948config SYS_FSL_PBL_RCW
949 string "Aadditional RCW (Power on reset configuration) for the PBL image"
950 depends on RAMBOOT_PBL
951 help
952 Enables addition of RCW (Power on reset configuration) in built image.
953 Please refer doc/README.pblimage for more details.
954
Tom Rini94b4fec2022-06-25 11:02:46 -0400955config SYS_BOOT_RAMDISK_HIGH
956 depends on CMD_BOOTM || CMD_BOOTI || CMD_BOOTZ
957 depends on !(NIOS2 || SANDBOX || SH || XTENSA)
958 def_bool y
Simon Glass65edcd32023-03-24 16:58:12 -0400959 select LMB
Tom Rini94b4fec2022-06-25 11:02:46 -0400960 help
961 Enable initrd_high functionality. If defined then the initrd_high
962 feature is enabled and the boot* ramdisk subcommand is enabled.
963
Simon Glassb45b1632020-09-10 20:21:13 -0600964endmenu # Boot images
965
Simon Glassf111bf72023-03-24 16:58:11 -0400966config DISTRO_DEFAULTS
Simon Glasse27d7df2023-09-14 10:55:55 -0600967 bool "(deprecated) Script-based booting of Linux distributions"
Tom Rini045245b2023-10-26 14:31:23 -0400968 select CMDLINE
Simon Glass054d0182023-03-24 16:58:13 -0400969 select BOOT_DEFAULTS
Simon Glassf111bf72023-03-24 16:58:11 -0400970 select AUTO_COMPLETE
971 select CMDLINE_EDITING
Simon Glassf111bf72023-03-24 16:58:11 -0400972 select CMD_SYSBOOT
Simon Glassf111bf72023-03-24 16:58:11 -0400973 select HUSH_PARSER
Simon Glassf111bf72023-03-24 16:58:11 -0400974 select SYS_LONGHELP
Simon Glassf111bf72023-03-24 16:58:11 -0400975 help
Simon Glasse27d7df2023-09-14 10:55:55 -0600976 Note: These scripts have been replaced by Standard Boot. Do not use
977 them on new boards. See 'Migrating from distro_boot' at
978 doc/develop/bootstd.rst
979
Simon Glassf111bf72023-03-24 16:58:11 -0400980 Select this to enable various options and commands which are suitable
981 for building u-boot for booting general purpose Linux distributions.
982
Simon Glassd02ddcf2020-09-10 20:21:14 -0600983menu "Boot timing"
984
985config BOOTSTAGE
986 bool "Boot timing and reporting"
987 help
988 Enable recording of boot time while booting. To use it, insert
989 calls to bootstage_mark() with a suitable BOOTSTAGE_ID from
990 bootstage.h. Only a single entry is recorded for each ID. You can
991 give the entry a name with bootstage_mark_name(). You can also
992 record elapsed time in a particular stage using bootstage_start()
993 before starting and bootstage_accum() when finished. Bootstage will
994 add up all the accumulated time and report it.
995
996 Normally, IDs are defined in bootstage.h but a small number of
997 additional 'user' IDs can be used by passing BOOTSTAGE_ID_ALLOC
998 as the ID.
999
1000 Calls to show_boot_progress() will also result in log entries but
1001 these will not have names.
1002
1003config SPL_BOOTSTAGE
1004 bool "Boot timing and reported in SPL"
Tom Rini0a83cc22022-06-10 23:03:09 -04001005 depends on BOOTSTAGE && SPL
Simon Glassd02ddcf2020-09-10 20:21:14 -06001006 help
1007 Enable recording of boot time in SPL. To make this visible to U-Boot
1008 proper, enable BOOTSTAGE_STASH as well. This will stash the timing
1009 information when SPL finishes and load it when U-Boot proper starts
1010 up.
1011
1012config TPL_BOOTSTAGE
1013 bool "Boot timing and reported in TPL"
Tom Rini36a4ca02022-06-08 08:24:39 -04001014 depends on BOOTSTAGE && TPL
Simon Glassd02ddcf2020-09-10 20:21:14 -06001015 help
1016 Enable recording of boot time in SPL. To make this visible to U-Boot
1017 proper, enable BOOTSTAGE_STASH as well. This will stash the timing
1018 information when TPL finishes and load it when U-Boot proper starts
1019 up.
1020
1021config BOOTSTAGE_REPORT
1022 bool "Display a detailed boot timing report before booting the OS"
1023 depends on BOOTSTAGE
1024 help
1025 Enable output of a boot time report just before the OS is booted.
1026 This shows how long it took U-Boot to go through each stage of the
1027 boot process. The report looks something like this:
1028
1029 Timer summary in microseconds:
1030 Mark Elapsed Stage
1031 0 0 reset
1032 3,575,678 3,575,678 board_init_f start
1033 3,575,695 17 arch_cpu_init A9
1034 3,575,777 82 arch_cpu_init done
1035 3,659,598 83,821 board_init_r start
1036 3,910,375 250,777 main_loop
1037 29,916,167 26,005,792 bootm_start
1038 30,361,327 445,160 start_kernel
1039
1040config BOOTSTAGE_RECORD_COUNT
1041 int "Number of boot stage records to store"
Simon Glass051ddfb2021-02-03 06:00:49 -07001042 depends on BOOTSTAGE
Simon Glassd02ddcf2020-09-10 20:21:14 -06001043 default 30
1044 help
1045 This is the size of the bootstage record list and is the maximum
1046 number of bootstage records that can be recorded.
1047
1048config SPL_BOOTSTAGE_RECORD_COUNT
1049 int "Number of boot stage records to store for SPL"
Simon Glass051ddfb2021-02-03 06:00:49 -07001050 depends on SPL_BOOTSTAGE
Simon Glassd02ddcf2020-09-10 20:21:14 -06001051 default 5
1052 help
1053 This is the size of the bootstage record list and is the maximum
1054 number of bootstage records that can be recorded.
1055
1056config TPL_BOOTSTAGE_RECORD_COUNT
1057 int "Number of boot stage records to store for TPL"
Simon Glass051ddfb2021-02-03 06:00:49 -07001058 depends on TPL_BOOTSTAGE
Simon Glassd02ddcf2020-09-10 20:21:14 -06001059 default 5
1060 help
1061 This is the size of the bootstage record list and is the maximum
1062 number of bootstage records that can be recorded.
1063
1064config BOOTSTAGE_FDT
1065 bool "Store boot timing information in the OS device tree"
1066 depends on BOOTSTAGE
1067 help
1068 Stash the bootstage information in the FDT. A root 'bootstage'
1069 node is created with each bootstage id as a child. Each child
1070 has a 'name' property and either 'mark' containing the
1071 mark time in microseconds, or 'accum' containing the
1072 accumulated time for that bootstage id in microseconds.
1073 For example:
1074
1075 bootstage {
1076 154 {
1077 name = "board_init_f";
1078 mark = <3575678>;
1079 };
1080 170 {
1081 name = "lcd";
1082 accum = <33482>;
1083 };
1084 };
1085
1086 Code in the Linux kernel can find this in /proc/devicetree.
1087
1088config BOOTSTAGE_STASH
1089 bool "Stash the boot timing information in memory before booting OS"
1090 depends on BOOTSTAGE
1091 help
1092 Some OSes do not support device tree. Bootstage can instead write
1093 the boot timing information in a binary format at a given address.
1094 This happens through a call to bootstage_stash(), typically in
1095 the CPU's cleanup_before_linux() function. You can use the
1096 'bootstage stash' and 'bootstage unstash' commands to do this on
1097 the command line.
1098
1099config BOOTSTAGE_STASH_ADDR
1100 hex "Address to stash boot timing information"
Tom Rinid78c9bd2024-07-15 12:42:00 +01001101 depends on BOOTSTAGE_STASH
1102 default 0xC3000000 if STM32MP13X || STM32MP15X
1103 default 0x87000000 if STM32MP25X
1104 default 0x0 if SANDBOX
Simon Glassd02ddcf2020-09-10 20:21:14 -06001105 help
1106 Provide an address which will not be overwritten by the OS when it
1107 starts, so that it can read this information when ready.
1108
1109config BOOTSTAGE_STASH_SIZE
1110 hex "Size of boot timing stash region"
Tom Rinid78c9bd2024-07-15 12:42:00 +01001111 depends on BOOTSTAGE_STASH
Simon Glassd02ddcf2020-09-10 20:21:14 -06001112 default 0x1000
1113 help
1114 This should be large enough to hold the bootstage stash. A value of
1115 4096 (4KiB) is normally plenty.
1116
1117config SHOW_BOOT_PROGRESS
1118 bool "Show boot progress in a board-specific manner"
1119 help
1120 Defining this option allows to add some board-specific code (calling
1121 a user-provided function show_boot_progress(int) that enables you to
1122 show the system's boot progress on some display (for example, some
1123 LEDs) on your board. At the moment, the following checkpoints are
1124 implemented:
1125
1126 Legacy uImage format:
1127
1128 Arg Where When
1129 1 common/cmd_bootm.c before attempting to boot an image
1130 -1 common/cmd_bootm.c Image header has bad magic number
1131 2 common/cmd_bootm.c Image header has correct magic number
1132 -2 common/cmd_bootm.c Image header has bad checksum
1133 3 common/cmd_bootm.c Image header has correct checksum
1134 -3 common/cmd_bootm.c Image data has bad checksum
1135 4 common/cmd_bootm.c Image data has correct checksum
1136 -4 common/cmd_bootm.c Image is for unsupported architecture
1137 5 common/cmd_bootm.c Architecture check OK
1138 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
1139 6 common/cmd_bootm.c Image Type check OK
1140 -6 common/cmd_bootm.c gunzip uncompression error
1141 -7 common/cmd_bootm.c Unimplemented compression type
1142 7 common/cmd_bootm.c Uncompression OK
1143 8 common/cmd_bootm.c No uncompress/copy overwrite error
1144 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
1145
1146 9 common/image.c Start initial ramdisk verification
1147 -10 common/image.c Ramdisk header has bad magic number
1148 -11 common/image.c Ramdisk header has bad checksum
1149 10 common/image.c Ramdisk header is OK
1150 -12 common/image.c Ramdisk data has bad checksum
1151 11 common/image.c Ramdisk data has correct checksum
1152 12 common/image.c Ramdisk verification complete, start loading
1153 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
1154 13 common/image.c Start multifile image verification
1155 14 common/image.c No initial ramdisk, no multifile, continue.
1156
1157 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
1158
1159 -30 arch/powerpc/lib/board.c Fatal error, hang the system
1160 -31 post/post.c POST test failed, detected by post_output_backlog()
1161 -32 post/post.c POST test failed, detected by post_run_single()
1162
1163 34 common/cmd_doc.c before loading a Image from a DOC device
1164 -35 common/cmd_doc.c Bad usage of "doc" command
1165 35 common/cmd_doc.c correct usage of "doc" command
1166 -36 common/cmd_doc.c No boot device
1167 36 common/cmd_doc.c correct boot device
1168 -37 common/cmd_doc.c Unknown Chip ID on boot device
1169 37 common/cmd_doc.c correct chip ID found, device available
1170 -38 common/cmd_doc.c Read Error on boot device
1171 38 common/cmd_doc.c reading Image header from DOC device OK
1172 -39 common/cmd_doc.c Image header has bad magic number
1173 39 common/cmd_doc.c Image header has correct magic number
1174 -40 common/cmd_doc.c Error reading Image from DOC device
1175 40 common/cmd_doc.c Image header has correct magic number
1176 41 common/cmd_ide.c before loading a Image from a IDE device
1177 -42 common/cmd_ide.c Bad usage of "ide" command
1178 42 common/cmd_ide.c correct usage of "ide" command
1179 -43 common/cmd_ide.c No boot device
1180 43 common/cmd_ide.c boot device found
1181 -44 common/cmd_ide.c Device not available
1182 44 common/cmd_ide.c Device available
1183 -45 common/cmd_ide.c wrong partition selected
1184 45 common/cmd_ide.c partition selected
1185 -46 common/cmd_ide.c Unknown partition table
1186 46 common/cmd_ide.c valid partition table found
1187 -47 common/cmd_ide.c Invalid partition type
1188 47 common/cmd_ide.c correct partition type
1189 -48 common/cmd_ide.c Error reading Image Header on boot device
1190 48 common/cmd_ide.c reading Image Header from IDE device OK
1191 -49 common/cmd_ide.c Image header has bad magic number
1192 49 common/cmd_ide.c Image header has correct magic number
1193 -50 common/cmd_ide.c Image header has bad checksum
1194 50 common/cmd_ide.c Image header has correct checksum
1195 -51 common/cmd_ide.c Error reading Image from IDE device
1196 51 common/cmd_ide.c reading Image from IDE device OK
1197 52 common/cmd_nand.c before loading a Image from a NAND device
1198 -53 common/cmd_nand.c Bad usage of "nand" command
1199 53 common/cmd_nand.c correct usage of "nand" command
1200 -54 common/cmd_nand.c No boot device
1201 54 common/cmd_nand.c boot device found
1202 -55 common/cmd_nand.c Unknown Chip ID on boot device
1203 55 common/cmd_nand.c correct chip ID found, device available
1204 -56 common/cmd_nand.c Error reading Image Header on boot device
1205 56 common/cmd_nand.c reading Image Header from NAND device OK
1206 -57 common/cmd_nand.c Image header has bad magic number
1207 57 common/cmd_nand.c Image header has correct magic number
1208 -58 common/cmd_nand.c Error reading Image from NAND device
1209 58 common/cmd_nand.c reading Image from NAND device OK
1210
1211 -60 common/env_common.c Environment has a bad CRC, using default
1212
1213 64 net/eth.c starting with Ethernet configuration.
1214 -64 net/eth.c no Ethernet found.
1215 65 net/eth.c Ethernet found.
1216
1217 -80 common/cmd_net.c usage wrong
1218 80 common/cmd_net.c before calling net_loop()
1219 -81 common/cmd_net.c some error in net_loop() occurred
1220 81 common/cmd_net.c net_loop() back without error
1221 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
1222 82 common/cmd_net.c trying automatic boot
1223 83 common/cmd_net.c running "source" command
1224 -83 common/cmd_net.c some error in automatic boot or "source" command
1225 84 common/cmd_net.c end without errors
1226
1227 FIT uImage format:
1228
1229 Arg Where When
1230 100 common/cmd_bootm.c Kernel FIT Image has correct format
1231 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
1232 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
1233 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
1234 102 common/cmd_bootm.c Kernel unit name specified
1235 -103 common/cmd_bootm.c Can't get kernel subimage node offset
1236 103 common/cmd_bootm.c Found configuration node
1237 104 common/cmd_bootm.c Got kernel subimage node offset
1238 -104 common/cmd_bootm.c Kernel subimage hash verification failed
1239 105 common/cmd_bootm.c Kernel subimage hash verification OK
1240 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
1241 106 common/cmd_bootm.c Architecture check OK
1242 -106 common/cmd_bootm.c Kernel subimage has wrong type
1243 107 common/cmd_bootm.c Kernel subimage type OK
1244 -107 common/cmd_bootm.c Can't get kernel subimage data/size
1245 108 common/cmd_bootm.c Got kernel subimage data/size
1246 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
1247 -109 common/cmd_bootm.c Can't get kernel subimage type
1248 -110 common/cmd_bootm.c Can't get kernel subimage comp
1249 -111 common/cmd_bootm.c Can't get kernel subimage os
1250 -112 common/cmd_bootm.c Can't get kernel subimage load address
1251 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
1252
1253 120 common/image.c Start initial ramdisk verification
1254 -120 common/image.c Ramdisk FIT image has incorrect format
1255 121 common/image.c Ramdisk FIT image has correct format
1256 122 common/image.c No ramdisk subimage unit name, using configuration
1257 -122 common/image.c Can't get configuration for ramdisk subimage
1258 123 common/image.c Ramdisk unit name specified
1259 -124 common/image.c Can't get ramdisk subimage node offset
1260 125 common/image.c Got ramdisk subimage node offset
1261 -125 common/image.c Ramdisk subimage hash verification failed
1262 126 common/image.c Ramdisk subimage hash verification OK
1263 -126 common/image.c Ramdisk subimage for unsupported architecture
1264 127 common/image.c Architecture check OK
1265 -127 common/image.c Can't get ramdisk subimage data/size
1266 128 common/image.c Got ramdisk subimage data/size
1267 129 common/image.c Can't get ramdisk load address
1268 -129 common/image.c Got ramdisk load address
1269
1270 -130 common/cmd_doc.c Incorrect FIT image format
1271 131 common/cmd_doc.c FIT image format OK
1272
1273 -140 common/cmd_ide.c Incorrect FIT image format
1274 141 common/cmd_ide.c FIT image format OK
1275
1276 -150 common/cmd_nand.c Incorrect FIT image format
1277 151 common/cmd_nand.c FIT image format OK
1278
Marek Vasut98154342021-10-23 03:06:03 +02001279config SPL_SHOW_BOOT_PROGRESS
Jan Kiszka5780edb2021-11-03 15:09:36 +01001280 bool "Show boot progress in a board-specific manner in SPL"
Marek Vasut98154342021-10-23 03:06:03 +02001281 depends on SPL
1282 help
1283 Defining this option allows to add some board-specific code (calling
1284 a user-provided function show_boot_progress(int) that enables you to
1285 show the system's boot progress on some display (for example, some
1286 LEDs) on your board. For details see SHOW_BOOT_PROGRESS.
1287
Simon Glassd02ddcf2020-09-10 20:21:14 -06001288endmenu
1289
Simon Glasseebed782020-09-10 20:21:15 -06001290menu "Boot media"
1291
1292config NOR_BOOT
1293 bool "Support for booting from NOR flash"
1294 depends on NOR
1295 help
1296 Enabling this will make a U-Boot binary that is capable of being
1297 booted via NOR. In this case we will enable certain pinmux early
1298 as the ROM only partially sets up pinmux. We also default to using
1299 NOR for environment.
1300
1301config NAND_BOOT
1302 bool "Support for booting from NAND flash"
Simon Glasseebed782020-09-10 20:21:15 -06001303 imply MTD_RAW_NAND
1304 help
1305 Enabling this will make a U-Boot binary that is capable of being
1306 booted via NAND flash. This is not a must, some SoCs need this,
1307 some not.
1308
1309config ONENAND_BOOT
1310 bool "Support for booting from ONENAND"
Simon Glasseebed782020-09-10 20:21:15 -06001311 imply MTD_RAW_NAND
1312 help
1313 Enabling this will make a U-Boot binary that is capable of being
1314 booted via ONENAND. This is not a must, some SoCs need this,
1315 some not.
1316
1317config QSPI_BOOT
1318 bool "Support for booting from QSPI flash"
Simon Glasseebed782020-09-10 20:21:15 -06001319 help
1320 Enabling this will make a U-Boot binary that is capable of being
1321 booted via QSPI flash. This is not a must, some SoCs need this,
1322 some not.
1323
1324config SATA_BOOT
1325 bool "Support for booting from SATA"
Simon Glasseebed782020-09-10 20:21:15 -06001326 help
1327 Enabling this will make a U-Boot binary that is capable of being
1328 booted via SATA. This is not a must, some SoCs need this,
1329 some not.
1330
1331config SD_BOOT
1332 bool "Support for booting from SD/EMMC"
Simon Glasseebed782020-09-10 20:21:15 -06001333 help
1334 Enabling this will make a U-Boot binary that is capable of being
1335 booted via SD/EMMC. This is not a must, some SoCs need this,
1336 some not.
1337
Tom Rinia43bf4e2021-12-11 14:55:50 -05001338config SD_BOOT_QSPI
1339 bool "Support for booting from SD/EMMC and enable QSPI"
1340 help
1341 Enabling this will make a U-Boot binary that is capable of being
1342 booted via SD/EMMC while enabling QSPI on the platform as well. This
1343 is not a must, some SoCs need this, some not.
1344
Simon Glasseebed782020-09-10 20:21:15 -06001345config SPI_BOOT
1346 bool "Support for booting from SPI flash"
Simon Glasseebed782020-09-10 20:21:15 -06001347 help
1348 Enabling this will make a U-Boot binary that is capable of being
1349 booted via SPI flash. This is not a must, some SoCs need this,
1350 some not.
1351
1352endmenu
1353
Simon Glasse9d54d72020-09-10 20:21:16 -06001354menu "Autoboot options"
1355
1356config AUTOBOOT
1357 bool "Autoboot"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001358 depends on CMDLINE
Simon Glasse9d54d72020-09-10 20:21:16 -06001359 default y
1360 help
1361 This enables the autoboot. See doc/README.autoboot for detail.
1362
Simon Glass7dee9dc2023-10-26 14:31:22 -04001363if AUTOBOOT
1364
Simon Glass1b6cbaa2020-09-10 20:21:17 -06001365config BOOTDELAY
1366 int "delay in seconds before automatically booting"
1367 default 2
Simon Glass1b6cbaa2020-09-10 20:21:17 -06001368 help
1369 Delay before automatically running bootcmd;
1370 set to 0 to autoboot with no delay, but you can stop it by key input.
1371 set to -1 to disable autoboot.
1372 set to -2 to autoboot with no delay and not check for abort
1373
1374 If this value is >= 0 then it is also used for the default delay
1375 before starting the default entry in bootmenu. If it is < 0 then
1376 a default value of 10s is used.
1377
1378 See doc/README.autoboot for details.
1379
Simon Glasse9d54d72020-09-10 20:21:16 -06001380config AUTOBOOT_KEYED
1381 bool "Stop autobooting via specific input key / string"
Simon Glasse9d54d72020-09-10 20:21:16 -06001382 help
1383 This option enables stopping (aborting) of the automatic
1384 boot feature only by issuing a specific input key or
1385 string. If not enabled, any input key will abort the
1386 U-Boot automatic booting process and bring the device
1387 to the U-Boot prompt for user input.
1388
Simon Glass7dee9dc2023-10-26 14:31:22 -04001389if AUTOBOOT_KEYED
1390
Steffen Jaeckeldfc97322021-07-08 15:57:38 +02001391config AUTOBOOT_FLUSH_STDIN
1392 bool "Enable flushing stdin before starting to read the password"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001393 depends on !SANDBOX
Steffen Jaeckeldfc97322021-07-08 15:57:38 +02001394 help
1395 When this option is enabled stdin buffer will be flushed before
1396 starting to read the password.
1397 This can't be enabled for the sandbox as flushing stdin would
1398 break the autoboot unit tests.
1399
Simon Glasse9d54d72020-09-10 20:21:16 -06001400config AUTOBOOT_PROMPT
1401 string "Autoboot stop prompt"
Simon Glasse9d54d72020-09-10 20:21:16 -06001402 default "Autoboot in %d seconds\\n"
1403 help
1404 This string is displayed before the boot delay selected by
1405 CONFIG_BOOTDELAY starts. If it is not defined there is no
1406 output indicating that autoboot is in progress.
1407
1408 Note that this define is used as the (only) argument to a
1409 printf() call, so it may contain '%' format specifications,
Quentin Schulzc0a7ae02024-06-12 16:58:47 +02001410 provided that it also includes, separated by commas exactly
Simon Glasse9d54d72020-09-10 20:21:16 -06001411 like in a printf statement, the required arguments. It is
1412 the responsibility of the user to select only such arguments
1413 that are valid in the given context.
1414
1415config AUTOBOOT_ENCRYPTION
1416 bool "Enable encryption in autoboot stopping"
Simon Glasse9d54d72020-09-10 20:21:16 -06001417 help
1418 This option allows a string to be entered into U-Boot to stop the
Steffen Jaeckel6aa6bfb2021-07-08 15:57:35 +02001419 autoboot.
1420 The behavior depends whether CONFIG_CRYPT_PW from lib is enabled
1421 or not.
1422 In case CONFIG_CRYPT_PW is enabled, the string will be forwarded
1423 to the crypt-based functionality and be compared against the
1424 string in the environment variable 'bootstopkeycrypt'.
1425 In case CONFIG_CRYPT_PW is disabled the string itself is hashed
1426 and compared against the hash in the environment variable
1427 'bootstopkeysha256'.
1428 If it matches in either case then boot stops and
1429 a command-line prompt is presented.
Simon Glasse9d54d72020-09-10 20:21:16 -06001430 This provides a way to ship a secure production device which can also
1431 be accessed at the U-Boot command line.
1432
Steffen Jaeckel28be70d2021-07-08 15:57:39 +02001433config AUTOBOOT_SHA256_FALLBACK
1434 bool "Allow fallback from crypt-hashed password to sha256"
1435 depends on AUTOBOOT_ENCRYPTION && CRYPT_PW
1436 help
1437 This option adds support to fall back from crypt-hashed
1438 passwords to checking a SHA256 hashed password in case the
1439 'bootstopusesha256' environment variable is set to 'true'.
1440
Simon Glasse9d54d72020-09-10 20:21:16 -06001441config AUTOBOOT_DELAY_STR
1442 string "Delay autobooting via specific input key / string"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001443 depends on !AUTOBOOT_ENCRYPTION
Simon Glasse9d54d72020-09-10 20:21:16 -06001444 help
1445 This option delays the automatic boot feature by issuing
1446 a specific input key or string. If CONFIG_AUTOBOOT_DELAY_STR
1447 or the environment variable "bootdelaykey" is specified
1448 and this string is received from console input before
1449 autoboot starts booting, U-Boot gives a command prompt. The
1450 U-Boot prompt will time out if CONFIG_BOOT_RETRY_TIME is
1451 used, otherwise it never times out.
1452
1453config AUTOBOOT_STOP_STR
1454 string "Stop autobooting via specific input key / string"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001455 depends on !AUTOBOOT_ENCRYPTION
Simon Glasse9d54d72020-09-10 20:21:16 -06001456 help
1457 This option enables stopping (aborting) of the automatic
1458 boot feature only by issuing a specific input key or
1459 string. If CONFIG_AUTOBOOT_STOP_STR or the environment
1460 variable "bootstopkey" is specified and this string is
1461 received from console input before autoboot starts booting,
1462 U-Boot gives a command prompt. The U-Boot prompt never
1463 times out, even if CONFIG_BOOT_RETRY_TIME is used.
1464
1465config AUTOBOOT_KEYED_CTRLC
1466 bool "Enable Ctrl-C autoboot interruption"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001467 depends on !AUTOBOOT_ENCRYPTION
Simon Glasse9d54d72020-09-10 20:21:16 -06001468 help
1469 This option allows for the boot sequence to be interrupted
1470 by ctrl-c, in addition to the "bootdelaykey" and "bootstopkey".
1471 Setting this variable provides an escape sequence from the
1472 limited "password" strings.
1473
Steffen Jaeckel792a13f2021-07-08 15:57:37 +02001474config AUTOBOOT_NEVER_TIMEOUT
1475 bool "Make the password entry never time-out"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001476 depends on AUTOBOOT_ENCRYPTION && CRYPT_PW
Steffen Jaeckel792a13f2021-07-08 15:57:37 +02001477 help
1478 This option removes the timeout from the password entry
1479 when the user first presses the <Enter> key before entering
1480 any other character.
1481
Steffen Jaeckel6aa6bfb2021-07-08 15:57:35 +02001482config AUTOBOOT_STOP_STR_ENABLE
1483 bool "Enable fixed string to stop autobooting"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001484 depends on AUTOBOOT_ENCRYPTION
Steffen Jaeckel6aa6bfb2021-07-08 15:57:35 +02001485 help
1486 This option enables the feature to add a fixed stop
1487 string that is defined at compile time.
1488 In every case it will be tried to load the stop
1489 string from the environment.
1490 In case this is enabled and there is no stop string
1491 in the environment, this will be used as default value.
1492
1493config AUTOBOOT_STOP_STR_CRYPT
1494 string "Stop autobooting via crypt-hashed password"
1495 depends on AUTOBOOT_STOP_STR_ENABLE && CRYPT_PW
1496 help
1497 This option adds the feature to only stop the autobooting,
1498 and therefore boot into the U-Boot prompt, when the input
1499 string / password matches a values that is hashed via
1500 one of the supported crypt-style password hashing options
1501 and saved in the environment variable "bootstopkeycrypt".
1502
Simon Glasse9d54d72020-09-10 20:21:16 -06001503config AUTOBOOT_STOP_STR_SHA256
Steffen Jaeckele1788f92021-07-08 15:57:40 +02001504 string "Stop autobooting via SHA256 hashed password"
Steffen Jaeckel6aa6bfb2021-07-08 15:57:35 +02001505 depends on AUTOBOOT_STOP_STR_ENABLE
Simon Glasse9d54d72020-09-10 20:21:16 -06001506 help
1507 This option adds the feature to only stop the autobooting,
1508 and therefore boot into the U-Boot prompt, when the input
Quentin Schulzc0a7ae02024-06-12 16:58:47 +02001509 string / password matches a values that is encrypted via
Joel Peshkin8b7bf532020-11-21 17:18:59 -08001510 a SHA256 hash and saved in the environment variable
1511 "bootstopkeysha256". If the value in that variable
1512 includes a ":", the portion prior to the ":" will be treated
1513 as a salt value.
Simon Glasse9d54d72020-09-10 20:21:16 -06001514
Simon Glass7dee9dc2023-10-26 14:31:22 -04001515endif # AUTOBOOT_KEYED
1516
1517if !AUTOBOOT_KEYED
1518
Simon Glasse9d54d72020-09-10 20:21:16 -06001519config AUTOBOOT_USE_MENUKEY
1520 bool "Allow a specify key to run a menu from the environment"
Simon Glasse9d54d72020-09-10 20:21:16 -06001521 help
1522 If a specific key is pressed to stop autoboot, then the commands in
1523 the environment variable 'menucmd' are executed before boot starts.
1524
1525config AUTOBOOT_MENUKEY
1526 int "ASCII value of boot key to show a menu"
1527 default 0
1528 depends on AUTOBOOT_USE_MENUKEY
1529 help
1530 If this key is pressed to stop autoboot, then the commands in the
1531 environment variable 'menucmd' will be executed before boot starts.
1532 For example, 33 means "!" in ASCII, so pressing ! at boot would take
1533 this action.
1534
Simon Glass7dee9dc2023-10-26 14:31:22 -04001535endif
1536
1537endif # AUTOBOOT
1538
Simon Glasse9d54d72020-09-10 20:21:16 -06001539config AUTOBOOT_MENU_SHOW
1540 bool "Show a menu on boot"
1541 depends on CMD_BOOTMENU
1542 help
1543 This enables the boot menu, controlled by environment variables
1544 defined by the board. The menu starts after running the 'preboot'
1545 environmnent variable (if enabled) and before handling the boot delay.
Peter Robinson16e0b8f2023-08-18 15:54:10 +01001546 See doc/usage/cmd/bootmenu.rst for more details.
Simon Glasse9d54d72020-09-10 20:21:16 -06001547
Masahisa Kojima97cbcc42022-05-26 19:09:38 +09001548config BOOTMENU_DISABLE_UBOOT_CONSOLE
1549 bool "Disallow bootmenu to enter the U-Boot console"
1550 depends on AUTOBOOT_MENU_SHOW
1551 help
1552 If this option is enabled, user can not enter the U-Boot console from
1553 bootmenu. It increases the system security.
1554
Tom Rinia45a3ef2022-03-11 09:12:04 -05001555config BOOT_RETRY
1556 bool "Boot retry feature"
1557 help
1558 Allow for having the U-Boot command prompt time out and attempt
1559 to boot again. If the environment variable "bootretry" is found then
1560 its value is used, otherwise the retry timeout is
1561 CONFIG_BOOT_RETRY_TIME. CONFIG_BOOT_RETRY_MIN is optional and
1562 defaults to CONFIG_BOOT_RETRY_TIME. All times are in seconds.
1563
1564config BOOT_RETRY_TIME
1565 int "Timeout in seconds before attempting to boot again"
1566 depends on BOOT_RETRY
1567 help
1568 Time in seconds before the U-Boot prompt will timeout and boot will
1569 be attempted again.
1570
1571config BOOT_RETRY_MIN
1572 int "Minimum timeout in seconds for 'bootretry'"
1573 depends on BOOT_RETRY
1574 default BOOT_RETRY_TIME
1575 help
1576 The minimum time in seconds that "bootretry" can be set to.
1577
1578config RESET_TO_RETRY
1579 bool "Reset the board to retry autoboot"
1580 depends on BOOT_RETRY
1581 help
1582 After the countdown timed out, the board will be reset to restart
1583 again.
1584
Simon Glasse9d54d72020-09-10 20:21:16 -06001585endmenu
1586
Philippe Reynesd28484e2022-03-28 22:56:59 +02001587menu "Image support"
1588
1589config IMAGE_PRE_LOAD
1590 bool "Image pre-load support"
1591 help
1592 Enable an image pre-load stage in the SPL.
1593 This pre-load stage allows to do some manipulation
1594 or check (for example signature check) on an image
1595 before launching it.
1596
1597config SPL_IMAGE_PRE_LOAD
1598 bool "Image pre-load support within SPL"
1599 depends on SPL && IMAGE_PRE_LOAD
1600 help
1601 Enable an image pre-load stage in the SPL.
1602 This pre-load stage allows to do some manipulation
1603 or check (for example signature check) on an image
1604 before launching it.
1605
1606config IMAGE_PRE_LOAD_SIG
1607 bool "Image pre-load signature support"
1608 depends on IMAGE_PRE_LOAD
1609 select FIT_SIGNATURE
1610 select RSA
1611 select RSA_VERIFY_WITH_PKEY
1612 help
1613 Enable signature check support in the pre-load stage.
1614 For this feature a very simple header is added before
1615 the image with few fields:
1616 - a magic
1617 - the image size
1618 - the signature
1619 All other information (header size, type of signature,
1620 ...) are provided in the node /image/pre-load/sig of
1621 u-boot.
1622
1623config SPL_IMAGE_PRE_LOAD_SIG
1624 bool "Image pre-load signature support witin SPL"
1625 depends on SPL_IMAGE_PRE_LOAD && IMAGE_PRE_LOAD_SIG
1626 select SPL_FIT_SIGNATURE
1627 select SPL_RSA
1628 select SPL_RSA_VERIFY_WITH_PKEY
1629 help
1630 Enable signature check support in the pre-load stage in the SPL.
1631 For this feature a very simple header is added before
1632 the image with few fields:
1633 - a magic
1634 - the image size
1635 - the signature
1636 All other information (header size, type of signature,
1637 ...) are provided in the node /image/pre-load/sig of
1638 u-boot.
1639
1640endmenu
1641
Simon Glass27367192023-09-14 10:55:46 -06001642if OF_LIBFDT
1643
1644menu "Devicetree fixup"
1645
Matthias Schiffere908fec2023-12-11 12:03:17 +01001646config OF_ENV_SETUP
1647 bool "Run a command from environment to set up device tree before boot"
1648 depends on CMD_FDT
1649 help
1650 This causes U-Boot to run a command from the environment variable
1651 fdt_fixup before booting into the operating system, which can use the
1652 fdt command to modify the device tree. The device tree is then passed
1653 to the OS.
1654
Simon Glass48e6d3d2023-09-14 10:55:47 -06001655config OF_BOARD_SETUP
1656 bool "Set up board-specific details in device tree before boot"
1657 help
1658 This causes U-Boot to call ft_board_setup() before booting into
1659 the Operating System. This function can set up various
1660 board-specific information in the device tree for use by the OS.
1661 The device tree is then passed to the OS.
1662
1663config OF_SYSTEM_SETUP
1664 bool "Set up system-specific details in device tree before boot"
1665 help
1666 This causes U-Boot to call ft_system_setup() before booting into
1667 the Operating System. This function can set up various
1668 system-specific information in the device tree for use by the OS.
1669 The device tree is then passed to the OS.
1670
1671config OF_STDOUT_VIA_ALIAS
1672 bool "Update the device-tree stdout alias from U-Boot"
1673 help
1674 This uses U-Boot's serial alias from the aliases node to update
1675 the device tree passed to the OS. The "linux,stdout-path" property
1676 in the chosen node is set to point to the correct serial node.
1677 This option currently references CONFIG_CONS_INDEX, which is
1678 incorrect when used with device tree as this option does not
1679 exist / should not be used.
1680
Simon Glassb7b7f162023-09-14 10:55:57 -06001681config FDT_FIXUP_PARTITIONS
Simon Glass1a5bcc12023-09-14 10:55:58 -06001682 bool "Overwrite MTD partitions in DTS through defined in 'mtdparts'"
Simon Glassb7b7f162023-09-14 10:55:57 -06001683 help
1684 Allow overwriting defined partitions in the device tree blob
1685 using partition info defined in the 'mtdparts' environment
1686 variable.
1687
Simon Glass27367192023-09-14 10:55:46 -06001688config FDT_SIMPLEFB
1689 bool "FDT tools for simplefb support"
1690 help
1691 Enable the fdt tools to manage the simple fb nodes in device tree.
1692 These functions can be used by board to indicate to the OS
1693 the presence of the simple frame buffer with associated reserved
1694 memory
1695
Simon Glass624c0e52023-09-14 10:55:59 -06001696config ARCH_FIXUP_FDT_MEMORY
1697 bool "Enable arch_fixup_memory_banks() call"
1698 default y
1699 help
1700 Enable FDT memory map syncup before OS boot. This feature can be
1701 used for booting OS with different memory setup where the part of
1702 the memory location should be used for different purpose.
1703
Simon Glass27367192023-09-14 10:55:46 -06001704endmenu
1705
1706endif # OF_LIBFDT
1707
Simon Glass5e958642020-09-10 20:21:18 -06001708config USE_BOOTARGS
1709 bool "Enable boot arguments"
1710 help
1711 Provide boot arguments to bootm command. Boot arguments are specified
1712 in CONFIG_BOOTARGS option. Enable this option to be able to specify
1713 CONFIG_BOOTARGS string. If this option is disabled, CONFIG_BOOTARGS
1714 will be undefined and won't take any space in U-Boot image.
1715
1716config BOOTARGS
1717 string "Boot arguments"
1718 depends on USE_BOOTARGS && !USE_DEFAULT_ENV_FILE
1719 help
1720 This can be used to pass arguments to the bootm command. The value of
1721 CONFIG_BOOTARGS goes into the environment value "bootargs". Note that
1722 this value will also override the "chosen" node in FDT blob.
1723
Simon Glass529e2082020-11-05 10:33:48 -07001724config BOOTARGS_SUBST
1725 bool "Support substituting strings in boot arguments"
1726 help
1727 This allows substituting string values in the boot arguments. These
1728 are applied after the commandline has been built.
1729
1730 One use for this is to insert the root-disk UUID into the command
1731 line where bootargs contains "root=${uuid}"
1732
1733 setenv bootargs "console= root=${uuid}"
1734 # Set the 'uuid' environment variable
1735 part uuid mmc 2:2 uuid
1736
1737 # Command-line substitution will put the real uuid into the
1738 # kernel command line
1739 bootm
1740
Simon Glass5e958642020-09-10 20:21:18 -06001741config USE_BOOTCOMMAND
1742 bool "Enable a default value for bootcmd"
Tom Rinidc3bf2d2023-10-26 14:31:28 -04001743 depends on CMDLINE
Simon Glass5e958642020-09-10 20:21:18 -06001744 help
1745 Provide a default value for the bootcmd entry in the environment. If
1746 autoboot is enabled this is what will be run automatically. Enable
1747 this option to be able to specify CONFIG_BOOTCOMMAND as a string. If
1748 this option is disabled, CONFIG_BOOTCOMMAND will be undefined and
1749 won't take any space in U-Boot image.
1750
1751config BOOTCOMMAND
1752 string "bootcmd value"
1753 depends on USE_BOOTCOMMAND && !USE_DEFAULT_ENV_FILE
Simon Glass2d5a8e12023-05-06 08:27:09 -06001754 default "bootflow scan -lb" if BOOTSTD_DEFAULTS && CMD_BOOTFLOW_FULL
1755 default "bootflow scan" if BOOTSTD_DEFAULTS && !CMD_BOOTFLOW_FULL
Simon Glassbe661cb2022-04-24 23:31:27 -06001756 default "run distro_bootcmd" if !BOOTSTD_BOOTCOMMAND && DISTRO_DEFAULTS
Simon Glass5e958642020-09-10 20:21:18 -06001757 help
1758 This is the string of commands that will be used as bootcmd and if
1759 AUTOBOOT is set, automatically run.
1760
1761config USE_PREBOOT
1762 bool "Enable preboot"
Tom Rinidc3bf2d2023-10-26 14:31:28 -04001763 depends on CMDLINE
Simon Glass5e958642020-09-10 20:21:18 -06001764 help
1765 When this option is enabled, the existence of the environment
1766 variable "preboot" will be checked immediately before starting the
1767 CONFIG_BOOTDELAY countdown and/or running the auto-boot command resp.
1768 entering interactive mode.
1769
1770 This feature is especially useful when "preboot" is automatically
1771 generated or modified. For example, the boot code can modify the
1772 "preboot" when a user holds down a certain combination of keys.
1773
1774config PREBOOT
1775 string "preboot default value"
1776 depends on USE_PREBOOT && !USE_DEFAULT_ENV_FILE
Patrick Delaunaybb15d402020-10-12 09:47:50 +02001777 default "usb start" if USB_KEYBOARD
Simon Glass5e958642020-09-10 20:21:18 -06001778 default ""
1779 help
1780 This is the default of "preboot" environment variable.
1781
Pali Rohár39c43c32022-07-10 13:42:55 +02001782config PREBOOT_DEFINED
1783 bool
1784 default y if PREBOOT != ""
1785
Simon Glassc10ddfd2020-09-10 20:21:20 -06001786config DEFAULT_FDT_FILE
1787 string "Default fdt file"
1788 help
1789 This option is used to set the default fdt file to boot OS.
1790
Dzmitry Sankouskia3463062022-02-22 21:49:52 +03001791config SAVE_PREV_BL_FDT_ADDR
1792 depends on ARM
1793 bool "Saves fdt address, passed by the previous bootloader, to env var"
1794 help
1795 When u-boot is used as a chain-loaded bootloader (replacing OS kernel),
1796 enable this option to save fdt address, passed by the
1797 previous bootloader for future use.
1798 Address is saved to `prevbl_fdt_addr` environment variable.
1799
1800 If no fdt was provided by previous bootloader, no env variables
1801 will be created.
1802
1803config SAVE_PREV_BL_INITRAMFS_START_ADDR
1804 depends on ARM
1805 bool "Saves initramfs address, passed by the previous bootloader, to env var"
1806 help
1807 When u-boot is used as a chain-loaded bootloader(replacing OS kernel),
1808 enable this option to save initramfs address, passed by the
1809 previous bootloader for future use.
1810 Address is saved to `prevbl_initrd_start_addr` environment variable.
1811
1812 If no initramfs was provided by previous bootloader, no env variables
1813 will be created.
1814
Simon Glassc8925112023-06-01 10:23:02 -06001815menu "Configuration editor"
1816
1817config CEDIT
1818 bool "Configuration editor"
Heinrich Schuchardtef97f7c2023-12-16 16:38:36 +01001819 depends on EXPO
Simon Glassc8925112023-06-01 10:23:02 -06001820 help
1821 Provides a way to deal with board configuration and present it to
1822 the user for adjustment.
1823
1824 This is intended to provide both graphical and text-based user
1825 interfaces, but only graphical is support at present.
1826
1827endmenu # Configuration editor
1828
Simon Glassb45b1632020-09-10 20:21:13 -06001829endmenu # Booting