blob: fe2919f18c4568170d8fb126223bbd565c8b41b1 [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
Simon Glass92368522023-11-18 14:05:19 -0700472config BOOTSTD_PROG
473 bool "Use programmatic boot"
474 depends on !CMDLINE
475 default y
476 help
477 Enable this to provide a board_run_command() function which can boot
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200478 a system without using commands. If the boot fails, then U-Boot will
Simon Glass92368522023-11-18 14:05:19 -0700479 panic.
480
481 Note: This currently has many limitations and is not a useful booting
482 solution. Future work will eventually make this a viable option.
483
Simon Glass4f8633d2022-07-30 15:52:21 -0600484config BOOTMETH_GLOBAL
485 bool
486 help
487 Add support for global bootmeths. This feature is used by VBE and
488 EFI bootmgr, since they take full control over which bootdevs are
489 selected to boot.
490
Mattijs Korpershoekb30baa92024-07-10 10:40:05 +0200491config BOOTMETH_ANDROID
492 bool "Bootdev support for Android"
493 depends on X86 || ARM || SANDBOX
494 depends on CMDLINE
495 select ANDROID_AB
496 select ANDROID_BOOT_IMAGE
497 select CMD_BCB
Jerome Forissiere0f95512024-10-16 12:03:59 +0200498 imply CMD_FASTBOOT
499 imply FASTBOOT if !NET_LWIP
Mattijs Korpershoekb30baa92024-07-10 10:40:05 +0200500 select PARTITION_TYPE_GUID
501 select PARTITION_UUIDS
502 help
503 Enables support for booting Android using bootstd. Android requires
504 multiple partitions (misc, boot, vbmeta, ...) in storage for booting.
505
506 Note that only MMC bootdevs are supported at present. This is caused
507 by AVB being limited to MMC devices only.
508
Simon Glassd74e62a2023-07-12 09:04:45 -0600509config BOOTMETH_CROS
510 bool "Bootdev support for Chromium OS"
Simon Glass18700262023-07-30 11:17:02 -0600511 depends on X86 || ARM || SANDBOX
512 default y if !ARM
Simon Glassd7d3a972023-08-24 13:55:45 -0600513 select EFI_PARTITION
514 select PARTITION_TYPE_GUID
515 select PARTITION_UUIDS
Simon Glassd74e62a2023-07-12 09:04:45 -0600516 help
517 Enables support for booting Chromium OS using bootdevs. This uses the
518 kernel A slot and obtains the kernel command line from the parameters
519 provided there.
520
521 Note that only x86 devices are supported at present.
522
Simon Glassb71d7f72023-05-10 16:34:46 -0600523config BOOTMETH_EXTLINUX
524 bool "Bootdev support for extlinux boot"
John Keeping9b60a172022-07-28 11:19:15 +0100525 select PXE_UTILS
Simon Glassad8ec372022-04-24 23:31:13 -0600526 default y
527 help
Simon Glassb71d7f72023-05-10 16:34:46 -0600528 Enables support for extlinux boot using bootdevs. This makes the
Simon Glassad8ec372022-04-24 23:31:13 -0600529 bootdevs look for a 'extlinux/extlinux.conf' on each filesystem
530 they scan.
531
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200532 The specification for this file is here:
Simon Glassb71d7f72023-05-10 16:34:46 -0600533
534 https://uapi-group.org/specifications/specs/boot_loader_specification/
535
Simon Glassad8ec372022-04-24 23:31:13 -0600536 This provides a way to try out standard boot on an existing boot flow.
537
Simon Glassb71d7f72023-05-10 16:34:46 -0600538config BOOTMETH_EXTLINUX_PXE
539 bool "Bootdev support for extlinux boot over network"
Simon Glass83144612022-04-24 23:31:16 -0600540 depends on CMD_PXE && CMD_NET && DM_ETH
541 default y
542 help
Simon Glassb71d7f72023-05-10 16:34:46 -0600543 Enables support for extlinux boot using bootdevs. This makes the
Simon Glass83144612022-04-24 23:31:16 -0600544 bootdevs look for a 'extlinux/extlinux.conf' on the tftp server.
545
Simon Glassb71d7f72023-05-10 16:34:46 -0600546 The specification for this file is here:
547
548 https://uapi-group.org/specifications/specs/boot_loader_specification/
549
Simon Glass83144612022-04-24 23:31:16 -0600550 This provides a way to try out standard boot on an existing boot flow.
551
Simon Glass66f62552022-04-24 23:31:17 -0600552config BOOTMETH_EFILOADER
553 bool "Bootdev support for EFI boot"
AKASHI Takahiro9b08b9a2024-01-17 13:39:41 +0900554 depends on EFI_BINARY_EXEC
Jerome Forissiere0f95512024-10-16 12:03:59 +0200555 imply CMD_TFTPBOOT if CMD_NET
Simon Glass66f62552022-04-24 23:31:17 -0600556 default y
557 help
558 Enables support for EFI boot using bootdevs. This makes the
559 bootdevs look for a 'boot<arch>.efi' on each filesystem
560 they scan. The resulting file is booted after enabling U-Boot's
561 EFI loader support.
562
563 The <arch> depends on the architecture of the board:
564
565 aa64 - aarch64 (ARM 64-bit)
566 arm - ARM 32-bit
567 ia32 - x86 32-bit
568 x64 - x86 64-bit
569 riscv32 - RISC-V 32-bit
570 riscv64 - RISC-V 64-bit
571
572 This provides a way to try out standard boot on an existing boot flow.
573
Heinrich Schuchardt72bca1a2024-04-03 20:05:17 +0200574config BOOTMETH_EFI_BOOTMGR
575 bool "Bootdev support for EFI boot manager"
576 depends on EFI_BOOTMGR
577 select BOOTMETH_GLOBAL
578 default y
579 help
580 Enable booting via the UEFI boot manager. Based on the EFI variables
581 the EFI binary to be launched is determined. To set the EFI variables
582 use the eficonfig command.
583
Heinrich Schuchardt1cd3ec92024-07-16 10:35:34 +0200584config BOOTMETH_QFW
585 bool "Boot method using QEMU parameters"
586 depends on QFW
587 default y
588 help
589 Use QEMU parameters -kernel, -initrd, -append to determine the kernel,
590 initial RAM disk, and kernel command line parameters to boot an
591 operating system. U-Boot's control device-tree is passed to the kernel.
592
Simon Glass0a9f4262022-07-30 15:52:32 -0600593config BOOTMETH_VBE
594 bool "Bootdev support for Verified Boot for Embedded"
595 depends on FIT
596 default y
597 select BOOTMETH_GLOBAL
Tom Rini7d3684a2023-01-16 15:46:49 -0500598 select EVENT
Simon Glass0a9f4262022-07-30 15:52:32 -0600599 help
600 Enables support for VBE boot. This is a standard boot method which
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200601 supports selection of various firmware components, selection of an OS to
Simon Glass0a9f4262022-07-30 15:52:32 -0600602 boot as well as updating these using fwupd.
603
Simon Glassdb92e782023-05-10 16:34:47 -0600604config BOOTMETH_DISTRO
605 bool # Options needed to boot any distro
Tom Rini9bf470a2023-10-26 14:31:27 -0400606 select BOOTMETH_SCRIPT if CMDLINE # E.g. Armbian uses scripts
Simon Glassdb92e782023-05-10 16:34:47 -0600607 select BOOTMETH_EXTLINUX # E.g. Debian uses these
608 select BOOTMETH_EXTLINUX_PXE if CMD_PXE && CMD_NET && DM_ETH
AKASHI Takahiro9b08b9a2024-01-17 13:39:41 +0900609 select BOOTMETH_EFILOADER if EFI_BINARY_EXEC # E.g. Ubuntu uses this
Simon Glassdb92e782023-05-10 16:34:47 -0600610
Simon Glassbc993e52022-10-20 18:23:13 -0600611config SPL_BOOTMETH_VBE
612 bool "Bootdev support for Verified Boot for Embedded (SPL)"
613 depends on SPL && FIT
Tom Rini7d3684a2023-01-16 15:46:49 -0500614 select EVENT
Simon Glassbc993e52022-10-20 18:23:13 -0600615 default y if VPL
616 help
617 Enables support for VBE boot. This is a standard boot method which
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200618 supports selection of various firmware components, selection of an OS to
Simon Glassbc993e52022-10-20 18:23:13 -0600619 boot as well as updating these using fwupd.
620
621config VPL_BOOTMETH_VBE
622 bool "Bootdev support for Verified Boot for Embedded (VPL)"
623 depends on VPL && FIT
Tom Rini7d3684a2023-01-16 15:46:49 -0500624 select EVENT
Simon Glassbc993e52022-10-20 18:23:13 -0600625 default y
626 help
627 Enables support for VBE boot. This is a standard boot method which
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200628 supports selection of various firmware components, selection of an OS to
Simon Glassbc993e52022-10-20 18:23:13 -0600629 boot as well as updating these using fwupd.
630
Simon Glassd0af04c2022-07-30 15:52:33 -0600631if BOOTMETH_VBE
632
Simon Glass513eeed2023-02-22 09:33:52 -0700633config BOOTMETH_VBE_REQUEST
634 bool "Support for serving VBE OS requests"
635 default y
636 help
637 Enables support for looking that the requests made by the
638 Operating System being booted. These requests result in additions to
639 the device tree /chosen node, added during the device tree fixup
640 phase.
641
642config SPL_BOOTMETH_VBE_REQUEST
643 bool "Support for serving VBE OS requests (SPL)"
644 depends on SPL
645 help
646 Enables support for looking that the requests made by the
647 Operating System being booted. These requests result in additions to
648 the device tree /chosen node, added during the device tree fixup
649 phase.
650
651 This is only useful if you are booting an OS direct from SPL.
652
Simon Glassd0af04c2022-07-30 15:52:33 -0600653config BOOTMETH_VBE_SIMPLE
654 bool "Bootdev support for VBE 'simple' method"
655 default y
656 help
657 Enables support for VBE 'simple' boot. This allows updating a single
658 firmware image in boot media such as MMC. It does not support any sort
659 of rollback, recovery or A/B boot.
660
Simon Glassbc993e52022-10-20 18:23:13 -0600661config BOOTMETH_VBE_SIMPLE_OS
662 bool "Bootdev support for VBE 'simple' method OS phase"
663 default y
664 help
665 Enables support for the OS parts of VBE 'simple' boot. This includes
666 fixing up the device tree with the required VBE information, ready
667 for booting into the OS. This option is only enabled for U-Boot
668 proper, since it is the phase where device tree fixups happen.
669
670config SPL_BOOTMETH_VBE_SIMPLE
671 bool "Bootdev support for VBE 'simple' method (SPL)"
672 depends on SPL
673 default y if VPL
674 help
675 Enables support for VBE 'simple' boot. This allows updating a single
676 firmware image in boot media such as MMC. It does not support any sort
677 of rollback, recovery or A/B boot.
678
679config VPL_BOOTMETH_VBE_SIMPLE
680 bool "Bootdev support for VBE 'simple' method (VPL)"
681 depends on VPL
682 default y
683 help
684 Enables support for VBE 'simple' boot. This allows updating a single
685 firmware image in boot media such as MMC. It does not support any sort
686 of rollback, recovery or A/B boot.
687
688config SPL_BOOTMETH_VBE_SIMPLE_FW
689 bool "Bootdev support for VBE 'simple' method firmware phase (SPL)"
690 depends on VPL
691 default y
692 help
693 Enables support for the firmware parts of VBE 'simple' boot. This
694 includes an SPL loader which locates the correct U-Boot to boot into.
695 This option should really only be enabled for VPL, since it is the
696 phase where the SPL + U-Boot decision should be made. But for now,
697 SPL does its own FIT-configuration selection.
698
699config VPL_BOOTMETH_VBE_SIMPLE_FW
700 bool "Bootdev support for VBE 'simple' method firmware phase (VPL)"
701 depends on VPL
702 default y
703 help
704 Enables support for the firmware parts of VBE 'simple' boot. This
705 includes an SPL loader which locates the correct SPL to boot into.
706 This option enabled for VPL, since it is the phase where the SPL
707 decision is made.
708
Simon Glassd0af04c2022-07-30 15:52:33 -0600709endif # BOOTMETH_VBE
710
Simon Glassd8adbe92023-01-06 08:52:36 -0600711config EXPO
712 bool "Support for expos - groups of scenes displaying a UI"
Simon Glass389a4582023-01-28 15:00:18 -0700713 depends on VIDEO
Simon Glassd8adbe92023-01-06 08:52:36 -0600714 default y if BOOTMETH_VBE
715 help
716 An expo is a way of presenting and collecting information from the
717 user. It consists of a collection of 'scenes' of which only one is
718 presented at a time. An expo is typically used to show a boot menu
719 and allow settings to be changed.
720
721 The expo can be presented in graphics form using a vidconsole, or in
722 text form on a serial console.
723
Simon Glass423994e2022-04-24 23:31:20 -0600724config BOOTMETH_SANDBOX
725 def_bool y
726 depends on SANDBOX
727 help
728 This is a sandbox bootmeth driver used for testing. It always returns
729 -ENOTSUPP when attempting to boot.
730
Simon Glass7e03e742022-04-24 23:31:22 -0600731config BOOTMETH_SCRIPT
732 bool "Bootdev support for U-Boot scripts"
733 default y if BOOTSTD_FULL
Tom Rini9bf470a2023-10-26 14:31:27 -0400734 depends on CMDLINE
Simon Glassb4b7ebe2023-05-05 20:03:05 -0600735 select HUSH_PARSER
Simon Glass7e03e742022-04-24 23:31:22 -0600736 help
737 Enables support for booting a distro via a U-Boot script. This makes
738 the bootdevs look for a 'boot/boot.scr' file which can be used to
739 boot the distro.
740
741 This provides a way to try out standard boot on an existing boot flow.
742 It is not enabled by default to save space.
743
Simon Glass77459f42024-08-07 16:47:27 -0600744config UPL
745 bool "upl - Universal Payload Specification"
Simon Glass3a028c22024-08-07 16:47:30 -0600746 imply CMD_UPL
Simon Glass77459f42024-08-07 16:47:27 -0600747 imply UPL_READ
Simon Glassb9474a82024-08-07 16:47:28 -0600748 imply UPL_WRITE
Simon Glassbc3ec002024-08-07 16:47:31 -0600749 imply SPL_UPL if SPL
Simon Glass77459f42024-08-07 16:47:27 -0600750 help
751 Provides support for UPL payloads and handoff information. U-Boot
752 supports generating and accepting handoff information. The mkimage
753 tool will eventually support creating payloads.
754
755if UPL
756
757config UPL_READ
758 bool "upl - Support reading a Universal Payload handoff"
759 help
760 Provides support for decoding a UPL-format payload into a C structure
761 which can be used elsewhere in U-Boot. This is just the reading
Simon Glass45aec8e2024-08-07 16:47:34 -0600762 implementation, useful for trying it out. See UPL_IN for how
763 to tell U-Boot to actually read it on startup and use it for memory
764 and device information, etc.
Simon Glass77459f42024-08-07 16:47:27 -0600765
Simon Glassb9474a82024-08-07 16:47:28 -0600766config UPL_WRITE
767 bool "upl - Support writing a Universal Payload handoff"
768 help
769 Provides support for encoding a UPL-format payload from a C structure
770 so it can be passed to another program. This is just the writing
Simon Glassbc3ec002024-08-07 16:47:31 -0600771 implementation, useful for trying it out. See SPL_UPL_OUT
772 for how to tell U-Boot SPL to actually write it before jumping to
773 the next phase.
774
Simon Glass45aec8e2024-08-07 16:47:34 -0600775config UPL_IN
776 bool "upl - Read the UPL handoff on startup"
777 select UPL_READ
778 help
779 Read an SPL handoff when U-Boot starts and use it to provide
780 devices, memory layout, etc. required by U-Boot. This allows U-Boot
781 to function as a payload in the meaning of the specification.
782
Simon Glassbc3ec002024-08-07 16:47:31 -0600783if SPL
784
785config SPL_UPL
786 bool "Write a UPL handoff in SPL"
787 imply SPL_UPL_OUT
788 help
789 This tells SPL to write a UPL handoff and pass it to the next phase
790 (e.g. to U-Boot or another program which SPL loads and runs). THis
791 provides information to help that program run correctly and
792 efficiently on the machine.
793
794config SPL_UPL_WRITE
795 bool # upl - Support writing a Universal Payload handoff in SPL
796 select SPL_BLOBLIST
797 help
798 Provides support for encoding a UPL-format payload from a C structure
799 so it can be passed to another program. This is just the writing
Simon Glassb9474a82024-08-07 16:47:28 -0600800 implementation, useful for trying it out.
801
Simon Glassbc3ec002024-08-07 16:47:31 -0600802config SPL_UPL_OUT
803 bool "upl - Support writing a Universal Payload handoff in SPL"
804 select SPL_UPL_WRITE
805 help
806 Provides support for encoding a UPL-format payload and passing it to
807 the next firmware phase. This allows U-Boot SPL to function as
808 Platform Init in the meaning of the specification.
809
810endif # SPL
811
Simon Glass77459f42024-08-07 16:47:27 -0600812endif # UPL
813
Simon Glass6cfb0022023-09-14 10:55:53 -0600814endif # BOOTSTD
Simon Glassad8ec372022-04-24 23:31:13 -0600815
Simon Glassb45b1632020-09-10 20:21:13 -0600816config LEGACY_IMAGE_FORMAT
817 bool "Enable support for the legacy image format"
Andrew Davis98a22d02022-05-04 15:52:27 -0500818 default y if !FIT_SIGNATURE && !TI_SECURE_DEVICE
Simon Glassb45b1632020-09-10 20:21:13 -0600819 help
820 This option enables the legacy image format. It is enabled by
821 default for backward compatibility, unless FIT_SIGNATURE is
822 set where it is disabled so that unsigned images cannot be
823 loaded. If a board needs the legacy image format support in this
824 case, enable it here.
825
Eddie James32401ba2023-10-24 10:43:50 -0500826config MEASURED_BOOT
827 bool "Measure boot images and configuration when booting without EFI"
828 depends on HASH && TPM_V2
Ilias Apalodimas1e665f92024-06-23 14:48:18 +0300829 select SHA1
830 select SHA256
831 select SHA384
832 select SHA512
Eddie James32401ba2023-10-24 10:43:50 -0500833 help
834 This option enables measurement of the boot process when booting
835 without UEFI . Measurement involves creating cryptographic hashes
836 of the binary images that are booting and storing them in the TPM.
837 In addition, a log of these hashes is stored in memory for the OS
838 to verify the booted images and configuration. Enable this if the
839 OS has configured some memory area for the event log and you intend
840 to use some attestation tools on your system.
841
842if MEASURED_BOOT
843 config MEASURE_DEVICETREE
844 bool "Measure the devicetree image"
845 default y if MEASURED_BOOT
846 help
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200847 On some platforms, the Device Tree is not static as it may contain
Eddie James32401ba2023-10-24 10:43:50 -0500848 random MAC addresses or other such data that changes each boot.
849 Therefore, it should not be measured into the TPM. In that case,
850 disable the measurement here.
851
852 config MEASURE_IGNORE_LOG
853 bool "Ignore the existing event log"
Eddie James32401ba2023-10-24 10:43:50 -0500854 help
855 On platforms that use an event log memory region that persists
856 through system resets and are the first stage bootloader, then
857 this option should be enabled to ignore any existing data in the
858 event log memory region.
859endif # MEASURED_BOOT
860
Tom Riniec8d1602023-10-26 14:31:25 -0400861config SYS_BOOTM_LEN
862 hex "Maximum size of a decompresed OS image"
Tom Rini793921e2024-04-18 08:29:35 -0600863 depends on CMD_BOOTM || CMD_BOOTI || CMD_BOOTZ || \
Tom Riniec8d1602023-10-26 14:31:25 -0400864 LEGACY_IMAGE_FORMAT || SPL_LEGACY_IMAGE_FORMAT
865 default 0x4000000 if PPC || ARM64
866 default 0x1000000 if X86 || ARCH_MX6 || ARCH_MX7
867 default 0x800000
868 help
869 This is the maximum size of the buffer that is used to decompress the OS
870 image in to if attempting to boot a compressed image.
871
Simon Glassf11d6132020-09-10 20:21:19 -0600872config SUPPORT_RAW_INITRD
873 bool "Enable raw initrd images"
874 help
875 Note, defining the SUPPORT_RAW_INITRD allows user to supply
876 kernel with raw initrd images. The syntax is slightly different, the
877 address of the initrd must be augmented by it's size, in the following
878 format: "<initrd address>:<initrd size>".
879
Simon Glassd81f07f2020-11-04 09:57:35 -0700880config CHROMEOS
881 bool "Support booting Chrome OS"
882 help
883 Chrome OS requires U-Boot to set up a table indicating the boot mode
884 (e.g. Developer mode) and a few other things. Enable this if you are
885 booting on a Chromebook to avoid getting an error about an invalid
886 firmware ID.
887
888config CHROMEOS_VBOOT
889 bool "Support Chrome OS verified boot"
890 help
891 This is intended to enable the full Chrome OS verified boot support
892 in U-Boot. It is not actually implemented in the U-Boot source code
893 at present, so this option is always set to 'n'. It allows
894 distinguishing between booting Chrome OS in a basic way (developer
895 mode) and a full boot.
896
Tom Rinieb4f2de2022-06-25 11:02:44 -0400897config SYS_RAMBOOT
898 bool
899
Tom Rini9ff815a2021-08-24 23:11:49 -0400900config RAMBOOT_PBL
901 bool "Freescale PBL(pre-boot loader) image format support"
Tom Rinieb4f2de2022-06-25 11:02:44 -0400902 select SYS_RAMBOOT if PPC
Tom Rini9ff815a2021-08-24 23:11:49 -0400903 help
904 Some SoCs use PBL to load RCW and/or pre-initialization instructions.
905 For more details refer to doc/README.pblimage
906
Tom Rini886e6e32022-03-23 17:20:03 -0400907choice
Tom Rini489f4022022-12-28 10:52:51 -0500908 prompt "Freescale PBL (or predecessor) load location"
Tom Rini886e6e32022-03-23 17:20:03 -0400909 depends on RAMBOOT_PBL || ((TARGET_P1010RDB_PA || TARGET_P1010RDB_PB \
910 || TARGET_P1020RDB_PC || TARGET_P1020RDB_PD || TARGET_P2020RDB) \
Pali Rohár6763ff82024-06-06 18:33:26 +0200911 && !CMD_NAND) || (TARGET_TURRIS_1X && SYS_MPC85XX_NO_RESETVEC)
Tom Rini886e6e32022-03-23 17:20:03 -0400912
913config SDCARD
Tom Rini489f4022022-12-28 10:52:51 -0500914 bool "Freescale PBL (or similar) is found on SD card"
Tom Rini886e6e32022-03-23 17:20:03 -0400915
916config SPIFLASH
Tom Rini489f4022022-12-28 10:52:51 -0500917 bool "Freescale PBL (or similar) is found on SPI flash"
918
919config NO_PBL
920 bool "Freescale PBL (or similar) is not used in this case"
Tom Rini886e6e32022-03-23 17:20:03 -0400921
922endchoice
923
Tom Rini5989fd42022-06-20 08:07:42 -0400924config FSL_FIXED_MMC_LOCATION
925 bool "PBL MMC is at a fixed location"
926 depends on SDCARD && !RAMBOOT_PBL
927
928config ESDHC_HC_BLK_ADDR
929 def_bool y
930 depends on FSL_FIXED_MMC_LOCATION && (ARCH_BSC9131 || ARCH_BSC9132 || ARCH_P1010)
931 help
932 In High Capacity SD Cards (> 2 GBytes), the 32-bit source address and
933 code length of these soc specify the memory address in block address
934 format. Block length is fixed to 512 bytes as per the SD High
935 Capacity specification.
936
Tom Rini9ff815a2021-08-24 23:11:49 -0400937config SYS_FSL_PBL_PBI
938 string "PBI(pre-boot instructions) commands for the PBL image"
939 depends on RAMBOOT_PBL
940 help
941 PBI commands can be used to configure SoC before it starts the execution.
942 Please refer doc/README.pblimage for more details.
943
944config SYS_FSL_PBL_RCW
945 string "Aadditional RCW (Power on reset configuration) for the PBL image"
946 depends on RAMBOOT_PBL
947 help
948 Enables addition of RCW (Power on reset configuration) in built image.
949 Please refer doc/README.pblimage for more details.
950
Tom Rini94b4fec2022-06-25 11:02:46 -0400951config SYS_BOOT_RAMDISK_HIGH
952 depends on CMD_BOOTM || CMD_BOOTI || CMD_BOOTZ
953 depends on !(NIOS2 || SANDBOX || SH || XTENSA)
954 def_bool y
Simon Glass65edcd32023-03-24 16:58:12 -0400955 select LMB
Tom Rini94b4fec2022-06-25 11:02:46 -0400956 help
957 Enable initrd_high functionality. If defined then the initrd_high
958 feature is enabled and the boot* ramdisk subcommand is enabled.
959
Simon Glassb45b1632020-09-10 20:21:13 -0600960endmenu # Boot images
961
Simon Glassf111bf72023-03-24 16:58:11 -0400962config DISTRO_DEFAULTS
Simon Glasse27d7df2023-09-14 10:55:55 -0600963 bool "(deprecated) Script-based booting of Linux distributions"
Tom Rini045245b2023-10-26 14:31:23 -0400964 select CMDLINE
Simon Glass054d0182023-03-24 16:58:13 -0400965 select BOOT_DEFAULTS
Simon Glassf111bf72023-03-24 16:58:11 -0400966 select AUTO_COMPLETE
967 select CMDLINE_EDITING
Simon Glassf111bf72023-03-24 16:58:11 -0400968 select CMD_SYSBOOT
Simon Glassf111bf72023-03-24 16:58:11 -0400969 select HUSH_PARSER
Simon Glassf111bf72023-03-24 16:58:11 -0400970 select SYS_LONGHELP
Simon Glassf111bf72023-03-24 16:58:11 -0400971 help
Simon Glasse27d7df2023-09-14 10:55:55 -0600972 Note: These scripts have been replaced by Standard Boot. Do not use
973 them on new boards. See 'Migrating from distro_boot' at
974 doc/develop/bootstd.rst
975
Simon Glassf111bf72023-03-24 16:58:11 -0400976 Select this to enable various options and commands which are suitable
977 for building u-boot for booting general purpose Linux distributions.
978
Simon Glassd02ddcf2020-09-10 20:21:14 -0600979menu "Boot timing"
980
981config BOOTSTAGE
982 bool "Boot timing and reporting"
983 help
984 Enable recording of boot time while booting. To use it, insert
985 calls to bootstage_mark() with a suitable BOOTSTAGE_ID from
986 bootstage.h. Only a single entry is recorded for each ID. You can
987 give the entry a name with bootstage_mark_name(). You can also
988 record elapsed time in a particular stage using bootstage_start()
989 before starting and bootstage_accum() when finished. Bootstage will
990 add up all the accumulated time and report it.
991
992 Normally, IDs are defined in bootstage.h but a small number of
993 additional 'user' IDs can be used by passing BOOTSTAGE_ID_ALLOC
994 as the ID.
995
996 Calls to show_boot_progress() will also result in log entries but
997 these will not have names.
998
999config SPL_BOOTSTAGE
1000 bool "Boot timing and reported in SPL"
Tom Rini0a83cc22022-06-10 23:03:09 -04001001 depends on BOOTSTAGE && SPL
Simon Glassd02ddcf2020-09-10 20:21:14 -06001002 help
1003 Enable recording of boot time in SPL. To make this visible to U-Boot
1004 proper, enable BOOTSTAGE_STASH as well. This will stash the timing
1005 information when SPL finishes and load it when U-Boot proper starts
1006 up.
1007
1008config TPL_BOOTSTAGE
1009 bool "Boot timing and reported in TPL"
Tom Rini36a4ca02022-06-08 08:24:39 -04001010 depends on BOOTSTAGE && TPL
Simon Glassd02ddcf2020-09-10 20:21:14 -06001011 help
1012 Enable recording of boot time in SPL. To make this visible to U-Boot
1013 proper, enable BOOTSTAGE_STASH as well. This will stash the timing
1014 information when TPL finishes and load it when U-Boot proper starts
1015 up.
1016
1017config BOOTSTAGE_REPORT
1018 bool "Display a detailed boot timing report before booting the OS"
1019 depends on BOOTSTAGE
1020 help
1021 Enable output of a boot time report just before the OS is booted.
1022 This shows how long it took U-Boot to go through each stage of the
1023 boot process. The report looks something like this:
1024
1025 Timer summary in microseconds:
1026 Mark Elapsed Stage
1027 0 0 reset
1028 3,575,678 3,575,678 board_init_f start
1029 3,575,695 17 arch_cpu_init A9
1030 3,575,777 82 arch_cpu_init done
1031 3,659,598 83,821 board_init_r start
1032 3,910,375 250,777 main_loop
1033 29,916,167 26,005,792 bootm_start
1034 30,361,327 445,160 start_kernel
1035
1036config BOOTSTAGE_RECORD_COUNT
1037 int "Number of boot stage records to store"
Simon Glass051ddfb2021-02-03 06:00:49 -07001038 depends on BOOTSTAGE
Simon Glassd02ddcf2020-09-10 20:21:14 -06001039 default 30
1040 help
1041 This is the size of the bootstage record list and is the maximum
1042 number of bootstage records that can be recorded.
1043
1044config SPL_BOOTSTAGE_RECORD_COUNT
1045 int "Number of boot stage records to store for SPL"
Simon Glass051ddfb2021-02-03 06:00:49 -07001046 depends on SPL_BOOTSTAGE
Simon Glassd02ddcf2020-09-10 20:21:14 -06001047 default 5
1048 help
1049 This is the size of the bootstage record list and is the maximum
1050 number of bootstage records that can be recorded.
1051
1052config TPL_BOOTSTAGE_RECORD_COUNT
1053 int "Number of boot stage records to store for TPL"
Simon Glass051ddfb2021-02-03 06:00:49 -07001054 depends on TPL_BOOTSTAGE
Simon Glassd02ddcf2020-09-10 20:21:14 -06001055 default 5
1056 help
1057 This is the size of the bootstage record list and is the maximum
1058 number of bootstage records that can be recorded.
1059
1060config BOOTSTAGE_FDT
1061 bool "Store boot timing information in the OS device tree"
1062 depends on BOOTSTAGE
1063 help
1064 Stash the bootstage information in the FDT. A root 'bootstage'
1065 node is created with each bootstage id as a child. Each child
1066 has a 'name' property and either 'mark' containing the
1067 mark time in microseconds, or 'accum' containing the
1068 accumulated time for that bootstage id in microseconds.
1069 For example:
1070
1071 bootstage {
1072 154 {
1073 name = "board_init_f";
1074 mark = <3575678>;
1075 };
1076 170 {
1077 name = "lcd";
1078 accum = <33482>;
1079 };
1080 };
1081
1082 Code in the Linux kernel can find this in /proc/devicetree.
1083
1084config BOOTSTAGE_STASH
1085 bool "Stash the boot timing information in memory before booting OS"
1086 depends on BOOTSTAGE
1087 help
1088 Some OSes do not support device tree. Bootstage can instead write
1089 the boot timing information in a binary format at a given address.
1090 This happens through a call to bootstage_stash(), typically in
1091 the CPU's cleanup_before_linux() function. You can use the
1092 'bootstage stash' and 'bootstage unstash' commands to do this on
1093 the command line.
1094
1095config BOOTSTAGE_STASH_ADDR
1096 hex "Address to stash boot timing information"
Tom Rinid78c9bd2024-07-15 12:42:00 +01001097 depends on BOOTSTAGE_STASH
1098 default 0xC3000000 if STM32MP13X || STM32MP15X
1099 default 0x87000000 if STM32MP25X
1100 default 0x0 if SANDBOX
Simon Glassd02ddcf2020-09-10 20:21:14 -06001101 help
1102 Provide an address which will not be overwritten by the OS when it
1103 starts, so that it can read this information when ready.
1104
1105config BOOTSTAGE_STASH_SIZE
1106 hex "Size of boot timing stash region"
Tom Rinid78c9bd2024-07-15 12:42:00 +01001107 depends on BOOTSTAGE_STASH
Simon Glassd02ddcf2020-09-10 20:21:14 -06001108 default 0x1000
1109 help
1110 This should be large enough to hold the bootstage stash. A value of
1111 4096 (4KiB) is normally plenty.
1112
1113config SHOW_BOOT_PROGRESS
1114 bool "Show boot progress in a board-specific manner"
1115 help
1116 Defining this option allows to add some board-specific code (calling
1117 a user-provided function show_boot_progress(int) that enables you to
1118 show the system's boot progress on some display (for example, some
1119 LEDs) on your board. At the moment, the following checkpoints are
1120 implemented:
1121
1122 Legacy uImage format:
1123
1124 Arg Where When
1125 1 common/cmd_bootm.c before attempting to boot an image
1126 -1 common/cmd_bootm.c Image header has bad magic number
1127 2 common/cmd_bootm.c Image header has correct magic number
1128 -2 common/cmd_bootm.c Image header has bad checksum
1129 3 common/cmd_bootm.c Image header has correct checksum
1130 -3 common/cmd_bootm.c Image data has bad checksum
1131 4 common/cmd_bootm.c Image data has correct checksum
1132 -4 common/cmd_bootm.c Image is for unsupported architecture
1133 5 common/cmd_bootm.c Architecture check OK
1134 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
1135 6 common/cmd_bootm.c Image Type check OK
1136 -6 common/cmd_bootm.c gunzip uncompression error
1137 -7 common/cmd_bootm.c Unimplemented compression type
1138 7 common/cmd_bootm.c Uncompression OK
1139 8 common/cmd_bootm.c No uncompress/copy overwrite error
1140 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
1141
1142 9 common/image.c Start initial ramdisk verification
1143 -10 common/image.c Ramdisk header has bad magic number
1144 -11 common/image.c Ramdisk header has bad checksum
1145 10 common/image.c Ramdisk header is OK
1146 -12 common/image.c Ramdisk data has bad checksum
1147 11 common/image.c Ramdisk data has correct checksum
1148 12 common/image.c Ramdisk verification complete, start loading
1149 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
1150 13 common/image.c Start multifile image verification
1151 14 common/image.c No initial ramdisk, no multifile, continue.
1152
1153 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
1154
1155 -30 arch/powerpc/lib/board.c Fatal error, hang the system
1156 -31 post/post.c POST test failed, detected by post_output_backlog()
1157 -32 post/post.c POST test failed, detected by post_run_single()
1158
1159 34 common/cmd_doc.c before loading a Image from a DOC device
1160 -35 common/cmd_doc.c Bad usage of "doc" command
1161 35 common/cmd_doc.c correct usage of "doc" command
1162 -36 common/cmd_doc.c No boot device
1163 36 common/cmd_doc.c correct boot device
1164 -37 common/cmd_doc.c Unknown Chip ID on boot device
1165 37 common/cmd_doc.c correct chip ID found, device available
1166 -38 common/cmd_doc.c Read Error on boot device
1167 38 common/cmd_doc.c reading Image header from DOC device OK
1168 -39 common/cmd_doc.c Image header has bad magic number
1169 39 common/cmd_doc.c Image header has correct magic number
1170 -40 common/cmd_doc.c Error reading Image from DOC device
1171 40 common/cmd_doc.c Image header has correct magic number
1172 41 common/cmd_ide.c before loading a Image from a IDE device
1173 -42 common/cmd_ide.c Bad usage of "ide" command
1174 42 common/cmd_ide.c correct usage of "ide" command
1175 -43 common/cmd_ide.c No boot device
1176 43 common/cmd_ide.c boot device found
1177 -44 common/cmd_ide.c Device not available
1178 44 common/cmd_ide.c Device available
1179 -45 common/cmd_ide.c wrong partition selected
1180 45 common/cmd_ide.c partition selected
1181 -46 common/cmd_ide.c Unknown partition table
1182 46 common/cmd_ide.c valid partition table found
1183 -47 common/cmd_ide.c Invalid partition type
1184 47 common/cmd_ide.c correct partition type
1185 -48 common/cmd_ide.c Error reading Image Header on boot device
1186 48 common/cmd_ide.c reading Image Header from IDE device OK
1187 -49 common/cmd_ide.c Image header has bad magic number
1188 49 common/cmd_ide.c Image header has correct magic number
1189 -50 common/cmd_ide.c Image header has bad checksum
1190 50 common/cmd_ide.c Image header has correct checksum
1191 -51 common/cmd_ide.c Error reading Image from IDE device
1192 51 common/cmd_ide.c reading Image from IDE device OK
1193 52 common/cmd_nand.c before loading a Image from a NAND device
1194 -53 common/cmd_nand.c Bad usage of "nand" command
1195 53 common/cmd_nand.c correct usage of "nand" command
1196 -54 common/cmd_nand.c No boot device
1197 54 common/cmd_nand.c boot device found
1198 -55 common/cmd_nand.c Unknown Chip ID on boot device
1199 55 common/cmd_nand.c correct chip ID found, device available
1200 -56 common/cmd_nand.c Error reading Image Header on boot device
1201 56 common/cmd_nand.c reading Image Header from NAND device OK
1202 -57 common/cmd_nand.c Image header has bad magic number
1203 57 common/cmd_nand.c Image header has correct magic number
1204 -58 common/cmd_nand.c Error reading Image from NAND device
1205 58 common/cmd_nand.c reading Image from NAND device OK
1206
1207 -60 common/env_common.c Environment has a bad CRC, using default
1208
1209 64 net/eth.c starting with Ethernet configuration.
1210 -64 net/eth.c no Ethernet found.
1211 65 net/eth.c Ethernet found.
1212
1213 -80 common/cmd_net.c usage wrong
1214 80 common/cmd_net.c before calling net_loop()
1215 -81 common/cmd_net.c some error in net_loop() occurred
1216 81 common/cmd_net.c net_loop() back without error
1217 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
1218 82 common/cmd_net.c trying automatic boot
1219 83 common/cmd_net.c running "source" command
1220 -83 common/cmd_net.c some error in automatic boot or "source" command
1221 84 common/cmd_net.c end without errors
1222
1223 FIT uImage format:
1224
1225 Arg Where When
1226 100 common/cmd_bootm.c Kernel FIT Image has correct format
1227 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
1228 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
1229 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
1230 102 common/cmd_bootm.c Kernel unit name specified
1231 -103 common/cmd_bootm.c Can't get kernel subimage node offset
1232 103 common/cmd_bootm.c Found configuration node
1233 104 common/cmd_bootm.c Got kernel subimage node offset
1234 -104 common/cmd_bootm.c Kernel subimage hash verification failed
1235 105 common/cmd_bootm.c Kernel subimage hash verification OK
1236 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
1237 106 common/cmd_bootm.c Architecture check OK
1238 -106 common/cmd_bootm.c Kernel subimage has wrong type
1239 107 common/cmd_bootm.c Kernel subimage type OK
1240 -107 common/cmd_bootm.c Can't get kernel subimage data/size
1241 108 common/cmd_bootm.c Got kernel subimage data/size
1242 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
1243 -109 common/cmd_bootm.c Can't get kernel subimage type
1244 -110 common/cmd_bootm.c Can't get kernel subimage comp
1245 -111 common/cmd_bootm.c Can't get kernel subimage os
1246 -112 common/cmd_bootm.c Can't get kernel subimage load address
1247 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
1248
1249 120 common/image.c Start initial ramdisk verification
1250 -120 common/image.c Ramdisk FIT image has incorrect format
1251 121 common/image.c Ramdisk FIT image has correct format
1252 122 common/image.c No ramdisk subimage unit name, using configuration
1253 -122 common/image.c Can't get configuration for ramdisk subimage
1254 123 common/image.c Ramdisk unit name specified
1255 -124 common/image.c Can't get ramdisk subimage node offset
1256 125 common/image.c Got ramdisk subimage node offset
1257 -125 common/image.c Ramdisk subimage hash verification failed
1258 126 common/image.c Ramdisk subimage hash verification OK
1259 -126 common/image.c Ramdisk subimage for unsupported architecture
1260 127 common/image.c Architecture check OK
1261 -127 common/image.c Can't get ramdisk subimage data/size
1262 128 common/image.c Got ramdisk subimage data/size
1263 129 common/image.c Can't get ramdisk load address
1264 -129 common/image.c Got ramdisk load address
1265
1266 -130 common/cmd_doc.c Incorrect FIT image format
1267 131 common/cmd_doc.c FIT image format OK
1268
1269 -140 common/cmd_ide.c Incorrect FIT image format
1270 141 common/cmd_ide.c FIT image format OK
1271
1272 -150 common/cmd_nand.c Incorrect FIT image format
1273 151 common/cmd_nand.c FIT image format OK
1274
Marek Vasut98154342021-10-23 03:06:03 +02001275config SPL_SHOW_BOOT_PROGRESS
Jan Kiszka5780edb2021-11-03 15:09:36 +01001276 bool "Show boot progress in a board-specific manner in SPL"
Marek Vasut98154342021-10-23 03:06:03 +02001277 depends on SPL
1278 help
1279 Defining this option allows to add some board-specific code (calling
1280 a user-provided function show_boot_progress(int) that enables you to
1281 show the system's boot progress on some display (for example, some
1282 LEDs) on your board. For details see SHOW_BOOT_PROGRESS.
1283
Simon Glassd02ddcf2020-09-10 20:21:14 -06001284endmenu
1285
Simon Glasseebed782020-09-10 20:21:15 -06001286menu "Boot media"
1287
1288config NOR_BOOT
1289 bool "Support for booting from NOR flash"
1290 depends on NOR
1291 help
1292 Enabling this will make a U-Boot binary that is capable of being
1293 booted via NOR. In this case we will enable certain pinmux early
1294 as the ROM only partially sets up pinmux. We also default to using
1295 NOR for environment.
1296
1297config NAND_BOOT
1298 bool "Support for booting from NAND flash"
Simon Glasseebed782020-09-10 20:21:15 -06001299 imply MTD_RAW_NAND
1300 help
1301 Enabling this will make a U-Boot binary that is capable of being
1302 booted via NAND flash. This is not a must, some SoCs need this,
1303 some not.
1304
1305config ONENAND_BOOT
1306 bool "Support for booting from ONENAND"
Simon Glasseebed782020-09-10 20:21:15 -06001307 imply MTD_RAW_NAND
1308 help
1309 Enabling this will make a U-Boot binary that is capable of being
1310 booted via ONENAND. This is not a must, some SoCs need this,
1311 some not.
1312
1313config QSPI_BOOT
1314 bool "Support for booting from QSPI flash"
Simon Glasseebed782020-09-10 20:21:15 -06001315 help
1316 Enabling this will make a U-Boot binary that is capable of being
1317 booted via QSPI flash. This is not a must, some SoCs need this,
1318 some not.
1319
1320config SATA_BOOT
1321 bool "Support for booting from SATA"
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 SATA. This is not a must, some SoCs need this,
1325 some not.
1326
1327config SD_BOOT
1328 bool "Support for booting from SD/EMMC"
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 SD/EMMC. This is not a must, some SoCs need this,
1332 some not.
1333
Tom Rinia43bf4e2021-12-11 14:55:50 -05001334config SD_BOOT_QSPI
1335 bool "Support for booting from SD/EMMC and enable QSPI"
1336 help
1337 Enabling this will make a U-Boot binary that is capable of being
1338 booted via SD/EMMC while enabling QSPI on the platform as well. This
1339 is not a must, some SoCs need this, some not.
1340
Simon Glasseebed782020-09-10 20:21:15 -06001341config SPI_BOOT
1342 bool "Support for booting from SPI flash"
Simon Glasseebed782020-09-10 20:21:15 -06001343 help
1344 Enabling this will make a U-Boot binary that is capable of being
1345 booted via SPI flash. This is not a must, some SoCs need this,
1346 some not.
1347
1348endmenu
1349
Simon Glasse9d54d72020-09-10 20:21:16 -06001350menu "Autoboot options"
1351
1352config AUTOBOOT
1353 bool "Autoboot"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001354 depends on CMDLINE
Simon Glasse9d54d72020-09-10 20:21:16 -06001355 default y
1356 help
1357 This enables the autoboot. See doc/README.autoboot for detail.
1358
Simon Glass7dee9dc2023-10-26 14:31:22 -04001359if AUTOBOOT
1360
Simon Glass1b6cbaa2020-09-10 20:21:17 -06001361config BOOTDELAY
1362 int "delay in seconds before automatically booting"
1363 default 2
Simon Glass1b6cbaa2020-09-10 20:21:17 -06001364 help
1365 Delay before automatically running bootcmd;
1366 set to 0 to autoboot with no delay, but you can stop it by key input.
1367 set to -1 to disable autoboot.
1368 set to -2 to autoboot with no delay and not check for abort
1369
1370 If this value is >= 0 then it is also used for the default delay
1371 before starting the default entry in bootmenu. If it is < 0 then
1372 a default value of 10s is used.
1373
1374 See doc/README.autoboot for details.
1375
Simon Glasse9d54d72020-09-10 20:21:16 -06001376config AUTOBOOT_KEYED
1377 bool "Stop autobooting via specific input key / string"
Simon Glasse9d54d72020-09-10 20:21:16 -06001378 help
1379 This option enables stopping (aborting) of the automatic
1380 boot feature only by issuing a specific input key or
1381 string. If not enabled, any input key will abort the
1382 U-Boot automatic booting process and bring the device
1383 to the U-Boot prompt for user input.
1384
Simon Glass7dee9dc2023-10-26 14:31:22 -04001385if AUTOBOOT_KEYED
1386
Steffen Jaeckeldfc97322021-07-08 15:57:38 +02001387config AUTOBOOT_FLUSH_STDIN
1388 bool "Enable flushing stdin before starting to read the password"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001389 depends on !SANDBOX
Steffen Jaeckeldfc97322021-07-08 15:57:38 +02001390 help
1391 When this option is enabled stdin buffer will be flushed before
1392 starting to read the password.
1393 This can't be enabled for the sandbox as flushing stdin would
1394 break the autoboot unit tests.
1395
Simon Glasse9d54d72020-09-10 20:21:16 -06001396config AUTOBOOT_PROMPT
1397 string "Autoboot stop prompt"
Simon Glasse9d54d72020-09-10 20:21:16 -06001398 default "Autoboot in %d seconds\\n"
1399 help
1400 This string is displayed before the boot delay selected by
1401 CONFIG_BOOTDELAY starts. If it is not defined there is no
1402 output indicating that autoboot is in progress.
1403
1404 Note that this define is used as the (only) argument to a
1405 printf() call, so it may contain '%' format specifications,
Quentin Schulzc0a7ae02024-06-12 16:58:47 +02001406 provided that it also includes, separated by commas exactly
Simon Glasse9d54d72020-09-10 20:21:16 -06001407 like in a printf statement, the required arguments. It is
1408 the responsibility of the user to select only such arguments
1409 that are valid in the given context.
1410
1411config AUTOBOOT_ENCRYPTION
1412 bool "Enable encryption in autoboot stopping"
Simon Glasse9d54d72020-09-10 20:21:16 -06001413 help
1414 This option allows a string to be entered into U-Boot to stop the
Steffen Jaeckel6aa6bfb2021-07-08 15:57:35 +02001415 autoboot.
1416 The behavior depends whether CONFIG_CRYPT_PW from lib is enabled
1417 or not.
1418 In case CONFIG_CRYPT_PW is enabled, the string will be forwarded
1419 to the crypt-based functionality and be compared against the
1420 string in the environment variable 'bootstopkeycrypt'.
1421 In case CONFIG_CRYPT_PW is disabled the string itself is hashed
1422 and compared against the hash in the environment variable
1423 'bootstopkeysha256'.
1424 If it matches in either case then boot stops and
1425 a command-line prompt is presented.
Simon Glasse9d54d72020-09-10 20:21:16 -06001426 This provides a way to ship a secure production device which can also
1427 be accessed at the U-Boot command line.
1428
Steffen Jaeckel28be70d2021-07-08 15:57:39 +02001429config AUTOBOOT_SHA256_FALLBACK
1430 bool "Allow fallback from crypt-hashed password to sha256"
1431 depends on AUTOBOOT_ENCRYPTION && CRYPT_PW
1432 help
1433 This option adds support to fall back from crypt-hashed
1434 passwords to checking a SHA256 hashed password in case the
1435 'bootstopusesha256' environment variable is set to 'true'.
1436
Simon Glasse9d54d72020-09-10 20:21:16 -06001437config AUTOBOOT_DELAY_STR
1438 string "Delay autobooting via specific input key / string"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001439 depends on !AUTOBOOT_ENCRYPTION
Simon Glasse9d54d72020-09-10 20:21:16 -06001440 help
1441 This option delays the automatic boot feature by issuing
1442 a specific input key or string. If CONFIG_AUTOBOOT_DELAY_STR
1443 or the environment variable "bootdelaykey" is specified
1444 and this string is received from console input before
1445 autoboot starts booting, U-Boot gives a command prompt. The
1446 U-Boot prompt will time out if CONFIG_BOOT_RETRY_TIME is
1447 used, otherwise it never times out.
1448
1449config AUTOBOOT_STOP_STR
1450 string "Stop autobooting via specific input key / string"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001451 depends on !AUTOBOOT_ENCRYPTION
Simon Glasse9d54d72020-09-10 20:21:16 -06001452 help
1453 This option enables stopping (aborting) of the automatic
1454 boot feature only by issuing a specific input key or
1455 string. If CONFIG_AUTOBOOT_STOP_STR or the environment
1456 variable "bootstopkey" is specified and this string is
1457 received from console input before autoboot starts booting,
1458 U-Boot gives a command prompt. The U-Boot prompt never
1459 times out, even if CONFIG_BOOT_RETRY_TIME is used.
1460
1461config AUTOBOOT_KEYED_CTRLC
1462 bool "Enable Ctrl-C autoboot interruption"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001463 depends on !AUTOBOOT_ENCRYPTION
Simon Glasse9d54d72020-09-10 20:21:16 -06001464 help
1465 This option allows for the boot sequence to be interrupted
1466 by ctrl-c, in addition to the "bootdelaykey" and "bootstopkey".
1467 Setting this variable provides an escape sequence from the
1468 limited "password" strings.
1469
Steffen Jaeckel792a13f2021-07-08 15:57:37 +02001470config AUTOBOOT_NEVER_TIMEOUT
1471 bool "Make the password entry never time-out"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001472 depends on AUTOBOOT_ENCRYPTION && CRYPT_PW
Steffen Jaeckel792a13f2021-07-08 15:57:37 +02001473 help
1474 This option removes the timeout from the password entry
1475 when the user first presses the <Enter> key before entering
1476 any other character.
1477
Steffen Jaeckel6aa6bfb2021-07-08 15:57:35 +02001478config AUTOBOOT_STOP_STR_ENABLE
1479 bool "Enable fixed string to stop autobooting"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001480 depends on AUTOBOOT_ENCRYPTION
Steffen Jaeckel6aa6bfb2021-07-08 15:57:35 +02001481 help
1482 This option enables the feature to add a fixed stop
1483 string that is defined at compile time.
1484 In every case it will be tried to load the stop
1485 string from the environment.
1486 In case this is enabled and there is no stop string
1487 in the environment, this will be used as default value.
1488
1489config AUTOBOOT_STOP_STR_CRYPT
1490 string "Stop autobooting via crypt-hashed password"
1491 depends on AUTOBOOT_STOP_STR_ENABLE && CRYPT_PW
1492 help
1493 This option adds the feature to only stop the autobooting,
1494 and therefore boot into the U-Boot prompt, when the input
1495 string / password matches a values that is hashed via
1496 one of the supported crypt-style password hashing options
1497 and saved in the environment variable "bootstopkeycrypt".
1498
Simon Glasse9d54d72020-09-10 20:21:16 -06001499config AUTOBOOT_STOP_STR_SHA256
Steffen Jaeckele1788f92021-07-08 15:57:40 +02001500 string "Stop autobooting via SHA256 hashed password"
Steffen Jaeckel6aa6bfb2021-07-08 15:57:35 +02001501 depends on AUTOBOOT_STOP_STR_ENABLE
Simon Glasse9d54d72020-09-10 20:21:16 -06001502 help
1503 This option adds the feature to only stop the autobooting,
1504 and therefore boot into the U-Boot prompt, when the input
Quentin Schulzc0a7ae02024-06-12 16:58:47 +02001505 string / password matches a values that is encrypted via
Joel Peshkin8b7bf532020-11-21 17:18:59 -08001506 a SHA256 hash and saved in the environment variable
1507 "bootstopkeysha256". If the value in that variable
1508 includes a ":", the portion prior to the ":" will be treated
1509 as a salt value.
Simon Glasse9d54d72020-09-10 20:21:16 -06001510
Simon Glass7dee9dc2023-10-26 14:31:22 -04001511endif # AUTOBOOT_KEYED
1512
1513if !AUTOBOOT_KEYED
1514
Simon Glasse9d54d72020-09-10 20:21:16 -06001515config AUTOBOOT_USE_MENUKEY
1516 bool "Allow a specify key to run a menu from the environment"
Simon Glasse9d54d72020-09-10 20:21:16 -06001517 help
1518 If a specific key is pressed to stop autoboot, then the commands in
1519 the environment variable 'menucmd' are executed before boot starts.
1520
1521config AUTOBOOT_MENUKEY
1522 int "ASCII value of boot key to show a menu"
1523 default 0
1524 depends on AUTOBOOT_USE_MENUKEY
1525 help
1526 If this key is pressed to stop autoboot, then the commands in the
1527 environment variable 'menucmd' will be executed before boot starts.
1528 For example, 33 means "!" in ASCII, so pressing ! at boot would take
1529 this action.
1530
Simon Glass7dee9dc2023-10-26 14:31:22 -04001531endif
1532
1533endif # AUTOBOOT
1534
Simon Glasse9d54d72020-09-10 20:21:16 -06001535config AUTOBOOT_MENU_SHOW
1536 bool "Show a menu on boot"
1537 depends on CMD_BOOTMENU
1538 help
1539 This enables the boot menu, controlled by environment variables
1540 defined by the board. The menu starts after running the 'preboot'
1541 environmnent variable (if enabled) and before handling the boot delay.
Peter Robinson16e0b8f2023-08-18 15:54:10 +01001542 See doc/usage/cmd/bootmenu.rst for more details.
Simon Glasse9d54d72020-09-10 20:21:16 -06001543
Masahisa Kojima97cbcc42022-05-26 19:09:38 +09001544config BOOTMENU_DISABLE_UBOOT_CONSOLE
1545 bool "Disallow bootmenu to enter the U-Boot console"
1546 depends on AUTOBOOT_MENU_SHOW
1547 help
1548 If this option is enabled, user can not enter the U-Boot console from
1549 bootmenu. It increases the system security.
1550
Tom Rinia45a3ef2022-03-11 09:12:04 -05001551config BOOT_RETRY
1552 bool "Boot retry feature"
1553 help
1554 Allow for having the U-Boot command prompt time out and attempt
1555 to boot again. If the environment variable "bootretry" is found then
1556 its value is used, otherwise the retry timeout is
1557 CONFIG_BOOT_RETRY_TIME. CONFIG_BOOT_RETRY_MIN is optional and
1558 defaults to CONFIG_BOOT_RETRY_TIME. All times are in seconds.
1559
1560config BOOT_RETRY_TIME
1561 int "Timeout in seconds before attempting to boot again"
1562 depends on BOOT_RETRY
1563 help
1564 Time in seconds before the U-Boot prompt will timeout and boot will
1565 be attempted again.
1566
1567config BOOT_RETRY_MIN
1568 int "Minimum timeout in seconds for 'bootretry'"
1569 depends on BOOT_RETRY
1570 default BOOT_RETRY_TIME
1571 help
1572 The minimum time in seconds that "bootretry" can be set to.
1573
1574config RESET_TO_RETRY
1575 bool "Reset the board to retry autoboot"
1576 depends on BOOT_RETRY
1577 help
1578 After the countdown timed out, the board will be reset to restart
1579 again.
1580
Simon Glasse9d54d72020-09-10 20:21:16 -06001581endmenu
1582
Philippe Reynesd28484e2022-03-28 22:56:59 +02001583menu "Image support"
1584
1585config IMAGE_PRE_LOAD
1586 bool "Image pre-load support"
1587 help
1588 Enable an image pre-load stage in the SPL.
1589 This pre-load stage allows to do some manipulation
1590 or check (for example signature check) on an image
1591 before launching it.
1592
1593config SPL_IMAGE_PRE_LOAD
1594 bool "Image pre-load support within SPL"
1595 depends on SPL && IMAGE_PRE_LOAD
1596 help
1597 Enable an image pre-load stage in the SPL.
1598 This pre-load stage allows to do some manipulation
1599 or check (for example signature check) on an image
1600 before launching it.
1601
1602config IMAGE_PRE_LOAD_SIG
1603 bool "Image pre-load signature support"
1604 depends on IMAGE_PRE_LOAD
1605 select FIT_SIGNATURE
1606 select RSA
1607 select RSA_VERIFY_WITH_PKEY
1608 help
1609 Enable signature check support in the pre-load stage.
1610 For this feature a very simple header is added before
1611 the image with few fields:
1612 - a magic
1613 - the image size
1614 - the signature
1615 All other information (header size, type of signature,
1616 ...) are provided in the node /image/pre-load/sig of
1617 u-boot.
1618
1619config SPL_IMAGE_PRE_LOAD_SIG
1620 bool "Image pre-load signature support witin SPL"
1621 depends on SPL_IMAGE_PRE_LOAD && IMAGE_PRE_LOAD_SIG
1622 select SPL_FIT_SIGNATURE
1623 select SPL_RSA
1624 select SPL_RSA_VERIFY_WITH_PKEY
1625 help
1626 Enable signature check support in the pre-load stage in the SPL.
1627 For this feature a very simple header is added before
1628 the image with few fields:
1629 - a magic
1630 - the image size
1631 - the signature
1632 All other information (header size, type of signature,
1633 ...) are provided in the node /image/pre-load/sig of
1634 u-boot.
1635
1636endmenu
1637
Simon Glass27367192023-09-14 10:55:46 -06001638if OF_LIBFDT
1639
1640menu "Devicetree fixup"
1641
Matthias Schiffere908fec2023-12-11 12:03:17 +01001642config OF_ENV_SETUP
1643 bool "Run a command from environment to set up device tree before boot"
1644 depends on CMD_FDT
1645 help
1646 This causes U-Boot to run a command from the environment variable
1647 fdt_fixup before booting into the operating system, which can use the
1648 fdt command to modify the device tree. The device tree is then passed
1649 to the OS.
1650
Simon Glass48e6d3d2023-09-14 10:55:47 -06001651config OF_BOARD_SETUP
1652 bool "Set up board-specific details in device tree before boot"
1653 help
1654 This causes U-Boot to call ft_board_setup() before booting into
1655 the Operating System. This function can set up various
1656 board-specific information in the device tree for use by the OS.
1657 The device tree is then passed to the OS.
1658
1659config OF_SYSTEM_SETUP
1660 bool "Set up system-specific details in device tree before boot"
1661 help
1662 This causes U-Boot to call ft_system_setup() before booting into
1663 the Operating System. This function can set up various
1664 system-specific information in the device tree for use by the OS.
1665 The device tree is then passed to the OS.
1666
1667config OF_STDOUT_VIA_ALIAS
1668 bool "Update the device-tree stdout alias from U-Boot"
1669 help
1670 This uses U-Boot's serial alias from the aliases node to update
1671 the device tree passed to the OS. The "linux,stdout-path" property
1672 in the chosen node is set to point to the correct serial node.
1673 This option currently references CONFIG_CONS_INDEX, which is
1674 incorrect when used with device tree as this option does not
1675 exist / should not be used.
1676
Simon Glassb7b7f162023-09-14 10:55:57 -06001677config FDT_FIXUP_PARTITIONS
Simon Glass1a5bcc12023-09-14 10:55:58 -06001678 bool "Overwrite MTD partitions in DTS through defined in 'mtdparts'"
Simon Glassb7b7f162023-09-14 10:55:57 -06001679 help
1680 Allow overwriting defined partitions in the device tree blob
1681 using partition info defined in the 'mtdparts' environment
1682 variable.
1683
Simon Glass27367192023-09-14 10:55:46 -06001684config FDT_SIMPLEFB
1685 bool "FDT tools for simplefb support"
Devarsh Thakkaree3dad42024-09-25 20:43:52 +05301686 depends on VIDEO
Simon Glass27367192023-09-14 10:55:46 -06001687 help
1688 Enable the fdt tools to manage the simple fb nodes in device tree.
1689 These functions can be used by board to indicate to the OS
1690 the presence of the simple frame buffer with associated reserved
1691 memory
1692
Simon Glass624c0e52023-09-14 10:55:59 -06001693config ARCH_FIXUP_FDT_MEMORY
1694 bool "Enable arch_fixup_memory_banks() call"
1695 default y
1696 help
1697 Enable FDT memory map syncup before OS boot. This feature can be
1698 used for booting OS with different memory setup where the part of
1699 the memory location should be used for different purpose.
1700
Simon Glass27367192023-09-14 10:55:46 -06001701endmenu
1702
1703endif # OF_LIBFDT
1704
Simon Glass5e958642020-09-10 20:21:18 -06001705config USE_BOOTARGS
1706 bool "Enable boot arguments"
1707 help
1708 Provide boot arguments to bootm command. Boot arguments are specified
1709 in CONFIG_BOOTARGS option. Enable this option to be able to specify
1710 CONFIG_BOOTARGS string. If this option is disabled, CONFIG_BOOTARGS
1711 will be undefined and won't take any space in U-Boot image.
1712
1713config BOOTARGS
1714 string "Boot arguments"
1715 depends on USE_BOOTARGS && !USE_DEFAULT_ENV_FILE
1716 help
1717 This can be used to pass arguments to the bootm command. The value of
1718 CONFIG_BOOTARGS goes into the environment value "bootargs". Note that
1719 this value will also override the "chosen" node in FDT blob.
1720
Simon Glass529e2082020-11-05 10:33:48 -07001721config BOOTARGS_SUBST
1722 bool "Support substituting strings in boot arguments"
1723 help
1724 This allows substituting string values in the boot arguments. These
1725 are applied after the commandline has been built.
1726
1727 One use for this is to insert the root-disk UUID into the command
1728 line where bootargs contains "root=${uuid}"
1729
1730 setenv bootargs "console= root=${uuid}"
1731 # Set the 'uuid' environment variable
1732 part uuid mmc 2:2 uuid
1733
1734 # Command-line substitution will put the real uuid into the
1735 # kernel command line
1736 bootm
1737
Simon Glass5e958642020-09-10 20:21:18 -06001738config USE_BOOTCOMMAND
1739 bool "Enable a default value for bootcmd"
Tom Rinidc3bf2d2023-10-26 14:31:28 -04001740 depends on CMDLINE
Simon Glass5e958642020-09-10 20:21:18 -06001741 help
1742 Provide a default value for the bootcmd entry in the environment. If
1743 autoboot is enabled this is what will be run automatically. Enable
1744 this option to be able to specify CONFIG_BOOTCOMMAND as a string. If
1745 this option is disabled, CONFIG_BOOTCOMMAND will be undefined and
1746 won't take any space in U-Boot image.
1747
1748config BOOTCOMMAND
1749 string "bootcmd value"
1750 depends on USE_BOOTCOMMAND && !USE_DEFAULT_ENV_FILE
Simon Glass2d5a8e12023-05-06 08:27:09 -06001751 default "bootflow scan -lb" if BOOTSTD_DEFAULTS && CMD_BOOTFLOW_FULL
1752 default "bootflow scan" if BOOTSTD_DEFAULTS && !CMD_BOOTFLOW_FULL
Simon Glassbe661cb2022-04-24 23:31:27 -06001753 default "run distro_bootcmd" if !BOOTSTD_BOOTCOMMAND && DISTRO_DEFAULTS
Simon Glass5e958642020-09-10 20:21:18 -06001754 help
1755 This is the string of commands that will be used as bootcmd and if
1756 AUTOBOOT is set, automatically run.
1757
1758config USE_PREBOOT
1759 bool "Enable preboot"
Tom Rinidc3bf2d2023-10-26 14:31:28 -04001760 depends on CMDLINE
Simon Glass5e958642020-09-10 20:21:18 -06001761 help
1762 When this option is enabled, the existence of the environment
1763 variable "preboot" will be checked immediately before starting the
1764 CONFIG_BOOTDELAY countdown and/or running the auto-boot command resp.
1765 entering interactive mode.
1766
1767 This feature is especially useful when "preboot" is automatically
1768 generated or modified. For example, the boot code can modify the
1769 "preboot" when a user holds down a certain combination of keys.
1770
1771config PREBOOT
1772 string "preboot default value"
1773 depends on USE_PREBOOT && !USE_DEFAULT_ENV_FILE
Patrick Delaunaybb15d402020-10-12 09:47:50 +02001774 default "usb start" if USB_KEYBOARD
Simon Glass5e958642020-09-10 20:21:18 -06001775 default ""
1776 help
1777 This is the default of "preboot" environment variable.
1778
Pali Rohár39c43c32022-07-10 13:42:55 +02001779config PREBOOT_DEFINED
1780 bool
1781 default y if PREBOOT != ""
1782
Simon Glassc10ddfd2020-09-10 20:21:20 -06001783config DEFAULT_FDT_FILE
1784 string "Default fdt file"
1785 help
1786 This option is used to set the default fdt file to boot OS.
1787
Dzmitry Sankouskia3463062022-02-22 21:49:52 +03001788config SAVE_PREV_BL_FDT_ADDR
1789 depends on ARM
1790 bool "Saves fdt address, passed by the previous bootloader, to env var"
1791 help
1792 When u-boot is used as a chain-loaded bootloader (replacing OS kernel),
1793 enable this option to save fdt address, passed by the
1794 previous bootloader for future use.
1795 Address is saved to `prevbl_fdt_addr` environment variable.
1796
1797 If no fdt was provided by previous bootloader, no env variables
1798 will be created.
1799
1800config SAVE_PREV_BL_INITRAMFS_START_ADDR
1801 depends on ARM
1802 bool "Saves initramfs address, passed by the previous bootloader, to env var"
1803 help
1804 When u-boot is used as a chain-loaded bootloader(replacing OS kernel),
1805 enable this option to save initramfs address, passed by the
1806 previous bootloader for future use.
1807 Address is saved to `prevbl_initrd_start_addr` environment variable.
1808
1809 If no initramfs was provided by previous bootloader, no env variables
1810 will be created.
1811
Simon Glassc8925112023-06-01 10:23:02 -06001812menu "Configuration editor"
1813
1814config CEDIT
1815 bool "Configuration editor"
Heinrich Schuchardtef97f7c2023-12-16 16:38:36 +01001816 depends on EXPO
Simon Glassc8925112023-06-01 10:23:02 -06001817 help
1818 Provides a way to deal with board configuration and present it to
1819 the user for adjustment.
1820
1821 This is intended to provide both graphical and text-based user
1822 interfaces, but only graphical is support at present.
1823
1824endmenu # Configuration editor
1825
Simon Glassb45b1632020-09-10 20:21:13 -06001826endmenu # Booting