]>
Commit | Line | Data |
---|---|---|
83d290c5 | 1 | /* SPDX-License-Identifier: GPL-2.0+ */ |
c609719b | 2 | /* |
f3998fdc SG |
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 | * | |
c609719b WD |
11 | * (C) Copyright 2002 |
12 | * Wolfgang Denk, DENX Software Engineering, wd@denx.de. | |
c609719b WD |
13 | */ |
14 | ||
f3998fdc SG |
15 | #ifndef _ENV_INTERNAL_H_ |
16 | #define _ENV_INTERNAL_H_ | |
c609719b | 17 | |
fb1c43cc MR |
18 | #include <linux/kconfig.h> |
19 | ||
c609719b WD |
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 | * | |
fc0b5948 | 28 | * The environment is preceded by a 32 bit CRC over the data part. |
c609719b | 29 | * |
fc0b5948 | 30 | *************************************************************************/ |
c609719b | 31 | |
5a1aceb0 | 32 | #if defined(CONFIG_ENV_IS_IN_FLASH) |
a8992e78 TR |
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 | |
c609719b | 38 | # endif |
507651d6 IG |
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) | |
6f403bad | 42 | # define ENV_IS_EMBEDDED |
c609719b | 43 | # endif |
0a9e4e77 MF |
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 | |
5a1aceb0 | 48 | #endif /* CONFIG_ENV_IS_IN_FLASH */ |
c609719b | 49 | |
51bfee19 | 50 | #if defined(CONFIG_ENV_IS_IN_NAND) |
c9f7351b BG |
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 | |
c9f7351b | 58 | # endif /* CONFIG_ENV_OFFSET_OOB */ |
51bfee19 | 59 | #endif /* CONFIG_ENV_IS_IN_NAND */ |
e443c944 | 60 | |
0a9e4e77 MF |
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) | |
6f403bad | 66 | # define ENV_IS_EMBEDDED |
0a9e4e77 MF |
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 | |
33a6b9e9 WD |
72 | # ifndef CONFIG_ENV_IS_EMBEDDED |
73 | # define CONFIG_ENV_IS_EMBEDDED | |
74 | # endif | |
0a9e4e77 MF |
75 | # endif |
76 | #endif | |
77 | ||
37566090 | 78 | #include "compiler.h" |
c609719b | 79 | |
6d0f6bcf | 80 | #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT |
89cdab78 | 81 | # define ENV_HEADER_SIZE (sizeof(uint32_t) + 1) |
c609719b | 82 | #else |
89cdab78 | 83 | # define ENV_HEADER_SIZE (sizeof(uint32_t)) |
c609719b WD |
84 | #endif |
85 | ||
0e8d1586 | 86 | #define ENV_SIZE (CONFIG_ENV_SIZE - ENV_HEADER_SIZE) |
c609719b | 87 | |
f030b7b2 SG |
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 | ||
507651d6 | 102 | typedef struct environment_s { |
89cdab78 | 103 | uint32_t crc; /* CRC32 over data bytes */ |
6d0f6bcf | 104 | #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT |
d3716dd6 | 105 | unsigned char flags; /* active/obsolete flags ENVF_REDUND_ */ |
c609719b WD |
106 | #endif |
107 | unsigned char data[ENV_SIZE]; /* Environment data */ | |
c6831c74 | 108 | } env_t; |
c609719b | 109 | |
994bc671 | 110 | #ifdef ENV_IS_EMBEDDED |
be54ec16 | 111 | extern env_t embedded_environment; |
994bc671 IG |
112 | #endif /* ENV_IS_EMBEDDED */ |
113 | ||
d1459f0f | 114 | extern const unsigned char default_environment[]; |
27aafe98 | 115 | |
2eb1573f MF |
116 | #ifndef DO_DEPS_ONLY |
117 | ||
170ab110 JH |
118 | #include <env_attr.h> |
119 | #include <env_callback.h> | |
2598090b | 120 | #include <env_flags.h> |
2eb1573f MF |
121 | #include <search.h> |
122 | ||
4415f1d1 | 123 | enum env_location { |
e1caa584 | 124 | ENVL_UNKNOWN, |
4415f1d1 SG |
125 | ENVL_EEPROM, |
126 | ENVL_EXT4, | |
127 | ENVL_FAT, | |
128 | ENVL_FLASH, | |
129 | ENVL_MMC, | |
130 | ENVL_NAND, | |
131 | ENVL_NVRAM, | |
132 | ENVL_ONENAND, | |
133 | ENVL_REMOTE, | |
134 | ENVL_SPI_FLASH, | |
135 | ENVL_UBI, | |
136 | ENVL_NOWHERE, | |
137 | ||
138 | ENVL_COUNT, | |
4415f1d1 SG |
139 | }; |
140 | ||
8a3a7e22 MR |
141 | /* value for the various operations we want to perform on the env */ |
142 | enum env_operation { | |
143 | ENVOP_GET_CHAR, /* we want to call the get_char function */ | |
144 | ENVOP_INIT, /* we want to call the init function */ | |
145 | ENVOP_LOAD, /* we want to call the load function */ | |
146 | ENVOP_SAVE, /* we want to call the save function */ | |
cd121bdb | 147 | ENVOP_ERASE, /* we want to call the erase function */ |
8a3a7e22 MR |
148 | }; |
149 | ||
4415f1d1 | 150 | struct env_driver { |
ac358beb | 151 | const char *name; |
4415f1d1 SG |
152 | enum env_location location; |
153 | ||
4415f1d1 SG |
154 | /** |
155 | * load() - Load the environment from storage | |
156 | * | |
157 | * This method is optional. If not provided, no environment will be | |
158 | * loaded. | |
c5951991 SG |
159 | * |
160 | * @return 0 if OK, -ve on error | |
4415f1d1 | 161 | */ |
c5951991 | 162 | int (*load)(void); |
4415f1d1 SG |
163 | |
164 | /** | |
165 | * save() - Save the environment to storage | |
166 | * | |
167 | * This method is required for 'saveenv' to work. | |
168 | * | |
169 | * @return 0 if OK, -ve on error | |
170 | */ | |
171 | int (*save)(void); | |
172 | ||
cd121bdb FW |
173 | /** |
174 | * erase() - Erase the environment on storage | |
175 | * | |
176 | * This method is optional and required for 'eraseenv' to work. | |
177 | * | |
178 | * @return 0 if OK, -ve on error | |
179 | */ | |
180 | int (*erase)(void); | |
181 | ||
4415f1d1 SG |
182 | /** |
183 | * init() - Set up the initial pre-relocation environment | |
184 | * | |
185 | * This method is optional. | |
186 | * | |
7938822a SG |
187 | * @return 0 if OK, -ENOENT if no initial environment could be found, |
188 | * other -ve on error | |
4415f1d1 SG |
189 | */ |
190 | int (*init)(void); | |
191 | }; | |
192 | ||
193 | /* Declare a new environment location driver */ | |
194 | #define U_BOOT_ENV_LOCATION(__name) \ | |
195 | ll_entry_declare(struct env_driver, __name, env_driver) | |
196 | ||
ac358beb SG |
197 | /* Declare the name of a location */ |
198 | #ifdef CONFIG_CMD_SAVEENV | |
199 | #define ENV_NAME(_name) .name = _name, | |
200 | #else | |
201 | #define ENV_NAME(_name) | |
202 | #endif | |
203 | ||
4415f1d1 SG |
204 | #ifdef CONFIG_CMD_SAVEENV |
205 | #define env_save_ptr(x) x | |
206 | #else | |
207 | #define env_save_ptr(x) NULL | |
208 | #endif | |
209 | ||
82b2f413 RV |
210 | #define ENV_SAVE_PTR(x) (CONFIG_IS_ENABLED(SAVEENV) ? (x) : NULL) |
211 | ||
2eb1573f MF |
212 | extern struct hsearch_data env_htab; |
213 | ||
507651d6 | 214 | #endif /* DO_DEPS_ONLY */ |
2eb1573f | 215 | |
f3998fdc | 216 | #endif /* _ENV_INTERNAL_H_ */ |