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
,
31 * Read an environment variable as a boolean
32 * Return -1 if variable does not exist (default to true)
34 int env_get_yesno(const char *var
)
36 char *s
= env_get(var
);
40 return (*s
== '1' || *s
== 'y' || *s
== 'Y' || *s
== 't' || *s
== 'T') ?
45 * Look up the variable from the default environment
47 char *env_get_default(const char *name
)
50 unsigned long really_valid
= gd
->env_valid
;
51 unsigned long real_gd_flags
= gd
->flags
;
53 /* Pretend that the image is bad. */
54 gd
->flags
&= ~GD_FLG_ENV_READY
;
55 gd
->env_valid
= ENV_INVALID
;
56 ret_val
= env_get(name
);
57 gd
->env_valid
= really_valid
;
58 gd
->flags
= real_gd_flags
;
62 void set_default_env(const char *s
)
66 if (sizeof(default_environment
) > ENV_SIZE
) {
67 puts("*** Error - default environment is too large\n\n");
73 printf("*** Warning - %s, "
74 "using default environment\n\n",
77 flags
= H_INTERACTIVE
;
81 puts("Using default environment\n\n");
84 if (himport_r(&env_htab
, (char *)default_environment
,
85 sizeof(default_environment
), '\0', flags
, 0,
87 pr_err("Environment import failed: errno = %d\n", errno
);
89 gd
->flags
|= GD_FLG_ENV_READY
;
90 gd
->flags
|= GD_FLG_ENV_DEFAULT
;
94 /* [re]set individual variables to their value in the default environment */
95 int set_default_vars(int nvars
, char * const vars
[])
98 * Special use-case: import from default environment
99 * (and use \0 as a separator)
101 return himport_r(&env_htab
, (const char *)default_environment
,
102 sizeof(default_environment
), '\0',
103 H_NOCLEAR
| H_INTERACTIVE
, 0, nvars
, vars
);
106 #ifdef CONFIG_ENV_AES
107 #include <uboot_aes.h>
109 * env_aes_cbc_get_key() - Get AES-128-CBC key for the environment
111 * This function shall return 16-byte array containing AES-128 key used
112 * to encrypt and decrypt the environment. This function must be overridden
113 * by the implementer as otherwise the environment encryption will not
116 __weak
uint8_t *env_aes_cbc_get_key(void)
121 static int env_aes_cbc_crypt(env_t
*env
, const int enc
)
123 unsigned char *data
= env
->data
;
125 uint8_t key_exp
[AES_EXPAND_KEY_LENGTH
];
128 key
= env_aes_cbc_get_key();
132 /* First we expand the key. */
133 aes_expand_key(key
, key_exp
);
135 /* Calculate the number of AES blocks to encrypt. */
136 aes_blocks
= ENV_SIZE
/ AES_KEY_LENGTH
;
139 aes_cbc_encrypt_blocks(key_exp
, data
, data
, aes_blocks
);
141 aes_cbc_decrypt_blocks(key_exp
, data
, data
, aes_blocks
);
146 static inline int env_aes_cbc_crypt(env_t
*env
, const int enc
)
153 * Check if CRC is valid and (if yes) import the environment.
154 * Note that "buf" may or may not be aligned.
156 int env_import(const char *buf
, int check
)
158 env_t
*ep
= (env_t
*)buf
;
164 memcpy(&crc
, &ep
->crc
, sizeof(crc
));
166 if (crc32(0, ep
->data
, ENV_SIZE
) != crc
) {
167 set_default_env("!bad CRC");
172 /* Decrypt the env if desired. */
173 ret
= env_aes_cbc_crypt(ep
, 0);
175 pr_err("Failed to decrypt env!\n");
176 set_default_env("!import failed");
180 if (himport_r(&env_htab
, (char *)ep
->data
, ENV_SIZE
, '\0', 0, 0,
182 gd
->flags
|= GD_FLG_ENV_READY
;
186 pr_err("Cannot import environment: errno = %d\n", errno
);
188 set_default_env("!import failed");
193 #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
194 static unsigned char env_flags
;
196 int env_import_redund(const char *buf1
, const char *buf2
)
198 int crc1_ok
, crc2_ok
;
199 env_t
*ep
, *tmp_env1
, *tmp_env2
;
201 tmp_env1
= (env_t
*)buf1
;
202 tmp_env2
= (env_t
*)buf2
;
204 crc1_ok
= crc32(0, tmp_env1
->data
, ENV_SIZE
) ==
206 crc2_ok
= crc32(0, tmp_env2
->data
, ENV_SIZE
) ==
209 if (!crc1_ok
&& !crc2_ok
) {
210 set_default_env("!bad CRC");
212 } else if (crc1_ok
&& !crc2_ok
) {
213 gd
->env_valid
= ENV_VALID
;
214 } else if (!crc1_ok
&& crc2_ok
) {
215 gd
->env_valid
= ENV_REDUND
;
217 /* both ok - check serial */
218 if (tmp_env1
->flags
== 255 && tmp_env2
->flags
== 0)
219 gd
->env_valid
= ENV_REDUND
;
220 else if (tmp_env2
->flags
== 255 && tmp_env1
->flags
== 0)
221 gd
->env_valid
= ENV_VALID
;
222 else if (tmp_env1
->flags
> tmp_env2
->flags
)
223 gd
->env_valid
= ENV_VALID
;
224 else if (tmp_env2
->flags
> tmp_env1
->flags
)
225 gd
->env_valid
= ENV_REDUND
;
226 else /* flags are equal - almost impossible */
227 gd
->env_valid
= ENV_VALID
;
230 if (gd
->env_valid
== ENV_VALID
)
235 env_flags
= ep
->flags
;
236 return env_import((char *)ep
, 0);
238 #endif /* CONFIG_SYS_REDUNDAND_ENVIRONMENT */
240 /* Export the environment and generate CRC for it. */
241 int env_export(env_t
*env_out
)
247 res
= (char *)env_out
->data
;
248 len
= hexport_r(&env_htab
, '\0', 0, &res
, ENV_SIZE
, 0, NULL
);
250 pr_err("Cannot export environment: errno = %d\n", errno
);
254 /* Encrypt the env if desired. */
255 ret
= env_aes_cbc_crypt(env_out
, 1);
259 env_out
->crc
= crc32(0, env_out
->data
, ENV_SIZE
);
261 #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
262 env_out
->flags
= ++env_flags
; /* increase the serial */
268 void env_relocate(void)
270 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
272 env_htab
.change_ok
+= gd
->reloc_off
;
274 if (gd
->env_valid
== ENV_INVALID
) {
275 #if defined(CONFIG_ENV_IS_NOWHERE) || defined(CONFIG_SPL_BUILD)
276 /* Environment not changable */
277 set_default_env(NULL
);
279 bootstage_error(BOOTSTAGE_ID_NET_CHECKSUM
);
280 set_default_env("!bad CRC");
287 #if defined(CONFIG_AUTO_COMPLETE) && !defined(CONFIG_SPL_BUILD)
288 int env_complete(char *var
, int maxv
, char *cmdv
[], int bufsz
, char *buf
)
297 while ((idx
= hmatch_r(var
, idx
, &match
, &env_htab
))) {
298 int vallen
= strlen(match
->key
) + 1;
300 if (found
>= maxv
- 2 || bufsz
< vallen
)
304 memcpy(buf
, match
->key
, vallen
);
309 qsort(cmdv
, found
, sizeof(cmdv
[0]), strcmp_compar
);
312 cmdv
[found
++] = "...";