]> git.ipfire.org Git - people/ms/u-boot.git/blame - common/cmd_nvedit.c
Merge branch 'buildman' of git://git.denx.de/u-boot-x86
[people/ms/u-boot.git] / common / cmd_nvedit.c
CommitLineData
a68d3ed0 1/*
ea009d47 2 * (C) Copyright 2000-2013
a68d3ed0
WD
3 * 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>
a000b795
KP
7 *
8 * Copyright 2011 Freescale Semiconductor, Inc.
9 *
3765b3e7 10 * SPDX-License-Identifier: GPL-2.0+
a68d3ed0
WD
11 */
12
ea882baf 13/*
a68d3ed0
WD
14 * Support for persistent environment data
15 *
ea882baf
WD
16 * The "environment" is stored on external storage as a list of '\0'
17 * terminated "name=value" strings. The end of the list is marked by
18 * a double '\0'. The environment is preceeded by a 32 bit CRC over
19 * the data part and, in case of redundant environment, a byte of
20 * flags.
a68d3ed0 21 *
ea882baf
WD
22 * This linearized representation will also be used before
23 * relocation, i. e. as long as we don't have a full C runtime
24 * environment. After that, we use a hash table.
a68d3ed0
WD
25 */
26
27#include <common.h>
28#include <command.h>
29#include <environment.h>
ea882baf
WD
30#include <search.h>
31#include <errno.h>
246c6922 32#include <malloc.h>
2a3cb020 33#include <watchdog.h>
a68d3ed0
WD
34#include <linux/stddef.h>
35#include <asm/byteorder.h>
a68d3ed0 36
d87080b7
WD
37DECLARE_GLOBAL_DATA_PTR;
38
f3c615b8
ML
39#if !defined(CONFIG_ENV_IS_IN_EEPROM) && \
40 !defined(CONFIG_ENV_IS_IN_FLASH) && \
41 !defined(CONFIG_ENV_IS_IN_DATAFLASH) && \
f3c615b8 42 !defined(CONFIG_ENV_IS_IN_MMC) && \
57210c7c 43 !defined(CONFIG_ENV_IS_IN_FAT) && \
f3c615b8
ML
44 !defined(CONFIG_ENV_IS_IN_NAND) && \
45 !defined(CONFIG_ENV_IS_IN_NVRAM) && \
46 !defined(CONFIG_ENV_IS_IN_ONENAND) && \
47 !defined(CONFIG_ENV_IS_IN_SPI_FLASH) && \
0a85a9e7 48 !defined(CONFIG_ENV_IS_IN_REMOTE) && \
2b74433f 49 !defined(CONFIG_ENV_IS_IN_UBI) && \
f3c615b8 50 !defined(CONFIG_ENV_IS_NOWHERE)
75eb82ec 51# error Define one of CONFIG_ENV_IS_IN_{EEPROM|FLASH|DATAFLASH|ONENAND|\
2b74433f 52SPI_FLASH|NVRAM|MMC|FAT|REMOTE|UBI} or CONFIG_ENV_IS_NOWHERE
a68d3ed0
WD
53#endif
54
ea882baf
WD
55/*
56 * Maximum expected input data size for import command
57 */
58#define MAX_ENV_SIZE (1 << 20) /* 1 MiB */
a68d3ed0 59
da95427c 60/*
ea882baf 61 * This variable is incremented on each do_env_set(), so it can
da95427c
HS
62 * be used via get_env_id() as an indication, if the environment
63 * has changed or not. So it is possible to reread an environment
64 * variable only if the environment was changed ... done so for
65 * example in NetInitLoop()
66 */
2f70c49e 67static int env_id = 1;
a68d3ed0 68
f3c615b8 69int get_env_id(void)
2f70c49e
HS
70{
71 return env_id;
72}
a68d3ed0 73
7ac2fe2d 74#ifndef CONFIG_SPL_BUILD
4c94f6c5 75/*
ea882baf
WD
76 * Command interface: print one or all environment variables
77 *
78 * Returns 0 in case of error, or length of printed string
4c94f6c5 79 */
be11235a 80static int env_print(char *name, int flag)
a68d3ed0 81{
ea882baf 82 char *res = NULL;
22a4a6c5 83 ssize_t len;
ea882baf
WD
84
85 if (name) { /* print a single name */
86 ENTRY e, *ep;
87
88 e.key = name;
89 e.data = NULL;
be11235a 90 hsearch_r(e, FIND, &ep, &env_htab, flag);
ea882baf
WD
91 if (ep == NULL)
92 return 0;
f3c615b8 93 len = printf("%s=%s\n", ep->key, ep->data);
ea882baf
WD
94 return len;
95 }
a68d3ed0 96
ea882baf 97 /* print whole list */
be11235a 98 len = hexport_r(&env_htab, '\n', flag, &res, 0, 0, NULL);
a68d3ed0 99
ea882baf
WD
100 if (len > 0) {
101 puts(res);
102 free(res);
103 return len;
a68d3ed0
WD
104 }
105
ea882baf 106 /* should never happen */
22a4a6c5 107 printf("## Error: cannot export environment\n");
ea882baf 108 return 0;
4c94f6c5 109}
a68d3ed0 110
088f1b19
KP
111static int do_env_print(cmd_tbl_t *cmdtp, int flag, int argc,
112 char * const argv[])
4c94f6c5
MF
113{
114 int i;
115 int rcode = 0;
be11235a
JH
116 int env_flag = H_HIDE_DOT;
117
118 if (argc > 1 && argv[1][0] == '-' && argv[1][1] == 'a') {
119 argc--;
120 argv++;
121 env_flag &= ~H_HIDE_DOT;
122 }
a68d3ed0 123
4c94f6c5
MF
124 if (argc == 1) {
125 /* print all env vars */
be11235a 126 rcode = env_print(NULL, env_flag);
ea882baf 127 if (!rcode)
4c94f6c5
MF
128 return 1;
129 printf("\nEnvironment size: %d/%ld bytes\n",
130 rcode, (ulong)ENV_SIZE);
131 return 0;
132 }
a68d3ed0 133
4c94f6c5 134 /* print selected env vars */
be11235a 135 env_flag &= ~H_HIDE_DOT;
4c94f6c5 136 for (i = 1; i < argc; ++i) {
be11235a 137 int rc = env_print(argv[i], env_flag);
ea882baf
WD
138 if (!rc) {
139 printf("## Error: \"%s\" not defined\n", argv[i]);
4c94f6c5 140 ++rcode;
a68d3ed0
WD
141 }
142 }
4c94f6c5 143
a68d3ed0
WD
144 return rcode;
145}
146
a000b795 147#ifdef CONFIG_CMD_GREPENV
d09b1787
IG
148static int do_env_grep(cmd_tbl_t *cmdtp, int flag,
149 int argc, char * const argv[])
a000b795 150{
5a31ea04 151 char *res = NULL;
be29df6a 152 int len, grep_how, grep_what;
a000b795
KP
153
154 if (argc < 2)
4c12eeb8 155 return CMD_RET_USAGE;
a000b795 156
be29df6a
WD
157 grep_how = H_MATCH_SUBSTR; /* default: substring search */
158 grep_what = H_MATCH_BOTH; /* default: grep names and values */
d87244d5
WD
159
160 while (argc > 1 && **(argv + 1) == '-') {
161 char *arg = *++argv;
162
163 --argc;
164 while (*++arg) {
165 switch (*arg) {
be29df6a
WD
166#ifdef CONFIG_REGEX
167 case 'e': /* use regex matching */
168 grep_how = H_MATCH_REGEX;
169 break;
170#endif
d87244d5 171 case 'n': /* grep for name */
be29df6a 172 grep_what = H_MATCH_KEY;
d87244d5
WD
173 break;
174 case 'v': /* grep for value */
be29df6a 175 grep_what = H_MATCH_DATA;
d87244d5
WD
176 break;
177 case 'b': /* grep for both */
be29df6a 178 grep_what = H_MATCH_BOTH;
d87244d5
WD
179 break;
180 case '-':
181 goto DONE;
182 default:
183 return CMD_RET_USAGE;
184 }
185 }
186 }
187
188DONE:
5a31ea04 189 len = hexport_r(&env_htab, '\n',
be29df6a 190 flag | grep_what | grep_how,
5a31ea04 191 &res, 0, argc, argv);
a000b795 192
5a31ea04
WD
193 if (len > 0) {
194 puts(res);
195 free(res);
a000b795
KP
196 }
197
5a31ea04
WD
198 if (len < 2)
199 return 1;
200
201 return 0;
a000b795
KP
202}
203#endif
7ac2fe2d 204#endif /* CONFIG_SPL_BUILD */
a000b795 205
c3f65258
GF
206/*
207 * Set a new environment variable,
208 * or replace or delete an existing one.
2598090b 209 */
088f1b19 210static int _do_env_set(int flag, int argc, char * const argv[])
c3f65258
GF
211{
212 int i, len;
213 char *name, *value, *s;
214 ENTRY e, *ep;
24ab5a19 215 int env_flag = H_INTERACTIVE;
c3f65258 216
24ab5a19
JH
217 debug("Initial value for argc=%d\n", argc);
218 while (argc > 1 && **(argv + 1) == '-') {
219 char *arg = *++argv;
220
221 --argc;
222 while (*++arg) {
223 switch (*arg) {
224 case 'f': /* force */
225 env_flag |= H_FORCE;
226 break;
227 default:
228 return CMD_RET_USAGE;
229 }
230 }
231 }
232 debug("Final value for argc=%d\n", argc);
c3f65258
GF
233 name = argv[1];
234 value = argv[2];
235
236 if (strchr(name, '=')) {
237 printf("## Error: illegal character '='"
238 "in variable name \"%s\"\n", name);
239 return 1;
240 }
241
242 env_id++;
c3f65258 243
a68d3ed0 244 /* Delete only ? */
d09b1787 245 if (argc < 3 || argv[2] == NULL) {
24ab5a19 246 int rc = hdelete_r(name, &env_htab, env_flag);
ea882baf 247 return !rc;
a68d3ed0
WD
248 }
249
250 /*
ea882baf 251 * Insert / replace new value
a68d3ed0 252 */
f3c615b8 253 for (i = 2, len = 0; i < argc; ++i)
a68d3ed0 254 len += strlen(argv[i]) + 1;
f3c615b8
ML
255
256 value = malloc(len);
257 if (value == NULL) {
ea882baf 258 printf("## Can't malloc %d bytes\n", len);
a68d3ed0
WD
259 return 1;
260 }
f3c615b8 261 for (i = 2, s = value; i < argc; ++i) {
ea882baf 262 char *v = argv[i];
a68d3ed0 263
ea882baf 264 while ((*s++ = *v++) != '\0')
a68d3ed0 265 ;
d09b1787 266 *(s - 1) = ' ';
ea882baf
WD
267 }
268 if (s != value)
269 *--s = '\0';
270
d09b1787
IG
271 e.key = name;
272 e.data = value;
24ab5a19 273 hsearch_r(e, ENTER, &ep, &env_htab, env_flag);
ea882baf
WD
274 free(value);
275 if (!ep) {
276 printf("## Error inserting \"%s\" variable, errno=%d\n",
277 name, errno);
278 return 1;
a68d3ed0 279 }
a68d3ed0 280
a68d3ed0
WD
281 return 0;
282}
283
84b5e802 284int setenv(const char *varname, const char *varvalue)
a68d3ed0 285{
84b5e802
WD
286 const char * const argv[4] = { "setenv", varname, varvalue, NULL };
287
a7eb1d66
JH
288 /* before import into hashtable */
289 if (!(gd->flags & GD_FLG_ENV_READY))
290 return 1;
291
d09b1787 292 if (varvalue == NULL || varvalue[0] == '\0')
84b5e802 293 return _do_env_set(0, 2, (char * const *)argv);
9ffd451a 294 else
84b5e802 295 return _do_env_set(0, 3, (char * const *)argv);
a68d3ed0
WD
296}
297
d67f10ce
SG
298/**
299 * Set an environment variable to an integer value
300 *
9602286d 301 * @param varname Environment variable to set
d67f10ce
SG
302 * @param value Value to set it to
303 * @return 0 if ok, 1 on error
304 */
305int setenv_ulong(const char *varname, ulong value)
306{
307 /* TODO: this should be unsigned */
308 char *str = simple_itoa(value);
309
310 return setenv(varname, str);
311}
312
313/**
bfc59966 314 * Set an environment variable to an value in hex
d67f10ce 315 *
9602286d 316 * @param varname Environment variable to set
bfc59966 317 * @param value Value to set it to
d67f10ce
SG
318 * @return 0 if ok, 1 on error
319 */
bfc59966 320int setenv_hex(const char *varname, ulong value)
d67f10ce
SG
321{
322 char str[17];
323
bfc59966 324 sprintf(str, "%lx", value);
d67f10ce
SG
325 return setenv(varname, str);
326}
327
76b8f79c
SG
328ulong getenv_hex(const char *varname, ulong default_val)
329{
330 const char *s;
331 ulong value;
332 char *endp;
333
334 s = getenv(varname);
335 if (s)
336 value = simple_strtoul(s, &endp, 16);
337 if (!s || endp == s)
338 return default_val;
339
340 return value;
341}
342
7ac2fe2d 343#ifndef CONFIG_SPL_BUILD
088f1b19 344static int do_env_set(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
a68d3ed0 345{
47e26b1b 346 if (argc < 2)
4c12eeb8 347 return CMD_RET_USAGE;
a68d3ed0 348
ea882baf 349 return _do_env_set(flag, argc, argv);
a68d3ed0
WD
350}
351
ea882baf 352/*
a68d3ed0
WD
353 * Prompt for environment variable
354 */
c76fe474 355#if defined(CONFIG_CMD_ASKENV)
f3c615b8 356int do_env_ask(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
a68d3ed0 357{
6d0f6bcf 358 char message[CONFIG_SYS_CBSIZE];
7d85591d 359 int i, len, pos, size;
a68d3ed0 360 char *local_args[4];
7d85591d 361 char *endptr;
a68d3ed0
WD
362
363 local_args[0] = argv[0];
364 local_args[1] = argv[1];
365 local_args[2] = NULL;
366 local_args[3] = NULL;
367
7d85591d
WD
368 /*
369 * Check the syntax:
370 *
371 * env_ask envname [message1 ...] [size]
372 */
373 if (argc == 1)
4c12eeb8 374 return CMD_RET_USAGE;
a68d3ed0 375
7d85591d
WD
376 /*
377 * We test the last argument if it can be converted
378 * into a decimal number. If yes, we assume it's
379 * the size. Otherwise we echo it as part of the
380 * message.
381 */
382 i = simple_strtoul(argv[argc - 1], &endptr, 10);
383 if (*endptr != '\0') { /* no size */
384 size = CONFIG_SYS_CBSIZE - 1;
385 } else { /* size given */
386 size = i;
387 --argc;
388 }
a68d3ed0 389
7d85591d
WD
390 if (argc <= 2) {
391 sprintf(message, "Please enter '%s': ", argv[1]);
392 } else {
393 /* env_ask envname message1 ... messagen [size] */
394 for (i = 2, pos = 0; i < argc; i++) {
f3c615b8 395 if (pos)
a68d3ed0 396 message[pos++] = ' ';
f3c615b8 397
d09b1787 398 strcpy(message + pos, argv[i]);
a68d3ed0
WD
399 pos += strlen(argv[i]);
400 }
7d85591d 401 message[pos++] = ' ';
a68d3ed0 402 message[pos] = '\0';
a68d3ed0
WD
403 }
404
6d0f6bcf
JCPV
405 if (size >= CONFIG_SYS_CBSIZE)
406 size = CONFIG_SYS_CBSIZE - 1;
a68d3ed0
WD
407
408 if (size <= 0)
409 return 1;
410
411 /* prompt for input */
ea882baf 412 len = readline(message);
a68d3ed0
WD
413
414 if (size < len)
415 console_buffer[size] = '\0';
416
417 len = 2;
418 if (console_buffer[0] != '\0') {
419 local_args[2] = console_buffer;
420 len = 3;
421 }
422
423 /* Continue calling setenv code */
ea882baf 424 return _do_env_set(flag, len, local_args);
a68d3ed0 425}
90253178 426#endif
a68d3ed0 427
5e2b3e0c
JH
428#if defined(CONFIG_CMD_ENV_CALLBACK)
429static int print_static_binding(const char *var_name, const char *callback_name)
430{
431 printf("\t%-20s %-20s\n", var_name, callback_name);
432
433 return 0;
434}
435
436static int print_active_callback(ENTRY *entry)
437{
438 struct env_clbk_tbl *clbkp;
439 int i;
440 int num_callbacks;
441
442 if (entry->callback == NULL)
443 return 0;
444
445 /* look up the callback in the linker-list */
446 num_callbacks = ll_entry_count(struct env_clbk_tbl, env_clbk);
447 for (i = 0, clbkp = ll_entry_start(struct env_clbk_tbl, env_clbk);
448 i < num_callbacks;
449 i++, clbkp++) {
450#if defined(CONFIG_NEEDS_MANUAL_RELOC)
451 if (entry->callback == clbkp->callback + gd->reloc_off)
452#else
453 if (entry->callback == clbkp->callback)
454#endif
455 break;
456 }
457
458 if (i == num_callbacks)
459 /* this should probably never happen, but just in case... */
460 printf("\t%-20s %p\n", entry->key, entry->callback);
461 else
462 printf("\t%-20s %-20s\n", entry->key, clbkp->name);
463
464 return 0;
465}
466
467/*
468 * Print the callbacks available and what they are bound to
469 */
470int do_env_callback(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
471{
472 struct env_clbk_tbl *clbkp;
473 int i;
474 int num_callbacks;
475
476 /* Print the available callbacks */
477 puts("Available callbacks:\n");
478 puts("\tCallback Name\n");
479 puts("\t-------------\n");
480 num_callbacks = ll_entry_count(struct env_clbk_tbl, env_clbk);
481 for (i = 0, clbkp = ll_entry_start(struct env_clbk_tbl, env_clbk);
482 i < num_callbacks;
483 i++, clbkp++)
484 printf("\t%s\n", clbkp->name);
485 puts("\n");
486
487 /* Print the static bindings that may exist */
488 puts("Static callback bindings:\n");
489 printf("\t%-20s %-20s\n", "Variable Name", "Callback Name");
490 printf("\t%-20s %-20s\n", "-------------", "-------------");
491 env_attr_walk(ENV_CALLBACK_LIST_STATIC, print_static_binding);
492 puts("\n");
493
494 /* walk through each variable and print the callback if it has one */
495 puts("Active callback bindings:\n");
496 printf("\t%-20s %-20s\n", "Variable Name", "Callback Name");
497 printf("\t%-20s %-20s\n", "-------------", "-------------");
498 hwalk_r(&env_htab, print_active_callback);
499 return 0;
500}
501#endif
502
fffad71b
JH
503#if defined(CONFIG_CMD_ENV_FLAGS)
504static int print_static_flags(const char *var_name, const char *flags)
505{
506 enum env_flags_vartype type = env_flags_parse_vartype(flags);
267541f7 507 enum env_flags_varaccess access = env_flags_parse_varaccess(flags);
fffad71b 508
267541f7
JH
509 printf("\t%-20s %-20s %-20s\n", var_name,
510 env_flags_get_vartype_name(type),
511 env_flags_get_varaccess_name(access));
fffad71b
JH
512
513 return 0;
514}
515
516static int print_active_flags(ENTRY *entry)
517{
518 enum env_flags_vartype type;
267541f7 519 enum env_flags_varaccess access;
fffad71b
JH
520
521 if (entry->flags == 0)
522 return 0;
523
524 type = (enum env_flags_vartype)
525 (entry->flags & ENV_FLAGS_VARTYPE_BIN_MASK);
267541f7
JH
526 access = env_flags_parse_varaccess_from_binflags(entry->flags);
527 printf("\t%-20s %-20s %-20s\n", entry->key,
528 env_flags_get_vartype_name(type),
529 env_flags_get_varaccess_name(access));
fffad71b
JH
530
531 return 0;
532}
533
534/*
535 * Print the flags available and what variables have flags
536 */
537int do_env_flags(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
538{
539 /* Print the available variable types */
540 printf("Available variable type flags (position %d):\n",
541 ENV_FLAGS_VARTYPE_LOC);
542 puts("\tFlag\tVariable Type Name\n");
543 puts("\t----\t------------------\n");
544 env_flags_print_vartypes();
545 puts("\n");
546
267541f7
JH
547 /* Print the available variable access types */
548 printf("Available variable access flags (position %d):\n",
549 ENV_FLAGS_VARACCESS_LOC);
550 puts("\tFlag\tVariable Access Name\n");
551 puts("\t----\t--------------------\n");
552 env_flags_print_varaccess();
553 puts("\n");
554
fffad71b
JH
555 /* Print the static flags that may exist */
556 puts("Static flags:\n");
267541f7
JH
557 printf("\t%-20s %-20s %-20s\n", "Variable Name", "Variable Type",
558 "Variable Access");
559 printf("\t%-20s %-20s %-20s\n", "-------------", "-------------",
560 "---------------");
fffad71b
JH
561 env_attr_walk(ENV_FLAGS_LIST_STATIC, print_static_flags);
562 puts("\n");
563
564 /* walk through each variable and print the flags if non-default */
565 puts("Active flags:\n");
267541f7
JH
566 printf("\t%-20s %-20s %-20s\n", "Variable Name", "Variable Type",
567 "Variable Access");
568 printf("\t%-20s %-20s %-20s\n", "-------------", "-------------",
569 "---------------");
fffad71b
JH
570 hwalk_r(&env_htab, print_active_flags);
571 return 0;
572}
573#endif
574
ea882baf 575/*
246c6922
PT
576 * Interactively edit an environment variable
577 */
578#if defined(CONFIG_CMD_EDITENV)
088f1b19
KP
579static int do_env_edit(cmd_tbl_t *cmdtp, int flag, int argc,
580 char * const argv[])
246c6922
PT
581{
582 char buffer[CONFIG_SYS_CBSIZE];
583 char *init_val;
246c6922 584
47e26b1b 585 if (argc < 2)
4c12eeb8 586 return CMD_RET_USAGE;
246c6922
PT
587
588 /* Set read buffer to initial value or empty sting */
589 init_val = getenv(argv[1]);
590 if (init_val)
7fcd9bbd 591 sprintf(buffer, "%s", init_val);
246c6922
PT
592 else
593 buffer[0] = '\0';
594
18a3cce9
JH
595 if (readline_into_buffer("edit: ", buffer, 0) < 0)
596 return 1;
246c6922
PT
597
598 return setenv(argv[1], buffer);
599}
600#endif /* CONFIG_CMD_EDITENV */
7ac2fe2d 601#endif /* CONFIG_SPL_BUILD */
246c6922 602
ea882baf 603/*
a68d3ed0
WD
604 * Look up variable from environment,
605 * return address of storage for that variable,
606 * or NULL if not found
607 */
84b5e802 608char *getenv(const char *name)
a68d3ed0 609{
d09b1787 610 if (gd->flags & GD_FLG_ENV_READY) { /* after import into hashtable */
ea882baf 611 ENTRY e, *ep;
a68d3ed0 612
91a76751 613 WATCHDOG_RESET();
2a3cb020 614
d09b1787
IG
615 e.key = name;
616 e.data = NULL;
c4e0057f 617 hsearch_r(e, FIND, &ep, &env_htab, 0);
91a76751 618
f3c615b8 619 return ep ? ep->data : NULL;
a68d3ed0
WD
620 }
621
ea882baf 622 /* restricted capabilities before import */
ea882baf
WD
623 if (getenv_f(name, (char *)(gd->env_buf), sizeof(gd->env_buf)) > 0)
624 return (char *)(gd->env_buf);
91a76751 625
ea882baf 626 return NULL;
a68d3ed0
WD
627}
628
ea882baf
WD
629/*
630 * Look up variable from environment for restricted C runtime env.
631 */
84b5e802 632int getenv_f(const char *name, char *buf, unsigned len)
a68d3ed0
WD
633{
634 int i, nxt;
635
d09b1787 636 for (i = 0; env_get_char(i) != '\0'; i = nxt + 1) {
a68d3ed0
WD
637 int val, n;
638
f3c615b8
ML
639 for (nxt = i; env_get_char(nxt) != '\0'; ++nxt) {
640 if (nxt >= CONFIG_ENV_SIZE)
641 return -1;
a68d3ed0 642 }
f3c615b8
ML
643
644 val = envmatch((uchar *)name, i);
645 if (val < 0)
a68d3ed0 646 continue;
9ed4a958 647
a68d3ed0 648 /* found; copy out */
f3c615b8 649 for (n = 0; n < len; ++n, ++buf) {
d09b1787
IG
650 *buf = env_get_char(val++);
651 if (*buf == '\0')
9ed4a958
WD
652 return n;
653 }
654
655 if (n)
656 *--buf = '\0';
657
a02a884b
WD
658 printf("env_buf [%d bytes] too small for value of \"%s\"\n",
659 len, name);
9ed4a958
WD
660
661 return n;
a68d3ed0 662 }
d09b1787 663
f3c615b8 664 return -1;
a68d3ed0
WD
665}
666
4a9b4131
SG
667/**
668 * Decode the integer value of an environment variable and return it.
669 *
670 * @param name Name of environemnt variable
671 * @param base Number base to use (normally 10, or 16 for hex)
672 * @param default_val Default value to return if the variable is not
673 * found
674 * @return the decoded value, or default_val if not found
675 */
676ulong getenv_ulong(const char *name, int base, ulong default_val)
677{
678 /*
679 * We can use getenv() here, even before relocation, since the
680 * environment variable value is an integer and thus short.
681 */
682 const char *str = getenv(name);
683
684 return str ? simple_strtoul(str, NULL, base) : default_val;
685}
686
7ac2fe2d 687#ifndef CONFIG_SPL_BUILD
bdab39d3 688#if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE)
088f1b19
KP
689static int do_env_save(cmd_tbl_t *cmdtp, int flag, int argc,
690 char * const argv[])
a68d3ed0 691{
f3c615b8 692 printf("Saving Environment to %s...\n", env_name_spec);
a68d3ed0 693
f3c615b8 694 return saveenv() ? 1 : 0;
a68d3ed0 695}
8bde7f77 696
ba69dc26 697U_BOOT_CMD(
ea882baf 698 saveenv, 1, 0, do_env_save,
2fb2604d 699 "save environment variables to persistent storage",
a89c33db 700 ""
ba69dc26 701);
a68d3ed0 702#endif
7ac2fe2d 703#endif /* CONFIG_SPL_BUILD */
a68d3ed0
WD
704
705
ea882baf 706/*
a68d3ed0
WD
707 * Match a name / name=value pair
708 *
709 * s1 is either a simple 'name', or a 'name=value' pair.
710 * i2 is the environment index for a 'name2=value2' pair.
d09b1787 711 * If the names match, return the index for the value2, else -1.
a68d3ed0 712 */
f3c615b8 713int envmatch(uchar *s1, int i2)
a68d3ed0 714{
586197df
JH
715 if (s1 == NULL)
716 return -1;
717
a68d3ed0
WD
718 while (*s1 == env_get_char(i2++))
719 if (*s1++ == '=')
f3c615b8 720 return i2;
d09b1787 721
a68d3ed0 722 if (*s1 == '\0' && env_get_char(i2-1) == '=')
f3c615b8 723 return i2;
d09b1787 724
f3c615b8 725 return -1;
a68d3ed0 726}
8bde7f77 727
7ac2fe2d 728#ifndef CONFIG_SPL_BUILD
b64b7c3d 729static int do_env_default(cmd_tbl_t *cmdtp, int __flag,
d09b1787 730 int argc, char * const argv[])
ea882baf 731{
b64b7c3d 732 int all = 0, flag = 0;
f3c615b8 733
b64b7c3d
GF
734 debug("Initial value for argc=%d\n", argc);
735 while (--argc > 0 && **++argv == '-') {
736 char *arg = *argv;
737
738 while (*++arg) {
739 switch (*arg) {
740 case 'a': /* default all */
741 all = 1;
742 break;
743 case 'f': /* force */
744 flag |= H_FORCE;
745 break;
746 default:
747 return cmd_usage(cmdtp);
748 }
749 }
750 }
751 debug("Final value for argc=%d\n", argc);
752 if (all && (argc == 0)) {
753 /* Reset the whole environment */
754 set_default_env("## Resetting to default environment\n");
755 return 0;
756 }
757 if (!all && (argc > 0)) {
758 /* Reset individual variables */
759 set_default_vars(argc, argv);
760 return 0;
761 }
762
763 return cmd_usage(cmdtp);
ea882baf
WD
764}
765
d09b1787
IG
766static int do_env_delete(cmd_tbl_t *cmdtp, int flag,
767 int argc, char * const argv[])
ea882baf 768{
9d8d661d
JH
769 int env_flag = H_INTERACTIVE;
770 int ret = 0;
771
772 debug("Initial value for argc=%d\n", argc);
773 while (argc > 1 && **(argv + 1) == '-') {
774 char *arg = *++argv;
775
776 --argc;
777 while (*++arg) {
778 switch (*arg) {
779 case 'f': /* force */
780 env_flag |= H_FORCE;
781 break;
782 default:
783 return CMD_RET_USAGE;
784 }
785 }
786 }
787 debug("Final value for argc=%d\n", argc);
788
789 env_id++;
790
791 while (--argc > 0) {
792 char *name = *++argv;
793
794 if (!hdelete_r(name, &env_htab, env_flag))
795 ret = 1;
796 }
797
798 return ret;
ea882baf
WD
799}
800
0c79cda0 801#ifdef CONFIG_CMD_EXPORTENV
ea882baf 802/*
37f2fe74 803 * env export [-t | -b | -c] [-s size] addr [var ...]
ea882baf
WD
804 * -t: export as text format; if size is given, data will be
805 * padded with '\0' bytes; if not, one terminating '\0'
806 * will be added (which is included in the "filesize"
807 * setting so you can for exmple copy this to flash and
808 * keep the termination).
809 * -b: export as binary format (name=value pairs separated by
810 * '\0', list end marked by double "\0\0")
811 * -c: export as checksum protected environment format as
812 * used for example by "saveenv" command
37f2fe74
WD
813 * -s size:
814 * size of output buffer
ea882baf 815 * addr: memory address where environment gets stored
37f2fe74
WD
816 * var... List of variable names that get included into the
817 * export. Without arguments, the whole environment gets
818 * exported.
ea882baf
WD
819 *
820 * With "-c" and size is NOT given, then the export command will
821 * format the data as currently used for the persistent storage,
822 * i. e. it will use CONFIG_ENV_SECT_SIZE as output block size and
823 * prepend a valid CRC32 checksum and, in case of resundant
824 * environment, a "current" redundancy flag. If size is given, this
825 * value will be used instead of CONFIG_ENV_SECT_SIZE; again, CRC32
826 * checksum and redundancy flag will be inserted.
827 *
828 * With "-b" and "-t", always only the real data (including a
829 * terminating '\0' byte) will be written; here the optional size
830 * argument will be used to make sure not to overflow the user
831 * provided buffer; the command will abort if the size is not
832 * sufficient. Any remainign space will be '\0' padded.
833 *
834 * On successful return, the variable "filesize" will be set.
835 * Note that filesize includes the trailing/terminating '\0' byte(s).
836 *
837 * Usage szenario: create a text snapshot/backup of the current settings:
838 *
839 * => env export -t 100000
840 * => era ${backup_addr} +${filesize}
841 * => cp.b 100000 ${backup_addr} ${filesize}
842 *
843 * Re-import this snapshot, deleting all other settings:
844 *
845 * => env import -d -t ${backup_addr}
846 */
d09b1787
IG
847static int do_env_export(cmd_tbl_t *cmdtp, int flag,
848 int argc, char * const argv[])
ea882baf
WD
849{
850 char buf[32];
851 char *addr, *cmd, *res;
37f2fe74 852 size_t size = 0;
ea882baf
WD
853 ssize_t len;
854 env_t *envp;
855 char sep = '\n';
856 int chk = 0;
857 int fmt = 0;
858
859 cmd = *argv;
860
861 while (--argc > 0 && **++argv == '-') {
862 char *arg = *argv;
863 while (*++arg) {
864 switch (*arg) {
865 case 'b': /* raw binary format */
866 if (fmt++)
867 goto sep_err;
868 sep = '\0';
869 break;
870 case 'c': /* external checksum format */
871 if (fmt++)
872 goto sep_err;
873 sep = '\0';
874 chk = 1;
875 break;
37f2fe74
WD
876 case 's': /* size given */
877 if (--argc <= 0)
878 return cmd_usage(cmdtp);
879 size = simple_strtoul(*++argv, NULL, 16);
880 goto NXTARG;
ea882baf
WD
881 case 't': /* text format */
882 if (fmt++)
883 goto sep_err;
884 sep = '\n';
885 break;
886 default:
4c12eeb8 887 return CMD_RET_USAGE;
ea882baf
WD
888 }
889 }
37f2fe74 890NXTARG: ;
ea882baf
WD
891 }
892
f3c615b8 893 if (argc < 1)
4c12eeb8 894 return CMD_RET_USAGE;
8bde7f77 895
ea882baf
WD
896 addr = (char *)simple_strtoul(argv[0], NULL, 16);
897
37f2fe74 898 if (size)
ea882baf 899 memset(addr, '\0', size);
37f2fe74
WD
900
901 argc--;
902 argv++;
ea882baf
WD
903
904 if (sep) { /* export as text file */
ea009d47
WD
905 len = hexport_r(&env_htab, sep,
906 H_MATCH_KEY | H_MATCH_IDENT,
907 &addr, size, argc, argv);
ea882baf 908 if (len < 0) {
d09b1787 909 error("Cannot export environment: errno = %d\n", errno);
ea882baf
WD
910 return 1;
911 }
8c3aff52 912 sprintf(buf, "%zX", (size_t)len);
ea882baf
WD
913 setenv("filesize", buf);
914
915 return 0;
916 }
917
918 envp = (env_t *)addr;
919
920 if (chk) /* export as checksum protected block */
921 res = (char *)envp->data;
922 else /* export as raw binary data */
923 res = addr;
924
ea009d47
WD
925 len = hexport_r(&env_htab, '\0',
926 H_MATCH_KEY | H_MATCH_IDENT,
927 &res, ENV_SIZE, argc, argv);
ea882baf 928 if (len < 0) {
d09b1787 929 error("Cannot export environment: errno = %d\n", errno);
ea882baf
WD
930 return 1;
931 }
932
933 if (chk) {
d09b1787 934 envp->crc = crc32(0, envp->data, ENV_SIZE);
ea882baf
WD
935#ifdef CONFIG_ENV_ADDR_REDUND
936 envp->flags = ACTIVE_FLAG;
937#endif
938 }
41ef372c 939 setenv_hex("filesize", len + offsetof(env_t, data));
ea882baf
WD
940
941 return 0;
942
943sep_err:
d09b1787 944 printf("## %s: only one of \"-b\", \"-c\" or \"-t\" allowed\n", cmd);
ea882baf
WD
945 return 1;
946}
0c79cda0 947#endif
ea882baf 948
0c79cda0 949#ifdef CONFIG_CMD_IMPORTENV
ea882baf
WD
950/*
951 * env import [-d] [-t | -b | -c] addr [size]
952 * -d: delete existing environment before importing;
953 * otherwise overwrite / append to existion definitions
954 * -t: assume text format; either "size" must be given or the
955 * text data must be '\0' terminated
956 * -b: assume binary format ('\0' separated, "\0\0" terminated)
957 * -c: assume checksum protected environment format
958 * addr: memory address to read from
959 * size: length of input data; if missing, proper '\0'
960 * termination is mandatory
961 */
d09b1787
IG
962static int do_env_import(cmd_tbl_t *cmdtp, int flag,
963 int argc, char * const argv[])
ea882baf
WD
964{
965 char *cmd, *addr;
966 char sep = '\n';
967 int chk = 0;
968 int fmt = 0;
969 int del = 0;
970 size_t size;
971
972 cmd = *argv;
973
974 while (--argc > 0 && **++argv == '-') {
975 char *arg = *argv;
976 while (*++arg) {
977 switch (*arg) {
978 case 'b': /* raw binary format */
979 if (fmt++)
980 goto sep_err;
981 sep = '\0';
982 break;
983 case 'c': /* external checksum format */
984 if (fmt++)
985 goto sep_err;
986 sep = '\0';
987 chk = 1;
988 break;
989 case 't': /* text format */
990 if (fmt++)
991 goto sep_err;
992 sep = '\n';
993 break;
994 case 'd':
995 del = 1;
996 break;
997 default:
4c12eeb8 998 return CMD_RET_USAGE;
ea882baf
WD
999 }
1000 }
1001 }
1002
f3c615b8 1003 if (argc < 1)
4c12eeb8 1004 return CMD_RET_USAGE;
ea882baf
WD
1005
1006 if (!fmt)
1007 printf("## Warning: defaulting to text format\n");
1008
1009 addr = (char *)simple_strtoul(argv[0], NULL, 16);
1010
1011 if (argc == 2) {
1012 size = simple_strtoul(argv[1], NULL, 16);
1013 } else {
1014 char *s = addr;
1015
1016 size = 0;
1017
1018 while (size < MAX_ENV_SIZE) {
1019 if ((*s == sep) && (*(s+1) == '\0'))
1020 break;
1021 ++s;
1022 ++size;
1023 }
1024 if (size == MAX_ENV_SIZE) {
1025 printf("## Warning: Input data exceeds %d bytes"
1026 " - truncated\n", MAX_ENV_SIZE);
1027 }
d3f80c77 1028 size += 2;
79afc88d 1029 printf("## Info: input data size = %zu = 0x%zX\n", size, size);
ea882baf
WD
1030 }
1031
1032 if (chk) {
1033 uint32_t crc;
1034 env_t *ep = (env_t *)addr;
1035
1036 size -= offsetof(env_t, data);
1037 memcpy(&crc, &ep->crc, sizeof(crc));
1038
1039 if (crc32(0, ep->data, size) != crc) {
1040 puts("## Error: bad CRC, import failed\n");
1041 return 1;
1042 }
1043 addr = (char *)ep->data;
1044 }
1045
348b1f1c 1046 if (himport_r(&env_htab, addr, size, sep, del ? 0 : H_NOCLEAR,
c4e0057f 1047 0, NULL) == 0) {
ea882baf
WD
1048 error("Environment import failed: errno = %d\n", errno);
1049 return 1;
1050 }
1051 gd->flags |= GD_FLG_ENV_READY;
1052
1053 return 0;
1054
1055sep_err:
1056 printf("## %s: only one of \"-b\", \"-c\" or \"-t\" allowed\n",
1057 cmd);
1058 return 1;
1059}
0c79cda0 1060#endif
ea882baf 1061
ea882baf
WD
1062/*
1063 * New command line interface: "env" command with subcommands
1064 */
1065static cmd_tbl_t cmd_env_sub[] = {
1066#if defined(CONFIG_CMD_ASKENV)
1067 U_BOOT_CMD_MKENT(ask, CONFIG_SYS_MAXARGS, 1, do_env_ask, "", ""),
1068#endif
1069 U_BOOT_CMD_MKENT(default, 1, 0, do_env_default, "", ""),
9d8d661d 1070 U_BOOT_CMD_MKENT(delete, CONFIG_SYS_MAXARGS, 0, do_env_delete, "", ""),
ea882baf
WD
1071#if defined(CONFIG_CMD_EDITENV)
1072 U_BOOT_CMD_MKENT(edit, 2, 0, do_env_edit, "", ""),
1073#endif
5e2b3e0c
JH
1074#if defined(CONFIG_CMD_ENV_CALLBACK)
1075 U_BOOT_CMD_MKENT(callbacks, 1, 0, do_env_callback, "", ""),
1076#endif
fffad71b
JH
1077#if defined(CONFIG_CMD_ENV_FLAGS)
1078 U_BOOT_CMD_MKENT(flags, 1, 0, do_env_flags, "", ""),
1079#endif
0c79cda0 1080#if defined(CONFIG_CMD_EXPORTENV)
ea882baf 1081 U_BOOT_CMD_MKENT(export, 4, 0, do_env_export, "", ""),
0c79cda0 1082#endif
a000b795
KP
1083#if defined(CONFIG_CMD_GREPENV)
1084 U_BOOT_CMD_MKENT(grep, CONFIG_SYS_MAXARGS, 1, do_env_grep, "", ""),
1085#endif
0c79cda0 1086#if defined(CONFIG_CMD_IMPORTENV)
ea882baf 1087 U_BOOT_CMD_MKENT(import, 5, 0, do_env_import, "", ""),
0c79cda0 1088#endif
ea882baf
WD
1089 U_BOOT_CMD_MKENT(print, CONFIG_SYS_MAXARGS, 1, do_env_print, "", ""),
1090#if defined(CONFIG_CMD_RUN)
1091 U_BOOT_CMD_MKENT(run, CONFIG_SYS_MAXARGS, 1, do_run, "", ""),
1092#endif
1093#if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE)
1094 U_BOOT_CMD_MKENT(save, 1, 0, do_env_save, "", ""),
1095#endif
1096 U_BOOT_CMD_MKENT(set, CONFIG_SYS_MAXARGS, 0, do_env_set, "", ""),
1097};
1098
2e5167cc 1099#if defined(CONFIG_NEEDS_MANUAL_RELOC)
60f7da1f
HS
1100void env_reloc(void)
1101{
1102 fixup_cmdtable(cmd_env_sub, ARRAY_SIZE(cmd_env_sub));
1103}
1104#endif
1105
f3c615b8 1106static int do_env(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
ea882baf
WD
1107{
1108 cmd_tbl_t *cp;
1109
5904da02 1110 if (argc < 2)
4c12eeb8 1111 return CMD_RET_USAGE;
5904da02 1112
ea882baf
WD
1113 /* drop initial "env" arg */
1114 argc--;
1115 argv++;
1116
1117 cp = find_cmd_tbl(argv[0], cmd_env_sub, ARRAY_SIZE(cmd_env_sub));
1118
1119 if (cp)
1120 return cp->cmd(cmdtp, flag, argc, argv);
1121
4c12eeb8 1122 return CMD_RET_USAGE;
ea882baf
WD
1123}
1124
088f1b19
KP
1125#ifdef CONFIG_SYS_LONGHELP
1126static char env_help_text[] =
ea882baf
WD
1127#if defined(CONFIG_CMD_ASKENV)
1128 "ask name [message] [size] - ask for environment variable\nenv "
5e2b3e0c
JH
1129#endif
1130#if defined(CONFIG_CMD_ENV_CALLBACK)
1131 "callbacks - print callbacks and their associated variables\nenv "
ea882baf 1132#endif
b64b7c3d
GF
1133 "default [-f] -a - [forcibly] reset default environment\n"
1134 "env default [-f] var [...] - [forcibly] reset variable(s) to their default values\n"
9d8d661d 1135 "env delete [-f] var [...] - [forcibly] delete variable(s)\n"
ea882baf
WD
1136#if defined(CONFIG_CMD_EDITENV)
1137 "env edit name - edit environment variable\n"
1138#endif
4796bc4b 1139#if defined(CONFIG_CMD_EXPORTENV)
37f2fe74 1140 "env export [-t | -b | -c] [-s size] addr [var ...] - export environment\n"
4796bc4b 1141#endif
fffad71b
JH
1142#if defined(CONFIG_CMD_ENV_FLAGS)
1143 "env flags - print variables that have non-default flags\n"
1144#endif
a000b795 1145#if defined(CONFIG_CMD_GREPENV)
be29df6a
WD
1146#ifdef CONFIG_REGEX
1147 "env grep [-e] [-n | -v | -b] string [...] - search environment\n"
1148#else
d87244d5 1149 "env grep [-n | -v | -b] string [...] - search environment\n"
a000b795 1150#endif
be29df6a 1151#endif
4796bc4b 1152#if defined(CONFIG_CMD_IMPORTENV)
a000b795 1153 "env import [-d] [-t | -b | -c] addr [size] - import environment\n"
4796bc4b 1154#endif
be11235a 1155 "env print [-a | name ...] - print environment\n"
ea882baf
WD
1156#if defined(CONFIG_CMD_RUN)
1157 "env run var [...] - run commands in an environment variable\n"
1158#endif
d798a9b5 1159#if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE)
ea882baf 1160 "env save - save environment\n"
d798a9b5 1161#endif
088f1b19
KP
1162 "env set [-f] name [arg ...]\n";
1163#endif
1164
1165U_BOOT_CMD(
1166 env, CONFIG_SYS_MAXARGS, 1, do_env,
1167 "environment handling commands", env_help_text
ea882baf
WD
1168);
1169
1170/*
1171 * Old command line interface, kept for compatibility
1172 */
8bde7f77 1173
246c6922 1174#if defined(CONFIG_CMD_EDITENV)
722b061b 1175U_BOOT_CMD_COMPLETE(
ea882baf 1176 editenv, 2, 0, do_env_edit,
246c6922
PT
1177 "edit environment variable",
1178 "name\n"
722b061b
MF
1179 " - edit environment variable 'name'",
1180 var_complete
246c6922
PT
1181);
1182#endif
1183
722b061b 1184U_BOOT_CMD_COMPLETE(
ea882baf 1185 printenv, CONFIG_SYS_MAXARGS, 1, do_env_print,
2fb2604d 1186 "print environment variables",
be11235a 1187 "[-a]\n - print [all] values of all environment variables\n"
8bde7f77 1188 "printenv name ...\n"
722b061b
MF
1189 " - print value of environment variable 'name'",
1190 var_complete
8bde7f77
WD
1191);
1192
a000b795
KP
1193#ifdef CONFIG_CMD_GREPENV
1194U_BOOT_CMD_COMPLETE(
1195 grepenv, CONFIG_SYS_MAXARGS, 0, do_env_grep,
1196 "search environment variables",
be29df6a
WD
1197#ifdef CONFIG_REGEX
1198 "[-e] [-n | -v | -b] string ...\n"
1199#else
d87244d5 1200 "[-n | -v | -b] string ...\n"
be29df6a 1201#endif
d87244d5 1202 " - list environment name=value pairs matching 'string'\n"
be29df6a
WD
1203#ifdef CONFIG_REGEX
1204 " \"-e\": enable regular expressions;\n"
1205#endif
d87244d5
WD
1206 " \"-n\": search variable names; \"-v\": search values;\n"
1207 " \"-b\": search both names and values (default)",
a000b795
KP
1208 var_complete
1209);
1210#endif
1211
722b061b 1212U_BOOT_CMD_COMPLETE(
ea882baf 1213 setenv, CONFIG_SYS_MAXARGS, 0, do_env_set,
2fb2604d 1214 "set environment variables",
24ab5a19
JH
1215 "[-f] name value ...\n"
1216 " - [forcibly] set environment variable 'name' to 'value ...'\n"
1217 "setenv [-f] name\n"
1218 " - [forcibly] delete environment variable 'name'",
722b061b 1219 var_complete
8bde7f77
WD
1220);
1221
c76fe474 1222#if defined(CONFIG_CMD_ASKENV)
8bde7f77 1223
0d498393 1224U_BOOT_CMD(
ea882baf 1225 askenv, CONFIG_SYS_MAXARGS, 1, do_env_ask,
2fb2604d 1226 "get environment variables from stdin",
8bde7f77 1227 "name [message] [size]\n"
7d85591d 1228 " - get environment variable 'name' from stdin (max 'size' chars)"
8bde7f77 1229);
90253178 1230#endif
8bde7f77 1231
c76fe474 1232#if defined(CONFIG_CMD_RUN)
722b061b 1233U_BOOT_CMD_COMPLETE(
6d0f6bcf 1234 run, CONFIG_SYS_MAXARGS, 1, do_run,
2fb2604d 1235 "run commands in an environment variable",
8bde7f77 1236 "var [...]\n"
722b061b
MF
1237 " - run the commands in the environment variable(s) 'var'",
1238 var_complete
8bde7f77 1239);
90253178 1240#endif
7ac2fe2d 1241#endif /* CONFIG_SPL_BUILD */