env: Allow to build multiple environments in Kconfig
[oweals/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_FAT
7         depends on !ENV_IS_IN_FLASH
8         depends on !ENV_IS_IN_MMC
9         depends on !ENV_IS_IN_NAND
10         depends on !ENV_IS_IN_NVRAM
11         depends on !ENV_IS_IN_ONENAND
12         depends on !ENV_IS_IN_REMOTE
13         depends on !ENV_IS_IN_SPI_FLASH
14         depends on !ENV_IS_IN_UBI
15         default y
16         help
17           Define this if you don't want to or can't have an environment stored
18           on a storage medium. In this case the environemnt will still exist
19           while U-Boot is running, but once U-Boot exits it will not be
20           stored. U-Boot will therefore always start up with a default
21           environment.
22
23 config ENV_IS_IN_EEPROM
24         bool "Environment in EEPROM"
25         depends on !CHAIN_OF_TRUST
26         help
27           Use this if you have an EEPROM or similar serial access
28           device and a driver for it.
29
30           - CONFIG_ENV_OFFSET:
31           - CONFIG_ENV_SIZE:
32
33           These two #defines specify the offset and size of the
34           environment area within the total memory of your EEPROM.
35
36           Note that we consider the length of the address field to
37           still be one byte because the extra address bits are hidden
38           in the chip address.
39
40           - CONFIG_ENV_EEPROM_IS_ON_I2C
41           define this, if you have I2C and SPI activated, and your
42           EEPROM, which holds the environment, is on the I2C bus.
43
44           - CONFIG_I2C_ENV_EEPROM_BUS
45           if you have an Environment on an EEPROM reached over
46           I2C muxes, you can define here, how to reach this
47           EEPROM. For example:
48
49           #define CONFIG_I2C_ENV_EEPROM_BUS       1
50
51           EEPROM which holds the environment, is reached over
52           a pca9547 i2c mux with address 0x70, channel 3.
53
54 config ENV_IS_IN_FAT
55         bool "Environment is in a FAT filesystem"
56         depends on !CHAIN_OF_TRUST
57         default y if ARCH_BCM283X
58         default y if MMC_OMAP_HS && TI_COMMON_CMD_OPTIONS
59         select FS_FAT
60         select FAT_WRITE
61         help
62           Define this if you want to use the FAT file system for the environment.
63
64 config ENV_IS_IN_EXT4
65         bool "Environment is in a EXT4 filesystem"
66         depends on !CHAIN_OF_TRUST
67         select EXT4_WRITE
68         help
69           Define this if you want to use the EXT4 file system for the environment.
70
71 config ENV_IS_IN_FLASH
72         bool "Environment in flash memory"
73         depends on !CHAIN_OF_TRUST
74         default y if ARCH_CINTEGRATOR
75         default y if ARCH_INTEGRATOR_CP
76         default y if M548x || M547x || M5282 || MCF547x_8x
77         default y if MCF532x || MCF52x2
78         default y if MPC86xx || MPC83xx
79         default y if ARCH_MPC8572 || ARCH_MPC8548 || ARCH_MPC8641
80         default y if SH && !CPU_SH4
81         help
82           Define this if you have a flash device which you want to use for the
83           environment.
84
85           a) The environment occupies one whole flash sector, which is
86            "embedded" in the text segment with the U-Boot code. This
87            happens usually with "bottom boot sector" or "top boot
88            sector" type flash chips, which have several smaller
89            sectors at the start or the end. For instance, such a
90            layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
91            such a case you would place the environment in one of the
92            4 kB sectors - with U-Boot code before and after it. With
93            "top boot sector" type flash chips, you would put the
94            environment in one of the last sectors, leaving a gap
95            between U-Boot and the environment.
96
97           CONFIG_ENV_OFFSET:
98
99            Offset of environment data (variable area) to the
100            beginning of flash memory; for instance, with bottom boot
101            type flash chips the second sector can be used: the offset
102            for this sector is given here.
103
104            CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
105
106           CONFIG_ENV_ADDR:
107
108            This is just another way to specify the start address of
109            the flash sector containing the environment (instead of
110            CONFIG_ENV_OFFSET).
111
112           CONFIG_ENV_SECT_SIZE:
113
114            Size of the sector containing the environment.
115
116
117           b) Sometimes flash chips have few, equal sized, BIG sectors.
118            In such a case you don't want to spend a whole sector for
119            the environment.
120
121           CONFIG_ENV_SIZE:
122
123            If you use this in combination with CONFIG_ENV_IS_IN_FLASH
124            and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
125            of this flash sector for the environment. This saves
126            memory for the RAM copy of the environment.
127
128            It may also save flash memory if you decide to use this
129            when your environment is "embedded" within U-Boot code,
130            since then the remainder of the flash sector could be used
131            for U-Boot code. It should be pointed out that this is
132            STRONGLY DISCOURAGED from a robustness point of view:
133            updating the environment in flash makes it always
134            necessary to erase the WHOLE sector. If something goes
135            wrong before the contents has been restored from a copy in
136            RAM, your target system will be dead.
137
138           CONFIG_ENV_ADDR_REDUND
139           CONFIG_ENV_SIZE_REDUND
140
141            These settings describe a second storage area used to hold
142            a redundant copy of the environment data, so that there is
143            a valid backup copy in case there is a power failure during
144            a "saveenv" operation.
145
146           BE CAREFUL! Any changes to the flash layout, and some changes to the
147           source code will make it necessary to adapt <board>/u-boot.lds*
148           accordingly!
149
150 config ENV_IS_IN_MMC
151         bool "Environment in an MMC device"
152         depends on !CHAIN_OF_TRUST
153         depends on MMC
154         default y if ARCH_SUNXI
155         default y if ARCH_EXYNOS4
156         default y if MX6SX || MX7D
157         default y if TEGRA30 || TEGRA124
158         default y if TEGRA_ARMV8_COMMON
159         help
160           Define this if you have an MMC device which you want to use for the
161           environment.
162
163           CONFIG_SYS_MMC_ENV_DEV:
164
165           Specifies which MMC device the environment is stored in.
166
167           CONFIG_SYS_MMC_ENV_PART (optional):
168
169           Specifies which MMC partition the environment is stored in. If not
170           set, defaults to partition 0, the user area. Common values might be
171           1 (first MMC boot partition), 2 (second MMC boot partition).
172
173           CONFIG_ENV_OFFSET:
174           CONFIG_ENV_SIZE:
175
176           These two #defines specify the offset and size of the environment
177           area within the specified MMC device.
178
179           If offset is positive (the usual case), it is treated as relative to
180           the start of the MMC partition. If offset is negative, it is treated
181           as relative to the end of the MMC partition. This can be useful if
182           your board may be fitted with different MMC devices, which have
183           different sizes for the MMC partitions, and you always want the
184           environment placed at the very end of the partition, to leave the
185           maximum possible space before it, to store other data.
186
187           These two values are in units of bytes, but must be aligned to an
188           MMC sector boundary.
189
190           CONFIG_ENV_OFFSET_REDUND (optional):
191
192           Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
193           hold a redundant copy of the environment data. This provides a
194           valid backup copy in case the other copy is corrupted, e.g. due
195           to a power failure during a "saveenv" operation.
196
197           This value may also be positive or negative; this is handled in the
198           same way as CONFIG_ENV_OFFSET.
199
200           This value is also in units of bytes, but must also be aligned to
201           an MMC sector boundary.
202
203           CONFIG_ENV_SIZE_REDUND (optional):
204
205           This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
206           set. If this value is set, it must be set to the same value as
207           CONFIG_ENV_SIZE.
208
209 config ENV_IS_IN_NAND
210         bool "Environment in a NAND device"
211         depends on !CHAIN_OF_TRUST
212         help
213           Define this if you have a NAND device which you want to use for the
214           environment.
215
216           - CONFIG_ENV_OFFSET:
217           - CONFIG_ENV_SIZE:
218
219           These two #defines specify the offset and size of the environment
220           area within the first NAND device.  CONFIG_ENV_OFFSET must be
221           aligned to an erase block boundary.
222
223           - CONFIG_ENV_OFFSET_REDUND (optional):
224
225           This setting describes a second storage area of CONFIG_ENV_SIZE
226           size used to hold a redundant copy of the environment data, so
227           that there is a valid backup copy in case there is a power failure
228           during a "saveenv" operation.  CONFIG_ENV_OFFSET_REDUND must be
229           aligned to an erase block boundary.
230
231           - CONFIG_ENV_RANGE (optional):
232
233           Specifies the length of the region in which the environment
234           can be written.  This should be a multiple of the NAND device's
235           block size.  Specifying a range with more erase blocks than
236           are needed to hold CONFIG_ENV_SIZE allows bad blocks within
237           the range to be avoided.
238
239           - CONFIG_ENV_OFFSET_OOB (optional):
240
241           Enables support for dynamically retrieving the offset of the
242           environment from block zero's out-of-band data.  The
243           "nand env.oob" command can be used to record this offset.
244           Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
245           using CONFIG_ENV_OFFSET_OOB.
246
247 config ENV_IS_IN_NVRAM
248         bool "Environment in a non-volatile RAM"
249         depends on !CHAIN_OF_TRUST
250         help
251           Define this if you have some non-volatile memory device
252           (NVRAM, battery buffered SRAM) which you want to use for the
253           environment.
254
255           - CONFIG_ENV_ADDR:
256           - CONFIG_ENV_SIZE:
257
258           These two #defines are used to determine the memory area you
259           want to use for environment. It is assumed that this memory
260           can just be read and written to, without any special
261           provision.
262
263 config ENV_IS_IN_ONENAND
264         bool "Environment is in OneNAND"
265         depends on !CHAIN_OF_TRUST
266         help
267           Define this if you want to put your local device's environment in
268           OneNAND.
269
270           - CONFIG_ENV_ADDR:
271           - CONFIG_ENV_SIZE:
272
273           These two #defines are used to determine the device range you
274           want to use for environment. It is assumed that this memory
275           can just be read and written to, without any special
276           provision.
277
278 config ENV_IS_IN_REMOTE
279         bool "Environment is in remove memory space"
280         depends on !CHAIN_OF_TRUST
281         help
282           Define this if you have a remote memory space which you
283           want to use for the local device's environment.
284
285           - CONFIG_ENV_ADDR:
286           - CONFIG_ENV_SIZE:
287
288           These two #defines specify the address and size of the
289           environment area within the remote memory space. The
290           local device can get the environment from remote memory
291           space by SRIO or PCIE links.
292
293 config ENV_IS_IN_SPI_FLASH
294         bool "Environment is in SPI flash"
295         depends on !CHAIN_OF_TRUST
296         default y if ARMADA_XP
297         default y if INTEL_BAYTRAIL
298         default y if INTEL_BRASWELL
299         default y if INTEL_BROADWELL
300         default y if NORTHBRIDGE_INTEL_IVYBRIDGE
301         default y if INTEL_QUARK
302         default y if INTEL_QUEENSBAY
303         help
304           Define this if you have a SPI Flash memory device which you
305           want to use for the environment.
306
307           - CONFIG_ENV_OFFSET:
308           - CONFIG_ENV_SIZE:
309
310           These two #defines specify the offset and size of the
311           environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
312           aligned to an erase sector boundary.
313
314           - CONFIG_ENV_SECT_SIZE:
315
316           Define the SPI flash's sector size.
317
318           - CONFIG_ENV_OFFSET_REDUND (optional):
319
320           This setting describes a second storage area of CONFIG_ENV_SIZE
321           size used to hold a redundant copy of the environment data, so
322           that there is a valid backup copy in case there is a power failure
323           during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
324           aligned to an erase sector boundary.
325
326           - CONFIG_ENV_SPI_BUS (optional):
327           - CONFIG_ENV_SPI_CS (optional):
328
329           Define the SPI bus and chip select. If not defined they will be 0.
330
331           - CONFIG_ENV_SPI_MAX_HZ (optional):
332
333           Define the SPI max work clock. If not defined then use 1MHz.
334
335           - CONFIG_ENV_SPI_MODE (optional):
336
337           Define the SPI work mode. If not defined then use SPI_MODE_3.
338
339 config ENV_IS_IN_UBI
340         bool "Environment in a UBI volume"
341         depends on !CHAIN_OF_TRUST
342         help
343           Define this if you have an UBI volume that you want to use for the
344           environment.  This has the benefit of wear-leveling the environment
345           accesses, which is important on NAND.
346
347           - CONFIG_ENV_UBI_PART:
348
349           Define this to a string that is the mtd partition containing the UBI.
350
351           - CONFIG_ENV_UBI_VOLUME:
352
353           Define this to the name of the volume that you want to store the
354           environment in.
355
356           - CONFIG_ENV_UBI_VOLUME_REDUND:
357
358           Define this to the name of another volume to store a second copy of
359           the environment in.  This will enable redundant environments in UBI.
360           It is assumed that both volumes are in the same MTD partition.
361
362           - CONFIG_UBI_SILENCE_MSG
363           - CONFIG_UBIFS_SILENCE_MSG
364
365           You will probably want to define these to avoid a really noisy system
366           when storing the env in UBI.
367
368 config ENV_FAT_INTERFACE
369         string "Name of the block device for the environment"
370         depends on ENV_IS_IN_FAT
371         default "mmc" if TI_COMMON_CMD_OPTIONS || ARCH_ZYNQMP || ARCH_AT91
372         help
373           Define this to a string that is the name of the block device.
374
375 config ENV_FAT_DEVICE_AND_PART
376         string "Device and partition for where to store the environemt in FAT"
377         depends on ENV_IS_IN_FAT
378         default "0:1" if TI_COMMON_CMD_OPTIONS
379         default "0:auto" if ARCH_ZYNQMP
380         default "0" if ARCH_AT91
381         help
382           Define this to a string to specify the partition of the device. It can
383           be as following:
384
385             "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
386                - "D:P": device D partition P. Error occurs if device D has no
387                         partition table.
388                - "D:0": device D.
389                - "D" or "D:": device D partition 1 if device D has partition
390                               table, or the whole device D if has no partition
391                               table.
392                - "D:auto": first partition in device D with bootable flag set.
393                            If none, first valid partition in device D. If no
394                            partition table then means device D.
395
396 config ENV_FAT_FILE
397         string "Name of the FAT file to use for the environemnt"
398         depends on ENV_IS_IN_FAT
399         default "uboot.env"
400         help
401           It's a string of the FAT file name. This file use to store the
402           environment.
403
404 config ENV_EXT4_INTERFACE
405         string "Name of the block device for the environment"
406         depends on ENV_IS_IN_EXT4
407         help
408           Define this to a string that is the name of the block device.
409
410 config ENV_EXT4_DEVICE_AND_PART
411         string "Device and partition for where to store the environemt in EXT4"
412         depends on ENV_IS_IN_EXT4
413         help
414           Define this to a string to specify the partition of the device. It can
415           be as following:
416
417             "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
418                - "D:P": device D partition P. Error occurs if device D has no
419                         partition table.
420                - "D:0": device D.
421                - "D" or "D:": device D partition 1 if device D has partition
422                               table, or the whole device D if has no partition
423                               table.
424                - "D:auto": first partition in device D with bootable flag set.
425                            If none, first valid partition in device D. If no
426                            partition table then means device D.
427
428 config ENV_EXT4_FILE
429         string "Name of the EXT4 file to use for the environemnt"
430         depends on ENV_IS_IN_EXT4
431         default "uboot.env"
432         help
433           It's a string of the EXT4 file name. This file use to store the
434           environment (explicit path to the file)
435
436 if ARCH_SUNXI
437
438 config ENV_OFFSET
439         hex "Environment Offset"
440         depends on !ENV_IS_IN_UBI
441         depends on !ENV_IS_NOWHERE
442         default 0x88000 if ARCH_SUNXI
443         help
444           Offset from the start of the device (or partition)
445
446 config ENV_SIZE
447         hex "Environment Size"
448         depends on !ENV_IS_NOWHERE
449         default 0x20000 if ARCH_SUNXI
450         help
451           Size of the environment storage area
452
453 config ENV_UBI_PART
454         string "UBI partition name"
455         depends on ENV_IS_IN_UBI
456         help
457           MTD partition containing the UBI device
458
459 config ENV_UBI_VOLUME
460         string "UBI volume name"
461         depends on ENV_IS_IN_UBI
462         help
463           Name of the volume that you want to store the environment in.
464
465 endif
466
467 if ARCH_ROCKCHIP
468
469 config ENV_OFFSET
470         hex
471         depends on !ENV_IS_IN_UBI
472         depends on !ENV_IS_NOWHERE
473         default 0x3f8000
474         help
475           Offset from the start of the device (or partition)
476
477 config ENV_SIZE
478         hex
479         default 0x8000
480         help
481           Size of the environment storage area
482
483 endif
484
485 endmenu