blob: cd7b4cd1dfb7c3a59bfad6f1ae6c5fe5bb07dd8f [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
Igor Grinbergbf95df42011-12-26 03:33:10 +000030static uchar __env_get_char_spec(int index)
31{
32 return *((uchar *)(gd->env_addr + index));
33}
34uchar env_get_char_spec(int)
35 __attribute__((weak, alias("__env_get_char_spec")));
36
Igor Grinberg27aafe92011-11-07 01:14:11 +000037static uchar env_get_char_init(int index)
wdenk05706fd2002-09-28 17:48:27 +000038{
wdenk05706fd2002-09-28 17:48:27 +000039 /* if crc was bad, use the default environment */
40 if (gd->env_valid)
Igor Grinberg27aafe92011-11-07 01:14:11 +000041 return env_get_char_spec(index);
Wolfgang Denkea882ba2010-06-20 23:33:59 +020042 else
Igor Grinberg27aafe92011-11-07 01:14:11 +000043 return default_environment[index];
wdenk05706fd2002-09-28 17:48:27 +000044}
45
Igor Grinberg27aafe92011-11-07 01:14:11 +000046uchar env_get_char_memory(int index)
wdenk05706fd2002-09-28 17:48:27 +000047{
Wolfgang Denkea882ba2010-06-20 23:33:59 +020048 return *env_get_addr(index);
wdenk05706fd2002-09-28 17:48:27 +000049}
50
Igor Grinberg27aafe92011-11-07 01:14:11 +000051uchar env_get_char(int index)
Joakim Tjernlundb5026112008-07-06 12:30:09 +020052{
Joakim Tjernlundb5026112008-07-06 12:30:09 +020053 /* if relocated to RAM */
54 if (gd->flags & GD_FLG_RELOC)
Igor Grinberg27aafe92011-11-07 01:14:11 +000055 return env_get_char_memory(index);
Joakim Tjernlundb5026112008-07-06 12:30:09 +020056 else
Igor Grinberg27aafe92011-11-07 01:14:11 +000057 return env_get_char_init(index);
Joakim Tjernlundb5026112008-07-06 12:30:09 +020058}
59
Igor Grinberg27aafe92011-11-07 01:14:11 +000060const uchar *env_get_addr(int index)
wdenk05706fd2002-09-28 17:48:27 +000061{
Wolfgang Denkea882ba2010-06-20 23:33:59 +020062 if (gd->env_valid)
63 return (uchar *)(gd->env_addr + index);
64 else
65 return &default_environment[index];
wdenk05706fd2002-09-28 17:48:27 +000066}
67
Joe Hershbergerec8a2522012-12-11 22:16:22 -060068/*
69 * Read an environment variable as a boolean
70 * Return -1 if variable does not exist (default to true)
71 */
72int getenv_yesno(const char *var)
73{
74 char *s = getenv(var);
75
76 if (s == NULL)
77 return -1;
78 return (*s == '1' || *s == 'y' || *s == 'Y' || *s == 't' || *s == 'T') ?
79 1 : 0;
80}
81
Joe Hershberger267541f2012-12-11 22:16:34 -060082/*
83 * Look up the variable from the default environment
84 */
85char *getenv_default(const char *name)
86{
87 char *ret_val;
88 unsigned long really_valid = gd->env_valid;
89 unsigned long real_gd_flags = gd->flags;
90
91 /* Pretend that the image is bad. */
92 gd->flags &= ~GD_FLG_ENV_READY;
93 gd->env_valid = 0;
94 ret_val = getenv(name);
95 gd->env_valid = really_valid;
96 gd->flags = real_gd_flags;
97 return ret_val;
98}
99
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200100void set_default_env(const char *s)
Harald Welte5bb12db2008-07-07 15:40:39 +0800101{
Joe Hershbergerc4e00572012-12-11 22:16:19 -0600102 int flags = 0;
103
Harald Welte5bb12db2008-07-07 15:40:39 +0800104 if (sizeof(default_environment) > ENV_SIZE) {
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200105 puts("*** Error - default environment is too large\n\n");
Harald Welte5bb12db2008-07-07 15:40:39 +0800106 return;
107 }
108
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200109 if (s) {
110 if (*s == '!') {
111 printf("*** Warning - %s, "
112 "using default environment\n\n",
Igor Grinberg27aafe92011-11-07 01:14:11 +0000113 s + 1);
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200114 } else {
Joe Hershbergerc4e00572012-12-11 22:16:19 -0600115 flags = H_INTERACTIVE;
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200116 puts(s);
117 }
118 } else {
119 puts("Using default environment\n\n");
120 }
121
Mike Frysinger2eb15732010-12-08 06:26:04 -0500122 if (himport_r(&env_htab, (char *)default_environment,
Joe Hershbergerc4e00572012-12-11 22:16:19 -0600123 sizeof(default_environment), '\0', flags,
124 0, NULL) == 0)
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200125 error("Environment import failed: errno = %d\n", errno);
Igor Grinberg27aafe92011-11-07 01:14:11 +0000126
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200127 gd->flags |= GD_FLG_ENV_READY;
128}
129
Gerlando Falautob64b7c32012-08-24 00:11:41 +0000130
131/* [re]set individual variables to their value in the default environment */
132int set_default_vars(int nvars, char * const vars[])
133{
134 /*
135 * Special use-case: import from default environment
136 * (and use \0 as a separator)
137 */
138 return himport_r(&env_htab, (const char *)default_environment,
Joe Hershbergerc4e00572012-12-11 22:16:19 -0600139 sizeof(default_environment), '\0',
140 H_NOCLEAR | H_INTERACTIVE, nvars, vars);
Gerlando Falautob64b7c32012-08-24 00:11:41 +0000141}
142
Marek Vasuta4223b72014-03-05 19:59:51 +0100143#ifdef CONFIG_ENV_AES
144#include <aes.h>
145/**
146 * env_aes_cbc_get_key() - Get AES-128-CBC key for the environment
147 *
148 * This function shall return 16-byte array containing AES-128 key used
149 * to encrypt and decrypt the environment. This function must be overriden
150 * by the implementer as otherwise the environment encryption will not
151 * work.
152 */
153__weak uint8_t *env_aes_cbc_get_key(void)
154{
155 return NULL;
156}
157
158static int env_aes_cbc_crypt(env_t *env, const int enc)
159{
160 unsigned char *data = env->data;
161 uint8_t *key;
162 uint8_t key_exp[AES_EXPAND_KEY_LENGTH];
163 uint32_t aes_blocks;
164
165 key = env_aes_cbc_get_key();
166 if (!key)
167 return -EINVAL;
168
169 /* First we expand the key. */
170 aes_expand_key(key, key_exp);
171
172 /* Calculate the number of AES blocks to encrypt. */
173 aes_blocks = ENV_SIZE / AES_KEY_LENGTH;
174
175 if (enc)
176 aes_cbc_encrypt_blocks(key_exp, data, data, aes_blocks);
177 else
178 aes_cbc_decrypt_blocks(key_exp, data, data, aes_blocks);
179
180 return 0;
181}
182#else
183static inline int env_aes_cbc_crypt(env_t *env, const int enc)
184{
185 return 0;
186}
187#endif
188
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200189/*
190 * Check if CRC is valid and (if yes) import the environment.
191 * Note that "buf" may or may not be aligned.
192 */
193int env_import(const char *buf, int check)
194{
195 env_t *ep = (env_t *)buf;
Marek Vasuta4223b72014-03-05 19:59:51 +0100196 int ret;
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200197
198 if (check) {
199 uint32_t crc;
200
201 memcpy(&crc, &ep->crc, sizeof(crc));
202
203 if (crc32(0, ep->data, ENV_SIZE) != crc) {
204 set_default_env("!bad CRC");
205 return 0;
206 }
207 }
208
Marek Vasuta4223b72014-03-05 19:59:51 +0100209 /* Decrypt the env if desired. */
210 ret = env_aes_cbc_crypt(ep, 0);
211 if (ret) {
212 error("Failed to decrypt env!\n");
213 set_default_env("!import failed");
214 return ret;
215 }
216
Gerlando Falauto348b1f12012-08-24 00:11:38 +0000217 if (himport_r(&env_htab, (char *)ep->data, ENV_SIZE, '\0', 0,
Joe Hershbergerc4e00572012-12-11 22:16:19 -0600218 0, NULL)) {
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200219 gd->flags |= GD_FLG_ENV_READY;
220 return 1;
221 }
222
223 error("Cannot import environment: errno = %d\n", errno);
224
225 set_default_env("!import failed");
226
227 return 0;
Harald Welte5bb12db2008-07-07 15:40:39 +0800228}
229
Marek Vasut7ce15262014-03-05 19:59:50 +0100230/* Emport the environment and generate CRC for it. */
231int env_export(env_t *env_out)
232{
233 char *res;
234 ssize_t len;
Marek Vasuta4223b72014-03-05 19:59:51 +0100235 int ret;
Marek Vasut7ce15262014-03-05 19:59:50 +0100236
237 res = (char *)env_out->data;
238 len = hexport_r(&env_htab, '\0', 0, &res, ENV_SIZE, 0, NULL);
239 if (len < 0) {
240 error("Cannot export environment: errno = %d\n", errno);
241 return 1;
242 }
Marek Vasuta4223b72014-03-05 19:59:51 +0100243
244 /* Encrypt the env if desired. */
245 ret = env_aes_cbc_crypt(env_out, 1);
246 if (ret)
247 return ret;
248
Marek Vasut7ce15262014-03-05 19:59:50 +0100249 env_out->crc = crc32(0, env_out->data, ENV_SIZE);
250
251 return 0;
252}
253
Igor Grinberg27aafe92011-11-07 01:14:11 +0000254void env_relocate(void)
wdenk05706fd2002-09-28 17:48:27 +0000255{
Wolfgang Denk2e5167c2010-10-28 20:00:11 +0200256#if defined(CONFIG_NEEDS_MANUAL_RELOC)
Heiko Schocher60f7da12010-10-05 14:17:00 +0200257 env_reloc();
Joe Hershberger7afcf3a2012-12-11 22:16:21 -0600258 env_htab.change_ok += gd->reloc_off;
Heiko Schocher60f7da12010-10-05 14:17:00 +0200259#endif
wdenk05706fd2002-09-28 17:48:27 +0000260 if (gd->env_valid == 0) {
Ilya Yanok7ac2fe22012-09-18 00:22:50 +0000261#if defined(CONFIG_ENV_IS_NOWHERE) || defined(CONFIG_SPL_BUILD)
262 /* Environment not changable */
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200263 set_default_env(NULL);
wdenk05706fd2002-09-28 17:48:27 +0000264#else
Simon Glass770605e2012-02-13 13:51:18 +0000265 bootstage_error(BOOTSTAGE_ID_NET_CHECKSUM);
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200266 set_default_env("!bad CRC");
Lei Wend2590792010-10-10 12:36:40 +0800267#endif
Wolfgang Denkea882ba2010-06-20 23:33:59 +0200268 } else {
Igor Grinberg27aafe92011-11-07 01:14:11 +0000269 env_relocate_spec();
wdenk05706fd2002-09-28 17:48:27 +0000270 }
wdenk05706fd2002-09-28 17:48:27 +0000271}
wdenk04a85b32004-04-15 18:22:41 +0000272
Ilya Yanok7ac2fe22012-09-18 00:22:50 +0000273#if defined(CONFIG_AUTO_COMPLETE) && !defined(CONFIG_SPL_BUILD)
wdenk04a85b32004-04-15 18:22:41 +0000274int env_complete(char *var, int maxv, char *cmdv[], int bufsz, char *buf)
275{
Mike Frysinger560d4242010-12-17 16:51:59 -0500276 ENTRY *match;
277 int found, idx;
wdenk04a85b32004-04-15 18:22:41 +0000278
Mike Frysinger560d4242010-12-17 16:51:59 -0500279 idx = 0;
wdenk04a85b32004-04-15 18:22:41 +0000280 found = 0;
281 cmdv[0] = NULL;
282
Mike Frysinger560d4242010-12-17 16:51:59 -0500283 while ((idx = hmatch_r(var, idx, &match, &env_htab))) {
284 int vallen = strlen(match->key) + 1;
wdenk04a85b32004-04-15 18:22:41 +0000285
Mike Frysinger560d4242010-12-17 16:51:59 -0500286 if (found >= maxv - 2 || bufsz < vallen)
wdenk04a85b32004-04-15 18:22:41 +0000287 break;
Mike Frysinger560d4242010-12-17 16:51:59 -0500288
wdenk04a85b32004-04-15 18:22:41 +0000289 cmdv[found++] = buf;
Mike Frysinger560d4242010-12-17 16:51:59 -0500290 memcpy(buf, match->key, vallen);
291 buf += vallen;
292 bufsz -= vallen;
wdenk04a85b32004-04-15 18:22:41 +0000293 }
294
Mike Frysinger560d4242010-12-17 16:51:59 -0500295 qsort(cmdv, found, sizeof(cmdv[0]), strcmp_compar);
296
297 if (idx)
298 cmdv[found++] = "...";
Igor Grinberg27aafe92011-11-07 01:14:11 +0000299
wdenk04a85b32004-04-15 18:22:41 +0000300 cmdv[found] = NULL;
301 return found;
302}
303#endif