2 * (C) Copyright 2000-2010
3 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
5 * (C) Copyright 2001 Sysgo Real-Time Solutions, GmbH <www.elinos.com>
6 * Andreas Heppel <aheppel@sysgo.de>
8 * SPDX-License-Identifier: GPL-2.0+
13 #include <environment.h>
14 #include <linux/stddef.h>
19 DECLARE_GLOBAL_DATA_PTR;
21 /************************************************************************
22 * Default settings to be used when no valid environment is found
24 #include <env_default.h>
26 struct hsearch_data env_htab = {
27 .change_ok = env_flags_validate,
30 __weak uchar env_get_char_spec(int index)
32 return *((uchar *)(gd->env_addr + index));
35 static uchar env_get_char_memory(int index)
37 return *(uchar *)(gd->env_addr + index);
40 uchar env_get_char(int index)
42 /* if env is not set up, or crc was bad, use the default environment */
44 return default_environment[index];
45 else if (gd->flags & GD_FLG_RELOC) /* if relocated to RAM */
46 return env_get_char_memory(index);
48 return env_get_char_spec(index);
52 * Read an environment variable as a boolean
53 * Return -1 if variable does not exist (default to true)
55 int getenv_yesno(const char *var)
57 char *s = getenv(var);
61 return (*s == '1' || *s == 'y' || *s == 'Y' || *s == 't' || *s == 'T') ?
66 * Look up the variable from the default environment
68 char *getenv_default(const char *name)
71 unsigned long really_valid = gd->env_valid;
72 unsigned long real_gd_flags = gd->flags;
74 /* Pretend that the image is bad. */
75 gd->flags &= ~GD_FLG_ENV_READY;
77 ret_val = getenv(name);
78 gd->env_valid = really_valid;
79 gd->flags = real_gd_flags;
83 void set_default_env(const char *s)
87 if (sizeof(default_environment) > ENV_SIZE) {
88 puts("*** Error - default environment is too large\n\n");
94 printf("*** Warning - %s, "
95 "using default environment\n\n",
98 flags = H_INTERACTIVE;
102 puts("Using default environment\n\n");
105 if (himport_r(&env_htab, (char *)default_environment,
106 sizeof(default_environment), '\0', flags, 0,
108 error("Environment import failed: errno = %d\n", errno);
110 gd->flags |= GD_FLG_ENV_READY;
111 gd->flags |= GD_FLG_ENV_DEFAULT;
115 /* [re]set individual variables to their value in the default environment */
116 int set_default_vars(int nvars, char * const vars[])
119 * Special use-case: import from default environment
120 * (and use \0 as a separator)
122 return himport_r(&env_htab, (const char *)default_environment,
123 sizeof(default_environment), '\0',
124 H_NOCLEAR | H_INTERACTIVE, 0, nvars, vars);
127 #ifdef CONFIG_ENV_AES
128 #include <uboot_aes.h>
130 * env_aes_cbc_get_key() - Get AES-128-CBC key for the environment
132 * This function shall return 16-byte array containing AES-128 key used
133 * to encrypt and decrypt the environment. This function must be overridden
134 * by the implementer as otherwise the environment encryption will not
137 __weak uint8_t *env_aes_cbc_get_key(void)
142 static int env_aes_cbc_crypt(env_t *env, const int enc)
144 unsigned char *data = env->data;
146 uint8_t key_exp[AES_EXPAND_KEY_LENGTH];
149 key = env_aes_cbc_get_key();
153 /* First we expand the key. */
154 aes_expand_key(key, key_exp);
156 /* Calculate the number of AES blocks to encrypt. */
157 aes_blocks = ENV_SIZE / AES_KEY_LENGTH;
160 aes_cbc_encrypt_blocks(key_exp, data, data, aes_blocks);
162 aes_cbc_decrypt_blocks(key_exp, data, data, aes_blocks);
167 static inline int env_aes_cbc_crypt(env_t *env, const int enc)
174 * Check if CRC is valid and (if yes) import the environment.
175 * Note that "buf" may or may not be aligned.
177 int env_import(const char *buf, int check)
179 env_t *ep = (env_t *)buf;
185 memcpy(&crc, &ep->crc, sizeof(crc));
187 if (crc32(0, ep->data, ENV_SIZE) != crc) {
188 set_default_env("!bad CRC");
193 /* Decrypt the env if desired. */
194 ret = env_aes_cbc_crypt(ep, 0);
196 error("Failed to decrypt env!\n");
197 set_default_env("!import failed");
201 if (himport_r(&env_htab, (char *)ep->data, ENV_SIZE, '\0', 0, 0,
203 gd->flags |= GD_FLG_ENV_READY;
207 error("Cannot import environment: errno = %d\n", errno);
209 set_default_env("!import failed");
214 #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
215 static unsigned char env_flags;
217 int env_import_redund(const char *buf1, const char *buf2)
219 int crc1_ok, crc2_ok;
220 env_t *ep, *tmp_env1, *tmp_env2;
222 tmp_env1 = (env_t *)buf1;
223 tmp_env2 = (env_t *)buf2;
225 crc1_ok = crc32(0, tmp_env1->data, ENV_SIZE) ==
227 crc2_ok = crc32(0, tmp_env2->data, ENV_SIZE) ==
230 if (!crc1_ok && !crc2_ok) {
231 set_default_env("!bad CRC");
233 } else if (crc1_ok && !crc2_ok) {
235 } else if (!crc1_ok && crc2_ok) {
238 /* both ok - check serial */
239 if (tmp_env1->flags == 255 && tmp_env2->flags == 0)
241 else if (tmp_env2->flags == 255 && tmp_env1->flags == 0)
243 else if (tmp_env1->flags > tmp_env2->flags)
245 else if (tmp_env2->flags > tmp_env1->flags)
247 else /* flags are equal - almost impossible */
251 if (gd->env_valid == 1)
256 env_flags = ep->flags;
257 return env_import((char *)ep, 0);
259 #endif /* CONFIG_SYS_REDUNDAND_ENVIRONMENT */
261 /* Export the environment and generate CRC for it. */
262 int env_export(env_t *env_out)
268 res = (char *)env_out->data;
269 len = hexport_r(&env_htab, '\0', 0, &res, ENV_SIZE, 0, NULL);
271 error("Cannot export environment: errno = %d\n", errno);
275 /* Encrypt the env if desired. */
276 ret = env_aes_cbc_crypt(env_out, 1);
280 env_out->crc = crc32(0, env_out->data, ENV_SIZE);
282 #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
283 env_out->flags = ++env_flags; /* increase the serial */
289 void env_relocate(void)
291 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
293 env_htab.change_ok += gd->reloc_off;
295 if (gd->env_valid == 0) {
296 #if defined(CONFIG_ENV_IS_NOWHERE) || defined(CONFIG_SPL_BUILD)
297 /* Environment not changable */
298 set_default_env(NULL);
300 bootstage_error(BOOTSTAGE_ID_NET_CHECKSUM);
301 set_default_env("!bad CRC");
308 #if defined(CONFIG_AUTO_COMPLETE) && !defined(CONFIG_SPL_BUILD)
309 int env_complete(char *var, int maxv, char *cmdv[], int bufsz, char *buf)
318 while ((idx = hmatch_r(var, idx, &match, &env_htab))) {
319 int vallen = strlen(match->key) + 1;
321 if (found >= maxv - 2 || bufsz < vallen)
325 memcpy(buf, match->key, vallen);
330 qsort(cmdv, found, sizeof(cmdv[0]), strcmp_compar);
333 cmdv[found++] = "...";