Merge tag 'mmc-5-20' of https://github.com/MrVan/u-boot
[platform/kernel/u-boot.git] / env / Kconfig
1 menu "Environment"
2
3 config ENV_IS_NOWHERE
4         bool "Environment is not stored"
5         depends on !ENV_IS_IN_EEPROM
6         depends on !ENV_IS_IN_EXT4
7         depends on !ENV_IS_IN_FAT
8         depends on !ENV_IS_IN_FLASH
9         depends on !ENV_IS_IN_MMC
10         depends on !ENV_IS_IN_NAND
11         depends on !ENV_IS_IN_NVRAM
12         depends on !ENV_IS_IN_ONENAND
13         depends on !ENV_IS_IN_REMOTE
14         depends on !ENV_IS_IN_SPI_FLASH
15         depends on !ENV_IS_IN_UBI
16         default y
17         help
18           Define this if you don't want to or can't have an environment stored
19           on a storage medium. In this case the environment will still exist
20           while U-Boot is running, but once U-Boot exits it will not be
21           stored. U-Boot will therefore always start up with a default
22           environment.
23
24 config ENV_IS_IN_EEPROM
25         bool "Environment in EEPROM"
26         depends on !CHAIN_OF_TRUST
27         help
28           Use this if you have an EEPROM or similar serial access
29           device and a driver for it.
30
31           - CONFIG_ENV_OFFSET:
32           - CONFIG_ENV_SIZE:
33
34           These two #defines specify the offset and size of the
35           environment area within the total memory of your EEPROM.
36
37           Note that we consider the length of the address field to
38           still be one byte because the extra address bits are hidden
39           in the chip address.
40
41           - CONFIG_ENV_EEPROM_IS_ON_I2C
42           define this, if you have I2C and SPI activated, and your
43           EEPROM, which holds the environment, is on the I2C bus.
44
45           - CONFIG_I2C_ENV_EEPROM_BUS
46           if you have an Environment on an EEPROM reached over
47           I2C muxes, you can define here, how to reach this
48           EEPROM. For example:
49
50           #define CONFIG_I2C_ENV_EEPROM_BUS       1
51
52           EEPROM which holds the environment, is reached over
53           a pca9547 i2c mux with address 0x70, channel 3.
54
55 config ENV_IS_IN_FAT
56         bool "Environment is in a FAT filesystem"
57         depends on !CHAIN_OF_TRUST
58         default y if ARCH_BCM283X
59         default y if ARCH_SUNXI && MMC
60         default y if MMC_OMAP_HS && TI_COMMON_CMD_OPTIONS
61         select FS_FAT
62         select FAT_WRITE
63         help
64           Define this if you want to use the FAT file system for the environment.
65
66 config ENV_IS_IN_EXT4
67         bool "Environment is in a EXT4 filesystem"
68         depends on !CHAIN_OF_TRUST
69         select EXT4_WRITE
70         help
71           Define this if you want to use the EXT4 file system for the environment.
72
73 config ENV_IS_IN_FLASH
74         bool "Environment in flash memory"
75         depends on !CHAIN_OF_TRUST
76         default y if ARCH_CINTEGRATOR
77         default y if ARCH_INTEGRATOR_CP
78         default y if M548x || M547x || M5282 || MCF547x_8x
79         default y if MCF532x || MCF52x2
80         default y if MPC86xx || MPC83xx
81         default y if ARCH_MPC8572 || ARCH_MPC8548 || ARCH_MPC8641
82         default y if SH && !CPU_SH4
83         help
84           Define this if you have a flash device which you want to use for the
85           environment.
86
87           a) The environment occupies one whole flash sector, which is
88            "embedded" in the text segment with the U-Boot code. This
89            happens usually with "bottom boot sector" or "top boot
90            sector" type flash chips, which have several smaller
91            sectors at the start or the end. For instance, such a
92            layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
93            such a case you would place the environment in one of the
94            4 kB sectors - with U-Boot code before and after it. With
95            "top boot sector" type flash chips, you would put the
96            environment in one of the last sectors, leaving a gap
97            between U-Boot and the environment.
98
99           CONFIG_ENV_OFFSET:
100
101            Offset of environment data (variable area) to the
102            beginning of flash memory; for instance, with bottom boot
103            type flash chips the second sector can be used: the offset
104            for this sector is given here.
105
106            CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
107
108           CONFIG_ENV_ADDR:
109
110            This is just another way to specify the start address of
111            the flash sector containing the environment (instead of
112            CONFIG_ENV_OFFSET).
113
114           CONFIG_ENV_SECT_SIZE:
115
116            Size of the sector containing the environment.
117
118
119           b) Sometimes flash chips have few, equal sized, BIG sectors.
120            In such a case you don't want to spend a whole sector for
121            the environment.
122
123           CONFIG_ENV_SIZE:
124
125            If you use this in combination with CONFIG_ENV_IS_IN_FLASH
126            and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
127            of this flash sector for the environment. This saves
128            memory for the RAM copy of the environment.
129
130            It may also save flash memory if you decide to use this
131            when your environment is "embedded" within U-Boot code,
132            since then the remainder of the flash sector could be used
133            for U-Boot code. It should be pointed out that this is
134            STRONGLY DISCOURAGED from a robustness point of view:
135            updating the environment in flash makes it always
136            necessary to erase the WHOLE sector. If something goes
137            wrong before the contents has been restored from a copy in
138            RAM, your target system will be dead.
139
140           CONFIG_ENV_ADDR_REDUND
141           CONFIG_ENV_SIZE_REDUND
142
143            These settings describe a second storage area used to hold
144            a redundant copy of the environment data, so that there is
145            a valid backup copy in case there is a power failure during
146            a "saveenv" operation.
147
148           BE CAREFUL! Any changes to the flash layout, and some changes to the
149           source code will make it necessary to adapt <board>/u-boot.lds*
150           accordingly!
151
152 config ENV_IS_IN_MMC
153         bool "Environment in an MMC device"
154         depends on !CHAIN_OF_TRUST
155         depends on MMC
156         default y if ARCH_EXYNOS4
157         default y if MX6SX || MX7D
158         default y if TEGRA30 || TEGRA124
159         default y if TEGRA_ARMV8_COMMON
160         help
161           Define this if you have an MMC device which you want to use for the
162           environment.
163
164           CONFIG_SYS_MMC_ENV_DEV:
165
166           Specifies which MMC device the environment is stored in.
167
168           CONFIG_SYS_MMC_ENV_PART (optional):
169
170           Specifies which MMC partition the environment is stored in. If not
171           set, defaults to partition 0, the user area. Common values might be
172           1 (first MMC boot partition), 2 (second MMC boot partition).
173
174           CONFIG_ENV_OFFSET:
175           CONFIG_ENV_SIZE:
176
177           These two #defines specify the offset and size of the environment
178           area within the specified MMC device.
179
180           If offset is positive (the usual case), it is treated as relative to
181           the start of the MMC partition. If offset is negative, it is treated
182           as relative to the end of the MMC partition. This can be useful if
183           your board may be fitted with different MMC devices, which have
184           different sizes for the MMC partitions, and you always want the
185           environment placed at the very end of the partition, to leave the
186           maximum possible space before it, to store other data.
187
188           These two values are in units of bytes, but must be aligned to an
189           MMC sector boundary.
190
191           CONFIG_ENV_OFFSET_REDUND (optional):
192
193           Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
194           hold a redundant copy of the environment data. This provides a
195           valid backup copy in case the other copy is corrupted, e.g. due
196           to a power failure during a "saveenv" operation.
197
198           This value may also be positive or negative; this is handled in the
199           same way as CONFIG_ENV_OFFSET.
200
201           This value is also in units of bytes, but must also be aligned to
202           an MMC sector boundary.
203
204           CONFIG_ENV_SIZE_REDUND (optional):
205
206           This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
207           set. If this value is set, it must be set to the same value as
208           CONFIG_ENV_SIZE.
209
210 config ENV_IS_IN_NAND
211         bool "Environment in a NAND device"
212         depends on !CHAIN_OF_TRUST
213         help
214           Define this if you have a NAND device which you want to use for the
215           environment.
216
217           - CONFIG_ENV_OFFSET:
218           - CONFIG_ENV_SIZE:
219
220           These two #defines specify the offset and size of the environment
221           area within the first NAND device.  CONFIG_ENV_OFFSET must be
222           aligned to an erase block boundary.
223
224           - CONFIG_ENV_OFFSET_REDUND (optional):
225
226           This setting describes a second storage area of CONFIG_ENV_SIZE
227           size used to hold a redundant copy of the environment data, so
228           that there is a valid backup copy in case there is a power failure
229           during a "saveenv" operation.  CONFIG_ENV_OFFSET_REDUND must be
230           aligned to an erase block boundary.
231
232           - CONFIG_ENV_RANGE (optional):
233
234           Specifies the length of the region in which the environment
235           can be written.  This should be a multiple of the NAND device's
236           block size.  Specifying a range with more erase blocks than
237           are needed to hold CONFIG_ENV_SIZE allows bad blocks within
238           the range to be avoided.
239
240           - CONFIG_ENV_OFFSET_OOB (optional):
241
242           Enables support for dynamically retrieving the offset of the
243           environment from block zero's out-of-band data.  The
244           "nand env.oob" command can be used to record this offset.
245           Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
246           using CONFIG_ENV_OFFSET_OOB.
247
248 config ENV_IS_IN_NVRAM
249         bool "Environment in a non-volatile RAM"
250         depends on !CHAIN_OF_TRUST
251         help
252           Define this if you have some non-volatile memory device
253           (NVRAM, battery buffered SRAM) which you want to use for the
254           environment.
255
256           - CONFIG_ENV_ADDR:
257           - CONFIG_ENV_SIZE:
258
259           These two #defines are used to determine the memory area you
260           want to use for environment. It is assumed that this memory
261           can just be read and written to, without any special
262           provision.
263
264 config ENV_IS_IN_ONENAND
265         bool "Environment is in OneNAND"
266         depends on !CHAIN_OF_TRUST
267         help
268           Define this if you want to put your local device's environment in
269           OneNAND.
270
271           - CONFIG_ENV_ADDR:
272           - CONFIG_ENV_SIZE:
273
274           These two #defines are used to determine the device range you
275           want to use for environment. It is assumed that this memory
276           can just be read and written to, without any special
277           provision.
278
279 config ENV_IS_IN_REMOTE
280         bool "Environment is in remote memory space"
281         depends on !CHAIN_OF_TRUST
282         help
283           Define this if you have a remote memory space which you
284           want to use for the local device's environment.
285
286           - CONFIG_ENV_ADDR:
287           - CONFIG_ENV_SIZE:
288
289           These two #defines specify the address and size of the
290           environment area within the remote memory space. The
291           local device can get the environment from remote memory
292           space by SRIO or PCIE links.
293
294 config ENV_IS_IN_SPI_FLASH
295         bool "Environment is in SPI flash"
296         depends on !CHAIN_OF_TRUST
297         default y if ARMADA_XP
298         default y if INTEL_BAYTRAIL
299         default y if INTEL_BRASWELL
300         default y if INTEL_BROADWELL
301         default y if NORTHBRIDGE_INTEL_IVYBRIDGE
302         default y if INTEL_QUARK
303         default y if INTEL_QUEENSBAY
304         help
305           Define this if you have a SPI Flash memory device which you
306           want to use for the environment.
307
308           - CONFIG_ENV_OFFSET:
309           - CONFIG_ENV_SIZE:
310
311           These two #defines specify the offset and size of the
312           environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
313           aligned to an erase sector boundary.
314
315           - CONFIG_ENV_SECT_SIZE:
316
317           Define the SPI flash's sector size.
318
319           - CONFIG_ENV_OFFSET_REDUND (optional):
320
321           This setting describes a second storage area of CONFIG_ENV_SIZE
322           size used to hold a redundant copy of the environment data, so
323           that there is a valid backup copy in case there is a power failure
324           during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
325           aligned to an erase sector boundary.
326
327 config USE_ENV_SPI_BUS
328         bool "SPI flash bus for environment"
329         depends on ENV_IS_IN_SPI_FLASH
330         help
331           Force the SPI bus for environment.
332           If not defined, use CONFIG_SF_DEFAULT_BUS.
333
334 config ENV_SPI_BUS
335         int "Value of SPI flash bus for environment"
336         depends on USE_ENV_SPI_BUS
337         help
338           Value the SPI bus and chip select for environment.
339
340 config USE_ENV_SPI_CS
341         bool "SPI flash chip select for environment"
342         depends on ENV_IS_IN_SPI_FLASH
343         help
344           Force the SPI chip select for environment.
345           If not defined, use CONFIG_SF_DEFAULT_CS.
346
347 config ENV_SPI_CS
348         int "Value of SPI flash chip select for environment"
349         depends on USE_ENV_SPI_CS
350         help
351           Value of the SPI chip select for environment.
352
353 config USE_ENV_SPI_MAX_HZ
354         bool "SPI flash max frequency for environment"
355         depends on ENV_IS_IN_SPI_FLASH
356         help
357           Force the SPI max work clock for environment.
358           If not defined, use CONFIG_SF_DEFAULT_SPEED.
359
360 config ENV_SPI_MAX_HZ
361         int "Value of SPI flash max frequency for environment"
362         depends on USE_ENV_SPI_MAX_HZ
363         help
364           Value of the SPI max work clock for environment.
365
366 config USE_ENV_SPI_MODE
367         bool "SPI flash mode for environment"
368         depends on ENV_IS_IN_SPI_FLASH
369         help
370           Force the SPI work mode for environment.
371
372 config ENV_SPI_MODE
373         hex "Value of SPI flash work mode for environment"
374         depends on USE_ENV_SPI_MODE
375         help
376           Value of the SPI work mode for environment.
377           See include/spi.h for value.
378
379 config ENV_IS_IN_UBI
380         bool "Environment in a UBI volume"
381         depends on !CHAIN_OF_TRUST
382         help
383           Define this if you have an UBI volume that you want to use for the
384           environment.  This has the benefit of wear-leveling the environment
385           accesses, which is important on NAND.
386
387           - CONFIG_ENV_UBI_PART:
388
389           Define this to a string that is the mtd partition containing the UBI.
390
391           - CONFIG_ENV_UBI_VOLUME:
392
393           Define this to the name of the volume that you want to store the
394           environment in.
395
396           - CONFIG_ENV_UBI_VOLUME_REDUND:
397
398           Define this to the name of another volume to store a second copy of
399           the environment in.  This will enable redundant environments in UBI.
400           It is assumed that both volumes are in the same MTD partition.
401
402 config ENV_FAT_INTERFACE
403         string "Name of the block device for the environment"
404         depends on ENV_IS_IN_FAT
405         default "mmc" if ARCH_SUNXI
406         default "mmc" if TI_COMMON_CMD_OPTIONS || ARCH_ZYNQMP || ARCH_AT91
407         help
408           Define this to a string that is the name of the block device.
409
410 config ENV_FAT_DEVICE_AND_PART
411         string "Device and partition for where to store the environemt in FAT"
412         depends on ENV_IS_IN_FAT
413         default "0:1" if TI_COMMON_CMD_OPTIONS
414         default "0:auto" if ARCH_ZYNQMP
415         default "0:auto" if ARCH_SUNXI && MMC_SUNXI_SLOT_EXTRA = -1
416         default "1:auto" if ARCH_SUNXI && MMC_SUNXI_SLOT_EXTRA != -1
417         default "0" if ARCH_AT91
418         help
419           Define this to a string to specify the partition of the device. It can
420           be as following:
421
422             "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
423                - "D:P": device D partition P. Error occurs if device D has no
424                         partition table.
425                - "D:0": device D.
426                - "D" or "D:": device D partition 1 if device D has partition
427                               table, or the whole device D if has no partition
428                               table.
429                - "D:auto": first partition in device D with bootable flag set.
430                            If none, first valid partition in device D. If no
431                            partition table then means device D.
432
433 config ENV_FAT_FILE
434         string "Name of the FAT file to use for the environment"
435         depends on ENV_IS_IN_FAT
436         default "uboot.env"
437         help
438           It's a string of the FAT file name. This file use to store the
439           environment.
440
441 config ENV_EXT4_INTERFACE
442         string "Name of the block device for the environment"
443         depends on ENV_IS_IN_EXT4
444         help
445           Define this to a string that is the name of the block device.
446
447 config ENV_EXT4_DEVICE_AND_PART
448         string "Device and partition for where to store the environemt in EXT4"
449         depends on ENV_IS_IN_EXT4
450         help
451           Define this to a string to specify the partition of the device. It can
452           be as following:
453
454             "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
455                - "D:P": device D partition P. Error occurs if device D has no
456                         partition table.
457                - "D:0": device D.
458                - "D" or "D:": device D partition 1 if device D has partition
459                               table, or the whole device D if has no partition
460                               table.
461                - "D:auto": first partition in device D with bootable flag set.
462                            If none, first valid partition in device D. If no
463                            partition table then means device D.
464
465 config ENV_EXT4_FILE
466         string "Name of the EXT4 file to use for the environment"
467         depends on ENV_IS_IN_EXT4
468         default "uboot.env"
469         help
470           It's a string of the EXT4 file name. This file use to store the
471           environment (explicit path to the file)
472
473 if ARCH_ROCKCHIP || ARCH_SUNXI || ARCH_ZYNQ || ARCH_ZYNQMP || ARCH_VERSAL || ARC
474
475 config ENV_OFFSET
476         hex "Environment Offset"
477         depends on !ENV_IS_IN_UBI
478         depends on !ENV_IS_NOWHERE
479         default 0x3f8000 if ARCH_ROCKCHIP
480         default 0x88000 if ARCH_SUNXI
481         default 0xE0000 if ARCH_ZYNQ
482         default 0x1E00000 if ARCH_ZYNQMP
483         default 0 if ARC
484         help
485           Offset from the start of the device (or partition)
486
487 config ENV_SIZE
488         hex "Environment Size"
489         default 0x40000 if ENV_IS_IN_SPI_FLASH && ARCH_ZYNQMP
490         default 0x20000 if ARCH_SUNXI || ARCH_ZYNQ
491         default 0x8000 if ARCH_ROCKCHIP || ARCH_ZYNQMP || ARCH_VERSAL
492         default 0x4000 if ARC
493         help
494           Size of the environment storage area
495
496 config ENV_SECT_SIZE
497         hex "Environment Sector-Size"
498         depends on !ENV_IS_NOWHERE && (ARCH_ZYNQ || ARCH_ZYNQMP)
499         default 0x40000 if ARCH_ZYNQMP
500         default 0x20000 if ARCH_ZYNQ
501         help
502           Size of the sector containing the environment.
503
504 config ENV_UBI_PART
505         string "UBI partition name"
506         depends on ENV_IS_IN_UBI
507         help
508           MTD partition containing the UBI device
509
510 config ENV_UBI_VOLUME
511         string "UBI volume name"
512         depends on ENV_IS_IN_UBI
513         help
514           Name of the volume that you want to store the environment in.
515
516 endif
517
518 config USE_DEFAULT_ENV_FILE
519         bool "Create default environment from file"
520         help
521           Normally, the default environment is automatically generated
522           based on the settings of various CONFIG_* options, as well
523           as the CONFIG_EXTRA_ENV_SETTINGS. By selecting this option,
524           you can instead define the entire default environment in an
525           external file.
526
527 config DEFAULT_ENV_FILE
528         string "Path to default environment file"
529         depends on USE_DEFAULT_ENV_FILE
530         help
531           The path containing the default environment. The format is
532           the same as accepted by the mkenvimage tool: lines
533           containing key=value pairs, blank lines and lines beginning
534           with # are ignored.
535
536 config ENV_VARS_UBOOT_RUNTIME_CONFIG
537         bool "Add run-time information to the environment"
538         help
539           Enable this in order to add variables describing certain
540           run-time determined information about the hardware to the
541           environment.  These will be named board_name, board_rev.
542
543 if SPL_ENV_SUPPORT
544 config SPL_ENV_IS_NOWHERE
545         bool "SPL Environment is not stored"
546         default y if ENV_IS_NOWHERE
547         help
548           Similar to ENV_IS_NOWHERE, used for SPL environment.
549
550 config SPL_ENV_IS_IN_MMC
551         bool "SPL Environment in an MMC device"
552         depends on !SPL_ENV_IS_NOWHERE
553         depends on ENV_IS_IN_MMC
554         default y
555         help
556           Similar to ENV_IS_IN_MMC, used for SPL environment.
557
558 config SPL_ENV_IS_IN_FAT
559         bool "SPL Environment is in a FAT filesystem"
560         depends on !SPL_ENV_IS_NOWHERE
561         depends on ENV_IS_IN_FAT
562         default y
563         help
564           Similar to ENV_IS_IN_FAT, used for SPL environment.
565
566 config SPL_ENV_IS_IN_EXT4
567         bool "SPL Environment is in a EXT4 filesystem"
568         depends on !SPL_ENV_IS_NOWHERE
569         depends on ENV_IS_IN_EXT4
570         default y
571         help
572           Similar to ENV_IS_IN_EXT4, used for SPL environment.
573
574 config SPL_ENV_IS_IN_NAND
575         bool "SPL Environment in a NAND device"
576         depends on !SPL_ENV_IS_NOWHERE
577         depends on ENV_IS_IN_NAND
578         default y
579         help
580           Similar to ENV_IS_IN_NAND, used for SPL environment.
581
582 config SPL_ENV_IS_IN_SPI_FLASH
583         bool "SPL Environment is in SPI flash"
584         depends on !SPL_ENV_IS_NOWHERE
585         depends on ENV_IS_IN_SPI_FLASH
586         default y
587         help
588           Similar to ENV_IS_IN_SPI_FLASH, used for SPL environment.
589
590 config SPL_ENV_IS_IN_FLASH
591         bool "SPL Environment in flash memory"
592         depends on !SPL_ENV_IS_NOWHERE
593         depends on ENV_IS_IN_FLASH
594         default y
595         help
596           Similar to ENV_IS_IN_FLASH, used for SPL environment.
597
598 endif
599
600 if TPL_ENV_SUPPORT
601
602 config TPL_ENV_IS_NOWHERE
603         bool "TPL Environment is not stored"
604         default y if ENV_IS_NOWHERE
605         help
606           Similar to ENV_IS_NOWHERE, used for TPL environment.
607
608 config TPL_ENV_IS_IN_MMC
609         bool "TPL Environment in an MMC device"
610         depends on !TPL_ENV_IS_NOWHERE
611         depends on ENV_IS_IN_MMC
612         default y
613         help
614           Similar to ENV_IS_IN_MMC, used for TPL environment.
615
616 config TPL_ENV_IS_IN_FAT
617         bool "TPL Environment is in a FAT filesystem"
618         depends on !TPL_ENV_IS_NOWHERE
619         depends on ENV_IS_IN_FAT
620         default y
621         help
622           Similar to ENV_IS_IN_FAT, used for TPL environment.
623
624 config TPL_ENV_IS_IN_EXT4
625         bool "TPL Environment is in a EXT4 filesystem"
626         depends on !TPL_ENV_IS_NOWHERE
627         depends on ENV_IS_IN_EXT4
628         default y
629         help
630           Similar to ENV_IS_IN_EXT4, used for TPL environment.
631
632 config TPL_ENV_IS_IN_NAND
633         bool "TPL Environment in a NAND device"
634         depends on !TPL_ENV_IS_NOWHERE
635         depends on ENV_IS_IN_NAND
636         default y
637         help
638           Similar to ENV_IS_IN_NAND, used for TPL environment.
639
640 config TPL_ENV_IS_IN_SPI_FLASH
641         bool "TPL Environment is in SPI flash"
642         depends on !TPL_ENV_IS_NOWHERE
643         depends on ENV_IS_IN_SPI_FLASH
644         default y
645         help
646           Similar to ENV_IS_IN_SPI_FLASH, used for TPL environment.
647
648 config TPL_ENV_IS_IN_FLASH
649         bool "TPL Environment in flash memory"
650         depends on !TPL_ENV_IS_NOWHERE
651         depends on ENV_IS_IN_FLASH
652         default y
653         help
654           Similar to ENV_IS_IN_FLASH, used for TPL environment.
655
656 endif
657
658 endmenu