summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorTom Rini <[email protected]>2026-05-25 13:44:45 -0600
committerTom Rini <[email protected]>2026-05-25 13:44:45 -0600
commit8d5f30b52f7c800c2177188fc4d331fb7af2c46a (patch)
treea3f23faa01933dcb49c22ca50c8d5a9e3293a87a /README
parent77efd55f89e406d49a8697fd5475b6ab2ba6497c (diff)
parente11b0c5cab44817b3c1cb4fd29339010b4db4321 (diff)
Merge patch series "env: migrate static flags list to Kconfig"next
This series from James Hilliard <[email protected]> converts the static flags list for the environment to be configured via Kconfig and updates the documentation. Link: https://lore.kernel.org/r/[email protected]
Diffstat (limited to 'README')
-rw-r--r--README169
1 files changed, 1 insertions, 168 deletions
diff --git a/README b/README
index 5653f687e82..472cf37d9cc 100644
--- a/README
+++ b/README
@@ -707,7 +707,7 @@ The following options need to be configured:
The same can be accomplished in a more flexible way
for any variable by configuring the type of access
to allow for those variables in the ".flags" variable
- or define CFG_ENV_FLAGS_LIST_STATIC.
+ or by setting CONFIG_ENV_FLAGS_LIST_STATIC.
- Protected RAM:
CFG_PRAM
@@ -941,173 +941,6 @@ typically in board_init_f() and board_init_r().
- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
- CONFIG_BOARD_LATE_INIT: Call board_late_init()
-Configuration Settings:
------------------------
-
-- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
- undefine this when you're short of memory.
-
-- CFG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
- width of the commands listed in the 'help' command output.
-
-- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
- prompt for user input.
-
-- CFG_SYS_BAUDRATE_TABLE:
- List of legal baudrate settings for this board.
-
-- CFG_SYS_MEM_RESERVE_SECURE
- Only implemented for ARMv8 for now.
- If defined, the size of CFG_SYS_MEM_RESERVE_SECURE memory
- is substracted from total RAM and won't be reported to OS.
- This memory can be used as secure memory. A variable
- gd->arch.secure_ram is used to track the location. In systems
- the RAM base is not zero, or RAM is divided into banks,
- this variable needs to be recalcuated to get the address.
-
-- CFG_SYS_SDRAM_BASE:
- Physical start address of SDRAM. _Must_ be 0 here.
-
-- CFG_SYS_FLASH_BASE:
- Physical start address of Flash memory.
-
-- CONFIG_SYS_MALLOC_LEN:
- Size of DRAM reserved for malloc() use.
-
-- CFG_SYS_BOOTMAPSZ:
- Maximum size of memory mapped by the startup code of
- the Linux kernel; all data that must be processed by
- the Linux kernel (bd_info, boot arguments, FDT blob if
- used) must be put below this limit, unless "bootm_low"
- environment variable is defined and non-zero. In such case
- all data for the Linux kernel must be between "bootm_low"
- and "bootm_low" + CFG_SYS_BOOTMAPSZ. The environment
- variable "bootm_mapsize" will override the value of
- CFG_SYS_BOOTMAPSZ. If CFG_SYS_BOOTMAPSZ is undefined,
- then the value in "bootm_size" will be used instead.
-
-- CONFIG_SYS_BOOT_GET_CMDLINE:
- Enables allocating and saving kernel cmdline in space between
- "bootm_low" and "bootm_low" + BOOTMAPSZ.
-
-- CONFIG_SYS_BOOT_GET_KBD:
- Enables allocating and saving a kernel copy of the bd_info in
- space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
-
-- CONFIG_SYS_FLASH_PROTECTION
- If defined, hardware flash sectors protection is used
- instead of U-Boot software protection.
-
-- CONFIG_SYS_FLASH_CFI:
- Define if the flash driver uses extra elements in the
- common flash structure for storing flash geometry.
-
-- CONFIG_FLASH_CFI_DRIVER
- This option also enables the building of the cfi_flash driver
- in the drivers directory
-
-- CONFIG_FLASH_CFI_MTD
- This option enables the building of the cfi_mtd driver
- in the drivers directory. The driver exports CFI flash
- to the MTD layer.
-
-- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
- Use buffered writes to flash.
-
-- CONFIG_ENV_FLAGS_LIST_DEFAULT
-- CFG_ENV_FLAGS_LIST_STATIC
- Enable validation of the values given to environment variables when
- calling env set. Variables can be restricted to only decimal,
- hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
- the variables can also be restricted to IP address or MAC address.
-
- The format of the list is:
- type_attribute = [s|d|x|b|i|m]
- access_attribute = [a|r|o|c]
- attributes = type_attribute[access_attribute]
- entry = variable_name[:attributes]
- list = entry[,list]
-
- The type attributes are:
- s - String (default)
- d - Decimal
- x - Hexadecimal
- b - Boolean ([1yYtT|0nNfF])
- i - IP address
- m - MAC address
-
- The access attributes are:
- a - Any (default)
- r - Read-only
- o - Write-once
- c - Change-default
-
- - CONFIG_ENV_FLAGS_LIST_DEFAULT
- Define this to a list (string) to define the ".flags"
- environment variable in the default or embedded environment.
-
- - CFG_ENV_FLAGS_LIST_STATIC
- Define this to a list (string) to define validation that
- should be done if an entry is not found in the ".flags"
- environment variable. To override a setting in the static
- list, simply add an entry for the same variable name to the
- ".flags" variable.
-
- If CONFIG_REGEX is defined, the variable_name above is evaluated as a
- regular expression. This allows multiple variables to define the same
- flags without explicitly listing them for each variable.
-
-The following definitions that deal with the placement and management
-of environment data (variable area); in general, we support the
-following configurations:
-
-BE CAREFUL! The first access to the environment happens quite early
-in U-Boot initialization (when we try to get the setting of for the
-console baudrate). You *MUST* have mapped your NVRAM area then, or
-U-Boot will hang.
-
-Please note that even with NVRAM we still use a copy of the
-environment in RAM: we could work on NVRAM directly, but we want to
-keep settings there always unmodified except somebody uses "saveenv"
-to save the current settings.
-
-BE CAREFUL! For some special cases, the local device can not use
-"saveenv" command. For example, the local device will get the
-environment stored in a remote NOR flash by SRIO or PCIE link,
-but it can not erase, write this NOR flash by SRIO or PCIE interface.
-
-- CONFIG_NAND_ENV_DST
-
- Defines address in RAM to which the nand_spl code should copy the
- environment. If redundant environment is used, it will be copied to
- CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
-
-Please note that the environment is read-only until the monitor
-has been relocated to RAM and a RAM copy of the environment has been
-created; also, when using EEPROM you will have to use env_get_f()
-until then to read environment variables.
-
-The environment is protected by a CRC32 checksum. Before the monitor
-is relocated into RAM, as a result of a bad CRC you will be working
-with the compiled-in default environment - *silently*!!! [This is
-necessary, because the first environment variable we need is the
-"baudrate" setting for the console - if we have a bad CRC, we don't
-have any device yet where we could complain.]
-
-Note: once the monitor has been relocated, then it will complain if
-the default environment is used; a new CRC is computed as soon as you
-use the "saveenv" command to store a valid environment.
-
-- CONFIG_DISPLAY_BOARDINFO
- Display information about the board that U-Boot is running on
- when U-Boot starts up. The board function checkboard() is called
- to do this.
-
-- CONFIG_DISPLAY_BOARDINFO_LATE
- Similar to the previous option, but display this information
- later, once stdio is running and output goes to the LCD, if
- present.
-
Low Level (hardware related) configuration options:
---------------------------------------------------