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 | * |
Wolfgang Denk | d79de1d | 2013-07-08 09:37:19 +0200 | [diff] [blame] | 5 | * SPDX-License-Identifier: GPL-2.0+ |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 6 | */ |
| 7 | |
| 8 | #ifndef _ENVIRONMENT_H_ |
Igor Grinberg | d766c51 | 2011-12-25 01:42:57 +0000 | [diff] [blame] | 9 | #define _ENVIRONMENT_H_ |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 10 | |
Maxime Ripard | d780cdc | 2017-02-27 18:22:03 +0100 | [diff] [blame] | 11 | #include <linux/kconfig.h> |
| 12 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 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 | * |
Robert P. J. Day | c5b1e5d | 2016-09-07 14:27:59 -0400 | [diff] [blame] | 21 | * The environment is preceded by a 32 bit CRC over the data part. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 22 | * |
Robert P. J. Day | c5b1e5d | 2016-09-07 14:27:59 -0400 | [diff] [blame] | 23 | *************************************************************************/ |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 24 | |
Jean-Christophe PLAGNIOL-VILLARD | 53db4cd | 2008-09-10 22:48:04 +0200 | [diff] [blame] | 25 | #if defined(CONFIG_ENV_IS_IN_FLASH) |
Igor Grinberg | 8954e63 | 2011-11-07 01:13:55 +0000 | [diff] [blame] | 26 | # ifndef CONFIG_ENV_ADDR |
| 27 | # define CONFIG_ENV_ADDR (CONFIG_SYS_FLASH_BASE + CONFIG_ENV_OFFSET) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 28 | # endif |
Igor Grinberg | 8954e63 | 2011-11-07 01:13:55 +0000 | [diff] [blame] | 29 | # ifndef CONFIG_ENV_OFFSET |
| 30 | # define CONFIG_ENV_OFFSET (CONFIG_ENV_ADDR - CONFIG_SYS_FLASH_BASE) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 31 | # endif |
Jean-Christophe PLAGNIOL-VILLARD | 7e1cda6 | 2008-09-10 22:48:06 +0200 | [diff] [blame] | 32 | # if !defined(CONFIG_ENV_ADDR_REDUND) && defined(CONFIG_ENV_OFFSET_REDUND) |
Igor Grinberg | 8954e63 | 2011-11-07 01:13:55 +0000 | [diff] [blame] | 33 | # define CONFIG_ENV_ADDR_REDUND \ |
| 34 | (CONFIG_SYS_FLASH_BASE + CONFIG_ENV_OFFSET_REDUND) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 35 | # endif |
Jean-Christophe PLAGNIOL-VILLARD | 7e1cda6 | 2008-09-10 22:48:06 +0200 | [diff] [blame] | 36 | # if defined(CONFIG_ENV_SECT_SIZE) || defined(CONFIG_ENV_SIZE) |
Igor Grinberg | 8954e63 | 2011-11-07 01:13:55 +0000 | [diff] [blame] | 37 | # ifndef CONFIG_ENV_SECT_SIZE |
| 38 | # define CONFIG_ENV_SECT_SIZE CONFIG_ENV_SIZE |
wdenk | d730fbc | 2003-03-06 14:23:06 +0000 | [diff] [blame] | 39 | # endif |
Igor Grinberg | 8954e63 | 2011-11-07 01:13:55 +0000 | [diff] [blame] | 40 | # ifndef CONFIG_ENV_SIZE |
| 41 | # define CONFIG_ENV_SIZE CONFIG_ENV_SECT_SIZE |
wdenk | d730fbc | 2003-03-06 14:23:06 +0000 | [diff] [blame] | 42 | # endif |
| 43 | # else |
Jean-Christophe PLAGNIOL-VILLARD | 7e1cda6 | 2008-09-10 22:48:06 +0200 | [diff] [blame] | 44 | # error "Both CONFIG_ENV_SECT_SIZE and CONFIG_ENV_SIZE undefined" |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 45 | # endif |
Jean-Christophe PLAGNIOL-VILLARD | 7e1cda6 | 2008-09-10 22:48:06 +0200 | [diff] [blame] | 46 | # if defined(CONFIG_ENV_ADDR_REDUND) && !defined(CONFIG_ENV_SIZE_REDUND) |
| 47 | # define CONFIG_ENV_SIZE_REDUND CONFIG_ENV_SIZE |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 48 | # endif |
Igor Grinberg | 8954e63 | 2011-11-07 01:13:55 +0000 | [diff] [blame] | 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) |
Igor Grinberg | d766c51 | 2011-12-25 01:42:57 +0000 | [diff] [blame] | 52 | # define ENV_IS_EMBEDDED |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 53 | # endif |
Jean-Christophe PLAGNIOL-VILLARD | 7e1cda6 | 2008-09-10 22:48:06 +0200 | [diff] [blame] | 54 | # if defined(CONFIG_ENV_ADDR_REDUND) || defined(CONFIG_ENV_OFFSET_REDUND) |
Igor Grinberg | d766c51 | 2011-12-25 01:42:57 +0000 | [diff] [blame] | 55 | # define CONFIG_SYS_REDUNDAND_ENVIRONMENT |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 56 | # endif |
Mike Frysinger | 9e800f4 | 2009-07-24 16:34:32 -0400 | [diff] [blame] | 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 |
Jean-Christophe PLAGNIOL-VILLARD | 53db4cd | 2008-09-10 22:48:04 +0200 | [diff] [blame] | 61 | #endif /* CONFIG_ENV_IS_IN_FLASH */ |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 62 | |
Bo Shen | 6c5ad5c | 2013-05-15 09:38:16 +0800 | [diff] [blame] | 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 | |
Jean-Christophe PLAGNIOL-VILLARD | dda84dd | 2008-09-10 22:47:58 +0200 | [diff] [blame] | 69 | #if defined(CONFIG_ENV_IS_IN_NAND) |
Ben Gardiner | 5fc8b7f | 2010-07-05 13:27:07 -0400 | [diff] [blame] | 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 */ |
Jean-Christophe PLAGNIOL-VILLARD | 7e1cda6 | 2008-09-10 22:48:06 +0200 | [diff] [blame] | 85 | # ifndef CONFIG_ENV_SIZE |
| 86 | # error "Need to define CONFIG_ENV_SIZE when using CONFIG_ENV_IS_IN_NAND" |
Markus Klotzbuecher | 5d113e0 | 2006-03-20 18:02:44 +0100 | [diff] [blame] | 87 | # endif |
Jean-Christophe PLAGNIOL-VILLARD | dda84dd | 2008-09-10 22:47:58 +0200 | [diff] [blame] | 88 | #endif /* CONFIG_ENV_IS_IN_NAND */ |
Markus Klotzbuecher | 5d113e0 | 2006-03-20 18:02:44 +0100 | [diff] [blame] | 89 | |
Joe Hershberger | 0c5faa8 | 2013-04-08 10:32:51 +0000 | [diff] [blame] | 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 |
Joe Hershberger | db14e86 | 2013-04-08 10:32:52 +0000 | [diff] [blame] | 97 | # if defined(CONFIG_ENV_UBI_VOLUME_REDUND) |
| 98 | # define CONFIG_SYS_REDUNDAND_ENVIRONMENT |
| 99 | # endif |
Joe Hershberger | 0c5faa8 | 2013-04-08 10:32:51 +0000 | [diff] [blame] | 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 | |
Mike Frysinger | 9e800f4 | 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 | 8954e63 | 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 | 9e800f4 | 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) |
Igor Grinberg | d766c51 | 2011-12-25 01:42:57 +0000 | [diff] [blame] | 123 | # define ENV_IS_EMBEDDED |
Mike Frysinger | 9e800f4 | 2009-07-24 16:34:32 -0400 | [diff] [blame] | 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 | 7728b74 | 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 | 9e800f4 | 2009-07-24 16:34:32 -0400 | [diff] [blame] | 132 | # endif |
| 133 | #endif |
| 134 | |
Mike Frysinger | 4ad8e9f | 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 | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 137 | #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT |
Mike Frysinger | a2c67e9 | 2008-03-31 11:02:01 -0400 | [diff] [blame] | 138 | # define ENV_HEADER_SIZE (sizeof(uint32_t) + 1) |
Wolfgang Denk | 89f5df9 | 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 | a2c67e9 | 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 | |
Marek Vasut | 486112d | 2014-03-05 19:59:51 +0100 | [diff] [blame] | 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 |
Jean-Christophe PLAGNIOL-VILLARD | 7e1cda6 | 2008-09-10 22:48:06 +0200 | [diff] [blame] | 150 | #define ENV_SIZE (CONFIG_ENV_SIZE - ENV_HEADER_SIZE) |
Marek Vasut | 486112d | 2014-03-05 19:59:51 +0100 | [diff] [blame] | 151 | #endif |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 152 | |
Igor Grinberg | 8954e63 | 2011-11-07 01:13:55 +0000 | [diff] [blame] | 153 | typedef struct environment_s { |
Mike Frysinger | a2c67e9 | 2008-03-31 11:02:01 -0400 | [diff] [blame] | 154 | uint32_t crc; /* CRC32 over data bytes */ |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 155 | #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 156 | unsigned char flags; /* active/obsolete flags */ |
| 157 | #endif |
| 158 | unsigned char data[ENV_SIZE]; /* Environment data */ |
Marek Vasut | 486112d | 2014-03-05 19:59:51 +0100 | [diff] [blame] | 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 | ; |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 165 | |
Igor Grinberg | 23b54b9 | 2011-11-17 06:07:23 +0000 | [diff] [blame] | 166 | #ifdef ENV_IS_EMBEDDED |
| 167 | extern env_t environment; |
| 168 | #endif /* ENV_IS_EMBEDDED */ |
| 169 | |
Igor Grinberg | 6d67c73 | 2011-11-07 01:13:57 +0000 | [diff] [blame] | 170 | extern const unsigned char default_environment[]; |
Igor Grinberg | 3e77359 | 2011-11-07 01:14:11 +0000 | [diff] [blame] | 171 | extern env_t *env_ptr; |
| 172 | |
Igor Grinberg | 3e77359 | 2011-11-07 01:14:11 +0000 | [diff] [blame] | 173 | #if defined(CONFIG_NEEDS_MANUAL_RELOC) |
| 174 | extern void env_reloc(void); |
| 175 | #endif |
Igor Grinberg | 6d67c73 | 2011-11-07 01:13:57 +0000 | [diff] [blame] | 176 | |
Dmitry Lifshitz | df90f8e | 2014-07-30 13:19:05 +0300 | [diff] [blame] | 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); |
Dmitry Lifshitz | 97d2fb9 | 2014-07-30 13:19:06 +0300 | [diff] [blame] | 181 | # ifdef CONFIG_SYS_MMC_ENV_PART |
| 182 | extern uint mmc_get_env_part(struct mmc *mmc); |
| 183 | # endif |
Dmitry Lifshitz | df90f8e | 2014-07-30 13:19:05 +0300 | [diff] [blame] | 184 | #endif |
| 185 | |
Mike Frysinger | 92d7a99 | 2010-12-08 06:26:04 -0500 | [diff] [blame] | 186 | #ifndef DO_DEPS_ONLY |
| 187 | |
Joe Hershberger | 60fd3ad | 2012-12-11 22:16:24 -0600 | [diff] [blame] | 188 | #include <env_attr.h> |
| 189 | #include <env_callback.h> |
Joe Hershberger | 71497d0 | 2012-12-11 22:16:31 -0600 | [diff] [blame] | 190 | #include <env_flags.h> |
Mike Frysinger | 92d7a99 | 2010-12-08 06:26:04 -0500 | [diff] [blame] | 191 | #include <search.h> |
| 192 | |
Simon Glass | 4bc2ad2 | 2017-08-03 12:21:56 -0600 | [diff] [blame] | 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 | |
Simon Glass | c10a88e | 2017-08-03 12:21:58 -0600 | [diff] [blame] | 200 | enum env_location { |
Simon Glass | c10a88e | 2017-08-03 12:21:58 -0600 | [diff] [blame] | 201 | ENVL_EEPROM, |
| 202 | ENVL_EXT4, |
| 203 | ENVL_FAT, |
| 204 | ENVL_FLASH, |
| 205 | ENVL_MMC, |
| 206 | ENVL_NAND, |
| 207 | ENVL_NVRAM, |
| 208 | ENVL_ONENAND, |
| 209 | ENVL_REMOTE, |
| 210 | ENVL_SPI_FLASH, |
| 211 | ENVL_UBI, |
| 212 | ENVL_NOWHERE, |
| 213 | |
| 214 | ENVL_COUNT, |
| 215 | ENVL_UNKNOWN, |
| 216 | }; |
| 217 | |
| 218 | struct env_driver { |
Simon Glass | d8273ed | 2017-08-03 12:22:03 -0600 | [diff] [blame] | 219 | const char *name; |
Simon Glass | c10a88e | 2017-08-03 12:21:58 -0600 | [diff] [blame] | 220 | enum env_location location; |
| 221 | |
| 222 | /** |
| 223 | * get_char() - Read a character from the environment |
| 224 | * |
| 225 | * This method is optional. If not provided, a default implementation |
| 226 | * will read from gd->env_addr. |
| 227 | * |
| 228 | * @index: Index of character to read (0=first) |
Simon Glass | 3fa4c22 | 2017-08-03 12:22:16 -0600 | [diff] [blame] | 229 | * @return character read, or -ve on error |
Simon Glass | c10a88e | 2017-08-03 12:21:58 -0600 | [diff] [blame] | 230 | */ |
Simon Glass | 3fa4c22 | 2017-08-03 12:22:16 -0600 | [diff] [blame] | 231 | int (*get_char)(int index); |
Simon Glass | c10a88e | 2017-08-03 12:21:58 -0600 | [diff] [blame] | 232 | |
| 233 | /** |
| 234 | * load() - Load the environment from storage |
| 235 | * |
| 236 | * This method is optional. If not provided, no environment will be |
| 237 | * loaded. |
Simon Glass | 9977849 | 2017-08-03 12:22:17 -0600 | [diff] [blame] | 238 | * |
| 239 | * @return 0 if OK, -ve on error |
Simon Glass | c10a88e | 2017-08-03 12:21:58 -0600 | [diff] [blame] | 240 | */ |
Simon Glass | 9977849 | 2017-08-03 12:22:17 -0600 | [diff] [blame] | 241 | int (*load)(void); |
Simon Glass | c10a88e | 2017-08-03 12:21:58 -0600 | [diff] [blame] | 242 | |
| 243 | /** |
| 244 | * save() - Save the environment to storage |
| 245 | * |
| 246 | * This method is required for 'saveenv' to work. |
| 247 | * |
| 248 | * @return 0 if OK, -ve on error |
| 249 | */ |
| 250 | int (*save)(void); |
| 251 | |
| 252 | /** |
| 253 | * init() - Set up the initial pre-relocation environment |
| 254 | * |
| 255 | * This method is optional. |
| 256 | * |
Simon Glass | d40d804 | 2017-08-03 12:22:02 -0600 | [diff] [blame] | 257 | * @return 0 if OK, -ENOENT if no initial environment could be found, |
| 258 | * other -ve on error |
Simon Glass | c10a88e | 2017-08-03 12:21:58 -0600 | [diff] [blame] | 259 | */ |
| 260 | int (*init)(void); |
| 261 | }; |
| 262 | |
| 263 | /* Declare a new environment location driver */ |
| 264 | #define U_BOOT_ENV_LOCATION(__name) \ |
| 265 | ll_entry_declare(struct env_driver, __name, env_driver) |
| 266 | |
Simon Glass | d8273ed | 2017-08-03 12:22:03 -0600 | [diff] [blame] | 267 | /* Declare the name of a location */ |
| 268 | #ifdef CONFIG_CMD_SAVEENV |
| 269 | #define ENV_NAME(_name) .name = _name, |
| 270 | #else |
| 271 | #define ENV_NAME(_name) |
| 272 | #endif |
| 273 | |
Simon Glass | c10a88e | 2017-08-03 12:21:58 -0600 | [diff] [blame] | 274 | #ifdef CONFIG_CMD_SAVEENV |
| 275 | #define env_save_ptr(x) x |
| 276 | #else |
| 277 | #define env_save_ptr(x) NULL |
| 278 | #endif |
| 279 | |
Mike Frysinger | 92d7a99 | 2010-12-08 06:26:04 -0500 | [diff] [blame] | 280 | extern struct hsearch_data env_htab; |
| 281 | |
Wolfgang Denk | 7a8b855 | 2008-05-14 12:22:49 +0200 | [diff] [blame] | 282 | /* Function that updates CRC of the enironment */ |
Igor Grinberg | 8954e63 | 2011-11-07 01:13:55 +0000 | [diff] [blame] | 283 | void env_crc_update(void); |
Wolfgang Denk | 7a8b855 | 2008-05-14 12:22:49 +0200 | [diff] [blame] | 284 | |
Joe Hershberger | 6fe26c9 | 2012-12-11 22:16:34 -0600 | [diff] [blame] | 285 | /* Look up the variable from the default environment */ |
Simon Glass | da1a134 | 2017-08-03 12:22:15 -0600 | [diff] [blame] | 286 | char *env_get_default(const char *name); |
Joe Hershberger | 6fe26c9 | 2012-12-11 22:16:34 -0600 | [diff] [blame] | 287 | |
Harald Welte | 72eb50a | 2008-07-07 15:40:39 +0800 | [diff] [blame] | 288 | /* [re]set to the default environment */ |
Wolfgang Denk | 460a9ff | 2010-06-20 23:33:59 +0200 | [diff] [blame] | 289 | void set_default_env(const char *s); |
| 290 | |
Gerlando Falauto | fe9f49d | 2012-08-24 00:11:41 +0000 | [diff] [blame] | 291 | /* [re]set individual variables to their value in the default environment */ |
| 292 | int set_default_vars(int nvars, char * const vars[]); |
| 293 | |
Wolfgang Denk | 460a9ff | 2010-06-20 23:33:59 +0200 | [diff] [blame] | 294 | /* Import from binary representation into hash table */ |
| 295 | int env_import(const char *buf, int check); |
Harald Welte | 72eb50a | 2008-07-07 15:40:39 +0800 | [diff] [blame] | 296 | |
Marek Vasut | d73c129 | 2014-03-05 19:59:50 +0100 | [diff] [blame] | 297 | /* Export from hash table into binary representation */ |
| 298 | int env_export(env_t *env_out); |
| 299 | |
Fiach Antaw | 57ea7f7 | 2017-01-25 18:53:11 +1000 | [diff] [blame] | 300 | #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT |
| 301 | /* Select and import one of two redundant environments */ |
| 302 | int env_import_redund(const char *buf1, const char *buf2); |
| 303 | #endif |
| 304 | |
Simon Glass | d8273ed | 2017-08-03 12:22:03 -0600 | [diff] [blame] | 305 | /** |
| 306 | * env_driver_lookup_default() - Look up the default environment driver |
| 307 | * |
| 308 | * @return pointer to driver, or NULL if none (which should not happen) |
| 309 | */ |
| 310 | struct env_driver *env_driver_lookup_default(void); |
| 311 | |
Simon Glass | 10b0d7b | 2017-08-03 12:22:06 -0600 | [diff] [blame] | 312 | /** |
| 313 | * env_get_char() - Get a character from the early environment |
| 314 | * |
| 315 | * This reads from the pre-relocation environemnt |
| 316 | * |
| 317 | * @index: Index of character to read (0 = first) |
| 318 | * @return character read, or -ve on error |
| 319 | */ |
| 320 | int env_get_char(int index); |
| 321 | |
Simon Glass | 1753957 | 2017-08-03 12:22:07 -0600 | [diff] [blame] | 322 | /** |
| 323 | * env_load() - Load the environment from storage |
| 324 | * |
| 325 | * @return 0 if OK, -ve on error |
| 326 | */ |
| 327 | int env_load(void); |
| 328 | |
Simon Glass | d49b889 | 2017-08-03 12:22:08 -0600 | [diff] [blame] | 329 | /** |
| 330 | * env_save() - Save the environment to storage |
| 331 | * |
| 332 | * @return 0 if OK, -ve on error |
| 333 | */ |
| 334 | int env_save(void); |
| 335 | |
Igor Grinberg | 8954e63 | 2011-11-07 01:13:55 +0000 | [diff] [blame] | 336 | #endif /* DO_DEPS_ONLY */ |
Mike Frysinger | 92d7a99 | 2010-12-08 06:26:04 -0500 | [diff] [blame] | 337 | |
Igor Grinberg | 8954e63 | 2011-11-07 01:13:55 +0000 | [diff] [blame] | 338 | #endif /* _ENVIRONMENT_H_ */ |