env/Kconfig

   1 menu "Environment"
   2
   3 config ENV_IS_IN_DATAFLASH
   4         bool "Environment in dataflash"
   5         depends on !CHAIN_OF_TRUST
   6         help
   7           Define this if you have a DataFlash memory device which you
   8           want to use for the environment.
   9
  10           - CONFIG_ENV_OFFSET:
  11           - CONFIG_ENV_ADDR:
  12           - CONFIG_ENV_SIZE:
  13
  14           These three #defines specify the offset and size of the
  15           environment area within the total memory of your DataFlash placed
  16           at the specified address.
  17
  18 config ENV_IS_IN_EEPROM
  19         bool "Environment in EEPROM"
  20         depends on !CHAIN_OF_TRUST
  21         help
  22           Use this if you have an EEPROM or similar serial access
  23           device and a driver for it.
  24
  25           - CONFIG_ENV_OFFSET:
  26           - CONFIG_ENV_SIZE:
  27
  28           These two #defines specify the offset and size of the
  29           environment area within the total memory of your EEPROM.
  30
  31           - CONFIG_SYS_I2C_EEPROM_ADDR:
  32           If defined, specified the chip address of the EEPROM device.
  33           The default address is zero.
  34
  35           - CONFIG_SYS_I2C_EEPROM_BUS:
  36           If defined, specified the i2c bus of the EEPROM device.
  37
  38           - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
  39           If defined, the number of bits used to address bytes in a
  40           single page in the EEPROM device.  A 64 byte page, for example
  41           would require six bits.
  42
  43           - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
  44           If defined, the number of milliseconds to delay between
  45           page writes.  The default is zero milliseconds.
  46
  47           - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
  48           The length in bytes of the EEPROM memory array address.  Note
  49           that this is NOT the chip address length!
  50
  51           - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
  52           EEPROM chips that implement "address overflow" are ones
  53           like Catalyst 24WC04/08/16 which has 9/10/11 bits of
  54           address and the extra bits end up in the "chip address" bit
  55           slots. This makes a 24WC08 (1Kbyte) chip look like four 256
  56           byte chips.
  57
  58           Note that we consider the length of the address field to
  59           still be one byte because the extra address bits are hidden
  60           in the chip address.
  61
  62           - CONFIG_SYS_EEPROM_SIZE:
  63           The size in bytes of the EEPROM device.
  64
  65           - CONFIG_ENV_EEPROM_IS_ON_I2C
  66           define this, if you have I2C and SPI activated, and your
  67           EEPROM, which holds the environment, is on the I2C bus.
  68
  69           - CONFIG_I2C_ENV_EEPROM_BUS
  70           if you have an Environment on an EEPROM reached over
  71           I2C muxes, you can define here, how to reach this
  72           EEPROM. For example:
  73
  74           #define CONFIG_I2C_ENV_EEPROM_BUS       1
  75
  76           EEPROM which holds the environment, is reached over
  77           a pca9547 i2c mux with address 0x70, channel 3.
  78
  79 config ENV_IS_IN_FAT
  80         bool "Environment is in a FAT filesystem"
  81         depends on !CHAIN_OF_TRUST
  82         select FAT_WRITE
  83         help
  84          Define this if you want to use the FAT file system for the environment.
  85
  86
  87          - CONFIG_FAT_WRITE:
  88          This must be enabled. Otherwise it cannot save the environment file.
  89
  90 config ENV_IS_IN_FLASH
  91         bool "Environment in flash memory"
  92         depends on !CHAIN_OF_TRUST
  93         help
  94           Define this if you have a flash device which you want to use for the
  95           environment.
  96
  97           a) The environment occupies one whole flash sector, which is
  98            "embedded" in the text segment with the U-Boot code. This
  99            happens usually with "bottom boot sector" or "top boot
 100            sector" type flash chips, which have several smaller
 101            sectors at the start or the end. For instance, such a
 102            layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
 103            such a case you would place the environment in one of the
 104            4 kB sectors - with U-Boot code before and after it. With
 105            "top boot sector" type flash chips, you would put the
 106            environment in one of the last sectors, leaving a gap
 107            between U-Boot and the environment.
 108
 109           CONFIG_ENV_OFFSET:
 110
 111            Offset of environment data (variable area) to the
 112            beginning of flash memory; for instance, with bottom boot
 113            type flash chips the second sector can be used: the offset
 114            for this sector is given here.
 115
 116            CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
 117
 118           CONFIG_ENV_ADDR:
 119
 120            This is just another way to specify the start address of
 121            the flash sector containing the environment (instead of
 122            CONFIG_ENV_OFFSET).
 123
 124           CONFIG_ENV_SECT_SIZE:
 125
 126            Size of the sector containing the environment.
 127
 128
 129           b) Sometimes flash chips have few, equal sized, BIG sectors.
 130            In such a case you don't want to spend a whole sector for
 131            the environment.
 132
 133           CONFIG_ENV_SIZE:
 134
 135            If you use this in combination with CONFIG_ENV_IS_IN_FLASH
 136            and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
 137            of this flash sector for the environment. This saves
 138            memory for the RAM copy of the environment.
 139
 140            It may also save flash memory if you decide to use this
 141            when your environment is "embedded" within U-Boot code,
 142            since then the remainder of the flash sector could be used
 143            for U-Boot code. It should be pointed out that this is
 144            STRONGLY DISCOURAGED from a robustness point of view:
 145            updating the environment in flash makes it always
 146            necessary to erase the WHOLE sector. If something goes
 147            wrong before the contents has been restored from a copy in
 148            RAM, your target system will be dead.
 149
 150           CONFIG_ENV_ADDR_REDUND
 151           CONFIG_ENV_SIZE_REDUND
 152
 153            These settings describe a second storage area used to hold
 154            a redundant copy of the environment data, so that there is
 155            a valid backup copy in case there is a power failure during
 156            a "saveenv" operation.
 157
 158           BE CAREFUL! Any changes to the flash layout, and some changes to the
 159           source code will make it necessary to adapt <board>/u-boot.lds*
 160           accordingly!
 161
 162 config ENV_IS_IN_MMC
 163         bool "Environment in an MMC device"
 164         depends on !CHAIN_OF_TRUST
 165         default y if ARCH_SUNXI
 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
 216 config 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
 254 config 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
 270 config 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
 285 config 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
 300 config 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
 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_IS_NOWHERE
 369         bool "Environment is not stored"
 370         help
 371           Define this if you don't want to or can't have an environment stored
 372           on a storage medium
 373
 374 config ENV_FAT_INTERFACE
 375         string "Name of the block device for the environment"
 376         depends on ENV_IS_IN_FAT
 377         default "mmc" if TI_COMMON_CMD_OPTIONS || ARCH_ZYNQMP || ARCH_AT91
 378         help
 379           Define this to a string that is the name of the block device.
 380
 381 config ENV_FAT_DEVICE_AND_PART
 382         string "Device and partition for where to store the environemt in FAT"
 383         depends on ENV_IS_IN_FAT
 384         default "0:1" if TI_COMMON_CMD_OPTIONS
 385         default "0:auto" if ARCH_ZYNQMP
 386         default "0" if ARCH_AT91
 387         help
 388           Define this to a string to specify the partition of the device. It can
 389           be as following:
 390
 391             "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
 392                - "D:P": device D partition P. Error occurs if device D has no
 393                         partition table.
 394                - "D:0": device D.
 395                - "D" or "D:": device D partition 1 if device D has partition
 396                               table, or the whole device D if has no partition
 397                               table.
 398                - "D:auto": first partition in device D with bootable flag set.
 399                            If none, first valid partition in device D. If no
 400                            partition table then means device D.
 401
 402 config ENV_FAT_FILE
 403         string "Name of the FAT file to use for the environemnt"
 404         depends on ENV_IS_IN_FAT
 405         default "uboot.env"
 406         help
 407           It's a string of the FAT file name. This file use to store the
 408           environment.
 409
 410 if ARCH_SUNXI
 411
 412 config ENV_OFFSET
 413         hex "Environment Offset"
 414         depends on !ENV_IS_IN_UBI
 415         depends on !ENV_IS_NOWHERE
 416         default 0x88000 if ARCH_SUNXI
 417         help
 418           Offset from the start of the device (or partition)
 419
 420 config ENV_SIZE
 421         hex "Environment Size"
 422         depends on !ENV_IS_NOWHERE
 423         default 0x20000 if ARCH_SUNXI
 424         help
 425           Size of the environment storage area
 426
 427 config ENV_UBI_PART
 428         string "UBI partition name"
 429         depends on ENV_IS_IN_UBI
 430         help
 431           MTD partition containing the UBI device
 432
 433 config ENV_UBI_VOLUME
 434         string "UBI volume name"
 435         depends on ENV_IS_IN_UBI
 436         help
 437           Name of the volume that you want to store the environment in.
 438
 439 endif
 440
 441 endmenu