3 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
5 * SPDX-License-Identifier: GPL-2.0+
8 #ifndef _ENVIRONMENT_H_
9 #define _ENVIRONMENT_H_
11 #include <linux/kconfig.h>
13 /**************************************************************************
15 * The "environment" is stored as a list of '\0' terminated
16 * "name=value" strings. The end of the list is marked by a double
17 * '\0'. New entries are always added at the end. Deleting an entry
18 * shifts the remaining entries to the front. Replacing an entry is a
19 * combination of deleting the old value and adding the new one.
21 * The environment is preceded by a 32 bit CRC over the data part.
23 *************************************************************************/
25 #if defined(CONFIG_ENV_IS_IN_FLASH)
26 # ifndef CONFIG_ENV_ADDR
27 # define CONFIG_ENV_ADDR (CONFIG_SYS_FLASH_BASE + CONFIG_ENV_OFFSET)
29 # ifndef CONFIG_ENV_OFFSET
30 # define CONFIG_ENV_OFFSET (CONFIG_ENV_ADDR - CONFIG_SYS_FLASH_BASE)
32 # if !defined(CONFIG_ENV_ADDR_REDUND) && defined(CONFIG_ENV_OFFSET_REDUND)
33 # define CONFIG_ENV_ADDR_REDUND \
34 (CONFIG_SYS_FLASH_BASE + CONFIG_ENV_OFFSET_REDUND)
36 # if defined(CONFIG_ENV_SECT_SIZE) || defined(CONFIG_ENV_SIZE)
37 # ifndef CONFIG_ENV_SECT_SIZE
38 # define CONFIG_ENV_SECT_SIZE CONFIG_ENV_SIZE
40 # ifndef CONFIG_ENV_SIZE
41 # define CONFIG_ENV_SIZE CONFIG_ENV_SECT_SIZE
44 # error "Both CONFIG_ENV_SECT_SIZE and CONFIG_ENV_SIZE undefined"
46 # if defined(CONFIG_ENV_ADDR_REDUND) && !defined(CONFIG_ENV_SIZE_REDUND)
47 # define CONFIG_ENV_SIZE_REDUND CONFIG_ENV_SIZE
49 # if (CONFIG_ENV_ADDR >= CONFIG_SYS_MONITOR_BASE) && \
50 (CONFIG_ENV_ADDR + CONFIG_ENV_SIZE) <= \
51 (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN)
52 # define ENV_IS_EMBEDDED
54 # if defined(CONFIG_ENV_ADDR_REDUND) || defined(CONFIG_ENV_OFFSET_REDUND)
55 # define CONFIG_SYS_REDUNDAND_ENVIRONMENT
57 # ifdef CONFIG_ENV_IS_EMBEDDED
58 # error "do not define CONFIG_ENV_IS_EMBEDDED in your board config"
59 # error "it is calculated automatically for you"
61 #endif /* CONFIG_ENV_IS_IN_FLASH */
63 #if defined(CONFIG_ENV_IS_IN_MMC)
64 # ifdef CONFIG_ENV_OFFSET_REDUND
65 # define CONFIG_SYS_REDUNDAND_ENVIRONMENT
69 #if defined(CONFIG_ENV_IS_IN_NAND)
70 # if defined(CONFIG_ENV_OFFSET_OOB)
71 # ifdef CONFIG_ENV_OFFSET_REDUND
72 # error "CONFIG_ENV_OFFSET_REDUND is not supported when CONFIG_ENV_OFFSET_OOB"
75 extern unsigned long nand_env_oob_offset;
76 # define CONFIG_ENV_OFFSET nand_env_oob_offset
78 # ifndef CONFIG_ENV_OFFSET
79 # error "Need to define CONFIG_ENV_OFFSET when using CONFIG_ENV_IS_IN_NAND"
81 # ifdef CONFIG_ENV_OFFSET_REDUND
82 # define CONFIG_SYS_REDUNDAND_ENVIRONMENT
84 # endif /* CONFIG_ENV_OFFSET_OOB */
85 # ifndef CONFIG_ENV_SIZE
86 # error "Need to define CONFIG_ENV_SIZE when using CONFIG_ENV_IS_IN_NAND"
88 #endif /* CONFIG_ENV_IS_IN_NAND */
90 #if defined(CONFIG_ENV_IS_IN_UBI)
91 # ifndef CONFIG_ENV_UBI_PART
92 # error "Need to define CONFIG_ENV_UBI_PART when using CONFIG_ENV_IS_IN_UBI"
94 # ifndef CONFIG_ENV_UBI_VOLUME
95 # error "Need to define CONFIG_ENV_UBI_VOLUME when using CONFIG_ENV_IS_IN_UBI"
97 # if defined(CONFIG_ENV_UBI_VOLUME_REDUND)
98 # define CONFIG_SYS_REDUNDAND_ENVIRONMENT
100 # ifndef CONFIG_ENV_SIZE
101 # error "Need to define CONFIG_ENV_SIZE when using CONFIG_ENV_IS_IN_UBI"
103 # ifndef CONFIG_CMD_UBI
104 # error "Need to define CONFIG_CMD_UBI when using CONFIG_ENV_IS_IN_UBI"
106 #endif /* CONFIG_ENV_IS_IN_UBI */
108 /* Embedded env is only supported for some flash types */
109 #ifdef CONFIG_ENV_IS_EMBEDDED
110 # if !defined(CONFIG_ENV_IS_IN_FLASH) && \
111 !defined(CONFIG_ENV_IS_IN_NAND) && \
112 !defined(CONFIG_ENV_IS_IN_ONENAND) && \
113 !defined(CONFIG_ENV_IS_IN_SPI_FLASH)
114 # error "CONFIG_ENV_IS_EMBEDDED not supported for your flash type"
119 * For the flash types where embedded env is supported, but it cannot be
120 * calculated automatically (i.e. NAND), take the board opt-in.
122 #if defined(CONFIG_ENV_IS_EMBEDDED) && !defined(ENV_IS_EMBEDDED)
123 # define ENV_IS_EMBEDDED
126 /* The build system likes to know if the env is embedded */
128 # ifdef ENV_IS_EMBEDDED
129 # ifndef CONFIG_ENV_IS_EMBEDDED
130 # define CONFIG_ENV_IS_EMBEDDED
135 #include "compiler.h"
137 #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
138 # define ENV_HEADER_SIZE (sizeof(uint32_t) + 1)
140 # define ACTIVE_FLAG 1
141 # define OBSOLETE_FLAG 0
143 # define ENV_HEADER_SIZE (sizeof(uint32_t))
146 #define ENV_SIZE (CONFIG_ENV_SIZE - ENV_HEADER_SIZE)
148 typedef struct environment_s {
149 uint32_t crc; /* CRC32 over data bytes */
150 #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
151 unsigned char flags; /* active/obsolete flags */
153 unsigned char data[ENV_SIZE]; /* Environment data */
156 #ifdef ENV_IS_EMBEDDED
157 extern env_t environment;
158 #endif /* ENV_IS_EMBEDDED */
160 extern const unsigned char default_environment[];
161 extern env_t *env_ptr;
163 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
164 extern void env_reloc(void);
167 #ifdef CONFIG_ENV_IS_IN_MMC
170 extern int mmc_get_env_addr(struct mmc *mmc, int copy, u32 *env_addr);
171 # ifdef CONFIG_SYS_MMC_ENV_PART
172 extern uint mmc_get_env_part(struct mmc *mmc);
178 #include <env_attr.h>
179 #include <env_callback.h>
180 #include <env_flags.h>
183 /* Value for environment validity */
185 ENV_INVALID, /* No valid environment */
186 ENV_VALID, /* First or only environment is valid */
187 ENV_REDUND, /* Redundant environment is valid */
208 /* value for the various operations we want to perform on the env */
210 ENVOP_GET_CHAR, /* we want to call the get_char function */
211 ENVOP_INIT, /* we want to call the init function */
212 ENVOP_LOAD, /* we want to call the load function */
213 ENVOP_SAVE, /* we want to call the save function */
218 enum env_location location;
221 * load() - Load the environment from storage
223 * This method is optional. If not provided, no environment will be
226 * @return 0 if OK, -ve on error
231 * save() - Save the environment to storage
233 * This method is required for 'saveenv' to work.
235 * @return 0 if OK, -ve on error
240 * init() - Set up the initial pre-relocation environment
242 * This method is optional.
244 * @return 0 if OK, -ENOENT if no initial environment could be found,
250 /* Declare a new environment location driver */
251 #define U_BOOT_ENV_LOCATION(__name) \
252 ll_entry_declare(struct env_driver, __name, env_driver)
254 /* Declare the name of a location */
255 #ifdef CONFIG_CMD_SAVEENV
256 #define ENV_NAME(_name) .name = _name,
258 #define ENV_NAME(_name)
261 #ifdef CONFIG_CMD_SAVEENV
262 #define env_save_ptr(x) x
264 #define env_save_ptr(x) NULL
267 extern struct hsearch_data env_htab;
269 /* Function that updates CRC of the enironment */
270 void env_crc_update(void);
272 /* Look up the variable from the default environment */
273 char *env_get_default(const char *name);
275 /* [re]set to the default environment */
276 void set_default_env(const char *s);
278 /* [re]set individual variables to their value in the default environment */
279 int set_default_vars(int nvars, char * const vars[]);
281 /* Import from binary representation into hash table */
282 int env_import(const char *buf, int check);
284 /* Export from hash table into binary representation */
285 int env_export(env_t *env_out);
287 #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
288 /* Select and import one of two redundant environments */
289 int env_import_redund(const char *buf1, int buf1_status,
290 const char *buf2, int buf2_status);
294 * env_get_char() - Get a character from the early environment
296 * This reads from the pre-relocation environemnt
298 * @index: Index of character to read (0 = first)
299 * @return character read, or -ve on error
301 int env_get_char(int index);
304 * env_load() - Load the environment from storage
306 * @return 0 if OK, -ve on error
311 * env_save() - Save the environment to storage
313 * @return 0 if OK, -ve on error
317 #endif /* DO_DEPS_ONLY */
319 #endif /* _ENVIRONMENT_H_ */