wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 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_ 1 |
| 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 | |
Jean-Christophe PLAGNIOL-VILLARD | 5a1aceb | 2008-09-10 22:48:04 +0200 | [diff] [blame] | 40 | #if defined(CONFIG_ENV_IS_IN_FLASH) |
Igor Grinberg | 507651d | 2011-11-07 01:13:55 +0000 | [diff] [blame] | 41 | # ifndef CONFIG_ENV_ADDR |
| 42 | # define CONFIG_ENV_ADDR (CONFIG_SYS_FLASH_BASE + CONFIG_ENV_OFFSET) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 43 | # endif |
Igor Grinberg | 507651d | 2011-11-07 01:13:55 +0000 | [diff] [blame] | 44 | # ifndef CONFIG_ENV_OFFSET |
| 45 | # define CONFIG_ENV_OFFSET (CONFIG_ENV_ADDR - CONFIG_SYS_FLASH_BASE) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 46 | # endif |
Jean-Christophe PLAGNIOL-VILLARD | 0e8d158 | 2008-09-10 22:48:06 +0200 | [diff] [blame] | 47 | # if !defined(CONFIG_ENV_ADDR_REDUND) && defined(CONFIG_ENV_OFFSET_REDUND) |
Igor Grinberg | 507651d | 2011-11-07 01:13:55 +0000 | [diff] [blame] | 48 | # define CONFIG_ENV_ADDR_REDUND \ |
| 49 | (CONFIG_SYS_FLASH_BASE + CONFIG_ENV_OFFSET_REDUND) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 50 | # endif |
Jean-Christophe PLAGNIOL-VILLARD | 0e8d158 | 2008-09-10 22:48:06 +0200 | [diff] [blame] | 51 | # if defined(CONFIG_ENV_SECT_SIZE) || defined(CONFIG_ENV_SIZE) |
Igor Grinberg | 507651d | 2011-11-07 01:13:55 +0000 | [diff] [blame] | 52 | # ifndef CONFIG_ENV_SECT_SIZE |
| 53 | # define CONFIG_ENV_SECT_SIZE CONFIG_ENV_SIZE |
wdenk | 500545c | 2003-03-06 14:23:06 +0000 | [diff] [blame] | 54 | # endif |
Igor Grinberg | 507651d | 2011-11-07 01:13:55 +0000 | [diff] [blame] | 55 | # ifndef CONFIG_ENV_SIZE |
| 56 | # define CONFIG_ENV_SIZE CONFIG_ENV_SECT_SIZE |
wdenk | 500545c | 2003-03-06 14:23:06 +0000 | [diff] [blame] | 57 | # endif |
| 58 | # else |
Jean-Christophe PLAGNIOL-VILLARD | 0e8d158 | 2008-09-10 22:48:06 +0200 | [diff] [blame] | 59 | # error "Both CONFIG_ENV_SECT_SIZE and CONFIG_ENV_SIZE undefined" |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 60 | # endif |
Jean-Christophe PLAGNIOL-VILLARD | 0e8d158 | 2008-09-10 22:48:06 +0200 | [diff] [blame] | 61 | # if defined(CONFIG_ENV_ADDR_REDUND) && !defined(CONFIG_ENV_SIZE_REDUND) |
| 62 | # define CONFIG_ENV_SIZE_REDUND CONFIG_ENV_SIZE |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 63 | # endif |
Igor Grinberg | 507651d | 2011-11-07 01:13:55 +0000 | [diff] [blame] | 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) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 67 | # define ENV_IS_EMBEDDED 1 |
| 68 | # endif |
Jean-Christophe PLAGNIOL-VILLARD | 0e8d158 | 2008-09-10 22:48:06 +0200 | [diff] [blame] | 69 | # if defined(CONFIG_ENV_ADDR_REDUND) || defined(CONFIG_ENV_OFFSET_REDUND) |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 70 | # define CONFIG_SYS_REDUNDAND_ENVIRONMENT 1 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 71 | # endif |
Mike Frysinger | 0a9e4e7 | 2009-07-24 16:34:32 -0400 | [diff] [blame] | 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 |
Jean-Christophe PLAGNIOL-VILLARD | 5a1aceb | 2008-09-10 22:48:04 +0200 | [diff] [blame] | 76 | #endif /* CONFIG_ENV_IS_IN_FLASH */ |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 77 | |
Jean-Christophe PLAGNIOL-VILLARD | 51bfee1 | 2008-09-10 22:47:58 +0200 | [diff] [blame] | 78 | #if defined(CONFIG_ENV_IS_IN_NAND) |
Ben Gardiner | c9f7351 | 2010-07-05 13:27:07 -0400 | [diff] [blame] | 79 | # if defined(CONFIG_ENV_OFFSET_OOB) |
| 80 | # ifdef CONFIG_ENV_OFFSET_REDUND |
| 81 | # error "CONFIG_ENV_OFFSET_REDUND is not supported when CONFIG_ENV_OFFSET_OOB" |
| 82 | # error "is set" |
| 83 | # endif |
| 84 | extern unsigned long nand_env_oob_offset; |
| 85 | # define CONFIG_ENV_OFFSET nand_env_oob_offset |
| 86 | # else |
| 87 | # ifndef CONFIG_ENV_OFFSET |
| 88 | # error "Need to define CONFIG_ENV_OFFSET when using CONFIG_ENV_IS_IN_NAND" |
| 89 | # endif |
| 90 | # ifdef CONFIG_ENV_OFFSET_REDUND |
| 91 | # define CONFIG_SYS_REDUNDAND_ENVIRONMENT |
| 92 | # endif |
| 93 | # endif /* CONFIG_ENV_OFFSET_OOB */ |
Jean-Christophe PLAGNIOL-VILLARD | 0e8d158 | 2008-09-10 22:48:06 +0200 | [diff] [blame] | 94 | # ifndef CONFIG_ENV_SIZE |
| 95 | # error "Need to define CONFIG_ENV_SIZE when using CONFIG_ENV_IS_IN_NAND" |
Markus Klotzbuecher | e443c94 | 2006-03-20 18:02:44 +0100 | [diff] [blame] | 96 | # endif |
Jean-Christophe PLAGNIOL-VILLARD | 51bfee1 | 2008-09-10 22:47:58 +0200 | [diff] [blame] | 97 | #endif /* CONFIG_ENV_IS_IN_NAND */ |
Markus Klotzbuecher | e443c94 | 2006-03-20 18:02:44 +0100 | [diff] [blame] | 98 | |
unsik Kim | 75eb82e | 2009-02-25 11:31:24 +0900 | [diff] [blame] | 99 | #if defined(CONFIG_ENV_IS_IN_MG_DISK) |
| 100 | # ifndef CONFIG_ENV_ADDR |
| 101 | # error "Need to define CONFIG_ENV_ADDR when using CONFIG_ENV_IS_IN_MG_DISK" |
| 102 | # endif |
| 103 | # ifndef CONFIG_ENV_SIZE |
| 104 | # error "Need to define CONFIG_ENV_SIZE when using CONFIG_ENV_IS_IN_MG_DISK" |
| 105 | # endif |
unsik Kim | 75eb82e | 2009-02-25 11:31:24 +0900 | [diff] [blame] | 106 | #endif /* CONFIG_ENV_IS_IN_MG_DISK */ |
| 107 | |
Mike Frysinger | 0a9e4e7 | 2009-07-24 16:34:32 -0400 | [diff] [blame] | 108 | /* Embedded env is only supported for some flash types */ |
| 109 | #ifdef CONFIG_ENV_IS_EMBEDDED |
Igor Grinberg | 507651d | 2011-11-07 01:13:55 +0000 | [diff] [blame] | 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) |
Mike Frysinger | 0a9e4e7 | 2009-07-24 16:34:32 -0400 | [diff] [blame] | 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 1 |
| 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 |
Wolfgang Denk | 33a6b9e | 2011-07-30 14:01:08 +0000 | [diff] [blame] | 129 | # ifndef CONFIG_ENV_IS_EMBEDDED |
| 130 | # define CONFIG_ENV_IS_EMBEDDED |
| 131 | # endif |
Mike Frysinger | 0a9e4e7 | 2009-07-24 16:34:32 -0400 | [diff] [blame] | 132 | # endif |
| 133 | #endif |
| 134 | |
Mike Frysinger | 3756609 | 2009-07-02 19:23:25 -0400 | [diff] [blame] | 135 | #include "compiler.h" |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 136 | |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 137 | #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT |
Mike Frysinger | 89cdab7 | 2008-03-31 11:02:01 -0400 | [diff] [blame] | 138 | # define ENV_HEADER_SIZE (sizeof(uint32_t) + 1) |
Wolfgang Denk | b218ccb | 2010-06-22 15:44:16 +0200 | [diff] [blame] | 139 | |
| 140 | # define ACTIVE_FLAG 1 |
| 141 | # define OBSOLETE_FLAG 0 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 142 | #else |
Mike Frysinger | 89cdab7 | 2008-03-31 11:02:01 -0400 | [diff] [blame] | 143 | # define ENV_HEADER_SIZE (sizeof(uint32_t)) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 144 | #endif |
| 145 | |
Igor Grinberg | d09b178 | 2011-11-07 01:13:59 +0000 | [diff] [blame] | 146 | #if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE) |
| 147 | extern char *env_name_spec; |
| 148 | #endif |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 149 | |
Jean-Christophe PLAGNIOL-VILLARD | 0e8d158 | 2008-09-10 22:48:06 +0200 | [diff] [blame] | 150 | #define ENV_SIZE (CONFIG_ENV_SIZE - ENV_HEADER_SIZE) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 151 | |
Igor Grinberg | 507651d | 2011-11-07 01:13:55 +0000 | [diff] [blame] | 152 | typedef struct environment_s { |
Mike Frysinger | 89cdab7 | 2008-03-31 11:02:01 -0400 | [diff] [blame] | 153 | uint32_t crc; /* CRC32 over data bytes */ |
Jean-Christophe PLAGNIOL-VILLARD | 6d0f6bc | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 154 | #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 155 | unsigned char flags; /* active/obsolete flags */ |
| 156 | #endif |
| 157 | unsigned char data[ENV_SIZE]; /* Environment data */ |
| 158 | } env_t; |
| 159 | |
Igor Grinberg | 994bc67 | 2011-11-17 06:07:23 +0000 | [diff] [blame] | 160 | #ifdef ENV_IS_EMBEDDED |
| 161 | extern env_t environment; |
| 162 | #endif /* ENV_IS_EMBEDDED */ |
| 163 | |
Igor Grinberg | d1459f0 | 2011-11-07 01:13:57 +0000 | [diff] [blame] | 164 | extern const unsigned char default_environment[]; |
| 165 | |
Mike Frysinger | 2eb1573 | 2010-12-08 06:26:04 -0500 | [diff] [blame] | 166 | #ifndef DO_DEPS_ONLY |
| 167 | |
| 168 | #include <search.h> |
| 169 | |
| 170 | extern struct hsearch_data env_htab; |
| 171 | |
Joakim Tjernlund | b502611 | 2008-07-06 12:30:09 +0200 | [diff] [blame] | 172 | /* Function that returns a character from the environment */ |
Igor Grinberg | 507651d | 2011-11-07 01:13:55 +0000 | [diff] [blame] | 173 | unsigned char env_get_char(int); |
Wolfgang Denk | a8409f4 | 2008-05-14 12:22:49 +0200 | [diff] [blame] | 174 | |
| 175 | /* Function that returns a pointer to a value from the environment */ |
Mike Frysinger | 147c716 | 2011-04-23 23:43:21 +0000 | [diff] [blame] | 176 | const unsigned char *env_get_addr(int); |
Igor Grinberg | 507651d | 2011-11-07 01:13:55 +0000 | [diff] [blame] | 177 | unsigned char env_get_char_memory(int index); |
Wolfgang Denk | a8409f4 | 2008-05-14 12:22:49 +0200 | [diff] [blame] | 178 | |
| 179 | /* Function that updates CRC of the enironment */ |
Igor Grinberg | 507651d | 2011-11-07 01:13:55 +0000 | [diff] [blame] | 180 | void env_crc_update(void); |
Wolfgang Denk | a8409f4 | 2008-05-14 12:22:49 +0200 | [diff] [blame] | 181 | |
Harald Welte | 5bb12db | 2008-07-07 15:40:39 +0800 | [diff] [blame] | 182 | /* [re]set to the default environment */ |
Wolfgang Denk | ea882ba | 2010-06-20 23:33:59 +0200 | [diff] [blame] | 183 | void set_default_env(const char *s); |
| 184 | |
| 185 | /* Import from binary representation into hash table */ |
| 186 | int env_import(const char *buf, int check); |
Harald Welte | 5bb12db | 2008-07-07 15:40:39 +0800 | [diff] [blame] | 187 | |
Igor Grinberg | 507651d | 2011-11-07 01:13:55 +0000 | [diff] [blame] | 188 | #endif /* DO_DEPS_ONLY */ |
Mike Frysinger | 2eb1573 | 2010-12-08 06:26:04 -0500 | [diff] [blame] | 189 | |
Igor Grinberg | 507651d | 2011-11-07 01:13:55 +0000 | [diff] [blame] | 190 | #endif /* _ENVIRONMENT_H_ */ |