Merge git://git.denx.de/u-boot-x86
[platform/kernel/u-boot.git] / include / environment.h
1 /* SPDX-License-Identifier: GPL-2.0+ */
2 /*
3  * (C) Copyright 2002
4  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
5  */
6
7 #ifndef _ENVIRONMENT_H_
8 #define _ENVIRONMENT_H_
9
10 #include <linux/kconfig.h>
11
12 /**************************************************************************
13  *
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.
19  *
20  * The environment is preceded by a 32 bit CRC over the data part.
21  *
22  *************************************************************************/
23
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)
27 # endif
28 # ifndef        CONFIG_ENV_OFFSET
29 #  define       CONFIG_ENV_OFFSET (CONFIG_ENV_ADDR - CONFIG_SYS_FLASH_BASE)
30 # endif
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)
34 # endif
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
38 #  endif
39 #  ifndef       CONFIG_ENV_SIZE
40 #   define      CONFIG_ENV_SIZE CONFIG_ENV_SECT_SIZE
41 #  endif
42 # else
43 #  error "Both CONFIG_ENV_SECT_SIZE and CONFIG_ENV_SIZE undefined"
44 # endif
45 # if defined(CONFIG_ENV_ADDR_REDUND) && !defined(CONFIG_ENV_SIZE_REDUND)
46 #  define CONFIG_ENV_SIZE_REDUND        CONFIG_ENV_SIZE
47 # endif
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
52 # endif
53 # if defined(CONFIG_ENV_ADDR_REDUND) || defined(CONFIG_ENV_OFFSET_REDUND)
54 #  define CONFIG_SYS_REDUNDAND_ENVIRONMENT
55 # endif
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"
59 # endif
60 #endif  /* CONFIG_ENV_IS_IN_FLASH */
61
62 #if defined(CONFIG_ENV_IS_IN_MMC)
63 # ifdef CONFIG_ENV_OFFSET_REDUND
64 #  define CONFIG_SYS_REDUNDAND_ENVIRONMENT
65 # endif
66 #endif
67
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"
72 #   error "is set"
73 #  endif
74 extern unsigned long nand_env_oob_offset;
75 #  define CONFIG_ENV_OFFSET nand_env_oob_offset
76 # else
77 #  ifndef CONFIG_ENV_OFFSET
78 #   error "Need to define CONFIG_ENV_OFFSET when using CONFIG_ENV_IS_IN_NAND"
79 #  endif
80 #  ifdef CONFIG_ENV_OFFSET_REDUND
81 #   define CONFIG_SYS_REDUNDAND_ENVIRONMENT
82 #  endif
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"
86 # endif
87 #endif /* CONFIG_ENV_IS_IN_NAND */
88
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"
92 # endif
93 # ifndef CONFIG_ENV_UBI_VOLUME
94 #  error "Need to define CONFIG_ENV_UBI_VOLUME when using CONFIG_ENV_IS_IN_UBI"
95 # endif
96 # if defined(CONFIG_ENV_UBI_VOLUME_REDUND)
97 #  define CONFIG_SYS_REDUNDAND_ENVIRONMENT
98 # endif
99 # ifndef CONFIG_ENV_SIZE
100 #  error "Need to define CONFIG_ENV_SIZE when using CONFIG_ENV_IS_IN_UBI"
101 # endif
102 # ifndef CONFIG_CMD_UBI
103 #  error "Need to define CONFIG_CMD_UBI when using CONFIG_ENV_IS_IN_UBI"
104 # endif
105 #endif /* CONFIG_ENV_IS_IN_UBI */
106
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"
114 # endif
115 #endif
116
117 /*
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.
120  */
121 #if defined(CONFIG_ENV_IS_EMBEDDED) && !defined(ENV_IS_EMBEDDED)
122 # define ENV_IS_EMBEDDED
123 #endif
124
125 /* The build system likes to know if the env is embedded */
126 #ifdef DO_DEPS_ONLY
127 # ifdef ENV_IS_EMBEDDED
128 #  ifndef CONFIG_ENV_IS_EMBEDDED
129 #   define CONFIG_ENV_IS_EMBEDDED
130 #  endif
131 # endif
132 #endif
133
134 #include "compiler.h"
135
136 #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
137 # define ENV_HEADER_SIZE        (sizeof(uint32_t) + 1)
138
139 # define ACTIVE_FLAG   1
140 # define OBSOLETE_FLAG 0
141 #else
142 # define ENV_HEADER_SIZE        (sizeof(uint32_t))
143 #endif
144
145 #define ENV_SIZE (CONFIG_ENV_SIZE - ENV_HEADER_SIZE)
146
147 typedef struct environment_s {
148         uint32_t        crc;            /* CRC32 over data bytes        */
149 #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
150         unsigned char   flags;          /* active/obsolete flags        */
151 #endif
152         unsigned char   data[ENV_SIZE]; /* Environment data             */
153 } env_t;
154
155 #ifdef ENV_IS_EMBEDDED
156 extern env_t environment;
157 #endif /* ENV_IS_EMBEDDED */
158
159 extern const unsigned char default_environment[];
160 extern env_t *env_ptr;
161
162 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
163 extern void env_reloc(void);
164 #endif
165
166 #ifdef CONFIG_ENV_IS_IN_MMC
167 #include <mmc.h>
168
169 extern int mmc_get_env_addr(struct mmc *mmc, int copy, u32 *env_addr);
170 # ifdef CONFIG_SYS_MMC_ENV_PART
171 extern uint mmc_get_env_part(struct mmc *mmc);
172 # endif
173 #endif
174
175 #ifndef DO_DEPS_ONLY
176
177 #include <env_attr.h>
178 #include <env_callback.h>
179 #include <env_flags.h>
180 #include <search.h>
181
182 /* Value for environment validity */
183 enum env_valid {
184         ENV_INVALID,    /* No valid environment */
185         ENV_VALID,      /* First or only environment is valid */
186         ENV_REDUND,     /* Redundant environment is valid */
187 };
188
189 enum env_location {
190         ENVL_UNKNOWN,
191         ENVL_EEPROM,
192         ENVL_EXT4,
193         ENVL_FAT,
194         ENVL_FLASH,
195         ENVL_MMC,
196         ENVL_NAND,
197         ENVL_NVRAM,
198         ENVL_ONENAND,
199         ENVL_REMOTE,
200         ENVL_SPI_FLASH,
201         ENVL_UBI,
202         ENVL_NOWHERE,
203
204         ENVL_COUNT,
205 };
206
207 /* value for the various operations we want to perform on the env */
208 enum env_operation {
209         ENVOP_GET_CHAR, /* we want to call the get_char function */
210         ENVOP_INIT,     /* we want to call the init function */
211         ENVOP_LOAD,     /* we want to call the load function */
212         ENVOP_SAVE,     /* we want to call the save function */
213 };
214
215 struct env_driver {
216         const char *name;
217         enum env_location location;
218
219         /**
220          * load() - Load the environment from storage
221          *
222          * This method is optional. If not provided, no environment will be
223          * loaded.
224          *
225          * @return 0 if OK, -ve on error
226          */
227         int (*load)(void);
228
229         /**
230          * save() - Save the environment to storage
231          *
232          * This method is required for 'saveenv' to work.
233          *
234          * @return 0 if OK, -ve on error
235          */
236         int (*save)(void);
237
238         /**
239          * init() - Set up the initial pre-relocation environment
240          *
241          * This method is optional.
242          *
243          * @return 0 if OK, -ENOENT if no initial environment could be found,
244          * other -ve on error
245          */
246         int (*init)(void);
247 };
248
249 /* Declare a new environment location driver */
250 #define U_BOOT_ENV_LOCATION(__name)                                     \
251         ll_entry_declare(struct env_driver, __name, env_driver)
252
253 /* Declare the name of a location */
254 #ifdef CONFIG_CMD_SAVEENV
255 #define ENV_NAME(_name) .name = _name,
256 #else
257 #define ENV_NAME(_name)
258 #endif
259
260 #ifdef CONFIG_CMD_SAVEENV
261 #define env_save_ptr(x) x
262 #else
263 #define env_save_ptr(x) NULL
264 #endif
265
266 extern struct hsearch_data env_htab;
267
268 /* Function that updates CRC of the enironment */
269 void env_crc_update(void);
270
271 /* Look up the variable from the default environment */
272 char *env_get_default(const char *name);
273
274 /* [re]set to the default environment */
275 void set_default_env(const char *s, int flags);
276
277 /* [re]set individual variables to their value in the default environment */
278 int set_default_vars(int nvars, char * const vars[], int flags);
279
280 /* Import from binary representation into hash table */
281 int env_import(const char *buf, int check);
282
283 /* Export from hash table into binary representation */
284 int env_export(env_t *env_out);
285
286 #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
287 /* Select and import one of two redundant environments */
288 int env_import_redund(const char *buf1, int buf1_status,
289                       const char *buf2, int buf2_status);
290 #endif
291
292 /**
293  * env_get_char() - Get a character from the early environment
294  *
295  * This reads from the pre-relocation environment
296  *
297  * @index: Index of character to read (0 = first)
298  * @return character read, or -ve on error
299  */
300 int env_get_char(int index);
301
302 /**
303  * env_load() - Load the environment from storage
304  *
305  * @return 0 if OK, -ve on error
306  */
307 int env_load(void);
308
309 /**
310  * env_save() - Save the environment to storage
311  *
312  * @return 0 if OK, -ve on error
313  */
314 int env_save(void);
315
316 /**
317  * env_fix_drivers() - Updates envdriver as per relocation
318  */
319 void env_fix_drivers(void);
320
321 void eth_parse_enetaddr(const char *addr, uint8_t *enetaddr);
322 int eth_env_get_enetaddr(const char *name, uint8_t *enetaddr);
323 int eth_env_set_enetaddr(const char *name, const uint8_t *enetaddr);
324
325 #endif /* DO_DEPS_ONLY */
326
327 #endif /* _ENVIRONMENT_H_ */