blob: bd340fe9d52d7bdfb62d68c83ceca6954ccf27ae [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001// SPDX-License-Identifier: GPL-2.0+
wdenk05706fd2002-09-28 17:48:27 +00002/*
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003 * (C) Copyright 2000-2010
wdenk05706fd2002-09-28 17:48:27 +00004 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
5 *
6 * (C) Copyright 2001 Sysgo Real-Time Solutions, GmbH <www.elinos.com>
7 * Andreas Heppel <aheppel@sysgo.de>
wdenk05706fd2002-09-28 17:48:27 +00008 */
9
10#include <common.h>
11#include <command.h>
12#include <environment.h>
wdenk05706fd2002-09-28 17:48:27 +000013#include <linux/stddef.h>
Wolfgang Denkea882ba2010-06-20 23:33:59 +020014#include <search.h>
15#include <errno.h>
wdenk05706fd2002-09-28 17:48:27 +000016#include <malloc.h>
17
Wolfgang Denkd87080b2006-03-31 18:32:53 +020018DECLARE_GLOBAL_DATA_PTR;
19
wdenk05706fd2002-09-28 17:48:27 +000020/************************************************************************
21 * Default settings to be used when no valid environment is found
22 */
Joe Hershbergerddd84182012-10-12 08:48:51 +000023#include <env_default.h>
wdenk05706fd2002-09-28 17:48:27 +000024
Gerlando Falautoc5983592012-08-24 00:11:39 +000025struct hsearch_data env_htab = {
Patrick Delaunay7d477652019-04-18 17:32:49 +020026#if CONFIG_IS_ENABLED(ENV_SUPPORT)
27 /* defined in flags.c, only compile with ENV_SUPPORT */
Joe Hershberger25980902012-12-11 22:16:31 -060028 .change_ok = env_flags_validate,
Patrick Delaunay7d477652019-04-18 17:32:49 +020029#endif
Gerlando Falautoc5983592012-08-24 00:11:39 +000030};
Mike Frysinger2eb15732010-12-08 06:26:04 -050031
Joe Hershbergerec8a2522012-12-11 22:16:22 -060032/*
33 * Read an environment variable as a boolean
34 * Return -1 if variable does not exist (default to true)
35 */
Simon Glassbfebc8c2017-08-03 12:22:13 -060036int env_get_yesno(const char *var)
Joe Hershbergerec8a2522012-12-11 22:16:22 -060037{
Simon Glass00caae62017-08-03 12:22:12 -060038 char *s = env_get(var);
Joe Hershbergerec8a2522012-12-11 22:16:22 -060039
40 if (s == NULL)
41 return -1;
42 return (*s == '1' || *s == 'y' || *s == 'Y' || *s == 't' || *s == 'T') ?
43 1 : 0;
44}
45
Joe Hershberger267541f2012-12-11 22:16:34 -060046/*
47 * Look up the variable from the default environment
48 */
Simon Glass723806c2017-08-03 12:22:15 -060049char *env_get_default(const char *name)
Joe Hershberger267541f2012-12-11 22:16:34 -060050{
51 char *ret_val;
52 unsigned long really_valid = gd->env_valid;
53 unsigned long real_gd_flags = gd->flags;
54
55 /* Pretend that the image is bad. */
56 gd->flags &= ~GD_FLG_ENV_READY;
Simon Glass2d7cb5b2017-08-20 04:45:15 -060057 gd->env_valid = ENV_INVALID;
Simon Glass00caae62017-08-03 12:22:12 -060058 ret_val = env_get(name);
Joe Hershberger267541f2012-12-11 22:16:34 -060059 gd->env_valid = really_valid;
60 gd->flags = real_gd_flags;
61 return ret_val;
62}
63
Yaniv Levinskyc5d548a2018-06-24 19:16:57 +030064void set_default_env(const char *s, int flags)
Harald Welte5bb12db2008-07-07 15:40:39 +080065{
66 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) {
Yaniv Levinskyc5d548a2018-06-24 19:16:57 +030072 if ((flags & H_INTERACTIVE) == 0) {
Wolfgang Denkea882ba2010-06-20 23:33:59 +020073 printf("*** Warning - %s, "
Yaniv Levinskyc5d548a2018-06-24 19:16:57 +030074 "using default environment\n\n", s);
Wolfgang Denkea882ba2010-06-20 23:33:59 +020075 } else {
76 puts(s);
77 }
78 } else {
Maxime Ripard58ae9992018-01-23 21:16:57 +010079 debug("Using default environment\n");
Wolfgang Denkea882ba2010-06-20 23:33:59 +020080 }
81
Mike Frysinger2eb15732010-12-08 06:26:04 -050082 if (himport_r(&env_htab, (char *)default_environment,
Alexander Hollerecd14462014-07-14 17:49:55 +020083 sizeof(default_environment), '\0', flags, 0,
Joe Hershbergerc4e00572012-12-11 22:16:19 -060084 0, NULL) == 0)
Quentin Schulz6c90f622018-07-09 19:16:25 +020085 pr_err("## Error: Environment import failed: errno = %d\n",
86 errno);
Igor Grinberg27aafe92011-11-07 01:14:11 +000087
Wolfgang Denkea882ba2010-06-20 23:33:59 +020088 gd->flags |= GD_FLG_ENV_READY;
Michal Simek340b0e32016-05-30 16:06:54 +020089 gd->flags |= GD_FLG_ENV_DEFAULT;
Wolfgang Denkea882ba2010-06-20 23:33:59 +020090}
91
Gerlando Falautob64b7c32012-08-24 00:11:41 +000092
93/* [re]set individual variables to their value in the default environment */
Yaniv Levinsky477f8112018-06-24 19:16:55 +030094int set_default_vars(int nvars, char * const vars[], int flags)
Gerlando Falautob64b7c32012-08-24 00:11:41 +000095{
96 /*
97 * Special use-case: import from default environment
98 * (and use \0 as a separator)
99 */
Yaniv Levinsky5a042642018-06-24 19:16:56 +0300100 flags |= H_NOCLEAR;
Gerlando Falautob64b7c32012-08-24 00:11:41 +0000101 return himport_r(&env_htab, (const char *)default_environment,
Joe Hershbergerc4e00572012-12-11 22:16:19 -0600102 sizeof(default_environment), '\0',
Yaniv Levinsky477f8112018-06-24 19:16:55 +0300103 flags, 0, nvars, vars);
Gerlando Falautob64b7c32012-08-24 00:11:41 +0000104}
105
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200106/*
107 * Check if CRC is valid and (if yes) import the environment.
108 * Note that "buf" may or may not be aligned.
109 */
110int env_import(const char *buf, int check)
111{
112 env_t *ep = (env_t *)buf;
113
114 if (check) {
115 uint32_t crc;
116
117 memcpy(&crc, &ep->crc, sizeof(crc));
118
119 if (crc32(0, ep->data, ENV_SIZE) != crc) {
Yaniv Levinskyc5d548a2018-06-24 19:16:57 +0300120 set_default_env("bad CRC", 0);
Sam Protsenko49d04c52019-01-18 21:19:03 +0200121 return -ENOMSG; /* needed for env_load() */
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200122 }
123 }
124
Alexander Hollerecd14462014-07-14 17:49:55 +0200125 if (himport_r(&env_htab, (char *)ep->data, ENV_SIZE, '\0', 0, 0,
Joe Hershbergerc4e00572012-12-11 22:16:19 -0600126 0, NULL)) {
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200127 gd->flags |= GD_FLG_ENV_READY;
Simon Goldschmidt42a18202018-01-31 14:47:10 +0100128 return 0;
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200129 }
130
Masahiro Yamada9b643e32017-09-16 14:10:41 +0900131 pr_err("Cannot import environment: errno = %d\n", errno);
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200132
Yaniv Levinskyc5d548a2018-06-24 19:16:57 +0300133 set_default_env("import failed", 0);
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200134
Simon Goldschmidt42a18202018-01-31 14:47:10 +0100135 return -EIO;
Harald Welte5bb12db2008-07-07 15:40:39 +0800136}
137
Fiach Antaw76768f52017-01-25 18:53:11 +1000138#ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
139static unsigned char env_flags;
140
Simon Goldschmidt31f044b2018-01-31 14:47:11 +0100141int env_import_redund(const char *buf1, int buf1_read_fail,
142 const char *buf2, int buf2_read_fail)
Fiach Antaw76768f52017-01-25 18:53:11 +1000143{
144 int crc1_ok, crc2_ok;
145 env_t *ep, *tmp_env1, *tmp_env2;
146
147 tmp_env1 = (env_t *)buf1;
148 tmp_env2 = (env_t *)buf2;
149
Simon Goldschmidt31f044b2018-01-31 14:47:11 +0100150 if (buf1_read_fail && buf2_read_fail) {
151 puts("*** Error - No Valid Environment Area found\n");
152 } else if (buf1_read_fail || buf2_read_fail) {
153 puts("*** Warning - some problems detected ");
154 puts("reading environment; recovered successfully\n");
155 }
156
157 if (buf1_read_fail && buf2_read_fail) {
Yaniv Levinskyc5d548a2018-06-24 19:16:57 +0300158 set_default_env("bad env area", 0);
Simon Goldschmidt31f044b2018-01-31 14:47:11 +0100159 return -EIO;
160 } else if (!buf1_read_fail && buf2_read_fail) {
161 gd->env_valid = ENV_VALID;
162 return env_import((char *)tmp_env1, 1);
163 } else if (buf1_read_fail && !buf2_read_fail) {
164 gd->env_valid = ENV_REDUND;
165 return env_import((char *)tmp_env2, 1);
166 }
167
Fiach Antaw76768f52017-01-25 18:53:11 +1000168 crc1_ok = crc32(0, tmp_env1->data, ENV_SIZE) ==
169 tmp_env1->crc;
170 crc2_ok = crc32(0, tmp_env2->data, ENV_SIZE) ==
171 tmp_env2->crc;
172
173 if (!crc1_ok && !crc2_ok) {
Yaniv Levinskyc5d548a2018-06-24 19:16:57 +0300174 set_default_env("bad CRC", 0);
Sam Protsenko49d04c52019-01-18 21:19:03 +0200175 return -ENOMSG; /* needed for env_load() */
Fiach Antaw76768f52017-01-25 18:53:11 +1000176 } else if (crc1_ok && !crc2_ok) {
Simon Glass2d7cb5b2017-08-20 04:45:15 -0600177 gd->env_valid = ENV_VALID;
Fiach Antaw76768f52017-01-25 18:53:11 +1000178 } else if (!crc1_ok && crc2_ok) {
Simon Glass2d7cb5b2017-08-20 04:45:15 -0600179 gd->env_valid = ENV_REDUND;
Fiach Antaw76768f52017-01-25 18:53:11 +1000180 } else {
181 /* both ok - check serial */
182 if (tmp_env1->flags == 255 && tmp_env2->flags == 0)
Simon Glass2d7cb5b2017-08-20 04:45:15 -0600183 gd->env_valid = ENV_REDUND;
Fiach Antaw76768f52017-01-25 18:53:11 +1000184 else if (tmp_env2->flags == 255 && tmp_env1->flags == 0)
Simon Glass2d7cb5b2017-08-20 04:45:15 -0600185 gd->env_valid = ENV_VALID;
Fiach Antaw76768f52017-01-25 18:53:11 +1000186 else if (tmp_env1->flags > tmp_env2->flags)
Simon Glass2d7cb5b2017-08-20 04:45:15 -0600187 gd->env_valid = ENV_VALID;
Fiach Antaw76768f52017-01-25 18:53:11 +1000188 else if (tmp_env2->flags > tmp_env1->flags)
Simon Glass2d7cb5b2017-08-20 04:45:15 -0600189 gd->env_valid = ENV_REDUND;
Fiach Antaw76768f52017-01-25 18:53:11 +1000190 else /* flags are equal - almost impossible */
Simon Glass2d7cb5b2017-08-20 04:45:15 -0600191 gd->env_valid = ENV_VALID;
Fiach Antaw76768f52017-01-25 18:53:11 +1000192 }
193
Simon Glass2d7cb5b2017-08-20 04:45:15 -0600194 if (gd->env_valid == ENV_VALID)
Fiach Antaw76768f52017-01-25 18:53:11 +1000195 ep = tmp_env1;
196 else
197 ep = tmp_env2;
198
199 env_flags = ep->flags;
200 return env_import((char *)ep, 0);
201}
202#endif /* CONFIG_SYS_REDUNDAND_ENVIRONMENT */
203
Robert P. J. Dayfc0b5942016-09-07 14:27:59 -0400204/* Export the environment and generate CRC for it. */
Marek Vasut7ce15262014-03-05 19:59:50 +0100205int env_export(env_t *env_out)
206{
207 char *res;
208 ssize_t len;
209
210 res = (char *)env_out->data;
211 len = hexport_r(&env_htab, '\0', 0, &res, ENV_SIZE, 0, NULL);
212 if (len < 0) {
Masahiro Yamada9b643e32017-09-16 14:10:41 +0900213 pr_err("Cannot export environment: errno = %d\n", errno);
Marek Vasut7ce15262014-03-05 19:59:50 +0100214 return 1;
215 }
Marek Vasuta4223b72014-03-05 19:59:51 +0100216
Marek Vasut7ce15262014-03-05 19:59:50 +0100217 env_out->crc = crc32(0, env_out->data, ENV_SIZE);
218
Fiach Antaw76768f52017-01-25 18:53:11 +1000219#ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
220 env_out->flags = ++env_flags; /* increase the serial */
221#endif
222
Marek Vasut7ce15262014-03-05 19:59:50 +0100223 return 0;
224}
225
Igor Grinberg27aafe92011-11-07 01:14:11 +0000226void env_relocate(void)
wdenk05706fd2002-09-28 17:48:27 +0000227{
Wolfgang Denk2e5167c2010-10-28 20:00:11 +0200228#if defined(CONFIG_NEEDS_MANUAL_RELOC)
Heiko Schocher60f7da12010-10-05 14:17:00 +0200229 env_reloc();
Siva Durga Prasad Paladugu7bcdf192018-04-13 07:57:21 +0200230 env_fix_drivers();
Patrick Delaunay7d477652019-04-18 17:32:49 +0200231
232 if (env_htab.change_ok)
233 env_htab.change_ok += gd->reloc_off;
Heiko Schocher60f7da12010-10-05 14:17:00 +0200234#endif
Simon Glass2d7cb5b2017-08-20 04:45:15 -0600235 if (gd->env_valid == ENV_INVALID) {
Ilya Yanok7ac2fe22012-09-18 00:22:50 +0000236#if defined(CONFIG_ENV_IS_NOWHERE) || defined(CONFIG_SPL_BUILD)
237 /* Environment not changable */
Yaniv Levinskyc5d548a2018-06-24 19:16:57 +0300238 set_default_env(NULL, 0);
wdenk05706fd2002-09-28 17:48:27 +0000239#else
Simon Glass770605e2012-02-13 13:51:18 +0000240 bootstage_error(BOOTSTAGE_ID_NET_CHECKSUM);
Yaniv Levinskyc5d548a2018-06-24 19:16:57 +0300241 set_default_env("bad CRC", 0);
Lei Wend2590792010-10-10 12:36:40 +0800242#endif
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200243 } else {
Simon Glass310fb142017-08-03 12:22:07 -0600244 env_load();
wdenk05706fd2002-09-28 17:48:27 +0000245 }
wdenk05706fd2002-09-28 17:48:27 +0000246}
wdenk04a85b32004-04-15 18:22:41 +0000247
Boris Brezillon03dcf172018-12-05 09:26:50 +0100248#ifdef CONFIG_AUTO_COMPLETE
249int env_complete(char *var, int maxv, char *cmdv[], int bufsz, char *buf,
250 bool dollar_comp)
wdenk04a85b32004-04-15 18:22:41 +0000251{
Mike Frysinger560d4242010-12-17 16:51:59 -0500252 ENTRY *match;
253 int found, idx;
wdenk04a85b32004-04-15 18:22:41 +0000254
Boris Brezillon03dcf172018-12-05 09:26:50 +0100255 if (dollar_comp) {
256 /*
257 * When doing $ completion, the first character should
258 * obviously be a '$'.
259 */
260 if (var[0] != '$')
261 return 0;
262
263 var++;
264
265 /*
266 * The second one, if present, should be a '{', as some
267 * configuration of the u-boot shell expand ${var} but not
268 * $var.
269 */
270 if (var[0] == '{')
271 var++;
272 else if (var[0] != '\0')
273 return 0;
274 }
275
Mike Frysinger560d4242010-12-17 16:51:59 -0500276 idx = 0;
wdenk04a85b32004-04-15 18:22:41 +0000277 found = 0;
278 cmdv[0] = NULL;
279
Boris Brezillon03dcf172018-12-05 09:26:50 +0100280
Mike Frysinger560d4242010-12-17 16:51:59 -0500281 while ((idx = hmatch_r(var, idx, &match, &env_htab))) {
282 int vallen = strlen(match->key) + 1;
wdenk04a85b32004-04-15 18:22:41 +0000283
Boris Brezillon03dcf172018-12-05 09:26:50 +0100284 if (found >= maxv - 2 ||
285 bufsz < vallen + (dollar_comp ? 3 : 0))
wdenk04a85b32004-04-15 18:22:41 +0000286 break;
Mike Frysinger560d4242010-12-17 16:51:59 -0500287
wdenk04a85b32004-04-15 18:22:41 +0000288 cmdv[found++] = buf;
Boris Brezillon03dcf172018-12-05 09:26:50 +0100289
290 /* Add the '${' prefix to each var when doing $ completion. */
291 if (dollar_comp) {
292 strcpy(buf, "${");
293 buf += 2;
294 bufsz -= 3;
295 }
296
Mike Frysinger560d4242010-12-17 16:51:59 -0500297 memcpy(buf, match->key, vallen);
298 buf += vallen;
299 bufsz -= vallen;
Boris Brezillon03dcf172018-12-05 09:26:50 +0100300
301 if (dollar_comp) {
302 /*
303 * This one is a bit odd: vallen already contains the
304 * '\0' character but we need to add the '}' suffix,
305 * hence the buf - 1 here. strcpy() will add the '\0'
306 * character just after '}'. buf is then incremented
307 * to account for the extra '}' we just added.
308 */
309 strcpy(buf - 1, "}");
310 buf++;
311 }
wdenk04a85b32004-04-15 18:22:41 +0000312 }
313
Mike Frysinger560d4242010-12-17 16:51:59 -0500314 qsort(cmdv, found, sizeof(cmdv[0]), strcmp_compar);
315
316 if (idx)
Boris Brezillon03dcf172018-12-05 09:26:50 +0100317 cmdv[found++] = dollar_comp ? "${...}" : "...";
Igor Grinberg27aafe92011-11-07 01:14:11 +0000318
wdenk04a85b32004-04-15 18:22:41 +0000319 cmdv[found] = NULL;
320 return found;
321}
322#endif