Tom Rini | 10e4779 | 2018-05-06 17:58:06 -0400 | [diff] [blame] | 1 | /* SPDX-License-Identifier: GPL-2.0+ */ |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 2 | /* |
Simon Glass | 9d1f619 | 2019-08-02 09:44:25 -0600 | [diff] [blame] | 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 | * |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 11 | * (C) Copyright 2002 |
| 12 | * Wolfgang Denk, DENX Software Engineering, wd@denx.de. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 13 | */ |
| 14 | |
Simon Glass | 9d1f619 | 2019-08-02 09:44:25 -0600 | [diff] [blame] | 15 | #ifndef _ENV_INTERNAL_H_ |
| 16 | #define _ENV_INTERNAL_H_ |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 17 | |
Maxime Ripard | d780cdc | 2017-02-27 18:22:03 +0100 | [diff] [blame] | 18 | #include <linux/kconfig.h> |
| 19 | |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 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 | * |
Robert P. J. Day | c5b1e5d | 2016-09-07 14:27:59 -0400 | [diff] [blame] | 28 | * The environment is preceded by a 32 bit CRC over the data part. |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 29 | * |
Robert P. J. Day | c5b1e5d | 2016-09-07 14:27:59 -0400 | [diff] [blame] | 30 | *************************************************************************/ |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 31 | |
Jean-Christophe PLAGNIOL-VILLARD | 53db4cd | 2008-09-10 22:48:04 +0200 | [diff] [blame] | 32 | #if defined(CONFIG_ENV_IS_IN_FLASH) |
Tom Rini | f4bdf1b | 2019-11-18 20:02:07 -0500 | [diff] [blame] | 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 |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 38 | # endif |
Igor Grinberg | 8954e63 | 2011-11-07 01:13:55 +0000 | [diff] [blame] | 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) |
Igor Grinberg | d766c51 | 2011-12-25 01:42:57 +0000 | [diff] [blame] | 42 | # define ENV_IS_EMBEDDED |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 43 | # endif |
Jean-Christophe PLAGNIOL-VILLARD | 53db4cd | 2008-09-10 22:48:04 +0200 | [diff] [blame] | 44 | #endif /* CONFIG_ENV_IS_IN_FLASH */ |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 45 | |
Jean-Christophe PLAGNIOL-VILLARD | dda84dd | 2008-09-10 22:47:58 +0200 | [diff] [blame] | 46 | #if defined(CONFIG_ENV_IS_IN_NAND) |
Ben Gardiner | 5fc8b7f | 2010-07-05 13:27:07 -0400 | [diff] [blame] | 47 | # if defined(CONFIG_ENV_OFFSET_OOB) |
| 48 | # ifdef CONFIG_ENV_OFFSET_REDUND |
| 49 | # error "CONFIG_ENV_OFFSET_REDUND is not supported when CONFIG_ENV_OFFSET_OOB" |
| 50 | # error "is set" |
| 51 | # endif |
| 52 | extern unsigned long nand_env_oob_offset; |
Ben Gardiner | 5fc8b7f | 2010-07-05 13:27:07 -0400 | [diff] [blame] | 53 | # endif /* CONFIG_ENV_OFFSET_OOB */ |
Jean-Christophe PLAGNIOL-VILLARD | dda84dd | 2008-09-10 22:47:58 +0200 | [diff] [blame] | 54 | #endif /* CONFIG_ENV_IS_IN_NAND */ |
Markus Klotzbuecher | 5d113e0 | 2006-03-20 18:02:44 +0100 | [diff] [blame] | 55 | |
Mike Frysinger | 4ad8e9f | 2009-07-02 19:23:25 -0400 | [diff] [blame] | 56 | #include "compiler.h" |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 57 | |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 58 | #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT |
Mike Frysinger | a2c67e9 | 2008-03-31 11:02:01 -0400 | [diff] [blame] | 59 | # define ENV_HEADER_SIZE (sizeof(uint32_t) + 1) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 60 | #else |
Mike Frysinger | a2c67e9 | 2008-03-31 11:02:01 -0400 | [diff] [blame] | 61 | # define ENV_HEADER_SIZE (sizeof(uint32_t)) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 62 | #endif |
| 63 | |
Jean-Christophe PLAGNIOL-VILLARD | 7e1cda6 | 2008-09-10 22:48:06 +0200 | [diff] [blame] | 64 | #define ENV_SIZE (CONFIG_ENV_SIZE - ENV_HEADER_SIZE) |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 65 | |
Simon Glass | 48d3ebc | 2019-08-01 09:47:11 -0600 | [diff] [blame] | 66 | /* |
| 67 | * If the environment is in RAM, allocate extra space for it in the malloc |
| 68 | * region. |
| 69 | */ |
Tom Rini | 4714ab2 | 2022-12-02 16:42:17 -0500 | [diff] [blame] | 70 | #if defined(ENV_IS_EMBEDDED) |
Simon Glass | 48d3ebc | 2019-08-01 09:47:11 -0600 | [diff] [blame] | 71 | #define TOTAL_MALLOC_LEN CONFIG_SYS_MALLOC_LEN |
| 72 | #elif (CONFIG_ENV_ADDR + CONFIG_ENV_SIZE < CONFIG_SYS_MONITOR_BASE) || \ |
| 73 | (CONFIG_ENV_ADDR >= CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN) || \ |
| 74 | defined(CONFIG_ENV_IS_IN_NVRAM) |
| 75 | #define TOTAL_MALLOC_LEN (CONFIG_SYS_MALLOC_LEN + CONFIG_ENV_SIZE) |
| 76 | #else |
| 77 | #define TOTAL_MALLOC_LEN CONFIG_SYS_MALLOC_LEN |
| 78 | #endif |
| 79 | |
Igor Grinberg | 8954e63 | 2011-11-07 01:13:55 +0000 | [diff] [blame] | 80 | typedef struct environment_s { |
Mike Frysinger | a2c67e9 | 2008-03-31 11:02:01 -0400 | [diff] [blame] | 81 | uint32_t crc; /* CRC32 over data bytes */ |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 82 | #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT |
Simon Glass | 4686d8f | 2019-08-01 09:47:08 -0600 | [diff] [blame] | 83 | unsigned char flags; /* active/obsolete flags ENVF_REDUND_ */ |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 84 | #endif |
| 85 | unsigned char data[ENV_SIZE]; /* Environment data */ |
Tom Rini | 6b6ee8a | 2017-11-14 08:39:35 -0500 | [diff] [blame] | 86 | } env_t; |
wdenk | c609719 | 2002-11-03 00:24:07 +0000 | [diff] [blame] | 87 | |
Igor Grinberg | 23b54b9 | 2011-11-17 06:07:23 +0000 | [diff] [blame] | 88 | #ifdef ENV_IS_EMBEDDED |
Simon Glass | 204eb22 | 2019-08-01 09:47:03 -0600 | [diff] [blame] | 89 | extern env_t embedded_environment; |
Igor Grinberg | 23b54b9 | 2011-11-17 06:07:23 +0000 | [diff] [blame] | 90 | #endif /* ENV_IS_EMBEDDED */ |
| 91 | |
Algapally Santosh Sagar | 0ed240e | 2023-09-21 16:50:42 +0530 | [diff] [blame] | 92 | #ifdef CONFIG_DEFAULT_ENV_IS_RW |
Marek Behún | 73d2534 | 2021-10-22 15:47:24 +0200 | [diff] [blame] | 93 | extern char default_environment[]; |
Pali Rohár | 3c72b1b | 2020-12-23 12:21:28 +0100 | [diff] [blame] | 94 | #else |
Marek Behún | 73d2534 | 2021-10-22 15:47:24 +0200 | [diff] [blame] | 95 | extern const char default_environment[]; |
Pali Rohár | 3c72b1b | 2020-12-23 12:21:28 +0100 | [diff] [blame] | 96 | #endif |
Igor Grinberg | 3e77359 | 2011-11-07 01:14:11 +0000 | [diff] [blame] | 97 | |
Mike Frysinger | 92d7a99 | 2010-12-08 06:26:04 -0500 | [diff] [blame] | 98 | #ifndef DO_DEPS_ONLY |
| 99 | |
Joe Hershberger | 60fd3ad | 2012-12-11 22:16:24 -0600 | [diff] [blame] | 100 | #include <env_attr.h> |
| 101 | #include <env_callback.h> |
Joe Hershberger | 71497d0 | 2012-12-11 22:16:31 -0600 | [diff] [blame] | 102 | #include <env_flags.h> |
Mike Frysinger | 92d7a99 | 2010-12-08 06:26:04 -0500 | [diff] [blame] | 103 | #include <search.h> |
| 104 | |
Simon Glass | c10a88e | 2017-08-03 12:21:58 -0600 | [diff] [blame] | 105 | enum env_location { |
York Sun | 470947d | 2018-02-07 14:17:11 -0800 | [diff] [blame] | 106 | ENVL_UNKNOWN, |
Simon Glass | c10a88e | 2017-08-03 12:21:58 -0600 | [diff] [blame] | 107 | ENVL_EEPROM, |
| 108 | ENVL_EXT4, |
| 109 | ENVL_FAT, |
| 110 | ENVL_FLASH, |
| 111 | ENVL_MMC, |
| 112 | ENVL_NAND, |
| 113 | ENVL_NVRAM, |
| 114 | ENVL_ONENAND, |
| 115 | ENVL_REMOTE, |
| 116 | ENVL_SPI_FLASH, |
| 117 | ENVL_UBI, |
| 118 | ENVL_NOWHERE, |
| 119 | |
| 120 | ENVL_COUNT, |
Simon Glass | c10a88e | 2017-08-03 12:21:58 -0600 | [diff] [blame] | 121 | }; |
| 122 | |
Maxime Ripard | fd3158e | 2018-01-23 21:16:52 +0100 | [diff] [blame] | 123 | /* value for the various operations we want to perform on the env */ |
| 124 | enum env_operation { |
| 125 | ENVOP_GET_CHAR, /* we want to call the get_char function */ |
| 126 | ENVOP_INIT, /* we want to call the init function */ |
| 127 | ENVOP_LOAD, /* we want to call the load function */ |
| 128 | ENVOP_SAVE, /* we want to call the save function */ |
Frank Wunderlich | 33afa93 | 2019-06-29 11:36:19 +0200 | [diff] [blame] | 129 | ENVOP_ERASE, /* we want to call the erase function */ |
Maxime Ripard | fd3158e | 2018-01-23 21:16:52 +0100 | [diff] [blame] | 130 | }; |
| 131 | |
Simon Glass | c10a88e | 2017-08-03 12:21:58 -0600 | [diff] [blame] | 132 | struct env_driver { |
Simon Glass | d8273ed | 2017-08-03 12:22:03 -0600 | [diff] [blame] | 133 | const char *name; |
Simon Glass | c10a88e | 2017-08-03 12:21:58 -0600 | [diff] [blame] | 134 | enum env_location location; |
| 135 | |
| 136 | /** |
Simon Glass | c10a88e | 2017-08-03 12:21:58 -0600 | [diff] [blame] | 137 | * load() - Load the environment from storage |
| 138 | * |
Patrick Delaunay | eebd74d | 2020-07-28 11:51:19 +0200 | [diff] [blame] | 139 | * This method is required for loading environment |
Simon Glass | 9977849 | 2017-08-03 12:22:17 -0600 | [diff] [blame] | 140 | * |
| 141 | * @return 0 if OK, -ve on error |
Simon Glass | c10a88e | 2017-08-03 12:21:58 -0600 | [diff] [blame] | 142 | */ |
Simon Glass | 9977849 | 2017-08-03 12:22:17 -0600 | [diff] [blame] | 143 | int (*load)(void); |
Simon Glass | c10a88e | 2017-08-03 12:21:58 -0600 | [diff] [blame] | 144 | |
| 145 | /** |
| 146 | * save() - Save the environment to storage |
| 147 | * |
| 148 | * This method is required for 'saveenv' to work. |
| 149 | * |
| 150 | * @return 0 if OK, -ve on error |
| 151 | */ |
| 152 | int (*save)(void); |
| 153 | |
| 154 | /** |
Frank Wunderlich | 33afa93 | 2019-06-29 11:36:19 +0200 | [diff] [blame] | 155 | * erase() - Erase the environment on storage |
| 156 | * |
| 157 | * This method is optional and required for 'eraseenv' to work. |
| 158 | * |
| 159 | * @return 0 if OK, -ve on error |
| 160 | */ |
| 161 | int (*erase)(void); |
| 162 | |
| 163 | /** |
Simon Glass | c10a88e | 2017-08-03 12:21:58 -0600 | [diff] [blame] | 164 | * init() - Set up the initial pre-relocation environment |
| 165 | * |
| 166 | * This method is optional. |
| 167 | * |
Simon Glass | d40d804 | 2017-08-03 12:22:02 -0600 | [diff] [blame] | 168 | * @return 0 if OK, -ENOENT if no initial environment could be found, |
| 169 | * other -ve on error |
Simon Glass | c10a88e | 2017-08-03 12:21:58 -0600 | [diff] [blame] | 170 | */ |
| 171 | int (*init)(void); |
| 172 | }; |
| 173 | |
| 174 | /* Declare a new environment location driver */ |
| 175 | #define U_BOOT_ENV_LOCATION(__name) \ |
| 176 | ll_entry_declare(struct env_driver, __name, env_driver) |
| 177 | |
Simon Glass | d8273ed | 2017-08-03 12:22:03 -0600 | [diff] [blame] | 178 | /* Declare the name of a location */ |
| 179 | #ifdef CONFIG_CMD_SAVEENV |
| 180 | #define ENV_NAME(_name) .name = _name, |
| 181 | #else |
| 182 | #define ENV_NAME(_name) |
| 183 | #endif |
| 184 | |
Simon Glass | c10a88e | 2017-08-03 12:21:58 -0600 | [diff] [blame] | 185 | #ifdef CONFIG_CMD_SAVEENV |
| 186 | #define env_save_ptr(x) x |
| 187 | #else |
| 188 | #define env_save_ptr(x) NULL |
| 189 | #endif |
| 190 | |
Rasmus Villemoes | 2c9e0a7 | 2020-02-19 09:47:40 +0000 | [diff] [blame] | 191 | #define ENV_SAVE_PTR(x) (CONFIG_IS_ENABLED(SAVEENV) ? (x) : NULL) |
Simon Glass | 3cc00c4 | 2023-02-05 15:36:29 -0700 | [diff] [blame] | 192 | #define ENV_ERASE_PTR(x) (IS_ENABLED(CONFIG_CMD_ERASEENV) ? (x) : NULL) |
Rasmus Villemoes | 2c9e0a7 | 2020-02-19 09:47:40 +0000 | [diff] [blame] | 193 | |
Mike Frysinger | 92d7a99 | 2010-12-08 06:26:04 -0500 | [diff] [blame] | 194 | extern struct hsearch_data env_htab; |
| 195 | |
Patrick Delaunay | c149a3b | 2020-06-19 14:03:35 +0200 | [diff] [blame] | 196 | /** |
Patrick Delaunay | 0f4f5db | 2020-06-15 16:52:17 +0200 | [diff] [blame] | 197 | * env_ext4_get_intf() - Provide the interface for env in EXT4 |
| 198 | * |
| 199 | * It is a weak function allowing board to overidde the default interface for |
| 200 | * U-Boot env in EXT4: CONFIG_ENV_EXT4_INTERFACE |
| 201 | * |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 202 | * Return: string of interface, empty if not supported |
Patrick Delaunay | 0f4f5db | 2020-06-15 16:52:17 +0200 | [diff] [blame] | 203 | */ |
| 204 | const char *env_ext4_get_intf(void); |
| 205 | |
| 206 | /** |
| 207 | * env_ext4_get_dev_part() - Provide the device and partition for env in EXT4 |
| 208 | * |
| 209 | * It is a weak function allowing board to overidde the default device and |
| 210 | * partition used for U-Boot env in EXT4: CONFIG_ENV_EXT4_DEVICE_AND_PART |
| 211 | * |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 212 | * Return: string of device and partition |
Patrick Delaunay | 0f4f5db | 2020-06-15 16:52:17 +0200 | [diff] [blame] | 213 | */ |
| 214 | const char *env_ext4_get_dev_part(void); |
| 215 | |
| 216 | /** |
Marek Vasut | f92cf58 | 2022-04-06 02:21:32 +0200 | [diff] [blame] | 217 | * arch_env_get_location()- Provide the best location for the U-Boot environment |
| 218 | * |
| 219 | * It is a weak function allowing board to overidde the environment location |
| 220 | * on architecture level. This has lower priority than env_get_location(), |
| 221 | * which can be defined on board level. |
| 222 | * |
| 223 | * @op: operations performed on the environment |
| 224 | * @prio: priority between the multiple environments, 0 being the |
| 225 | * highest priority |
| 226 | * Return: an enum env_location value on success, or -ve error code. |
| 227 | */ |
| 228 | enum env_location arch_env_get_location(enum env_operation op, int prio); |
| 229 | |
| 230 | /** |
Patrick Delaunay | c149a3b | 2020-06-19 14:03:35 +0200 | [diff] [blame] | 231 | * env_get_location()- Provide the best location for the U-Boot environment |
| 232 | * |
| 233 | * It is a weak function allowing board to overidde the environment location |
Marek Vasut | f92cf58 | 2022-04-06 02:21:32 +0200 | [diff] [blame] | 234 | * on board level. This has higher priority than arch_env_get_location(), |
| 235 | * which can be defined on architecture level. |
Patrick Delaunay | c149a3b | 2020-06-19 14:03:35 +0200 | [diff] [blame] | 236 | * |
| 237 | * @op: operations performed on the environment |
| 238 | * @prio: priority between the multiple environments, 0 being the |
| 239 | * highest priority |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 240 | * Return: an enum env_location value on success, or -ve error code. |
Patrick Delaunay | c149a3b | 2020-06-19 14:03:35 +0200 | [diff] [blame] | 241 | */ |
| 242 | enum env_location env_get_location(enum env_operation op, int prio); |
He Yong | 25936aa | 2022-02-18 00:07:25 +0800 | [diff] [blame] | 243 | |
| 244 | /** |
| 245 | * env_fat_get_intf() - Provide the interface for env in FAT |
| 246 | * |
| 247 | * It is a weak function allowing board to overidde the default interface for |
| 248 | * U-Boot env in FAT: CONFIG_ENV_FAT_INTERFACE |
| 249 | * |
| 250 | * Return: string of interface, empty if not supported |
| 251 | */ |
| 252 | const char *env_fat_get_intf(void); |
| 253 | |
| 254 | /** |
| 255 | * env_fat_get_dev_part() - Provide the device and partition for env in FAT |
| 256 | * |
| 257 | * It is a weak function allowing board to overidde the default device and |
| 258 | * partition used for U-Boot env in FAT: CONFIG_ENV_FAT_DEVICE_AND_PART |
| 259 | * |
| 260 | * Return: string of device and partition |
| 261 | */ |
| 262 | char *env_fat_get_dev_part(void); |
Igor Grinberg | 8954e63 | 2011-11-07 01:13:55 +0000 | [diff] [blame] | 263 | #endif /* DO_DEPS_ONLY */ |
Mike Frysinger | 92d7a99 | 2010-12-08 06:26:04 -0500 | [diff] [blame] | 264 | |
Simon Glass | 9d1f619 | 2019-08-02 09:44:25 -0600 | [diff] [blame] | 265 | #endif /* _ENV_INTERNAL_H_ */ |