blob: 4b646b7e46be7ff95d5563f20e60500c9fc92690 [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
Simon Glassdf49cd02024-12-07 10:24:09 -0700166config VPL_FIT
167 bool "Support Flattened Image Tree within VPL"
168 depends on VPL
169 select VPL_HASH
170 select VPL_OF_LIBFDT
171
172config TPL_FIT
173 bool "Support Flattened Image Tree within TPL"
174 depends on TPL
175 select TPL_HASH
176 select TPL_OF_LIBFDT
177
Simon Glassb45b1632020-09-10 20:21:13 -0600178config SPL_FIT_PRINT
179 bool "Support FIT printing within SPL"
180 depends on SPL_FIT
181 help
182 Support printing the content of the fitImage in a verbose manner in SPL.
183
Simon Glass244705b2021-02-15 17:08:10 -0700184config SPL_FIT_FULL_CHECK
185 bool "Do a full check of the FIT before using it"
Tom Rini0f3d1de2022-12-04 10:14:20 -0500186 depends on SPL_FIT
Simon Glass244705b2021-02-15 17:08:10 -0700187 help
188 Enable this do a full check of the FIT to make sure it is valid. This
189 helps to protect against carefully crafted FITs which take advantage
190 of bugs or omissions in the code. This includes a bad structure,
191 multiple root nodes and the like.
192
Simon Glassb45b1632020-09-10 20:21:13 -0600193config SPL_FIT_SIGNATURE
194 bool "Enable signature verification of FIT firmware within SPL"
195 depends on SPL_DM
Klaus Heinrich Kiwiae5073f2021-02-09 15:41:54 -0300196 depends on SPL_LOAD_FIT || SPL_LOAD_FIT_FULL
Klaus Heinrich Kiwic9796e62021-02-09 15:41:53 -0300197 select FIT_SIGNATURE
Simon Glassb45b1632020-09-10 20:21:13 -0600198 select SPL_FIT
Simon Glassa8437ce2021-07-10 21:14:25 -0600199 select SPL_CRYPTO
Alexandru Gagniuc97464ff2021-09-02 19:54:19 -0500200 select SPL_HASH
Alexandru Gagniuc1f2e2312021-07-29 11:47:18 -0500201 imply SPL_RSA
202 imply SPL_RSA_VERIFY
Simon Glassb45b1632020-09-10 20:21:13 -0600203 select SPL_IMAGE_SIGN_INFO
Simon Glass244705b2021-02-15 17:08:10 -0700204 select SPL_FIT_FULL_CHECK
Simon Glassb45b1632020-09-10 20:21:13 -0600205
Simon Glassc0cabbc2021-09-25 19:43:39 -0600206config SPL_FIT_SIGNATURE_MAX_SIZE
207 hex "Max size of signed FIT structures in SPL"
208 depends on SPL_FIT_SIGNATURE
209 default 0x10000000
210 help
211 This option sets a max size in bytes for verified FIT uImages.
212 A sane value of 256MB protects corrupted DTB structures from overlapping
213 device memory. Assure this size does not extend past expected storage
214 space.
215
Philippe Reynes47f3eb22021-10-15 11:35:03 +0200216config SPL_FIT_RSASSA_PSS
217 bool "Support rsassa-pss signature scheme of FIT image contents in SPL"
218 depends on SPL_FIT_SIGNATURE
219 help
220 Enable this to support the pss padding algorithm as described
221 in the rfc8017 (https://tools.ietf.org/html/rfc8017) in SPL.
222
Simon Glassb45b1632020-09-10 20:21:13 -0600223config SPL_LOAD_FIT
224 bool "Enable SPL loading U-Boot as a FIT (basic fitImage features)"
Simon Glass2289ca92023-09-14 10:55:52 -0600225 depends on SPL
Simon Glassb45b1632020-09-10 20:21:13 -0600226 select SPL_FIT
227 help
228 Normally with the SPL framework a legacy image is generated as part
229 of the build. This contains U-Boot along with information as to
230 where it should be loaded. This option instead enables generation
231 of a FIT (Flat Image Tree) which provides more flexibility. In
232 particular it can handle selecting from multiple device tree
233 and passing the correct one to U-Boot.
234
Alexandru Gagniuc064c9c22021-03-29 12:05:15 -0500235 This path has the following limitations:
236
Bin Meng91cdcb92021-05-10 20:23:29 +0800237 1. "loadables" images, other than FDTs, which do not have a "load"
Alexandru Gagniuc064c9c22021-03-29 12:05:15 -0500238 property will not be loaded. This limitation also applies to FPGA
239 images with the correct "compatible" string.
Heinrich Schuchardtb72eb352024-06-18 08:23:17 +0200240 2. For FPGA images, the supported "compatible" list may be found in
241 https://fitspec.osfw.foundation/.
Alexandru Gagniuc064c9c22021-03-29 12:05:15 -0500242 3. FDTs are only loaded for images with an "os" property of "u-boot".
243 "linux" images are also supported with Falcon boot mode.
244
Simon Glassb45b1632020-09-10 20:21:13 -0600245config SPL_LOAD_FIT_ADDRESS
246 hex "load address of fit image"
Simon Glassdfcedda2023-09-14 10:55:51 -0600247 depends on SPL_LOAD_FIT
Rasmus Villemoesd1bb9532024-10-24 12:01:45 +0200248 default 0x44000000 if ARCH_IMX8M
Simon Glassb45b1632020-09-10 20:21:13 -0600249 default 0x0
250 help
251 Specify the load address of the fit image that will be loaded
252 by SPL.
253
254config SPL_LOAD_FIT_APPLY_OVERLAY
255 bool "Enable SPL applying DT overlays from FIT"
256 depends on SPL_LOAD_FIT
257 select OF_LIBFDT_OVERLAY
258 help
Hugo Villeneuve5c1c6cc2023-04-24 16:51:12 -0400259 The device tree is loaded from the FIT image. Allow the SPL to
Simon Glassb45b1632020-09-10 20:21:13 -0600260 also load device-tree overlays from the FIT image an apply them
261 over the device tree.
262
263config SPL_LOAD_FIT_APPLY_OVERLAY_BUF_SZ
264 depends on SPL_LOAD_FIT_APPLY_OVERLAY
265 default 0x10000
266 hex "size of temporary buffer used to load the overlays"
267 help
268 The size of the area where the overlays will be loaded and
269 uncompress. Must be at least as large as biggest overlay
270 (uncompressed)
271
272config SPL_LOAD_FIT_FULL
273 bool "Enable SPL loading U-Boot as a FIT (full fitImage features)"
274 select SPL_FIT
275 help
276 Normally with the SPL framework a legacy image is generated as part
277 of the build. This contains U-Boot along with information as to
278 where it should be loaded. This option instead enables generation
279 of a FIT (Flat Image Tree) which provides more flexibility. In
280 particular it can handle selecting from multiple device tree
281 and passing the correct one to U-Boot.
282
Simon Glassdf49cd02024-12-07 10:24:09 -0700283config TPL_LOAD_FIT
284 bool "Enable TPL loading U-Boot as a FIT (basic fitImage features)"
285 depends on TPL
286 select TPL_FIT
287 help
288 Normally with the SPL framework a legacy image is generated as part
289 of the build. This contains U-Boot along with information as to
290 where it should be loaded. This option instead enables generation
291 of a FIT (Flat Image Tree) which provides more flexibility. In
292 particular it can handle selecting from multiple device tree
293 and passing the correct one to U-Boot.
294
295 This path has the following limitations:
296
297 1. "loadables" images, other than FDTs, which do not have a "load"
298 property will not be loaded. This limitation also applies to FPGA
299 images with the correct "compatible" string.
300 2. For FPGA images, the supported "compatible" list is in the
301 doc/uImage.FIT/source_file_format.txt.
302 3. FDTs are only loaded for images with an "os" property of "u-boot".
303 "linux" images are also supported with Falcon boot mode.
304
Simon Glassb45b1632020-09-10 20:21:13 -0600305config SPL_FIT_IMAGE_POST_PROCESS
306 bool "Enable post-processing of FIT artifacts after loading by the SPL"
307 depends on SPL_LOAD_FIT
Andrew Davis4ba9e6e2022-05-04 15:52:28 -0500308 default y if TI_SECURE_DEVICE
Simon Glassb45b1632020-09-10 20:21:13 -0600309 help
310 Allows doing any sort of manipulation to blobs after they got extracted
311 from the U-Boot FIT image like stripping off headers or modifying the
312 size of the blob, verification, authentication, decryption etc. in a
313 platform or board specific way. In order to use this feature a platform
314 or board-specific implementation of board_fit_image_post_process() must
315 be provided. Also, anything done during this post-processing step would
316 need to be comprehended in how the images were prepared before being
317 injected into the FIT creation (i.e. the blobs would have been pre-
318 processed before being added to the FIT image).
319
Tom Rinibaed5b42024-10-15 16:51:05 -0600320config USE_SPL_FIT_GENERATOR
321 bool "Use a script to generate the .its script"
322 depends on SPL_FIT
323 default y if SPL_FIT && ARCH_ZYNQMP
324
325config SPL_FIT_GENERATOR
326 string ".its file generator script for U-Boot FIT image"
327 depends on USE_SPL_FIT_GENERATOR
328 default "arch/arm/mach-zynqmp/mkimage_fit_atf.sh" if SPL_LOAD_FIT && ARCH_ZYNQMP
329 help
330 Specifies a (platform specific) script file to generate the FIT
331 source file used to build the U-Boot FIT image file. This gets
332 passed a list of supported device tree file stub names to
333 include in the generated image.
334
Simon Glassbc993e52022-10-20 18:23:13 -0600335if VPL
336
337config VPL_FIT
338 bool "Support Flattened Image Tree within VPL"
339 depends on VPL
340 default y
341 select VPL_HASH
342 select VPL_OF_LIBFDT
343
Simon Glassdf49cd02024-12-07 10:24:09 -0700344config VPL_LOAD_FIT
345 bool "Enable VPL loading U-Boot as a FIT (basic fitImage features)"
346 select VPL_FIT
347 default y
348
349config VPL_LOAD_FIT_FULL
350 bool "Enable SPL loading U-Boot as a FIT (full fitImage features)"
351 select VPL_FIT
352 help
353 Normally with the SPL framework a legacy image is generated as part
354 of the build. This contains U-Boot along with information as to
355 where it should be loaded. This option instead enables generation
356 of a FIT (Flat Image Tree) which provides more flexibility. In
357 particular it can handle selecting from multiple device tree
358 and passing the correct one to U-Boot.
359
Simon Glassbc993e52022-10-20 18:23:13 -0600360config VPL_FIT_PRINT
361 bool "Support FIT printing within VPL"
362 depends on VPL_FIT
363 default y
364 help
365 Support printing the content of the fitImage in a verbose manner in VPL.
366
367config VPL_FIT_FULL_CHECK
368 bool "Do a full check of the FIT before using it"
369 default y
370 help
371 Enable this do a full check of the FIT to make sure it is valid. This
372 helps to protect against carefully crafted FITs which take advantage
373 of bugs or omissions in the code. This includes a bad structure,
374 multiple root nodes and the like.
375
376config VPL_FIT_SIGNATURE
377 bool "Enable signature verification of FIT firmware within VPL"
378 depends on VPL_DM
Simon Glassbc993e52022-10-20 18:23:13 -0600379 default y
380 select FIT_SIGNATURE
381 select VPL_FIT
382 select VPL_CRYPTO
383 select VPL_HASH
384 imply VPL_RSA
385 imply VPL_RSA_VERIFY
386 select VPL_IMAGE_SIGN_INFO
387 select VPL_FIT_FULL_CHECK
388
389config VPL_FIT_SIGNATURE_MAX_SIZE
390 hex "Max size of signed FIT structures in VPL"
391 depends on VPL_FIT_SIGNATURE
392 default 0x10000000
393 help
394 This option sets a max size in bytes for verified FIT uImages.
395 A sane value of 256MB protects corrupted DTB structures from overlapping
396 device memory. Assure this size does not extend past expected storage
397 space.
398
399endif # VPL
400
Simon Glass2289ca92023-09-14 10:55:52 -0600401endif # FIT
402
John Keeping9b60a172022-07-28 11:19:15 +0100403config PXE_UTILS
404 bool
405 select MENU
406 help
407 Utilities for parsing PXE file formats.
408
Tom Rini984bfdc2023-10-26 14:31:24 -0400409config BOOT_DEFAULTS_FEATURES
410 bool
411 select SUPPORT_RAW_INITRD
412 select ENV_VARS_UBOOT_CONFIG
413 imply USB_STORAGE
414 imply EFI_PARTITION
415 imply ISO_PARTITION
416
417config BOOT_DEFAULTS_CMDS
418 bool
Simon Glass054d0182023-03-24 16:58:13 -0400419 imply USE_BOOTCOMMAND
420 select CMD_ENV_EXISTS
421 select CMD_EXT2
422 select CMD_EXT4
423 select CMD_FAT
424 select CMD_FS_GENERIC
425 select CMD_PART if PARTITIONS
426 select CMD_DHCP if CMD_NET
427 select CMD_PING if CMD_NET
428 select CMD_PXE if CMD_NET
Simon Glass054d0182023-03-24 16:58:13 -0400429 select CMD_BOOTI if ARM64
430 select CMD_BOOTZ if ARM && !ARM64
431 imply CMD_MII if NET
Tom Rini984bfdc2023-10-26 14:31:24 -0400432
433config BOOT_DEFAULTS
434 bool # Common defaults for standard boot and distroboot
435 select BOOT_DEFAULTS_FEATURES
436 select BOOT_DEFAULTS_CMDS if CMDLINE
Simon Glass054d0182023-03-24 16:58:13 -0400437 help
438 These are not required but are commonly needed to support a good
439 selection of booting methods. Enable this to improve the capability
440 of U-Boot to boot various images. Currently much functionality is
441 tied to enabling the command that exercises it.
442
Simon Glass6cfb0022023-09-14 10:55:53 -0600443menuconfig BOOTSTD
444 bool "Standard boot"
Simon Glass08ad13e2022-04-24 23:31:06 -0600445 default y
446 depends on DM && OF_CONTROL && BLK
447 help
448 U-Boot supports a standard way of locating something to boot,
449 typically an Operating System such as Linux, provided by a distro such
450 as Arch Linux or Debian. Enable this to support iterating through
451 available bootdevs and using bootmeths to find bootflows suitable for
452 booting.
453
454 Standard boot is not a standard way of booting, just a framework
455 within U-Boot for supporting all the different ways that exist.
456
457 Terminology:
458
459 - bootdev - a device which can hold a distro (e.g. MMC)
460 - bootmeth - a method to scan a bootdev to find bootflows (owned by
461 U-Boot)
462 - bootflow - a description of how to boot (owned by the distro)
463
Simon Glass6cfb0022023-09-14 10:55:53 -0600464if BOOTSTD
465
Simon Glassbc993e52022-10-20 18:23:13 -0600466config SPL_BOOTSTD
Simon Glass4aa874f2023-02-22 09:33:58 -0700467 bool "Standard boot support in SPL"
Simon Glassbc993e52022-10-20 18:23:13 -0600468 depends on SPL && SPL_DM && SPL_OF_CONTROL && SPL_BLK
469 default y if VPL
470 help
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200471 This enables standard boot in SPL. This is needed so that VBE
Simon Glassbc993e52022-10-20 18:23:13 -0600472 (Verified Boot for Embedded) can be used, since it depends on standard
473 boot. It is enabled by default since the main purpose of VPL is to
474 handle the firmware part of VBE.
475
476config VPL_BOOTSTD
477 bool "Standard boot support in VPL"
478 depends on VPL && VPL_DM && VPL_OF_CONTROL && VPL_BLK
479 default y
480 help
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200481 This enables standard boot in SPL. This is needed so that VBE
Simon Glassbc993e52022-10-20 18:23:13 -0600482 (Verified Boot for Embedded) can be used, since it depends on standard
483 boot. It is enabled by default since the main purpose of VPL is to
484 handle the firmware part of VBE.
485
Simon Glass78c79dd2023-02-22 14:06:23 -0700486config BOOTSTD_FULL
487 bool "Enhanced features for standard boot"
488 default y if SANDBOX
Shantur Rathore19b54342023-12-23 06:51:59 +0000489 imply BOOTSTD_DEFAULTS
Simon Glass78c79dd2023-02-22 14:06:23 -0700490 help
491 This enables various useful features for standard boot, which are not
492 essential for operation:
493
494 - bootdev, bootmeth commands
495 - extra features in the bootflow command
496 - support for selecting the ordering of bootmeths ("bootmeth order")
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200497 - support for selecting the ordering of bootdevs using the Device Tree
Simon Glass78c79dd2023-02-22 14:06:23 -0700498 as well as the "boot_targets" environment variable
499
Simon Glass2e5161eb2023-01-28 15:00:21 -0700500config BOOTSTD_DEFAULTS
501 bool "Select some common defaults for standard boot"
502 depends on BOOTSTD
Simon Glass054d0182023-03-24 16:58:13 -0400503 select BOOT_DEFAULTS
Simon Glassdb92e782023-05-10 16:34:47 -0600504 select BOOTMETH_DISTRO
Simon Glass2e5161eb2023-01-28 15:00:21 -0700505 help
506 These are not required but are commonly needed to support a good
507 selection of booting methods. Enable this to improve the capability
508 of U-Boot to boot various images.
509
Simon Glassbe661cb2022-04-24 23:31:27 -0600510config BOOTSTD_BOOTCOMMAND
511 bool "Use bootstd to boot"
512 default y if !DISTRO_DEFAULTS
513 help
514 Enable this to select a default boot-command suitable for booting
515 with standard boot. This can be overridden by the board if needed,
516 but the default command should be enough for most boards which use
517 standard boot.
518
519 For now this is only selected if distro boot is NOT used, since
520 standard boot does not support all of the features of distro boot
521 yet.
522
Marek Vasutabb772a2024-10-20 17:43:12 +0200523config BOOTSTD_MENU
524 bool "Provide a menu of available bootflows for standard boot"
525 depends on BOOTSTD_FULL && EXPO
526 default y
527 help
528 Provide a menu of available bootflows and related options.
529
Simon Glass92368522023-11-18 14:05:19 -0700530config BOOTSTD_PROG
531 bool "Use programmatic boot"
532 depends on !CMDLINE
533 default y
534 help
535 Enable this to provide a board_run_command() function which can boot
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200536 a system without using commands. If the boot fails, then U-Boot will
Simon Glass92368522023-11-18 14:05:19 -0700537 panic.
538
539 Note: This currently has many limitations and is not a useful booting
540 solution. Future work will eventually make this a viable option.
541
Simon Glass4f8633d2022-07-30 15:52:21 -0600542config BOOTMETH_GLOBAL
543 bool
544 help
545 Add support for global bootmeths. This feature is used by VBE and
546 EFI bootmgr, since they take full control over which bootdevs are
547 selected to boot.
548
Mattijs Korpershoekb30baa92024-07-10 10:40:05 +0200549config BOOTMETH_ANDROID
550 bool "Bootdev support for Android"
551 depends on X86 || ARM || SANDBOX
552 depends on CMDLINE
Mattijs Korpershoekb30baa92024-07-10 10:40:05 +0200553 select ANDROID_BOOT_IMAGE
554 select CMD_BCB
Jerome Forissiere0f95512024-10-16 12:03:59 +0200555 imply CMD_FASTBOOT
556 imply FASTBOOT if !NET_LWIP
Mattijs Korpershoekb30baa92024-07-10 10:40:05 +0200557 select PARTITION_TYPE_GUID
558 select PARTITION_UUIDS
559 help
560 Enables support for booting Android using bootstd. Android requires
561 multiple partitions (misc, boot, vbmeta, ...) in storage for booting.
562
563 Note that only MMC bootdevs are supported at present. This is caused
564 by AVB being limited to MMC devices only.
565
Simon Glassd74e62a2023-07-12 09:04:45 -0600566config BOOTMETH_CROS
567 bool "Bootdev support for Chromium OS"
Simon Glass18700262023-07-30 11:17:02 -0600568 depends on X86 || ARM || SANDBOX
569 default y if !ARM
Simon Glassd7d3a972023-08-24 13:55:45 -0600570 select EFI_PARTITION
571 select PARTITION_TYPE_GUID
572 select PARTITION_UUIDS
Simon Glassd74e62a2023-07-12 09:04:45 -0600573 help
574 Enables support for booting Chromium OS using bootdevs. This uses the
575 kernel A slot and obtains the kernel command line from the parameters
576 provided there.
577
578 Note that only x86 devices are supported at present.
579
Simon Glassb71d7f72023-05-10 16:34:46 -0600580config BOOTMETH_EXTLINUX
581 bool "Bootdev support for extlinux boot"
John Keeping9b60a172022-07-28 11:19:15 +0100582 select PXE_UTILS
Simon Glassad8ec372022-04-24 23:31:13 -0600583 default y
584 help
Simon Glassb71d7f72023-05-10 16:34:46 -0600585 Enables support for extlinux boot using bootdevs. This makes the
Simon Glassad8ec372022-04-24 23:31:13 -0600586 bootdevs look for a 'extlinux/extlinux.conf' on each filesystem
587 they scan.
588
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200589 The specification for this file is here:
Simon Glassb71d7f72023-05-10 16:34:46 -0600590
591 https://uapi-group.org/specifications/specs/boot_loader_specification/
592
Simon Glassad8ec372022-04-24 23:31:13 -0600593 This provides a way to try out standard boot on an existing boot flow.
594
Simon Glassb71d7f72023-05-10 16:34:46 -0600595config BOOTMETH_EXTLINUX_PXE
596 bool "Bootdev support for extlinux boot over network"
Simon Glass83144612022-04-24 23:31:16 -0600597 depends on CMD_PXE && CMD_NET && DM_ETH
598 default y
599 help
Simon Glassb71d7f72023-05-10 16:34:46 -0600600 Enables support for extlinux boot using bootdevs. This makes the
Simon Glass83144612022-04-24 23:31:16 -0600601 bootdevs look for a 'extlinux/extlinux.conf' on the tftp server.
602
Simon Glassb71d7f72023-05-10 16:34:46 -0600603 The specification for this file is here:
604
605 https://uapi-group.org/specifications/specs/boot_loader_specification/
606
Simon Glass83144612022-04-24 23:31:16 -0600607 This provides a way to try out standard boot on an existing boot flow.
608
Simon Glass66f62552022-04-24 23:31:17 -0600609config BOOTMETH_EFILOADER
610 bool "Bootdev support for EFI boot"
AKASHI Takahiro9b08b9a2024-01-17 13:39:41 +0900611 depends on EFI_BINARY_EXEC
Jerome Forissiere0f95512024-10-16 12:03:59 +0200612 imply CMD_TFTPBOOT if CMD_NET
Simon Glass66f62552022-04-24 23:31:17 -0600613 default y
614 help
615 Enables support for EFI boot using bootdevs. This makes the
616 bootdevs look for a 'boot<arch>.efi' on each filesystem
617 they scan. The resulting file is booted after enabling U-Boot's
618 EFI loader support.
619
620 The <arch> depends on the architecture of the board:
621
622 aa64 - aarch64 (ARM 64-bit)
623 arm - ARM 32-bit
624 ia32 - x86 32-bit
625 x64 - x86 64-bit
626 riscv32 - RISC-V 32-bit
627 riscv64 - RISC-V 64-bit
628
629 This provides a way to try out standard boot on an existing boot flow.
630
Heinrich Schuchardt72bca1a2024-04-03 20:05:17 +0200631config BOOTMETH_EFI_BOOTMGR
632 bool "Bootdev support for EFI boot manager"
633 depends on EFI_BOOTMGR
634 select BOOTMETH_GLOBAL
635 default y
636 help
637 Enable booting via the UEFI boot manager. Based on the EFI variables
638 the EFI binary to be launched is determined. To set the EFI variables
639 use the eficonfig command.
640
Heinrich Schuchardt1cd3ec92024-07-16 10:35:34 +0200641config BOOTMETH_QFW
642 bool "Boot method using QEMU parameters"
643 depends on QFW
644 default y
645 help
646 Use QEMU parameters -kernel, -initrd, -append to determine the kernel,
647 initial RAM disk, and kernel command line parameters to boot an
648 operating system. U-Boot's control device-tree is passed to the kernel.
649
Simon Glass0a9f4262022-07-30 15:52:32 -0600650config BOOTMETH_VBE
651 bool "Bootdev support for Verified Boot for Embedded"
652 depends on FIT
653 default y
654 select BOOTMETH_GLOBAL
Tom Rini7d3684a2023-01-16 15:46:49 -0500655 select EVENT
Simon Glass0a9f4262022-07-30 15:52:32 -0600656 help
657 Enables support for VBE boot. This is a standard boot method which
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200658 supports selection of various firmware components, selection of an OS to
Simon Glass0a9f4262022-07-30 15:52:32 -0600659 boot as well as updating these using fwupd.
660
Simon Glassdb92e782023-05-10 16:34:47 -0600661config BOOTMETH_DISTRO
662 bool # Options needed to boot any distro
Tom Rini9bf470a2023-10-26 14:31:27 -0400663 select BOOTMETH_SCRIPT if CMDLINE # E.g. Armbian uses scripts
Simon Glassdb92e782023-05-10 16:34:47 -0600664 select BOOTMETH_EXTLINUX # E.g. Debian uses these
665 select BOOTMETH_EXTLINUX_PXE if CMD_PXE && CMD_NET && DM_ETH
AKASHI Takahiro9b08b9a2024-01-17 13:39:41 +0900666 select BOOTMETH_EFILOADER if EFI_BINARY_EXEC # E.g. Ubuntu uses this
Simon Glassdb92e782023-05-10 16:34:47 -0600667
Simon Glassbc993e52022-10-20 18:23:13 -0600668config SPL_BOOTMETH_VBE
669 bool "Bootdev support for Verified Boot for Embedded (SPL)"
670 depends on SPL && FIT
Tom Rini7d3684a2023-01-16 15:46:49 -0500671 select EVENT
Simon Glassbc993e52022-10-20 18:23:13 -0600672 default y if VPL
673 help
674 Enables support for VBE boot. This is a standard boot method which
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200675 supports selection of various firmware components, selection of an OS to
Simon Glassbc993e52022-10-20 18:23:13 -0600676 boot as well as updating these using fwupd.
677
678config VPL_BOOTMETH_VBE
679 bool "Bootdev support for Verified Boot for Embedded (VPL)"
680 depends on VPL && FIT
Tom Rini7d3684a2023-01-16 15:46:49 -0500681 select EVENT
Simon Glassbc993e52022-10-20 18:23:13 -0600682 default y
683 help
684 Enables support for VBE boot. This is a standard boot method which
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200685 supports selection of various firmware components, selection of an OS to
Simon Glassbc993e52022-10-20 18:23:13 -0600686 boot as well as updating these using fwupd.
687
Simon Glassdf49cd02024-12-07 10:24:09 -0700688config TPL_BOOTMETH_VBE
689 bool "Bootdev support for Verified Boot for Embedded (TPL)"
690 depends on TPL
691 default y
692 help
693 Enables support for VBE boot. This is a standard boot method which
694 supports selection of various firmware components, seleciton of an OS to
695 boot as well as updating these using fwupd.
696
Simon Glassd0af04c2022-07-30 15:52:33 -0600697if BOOTMETH_VBE
698
Simon Glass513eeed2023-02-22 09:33:52 -0700699config BOOTMETH_VBE_REQUEST
700 bool "Support for serving VBE OS requests"
701 default y
702 help
703 Enables support for looking that the requests made by the
704 Operating System being booted. These requests result in additions to
705 the device tree /chosen node, added during the device tree fixup
706 phase.
707
708config SPL_BOOTMETH_VBE_REQUEST
709 bool "Support for serving VBE OS requests (SPL)"
710 depends on SPL
711 help
712 Enables support for looking that the requests made by the
713 Operating System being booted. These requests result in additions to
714 the device tree /chosen node, added during the device tree fixup
715 phase.
716
717 This is only useful if you are booting an OS direct from SPL.
718
Simon Glassd0af04c2022-07-30 15:52:33 -0600719config BOOTMETH_VBE_SIMPLE
720 bool "Bootdev support for VBE 'simple' method"
721 default y
Simon Glasseff4b7d2024-12-07 10:24:11 -0700722 imply SPL_CRC8 if SPL
723 imply VPL_CRC8 if VPL
Simon Glassd0af04c2022-07-30 15:52:33 -0600724 help
725 Enables support for VBE 'simple' boot. This allows updating a single
726 firmware image in boot media such as MMC. It does not support any sort
727 of rollback, recovery or A/B boot.
728
Simon Glassbc993e52022-10-20 18:23:13 -0600729config BOOTMETH_VBE_SIMPLE_OS
730 bool "Bootdev support for VBE 'simple' method OS phase"
731 default y
732 help
733 Enables support for the OS parts of VBE 'simple' boot. This includes
734 fixing up the device tree with the required VBE information, ready
735 for booting into the OS. This option is only enabled for U-Boot
736 proper, since it is the phase where device tree fixups happen.
737
738config SPL_BOOTMETH_VBE_SIMPLE
739 bool "Bootdev support for VBE 'simple' method (SPL)"
740 depends on SPL
741 default y if VPL
742 help
743 Enables support for VBE 'simple' boot. This allows updating a single
744 firmware image in boot media such as MMC. It does not support any sort
745 of rollback, recovery or A/B boot.
746
747config VPL_BOOTMETH_VBE_SIMPLE
748 bool "Bootdev support for VBE 'simple' method (VPL)"
749 depends on VPL
750 default y
751 help
752 Enables support for VBE 'simple' boot. This allows updating a single
753 firmware image in boot media such as MMC. It does not support any sort
754 of rollback, recovery or A/B boot.
755
756config SPL_BOOTMETH_VBE_SIMPLE_FW
757 bool "Bootdev support for VBE 'simple' method firmware phase (SPL)"
758 depends on VPL
759 default y
760 help
761 Enables support for the firmware parts of VBE 'simple' boot. This
762 includes an SPL loader which locates the correct U-Boot to boot into.
763 This option should really only be enabled for VPL, since it is the
764 phase where the SPL + U-Boot decision should be made. But for now,
765 SPL does its own FIT-configuration selection.
766
767config VPL_BOOTMETH_VBE_SIMPLE_FW
768 bool "Bootdev support for VBE 'simple' method firmware phase (VPL)"
769 depends on VPL
770 default y
771 help
772 Enables support for the firmware parts of VBE 'simple' boot. This
773 includes an SPL loader which locates the correct SPL to boot into.
774 This option enabled for VPL, since it is the phase where the SPL
775 decision is made.
776
Simon Glassdf49cd02024-12-07 10:24:09 -0700777config TPL_BOOTMETH_VBE_SIMPLE_FW
778 bool "Bootdev support for VBE 'simple' method firmware phase (TPL)"
779 depends on VPL
780 default y
781 help
782 Enables support for the firmware parts of VBE 'simple' boot, in TPL.
783 TPL loads a FIT containing the VPL binary and a suitable devicetree.
784
785endif # BOOTMETH_VBE_SIMPLE
Simon Glassd0af04c2022-07-30 15:52:33 -0600786
Simon Glassd8adbe92023-01-06 08:52:36 -0600787config EXPO
788 bool "Support for expos - groups of scenes displaying a UI"
Simon Glass389a4582023-01-28 15:00:18 -0700789 depends on VIDEO
Simon Glassd8adbe92023-01-06 08:52:36 -0600790 default y if BOOTMETH_VBE
791 help
792 An expo is a way of presenting and collecting information from the
793 user. It consists of a collection of 'scenes' of which only one is
794 presented at a time. An expo is typically used to show a boot menu
795 and allow settings to be changed.
796
797 The expo can be presented in graphics form using a vidconsole, or in
798 text form on a serial console.
799
Simon Glass423994e2022-04-24 23:31:20 -0600800config BOOTMETH_SANDBOX
801 def_bool y
802 depends on SANDBOX
803 help
804 This is a sandbox bootmeth driver used for testing. It always returns
805 -ENOTSUPP when attempting to boot.
806
Simon Glass7e03e742022-04-24 23:31:22 -0600807config BOOTMETH_SCRIPT
808 bool "Bootdev support for U-Boot scripts"
809 default y if BOOTSTD_FULL
Tom Rini9bf470a2023-10-26 14:31:27 -0400810 depends on CMDLINE
Simon Glassb4b7ebe2023-05-05 20:03:05 -0600811 select HUSH_PARSER
Simon Glass7e03e742022-04-24 23:31:22 -0600812 help
813 Enables support for booting a distro via a U-Boot script. This makes
814 the bootdevs look for a 'boot/boot.scr' file which can be used to
815 boot the distro.
816
817 This provides a way to try out standard boot on an existing boot flow.
818 It is not enabled by default to save space.
819
Simon Glass77459f42024-08-07 16:47:27 -0600820config UPL
821 bool "upl - Universal Payload Specification"
Simon Glass3a028c22024-08-07 16:47:30 -0600822 imply CMD_UPL
Simon Glass77459f42024-08-07 16:47:27 -0600823 imply UPL_READ
Simon Glassb9474a82024-08-07 16:47:28 -0600824 imply UPL_WRITE
Simon Glassbc3ec002024-08-07 16:47:31 -0600825 imply SPL_UPL if SPL
Simon Glass77459f42024-08-07 16:47:27 -0600826 help
827 Provides support for UPL payloads and handoff information. U-Boot
828 supports generating and accepting handoff information. The mkimage
829 tool will eventually support creating payloads.
830
831if UPL
832
833config UPL_READ
834 bool "upl - Support reading a Universal Payload handoff"
835 help
836 Provides support for decoding a UPL-format payload into a C structure
837 which can be used elsewhere in U-Boot. This is just the reading
Simon Glass45aec8e2024-08-07 16:47:34 -0600838 implementation, useful for trying it out. See UPL_IN for how
839 to tell U-Boot to actually read it on startup and use it for memory
840 and device information, etc.
Simon Glass77459f42024-08-07 16:47:27 -0600841
Simon Glassb9474a82024-08-07 16:47:28 -0600842config UPL_WRITE
843 bool "upl - Support writing a Universal Payload handoff"
844 help
845 Provides support for encoding a UPL-format payload from a C structure
846 so it can be passed to another program. This is just the writing
Simon Glassbc3ec002024-08-07 16:47:31 -0600847 implementation, useful for trying it out. See SPL_UPL_OUT
848 for how to tell U-Boot SPL to actually write it before jumping to
849 the next phase.
850
Simon Glass45aec8e2024-08-07 16:47:34 -0600851config UPL_IN
852 bool "upl - Read the UPL handoff on startup"
853 select UPL_READ
854 help
855 Read an SPL handoff when U-Boot starts and use it to provide
856 devices, memory layout, etc. required by U-Boot. This allows U-Boot
857 to function as a payload in the meaning of the specification.
858
Simon Glassbc3ec002024-08-07 16:47:31 -0600859if SPL
860
861config SPL_UPL
862 bool "Write a UPL handoff in SPL"
863 imply SPL_UPL_OUT
864 help
865 This tells SPL to write a UPL handoff and pass it to the next phase
866 (e.g. to U-Boot or another program which SPL loads and runs). THis
867 provides information to help that program run correctly and
868 efficiently on the machine.
869
870config SPL_UPL_WRITE
871 bool # upl - Support writing a Universal Payload handoff in SPL
872 select SPL_BLOBLIST
873 help
874 Provides support for encoding a UPL-format payload from a C structure
875 so it can be passed to another program. This is just the writing
Simon Glassb9474a82024-08-07 16:47:28 -0600876 implementation, useful for trying it out.
877
Simon Glassbc3ec002024-08-07 16:47:31 -0600878config SPL_UPL_OUT
879 bool "upl - Support writing a Universal Payload handoff in SPL"
880 select SPL_UPL_WRITE
881 help
882 Provides support for encoding a UPL-format payload and passing it to
883 the next firmware phase. This allows U-Boot SPL to function as
884 Platform Init in the meaning of the specification.
885
886endif # SPL
887
Simon Glass77459f42024-08-07 16:47:27 -0600888endif # UPL
889
Simon Glass6cfb0022023-09-14 10:55:53 -0600890endif # BOOTSTD
Simon Glassad8ec372022-04-24 23:31:13 -0600891
Simon Glassb45b1632020-09-10 20:21:13 -0600892config LEGACY_IMAGE_FORMAT
893 bool "Enable support for the legacy image format"
Andrew Davis98a22d02022-05-04 15:52:27 -0500894 default y if !FIT_SIGNATURE && !TI_SECURE_DEVICE
Simon Glassb45b1632020-09-10 20:21:13 -0600895 help
896 This option enables the legacy image format. It is enabled by
897 default for backward compatibility, unless FIT_SIGNATURE is
898 set where it is disabled so that unsigned images cannot be
899 loaded. If a board needs the legacy image format support in this
900 case, enable it here.
901
Eddie James32401ba2023-10-24 10:43:50 -0500902config MEASURED_BOOT
903 bool "Measure boot images and configuration when booting without EFI"
904 depends on HASH && TPM_V2
Ilias Apalodimas1e665f92024-06-23 14:48:18 +0300905 select SHA1
906 select SHA256
907 select SHA384
908 select SHA512
Eddie James32401ba2023-10-24 10:43:50 -0500909 help
910 This option enables measurement of the boot process when booting
911 without UEFI . Measurement involves creating cryptographic hashes
912 of the binary images that are booting and storing them in the TPM.
913 In addition, a log of these hashes is stored in memory for the OS
914 to verify the booted images and configuration. Enable this if the
915 OS has configured some memory area for the event log and you intend
916 to use some attestation tools on your system.
917
918if MEASURED_BOOT
919 config MEASURE_DEVICETREE
920 bool "Measure the devicetree image"
921 default y if MEASURED_BOOT
922 help
Quentin Schulzc0a7ae02024-06-12 16:58:47 +0200923 On some platforms, the Device Tree is not static as it may contain
Eddie James32401ba2023-10-24 10:43:50 -0500924 random MAC addresses or other such data that changes each boot.
925 Therefore, it should not be measured into the TPM. In that case,
926 disable the measurement here.
927
928 config MEASURE_IGNORE_LOG
929 bool "Ignore the existing event log"
Eddie James32401ba2023-10-24 10:43:50 -0500930 help
931 On platforms that use an event log memory region that persists
932 through system resets and are the first stage bootloader, then
933 this option should be enabled to ignore any existing data in the
934 event log memory region.
935endif # MEASURED_BOOT
936
Tom Riniec8d1602023-10-26 14:31:25 -0400937config SYS_BOOTM_LEN
938 hex "Maximum size of a decompresed OS image"
Tom Rini793921e2024-04-18 08:29:35 -0600939 depends on CMD_BOOTM || CMD_BOOTI || CMD_BOOTZ || \
Tom Riniec8d1602023-10-26 14:31:25 -0400940 LEGACY_IMAGE_FORMAT || SPL_LEGACY_IMAGE_FORMAT
941 default 0x4000000 if PPC || ARM64
942 default 0x1000000 if X86 || ARCH_MX6 || ARCH_MX7
943 default 0x800000
944 help
945 This is the maximum size of the buffer that is used to decompress the OS
946 image in to if attempting to boot a compressed image.
947
Simon Glassf11d6132020-09-10 20:21:19 -0600948config SUPPORT_RAW_INITRD
949 bool "Enable raw initrd images"
950 help
951 Note, defining the SUPPORT_RAW_INITRD allows user to supply
952 kernel with raw initrd images. The syntax is slightly different, the
953 address of the initrd must be augmented by it's size, in the following
954 format: "<initrd address>:<initrd size>".
955
Simon Glassd81f07f2020-11-04 09:57:35 -0700956config CHROMEOS
957 bool "Support booting Chrome OS"
958 help
959 Chrome OS requires U-Boot to set up a table indicating the boot mode
960 (e.g. Developer mode) and a few other things. Enable this if you are
961 booting on a Chromebook to avoid getting an error about an invalid
962 firmware ID.
963
964config CHROMEOS_VBOOT
965 bool "Support Chrome OS verified boot"
966 help
967 This is intended to enable the full Chrome OS verified boot support
968 in U-Boot. It is not actually implemented in the U-Boot source code
969 at present, so this option is always set to 'n'. It allows
970 distinguishing between booting Chrome OS in a basic way (developer
971 mode) and a full boot.
972
Tom Rinieb4f2de2022-06-25 11:02:44 -0400973config SYS_RAMBOOT
974 bool
975
Tom Rini9ff815a2021-08-24 23:11:49 -0400976config RAMBOOT_PBL
977 bool "Freescale PBL(pre-boot loader) image format support"
Tom Rinieb4f2de2022-06-25 11:02:44 -0400978 select SYS_RAMBOOT if PPC
Tom Rini9ff815a2021-08-24 23:11:49 -0400979 help
980 Some SoCs use PBL to load RCW and/or pre-initialization instructions.
981 For more details refer to doc/README.pblimage
982
Tom Rini886e6e32022-03-23 17:20:03 -0400983choice
Tom Rini489f4022022-12-28 10:52:51 -0500984 prompt "Freescale PBL (or predecessor) load location"
Tom Rini886e6e32022-03-23 17:20:03 -0400985 depends on RAMBOOT_PBL || ((TARGET_P1010RDB_PA || TARGET_P1010RDB_PB \
986 || TARGET_P1020RDB_PC || TARGET_P1020RDB_PD || TARGET_P2020RDB) \
Pali Rohár6763ff82024-06-06 18:33:26 +0200987 && !CMD_NAND) || (TARGET_TURRIS_1X && SYS_MPC85XX_NO_RESETVEC)
Tom Rini886e6e32022-03-23 17:20:03 -0400988
989config SDCARD
Tom Rini489f4022022-12-28 10:52:51 -0500990 bool "Freescale PBL (or similar) is found on SD card"
Tom Rini886e6e32022-03-23 17:20:03 -0400991
992config SPIFLASH
Tom Rini489f4022022-12-28 10:52:51 -0500993 bool "Freescale PBL (or similar) is found on SPI flash"
994
995config NO_PBL
996 bool "Freescale PBL (or similar) is not used in this case"
Tom Rini886e6e32022-03-23 17:20:03 -0400997
998endchoice
999
Tom Rini5989fd42022-06-20 08:07:42 -04001000config FSL_FIXED_MMC_LOCATION
1001 bool "PBL MMC is at a fixed location"
1002 depends on SDCARD && !RAMBOOT_PBL
1003
1004config ESDHC_HC_BLK_ADDR
1005 def_bool y
1006 depends on FSL_FIXED_MMC_LOCATION && (ARCH_BSC9131 || ARCH_BSC9132 || ARCH_P1010)
1007 help
1008 In High Capacity SD Cards (> 2 GBytes), the 32-bit source address and
1009 code length of these soc specify the memory address in block address
1010 format. Block length is fixed to 512 bytes as per the SD High
1011 Capacity specification.
1012
Tom Rini9ff815a2021-08-24 23:11:49 -04001013config SYS_FSL_PBL_PBI
1014 string "PBI(pre-boot instructions) commands for the PBL image"
1015 depends on RAMBOOT_PBL
1016 help
1017 PBI commands can be used to configure SoC before it starts the execution.
1018 Please refer doc/README.pblimage for more details.
1019
1020config SYS_FSL_PBL_RCW
1021 string "Aadditional RCW (Power on reset configuration) for the PBL image"
1022 depends on RAMBOOT_PBL
1023 help
1024 Enables addition of RCW (Power on reset configuration) in built image.
1025 Please refer doc/README.pblimage for more details.
1026
Tom Rini94b4fec2022-06-25 11:02:46 -04001027config SYS_BOOT_RAMDISK_HIGH
1028 depends on CMD_BOOTM || CMD_BOOTI || CMD_BOOTZ
1029 depends on !(NIOS2 || SANDBOX || SH || XTENSA)
1030 def_bool y
Simon Glass65edcd32023-03-24 16:58:12 -04001031 select LMB
Tom Rini94b4fec2022-06-25 11:02:46 -04001032 help
1033 Enable initrd_high functionality. If defined then the initrd_high
1034 feature is enabled and the boot* ramdisk subcommand is enabled.
1035
Simon Glassb45b1632020-09-10 20:21:13 -06001036endmenu # Boot images
1037
Simon Glassf111bf72023-03-24 16:58:11 -04001038config DISTRO_DEFAULTS
Simon Glasse27d7df2023-09-14 10:55:55 -06001039 bool "(deprecated) Script-based booting of Linux distributions"
Tom Rini045245b2023-10-26 14:31:23 -04001040 select CMDLINE
Simon Glass054d0182023-03-24 16:58:13 -04001041 select BOOT_DEFAULTS
Simon Glassf111bf72023-03-24 16:58:11 -04001042 select AUTO_COMPLETE
1043 select CMDLINE_EDITING
Simon Glassf111bf72023-03-24 16:58:11 -04001044 select CMD_SYSBOOT
Simon Glassf111bf72023-03-24 16:58:11 -04001045 select HUSH_PARSER
Simon Glassf111bf72023-03-24 16:58:11 -04001046 select SYS_LONGHELP
Simon Glassf111bf72023-03-24 16:58:11 -04001047 help
Simon Glasse27d7df2023-09-14 10:55:55 -06001048 Note: These scripts have been replaced by Standard Boot. Do not use
1049 them on new boards. See 'Migrating from distro_boot' at
1050 doc/develop/bootstd.rst
1051
Simon Glassf111bf72023-03-24 16:58:11 -04001052 Select this to enable various options and commands which are suitable
1053 for building u-boot for booting general purpose Linux distributions.
1054
Simon Glassd02ddcf2020-09-10 20:21:14 -06001055menu "Boot timing"
1056
1057config BOOTSTAGE
1058 bool "Boot timing and reporting"
1059 help
1060 Enable recording of boot time while booting. To use it, insert
1061 calls to bootstage_mark() with a suitable BOOTSTAGE_ID from
1062 bootstage.h. Only a single entry is recorded for each ID. You can
1063 give the entry a name with bootstage_mark_name(). You can also
1064 record elapsed time in a particular stage using bootstage_start()
1065 before starting and bootstage_accum() when finished. Bootstage will
1066 add up all the accumulated time and report it.
1067
1068 Normally, IDs are defined in bootstage.h but a small number of
1069 additional 'user' IDs can be used by passing BOOTSTAGE_ID_ALLOC
1070 as the ID.
1071
1072 Calls to show_boot_progress() will also result in log entries but
1073 these will not have names.
1074
1075config SPL_BOOTSTAGE
1076 bool "Boot timing and reported in SPL"
Tom Rini0a83cc22022-06-10 23:03:09 -04001077 depends on BOOTSTAGE && SPL
Simon Glassd02ddcf2020-09-10 20:21:14 -06001078 help
1079 Enable recording of boot time in SPL. To make this visible to U-Boot
1080 proper, enable BOOTSTAGE_STASH as well. This will stash the timing
1081 information when SPL finishes and load it when U-Boot proper starts
1082 up.
1083
1084config TPL_BOOTSTAGE
1085 bool "Boot timing and reported in TPL"
Tom Rini36a4ca02022-06-08 08:24:39 -04001086 depends on BOOTSTAGE && TPL
Simon Glassd02ddcf2020-09-10 20:21:14 -06001087 help
1088 Enable recording of boot time in SPL. To make this visible to U-Boot
1089 proper, enable BOOTSTAGE_STASH as well. This will stash the timing
1090 information when TPL finishes and load it when U-Boot proper starts
1091 up.
1092
1093config BOOTSTAGE_REPORT
1094 bool "Display a detailed boot timing report before booting the OS"
1095 depends on BOOTSTAGE
1096 help
1097 Enable output of a boot time report just before the OS is booted.
1098 This shows how long it took U-Boot to go through each stage of the
1099 boot process. The report looks something like this:
1100
1101 Timer summary in microseconds:
1102 Mark Elapsed Stage
1103 0 0 reset
1104 3,575,678 3,575,678 board_init_f start
1105 3,575,695 17 arch_cpu_init A9
1106 3,575,777 82 arch_cpu_init done
1107 3,659,598 83,821 board_init_r start
1108 3,910,375 250,777 main_loop
1109 29,916,167 26,005,792 bootm_start
1110 30,361,327 445,160 start_kernel
1111
1112config BOOTSTAGE_RECORD_COUNT
1113 int "Number of boot stage records to store"
Simon Glass051ddfb2021-02-03 06:00:49 -07001114 depends on BOOTSTAGE
Simon Glassd02ddcf2020-09-10 20:21:14 -06001115 default 30
1116 help
1117 This is the size of the bootstage record list and is the maximum
1118 number of bootstage records that can be recorded.
1119
1120config SPL_BOOTSTAGE_RECORD_COUNT
1121 int "Number of boot stage records to store for SPL"
Simon Glass051ddfb2021-02-03 06:00:49 -07001122 depends on SPL_BOOTSTAGE
Simon Glassd02ddcf2020-09-10 20:21:14 -06001123 default 5
1124 help
1125 This is the size of the bootstage record list and is the maximum
1126 number of bootstage records that can be recorded.
1127
1128config TPL_BOOTSTAGE_RECORD_COUNT
1129 int "Number of boot stage records to store for TPL"
Simon Glass051ddfb2021-02-03 06:00:49 -07001130 depends on TPL_BOOTSTAGE
Simon Glassd02ddcf2020-09-10 20:21:14 -06001131 default 5
1132 help
1133 This is the size of the bootstage record list and is the maximum
1134 number of bootstage records that can be recorded.
1135
1136config BOOTSTAGE_FDT
1137 bool "Store boot timing information in the OS device tree"
1138 depends on BOOTSTAGE
1139 help
1140 Stash the bootstage information in the FDT. A root 'bootstage'
1141 node is created with each bootstage id as a child. Each child
1142 has a 'name' property and either 'mark' containing the
1143 mark time in microseconds, or 'accum' containing the
1144 accumulated time for that bootstage id in microseconds.
1145 For example:
1146
1147 bootstage {
1148 154 {
1149 name = "board_init_f";
1150 mark = <3575678>;
1151 };
1152 170 {
1153 name = "lcd";
1154 accum = <33482>;
1155 };
1156 };
1157
1158 Code in the Linux kernel can find this in /proc/devicetree.
1159
1160config BOOTSTAGE_STASH
1161 bool "Stash the boot timing information in memory before booting OS"
1162 depends on BOOTSTAGE
1163 help
1164 Some OSes do not support device tree. Bootstage can instead write
1165 the boot timing information in a binary format at a given address.
1166 This happens through a call to bootstage_stash(), typically in
1167 the CPU's cleanup_before_linux() function. You can use the
1168 'bootstage stash' and 'bootstage unstash' commands to do this on
1169 the command line.
1170
1171config BOOTSTAGE_STASH_ADDR
1172 hex "Address to stash boot timing information"
Tom Rinid78c9bd2024-07-15 12:42:00 +01001173 depends on BOOTSTAGE_STASH
1174 default 0xC3000000 if STM32MP13X || STM32MP15X
1175 default 0x87000000 if STM32MP25X
1176 default 0x0 if SANDBOX
Simon Glassd02ddcf2020-09-10 20:21:14 -06001177 help
1178 Provide an address which will not be overwritten by the OS when it
1179 starts, so that it can read this information when ready.
1180
1181config BOOTSTAGE_STASH_SIZE
1182 hex "Size of boot timing stash region"
Tom Rinid78c9bd2024-07-15 12:42:00 +01001183 depends on BOOTSTAGE_STASH
Simon Glassd02ddcf2020-09-10 20:21:14 -06001184 default 0x1000
1185 help
1186 This should be large enough to hold the bootstage stash. A value of
1187 4096 (4KiB) is normally plenty.
1188
1189config SHOW_BOOT_PROGRESS
1190 bool "Show boot progress in a board-specific manner"
1191 help
1192 Defining this option allows to add some board-specific code (calling
1193 a user-provided function show_boot_progress(int) that enables you to
1194 show the system's boot progress on some display (for example, some
1195 LEDs) on your board. At the moment, the following checkpoints are
1196 implemented:
1197
1198 Legacy uImage format:
1199
1200 Arg Where When
1201 1 common/cmd_bootm.c before attempting to boot an image
1202 -1 common/cmd_bootm.c Image header has bad magic number
1203 2 common/cmd_bootm.c Image header has correct magic number
1204 -2 common/cmd_bootm.c Image header has bad checksum
1205 3 common/cmd_bootm.c Image header has correct checksum
1206 -3 common/cmd_bootm.c Image data has bad checksum
1207 4 common/cmd_bootm.c Image data has correct checksum
1208 -4 common/cmd_bootm.c Image is for unsupported architecture
1209 5 common/cmd_bootm.c Architecture check OK
1210 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
1211 6 common/cmd_bootm.c Image Type check OK
1212 -6 common/cmd_bootm.c gunzip uncompression error
1213 -7 common/cmd_bootm.c Unimplemented compression type
1214 7 common/cmd_bootm.c Uncompression OK
1215 8 common/cmd_bootm.c No uncompress/copy overwrite error
1216 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
1217
1218 9 common/image.c Start initial ramdisk verification
1219 -10 common/image.c Ramdisk header has bad magic number
1220 -11 common/image.c Ramdisk header has bad checksum
1221 10 common/image.c Ramdisk header is OK
1222 -12 common/image.c Ramdisk data has bad checksum
1223 11 common/image.c Ramdisk data has correct checksum
1224 12 common/image.c Ramdisk verification complete, start loading
1225 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
1226 13 common/image.c Start multifile image verification
1227 14 common/image.c No initial ramdisk, no multifile, continue.
1228
1229 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
1230
1231 -30 arch/powerpc/lib/board.c Fatal error, hang the system
1232 -31 post/post.c POST test failed, detected by post_output_backlog()
1233 -32 post/post.c POST test failed, detected by post_run_single()
1234
1235 34 common/cmd_doc.c before loading a Image from a DOC device
1236 -35 common/cmd_doc.c Bad usage of "doc" command
1237 35 common/cmd_doc.c correct usage of "doc" command
1238 -36 common/cmd_doc.c No boot device
1239 36 common/cmd_doc.c correct boot device
1240 -37 common/cmd_doc.c Unknown Chip ID on boot device
1241 37 common/cmd_doc.c correct chip ID found, device available
1242 -38 common/cmd_doc.c Read Error on boot device
1243 38 common/cmd_doc.c reading Image header from DOC device OK
1244 -39 common/cmd_doc.c Image header has bad magic number
1245 39 common/cmd_doc.c Image header has correct magic number
1246 -40 common/cmd_doc.c Error reading Image from DOC device
1247 40 common/cmd_doc.c Image header has correct magic number
1248 41 common/cmd_ide.c before loading a Image from a IDE device
1249 -42 common/cmd_ide.c Bad usage of "ide" command
1250 42 common/cmd_ide.c correct usage of "ide" command
1251 -43 common/cmd_ide.c No boot device
1252 43 common/cmd_ide.c boot device found
1253 -44 common/cmd_ide.c Device not available
1254 44 common/cmd_ide.c Device available
1255 -45 common/cmd_ide.c wrong partition selected
1256 45 common/cmd_ide.c partition selected
1257 -46 common/cmd_ide.c Unknown partition table
1258 46 common/cmd_ide.c valid partition table found
1259 -47 common/cmd_ide.c Invalid partition type
1260 47 common/cmd_ide.c correct partition type
1261 -48 common/cmd_ide.c Error reading Image Header on boot device
1262 48 common/cmd_ide.c reading Image Header from IDE device OK
1263 -49 common/cmd_ide.c Image header has bad magic number
1264 49 common/cmd_ide.c Image header has correct magic number
1265 -50 common/cmd_ide.c Image header has bad checksum
1266 50 common/cmd_ide.c Image header has correct checksum
1267 -51 common/cmd_ide.c Error reading Image from IDE device
1268 51 common/cmd_ide.c reading Image from IDE device OK
1269 52 common/cmd_nand.c before loading a Image from a NAND device
1270 -53 common/cmd_nand.c Bad usage of "nand" command
1271 53 common/cmd_nand.c correct usage of "nand" command
1272 -54 common/cmd_nand.c No boot device
1273 54 common/cmd_nand.c boot device found
1274 -55 common/cmd_nand.c Unknown Chip ID on boot device
1275 55 common/cmd_nand.c correct chip ID found, device available
1276 -56 common/cmd_nand.c Error reading Image Header on boot device
1277 56 common/cmd_nand.c reading Image Header from NAND device OK
1278 -57 common/cmd_nand.c Image header has bad magic number
1279 57 common/cmd_nand.c Image header has correct magic number
1280 -58 common/cmd_nand.c Error reading Image from NAND device
1281 58 common/cmd_nand.c reading Image from NAND device OK
1282
1283 -60 common/env_common.c Environment has a bad CRC, using default
1284
1285 64 net/eth.c starting with Ethernet configuration.
1286 -64 net/eth.c no Ethernet found.
1287 65 net/eth.c Ethernet found.
1288
1289 -80 common/cmd_net.c usage wrong
1290 80 common/cmd_net.c before calling net_loop()
1291 -81 common/cmd_net.c some error in net_loop() occurred
1292 81 common/cmd_net.c net_loop() back without error
1293 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
1294 82 common/cmd_net.c trying automatic boot
1295 83 common/cmd_net.c running "source" command
1296 -83 common/cmd_net.c some error in automatic boot or "source" command
1297 84 common/cmd_net.c end without errors
1298
1299 FIT uImage format:
1300
1301 Arg Where When
1302 100 common/cmd_bootm.c Kernel FIT Image has correct format
1303 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
1304 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
1305 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
1306 102 common/cmd_bootm.c Kernel unit name specified
1307 -103 common/cmd_bootm.c Can't get kernel subimage node offset
1308 103 common/cmd_bootm.c Found configuration node
1309 104 common/cmd_bootm.c Got kernel subimage node offset
1310 -104 common/cmd_bootm.c Kernel subimage hash verification failed
1311 105 common/cmd_bootm.c Kernel subimage hash verification OK
1312 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
1313 106 common/cmd_bootm.c Architecture check OK
1314 -106 common/cmd_bootm.c Kernel subimage has wrong type
1315 107 common/cmd_bootm.c Kernel subimage type OK
1316 -107 common/cmd_bootm.c Can't get kernel subimage data/size
1317 108 common/cmd_bootm.c Got kernel subimage data/size
1318 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
1319 -109 common/cmd_bootm.c Can't get kernel subimage type
1320 -110 common/cmd_bootm.c Can't get kernel subimage comp
1321 -111 common/cmd_bootm.c Can't get kernel subimage os
1322 -112 common/cmd_bootm.c Can't get kernel subimage load address
1323 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
1324
1325 120 common/image.c Start initial ramdisk verification
1326 -120 common/image.c Ramdisk FIT image has incorrect format
1327 121 common/image.c Ramdisk FIT image has correct format
1328 122 common/image.c No ramdisk subimage unit name, using configuration
1329 -122 common/image.c Can't get configuration for ramdisk subimage
1330 123 common/image.c Ramdisk unit name specified
1331 -124 common/image.c Can't get ramdisk subimage node offset
1332 125 common/image.c Got ramdisk subimage node offset
1333 -125 common/image.c Ramdisk subimage hash verification failed
1334 126 common/image.c Ramdisk subimage hash verification OK
1335 -126 common/image.c Ramdisk subimage for unsupported architecture
1336 127 common/image.c Architecture check OK
1337 -127 common/image.c Can't get ramdisk subimage data/size
1338 128 common/image.c Got ramdisk subimage data/size
1339 129 common/image.c Can't get ramdisk load address
1340 -129 common/image.c Got ramdisk load address
1341
1342 -130 common/cmd_doc.c Incorrect FIT image format
1343 131 common/cmd_doc.c FIT image format OK
1344
1345 -140 common/cmd_ide.c Incorrect FIT image format
1346 141 common/cmd_ide.c FIT image format OK
1347
1348 -150 common/cmd_nand.c Incorrect FIT image format
1349 151 common/cmd_nand.c FIT image format OK
1350
Marek Vasut98154342021-10-23 03:06:03 +02001351config SPL_SHOW_BOOT_PROGRESS
Jan Kiszka5780edb2021-11-03 15:09:36 +01001352 bool "Show boot progress in a board-specific manner in SPL"
Marek Vasut98154342021-10-23 03:06:03 +02001353 depends on SPL
1354 help
1355 Defining this option allows to add some board-specific code (calling
1356 a user-provided function show_boot_progress(int) that enables you to
1357 show the system's boot progress on some display (for example, some
1358 LEDs) on your board. For details see SHOW_BOOT_PROGRESS.
1359
Simon Glassd02ddcf2020-09-10 20:21:14 -06001360endmenu
1361
Simon Glasseebed782020-09-10 20:21:15 -06001362menu "Boot media"
1363
1364config NOR_BOOT
1365 bool "Support for booting from NOR flash"
1366 depends on NOR
1367 help
1368 Enabling this will make a U-Boot binary that is capable of being
1369 booted via NOR. In this case we will enable certain pinmux early
1370 as the ROM only partially sets up pinmux. We also default to using
1371 NOR for environment.
1372
1373config NAND_BOOT
1374 bool "Support for booting from NAND flash"
Simon Glasseebed782020-09-10 20:21:15 -06001375 imply MTD_RAW_NAND
1376 help
1377 Enabling this will make a U-Boot binary that is capable of being
1378 booted via NAND flash. This is not a must, some SoCs need this,
1379 some not.
1380
1381config ONENAND_BOOT
1382 bool "Support for booting from ONENAND"
Simon Glasseebed782020-09-10 20:21:15 -06001383 imply MTD_RAW_NAND
1384 help
1385 Enabling this will make a U-Boot binary that is capable of being
1386 booted via ONENAND. This is not a must, some SoCs need this,
1387 some not.
1388
1389config QSPI_BOOT
1390 bool "Support for booting from QSPI flash"
Simon Glasseebed782020-09-10 20:21:15 -06001391 help
1392 Enabling this will make a U-Boot binary that is capable of being
1393 booted via QSPI flash. This is not a must, some SoCs need this,
1394 some not.
1395
1396config SATA_BOOT
1397 bool "Support for booting from SATA"
Simon Glasseebed782020-09-10 20:21:15 -06001398 help
1399 Enabling this will make a U-Boot binary that is capable of being
1400 booted via SATA. This is not a must, some SoCs need this,
1401 some not.
1402
1403config SD_BOOT
1404 bool "Support for booting from SD/EMMC"
Simon Glasseebed782020-09-10 20:21:15 -06001405 help
1406 Enabling this will make a U-Boot binary that is capable of being
1407 booted via SD/EMMC. This is not a must, some SoCs need this,
1408 some not.
1409
Tom Rinia43bf4e2021-12-11 14:55:50 -05001410config SD_BOOT_QSPI
1411 bool "Support for booting from SD/EMMC and enable QSPI"
1412 help
1413 Enabling this will make a U-Boot binary that is capable of being
1414 booted via SD/EMMC while enabling QSPI on the platform as well. This
1415 is not a must, some SoCs need this, some not.
1416
Simon Glasseebed782020-09-10 20:21:15 -06001417config SPI_BOOT
1418 bool "Support for booting from SPI flash"
Simon Glasseebed782020-09-10 20:21:15 -06001419 help
1420 Enabling this will make a U-Boot binary that is capable of being
1421 booted via SPI flash. This is not a must, some SoCs need this,
1422 some not.
1423
1424endmenu
1425
Simon Glasse9d54d72020-09-10 20:21:16 -06001426menu "Autoboot options"
1427
1428config AUTOBOOT
1429 bool "Autoboot"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001430 depends on CMDLINE
Simon Glasse9d54d72020-09-10 20:21:16 -06001431 default y
1432 help
1433 This enables the autoboot. See doc/README.autoboot for detail.
1434
Simon Glass7dee9dc2023-10-26 14:31:22 -04001435if AUTOBOOT
1436
Simon Glass1b6cbaa2020-09-10 20:21:17 -06001437config BOOTDELAY
1438 int "delay in seconds before automatically booting"
1439 default 2
Simon Glass1b6cbaa2020-09-10 20:21:17 -06001440 help
1441 Delay before automatically running bootcmd;
1442 set to 0 to autoboot with no delay, but you can stop it by key input.
1443 set to -1 to disable autoboot.
1444 set to -2 to autoboot with no delay and not check for abort
1445
1446 If this value is >= 0 then it is also used for the default delay
1447 before starting the default entry in bootmenu. If it is < 0 then
1448 a default value of 10s is used.
1449
1450 See doc/README.autoboot for details.
1451
Simon Glasse9d54d72020-09-10 20:21:16 -06001452config AUTOBOOT_KEYED
1453 bool "Stop autobooting via specific input key / string"
Simon Glasse9d54d72020-09-10 20:21:16 -06001454 help
1455 This option enables stopping (aborting) of the automatic
1456 boot feature only by issuing a specific input key or
1457 string. If not enabled, any input key will abort the
1458 U-Boot automatic booting process and bring the device
1459 to the U-Boot prompt for user input.
1460
Simon Glass7dee9dc2023-10-26 14:31:22 -04001461if AUTOBOOT_KEYED
1462
Steffen Jaeckeldfc97322021-07-08 15:57:38 +02001463config AUTOBOOT_FLUSH_STDIN
1464 bool "Enable flushing stdin before starting to read the password"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001465 depends on !SANDBOX
Steffen Jaeckeldfc97322021-07-08 15:57:38 +02001466 help
1467 When this option is enabled stdin buffer will be flushed before
1468 starting to read the password.
1469 This can't be enabled for the sandbox as flushing stdin would
1470 break the autoboot unit tests.
1471
Simon Glasse9d54d72020-09-10 20:21:16 -06001472config AUTOBOOT_PROMPT
1473 string "Autoboot stop prompt"
Simon Glasse9d54d72020-09-10 20:21:16 -06001474 default "Autoboot in %d seconds\\n"
1475 help
1476 This string is displayed before the boot delay selected by
1477 CONFIG_BOOTDELAY starts. If it is not defined there is no
1478 output indicating that autoboot is in progress.
1479
1480 Note that this define is used as the (only) argument to a
1481 printf() call, so it may contain '%' format specifications,
Quentin Schulzc0a7ae02024-06-12 16:58:47 +02001482 provided that it also includes, separated by commas exactly
Simon Glasse9d54d72020-09-10 20:21:16 -06001483 like in a printf statement, the required arguments. It is
1484 the responsibility of the user to select only such arguments
1485 that are valid in the given context.
1486
1487config AUTOBOOT_ENCRYPTION
1488 bool "Enable encryption in autoboot stopping"
Simon Glasse9d54d72020-09-10 20:21:16 -06001489 help
1490 This option allows a string to be entered into U-Boot to stop the
Steffen Jaeckel6aa6bfb2021-07-08 15:57:35 +02001491 autoboot.
1492 The behavior depends whether CONFIG_CRYPT_PW from lib is enabled
1493 or not.
1494 In case CONFIG_CRYPT_PW is enabled, the string will be forwarded
1495 to the crypt-based functionality and be compared against the
1496 string in the environment variable 'bootstopkeycrypt'.
1497 In case CONFIG_CRYPT_PW is disabled the string itself is hashed
1498 and compared against the hash in the environment variable
1499 'bootstopkeysha256'.
1500 If it matches in either case then boot stops and
1501 a command-line prompt is presented.
Simon Glasse9d54d72020-09-10 20:21:16 -06001502 This provides a way to ship a secure production device which can also
1503 be accessed at the U-Boot command line.
1504
Steffen Jaeckel28be70d2021-07-08 15:57:39 +02001505config AUTOBOOT_SHA256_FALLBACK
1506 bool "Allow fallback from crypt-hashed password to sha256"
1507 depends on AUTOBOOT_ENCRYPTION && CRYPT_PW
1508 help
1509 This option adds support to fall back from crypt-hashed
1510 passwords to checking a SHA256 hashed password in case the
1511 'bootstopusesha256' environment variable is set to 'true'.
1512
Simon Glasse9d54d72020-09-10 20:21:16 -06001513config AUTOBOOT_DELAY_STR
1514 string "Delay autobooting via specific input key / string"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001515 depends on !AUTOBOOT_ENCRYPTION
Simon Glasse9d54d72020-09-10 20:21:16 -06001516 help
1517 This option delays the automatic boot feature by issuing
1518 a specific input key or string. If CONFIG_AUTOBOOT_DELAY_STR
1519 or the environment variable "bootdelaykey" is specified
1520 and this string is received from console input before
1521 autoboot starts booting, U-Boot gives a command prompt. The
1522 U-Boot prompt will time out if CONFIG_BOOT_RETRY_TIME is
1523 used, otherwise it never times out.
1524
1525config AUTOBOOT_STOP_STR
1526 string "Stop autobooting via specific input key / string"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001527 depends on !AUTOBOOT_ENCRYPTION
Simon Glasse9d54d72020-09-10 20:21:16 -06001528 help
1529 This option enables stopping (aborting) of the automatic
1530 boot feature only by issuing a specific input key or
1531 string. If CONFIG_AUTOBOOT_STOP_STR or the environment
1532 variable "bootstopkey" is specified and this string is
1533 received from console input before autoboot starts booting,
1534 U-Boot gives a command prompt. The U-Boot prompt never
1535 times out, even if CONFIG_BOOT_RETRY_TIME is used.
1536
1537config AUTOBOOT_KEYED_CTRLC
1538 bool "Enable Ctrl-C autoboot interruption"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001539 depends on !AUTOBOOT_ENCRYPTION
Simon Glasse9d54d72020-09-10 20:21:16 -06001540 help
1541 This option allows for the boot sequence to be interrupted
1542 by ctrl-c, in addition to the "bootdelaykey" and "bootstopkey".
1543 Setting this variable provides an escape sequence from the
1544 limited "password" strings.
1545
Steffen Jaeckel792a13f2021-07-08 15:57:37 +02001546config AUTOBOOT_NEVER_TIMEOUT
1547 bool "Make the password entry never time-out"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001548 depends on AUTOBOOT_ENCRYPTION && CRYPT_PW
Steffen Jaeckel792a13f2021-07-08 15:57:37 +02001549 help
1550 This option removes the timeout from the password entry
1551 when the user first presses the <Enter> key before entering
1552 any other character.
1553
Steffen Jaeckel6aa6bfb2021-07-08 15:57:35 +02001554config AUTOBOOT_STOP_STR_ENABLE
1555 bool "Enable fixed string to stop autobooting"
Simon Glass7dee9dc2023-10-26 14:31:22 -04001556 depends on AUTOBOOT_ENCRYPTION
Steffen Jaeckel6aa6bfb2021-07-08 15:57:35 +02001557 help
1558 This option enables the feature to add a fixed stop
1559 string that is defined at compile time.
1560 In every case it will be tried to load the stop
1561 string from the environment.
1562 In case this is enabled and there is no stop string
1563 in the environment, this will be used as default value.
1564
1565config AUTOBOOT_STOP_STR_CRYPT
1566 string "Stop autobooting via crypt-hashed password"
1567 depends on AUTOBOOT_STOP_STR_ENABLE && CRYPT_PW
1568 help
1569 This option adds the feature to only stop the autobooting,
1570 and therefore boot into the U-Boot prompt, when the input
1571 string / password matches a values that is hashed via
1572 one of the supported crypt-style password hashing options
1573 and saved in the environment variable "bootstopkeycrypt".
1574
Simon Glasse9d54d72020-09-10 20:21:16 -06001575config AUTOBOOT_STOP_STR_SHA256
Steffen Jaeckele1788f92021-07-08 15:57:40 +02001576 string "Stop autobooting via SHA256 hashed password"
Steffen Jaeckel6aa6bfb2021-07-08 15:57:35 +02001577 depends on AUTOBOOT_STOP_STR_ENABLE
Simon Glasse9d54d72020-09-10 20:21:16 -06001578 help
1579 This option adds the feature to only stop the autobooting,
1580 and therefore boot into the U-Boot prompt, when the input
Quentin Schulzc0a7ae02024-06-12 16:58:47 +02001581 string / password matches a values that is encrypted via
Joel Peshkin8b7bf532020-11-21 17:18:59 -08001582 a SHA256 hash and saved in the environment variable
1583 "bootstopkeysha256". If the value in that variable
1584 includes a ":", the portion prior to the ":" will be treated
1585 as a salt value.
Simon Glasse9d54d72020-09-10 20:21:16 -06001586
Simon Glass7dee9dc2023-10-26 14:31:22 -04001587endif # AUTOBOOT_KEYED
1588
1589if !AUTOBOOT_KEYED
1590
Simon Glasse9d54d72020-09-10 20:21:16 -06001591config AUTOBOOT_USE_MENUKEY
1592 bool "Allow a specify key to run a menu from the environment"
Simon Glasse9d54d72020-09-10 20:21:16 -06001593 help
1594 If a specific key is pressed to stop autoboot, then the commands in
1595 the environment variable 'menucmd' are executed before boot starts.
1596
1597config AUTOBOOT_MENUKEY
1598 int "ASCII value of boot key to show a menu"
1599 default 0
1600 depends on AUTOBOOT_USE_MENUKEY
1601 help
1602 If this key is pressed to stop autoboot, then the commands in the
1603 environment variable 'menucmd' will be executed before boot starts.
1604 For example, 33 means "!" in ASCII, so pressing ! at boot would take
1605 this action.
1606
Simon Glass7dee9dc2023-10-26 14:31:22 -04001607endif
1608
1609endif # AUTOBOOT
1610
Simon Glasse9d54d72020-09-10 20:21:16 -06001611config AUTOBOOT_MENU_SHOW
1612 bool "Show a menu on boot"
1613 depends on CMD_BOOTMENU
1614 help
1615 This enables the boot menu, controlled by environment variables
1616 defined by the board. The menu starts after running the 'preboot'
1617 environmnent variable (if enabled) and before handling the boot delay.
Peter Robinson16e0b8f2023-08-18 15:54:10 +01001618 See doc/usage/cmd/bootmenu.rst for more details.
Simon Glasse9d54d72020-09-10 20:21:16 -06001619
Masahisa Kojima97cbcc42022-05-26 19:09:38 +09001620config BOOTMENU_DISABLE_UBOOT_CONSOLE
1621 bool "Disallow bootmenu to enter the U-Boot console"
1622 depends on AUTOBOOT_MENU_SHOW
1623 help
1624 If this option is enabled, user can not enter the U-Boot console from
1625 bootmenu. It increases the system security.
1626
Tom Rinia45a3ef2022-03-11 09:12:04 -05001627config BOOT_RETRY
1628 bool "Boot retry feature"
1629 help
1630 Allow for having the U-Boot command prompt time out and attempt
1631 to boot again. If the environment variable "bootretry" is found then
1632 its value is used, otherwise the retry timeout is
1633 CONFIG_BOOT_RETRY_TIME. CONFIG_BOOT_RETRY_MIN is optional and
1634 defaults to CONFIG_BOOT_RETRY_TIME. All times are in seconds.
1635
1636config BOOT_RETRY_TIME
1637 int "Timeout in seconds before attempting to boot again"
1638 depends on BOOT_RETRY
1639 help
1640 Time in seconds before the U-Boot prompt will timeout and boot will
1641 be attempted again.
1642
1643config BOOT_RETRY_MIN
1644 int "Minimum timeout in seconds for 'bootretry'"
1645 depends on BOOT_RETRY
1646 default BOOT_RETRY_TIME
1647 help
1648 The minimum time in seconds that "bootretry" can be set to.
1649
1650config RESET_TO_RETRY
1651 bool "Reset the board to retry autoboot"
1652 depends on BOOT_RETRY
1653 help
1654 After the countdown timed out, the board will be reset to restart
1655 again.
1656
Simon Glasse9d54d72020-09-10 20:21:16 -06001657endmenu
1658
Philippe Reynesd28484e2022-03-28 22:56:59 +02001659menu "Image support"
1660
1661config IMAGE_PRE_LOAD
1662 bool "Image pre-load support"
1663 help
1664 Enable an image pre-load stage in the SPL.
1665 This pre-load stage allows to do some manipulation
1666 or check (for example signature check) on an image
1667 before launching it.
1668
1669config SPL_IMAGE_PRE_LOAD
1670 bool "Image pre-load support within SPL"
1671 depends on SPL && IMAGE_PRE_LOAD
1672 help
1673 Enable an image pre-load stage in the SPL.
1674 This pre-load stage allows to do some manipulation
1675 or check (for example signature check) on an image
1676 before launching it.
1677
1678config IMAGE_PRE_LOAD_SIG
1679 bool "Image pre-load signature support"
1680 depends on IMAGE_PRE_LOAD
1681 select FIT_SIGNATURE
1682 select RSA
1683 select RSA_VERIFY_WITH_PKEY
1684 help
1685 Enable signature check support in the pre-load stage.
1686 For this feature a very simple header is added before
1687 the image with few fields:
1688 - a magic
1689 - the image size
1690 - the signature
1691 All other information (header size, type of signature,
1692 ...) are provided in the node /image/pre-load/sig of
1693 u-boot.
1694
1695config SPL_IMAGE_PRE_LOAD_SIG
1696 bool "Image pre-load signature support witin SPL"
1697 depends on SPL_IMAGE_PRE_LOAD && IMAGE_PRE_LOAD_SIG
1698 select SPL_FIT_SIGNATURE
1699 select SPL_RSA
1700 select SPL_RSA_VERIFY_WITH_PKEY
1701 help
1702 Enable signature check support in the pre-load stage in the SPL.
1703 For this feature a very simple header is added before
1704 the image with few fields:
1705 - a magic
1706 - the image size
1707 - the signature
1708 All other information (header size, type of signature,
1709 ...) are provided in the node /image/pre-load/sig of
1710 u-boot.
1711
1712endmenu
1713
Simon Glass27367192023-09-14 10:55:46 -06001714if OF_LIBFDT
1715
1716menu "Devicetree fixup"
1717
Matthias Schiffere908fec2023-12-11 12:03:17 +01001718config OF_ENV_SETUP
1719 bool "Run a command from environment to set up device tree before boot"
1720 depends on CMD_FDT
1721 help
1722 This causes U-Boot to run a command from the environment variable
1723 fdt_fixup before booting into the operating system, which can use the
1724 fdt command to modify the device tree. The device tree is then passed
1725 to the OS.
1726
Simon Glass48e6d3d2023-09-14 10:55:47 -06001727config OF_BOARD_SETUP
1728 bool "Set up board-specific details in device tree before boot"
1729 help
1730 This causes U-Boot to call ft_board_setup() before booting into
1731 the Operating System. This function can set up various
1732 board-specific information in the device tree for use by the OS.
1733 The device tree is then passed to the OS.
1734
1735config OF_SYSTEM_SETUP
1736 bool "Set up system-specific details in device tree before boot"
1737 help
1738 This causes U-Boot to call ft_system_setup() before booting into
1739 the Operating System. This function can set up various
1740 system-specific information in the device tree for use by the OS.
1741 The device tree is then passed to the OS.
1742
1743config OF_STDOUT_VIA_ALIAS
1744 bool "Update the device-tree stdout alias from U-Boot"
1745 help
1746 This uses U-Boot's serial alias from the aliases node to update
1747 the device tree passed to the OS. The "linux,stdout-path" property
1748 in the chosen node is set to point to the correct serial node.
1749 This option currently references CONFIG_CONS_INDEX, which is
1750 incorrect when used with device tree as this option does not
1751 exist / should not be used.
1752
Simon Glassb7b7f162023-09-14 10:55:57 -06001753config FDT_FIXUP_PARTITIONS
Simon Glass1a5bcc12023-09-14 10:55:58 -06001754 bool "Overwrite MTD partitions in DTS through defined in 'mtdparts'"
Simon Glassb7b7f162023-09-14 10:55:57 -06001755 help
1756 Allow overwriting defined partitions in the device tree blob
1757 using partition info defined in the 'mtdparts' environment
1758 variable.
1759
Simon Glass27367192023-09-14 10:55:46 -06001760config FDT_SIMPLEFB
1761 bool "FDT tools for simplefb support"
Devarsh Thakkaree3dad42024-09-25 20:43:52 +05301762 depends on VIDEO
Simon Glass27367192023-09-14 10:55:46 -06001763 help
1764 Enable the fdt tools to manage the simple fb nodes in device tree.
1765 These functions can be used by board to indicate to the OS
1766 the presence of the simple frame buffer with associated reserved
1767 memory
1768
Simon Glass624c0e52023-09-14 10:55:59 -06001769config ARCH_FIXUP_FDT_MEMORY
Baruch Siachcfd5a552024-10-28 18:44:35 +02001770 bool "Enable fdt_fixup_memory_banks() call"
Simon Glass624c0e52023-09-14 10:55:59 -06001771 default y
1772 help
1773 Enable FDT memory map syncup before OS boot. This feature can be
1774 used for booting OS with different memory setup where the part of
1775 the memory location should be used for different purpose.
1776
Simon Glass27367192023-09-14 10:55:46 -06001777endmenu
1778
1779endif # OF_LIBFDT
1780
Simon Glass5e958642020-09-10 20:21:18 -06001781config USE_BOOTARGS
1782 bool "Enable boot arguments"
1783 help
1784 Provide boot arguments to bootm command. Boot arguments are specified
1785 in CONFIG_BOOTARGS option. Enable this option to be able to specify
1786 CONFIG_BOOTARGS string. If this option is disabled, CONFIG_BOOTARGS
1787 will be undefined and won't take any space in U-Boot image.
1788
1789config BOOTARGS
1790 string "Boot arguments"
1791 depends on USE_BOOTARGS && !USE_DEFAULT_ENV_FILE
1792 help
1793 This can be used to pass arguments to the bootm command. The value of
1794 CONFIG_BOOTARGS goes into the environment value "bootargs". Note that
1795 this value will also override the "chosen" node in FDT blob.
1796
Simon Glass529e2082020-11-05 10:33:48 -07001797config BOOTARGS_SUBST
1798 bool "Support substituting strings in boot arguments"
1799 help
1800 This allows substituting string values in the boot arguments. These
1801 are applied after the commandline has been built.
1802
1803 One use for this is to insert the root-disk UUID into the command
1804 line where bootargs contains "root=${uuid}"
1805
1806 setenv bootargs "console= root=${uuid}"
1807 # Set the 'uuid' environment variable
1808 part uuid mmc 2:2 uuid
1809
1810 # Command-line substitution will put the real uuid into the
1811 # kernel command line
1812 bootm
1813
Simon Glass5e958642020-09-10 20:21:18 -06001814config USE_BOOTCOMMAND
1815 bool "Enable a default value for bootcmd"
Tom Rinidc3bf2d2023-10-26 14:31:28 -04001816 depends on CMDLINE
Simon Glass5e958642020-09-10 20:21:18 -06001817 help
1818 Provide a default value for the bootcmd entry in the environment. If
1819 autoboot is enabled this is what will be run automatically. Enable
1820 this option to be able to specify CONFIG_BOOTCOMMAND as a string. If
1821 this option is disabled, CONFIG_BOOTCOMMAND will be undefined and
1822 won't take any space in U-Boot image.
1823
1824config BOOTCOMMAND
1825 string "bootcmd value"
1826 depends on USE_BOOTCOMMAND && !USE_DEFAULT_ENV_FILE
Simon Glass2d5a8e12023-05-06 08:27:09 -06001827 default "bootflow scan -lb" if BOOTSTD_DEFAULTS && CMD_BOOTFLOW_FULL
1828 default "bootflow scan" if BOOTSTD_DEFAULTS && !CMD_BOOTFLOW_FULL
Simon Glassbe661cb2022-04-24 23:31:27 -06001829 default "run distro_bootcmd" if !BOOTSTD_BOOTCOMMAND && DISTRO_DEFAULTS
Simon Glass5e958642020-09-10 20:21:18 -06001830 help
1831 This is the string of commands that will be used as bootcmd and if
1832 AUTOBOOT is set, automatically run.
1833
1834config USE_PREBOOT
1835 bool "Enable preboot"
Tom Rinidc3bf2d2023-10-26 14:31:28 -04001836 depends on CMDLINE
Simon Glass5e958642020-09-10 20:21:18 -06001837 help
1838 When this option is enabled, the existence of the environment
1839 variable "preboot" will be checked immediately before starting the
1840 CONFIG_BOOTDELAY countdown and/or running the auto-boot command resp.
1841 entering interactive mode.
1842
1843 This feature is especially useful when "preboot" is automatically
1844 generated or modified. For example, the boot code can modify the
1845 "preboot" when a user holds down a certain combination of keys.
1846
1847config PREBOOT
1848 string "preboot default value"
1849 depends on USE_PREBOOT && !USE_DEFAULT_ENV_FILE
Patrick Delaunaybb15d402020-10-12 09:47:50 +02001850 default "usb start" if USB_KEYBOARD
Simon Glass5e958642020-09-10 20:21:18 -06001851 default ""
1852 help
1853 This is the default of "preboot" environment variable.
1854
Pali Rohár39c43c32022-07-10 13:42:55 +02001855config PREBOOT_DEFINED
1856 bool
1857 default y if PREBOOT != ""
1858
Simon Glassc10ddfd2020-09-10 20:21:20 -06001859config DEFAULT_FDT_FILE
1860 string "Default fdt file"
1861 help
1862 This option is used to set the default fdt file to boot OS.
1863
Dzmitry Sankouskia3463062022-02-22 21:49:52 +03001864config SAVE_PREV_BL_FDT_ADDR
1865 depends on ARM
1866 bool "Saves fdt address, passed by the previous bootloader, to env var"
1867 help
1868 When u-boot is used as a chain-loaded bootloader (replacing OS kernel),
1869 enable this option to save fdt address, passed by the
1870 previous bootloader for future use.
1871 Address is saved to `prevbl_fdt_addr` environment variable.
1872
1873 If no fdt was provided by previous bootloader, no env variables
1874 will be created.
1875
1876config SAVE_PREV_BL_INITRAMFS_START_ADDR
1877 depends on ARM
1878 bool "Saves initramfs address, passed by the previous bootloader, to env var"
1879 help
1880 When u-boot is used as a chain-loaded bootloader(replacing OS kernel),
1881 enable this option to save initramfs address, passed by the
1882 previous bootloader for future use.
1883 Address is saved to `prevbl_initrd_start_addr` environment variable.
1884
1885 If no initramfs was provided by previous bootloader, no env variables
1886 will be created.
1887
Simon Glassc8925112023-06-01 10:23:02 -06001888menu "Configuration editor"
1889
1890config CEDIT
1891 bool "Configuration editor"
Heinrich Schuchardtef97f7c2023-12-16 16:38:36 +01001892 depends on EXPO
Simon Glassc8925112023-06-01 10:23:02 -06001893 help
1894 Provides a way to deal with board configuration and present it to
1895 the user for adjustment.
1896
1897 This is intended to provide both graphical and text-based user
1898 interfaces, but only graphical is support at present.
1899
1900endmenu # Configuration editor
1901
Simon Glassb45b1632020-09-10 20:21:13 -06001902endmenu # Booting