1 /* SPDX-License-Identifier: GPL-2.0+ */
3 * Internal environment header file. This includes direct access to environment
4 * information such as its size and offset, direct access to the default
5 * environment and embedded environment (if used). It also provides environment
6 * drivers with various declarations.
8 * It should not be included by board files, drivers and code other than that
9 * related to the environment implementation.
12 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
15 #ifndef _ENV_INTERNAL_H_
16 #define _ENV_INTERNAL_H_
18 #include <linux/kconfig.h>
20 /**************************************************************************
22 * The "environment" is stored as a list of '\0' terminated
23 * "name=value" strings. The end of the list is marked by a double
24 * '\0'. New entries are always added at the end. Deleting an entry
25 * shifts the remaining entries to the front. Replacing an entry is a
26 * combination of deleting the old value and adding the new one.
28 * The environment is preceded by a 32 bit CRC over the data part.
30 *************************************************************************/
32 #if defined(CONFIG_ENV_IS_IN_FLASH)
33 # ifndef CONFIG_ENV_ADDR
34 # define CONFIG_ENV_ADDR (CONFIG_SYS_FLASH_BASE + CONFIG_ENV_OFFSET)
36 # ifndef CONFIG_ENV_OFFSET
37 # define CONFIG_ENV_OFFSET (CONFIG_ENV_ADDR - CONFIG_SYS_FLASH_BASE)
39 # if !defined(CONFIG_ENV_ADDR_REDUND) && defined(CONFIG_ENV_OFFSET_REDUND)
40 # define CONFIG_ENV_ADDR_REDUND \
41 (CONFIG_SYS_FLASH_BASE + CONFIG_ENV_OFFSET_REDUND)
43 # if defined(CONFIG_ENV_SECT_SIZE) || defined(CONFIG_ENV_SIZE)
44 # ifndef CONFIG_ENV_SECT_SIZE
45 # define CONFIG_ENV_SECT_SIZE CONFIG_ENV_SIZE
47 # ifndef CONFIG_ENV_SIZE
48 # define CONFIG_ENV_SIZE CONFIG_ENV_SECT_SIZE
51 # error "Both CONFIG_ENV_SECT_SIZE and CONFIG_ENV_SIZE undefined"
53 # if defined(CONFIG_ENV_ADDR_REDUND) && !defined(CONFIG_ENV_SIZE_REDUND)
54 # define CONFIG_ENV_SIZE_REDUND CONFIG_ENV_SIZE
56 # if (CONFIG_ENV_ADDR >= CONFIG_SYS_MONITOR_BASE) && \
57 (CONFIG_ENV_ADDR + CONFIG_ENV_SIZE) <= \
58 (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN)
59 # define ENV_IS_EMBEDDED
61 # ifdef CONFIG_ENV_IS_EMBEDDED
62 # error "do not define CONFIG_ENV_IS_EMBEDDED in your board config"
63 # error "it is calculated automatically for you"
65 #endif /* CONFIG_ENV_IS_IN_FLASH */
67 #if defined(CONFIG_ENV_IS_IN_NAND)
68 # if defined(CONFIG_ENV_OFFSET_OOB)
69 # ifdef CONFIG_ENV_OFFSET_REDUND
70 # error "CONFIG_ENV_OFFSET_REDUND is not supported when CONFIG_ENV_OFFSET_OOB"
73 extern unsigned long nand_env_oob_offset;
74 # define CONFIG_ENV_OFFSET nand_env_oob_offset
76 # ifndef CONFIG_ENV_OFFSET
77 # error "Need to define CONFIG_ENV_OFFSET when using CONFIG_ENV_IS_IN_NAND"
79 # endif /* CONFIG_ENV_OFFSET_OOB */
80 # ifndef CONFIG_ENV_SIZE
81 # error "Need to define CONFIG_ENV_SIZE when using CONFIG_ENV_IS_IN_NAND"
83 #endif /* CONFIG_ENV_IS_IN_NAND */
85 #if defined(CONFIG_ENV_IS_IN_UBI)
86 # ifndef CONFIG_ENV_UBI_PART
87 # error "Need to define CONFIG_ENV_UBI_PART when using CONFIG_ENV_IS_IN_UBI"
89 # ifndef CONFIG_ENV_UBI_VOLUME
90 # error "Need to define CONFIG_ENV_UBI_VOLUME when using CONFIG_ENV_IS_IN_UBI"
92 # ifndef CONFIG_ENV_SIZE
93 # error "Need to define CONFIG_ENV_SIZE when using CONFIG_ENV_IS_IN_UBI"
95 # ifndef CONFIG_CMD_UBI
96 # error "Need to define CONFIG_CMD_UBI when using CONFIG_ENV_IS_IN_UBI"
98 #endif /* CONFIG_ENV_IS_IN_UBI */
100 /* Embedded env is only supported for some flash types */
101 #ifdef CONFIG_ENV_IS_EMBEDDED
102 # if !defined(CONFIG_ENV_IS_IN_FLASH) && \
103 !defined(CONFIG_ENV_IS_IN_NAND) && \
104 !defined(CONFIG_ENV_IS_IN_ONENAND) && \
105 !defined(CONFIG_ENV_IS_IN_SPI_FLASH)
106 # error "CONFIG_ENV_IS_EMBEDDED not supported for your flash type"
111 * For the flash types where embedded env is supported, but it cannot be
112 * calculated automatically (i.e. NAND), take the board opt-in.
114 #if defined(CONFIG_ENV_IS_EMBEDDED) && !defined(ENV_IS_EMBEDDED)
115 # define ENV_IS_EMBEDDED
118 /* The build system likes to know if the env is embedded */
120 # ifdef ENV_IS_EMBEDDED
121 # ifndef CONFIG_ENV_IS_EMBEDDED
122 # define CONFIG_ENV_IS_EMBEDDED
127 #include "compiler.h"
129 #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
130 # define ENV_HEADER_SIZE (sizeof(uint32_t) + 1)
132 # define ENV_HEADER_SIZE (sizeof(uint32_t))
135 #define ENV_SIZE (CONFIG_ENV_SIZE - ENV_HEADER_SIZE)
138 * If the environment is in RAM, allocate extra space for it in the malloc
141 #if defined(CONFIG_ENV_IS_EMBEDDED)
142 #define TOTAL_MALLOC_LEN CONFIG_SYS_MALLOC_LEN
143 #elif (CONFIG_ENV_ADDR + CONFIG_ENV_SIZE < CONFIG_SYS_MONITOR_BASE) || \
144 (CONFIG_ENV_ADDR >= CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN) || \
145 defined(CONFIG_ENV_IS_IN_NVRAM)
146 #define TOTAL_MALLOC_LEN (CONFIG_SYS_MALLOC_LEN + CONFIG_ENV_SIZE)
148 #define TOTAL_MALLOC_LEN CONFIG_SYS_MALLOC_LEN
151 typedef struct environment_s {
152 uint32_t crc; /* CRC32 over data bytes */
153 #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
154 unsigned char flags; /* active/obsolete flags ENVF_REDUND_ */
156 unsigned char data[ENV_SIZE]; /* Environment data */
159 #ifdef ENV_IS_EMBEDDED
160 extern env_t embedded_environment;
161 #endif /* ENV_IS_EMBEDDED */
163 extern const unsigned char default_environment[];
167 #include <env_attr.h>
168 #include <env_callback.h>
169 #include <env_flags.h>
190 /* value for the various operations we want to perform on the env */
192 ENVOP_GET_CHAR, /* we want to call the get_char function */
193 ENVOP_INIT, /* we want to call the init function */
194 ENVOP_LOAD, /* we want to call the load function */
195 ENVOP_SAVE, /* we want to call the save function */
196 ENVOP_ERASE, /* we want to call the erase function */
201 enum env_location location;
204 * load() - Load the environment from storage
206 * This method is optional. If not provided, no environment will be
209 * @return 0 if OK, -ve on error
214 * save() - Save the environment to storage
216 * This method is required for 'saveenv' to work.
218 * @return 0 if OK, -ve on error
223 * erase() - Erase the environment on storage
225 * This method is optional and required for 'eraseenv' to work.
227 * @return 0 if OK, -ve on error
232 * init() - Set up the initial pre-relocation environment
234 * This method is optional.
236 * @return 0 if OK, -ENOENT if no initial environment could be found,
242 /* Declare a new environment location driver */
243 #define U_BOOT_ENV_LOCATION(__name) \
244 ll_entry_declare(struct env_driver, __name, env_driver)
246 /* Declare the name of a location */
247 #ifdef CONFIG_CMD_SAVEENV
248 #define ENV_NAME(_name) .name = _name,
250 #define ENV_NAME(_name)
253 #ifdef CONFIG_CMD_SAVEENV
254 #define env_save_ptr(x) x
256 #define env_save_ptr(x) NULL
259 extern struct hsearch_data env_htab;
261 #endif /* DO_DEPS_ONLY */
263 #endif /* _ENV_INTERNAL_H_ */