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 debug("Using default environment\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);
107 * Check if CRC is valid and (if yes) import the environment.
108 * Note that "buf" may or may not be aligned.
110 int env_import(const char *buf, int check)
112 env_t *ep = (env_t *)buf;
117 memcpy(&crc, &ep->crc, sizeof(crc));
119 if (crc32(0, ep->data, ENV_SIZE) != crc) {
120 set_default_env("!bad CRC");
125 if (himport_r(&env_htab, (char *)ep->data, ENV_SIZE, '\0', 0, 0,
127 gd->flags |= GD_FLG_ENV_READY;
131 pr_err("Cannot import environment: errno = %d\n", errno);
133 set_default_env("!import failed");
138 #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
139 static unsigned char env_flags;
141 int env_import_redund(const char *buf1, int buf1_read_fail,
142 const char *buf2, int buf2_read_fail)
144 int crc1_ok, crc2_ok;
145 env_t *ep, *tmp_env1, *tmp_env2;
147 tmp_env1 = (env_t *)buf1;
148 tmp_env2 = (env_t *)buf2;
150 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");
157 if (buf1_read_fail && buf2_read_fail) {
158 set_default_env("!bad env area");
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);
168 crc1_ok = crc32(0, tmp_env1->data, ENV_SIZE) ==
170 crc2_ok = crc32(0, tmp_env2->data, ENV_SIZE) ==
173 if (!crc1_ok && !crc2_ok) {
174 set_default_env("!bad CRC");
176 } else if (crc1_ok && !crc2_ok) {
177 gd->env_valid = ENV_VALID;
178 } else if (!crc1_ok && crc2_ok) {
179 gd->env_valid = ENV_REDUND;
181 /* both ok - check serial */
182 if (tmp_env1->flags == 255 && tmp_env2->flags == 0)
183 gd->env_valid = ENV_REDUND;
184 else if (tmp_env2->flags == 255 && tmp_env1->flags == 0)
185 gd->env_valid = ENV_VALID;
186 else if (tmp_env1->flags > tmp_env2->flags)
187 gd->env_valid = ENV_VALID;
188 else if (tmp_env2->flags > tmp_env1->flags)
189 gd->env_valid = ENV_REDUND;
190 else /* flags are equal - almost impossible */
191 gd->env_valid = ENV_VALID;
194 if (gd->env_valid == ENV_VALID)
199 env_flags = ep->flags;
200 return env_import((char *)ep, 0);
202 #endif /* CONFIG_SYS_REDUNDAND_ENVIRONMENT */
204 /* Export the environment and generate CRC for it. */
205 int env_export(env_t *env_out)
210 res = (char *)env_out->data;
211 len = hexport_r(&env_htab, '\0', 0, &res, ENV_SIZE, 0, NULL);
213 pr_err("Cannot export environment: errno = %d\n", errno);
217 env_out->crc = crc32(0, env_out->data, ENV_SIZE);
219 #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
220 env_out->flags = ++env_flags; /* increase the serial */
226 void env_relocate(void)
228 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
230 env_htab.change_ok += gd->reloc_off;
232 if (gd->env_valid == ENV_INVALID) {
233 #if defined(CONFIG_ENV_IS_NOWHERE) || defined(CONFIG_SPL_BUILD)
234 /* Environment not changable */
235 set_default_env(NULL);
237 bootstage_error(BOOTSTAGE_ID_NET_CHECKSUM);
238 set_default_env("!bad CRC");
245 #if defined(CONFIG_AUTO_COMPLETE) && !defined(CONFIG_SPL_BUILD)
246 int env_complete(char *var, int maxv, char *cmdv[], int bufsz, char *buf)
255 while ((idx = hmatch_r(var, idx, &match, &env_htab))) {
256 int vallen = strlen(match->key) + 1;
258 if (found >= maxv - 2 || bufsz < vallen)
262 memcpy(buf, match->key, vallen);
267 qsort(cmdv, found, sizeof(cmdv[0]), strcmp_compar);
270 cmdv[found++] = "...";