1 /* SPDX-License-Identifier: GPL-2.0+ */
4 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
7 #ifndef _ENVIRONMENT_H_
8 #define _ENVIRONMENT_H_
10 #include <linux/kconfig.h>
12 /**************************************************************************
14 * The "environment" is stored as a list of '\0' terminated
15 * "name=value" strings. The end of the list is marked by a double
16 * '\0'. New entries are always added at the end. Deleting an entry
17 * shifts the remaining entries to the front. Replacing an entry is a
18 * combination of deleting the old value and adding the new one.
20 * The environment is preceded by a 32 bit CRC over the data part.
22 *************************************************************************/
24 #if defined(CONFIG_ENV_IS_IN_FLASH)
25 # ifndef CONFIG_ENV_ADDR
26 # define CONFIG_ENV_ADDR (CONFIG_SYS_FLASH_BASE + CONFIG_ENV_OFFSET)
28 # ifndef CONFIG_ENV_OFFSET
29 # define CONFIG_ENV_OFFSET (CONFIG_ENV_ADDR - CONFIG_SYS_FLASH_BASE)
31 # if !defined(CONFIG_ENV_ADDR_REDUND) && defined(CONFIG_ENV_OFFSET_REDUND)
32 # define CONFIG_ENV_ADDR_REDUND \
33 (CONFIG_SYS_FLASH_BASE + CONFIG_ENV_OFFSET_REDUND)
35 # if defined(CONFIG_ENV_SECT_SIZE) || defined(CONFIG_ENV_SIZE)
36 # ifndef CONFIG_ENV_SECT_SIZE
37 # define CONFIG_ENV_SECT_SIZE CONFIG_ENV_SIZE
39 # ifndef CONFIG_ENV_SIZE
40 # define CONFIG_ENV_SIZE CONFIG_ENV_SECT_SIZE
43 # error "Both CONFIG_ENV_SECT_SIZE and CONFIG_ENV_SIZE undefined"
45 # if defined(CONFIG_ENV_ADDR_REDUND) && !defined(CONFIG_ENV_SIZE_REDUND)
46 # define CONFIG_ENV_SIZE_REDUND CONFIG_ENV_SIZE
48 # if (CONFIG_ENV_ADDR >= CONFIG_SYS_MONITOR_BASE) && \
49 (CONFIG_ENV_ADDR + CONFIG_ENV_SIZE) <= \
50 (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN)
51 # define ENV_IS_EMBEDDED
53 # if defined(CONFIG_ENV_ADDR_REDUND) || defined(CONFIG_ENV_OFFSET_REDUND)
54 # define CONFIG_SYS_REDUNDAND_ENVIRONMENT
56 # ifdef CONFIG_ENV_IS_EMBEDDED
57 # error "do not define CONFIG_ENV_IS_EMBEDDED in your board config"
58 # error "it is calculated automatically for you"
60 #endif /* CONFIG_ENV_IS_IN_FLASH */
62 #if defined(CONFIG_ENV_IS_IN_MMC)
63 # ifdef CONFIG_ENV_OFFSET_REDUND
64 # define CONFIG_SYS_REDUNDAND_ENVIRONMENT
68 #if defined(CONFIG_ENV_IS_IN_NAND)
69 # if defined(CONFIG_ENV_OFFSET_OOB)
70 # ifdef CONFIG_ENV_OFFSET_REDUND
71 # error "CONFIG_ENV_OFFSET_REDUND is not supported when CONFIG_ENV_OFFSET_OOB"
74 extern unsigned long nand_env_oob_offset;
75 # define CONFIG_ENV_OFFSET nand_env_oob_offset
77 # ifndef CONFIG_ENV_OFFSET
78 # error "Need to define CONFIG_ENV_OFFSET when using CONFIG_ENV_IS_IN_NAND"
80 # ifdef CONFIG_ENV_OFFSET_REDUND
81 # define CONFIG_SYS_REDUNDAND_ENVIRONMENT
83 # endif /* CONFIG_ENV_OFFSET_OOB */
84 # ifndef CONFIG_ENV_SIZE
85 # error "Need to define CONFIG_ENV_SIZE when using CONFIG_ENV_IS_IN_NAND"
87 #endif /* CONFIG_ENV_IS_IN_NAND */
89 #if defined(CONFIG_ENV_IS_IN_UBI)
90 # ifndef CONFIG_ENV_UBI_PART
91 # error "Need to define CONFIG_ENV_UBI_PART when using CONFIG_ENV_IS_IN_UBI"
93 # ifndef CONFIG_ENV_UBI_VOLUME
94 # error "Need to define CONFIG_ENV_UBI_VOLUME when using CONFIG_ENV_IS_IN_UBI"
96 # if defined(CONFIG_ENV_UBI_VOLUME_REDUND)
97 # define CONFIG_SYS_REDUNDAND_ENVIRONMENT
99 # ifndef CONFIG_ENV_SIZE
100 # error "Need to define CONFIG_ENV_SIZE when using CONFIG_ENV_IS_IN_UBI"
102 # ifndef CONFIG_CMD_UBI
103 # error "Need to define CONFIG_CMD_UBI when using CONFIG_ENV_IS_IN_UBI"
105 #endif /* CONFIG_ENV_IS_IN_UBI */
107 /* Embedded env is only supported for some flash types */
108 #ifdef CONFIG_ENV_IS_EMBEDDED
109 # if !defined(CONFIG_ENV_IS_IN_FLASH) && \
110 !defined(CONFIG_ENV_IS_IN_NAND) && \
111 !defined(CONFIG_ENV_IS_IN_ONENAND) && \
112 !defined(CONFIG_ENV_IS_IN_SPI_FLASH)
113 # error "CONFIG_ENV_IS_EMBEDDED not supported for your flash type"
118 * For the flash types where embedded env is supported, but it cannot be
119 * calculated automatically (i.e. NAND), take the board opt-in.
121 #if defined(CONFIG_ENV_IS_EMBEDDED) && !defined(ENV_IS_EMBEDDED)
122 # define ENV_IS_EMBEDDED
125 /* The build system likes to know if the env is embedded */
127 # ifdef ENV_IS_EMBEDDED
128 # ifndef CONFIG_ENV_IS_EMBEDDED
129 # define CONFIG_ENV_IS_EMBEDDED
134 #include "compiler.h"
136 #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
137 # define ENV_HEADER_SIZE (sizeof(uint32_t) + 1)
139 # define ENV_HEADER_SIZE (sizeof(uint32_t))
142 #define ENV_SIZE (CONFIG_ENV_SIZE - ENV_HEADER_SIZE)
144 typedef struct environment_s {
145 uint32_t crc; /* CRC32 over data bytes */
146 #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
147 unsigned char flags; /* active/obsolete flags ENVF_REDUND_ */
149 unsigned char data[ENV_SIZE]; /* Environment data */
152 #ifdef ENV_IS_EMBEDDED
153 extern env_t embedded_environment;
154 #endif /* ENV_IS_EMBEDDED */
156 extern const unsigned char default_environment[];
160 #include <env_attr.h>
161 #include <env_callback.h>
162 #include <env_flags.h>
183 /* value for the various operations we want to perform on the env */
185 ENVOP_GET_CHAR, /* we want to call the get_char function */
186 ENVOP_INIT, /* we want to call the init function */
187 ENVOP_LOAD, /* we want to call the load function */
188 ENVOP_SAVE, /* we want to call the save function */
189 ENVOP_ERASE, /* we want to call the erase function */
194 enum env_location location;
197 * load() - Load the environment from storage
199 * This method is optional. If not provided, no environment will be
202 * @return 0 if OK, -ve on error
207 * save() - Save the environment to storage
209 * This method is required for 'saveenv' to work.
211 * @return 0 if OK, -ve on error
216 * erase() - Erase the environment on storage
218 * This method is optional and required for 'eraseenv' to work.
220 * @return 0 if OK, -ve on error
225 * init() - Set up the initial pre-relocation environment
227 * This method is optional.
229 * @return 0 if OK, -ENOENT if no initial environment could be found,
235 /* Declare a new environment location driver */
236 #define U_BOOT_ENV_LOCATION(__name) \
237 ll_entry_declare(struct env_driver, __name, env_driver)
239 /* Declare the name of a location */
240 #ifdef CONFIG_CMD_SAVEENV
241 #define ENV_NAME(_name) .name = _name,
243 #define ENV_NAME(_name)
246 #ifdef CONFIG_CMD_SAVEENV
247 #define env_save_ptr(x) x
249 #define env_save_ptr(x) NULL
252 extern struct hsearch_data env_htab;
254 #endif /* DO_DEPS_ONLY */
256 #endif /* _ENVIRONMENT_H_ */