cmd_nvedit.c 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086
  1. /*
  2. * (C) Copyright 2000-2010
  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>
  7. *
  8. * Copyright 2011 Freescale Semiconductor, Inc.
  9. *
  10. * See file CREDITS for list of people who contributed to this
  11. * project.
  12. *
  13. * This program is free software; you can redistribute it and/or
  14. * modify it under the terms of the GNU General Public License as
  15. * published by the Free Software Foundation; either version 2 of
  16. * the License, or (at your option) any later version.
  17. *
  18. * This program is distributed in the hope that it will be useful,
  19. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  21. * GNU General Public License for more details.
  22. *
  23. * You should have received a copy of the GNU General Public License
  24. * along with this program; if not, write to the Free Software
  25. * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  26. * MA 02111-1307 USA
  27. */
  28. /*
  29. * Support for persistent environment data
  30. *
  31. * The "environment" is stored on external storage as a list of '\0'
  32. * terminated "name=value" strings. The end of the list is marked by
  33. * a double '\0'. The environment is preceeded by a 32 bit CRC over
  34. * the data part and, in case of redundant environment, a byte of
  35. * flags.
  36. *
  37. * This linearized representation will also be used before
  38. * relocation, i. e. as long as we don't have a full C runtime
  39. * environment. After that, we use a hash table.
  40. */
  41. #include <common.h>
  42. #include <command.h>
  43. #include <environment.h>
  44. #include <search.h>
  45. #include <errno.h>
  46. #include <malloc.h>
  47. #include <watchdog.h>
  48. #include <serial.h>
  49. #include <linux/stddef.h>
  50. #include <asm/byteorder.h>
  51. #if defined(CONFIG_CMD_NET)
  52. #include <net.h>
  53. #endif
  54. DECLARE_GLOBAL_DATA_PTR;
  55. #if !defined(CONFIG_ENV_IS_IN_EEPROM) && \
  56. !defined(CONFIG_ENV_IS_IN_FLASH) && \
  57. !defined(CONFIG_ENV_IS_IN_DATAFLASH) && \
  58. !defined(CONFIG_ENV_IS_IN_MMC) && \
  59. !defined(CONFIG_ENV_IS_IN_FAT) && \
  60. !defined(CONFIG_ENV_IS_IN_NAND) && \
  61. !defined(CONFIG_ENV_IS_IN_NVRAM) && \
  62. !defined(CONFIG_ENV_IS_IN_ONENAND) && \
  63. !defined(CONFIG_ENV_IS_IN_SPI_FLASH) && \
  64. !defined(CONFIG_ENV_IS_IN_REMOTE) && \
  65. !defined(CONFIG_ENV_IS_NOWHERE)
  66. # error Define one of CONFIG_ENV_IS_IN_{EEPROM|FLASH|DATAFLASH|ONENAND|\
  67. SPI_FLASH|NVRAM|MMC|FAT|REMOTE} or CONFIG_ENV_IS_NOWHERE
  68. #endif
  69. #define XMK_STR(x) #x
  70. #define MK_STR(x) XMK_STR(x)
  71. /*
  72. * Maximum expected input data size for import command
  73. */
  74. #define MAX_ENV_SIZE (1 << 20) /* 1 MiB */
  75. ulong load_addr = CONFIG_SYS_LOAD_ADDR; /* Default Load Address */
  76. ulong save_addr; /* Default Save Address */
  77. ulong save_size; /* Default Save Size (in bytes) */
  78. /*
  79. * Table with supported baudrates (defined in config_xyz.h)
  80. */
  81. static const unsigned long baudrate_table[] = CONFIG_SYS_BAUDRATE_TABLE;
  82. #define N_BAUDRATES (sizeof(baudrate_table) / sizeof(baudrate_table[0]))
  83. /*
  84. * This variable is incremented on each do_env_set(), so it can
  85. * be used via get_env_id() as an indication, if the environment
  86. * has changed or not. So it is possible to reread an environment
  87. * variable only if the environment was changed ... done so for
  88. * example in NetInitLoop()
  89. */
  90. static int env_id = 1;
  91. int get_env_id(void)
  92. {
  93. return env_id;
  94. }
  95. /*
  96. * Command interface: print one or all environment variables
  97. *
  98. * Returns 0 in case of error, or length of printed string
  99. */
  100. static int env_print(char *name)
  101. {
  102. char *res = NULL;
  103. size_t len;
  104. if (name) { /* print a single name */
  105. ENTRY e, *ep;
  106. e.key = name;
  107. e.data = NULL;
  108. hsearch_r(e, FIND, &ep, &env_htab);
  109. if (ep == NULL)
  110. return 0;
  111. len = printf("%s=%s\n", ep->key, ep->data);
  112. return len;
  113. }
  114. /* print whole list */
  115. len = hexport_r(&env_htab, '\n', &res, 0, 0, NULL);
  116. if (len > 0) {
  117. puts(res);
  118. free(res);
  119. return len;
  120. }
  121. /* should never happen */
  122. return 0;
  123. }
  124. int do_env_print (cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
  125. {
  126. int i;
  127. int rcode = 0;
  128. if (argc == 1) {
  129. /* print all env vars */
  130. rcode = env_print(NULL);
  131. if (!rcode)
  132. return 1;
  133. printf("\nEnvironment size: %d/%ld bytes\n",
  134. rcode, (ulong)ENV_SIZE);
  135. return 0;
  136. }
  137. /* print selected env vars */
  138. for (i = 1; i < argc; ++i) {
  139. int rc = env_print(argv[i]);
  140. if (!rc) {
  141. printf("## Error: \"%s\" not defined\n", argv[i]);
  142. ++rcode;
  143. }
  144. }
  145. return rcode;
  146. }
  147. #ifdef CONFIG_CMD_GREPENV
  148. static int do_env_grep(cmd_tbl_t *cmdtp, int flag,
  149. int argc, char * const argv[])
  150. {
  151. ENTRY *match;
  152. unsigned char matched[env_htab.size / 8];
  153. int rcode = 1, arg = 1, idx;
  154. if (argc < 2)
  155. return CMD_RET_USAGE;
  156. memset(matched, 0, env_htab.size / 8);
  157. while (arg <= argc) {
  158. idx = 0;
  159. while ((idx = hstrstr_r(argv[arg], idx, &match, &env_htab))) {
  160. if (!(matched[idx / 8] & (1 << (idx & 7)))) {
  161. puts(match->key);
  162. puts("=");
  163. puts(match->data);
  164. puts("\n");
  165. }
  166. matched[idx / 8] |= 1 << (idx & 7);
  167. rcode = 0;
  168. }
  169. arg++;
  170. }
  171. return rcode;
  172. }
  173. #endif
  174. /*
  175. * Perform consistency checking before setting, replacing, or deleting an
  176. * environment variable, then (if successful) apply the changes to internals so
  177. * to make them effective. Code for this function was taken out of
  178. * _do_env_set(), which now calls it instead.
  179. * Returns 0 in case of success, 1 in case of failure.
  180. * When (flag & H_FORCE) is set, do not print out any error message and force
  181. * overwriting of write-once variables.
  182. */
  183. int env_check_apply(const char *name, const char *oldval,
  184. const char *newval, int flag)
  185. {
  186. int console = -1;
  187. /* Check for console redirection */
  188. if (strcmp(name, "stdin") == 0)
  189. console = stdin;
  190. else if (strcmp(name, "stdout") == 0)
  191. console = stdout;
  192. else if (strcmp(name, "stderr") == 0)
  193. console = stderr;
  194. if (console != -1) {
  195. if ((newval == NULL) || (*newval == '\0')) {
  196. /* We cannot delete stdin/stdout/stderr */
  197. if ((flag & H_FORCE) == 0)
  198. printf("Can't delete \"%s\"\n", name);
  199. return 1;
  200. }
  201. #ifdef CONFIG_CONSOLE_MUX
  202. if (iomux_doenv(console, newval))
  203. return 1;
  204. #else
  205. /* Try assigning specified device */
  206. if (console_assign(console, newval) < 0)
  207. return 1;
  208. #ifdef CONFIG_SERIAL_MULTI
  209. if (serial_assign(newval) < 0)
  210. return 1;
  211. #endif
  212. #endif /* CONFIG_CONSOLE_MUX */
  213. }
  214. /*
  215. * Some variables like "ethaddr" and "serial#" can be set only once and
  216. * cannot be deleted, unless CONFIG_ENV_OVERWRITE is defined.
  217. */
  218. #ifndef CONFIG_ENV_OVERWRITE
  219. if (oldval != NULL && /* variable exists */
  220. (flag & H_FORCE) == 0) { /* and we are not forced */
  221. if (strcmp(name, "serial#") == 0 ||
  222. (strcmp(name, "ethaddr") == 0
  223. #if defined(CONFIG_OVERWRITE_ETHADDR_ONCE) && defined(CONFIG_ETHADDR)
  224. && strcmp(oldval, MK_STR(CONFIG_ETHADDR)) != 0
  225. #endif /* CONFIG_OVERWRITE_ETHADDR_ONCE && CONFIG_ETHADDR */
  226. )) {
  227. printf("Can't overwrite \"%s\"\n", name);
  228. return 1;
  229. }
  230. }
  231. #endif
  232. /*
  233. * When we change baudrate, or we are doing an env default -a
  234. * (which will erase all variables prior to calling this),
  235. * we want the baudrate to actually change - for real.
  236. */
  237. if (oldval != NULL || /* variable exists */
  238. (flag & H_NOCLEAR) == 0) { /* or env is clear */
  239. /*
  240. * Switch to new baudrate if new baudrate is supported
  241. */
  242. if (strcmp(name, "baudrate") == 0) {
  243. int baudrate = simple_strtoul(newval, NULL, 10);
  244. int i;
  245. for (i = 0; i < N_BAUDRATES; ++i) {
  246. if (baudrate == baudrate_table[i])
  247. break;
  248. }
  249. if (i == N_BAUDRATES) {
  250. if ((flag & H_FORCE) == 0)
  251. printf("## Baudrate %d bps not "
  252. "supported\n", baudrate);
  253. return 1;
  254. }
  255. if (gd->baudrate == baudrate) {
  256. /* If unchanged, we just say it's OK */
  257. return 0;
  258. }
  259. printf("## Switch baudrate to %d bps and"
  260. "press ENTER ...\n", baudrate);
  261. udelay(50000);
  262. gd->baudrate = baudrate;
  263. #if defined(CONFIG_PPC) || defined(CONFIG_MCF52x2)
  264. gd->bd->bi_baudrate = baudrate;
  265. #endif
  266. serial_setbrg();
  267. udelay(50000);
  268. while (getc() != '\r')
  269. ;
  270. }
  271. }
  272. /*
  273. * Some variables should be updated when the corresponding
  274. * entry in the environment is changed
  275. */
  276. if (strcmp(name, "loadaddr") == 0) {
  277. load_addr = simple_strtoul(newval, NULL, 16);
  278. return 0;
  279. }
  280. #if defined(CONFIG_CMD_NET)
  281. else if (strcmp(name, "bootfile") == 0) {
  282. copy_filename(BootFile, newval, sizeof(BootFile));
  283. return 0;
  284. }
  285. #endif
  286. return 0;
  287. }
  288. /*
  289. * Set a new environment variable,
  290. * or replace or delete an existing one.
  291. */
  292. int _do_env_set(int flag, int argc, char * const argv[])
  293. {
  294. int i, len;
  295. char *name, *value, *s;
  296. ENTRY e, *ep;
  297. name = argv[1];
  298. value = argv[2];
  299. if (strchr(name, '=')) {
  300. printf("## Error: illegal character '='"
  301. "in variable name \"%s\"\n", name);
  302. return 1;
  303. }
  304. env_id++;
  305. /*
  306. * search if variable with this name already exists
  307. */
  308. e.key = name;
  309. e.data = NULL;
  310. hsearch_r(e, FIND, &ep, &env_htab);
  311. /*
  312. * Perform requested checks. Notice how since we are overwriting
  313. * a single variable, we need to set H_NOCLEAR
  314. */
  315. if (env_check_apply(name, ep ? ep->data : NULL, value, H_NOCLEAR)) {
  316. debug("check function did not approve, refusing\n");
  317. return 1;
  318. }
  319. /* Delete only ? */
  320. if (argc < 3 || argv[2] == NULL) {
  321. int rc = hdelete_r(name, &env_htab);
  322. return !rc;
  323. }
  324. /*
  325. * Insert / replace new value
  326. */
  327. for (i = 2, len = 0; i < argc; ++i)
  328. len += strlen(argv[i]) + 1;
  329. value = malloc(len);
  330. if (value == NULL) {
  331. printf("## Can't malloc %d bytes\n", len);
  332. return 1;
  333. }
  334. for (i = 2, s = value; i < argc; ++i) {
  335. char *v = argv[i];
  336. while ((*s++ = *v++) != '\0')
  337. ;
  338. *(s - 1) = ' ';
  339. }
  340. if (s != value)
  341. *--s = '\0';
  342. e.key = name;
  343. e.data = value;
  344. hsearch_r(e, ENTER, &ep, &env_htab);
  345. free(value);
  346. if (!ep) {
  347. printf("## Error inserting \"%s\" variable, errno=%d\n",
  348. name, errno);
  349. return 1;
  350. }
  351. return 0;
  352. }
  353. int setenv(const char *varname, const char *varvalue)
  354. {
  355. const char * const argv[4] = { "setenv", varname, varvalue, NULL };
  356. if (varvalue == NULL || varvalue[0] == '\0')
  357. return _do_env_set(0, 2, (char * const *)argv);
  358. else
  359. return _do_env_set(0, 3, (char * const *)argv);
  360. }
  361. /**
  362. * Set an environment variable to an integer value
  363. *
  364. * @param varname Environmet variable to set
  365. * @param value Value to set it to
  366. * @return 0 if ok, 1 on error
  367. */
  368. int setenv_ulong(const char *varname, ulong value)
  369. {
  370. /* TODO: this should be unsigned */
  371. char *str = simple_itoa(value);
  372. return setenv(varname, str);
  373. }
  374. /**
  375. * Set an environment variable to an address in hex
  376. *
  377. * @param varname Environmet variable to set
  378. * @param addr Value to set it to
  379. * @return 0 if ok, 1 on error
  380. */
  381. int setenv_addr(const char *varname, const void *addr)
  382. {
  383. char str[17];
  384. sprintf(str, "%lx", (uintptr_t)addr);
  385. return setenv(varname, str);
  386. }
  387. int do_env_set(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
  388. {
  389. if (argc < 2)
  390. return CMD_RET_USAGE;
  391. return _do_env_set(flag, argc, argv);
  392. }
  393. /*
  394. * Prompt for environment variable
  395. */
  396. #if defined(CONFIG_CMD_ASKENV)
  397. int do_env_ask(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
  398. {
  399. char message[CONFIG_SYS_CBSIZE];
  400. int size = CONFIG_SYS_CBSIZE - 1;
  401. int i, len, pos;
  402. char *local_args[4];
  403. local_args[0] = argv[0];
  404. local_args[1] = argv[1];
  405. local_args[2] = NULL;
  406. local_args[3] = NULL;
  407. /* Check the syntax */
  408. switch (argc) {
  409. case 1:
  410. return CMD_RET_USAGE;
  411. case 2: /* env_ask envname */
  412. sprintf(message, "Please enter '%s':", argv[1]);
  413. break;
  414. case 3: /* env_ask envname size */
  415. sprintf(message, "Please enter '%s':", argv[1]);
  416. size = simple_strtoul(argv[2], NULL, 10);
  417. break;
  418. default: /* env_ask envname message1 ... messagen size */
  419. for (i = 2, pos = 0; i < argc - 1; i++) {
  420. if (pos)
  421. message[pos++] = ' ';
  422. strcpy(message + pos, argv[i]);
  423. pos += strlen(argv[i]);
  424. }
  425. message[pos] = '\0';
  426. size = simple_strtoul(argv[argc - 1], NULL, 10);
  427. break;
  428. }
  429. if (size >= CONFIG_SYS_CBSIZE)
  430. size = CONFIG_SYS_CBSIZE - 1;
  431. if (size <= 0)
  432. return 1;
  433. /* prompt for input */
  434. len = readline(message);
  435. if (size < len)
  436. console_buffer[size] = '\0';
  437. len = 2;
  438. if (console_buffer[0] != '\0') {
  439. local_args[2] = console_buffer;
  440. len = 3;
  441. }
  442. /* Continue calling setenv code */
  443. return _do_env_set(flag, len, local_args);
  444. }
  445. #endif
  446. /*
  447. * Interactively edit an environment variable
  448. */
  449. #if defined(CONFIG_CMD_EDITENV)
  450. int do_env_edit(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
  451. {
  452. char buffer[CONFIG_SYS_CBSIZE];
  453. char *init_val;
  454. if (argc < 2)
  455. return CMD_RET_USAGE;
  456. /* Set read buffer to initial value or empty sting */
  457. init_val = getenv(argv[1]);
  458. if (init_val)
  459. sprintf(buffer, "%s", init_val);
  460. else
  461. buffer[0] = '\0';
  462. readline_into_buffer("edit: ", buffer, 0);
  463. return setenv(argv[1], buffer);
  464. }
  465. #endif /* CONFIG_CMD_EDITENV */
  466. /*
  467. * Look up variable from environment,
  468. * return address of storage for that variable,
  469. * or NULL if not found
  470. */
  471. char *getenv(const char *name)
  472. {
  473. if (gd->flags & GD_FLG_ENV_READY) { /* after import into hashtable */
  474. ENTRY e, *ep;
  475. WATCHDOG_RESET();
  476. e.key = name;
  477. e.data = NULL;
  478. hsearch_r(e, FIND, &ep, &env_htab);
  479. return ep ? ep->data : NULL;
  480. }
  481. /* restricted capabilities before import */
  482. if (getenv_f(name, (char *)(gd->env_buf), sizeof(gd->env_buf)) > 0)
  483. return (char *)(gd->env_buf);
  484. return NULL;
  485. }
  486. /*
  487. * Look up variable from environment for restricted C runtime env.
  488. */
  489. int getenv_f(const char *name, char *buf, unsigned len)
  490. {
  491. int i, nxt;
  492. for (i = 0; env_get_char(i) != '\0'; i = nxt + 1) {
  493. int val, n;
  494. for (nxt = i; env_get_char(nxt) != '\0'; ++nxt) {
  495. if (nxt >= CONFIG_ENV_SIZE)
  496. return -1;
  497. }
  498. val = envmatch((uchar *)name, i);
  499. if (val < 0)
  500. continue;
  501. /* found; copy out */
  502. for (n = 0; n < len; ++n, ++buf) {
  503. *buf = env_get_char(val++);
  504. if (*buf == '\0')
  505. return n;
  506. }
  507. if (n)
  508. *--buf = '\0';
  509. printf("env_buf [%d bytes] too small for value of \"%s\"\n",
  510. len, name);
  511. return n;
  512. }
  513. return -1;
  514. }
  515. /**
  516. * Decode the integer value of an environment variable and return it.
  517. *
  518. * @param name Name of environemnt variable
  519. * @param base Number base to use (normally 10, or 16 for hex)
  520. * @param default_val Default value to return if the variable is not
  521. * found
  522. * @return the decoded value, or default_val if not found
  523. */
  524. ulong getenv_ulong(const char *name, int base, ulong default_val)
  525. {
  526. /*
  527. * We can use getenv() here, even before relocation, since the
  528. * environment variable value is an integer and thus short.
  529. */
  530. const char *str = getenv(name);
  531. return str ? simple_strtoul(str, NULL, base) : default_val;
  532. }
  533. #if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE)
  534. int do_env_save(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
  535. {
  536. printf("Saving Environment to %s...\n", env_name_spec);
  537. return saveenv() ? 1 : 0;
  538. }
  539. U_BOOT_CMD(
  540. saveenv, 1, 0, do_env_save,
  541. "save environment variables to persistent storage",
  542. ""
  543. );
  544. #endif
  545. /*
  546. * Match a name / name=value pair
  547. *
  548. * s1 is either a simple 'name', or a 'name=value' pair.
  549. * i2 is the environment index for a 'name2=value2' pair.
  550. * If the names match, return the index for the value2, else -1.
  551. */
  552. int envmatch(uchar *s1, int i2)
  553. {
  554. while (*s1 == env_get_char(i2++))
  555. if (*s1++ == '=')
  556. return i2;
  557. if (*s1 == '\0' && env_get_char(i2-1) == '=')
  558. return i2;
  559. return -1;
  560. }
  561. static int do_env_default(cmd_tbl_t *cmdtp, int flag,
  562. int argc, char * const argv[])
  563. {
  564. if (argc != 2 || strcmp(argv[1], "-f") != 0)
  565. return CMD_RET_USAGE;
  566. set_default_env("## Resetting to default environment\n");
  567. return 0;
  568. }
  569. static int do_env_delete(cmd_tbl_t *cmdtp, int flag,
  570. int argc, char * const argv[])
  571. {
  572. printf("Not implemented yet\n");
  573. return 0;
  574. }
  575. #ifdef CONFIG_CMD_EXPORTENV
  576. /*
  577. * env export [-t | -b | -c] [-s size] addr [var ...]
  578. * -t: export as text format; if size is given, data will be
  579. * padded with '\0' bytes; if not, one terminating '\0'
  580. * will be added (which is included in the "filesize"
  581. * setting so you can for exmple copy this to flash and
  582. * keep the termination).
  583. * -b: export as binary format (name=value pairs separated by
  584. * '\0', list end marked by double "\0\0")
  585. * -c: export as checksum protected environment format as
  586. * used for example by "saveenv" command
  587. * -s size:
  588. * size of output buffer
  589. * addr: memory address where environment gets stored
  590. * var... List of variable names that get included into the
  591. * export. Without arguments, the whole environment gets
  592. * exported.
  593. *
  594. * With "-c" and size is NOT given, then the export command will
  595. * format the data as currently used for the persistent storage,
  596. * i. e. it will use CONFIG_ENV_SECT_SIZE as output block size and
  597. * prepend a valid CRC32 checksum and, in case of resundant
  598. * environment, a "current" redundancy flag. If size is given, this
  599. * value will be used instead of CONFIG_ENV_SECT_SIZE; again, CRC32
  600. * checksum and redundancy flag will be inserted.
  601. *
  602. * With "-b" and "-t", always only the real data (including a
  603. * terminating '\0' byte) will be written; here the optional size
  604. * argument will be used to make sure not to overflow the user
  605. * provided buffer; the command will abort if the size is not
  606. * sufficient. Any remainign space will be '\0' padded.
  607. *
  608. * On successful return, the variable "filesize" will be set.
  609. * Note that filesize includes the trailing/terminating '\0' byte(s).
  610. *
  611. * Usage szenario: create a text snapshot/backup of the current settings:
  612. *
  613. * => env export -t 100000
  614. * => era ${backup_addr} +${filesize}
  615. * => cp.b 100000 ${backup_addr} ${filesize}
  616. *
  617. * Re-import this snapshot, deleting all other settings:
  618. *
  619. * => env import -d -t ${backup_addr}
  620. */
  621. static int do_env_export(cmd_tbl_t *cmdtp, int flag,
  622. int argc, char * const argv[])
  623. {
  624. char buf[32];
  625. char *addr, *cmd, *res;
  626. size_t size = 0;
  627. ssize_t len;
  628. env_t *envp;
  629. char sep = '\n';
  630. int chk = 0;
  631. int fmt = 0;
  632. cmd = *argv;
  633. while (--argc > 0 && **++argv == '-') {
  634. char *arg = *argv;
  635. while (*++arg) {
  636. switch (*arg) {
  637. case 'b': /* raw binary format */
  638. if (fmt++)
  639. goto sep_err;
  640. sep = '\0';
  641. break;
  642. case 'c': /* external checksum format */
  643. if (fmt++)
  644. goto sep_err;
  645. sep = '\0';
  646. chk = 1;
  647. break;
  648. case 's': /* size given */
  649. if (--argc <= 0)
  650. return cmd_usage(cmdtp);
  651. size = simple_strtoul(*++argv, NULL, 16);
  652. goto NXTARG;
  653. case 't': /* text format */
  654. if (fmt++)
  655. goto sep_err;
  656. sep = '\n';
  657. break;
  658. default:
  659. return CMD_RET_USAGE;
  660. }
  661. }
  662. NXTARG: ;
  663. }
  664. if (argc < 1)
  665. return CMD_RET_USAGE;
  666. addr = (char *)simple_strtoul(argv[0], NULL, 16);
  667. if (size)
  668. memset(addr, '\0', size);
  669. argc--;
  670. argv++;
  671. if (sep) { /* export as text file */
  672. len = hexport_r(&env_htab, sep, &addr, size, argc, argv);
  673. if (len < 0) {
  674. error("Cannot export environment: errno = %d\n", errno);
  675. return 1;
  676. }
  677. sprintf(buf, "%zX", (size_t)len);
  678. setenv("filesize", buf);
  679. return 0;
  680. }
  681. envp = (env_t *)addr;
  682. if (chk) /* export as checksum protected block */
  683. res = (char *)envp->data;
  684. else /* export as raw binary data */
  685. res = addr;
  686. len = hexport_r(&env_htab, '\0', &res, ENV_SIZE, argc, argv);
  687. if (len < 0) {
  688. error("Cannot export environment: errno = %d\n", errno);
  689. return 1;
  690. }
  691. if (chk) {
  692. envp->crc = crc32(0, envp->data, ENV_SIZE);
  693. #ifdef CONFIG_ENV_ADDR_REDUND
  694. envp->flags = ACTIVE_FLAG;
  695. #endif
  696. }
  697. sprintf(buf, "%zX", (size_t)(len + offsetof(env_t, data)));
  698. setenv("filesize", buf);
  699. return 0;
  700. sep_err:
  701. printf("## %s: only one of \"-b\", \"-c\" or \"-t\" allowed\n", cmd);
  702. return 1;
  703. }
  704. #endif
  705. #ifdef CONFIG_CMD_IMPORTENV
  706. /*
  707. * env import [-d] [-t | -b | -c] addr [size]
  708. * -d: delete existing environment before importing;
  709. * otherwise overwrite / append to existion definitions
  710. * -t: assume text format; either "size" must be given or the
  711. * text data must be '\0' terminated
  712. * -b: assume binary format ('\0' separated, "\0\0" terminated)
  713. * -c: assume checksum protected environment format
  714. * addr: memory address to read from
  715. * size: length of input data; if missing, proper '\0'
  716. * termination is mandatory
  717. */
  718. static int do_env_import(cmd_tbl_t *cmdtp, int flag,
  719. int argc, char * const argv[])
  720. {
  721. char *cmd, *addr;
  722. char sep = '\n';
  723. int chk = 0;
  724. int fmt = 0;
  725. int del = 0;
  726. size_t size;
  727. cmd = *argv;
  728. while (--argc > 0 && **++argv == '-') {
  729. char *arg = *argv;
  730. while (*++arg) {
  731. switch (*arg) {
  732. case 'b': /* raw binary format */
  733. if (fmt++)
  734. goto sep_err;
  735. sep = '\0';
  736. break;
  737. case 'c': /* external checksum format */
  738. if (fmt++)
  739. goto sep_err;
  740. sep = '\0';
  741. chk = 1;
  742. break;
  743. case 't': /* text format */
  744. if (fmt++)
  745. goto sep_err;
  746. sep = '\n';
  747. break;
  748. case 'd':
  749. del = 1;
  750. break;
  751. default:
  752. return CMD_RET_USAGE;
  753. }
  754. }
  755. }
  756. if (argc < 1)
  757. return CMD_RET_USAGE;
  758. if (!fmt)
  759. printf("## Warning: defaulting to text format\n");
  760. addr = (char *)simple_strtoul(argv[0], NULL, 16);
  761. if (argc == 2) {
  762. size = simple_strtoul(argv[1], NULL, 16);
  763. } else {
  764. char *s = addr;
  765. size = 0;
  766. while (size < MAX_ENV_SIZE) {
  767. if ((*s == sep) && (*(s+1) == '\0'))
  768. break;
  769. ++s;
  770. ++size;
  771. }
  772. if (size == MAX_ENV_SIZE) {
  773. printf("## Warning: Input data exceeds %d bytes"
  774. " - truncated\n", MAX_ENV_SIZE);
  775. }
  776. size += 2;
  777. printf("## Info: input data size = %zu = 0x%zX\n", size, size);
  778. }
  779. if (chk) {
  780. uint32_t crc;
  781. env_t *ep = (env_t *)addr;
  782. size -= offsetof(env_t, data);
  783. memcpy(&crc, &ep->crc, sizeof(crc));
  784. if (crc32(0, ep->data, size) != crc) {
  785. puts("## Error: bad CRC, import failed\n");
  786. return 1;
  787. }
  788. addr = (char *)ep->data;
  789. }
  790. if (himport_r(&env_htab, addr, size, sep, del ? 0 : H_NOCLEAR) == 0) {
  791. error("Environment import failed: errno = %d\n", errno);
  792. return 1;
  793. }
  794. gd->flags |= GD_FLG_ENV_READY;
  795. return 0;
  796. sep_err:
  797. printf("## %s: only one of \"-b\", \"-c\" or \"-t\" allowed\n",
  798. cmd);
  799. return 1;
  800. }
  801. #endif
  802. /*
  803. * New command line interface: "env" command with subcommands
  804. */
  805. static cmd_tbl_t cmd_env_sub[] = {
  806. #if defined(CONFIG_CMD_ASKENV)
  807. U_BOOT_CMD_MKENT(ask, CONFIG_SYS_MAXARGS, 1, do_env_ask, "", ""),
  808. #endif
  809. U_BOOT_CMD_MKENT(default, 1, 0, do_env_default, "", ""),
  810. U_BOOT_CMD_MKENT(delete, 2, 0, do_env_delete, "", ""),
  811. #if defined(CONFIG_CMD_EDITENV)
  812. U_BOOT_CMD_MKENT(edit, 2, 0, do_env_edit, "", ""),
  813. #endif
  814. #if defined(CONFIG_CMD_EXPORTENV)
  815. U_BOOT_CMD_MKENT(export, 4, 0, do_env_export, "", ""),
  816. #endif
  817. #if defined(CONFIG_CMD_GREPENV)
  818. U_BOOT_CMD_MKENT(grep, CONFIG_SYS_MAXARGS, 1, do_env_grep, "", ""),
  819. #endif
  820. #if defined(CONFIG_CMD_IMPORTENV)
  821. U_BOOT_CMD_MKENT(import, 5, 0, do_env_import, "", ""),
  822. #endif
  823. U_BOOT_CMD_MKENT(print, CONFIG_SYS_MAXARGS, 1, do_env_print, "", ""),
  824. #if defined(CONFIG_CMD_RUN)
  825. U_BOOT_CMD_MKENT(run, CONFIG_SYS_MAXARGS, 1, do_run, "", ""),
  826. #endif
  827. #if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE)
  828. U_BOOT_CMD_MKENT(save, 1, 0, do_env_save, "", ""),
  829. #endif
  830. U_BOOT_CMD_MKENT(set, CONFIG_SYS_MAXARGS, 0, do_env_set, "", ""),
  831. };
  832. #if defined(CONFIG_NEEDS_MANUAL_RELOC)
  833. void env_reloc(void)
  834. {
  835. fixup_cmdtable(cmd_env_sub, ARRAY_SIZE(cmd_env_sub));
  836. }
  837. #endif
  838. static int do_env(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
  839. {
  840. cmd_tbl_t *cp;
  841. if (argc < 2)
  842. return CMD_RET_USAGE;
  843. /* drop initial "env" arg */
  844. argc--;
  845. argv++;
  846. cp = find_cmd_tbl(argv[0], cmd_env_sub, ARRAY_SIZE(cmd_env_sub));
  847. if (cp)
  848. return cp->cmd(cmdtp, flag, argc, argv);
  849. return CMD_RET_USAGE;
  850. }
  851. U_BOOT_CMD(
  852. env, CONFIG_SYS_MAXARGS, 1, do_env,
  853. "environment handling commands",
  854. #if defined(CONFIG_CMD_ASKENV)
  855. "ask name [message] [size] - ask for environment variable\nenv "
  856. #endif
  857. "default -f - reset default environment\n"
  858. #if defined(CONFIG_CMD_EDITENV)
  859. "env edit name - edit environment variable\n"
  860. #endif
  861. #if defined(CONFIG_CMD_EXPORTENV)
  862. "env export [-t | -b | -c] [-s size] addr [var ...] - export environment\n"
  863. #endif
  864. #if defined(CONFIG_CMD_GREPENV)
  865. "env grep string [...] - search environment\n"
  866. #endif
  867. #if defined(CONFIG_CMD_IMPORTENV)
  868. "env import [-d] [-t | -b | -c] addr [size] - import environment\n"
  869. #endif
  870. "env print [name ...] - print environment\n"
  871. #if defined(CONFIG_CMD_RUN)
  872. "env run var [...] - run commands in an environment variable\n"
  873. #endif
  874. #if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE)
  875. "env save - save environment\n"
  876. #endif
  877. "env set [-f] name [arg ...]\n"
  878. );
  879. /*
  880. * Old command line interface, kept for compatibility
  881. */
  882. #if defined(CONFIG_CMD_EDITENV)
  883. U_BOOT_CMD_COMPLETE(
  884. editenv, 2, 0, do_env_edit,
  885. "edit environment variable",
  886. "name\n"
  887. " - edit environment variable 'name'",
  888. var_complete
  889. );
  890. #endif
  891. U_BOOT_CMD_COMPLETE(
  892. printenv, CONFIG_SYS_MAXARGS, 1, do_env_print,
  893. "print environment variables",
  894. "\n - print values of all environment variables\n"
  895. "printenv name ...\n"
  896. " - print value of environment variable 'name'",
  897. var_complete
  898. );
  899. #ifdef CONFIG_CMD_GREPENV
  900. U_BOOT_CMD_COMPLETE(
  901. grepenv, CONFIG_SYS_MAXARGS, 0, do_env_grep,
  902. "search environment variables",
  903. "string ...\n"
  904. " - list environment name=value pairs matching 'string'",
  905. var_complete
  906. );
  907. #endif
  908. U_BOOT_CMD_COMPLETE(
  909. setenv, CONFIG_SYS_MAXARGS, 0, do_env_set,
  910. "set environment variables",
  911. "name value ...\n"
  912. " - set environment variable 'name' to 'value ...'\n"
  913. "setenv name\n"
  914. " - delete environment variable 'name'",
  915. var_complete
  916. );
  917. #if defined(CONFIG_CMD_ASKENV)
  918. U_BOOT_CMD(
  919. askenv, CONFIG_SYS_MAXARGS, 1, do_env_ask,
  920. "get environment variables from stdin",
  921. "name [message] [size]\n"
  922. " - get environment variable 'name' from stdin (max 'size' chars)\n"
  923. "askenv name\n"
  924. " - get environment variable 'name' from stdin\n"
  925. "askenv name size\n"
  926. " - get environment variable 'name' from stdin (max 'size' chars)\n"
  927. "askenv name [message] size\n"
  928. " - display 'message' string and get environment variable 'name'"
  929. "from stdin (max 'size' chars)"
  930. );
  931. #endif
  932. #if defined(CONFIG_CMD_RUN)
  933. U_BOOT_CMD_COMPLETE(
  934. run, CONFIG_SYS_MAXARGS, 1, do_run,
  935. "run commands in an environment variable",
  936. "var [...]\n"
  937. " - run the commands in the environment variable(s) 'var'",
  938. var_complete
  939. );
  940. #endif