blob: 3317cef3552264cae2870df6ad1cedaa0096fb75 [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 = {
Joe Hershberger25980902012-12-11 22:16:31 -060026 .change_ok = env_flags_validate,
Gerlando Falautoc5983592012-08-24 00:11:39 +000027};
Mike Frysinger2eb15732010-12-08 06:26:04 -050028
Joe Hershbergerec8a2522012-12-11 22:16:22 -060029/*
30 * Read an environment variable as a boolean
31 * Return -1 if variable does not exist (default to true)
32 */
Simon Glassbfebc8c2017-08-03 12:22:13 -060033int env_get_yesno(const char *var)
Joe Hershbergerec8a2522012-12-11 22:16:22 -060034{
Simon Glass00caae62017-08-03 12:22:12 -060035 char *s = env_get(var);
Joe Hershbergerec8a2522012-12-11 22:16:22 -060036
37 if (s == NULL)
38 return -1;
39 return (*s == '1' || *s == 'y' || *s == 'Y' || *s == 't' || *s == 'T') ?
40 1 : 0;
41}
42
Joe Hershberger267541f2012-12-11 22:16:34 -060043/*
44 * Look up the variable from the default environment
45 */
Simon Glass723806c2017-08-03 12:22:15 -060046char *env_get_default(const char *name)
Joe Hershberger267541f2012-12-11 22:16:34 -060047{
48 char *ret_val;
49 unsigned long really_valid = gd->env_valid;
50 unsigned long real_gd_flags = gd->flags;
51
52 /* Pretend that the image is bad. */
53 gd->flags &= ~GD_FLG_ENV_READY;
Simon Glass2d7cb5b2017-08-20 04:45:15 -060054 gd->env_valid = ENV_INVALID;
Simon Glass00caae62017-08-03 12:22:12 -060055 ret_val = env_get(name);
Joe Hershberger267541f2012-12-11 22:16:34 -060056 gd->env_valid = really_valid;
57 gd->flags = real_gd_flags;
58 return ret_val;
59}
60
Yaniv Levinskyc5d548a2018-06-24 19:16:57 +030061void set_default_env(const char *s, int flags)
Harald Welte5bb12db2008-07-07 15:40:39 +080062{
63 if (sizeof(default_environment) > ENV_SIZE) {
Wolfgang Denkea882ba2010-06-20 23:33:59 +020064 puts("*** Error - default environment is too large\n\n");
Harald Welte5bb12db2008-07-07 15:40:39 +080065 return;
66 }
67
Wolfgang Denkea882ba2010-06-20 23:33:59 +020068 if (s) {
Yaniv Levinskyc5d548a2018-06-24 19:16:57 +030069 if ((flags & H_INTERACTIVE) == 0) {
Wolfgang Denkea882ba2010-06-20 23:33:59 +020070 printf("*** Warning - %s, "
Yaniv Levinskyc5d548a2018-06-24 19:16:57 +030071 "using default environment\n\n", s);
Wolfgang Denkea882ba2010-06-20 23:33:59 +020072 } else {
73 puts(s);
74 }
75 } else {
Maxime Ripard58ae9992018-01-23 21:16:57 +010076 debug("Using default environment\n");
Wolfgang Denkea882ba2010-06-20 23:33:59 +020077 }
78
Mike Frysinger2eb15732010-12-08 06:26:04 -050079 if (himport_r(&env_htab, (char *)default_environment,
Alexander Hollerecd14462014-07-14 17:49:55 +020080 sizeof(default_environment), '\0', flags, 0,
Joe Hershbergerc4e00572012-12-11 22:16:19 -060081 0, NULL) == 0)
Quentin Schulz6c90f622018-07-09 19:16:25 +020082 pr_err("## Error: Environment import failed: errno = %d\n",
83 errno);
Igor Grinberg27aafe92011-11-07 01:14:11 +000084
Wolfgang Denkea882ba2010-06-20 23:33:59 +020085 gd->flags |= GD_FLG_ENV_READY;
Michal Simek340b0e32016-05-30 16:06:54 +020086 gd->flags |= GD_FLG_ENV_DEFAULT;
Wolfgang Denkea882ba2010-06-20 23:33:59 +020087}
88
Gerlando Falautob64b7c32012-08-24 00:11:41 +000089
90/* [re]set individual variables to their value in the default environment */
Yaniv Levinsky477f8112018-06-24 19:16:55 +030091int set_default_vars(int nvars, char * const vars[], int flags)
Gerlando Falautob64b7c32012-08-24 00:11:41 +000092{
93 /*
94 * Special use-case: import from default environment
95 * (and use \0 as a separator)
96 */
Yaniv Levinsky5a042642018-06-24 19:16:56 +030097 flags |= H_NOCLEAR;
Gerlando Falautob64b7c32012-08-24 00:11:41 +000098 return himport_r(&env_htab, (const char *)default_environment,
Joe Hershbergerc4e00572012-12-11 22:16:19 -060099 sizeof(default_environment), '\0',
Yaniv Levinsky477f8112018-06-24 19:16:55 +0300100 flags, 0, nvars, vars);
Gerlando Falautob64b7c32012-08-24 00:11:41 +0000101}
102
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200103/*
104 * Check if CRC is valid and (if yes) import the environment.
105 * Note that "buf" may or may not be aligned.
106 */
107int env_import(const char *buf, int check)
108{
109 env_t *ep = (env_t *)buf;
110
111 if (check) {
112 uint32_t crc;
113
114 memcpy(&crc, &ep->crc, sizeof(crc));
115
116 if (crc32(0, ep->data, ENV_SIZE) != crc) {
Yaniv Levinskyc5d548a2018-06-24 19:16:57 +0300117 set_default_env("bad CRC", 0);
Simon Goldschmidt42a18202018-01-31 14:47:10 +0100118 return -EIO;
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200119 }
120 }
121
Alexander Hollerecd14462014-07-14 17:49:55 +0200122 if (himport_r(&env_htab, (char *)ep->data, ENV_SIZE, '\0', 0, 0,
Joe Hershbergerc4e00572012-12-11 22:16:19 -0600123 0, NULL)) {
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200124 gd->flags |= GD_FLG_ENV_READY;
Simon Goldschmidt42a18202018-01-31 14:47:10 +0100125 return 0;
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200126 }
127
Masahiro Yamada9b643e32017-09-16 14:10:41 +0900128 pr_err("Cannot import environment: errno = %d\n", errno);
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200129
Yaniv Levinskyc5d548a2018-06-24 19:16:57 +0300130 set_default_env("import failed", 0);
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200131
Simon Goldschmidt42a18202018-01-31 14:47:10 +0100132 return -EIO;
Harald Welte5bb12db2008-07-07 15:40:39 +0800133}
134
Fiach Antaw76768f52017-01-25 18:53:11 +1000135#ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
136static unsigned char env_flags;
137
Simon Goldschmidt31f044b2018-01-31 14:47:11 +0100138int env_import_redund(const char *buf1, int buf1_read_fail,
139 const char *buf2, int buf2_read_fail)
Fiach Antaw76768f52017-01-25 18:53:11 +1000140{
141 int crc1_ok, crc2_ok;
142 env_t *ep, *tmp_env1, *tmp_env2;
143
144 tmp_env1 = (env_t *)buf1;
145 tmp_env2 = (env_t *)buf2;
146
Simon Goldschmidt31f044b2018-01-31 14:47:11 +0100147 if (buf1_read_fail && buf2_read_fail) {
148 puts("*** Error - No Valid Environment Area found\n");
149 } else if (buf1_read_fail || buf2_read_fail) {
150 puts("*** Warning - some problems detected ");
151 puts("reading environment; recovered successfully\n");
152 }
153
154 if (buf1_read_fail && buf2_read_fail) {
Yaniv Levinskyc5d548a2018-06-24 19:16:57 +0300155 set_default_env("bad env area", 0);
Simon Goldschmidt31f044b2018-01-31 14:47:11 +0100156 return -EIO;
157 } else if (!buf1_read_fail && buf2_read_fail) {
158 gd->env_valid = ENV_VALID;
159 return env_import((char *)tmp_env1, 1);
160 } else if (buf1_read_fail && !buf2_read_fail) {
161 gd->env_valid = ENV_REDUND;
162 return env_import((char *)tmp_env2, 1);
163 }
164
Fiach Antaw76768f52017-01-25 18:53:11 +1000165 crc1_ok = crc32(0, tmp_env1->data, ENV_SIZE) ==
166 tmp_env1->crc;
167 crc2_ok = crc32(0, tmp_env2->data, ENV_SIZE) ==
168 tmp_env2->crc;
169
170 if (!crc1_ok && !crc2_ok) {
Yaniv Levinskyc5d548a2018-06-24 19:16:57 +0300171 set_default_env("bad CRC", 0);
Simon Goldschmidt42a18202018-01-31 14:47:10 +0100172 return -EIO;
Fiach Antaw76768f52017-01-25 18:53:11 +1000173 } else if (crc1_ok && !crc2_ok) {
Simon Glass2d7cb5b2017-08-20 04:45:15 -0600174 gd->env_valid = ENV_VALID;
Fiach Antaw76768f52017-01-25 18:53:11 +1000175 } else if (!crc1_ok && crc2_ok) {
Simon Glass2d7cb5b2017-08-20 04:45:15 -0600176 gd->env_valid = ENV_REDUND;
Fiach Antaw76768f52017-01-25 18:53:11 +1000177 } else {
178 /* both ok - check serial */
179 if (tmp_env1->flags == 255 && tmp_env2->flags == 0)
Simon Glass2d7cb5b2017-08-20 04:45:15 -0600180 gd->env_valid = ENV_REDUND;
Fiach Antaw76768f52017-01-25 18:53:11 +1000181 else if (tmp_env2->flags == 255 && tmp_env1->flags == 0)
Simon Glass2d7cb5b2017-08-20 04:45:15 -0600182 gd->env_valid = ENV_VALID;
Fiach Antaw76768f52017-01-25 18:53:11 +1000183 else if (tmp_env1->flags > tmp_env2->flags)
Simon Glass2d7cb5b2017-08-20 04:45:15 -0600184 gd->env_valid = ENV_VALID;
Fiach Antaw76768f52017-01-25 18:53:11 +1000185 else if (tmp_env2->flags > tmp_env1->flags)
Simon Glass2d7cb5b2017-08-20 04:45:15 -0600186 gd->env_valid = ENV_REDUND;
Fiach Antaw76768f52017-01-25 18:53:11 +1000187 else /* flags are equal - almost impossible */
Simon Glass2d7cb5b2017-08-20 04:45:15 -0600188 gd->env_valid = ENV_VALID;
Fiach Antaw76768f52017-01-25 18:53:11 +1000189 }
190
Simon Glass2d7cb5b2017-08-20 04:45:15 -0600191 if (gd->env_valid == ENV_VALID)
Fiach Antaw76768f52017-01-25 18:53:11 +1000192 ep = tmp_env1;
193 else
194 ep = tmp_env2;
195
196 env_flags = ep->flags;
197 return env_import((char *)ep, 0);
198}
199#endif /* CONFIG_SYS_REDUNDAND_ENVIRONMENT */
200
Robert P. J. Dayfc0b5942016-09-07 14:27:59 -0400201/* Export the environment and generate CRC for it. */
Marek Vasut7ce15262014-03-05 19:59:50 +0100202int env_export(env_t *env_out)
203{
204 char *res;
205 ssize_t len;
206
207 res = (char *)env_out->data;
208 len = hexport_r(&env_htab, '\0', 0, &res, ENV_SIZE, 0, NULL);
209 if (len < 0) {
Masahiro Yamada9b643e32017-09-16 14:10:41 +0900210 pr_err("Cannot export environment: errno = %d\n", errno);
Marek Vasut7ce15262014-03-05 19:59:50 +0100211 return 1;
212 }
Marek Vasuta4223b72014-03-05 19:59:51 +0100213
Marek Vasut7ce15262014-03-05 19:59:50 +0100214 env_out->crc = crc32(0, env_out->data, ENV_SIZE);
215
Fiach Antaw76768f52017-01-25 18:53:11 +1000216#ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
217 env_out->flags = ++env_flags; /* increase the serial */
218#endif
219
Marek Vasut7ce15262014-03-05 19:59:50 +0100220 return 0;
221}
222
Igor Grinberg27aafe92011-11-07 01:14:11 +0000223void env_relocate(void)
wdenk05706fd2002-09-28 17:48:27 +0000224{
Wolfgang Denk2e5167c2010-10-28 20:00:11 +0200225#if defined(CONFIG_NEEDS_MANUAL_RELOC)
Heiko Schocher60f7da12010-10-05 14:17:00 +0200226 env_reloc();
Siva Durga Prasad Paladugu7bcdf192018-04-13 07:57:21 +0200227 env_fix_drivers();
Joe Hershberger7afcf3a2012-12-11 22:16:21 -0600228 env_htab.change_ok += gd->reloc_off;
Heiko Schocher60f7da12010-10-05 14:17:00 +0200229#endif
Simon Glass2d7cb5b2017-08-20 04:45:15 -0600230 if (gd->env_valid == ENV_INVALID) {
Ilya Yanok7ac2fe22012-09-18 00:22:50 +0000231#if defined(CONFIG_ENV_IS_NOWHERE) || defined(CONFIG_SPL_BUILD)
232 /* Environment not changable */
Yaniv Levinskyc5d548a2018-06-24 19:16:57 +0300233 set_default_env(NULL, 0);
wdenk05706fd2002-09-28 17:48:27 +0000234#else
Simon Glass770605e2012-02-13 13:51:18 +0000235 bootstage_error(BOOTSTAGE_ID_NET_CHECKSUM);
Yaniv Levinskyc5d548a2018-06-24 19:16:57 +0300236 set_default_env("bad CRC", 0);
Lei Wend2590792010-10-10 12:36:40 +0800237#endif
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200238 } else {
Simon Glass310fb142017-08-03 12:22:07 -0600239 env_load();
wdenk05706fd2002-09-28 17:48:27 +0000240 }
wdenk05706fd2002-09-28 17:48:27 +0000241}
wdenk04a85b32004-04-15 18:22:41 +0000242
Ilya Yanok7ac2fe22012-09-18 00:22:50 +0000243#if defined(CONFIG_AUTO_COMPLETE) && !defined(CONFIG_SPL_BUILD)
wdenk04a85b32004-04-15 18:22:41 +0000244int env_complete(char *var, int maxv, char *cmdv[], int bufsz, char *buf)
245{
Mike Frysinger560d4242010-12-17 16:51:59 -0500246 ENTRY *match;
247 int found, idx;
wdenk04a85b32004-04-15 18:22:41 +0000248
Mike Frysinger560d4242010-12-17 16:51:59 -0500249 idx = 0;
wdenk04a85b32004-04-15 18:22:41 +0000250 found = 0;
251 cmdv[0] = NULL;
252
Mike Frysinger560d4242010-12-17 16:51:59 -0500253 while ((idx = hmatch_r(var, idx, &match, &env_htab))) {
254 int vallen = strlen(match->key) + 1;
wdenk04a85b32004-04-15 18:22:41 +0000255
Mike Frysinger560d4242010-12-17 16:51:59 -0500256 if (found >= maxv - 2 || bufsz < vallen)
wdenk04a85b32004-04-15 18:22:41 +0000257 break;
Mike Frysinger560d4242010-12-17 16:51:59 -0500258
wdenk04a85b32004-04-15 18:22:41 +0000259 cmdv[found++] = buf;
Mike Frysinger560d4242010-12-17 16:51:59 -0500260 memcpy(buf, match->key, vallen);
261 buf += vallen;
262 bufsz -= vallen;
wdenk04a85b32004-04-15 18:22:41 +0000263 }
264
Mike Frysinger560d4242010-12-17 16:51:59 -0500265 qsort(cmdv, found, sizeof(cmdv[0]), strcmp_compar);
266
267 if (idx)
268 cmdv[found++] = "...";
Igor Grinberg27aafe92011-11-07 01:14:11 +0000269
wdenk04a85b32004-04-15 18:22:41 +0000270 cmdv[found] = NULL;
271 return found;
272}
273#endif