blob: 7dd30a030e39952b08d19fac4976d6458f67dad5 [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
Rasmus Villemoesd1bb9532024-10-24 12:01:45 +0200236 default 0x44000000 if ARCH_IMX8M
Simon Glassb45b1632020-09-10 20:21:13 -0600237 default 0x0
238 help
239 Specify the load address of the fit image that will be loaded
240 by SPL.
241
242config SPL_LOAD_FIT_APPLY_OVERLAY
243 bool "Enable SPL applying DT overlays from FIT"
244 depends on SPL_LOAD_FIT
245 select OF_LIBFDT_OVERLAY
246 help
Hugo Villeneuve5c1c6cc2023-04-24 16:51:12 -0400247 The device tree is loaded from the FIT image. Allow the SPL to
Simon Glassb45b1632020-09-10 20:21:13 -0600248 also load device-tree overlays from the FIT image an apply them
249 over the device tree.
250
251config SPL_LOAD_FIT_APPLY_OVERLAY_BUF_SZ
252 depends on SPL_LOAD_FIT_APPLY_OVERLAY
253 default 0x10000
254 hex "size of temporary buffer used to load the overlays"
255 help
256 The size of the area where the overlays will be loaded and
257 uncompress. Must be at least as large as biggest overlay
258 (uncompressed)
259
260config SPL_LOAD_FIT_FULL
261 bool "Enable SPL loading U-Boot as a FIT (full fitImage features)"
262 select SPL_FIT
263 help
264 Normally with the SPL framework a legacy image is generated as part
265 of the build. This contains U-Boot along with information as to
266 where it should be loaded. This option instead enables generation
267 of a FIT (Flat Image Tree) which provides more flexibility. In
268 particular it can handle selecting from multiple device tree
269 and passing the correct one to U-Boot.
270
271config SPL_FIT_IMAGE_POST_PROCESS
272 bool "Enable post-processing of FIT artifacts after loading by the SPL"
273 depends on SPL_LOAD_FIT
Andrew Davis4ba9e6e2022-05-04 15:52:28 -0500274 default y if TI_SECURE_DEVICE
Simon Glassb45b1632020-09-10 20:21:13 -0600275 help
276 Allows doing any sort of manipulation to blobs after they got extracted
277 from the U-Boot FIT image like stripping off headers or modifying the
278 size of the blob, verification, authentication, decryption etc. in a
279 platform or board specific way. In order to use this feature a platform
280 or board-specific implementation of board_fit_image_post_process() must
281 be provided. Also, anything done during this post-processing step would
282 need to be comprehended in how the images were prepared before being
283 injected into the FIT creation (i.e. the blobs would have been pre-
284 processed before being added to the FIT image).
285
Tom Rinibaed5b42024-10-15 16:51:05 -0600286config USE_SPL_FIT_GENERATOR
287 bool "Use a script to generate the .its script"
288 depends on SPL_FIT
289 default y if SPL_FIT && ARCH_ZYNQMP
290
291config SPL_FIT_GENERATOR
292 string ".its file generator script for U-Boot FIT image"
293 depends on USE_SPL_FIT_GENERATOR
294 default "arch/arm/mach-zynqmp/mkimage_fit_atf.sh" if SPL_LOAD_FIT && ARCH_ZYNQMP
295 help
296 Specifies a (platform specific) script file to generate the FIT
297 source file used to build the U-Boot FIT image file. This gets
298 passed a list of supported device tree file stub names to
299 include in the generated image.
300
Simon Glassbc993e52022-10-20 18:23:13 -0600301if VPL
302
303config VPL_FIT
304 bool "Support Flattened Image Tree within VPL"
305 depends on VPL
306 default y
307 select VPL_HASH
308 select VPL_OF_LIBFDT
309
310config VPL_FIT_PRINT
311 bool "Support FIT printing within VPL"
312 depends on VPL_FIT
313 default y
314 help
315 Support printing the content of the fitImage in a verbose manner in VPL.
316
317config VPL_FIT_FULL_CHECK
318 bool "Do a full check of the FIT before using it"
319 default y
320 help
321 Enable this do a full check of the FIT to make sure it is valid. This
322 helps to protect against carefully crafted FITs which take advantage
323 of bugs or omissions in the code. This includes a bad structure,
324 multiple root nodes and the like.
325
326config VPL_FIT_SIGNATURE
327 bool "Enable signature verification of FIT firmware within VPL"
328 depends on VPL_DM
Simon Glassbc993e52022-10-20 18:23:13 -0600329 default y
330 select FIT_SIGNATURE
331 select VPL_FIT
332 select VPL_CRYPTO
333 select VPL_HASH
334 imply VPL_RSA
335 imply VPL_RSA_VERIFY
336 select VPL_IMAGE_SIGN_INFO
337 select VPL_FIT_FULL_CHECK
338
339config VPL_FIT_SIGNATURE_MAX_SIZE
340 hex "Max size of signed FIT structures in VPL"
341 depends on VPL_FIT_SIGNATURE
342 default 0x10000000
343 help
344 This option sets a max size in bytes for verified FIT uImages.
345 A sane value of 256MB protects corrupted DTB structures from overlapping
346 device memory. Assure this size does not extend past expected storage
347 space.
348
349endif # VPL
350
Simon Glass2289ca92023-09-14 10:55:52 -0600351endif # FIT
352
John Keeping9b60a172022-07-28 11:19:15 +0100353config PXE_UTILS
354 bool
355 select MENU
356 help
357 Utilities for parsing PXE file formats.
358
Tom Rini984bfdc2023-10-26 14:31:24 -0400359config BOOT_DEFAULTS_FEATURES
360 bool
361 select SUPPORT_RAW_INITRD
362 select ENV_VARS_UBOOT_CONFIG
363 imply USB_STORAGE
364 imply EFI_PARTITION
365 imply ISO_PARTITION
366
367config BOOT_DEFAULTS_CMDS
368 bool
Simon Glass054d0182023-03-24 16:58:13 -0400369 imply USE_BOOTCOMMAND
370 select CMD_ENV_EXISTS
371 select CMD_EXT2
372 select CMD_EXT4
373 select CMD_FAT
374 select CMD_FS_GENERIC
375 select CMD_PART if PARTITIONS
376 select CMD_DHCP if CMD_NET
377 select CMD_PING if CMD_NET
378 select CMD_PXE if CMD_NET
Simon Glass054d0182023-03-24 16:58:13 -0400379 select CMD_BOOTI if ARM64
380 select CMD_BOOTZ if ARM && !ARM64
381 imply CMD_MII if NET
Tom Rini984bfdc2023-10-26 14:31:24 -0400382
383config BOOT_DEFAULTS
384 bool # Common defaults for standard boot and distroboot
385 select BOOT_DEFAULTS_FEATURES
386 select BOOT_DEFAULTS_CMDS if CMDLINE
Simon Glass054d0182023-03-24 16:58:13 -0400387 help
388 These are not required but are commonly needed to support a good
389 selection of booting methods. Enable this to improve the capability
390 of U-Boot to boot various images. Currently much functionality is
391 tied to enabling the command that exercises it.
392
Simon Glass6cfb0022023-09-14 10:55:53 -0600393menuconfig BOOTSTD
394 bool "Standard boot"
Simon Glass08ad13e2022-04-24 23:31:06 -0600395 default y
396 depends on DM && OF_CONTROL && BLK
397 help
398 U-Boot supports a standard way of locating something to boot,
399 typically an Operating System such as Linux, provided by a distro such
400 as Arch Linux or Debian. Enable this to support iterating through
401 available bootdevs and using bootmeths to find bootflows suitable for
402 booting.
403
404 Standard boot is not a standard way of booting, just a framework
405 within U-Boot for supporting all the different ways that exist.
406
407 Terminology:
408
409 - bootdev - a device which can hold a distro (e.g. MMC)
410 - bootmeth - a method to scan a bootdev to find bootflows (owned by
411 U-Boot)
412 - bootflow - a description of how to boot (owned by the distro)
413
Simon Glass6cfb0022023-09-14 10:55:53 -0600414if BOOTSTD
415
Simon Glassbc993e52022-10-20 18:23:13 -0600416config SPL_BOOTSTD
Simon Glass4aa874f2023-02-22 09:33:58 -0700417 bool "Standard boot support in SPL"
Simon Glassbc993e52022-10-20 18:23:13 -0600418 depends on SPL && SPL_DM && SPL_OF_CONTROL && SPL_BLK
419 default y if VPL
420 help
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200421 This enables standard boot in SPL. This is needed so that VBE
Simon Glassbc993e52022-10-20 18:23:13 -0600422 (Verified Boot for Embedded) can be used, since it depends on standard
423 boot. It is enabled by default since the main purpose of VPL is to
424 handle the firmware part of VBE.
425
426config VPL_BOOTSTD
427 bool "Standard boot support in VPL"
428 depends on VPL && VPL_DM && VPL_OF_CONTROL && VPL_BLK
429 default y
430 help
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200431 This enables standard boot in SPL. This is needed so that VBE
Simon Glassbc993e52022-10-20 18:23:13 -0600432 (Verified Boot for Embedded) can be used, since it depends on standard
433 boot. It is enabled by default since the main purpose of VPL is to
434 handle the firmware part of VBE.
435
Simon Glass78c79dd2023-02-22 14:06:23 -0700436config BOOTSTD_FULL
437 bool "Enhanced features for standard boot"
438 default y if SANDBOX
Shantur Rathore19b54342023-12-23 06:51:59 +0000439 imply BOOTSTD_DEFAULTS
Simon Glass78c79dd2023-02-22 14:06:23 -0700440 help
441 This enables various useful features for standard boot, which are not
442 essential for operation:
443
444 - bootdev, bootmeth commands
445 - extra features in the bootflow command
446 - support for selecting the ordering of bootmeths ("bootmeth order")
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200447 - support for selecting the ordering of bootdevs using the Device Tree
Simon Glass78c79dd2023-02-22 14:06:23 -0700448 as well as the "boot_targets" environment variable
449
Simon Glass2e5161eb2023-01-28 15:00:21 -0700450config BOOTSTD_DEFAULTS
451 bool "Select some common defaults for standard boot"
452 depends on BOOTSTD
Simon Glass054d0182023-03-24 16:58:13 -0400453 select BOOT_DEFAULTS
Simon Glassdb92e782023-05-10 16:34:47 -0600454 select BOOTMETH_DISTRO
Simon Glass2e5161eb2023-01-28 15:00:21 -0700455 help
456 These are not required but are commonly needed to support a good
457 selection of booting methods. Enable this to improve the capability
458 of U-Boot to boot various images.
459
Simon Glassbe661cb2022-04-24 23:31:27 -0600460config BOOTSTD_BOOTCOMMAND
461 bool "Use bootstd to boot"
462 default y if !DISTRO_DEFAULTS
463 help
464 Enable this to select a default boot-command suitable for booting
465 with standard boot. This can be overridden by the board if needed,
466 but the default command should be enough for most boards which use
467 standard boot.
468
469 For now this is only selected if distro boot is NOT used, since
470 standard boot does not support all of the features of distro boot
471 yet.
472
Marek Vasutabb772a2024-10-20 17:43:12 +0200473config BOOTSTD_MENU
474 bool "Provide a menu of available bootflows for standard boot"
475 depends on BOOTSTD_FULL && EXPO
476 default y
477 help
478 Provide a menu of available bootflows and related options.
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
Jerome Forissiere0f95512024-10-16 12:03:59 +0200506 imply CMD_FASTBOOT
507 imply FASTBOOT if !NET_LWIP
Mattijs Korpershoekb30baa92024-07-10 10:40:05 +0200508 select PARTITION_TYPE_GUID
509 select PARTITION_UUIDS
510 help
511 Enables support for booting Android using bootstd. Android requires
512 multiple partitions (misc, boot, vbmeta, ...) in storage for booting.
513
514 Note that only MMC bootdevs are supported at present. This is caused
515 by AVB being limited to MMC devices only.
516
Simon Glassd74e62a2023-07-12 09:04:45 -0600517config BOOTMETH_CROS
518 bool "Bootdev support for Chromium OS"
Simon Glass18700262023-07-30 11:17:02 -0600519 depends on X86 || ARM || SANDBOX
520 default y if !ARM
Simon Glassd7d3a972023-08-24 13:55:45 -0600521 select EFI_PARTITION
522 select PARTITION_TYPE_GUID
523 select PARTITION_UUIDS
Simon Glassd74e62a2023-07-12 09:04:45 -0600524 help
525 Enables support for booting Chromium OS using bootdevs. This uses the
526 kernel A slot and obtains the kernel command line from the parameters
527 provided there.
528
529 Note that only x86 devices are supported at present.
530
Simon Glassb71d7f72023-05-10 16:34:46 -0600531config BOOTMETH_EXTLINUX
532 bool "Bootdev support for extlinux boot"
John Keeping9b60a172022-07-28 11:19:15 +0100533 select PXE_UTILS
Simon Glassad8ec372022-04-24 23:31:13 -0600534 default y
535 help
Simon Glassb71d7f72023-05-10 16:34:46 -0600536 Enables support for extlinux boot using bootdevs. This makes the
Simon Glassad8ec372022-04-24 23:31:13 -0600537 bootdevs look for a 'extlinux/extlinux.conf' on each filesystem
538 they scan.
539
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200540 The specification for this file is here:
Simon Glassb71d7f72023-05-10 16:34:46 -0600541
542 https://uapi-group.org/specifications/specs/boot_loader_specification/
543
Simon Glassad8ec372022-04-24 23:31:13 -0600544 This provides a way to try out standard boot on an existing boot flow.
545
Simon Glassb71d7f72023-05-10 16:34:46 -0600546config BOOTMETH_EXTLINUX_PXE
547 bool "Bootdev support for extlinux boot over network"
Simon Glass83144612022-04-24 23:31:16 -0600548 depends on CMD_PXE && CMD_NET && DM_ETH
549 default y
550 help
Simon Glassb71d7f72023-05-10 16:34:46 -0600551 Enables support for extlinux boot using bootdevs. This makes the
Simon Glass83144612022-04-24 23:31:16 -0600552 bootdevs look for a 'extlinux/extlinux.conf' on the tftp server.
553
Simon Glassb71d7f72023-05-10 16:34:46 -0600554 The specification for this file is here:
555
556 https://uapi-group.org/specifications/specs/boot_loader_specification/
557
Simon Glass83144612022-04-24 23:31:16 -0600558 This provides a way to try out standard boot on an existing boot flow.
559
Simon Glass66f62552022-04-24 23:31:17 -0600560config BOOTMETH_EFILOADER
561 bool "Bootdev support for EFI boot"
AKASHI Takahiro9b08b9a2024-01-17 13:39:41 +0900562 depends on EFI_BINARY_EXEC
Jerome Forissiere0f95512024-10-16 12:03:59 +0200563 imply CMD_TFTPBOOT if CMD_NET
Simon Glass66f62552022-04-24 23:31:17 -0600564 default y
565 help
566 Enables support for EFI boot using bootdevs. This makes the
567 bootdevs look for a 'boot<arch>.efi' on each filesystem
568 they scan. The resulting file is booted after enabling U-Boot's
569 EFI loader support.
570
571 The <arch> depends on the architecture of the board:
572
573 aa64 - aarch64 (ARM 64-bit)
574 arm - ARM 32-bit
575 ia32 - x86 32-bit
576 x64 - x86 64-bit
577 riscv32 - RISC-V 32-bit
578 riscv64 - RISC-V 64-bit
579
580 This provides a way to try out standard boot on an existing boot flow.
581
Heinrich Schuchardt72bca1a2024-04-03 20:05:17 +0200582config BOOTMETH_EFI_BOOTMGR
583 bool "Bootdev support for EFI boot manager"
584 depends on EFI_BOOTMGR
585 select BOOTMETH_GLOBAL
586 default y
587 help
588 Enable booting via the UEFI boot manager. Based on the EFI variables
589 the EFI binary to be launched is determined. To set the EFI variables
590 use the eficonfig command.
591
Heinrich Schuchardt1cd3ec92024-07-16 10:35:34 +0200592config BOOTMETH_QFW
593 bool "Boot method using QEMU parameters"
594 depends on QFW
595 default y
596 help
597 Use QEMU parameters -kernel, -initrd, -append to determine the kernel,
598 initial RAM disk, and kernel command line parameters to boot an
599 operating system. U-Boot's control device-tree is passed to the kernel.
600
Simon Glass0a9f4262022-07-30 15:52:32 -0600601config BOOTMETH_VBE
602 bool "Bootdev support for Verified Boot for Embedded"
603 depends on FIT
604 default y
605 select BOOTMETH_GLOBAL
Tom Rini7d3684a2023-01-16 15:46:49 -0500606 select EVENT
Simon Glass0a9f4262022-07-30 15:52:32 -0600607 help
608 Enables support for VBE boot. This is a standard boot method which
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200609 supports selection of various firmware components, selection of an OS to
Simon Glass0a9f4262022-07-30 15:52:32 -0600610 boot as well as updating these using fwupd.
611
Simon Glassdb92e782023-05-10 16:34:47 -0600612config BOOTMETH_DISTRO
613 bool # Options needed to boot any distro
Tom Rini9bf470a2023-10-26 14:31:27 -0400614 select BOOTMETH_SCRIPT if CMDLINE # E.g. Armbian uses scripts
Simon Glassdb92e782023-05-10 16:34:47 -0600615 select BOOTMETH_EXTLINUX # E.g. Debian uses these
616 select BOOTMETH_EXTLINUX_PXE if CMD_PXE && CMD_NET && DM_ETH
AKASHI Takahiro9b08b9a2024-01-17 13:39:41 +0900617 select BOOTMETH_EFILOADER if EFI_BINARY_EXEC # E.g. Ubuntu uses this
Simon Glassdb92e782023-05-10 16:34:47 -0600618
Simon Glassbc993e52022-10-20 18:23:13 -0600619config SPL_BOOTMETH_VBE
620 bool "Bootdev support for Verified Boot for Embedded (SPL)"
621 depends on SPL && FIT
Tom Rini7d3684a2023-01-16 15:46:49 -0500622 select EVENT
Simon Glassbc993e52022-10-20 18:23:13 -0600623 default y if VPL
624 help
625 Enables support for VBE boot. This is a standard boot method which
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200626 supports selection of various firmware components, selection of an OS to
Simon Glassbc993e52022-10-20 18:23:13 -0600627 boot as well as updating these using fwupd.
628
629config VPL_BOOTMETH_VBE
630 bool "Bootdev support for Verified Boot for Embedded (VPL)"
631 depends on VPL && FIT
Tom Rini7d3684a2023-01-16 15:46:49 -0500632 select EVENT
Simon Glassbc993e52022-10-20 18:23:13 -0600633 default y
634 help
635 Enables support for VBE boot. This is a standard boot method which
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200636 supports selection of various firmware components, selection of an OS to
Simon Glassbc993e52022-10-20 18:23:13 -0600637 boot as well as updating these using fwupd.
638
Simon Glassd0af04c2022-07-30 15:52:33 -0600639if BOOTMETH_VBE
640
Simon Glass513eeed2023-02-22 09:33:52 -0700641config BOOTMETH_VBE_REQUEST
642 bool "Support for serving VBE OS requests"
643 default y
644 help
645 Enables support for looking that the requests made by the
646 Operating System being booted. These requests result in additions to
647 the device tree /chosen node, added during the device tree fixup
648 phase.
649
650config SPL_BOOTMETH_VBE_REQUEST
651 bool "Support for serving VBE OS requests (SPL)"
652 depends on SPL
653 help
654 Enables support for looking that the requests made by the
655 Operating System being booted. These requests result in additions to
656 the device tree /chosen node, added during the device tree fixup
657 phase.
658
659 This is only useful if you are booting an OS direct from SPL.
660
Simon Glassd0af04c2022-07-30 15:52:33 -0600661config BOOTMETH_VBE_SIMPLE
662 bool "Bootdev support for VBE 'simple' method"
663 default y
664 help
665 Enables support for VBE 'simple' boot. This allows updating a single
666 firmware image in boot media such as MMC. It does not support any sort
667 of rollback, recovery or A/B boot.
668
Simon Glassbc993e52022-10-20 18:23:13 -0600669config BOOTMETH_VBE_SIMPLE_OS
670 bool "Bootdev support for VBE 'simple' method OS phase"
671 default y
672 help
673 Enables support for the OS parts of VBE 'simple' boot. This includes
674 fixing up the device tree with the required VBE information, ready
675 for booting into the OS. This option is only enabled for U-Boot
676 proper, since it is the phase where device tree fixups happen.
677
678config SPL_BOOTMETH_VBE_SIMPLE
679 bool "Bootdev support for VBE 'simple' method (SPL)"
680 depends on SPL
681 default y if VPL
682 help
683 Enables support for VBE 'simple' boot. This allows updating a single
684 firmware image in boot media such as MMC. It does not support any sort
685 of rollback, recovery or A/B boot.
686
687config VPL_BOOTMETH_VBE_SIMPLE
688 bool "Bootdev support for VBE 'simple' method (VPL)"
689 depends on VPL
690 default y
691 help
692 Enables support for VBE 'simple' boot. This allows updating a single
693 firmware image in boot media such as MMC. It does not support any sort
694 of rollback, recovery or A/B boot.
695
696config SPL_BOOTMETH_VBE_SIMPLE_FW
697 bool "Bootdev support for VBE 'simple' method firmware phase (SPL)"
698 depends on VPL
699 default y
700 help
701 Enables support for the firmware parts of VBE 'simple' boot. This
702 includes an SPL loader which locates the correct U-Boot to boot into.
703 This option should really only be enabled for VPL, since it is the
704 phase where the SPL + U-Boot decision should be made. But for now,
705 SPL does its own FIT-configuration selection.
706
707config VPL_BOOTMETH_VBE_SIMPLE_FW
708 bool "Bootdev support for VBE 'simple' method firmware phase (VPL)"
709 depends on VPL
710 default y
711 help
712 Enables support for the firmware parts of VBE 'simple' boot. This
713 includes an SPL loader which locates the correct SPL to boot into.
714 This option enabled for VPL, since it is the phase where the SPL
715 decision is made.
716
Simon Glassd0af04c2022-07-30 15:52:33 -0600717endif # BOOTMETH_VBE
718
Simon Glassd8adbe92023-01-06 08:52:36 -0600719config EXPO
720 bool "Support for expos - groups of scenes displaying a UI"
Simon Glass389a4582023-01-28 15:00:18 -0700721 depends on VIDEO
Simon Glassd8adbe92023-01-06 08:52:36 -0600722 default y if BOOTMETH_VBE
723 help
724 An expo is a way of presenting and collecting information from the
725 user. It consists of a collection of 'scenes' of which only one is
726 presented at a time. An expo is typically used to show a boot menu
727 and allow settings to be changed.
728
729 The expo can be presented in graphics form using a vidconsole, or in
730 text form on a serial console.
731
Simon Glass423994e2022-04-24 23:31:20 -0600732config BOOTMETH_SANDBOX
733 def_bool y
734 depends on SANDBOX
735 help
736 This is a sandbox bootmeth driver used for testing. It always returns
737 -ENOTSUPP when attempting to boot.
738
Simon Glass7e03e742022-04-24 23:31:22 -0600739config BOOTMETH_SCRIPT
740 bool "Bootdev support for U-Boot scripts"
741 default y if BOOTSTD_FULL
Tom Rini9bf470a2023-10-26 14:31:27 -0400742 depends on CMDLINE
Simon Glassb4b7ebe2023-05-05 20:03:05 -0600743 select HUSH_PARSER
Simon Glass7e03e742022-04-24 23:31:22 -0600744 help
745 Enables support for booting a distro via a U-Boot script. This makes
746 the bootdevs look for a 'boot/boot.scr' file which can be used to
747 boot the distro.
748
749 This provides a way to try out standard boot on an existing boot flow.
750 It is not enabled by default to save space.
751
Simon Glass77459f42024-08-07 16:47:27 -0600752config UPL
753 bool "upl - Universal Payload Specification"
Simon Glass3a028c22024-08-07 16:47:30 -0600754 imply CMD_UPL
Simon Glass77459f42024-08-07 16:47:27 -0600755 imply UPL_READ
Simon Glassb9474a82024-08-07 16:47:28 -0600756 imply UPL_WRITE
Simon Glassbc3ec002024-08-07 16:47:31 -0600757 imply SPL_UPL if SPL
Simon Glass77459f42024-08-07 16:47:27 -0600758 help
759 Provides support for UPL payloads and handoff information. U-Boot
760 supports generating and accepting handoff information. The mkimage
761 tool will eventually support creating payloads.
762
763if UPL
764
765config UPL_READ
766 bool "upl - Support reading a Universal Payload handoff"
767 help
768 Provides support for decoding a UPL-format payload into a C structure
769 which can be used elsewhere in U-Boot. This is just the reading
Simon Glass45aec8e2024-08-07 16:47:34 -0600770 implementation, useful for trying it out. See UPL_IN for how
771 to tell U-Boot to actually read it on startup and use it for memory
772 and device information, etc.
Simon Glass77459f42024-08-07 16:47:27 -0600773
Simon Glassb9474a82024-08-07 16:47:28 -0600774config UPL_WRITE
775 bool "upl - Support writing a Universal Payload handoff"
776 help
777 Provides support for encoding a UPL-format payload from a C structure
778 so it can be passed to another program. This is just the writing
Simon Glassbc3ec002024-08-07 16:47:31 -0600779 implementation, useful for trying it out. See SPL_UPL_OUT
780 for how to tell U-Boot SPL to actually write it before jumping to
781 the next phase.
782
Simon Glass45aec8e2024-08-07 16:47:34 -0600783config UPL_IN
784 bool "upl - Read the UPL handoff on startup"
785 select UPL_READ
786 help
787 Read an SPL handoff when U-Boot starts and use it to provide
788 devices, memory layout, etc. required by U-Boot. This allows U-Boot
789 to function as a payload in the meaning of the specification.
790
Simon Glassbc3ec002024-08-07 16:47:31 -0600791if SPL
792
793config SPL_UPL
794 bool "Write a UPL handoff in SPL"
795 imply SPL_UPL_OUT
796 help
797 This tells SPL to write a UPL handoff and pass it to the next phase
798 (e.g. to U-Boot or another program which SPL loads and runs). THis
799 provides information to help that program run correctly and
800 efficiently on the machine.
801
802config SPL_UPL_WRITE
803 bool # upl - Support writing a Universal Payload handoff in SPL
804 select SPL_BLOBLIST
805 help
806 Provides support for encoding a UPL-format payload from a C structure
807 so it can be passed to another program. This is just the writing
Simon Glassb9474a82024-08-07 16:47:28 -0600808 implementation, useful for trying it out.
809
Simon Glassbc3ec002024-08-07 16:47:31 -0600810config SPL_UPL_OUT
811 bool "upl - Support writing a Universal Payload handoff in SPL"
812 select SPL_UPL_WRITE
813 help
814 Provides support for encoding a UPL-format payload and passing it to
815 the next firmware phase. This allows U-Boot SPL to function as
816 Platform Init in the meaning of the specification.
817
818endif # SPL
819
Simon Glass77459f42024-08-07 16:47:27 -0600820endif # UPL
821
Simon Glass6cfb0022023-09-14 10:55:53 -0600822endif # BOOTSTD
Simon Glassad8ec372022-04-24 23:31:13 -0600823
Simon Glassb45b1632020-09-10 20:21:13 -0600824config LEGACY_IMAGE_FORMAT
825 bool "Enable support for the legacy image format"
Andrew Davis98a22d02022-05-04 15:52:27 -0500826 default y if !FIT_SIGNATURE && !TI_SECURE_DEVICE
Simon Glassb45b1632020-09-10 20:21:13 -0600827 help
828 This option enables the legacy image format. It is enabled by
829 default for backward compatibility, unless FIT_SIGNATURE is
830 set where it is disabled so that unsigned images cannot be
831 loaded. If a board needs the legacy image format support in this
832 case, enable it here.
833
Eddie James32401ba2023-10-24 10:43:50 -0500834config MEASURED_BOOT
835 bool "Measure boot images and configuration when booting without EFI"
836 depends on HASH && TPM_V2
Ilias Apalodimas1e665f92024-06-23 14:48:18 +0300837 select SHA1
838 select SHA256
839 select SHA384
840 select SHA512
Eddie James32401ba2023-10-24 10:43:50 -0500841 help
842 This option enables measurement of the boot process when booting
843 without UEFI . Measurement involves creating cryptographic hashes
844 of the binary images that are booting and storing them in the TPM.
845 In addition, a log of these hashes is stored in memory for the OS
846 to verify the booted images and configuration. Enable this if the
847 OS has configured some memory area for the event log and you intend
848 to use some attestation tools on your system.
849
850if MEASURED_BOOT
851 config MEASURE_DEVICETREE
852 bool "Measure the devicetree image"
853 default y if MEASURED_BOOT
854 help
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200855 On some platforms, the Device Tree is not static as it may contain
Eddie James32401ba2023-10-24 10:43:50 -0500856 random MAC addresses or other such data that changes each boot.
857 Therefore, it should not be measured into the TPM. In that case,
858 disable the measurement here.
859
860 config MEASURE_IGNORE_LOG
861 bool "Ignore the existing event log"
Eddie James32401ba2023-10-24 10:43:50 -0500862 help
863 On platforms that use an event log memory region that persists
864 through system resets and are the first stage bootloader, then
865 this option should be enabled to ignore any existing data in the
866 event log memory region.
867endif # MEASURED_BOOT
868
Tom Riniec8d1602023-10-26 14:31:25 -0400869config SYS_BOOTM_LEN
870 hex "Maximum size of a decompresed OS image"
Tom Rini793921e2024-04-18 08:29:35 -0600871 depends on CMD_BOOTM || CMD_BOOTI || CMD_BOOTZ || \
Tom Riniec8d1602023-10-26 14:31:25 -0400872 LEGACY_IMAGE_FORMAT || SPL_LEGACY_IMAGE_FORMAT
873 default 0x4000000 if PPC || ARM64
874 default 0x1000000 if X86 || ARCH_MX6 || ARCH_MX7
875 default 0x800000
876 help
877 This is the maximum size of the buffer that is used to decompress the OS
878 image in to if attempting to boot a compressed image.
879
Simon Glassf11d6132020-09-10 20:21:19 -0600880config SUPPORT_RAW_INITRD
881 bool "Enable raw initrd images"
882 help
883 Note, defining the SUPPORT_RAW_INITRD allows user to supply
884 kernel with raw initrd images. The syntax is slightly different, the
885 address of the initrd must be augmented by it's size, in the following
886 format: "<initrd address>:<initrd size>".
887
Simon Glassd81f07f2020-11-04 09:57:35 -0700888config CHROMEOS
889 bool "Support booting Chrome OS"
890 help
891 Chrome OS requires U-Boot to set up a table indicating the boot mode
892 (e.g. Developer mode) and a few other things. Enable this if you are
893 booting on a Chromebook to avoid getting an error about an invalid
894 firmware ID.
895
896config CHROMEOS_VBOOT
897 bool "Support Chrome OS verified boot"
898 help
899 This is intended to enable the full Chrome OS verified boot support
900 in U-Boot. It is not actually implemented in the U-Boot source code
901 at present, so this option is always set to 'n'. It allows
902 distinguishing between booting Chrome OS in a basic way (developer
903 mode) and a full boot.
904
Tom Rinieb4f2de2022-06-25 11:02:44 -0400905config SYS_RAMBOOT
906 bool
907
Tom Rini9ff815a2021-08-24 23:11:49 -0400908config RAMBOOT_PBL
909 bool "Freescale PBL(pre-boot loader) image format support"
Tom Rinieb4f2de2022-06-25 11:02:44 -0400910 select SYS_RAMBOOT if PPC
Tom Rini9ff815a2021-08-24 23:11:49 -0400911 help
912 Some SoCs use PBL to load RCW and/or pre-initialization instructions.
913 For more details refer to doc/README.pblimage
914
Tom Rini886e6e32022-03-23 17:20:03 -0400915choice
Tom Rini489f4022022-12-28 10:52:51 -0500916 prompt "Freescale PBL (or predecessor) load location"
Tom Rini886e6e32022-03-23 17:20:03 -0400917 depends on RAMBOOT_PBL || ((TARGET_P1010RDB_PA || TARGET_P1010RDB_PB \
918 || TARGET_P1020RDB_PC || TARGET_P1020RDB_PD || TARGET_P2020RDB) \
Pali Rohár6763ff82024-06-06 18:33:26 +0200919 && !CMD_NAND) || (TARGET_TURRIS_1X && SYS_MPC85XX_NO_RESETVEC)
Tom Rini886e6e32022-03-23 17:20:03 -0400920
921config SDCARD
Tom Rini489f4022022-12-28 10:52:51 -0500922 bool "Freescale PBL (or similar) is found on SD card"
Tom Rini886e6e32022-03-23 17:20:03 -0400923
924config SPIFLASH
Tom Rini489f4022022-12-28 10:52:51 -0500925 bool "Freescale PBL (or similar) is found on SPI flash"
926
927config NO_PBL
928 bool "Freescale PBL (or similar) is not used in this case"
Tom Rini886e6e32022-03-23 17:20:03 -0400929
930endchoice
931
Tom Rini5989fd42022-06-20 08:07:42 -0400932config FSL_FIXED_MMC_LOCATION
933 bool "PBL MMC is at a fixed location"
934 depends on SDCARD && !RAMBOOT_PBL
935
936config ESDHC_HC_BLK_ADDR
937 def_bool y
938 depends on FSL_FIXED_MMC_LOCATION && (ARCH_BSC9131 || ARCH_BSC9132 || ARCH_P1010)
939 help
940 In High Capacity SD Cards (> 2 GBytes), the 32-bit source address and
941 code length of these soc specify the memory address in block address
942 format. Block length is fixed to 512 bytes as per the SD High
943 Capacity specification.
944
Tom Rini9ff815a2021-08-24 23:11:49 -0400945config SYS_FSL_PBL_PBI
946 string "PBI(pre-boot instructions) commands for the PBL image"
947 depends on RAMBOOT_PBL
948 help
949 PBI commands can be used to configure SoC before it starts the execution.
950 Please refer doc/README.pblimage for more details.
951
952config SYS_FSL_PBL_RCW
953 string "Aadditional RCW (Power on reset configuration) for the PBL image"
954 depends on RAMBOOT_PBL
955 help
956 Enables addition of RCW (Power on reset configuration) in built image.
957 Please refer doc/README.pblimage for more details.
958
Tom Rini94b4fec2022-06-25 11:02:46 -0400959config SYS_BOOT_RAMDISK_HIGH
960 depends on CMD_BOOTM || CMD_BOOTI || CMD_BOOTZ
961 depends on !(NIOS2 || SANDBOX || SH || XTENSA)
962 def_bool y
Simon Glass65edcd32023-03-24 16:58:12 -0400963 select LMB
Tom Rini94b4fec2022-06-25 11:02:46 -0400964 help
965 Enable initrd_high functionality. If defined then the initrd_high
966 feature is enabled and the boot* ramdisk subcommand is enabled.
967
Simon Glassb45b1632020-09-10 20:21:13 -0600968endmenu # Boot images
969
Simon Glassf111bf72023-03-24 16:58:11 -0400970config DISTRO_DEFAULTS
Simon Glasse27d7df2023-09-14 10:55:55 -0600971 bool "(deprecated) Script-based booting of Linux distributions"
Tom Rini045245b2023-10-26 14:31:23 -0400972 select CMDLINE
Simon Glass054d0182023-03-24 16:58:13 -0400973 select BOOT_DEFAULTS
Simon Glassf111bf72023-03-24 16:58:11 -0400974 select AUTO_COMPLETE
975 select CMDLINE_EDITING
Simon Glassf111bf72023-03-24 16:58:11 -0400976 select CMD_SYSBOOT
Simon Glassf111bf72023-03-24 16:58:11 -0400977 select HUSH_PARSER
Simon Glassf111bf72023-03-24 16:58:11 -0400978 select SYS_LONGHELP
Simon Glassf111bf72023-03-24 16:58:11 -0400979 help
Simon Glasse27d7df2023-09-14 10:55:55 -0600980 Note: These scripts have been replaced by Standard Boot. Do not use
981 them on new boards. See 'Migrating from distro_boot' at
982 doc/develop/bootstd.rst
983
Simon Glassf111bf72023-03-24 16:58:11 -0400984 Select this to enable various options and commands which are suitable
985 for building u-boot for booting general purpose Linux distributions.
986
Simon Glassd02ddcf2020-09-10 20:21:14 -0600987menu "Boot timing"
988
989config BOOTSTAGE
990 bool "Boot timing and reporting"
991 help
992 Enable recording of boot time while booting. To use it, insert
993 calls to bootstage_mark() with a suitable BOOTSTAGE_ID from
994 bootstage.h. Only a single entry is recorded for each ID. You can
995 give the entry a name with bootstage_mark_name(). You can also
996 record elapsed time in a particular stage using bootstage_start()
997 before starting and bootstage_accum() when finished. Bootstage will
998 add up all the accumulated time and report it.
999
1000 Normally, IDs are defined in bootstage.h but a small number of
1001 additional 'user' IDs can be used by passing BOOTSTAGE_ID_ALLOC
1002 as the ID.
1003
1004 Calls to show_boot_progress() will also result in log entries but
1005 these will not have names.
1006
1007config SPL_BOOTSTAGE
1008 bool "Boot timing and reported in SPL"
Tom Rini0a83cc22022-06-10 23:03:09 -04001009 depends on BOOTSTAGE && SPL
Simon Glassd02ddcf2020-09-10 20:21:14 -06001010 help
1011 Enable recording of boot time in SPL. To make this visible to U-Boot
1012 proper, enable BOOTSTAGE_STASH as well. This will stash the timing
1013 information when SPL finishes and load it when U-Boot proper starts
1014 up.
1015
1016config TPL_BOOTSTAGE
1017 bool "Boot timing and reported in TPL"
Tom Rini36a4ca02022-06-08 08:24:39 -04001018 depends on BOOTSTAGE && TPL
Simon Glassd02ddcf2020-09-10 20:21:14 -06001019 help
1020 Enable recording of boot time in SPL. To make this visible to U-Boot
1021 proper, enable BOOTSTAGE_STASH as well. This will stash the timing
1022 information when TPL finishes and load it when U-Boot proper starts
1023 up.
1024
1025config BOOTSTAGE_REPORT
1026 bool "Display a detailed boot timing report before booting the OS"
1027 depends on BOOTSTAGE
1028 help
1029 Enable output of a boot time report just before the OS is booted.
1030 This shows how long it took U-Boot to go through each stage of the
1031 boot process. The report looks something like this:
1032
1033 Timer summary in microseconds:
1034 Mark Elapsed Stage
1035 0 0 reset
1036 3,575,678 3,575,678 board_init_f start
1037 3,575,695 17 arch_cpu_init A9
1038 3,575,777 82 arch_cpu_init done
1039 3,659,598 83,821 board_init_r start
1040 3,910,375 250,777 main_loop
1041 29,916,167 26,005,792 bootm_start
1042 30,361,327 445,160 start_kernel
1043
1044config BOOTSTAGE_RECORD_COUNT
1045 int "Number of boot stage records to store"
Simon Glass051ddfb2021-02-03 06:00:49 -07001046 depends on BOOTSTAGE
Simon Glassd02ddcf2020-09-10 20:21:14 -06001047 default 30
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 SPL_BOOTSTAGE_RECORD_COUNT
1053 int "Number of boot stage records to store for SPL"
Simon Glass051ddfb2021-02-03 06:00:49 -07001054 depends on SPL_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 TPL_BOOTSTAGE_RECORD_COUNT
1061 int "Number of boot stage records to store for TPL"
Simon Glass051ddfb2021-02-03 06:00:49 -07001062 depends on TPL_BOOTSTAGE
Simon Glassd02ddcf2020-09-10 20:21:14 -06001063 default 5
1064 help
1065 This is the size of the bootstage record list and is the maximum
1066 number of bootstage records that can be recorded.
1067
1068config BOOTSTAGE_FDT
1069 bool "Store boot timing information in the OS device tree"
1070 depends on BOOTSTAGE
1071 help
1072 Stash the bootstage information in the FDT. A root 'bootstage'
1073 node is created with each bootstage id as a child. Each child
1074 has a 'name' property and either 'mark' containing the
1075 mark time in microseconds, or 'accum' containing the
1076 accumulated time for that bootstage id in microseconds.
1077 For example:
1078
1079 bootstage {
1080 154 {
1081 name = "board_init_f";
1082 mark = <3575678>;
1083 };
1084 170 {
1085 name = "lcd";
1086 accum = <33482>;
1087 };
1088 };
1089
1090 Code in the Linux kernel can find this in /proc/devicetree.
1091
1092config BOOTSTAGE_STASH
1093 bool "Stash the boot timing information in memory before booting OS"
1094 depends on BOOTSTAGE
1095 help
1096 Some OSes do not support device tree. Bootstage can instead write
1097 the boot timing information in a binary format at a given address.
1098 This happens through a call to bootstage_stash(), typically in
1099 the CPU's cleanup_before_linux() function. You can use the
1100 'bootstage stash' and 'bootstage unstash' commands to do this on
1101 the command line.
1102
1103config BOOTSTAGE_STASH_ADDR
1104 hex "Address to stash boot timing information"
Tom Rinid78c9bd2024-07-15 12:42:00 +01001105 depends on BOOTSTAGE_STASH
1106 default 0xC3000000 if STM32MP13X || STM32MP15X
1107 default 0x87000000 if STM32MP25X
1108 default 0x0 if SANDBOX
Simon Glassd02ddcf2020-09-10 20:21:14 -06001109 help
1110 Provide an address which will not be overwritten by the OS when it
1111 starts, so that it can read this information when ready.
1112
1113config BOOTSTAGE_STASH_SIZE
1114 hex "Size of boot timing stash region"
Tom Rinid78c9bd2024-07-15 12:42:00 +01001115 depends on BOOTSTAGE_STASH
Simon Glassd02ddcf2020-09-10 20:21:14 -06001116 default 0x1000
1117 help
1118 This should be large enough to hold the bootstage stash. A value of
1119 4096 (4KiB) is normally plenty.
1120
1121config SHOW_BOOT_PROGRESS
1122 bool "Show boot progress in a board-specific manner"
1123 help
1124 Defining this option allows to add some board-specific code (calling
1125 a user-provided function show_boot_progress(int) that enables you to
1126 show the system's boot progress on some display (for example, some
1127 LEDs) on your board. At the moment, the following checkpoints are
1128 implemented:
1129
1130 Legacy uImage format:
1131
1132 Arg Where When
1133 1 common/cmd_bootm.c before attempting to boot an image
1134 -1 common/cmd_bootm.c Image header has bad magic number
1135 2 common/cmd_bootm.c Image header has correct magic number
1136 -2 common/cmd_bootm.c Image header has bad checksum
1137 3 common/cmd_bootm.c Image header has correct checksum
1138 -3 common/cmd_bootm.c Image data has bad checksum
1139 4 common/cmd_bootm.c Image data has correct checksum
1140 -4 common/cmd_bootm.c Image is for unsupported architecture
1141 5 common/cmd_bootm.c Architecture check OK
1142 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
1143 6 common/cmd_bootm.c Image Type check OK
1144 -6 common/cmd_bootm.c gunzip uncompression error
1145 -7 common/cmd_bootm.c Unimplemented compression type
1146 7 common/cmd_bootm.c Uncompression OK
1147 8 common/cmd_bootm.c No uncompress/copy overwrite error
1148 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
1149
1150 9 common/image.c Start initial ramdisk verification
1151 -10 common/image.c Ramdisk header has bad magic number
1152 -11 common/image.c Ramdisk header has bad checksum
1153 10 common/image.c Ramdisk header is OK
1154 -12 common/image.c Ramdisk data has bad checksum
1155 11 common/image.c Ramdisk data has correct checksum
1156 12 common/image.c Ramdisk verification complete, start loading
1157 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
1158 13 common/image.c Start multifile image verification
1159 14 common/image.c No initial ramdisk, no multifile, continue.
1160
1161 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
1162
1163 -30 arch/powerpc/lib/board.c Fatal error, hang the system
1164 -31 post/post.c POST test failed, detected by post_output_backlog()
1165 -32 post/post.c POST test failed, detected by post_run_single()
1166
1167 34 common/cmd_doc.c before loading a Image from a DOC device
1168 -35 common/cmd_doc.c Bad usage of "doc" command
1169 35 common/cmd_doc.c correct usage of "doc" command
1170 -36 common/cmd_doc.c No boot device
1171 36 common/cmd_doc.c correct boot device
1172 -37 common/cmd_doc.c Unknown Chip ID on boot device
1173 37 common/cmd_doc.c correct chip ID found, device available
1174 -38 common/cmd_doc.c Read Error on boot device
1175 38 common/cmd_doc.c reading Image header from DOC device OK
1176 -39 common/cmd_doc.c Image header has bad magic number
1177 39 common/cmd_doc.c Image header has correct magic number
1178 -40 common/cmd_doc.c Error reading Image from DOC device
1179 40 common/cmd_doc.c Image header has correct magic number
1180 41 common/cmd_ide.c before loading a Image from a IDE device
1181 -42 common/cmd_ide.c Bad usage of "ide" command
1182 42 common/cmd_ide.c correct usage of "ide" command
1183 -43 common/cmd_ide.c No boot device
1184 43 common/cmd_ide.c boot device found
1185 -44 common/cmd_ide.c Device not available
1186 44 common/cmd_ide.c Device available
1187 -45 common/cmd_ide.c wrong partition selected
1188 45 common/cmd_ide.c partition selected
1189 -46 common/cmd_ide.c Unknown partition table
1190 46 common/cmd_ide.c valid partition table found
1191 -47 common/cmd_ide.c Invalid partition type
1192 47 common/cmd_ide.c correct partition type
1193 -48 common/cmd_ide.c Error reading Image Header on boot device
1194 48 common/cmd_ide.c reading Image Header from IDE device OK
1195 -49 common/cmd_ide.c Image header has bad magic number
1196 49 common/cmd_ide.c Image header has correct magic number
1197 -50 common/cmd_ide.c Image header has bad checksum
1198 50 common/cmd_ide.c Image header has correct checksum
1199 -51 common/cmd_ide.c Error reading Image from IDE device
1200 51 common/cmd_ide.c reading Image from IDE device OK
1201 52 common/cmd_nand.c before loading a Image from a NAND device
1202 -53 common/cmd_nand.c Bad usage of "nand" command
1203 53 common/cmd_nand.c correct usage of "nand" command
1204 -54 common/cmd_nand.c No boot device
1205 54 common/cmd_nand.c boot device found
1206 -55 common/cmd_nand.c Unknown Chip ID on boot device
1207 55 common/cmd_nand.c correct chip ID found, device available
1208 -56 common/cmd_nand.c Error reading Image Header on boot device
1209 56 common/cmd_nand.c reading Image Header from NAND device OK
1210 -57 common/cmd_nand.c Image header has bad magic number
1211 57 common/cmd_nand.c Image header has correct magic number
1212 -58 common/cmd_nand.c Error reading Image from NAND device
1213 58 common/cmd_nand.c reading Image from NAND device OK
1214
1215 -60 common/env_common.c Environment has a bad CRC, using default
1216
1217 64 net/eth.c starting with Ethernet configuration.
1218 -64 net/eth.c no Ethernet found.
1219 65 net/eth.c Ethernet found.
1220
1221 -80 common/cmd_net.c usage wrong
1222 80 common/cmd_net.c before calling net_loop()
1223 -81 common/cmd_net.c some error in net_loop() occurred
1224 81 common/cmd_net.c net_loop() back without error
1225 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
1226 82 common/cmd_net.c trying automatic boot
1227 83 common/cmd_net.c running "source" command
1228 -83 common/cmd_net.c some error in automatic boot or "source" command
1229 84 common/cmd_net.c end without errors
1230
1231 FIT uImage format:
1232
1233 Arg Where When
1234 100 common/cmd_bootm.c Kernel FIT Image has correct format
1235 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
1236 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
1237 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
1238 102 common/cmd_bootm.c Kernel unit name specified
1239 -103 common/cmd_bootm.c Can't get kernel subimage node offset
1240 103 common/cmd_bootm.c Found configuration node
1241 104 common/cmd_bootm.c Got kernel subimage node offset
1242 -104 common/cmd_bootm.c Kernel subimage hash verification failed
1243 105 common/cmd_bootm.c Kernel subimage hash verification OK
1244 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
1245 106 common/cmd_bootm.c Architecture check OK
1246 -106 common/cmd_bootm.c Kernel subimage has wrong type
1247 107 common/cmd_bootm.c Kernel subimage type OK
1248 -107 common/cmd_bootm.c Can't get kernel subimage data/size
1249 108 common/cmd_bootm.c Got kernel subimage data/size
1250 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
1251 -109 common/cmd_bootm.c Can't get kernel subimage type
1252 -110 common/cmd_bootm.c Can't get kernel subimage comp
1253 -111 common/cmd_bootm.c Can't get kernel subimage os
1254 -112 common/cmd_bootm.c Can't get kernel subimage load address
1255 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
1256
1257 120 common/image.c Start initial ramdisk verification
1258 -120 common/image.c Ramdisk FIT image has incorrect format
1259 121 common/image.c Ramdisk FIT image has correct format
1260 122 common/image.c No ramdisk subimage unit name, using configuration
1261 -122 common/image.c Can't get configuration for ramdisk subimage
1262 123 common/image.c Ramdisk unit name specified
1263 -124 common/image.c Can't get ramdisk subimage node offset
1264 125 common/image.c Got ramdisk subimage node offset
1265 -125 common/image.c Ramdisk subimage hash verification failed
1266 126 common/image.c Ramdisk subimage hash verification OK
1267 -126 common/image.c Ramdisk subimage for unsupported architecture
1268 127 common/image.c Architecture check OK
1269 -127 common/image.c Can't get ramdisk subimage data/size
1270 128 common/image.c Got ramdisk subimage data/size
1271 129 common/image.c Can't get ramdisk load address
1272 -129 common/image.c Got ramdisk load address
1273
1274 -130 common/cmd_doc.c Incorrect FIT image format
1275 131 common/cmd_doc.c FIT image format OK
1276
1277 -140 common/cmd_ide.c Incorrect FIT image format
1278 141 common/cmd_ide.c FIT image format OK
1279
1280 -150 common/cmd_nand.c Incorrect FIT image format
1281 151 common/cmd_nand.c FIT image format OK
1282
Marek Vasut98154342021-10-23 03:06:03 +02001283config SPL_SHOW_BOOT_PROGRESS
Jan Kiszka5780edb2021-11-03 15:09:36 +01001284 bool "Show boot progress in a board-specific manner in SPL"
Marek Vasut98154342021-10-23 03:06:03 +02001285 depends on SPL
1286 help
1287 Defining this option allows to add some board-specific code (calling
1288 a user-provided function show_boot_progress(int) that enables you to
1289 show the system's boot progress on some display (for example, some
1290 LEDs) on your board. For details see SHOW_BOOT_PROGRESS.
1291
Simon Glassd02ddcf2020-09-10 20:21:14 -06001292endmenu
1293
Simon Glasseebed782020-09-10 20:21:15 -06001294menu "Boot media"
1295
1296config NOR_BOOT
1297 bool "Support for booting from NOR flash"
1298 depends on NOR
1299 help
1300 Enabling this will make a U-Boot binary that is capable of being
1301 booted via NOR. In this case we will enable certain pinmux early
1302 as the ROM only partially sets up pinmux. We also default to using
1303 NOR for environment.
1304
1305config NAND_BOOT
1306 bool "Support for booting from NAND flash"
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 NAND flash. This is not a must, some SoCs need this,
1311 some not.
1312
1313config ONENAND_BOOT
1314 bool "Support for booting from ONENAND"
Simon Glasseebed782020-09-10 20:21:15 -06001315 imply MTD_RAW_NAND
1316 help
1317 Enabling this will make a U-Boot binary that is capable of being
1318 booted via ONENAND. This is not a must, some SoCs need this,
1319 some not.
1320
1321config QSPI_BOOT
1322 bool "Support for booting from QSPI flash"
Simon Glasseebed782020-09-10 20:21:15 -06001323 help
1324 Enabling this will make a U-Boot binary that is capable of being
1325 booted via QSPI flash. This is not a must, some SoCs need this,
1326 some not.
1327
1328config SATA_BOOT
1329 bool "Support for booting from SATA"
Simon Glasseebed782020-09-10 20:21:15 -06001330 help
1331 Enabling this will make a U-Boot binary that is capable of being
1332 booted via SATA. This is not a must, some SoCs need this,
1333 some not.
1334
1335config SD_BOOT
1336 bool "Support for booting from SD/EMMC"
Simon Glasseebed782020-09-10 20:21:15 -06001337 help
1338 Enabling this will make a U-Boot binary that is capable of being
1339 booted via SD/EMMC. This is not a must, some SoCs need this,
1340 some not.
1341
Tom Rinia43bf4e2021-12-11 14:55:50 -05001342config SD_BOOT_QSPI
1343 bool "Support for booting from SD/EMMC and enable QSPI"
1344 help
1345 Enabling this will make a U-Boot binary that is capable of being
1346 booted via SD/EMMC while enabling QSPI on the platform as well. This
1347 is not a must, some SoCs need this, some not.
1348
Simon Glasseebed782020-09-10 20:21:15 -06001349config SPI_BOOT
1350 bool "Support for booting from SPI flash"
Simon Glasseebed782020-09-10 20:21:15 -06001351 help
1352 Enabling this will make a U-Boot binary that is capable of being
1353 booted via SPI flash. This is not a must, some SoCs need this,
1354 some not.
1355
1356endmenu
1357
Simon Glasse9d54d72020-09-10 20:21:16 -06001358menu "Autoboot options"
1359
1360config AUTOBOOT
1361 bool "Autoboot"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001362 depends on CMDLINE
Simon Glasse9d54d72020-09-10 20:21:16 -06001363 default y
1364 help
1365 This enables the autoboot. See doc/README.autoboot for detail.
1366
Simon Glass7dee9dc2023-10-26 14:31:22 -04001367if AUTOBOOT
1368
Simon Glass1b6cbaa2020-09-10 20:21:17 -06001369config BOOTDELAY
1370 int "delay in seconds before automatically booting"
1371 default 2
Simon Glass1b6cbaa2020-09-10 20:21:17 -06001372 help
1373 Delay before automatically running bootcmd;
1374 set to 0 to autoboot with no delay, but you can stop it by key input.
1375 set to -1 to disable autoboot.
1376 set to -2 to autoboot with no delay and not check for abort
1377
1378 If this value is >= 0 then it is also used for the default delay
1379 before starting the default entry in bootmenu. If it is < 0 then
1380 a default value of 10s is used.
1381
1382 See doc/README.autoboot for details.
1383
Simon Glasse9d54d72020-09-10 20:21:16 -06001384config AUTOBOOT_KEYED
1385 bool "Stop autobooting via specific input key / string"
Simon Glasse9d54d72020-09-10 20:21:16 -06001386 help
1387 This option enables stopping (aborting) of the automatic
1388 boot feature only by issuing a specific input key or
1389 string. If not enabled, any input key will abort the
1390 U-Boot automatic booting process and bring the device
1391 to the U-Boot prompt for user input.
1392
Simon Glass7dee9dc2023-10-26 14:31:22 -04001393if AUTOBOOT_KEYED
1394
Steffen Jaeckeldfc97322021-07-08 15:57:38 +02001395config AUTOBOOT_FLUSH_STDIN
1396 bool "Enable flushing stdin before starting to read the password"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001397 depends on !SANDBOX
Steffen Jaeckeldfc97322021-07-08 15:57:38 +02001398 help
1399 When this option is enabled stdin buffer will be flushed before
1400 starting to read the password.
1401 This can't be enabled for the sandbox as flushing stdin would
1402 break the autoboot unit tests.
1403
Simon Glasse9d54d72020-09-10 20:21:16 -06001404config AUTOBOOT_PROMPT
1405 string "Autoboot stop prompt"
Simon Glasse9d54d72020-09-10 20:21:16 -06001406 default "Autoboot in %d seconds\\n"
1407 help
1408 This string is displayed before the boot delay selected by
1409 CONFIG_BOOTDELAY starts. If it is not defined there is no
1410 output indicating that autoboot is in progress.
1411
1412 Note that this define is used as the (only) argument to a
1413 printf() call, so it may contain '%' format specifications,
Quentin Schulzc0a7ae02024-06-12 16:58:47 +02001414 provided that it also includes, separated by commas exactly
Simon Glasse9d54d72020-09-10 20:21:16 -06001415 like in a printf statement, the required arguments. It is
1416 the responsibility of the user to select only such arguments
1417 that are valid in the given context.
1418
1419config AUTOBOOT_ENCRYPTION
1420 bool "Enable encryption in autoboot stopping"
Simon Glasse9d54d72020-09-10 20:21:16 -06001421 help
1422 This option allows a string to be entered into U-Boot to stop the
Steffen Jaeckel6aa6bfb2021-07-08 15:57:35 +02001423 autoboot.
1424 The behavior depends whether CONFIG_CRYPT_PW from lib is enabled
1425 or not.
1426 In case CONFIG_CRYPT_PW is enabled, the string will be forwarded
1427 to the crypt-based functionality and be compared against the
1428 string in the environment variable 'bootstopkeycrypt'.
1429 In case CONFIG_CRYPT_PW is disabled the string itself is hashed
1430 and compared against the hash in the environment variable
1431 'bootstopkeysha256'.
1432 If it matches in either case then boot stops and
1433 a command-line prompt is presented.
Simon Glasse9d54d72020-09-10 20:21:16 -06001434 This provides a way to ship a secure production device which can also
1435 be accessed at the U-Boot command line.
1436
Steffen Jaeckel28be70d2021-07-08 15:57:39 +02001437config AUTOBOOT_SHA256_FALLBACK
1438 bool "Allow fallback from crypt-hashed password to sha256"
1439 depends on AUTOBOOT_ENCRYPTION && CRYPT_PW
1440 help
1441 This option adds support to fall back from crypt-hashed
1442 passwords to checking a SHA256 hashed password in case the
1443 'bootstopusesha256' environment variable is set to 'true'.
1444
Simon Glasse9d54d72020-09-10 20:21:16 -06001445config AUTOBOOT_DELAY_STR
1446 string "Delay autobooting via specific input key / string"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001447 depends on !AUTOBOOT_ENCRYPTION
Simon Glasse9d54d72020-09-10 20:21:16 -06001448 help
1449 This option delays the automatic boot feature by issuing
1450 a specific input key or string. If CONFIG_AUTOBOOT_DELAY_STR
1451 or the environment variable "bootdelaykey" is specified
1452 and this string is received from console input before
1453 autoboot starts booting, U-Boot gives a command prompt. The
1454 U-Boot prompt will time out if CONFIG_BOOT_RETRY_TIME is
1455 used, otherwise it never times out.
1456
1457config AUTOBOOT_STOP_STR
1458 string "Stop autobooting via specific input key / string"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001459 depends on !AUTOBOOT_ENCRYPTION
Simon Glasse9d54d72020-09-10 20:21:16 -06001460 help
1461 This option enables stopping (aborting) of the automatic
1462 boot feature only by issuing a specific input key or
1463 string. If CONFIG_AUTOBOOT_STOP_STR or the environment
1464 variable "bootstopkey" is specified and this string is
1465 received from console input before autoboot starts booting,
1466 U-Boot gives a command prompt. The U-Boot prompt never
1467 times out, even if CONFIG_BOOT_RETRY_TIME is used.
1468
1469config AUTOBOOT_KEYED_CTRLC
1470 bool "Enable Ctrl-C autoboot interruption"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001471 depends on !AUTOBOOT_ENCRYPTION
Simon Glasse9d54d72020-09-10 20:21:16 -06001472 help
1473 This option allows for the boot sequence to be interrupted
1474 by ctrl-c, in addition to the "bootdelaykey" and "bootstopkey".
1475 Setting this variable provides an escape sequence from the
1476 limited "password" strings.
1477
Steffen Jaeckel792a13f2021-07-08 15:57:37 +02001478config AUTOBOOT_NEVER_TIMEOUT
1479 bool "Make the password entry never time-out"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001480 depends on AUTOBOOT_ENCRYPTION && CRYPT_PW
Steffen Jaeckel792a13f2021-07-08 15:57:37 +02001481 help
1482 This option removes the timeout from the password entry
1483 when the user first presses the <Enter> key before entering
1484 any other character.
1485
Steffen Jaeckel6aa6bfb2021-07-08 15:57:35 +02001486config AUTOBOOT_STOP_STR_ENABLE
1487 bool "Enable fixed string to stop autobooting"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001488 depends on AUTOBOOT_ENCRYPTION
Steffen Jaeckel6aa6bfb2021-07-08 15:57:35 +02001489 help
1490 This option enables the feature to add a fixed stop
1491 string that is defined at compile time.
1492 In every case it will be tried to load the stop
1493 string from the environment.
1494 In case this is enabled and there is no stop string
1495 in the environment, this will be used as default value.
1496
1497config AUTOBOOT_STOP_STR_CRYPT
1498 string "Stop autobooting via crypt-hashed password"
1499 depends on AUTOBOOT_STOP_STR_ENABLE && CRYPT_PW
1500 help
1501 This option adds the feature to only stop the autobooting,
1502 and therefore boot into the U-Boot prompt, when the input
1503 string / password matches a values that is hashed via
1504 one of the supported crypt-style password hashing options
1505 and saved in the environment variable "bootstopkeycrypt".
1506
Simon Glasse9d54d72020-09-10 20:21:16 -06001507config AUTOBOOT_STOP_STR_SHA256
Steffen Jaeckele1788f92021-07-08 15:57:40 +02001508 string "Stop autobooting via SHA256 hashed password"
Steffen Jaeckel6aa6bfb2021-07-08 15:57:35 +02001509 depends on AUTOBOOT_STOP_STR_ENABLE
Simon Glasse9d54d72020-09-10 20:21:16 -06001510 help
1511 This option adds the feature to only stop the autobooting,
1512 and therefore boot into the U-Boot prompt, when the input
Quentin Schulzc0a7ae02024-06-12 16:58:47 +02001513 string / password matches a values that is encrypted via
Joel Peshkin8b7bf532020-11-21 17:18:59 -08001514 a SHA256 hash and saved in the environment variable
1515 "bootstopkeysha256". If the value in that variable
1516 includes a ":", the portion prior to the ":" will be treated
1517 as a salt value.
Simon Glasse9d54d72020-09-10 20:21:16 -06001518
Simon Glass7dee9dc2023-10-26 14:31:22 -04001519endif # AUTOBOOT_KEYED
1520
1521if !AUTOBOOT_KEYED
1522
Simon Glasse9d54d72020-09-10 20:21:16 -06001523config AUTOBOOT_USE_MENUKEY
1524 bool "Allow a specify key to run a menu from the environment"
Simon Glasse9d54d72020-09-10 20:21:16 -06001525 help
1526 If a specific key is pressed to stop autoboot, then the commands in
1527 the environment variable 'menucmd' are executed before boot starts.
1528
1529config AUTOBOOT_MENUKEY
1530 int "ASCII value of boot key to show a menu"
1531 default 0
1532 depends on AUTOBOOT_USE_MENUKEY
1533 help
1534 If this key is pressed to stop autoboot, then the commands in the
1535 environment variable 'menucmd' will be executed before boot starts.
1536 For example, 33 means "!" in ASCII, so pressing ! at boot would take
1537 this action.
1538
Simon Glass7dee9dc2023-10-26 14:31:22 -04001539endif
1540
1541endif # AUTOBOOT
1542
Simon Glasse9d54d72020-09-10 20:21:16 -06001543config AUTOBOOT_MENU_SHOW
1544 bool "Show a menu on boot"
1545 depends on CMD_BOOTMENU
1546 help
1547 This enables the boot menu, controlled by environment variables
1548 defined by the board. The menu starts after running the 'preboot'
1549 environmnent variable (if enabled) and before handling the boot delay.
Peter Robinson16e0b8f2023-08-18 15:54:10 +01001550 See doc/usage/cmd/bootmenu.rst for more details.
Simon Glasse9d54d72020-09-10 20:21:16 -06001551
Masahisa Kojima97cbcc42022-05-26 19:09:38 +09001552config BOOTMENU_DISABLE_UBOOT_CONSOLE
1553 bool "Disallow bootmenu to enter the U-Boot console"
1554 depends on AUTOBOOT_MENU_SHOW
1555 help
1556 If this option is enabled, user can not enter the U-Boot console from
1557 bootmenu. It increases the system security.
1558
Tom Rinia45a3ef2022-03-11 09:12:04 -05001559config BOOT_RETRY
1560 bool "Boot retry feature"
1561 help
1562 Allow for having the U-Boot command prompt time out and attempt
1563 to boot again. If the environment variable "bootretry" is found then
1564 its value is used, otherwise the retry timeout is
1565 CONFIG_BOOT_RETRY_TIME. CONFIG_BOOT_RETRY_MIN is optional and
1566 defaults to CONFIG_BOOT_RETRY_TIME. All times are in seconds.
1567
1568config BOOT_RETRY_TIME
1569 int "Timeout in seconds before attempting to boot again"
1570 depends on BOOT_RETRY
1571 help
1572 Time in seconds before the U-Boot prompt will timeout and boot will
1573 be attempted again.
1574
1575config BOOT_RETRY_MIN
1576 int "Minimum timeout in seconds for 'bootretry'"
1577 depends on BOOT_RETRY
1578 default BOOT_RETRY_TIME
1579 help
1580 The minimum time in seconds that "bootretry" can be set to.
1581
1582config RESET_TO_RETRY
1583 bool "Reset the board to retry autoboot"
1584 depends on BOOT_RETRY
1585 help
1586 After the countdown timed out, the board will be reset to restart
1587 again.
1588
Simon Glasse9d54d72020-09-10 20:21:16 -06001589endmenu
1590
Philippe Reynesd28484e2022-03-28 22:56:59 +02001591menu "Image support"
1592
1593config IMAGE_PRE_LOAD
1594 bool "Image pre-load support"
1595 help
1596 Enable an image pre-load stage in the SPL.
1597 This pre-load stage allows to do some manipulation
1598 or check (for example signature check) on an image
1599 before launching it.
1600
1601config SPL_IMAGE_PRE_LOAD
1602 bool "Image pre-load support within SPL"
1603 depends on SPL && IMAGE_PRE_LOAD
1604 help
1605 Enable an image pre-load stage in the SPL.
1606 This pre-load stage allows to do some manipulation
1607 or check (for example signature check) on an image
1608 before launching it.
1609
1610config IMAGE_PRE_LOAD_SIG
1611 bool "Image pre-load signature support"
1612 depends on IMAGE_PRE_LOAD
1613 select FIT_SIGNATURE
1614 select RSA
1615 select RSA_VERIFY_WITH_PKEY
1616 help
1617 Enable signature check support in the pre-load stage.
1618 For this feature a very simple header is added before
1619 the image with few fields:
1620 - a magic
1621 - the image size
1622 - the signature
1623 All other information (header size, type of signature,
1624 ...) are provided in the node /image/pre-load/sig of
1625 u-boot.
1626
1627config SPL_IMAGE_PRE_LOAD_SIG
1628 bool "Image pre-load signature support witin SPL"
1629 depends on SPL_IMAGE_PRE_LOAD && IMAGE_PRE_LOAD_SIG
1630 select SPL_FIT_SIGNATURE
1631 select SPL_RSA
1632 select SPL_RSA_VERIFY_WITH_PKEY
1633 help
1634 Enable signature check support in the pre-load stage in the SPL.
1635 For this feature a very simple header is added before
1636 the image with few fields:
1637 - a magic
1638 - the image size
1639 - the signature
1640 All other information (header size, type of signature,
1641 ...) are provided in the node /image/pre-load/sig of
1642 u-boot.
1643
1644endmenu
1645
Simon Glass27367192023-09-14 10:55:46 -06001646if OF_LIBFDT
1647
1648menu "Devicetree fixup"
1649
Matthias Schiffere908fec2023-12-11 12:03:17 +01001650config OF_ENV_SETUP
1651 bool "Run a command from environment to set up device tree before boot"
1652 depends on CMD_FDT
1653 help
1654 This causes U-Boot to run a command from the environment variable
1655 fdt_fixup before booting into the operating system, which can use the
1656 fdt command to modify the device tree. The device tree is then passed
1657 to the OS.
1658
Simon Glass48e6d3d2023-09-14 10:55:47 -06001659config OF_BOARD_SETUP
1660 bool "Set up board-specific details in device tree before boot"
1661 help
1662 This causes U-Boot to call ft_board_setup() before booting into
1663 the Operating System. This function can set up various
1664 board-specific information in the device tree for use by the OS.
1665 The device tree is then passed to the OS.
1666
1667config OF_SYSTEM_SETUP
1668 bool "Set up system-specific details in device tree before boot"
1669 help
1670 This causes U-Boot to call ft_system_setup() before booting into
1671 the Operating System. This function can set up various
1672 system-specific information in the device tree for use by the OS.
1673 The device tree is then passed to the OS.
1674
1675config OF_STDOUT_VIA_ALIAS
1676 bool "Update the device-tree stdout alias from U-Boot"
1677 help
1678 This uses U-Boot's serial alias from the aliases node to update
1679 the device tree passed to the OS. The "linux,stdout-path" property
1680 in the chosen node is set to point to the correct serial node.
1681 This option currently references CONFIG_CONS_INDEX, which is
1682 incorrect when used with device tree as this option does not
1683 exist / should not be used.
1684
Simon Glassb7b7f162023-09-14 10:55:57 -06001685config FDT_FIXUP_PARTITIONS
Simon Glass1a5bcc12023-09-14 10:55:58 -06001686 bool "Overwrite MTD partitions in DTS through defined in 'mtdparts'"
Simon Glassb7b7f162023-09-14 10:55:57 -06001687 help
1688 Allow overwriting defined partitions in the device tree blob
1689 using partition info defined in the 'mtdparts' environment
1690 variable.
1691
Simon Glass27367192023-09-14 10:55:46 -06001692config FDT_SIMPLEFB
1693 bool "FDT tools for simplefb support"
Devarsh Thakkaree3dad42024-09-25 20:43:52 +05301694 depends on VIDEO
Simon Glass27367192023-09-14 10:55:46 -06001695 help
1696 Enable the fdt tools to manage the simple fb nodes in device tree.
1697 These functions can be used by board to indicate to the OS
1698 the presence of the simple frame buffer with associated reserved
1699 memory
1700
Simon Glass624c0e52023-09-14 10:55:59 -06001701config ARCH_FIXUP_FDT_MEMORY
Baruch Siachcfd5a552024-10-28 18:44:35 +02001702 bool "Enable fdt_fixup_memory_banks() call"
Simon Glass624c0e52023-09-14 10:55:59 -06001703 default y
1704 help
1705 Enable FDT memory map syncup before OS boot. This feature can be
1706 used for booting OS with different memory setup where the part of
1707 the memory location should be used for different purpose.
1708
Simon Glass27367192023-09-14 10:55:46 -06001709endmenu
1710
1711endif # OF_LIBFDT
1712
Simon Glass5e958642020-09-10 20:21:18 -06001713config USE_BOOTARGS
1714 bool "Enable boot arguments"
1715 help
1716 Provide boot arguments to bootm command. Boot arguments are specified
1717 in CONFIG_BOOTARGS option. Enable this option to be able to specify
1718 CONFIG_BOOTARGS string. If this option is disabled, CONFIG_BOOTARGS
1719 will be undefined and won't take any space in U-Boot image.
1720
1721config BOOTARGS
1722 string "Boot arguments"
1723 depends on USE_BOOTARGS && !USE_DEFAULT_ENV_FILE
1724 help
1725 This can be used to pass arguments to the bootm command. The value of
1726 CONFIG_BOOTARGS goes into the environment value "bootargs". Note that
1727 this value will also override the "chosen" node in FDT blob.
1728
Simon Glass529e2082020-11-05 10:33:48 -07001729config BOOTARGS_SUBST
1730 bool "Support substituting strings in boot arguments"
1731 help
1732 This allows substituting string values in the boot arguments. These
1733 are applied after the commandline has been built.
1734
1735 One use for this is to insert the root-disk UUID into the command
1736 line where bootargs contains "root=${uuid}"
1737
1738 setenv bootargs "console= root=${uuid}"
1739 # Set the 'uuid' environment variable
1740 part uuid mmc 2:2 uuid
1741
1742 # Command-line substitution will put the real uuid into the
1743 # kernel command line
1744 bootm
1745
Simon Glass5e958642020-09-10 20:21:18 -06001746config USE_BOOTCOMMAND
1747 bool "Enable a default value for bootcmd"
Tom Rinidc3bf2d2023-10-26 14:31:28 -04001748 depends on CMDLINE
Simon Glass5e958642020-09-10 20:21:18 -06001749 help
1750 Provide a default value for the bootcmd entry in the environment. If
1751 autoboot is enabled this is what will be run automatically. Enable
1752 this option to be able to specify CONFIG_BOOTCOMMAND as a string. If
1753 this option is disabled, CONFIG_BOOTCOMMAND will be undefined and
1754 won't take any space in U-Boot image.
1755
1756config BOOTCOMMAND
1757 string "bootcmd value"
1758 depends on USE_BOOTCOMMAND && !USE_DEFAULT_ENV_FILE
Simon Glass2d5a8e12023-05-06 08:27:09 -06001759 default "bootflow scan -lb" if BOOTSTD_DEFAULTS && CMD_BOOTFLOW_FULL
1760 default "bootflow scan" if BOOTSTD_DEFAULTS && !CMD_BOOTFLOW_FULL
Simon Glassbe661cb2022-04-24 23:31:27 -06001761 default "run distro_bootcmd" if !BOOTSTD_BOOTCOMMAND && DISTRO_DEFAULTS
Simon Glass5e958642020-09-10 20:21:18 -06001762 help
1763 This is the string of commands that will be used as bootcmd and if
1764 AUTOBOOT is set, automatically run.
1765
1766config USE_PREBOOT
1767 bool "Enable preboot"
Tom Rinidc3bf2d2023-10-26 14:31:28 -04001768 depends on CMDLINE
Simon Glass5e958642020-09-10 20:21:18 -06001769 help
1770 When this option is enabled, the existence of the environment
1771 variable "preboot" will be checked immediately before starting the
1772 CONFIG_BOOTDELAY countdown and/or running the auto-boot command resp.
1773 entering interactive mode.
1774
1775 This feature is especially useful when "preboot" is automatically
1776 generated or modified. For example, the boot code can modify the
1777 "preboot" when a user holds down a certain combination of keys.
1778
1779config PREBOOT
1780 string "preboot default value"
1781 depends on USE_PREBOOT && !USE_DEFAULT_ENV_FILE
Patrick Delaunaybb15d402020-10-12 09:47:50 +02001782 default "usb start" if USB_KEYBOARD
Simon Glass5e958642020-09-10 20:21:18 -06001783 default ""
1784 help
1785 This is the default of "preboot" environment variable.
1786
Pali Rohár39c43c32022-07-10 13:42:55 +02001787config PREBOOT_DEFINED
1788 bool
1789 default y if PREBOOT != ""
1790
Simon Glassc10ddfd2020-09-10 20:21:20 -06001791config DEFAULT_FDT_FILE
1792 string "Default fdt file"
1793 help
1794 This option is used to set the default fdt file to boot OS.
1795
Dzmitry Sankouskia3463062022-02-22 21:49:52 +03001796config SAVE_PREV_BL_FDT_ADDR
1797 depends on ARM
1798 bool "Saves fdt address, passed by the previous bootloader, to env var"
1799 help
1800 When u-boot is used as a chain-loaded bootloader (replacing OS kernel),
1801 enable this option to save fdt address, passed by the
1802 previous bootloader for future use.
1803 Address is saved to `prevbl_fdt_addr` environment variable.
1804
1805 If no fdt was provided by previous bootloader, no env variables
1806 will be created.
1807
1808config SAVE_PREV_BL_INITRAMFS_START_ADDR
1809 depends on ARM
1810 bool "Saves initramfs address, passed by the previous bootloader, to env var"
1811 help
1812 When u-boot is used as a chain-loaded bootloader(replacing OS kernel),
1813 enable this option to save initramfs address, passed by the
1814 previous bootloader for future use.
1815 Address is saved to `prevbl_initrd_start_addr` environment variable.
1816
1817 If no initramfs was provided by previous bootloader, no env variables
1818 will be created.
1819
Simon Glassc8925112023-06-01 10:23:02 -06001820menu "Configuration editor"
1821
1822config CEDIT
1823 bool "Configuration editor"
Heinrich Schuchardtef97f7c2023-12-16 16:38:36 +01001824 depends on EXPO
Simon Glassc8925112023-06-01 10:23:02 -06001825 help
1826 Provides a way to deal with board configuration and present it to
1827 the user for adjustment.
1828
1829 This is intended to provide both graphical and text-based user
1830 interfaces, but only graphical is support at present.
1831
1832endmenu # Configuration editor
1833
Simon Glassb45b1632020-09-10 20:21:13 -06001834endmenu # Booting