blob: 70715bb6e7564554c233ca3b9e08b928c7bf3925 [file] [log] [blame]
wdenk05706fd2002-09-28 17:48:27 +00001/*
Wolfgang Denkea882ba2010-06-20 23:33:59 +02002 * (C) Copyright 2000-2010
wdenk05706fd2002-09-28 17:48:27 +00003 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4 *
5 * (C) Copyright 2001 Sysgo Real-Time Solutions, GmbH <www.elinos.com>
6 * Andreas Heppel <aheppel@sysgo.de>
Wolfgang Denkea882ba2010-06-20 23:33:59 +02007 *
Wolfgang Denk3765b3e2013-10-07 13:07:26 +02008 * SPDX-License-Identifier: GPL-2.0+
wdenk05706fd2002-09-28 17:48:27 +00009 */
10
11#include <common.h>
12#include <command.h>
13#include <environment.h>
wdenk05706fd2002-09-28 17:48:27 +000014#include <linux/stddef.h>
Wolfgang Denkea882ba2010-06-20 23:33:59 +020015#include <search.h>
16#include <errno.h>
wdenk05706fd2002-09-28 17:48:27 +000017#include <malloc.h>
18
Wolfgang Denkd87080b2006-03-31 18:32:53 +020019DECLARE_GLOBAL_DATA_PTR;
20
wdenk05706fd2002-09-28 17:48:27 +000021/************************************************************************
22 * Default settings to be used when no valid environment is found
23 */
Joe Hershbergerddd84182012-10-12 08:48:51 +000024#include <env_default.h>
wdenk05706fd2002-09-28 17:48:27 +000025
Gerlando Falautoc5983592012-08-24 00:11:39 +000026struct hsearch_data env_htab = {
Joe Hershberger25980902012-12-11 22:16:31 -060027 .change_ok = env_flags_validate,
Gerlando Falautoc5983592012-08-24 00:11:39 +000028};
Mike Frysinger2eb15732010-12-08 06:26:04 -050029
Joe Hershbergerec8a2522012-12-11 22:16:22 -060030/*
31 * Read an environment variable as a boolean
32 * Return -1 if variable does not exist (default to true)
33 */
Simon Glassbfebc8c2017-08-03 12:22:13 -060034int env_get_yesno(const char *var)
Joe Hershbergerec8a2522012-12-11 22:16:22 -060035{
Simon Glass00caae62017-08-03 12:22:12 -060036 char *s = env_get(var);
Joe Hershbergerec8a2522012-12-11 22:16:22 -060037
38 if (s == NULL)
39 return -1;
40 return (*s == '1' || *s == 'y' || *s == 'Y' || *s == 't' || *s == 'T') ?
41 1 : 0;
42}
43
Joe Hershberger267541f2012-12-11 22:16:34 -060044/*
45 * Look up the variable from the default environment
46 */
Simon Glass723806c2017-08-03 12:22:15 -060047char *env_get_default(const char *name)
Joe Hershberger267541f2012-12-11 22:16:34 -060048{
49 char *ret_val;
50 unsigned long really_valid = gd->env_valid;
51 unsigned long real_gd_flags = gd->flags;
52
53 /* Pretend that the image is bad. */
54 gd->flags &= ~GD_FLG_ENV_READY;
Simon Glass2d7cb5b2017-08-20 04:45:15 -060055 gd->env_valid = ENV_INVALID;
Simon Glass00caae62017-08-03 12:22:12 -060056 ret_val = env_get(name);
Joe Hershberger267541f2012-12-11 22:16:34 -060057 gd->env_valid = really_valid;
58 gd->flags = real_gd_flags;
59 return ret_val;
60}
61
Wolfgang Denkea882ba2010-06-20 23:33:59 +020062void set_default_env(const char *s)
Harald Welte5bb12db2008-07-07 15:40:39 +080063{
Joe Hershbergerc4e00572012-12-11 22:16:19 -060064 int flags = 0;
65
Harald Welte5bb12db2008-07-07 15:40:39 +080066 if (sizeof(default_environment) > ENV_SIZE) {
Wolfgang Denkea882ba2010-06-20 23:33:59 +020067 puts("*** Error - default environment is too large\n\n");
Harald Welte5bb12db2008-07-07 15:40:39 +080068 return;
69 }
70
Wolfgang Denkea882ba2010-06-20 23:33:59 +020071 if (s) {
72 if (*s == '!') {
73 printf("*** Warning - %s, "
74 "using default environment\n\n",
Igor Grinberg27aafe92011-11-07 01:14:11 +000075 s + 1);
Wolfgang Denkea882ba2010-06-20 23:33:59 +020076 } else {
Joe Hershbergerc4e00572012-12-11 22:16:19 -060077 flags = H_INTERACTIVE;
Wolfgang Denkea882ba2010-06-20 23:33:59 +020078 puts(s);
79 }
80 } else {
81 puts("Using default environment\n\n");
82 }
83
Mike Frysinger2eb15732010-12-08 06:26:04 -050084 if (himport_r(&env_htab, (char *)default_environment,
Alexander Hollerecd14462014-07-14 17:49:55 +020085 sizeof(default_environment), '\0', flags, 0,
Joe Hershbergerc4e00572012-12-11 22:16:19 -060086 0, NULL) == 0)
Masahiro Yamada9b643e32017-09-16 14:10:41 +090087 pr_err("Environment import failed: errno = %d\n", errno);
Igor Grinberg27aafe92011-11-07 01:14:11 +000088
Wolfgang Denkea882ba2010-06-20 23:33:59 +020089 gd->flags |= GD_FLG_ENV_READY;
Michal Simek340b0e32016-05-30 16:06:54 +020090 gd->flags |= GD_FLG_ENV_DEFAULT;
Wolfgang Denkea882ba2010-06-20 23:33:59 +020091}
92
Gerlando Falautob64b7c32012-08-24 00:11:41 +000093
94/* [re]set individual variables to their value in the default environment */
95int set_default_vars(int nvars, char * const vars[])
96{
97 /*
98 * Special use-case: import from default environment
99 * (and use \0 as a separator)
100 */
101 return himport_r(&env_htab, (const char *)default_environment,
Joe Hershbergerc4e00572012-12-11 22:16:19 -0600102 sizeof(default_environment), '\0',
Alexander Hollerecd14462014-07-14 17:49:55 +0200103 H_NOCLEAR | H_INTERACTIVE, 0, nvars, vars);
Gerlando Falautob64b7c32012-08-24 00:11:41 +0000104}
105
Marek Vasuta4223b72014-03-05 19:59:51 +0100106#ifdef CONFIG_ENV_AES
Stefano Babicb80c0b92017-04-05 18:08:00 +0200107#include <uboot_aes.h>
Marek Vasuta4223b72014-03-05 19:59:51 +0100108/**
109 * env_aes_cbc_get_key() - Get AES-128-CBC key for the environment
110 *
111 * This function shall return 16-byte array containing AES-128 key used
Robert P. J. Day62a3b7d2016-07-15 13:44:45 -0400112 * to encrypt and decrypt the environment. This function must be overridden
Marek Vasuta4223b72014-03-05 19:59:51 +0100113 * by the implementer as otherwise the environment encryption will not
114 * work.
115 */
116__weak uint8_t *env_aes_cbc_get_key(void)
117{
118 return NULL;
119}
120
121static int env_aes_cbc_crypt(env_t *env, const int enc)
122{
123 unsigned char *data = env->data;
124 uint8_t *key;
125 uint8_t key_exp[AES_EXPAND_KEY_LENGTH];
126 uint32_t aes_blocks;
127
128 key = env_aes_cbc_get_key();
129 if (!key)
130 return -EINVAL;
131
132 /* First we expand the key. */
133 aes_expand_key(key, key_exp);
134
135 /* Calculate the number of AES blocks to encrypt. */
136 aes_blocks = ENV_SIZE / AES_KEY_LENGTH;
137
138 if (enc)
139 aes_cbc_encrypt_blocks(key_exp, data, data, aes_blocks);
140 else
141 aes_cbc_decrypt_blocks(key_exp, data, data, aes_blocks);
142
143 return 0;
144}
145#else
146static inline int env_aes_cbc_crypt(env_t *env, const int enc)
147{
148 return 0;
149}
150#endif
151
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200152/*
153 * Check if CRC is valid and (if yes) import the environment.
154 * Note that "buf" may or may not be aligned.
155 */
156int env_import(const char *buf, int check)
157{
158 env_t *ep = (env_t *)buf;
Marek Vasuta4223b72014-03-05 19:59:51 +0100159 int ret;
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200160
161 if (check) {
162 uint32_t crc;
163
164 memcpy(&crc, &ep->crc, sizeof(crc));
165
166 if (crc32(0, ep->data, ENV_SIZE) != crc) {
167 set_default_env("!bad CRC");
168 return 0;
169 }
170 }
171
Marek Vasuta4223b72014-03-05 19:59:51 +0100172 /* Decrypt the env if desired. */
173 ret = env_aes_cbc_crypt(ep, 0);
174 if (ret) {
Masahiro Yamada9b643e32017-09-16 14:10:41 +0900175 pr_err("Failed to decrypt env!\n");
Marek Vasuta4223b72014-03-05 19:59:51 +0100176 set_default_env("!import failed");
177 return ret;
178 }
179
Alexander Hollerecd14462014-07-14 17:49:55 +0200180 if (himport_r(&env_htab, (char *)ep->data, ENV_SIZE, '\0', 0, 0,
Joe Hershbergerc4e00572012-12-11 22:16:19 -0600181 0, NULL)) {
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200182 gd->flags |= GD_FLG_ENV_READY;
183 return 1;
184 }
185
Masahiro Yamada9b643e32017-09-16 14:10:41 +0900186 pr_err("Cannot import environment: errno = %d\n", errno);
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200187
188 set_default_env("!import failed");
189
190 return 0;
Harald Welte5bb12db2008-07-07 15:40:39 +0800191}
192
Fiach Antaw76768f52017-01-25 18:53:11 +1000193#ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
194static unsigned char env_flags;
195
196int env_import_redund(const char *buf1, const char *buf2)
197{
198 int crc1_ok, crc2_ok;
199 env_t *ep, *tmp_env1, *tmp_env2;
200
201 tmp_env1 = (env_t *)buf1;
202 tmp_env2 = (env_t *)buf2;
203
204 crc1_ok = crc32(0, tmp_env1->data, ENV_SIZE) ==
205 tmp_env1->crc;
206 crc2_ok = crc32(0, tmp_env2->data, ENV_SIZE) ==
207 tmp_env2->crc;
208
209 if (!crc1_ok && !crc2_ok) {
210 set_default_env("!bad CRC");
211 return 0;
212 } else if (crc1_ok && !crc2_ok) {
Simon Glass2d7cb5b2017-08-20 04:45:15 -0600213 gd->env_valid = ENV_VALID;
Fiach Antaw76768f52017-01-25 18:53:11 +1000214 } else if (!crc1_ok && crc2_ok) {
Simon Glass2d7cb5b2017-08-20 04:45:15 -0600215 gd->env_valid = ENV_REDUND;
Fiach Antaw76768f52017-01-25 18:53:11 +1000216 } else {
217 /* both ok - check serial */
218 if (tmp_env1->flags == 255 && tmp_env2->flags == 0)
Simon Glass2d7cb5b2017-08-20 04:45:15 -0600219 gd->env_valid = ENV_REDUND;
Fiach Antaw76768f52017-01-25 18:53:11 +1000220 else if (tmp_env2->flags == 255 && tmp_env1->flags == 0)
Simon Glass2d7cb5b2017-08-20 04:45:15 -0600221 gd->env_valid = ENV_VALID;
Fiach Antaw76768f52017-01-25 18:53:11 +1000222 else if (tmp_env1->flags > tmp_env2->flags)
Simon Glass2d7cb5b2017-08-20 04:45:15 -0600223 gd->env_valid = ENV_VALID;
Fiach Antaw76768f52017-01-25 18:53:11 +1000224 else if (tmp_env2->flags > tmp_env1->flags)
Simon Glass2d7cb5b2017-08-20 04:45:15 -0600225 gd->env_valid = ENV_REDUND;
Fiach Antaw76768f52017-01-25 18:53:11 +1000226 else /* flags are equal - almost impossible */
Simon Glass2d7cb5b2017-08-20 04:45:15 -0600227 gd->env_valid = ENV_VALID;
Fiach Antaw76768f52017-01-25 18:53:11 +1000228 }
229
Simon Glass2d7cb5b2017-08-20 04:45:15 -0600230 if (gd->env_valid == ENV_VALID)
Fiach Antaw76768f52017-01-25 18:53:11 +1000231 ep = tmp_env1;
232 else
233 ep = tmp_env2;
234
235 env_flags = ep->flags;
236 return env_import((char *)ep, 0);
237}
238#endif /* CONFIG_SYS_REDUNDAND_ENVIRONMENT */
239
Robert P. J. Dayfc0b5942016-09-07 14:27:59 -0400240/* Export the environment and generate CRC for it. */
Marek Vasut7ce15262014-03-05 19:59:50 +0100241int env_export(env_t *env_out)
242{
243 char *res;
244 ssize_t len;
Marek Vasuta4223b72014-03-05 19:59:51 +0100245 int ret;
Marek Vasut7ce15262014-03-05 19:59:50 +0100246
247 res = (char *)env_out->data;
248 len = hexport_r(&env_htab, '\0', 0, &res, ENV_SIZE, 0, NULL);
249 if (len < 0) {
Masahiro Yamada9b643e32017-09-16 14:10:41 +0900250 pr_err("Cannot export environment: errno = %d\n", errno);
Marek Vasut7ce15262014-03-05 19:59:50 +0100251 return 1;
252 }
Marek Vasuta4223b72014-03-05 19:59:51 +0100253
254 /* Encrypt the env if desired. */
255 ret = env_aes_cbc_crypt(env_out, 1);
256 if (ret)
257 return ret;
258
Marek Vasut7ce15262014-03-05 19:59:50 +0100259 env_out->crc = crc32(0, env_out->data, ENV_SIZE);
260
Fiach Antaw76768f52017-01-25 18:53:11 +1000261#ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
262 env_out->flags = ++env_flags; /* increase the serial */
263#endif
264
Marek Vasut7ce15262014-03-05 19:59:50 +0100265 return 0;
266}
267
Igor Grinberg27aafe92011-11-07 01:14:11 +0000268void env_relocate(void)
wdenk05706fd2002-09-28 17:48:27 +0000269{
Wolfgang Denk2e5167c2010-10-28 20:00:11 +0200270#if defined(CONFIG_NEEDS_MANUAL_RELOC)
Heiko Schocher60f7da12010-10-05 14:17:00 +0200271 env_reloc();
Joe Hershberger7afcf3a2012-12-11 22:16:21 -0600272 env_htab.change_ok += gd->reloc_off;
Heiko Schocher60f7da12010-10-05 14:17:00 +0200273#endif
Simon Glass2d7cb5b2017-08-20 04:45:15 -0600274 if (gd->env_valid == ENV_INVALID) {
Ilya Yanok7ac2fe22012-09-18 00:22:50 +0000275#if defined(CONFIG_ENV_IS_NOWHERE) || defined(CONFIG_SPL_BUILD)
276 /* Environment not changable */
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200277 set_default_env(NULL);
wdenk05706fd2002-09-28 17:48:27 +0000278#else
Simon Glass770605e2012-02-13 13:51:18 +0000279 bootstage_error(BOOTSTAGE_ID_NET_CHECKSUM);
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200280 set_default_env("!bad CRC");
Lei Wend2590792010-10-10 12:36:40 +0800281#endif
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200282 } else {
Simon Glass310fb142017-08-03 12:22:07 -0600283 env_load();
wdenk05706fd2002-09-28 17:48:27 +0000284 }
wdenk05706fd2002-09-28 17:48:27 +0000285}
wdenk04a85b32004-04-15 18:22:41 +0000286
Ilya Yanok7ac2fe22012-09-18 00:22:50 +0000287#if defined(CONFIG_AUTO_COMPLETE) && !defined(CONFIG_SPL_BUILD)
wdenk04a85b32004-04-15 18:22:41 +0000288int env_complete(char *var, int maxv, char *cmdv[], int bufsz, char *buf)
289{
Mike Frysinger560d4242010-12-17 16:51:59 -0500290 ENTRY *match;
291 int found, idx;
wdenk04a85b32004-04-15 18:22:41 +0000292
Mike Frysinger560d4242010-12-17 16:51:59 -0500293 idx = 0;
wdenk04a85b32004-04-15 18:22:41 +0000294 found = 0;
295 cmdv[0] = NULL;
296
Mike Frysinger560d4242010-12-17 16:51:59 -0500297 while ((idx = hmatch_r(var, idx, &match, &env_htab))) {
298 int vallen = strlen(match->key) + 1;
wdenk04a85b32004-04-15 18:22:41 +0000299
Mike Frysinger560d4242010-12-17 16:51:59 -0500300 if (found >= maxv - 2 || bufsz < vallen)
wdenk04a85b32004-04-15 18:22:41 +0000301 break;
Mike Frysinger560d4242010-12-17 16:51:59 -0500302
wdenk04a85b32004-04-15 18:22:41 +0000303 cmdv[found++] = buf;
Mike Frysinger560d4242010-12-17 16:51:59 -0500304 memcpy(buf, match->key, vallen);
305 buf += vallen;
306 bufsz -= vallen;
wdenk04a85b32004-04-15 18:22:41 +0000307 }
308
Mike Frysinger560d4242010-12-17 16:51:59 -0500309 qsort(cmdv, found, sizeof(cmdv[0]), strcmp_compar);
310
311 if (idx)
312 cmdv[found++] = "...";
Igor Grinberg27aafe92011-11-07 01:14:11 +0000313
wdenk04a85b32004-04-15 18:22:41 +0000314 cmdv[found] = NULL;
315 return found;
316}
317#endif