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