blob: 0aed7aea46bcb28e0b9c4c9833f7e05894507f45 [file] [log] [blame]
Simon Glass547cb402017-08-03 12:21:49 -06001menu "Environment"
2
Rasmus Villemoesecdf0742019-12-15 22:29:39 +00003config ENV_SUPPORT
4 def_bool y
5
Simon Glass7327fe72021-10-21 21:08:46 -06006config ENV_SOURCE_FILE
7 string "Environment file to use"
8 default ""
9 help
10 This sets the basename to use to generate the default environment.
11 This a text file as described in doc/usage/environment.rst
12
13 The file must be in the board directory and have a .env extension, so
14 the resulting filename is typically
15 board/<vendor>/<board>/<CONFIG_ENV_SOURCE_FILE>.env
16
17 If the file is not present, an error is produced.
18
19 If this CONFIG is empty, U-Boot uses CONFIG SYS_BOARD as a default, if
20 the file board/<vendor>/<board>/<SYS_BOARD>.env exists. Otherwise the
21 environment is assumed to come from the ad-hoc
22 CONFIG_EXTRA_ENV_SETTINGS #define
23
Rasmus Villemoes21294752020-02-19 09:47:39 +000024config SAVEENV
25 def_bool y if CMD_SAVEENV
26
Adam Ford710966e2020-07-03 06:48:56 -050027config ENV_OVERWRITE
28 bool "Enable overwriting environment"
29 help
30 Use this to permit overriding of certain environmental variables
31 like Ethernet and Serial
32
Tom Rini0459c6b2022-06-12 20:01:58 -040033config ENV_MIN_ENTRIES
34 int "Minimum number of entries in the environment hashtable"
35 default 64
36 help
37 Minimum number of entries in the hash table that is used internally
38 to store the environment settings.
39
40config ENV_MAX_ENTRIES
41 int "Maximumm number of entries in the environment hashtable"
42 default 512
43 help
44 Maximum number of entries in the hash table that is used internally
45 to store the environment settings. The default setting is supposed to
46 be generous and should work in most cases. This setting can be used
47 to tune behaviour; see lib/hashtable.c for details.
48
Simon Glass87551f12017-08-03 12:21:59 -060049config ENV_IS_NOWHERE
50 bool "Environment is not stored"
Patrice Chotardaf755812019-05-07 11:24:02 +020051 default y if !ENV_IS_IN_EEPROM && !ENV_IS_IN_EXT4 && \
52 !ENV_IS_IN_FAT && !ENV_IS_IN_FLASH && \
53 !ENV_IS_IN_MMC && !ENV_IS_IN_NAND && \
54 !ENV_IS_IN_NVRAM && !ENV_IS_IN_ONENAND && \
55 !ENV_IS_IN_REMOTE && !ENV_IS_IN_SPI_FLASH && \
56 !ENV_IS_IN_UBI
Simon Glass87551f12017-08-03 12:21:59 -060057 help
58 Define this if you don't want to or can't have an environment stored
Shyam Sainiefe757c2018-06-07 19:47:19 +053059 on a storage medium. In this case the environment will still exist
Simon Glass87551f12017-08-03 12:21:59 -060060 while U-Boot is running, but once U-Boot exits it will not be
61 stored. U-Boot will therefore always start up with a default
62 environment.
63
Simon Glass547cb402017-08-03 12:21:49 -060064config ENV_IS_IN_EEPROM
65 bool "Environment in EEPROM"
66 depends on !CHAIN_OF_TRUST
67 help
68 Use this if you have an EEPROM or similar serial access
69 device and a driver for it.
70
71 - CONFIG_ENV_OFFSET:
72 - CONFIG_ENV_SIZE:
73
74 These two #defines specify the offset and size of the
75 environment area within the total memory of your EEPROM.
76
Simon Glass547cb402017-08-03 12:21:49 -060077 Note that we consider the length of the address field to
78 still be one byte because the extra address bits are hidden
79 in the chip address.
80
Simon Glass547cb402017-08-03 12:21:49 -060081 - CONFIG_I2C_ENV_EEPROM_BUS
82 if you have an Environment on an EEPROM reached over
83 I2C muxes, you can define here, how to reach this
84 EEPROM. For example:
85
86 #define CONFIG_I2C_ENV_EEPROM_BUS 1
87
88 EEPROM which holds the environment, is reached over
89 a pca9547 i2c mux with address 0x70, channel 3.
90
91config ENV_IS_IN_FAT
92 bool "Environment is in a FAT filesystem"
93 depends on !CHAIN_OF_TRUST
Maxime Ripard7569e182018-01-23 21:17:01 +010094 default y if ARCH_BCM283X
Maxime Ripard8b7dcd32018-01-23 21:17:04 +010095 default y if ARCH_SUNXI && MMC
Maxime Ripard7569e182018-01-23 21:17:01 +010096 default y if MMC_OMAP_HS && TI_COMMON_CMD_OPTIONS
Tuomas Tynkkynendc256cd2018-01-05 02:45:19 +020097 select FS_FAT
Simon Glass547cb402017-08-03 12:21:49 -060098 select FAT_WRITE
99 help
Simon Glassea8bf842017-08-03 12:21:50 -0600100 Define this if you want to use the FAT file system for the environment.
Simon Glass547cb402017-08-03 12:21:49 -0600101
Jorge Ramirez-Ortiz4a4c26d2018-01-10 11:33:48 +0100102config ENV_IS_IN_EXT4
103 bool "Environment is in a EXT4 filesystem"
104 depends on !CHAIN_OF_TRUST
Michal Simek4b4ba3c2020-08-19 10:44:23 +0200105 select FS_EXT4
Jorge Ramirez-Ortiz4a4c26d2018-01-10 11:33:48 +0100106 select EXT4_WRITE
107 help
108 Define this if you want to use the EXT4 file system for the environment.
109
Simon Glass547cb402017-08-03 12:21:49 -0600110config ENV_IS_IN_FLASH
111 bool "Environment in flash memory"
112 depends on !CHAIN_OF_TRUST
Maxime Ripard7569e182018-01-23 21:17:01 +0100113 default y if ARCH_CINTEGRATOR
114 default y if ARCH_INTEGRATOR_CP
Tom Rini7ab2f5f2021-05-14 21:34:10 -0400115 default y if M548x || M547x || M5282
Maxime Ripard7569e182018-01-23 21:17:01 +0100116 default y if MCF532x || MCF52x2
117 default y if MPC86xx || MPC83xx
Tom Rinie5404982021-05-14 21:34:26 -0400118 default y if ARCH_MPC8548
Maxime Ripard7569e182018-01-23 21:17:01 +0100119 default y if SH && !CPU_SH4
Simon Glass547cb402017-08-03 12:21:49 -0600120 help
121 Define this if you have a flash device which you want to use for the
122 environment.
123
124 a) The environment occupies one whole flash sector, which is
125 "embedded" in the text segment with the U-Boot code. This
126 happens usually with "bottom boot sector" or "top boot
127 sector" type flash chips, which have several smaller
128 sectors at the start or the end. For instance, such a
129 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
130 such a case you would place the environment in one of the
131 4 kB sectors - with U-Boot code before and after it. With
132 "top boot sector" type flash chips, you would put the
133 environment in one of the last sectors, leaving a gap
134 between U-Boot and the environment.
135
136 CONFIG_ENV_OFFSET:
137
138 Offset of environment data (variable area) to the
139 beginning of flash memory; for instance, with bottom boot
140 type flash chips the second sector can be used: the offset
141 for this sector is given here.
142
143 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
144
145 CONFIG_ENV_ADDR:
146
147 This is just another way to specify the start address of
148 the flash sector containing the environment (instead of
149 CONFIG_ENV_OFFSET).
150
151 CONFIG_ENV_SECT_SIZE:
152
153 Size of the sector containing the environment.
154
155
156 b) Sometimes flash chips have few, equal sized, BIG sectors.
157 In such a case you don't want to spend a whole sector for
158 the environment.
159
160 CONFIG_ENV_SIZE:
161
162 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
163 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
164 of this flash sector for the environment. This saves
165 memory for the RAM copy of the environment.
166
167 It may also save flash memory if you decide to use this
168 when your environment is "embedded" within U-Boot code,
169 since then the remainder of the flash sector could be used
170 for U-Boot code. It should be pointed out that this is
171 STRONGLY DISCOURAGED from a robustness point of view:
172 updating the environment in flash makes it always
173 necessary to erase the WHOLE sector. If something goes
174 wrong before the contents has been restored from a copy in
175 RAM, your target system will be dead.
176
177 CONFIG_ENV_ADDR_REDUND
Simon Glass547cb402017-08-03 12:21:49 -0600178
179 These settings describe a second storage area used to hold
180 a redundant copy of the environment data, so that there is
181 a valid backup copy in case there is a power failure during
182 a "saveenv" operation.
183
184 BE CAREFUL! Any changes to the flash layout, and some changes to the
185 source code will make it necessary to adapt <board>/u-boot.lds*
186 accordingly!
187
188config ENV_IS_IN_MMC
189 bool "Environment in an MMC device"
190 depends on !CHAIN_OF_TRUST
Maxime Ripard662a1ec2018-01-23 21:17:00 +0100191 depends on MMC
Maxime Ripard7569e182018-01-23 21:17:01 +0100192 default y if ARCH_EXYNOS4
193 default y if MX6SX || MX7D
194 default y if TEGRA30 || TEGRA124
195 default y if TEGRA_ARMV8_COMMON
Simon Glass547cb402017-08-03 12:21:49 -0600196 help
197 Define this if you have an MMC device which you want to use for the
198 environment.
199
200 CONFIG_SYS_MMC_ENV_DEV:
201
202 Specifies which MMC device the environment is stored in.
203
204 CONFIG_SYS_MMC_ENV_PART (optional):
205
206 Specifies which MMC partition the environment is stored in. If not
207 set, defaults to partition 0, the user area. Common values might be
208 1 (first MMC boot partition), 2 (second MMC boot partition).
209
210 CONFIG_ENV_OFFSET:
211 CONFIG_ENV_SIZE:
212
213 These two #defines specify the offset and size of the environment
214 area within the specified MMC device.
215
216 If offset is positive (the usual case), it is treated as relative to
217 the start of the MMC partition. If offset is negative, it is treated
218 as relative to the end of the MMC partition. This can be useful if
219 your board may be fitted with different MMC devices, which have
220 different sizes for the MMC partitions, and you always want the
221 environment placed at the very end of the partition, to leave the
222 maximum possible space before it, to store other data.
223
224 These two values are in units of bytes, but must be aligned to an
225 MMC sector boundary.
226
227 CONFIG_ENV_OFFSET_REDUND (optional):
228
229 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
230 hold a redundant copy of the environment data. This provides a
231 valid backup copy in case the other copy is corrupted, e.g. due
232 to a power failure during a "saveenv" operation.
233
234 This value may also be positive or negative; this is handled in the
235 same way as CONFIG_ENV_OFFSET.
236
Marek Vasut509f36e2021-10-17 19:23:36 +0200237 In case CONFIG_SYS_MMC_ENV_PART is 1 (i.e. environment in eMMC boot
238 partition) then setting CONFIG_ENV_OFFSET_REDUND to the same value
239 as CONFIG_ENV_OFFSET makes use of the second eMMC boot partition for
240 the redundant environment copy.
241
Simon Glass547cb402017-08-03 12:21:49 -0600242 This value is also in units of bytes, but must also be aligned to
243 an MMC sector boundary.
244
Simon Glass547cb402017-08-03 12:21:49 -0600245config ENV_IS_IN_NAND
246 bool "Environment in a NAND device"
247 depends on !CHAIN_OF_TRUST
248 help
249 Define this if you have a NAND device which you want to use for the
250 environment.
251
252 - CONFIG_ENV_OFFSET:
253 - CONFIG_ENV_SIZE:
254
255 These two #defines specify the offset and size of the environment
256 area within the first NAND device. CONFIG_ENV_OFFSET must be
257 aligned to an erase block boundary.
258
259 - CONFIG_ENV_OFFSET_REDUND (optional):
260
261 This setting describes a second storage area of CONFIG_ENV_SIZE
262 size used to hold a redundant copy of the environment data, so
263 that there is a valid backup copy in case there is a power failure
264 during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
265 aligned to an erase block boundary.
266
267 - CONFIG_ENV_RANGE (optional):
268
269 Specifies the length of the region in which the environment
270 can be written. This should be a multiple of the NAND device's
271 block size. Specifying a range with more erase blocks than
272 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
273 the range to be avoided.
274
275 - CONFIG_ENV_OFFSET_OOB (optional):
276
277 Enables support for dynamically retrieving the offset of the
278 environment from block zero's out-of-band data. The
279 "nand env.oob" command can be used to record this offset.
280 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
281 using CONFIG_ENV_OFFSET_OOB.
282
283config ENV_IS_IN_NVRAM
284 bool "Environment in a non-volatile RAM"
285 depends on !CHAIN_OF_TRUST
286 help
287 Define this if you have some non-volatile memory device
288 (NVRAM, battery buffered SRAM) which you want to use for the
289 environment.
290
291 - CONFIG_ENV_ADDR:
292 - CONFIG_ENV_SIZE:
293
294 These two #defines are used to determine the memory area you
295 want to use for environment. It is assumed that this memory
296 can just be read and written to, without any special
297 provision.
298
299config ENV_IS_IN_ONENAND
300 bool "Environment is in OneNAND"
301 depends on !CHAIN_OF_TRUST
302 help
303 Define this if you want to put your local device's environment in
304 OneNAND.
305
306 - CONFIG_ENV_ADDR:
307 - CONFIG_ENV_SIZE:
308
309 These two #defines are used to determine the device range you
310 want to use for environment. It is assumed that this memory
311 can just be read and written to, without any special
312 provision.
313
314config ENV_IS_IN_REMOTE
Heinrich Schuchardtaefbfe12018-03-17 22:53:11 +0000315 bool "Environment is in remote memory space"
Simon Glass547cb402017-08-03 12:21:49 -0600316 depends on !CHAIN_OF_TRUST
317 help
318 Define this if you have a remote memory space which you
319 want to use for the local device's environment.
320
321 - CONFIG_ENV_ADDR:
322 - CONFIG_ENV_SIZE:
323
324 These two #defines specify the address and size of the
325 environment area within the remote memory space. The
326 local device can get the environment from remote memory
327 space by SRIO or PCIE links.
328
329config ENV_IS_IN_SPI_FLASH
330 bool "Environment is in SPI flash"
Tom Rinie5289a72019-05-29 17:01:28 -0400331 depends on !CHAIN_OF_TRUST && SPI
Maxime Ripard7569e182018-01-23 21:17:01 +0100332 default y if ARMADA_XP
333 default y if INTEL_BAYTRAIL
334 default y if INTEL_BRASWELL
335 default y if INTEL_BROADWELL
336 default y if NORTHBRIDGE_INTEL_IVYBRIDGE
337 default y if INTEL_QUARK
338 default y if INTEL_QUEENSBAY
Andre Przywarae28ff722022-01-11 12:46:05 +0000339 default y if ARCH_SUNXI
Simon Glass547cb402017-08-03 12:21:49 -0600340 help
341 Define this if you have a SPI Flash memory device which you
342 want to use for the environment.
343
344 - CONFIG_ENV_OFFSET:
345 - CONFIG_ENV_SIZE:
346
347 These two #defines specify the offset and size of the
348 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
349 aligned to an erase sector boundary.
350
351 - CONFIG_ENV_SECT_SIZE:
352
353 Define the SPI flash's sector size.
354
355 - CONFIG_ENV_OFFSET_REDUND (optional):
356
357 This setting describes a second storage area of CONFIG_ENV_SIZE
358 size used to hold a redundant copy of the environment data, so
359 that there is a valid backup copy in case there is a power failure
360 during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
361 aligned to an erase sector boundary.
362
Rasmus Villemoese535f5b2021-04-14 20:51:43 +0200363config ENV_SECT_SIZE_AUTO
364 bool "Use automatically detected sector size"
365 depends on ENV_IS_IN_SPI_FLASH
366 help
367 Some boards exist in multiple variants, with different
368 flashes having different sector sizes. In such cases, you
369 can select this option to make U-Boot use the actual sector
370 size when figuring out how much to erase, which can thus be
371 more efficient on the flashes with smaller erase size. Since
372 the environment must always be aligned on a sector boundary,
373 CONFIG_ENV_OFFSET must be aligned to the largest of the
374 different sector sizes, and CONFIG_ENV_SECT_SIZE should be
375 set to that value.
376
Patrick Delaunayf8e932e2019-02-27 15:20:38 +0100377config ENV_SPI_BUS
378 int "Value of SPI flash bus for environment"
Patrick Delaunayf8e932e2019-02-27 15:20:38 +0100379 depends on ENV_IS_IN_SPI_FLASH
Tom Rini119d2fb2021-12-11 14:55:48 -0500380 default SF_DEFAULT_BUS
Patrick Delaunayf8e932e2019-02-27 15:20:38 +0100381 help
Tom Rini119d2fb2021-12-11 14:55:48 -0500382 Value the SPI bus and chip select for environment.
Simon Glass547cb402017-08-03 12:21:49 -0600383
Patrick Delaunayf8e932e2019-02-27 15:20:38 +0100384config ENV_SPI_CS
385 int "Value of SPI flash chip select for environment"
Patrick Delaunayf8e932e2019-02-27 15:20:38 +0100386 depends on ENV_IS_IN_SPI_FLASH
Tom Rini119d2fb2021-12-11 14:55:48 -0500387 default SF_DEFAULT_CS
Patrick Delaunayf8e932e2019-02-27 15:20:38 +0100388 help
Tom Rini119d2fb2021-12-11 14:55:48 -0500389 Value of the SPI chip select for environment.
Patrick Delaunayf8e932e2019-02-27 15:20:38 +0100390
391config ENV_SPI_MAX_HZ
Marek Vasutdfe74622019-05-04 19:10:05 +0200392 int "Value of SPI flash max frequency for environment"
Patrick Delaunayf8e932e2019-02-27 15:20:38 +0100393 depends on ENV_IS_IN_SPI_FLASH
Tom Rini119d2fb2021-12-11 14:55:48 -0500394 default SF_DEFAULT_SPEED
Patrick Delaunayf8e932e2019-02-27 15:20:38 +0100395 help
Tom Rini119d2fb2021-12-11 14:55:48 -0500396 Value of the SPI max work clock for environment.
Simon Glass547cb402017-08-03 12:21:49 -0600397
Patrick Delaunayf8e932e2019-02-27 15:20:38 +0100398config ENV_SPI_MODE
399 hex "Value of SPI flash work mode for environment"
Tom Rini119d2fb2021-12-11 14:55:48 -0500400 depends on ENV_IS_IN_SPI_FLASH
401 default SF_DEFAULT_MODE
Patrick Delaunayf8e932e2019-02-27 15:20:38 +0100402 help
403 Value of the SPI work mode for environment.
404 See include/spi.h for value.
Simon Glass547cb402017-08-03 12:21:49 -0600405
Heiko Schocher704d21c2020-10-10 10:28:05 +0200406config ENV_SPI_EARLY
407 bool "Access Environment in SPI flashes before relocation"
408 depends on ENV_IS_IN_SPI_FLASH
409 help
410 Enable this if you want to use Environment in SPI flash
411 before relocation. Call env_init() and than you can use
412 env_get_f() for accessing Environment variables.
413
Simon Glass547cb402017-08-03 12:21:49 -0600414config ENV_IS_IN_UBI
415 bool "Environment in a UBI volume"
416 depends on !CHAIN_OF_TRUST
Miquel Raynal27271b62019-10-03 19:50:12 +0200417 depends on MTD_UBI
418 depends on CMD_UBI
Simon Glass547cb402017-08-03 12:21:49 -0600419 help
420 Define this if you have an UBI volume that you want to use for the
421 environment. This has the benefit of wear-leveling the environment
422 accesses, which is important on NAND.
423
424 - CONFIG_ENV_UBI_PART:
425
426 Define this to a string that is the mtd partition containing the UBI.
427
428 - CONFIG_ENV_UBI_VOLUME:
429
430 Define this to the name of the volume that you want to store the
431 environment in.
432
433 - CONFIG_ENV_UBI_VOLUME_REDUND:
434
435 Define this to the name of another volume to store a second copy of
436 the environment in. This will enable redundant environments in UBI.
437 It is assumed that both volumes are in the same MTD partition.
438
Tom Rini4bb26a42019-11-10 11:28:03 -0500439config SYS_REDUNDAND_ENVIRONMENT
440 bool "Enable redundant environment support"
Tom Rini4bb26a42019-11-10 11:28:03 -0500441 help
442 Normally, the environemt is stored in a single location. By
443 selecting this option, you can then define where to hold a redundant
444 copy of the environment data, so that there is a valid backup copy in
445 case there is a power failure during a "saveenv" operation.
Michal Simekcc780ec2021-01-13 10:25:50 +0100446 Also this config changes the binary environment structure handling
447 which is used by env import/export commands which are independent of
448 storing variables to redundant location on a non volatile device.
Tom Rini4bb26a42019-11-10 11:28:03 -0500449
Simon Glass547cb402017-08-03 12:21:49 -0600450config ENV_FAT_INTERFACE
451 string "Name of the block device for the environment"
452 depends on ENV_IS_IN_FAT
Michal Simek5227e1e2020-02-25 15:50:33 +0100453 default "mmc"
Simon Glass547cb402017-08-03 12:21:49 -0600454 help
455 Define this to a string that is the name of the block device.
456
457config ENV_FAT_DEVICE_AND_PART
458 string "Device and partition for where to store the environemt in FAT"
459 depends on ENV_IS_IN_FAT
460 default "0:1" if TI_COMMON_CMD_OPTIONS
Ashok Reddy Somafb6b3cd2021-02-23 08:07:46 -0700461 default "0:auto" if ARCH_ZYNQ || ARCH_ZYNQMP || ARCH_VERSAL
Samuel Hollandbc42abb2021-04-18 22:16:21 -0500462 default ":auto" if ARCH_SUNXI
Simon Glass547cb402017-08-03 12:21:49 -0600463 default "0" if ARCH_AT91
464 help
465 Define this to a string to specify the partition of the device. It can
466 be as following:
467
468 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
469 - "D:P": device D partition P. Error occurs if device D has no
470 partition table.
471 - "D:0": device D.
472 - "D" or "D:": device D partition 1 if device D has partition
473 table, or the whole device D if has no partition
474 table.
475 - "D:auto": first partition in device D with bootable flag set.
476 If none, first valid partition in device D. If no
477 partition table then means device D.
478
David Woodhouse93365392020-06-19 23:07:17 +0100479 If ENV_FAT_INTERFACE is set to "mmc" then device 'D' can be omitted,
480 leaving the string starting with a colon, and the boot device will
481 be used.
482
Simon Glass547cb402017-08-03 12:21:49 -0600483config ENV_FAT_FILE
Shyam Sainiefe757c2018-06-07 19:47:19 +0530484 string "Name of the FAT file to use for the environment"
Simon Glass547cb402017-08-03 12:21:49 -0600485 depends on ENV_IS_IN_FAT
486 default "uboot.env"
487 help
488 It's a string of the FAT file name. This file use to store the
489 environment.
490
Brandon Maierf2815462021-01-16 15:14:43 -0600491config ENV_FAT_FILE_REDUND
492 string "Name of the FAT file to use for the environment"
493 depends on ENV_IS_IN_FAT && SYS_REDUNDAND_ENVIRONMENT
494 default "uboot-redund.env"
495 help
496 It's a string of the FAT file name. This file use to store the
497 redundant environment.
498
Jorge Ramirez-Ortiz4a4c26d2018-01-10 11:33:48 +0100499config ENV_EXT4_INTERFACE
500 string "Name of the block device for the environment"
501 depends on ENV_IS_IN_EXT4
502 help
503 Define this to a string that is the name of the block device.
504
505config ENV_EXT4_DEVICE_AND_PART
506 string "Device and partition for where to store the environemt in EXT4"
507 depends on ENV_IS_IN_EXT4
508 help
509 Define this to a string to specify the partition of the device. It can
510 be as following:
511
512 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
513 - "D:P": device D partition P. Error occurs if device D has no
514 partition table.
515 - "D:0": device D.
516 - "D" or "D:": device D partition 1 if device D has partition
517 table, or the whole device D if has no partition
518 table.
519 - "D:auto": first partition in device D with bootable flag set.
520 If none, first valid partition in device D. If no
521 partition table then means device D.
522
David Woodhouse6815e2c2020-08-04 10:05:47 +0100523 If ENV_EXT4_INTERFACE is set to "mmc" then device 'D' can be omitted,
524 leaving the string starting with a colon, and the boot device will
525 be used.
526
Jorge Ramirez-Ortiz4a4c26d2018-01-10 11:33:48 +0100527config ENV_EXT4_FILE
Shyam Sainiefe757c2018-06-07 19:47:19 +0530528 string "Name of the EXT4 file to use for the environment"
Jorge Ramirez-Ortiz4a4c26d2018-01-10 11:33:48 +0100529 depends on ENV_IS_IN_EXT4
Patrick Delaunay955b6712020-07-28 11:51:14 +0200530 default "/uboot.env"
Jorge Ramirez-Ortiz4a4c26d2018-01-10 11:33:48 +0100531 help
532 It's a string of the EXT4 file name. This file use to store the
533 environment (explicit path to the file)
534
Tom Rini5cd7ece2019-11-18 20:02:10 -0500535config ENV_ADDR
536 hex "Environment address"
537 depends on ENV_IS_IN_FLASH || ENV_IS_IN_NVRAM || ENV_IS_IN_ONENAND || \
538 ENV_IS_IN_REMOTE || ENV_IS_IN_SPI_FLASH
539 default 0x0 if ENV_IS_IN_SPI_FLASH
540 help
541 Offset from the start of the device (or partition)
542
543config ENV_ADDR_REDUND
544 hex "Redundant environment address"
545 depends on ENV_IS_IN_FLASH && SYS_REDUNDAND_ENVIRONMENT
546 help
547 Offset from the start of the device (or partition) of the redundant
548 environment location.
Simon Glass547cb402017-08-03 12:21:49 -0600549
550config ENV_OFFSET
Tom Rini5cd7ece2019-11-18 20:02:10 -0500551 hex "Environment offset"
552 depends on ENV_IS_IN_EEPROM || ENV_IS_IN_MMC || ENV_IS_IN_NAND || \
553 ENV_IS_IN_SPI_FLASH
Jagan Tekic4ec2262019-12-21 13:24:35 +0530554 default 0x3f8000 if ARCH_ROCKCHIP && ENV_IS_IN_MMC
Jagan Teki68397572019-12-21 13:24:36 +0530555 default 0x140000 if ARCH_ROCKCHIP && ENV_IS_IN_SPI_FLASH
Andre Przywaracf844082022-01-11 12:46:03 +0000556 default 0xF0000 if ARCH_SUNXI
Michal Simeke93ef192018-07-19 08:45:45 +0200557 default 0xE0000 if ARCH_ZYNQ
558 default 0x1E00000 if ARCH_ZYNQMP
T Karthik Reddy76770302019-08-05 16:18:57 +0530559 default 0x7F40000 if ARCH_VERSAL
Alexey Brodkin07dfc092019-01-15 11:42:48 +0300560 default 0 if ARC
Markus Klotzbuecher7bd60e62019-05-15 15:15:54 +0200561 default 0x140000 if ARCH_AT91
562 default 0x260000 if ARCH_OMAP2PLUS
Varalaxmi Bingi52e79212020-02-05 03:58:20 -0700563 default 0x1080000 if MICROBLAZE && ENV_IS_IN_SPI_FLASH
Simon Glass547cb402017-08-03 12:21:49 -0600564 help
565 Offset from the start of the device (or partition)
566
Tom Rini5cd7ece2019-11-18 20:02:10 -0500567config ENV_OFFSET_REDUND
568 hex "Redundant environment offset"
569 depends on (ENV_IS_IN_EEPROM || ENV_IS_IN_MMC || ENV_IS_IN_NAND || \
570 ENV_IS_IN_SPI_FLASH) && SYS_REDUNDAND_ENVIRONMENT
Michal Simek46d6b522021-02-24 10:33:45 +0100571 default 0
Tom Rini5cd7ece2019-11-18 20:02:10 -0500572 help
573 Offset from the start of the device (or partition) of the redundant
574 environment location.
575
Simon Glass547cb402017-08-03 12:21:49 -0600576config ENV_SIZE
577 hex "Environment Size"
Michal Simeke93ef192018-07-19 08:45:45 +0200578 default 0x40000 if ENV_IS_IN_SPI_FLASH && ARCH_ZYNQMP
Andre Przywaracf844082022-01-11 12:46:03 +0000579 default 0x20000 if ARCH_ZYNQ || ARCH_OMAP2PLUS || ARCH_AT91
580 default 0x10000 if ARCH_SUNXI
Jagan Tekic4ec2262019-12-21 13:24:35 +0530581 default 0x8000 if ARCH_ROCKCHIP && ENV_IS_IN_MMC
Jagan Teki68397572019-12-21 13:24:36 +0530582 default 0x2000 if ARCH_ROCKCHIP && ENV_IS_IN_SPI_FLASH
Jagan Tekic4ec2262019-12-21 13:24:35 +0530583 default 0x8000 if ARCH_ZYNQMP || ARCH_VERSAL
Alexey Brodkin07dfc092019-01-15 11:42:48 +0300584 default 0x4000 if ARC
Markus Klotzbuecher7bd60e62019-05-15 15:15:54 +0200585 default 0x1f000
Simon Glass547cb402017-08-03 12:21:49 -0600586 help
587 Size of the environment storage area
588
Michal Simeke93ef192018-07-19 08:45:45 +0200589config ENV_SECT_SIZE
590 hex "Environment Sector-Size"
Tom Rini5cd7ece2019-11-18 20:02:10 -0500591 depends on ENV_IS_IN_FLASH || ENV_IS_IN_SPI_FLASH
Jagan Teki68397572019-12-21 13:24:36 +0530592 default 0x2000 if ARCH_ROCKCHIP
T Karthik Reddy76770302019-08-05 16:18:57 +0530593 default 0x40000 if ARCH_ZYNQMP || ARCH_VERSAL
Markus Klotzbuecher7bd60e62019-05-15 15:15:54 +0200594 default 0x20000 if ARCH_ZYNQ || ARCH_OMAP2PLUS || ARCH_AT91
Varalaxmi Bingi52e79212020-02-05 03:58:20 -0700595 default 0x20000 if MICROBLAZE && ENV_IS_IN_SPI_FLASH
Andre Przywaracf844082022-01-11 12:46:03 +0000596 default 0x10000 if ARCH_SUNXI && ENV_IS_IN_SPI_FLASH
Michal Simeke93ef192018-07-19 08:45:45 +0200597 help
598 Size of the sector containing the environment.
599
Simon Glass547cb402017-08-03 12:21:49 -0600600config ENV_UBI_PART
601 string "UBI partition name"
602 depends on ENV_IS_IN_UBI
603 help
604 MTD partition containing the UBI device
605
606config ENV_UBI_VOLUME
607 string "UBI volume name"
608 depends on ENV_IS_IN_UBI
609 help
610 Name of the volume that you want to store the environment in.
611
Markus Klotzbuecher975bcde2019-05-15 15:15:53 +0200612config ENV_UBI_VOLUME_REDUND
613 string "UBI redundant volume name"
Tom Rini4bb26a42019-11-10 11:28:03 -0500614 depends on ENV_IS_IN_UBI && SYS_REDUNDAND_ENVIRONMENT
Markus Klotzbuecher975bcde2019-05-15 15:15:53 +0200615 help
616 Name of the redundant volume that you want to store the environment in.
617
Hamish Guthrie674ab242019-05-15 15:15:55 +0200618config ENV_UBI_VID_OFFSET
619 int "ubi environment VID offset"
620 depends on ENV_IS_IN_UBI
621 default 0
622 help
623 UBI VID offset for environment. If 0, no custom VID offset is used.
624
Tom Rinica63e712019-11-12 22:46:36 -0500625config SYS_RELOC_GD_ENV_ADDR
Patrick Delaunay9f757532020-06-10 19:28:42 +0200626 bool "Relocate gd->env_addr"
Tom Rinica63e712019-11-12 22:46:36 -0500627 help
628 Relocate the early env_addr pointer so we know it is not inside
629 the binary. Some systems need this and for the rest, it doesn't hurt.
630
Tom Rinieb1f9092020-07-24 17:14:47 -0400631config SYS_MMC_ENV_DEV
632 int "mmc device number"
633 depends on ENV_IS_IN_MMC || ENV_IS_IN_FAT || SYS_LS_PPA_FW_IN_MMC || \
Kuldeep Singhd6cfb902021-08-10 11:20:06 +0530634 CMD_MVEBU_BUBT || FMAN_ENET || QE || PHY_CORTINA
Tom Rinieb1f9092020-07-24 17:14:47 -0400635 default 0
636 help
637 MMC device number on the platform where the environment is stored.
638
639config SYS_MMC_ENV_PART
640 int "mmc partition number"
641 depends on ENV_IS_IN_MMC || ENV_IS_IN_FAT
642 default 0
643 help
644 MMC hardware partition device number on the platform where the
645 environment is stored. Note that this is not related to any software
646 defined partition table but instead if we are in the user area, which is
647 partition 0 or the first boot partition, which is 1 or some other defined
648 partition.
649
Rasmus Villemoes14c71142018-03-20 11:38:45 +0100650config USE_DEFAULT_ENV_FILE
651 bool "Create default environment from file"
652 help
653 Normally, the default environment is automatically generated
654 based on the settings of various CONFIG_* options, as well
655 as the CONFIG_EXTRA_ENV_SETTINGS. By selecting this option,
656 you can instead define the entire default environment in an
657 external file.
658
659config DEFAULT_ENV_FILE
660 string "Path to default environment file"
661 depends on USE_DEFAULT_ENV_FILE
662 help
663 The path containing the default environment. The format is
664 the same as accepted by the mkenvimage tool: lines
665 containing key=value pairs, blank lines and lines beginning
666 with # are ignored.
667
Alex Kiernana410d6e2018-04-01 16:37:53 +0000668config ENV_VARS_UBOOT_RUNTIME_CONFIG
669 bool "Add run-time information to the environment"
670 help
671 Enable this in order to add variables describing certain
672 run-time determined information about the hardware to the
673 environment. These will be named board_name, board_rev.
674
Ovidiu Panait86ccd752020-05-06 20:38:42 +0300675config DELAY_ENVIRONMENT
676 bool "Delay environment loading"
677 depends on !OF_CONTROL
678 help
679 Enable this to inhibit loading the environment during board
680 initialization. This can address the security risk of untrusted data
681 being used during boot. Normally the environment is loaded when the
682 board is initialised so that it is available to U-Boot. This inhibits
683 that so that the environment is not available until explicitly loaded
684 later by U-Boot code. With CONFIG_OF_CONTROL this is instead
685 controlled by the value of /config/load-environment.
686
Rasmus Villemoescf8e5432021-04-21 11:06:54 +0200687config ENV_IMPORT_FDT
688 bool "Amend environment by FDT properties"
689 depends on OF_CONTROL
690 help
691 If selected, after the environment has been loaded from its
692 persistent location, the "env_fdt_path" variable is looked
693 up and used as a path to a node in the control DTB. The
694 property/value pairs in that node is then used to update the
695 run-time environment. This can be useful to use the same
696 U-Boot binary with different board variants.
697
698config ENV_FDT_PATH
699 string "Default value for env_fdt_path variable"
700 depends on ENV_IMPORT_FDT
701 default "/config/environment"
702 help
703 The initial value of the env_fdt_path variable.
704
Marek Vasuta7b82672020-07-07 20:51:38 +0200705config ENV_APPEND
706 bool "Always append the environment with new data"
Marek Vasuta7b82672020-07-07 20:51:38 +0200707 help
708 If defined, the environment hash table is only ever appended with new
709 data, but the existing hash table can never be dropped and reloaded
710 with newly imported data. This may be used in combination with static
711 flags to e.g. to protect variables which must not be modified.
712
Marek Vasut803549f2020-07-07 20:51:39 +0200713config ENV_WRITEABLE_LIST
714 bool "Permit write access only to listed variables"
Marek Vasut803549f2020-07-07 20:51:39 +0200715 help
716 If defined, only environment variables which explicitly set the 'w'
717 writeable flag can be written and modified at runtime. No variables
718 can be otherwise created, written or imported into the environment.
719
Marek Vasutb7f3f232020-05-22 01:10:14 +0200720config ENV_ACCESS_IGNORE_FORCE
721 bool "Block forced environment operations"
Marek Vasutb7f3f232020-05-22 01:10:14 +0200722 help
723 If defined, don't allow the -f switch to env set override variable
724 access flags.
725
York Sun187da8d2018-06-26 10:03:22 -0700726if SPL_ENV_SUPPORT
727config SPL_ENV_IS_NOWHERE
728 bool "SPL Environment is not stored"
729 default y if ENV_IS_NOWHERE
730 help
731 Similar to ENV_IS_NOWHERE, used for SPL environment.
732
733config SPL_ENV_IS_IN_MMC
734 bool "SPL Environment in an MMC device"
735 depends on !SPL_ENV_IS_NOWHERE
736 depends on ENV_IS_IN_MMC
737 default y
738 help
739 Similar to ENV_IS_IN_MMC, used for SPL environment.
740
741config SPL_ENV_IS_IN_FAT
742 bool "SPL Environment is in a FAT filesystem"
743 depends on !SPL_ENV_IS_NOWHERE
744 depends on ENV_IS_IN_FAT
745 default y
746 help
747 Similar to ENV_IS_IN_FAT, used for SPL environment.
748
749config SPL_ENV_IS_IN_EXT4
750 bool "SPL Environment is in a EXT4 filesystem"
751 depends on !SPL_ENV_IS_NOWHERE
752 depends on ENV_IS_IN_EXT4
753 default y
754 help
755 Similar to ENV_IS_IN_EXT4, used for SPL environment.
756
757config SPL_ENV_IS_IN_NAND
758 bool "SPL Environment in a NAND device"
759 depends on !SPL_ENV_IS_NOWHERE
760 depends on ENV_IS_IN_NAND
761 default y
762 help
763 Similar to ENV_IS_IN_NAND, used for SPL environment.
764
765config SPL_ENV_IS_IN_SPI_FLASH
766 bool "SPL Environment is in SPI flash"
767 depends on !SPL_ENV_IS_NOWHERE
768 depends on ENV_IS_IN_SPI_FLASH
769 default y
770 help
771 Similar to ENV_IS_IN_SPI_FLASH, used for SPL environment.
772
773config SPL_ENV_IS_IN_FLASH
774 bool "SPL Environment in flash memory"
775 depends on !SPL_ENV_IS_NOWHERE
776 depends on ENV_IS_IN_FLASH
777 default y
778 help
779 Similar to ENV_IS_IN_FLASH, used for SPL environment.
780
781endif
782
783if TPL_ENV_SUPPORT
784
785config TPL_ENV_IS_NOWHERE
786 bool "TPL Environment is not stored"
787 default y if ENV_IS_NOWHERE
788 help
789 Similar to ENV_IS_NOWHERE, used for TPL environment.
790
791config TPL_ENV_IS_IN_MMC
792 bool "TPL Environment in an MMC device"
793 depends on !TPL_ENV_IS_NOWHERE
794 depends on ENV_IS_IN_MMC
795 default y
796 help
797 Similar to ENV_IS_IN_MMC, used for TPL environment.
798
799config TPL_ENV_IS_IN_FAT
800 bool "TPL Environment is in a FAT filesystem"
801 depends on !TPL_ENV_IS_NOWHERE
802 depends on ENV_IS_IN_FAT
803 default y
804 help
805 Similar to ENV_IS_IN_FAT, used for TPL environment.
806
807config TPL_ENV_IS_IN_EXT4
808 bool "TPL Environment is in a EXT4 filesystem"
809 depends on !TPL_ENV_IS_NOWHERE
810 depends on ENV_IS_IN_EXT4
811 default y
812 help
813 Similar to ENV_IS_IN_EXT4, used for TPL environment.
814
815config TPL_ENV_IS_IN_NAND
816 bool "TPL Environment in a NAND device"
817 depends on !TPL_ENV_IS_NOWHERE
818 depends on ENV_IS_IN_NAND
819 default y
820 help
821 Similar to ENV_IS_IN_NAND, used for TPL environment.
822
823config TPL_ENV_IS_IN_SPI_FLASH
824 bool "TPL Environment is in SPI flash"
825 depends on !TPL_ENV_IS_NOWHERE
826 depends on ENV_IS_IN_SPI_FLASH
827 default y
828 help
829 Similar to ENV_IS_IN_SPI_FLASH, used for TPL environment.
830
831config TPL_ENV_IS_IN_FLASH
832 bool "TPL Environment in flash memory"
833 depends on !TPL_ENV_IS_NOWHERE
834 depends on ENV_IS_IN_FLASH
835 default y
836 help
837 Similar to ENV_IS_IN_FLASH, used for TPL environment.
838
839endif
840
Tom Rini5fb860c2022-02-25 11:19:48 -0500841config USE_BOOTFILE
842 bool "Add a 'bootfile' environment variable"
843 help
844 The "bootfile" variable is used in some cases to allow for
845 controlling what file U-Boot will attempt to load and boot. To set
846 this, enable this option and set the value in the next question.
847
848config BOOTFILE
849 string "'bootfile' environment variable value"
850 depends on USE_BOOTFILE
851 help
852 The value to set the "bootfile" variable to.
853
Tom Rinife586752022-03-11 09:12:07 -0500854config USE_ETHPRIME
855 bool "Add an 'ethprime' environment variable"
856 help
857 The "ethprime" variable is used in some cases to control which
858 network interface is used first.
859
860config ETHPRIME
861 string "'ethprime' environment variable value"
862 depends on USE_ETHPRIME
863 help
864 The value to set the "ethprime" variable to.
865
Simon Glass99298be2020-09-10 20:21:24 -0600866config VERSION_VARIABLE
867 bool "Add a 'ver' environment variable with the U-Boot version"
868 help
869 If this variable is defined, an environment variable
870 named "ver" is created by U-Boot showing the U-Boot
871 version as printed by the "version" command.
872 Any change to this variable will be reverted at the
873 next reset.
874
Simon Glass547cb402017-08-03 12:21:49 -0600875endmenu