environment.h 8.4 KB
Newer Older
1
/* SPDX-License-Identifier: GPL-2.0+ */
wdenk's avatar
wdenk committed
2 3 4 5 6 7
/*
 * (C) Copyright 2002
 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
 */

#ifndef _ENVIRONMENT_H_
8
#define _ENVIRONMENT_H_
wdenk's avatar
wdenk committed
9

10 11
#include <linux/kconfig.h>

wdenk's avatar
wdenk committed
12 13 14 15 16 17 18 19
/**************************************************************************
 *
 * The "environment" is stored as a list of '\0' terminated
 * "name=value" strings. The end of the list is marked by a double
 * '\0'. New entries are always added at the end. Deleting an entry
 * shifts the remaining entries to the front. Replacing an entry is a
 * 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.
wdenk's avatar
wdenk committed
21
 *
22
 *************************************************************************/
wdenk's avatar
wdenk committed
23

24
#if defined(CONFIG_ENV_IS_IN_FLASH)
25 26
# ifndef	CONFIG_ENV_ADDR
#  define	CONFIG_ENV_ADDR	(CONFIG_SYS_FLASH_BASE + CONFIG_ENV_OFFSET)
wdenk's avatar
wdenk committed
27
# endif
28 29
# ifndef	CONFIG_ENV_OFFSET
#  define	CONFIG_ENV_OFFSET (CONFIG_ENV_ADDR - CONFIG_SYS_FLASH_BASE)
wdenk's avatar
wdenk committed
30
# endif
31
# if !defined(CONFIG_ENV_ADDR_REDUND) && defined(CONFIG_ENV_OFFSET_REDUND)
32 33
#  define	CONFIG_ENV_ADDR_REDUND	\
		(CONFIG_SYS_FLASH_BASE + CONFIG_ENV_OFFSET_REDUND)
wdenk's avatar
wdenk committed
34
# endif
35
# if defined(CONFIG_ENV_SECT_SIZE) || defined(CONFIG_ENV_SIZE)
36 37
#  ifndef	CONFIG_ENV_SECT_SIZE
#   define	CONFIG_ENV_SECT_SIZE	CONFIG_ENV_SIZE
38
#  endif
39 40
#  ifndef	CONFIG_ENV_SIZE
#   define	CONFIG_ENV_SIZE	CONFIG_ENV_SECT_SIZE
41 42
#  endif
# else
43
#  error "Both CONFIG_ENV_SECT_SIZE and CONFIG_ENV_SIZE undefined"
wdenk's avatar
wdenk committed
44
# endif
45 46
# if defined(CONFIG_ENV_ADDR_REDUND) && !defined(CONFIG_ENV_SIZE_REDUND)
#  define CONFIG_ENV_SIZE_REDUND	CONFIG_ENV_SIZE
wdenk's avatar
wdenk committed
47
# endif
48 49 50
# if	(CONFIG_ENV_ADDR >= CONFIG_SYS_MONITOR_BASE) &&		\
	(CONFIG_ENV_ADDR + CONFIG_ENV_SIZE) <=			\
	(CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN)
51
#  define ENV_IS_EMBEDDED
wdenk's avatar
wdenk committed
52
# endif
53
# if defined(CONFIG_ENV_ADDR_REDUND) || defined(CONFIG_ENV_OFFSET_REDUND)
54
#  define CONFIG_SYS_REDUNDAND_ENVIRONMENT
wdenk's avatar
wdenk committed
55
# endif
56 57 58 59
# ifdef CONFIG_ENV_IS_EMBEDDED
#  error "do not define CONFIG_ENV_IS_EMBEDDED in your board config"
#  error "it is calculated automatically for you"
# endif
60
#endif	/* CONFIG_ENV_IS_IN_FLASH */
wdenk's avatar
wdenk committed
61

62 63 64 65 66 67
#if defined(CONFIG_ENV_IS_IN_MMC)
# ifdef CONFIG_ENV_OFFSET_REDUND
#  define CONFIG_SYS_REDUNDAND_ENVIRONMENT
# endif
#endif

68
#if defined(CONFIG_ENV_IS_IN_NAND)
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83
# if defined(CONFIG_ENV_OFFSET_OOB)
#  ifdef CONFIG_ENV_OFFSET_REDUND
#   error "CONFIG_ENV_OFFSET_REDUND is not supported when CONFIG_ENV_OFFSET_OOB"
#   error "is set"
#  endif
extern unsigned long nand_env_oob_offset;
#  define CONFIG_ENV_OFFSET nand_env_oob_offset
# else
#  ifndef CONFIG_ENV_OFFSET
#   error "Need to define CONFIG_ENV_OFFSET when using CONFIG_ENV_IS_IN_NAND"
#  endif
#  ifdef CONFIG_ENV_OFFSET_REDUND
#   define CONFIG_SYS_REDUNDAND_ENVIRONMENT
#  endif
# endif /* CONFIG_ENV_OFFSET_OOB */
84 85
# ifndef CONFIG_ENV_SIZE
#  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 90 91 92 93 94 95
#if defined(CONFIG_ENV_IS_IN_UBI)
# ifndef CONFIG_ENV_UBI_PART
#  error "Need to define CONFIG_ENV_UBI_PART when using CONFIG_ENV_IS_IN_UBI"
# endif
# ifndef CONFIG_ENV_UBI_VOLUME
#  error "Need to define CONFIG_ENV_UBI_VOLUME when using CONFIG_ENV_IS_IN_UBI"
# endif
96 97 98
# if defined(CONFIG_ENV_UBI_VOLUME_REDUND)
#  define CONFIG_SYS_REDUNDAND_ENVIRONMENT
# endif
99 100 101 102 103 104 105 106
# ifndef CONFIG_ENV_SIZE
#  error "Need to define CONFIG_ENV_SIZE when using CONFIG_ENV_IS_IN_UBI"
# endif
# ifndef CONFIG_CMD_UBI
#  error "Need to define CONFIG_CMD_UBI when using CONFIG_ENV_IS_IN_UBI"
# endif
#endif /* CONFIG_ENV_IS_IN_UBI */

107 108
/* Embedded env is only supported for some flash types */
#ifdef CONFIG_ENV_IS_EMBEDDED
109 110 111 112
# if	!defined(CONFIG_ENV_IS_IN_FLASH)	&& \
	!defined(CONFIG_ENV_IS_IN_NAND)		&& \
	!defined(CONFIG_ENV_IS_IN_ONENAND)	&& \
	!defined(CONFIG_ENV_IS_IN_SPI_FLASH)
113 114 115 116 117 118 119 120 121
#  error "CONFIG_ENV_IS_EMBEDDED not supported for your flash type"
# endif
#endif

/*
 * For the flash types where embedded env is supported, but it cannot be
 * calculated automatically (i.e. NAND), take the board opt-in.
 */
#if defined(CONFIG_ENV_IS_EMBEDDED) && !defined(ENV_IS_EMBEDDED)
122
# define ENV_IS_EMBEDDED
123 124 125 126 127
#endif

/* The build system likes to know if the env is embedded */
#ifdef DO_DEPS_ONLY
# ifdef ENV_IS_EMBEDDED
128 129 130
#  ifndef CONFIG_ENV_IS_EMBEDDED
#   define CONFIG_ENV_IS_EMBEDDED
#  endif
131 132 133
# endif
#endif

134
#include "compiler.h"
wdenk's avatar
wdenk committed
135

136
#ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
137
# define ENV_HEADER_SIZE	(sizeof(uint32_t) + 1)
138 139 140

# define ACTIVE_FLAG   1
# define OBSOLETE_FLAG 0
wdenk's avatar
wdenk committed
141
#else
142
# define ENV_HEADER_SIZE	(sizeof(uint32_t))
wdenk's avatar
wdenk committed
143 144
#endif

145
#define ENV_SIZE (CONFIG_ENV_SIZE - ENV_HEADER_SIZE)
wdenk's avatar
wdenk committed
146

147
typedef struct environment_s {
148
	uint32_t	crc;		/* CRC32 over data bytes	*/
149
#ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
wdenk's avatar
wdenk committed
150 151 152
	unsigned char	flags;		/* active/obsolete flags	*/
#endif
	unsigned char	data[ENV_SIZE]; /* Environment data		*/
153
} env_t;
wdenk's avatar
wdenk committed
154

155 156 157 158
#ifdef ENV_IS_EMBEDDED
extern env_t environment;
#endif /* ENV_IS_EMBEDDED */

159
extern const unsigned char default_environment[];
160 161 162 163

#if defined(CONFIG_NEEDS_MANUAL_RELOC)
extern void env_reloc(void);
#endif
164

165 166
#ifndef DO_DEPS_ONLY

167 168
#include <env_attr.h>
#include <env_callback.h>
169
#include <env_flags.h>
170 171
#include <search.h>

172 173 174 175 176 177 178
/* Value for environment validity */
enum env_valid {
	ENV_INVALID,	/* No valid environment */
	ENV_VALID,	/* First or only environment is valid */
	ENV_REDUND,	/* Redundant environment is valid */
};

179
enum env_location {
York Sun's avatar
York Sun committed
180
	ENVL_UNKNOWN,
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
	ENVL_EEPROM,
	ENVL_EXT4,
	ENVL_FAT,
	ENVL_FLASH,
	ENVL_MMC,
	ENVL_NAND,
	ENVL_NVRAM,
	ENVL_ONENAND,
	ENVL_REMOTE,
	ENVL_SPI_FLASH,
	ENVL_UBI,
	ENVL_NOWHERE,

	ENVL_COUNT,
};

197 198 199 200 201 202 203 204
/* value for the various operations we want to perform on the env */
enum env_operation {
	ENVOP_GET_CHAR,	/* we want to call the get_char function */
	ENVOP_INIT,	/* we want to call the init function */
	ENVOP_LOAD,	/* we want to call the load function */
	ENVOP_SAVE,	/* we want to call the save function */
};

205
struct env_driver {
206
	const char *name;
207 208 209 210 211 212 213
	enum env_location location;

	/**
	 * load() - Load the environment from storage
	 *
	 * This method is optional. If not provided, no environment will be
	 * loaded.
214 215
	 *
	 * @return 0 if OK, -ve on error
216
	 */
217
	int (*load)(void);
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232

	/**
	 * save() - Save the environment to storage
	 *
	 * This method is required for 'saveenv' to work.
	 *
	 * @return 0 if OK, -ve on error
	 */
	int (*save)(void);

	/**
	 * init() - Set up the initial pre-relocation environment
	 *
	 * This method is optional.
	 *
233 234
	 * @return 0 if OK, -ENOENT if no initial environment could be found,
	 * other -ve on error
235 236 237 238 239 240 241 242
	 */
	int (*init)(void);
};

/* Declare a new environment location driver */
#define U_BOOT_ENV_LOCATION(__name)					\
	ll_entry_declare(struct env_driver, __name, env_driver)

243 244 245 246 247 248 249
/* Declare the name of a location */
#ifdef CONFIG_CMD_SAVEENV
#define ENV_NAME(_name) .name = _name,
#else
#define ENV_NAME(_name)
#endif

250 251 252 253 254 255
#ifdef CONFIG_CMD_SAVEENV
#define env_save_ptr(x) x
#else
#define env_save_ptr(x) NULL
#endif

256 257
extern struct hsearch_data env_htab;

258
/* Function that updates CRC of the enironment */
259
void env_crc_update(void);
260

261
/* Look up the variable from the default environment */
262
char *env_get_default(const char *name);
263

264
/* [re]set to the default environment */
265
void set_default_env(const char *s, int flags);
266

267
/* [re]set individual variables to their value in the default environment */
268
int set_default_vars(int nvars, char * const vars[], int flags);
269

270 271
/* Import from binary representation into hash table */
int env_import(const char *buf, int check);
272

273 274 275
/* Export from hash table into binary representation */
int env_export(env_t *env_out);

276 277
#ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
/* Select and import one of two redundant environments */
278 279
int env_import_redund(const char *buf1, int buf1_status,
		      const char *buf2, int buf2_status);
280 281
#endif

282 283 284
/**
 * env_get_char() - Get a character from the early environment
 *
Shyam Saini's avatar
Shyam Saini committed
285
 * This reads from the pre-relocation environment
286 287 288 289 290 291
 *
 * @index: Index of character to read (0 = first)
 * @return character read, or -ve on error
 */
int env_get_char(int index);

292 293 294 295 296 297 298
/**
 * env_load() - Load the environment from storage
 *
 * @return 0 if OK, -ve on error
 */
int env_load(void);

299 300 301 302 303 304 305
/**
 * env_save() - Save the environment to storage
 *
 * @return 0 if OK, -ve on error
 */
int env_save(void);

306 307 308 309 310
/**
 * env_fix_drivers() - Updates envdriver as per relocation
 */
void env_fix_drivers(void);

311 312 313 314
void eth_parse_enetaddr(const char *addr, uint8_t *enetaddr);
int eth_env_get_enetaddr(const char *name, uint8_t *enetaddr);
int eth_env_set_enetaddr(const char *name, const uint8_t *enetaddr);

315
#endif /* DO_DEPS_ONLY */
316

317
#endif /* _ENVIRONMENT_H_ */