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 uchar env_get_char(int index)
37 /* if env is not set up, or crc was bad, use the default environment */
39 return default_environment[index];
41 return env_get_char_spec(index);
45 * Read an environment variable as a boolean
46 * Return -1 if variable does not exist (default to true)
48 int getenv_yesno(const char *var)
50 char *s = getenv(var);
54 return (*s == '1' || *s == 'y' || *s == 'Y' || *s == 't' || *s == 'T') ?
59 * Look up the variable from the default environment
61 char *getenv_default(const char *name)
64 unsigned long really_valid = gd->env_valid;
65 unsigned long real_gd_flags = gd->flags;
67 /* Pretend that the image is bad. */
68 gd->flags &= ~GD_FLG_ENV_READY;
70 ret_val = getenv(name);
71 gd->env_valid = really_valid;
72 gd->flags = real_gd_flags;
76 void set_default_env(const char *s)
80 if (sizeof(default_environment) > ENV_SIZE) {
81 puts("*** Error - default environment is too large\n\n");
87 printf("*** Warning - %s, "
88 "using default environment\n\n",
91 flags = H_INTERACTIVE;
95 puts("Using default environment\n\n");
98 if (himport_r(&env_htab, (char *)default_environment,
99 sizeof(default_environment), '\0', flags, 0,
101 error("Environment import failed: errno = %d\n", errno);
103 gd->flags |= GD_FLG_ENV_READY;
104 gd->flags |= GD_FLG_ENV_DEFAULT;
108 /* [re]set individual variables to their value in the default environment */
109 int set_default_vars(int nvars, char * const vars[])
112 * Special use-case: import from default environment
113 * (and use \0 as a separator)
115 return himport_r(&env_htab, (const char *)default_environment,
116 sizeof(default_environment), '\0',
117 H_NOCLEAR | H_INTERACTIVE, 0, nvars, vars);
120 #ifdef CONFIG_ENV_AES
121 #include <uboot_aes.h>
123 * env_aes_cbc_get_key() - Get AES-128-CBC key for the environment
125 * This function shall return 16-byte array containing AES-128 key used
126 * to encrypt and decrypt the environment. This function must be overridden
127 * by the implementer as otherwise the environment encryption will not
130 __weak uint8_t *env_aes_cbc_get_key(void)
135 static int env_aes_cbc_crypt(env_t *env, const int enc)
137 unsigned char *data = env->data;
139 uint8_t key_exp[AES_EXPAND_KEY_LENGTH];
142 key = env_aes_cbc_get_key();
146 /* First we expand the key. */
147 aes_expand_key(key, key_exp);
149 /* Calculate the number of AES blocks to encrypt. */
150 aes_blocks = ENV_SIZE / AES_KEY_LENGTH;
153 aes_cbc_encrypt_blocks(key_exp, data, data, aes_blocks);
155 aes_cbc_decrypt_blocks(key_exp, data, data, aes_blocks);
160 static inline int env_aes_cbc_crypt(env_t *env, const int enc)
167 * Check if CRC is valid and (if yes) import the environment.
168 * Note that "buf" may or may not be aligned.
170 int env_import(const char *buf, int check)
172 env_t *ep = (env_t *)buf;
178 memcpy(&crc, &ep->crc, sizeof(crc));
180 if (crc32(0, ep->data, ENV_SIZE) != crc) {
181 set_default_env("!bad CRC");
186 /* Decrypt the env if desired. */
187 ret = env_aes_cbc_crypt(ep, 0);
189 error("Failed to decrypt env!\n");
190 set_default_env("!import failed");
194 if (himport_r(&env_htab, (char *)ep->data, ENV_SIZE, '\0', 0, 0,
196 gd->flags |= GD_FLG_ENV_READY;
200 error("Cannot import environment: errno = %d\n", errno);
202 set_default_env("!import failed");
207 #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
208 static unsigned char env_flags;
210 int env_import_redund(const char *buf1, const char *buf2)
212 int crc1_ok, crc2_ok;
213 env_t *ep, *tmp_env1, *tmp_env2;
215 tmp_env1 = (env_t *)buf1;
216 tmp_env2 = (env_t *)buf2;
218 crc1_ok = crc32(0, tmp_env1->data, ENV_SIZE) ==
220 crc2_ok = crc32(0, tmp_env2->data, ENV_SIZE) ==
223 if (!crc1_ok && !crc2_ok) {
224 set_default_env("!bad CRC");
226 } else if (crc1_ok && !crc2_ok) {
228 } else if (!crc1_ok && crc2_ok) {
231 /* both ok - check serial */
232 if (tmp_env1->flags == 255 && tmp_env2->flags == 0)
234 else if (tmp_env2->flags == 255 && tmp_env1->flags == 0)
236 else if (tmp_env1->flags > tmp_env2->flags)
238 else if (tmp_env2->flags > tmp_env1->flags)
240 else /* flags are equal - almost impossible */
244 if (gd->env_valid == 1)
249 env_flags = ep->flags;
250 return env_import((char *)ep, 0);
252 #endif /* CONFIG_SYS_REDUNDAND_ENVIRONMENT */
254 /* Export the environment and generate CRC for it. */
255 int env_export(env_t *env_out)
261 res = (char *)env_out->data;
262 len = hexport_r(&env_htab, '\0', 0, &res, ENV_SIZE, 0, NULL);
264 error("Cannot export environment: errno = %d\n", errno);
268 /* Encrypt the env if desired. */
269 ret = env_aes_cbc_crypt(env_out, 1);
273 env_out->crc = crc32(0, env_out->data, ENV_SIZE);
275 #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
276 env_out->flags = ++env_flags; /* increase the serial */
282 void env_relocate(void)
284 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
286 env_htab.change_ok += gd->reloc_off;
288 if (gd->env_valid == 0) {
289 #if defined(CONFIG_ENV_IS_NOWHERE) || defined(CONFIG_SPL_BUILD)
290 /* Environment not changable */
291 set_default_env(NULL);
293 bootstage_error(BOOTSTAGE_ID_NET_CHECKSUM);
294 set_default_env("!bad CRC");
301 #if defined(CONFIG_AUTO_COMPLETE) && !defined(CONFIG_SPL_BUILD)
302 int env_complete(char *var, int maxv, char *cmdv[], int bufsz, char *buf)
311 while ((idx = hmatch_r(var, idx, &match, &env_htab))) {
312 int vallen = strlen(match->key) + 1;
314 if (found >= maxv - 2 || bufsz < vallen)
318 memcpy(buf, match->key, vallen);
323 qsort(cmdv, found, sizeof(cmdv[0]), strcmp_compar);
326 cmdv[found++] = "...";