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