1 /* 2 * (C) Copyright 2002 3 * Wolfgang Denk, DENX Software Engineering, wd@denx.de. 4 * 5 * See file CREDITS for list of people who contributed to this 6 * project. 7 * 8 * This program is free software; you can redistribute it and/or 9 * modify it under the terms of the GNU General Public License as 10 * published by the Free Software Foundation; either version 2 of 11 * the License, or (at your option) any later version. 12 * 13 * This program is distributed in the hope that it will be useful, 14 * but WITHOUT ANY WARRANTY; without even the implied warranty of 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 * GNU General Public License for more details. 17 * 18 * You should have received a copy of the GNU General Public License 19 * along with this program; if not, write to the Free Software 20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, 21 * MA 02111-1307 USA 22 */ 23 24 #ifndef _ENVIRONMENT_H_ 25 #define _ENVIRONMENT_H_ 26 27 /************************************************************************** 28 * 29 * The "environment" is stored as a list of '\0' terminated 30 * "name=value" strings. The end of the list is marked by a double 31 * '\0'. New entries are always added at the end. Deleting an entry 32 * shifts the remaining entries to the front. Replacing an entry is a 33 * combination of deleting the old value and adding the new one. 34 * 35 * The environment is preceeded by a 32 bit CRC over the data part. 36 * 37 ************************************************************************** 38 */ 39 40 #if defined(CONFIG_ENV_IS_IN_FLASH) 41 # ifndef CONFIG_ENV_ADDR 42 # define CONFIG_ENV_ADDR (CONFIG_SYS_FLASH_BASE + CONFIG_ENV_OFFSET) 43 # endif 44 # ifndef CONFIG_ENV_OFFSET 45 # define CONFIG_ENV_OFFSET (CONFIG_ENV_ADDR - CONFIG_SYS_FLASH_BASE) 46 # endif 47 # if !defined(CONFIG_ENV_ADDR_REDUND) && defined(CONFIG_ENV_OFFSET_REDUND) 48 # define CONFIG_ENV_ADDR_REDUND \ 49 (CONFIG_SYS_FLASH_BASE + CONFIG_ENV_OFFSET_REDUND) 50 # endif 51 # if defined(CONFIG_ENV_SECT_SIZE) || defined(CONFIG_ENV_SIZE) 52 # ifndef CONFIG_ENV_SECT_SIZE 53 # define CONFIG_ENV_SECT_SIZE CONFIG_ENV_SIZE 54 # endif 55 # ifndef CONFIG_ENV_SIZE 56 # define CONFIG_ENV_SIZE CONFIG_ENV_SECT_SIZE 57 # endif 58 # else 59 # error "Both CONFIG_ENV_SECT_SIZE and CONFIG_ENV_SIZE undefined" 60 # endif 61 # if defined(CONFIG_ENV_ADDR_REDUND) && !defined(CONFIG_ENV_SIZE_REDUND) 62 # define CONFIG_ENV_SIZE_REDUND CONFIG_ENV_SIZE 63 # endif 64 # if (CONFIG_ENV_ADDR >= CONFIG_SYS_MONITOR_BASE) && \ 65 (CONFIG_ENV_ADDR + CONFIG_ENV_SIZE) <= \ 66 (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN) 67 # define ENV_IS_EMBEDDED 68 # endif 69 # if defined(CONFIG_ENV_ADDR_REDUND) || defined(CONFIG_ENV_OFFSET_REDUND) 70 # define CONFIG_SYS_REDUNDAND_ENVIRONMENT 71 # endif 72 # ifdef CONFIG_ENV_IS_EMBEDDED 73 # error "do not define CONFIG_ENV_IS_EMBEDDED in your board config" 74 # error "it is calculated automatically for you" 75 # endif 76 #endif /* CONFIG_ENV_IS_IN_FLASH */ 77 78 #if defined(CONFIG_ENV_IS_IN_MMC) 79 # ifdef CONFIG_ENV_OFFSET_REDUND 80 # define CONFIG_SYS_REDUNDAND_ENVIRONMENT 81 # endif 82 #endif 83 84 #if defined(CONFIG_ENV_IS_IN_NAND) 85 # if defined(CONFIG_ENV_OFFSET_OOB) 86 # ifdef CONFIG_ENV_OFFSET_REDUND 87 # error "CONFIG_ENV_OFFSET_REDUND is not supported when CONFIG_ENV_OFFSET_OOB" 88 # error "is set" 89 # endif 90 extern unsigned long nand_env_oob_offset; 91 # define CONFIG_ENV_OFFSET nand_env_oob_offset 92 # else 93 # ifndef CONFIG_ENV_OFFSET 94 # error "Need to define CONFIG_ENV_OFFSET when using CONFIG_ENV_IS_IN_NAND" 95 # endif 96 # ifdef CONFIG_ENV_OFFSET_REDUND 97 # define CONFIG_SYS_REDUNDAND_ENVIRONMENT 98 # endif 99 # endif /* CONFIG_ENV_OFFSET_OOB */ 100 # ifndef CONFIG_ENV_SIZE 101 # error "Need to define CONFIG_ENV_SIZE when using CONFIG_ENV_IS_IN_NAND" 102 # endif 103 #endif /* CONFIG_ENV_IS_IN_NAND */ 104 105 #if defined(CONFIG_ENV_IS_IN_UBI) 106 # ifndef CONFIG_ENV_UBI_PART 107 # error "Need to define CONFIG_ENV_UBI_PART when using CONFIG_ENV_IS_IN_UBI" 108 # endif 109 # ifndef CONFIG_ENV_UBI_VOLUME 110 # error "Need to define CONFIG_ENV_UBI_VOLUME when using CONFIG_ENV_IS_IN_UBI" 111 # endif 112 # if defined(CONFIG_ENV_UBI_VOLUME_REDUND) 113 # define CONFIG_SYS_REDUNDAND_ENVIRONMENT 114 # endif 115 # ifndef CONFIG_ENV_SIZE 116 # error "Need to define CONFIG_ENV_SIZE when using CONFIG_ENV_IS_IN_UBI" 117 # endif 118 # ifndef CONFIG_CMD_UBI 119 # error "Need to define CONFIG_CMD_UBI when using CONFIG_ENV_IS_IN_UBI" 120 # endif 121 #endif /* CONFIG_ENV_IS_IN_UBI */ 122 123 /* Embedded env is only supported for some flash types */ 124 #ifdef CONFIG_ENV_IS_EMBEDDED 125 # if !defined(CONFIG_ENV_IS_IN_FLASH) && \ 126 !defined(CONFIG_ENV_IS_IN_NAND) && \ 127 !defined(CONFIG_ENV_IS_IN_ONENAND) && \ 128 !defined(CONFIG_ENV_IS_IN_SPI_FLASH) 129 # error "CONFIG_ENV_IS_EMBEDDED not supported for your flash type" 130 # endif 131 #endif 132 133 /* 134 * For the flash types where embedded env is supported, but it cannot be 135 * calculated automatically (i.e. NAND), take the board opt-in. 136 */ 137 #if defined(CONFIG_ENV_IS_EMBEDDED) && !defined(ENV_IS_EMBEDDED) 138 # define ENV_IS_EMBEDDED 139 #endif 140 141 /* The build system likes to know if the env is embedded */ 142 #ifdef DO_DEPS_ONLY 143 # ifdef ENV_IS_EMBEDDED 144 # ifndef CONFIG_ENV_IS_EMBEDDED 145 # define CONFIG_ENV_IS_EMBEDDED 146 # endif 147 # endif 148 #endif 149 150 #include "compiler.h" 151 152 #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT 153 # define ENV_HEADER_SIZE (sizeof(uint32_t) + 1) 154 155 # define ACTIVE_FLAG 1 156 # define OBSOLETE_FLAG 0 157 #else 158 # define ENV_HEADER_SIZE (sizeof(uint32_t)) 159 #endif 160 161 #if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE) 162 extern char *env_name_spec; 163 #endif 164 165 #define ENV_SIZE (CONFIG_ENV_SIZE - ENV_HEADER_SIZE) 166 167 typedef struct environment_s { 168 uint32_t crc; /* CRC32 over data bytes */ 169 #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT 170 unsigned char flags; /* active/obsolete flags */ 171 #endif 172 unsigned char data[ENV_SIZE]; /* Environment data */ 173 } env_t; 174 175 #ifdef ENV_IS_EMBEDDED 176 extern env_t environment; 177 #endif /* ENV_IS_EMBEDDED */ 178 179 extern const unsigned char default_environment[]; 180 extern env_t *env_ptr; 181 182 extern void env_relocate_spec(void); 183 extern unsigned char env_get_char_spec(int); 184 185 #if defined(CONFIG_NEEDS_MANUAL_RELOC) 186 extern void env_reloc(void); 187 #endif 188 189 #ifndef DO_DEPS_ONLY 190 191 #include <env_attr.h> 192 #include <env_callback.h> 193 #include <env_flags.h> 194 #include <search.h> 195 196 extern struct hsearch_data env_htab; 197 198 /* Function that returns a character from the environment */ 199 unsigned char env_get_char(int); 200 201 /* Function that returns a pointer to a value from the environment */ 202 const unsigned char *env_get_addr(int); 203 unsigned char env_get_char_memory(int index); 204 205 /* Function that updates CRC of the enironment */ 206 void env_crc_update(void); 207 208 /* Look up the variable from the default environment */ 209 char *getenv_default(const char *name); 210 211 /* [re]set to the default environment */ 212 void set_default_env(const char *s); 213 214 /* [re]set individual variables to their value in the default environment */ 215 int set_default_vars(int nvars, char * const vars[]); 216 217 /* Import from binary representation into hash table */ 218 int env_import(const char *buf, int check); 219 220 #endif /* DO_DEPS_ONLY */ 221 222 #endif /* _ENVIRONMENT_H_ */ 223