1 /* SPDX-License-Identifier: GPL-2.0+ */ 2 /* 3 * Internal environment header file. This includes direct access to environment 4 * information such as its size and offset, direct access to the default 5 * environment and embedded environment (if used). It also provides environment 6 * drivers with various declarations. 7 * 8 * It should not be included by board files, drivers and code other than that 9 * related to the environment implementation. 10 * 11 * (C) Copyright 2002 12 * Wolfgang Denk, DENX Software Engineering, wd@denx.de. 13 */ 14 15 #ifndef _ENV_INTERNAL_H_ 16 #define _ENV_INTERNAL_H_ 17 18 #include <linux/kconfig.h> 19 20 /************************************************************************** 21 * 22 * The "environment" is stored as a list of '\0' terminated 23 * "name=value" strings. The end of the list is marked by a double 24 * '\0'. New entries are always added at the end. Deleting an entry 25 * shifts the remaining entries to the front. Replacing an entry is a 26 * combination of deleting the old value and adding the new one. 27 * 28 * The environment is preceded by a 32 bit CRC over the data part. 29 * 30 *************************************************************************/ 31 32 #if defined(CONFIG_ENV_IS_IN_FLASH) 33 # if defined(CONFIG_ENV_ADDR_REDUND) && \ 34 ((CONFIG_ENV_ADDR >= CONFIG_SYS_MONITOR_BASE) && \ 35 (CONFIG_ENV_ADDR_REDUND + CONFIG_ENV_SIZE) <= \ 36 (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN)) 37 # define ENV_IS_EMBEDDED 38 # endif 39 # if (CONFIG_ENV_ADDR >= CONFIG_SYS_MONITOR_BASE) && \ 40 (CONFIG_ENV_ADDR + CONFIG_ENV_SIZE) <= \ 41 (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN) 42 # define ENV_IS_EMBEDDED 43 # endif 44 # ifdef CONFIG_ENV_IS_EMBEDDED 45 # error "do not define CONFIG_ENV_IS_EMBEDDED in your board config" 46 # error "it is calculated automatically for you" 47 # endif 48 #endif /* CONFIG_ENV_IS_IN_FLASH */ 49 50 #if defined(CONFIG_ENV_IS_IN_NAND) 51 # if defined(CONFIG_ENV_OFFSET_OOB) 52 # ifdef CONFIG_ENV_OFFSET_REDUND 53 # error "CONFIG_ENV_OFFSET_REDUND is not supported when CONFIG_ENV_OFFSET_OOB" 54 # error "is set" 55 # endif 56 extern unsigned long nand_env_oob_offset; 57 # define CONFIG_ENV_OFFSET nand_env_oob_offset 58 # endif /* CONFIG_ENV_OFFSET_OOB */ 59 #endif /* CONFIG_ENV_IS_IN_NAND */ 60 61 /* 62 * For the flash types where embedded env is supported, but it cannot be 63 * calculated automatically (i.e. NAND), take the board opt-in. 64 */ 65 #if defined(CONFIG_ENV_IS_EMBEDDED) && !defined(ENV_IS_EMBEDDED) 66 # define ENV_IS_EMBEDDED 67 #endif 68 69 /* The build system likes to know if the env is embedded */ 70 #ifdef DO_DEPS_ONLY 71 # ifdef ENV_IS_EMBEDDED 72 # ifndef CONFIG_ENV_IS_EMBEDDED 73 # define CONFIG_ENV_IS_EMBEDDED 74 # endif 75 # endif 76 #endif 77 78 #include "compiler.h" 79 80 #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT 81 # define ENV_HEADER_SIZE (sizeof(uint32_t) + 1) 82 #else 83 # define ENV_HEADER_SIZE (sizeof(uint32_t)) 84 #endif 85 86 #define ENV_SIZE (CONFIG_ENV_SIZE - ENV_HEADER_SIZE) 87 88 /* 89 * If the environment is in RAM, allocate extra space for it in the malloc 90 * region. 91 */ 92 #if defined(CONFIG_ENV_IS_EMBEDDED) 93 #define TOTAL_MALLOC_LEN CONFIG_SYS_MALLOC_LEN 94 #elif (CONFIG_ENV_ADDR + CONFIG_ENV_SIZE < CONFIG_SYS_MONITOR_BASE) || \ 95 (CONFIG_ENV_ADDR >= CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN) || \ 96 defined(CONFIG_ENV_IS_IN_NVRAM) 97 #define TOTAL_MALLOC_LEN (CONFIG_SYS_MALLOC_LEN + CONFIG_ENV_SIZE) 98 #else 99 #define TOTAL_MALLOC_LEN CONFIG_SYS_MALLOC_LEN 100 #endif 101 102 typedef struct environment_s { 103 uint32_t crc; /* CRC32 over data bytes */ 104 #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT 105 unsigned char flags; /* active/obsolete flags ENVF_REDUND_ */ 106 #endif 107 unsigned char data[ENV_SIZE]; /* Environment data */ 108 } env_t; 109 110 #ifdef ENV_IS_EMBEDDED 111 extern env_t embedded_environment; 112 #endif /* ENV_IS_EMBEDDED */ 113 114 #ifdef DEFAULT_ENV_IS_RW 115 extern unsigned char default_environment[]; 116 #else 117 extern const unsigned char default_environment[]; 118 #endif 119 120 #ifndef DO_DEPS_ONLY 121 122 #include <env_attr.h> 123 #include <env_callback.h> 124 #include <env_flags.h> 125 #include <search.h> 126 127 enum env_location { 128 ENVL_UNKNOWN, 129 ENVL_EEPROM, 130 ENVL_EXT4, 131 ENVL_FAT, 132 ENVL_FLASH, 133 ENVL_MMC, 134 ENVL_NAND, 135 ENVL_NVRAM, 136 ENVL_ONENAND, 137 ENVL_REMOTE, 138 ENVL_SPI_FLASH, 139 ENVL_UBI, 140 ENVL_NOWHERE, 141 142 ENVL_COUNT, 143 }; 144 145 /* value for the various operations we want to perform on the env */ 146 enum env_operation { 147 ENVOP_GET_CHAR, /* we want to call the get_char function */ 148 ENVOP_INIT, /* we want to call the init function */ 149 ENVOP_LOAD, /* we want to call the load function */ 150 ENVOP_SAVE, /* we want to call the save function */ 151 ENVOP_ERASE, /* we want to call the erase function */ 152 }; 153 154 struct env_driver { 155 const char *name; 156 enum env_location location; 157 158 /** 159 * load() - Load the environment from storage 160 * 161 * This method is required for loading environment 162 * 163 * @return 0 if OK, -ve on error 164 */ 165 int (*load)(void); 166 167 /** 168 * save() - Save the environment to storage 169 * 170 * This method is required for 'saveenv' to work. 171 * 172 * @return 0 if OK, -ve on error 173 */ 174 int (*save)(void); 175 176 /** 177 * erase() - Erase the environment on storage 178 * 179 * This method is optional and required for 'eraseenv' to work. 180 * 181 * @return 0 if OK, -ve on error 182 */ 183 int (*erase)(void); 184 185 /** 186 * init() - Set up the initial pre-relocation environment 187 * 188 * This method is optional. 189 * 190 * @return 0 if OK, -ENOENT if no initial environment could be found, 191 * other -ve on error 192 */ 193 int (*init)(void); 194 }; 195 196 /* Declare a new environment location driver */ 197 #define U_BOOT_ENV_LOCATION(__name) \ 198 ll_entry_declare(struct env_driver, __name, env_driver) 199 200 /* Declare the name of a location */ 201 #ifdef CONFIG_CMD_SAVEENV 202 #define ENV_NAME(_name) .name = _name, 203 #else 204 #define ENV_NAME(_name) 205 #endif 206 207 #ifdef CONFIG_CMD_SAVEENV 208 #define env_save_ptr(x) x 209 #else 210 #define env_save_ptr(x) NULL 211 #endif 212 213 #define ENV_SAVE_PTR(x) (CONFIG_IS_ENABLED(SAVEENV) ? (x) : NULL) 214 #define ENV_ERASE_PTR(x) (CONFIG_IS_ENABLED(CMD_ERASEENV) ? (x) : NULL) 215 216 extern struct hsearch_data env_htab; 217 218 /** 219 * env_ext4_get_intf() - Provide the interface for env in EXT4 220 * 221 * It is a weak function allowing board to overidde the default interface for 222 * U-Boot env in EXT4: CONFIG_ENV_EXT4_INTERFACE 223 * 224 * @return string of interface, empty if not supported 225 */ 226 const char *env_ext4_get_intf(void); 227 228 /** 229 * env_ext4_get_dev_part() - Provide the device and partition for env in EXT4 230 * 231 * It is a weak function allowing board to overidde the default device and 232 * partition used for U-Boot env in EXT4: CONFIG_ENV_EXT4_DEVICE_AND_PART 233 * 234 * @return string of device and partition 235 */ 236 const char *env_ext4_get_dev_part(void); 237 238 /** 239 * env_get_location()- Provide the best location for the U-Boot environment 240 * 241 * It is a weak function allowing board to overidde the environment location 242 * 243 * @op: operations performed on the environment 244 * @prio: priority between the multiple environments, 0 being the 245 * highest priority 246 * @return an enum env_location value on success, or -ve error code. 247 */ 248 enum env_location env_get_location(enum env_operation op, int prio); 249 #endif /* DO_DEPS_ONLY */ 250 251 #endif /* _ENV_INTERNAL_H_ */ 252