blob: 925afe06a19f989c3e7a6a782d61c0ce012c7de4 [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
285config SPL_FIT_SOURCE
286 string ".its source file for U-Boot FIT image"
287 depends on SPL_FIT
288 help
289 Specifies a (platform specific) FIT source file to generate the
290 U-Boot FIT image. This could specify further image to load and/or
291 execute.
292
293config USE_SPL_FIT_GENERATOR
294 bool "Use a script to generate the .its script"
Tom Rini0f3d1de2022-12-04 10:14:20 -0500295 depends on SPL_FIT
Simon Glassbd7694f2023-01-07 14:07:19 -0700296 default y if SPL_FIT && ARCH_ZYNQMP
Simon Glassb45b1632020-09-10 20:21:13 -0600297
298config SPL_FIT_GENERATOR
299 string ".its file generator script for U-Boot FIT image"
300 depends on USE_SPL_FIT_GENERATOR
Simon Glassb45b1632020-09-10 20:21:13 -0600301 default "arch/arm/mach-zynqmp/mkimage_fit_atf.sh" if SPL_LOAD_FIT && ARCH_ZYNQMP
Simon Glassb45b1632020-09-10 20:21:13 -0600302 help
303 Specifies a (platform specific) script file to generate the FIT
304 source file used to build the U-Boot FIT image file. This gets
305 passed a list of supported device tree file stub names to
306 include in the generated image.
307
Simon Glassbc993e52022-10-20 18:23:13 -0600308if VPL
309
310config VPL_FIT
311 bool "Support Flattened Image Tree within VPL"
312 depends on VPL
313 default y
314 select VPL_HASH
315 select VPL_OF_LIBFDT
316
317config VPL_FIT_PRINT
318 bool "Support FIT printing within VPL"
319 depends on VPL_FIT
320 default y
321 help
322 Support printing the content of the fitImage in a verbose manner in VPL.
323
324config VPL_FIT_FULL_CHECK
325 bool "Do a full check of the FIT before using it"
326 default y
327 help
328 Enable this do a full check of the FIT to make sure it is valid. This
329 helps to protect against carefully crafted FITs which take advantage
330 of bugs or omissions in the code. This includes a bad structure,
331 multiple root nodes and the like.
332
333config VPL_FIT_SIGNATURE
334 bool "Enable signature verification of FIT firmware within VPL"
335 depends on VPL_DM
Simon Glassbc993e52022-10-20 18:23:13 -0600336 default y
337 select FIT_SIGNATURE
338 select VPL_FIT
339 select VPL_CRYPTO
340 select VPL_HASH
341 imply VPL_RSA
342 imply VPL_RSA_VERIFY
343 select VPL_IMAGE_SIGN_INFO
344 select VPL_FIT_FULL_CHECK
345
346config VPL_FIT_SIGNATURE_MAX_SIZE
347 hex "Max size of signed FIT structures in VPL"
348 depends on VPL_FIT_SIGNATURE
349 default 0x10000000
350 help
351 This option sets a max size in bytes for verified FIT uImages.
352 A sane value of 256MB protects corrupted DTB structures from overlapping
353 device memory. Assure this size does not extend past expected storage
354 space.
355
356endif # VPL
357
Simon Glass2289ca92023-09-14 10:55:52 -0600358endif # FIT
359
John Keeping9b60a172022-07-28 11:19:15 +0100360config PXE_UTILS
361 bool
362 select MENU
363 help
364 Utilities for parsing PXE file formats.
365
Tom Rini984bfdc2023-10-26 14:31:24 -0400366config BOOT_DEFAULTS_FEATURES
367 bool
368 select SUPPORT_RAW_INITRD
369 select ENV_VARS_UBOOT_CONFIG
370 imply USB_STORAGE
371 imply EFI_PARTITION
372 imply ISO_PARTITION
373
374config BOOT_DEFAULTS_CMDS
375 bool
Simon Glass054d0182023-03-24 16:58:13 -0400376 imply USE_BOOTCOMMAND
377 select CMD_ENV_EXISTS
378 select CMD_EXT2
379 select CMD_EXT4
380 select CMD_FAT
381 select CMD_FS_GENERIC
382 select CMD_PART if PARTITIONS
383 select CMD_DHCP if CMD_NET
384 select CMD_PING if CMD_NET
385 select CMD_PXE if CMD_NET
Simon Glass054d0182023-03-24 16:58:13 -0400386 select CMD_BOOTI if ARM64
387 select CMD_BOOTZ if ARM && !ARM64
388 imply CMD_MII if NET
Tom Rini984bfdc2023-10-26 14:31:24 -0400389
390config BOOT_DEFAULTS
391 bool # Common defaults for standard boot and distroboot
392 select BOOT_DEFAULTS_FEATURES
393 select BOOT_DEFAULTS_CMDS if CMDLINE
Simon Glass054d0182023-03-24 16:58:13 -0400394 help
395 These are not required but are commonly needed to support a good
396 selection of booting methods. Enable this to improve the capability
397 of U-Boot to boot various images. Currently much functionality is
398 tied to enabling the command that exercises it.
399
Simon Glass6cfb0022023-09-14 10:55:53 -0600400menuconfig BOOTSTD
401 bool "Standard boot"
Simon Glass08ad13e2022-04-24 23:31:06 -0600402 default y
403 depends on DM && OF_CONTROL && BLK
404 help
405 U-Boot supports a standard way of locating something to boot,
406 typically an Operating System such as Linux, provided by a distro such
407 as Arch Linux or Debian. Enable this to support iterating through
408 available bootdevs and using bootmeths to find bootflows suitable for
409 booting.
410
411 Standard boot is not a standard way of booting, just a framework
412 within U-Boot for supporting all the different ways that exist.
413
414 Terminology:
415
416 - bootdev - a device which can hold a distro (e.g. MMC)
417 - bootmeth - a method to scan a bootdev to find bootflows (owned by
418 U-Boot)
419 - bootflow - a description of how to boot (owned by the distro)
420
Simon Glass6cfb0022023-09-14 10:55:53 -0600421if BOOTSTD
422
Simon Glassbc993e52022-10-20 18:23:13 -0600423config SPL_BOOTSTD
Simon Glass4aa874f2023-02-22 09:33:58 -0700424 bool "Standard boot support in SPL"
Simon Glassbc993e52022-10-20 18:23:13 -0600425 depends on SPL && SPL_DM && SPL_OF_CONTROL && SPL_BLK
426 default y if VPL
427 help
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200428 This enables standard boot in SPL. This is needed so that VBE
Simon Glassbc993e52022-10-20 18:23:13 -0600429 (Verified Boot for Embedded) can be used, since it depends on standard
430 boot. It is enabled by default since the main purpose of VPL is to
431 handle the firmware part of VBE.
432
433config VPL_BOOTSTD
434 bool "Standard boot support in VPL"
435 depends on VPL && VPL_DM && VPL_OF_CONTROL && VPL_BLK
436 default y
437 help
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200438 This enables standard boot in SPL. This is needed so that VBE
Simon Glassbc993e52022-10-20 18:23:13 -0600439 (Verified Boot for Embedded) can be used, since it depends on standard
440 boot. It is enabled by default since the main purpose of VPL is to
441 handle the firmware part of VBE.
442
Simon Glass78c79dd2023-02-22 14:06:23 -0700443config BOOTSTD_FULL
444 bool "Enhanced features for standard boot"
445 default y if SANDBOX
Shantur Rathore19b54342023-12-23 06:51:59 +0000446 imply BOOTSTD_DEFAULTS
Simon Glass78c79dd2023-02-22 14:06:23 -0700447 help
448 This enables various useful features for standard boot, which are not
449 essential for operation:
450
451 - bootdev, bootmeth commands
452 - extra features in the bootflow command
453 - support for selecting the ordering of bootmeths ("bootmeth order")
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200454 - support for selecting the ordering of bootdevs using the Device Tree
Simon Glass78c79dd2023-02-22 14:06:23 -0700455 as well as the "boot_targets" environment variable
456
Simon Glass2e5161eb2023-01-28 15:00:21 -0700457config BOOTSTD_DEFAULTS
458 bool "Select some common defaults for standard boot"
459 depends on BOOTSTD
Simon Glass054d0182023-03-24 16:58:13 -0400460 select BOOT_DEFAULTS
Simon Glassdb92e782023-05-10 16:34:47 -0600461 select BOOTMETH_DISTRO
Simon Glass2e5161eb2023-01-28 15:00:21 -0700462 help
463 These are not required but are commonly needed to support a good
464 selection of booting methods. Enable this to improve the capability
465 of U-Boot to boot various images.
466
Simon Glassbe661cb2022-04-24 23:31:27 -0600467config BOOTSTD_BOOTCOMMAND
468 bool "Use bootstd to boot"
469 default y if !DISTRO_DEFAULTS
470 help
471 Enable this to select a default boot-command suitable for booting
472 with standard boot. This can be overridden by the board if needed,
473 but the default command should be enough for most boards which use
474 standard boot.
475
476 For now this is only selected if distro boot is NOT used, since
477 standard boot does not support all of the features of distro boot
478 yet.
479
Simon Glass92368522023-11-18 14:05:19 -0700480config BOOTSTD_PROG
481 bool "Use programmatic boot"
482 depends on !CMDLINE
483 default y
484 help
485 Enable this to provide a board_run_command() function which can boot
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200486 a system without using commands. If the boot fails, then U-Boot will
Simon Glass92368522023-11-18 14:05:19 -0700487 panic.
488
489 Note: This currently has many limitations and is not a useful booting
490 solution. Future work will eventually make this a viable option.
491
Simon Glass4f8633d2022-07-30 15:52:21 -0600492config BOOTMETH_GLOBAL
493 bool
494 help
495 Add support for global bootmeths. This feature is used by VBE and
496 EFI bootmgr, since they take full control over which bootdevs are
497 selected to boot.
498
Mattijs Korpershoekb30baa92024-07-10 10:40:05 +0200499config BOOTMETH_ANDROID
500 bool "Bootdev support for Android"
501 depends on X86 || ARM || SANDBOX
502 depends on CMDLINE
503 select ANDROID_AB
504 select ANDROID_BOOT_IMAGE
505 select CMD_BCB
506 select CMD_FASTBOOT
507 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
Simon Glass66f62552022-04-24 23:31:17 -0600562 default y
563 help
564 Enables support for EFI boot using bootdevs. This makes the
565 bootdevs look for a 'boot<arch>.efi' on each filesystem
566 they scan. The resulting file is booted after enabling U-Boot's
567 EFI loader support.
568
569 The <arch> depends on the architecture of the board:
570
571 aa64 - aarch64 (ARM 64-bit)
572 arm - ARM 32-bit
573 ia32 - x86 32-bit
574 x64 - x86 64-bit
575 riscv32 - RISC-V 32-bit
576 riscv64 - RISC-V 64-bit
577
578 This provides a way to try out standard boot on an existing boot flow.
579
Heinrich Schuchardt72bca1a2024-04-03 20:05:17 +0200580config BOOTMETH_EFI_BOOTMGR
581 bool "Bootdev support for EFI boot manager"
582 depends on EFI_BOOTMGR
583 select BOOTMETH_GLOBAL
584 default y
585 help
586 Enable booting via the UEFI boot manager. Based on the EFI variables
587 the EFI binary to be launched is determined. To set the EFI variables
588 use the eficonfig command.
589
Heinrich Schuchardt1cd3ec92024-07-16 10:35:34 +0200590config BOOTMETH_QFW
591 bool "Boot method using QEMU parameters"
592 depends on QFW
593 default y
594 help
595 Use QEMU parameters -kernel, -initrd, -append to determine the kernel,
596 initial RAM disk, and kernel command line parameters to boot an
597 operating system. U-Boot's control device-tree is passed to the kernel.
598
Simon Glass0a9f4262022-07-30 15:52:32 -0600599config BOOTMETH_VBE
600 bool "Bootdev support for Verified Boot for Embedded"
601 depends on FIT
602 default y
603 select BOOTMETH_GLOBAL
Tom Rini7d3684a2023-01-16 15:46:49 -0500604 select EVENT
Simon Glass0a9f4262022-07-30 15:52:32 -0600605 help
606 Enables support for VBE boot. This is a standard boot method which
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200607 supports selection of various firmware components, selection of an OS to
Simon Glass0a9f4262022-07-30 15:52:32 -0600608 boot as well as updating these using fwupd.
609
Simon Glassdb92e782023-05-10 16:34:47 -0600610config BOOTMETH_DISTRO
611 bool # Options needed to boot any distro
Tom Rini9bf470a2023-10-26 14:31:27 -0400612 select BOOTMETH_SCRIPT if CMDLINE # E.g. Armbian uses scripts
Simon Glassdb92e782023-05-10 16:34:47 -0600613 select BOOTMETH_EXTLINUX # E.g. Debian uses these
614 select BOOTMETH_EXTLINUX_PXE if CMD_PXE && CMD_NET && DM_ETH
AKASHI Takahiro9b08b9a2024-01-17 13:39:41 +0900615 select BOOTMETH_EFILOADER if EFI_BINARY_EXEC # E.g. Ubuntu uses this
Simon Glassdb92e782023-05-10 16:34:47 -0600616
Simon Glassbc993e52022-10-20 18:23:13 -0600617config SPL_BOOTMETH_VBE
618 bool "Bootdev support for Verified Boot for Embedded (SPL)"
619 depends on SPL && FIT
Tom Rini7d3684a2023-01-16 15:46:49 -0500620 select EVENT
Simon Glassbc993e52022-10-20 18:23:13 -0600621 default y if VPL
622 help
623 Enables support for VBE boot. This is a standard boot method which
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200624 supports selection of various firmware components, selection of an OS to
Simon Glassbc993e52022-10-20 18:23:13 -0600625 boot as well as updating these using fwupd.
626
627config VPL_BOOTMETH_VBE
628 bool "Bootdev support for Verified Boot for Embedded (VPL)"
629 depends on VPL && FIT
Tom Rini7d3684a2023-01-16 15:46:49 -0500630 select EVENT
Simon Glassbc993e52022-10-20 18:23:13 -0600631 default y
632 help
633 Enables support for VBE boot. This is a standard boot method which
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200634 supports selection of various firmware components, selection of an OS to
Simon Glassbc993e52022-10-20 18:23:13 -0600635 boot as well as updating these using fwupd.
636
Simon Glassd0af04c2022-07-30 15:52:33 -0600637if BOOTMETH_VBE
638
Simon Glass513eeed2023-02-22 09:33:52 -0700639config BOOTMETH_VBE_REQUEST
640 bool "Support for serving VBE OS requests"
641 default y
642 help
643 Enables support for looking that the requests made by the
644 Operating System being booted. These requests result in additions to
645 the device tree /chosen node, added during the device tree fixup
646 phase.
647
648config SPL_BOOTMETH_VBE_REQUEST
649 bool "Support for serving VBE OS requests (SPL)"
650 depends on SPL
651 help
652 Enables support for looking that the requests made by the
653 Operating System being booted. These requests result in additions to
654 the device tree /chosen node, added during the device tree fixup
655 phase.
656
657 This is only useful if you are booting an OS direct from SPL.
658
Simon Glassd0af04c2022-07-30 15:52:33 -0600659config BOOTMETH_VBE_SIMPLE
660 bool "Bootdev support for VBE 'simple' method"
661 default y
662 help
663 Enables support for VBE 'simple' boot. This allows updating a single
664 firmware image in boot media such as MMC. It does not support any sort
665 of rollback, recovery or A/B boot.
666
Simon Glassbc993e52022-10-20 18:23:13 -0600667config BOOTMETH_VBE_SIMPLE_OS
668 bool "Bootdev support for VBE 'simple' method OS phase"
669 default y
670 help
671 Enables support for the OS parts of VBE 'simple' boot. This includes
672 fixing up the device tree with the required VBE information, ready
673 for booting into the OS. This option is only enabled for U-Boot
674 proper, since it is the phase where device tree fixups happen.
675
676config SPL_BOOTMETH_VBE_SIMPLE
677 bool "Bootdev support for VBE 'simple' method (SPL)"
678 depends on SPL
679 default y if VPL
680 help
681 Enables support for VBE 'simple' boot. This allows updating a single
682 firmware image in boot media such as MMC. It does not support any sort
683 of rollback, recovery or A/B boot.
684
685config VPL_BOOTMETH_VBE_SIMPLE
686 bool "Bootdev support for VBE 'simple' method (VPL)"
687 depends on VPL
688 default y
689 help
690 Enables support for VBE 'simple' boot. This allows updating a single
691 firmware image in boot media such as MMC. It does not support any sort
692 of rollback, recovery or A/B boot.
693
694config SPL_BOOTMETH_VBE_SIMPLE_FW
695 bool "Bootdev support for VBE 'simple' method firmware phase (SPL)"
696 depends on VPL
697 default y
698 help
699 Enables support for the firmware parts of VBE 'simple' boot. This
700 includes an SPL loader which locates the correct U-Boot to boot into.
701 This option should really only be enabled for VPL, since it is the
702 phase where the SPL + U-Boot decision should be made. But for now,
703 SPL does its own FIT-configuration selection.
704
705config VPL_BOOTMETH_VBE_SIMPLE_FW
706 bool "Bootdev support for VBE 'simple' method firmware phase (VPL)"
707 depends on VPL
708 default y
709 help
710 Enables support for the firmware parts of VBE 'simple' boot. This
711 includes an SPL loader which locates the correct SPL to boot into.
712 This option enabled for VPL, since it is the phase where the SPL
713 decision is made.
714
Simon Glassd0af04c2022-07-30 15:52:33 -0600715endif # BOOTMETH_VBE
716
Simon Glassd8adbe92023-01-06 08:52:36 -0600717config EXPO
718 bool "Support for expos - groups of scenes displaying a UI"
Simon Glass389a4582023-01-28 15:00:18 -0700719 depends on VIDEO
Simon Glassd8adbe92023-01-06 08:52:36 -0600720 default y if BOOTMETH_VBE
721 help
722 An expo is a way of presenting and collecting information from the
723 user. It consists of a collection of 'scenes' of which only one is
724 presented at a time. An expo is typically used to show a boot menu
725 and allow settings to be changed.
726
727 The expo can be presented in graphics form using a vidconsole, or in
728 text form on a serial console.
729
Simon Glass423994e2022-04-24 23:31:20 -0600730config BOOTMETH_SANDBOX
731 def_bool y
732 depends on SANDBOX
733 help
734 This is a sandbox bootmeth driver used for testing. It always returns
735 -ENOTSUPP when attempting to boot.
736
Simon Glass7e03e742022-04-24 23:31:22 -0600737config BOOTMETH_SCRIPT
738 bool "Bootdev support for U-Boot scripts"
739 default y if BOOTSTD_FULL
Tom Rini9bf470a2023-10-26 14:31:27 -0400740 depends on CMDLINE
Simon Glassb4b7ebe2023-05-05 20:03:05 -0600741 select HUSH_PARSER
Simon Glass7e03e742022-04-24 23:31:22 -0600742 help
743 Enables support for booting a distro via a U-Boot script. This makes
744 the bootdevs look for a 'boot/boot.scr' file which can be used to
745 boot the distro.
746
747 This provides a way to try out standard boot on an existing boot flow.
748 It is not enabled by default to save space.
749
Simon Glass77459f42024-08-07 16:47:27 -0600750config UPL
751 bool "upl - Universal Payload Specification"
Simon Glass3a028c22024-08-07 16:47:30 -0600752 imply CMD_UPL
Simon Glass77459f42024-08-07 16:47:27 -0600753 imply UPL_READ
Simon Glassb9474a82024-08-07 16:47:28 -0600754 imply UPL_WRITE
Simon Glassbc3ec002024-08-07 16:47:31 -0600755 imply SPL_UPL if SPL
Simon Glass77459f42024-08-07 16:47:27 -0600756 help
757 Provides support for UPL payloads and handoff information. U-Boot
758 supports generating and accepting handoff information. The mkimage
759 tool will eventually support creating payloads.
760
761if UPL
762
763config UPL_READ
764 bool "upl - Support reading a Universal Payload handoff"
765 help
766 Provides support for decoding a UPL-format payload into a C structure
767 which can be used elsewhere in U-Boot. This is just the reading
Simon Glass45aec8e2024-08-07 16:47:34 -0600768 implementation, useful for trying it out. See UPL_IN for how
769 to tell U-Boot to actually read it on startup and use it for memory
770 and device information, etc.
Simon Glass77459f42024-08-07 16:47:27 -0600771
Simon Glassb9474a82024-08-07 16:47:28 -0600772config UPL_WRITE
773 bool "upl - Support writing a Universal Payload handoff"
774 help
775 Provides support for encoding a UPL-format payload from a C structure
776 so it can be passed to another program. This is just the writing
Simon Glassbc3ec002024-08-07 16:47:31 -0600777 implementation, useful for trying it out. See SPL_UPL_OUT
778 for how to tell U-Boot SPL to actually write it before jumping to
779 the next phase.
780
Simon Glass45aec8e2024-08-07 16:47:34 -0600781config UPL_IN
782 bool "upl - Read the UPL handoff on startup"
783 select UPL_READ
784 help
785 Read an SPL handoff when U-Boot starts and use it to provide
786 devices, memory layout, etc. required by U-Boot. This allows U-Boot
787 to function as a payload in the meaning of the specification.
788
Simon Glassbc3ec002024-08-07 16:47:31 -0600789if SPL
790
791config SPL_UPL
792 bool "Write a UPL handoff in SPL"
793 imply SPL_UPL_OUT
794 help
795 This tells SPL to write a UPL handoff and pass it to the next phase
796 (e.g. to U-Boot or another program which SPL loads and runs). THis
797 provides information to help that program run correctly and
798 efficiently on the machine.
799
800config SPL_UPL_WRITE
801 bool # upl - Support writing a Universal Payload handoff in SPL
802 select SPL_BLOBLIST
803 help
804 Provides support for encoding a UPL-format payload from a C structure
805 so it can be passed to another program. This is just the writing
Simon Glassb9474a82024-08-07 16:47:28 -0600806 implementation, useful for trying it out.
807
Simon Glassbc3ec002024-08-07 16:47:31 -0600808config SPL_UPL_OUT
809 bool "upl - Support writing a Universal Payload handoff in SPL"
810 select SPL_UPL_WRITE
811 help
812 Provides support for encoding a UPL-format payload and passing it to
813 the next firmware phase. This allows U-Boot SPL to function as
814 Platform Init in the meaning of the specification.
815
816endif # SPL
817
Simon Glass77459f42024-08-07 16:47:27 -0600818endif # UPL
819
Simon Glass6cfb0022023-09-14 10:55:53 -0600820endif # BOOTSTD
Simon Glassad8ec372022-04-24 23:31:13 -0600821
Simon Glassb45b1632020-09-10 20:21:13 -0600822config LEGACY_IMAGE_FORMAT
823 bool "Enable support for the legacy image format"
Andrew Davis98a22d02022-05-04 15:52:27 -0500824 default y if !FIT_SIGNATURE && !TI_SECURE_DEVICE
Simon Glassb45b1632020-09-10 20:21:13 -0600825 help
826 This option enables the legacy image format. It is enabled by
827 default for backward compatibility, unless FIT_SIGNATURE is
828 set where it is disabled so that unsigned images cannot be
829 loaded. If a board needs the legacy image format support in this
830 case, enable it here.
831
Eddie James32401ba2023-10-24 10:43:50 -0500832config MEASURED_BOOT
833 bool "Measure boot images and configuration when booting without EFI"
834 depends on HASH && TPM_V2
Ilias Apalodimas1e665f92024-06-23 14:48:18 +0300835 select SHA1
836 select SHA256
837 select SHA384
838 select SHA512
Eddie James32401ba2023-10-24 10:43:50 -0500839 help
840 This option enables measurement of the boot process when booting
841 without UEFI . Measurement involves creating cryptographic hashes
842 of the binary images that are booting and storing them in the TPM.
843 In addition, a log of these hashes is stored in memory for the OS
844 to verify the booted images and configuration. Enable this if the
845 OS has configured some memory area for the event log and you intend
846 to use some attestation tools on your system.
847
848if MEASURED_BOOT
849 config MEASURE_DEVICETREE
850 bool "Measure the devicetree image"
851 default y if MEASURED_BOOT
852 help
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200853 On some platforms, the Device Tree is not static as it may contain
Eddie James32401ba2023-10-24 10:43:50 -0500854 random MAC addresses or other such data that changes each boot.
855 Therefore, it should not be measured into the TPM. In that case,
856 disable the measurement here.
857
858 config MEASURE_IGNORE_LOG
859 bool "Ignore the existing event log"
Eddie James32401ba2023-10-24 10:43:50 -0500860 help
861 On platforms that use an event log memory region that persists
862 through system resets and are the first stage bootloader, then
863 this option should be enabled to ignore any existing data in the
864 event log memory region.
865endif # MEASURED_BOOT
866
Tom Riniec8d1602023-10-26 14:31:25 -0400867config SYS_BOOTM_LEN
868 hex "Maximum size of a decompresed OS image"
Tom Rini793921e2024-04-18 08:29:35 -0600869 depends on CMD_BOOTM || CMD_BOOTI || CMD_BOOTZ || \
Tom Riniec8d1602023-10-26 14:31:25 -0400870 LEGACY_IMAGE_FORMAT || SPL_LEGACY_IMAGE_FORMAT
871 default 0x4000000 if PPC || ARM64
872 default 0x1000000 if X86 || ARCH_MX6 || ARCH_MX7
873 default 0x800000
874 help
875 This is the maximum size of the buffer that is used to decompress the OS
876 image in to if attempting to boot a compressed image.
877
Simon Glassf11d6132020-09-10 20:21:19 -0600878config SUPPORT_RAW_INITRD
879 bool "Enable raw initrd images"
880 help
881 Note, defining the SUPPORT_RAW_INITRD allows user to supply
882 kernel with raw initrd images. The syntax is slightly different, the
883 address of the initrd must be augmented by it's size, in the following
884 format: "<initrd address>:<initrd size>".
885
Simon Glassd81f07f2020-11-04 09:57:35 -0700886config CHROMEOS
887 bool "Support booting Chrome OS"
888 help
889 Chrome OS requires U-Boot to set up a table indicating the boot mode
890 (e.g. Developer mode) and a few other things. Enable this if you are
891 booting on a Chromebook to avoid getting an error about an invalid
892 firmware ID.
893
894config CHROMEOS_VBOOT
895 bool "Support Chrome OS verified boot"
896 help
897 This is intended to enable the full Chrome OS verified boot support
898 in U-Boot. It is not actually implemented in the U-Boot source code
899 at present, so this option is always set to 'n'. It allows
900 distinguishing between booting Chrome OS in a basic way (developer
901 mode) and a full boot.
902
Tom Rinieb4f2de2022-06-25 11:02:44 -0400903config SYS_RAMBOOT
904 bool
905
Tom Rini9ff815a2021-08-24 23:11:49 -0400906config RAMBOOT_PBL
907 bool "Freescale PBL(pre-boot loader) image format support"
Tom Rinieb4f2de2022-06-25 11:02:44 -0400908 select SYS_RAMBOOT if PPC
Tom Rini9ff815a2021-08-24 23:11:49 -0400909 help
910 Some SoCs use PBL to load RCW and/or pre-initialization instructions.
911 For more details refer to doc/README.pblimage
912
Tom Rini886e6e32022-03-23 17:20:03 -0400913choice
Tom Rini489f4022022-12-28 10:52:51 -0500914 prompt "Freescale PBL (or predecessor) load location"
Tom Rini886e6e32022-03-23 17:20:03 -0400915 depends on RAMBOOT_PBL || ((TARGET_P1010RDB_PA || TARGET_P1010RDB_PB \
916 || TARGET_P1020RDB_PC || TARGET_P1020RDB_PD || TARGET_P2020RDB) \
Pali Rohár6763ff82024-06-06 18:33:26 +0200917 && !CMD_NAND) || (TARGET_TURRIS_1X && SYS_MPC85XX_NO_RESETVEC)
Tom Rini886e6e32022-03-23 17:20:03 -0400918
919config SDCARD
Tom Rini489f4022022-12-28 10:52:51 -0500920 bool "Freescale PBL (or similar) is found on SD card"
Tom Rini886e6e32022-03-23 17:20:03 -0400921
922config SPIFLASH
Tom Rini489f4022022-12-28 10:52:51 -0500923 bool "Freescale PBL (or similar) is found on SPI flash"
924
925config NO_PBL
926 bool "Freescale PBL (or similar) is not used in this case"
Tom Rini886e6e32022-03-23 17:20:03 -0400927
928endchoice
929
Tom Rini5989fd42022-06-20 08:07:42 -0400930config FSL_FIXED_MMC_LOCATION
931 bool "PBL MMC is at a fixed location"
932 depends on SDCARD && !RAMBOOT_PBL
933
934config ESDHC_HC_BLK_ADDR
935 def_bool y
936 depends on FSL_FIXED_MMC_LOCATION && (ARCH_BSC9131 || ARCH_BSC9132 || ARCH_P1010)
937 help
938 In High Capacity SD Cards (> 2 GBytes), the 32-bit source address and
939 code length of these soc specify the memory address in block address
940 format. Block length is fixed to 512 bytes as per the SD High
941 Capacity specification.
942
Tom Rini9ff815a2021-08-24 23:11:49 -0400943config SYS_FSL_PBL_PBI
944 string "PBI(pre-boot instructions) commands for the PBL image"
945 depends on RAMBOOT_PBL
946 help
947 PBI commands can be used to configure SoC before it starts the execution.
948 Please refer doc/README.pblimage for more details.
949
950config SYS_FSL_PBL_RCW
951 string "Aadditional RCW (Power on reset configuration) for the PBL image"
952 depends on RAMBOOT_PBL
953 help
954 Enables addition of RCW (Power on reset configuration) in built image.
955 Please refer doc/README.pblimage for more details.
956
Tom Rini94b4fec2022-06-25 11:02:46 -0400957config SYS_BOOT_RAMDISK_HIGH
958 depends on CMD_BOOTM || CMD_BOOTI || CMD_BOOTZ
959 depends on !(NIOS2 || SANDBOX || SH || XTENSA)
960 def_bool y
Simon Glass65edcd32023-03-24 16:58:12 -0400961 select LMB
Tom Rini94b4fec2022-06-25 11:02:46 -0400962 help
963 Enable initrd_high functionality. If defined then the initrd_high
964 feature is enabled and the boot* ramdisk subcommand is enabled.
965
Simon Glassb45b1632020-09-10 20:21:13 -0600966endmenu # Boot images
967
Simon Glassf111bf72023-03-24 16:58:11 -0400968config DISTRO_DEFAULTS
Simon Glasse27d7df2023-09-14 10:55:55 -0600969 bool "(deprecated) Script-based booting of Linux distributions"
Tom Rini045245b2023-10-26 14:31:23 -0400970 select CMDLINE
Simon Glass054d0182023-03-24 16:58:13 -0400971 select BOOT_DEFAULTS
Simon Glassf111bf72023-03-24 16:58:11 -0400972 select AUTO_COMPLETE
973 select CMDLINE_EDITING
Simon Glassf111bf72023-03-24 16:58:11 -0400974 select CMD_SYSBOOT
Simon Glassf111bf72023-03-24 16:58:11 -0400975 select HUSH_PARSER
Simon Glassf111bf72023-03-24 16:58:11 -0400976 select SYS_LONGHELP
Simon Glassf111bf72023-03-24 16:58:11 -0400977 help
Simon Glasse27d7df2023-09-14 10:55:55 -0600978 Note: These scripts have been replaced by Standard Boot. Do not use
979 them on new boards. See 'Migrating from distro_boot' at
980 doc/develop/bootstd.rst
981
Simon Glassf111bf72023-03-24 16:58:11 -0400982 Select this to enable various options and commands which are suitable
983 for building u-boot for booting general purpose Linux distributions.
984
Simon Glassd02ddcf2020-09-10 20:21:14 -0600985menu "Boot timing"
986
987config BOOTSTAGE
988 bool "Boot timing and reporting"
989 help
990 Enable recording of boot time while booting. To use it, insert
991 calls to bootstage_mark() with a suitable BOOTSTAGE_ID from
992 bootstage.h. Only a single entry is recorded for each ID. You can
993 give the entry a name with bootstage_mark_name(). You can also
994 record elapsed time in a particular stage using bootstage_start()
995 before starting and bootstage_accum() when finished. Bootstage will
996 add up all the accumulated time and report it.
997
998 Normally, IDs are defined in bootstage.h but a small number of
999 additional 'user' IDs can be used by passing BOOTSTAGE_ID_ALLOC
1000 as the ID.
1001
1002 Calls to show_boot_progress() will also result in log entries but
1003 these will not have names.
1004
1005config SPL_BOOTSTAGE
1006 bool "Boot timing and reported in SPL"
Tom Rini0a83cc22022-06-10 23:03:09 -04001007 depends on BOOTSTAGE && SPL
Simon Glassd02ddcf2020-09-10 20:21:14 -06001008 help
1009 Enable recording of boot time in SPL. To make this visible to U-Boot
1010 proper, enable BOOTSTAGE_STASH as well. This will stash the timing
1011 information when SPL finishes and load it when U-Boot proper starts
1012 up.
1013
1014config TPL_BOOTSTAGE
1015 bool "Boot timing and reported in TPL"
Tom Rini36a4ca02022-06-08 08:24:39 -04001016 depends on BOOTSTAGE && TPL
Simon Glassd02ddcf2020-09-10 20:21:14 -06001017 help
1018 Enable recording of boot time in SPL. To make this visible to U-Boot
1019 proper, enable BOOTSTAGE_STASH as well. This will stash the timing
1020 information when TPL finishes and load it when U-Boot proper starts
1021 up.
1022
1023config BOOTSTAGE_REPORT
1024 bool "Display a detailed boot timing report before booting the OS"
1025 depends on BOOTSTAGE
1026 help
1027 Enable output of a boot time report just before the OS is booted.
1028 This shows how long it took U-Boot to go through each stage of the
1029 boot process. The report looks something like this:
1030
1031 Timer summary in microseconds:
1032 Mark Elapsed Stage
1033 0 0 reset
1034 3,575,678 3,575,678 board_init_f start
1035 3,575,695 17 arch_cpu_init A9
1036 3,575,777 82 arch_cpu_init done
1037 3,659,598 83,821 board_init_r start
1038 3,910,375 250,777 main_loop
1039 29,916,167 26,005,792 bootm_start
1040 30,361,327 445,160 start_kernel
1041
1042config BOOTSTAGE_RECORD_COUNT
1043 int "Number of boot stage records to store"
Simon Glass051ddfb2021-02-03 06:00:49 -07001044 depends on BOOTSTAGE
Simon Glassd02ddcf2020-09-10 20:21:14 -06001045 default 30
1046 help
1047 This is the size of the bootstage record list and is the maximum
1048 number of bootstage records that can be recorded.
1049
1050config SPL_BOOTSTAGE_RECORD_COUNT
1051 int "Number of boot stage records to store for SPL"
Simon Glass051ddfb2021-02-03 06:00:49 -07001052 depends on SPL_BOOTSTAGE
Simon Glassd02ddcf2020-09-10 20:21:14 -06001053 default 5
1054 help
1055 This is the size of the bootstage record list and is the maximum
1056 number of bootstage records that can be recorded.
1057
1058config TPL_BOOTSTAGE_RECORD_COUNT
1059 int "Number of boot stage records to store for TPL"
Simon Glass051ddfb2021-02-03 06:00:49 -07001060 depends on TPL_BOOTSTAGE
Simon Glassd02ddcf2020-09-10 20:21:14 -06001061 default 5
1062 help
1063 This is the size of the bootstage record list and is the maximum
1064 number of bootstage records that can be recorded.
1065
1066config BOOTSTAGE_FDT
1067 bool "Store boot timing information in the OS device tree"
1068 depends on BOOTSTAGE
1069 help
1070 Stash the bootstage information in the FDT. A root 'bootstage'
1071 node is created with each bootstage id as a child. Each child
1072 has a 'name' property and either 'mark' containing the
1073 mark time in microseconds, or 'accum' containing the
1074 accumulated time for that bootstage id in microseconds.
1075 For example:
1076
1077 bootstage {
1078 154 {
1079 name = "board_init_f";
1080 mark = <3575678>;
1081 };
1082 170 {
1083 name = "lcd";
1084 accum = <33482>;
1085 };
1086 };
1087
1088 Code in the Linux kernel can find this in /proc/devicetree.
1089
1090config BOOTSTAGE_STASH
1091 bool "Stash the boot timing information in memory before booting OS"
1092 depends on BOOTSTAGE
1093 help
1094 Some OSes do not support device tree. Bootstage can instead write
1095 the boot timing information in a binary format at a given address.
1096 This happens through a call to bootstage_stash(), typically in
1097 the CPU's cleanup_before_linux() function. You can use the
1098 'bootstage stash' and 'bootstage unstash' commands to do this on
1099 the command line.
1100
1101config BOOTSTAGE_STASH_ADDR
1102 hex "Address to stash boot timing information"
Tom Rinid78c9bd2024-07-15 12:42:00 +01001103 depends on BOOTSTAGE_STASH
1104 default 0xC3000000 if STM32MP13X || STM32MP15X
1105 default 0x87000000 if STM32MP25X
1106 default 0x0 if SANDBOX
Simon Glassd02ddcf2020-09-10 20:21:14 -06001107 help
1108 Provide an address which will not be overwritten by the OS when it
1109 starts, so that it can read this information when ready.
1110
1111config BOOTSTAGE_STASH_SIZE
1112 hex "Size of boot timing stash region"
Tom Rinid78c9bd2024-07-15 12:42:00 +01001113 depends on BOOTSTAGE_STASH
Simon Glassd02ddcf2020-09-10 20:21:14 -06001114 default 0x1000
1115 help
1116 This should be large enough to hold the bootstage stash. A value of
1117 4096 (4KiB) is normally plenty.
1118
1119config SHOW_BOOT_PROGRESS
1120 bool "Show boot progress in a board-specific manner"
1121 help
1122 Defining this option allows to add some board-specific code (calling
1123 a user-provided function show_boot_progress(int) that enables you to
1124 show the system's boot progress on some display (for example, some
1125 LEDs) on your board. At the moment, the following checkpoints are
1126 implemented:
1127
1128 Legacy uImage format:
1129
1130 Arg Where When
1131 1 common/cmd_bootm.c before attempting to boot an image
1132 -1 common/cmd_bootm.c Image header has bad magic number
1133 2 common/cmd_bootm.c Image header has correct magic number
1134 -2 common/cmd_bootm.c Image header has bad checksum
1135 3 common/cmd_bootm.c Image header has correct checksum
1136 -3 common/cmd_bootm.c Image data has bad checksum
1137 4 common/cmd_bootm.c Image data has correct checksum
1138 -4 common/cmd_bootm.c Image is for unsupported architecture
1139 5 common/cmd_bootm.c Architecture check OK
1140 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
1141 6 common/cmd_bootm.c Image Type check OK
1142 -6 common/cmd_bootm.c gunzip uncompression error
1143 -7 common/cmd_bootm.c Unimplemented compression type
1144 7 common/cmd_bootm.c Uncompression OK
1145 8 common/cmd_bootm.c No uncompress/copy overwrite error
1146 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
1147
1148 9 common/image.c Start initial ramdisk verification
1149 -10 common/image.c Ramdisk header has bad magic number
1150 -11 common/image.c Ramdisk header has bad checksum
1151 10 common/image.c Ramdisk header is OK
1152 -12 common/image.c Ramdisk data has bad checksum
1153 11 common/image.c Ramdisk data has correct checksum
1154 12 common/image.c Ramdisk verification complete, start loading
1155 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
1156 13 common/image.c Start multifile image verification
1157 14 common/image.c No initial ramdisk, no multifile, continue.
1158
1159 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
1160
1161 -30 arch/powerpc/lib/board.c Fatal error, hang the system
1162 -31 post/post.c POST test failed, detected by post_output_backlog()
1163 -32 post/post.c POST test failed, detected by post_run_single()
1164
1165 34 common/cmd_doc.c before loading a Image from a DOC device
1166 -35 common/cmd_doc.c Bad usage of "doc" command
1167 35 common/cmd_doc.c correct usage of "doc" command
1168 -36 common/cmd_doc.c No boot device
1169 36 common/cmd_doc.c correct boot device
1170 -37 common/cmd_doc.c Unknown Chip ID on boot device
1171 37 common/cmd_doc.c correct chip ID found, device available
1172 -38 common/cmd_doc.c Read Error on boot device
1173 38 common/cmd_doc.c reading Image header from DOC device OK
1174 -39 common/cmd_doc.c Image header has bad magic number
1175 39 common/cmd_doc.c Image header has correct magic number
1176 -40 common/cmd_doc.c Error reading Image from DOC device
1177 40 common/cmd_doc.c Image header has correct magic number
1178 41 common/cmd_ide.c before loading a Image from a IDE device
1179 -42 common/cmd_ide.c Bad usage of "ide" command
1180 42 common/cmd_ide.c correct usage of "ide" command
1181 -43 common/cmd_ide.c No boot device
1182 43 common/cmd_ide.c boot device found
1183 -44 common/cmd_ide.c Device not available
1184 44 common/cmd_ide.c Device available
1185 -45 common/cmd_ide.c wrong partition selected
1186 45 common/cmd_ide.c partition selected
1187 -46 common/cmd_ide.c Unknown partition table
1188 46 common/cmd_ide.c valid partition table found
1189 -47 common/cmd_ide.c Invalid partition type
1190 47 common/cmd_ide.c correct partition type
1191 -48 common/cmd_ide.c Error reading Image Header on boot device
1192 48 common/cmd_ide.c reading Image Header from IDE device OK
1193 -49 common/cmd_ide.c Image header has bad magic number
1194 49 common/cmd_ide.c Image header has correct magic number
1195 -50 common/cmd_ide.c Image header has bad checksum
1196 50 common/cmd_ide.c Image header has correct checksum
1197 -51 common/cmd_ide.c Error reading Image from IDE device
1198 51 common/cmd_ide.c reading Image from IDE device OK
1199 52 common/cmd_nand.c before loading a Image from a NAND device
1200 -53 common/cmd_nand.c Bad usage of "nand" command
1201 53 common/cmd_nand.c correct usage of "nand" command
1202 -54 common/cmd_nand.c No boot device
1203 54 common/cmd_nand.c boot device found
1204 -55 common/cmd_nand.c Unknown Chip ID on boot device
1205 55 common/cmd_nand.c correct chip ID found, device available
1206 -56 common/cmd_nand.c Error reading Image Header on boot device
1207 56 common/cmd_nand.c reading Image Header from NAND device OK
1208 -57 common/cmd_nand.c Image header has bad magic number
1209 57 common/cmd_nand.c Image header has correct magic number
1210 -58 common/cmd_nand.c Error reading Image from NAND device
1211 58 common/cmd_nand.c reading Image from NAND device OK
1212
1213 -60 common/env_common.c Environment has a bad CRC, using default
1214
1215 64 net/eth.c starting with Ethernet configuration.
1216 -64 net/eth.c no Ethernet found.
1217 65 net/eth.c Ethernet found.
1218
1219 -80 common/cmd_net.c usage wrong
1220 80 common/cmd_net.c before calling net_loop()
1221 -81 common/cmd_net.c some error in net_loop() occurred
1222 81 common/cmd_net.c net_loop() back without error
1223 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
1224 82 common/cmd_net.c trying automatic boot
1225 83 common/cmd_net.c running "source" command
1226 -83 common/cmd_net.c some error in automatic boot or "source" command
1227 84 common/cmd_net.c end without errors
1228
1229 FIT uImage format:
1230
1231 Arg Where When
1232 100 common/cmd_bootm.c Kernel FIT Image has correct format
1233 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
1234 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
1235 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
1236 102 common/cmd_bootm.c Kernel unit name specified
1237 -103 common/cmd_bootm.c Can't get kernel subimage node offset
1238 103 common/cmd_bootm.c Found configuration node
1239 104 common/cmd_bootm.c Got kernel subimage node offset
1240 -104 common/cmd_bootm.c Kernel subimage hash verification failed
1241 105 common/cmd_bootm.c Kernel subimage hash verification OK
1242 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
1243 106 common/cmd_bootm.c Architecture check OK
1244 -106 common/cmd_bootm.c Kernel subimage has wrong type
1245 107 common/cmd_bootm.c Kernel subimage type OK
1246 -107 common/cmd_bootm.c Can't get kernel subimage data/size
1247 108 common/cmd_bootm.c Got kernel subimage data/size
1248 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
1249 -109 common/cmd_bootm.c Can't get kernel subimage type
1250 -110 common/cmd_bootm.c Can't get kernel subimage comp
1251 -111 common/cmd_bootm.c Can't get kernel subimage os
1252 -112 common/cmd_bootm.c Can't get kernel subimage load address
1253 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
1254
1255 120 common/image.c Start initial ramdisk verification
1256 -120 common/image.c Ramdisk FIT image has incorrect format
1257 121 common/image.c Ramdisk FIT image has correct format
1258 122 common/image.c No ramdisk subimage unit name, using configuration
1259 -122 common/image.c Can't get configuration for ramdisk subimage
1260 123 common/image.c Ramdisk unit name specified
1261 -124 common/image.c Can't get ramdisk subimage node offset
1262 125 common/image.c Got ramdisk subimage node offset
1263 -125 common/image.c Ramdisk subimage hash verification failed
1264 126 common/image.c Ramdisk subimage hash verification OK
1265 -126 common/image.c Ramdisk subimage for unsupported architecture
1266 127 common/image.c Architecture check OK
1267 -127 common/image.c Can't get ramdisk subimage data/size
1268 128 common/image.c Got ramdisk subimage data/size
1269 129 common/image.c Can't get ramdisk load address
1270 -129 common/image.c Got ramdisk load address
1271
1272 -130 common/cmd_doc.c Incorrect FIT image format
1273 131 common/cmd_doc.c FIT image format OK
1274
1275 -140 common/cmd_ide.c Incorrect FIT image format
1276 141 common/cmd_ide.c FIT image format OK
1277
1278 -150 common/cmd_nand.c Incorrect FIT image format
1279 151 common/cmd_nand.c FIT image format OK
1280
Marek Vasut98154342021-10-23 03:06:03 +02001281config SPL_SHOW_BOOT_PROGRESS
Jan Kiszka5780edb2021-11-03 15:09:36 +01001282 bool "Show boot progress in a board-specific manner in SPL"
Marek Vasut98154342021-10-23 03:06:03 +02001283 depends on SPL
1284 help
1285 Defining this option allows to add some board-specific code (calling
1286 a user-provided function show_boot_progress(int) that enables you to
1287 show the system's boot progress on some display (for example, some
1288 LEDs) on your board. For details see SHOW_BOOT_PROGRESS.
1289
Simon Glassd02ddcf2020-09-10 20:21:14 -06001290endmenu
1291
Simon Glasseebed782020-09-10 20:21:15 -06001292menu "Boot media"
1293
1294config NOR_BOOT
1295 bool "Support for booting from NOR flash"
1296 depends on NOR
1297 help
1298 Enabling this will make a U-Boot binary that is capable of being
1299 booted via NOR. In this case we will enable certain pinmux early
1300 as the ROM only partially sets up pinmux. We also default to using
1301 NOR for environment.
1302
1303config NAND_BOOT
1304 bool "Support for booting from NAND flash"
Simon Glasseebed782020-09-10 20:21:15 -06001305 imply MTD_RAW_NAND
1306 help
1307 Enabling this will make a U-Boot binary that is capable of being
1308 booted via NAND flash. This is not a must, some SoCs need this,
1309 some not.
1310
1311config ONENAND_BOOT
1312 bool "Support for booting from ONENAND"
Simon Glasseebed782020-09-10 20:21:15 -06001313 imply MTD_RAW_NAND
1314 help
1315 Enabling this will make a U-Boot binary that is capable of being
1316 booted via ONENAND. This is not a must, some SoCs need this,
1317 some not.
1318
1319config QSPI_BOOT
1320 bool "Support for booting from QSPI flash"
Simon Glasseebed782020-09-10 20:21:15 -06001321 help
1322 Enabling this will make a U-Boot binary that is capable of being
1323 booted via QSPI flash. This is not a must, some SoCs need this,
1324 some not.
1325
1326config SATA_BOOT
1327 bool "Support for booting from SATA"
Simon Glasseebed782020-09-10 20:21:15 -06001328 help
1329 Enabling this will make a U-Boot binary that is capable of being
1330 booted via SATA. This is not a must, some SoCs need this,
1331 some not.
1332
1333config SD_BOOT
1334 bool "Support for booting from SD/EMMC"
Simon Glasseebed782020-09-10 20:21:15 -06001335 help
1336 Enabling this will make a U-Boot binary that is capable of being
1337 booted via SD/EMMC. This is not a must, some SoCs need this,
1338 some not.
1339
Tom Rinia43bf4e2021-12-11 14:55:50 -05001340config SD_BOOT_QSPI
1341 bool "Support for booting from SD/EMMC and enable QSPI"
1342 help
1343 Enabling this will make a U-Boot binary that is capable of being
1344 booted via SD/EMMC while enabling QSPI on the platform as well. This
1345 is not a must, some SoCs need this, some not.
1346
Simon Glasseebed782020-09-10 20:21:15 -06001347config SPI_BOOT
1348 bool "Support for booting from SPI flash"
Simon Glasseebed782020-09-10 20:21:15 -06001349 help
1350 Enabling this will make a U-Boot binary that is capable of being
1351 booted via SPI flash. This is not a must, some SoCs need this,
1352 some not.
1353
1354endmenu
1355
Simon Glasse9d54d72020-09-10 20:21:16 -06001356menu "Autoboot options"
1357
1358config AUTOBOOT
1359 bool "Autoboot"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001360 depends on CMDLINE
Simon Glasse9d54d72020-09-10 20:21:16 -06001361 default y
1362 help
1363 This enables the autoboot. See doc/README.autoboot for detail.
1364
Simon Glass7dee9dc2023-10-26 14:31:22 -04001365if AUTOBOOT
1366
Simon Glass1b6cbaa2020-09-10 20:21:17 -06001367config BOOTDELAY
1368 int "delay in seconds before automatically booting"
1369 default 2
Simon Glass1b6cbaa2020-09-10 20:21:17 -06001370 help
1371 Delay before automatically running bootcmd;
1372 set to 0 to autoboot with no delay, but you can stop it by key input.
1373 set to -1 to disable autoboot.
1374 set to -2 to autoboot with no delay and not check for abort
1375
1376 If this value is >= 0 then it is also used for the default delay
1377 before starting the default entry in bootmenu. If it is < 0 then
1378 a default value of 10s is used.
1379
1380 See doc/README.autoboot for details.
1381
Simon Glasse9d54d72020-09-10 20:21:16 -06001382config AUTOBOOT_KEYED
1383 bool "Stop autobooting via specific input key / string"
Simon Glasse9d54d72020-09-10 20:21:16 -06001384 help
1385 This option enables stopping (aborting) of the automatic
1386 boot feature only by issuing a specific input key or
1387 string. If not enabled, any input key will abort the
1388 U-Boot automatic booting process and bring the device
1389 to the U-Boot prompt for user input.
1390
Simon Glass7dee9dc2023-10-26 14:31:22 -04001391if AUTOBOOT_KEYED
1392
Steffen Jaeckeldfc97322021-07-08 15:57:38 +02001393config AUTOBOOT_FLUSH_STDIN
1394 bool "Enable flushing stdin before starting to read the password"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001395 depends on !SANDBOX
Steffen Jaeckeldfc97322021-07-08 15:57:38 +02001396 help
1397 When this option is enabled stdin buffer will be flushed before
1398 starting to read the password.
1399 This can't be enabled for the sandbox as flushing stdin would
1400 break the autoboot unit tests.
1401
Simon Glasse9d54d72020-09-10 20:21:16 -06001402config AUTOBOOT_PROMPT
1403 string "Autoboot stop prompt"
Simon Glasse9d54d72020-09-10 20:21:16 -06001404 default "Autoboot in %d seconds\\n"
1405 help
1406 This string is displayed before the boot delay selected by
1407 CONFIG_BOOTDELAY starts. If it is not defined there is no
1408 output indicating that autoboot is in progress.
1409
1410 Note that this define is used as the (only) argument to a
1411 printf() call, so it may contain '%' format specifications,
Quentin Schulzc0a7ae02024-06-12 16:58:47 +02001412 provided that it also includes, separated by commas exactly
Simon Glasse9d54d72020-09-10 20:21:16 -06001413 like in a printf statement, the required arguments. It is
1414 the responsibility of the user to select only such arguments
1415 that are valid in the given context.
1416
1417config AUTOBOOT_ENCRYPTION
1418 bool "Enable encryption in autoboot stopping"
Simon Glasse9d54d72020-09-10 20:21:16 -06001419 help
1420 This option allows a string to be entered into U-Boot to stop the
Steffen Jaeckel6aa6bfb2021-07-08 15:57:35 +02001421 autoboot.
1422 The behavior depends whether CONFIG_CRYPT_PW from lib is enabled
1423 or not.
1424 In case CONFIG_CRYPT_PW is enabled, the string will be forwarded
1425 to the crypt-based functionality and be compared against the
1426 string in the environment variable 'bootstopkeycrypt'.
1427 In case CONFIG_CRYPT_PW is disabled the string itself is hashed
1428 and compared against the hash in the environment variable
1429 'bootstopkeysha256'.
1430 If it matches in either case then boot stops and
1431 a command-line prompt is presented.
Simon Glasse9d54d72020-09-10 20:21:16 -06001432 This provides a way to ship a secure production device which can also
1433 be accessed at the U-Boot command line.
1434
Steffen Jaeckel28be70d2021-07-08 15:57:39 +02001435config AUTOBOOT_SHA256_FALLBACK
1436 bool "Allow fallback from crypt-hashed password to sha256"
1437 depends on AUTOBOOT_ENCRYPTION && CRYPT_PW
1438 help
1439 This option adds support to fall back from crypt-hashed
1440 passwords to checking a SHA256 hashed password in case the
1441 'bootstopusesha256' environment variable is set to 'true'.
1442
Simon Glasse9d54d72020-09-10 20:21:16 -06001443config AUTOBOOT_DELAY_STR
1444 string "Delay autobooting via specific input key / string"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001445 depends on !AUTOBOOT_ENCRYPTION
Simon Glasse9d54d72020-09-10 20:21:16 -06001446 help
1447 This option delays the automatic boot feature by issuing
1448 a specific input key or string. If CONFIG_AUTOBOOT_DELAY_STR
1449 or the environment variable "bootdelaykey" is specified
1450 and this string is received from console input before
1451 autoboot starts booting, U-Boot gives a command prompt. The
1452 U-Boot prompt will time out if CONFIG_BOOT_RETRY_TIME is
1453 used, otherwise it never times out.
1454
1455config AUTOBOOT_STOP_STR
1456 string "Stop autobooting via specific input key / string"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001457 depends on !AUTOBOOT_ENCRYPTION
Simon Glasse9d54d72020-09-10 20:21:16 -06001458 help
1459 This option enables stopping (aborting) of the automatic
1460 boot feature only by issuing a specific input key or
1461 string. If CONFIG_AUTOBOOT_STOP_STR or the environment
1462 variable "bootstopkey" is specified and this string is
1463 received from console input before autoboot starts booting,
1464 U-Boot gives a command prompt. The U-Boot prompt never
1465 times out, even if CONFIG_BOOT_RETRY_TIME is used.
1466
1467config AUTOBOOT_KEYED_CTRLC
1468 bool "Enable Ctrl-C autoboot interruption"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001469 depends on !AUTOBOOT_ENCRYPTION
Simon Glasse9d54d72020-09-10 20:21:16 -06001470 help
1471 This option allows for the boot sequence to be interrupted
1472 by ctrl-c, in addition to the "bootdelaykey" and "bootstopkey".
1473 Setting this variable provides an escape sequence from the
1474 limited "password" strings.
1475
Steffen Jaeckel792a13f2021-07-08 15:57:37 +02001476config AUTOBOOT_NEVER_TIMEOUT
1477 bool "Make the password entry never time-out"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001478 depends on AUTOBOOT_ENCRYPTION && CRYPT_PW
Steffen Jaeckel792a13f2021-07-08 15:57:37 +02001479 help
1480 This option removes the timeout from the password entry
1481 when the user first presses the <Enter> key before entering
1482 any other character.
1483
Steffen Jaeckel6aa6bfb2021-07-08 15:57:35 +02001484config AUTOBOOT_STOP_STR_ENABLE
1485 bool "Enable fixed string to stop autobooting"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001486 depends on AUTOBOOT_ENCRYPTION
Steffen Jaeckel6aa6bfb2021-07-08 15:57:35 +02001487 help
1488 This option enables the feature to add a fixed stop
1489 string that is defined at compile time.
1490 In every case it will be tried to load the stop
1491 string from the environment.
1492 In case this is enabled and there is no stop string
1493 in the environment, this will be used as default value.
1494
1495config AUTOBOOT_STOP_STR_CRYPT
1496 string "Stop autobooting via crypt-hashed password"
1497 depends on AUTOBOOT_STOP_STR_ENABLE && CRYPT_PW
1498 help
1499 This option adds the feature to only stop the autobooting,
1500 and therefore boot into the U-Boot prompt, when the input
1501 string / password matches a values that is hashed via
1502 one of the supported crypt-style password hashing options
1503 and saved in the environment variable "bootstopkeycrypt".
1504
Simon Glasse9d54d72020-09-10 20:21:16 -06001505config AUTOBOOT_STOP_STR_SHA256
Steffen Jaeckele1788f92021-07-08 15:57:40 +02001506 string "Stop autobooting via SHA256 hashed password"
Steffen Jaeckel6aa6bfb2021-07-08 15:57:35 +02001507 depends on AUTOBOOT_STOP_STR_ENABLE
Simon Glasse9d54d72020-09-10 20:21:16 -06001508 help
1509 This option adds the feature to only stop the autobooting,
1510 and therefore boot into the U-Boot prompt, when the input
Quentin Schulzc0a7ae02024-06-12 16:58:47 +02001511 string / password matches a values that is encrypted via
Joel Peshkin8b7bf532020-11-21 17:18:59 -08001512 a SHA256 hash and saved in the environment variable
1513 "bootstopkeysha256". If the value in that variable
1514 includes a ":", the portion prior to the ":" will be treated
1515 as a salt value.
Simon Glasse9d54d72020-09-10 20:21:16 -06001516
Simon Glass7dee9dc2023-10-26 14:31:22 -04001517endif # AUTOBOOT_KEYED
1518
1519if !AUTOBOOT_KEYED
1520
Simon Glasse9d54d72020-09-10 20:21:16 -06001521config AUTOBOOT_USE_MENUKEY
1522 bool "Allow a specify key to run a menu from the environment"
Simon Glasse9d54d72020-09-10 20:21:16 -06001523 help
1524 If a specific key is pressed to stop autoboot, then the commands in
1525 the environment variable 'menucmd' are executed before boot starts.
1526
1527config AUTOBOOT_MENUKEY
1528 int "ASCII value of boot key to show a menu"
1529 default 0
1530 depends on AUTOBOOT_USE_MENUKEY
1531 help
1532 If this key is pressed to stop autoboot, then the commands in the
1533 environment variable 'menucmd' will be executed before boot starts.
1534 For example, 33 means "!" in ASCII, so pressing ! at boot would take
1535 this action.
1536
Simon Glass7dee9dc2023-10-26 14:31:22 -04001537endif
1538
1539endif # AUTOBOOT
1540
Simon Glasse9d54d72020-09-10 20:21:16 -06001541config AUTOBOOT_MENU_SHOW
1542 bool "Show a menu on boot"
1543 depends on CMD_BOOTMENU
1544 help
1545 This enables the boot menu, controlled by environment variables
1546 defined by the board. The menu starts after running the 'preboot'
1547 environmnent variable (if enabled) and before handling the boot delay.
Peter Robinson16e0b8f2023-08-18 15:54:10 +01001548 See doc/usage/cmd/bootmenu.rst for more details.
Simon Glasse9d54d72020-09-10 20:21:16 -06001549
Masahisa Kojima97cbcc42022-05-26 19:09:38 +09001550config BOOTMENU_DISABLE_UBOOT_CONSOLE
1551 bool "Disallow bootmenu to enter the U-Boot console"
1552 depends on AUTOBOOT_MENU_SHOW
1553 help
1554 If this option is enabled, user can not enter the U-Boot console from
1555 bootmenu. It increases the system security.
1556
Tom Rinia45a3ef2022-03-11 09:12:04 -05001557config BOOT_RETRY
1558 bool "Boot retry feature"
1559 help
1560 Allow for having the U-Boot command prompt time out and attempt
1561 to boot again. If the environment variable "bootretry" is found then
1562 its value is used, otherwise the retry timeout is
1563 CONFIG_BOOT_RETRY_TIME. CONFIG_BOOT_RETRY_MIN is optional and
1564 defaults to CONFIG_BOOT_RETRY_TIME. All times are in seconds.
1565
1566config BOOT_RETRY_TIME
1567 int "Timeout in seconds before attempting to boot again"
1568 depends on BOOT_RETRY
1569 help
1570 Time in seconds before the U-Boot prompt will timeout and boot will
1571 be attempted again.
1572
1573config BOOT_RETRY_MIN
1574 int "Minimum timeout in seconds for 'bootretry'"
1575 depends on BOOT_RETRY
1576 default BOOT_RETRY_TIME
1577 help
1578 The minimum time in seconds that "bootretry" can be set to.
1579
1580config RESET_TO_RETRY
1581 bool "Reset the board to retry autoboot"
1582 depends on BOOT_RETRY
1583 help
1584 After the countdown timed out, the board will be reset to restart
1585 again.
1586
Simon Glasse9d54d72020-09-10 20:21:16 -06001587endmenu
1588
Philippe Reynesd28484e2022-03-28 22:56:59 +02001589menu "Image support"
1590
1591config IMAGE_PRE_LOAD
1592 bool "Image pre-load support"
1593 help
1594 Enable an image pre-load stage in the SPL.
1595 This pre-load stage allows to do some manipulation
1596 or check (for example signature check) on an image
1597 before launching it.
1598
1599config SPL_IMAGE_PRE_LOAD
1600 bool "Image pre-load support within SPL"
1601 depends on SPL && IMAGE_PRE_LOAD
1602 help
1603 Enable an image pre-load stage in the SPL.
1604 This pre-load stage allows to do some manipulation
1605 or check (for example signature check) on an image
1606 before launching it.
1607
1608config IMAGE_PRE_LOAD_SIG
1609 bool "Image pre-load signature support"
1610 depends on IMAGE_PRE_LOAD
1611 select FIT_SIGNATURE
1612 select RSA
1613 select RSA_VERIFY_WITH_PKEY
1614 help
1615 Enable signature check support in the pre-load stage.
1616 For this feature a very simple header is added before
1617 the image with few fields:
1618 - a magic
1619 - the image size
1620 - the signature
1621 All other information (header size, type of signature,
1622 ...) are provided in the node /image/pre-load/sig of
1623 u-boot.
1624
1625config SPL_IMAGE_PRE_LOAD_SIG
1626 bool "Image pre-load signature support witin SPL"
1627 depends on SPL_IMAGE_PRE_LOAD && IMAGE_PRE_LOAD_SIG
1628 select SPL_FIT_SIGNATURE
1629 select SPL_RSA
1630 select SPL_RSA_VERIFY_WITH_PKEY
1631 help
1632 Enable signature check support in the pre-load stage in the SPL.
1633 For this feature a very simple header is added before
1634 the image with few fields:
1635 - a magic
1636 - the image size
1637 - the signature
1638 All other information (header size, type of signature,
1639 ...) are provided in the node /image/pre-load/sig of
1640 u-boot.
1641
1642endmenu
1643
Simon Glass27367192023-09-14 10:55:46 -06001644if OF_LIBFDT
1645
1646menu "Devicetree fixup"
1647
Matthias Schiffere908fec2023-12-11 12:03:17 +01001648config OF_ENV_SETUP
1649 bool "Run a command from environment to set up device tree before boot"
1650 depends on CMD_FDT
1651 help
1652 This causes U-Boot to run a command from the environment variable
1653 fdt_fixup before booting into the operating system, which can use the
1654 fdt command to modify the device tree. The device tree is then passed
1655 to the OS.
1656
Simon Glass48e6d3d2023-09-14 10:55:47 -06001657config OF_BOARD_SETUP
1658 bool "Set up board-specific details in device tree before boot"
1659 help
1660 This causes U-Boot to call ft_board_setup() before booting into
1661 the Operating System. This function can set up various
1662 board-specific information in the device tree for use by the OS.
1663 The device tree is then passed to the OS.
1664
1665config OF_SYSTEM_SETUP
1666 bool "Set up system-specific details in device tree before boot"
1667 help
1668 This causes U-Boot to call ft_system_setup() before booting into
1669 the Operating System. This function can set up various
1670 system-specific information in the device tree for use by the OS.
1671 The device tree is then passed to the OS.
1672
1673config OF_STDOUT_VIA_ALIAS
1674 bool "Update the device-tree stdout alias from U-Boot"
1675 help
1676 This uses U-Boot's serial alias from the aliases node to update
1677 the device tree passed to the OS. The "linux,stdout-path" property
1678 in the chosen node is set to point to the correct serial node.
1679 This option currently references CONFIG_CONS_INDEX, which is
1680 incorrect when used with device tree as this option does not
1681 exist / should not be used.
1682
Simon Glassb7b7f162023-09-14 10:55:57 -06001683config FDT_FIXUP_PARTITIONS
Simon Glass1a5bcc12023-09-14 10:55:58 -06001684 bool "Overwrite MTD partitions in DTS through defined in 'mtdparts'"
Simon Glassb7b7f162023-09-14 10:55:57 -06001685 help
1686 Allow overwriting defined partitions in the device tree blob
1687 using partition info defined in the 'mtdparts' environment
1688 variable.
1689
Simon Glass27367192023-09-14 10:55:46 -06001690config FDT_SIMPLEFB
1691 bool "FDT tools for simplefb support"
1692 help
1693 Enable the fdt tools to manage the simple fb nodes in device tree.
1694 These functions can be used by board to indicate to the OS
1695 the presence of the simple frame buffer with associated reserved
1696 memory
1697
Simon Glass624c0e52023-09-14 10:55:59 -06001698config ARCH_FIXUP_FDT_MEMORY
1699 bool "Enable arch_fixup_memory_banks() call"
1700 default y
1701 help
1702 Enable FDT memory map syncup before OS boot. This feature can be
1703 used for booting OS with different memory setup where the part of
1704 the memory location should be used for different purpose.
1705
Simon Glass27367192023-09-14 10:55:46 -06001706endmenu
1707
1708endif # OF_LIBFDT
1709
Simon Glass5e958642020-09-10 20:21:18 -06001710config USE_BOOTARGS
1711 bool "Enable boot arguments"
1712 help
1713 Provide boot arguments to bootm command. Boot arguments are specified
1714 in CONFIG_BOOTARGS option. Enable this option to be able to specify
1715 CONFIG_BOOTARGS string. If this option is disabled, CONFIG_BOOTARGS
1716 will be undefined and won't take any space in U-Boot image.
1717
1718config BOOTARGS
1719 string "Boot arguments"
1720 depends on USE_BOOTARGS && !USE_DEFAULT_ENV_FILE
1721 help
1722 This can be used to pass arguments to the bootm command. The value of
1723 CONFIG_BOOTARGS goes into the environment value "bootargs". Note that
1724 this value will also override the "chosen" node in FDT blob.
1725
Simon Glass529e2082020-11-05 10:33:48 -07001726config BOOTARGS_SUBST
1727 bool "Support substituting strings in boot arguments"
1728 help
1729 This allows substituting string values in the boot arguments. These
1730 are applied after the commandline has been built.
1731
1732 One use for this is to insert the root-disk UUID into the command
1733 line where bootargs contains "root=${uuid}"
1734
1735 setenv bootargs "console= root=${uuid}"
1736 # Set the 'uuid' environment variable
1737 part uuid mmc 2:2 uuid
1738
1739 # Command-line substitution will put the real uuid into the
1740 # kernel command line
1741 bootm
1742
Simon Glass5e958642020-09-10 20:21:18 -06001743config USE_BOOTCOMMAND
1744 bool "Enable a default value for bootcmd"
Tom Rinidc3bf2d2023-10-26 14:31:28 -04001745 depends on CMDLINE
Simon Glass5e958642020-09-10 20:21:18 -06001746 help
1747 Provide a default value for the bootcmd entry in the environment. If
1748 autoboot is enabled this is what will be run automatically. Enable
1749 this option to be able to specify CONFIG_BOOTCOMMAND as a string. If
1750 this option is disabled, CONFIG_BOOTCOMMAND will be undefined and
1751 won't take any space in U-Boot image.
1752
1753config BOOTCOMMAND
1754 string "bootcmd value"
1755 depends on USE_BOOTCOMMAND && !USE_DEFAULT_ENV_FILE
Simon Glass2d5a8e12023-05-06 08:27:09 -06001756 default "bootflow scan -lb" if BOOTSTD_DEFAULTS && CMD_BOOTFLOW_FULL
1757 default "bootflow scan" if BOOTSTD_DEFAULTS && !CMD_BOOTFLOW_FULL
Simon Glassbe661cb2022-04-24 23:31:27 -06001758 default "run distro_bootcmd" if !BOOTSTD_BOOTCOMMAND && DISTRO_DEFAULTS
Simon Glass5e958642020-09-10 20:21:18 -06001759 help
1760 This is the string of commands that will be used as bootcmd and if
1761 AUTOBOOT is set, automatically run.
1762
1763config USE_PREBOOT
1764 bool "Enable preboot"
Tom Rinidc3bf2d2023-10-26 14:31:28 -04001765 depends on CMDLINE
Simon Glass5e958642020-09-10 20:21:18 -06001766 help
1767 When this option is enabled, the existence of the environment
1768 variable "preboot" will be checked immediately before starting the
1769 CONFIG_BOOTDELAY countdown and/or running the auto-boot command resp.
1770 entering interactive mode.
1771
1772 This feature is especially useful when "preboot" is automatically
1773 generated or modified. For example, the boot code can modify the
1774 "preboot" when a user holds down a certain combination of keys.
1775
1776config PREBOOT
1777 string "preboot default value"
1778 depends on USE_PREBOOT && !USE_DEFAULT_ENV_FILE
Patrick Delaunaybb15d402020-10-12 09:47:50 +02001779 default "usb start" if USB_KEYBOARD
Simon Glass5e958642020-09-10 20:21:18 -06001780 default ""
1781 help
1782 This is the default of "preboot" environment variable.
1783
Pali Rohár39c43c32022-07-10 13:42:55 +02001784config PREBOOT_DEFINED
1785 bool
1786 default y if PREBOOT != ""
1787
Simon Glassc10ddfd2020-09-10 20:21:20 -06001788config DEFAULT_FDT_FILE
1789 string "Default fdt file"
1790 help
1791 This option is used to set the default fdt file to boot OS.
1792
Dzmitry Sankouskia3463062022-02-22 21:49:52 +03001793config SAVE_PREV_BL_FDT_ADDR
1794 depends on ARM
1795 bool "Saves fdt address, passed by the previous bootloader, to env var"
1796 help
1797 When u-boot is used as a chain-loaded bootloader (replacing OS kernel),
1798 enable this option to save fdt address, passed by the
1799 previous bootloader for future use.
1800 Address is saved to `prevbl_fdt_addr` environment variable.
1801
1802 If no fdt was provided by previous bootloader, no env variables
1803 will be created.
1804
1805config SAVE_PREV_BL_INITRAMFS_START_ADDR
1806 depends on ARM
1807 bool "Saves initramfs address, passed by the previous bootloader, to env var"
1808 help
1809 When u-boot is used as a chain-loaded bootloader(replacing OS kernel),
1810 enable this option to save initramfs address, passed by the
1811 previous bootloader for future use.
1812 Address is saved to `prevbl_initrd_start_addr` environment variable.
1813
1814 If no initramfs was provided by previous bootloader, no env variables
1815 will be created.
1816
Simon Glassc8925112023-06-01 10:23:02 -06001817menu "Configuration editor"
1818
1819config CEDIT
1820 bool "Configuration editor"
Heinrich Schuchardtef97f7c2023-12-16 16:38:36 +01001821 depends on EXPO
Simon Glassc8925112023-06-01 10:23:02 -06001822 help
1823 Provides a way to deal with board configuration and present it to
1824 the user for adjustment.
1825
1826 This is intended to provide both graphical and text-based user
1827 interfaces, but only graphical is support at present.
1828
1829endmenu # Configuration editor
1830
Simon Glassb45b1632020-09-10 20:21:13 -06001831endmenu # Booting