blob: 9641abe371a0087ed8e3f5e2d12c8ad8e535c055 [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
Tom Rinic9edebe2022-12-04 10:03:50 -050022 CFG_EXTRA_ENV_SETTINGS #define
Simon Glass7327fe72021-10-21 21:08:46 -060023
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 Rini7bb25792022-12-02 16:42:39 -050033config OVERWRITE_ETHADDR_ONCE
34 bool "Enable overwriting ethaddr environment variables once"
35 depends on !ENV_OVERWRITE
36 help
37 Enable this to allow for the ethaddr environment variables to be
38 overwritten one time per boot, only. This allows for a default
39 to be installed in the environment, which can be changed exactly ONCE
40 by the user.
41
Tom Rini0459c6b2022-06-12 20:01:58 -040042config ENV_MIN_ENTRIES
43 int "Minimum number of entries in the environment hashtable"
44 default 64
45 help
46 Minimum number of entries in the hash table that is used internally
47 to store the environment settings.
48
49config ENV_MAX_ENTRIES
50 int "Maximumm number of entries in the environment hashtable"
51 default 512
52 help
53 Maximum number of entries in the hash table that is used internally
54 to store the environment settings. The default setting is supposed to
55 be generous and should work in most cases. This setting can be used
56 to tune behaviour; see lib/hashtable.c for details.
57
Troy Kisky91229722023-03-13 14:31:24 -070058config ENV_IS_DEFAULT
59 def_bool y if !ENV_IS_IN_EEPROM && !ENV_IS_IN_EXT4 && \
Patrice Chotardaf755812019-05-07 11:24:02 +020060 !ENV_IS_IN_FAT && !ENV_IS_IN_FLASH && \
61 !ENV_IS_IN_MMC && !ENV_IS_IN_NAND && \
62 !ENV_IS_IN_NVRAM && !ENV_IS_IN_ONENAND && \
63 !ENV_IS_IN_REMOTE && !ENV_IS_IN_SPI_FLASH && \
64 !ENV_IS_IN_UBI
Troy Kisky91229722023-03-13 14:31:24 -070065 select ENV_IS_NOWHERE
66
67config ENV_IS_NOWHERE
68 bool "Environment is not stored"
Simon Glass87551f12017-08-03 12:21:59 -060069 help
Troy Kisky91229722023-03-13 14:31:24 -070070 Define this if you don't care whether or not an environment is stored
Shyam Sainiefe757c2018-06-07 19:47:19 +053071 on a storage medium. In this case the environment will still exist
Troy Kisky91229722023-03-13 14:31:24 -070072 while U-Boot is running, but once U-Boot exits it may not be
73 stored. If no other ENV_IS_IN_ is defined, U-Boot will always start
74 up with the default environment.
Simon Glass87551f12017-08-03 12:21:59 -060075
Simon Glass547cb402017-08-03 12:21:49 -060076config ENV_IS_IN_EEPROM
77 bool "Environment in EEPROM"
78 depends on !CHAIN_OF_TRUST
79 help
80 Use this if you have an EEPROM or similar serial access
81 device and a driver for it.
82
83 - CONFIG_ENV_OFFSET:
84 - CONFIG_ENV_SIZE:
85
86 These two #defines specify the offset and size of the
87 environment area within the total memory of your EEPROM.
88
Simon Glass547cb402017-08-03 12:21:49 -060089 Note that we consider the length of the address field to
90 still be one byte because the extra address bits are hidden
91 in the chip address.
92
Simon Glass547cb402017-08-03 12:21:49 -060093 EEPROM which holds the environment, is reached over
94 a pca9547 i2c mux with address 0x70, channel 3.
95
96config ENV_IS_IN_FAT
97 bool "Environment is in a FAT filesystem"
98 depends on !CHAIN_OF_TRUST
Maxime Ripard7569e182018-01-23 21:17:01 +010099 default y if ARCH_BCM283X
Maxime Ripard8b7dcd32018-01-23 21:17:04 +0100100 default y if ARCH_SUNXI && MMC
Maxime Ripard7569e182018-01-23 21:17:01 +0100101 default y if MMC_OMAP_HS && TI_COMMON_CMD_OPTIONS
Tuomas Tynkkynendc256cd2018-01-05 02:45:19 +0200102 select FS_FAT
Simon Glass547cb402017-08-03 12:21:49 -0600103 select FAT_WRITE
104 help
Simon Glassea8bf842017-08-03 12:21:50 -0600105 Define this if you want to use the FAT file system for the environment.
Simon Glass547cb402017-08-03 12:21:49 -0600106
Jorge Ramirez-Ortiz4a4c26d2018-01-10 11:33:48 +0100107config ENV_IS_IN_EXT4
108 bool "Environment is in a EXT4 filesystem"
109 depends on !CHAIN_OF_TRUST
Michal Simek4b4ba3c2020-08-19 10:44:23 +0200110 select FS_EXT4
Jorge Ramirez-Ortiz4a4c26d2018-01-10 11:33:48 +0100111 select EXT4_WRITE
112 help
113 Define this if you want to use the EXT4 file system for the environment.
114
Simon Glass547cb402017-08-03 12:21:49 -0600115config ENV_IS_IN_FLASH
116 bool "Environment in flash memory"
117 depends on !CHAIN_OF_TRUST
Maxime Ripard7569e182018-01-23 21:17:01 +0100118 default y if ARCH_CINTEGRATOR
119 default y if ARCH_INTEGRATOR_CP
Tom Rini7ab2f5f2021-05-14 21:34:10 -0400120 default y if M548x || M547x || M5282
Maxime Ripard7569e182018-01-23 21:17:01 +0100121 default y if MCF532x || MCF52x2
122 default y if MPC86xx || MPC83xx
Tom Rinie5404982021-05-14 21:34:26 -0400123 default y if ARCH_MPC8548
Maxime Ripard7569e182018-01-23 21:17:01 +0100124 default y if SH && !CPU_SH4
Simon Glass547cb402017-08-03 12:21:49 -0600125 help
126 Define this if you have a flash device which you want to use for the
127 environment.
128
129 a) The environment occupies one whole flash sector, which is
130 "embedded" in the text segment with the U-Boot code. This
131 happens usually with "bottom boot sector" or "top boot
132 sector" type flash chips, which have several smaller
133 sectors at the start or the end. For instance, such a
134 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
135 such a case you would place the environment in one of the
136 4 kB sectors - with U-Boot code before and after it. With
137 "top boot sector" type flash chips, you would put the
138 environment in one of the last sectors, leaving a gap
139 between U-Boot and the environment.
140
141 CONFIG_ENV_OFFSET:
142
143 Offset of environment data (variable area) to the
144 beginning of flash memory; for instance, with bottom boot
145 type flash chips the second sector can be used: the offset
146 for this sector is given here.
147
Tom Rini6a5dccc2022-11-16 13:10:41 -0500148 CONFIG_ENV_OFFSET is used relative to CFG_SYS_FLASH_BASE.
Simon Glass547cb402017-08-03 12:21:49 -0600149
150 CONFIG_ENV_ADDR:
151
152 This is just another way to specify the start address of
153 the flash sector containing the environment (instead of
154 CONFIG_ENV_OFFSET).
155
156 CONFIG_ENV_SECT_SIZE:
157
158 Size of the sector containing the environment.
159
160
161 b) Sometimes flash chips have few, equal sized, BIG sectors.
162 In such a case you don't want to spend a whole sector for
163 the environment.
164
165 CONFIG_ENV_SIZE:
166
167 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
168 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
169 of this flash sector for the environment. This saves
170 memory for the RAM copy of the environment.
171
172 It may also save flash memory if you decide to use this
173 when your environment is "embedded" within U-Boot code,
174 since then the remainder of the flash sector could be used
175 for U-Boot code. It should be pointed out that this is
176 STRONGLY DISCOURAGED from a robustness point of view:
177 updating the environment in flash makes it always
178 necessary to erase the WHOLE sector. If something goes
179 wrong before the contents has been restored from a copy in
180 RAM, your target system will be dead.
181
182 CONFIG_ENV_ADDR_REDUND
Simon Glass547cb402017-08-03 12:21:49 -0600183
184 These settings describe a second storage area used to hold
185 a redundant copy of the environment data, so that there is
186 a valid backup copy in case there is a power failure during
187 a "saveenv" operation.
188
189 BE CAREFUL! Any changes to the flash layout, and some changes to the
190 source code will make it necessary to adapt <board>/u-boot.lds*
191 accordingly!
192
193config ENV_IS_IN_MMC
194 bool "Environment in an MMC device"
195 depends on !CHAIN_OF_TRUST
Maxime Ripard662a1ec2018-01-23 21:17:00 +0100196 depends on MMC
Maxime Ripard7569e182018-01-23 21:17:01 +0100197 default y if ARCH_EXYNOS4
198 default y if MX6SX || MX7D
199 default y if TEGRA30 || TEGRA124
200 default y if TEGRA_ARMV8_COMMON
Simon Glass547cb402017-08-03 12:21:49 -0600201 help
202 Define this if you have an MMC device which you want to use for the
203 environment.
204
205 CONFIG_SYS_MMC_ENV_DEV:
206
207 Specifies which MMC device the environment is stored in.
208
209 CONFIG_SYS_MMC_ENV_PART (optional):
210
211 Specifies which MMC partition the environment is stored in. If not
212 set, defaults to partition 0, the user area. Common values might be
213 1 (first MMC boot partition), 2 (second MMC boot partition).
214
215 CONFIG_ENV_OFFSET:
216 CONFIG_ENV_SIZE:
217
218 These two #defines specify the offset and size of the environment
219 area within the specified MMC device.
220
221 If offset is positive (the usual case), it is treated as relative to
222 the start of the MMC partition. If offset is negative, it is treated
223 as relative to the end of the MMC partition. This can be useful if
224 your board may be fitted with different MMC devices, which have
225 different sizes for the MMC partitions, and you always want the
226 environment placed at the very end of the partition, to leave the
227 maximum possible space before it, to store other data.
228
229 These two values are in units of bytes, but must be aligned to an
230 MMC sector boundary.
231
232 CONFIG_ENV_OFFSET_REDUND (optional):
233
234 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
235 hold a redundant copy of the environment data. This provides a
236 valid backup copy in case the other copy is corrupted, e.g. due
237 to a power failure during a "saveenv" operation.
238
239 This value may also be positive or negative; this is handled in the
240 same way as CONFIG_ENV_OFFSET.
241
Marek Vasut509f36e2021-10-17 19:23:36 +0200242 In case CONFIG_SYS_MMC_ENV_PART is 1 (i.e. environment in eMMC boot
243 partition) then setting CONFIG_ENV_OFFSET_REDUND to the same value
244 as CONFIG_ENV_OFFSET makes use of the second eMMC boot partition for
245 the redundant environment copy.
246
Simon Glass547cb402017-08-03 12:21:49 -0600247 This value is also in units of bytes, but must also be aligned to
248 an MMC sector boundary.
249
Patrick Delaunay41e143f2022-11-10 11:49:01 +0100250 CONFIG_ENV_MMC_USE_DT (optional):
251
252 These define forces the configuration by the config node in device
253 tree with partition name: "u-boot,mmc-env-partition" or with
254 offset: "u-boot,mmc-env-offset", "u-boot,mmc-env-offset-redundant".
255 CONFIG_ENV_OFFSET and CONFIG_ENV_OFFSET_REDUND are not used.
256
Simon Glass547cb402017-08-03 12:21:49 -0600257config ENV_IS_IN_NAND
258 bool "Environment in a NAND device"
259 depends on !CHAIN_OF_TRUST
260 help
261 Define this if you have a NAND device which you want to use for the
262 environment.
263
264 - CONFIG_ENV_OFFSET:
265 - CONFIG_ENV_SIZE:
266
267 These two #defines specify the offset and size of the environment
268 area within the first NAND device. CONFIG_ENV_OFFSET must be
269 aligned to an erase block boundary.
270
271 - CONFIG_ENV_OFFSET_REDUND (optional):
272
273 This setting describes a second storage area of CONFIG_ENV_SIZE
274 size used to hold a redundant copy of the environment data, so
275 that there is a valid backup copy in case there is a power failure
276 during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
277 aligned to an erase block boundary.
278
Simon Glass547cb402017-08-03 12:21:49 -0600279 - CONFIG_ENV_OFFSET_OOB (optional):
280
281 Enables support for dynamically retrieving the offset of the
282 environment from block zero's out-of-band data. The
283 "nand env.oob" command can be used to record this offset.
284 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
285 using CONFIG_ENV_OFFSET_OOB.
286
Tom Rini0eeb1c72022-06-13 22:57:33 -0400287config ENV_RANGE
288 hex "Length of the region in which the environment can be written"
289 depends on ENV_IS_IN_NAND
290 range ENV_SIZE 0x7fffffff
291 default ENV_SIZE
292 help
293 This should be a multiple of the NAND device's block size.
294 Specifying a range with more erase blocks than are needed to hold
295 CONFIG_ENV_SIZE allows bad blocks within the range to be avoided.
296
Simon Glass547cb402017-08-03 12:21:49 -0600297config ENV_IS_IN_NVRAM
298 bool "Environment in a non-volatile RAM"
299 depends on !CHAIN_OF_TRUST
300 help
301 Define this if you have some non-volatile memory device
302 (NVRAM, battery buffered SRAM) which you want to use for the
303 environment.
304
305 - CONFIG_ENV_ADDR:
306 - CONFIG_ENV_SIZE:
307
308 These two #defines are used to determine the memory area you
309 want to use for environment. It is assumed that this memory
310 can just be read and written to, without any special
311 provision.
312
313config ENV_IS_IN_ONENAND
314 bool "Environment is in OneNAND"
Tom Rini67ecd622024-04-27 08:10:52 -0600315 depends on !CHAIN_OF_TRUST && CMD_ONENAND
Simon Glass547cb402017-08-03 12:21:49 -0600316 help
317 Define this if you want to put your local device's environment in
318 OneNAND.
319
320 - CONFIG_ENV_ADDR:
321 - CONFIG_ENV_SIZE:
322
323 These two #defines are used to determine the device range you
324 want to use for environment. It is assumed that this memory
325 can just be read and written to, without any special
326 provision.
327
328config ENV_IS_IN_REMOTE
Heinrich Schuchardtaefbfe12018-03-17 22:53:11 +0000329 bool "Environment is in remote memory space"
Simon Glass547cb402017-08-03 12:21:49 -0600330 depends on !CHAIN_OF_TRUST
331 help
332 Define this if you have a remote memory space which you
333 want to use for the local device's environment.
334
335 - CONFIG_ENV_ADDR:
336 - CONFIG_ENV_SIZE:
337
338 These two #defines specify the address and size of the
339 environment area within the remote memory space. The
340 local device can get the environment from remote memory
341 space by SRIO or PCIE links.
342
343config ENV_IS_IN_SPI_FLASH
344 bool "Environment is in SPI flash"
Tom Rini7e28ea82024-01-10 13:46:08 -0500345 depends on !CHAIN_OF_TRUST && (SPI_FLASH || DM_SPI_FLASH)
Maxime Ripard7569e182018-01-23 21:17:01 +0100346 default y if ARMADA_XP
347 default y if INTEL_BAYTRAIL
348 default y if INTEL_BRASWELL
349 default y if INTEL_BROADWELL
350 default y if NORTHBRIDGE_INTEL_IVYBRIDGE
351 default y if INTEL_QUARK
352 default y if INTEL_QUEENSBAY
Andre Przywarae28ff722022-01-11 12:46:05 +0000353 default y if ARCH_SUNXI
Simon Glass547cb402017-08-03 12:21:49 -0600354 help
355 Define this if you have a SPI Flash memory device which you
356 want to use for the environment.
357
358 - CONFIG_ENV_OFFSET:
359 - CONFIG_ENV_SIZE:
360
361 These two #defines specify the offset and size of the
362 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
363 aligned to an erase sector boundary.
364
365 - CONFIG_ENV_SECT_SIZE:
366
367 Define the SPI flash's sector size.
368
369 - CONFIG_ENV_OFFSET_REDUND (optional):
370
371 This setting describes a second storage area of CONFIG_ENV_SIZE
372 size used to hold a redundant copy of the environment data, so
373 that there is a valid backup copy in case there is a power failure
374 during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
375 aligned to an erase sector boundary.
376
Rasmus Villemoese535f5b2021-04-14 20:51:43 +0200377config ENV_SECT_SIZE_AUTO
378 bool "Use automatically detected sector size"
379 depends on ENV_IS_IN_SPI_FLASH
380 help
381 Some boards exist in multiple variants, with different
382 flashes having different sector sizes. In such cases, you
383 can select this option to make U-Boot use the actual sector
384 size when figuring out how much to erase, which can thus be
385 more efficient on the flashes with smaller erase size. Since
386 the environment must always be aligned on a sector boundary,
387 CONFIG_ENV_OFFSET must be aligned to the largest of the
388 different sector sizes, and CONFIG_ENV_SECT_SIZE should be
389 set to that value.
390
Patrick Delaunayf8e932e2019-02-27 15:20:38 +0100391config ENV_SPI_BUS
392 int "Value of SPI flash bus 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_BUS
Patrick Delaunayf8e932e2019-02-27 15:20:38 +0100395 help
Tom Rini119d2fb2021-12-11 14:55:48 -0500396 Value the SPI bus and chip select for environment.
Simon Glass547cb402017-08-03 12:21:49 -0600397
Patrick Delaunayf8e932e2019-02-27 15:20:38 +0100398config ENV_SPI_CS
399 int "Value of SPI flash chip select for environment"
Patrick Delaunayf8e932e2019-02-27 15:20:38 +0100400 depends on ENV_IS_IN_SPI_FLASH
Tom Rini119d2fb2021-12-11 14:55:48 -0500401 default SF_DEFAULT_CS
Patrick Delaunayf8e932e2019-02-27 15:20:38 +0100402 help
Tom Rini119d2fb2021-12-11 14:55:48 -0500403 Value of the SPI chip select for environment.
Patrick Delaunayf8e932e2019-02-27 15:20:38 +0100404
405config ENV_SPI_MAX_HZ
Marek Vasutdfe74622019-05-04 19:10:05 +0200406 int "Value of SPI flash max frequency for environment"
Patrick Delaunayf8e932e2019-02-27 15:20:38 +0100407 depends on ENV_IS_IN_SPI_FLASH
Tom Rini119d2fb2021-12-11 14:55:48 -0500408 default SF_DEFAULT_SPEED
Patrick Delaunayf8e932e2019-02-27 15:20:38 +0100409 help
Tom Rini119d2fb2021-12-11 14:55:48 -0500410 Value of the SPI max work clock for environment.
Simon Glass547cb402017-08-03 12:21:49 -0600411
Patrick Delaunayf8e932e2019-02-27 15:20:38 +0100412config ENV_SPI_MODE
413 hex "Value of SPI flash work mode for environment"
Tom Rini119d2fb2021-12-11 14:55:48 -0500414 depends on ENV_IS_IN_SPI_FLASH
415 default SF_DEFAULT_MODE
Patrick Delaunayf8e932e2019-02-27 15:20:38 +0100416 help
417 Value of the SPI work mode for environment.
418 See include/spi.h for value.
Simon Glass547cb402017-08-03 12:21:49 -0600419
Heiko Schocher704d21c2020-10-10 10:28:05 +0200420config ENV_SPI_EARLY
421 bool "Access Environment in SPI flashes before relocation"
422 depends on ENV_IS_IN_SPI_FLASH
423 help
424 Enable this if you want to use Environment in SPI flash
425 before relocation. Call env_init() and than you can use
426 env_get_f() for accessing Environment variables.
427
Simon Glass547cb402017-08-03 12:21:49 -0600428config ENV_IS_IN_UBI
429 bool "Environment in a UBI volume"
430 depends on !CHAIN_OF_TRUST
Miquel Raynal27271b62019-10-03 19:50:12 +0200431 depends on MTD_UBI
432 depends on CMD_UBI
Simon Glass547cb402017-08-03 12:21:49 -0600433 help
434 Define this if you have an UBI volume that you want to use for the
435 environment. This has the benefit of wear-leveling the environment
436 accesses, which is important on NAND.
437
438 - CONFIG_ENV_UBI_PART:
439
440 Define this to a string that is the mtd partition containing the UBI.
441
442 - CONFIG_ENV_UBI_VOLUME:
443
444 Define this to the name of the volume that you want to store the
445 environment in.
446
447 - CONFIG_ENV_UBI_VOLUME_REDUND:
448
449 Define this to the name of another volume to store a second copy of
450 the environment in. This will enable redundant environments in UBI.
451 It is assumed that both volumes are in the same MTD partition.
452
Tom Rini4bb26a42019-11-10 11:28:03 -0500453config SYS_REDUNDAND_ENVIRONMENT
454 bool "Enable redundant environment support"
Tom Rini4bb26a42019-11-10 11:28:03 -0500455 help
456 Normally, the environemt is stored in a single location. By
457 selecting this option, you can then define where to hold a redundant
458 copy of the environment data, so that there is a valid backup copy in
459 case there is a power failure during a "saveenv" operation.
Michal Simekcc780ec2021-01-13 10:25:50 +0100460 Also this config changes the binary environment structure handling
461 which is used by env import/export commands which are independent of
462 storing variables to redundant location on a non volatile device.
Tom Rini4bb26a42019-11-10 11:28:03 -0500463
Simon Glass547cb402017-08-03 12:21:49 -0600464config ENV_FAT_INTERFACE
465 string "Name of the block device for the environment"
466 depends on ENV_IS_IN_FAT
Michal Simek5227e1e2020-02-25 15:50:33 +0100467 default "mmc"
Simon Glass547cb402017-08-03 12:21:49 -0600468 help
469 Define this to a string that is the name of the block device.
470
471config ENV_FAT_DEVICE_AND_PART
472 string "Device and partition for where to store the environemt in FAT"
473 depends on ENV_IS_IN_FAT
474 default "0:1" if TI_COMMON_CMD_OPTIONS
Venkatesh Yadav Abbarapufc4884b2024-03-12 17:04:21 +0530475 default "0:auto" if ARCH_ZYNQ || ARCH_ZYNQMP || ARCH_VERSAL || ARCH_VERSAL_NET
Samuel Hollandbc42abb2021-04-18 22:16:21 -0500476 default ":auto" if ARCH_SUNXI
Simon Glass547cb402017-08-03 12:21:49 -0600477 default "0" if ARCH_AT91
478 help
479 Define this to a string to specify the partition of the device. It can
480 be as following:
481
482 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
483 - "D:P": device D partition P. Error occurs if device D has no
484 partition table.
485 - "D:0": device D.
486 - "D" or "D:": device D partition 1 if device D has partition
487 table, or the whole device D if has no partition
488 table.
489 - "D:auto": first partition in device D with bootable flag set.
490 If none, first valid partition in device D. If no
491 partition table then means device D.
492
David Woodhouse93365392020-06-19 23:07:17 +0100493 If ENV_FAT_INTERFACE is set to "mmc" then device 'D' can be omitted,
494 leaving the string starting with a colon, and the boot device will
495 be used.
496
Simon Glass547cb402017-08-03 12:21:49 -0600497config ENV_FAT_FILE
Shyam Sainiefe757c2018-06-07 19:47:19 +0530498 string "Name of the FAT file to use for the environment"
Simon Glass547cb402017-08-03 12:21:49 -0600499 depends on ENV_IS_IN_FAT
500 default "uboot.env"
501 help
502 It's a string of the FAT file name. This file use to store the
503 environment.
504
Brandon Maierf2815462021-01-16 15:14:43 -0600505config ENV_FAT_FILE_REDUND
506 string "Name of the FAT file to use for the environment"
507 depends on ENV_IS_IN_FAT && SYS_REDUNDAND_ENVIRONMENT
508 default "uboot-redund.env"
509 help
510 It's a string of the FAT file name. This file use to store the
511 redundant environment.
512
Jorge Ramirez-Ortiz4a4c26d2018-01-10 11:33:48 +0100513config ENV_EXT4_INTERFACE
514 string "Name of the block device for the environment"
515 depends on ENV_IS_IN_EXT4
516 help
517 Define this to a string that is the name of the block device.
518
519config ENV_EXT4_DEVICE_AND_PART
520 string "Device and partition for where to store the environemt in EXT4"
521 depends on ENV_IS_IN_EXT4
522 help
523 Define this to a string to specify the partition of the device. It can
524 be as following:
525
526 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
527 - "D:P": device D partition P. Error occurs if device D has no
528 partition table.
529 - "D:0": device D.
530 - "D" or "D:": device D partition 1 if device D has partition
531 table, or the whole device D if has no partition
532 table.
533 - "D:auto": first partition in device D with bootable flag set.
534 If none, first valid partition in device D. If no
535 partition table then means device D.
536
David Woodhouse6815e2c2020-08-04 10:05:47 +0100537 If ENV_EXT4_INTERFACE is set to "mmc" then device 'D' can be omitted,
538 leaving the string starting with a colon, and the boot device will
539 be used.
540
Jorge Ramirez-Ortiz4a4c26d2018-01-10 11:33:48 +0100541config ENV_EXT4_FILE
Shyam Sainiefe757c2018-06-07 19:47:19 +0530542 string "Name of the EXT4 file to use for the environment"
Jorge Ramirez-Ortiz4a4c26d2018-01-10 11:33:48 +0100543 depends on ENV_IS_IN_EXT4
Patrick Delaunay955b6712020-07-28 11:51:14 +0200544 default "/uboot.env"
Jorge Ramirez-Ortiz4a4c26d2018-01-10 11:33:48 +0100545 help
546 It's a string of the EXT4 file name. This file use to store the
547 environment (explicit path to the file)
548
Tom Rini5cd7ece2019-11-18 20:02:10 -0500549config ENV_ADDR
550 hex "Environment address"
551 depends on ENV_IS_IN_FLASH || ENV_IS_IN_NVRAM || ENV_IS_IN_ONENAND || \
552 ENV_IS_IN_REMOTE || ENV_IS_IN_SPI_FLASH
553 default 0x0 if ENV_IS_IN_SPI_FLASH
554 help
555 Offset from the start of the device (or partition)
556
557config ENV_ADDR_REDUND
558 hex "Redundant environment address"
559 depends on ENV_IS_IN_FLASH && SYS_REDUNDAND_ENVIRONMENT
560 help
561 Offset from the start of the device (or partition) of the redundant
562 environment location.
Simon Glass547cb402017-08-03 12:21:49 -0600563
564config ENV_OFFSET
Tom Rini5cd7ece2019-11-18 20:02:10 -0500565 hex "Environment offset"
566 depends on ENV_IS_IN_EEPROM || ENV_IS_IN_MMC || ENV_IS_IN_NAND || \
567 ENV_IS_IN_SPI_FLASH
Jagan Tekic4ec2262019-12-21 13:24:35 +0530568 default 0x3f8000 if ARCH_ROCKCHIP && ENV_IS_IN_MMC
Jagan Teki68397572019-12-21 13:24:36 +0530569 default 0x140000 if ARCH_ROCKCHIP && ENV_IS_IN_SPI_FLASH
Andre Przywaracf844082022-01-11 12:46:03 +0000570 default 0xF0000 if ARCH_SUNXI
Michal Simeke93ef192018-07-19 08:45:45 +0200571 default 0xE0000 if ARCH_ZYNQ
572 default 0x1E00000 if ARCH_ZYNQMP
Michal Simek2e53eb22022-09-19 14:21:02 +0200573 default 0x7F40000 if ARCH_VERSAL || ARCH_VERSAL_NET
Tom Rinif18679c2023-08-02 11:09:43 -0400574 default 0x0 if ARC
Markus Klotzbuecher7bd60e62019-05-15 15:15:54 +0200575 default 0x140000 if ARCH_AT91
576 default 0x260000 if ARCH_OMAP2PLUS
Varalaxmi Bingi52e79212020-02-05 03:58:20 -0700577 default 0x1080000 if MICROBLAZE && ENV_IS_IN_SPI_FLASH
Simon Glass547cb402017-08-03 12:21:49 -0600578 help
Paul Barker86e23d12023-09-01 15:28:59 +0100579 Offset from the start of the device (or partition).
580
581 This offset may be interpreted differently depending on the chosen
582 ENV_IS_IN_* options. For example, for ENV_IS_IN_MMC=y, this offset may
583 be negative to indicate an offset backwards from the end of the
584 partition. See the relevant help messages for more details.
Simon Glass547cb402017-08-03 12:21:49 -0600585
Tom Rini5cd7ece2019-11-18 20:02:10 -0500586config ENV_OFFSET_REDUND
587 hex "Redundant environment offset"
588 depends on (ENV_IS_IN_EEPROM || ENV_IS_IN_MMC || ENV_IS_IN_NAND || \
589 ENV_IS_IN_SPI_FLASH) && SYS_REDUNDAND_ENVIRONMENT
T Karthik Reddy5bb3d912022-08-24 13:23:26 +0200590 default 0x10C0000 if MICROBLAZE
Tom Rinif18679c2023-08-02 11:09:43 -0400591 default 0x0
Tom Rini5cd7ece2019-11-18 20:02:10 -0500592 help
593 Offset from the start of the device (or partition) of the redundant
594 environment location.
595
Paul Barker86e23d12023-09-01 15:28:59 +0100596 This offset may be interpreted differently depending on the chosen
597 ENV_IS_IN_* options. For example, for ENV_IS_IN_MMC=y, this offset may
598 be negative to indicate an offset backwards from the end of the
599 partition. See the relevant help messages for more details.
600
Simon Glass547cb402017-08-03 12:21:49 -0600601config ENV_SIZE
602 hex "Environment Size"
Michal Simeke93ef192018-07-19 08:45:45 +0200603 default 0x40000 if ENV_IS_IN_SPI_FLASH && ARCH_ZYNQMP
Andre Przywaracf844082022-01-11 12:46:03 +0000604 default 0x20000 if ARCH_ZYNQ || ARCH_OMAP2PLUS || ARCH_AT91
605 default 0x10000 if ARCH_SUNXI
Jagan Tekic4ec2262019-12-21 13:24:35 +0530606 default 0x8000 if ARCH_ROCKCHIP && ENV_IS_IN_MMC
Jagan Teki68397572019-12-21 13:24:36 +0530607 default 0x2000 if ARCH_ROCKCHIP && ENV_IS_IN_SPI_FLASH
Michal Simek2e53eb22022-09-19 14:21:02 +0200608 default 0x8000 if ARCH_ZYNQMP || ARCH_VERSAL || ARCH_VERSAL_NET
Alexey Brodkin07dfc092019-01-15 11:42:48 +0300609 default 0x4000 if ARC
Markus Klotzbuecher7bd60e62019-05-15 15:15:54 +0200610 default 0x1f000
Simon Glass547cb402017-08-03 12:21:49 -0600611 help
612 Size of the environment storage area
613
Michal Simeke93ef192018-07-19 08:45:45 +0200614config ENV_SECT_SIZE
615 hex "Environment Sector-Size"
Tom Rini5cd7ece2019-11-18 20:02:10 -0500616 depends on ENV_IS_IN_FLASH || ENV_IS_IN_SPI_FLASH
Jagan Teki68397572019-12-21 13:24:36 +0530617 default 0x2000 if ARCH_ROCKCHIP
Michal Simek2e53eb22022-09-19 14:21:02 +0200618 default 0x40000 if ARCH_ZYNQMP || ARCH_VERSAL || ARCH_VERSAL_NET
Markus Klotzbuecher7bd60e62019-05-15 15:15:54 +0200619 default 0x20000 if ARCH_ZYNQ || ARCH_OMAP2PLUS || ARCH_AT91
Varalaxmi Bingi52e79212020-02-05 03:58:20 -0700620 default 0x20000 if MICROBLAZE && ENV_IS_IN_SPI_FLASH
Andre Przywaracf844082022-01-11 12:46:03 +0000621 default 0x10000 if ARCH_SUNXI && ENV_IS_IN_SPI_FLASH
Michal Simeke93ef192018-07-19 08:45:45 +0200622 help
623 Size of the sector containing the environment.
624
Simon Glass547cb402017-08-03 12:21:49 -0600625config ENV_UBI_PART
626 string "UBI partition name"
627 depends on ENV_IS_IN_UBI
628 help
629 MTD partition containing the UBI device
630
631config ENV_UBI_VOLUME
632 string "UBI volume name"
633 depends on ENV_IS_IN_UBI
634 help
635 Name of the volume that you want to store the environment in.
636
Markus Klotzbuecher975bcde2019-05-15 15:15:53 +0200637config ENV_UBI_VOLUME_REDUND
638 string "UBI redundant volume name"
Tom Rini4bb26a42019-11-10 11:28:03 -0500639 depends on ENV_IS_IN_UBI && SYS_REDUNDAND_ENVIRONMENT
Markus Klotzbuecher975bcde2019-05-15 15:15:53 +0200640 help
641 Name of the redundant volume that you want to store the environment in.
642
Hamish Guthrie674ab242019-05-15 15:15:55 +0200643config ENV_UBI_VID_OFFSET
644 int "ubi environment VID offset"
645 depends on ENV_IS_IN_UBI
646 default 0
647 help
648 UBI VID offset for environment. If 0, no custom VID offset is used.
649
Tom Rinica63e712019-11-12 22:46:36 -0500650config SYS_RELOC_GD_ENV_ADDR
Patrick Delaunay9f757532020-06-10 19:28:42 +0200651 bool "Relocate gd->env_addr"
Tom Rinica63e712019-11-12 22:46:36 -0500652 help
653 Relocate the early env_addr pointer so we know it is not inside
654 the binary. Some systems need this and for the rest, it doesn't hurt.
655
Tom Rinieb1f9092020-07-24 17:14:47 -0400656config SYS_MMC_ENV_DEV
657 int "mmc device number"
Laurentiu Tudorccb2fbf2023-08-23 16:25:46 +0300658 depends on ENV_IS_IN_MMC || ENV_IS_IN_FAT || \
Kuldeep Singhd6cfb902021-08-10 11:20:06 +0530659 CMD_MVEBU_BUBT || FMAN_ENET || QE || PHY_CORTINA
Tom Rinieb1f9092020-07-24 17:14:47 -0400660 default 0
661 help
662 MMC device number on the platform where the environment is stored.
663
664config SYS_MMC_ENV_PART
665 int "mmc partition number"
666 depends on ENV_IS_IN_MMC || ENV_IS_IN_FAT
667 default 0
668 help
669 MMC hardware partition device number on the platform where the
670 environment is stored. Note that this is not related to any software
671 defined partition table but instead if we are in the user area, which is
672 partition 0 or the first boot partition, which is 1 or some other defined
673 partition.
674
Emmanuel Di Fedeb6601dd2023-06-14 12:05:28 +0200675config USE_ENV_MMC_PARTITION
676 bool "use the mmc environment partition name"
677 depends on ENV_IS_IN_MMC
678
679config ENV_MMC_PARTITION
680 string "mmc environment partition name"
681 depends on USE_ENV_MMC_PARTITION
682 help
683 MMC partition name used to save environment variables.
684 If this variable is unset, u-boot will try to get the env partition name
685 from the device-tree's /config node.
686
Patrick Delaunay41e143f2022-11-10 11:49:01 +0100687config ENV_MMC_USE_DT
688 bool "Read partition name and offset in DT"
689 depends on ENV_IS_IN_MMC && OF_CONTROL
690 help
691 Only use the device tree to get the environment location in MMC
692 device, with partition name or with offset.
693 The 2 defines CONFIG_ENV_OFFSET, CONFIG_ENV_OFFSET_REDUND
694 are not used as fallback.
695
Rasmus Villemoes14c71142018-03-20 11:38:45 +0100696config USE_DEFAULT_ENV_FILE
697 bool "Create default environment from file"
698 help
699 Normally, the default environment is automatically generated
700 based on the settings of various CONFIG_* options, as well
Tom Rinic9edebe2022-12-04 10:03:50 -0500701 as the CFG_EXTRA_ENV_SETTINGS. By selecting this option,
Rasmus Villemoes14c71142018-03-20 11:38:45 +0100702 you can instead define the entire default environment in an
703 external file.
704
705config DEFAULT_ENV_FILE
706 string "Path to default environment file"
707 depends on USE_DEFAULT_ENV_FILE
708 help
709 The path containing the default environment. The format is
710 the same as accepted by the mkenvimage tool: lines
711 containing key=value pairs, blank lines and lines beginning
712 with # are ignored.
713
Alex Kiernana410d6e2018-04-01 16:37:53 +0000714config ENV_VARS_UBOOT_RUNTIME_CONFIG
715 bool "Add run-time information to the environment"
716 help
717 Enable this in order to add variables describing certain
718 run-time determined information about the hardware to the
719 environment. These will be named board_name, board_rev.
720
Ovidiu Panait86ccd752020-05-06 20:38:42 +0300721config DELAY_ENVIRONMENT
722 bool "Delay environment loading"
723 depends on !OF_CONTROL
724 help
725 Enable this to inhibit loading the environment during board
726 initialization. This can address the security risk of untrusted data
727 being used during boot. Normally the environment is loaded when the
728 board is initialised so that it is available to U-Boot. This inhibits
729 that so that the environment is not available until explicitly loaded
730 later by U-Boot code. With CONFIG_OF_CONTROL this is instead
731 controlled by the value of /config/load-environment.
732
Rasmus Villemoescf8e5432021-04-21 11:06:54 +0200733config ENV_IMPORT_FDT
734 bool "Amend environment by FDT properties"
735 depends on OF_CONTROL
736 help
737 If selected, after the environment has been loaded from its
738 persistent location, the "env_fdt_path" variable is looked
739 up and used as a path to a node in the control DTB. The
740 property/value pairs in that node is then used to update the
741 run-time environment. This can be useful to use the same
742 U-Boot binary with different board variants.
743
744config ENV_FDT_PATH
745 string "Default value for env_fdt_path variable"
746 depends on ENV_IMPORT_FDT
747 default "/config/environment"
748 help
749 The initial value of the env_fdt_path variable.
750
Marek Vasuta7b82672020-07-07 20:51:38 +0200751config ENV_APPEND
752 bool "Always append the environment with new data"
Marek Vasuta7b82672020-07-07 20:51:38 +0200753 help
754 If defined, the environment hash table is only ever appended with new
755 data, but the existing hash table can never be dropped and reloaded
756 with newly imported data. This may be used in combination with static
757 flags to e.g. to protect variables which must not be modified.
758
Marek Vasut803549f2020-07-07 20:51:39 +0200759config ENV_WRITEABLE_LIST
760 bool "Permit write access only to listed variables"
Jan Kiszka755703b2023-02-03 13:22:51 +0100761 select ENV_APPEND
Marek Vasut803549f2020-07-07 20:51:39 +0200762 help
763 If defined, only environment variables which explicitly set the 'w'
764 writeable flag can be written and modified at runtime. No variables
765 can be otherwise created, written or imported into the environment.
766
Marek Vasutb7f3f232020-05-22 01:10:14 +0200767config ENV_ACCESS_IGNORE_FORCE
768 bool "Block forced environment operations"
Marek Vasutb7f3f232020-05-22 01:10:14 +0200769 help
770 If defined, don't allow the -f switch to env set override variable
771 access flags.
772
York Sun187da8d2018-06-26 10:03:22 -0700773if SPL_ENV_SUPPORT
774config SPL_ENV_IS_NOWHERE
775 bool "SPL Environment is not stored"
776 default y if ENV_IS_NOWHERE
777 help
778 Similar to ENV_IS_NOWHERE, used for SPL environment.
779
780config SPL_ENV_IS_IN_MMC
781 bool "SPL Environment in an MMC device"
782 depends on !SPL_ENV_IS_NOWHERE
783 depends on ENV_IS_IN_MMC
784 default y
785 help
786 Similar to ENV_IS_IN_MMC, used for SPL environment.
787
788config SPL_ENV_IS_IN_FAT
789 bool "SPL Environment is in a FAT filesystem"
790 depends on !SPL_ENV_IS_NOWHERE
791 depends on ENV_IS_IN_FAT
792 default y
793 help
794 Similar to ENV_IS_IN_FAT, used for SPL environment.
795
796config SPL_ENV_IS_IN_EXT4
797 bool "SPL Environment is in a EXT4 filesystem"
798 depends on !SPL_ENV_IS_NOWHERE
799 depends on ENV_IS_IN_EXT4
800 default y
801 help
802 Similar to ENV_IS_IN_EXT4, used for SPL environment.
803
804config SPL_ENV_IS_IN_NAND
805 bool "SPL Environment in a NAND device"
806 depends on !SPL_ENV_IS_NOWHERE
807 depends on ENV_IS_IN_NAND
808 default y
809 help
810 Similar to ENV_IS_IN_NAND, used for SPL environment.
811
812config SPL_ENV_IS_IN_SPI_FLASH
813 bool "SPL Environment is in SPI flash"
814 depends on !SPL_ENV_IS_NOWHERE
815 depends on ENV_IS_IN_SPI_FLASH
816 default y
817 help
818 Similar to ENV_IS_IN_SPI_FLASH, used for SPL environment.
819
820config SPL_ENV_IS_IN_FLASH
821 bool "SPL Environment in flash memory"
822 depends on !SPL_ENV_IS_NOWHERE
823 depends on ENV_IS_IN_FLASH
824 default y
825 help
826 Similar to ENV_IS_IN_FLASH, used for SPL environment.
827
828endif
829
830if TPL_ENV_SUPPORT
831
832config TPL_ENV_IS_NOWHERE
833 bool "TPL Environment is not stored"
834 default y if ENV_IS_NOWHERE
835 help
836 Similar to ENV_IS_NOWHERE, used for TPL environment.
837
838config TPL_ENV_IS_IN_MMC
839 bool "TPL Environment in an MMC device"
840 depends on !TPL_ENV_IS_NOWHERE
841 depends on ENV_IS_IN_MMC
842 default y
843 help
844 Similar to ENV_IS_IN_MMC, used for TPL environment.
845
846config TPL_ENV_IS_IN_FAT
847 bool "TPL Environment is in a FAT filesystem"
848 depends on !TPL_ENV_IS_NOWHERE
849 depends on ENV_IS_IN_FAT
850 default y
851 help
852 Similar to ENV_IS_IN_FAT, used for TPL environment.
853
854config TPL_ENV_IS_IN_EXT4
855 bool "TPL Environment is in a EXT4 filesystem"
856 depends on !TPL_ENV_IS_NOWHERE
857 depends on ENV_IS_IN_EXT4
858 default y
859 help
860 Similar to ENV_IS_IN_EXT4, used for TPL environment.
861
862config TPL_ENV_IS_IN_NAND
863 bool "TPL Environment in a NAND device"
864 depends on !TPL_ENV_IS_NOWHERE
865 depends on ENV_IS_IN_NAND
866 default y
867 help
868 Similar to ENV_IS_IN_NAND, used for TPL environment.
869
870config TPL_ENV_IS_IN_SPI_FLASH
871 bool "TPL Environment is in SPI flash"
872 depends on !TPL_ENV_IS_NOWHERE
873 depends on ENV_IS_IN_SPI_FLASH
874 default y
875 help
876 Similar to ENV_IS_IN_SPI_FLASH, used for TPL environment.
877
878config TPL_ENV_IS_IN_FLASH
879 bool "TPL Environment in flash memory"
880 depends on !TPL_ENV_IS_NOWHERE
881 depends on ENV_IS_IN_FLASH
882 default y
883 help
884 Similar to ENV_IS_IN_FLASH, used for TPL environment.
885
886endif
887
Simon Glassfb89f632023-02-22 09:34:00 -0700888if VPL_ENV_SUPPORT
889
890config VPL_ENV_IS_NOWHERE
891 bool "VPL Environment is not stored"
892 default y if ENV_IS_NOWHERE
893 help
894 Similar to ENV_IS_NOWHERE, used for VPL environment.
895
896endif # VPL_ENV_SUPPORT
897
Tom Rini5fb860c2022-02-25 11:19:48 -0500898config USE_BOOTFILE
899 bool "Add a 'bootfile' environment variable"
900 help
901 The "bootfile" variable is used in some cases to allow for
902 controlling what file U-Boot will attempt to load and boot. To set
903 this, enable this option and set the value in the next question.
904
905config BOOTFILE
906 string "'bootfile' environment variable value"
907 depends on USE_BOOTFILE
908 help
909 The value to set the "bootfile" variable to.
910
Tom Rinife586752022-03-11 09:12:07 -0500911config USE_ETHPRIME
912 bool "Add an 'ethprime' environment variable"
913 help
914 The "ethprime" variable is used in some cases to control which
915 network interface is used first.
916
917config ETHPRIME
918 string "'ethprime' environment variable value"
919 depends on USE_ETHPRIME
920 help
921 The value to set the "ethprime" variable to.
922
Tom Rini1479a832022-12-02 16:42:27 -0500923config USE_HOSTNAME
924 bool "Set a default 'hostname' value in the environment"
925 default y if X86
926
927config HOSTNAME
928 string "Value of the default 'hostname' value in the environment"
929 depends on USE_HOSTNAME
930 default "x86" if X86
931 default "unknown"
932
Simon Glass99298be2020-09-10 20:21:24 -0600933config VERSION_VARIABLE
934 bool "Add a 'ver' environment variable with the U-Boot version"
935 help
936 If this variable is defined, an environment variable
937 named "ver" is created by U-Boot showing the U-Boot
938 version as printed by the "version" command.
939 Any change to this variable will be reverted at the
940 next reset.
941
Simon Glass547cb402017-08-03 12:21:49 -0600942endmenu