blob: b168b6bbcc2aac9b01b5405d97f5b9f30052ec00 [file] [log] [blame]
Simon Glassb45b1632020-09-10 20:21:13 -06001menu "Boot options"
2
Ilias Apalodimas17aea462024-08-30 14:45:27 +03003source "lib/efi_loader/Kconfig"
4
Simon Glassb45b1632020-09-10 20:21:13 -06005menu "Boot images"
6
Tom Rini793921e2024-04-18 08:29:35 -06007config ANDROID_BOOT_IMAGE
8 bool "Android Boot Images"
9 default y if FASTBOOT
10 help
11 This enables support for booting images which use the Android
12 image format header.
13
14config TIMESTAMP
15 bool "Show image date and time when displaying image information"
16 default y if CMD_DATE
17 help
18 When CONFIG_TIMESTAMP is selected, the timestamp (date and time) of
19 an image is printed by image commands like bootm or iminfo. This
20 is shown as 'Timestamp: xxx' and 'Created: xxx'. If this option is
21 enabled, then U-Boot requires FITs to have a timestamp. If a FIT is
22 loaded that does not, the message 'Wrong FIT format: no timestamp'
23 is shown.
24
25config BUTTON_CMD
26 bool "Support for running a command if a button is held during boot"
27 depends on CMDLINE
28 depends on BUTTON
29 help
30 For many embedded devices it's useful to enter a special flashing mode
31 such as fastboot mode when a button is held during boot. This option
32 allows arbitrary commands to be assigned to specific buttons. These will
33 be run after "preboot" if the button is held. Configuration is done via
34 the environment variables "button_cmd_N_name" and "button_cmd_N" where n is
35 the button number (starting from 0). e.g:
36
37 "button_cmd_0_name=vol_down"
38 "button_cmd_0=fastboot usb 0"
39
Simon Glasse9a089a2023-09-14 10:55:49 -060040menuconfig FIT
41 bool "Flattened Image Tree (FIT)"
Alexandru Gagniuc650b7862021-09-02 19:54:21 -050042 select HASH
Simon Glassb45b1632020-09-10 20:21:13 -060043 select MD5
44 select SHA1
Alexandru Gagniuc8d310ef2021-09-02 19:54:17 -050045 imply SHA256
Simon Glassb45b1632020-09-10 20:21:13 -060046 help
47 This option allows you to boot the new uImage structure,
48 Flattened Image Tree. FIT is formally a FDT, which can include
49 images of various types (kernel, FDT blob, ramdisk, etc.)
50 in a single blob. To boot this new uImage structure,
51 pass the address of the blob to the "bootm" command.
52 FIT is very flexible, supporting compression, multiple images,
53 multiple configurations, verification through hashing and also
54 verified boot (secure boot using RSA).
55
Simon Glasse9a089a2023-09-14 10:55:49 -060056if FIT
Simon Glass65831d92021-12-18 11:27:50 -070057
Simon Glassb45b1632020-09-10 20:21:13 -060058config FIT_EXTERNAL_OFFSET
59 hex "FIT external data offset"
60 default 0x0
61 help
62 This specifies a data offset in fit image.
63 The offset is from data payload offset to the beginning of
64 fit image header. When specifies a offset, specific data
65 could be put in the hole between data payload and fit image
66 header, such as CSF data on i.MX platform.
67
Simon Glass244705b2021-02-15 17:08:10 -070068config FIT_FULL_CHECK
69 bool "Do a full check of the FIT before using it"
70 default y
71 help
72 Enable this do a full check of the FIT to make sure it is valid. This
73 helps to protect against carefully crafted FITs which take advantage
74 of bugs or omissions in the code. This includes a bad structure,
75 multiple root nodes and the like.
76
Simon Glassb45b1632020-09-10 20:21:13 -060077config FIT_SIGNATURE
78 bool "Enable signature verification of FIT uImages"
Simon Glasse9a089a2023-09-14 10:55:49 -060079 depends on DM
Simon Glassb45b1632020-09-10 20:21:13 -060080 select HASH
Alexandru Gagniuc1f2e2312021-07-29 11:47:18 -050081 imply RSA
82 imply RSA_VERIFY
Simon Glassb45b1632020-09-10 20:21:13 -060083 select IMAGE_SIGN_INFO
Simon Glass244705b2021-02-15 17:08:10 -070084 select FIT_FULL_CHECK
Simon Glassb45b1632020-09-10 20:21:13 -060085 help
86 This option enables signature verification of FIT uImages,
87 using a hash signed and verified using RSA. If
88 CONFIG_SHA_PROG_HW_ACCEL is defined, i.e support for progressive
89 hashing is available using hardware, then the RSA library will use
Heinrich Schuchardtb72eb352024-06-18 08:23:17 +020090 it. See doc/usage/fit/signature.rst for more details.
Simon Glassb45b1632020-09-10 20:21:13 -060091
92 WARNING: When relying on signed FIT images with a required signature
93 check the legacy image format is disabled by default, so that
94 unsigned images cannot be loaded. If a board needs the legacy image
95 format support in this case, enable it using
96 CONFIG_LEGACY_IMAGE_FORMAT.
97
98config FIT_SIGNATURE_MAX_SIZE
99 hex "Max size of signed FIT structures"
100 depends on FIT_SIGNATURE
101 default 0x10000000
102 help
103 This option sets a max size in bytes for verified FIT uImages.
104 A sane value of 256MB protects corrupted DTB structures from overlapping
105 device memory. Assure this size does not extend past expected storage
106 space.
107
Simon Glass66b00c82021-07-14 17:05:31 -0500108config FIT_RSASSA_PSS
Simon Glassb45b1632020-09-10 20:21:13 -0600109 bool "Support rsassa-pss signature scheme of FIT image contents"
110 depends on FIT_SIGNATURE
Simon Glassb45b1632020-09-10 20:21:13 -0600111 help
112 Enable this to support the pss padding algorithm as described
113 in the rfc8017 (https://tools.ietf.org/html/rfc8017).
114
115config FIT_CIPHER
116 bool "Enable ciphering data in a FIT uImages"
Simon Glasse9a089a2023-09-14 10:55:49 -0600117 depends on DM
Simon Glassb45b1632020-09-10 20:21:13 -0600118 select AES
119 help
120 Enable the feature of data ciphering/unciphering in the tool mkimage
121 and in the u-boot support of the FIT image.
122
123config FIT_VERBOSE
124 bool "Show verbose messages when FIT images fail"
125 help
126 Generally a system will have valid FIT images so debug messages
127 are a waste of code space. If you are debugging your images then
128 you can enable this option to get more verbose information about
129 failures.
130
131config FIT_BEST_MATCH
132 bool "Select the best match for the kernel device tree"
133 help
134 When no configuration is explicitly selected, default to the
135 one whose fdt's compatibility field best matches that of
136 U-Boot itself. A match is considered "best" if it matches the
137 most specific compatibility entry of U-Boot's fdt's root node.
138 The order of entries in the configuration's fdt is ignored.
139
140config FIT_IMAGE_POST_PROCESS
141 bool "Enable post-processing of FIT artifacts after loading by U-Boot"
Manorit Chawdhryf65cdf72023-07-14 11:22:40 +0530142 depends on SOCFPGA_SECURE_VAB_AUTH
Simon Glassb45b1632020-09-10 20:21:13 -0600143 help
144 Allows doing any sort of manipulation to blobs after they got extracted
145 from FIT images like stripping off headers or modifying the size of the
146 blob, verification, authentication, decryption etc. in a platform or
147 board specific way. In order to use this feature a platform or board-
148 specific implementation of board_fit_image_post_process() must be
149 provided. Also, anything done during this post-processing step would
150 need to be comprehended in how the images were prepared before being
151 injected into the FIT creation (i.e. the blobs would have been pre-
152 processed before being added to the FIT image).
153
Ravik Hasija11dac412021-01-27 14:01:48 -0800154config FIT_PRINT
Anand Moon6c368f42024-06-23 23:10:21 +0530155 bool "Support FIT printing"
156 default y
157 help
158 Support printing the content of the fitImage in a verbose manner.
Ravik Hasija11dac412021-01-27 14:01:48 -0800159
Simon Glassb45b1632020-09-10 20:21:13 -0600160config SPL_FIT
161 bool "Support Flattened Image Tree within SPL"
Simon Glass2289ca92023-09-14 10:55:52 -0600162 depends on SPL
Alexandru Gagniuc650b7862021-09-02 19:54:21 -0500163 select SPL_HASH
Simon Glassb45b1632020-09-10 20:21:13 -0600164 select SPL_OF_LIBFDT
165
166config SPL_FIT_PRINT
167 bool "Support FIT printing within SPL"
168 depends on SPL_FIT
169 help
170 Support printing the content of the fitImage in a verbose manner in SPL.
171
Simon Glass244705b2021-02-15 17:08:10 -0700172config SPL_FIT_FULL_CHECK
173 bool "Do a full check of the FIT before using it"
Tom Rini0f3d1de2022-12-04 10:14:20 -0500174 depends on SPL_FIT
Simon Glass244705b2021-02-15 17:08:10 -0700175 help
176 Enable this do a full check of the FIT to make sure it is valid. This
177 helps to protect against carefully crafted FITs which take advantage
178 of bugs or omissions in the code. This includes a bad structure,
179 multiple root nodes and the like.
180
Simon Glassb45b1632020-09-10 20:21:13 -0600181config SPL_FIT_SIGNATURE
182 bool "Enable signature verification of FIT firmware within SPL"
183 depends on SPL_DM
Klaus Heinrich Kiwiae5073f2021-02-09 15:41:54 -0300184 depends on SPL_LOAD_FIT || SPL_LOAD_FIT_FULL
Klaus Heinrich Kiwic9796e62021-02-09 15:41:53 -0300185 select FIT_SIGNATURE
Simon Glassb45b1632020-09-10 20:21:13 -0600186 select SPL_FIT
Simon Glassa8437ce2021-07-10 21:14:25 -0600187 select SPL_CRYPTO
Alexandru Gagniuc97464ff2021-09-02 19:54:19 -0500188 select SPL_HASH
Alexandru Gagniuc1f2e2312021-07-29 11:47:18 -0500189 imply SPL_RSA
190 imply SPL_RSA_VERIFY
Simon Glassb45b1632020-09-10 20:21:13 -0600191 select SPL_IMAGE_SIGN_INFO
Simon Glass244705b2021-02-15 17:08:10 -0700192 select SPL_FIT_FULL_CHECK
Simon Glassb45b1632020-09-10 20:21:13 -0600193
Simon Glassc0cabbc2021-09-25 19:43:39 -0600194config SPL_FIT_SIGNATURE_MAX_SIZE
195 hex "Max size of signed FIT structures in SPL"
196 depends on SPL_FIT_SIGNATURE
197 default 0x10000000
198 help
199 This option sets a max size in bytes for verified FIT uImages.
200 A sane value of 256MB protects corrupted DTB structures from overlapping
201 device memory. Assure this size does not extend past expected storage
202 space.
203
Philippe Reynes47f3eb22021-10-15 11:35:03 +0200204config SPL_FIT_RSASSA_PSS
205 bool "Support rsassa-pss signature scheme of FIT image contents in SPL"
206 depends on SPL_FIT_SIGNATURE
207 help
208 Enable this to support the pss padding algorithm as described
209 in the rfc8017 (https://tools.ietf.org/html/rfc8017) in SPL.
210
Simon Glassb45b1632020-09-10 20:21:13 -0600211config SPL_LOAD_FIT
212 bool "Enable SPL loading U-Boot as a FIT (basic fitImage features)"
Simon Glass2289ca92023-09-14 10:55:52 -0600213 depends on SPL
Simon Glassb45b1632020-09-10 20:21:13 -0600214 select SPL_FIT
215 help
216 Normally with the SPL framework a legacy image is generated as part
217 of the build. This contains U-Boot along with information as to
218 where it should be loaded. This option instead enables generation
219 of a FIT (Flat Image Tree) which provides more flexibility. In
220 particular it can handle selecting from multiple device tree
221 and passing the correct one to U-Boot.
222
Alexandru Gagniuc064c9c22021-03-29 12:05:15 -0500223 This path has the following limitations:
224
Bin Meng91cdcb92021-05-10 20:23:29 +0800225 1. "loadables" images, other than FDTs, which do not have a "load"
Alexandru Gagniuc064c9c22021-03-29 12:05:15 -0500226 property will not be loaded. This limitation also applies to FPGA
227 images with the correct "compatible" string.
Heinrich Schuchardtb72eb352024-06-18 08:23:17 +0200228 2. For FPGA images, the supported "compatible" list may be found in
229 https://fitspec.osfw.foundation/.
Alexandru Gagniuc064c9c22021-03-29 12:05:15 -0500230 3. FDTs are only loaded for images with an "os" property of "u-boot".
231 "linux" images are also supported with Falcon boot mode.
232
Simon Glassb45b1632020-09-10 20:21:13 -0600233config SPL_LOAD_FIT_ADDRESS
234 hex "load address of fit image"
Simon Glassdfcedda2023-09-14 10:55:51 -0600235 depends on SPL_LOAD_FIT
Simon Glassb45b1632020-09-10 20:21:13 -0600236 default 0x0
237 help
238 Specify the load address of the fit image that will be loaded
239 by SPL.
240
241config SPL_LOAD_FIT_APPLY_OVERLAY
242 bool "Enable SPL applying DT overlays from FIT"
243 depends on SPL_LOAD_FIT
244 select OF_LIBFDT_OVERLAY
245 help
Hugo Villeneuve5c1c6cc2023-04-24 16:51:12 -0400246 The device tree is loaded from the FIT image. Allow the SPL to
Simon Glassb45b1632020-09-10 20:21:13 -0600247 also load device-tree overlays from the FIT image an apply them
248 over the device tree.
249
250config SPL_LOAD_FIT_APPLY_OVERLAY_BUF_SZ
251 depends on SPL_LOAD_FIT_APPLY_OVERLAY
252 default 0x10000
253 hex "size of temporary buffer used to load the overlays"
254 help
255 The size of the area where the overlays will be loaded and
256 uncompress. Must be at least as large as biggest overlay
257 (uncompressed)
258
259config SPL_LOAD_FIT_FULL
260 bool "Enable SPL loading U-Boot as a FIT (full fitImage features)"
261 select SPL_FIT
262 help
263 Normally with the SPL framework a legacy image is generated as part
264 of the build. This contains U-Boot along with information as to
265 where it should be loaded. This option instead enables generation
266 of a FIT (Flat Image Tree) which provides more flexibility. In
267 particular it can handle selecting from multiple device tree
268 and passing the correct one to U-Boot.
269
270config SPL_FIT_IMAGE_POST_PROCESS
271 bool "Enable post-processing of FIT artifacts after loading by the SPL"
272 depends on SPL_LOAD_FIT
Andrew Davis4ba9e6e2022-05-04 15:52:28 -0500273 default y if TI_SECURE_DEVICE
Simon Glassb45b1632020-09-10 20:21:13 -0600274 help
275 Allows doing any sort of manipulation to blobs after they got extracted
276 from the U-Boot FIT image like stripping off headers or modifying the
277 size of the blob, verification, authentication, decryption etc. in a
278 platform or board specific way. In order to use this feature a platform
279 or board-specific implementation of board_fit_image_post_process() must
280 be provided. Also, anything done during this post-processing step would
281 need to be comprehended in how the images were prepared before being
282 injected into the FIT creation (i.e. the blobs would have been pre-
283 processed before being added to the FIT image).
284
Tom Rinibaed5b42024-10-15 16:51:05 -0600285config USE_SPL_FIT_GENERATOR
286 bool "Use a script to generate the .its script"
287 depends on SPL_FIT
288 default y if SPL_FIT && ARCH_ZYNQMP
289
290config SPL_FIT_GENERATOR
291 string ".its file generator script for U-Boot FIT image"
292 depends on USE_SPL_FIT_GENERATOR
293 default "arch/arm/mach-zynqmp/mkimage_fit_atf.sh" if SPL_LOAD_FIT && ARCH_ZYNQMP
294 help
295 Specifies a (platform specific) script file to generate the FIT
296 source file used to build the U-Boot FIT image file. This gets
297 passed a list of supported device tree file stub names to
298 include in the generated image.
299
Simon Glassbc993e52022-10-20 18:23:13 -0600300if VPL
301
302config VPL_FIT
303 bool "Support Flattened Image Tree within VPL"
304 depends on VPL
305 default y
306 select VPL_HASH
307 select VPL_OF_LIBFDT
308
309config VPL_FIT_PRINT
310 bool "Support FIT printing within VPL"
311 depends on VPL_FIT
312 default y
313 help
314 Support printing the content of the fitImage in a verbose manner in VPL.
315
316config VPL_FIT_FULL_CHECK
317 bool "Do a full check of the FIT before using it"
318 default y
319 help
320 Enable this do a full check of the FIT to make sure it is valid. This
321 helps to protect against carefully crafted FITs which take advantage
322 of bugs or omissions in the code. This includes a bad structure,
323 multiple root nodes and the like.
324
325config VPL_FIT_SIGNATURE
326 bool "Enable signature verification of FIT firmware within VPL"
327 depends on VPL_DM
Simon Glassbc993e52022-10-20 18:23:13 -0600328 default y
329 select FIT_SIGNATURE
330 select VPL_FIT
331 select VPL_CRYPTO
332 select VPL_HASH
333 imply VPL_RSA
334 imply VPL_RSA_VERIFY
335 select VPL_IMAGE_SIGN_INFO
336 select VPL_FIT_FULL_CHECK
337
338config VPL_FIT_SIGNATURE_MAX_SIZE
339 hex "Max size of signed FIT structures in VPL"
340 depends on VPL_FIT_SIGNATURE
341 default 0x10000000
342 help
343 This option sets a max size in bytes for verified FIT uImages.
344 A sane value of 256MB protects corrupted DTB structures from overlapping
345 device memory. Assure this size does not extend past expected storage
346 space.
347
348endif # VPL
349
Simon Glass2289ca92023-09-14 10:55:52 -0600350endif # FIT
351
John Keeping9b60a172022-07-28 11:19:15 +0100352config PXE_UTILS
353 bool
354 select MENU
355 help
356 Utilities for parsing PXE file formats.
357
Tom Rini984bfdc2023-10-26 14:31:24 -0400358config BOOT_DEFAULTS_FEATURES
359 bool
360 select SUPPORT_RAW_INITRD
361 select ENV_VARS_UBOOT_CONFIG
362 imply USB_STORAGE
363 imply EFI_PARTITION
364 imply ISO_PARTITION
365
366config BOOT_DEFAULTS_CMDS
367 bool
Simon Glass054d0182023-03-24 16:58:13 -0400368 imply USE_BOOTCOMMAND
369 select CMD_ENV_EXISTS
370 select CMD_EXT2
371 select CMD_EXT4
372 select CMD_FAT
373 select CMD_FS_GENERIC
374 select CMD_PART if PARTITIONS
375 select CMD_DHCP if CMD_NET
376 select CMD_PING if CMD_NET
377 select CMD_PXE if CMD_NET
Simon Glass054d0182023-03-24 16:58:13 -0400378 select CMD_BOOTI if ARM64
379 select CMD_BOOTZ if ARM && !ARM64
380 imply CMD_MII if NET
Tom Rini984bfdc2023-10-26 14:31:24 -0400381
382config BOOT_DEFAULTS
383 bool # Common defaults for standard boot and distroboot
384 select BOOT_DEFAULTS_FEATURES
385 select BOOT_DEFAULTS_CMDS if CMDLINE
Simon Glass054d0182023-03-24 16:58:13 -0400386 help
387 These are not required but are commonly needed to support a good
388 selection of booting methods. Enable this to improve the capability
389 of U-Boot to boot various images. Currently much functionality is
390 tied to enabling the command that exercises it.
391
Simon Glass6cfb0022023-09-14 10:55:53 -0600392menuconfig BOOTSTD
393 bool "Standard boot"
Simon Glass08ad13e2022-04-24 23:31:06 -0600394 default y
395 depends on DM && OF_CONTROL && BLK
396 help
397 U-Boot supports a standard way of locating something to boot,
398 typically an Operating System such as Linux, provided by a distro such
399 as Arch Linux or Debian. Enable this to support iterating through
400 available bootdevs and using bootmeths to find bootflows suitable for
401 booting.
402
403 Standard boot is not a standard way of booting, just a framework
404 within U-Boot for supporting all the different ways that exist.
405
406 Terminology:
407
408 - bootdev - a device which can hold a distro (e.g. MMC)
409 - bootmeth - a method to scan a bootdev to find bootflows (owned by
410 U-Boot)
411 - bootflow - a description of how to boot (owned by the distro)
412
Simon Glass6cfb0022023-09-14 10:55:53 -0600413if BOOTSTD
414
Simon Glassbc993e52022-10-20 18:23:13 -0600415config SPL_BOOTSTD
Simon Glass4aa874f2023-02-22 09:33:58 -0700416 bool "Standard boot support in SPL"
Simon Glassbc993e52022-10-20 18:23:13 -0600417 depends on SPL && SPL_DM && SPL_OF_CONTROL && SPL_BLK
418 default y if VPL
419 help
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200420 This enables standard boot in SPL. This is needed so that VBE
Simon Glassbc993e52022-10-20 18:23:13 -0600421 (Verified Boot for Embedded) can be used, since it depends on standard
422 boot. It is enabled by default since the main purpose of VPL is to
423 handle the firmware part of VBE.
424
425config VPL_BOOTSTD
426 bool "Standard boot support in VPL"
427 depends on VPL && VPL_DM && VPL_OF_CONTROL && VPL_BLK
428 default y
429 help
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200430 This enables standard boot in SPL. This is needed so that VBE
Simon Glassbc993e52022-10-20 18:23:13 -0600431 (Verified Boot for Embedded) can be used, since it depends on standard
432 boot. It is enabled by default since the main purpose of VPL is to
433 handle the firmware part of VBE.
434
Simon Glass78c79dd2023-02-22 14:06:23 -0700435config BOOTSTD_FULL
436 bool "Enhanced features for standard boot"
437 default y if SANDBOX
Shantur Rathore19b54342023-12-23 06:51:59 +0000438 imply BOOTSTD_DEFAULTS
Simon Glass78c79dd2023-02-22 14:06:23 -0700439 help
440 This enables various useful features for standard boot, which are not
441 essential for operation:
442
443 - bootdev, bootmeth commands
444 - extra features in the bootflow command
445 - support for selecting the ordering of bootmeths ("bootmeth order")
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200446 - support for selecting the ordering of bootdevs using the Device Tree
Simon Glass78c79dd2023-02-22 14:06:23 -0700447 as well as the "boot_targets" environment variable
448
Simon Glass2e5161eb2023-01-28 15:00:21 -0700449config BOOTSTD_DEFAULTS
450 bool "Select some common defaults for standard boot"
451 depends on BOOTSTD
Simon Glass054d0182023-03-24 16:58:13 -0400452 select BOOT_DEFAULTS
Simon Glassdb92e782023-05-10 16:34:47 -0600453 select BOOTMETH_DISTRO
Simon Glass2e5161eb2023-01-28 15:00:21 -0700454 help
455 These are not required but are commonly needed to support a good
456 selection of booting methods. Enable this to improve the capability
457 of U-Boot to boot various images.
458
Simon Glassbe661cb2022-04-24 23:31:27 -0600459config BOOTSTD_BOOTCOMMAND
460 bool "Use bootstd to boot"
461 default y if !DISTRO_DEFAULTS
462 help
463 Enable this to select a default boot-command suitable for booting
464 with standard boot. This can be overridden by the board if needed,
465 but the default command should be enough for most boards which use
466 standard boot.
467
468 For now this is only selected if distro boot is NOT used, since
469 standard boot does not support all of the features of distro boot
470 yet.
471
Marek Vasutabb772a2024-10-20 17:43:12 +0200472config BOOTSTD_MENU
473 bool "Provide a menu of available bootflows for standard boot"
474 depends on BOOTSTD_FULL && EXPO
475 default y
476 help
477 Provide a menu of available bootflows and related options.
478
Simon Glass92368522023-11-18 14:05:19 -0700479config BOOTSTD_PROG
480 bool "Use programmatic boot"
481 depends on !CMDLINE
482 default y
483 help
484 Enable this to provide a board_run_command() function which can boot
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200485 a system without using commands. If the boot fails, then U-Boot will
Simon Glass92368522023-11-18 14:05:19 -0700486 panic.
487
488 Note: This currently has many limitations and is not a useful booting
489 solution. Future work will eventually make this a viable option.
490
Simon Glass4f8633d2022-07-30 15:52:21 -0600491config BOOTMETH_GLOBAL
492 bool
493 help
494 Add support for global bootmeths. This feature is used by VBE and
495 EFI bootmgr, since they take full control over which bootdevs are
496 selected to boot.
497
Mattijs Korpershoekb30baa92024-07-10 10:40:05 +0200498config BOOTMETH_ANDROID
499 bool "Bootdev support for Android"
500 depends on X86 || ARM || SANDBOX
501 depends on CMDLINE
502 select ANDROID_AB
503 select ANDROID_BOOT_IMAGE
504 select CMD_BCB
Jerome Forissiere0f95512024-10-16 12:03:59 +0200505 imply CMD_FASTBOOT
506 imply FASTBOOT if !NET_LWIP
Mattijs Korpershoekb30baa92024-07-10 10:40:05 +0200507 select PARTITION_TYPE_GUID
508 select PARTITION_UUIDS
509 help
510 Enables support for booting Android using bootstd. Android requires
511 multiple partitions (misc, boot, vbmeta, ...) in storage for booting.
512
513 Note that only MMC bootdevs are supported at present. This is caused
514 by AVB being limited to MMC devices only.
515
Simon Glassd74e62a2023-07-12 09:04:45 -0600516config BOOTMETH_CROS
517 bool "Bootdev support for Chromium OS"
Simon Glass18700262023-07-30 11:17:02 -0600518 depends on X86 || ARM || SANDBOX
519 default y if !ARM
Simon Glassd7d3a972023-08-24 13:55:45 -0600520 select EFI_PARTITION
521 select PARTITION_TYPE_GUID
522 select PARTITION_UUIDS
Simon Glassd74e62a2023-07-12 09:04:45 -0600523 help
524 Enables support for booting Chromium OS using bootdevs. This uses the
525 kernel A slot and obtains the kernel command line from the parameters
526 provided there.
527
528 Note that only x86 devices are supported at present.
529
Simon Glassb71d7f72023-05-10 16:34:46 -0600530config BOOTMETH_EXTLINUX
531 bool "Bootdev support for extlinux boot"
John Keeping9b60a172022-07-28 11:19:15 +0100532 select PXE_UTILS
Simon Glassad8ec372022-04-24 23:31:13 -0600533 default y
534 help
Simon Glassb71d7f72023-05-10 16:34:46 -0600535 Enables support for extlinux boot using bootdevs. This makes the
Simon Glassad8ec372022-04-24 23:31:13 -0600536 bootdevs look for a 'extlinux/extlinux.conf' on each filesystem
537 they scan.
538
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200539 The specification for this file is here:
Simon Glassb71d7f72023-05-10 16:34:46 -0600540
541 https://uapi-group.org/specifications/specs/boot_loader_specification/
542
Simon Glassad8ec372022-04-24 23:31:13 -0600543 This provides a way to try out standard boot on an existing boot flow.
544
Simon Glassb71d7f72023-05-10 16:34:46 -0600545config BOOTMETH_EXTLINUX_PXE
546 bool "Bootdev support for extlinux boot over network"
Simon Glass83144612022-04-24 23:31:16 -0600547 depends on CMD_PXE && CMD_NET && DM_ETH
548 default y
549 help
Simon Glassb71d7f72023-05-10 16:34:46 -0600550 Enables support for extlinux boot using bootdevs. This makes the
Simon Glass83144612022-04-24 23:31:16 -0600551 bootdevs look for a 'extlinux/extlinux.conf' on the tftp server.
552
Simon Glassb71d7f72023-05-10 16:34:46 -0600553 The specification for this file is here:
554
555 https://uapi-group.org/specifications/specs/boot_loader_specification/
556
Simon Glass83144612022-04-24 23:31:16 -0600557 This provides a way to try out standard boot on an existing boot flow.
558
Simon Glass66f62552022-04-24 23:31:17 -0600559config BOOTMETH_EFILOADER
560 bool "Bootdev support for EFI boot"
AKASHI Takahiro9b08b9a2024-01-17 13:39:41 +0900561 depends on EFI_BINARY_EXEC
Jerome Forissiere0f95512024-10-16 12:03:59 +0200562 imply CMD_TFTPBOOT if CMD_NET
Simon Glass66f62552022-04-24 23:31:17 -0600563 default y
564 help
565 Enables support for EFI boot using bootdevs. This makes the
566 bootdevs look for a 'boot<arch>.efi' on each filesystem
567 they scan. The resulting file is booted after enabling U-Boot's
568 EFI loader support.
569
570 The <arch> depends on the architecture of the board:
571
572 aa64 - aarch64 (ARM 64-bit)
573 arm - ARM 32-bit
574 ia32 - x86 32-bit
575 x64 - x86 64-bit
576 riscv32 - RISC-V 32-bit
577 riscv64 - RISC-V 64-bit
578
579 This provides a way to try out standard boot on an existing boot flow.
580
Heinrich Schuchardt72bca1a2024-04-03 20:05:17 +0200581config BOOTMETH_EFI_BOOTMGR
582 bool "Bootdev support for EFI boot manager"
583 depends on EFI_BOOTMGR
584 select BOOTMETH_GLOBAL
585 default y
586 help
587 Enable booting via the UEFI boot manager. Based on the EFI variables
588 the EFI binary to be launched is determined. To set the EFI variables
589 use the eficonfig command.
590
Heinrich Schuchardt1cd3ec92024-07-16 10:35:34 +0200591config BOOTMETH_QFW
592 bool "Boot method using QEMU parameters"
593 depends on QFW
594 default y
595 help
596 Use QEMU parameters -kernel, -initrd, -append to determine the kernel,
597 initial RAM disk, and kernel command line parameters to boot an
598 operating system. U-Boot's control device-tree is passed to the kernel.
599
Simon Glass0a9f4262022-07-30 15:52:32 -0600600config BOOTMETH_VBE
601 bool "Bootdev support for Verified Boot for Embedded"
602 depends on FIT
603 default y
604 select BOOTMETH_GLOBAL
Tom Rini7d3684a2023-01-16 15:46:49 -0500605 select EVENT
Simon Glass0a9f4262022-07-30 15:52:32 -0600606 help
607 Enables support for VBE boot. This is a standard boot method which
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200608 supports selection of various firmware components, selection of an OS to
Simon Glass0a9f4262022-07-30 15:52:32 -0600609 boot as well as updating these using fwupd.
610
Simon Glassdb92e782023-05-10 16:34:47 -0600611config BOOTMETH_DISTRO
612 bool # Options needed to boot any distro
Tom Rini9bf470a2023-10-26 14:31:27 -0400613 select BOOTMETH_SCRIPT if CMDLINE # E.g. Armbian uses scripts
Simon Glassdb92e782023-05-10 16:34:47 -0600614 select BOOTMETH_EXTLINUX # E.g. Debian uses these
615 select BOOTMETH_EXTLINUX_PXE if CMD_PXE && CMD_NET && DM_ETH
AKASHI Takahiro9b08b9a2024-01-17 13:39:41 +0900616 select BOOTMETH_EFILOADER if EFI_BINARY_EXEC # E.g. Ubuntu uses this
Simon Glassdb92e782023-05-10 16:34:47 -0600617
Simon Glassbc993e52022-10-20 18:23:13 -0600618config SPL_BOOTMETH_VBE
619 bool "Bootdev support for Verified Boot for Embedded (SPL)"
620 depends on SPL && FIT
Tom Rini7d3684a2023-01-16 15:46:49 -0500621 select EVENT
Simon Glassbc993e52022-10-20 18:23:13 -0600622 default y if VPL
623 help
624 Enables support for VBE boot. This is a standard boot method which
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200625 supports selection of various firmware components, selection of an OS to
Simon Glassbc993e52022-10-20 18:23:13 -0600626 boot as well as updating these using fwupd.
627
628config VPL_BOOTMETH_VBE
629 bool "Bootdev support for Verified Boot for Embedded (VPL)"
630 depends on VPL && FIT
Tom Rini7d3684a2023-01-16 15:46:49 -0500631 select EVENT
Simon Glassbc993e52022-10-20 18:23:13 -0600632 default y
633 help
634 Enables support for VBE boot. This is a standard boot method which
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200635 supports selection of various firmware components, selection of an OS to
Simon Glassbc993e52022-10-20 18:23:13 -0600636 boot as well as updating these using fwupd.
637
Simon Glassd0af04c2022-07-30 15:52:33 -0600638if BOOTMETH_VBE
639
Simon Glass513eeed2023-02-22 09:33:52 -0700640config BOOTMETH_VBE_REQUEST
641 bool "Support for serving VBE OS requests"
642 default y
643 help
644 Enables support for looking that the requests made by the
645 Operating System being booted. These requests result in additions to
646 the device tree /chosen node, added during the device tree fixup
647 phase.
648
649config SPL_BOOTMETH_VBE_REQUEST
650 bool "Support for serving VBE OS requests (SPL)"
651 depends on SPL
652 help
653 Enables support for looking that the requests made by the
654 Operating System being booted. These requests result in additions to
655 the device tree /chosen node, added during the device tree fixup
656 phase.
657
658 This is only useful if you are booting an OS direct from SPL.
659
Simon Glassd0af04c2022-07-30 15:52:33 -0600660config BOOTMETH_VBE_SIMPLE
661 bool "Bootdev support for VBE 'simple' method"
662 default y
663 help
664 Enables support for VBE 'simple' boot. This allows updating a single
665 firmware image in boot media such as MMC. It does not support any sort
666 of rollback, recovery or A/B boot.
667
Simon Glassbc993e52022-10-20 18:23:13 -0600668config BOOTMETH_VBE_SIMPLE_OS
669 bool "Bootdev support for VBE 'simple' method OS phase"
670 default y
671 help
672 Enables support for the OS parts of VBE 'simple' boot. This includes
673 fixing up the device tree with the required VBE information, ready
674 for booting into the OS. This option is only enabled for U-Boot
675 proper, since it is the phase where device tree fixups happen.
676
677config SPL_BOOTMETH_VBE_SIMPLE
678 bool "Bootdev support for VBE 'simple' method (SPL)"
679 depends on SPL
680 default y if VPL
681 help
682 Enables support for VBE 'simple' boot. This allows updating a single
683 firmware image in boot media such as MMC. It does not support any sort
684 of rollback, recovery or A/B boot.
685
686config VPL_BOOTMETH_VBE_SIMPLE
687 bool "Bootdev support for VBE 'simple' method (VPL)"
688 depends on VPL
689 default y
690 help
691 Enables support for VBE 'simple' boot. This allows updating a single
692 firmware image in boot media such as MMC. It does not support any sort
693 of rollback, recovery or A/B boot.
694
695config SPL_BOOTMETH_VBE_SIMPLE_FW
696 bool "Bootdev support for VBE 'simple' method firmware phase (SPL)"
697 depends on VPL
698 default y
699 help
700 Enables support for the firmware parts of VBE 'simple' boot. This
701 includes an SPL loader which locates the correct U-Boot to boot into.
702 This option should really only be enabled for VPL, since it is the
703 phase where the SPL + U-Boot decision should be made. But for now,
704 SPL does its own FIT-configuration selection.
705
706config VPL_BOOTMETH_VBE_SIMPLE_FW
707 bool "Bootdev support for VBE 'simple' method firmware phase (VPL)"
708 depends on VPL
709 default y
710 help
711 Enables support for the firmware parts of VBE 'simple' boot. This
712 includes an SPL loader which locates the correct SPL to boot into.
713 This option enabled for VPL, since it is the phase where the SPL
714 decision is made.
715
Simon Glassd0af04c2022-07-30 15:52:33 -0600716endif # BOOTMETH_VBE
717
Simon Glassd8adbe92023-01-06 08:52:36 -0600718config EXPO
719 bool "Support for expos - groups of scenes displaying a UI"
Simon Glass389a4582023-01-28 15:00:18 -0700720 depends on VIDEO
Simon Glassd8adbe92023-01-06 08:52:36 -0600721 default y if BOOTMETH_VBE
722 help
723 An expo is a way of presenting and collecting information from the
724 user. It consists of a collection of 'scenes' of which only one is
725 presented at a time. An expo is typically used to show a boot menu
726 and allow settings to be changed.
727
728 The expo can be presented in graphics form using a vidconsole, or in
729 text form on a serial console.
730
Simon Glass423994e2022-04-24 23:31:20 -0600731config BOOTMETH_SANDBOX
732 def_bool y
733 depends on SANDBOX
734 help
735 This is a sandbox bootmeth driver used for testing. It always returns
736 -ENOTSUPP when attempting to boot.
737
Simon Glass7e03e742022-04-24 23:31:22 -0600738config BOOTMETH_SCRIPT
739 bool "Bootdev support for U-Boot scripts"
740 default y if BOOTSTD_FULL
Tom Rini9bf470a2023-10-26 14:31:27 -0400741 depends on CMDLINE
Simon Glassb4b7ebe2023-05-05 20:03:05 -0600742 select HUSH_PARSER
Simon Glass7e03e742022-04-24 23:31:22 -0600743 help
744 Enables support for booting a distro via a U-Boot script. This makes
745 the bootdevs look for a 'boot/boot.scr' file which can be used to
746 boot the distro.
747
748 This provides a way to try out standard boot on an existing boot flow.
749 It is not enabled by default to save space.
750
Simon Glass77459f42024-08-07 16:47:27 -0600751config UPL
752 bool "upl - Universal Payload Specification"
Simon Glass3a028c22024-08-07 16:47:30 -0600753 imply CMD_UPL
Simon Glass77459f42024-08-07 16:47:27 -0600754 imply UPL_READ
Simon Glassb9474a82024-08-07 16:47:28 -0600755 imply UPL_WRITE
Simon Glassbc3ec002024-08-07 16:47:31 -0600756 imply SPL_UPL if SPL
Simon Glass77459f42024-08-07 16:47:27 -0600757 help
758 Provides support for UPL payloads and handoff information. U-Boot
759 supports generating and accepting handoff information. The mkimage
760 tool will eventually support creating payloads.
761
762if UPL
763
764config UPL_READ
765 bool "upl - Support reading a Universal Payload handoff"
766 help
767 Provides support for decoding a UPL-format payload into a C structure
768 which can be used elsewhere in U-Boot. This is just the reading
Simon Glass45aec8e2024-08-07 16:47:34 -0600769 implementation, useful for trying it out. See UPL_IN for how
770 to tell U-Boot to actually read it on startup and use it for memory
771 and device information, etc.
Simon Glass77459f42024-08-07 16:47:27 -0600772
Simon Glassb9474a82024-08-07 16:47:28 -0600773config UPL_WRITE
774 bool "upl - Support writing a Universal Payload handoff"
775 help
776 Provides support for encoding a UPL-format payload from a C structure
777 so it can be passed to another program. This is just the writing
Simon Glassbc3ec002024-08-07 16:47:31 -0600778 implementation, useful for trying it out. See SPL_UPL_OUT
779 for how to tell U-Boot SPL to actually write it before jumping to
780 the next phase.
781
Simon Glass45aec8e2024-08-07 16:47:34 -0600782config UPL_IN
783 bool "upl - Read the UPL handoff on startup"
784 select UPL_READ
785 help
786 Read an SPL handoff when U-Boot starts and use it to provide
787 devices, memory layout, etc. required by U-Boot. This allows U-Boot
788 to function as a payload in the meaning of the specification.
789
Simon Glassbc3ec002024-08-07 16:47:31 -0600790if SPL
791
792config SPL_UPL
793 bool "Write a UPL handoff in SPL"
794 imply SPL_UPL_OUT
795 help
796 This tells SPL to write a UPL handoff and pass it to the next phase
797 (e.g. to U-Boot or another program which SPL loads and runs). THis
798 provides information to help that program run correctly and
799 efficiently on the machine.
800
801config SPL_UPL_WRITE
802 bool # upl - Support writing a Universal Payload handoff in SPL
803 select SPL_BLOBLIST
804 help
805 Provides support for encoding a UPL-format payload from a C structure
806 so it can be passed to another program. This is just the writing
Simon Glassb9474a82024-08-07 16:47:28 -0600807 implementation, useful for trying it out.
808
Simon Glassbc3ec002024-08-07 16:47:31 -0600809config SPL_UPL_OUT
810 bool "upl - Support writing a Universal Payload handoff in SPL"
811 select SPL_UPL_WRITE
812 help
813 Provides support for encoding a UPL-format payload and passing it to
814 the next firmware phase. This allows U-Boot SPL to function as
815 Platform Init in the meaning of the specification.
816
817endif # SPL
818
Simon Glass77459f42024-08-07 16:47:27 -0600819endif # UPL
820
Simon Glass6cfb0022023-09-14 10:55:53 -0600821endif # BOOTSTD
Simon Glassad8ec372022-04-24 23:31:13 -0600822
Simon Glassb45b1632020-09-10 20:21:13 -0600823config LEGACY_IMAGE_FORMAT
824 bool "Enable support for the legacy image format"
Andrew Davis98a22d02022-05-04 15:52:27 -0500825 default y if !FIT_SIGNATURE && !TI_SECURE_DEVICE
Simon Glassb45b1632020-09-10 20:21:13 -0600826 help
827 This option enables the legacy image format. It is enabled by
828 default for backward compatibility, unless FIT_SIGNATURE is
829 set where it is disabled so that unsigned images cannot be
830 loaded. If a board needs the legacy image format support in this
831 case, enable it here.
832
Eddie James32401ba2023-10-24 10:43:50 -0500833config MEASURED_BOOT
834 bool "Measure boot images and configuration when booting without EFI"
835 depends on HASH && TPM_V2
Ilias Apalodimas1e665f92024-06-23 14:48:18 +0300836 select SHA1
837 select SHA256
838 select SHA384
839 select SHA512
Eddie James32401ba2023-10-24 10:43:50 -0500840 help
841 This option enables measurement of the boot process when booting
842 without UEFI . Measurement involves creating cryptographic hashes
843 of the binary images that are booting and storing them in the TPM.
844 In addition, a log of these hashes is stored in memory for the OS
845 to verify the booted images and configuration. Enable this if the
846 OS has configured some memory area for the event log and you intend
847 to use some attestation tools on your system.
848
849if MEASURED_BOOT
850 config MEASURE_DEVICETREE
851 bool "Measure the devicetree image"
852 default y if MEASURED_BOOT
853 help
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200854 On some platforms, the Device Tree is not static as it may contain
Eddie James32401ba2023-10-24 10:43:50 -0500855 random MAC addresses or other such data that changes each boot.
856 Therefore, it should not be measured into the TPM. In that case,
857 disable the measurement here.
858
859 config MEASURE_IGNORE_LOG
860 bool "Ignore the existing event log"
Eddie James32401ba2023-10-24 10:43:50 -0500861 help
862 On platforms that use an event log memory region that persists
863 through system resets and are the first stage bootloader, then
864 this option should be enabled to ignore any existing data in the
865 event log memory region.
866endif # MEASURED_BOOT
867
Tom Riniec8d1602023-10-26 14:31:25 -0400868config SYS_BOOTM_LEN
869 hex "Maximum size of a decompresed OS image"
Tom Rini793921e2024-04-18 08:29:35 -0600870 depends on CMD_BOOTM || CMD_BOOTI || CMD_BOOTZ || \
Tom Riniec8d1602023-10-26 14:31:25 -0400871 LEGACY_IMAGE_FORMAT || SPL_LEGACY_IMAGE_FORMAT
872 default 0x4000000 if PPC || ARM64
873 default 0x1000000 if X86 || ARCH_MX6 || ARCH_MX7
874 default 0x800000
875 help
876 This is the maximum size of the buffer that is used to decompress the OS
877 image in to if attempting to boot a compressed image.
878
Simon Glassf11d6132020-09-10 20:21:19 -0600879config SUPPORT_RAW_INITRD
880 bool "Enable raw initrd images"
881 help
882 Note, defining the SUPPORT_RAW_INITRD allows user to supply
883 kernel with raw initrd images. The syntax is slightly different, the
884 address of the initrd must be augmented by it's size, in the following
885 format: "<initrd address>:<initrd size>".
886
Simon Glassd81f07f2020-11-04 09:57:35 -0700887config CHROMEOS
888 bool "Support booting Chrome OS"
889 help
890 Chrome OS requires U-Boot to set up a table indicating the boot mode
891 (e.g. Developer mode) and a few other things. Enable this if you are
892 booting on a Chromebook to avoid getting an error about an invalid
893 firmware ID.
894
895config CHROMEOS_VBOOT
896 bool "Support Chrome OS verified boot"
897 help
898 This is intended to enable the full Chrome OS verified boot support
899 in U-Boot. It is not actually implemented in the U-Boot source code
900 at present, so this option is always set to 'n'. It allows
901 distinguishing between booting Chrome OS in a basic way (developer
902 mode) and a full boot.
903
Tom Rinieb4f2de2022-06-25 11:02:44 -0400904config SYS_RAMBOOT
905 bool
906
Tom Rini9ff815a2021-08-24 23:11:49 -0400907config RAMBOOT_PBL
908 bool "Freescale PBL(pre-boot loader) image format support"
Tom Rinieb4f2de2022-06-25 11:02:44 -0400909 select SYS_RAMBOOT if PPC
Tom Rini9ff815a2021-08-24 23:11:49 -0400910 help
911 Some SoCs use PBL to load RCW and/or pre-initialization instructions.
912 For more details refer to doc/README.pblimage
913
Tom Rini886e6e32022-03-23 17:20:03 -0400914choice
Tom Rini489f4022022-12-28 10:52:51 -0500915 prompt "Freescale PBL (or predecessor) load location"
Tom Rini886e6e32022-03-23 17:20:03 -0400916 depends on RAMBOOT_PBL || ((TARGET_P1010RDB_PA || TARGET_P1010RDB_PB \
917 || TARGET_P1020RDB_PC || TARGET_P1020RDB_PD || TARGET_P2020RDB) \
Pali Rohár6763ff82024-06-06 18:33:26 +0200918 && !CMD_NAND) || (TARGET_TURRIS_1X && SYS_MPC85XX_NO_RESETVEC)
Tom Rini886e6e32022-03-23 17:20:03 -0400919
920config SDCARD
Tom Rini489f4022022-12-28 10:52:51 -0500921 bool "Freescale PBL (or similar) is found on SD card"
Tom Rini886e6e32022-03-23 17:20:03 -0400922
923config SPIFLASH
Tom Rini489f4022022-12-28 10:52:51 -0500924 bool "Freescale PBL (or similar) is found on SPI flash"
925
926config NO_PBL
927 bool "Freescale PBL (or similar) is not used in this case"
Tom Rini886e6e32022-03-23 17:20:03 -0400928
929endchoice
930
Tom Rini5989fd42022-06-20 08:07:42 -0400931config FSL_FIXED_MMC_LOCATION
932 bool "PBL MMC is at a fixed location"
933 depends on SDCARD && !RAMBOOT_PBL
934
935config ESDHC_HC_BLK_ADDR
936 def_bool y
937 depends on FSL_FIXED_MMC_LOCATION && (ARCH_BSC9131 || ARCH_BSC9132 || ARCH_P1010)
938 help
939 In High Capacity SD Cards (> 2 GBytes), the 32-bit source address and
940 code length of these soc specify the memory address in block address
941 format. Block length is fixed to 512 bytes as per the SD High
942 Capacity specification.
943
Tom Rini9ff815a2021-08-24 23:11:49 -0400944config SYS_FSL_PBL_PBI
945 string "PBI(pre-boot instructions) commands for the PBL image"
946 depends on RAMBOOT_PBL
947 help
948 PBI commands can be used to configure SoC before it starts the execution.
949 Please refer doc/README.pblimage for more details.
950
951config SYS_FSL_PBL_RCW
952 string "Aadditional RCW (Power on reset configuration) for the PBL image"
953 depends on RAMBOOT_PBL
954 help
955 Enables addition of RCW (Power on reset configuration) in built image.
956 Please refer doc/README.pblimage for more details.
957
Tom Rini94b4fec2022-06-25 11:02:46 -0400958config SYS_BOOT_RAMDISK_HIGH
959 depends on CMD_BOOTM || CMD_BOOTI || CMD_BOOTZ
960 depends on !(NIOS2 || SANDBOX || SH || XTENSA)
961 def_bool y
Simon Glass65edcd32023-03-24 16:58:12 -0400962 select LMB
Tom Rini94b4fec2022-06-25 11:02:46 -0400963 help
964 Enable initrd_high functionality. If defined then the initrd_high
965 feature is enabled and the boot* ramdisk subcommand is enabled.
966
Simon Glassb45b1632020-09-10 20:21:13 -0600967endmenu # Boot images
968
Simon Glassf111bf72023-03-24 16:58:11 -0400969config DISTRO_DEFAULTS
Simon Glasse27d7df2023-09-14 10:55:55 -0600970 bool "(deprecated) Script-based booting of Linux distributions"
Tom Rini045245b2023-10-26 14:31:23 -0400971 select CMDLINE
Simon Glass054d0182023-03-24 16:58:13 -0400972 select BOOT_DEFAULTS
Simon Glassf111bf72023-03-24 16:58:11 -0400973 select AUTO_COMPLETE
974 select CMDLINE_EDITING
Simon Glassf111bf72023-03-24 16:58:11 -0400975 select CMD_SYSBOOT
Simon Glassf111bf72023-03-24 16:58:11 -0400976 select HUSH_PARSER
Simon Glassf111bf72023-03-24 16:58:11 -0400977 select SYS_LONGHELP
Simon Glassf111bf72023-03-24 16:58:11 -0400978 help
Simon Glasse27d7df2023-09-14 10:55:55 -0600979 Note: These scripts have been replaced by Standard Boot. Do not use
980 them on new boards. See 'Migrating from distro_boot' at
981 doc/develop/bootstd.rst
982
Simon Glassf111bf72023-03-24 16:58:11 -0400983 Select this to enable various options and commands which are suitable
984 for building u-boot for booting general purpose Linux distributions.
985
Simon Glassd02ddcf2020-09-10 20:21:14 -0600986menu "Boot timing"
987
988config BOOTSTAGE
989 bool "Boot timing and reporting"
990 help
991 Enable recording of boot time while booting. To use it, insert
992 calls to bootstage_mark() with a suitable BOOTSTAGE_ID from
993 bootstage.h. Only a single entry is recorded for each ID. You can
994 give the entry a name with bootstage_mark_name(). You can also
995 record elapsed time in a particular stage using bootstage_start()
996 before starting and bootstage_accum() when finished. Bootstage will
997 add up all the accumulated time and report it.
998
999 Normally, IDs are defined in bootstage.h but a small number of
1000 additional 'user' IDs can be used by passing BOOTSTAGE_ID_ALLOC
1001 as the ID.
1002
1003 Calls to show_boot_progress() will also result in log entries but
1004 these will not have names.
1005
1006config SPL_BOOTSTAGE
1007 bool "Boot timing and reported in SPL"
Tom Rini0a83cc22022-06-10 23:03:09 -04001008 depends on BOOTSTAGE && SPL
Simon Glassd02ddcf2020-09-10 20:21:14 -06001009 help
1010 Enable recording of boot time in SPL. To make this visible to U-Boot
1011 proper, enable BOOTSTAGE_STASH as well. This will stash the timing
1012 information when SPL finishes and load it when U-Boot proper starts
1013 up.
1014
1015config TPL_BOOTSTAGE
1016 bool "Boot timing and reported in TPL"
Tom Rini36a4ca02022-06-08 08:24:39 -04001017 depends on BOOTSTAGE && TPL
Simon Glassd02ddcf2020-09-10 20:21:14 -06001018 help
1019 Enable recording of boot time in SPL. To make this visible to U-Boot
1020 proper, enable BOOTSTAGE_STASH as well. This will stash the timing
1021 information when TPL finishes and load it when U-Boot proper starts
1022 up.
1023
1024config BOOTSTAGE_REPORT
1025 bool "Display a detailed boot timing report before booting the OS"
1026 depends on BOOTSTAGE
1027 help
1028 Enable output of a boot time report just before the OS is booted.
1029 This shows how long it took U-Boot to go through each stage of the
1030 boot process. The report looks something like this:
1031
1032 Timer summary in microseconds:
1033 Mark Elapsed Stage
1034 0 0 reset
1035 3,575,678 3,575,678 board_init_f start
1036 3,575,695 17 arch_cpu_init A9
1037 3,575,777 82 arch_cpu_init done
1038 3,659,598 83,821 board_init_r start
1039 3,910,375 250,777 main_loop
1040 29,916,167 26,005,792 bootm_start
1041 30,361,327 445,160 start_kernel
1042
1043config BOOTSTAGE_RECORD_COUNT
1044 int "Number of boot stage records to store"
Simon Glass051ddfb2021-02-03 06:00:49 -07001045 depends on BOOTSTAGE
Simon Glassd02ddcf2020-09-10 20:21:14 -06001046 default 30
1047 help
1048 This is the size of the bootstage record list and is the maximum
1049 number of bootstage records that can be recorded.
1050
1051config SPL_BOOTSTAGE_RECORD_COUNT
1052 int "Number of boot stage records to store for SPL"
Simon Glass051ddfb2021-02-03 06:00:49 -07001053 depends on SPL_BOOTSTAGE
Simon Glassd02ddcf2020-09-10 20:21:14 -06001054 default 5
1055 help
1056 This is the size of the bootstage record list and is the maximum
1057 number of bootstage records that can be recorded.
1058
1059config TPL_BOOTSTAGE_RECORD_COUNT
1060 int "Number of boot stage records to store for TPL"
Simon Glass051ddfb2021-02-03 06:00:49 -07001061 depends on TPL_BOOTSTAGE
Simon Glassd02ddcf2020-09-10 20:21:14 -06001062 default 5
1063 help
1064 This is the size of the bootstage record list and is the maximum
1065 number of bootstage records that can be recorded.
1066
1067config BOOTSTAGE_FDT
1068 bool "Store boot timing information in the OS device tree"
1069 depends on BOOTSTAGE
1070 help
1071 Stash the bootstage information in the FDT. A root 'bootstage'
1072 node is created with each bootstage id as a child. Each child
1073 has a 'name' property and either 'mark' containing the
1074 mark time in microseconds, or 'accum' containing the
1075 accumulated time for that bootstage id in microseconds.
1076 For example:
1077
1078 bootstage {
1079 154 {
1080 name = "board_init_f";
1081 mark = <3575678>;
1082 };
1083 170 {
1084 name = "lcd";
1085 accum = <33482>;
1086 };
1087 };
1088
1089 Code in the Linux kernel can find this in /proc/devicetree.
1090
1091config BOOTSTAGE_STASH
1092 bool "Stash the boot timing information in memory before booting OS"
1093 depends on BOOTSTAGE
1094 help
1095 Some OSes do not support device tree. Bootstage can instead write
1096 the boot timing information in a binary format at a given address.
1097 This happens through a call to bootstage_stash(), typically in
1098 the CPU's cleanup_before_linux() function. You can use the
1099 'bootstage stash' and 'bootstage unstash' commands to do this on
1100 the command line.
1101
1102config BOOTSTAGE_STASH_ADDR
1103 hex "Address to stash boot timing information"
Tom Rinid78c9bd2024-07-15 12:42:00 +01001104 depends on BOOTSTAGE_STASH
1105 default 0xC3000000 if STM32MP13X || STM32MP15X
1106 default 0x87000000 if STM32MP25X
1107 default 0x0 if SANDBOX
Simon Glassd02ddcf2020-09-10 20:21:14 -06001108 help
1109 Provide an address which will not be overwritten by the OS when it
1110 starts, so that it can read this information when ready.
1111
1112config BOOTSTAGE_STASH_SIZE
1113 hex "Size of boot timing stash region"
Tom Rinid78c9bd2024-07-15 12:42:00 +01001114 depends on BOOTSTAGE_STASH
Simon Glassd02ddcf2020-09-10 20:21:14 -06001115 default 0x1000
1116 help
1117 This should be large enough to hold the bootstage stash. A value of
1118 4096 (4KiB) is normally plenty.
1119
1120config SHOW_BOOT_PROGRESS
1121 bool "Show boot progress in a board-specific manner"
1122 help
1123 Defining this option allows to add some board-specific code (calling
1124 a user-provided function show_boot_progress(int) that enables you to
1125 show the system's boot progress on some display (for example, some
1126 LEDs) on your board. At the moment, the following checkpoints are
1127 implemented:
1128
1129 Legacy uImage format:
1130
1131 Arg Where When
1132 1 common/cmd_bootm.c before attempting to boot an image
1133 -1 common/cmd_bootm.c Image header has bad magic number
1134 2 common/cmd_bootm.c Image header has correct magic number
1135 -2 common/cmd_bootm.c Image header has bad checksum
1136 3 common/cmd_bootm.c Image header has correct checksum
1137 -3 common/cmd_bootm.c Image data has bad checksum
1138 4 common/cmd_bootm.c Image data has correct checksum
1139 -4 common/cmd_bootm.c Image is for unsupported architecture
1140 5 common/cmd_bootm.c Architecture check OK
1141 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
1142 6 common/cmd_bootm.c Image Type check OK
1143 -6 common/cmd_bootm.c gunzip uncompression error
1144 -7 common/cmd_bootm.c Unimplemented compression type
1145 7 common/cmd_bootm.c Uncompression OK
1146 8 common/cmd_bootm.c No uncompress/copy overwrite error
1147 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
1148
1149 9 common/image.c Start initial ramdisk verification
1150 -10 common/image.c Ramdisk header has bad magic number
1151 -11 common/image.c Ramdisk header has bad checksum
1152 10 common/image.c Ramdisk header is OK
1153 -12 common/image.c Ramdisk data has bad checksum
1154 11 common/image.c Ramdisk data has correct checksum
1155 12 common/image.c Ramdisk verification complete, start loading
1156 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
1157 13 common/image.c Start multifile image verification
1158 14 common/image.c No initial ramdisk, no multifile, continue.
1159
1160 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
1161
1162 -30 arch/powerpc/lib/board.c Fatal error, hang the system
1163 -31 post/post.c POST test failed, detected by post_output_backlog()
1164 -32 post/post.c POST test failed, detected by post_run_single()
1165
1166 34 common/cmd_doc.c before loading a Image from a DOC device
1167 -35 common/cmd_doc.c Bad usage of "doc" command
1168 35 common/cmd_doc.c correct usage of "doc" command
1169 -36 common/cmd_doc.c No boot device
1170 36 common/cmd_doc.c correct boot device
1171 -37 common/cmd_doc.c Unknown Chip ID on boot device
1172 37 common/cmd_doc.c correct chip ID found, device available
1173 -38 common/cmd_doc.c Read Error on boot device
1174 38 common/cmd_doc.c reading Image header from DOC device OK
1175 -39 common/cmd_doc.c Image header has bad magic number
1176 39 common/cmd_doc.c Image header has correct magic number
1177 -40 common/cmd_doc.c Error reading Image from DOC device
1178 40 common/cmd_doc.c Image header has correct magic number
1179 41 common/cmd_ide.c before loading a Image from a IDE device
1180 -42 common/cmd_ide.c Bad usage of "ide" command
1181 42 common/cmd_ide.c correct usage of "ide" command
1182 -43 common/cmd_ide.c No boot device
1183 43 common/cmd_ide.c boot device found
1184 -44 common/cmd_ide.c Device not available
1185 44 common/cmd_ide.c Device available
1186 -45 common/cmd_ide.c wrong partition selected
1187 45 common/cmd_ide.c partition selected
1188 -46 common/cmd_ide.c Unknown partition table
1189 46 common/cmd_ide.c valid partition table found
1190 -47 common/cmd_ide.c Invalid partition type
1191 47 common/cmd_ide.c correct partition type
1192 -48 common/cmd_ide.c Error reading Image Header on boot device
1193 48 common/cmd_ide.c reading Image Header from IDE device OK
1194 -49 common/cmd_ide.c Image header has bad magic number
1195 49 common/cmd_ide.c Image header has correct magic number
1196 -50 common/cmd_ide.c Image header has bad checksum
1197 50 common/cmd_ide.c Image header has correct checksum
1198 -51 common/cmd_ide.c Error reading Image from IDE device
1199 51 common/cmd_ide.c reading Image from IDE device OK
1200 52 common/cmd_nand.c before loading a Image from a NAND device
1201 -53 common/cmd_nand.c Bad usage of "nand" command
1202 53 common/cmd_nand.c correct usage of "nand" command
1203 -54 common/cmd_nand.c No boot device
1204 54 common/cmd_nand.c boot device found
1205 -55 common/cmd_nand.c Unknown Chip ID on boot device
1206 55 common/cmd_nand.c correct chip ID found, device available
1207 -56 common/cmd_nand.c Error reading Image Header on boot device
1208 56 common/cmd_nand.c reading Image Header from NAND device OK
1209 -57 common/cmd_nand.c Image header has bad magic number
1210 57 common/cmd_nand.c Image header has correct magic number
1211 -58 common/cmd_nand.c Error reading Image from NAND device
1212 58 common/cmd_nand.c reading Image from NAND device OK
1213
1214 -60 common/env_common.c Environment has a bad CRC, using default
1215
1216 64 net/eth.c starting with Ethernet configuration.
1217 -64 net/eth.c no Ethernet found.
1218 65 net/eth.c Ethernet found.
1219
1220 -80 common/cmd_net.c usage wrong
1221 80 common/cmd_net.c before calling net_loop()
1222 -81 common/cmd_net.c some error in net_loop() occurred
1223 81 common/cmd_net.c net_loop() back without error
1224 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
1225 82 common/cmd_net.c trying automatic boot
1226 83 common/cmd_net.c running "source" command
1227 -83 common/cmd_net.c some error in automatic boot or "source" command
1228 84 common/cmd_net.c end without errors
1229
1230 FIT uImage format:
1231
1232 Arg Where When
1233 100 common/cmd_bootm.c Kernel FIT Image has correct format
1234 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
1235 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
1236 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
1237 102 common/cmd_bootm.c Kernel unit name specified
1238 -103 common/cmd_bootm.c Can't get kernel subimage node offset
1239 103 common/cmd_bootm.c Found configuration node
1240 104 common/cmd_bootm.c Got kernel subimage node offset
1241 -104 common/cmd_bootm.c Kernel subimage hash verification failed
1242 105 common/cmd_bootm.c Kernel subimage hash verification OK
1243 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
1244 106 common/cmd_bootm.c Architecture check OK
1245 -106 common/cmd_bootm.c Kernel subimage has wrong type
1246 107 common/cmd_bootm.c Kernel subimage type OK
1247 -107 common/cmd_bootm.c Can't get kernel subimage data/size
1248 108 common/cmd_bootm.c Got kernel subimage data/size
1249 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
1250 -109 common/cmd_bootm.c Can't get kernel subimage type
1251 -110 common/cmd_bootm.c Can't get kernel subimage comp
1252 -111 common/cmd_bootm.c Can't get kernel subimage os
1253 -112 common/cmd_bootm.c Can't get kernel subimage load address
1254 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
1255
1256 120 common/image.c Start initial ramdisk verification
1257 -120 common/image.c Ramdisk FIT image has incorrect format
1258 121 common/image.c Ramdisk FIT image has correct format
1259 122 common/image.c No ramdisk subimage unit name, using configuration
1260 -122 common/image.c Can't get configuration for ramdisk subimage
1261 123 common/image.c Ramdisk unit name specified
1262 -124 common/image.c Can't get ramdisk subimage node offset
1263 125 common/image.c Got ramdisk subimage node offset
1264 -125 common/image.c Ramdisk subimage hash verification failed
1265 126 common/image.c Ramdisk subimage hash verification OK
1266 -126 common/image.c Ramdisk subimage for unsupported architecture
1267 127 common/image.c Architecture check OK
1268 -127 common/image.c Can't get ramdisk subimage data/size
1269 128 common/image.c Got ramdisk subimage data/size
1270 129 common/image.c Can't get ramdisk load address
1271 -129 common/image.c Got ramdisk load address
1272
1273 -130 common/cmd_doc.c Incorrect FIT image format
1274 131 common/cmd_doc.c FIT image format OK
1275
1276 -140 common/cmd_ide.c Incorrect FIT image format
1277 141 common/cmd_ide.c FIT image format OK
1278
1279 -150 common/cmd_nand.c Incorrect FIT image format
1280 151 common/cmd_nand.c FIT image format OK
1281
Marek Vasut98154342021-10-23 03:06:03 +02001282config SPL_SHOW_BOOT_PROGRESS
Jan Kiszka5780edb2021-11-03 15:09:36 +01001283 bool "Show boot progress in a board-specific manner in SPL"
Marek Vasut98154342021-10-23 03:06:03 +02001284 depends on SPL
1285 help
1286 Defining this option allows to add some board-specific code (calling
1287 a user-provided function show_boot_progress(int) that enables you to
1288 show the system's boot progress on some display (for example, some
1289 LEDs) on your board. For details see SHOW_BOOT_PROGRESS.
1290
Simon Glassd02ddcf2020-09-10 20:21:14 -06001291endmenu
1292
Simon Glasseebed782020-09-10 20:21:15 -06001293menu "Boot media"
1294
1295config NOR_BOOT
1296 bool "Support for booting from NOR flash"
1297 depends on NOR
1298 help
1299 Enabling this will make a U-Boot binary that is capable of being
1300 booted via NOR. In this case we will enable certain pinmux early
1301 as the ROM only partially sets up pinmux. We also default to using
1302 NOR for environment.
1303
1304config NAND_BOOT
1305 bool "Support for booting from NAND flash"
Simon Glasseebed782020-09-10 20:21:15 -06001306 imply MTD_RAW_NAND
1307 help
1308 Enabling this will make a U-Boot binary that is capable of being
1309 booted via NAND flash. This is not a must, some SoCs need this,
1310 some not.
1311
1312config ONENAND_BOOT
1313 bool "Support for booting from ONENAND"
Simon Glasseebed782020-09-10 20:21:15 -06001314 imply MTD_RAW_NAND
1315 help
1316 Enabling this will make a U-Boot binary that is capable of being
1317 booted via ONENAND. This is not a must, some SoCs need this,
1318 some not.
1319
1320config QSPI_BOOT
1321 bool "Support for booting from QSPI flash"
Simon Glasseebed782020-09-10 20:21:15 -06001322 help
1323 Enabling this will make a U-Boot binary that is capable of being
1324 booted via QSPI flash. This is not a must, some SoCs need this,
1325 some not.
1326
1327config SATA_BOOT
1328 bool "Support for booting from SATA"
Simon Glasseebed782020-09-10 20:21:15 -06001329 help
1330 Enabling this will make a U-Boot binary that is capable of being
1331 booted via SATA. This is not a must, some SoCs need this,
1332 some not.
1333
1334config SD_BOOT
1335 bool "Support for booting from SD/EMMC"
Simon Glasseebed782020-09-10 20:21:15 -06001336 help
1337 Enabling this will make a U-Boot binary that is capable of being
1338 booted via SD/EMMC. This is not a must, some SoCs need this,
1339 some not.
1340
Tom Rinia43bf4e2021-12-11 14:55:50 -05001341config SD_BOOT_QSPI
1342 bool "Support for booting from SD/EMMC and enable QSPI"
1343 help
1344 Enabling this will make a U-Boot binary that is capable of being
1345 booted via SD/EMMC while enabling QSPI on the platform as well. This
1346 is not a must, some SoCs need this, some not.
1347
Simon Glasseebed782020-09-10 20:21:15 -06001348config SPI_BOOT
1349 bool "Support for booting from SPI flash"
Simon Glasseebed782020-09-10 20:21:15 -06001350 help
1351 Enabling this will make a U-Boot binary that is capable of being
1352 booted via SPI flash. This is not a must, some SoCs need this,
1353 some not.
1354
1355endmenu
1356
Simon Glasse9d54d72020-09-10 20:21:16 -06001357menu "Autoboot options"
1358
1359config AUTOBOOT
1360 bool "Autoboot"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001361 depends on CMDLINE
Simon Glasse9d54d72020-09-10 20:21:16 -06001362 default y
1363 help
1364 This enables the autoboot. See doc/README.autoboot for detail.
1365
Simon Glass7dee9dc2023-10-26 14:31:22 -04001366if AUTOBOOT
1367
Simon Glass1b6cbaa2020-09-10 20:21:17 -06001368config BOOTDELAY
1369 int "delay in seconds before automatically booting"
1370 default 2
Simon Glass1b6cbaa2020-09-10 20:21:17 -06001371 help
1372 Delay before automatically running bootcmd;
1373 set to 0 to autoboot with no delay, but you can stop it by key input.
1374 set to -1 to disable autoboot.
1375 set to -2 to autoboot with no delay and not check for abort
1376
1377 If this value is >= 0 then it is also used for the default delay
1378 before starting the default entry in bootmenu. If it is < 0 then
1379 a default value of 10s is used.
1380
1381 See doc/README.autoboot for details.
1382
Simon Glasse9d54d72020-09-10 20:21:16 -06001383config AUTOBOOT_KEYED
1384 bool "Stop autobooting via specific input key / string"
Simon Glasse9d54d72020-09-10 20:21:16 -06001385 help
1386 This option enables stopping (aborting) of the automatic
1387 boot feature only by issuing a specific input key or
1388 string. If not enabled, any input key will abort the
1389 U-Boot automatic booting process and bring the device
1390 to the U-Boot prompt for user input.
1391
Simon Glass7dee9dc2023-10-26 14:31:22 -04001392if AUTOBOOT_KEYED
1393
Steffen Jaeckeldfc97322021-07-08 15:57:38 +02001394config AUTOBOOT_FLUSH_STDIN
1395 bool "Enable flushing stdin before starting to read the password"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001396 depends on !SANDBOX
Steffen Jaeckeldfc97322021-07-08 15:57:38 +02001397 help
1398 When this option is enabled stdin buffer will be flushed before
1399 starting to read the password.
1400 This can't be enabled for the sandbox as flushing stdin would
1401 break the autoboot unit tests.
1402
Simon Glasse9d54d72020-09-10 20:21:16 -06001403config AUTOBOOT_PROMPT
1404 string "Autoboot stop prompt"
Simon Glasse9d54d72020-09-10 20:21:16 -06001405 default "Autoboot in %d seconds\\n"
1406 help
1407 This string is displayed before the boot delay selected by
1408 CONFIG_BOOTDELAY starts. If it is not defined there is no
1409 output indicating that autoboot is in progress.
1410
1411 Note that this define is used as the (only) argument to a
1412 printf() call, so it may contain '%' format specifications,
Quentin Schulzc0a7ae02024-06-12 16:58:47 +02001413 provided that it also includes, separated by commas exactly
Simon Glasse9d54d72020-09-10 20:21:16 -06001414 like in a printf statement, the required arguments. It is
1415 the responsibility of the user to select only such arguments
1416 that are valid in the given context.
1417
1418config AUTOBOOT_ENCRYPTION
1419 bool "Enable encryption in autoboot stopping"
Simon Glasse9d54d72020-09-10 20:21:16 -06001420 help
1421 This option allows a string to be entered into U-Boot to stop the
Steffen Jaeckel6aa6bfb2021-07-08 15:57:35 +02001422 autoboot.
1423 The behavior depends whether CONFIG_CRYPT_PW from lib is enabled
1424 or not.
1425 In case CONFIG_CRYPT_PW is enabled, the string will be forwarded
1426 to the crypt-based functionality and be compared against the
1427 string in the environment variable 'bootstopkeycrypt'.
1428 In case CONFIG_CRYPT_PW is disabled the string itself is hashed
1429 and compared against the hash in the environment variable
1430 'bootstopkeysha256'.
1431 If it matches in either case then boot stops and
1432 a command-line prompt is presented.
Simon Glasse9d54d72020-09-10 20:21:16 -06001433 This provides a way to ship a secure production device which can also
1434 be accessed at the U-Boot command line.
1435
Steffen Jaeckel28be70d2021-07-08 15:57:39 +02001436config AUTOBOOT_SHA256_FALLBACK
1437 bool "Allow fallback from crypt-hashed password to sha256"
1438 depends on AUTOBOOT_ENCRYPTION && CRYPT_PW
1439 help
1440 This option adds support to fall back from crypt-hashed
1441 passwords to checking a SHA256 hashed password in case the
1442 'bootstopusesha256' environment variable is set to 'true'.
1443
Simon Glasse9d54d72020-09-10 20:21:16 -06001444config AUTOBOOT_DELAY_STR
1445 string "Delay autobooting via specific input key / string"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001446 depends on !AUTOBOOT_ENCRYPTION
Simon Glasse9d54d72020-09-10 20:21:16 -06001447 help
1448 This option delays the automatic boot feature by issuing
1449 a specific input key or string. If CONFIG_AUTOBOOT_DELAY_STR
1450 or the environment variable "bootdelaykey" is specified
1451 and this string is received from console input before
1452 autoboot starts booting, U-Boot gives a command prompt. The
1453 U-Boot prompt will time out if CONFIG_BOOT_RETRY_TIME is
1454 used, otherwise it never times out.
1455
1456config AUTOBOOT_STOP_STR
1457 string "Stop autobooting via specific input key / string"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001458 depends on !AUTOBOOT_ENCRYPTION
Simon Glasse9d54d72020-09-10 20:21:16 -06001459 help
1460 This option enables stopping (aborting) of the automatic
1461 boot feature only by issuing a specific input key or
1462 string. If CONFIG_AUTOBOOT_STOP_STR or the environment
1463 variable "bootstopkey" is specified and this string is
1464 received from console input before autoboot starts booting,
1465 U-Boot gives a command prompt. The U-Boot prompt never
1466 times out, even if CONFIG_BOOT_RETRY_TIME is used.
1467
1468config AUTOBOOT_KEYED_CTRLC
1469 bool "Enable Ctrl-C autoboot interruption"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001470 depends on !AUTOBOOT_ENCRYPTION
Simon Glasse9d54d72020-09-10 20:21:16 -06001471 help
1472 This option allows for the boot sequence to be interrupted
1473 by ctrl-c, in addition to the "bootdelaykey" and "bootstopkey".
1474 Setting this variable provides an escape sequence from the
1475 limited "password" strings.
1476
Steffen Jaeckel792a13f2021-07-08 15:57:37 +02001477config AUTOBOOT_NEVER_TIMEOUT
1478 bool "Make the password entry never time-out"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001479 depends on AUTOBOOT_ENCRYPTION && CRYPT_PW
Steffen Jaeckel792a13f2021-07-08 15:57:37 +02001480 help
1481 This option removes the timeout from the password entry
1482 when the user first presses the <Enter> key before entering
1483 any other character.
1484
Steffen Jaeckel6aa6bfb2021-07-08 15:57:35 +02001485config AUTOBOOT_STOP_STR_ENABLE
1486 bool "Enable fixed string to stop autobooting"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001487 depends on AUTOBOOT_ENCRYPTION
Steffen Jaeckel6aa6bfb2021-07-08 15:57:35 +02001488 help
1489 This option enables the feature to add a fixed stop
1490 string that is defined at compile time.
1491 In every case it will be tried to load the stop
1492 string from the environment.
1493 In case this is enabled and there is no stop string
1494 in the environment, this will be used as default value.
1495
1496config AUTOBOOT_STOP_STR_CRYPT
1497 string "Stop autobooting via crypt-hashed password"
1498 depends on AUTOBOOT_STOP_STR_ENABLE && CRYPT_PW
1499 help
1500 This option adds the feature to only stop the autobooting,
1501 and therefore boot into the U-Boot prompt, when the input
1502 string / password matches a values that is hashed via
1503 one of the supported crypt-style password hashing options
1504 and saved in the environment variable "bootstopkeycrypt".
1505
Simon Glasse9d54d72020-09-10 20:21:16 -06001506config AUTOBOOT_STOP_STR_SHA256
Steffen Jaeckele1788f92021-07-08 15:57:40 +02001507 string "Stop autobooting via SHA256 hashed password"
Steffen Jaeckel6aa6bfb2021-07-08 15:57:35 +02001508 depends on AUTOBOOT_STOP_STR_ENABLE
Simon Glasse9d54d72020-09-10 20:21:16 -06001509 help
1510 This option adds the feature to only stop the autobooting,
1511 and therefore boot into the U-Boot prompt, when the input
Quentin Schulzc0a7ae02024-06-12 16:58:47 +02001512 string / password matches a values that is encrypted via
Joel Peshkin8b7bf532020-11-21 17:18:59 -08001513 a SHA256 hash and saved in the environment variable
1514 "bootstopkeysha256". If the value in that variable
1515 includes a ":", the portion prior to the ":" will be treated
1516 as a salt value.
Simon Glasse9d54d72020-09-10 20:21:16 -06001517
Simon Glass7dee9dc2023-10-26 14:31:22 -04001518endif # AUTOBOOT_KEYED
1519
1520if !AUTOBOOT_KEYED
1521
Simon Glasse9d54d72020-09-10 20:21:16 -06001522config AUTOBOOT_USE_MENUKEY
1523 bool "Allow a specify key to run a menu from the environment"
Simon Glasse9d54d72020-09-10 20:21:16 -06001524 help
1525 If a specific key is pressed to stop autoboot, then the commands in
1526 the environment variable 'menucmd' are executed before boot starts.
1527
1528config AUTOBOOT_MENUKEY
1529 int "ASCII value of boot key to show a menu"
1530 default 0
1531 depends on AUTOBOOT_USE_MENUKEY
1532 help
1533 If this key is pressed to stop autoboot, then the commands in the
1534 environment variable 'menucmd' will be executed before boot starts.
1535 For example, 33 means "!" in ASCII, so pressing ! at boot would take
1536 this action.
1537
Simon Glass7dee9dc2023-10-26 14:31:22 -04001538endif
1539
1540endif # AUTOBOOT
1541
Simon Glasse9d54d72020-09-10 20:21:16 -06001542config AUTOBOOT_MENU_SHOW
1543 bool "Show a menu on boot"
1544 depends on CMD_BOOTMENU
1545 help
1546 This enables the boot menu, controlled by environment variables
1547 defined by the board. The menu starts after running the 'preboot'
1548 environmnent variable (if enabled) and before handling the boot delay.
Peter Robinson16e0b8f2023-08-18 15:54:10 +01001549 See doc/usage/cmd/bootmenu.rst for more details.
Simon Glasse9d54d72020-09-10 20:21:16 -06001550
Masahisa Kojima97cbcc42022-05-26 19:09:38 +09001551config BOOTMENU_DISABLE_UBOOT_CONSOLE
1552 bool "Disallow bootmenu to enter the U-Boot console"
1553 depends on AUTOBOOT_MENU_SHOW
1554 help
1555 If this option is enabled, user can not enter the U-Boot console from
1556 bootmenu. It increases the system security.
1557
Tom Rinia45a3ef2022-03-11 09:12:04 -05001558config BOOT_RETRY
1559 bool "Boot retry feature"
1560 help
1561 Allow for having the U-Boot command prompt time out and attempt
1562 to boot again. If the environment variable "bootretry" is found then
1563 its value is used, otherwise the retry timeout is
1564 CONFIG_BOOT_RETRY_TIME. CONFIG_BOOT_RETRY_MIN is optional and
1565 defaults to CONFIG_BOOT_RETRY_TIME. All times are in seconds.
1566
1567config BOOT_RETRY_TIME
1568 int "Timeout in seconds before attempting to boot again"
1569 depends on BOOT_RETRY
1570 help
1571 Time in seconds before the U-Boot prompt will timeout and boot will
1572 be attempted again.
1573
1574config BOOT_RETRY_MIN
1575 int "Minimum timeout in seconds for 'bootretry'"
1576 depends on BOOT_RETRY
1577 default BOOT_RETRY_TIME
1578 help
1579 The minimum time in seconds that "bootretry" can be set to.
1580
1581config RESET_TO_RETRY
1582 bool "Reset the board to retry autoboot"
1583 depends on BOOT_RETRY
1584 help
1585 After the countdown timed out, the board will be reset to restart
1586 again.
1587
Simon Glasse9d54d72020-09-10 20:21:16 -06001588endmenu
1589
Philippe Reynesd28484e2022-03-28 22:56:59 +02001590menu "Image support"
1591
1592config IMAGE_PRE_LOAD
1593 bool "Image pre-load support"
1594 help
1595 Enable an image pre-load stage in the SPL.
1596 This pre-load stage allows to do some manipulation
1597 or check (for example signature check) on an image
1598 before launching it.
1599
1600config SPL_IMAGE_PRE_LOAD
1601 bool "Image pre-load support within SPL"
1602 depends on SPL && IMAGE_PRE_LOAD
1603 help
1604 Enable an image pre-load stage in the SPL.
1605 This pre-load stage allows to do some manipulation
1606 or check (for example signature check) on an image
1607 before launching it.
1608
1609config IMAGE_PRE_LOAD_SIG
1610 bool "Image pre-load signature support"
1611 depends on IMAGE_PRE_LOAD
1612 select FIT_SIGNATURE
1613 select RSA
1614 select RSA_VERIFY_WITH_PKEY
1615 help
1616 Enable signature check support in the pre-load stage.
1617 For this feature a very simple header is added before
1618 the image with few fields:
1619 - a magic
1620 - the image size
1621 - the signature
1622 All other information (header size, type of signature,
1623 ...) are provided in the node /image/pre-load/sig of
1624 u-boot.
1625
1626config SPL_IMAGE_PRE_LOAD_SIG
1627 bool "Image pre-load signature support witin SPL"
1628 depends on SPL_IMAGE_PRE_LOAD && IMAGE_PRE_LOAD_SIG
1629 select SPL_FIT_SIGNATURE
1630 select SPL_RSA
1631 select SPL_RSA_VERIFY_WITH_PKEY
1632 help
1633 Enable signature check support in the pre-load stage in the SPL.
1634 For this feature a very simple header is added before
1635 the image with few fields:
1636 - a magic
1637 - the image size
1638 - the signature
1639 All other information (header size, type of signature,
1640 ...) are provided in the node /image/pre-load/sig of
1641 u-boot.
1642
1643endmenu
1644
Simon Glass27367192023-09-14 10:55:46 -06001645if OF_LIBFDT
1646
1647menu "Devicetree fixup"
1648
Matthias Schiffere908fec2023-12-11 12:03:17 +01001649config OF_ENV_SETUP
1650 bool "Run a command from environment to set up device tree before boot"
1651 depends on CMD_FDT
1652 help
1653 This causes U-Boot to run a command from the environment variable
1654 fdt_fixup before booting into the operating system, which can use the
1655 fdt command to modify the device tree. The device tree is then passed
1656 to the OS.
1657
Simon Glass48e6d3d2023-09-14 10:55:47 -06001658config OF_BOARD_SETUP
1659 bool "Set up board-specific details in device tree before boot"
1660 help
1661 This causes U-Boot to call ft_board_setup() before booting into
1662 the Operating System. This function can set up various
1663 board-specific information in the device tree for use by the OS.
1664 The device tree is then passed to the OS.
1665
1666config OF_SYSTEM_SETUP
1667 bool "Set up system-specific details in device tree before boot"
1668 help
1669 This causes U-Boot to call ft_system_setup() before booting into
1670 the Operating System. This function can set up various
1671 system-specific information in the device tree for use by the OS.
1672 The device tree is then passed to the OS.
1673
1674config OF_STDOUT_VIA_ALIAS
1675 bool "Update the device-tree stdout alias from U-Boot"
1676 help
1677 This uses U-Boot's serial alias from the aliases node to update
1678 the device tree passed to the OS. The "linux,stdout-path" property
1679 in the chosen node is set to point to the correct serial node.
1680 This option currently references CONFIG_CONS_INDEX, which is
1681 incorrect when used with device tree as this option does not
1682 exist / should not be used.
1683
Simon Glassb7b7f162023-09-14 10:55:57 -06001684config FDT_FIXUP_PARTITIONS
Simon Glass1a5bcc12023-09-14 10:55:58 -06001685 bool "Overwrite MTD partitions in DTS through defined in 'mtdparts'"
Simon Glassb7b7f162023-09-14 10:55:57 -06001686 help
1687 Allow overwriting defined partitions in the device tree blob
1688 using partition info defined in the 'mtdparts' environment
1689 variable.
1690
Simon Glass27367192023-09-14 10:55:46 -06001691config FDT_SIMPLEFB
1692 bool "FDT tools for simplefb support"
Devarsh Thakkaree3dad42024-09-25 20:43:52 +05301693 depends on VIDEO
Simon Glass27367192023-09-14 10:55:46 -06001694 help
1695 Enable the fdt tools to manage the simple fb nodes in device tree.
1696 These functions can be used by board to indicate to the OS
1697 the presence of the simple frame buffer with associated reserved
1698 memory
1699
Simon Glass624c0e52023-09-14 10:55:59 -06001700config ARCH_FIXUP_FDT_MEMORY
1701 bool "Enable arch_fixup_memory_banks() call"
1702 default y
1703 help
1704 Enable FDT memory map syncup before OS boot. This feature can be
1705 used for booting OS with different memory setup where the part of
1706 the memory location should be used for different purpose.
1707
Simon Glass27367192023-09-14 10:55:46 -06001708endmenu
1709
1710endif # OF_LIBFDT
1711
Simon Glass5e958642020-09-10 20:21:18 -06001712config USE_BOOTARGS
1713 bool "Enable boot arguments"
1714 help
1715 Provide boot arguments to bootm command. Boot arguments are specified
1716 in CONFIG_BOOTARGS option. Enable this option to be able to specify
1717 CONFIG_BOOTARGS string. If this option is disabled, CONFIG_BOOTARGS
1718 will be undefined and won't take any space in U-Boot image.
1719
1720config BOOTARGS
1721 string "Boot arguments"
1722 depends on USE_BOOTARGS && !USE_DEFAULT_ENV_FILE
1723 help
1724 This can be used to pass arguments to the bootm command. The value of
1725 CONFIG_BOOTARGS goes into the environment value "bootargs". Note that
1726 this value will also override the "chosen" node in FDT blob.
1727
Simon Glass529e2082020-11-05 10:33:48 -07001728config BOOTARGS_SUBST
1729 bool "Support substituting strings in boot arguments"
1730 help
1731 This allows substituting string values in the boot arguments. These
1732 are applied after the commandline has been built.
1733
1734 One use for this is to insert the root-disk UUID into the command
1735 line where bootargs contains "root=${uuid}"
1736
1737 setenv bootargs "console= root=${uuid}"
1738 # Set the 'uuid' environment variable
1739 part uuid mmc 2:2 uuid
1740
1741 # Command-line substitution will put the real uuid into the
1742 # kernel command line
1743 bootm
1744
Simon Glass5e958642020-09-10 20:21:18 -06001745config USE_BOOTCOMMAND
1746 bool "Enable a default value for bootcmd"
Tom Rinidc3bf2d2023-10-26 14:31:28 -04001747 depends on CMDLINE
Simon Glass5e958642020-09-10 20:21:18 -06001748 help
1749 Provide a default value for the bootcmd entry in the environment. If
1750 autoboot is enabled this is what will be run automatically. Enable
1751 this option to be able to specify CONFIG_BOOTCOMMAND as a string. If
1752 this option is disabled, CONFIG_BOOTCOMMAND will be undefined and
1753 won't take any space in U-Boot image.
1754
1755config BOOTCOMMAND
1756 string "bootcmd value"
1757 depends on USE_BOOTCOMMAND && !USE_DEFAULT_ENV_FILE
Simon Glass2d5a8e12023-05-06 08:27:09 -06001758 default "bootflow scan -lb" if BOOTSTD_DEFAULTS && CMD_BOOTFLOW_FULL
1759 default "bootflow scan" if BOOTSTD_DEFAULTS && !CMD_BOOTFLOW_FULL
Simon Glassbe661cb2022-04-24 23:31:27 -06001760 default "run distro_bootcmd" if !BOOTSTD_BOOTCOMMAND && DISTRO_DEFAULTS
Simon Glass5e958642020-09-10 20:21:18 -06001761 help
1762 This is the string of commands that will be used as bootcmd and if
1763 AUTOBOOT is set, automatically run.
1764
1765config USE_PREBOOT
1766 bool "Enable preboot"
Tom Rinidc3bf2d2023-10-26 14:31:28 -04001767 depends on CMDLINE
Simon Glass5e958642020-09-10 20:21:18 -06001768 help
1769 When this option is enabled, the existence of the environment
1770 variable "preboot" will be checked immediately before starting the
1771 CONFIG_BOOTDELAY countdown and/or running the auto-boot command resp.
1772 entering interactive mode.
1773
1774 This feature is especially useful when "preboot" is automatically
1775 generated or modified. For example, the boot code can modify the
1776 "preboot" when a user holds down a certain combination of keys.
1777
1778config PREBOOT
1779 string "preboot default value"
1780 depends on USE_PREBOOT && !USE_DEFAULT_ENV_FILE
Patrick Delaunaybb15d402020-10-12 09:47:50 +02001781 default "usb start" if USB_KEYBOARD
Simon Glass5e958642020-09-10 20:21:18 -06001782 default ""
1783 help
1784 This is the default of "preboot" environment variable.
1785
Pali Rohár39c43c32022-07-10 13:42:55 +02001786config PREBOOT_DEFINED
1787 bool
1788 default y if PREBOOT != ""
1789
Simon Glassc10ddfd2020-09-10 20:21:20 -06001790config DEFAULT_FDT_FILE
1791 string "Default fdt file"
1792 help
1793 This option is used to set the default fdt file to boot OS.
1794
Dzmitry Sankouskia3463062022-02-22 21:49:52 +03001795config SAVE_PREV_BL_FDT_ADDR
1796 depends on ARM
1797 bool "Saves fdt address, passed by the previous bootloader, to env var"
1798 help
1799 When u-boot is used as a chain-loaded bootloader (replacing OS kernel),
1800 enable this option to save fdt address, passed by the
1801 previous bootloader for future use.
1802 Address is saved to `prevbl_fdt_addr` environment variable.
1803
1804 If no fdt was provided by previous bootloader, no env variables
1805 will be created.
1806
1807config SAVE_PREV_BL_INITRAMFS_START_ADDR
1808 depends on ARM
1809 bool "Saves initramfs address, passed by the previous bootloader, to env var"
1810 help
1811 When u-boot is used as a chain-loaded bootloader(replacing OS kernel),
1812 enable this option to save initramfs address, passed by the
1813 previous bootloader for future use.
1814 Address is saved to `prevbl_initrd_start_addr` environment variable.
1815
1816 If no initramfs was provided by previous bootloader, no env variables
1817 will be created.
1818
Simon Glassc8925112023-06-01 10:23:02 -06001819menu "Configuration editor"
1820
1821config CEDIT
1822 bool "Configuration editor"
Heinrich Schuchardtef97f7c2023-12-16 16:38:36 +01001823 depends on EXPO
Simon Glassc8925112023-06-01 10:23:02 -06001824 help
1825 Provides a way to deal with board configuration and present it to
1826 the user for adjustment.
1827
1828 This is intended to provide both graphical and text-based user
1829 interfaces, but only graphical is support at present.
1830
1831endmenu # Configuration editor
1832
Simon Glassb45b1632020-09-10 20:21:13 -06001833endmenu # Booting