common/cmd_nvedit.c

   1 /*
   2  * (C) Copyright 2000-2002
   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  * See file CREDITS for list of people who contributed to this
   9  * project.
  10  *
  11  * This program is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU General Public License as
  13  * published by the Free Software Foundation; either version 2 of
  14  * the License, or (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  24  * MA 02111-1307 USA
  25  */
  26
  27 /**************************************************************************
  28  *
  29  * Support for persistent environment data
  30  *
  31  * The "environment" is stored as a list of '\0' terminated
  32  * "name=value" strings. The end of the list is marked by a double
  33  * '\0'. New entries are always added at the end. Deleting an entry
  34  * shifts the remaining entries to the front. Replacing an entry is a
  35  * combination of deleting the old value and adding the new one.
  36  *
  37  * The environment is preceeded by a 32 bit CRC over the data part.
  38  *
  39  **************************************************************************
  40  */
  41
  42 #include <common.h>
  43 #include <command.h>
  44 #include <environment.h>
  45 #if defined(CONFIG_CMD_EDITENV)
  46 #include <malloc.h>
  47 #endif
  48 #include <watchdog.h>
  49 #include <serial.h>
  50 #include <linux/stddef.h>
  51 #include <asm/byteorder.h>
  52 #if defined(CONFIG_CMD_NET)
  53 #include <net.h>
  54 #endif
  55
  56 DECLARE_GLOBAL_DATA_PTR;
  57
  58 #if !defined(CONFIG_ENV_IS_IN_EEPROM)   && \
  59     !defined(CONFIG_ENV_IS_IN_FLASH)    && \
  60     !defined(CONFIG_ENV_IS_IN_DATAFLASH)        && \
  61     !defined(CONFIG_ENV_IS_IN_MG_DISK)  && \
  62     !defined(CONFIG_ENV_IS_IN_NAND)     && \
  63     !defined(CONFIG_ENV_IS_IN_NVRAM)    && \
  64     !defined(CONFIG_ENV_IS_IN_ONENAND)  && \
  65     !defined(CONFIG_ENV_IS_IN_SPI_FLASH)        && \
  66     !defined(CONFIG_ENV_IS_NOWHERE)
  67 # error Define one of CONFIG_ENV_IS_IN_{EEPROM|FLASH|DATAFLASH|ONENAND|\
  68 SPI_FLASH|MG_DISK|NVRAM|NOWHERE}
  69 #endif
  70
  71 #define XMK_STR(x)      #x
  72 #define MK_STR(x)       XMK_STR(x)
  73
  74 /************************************************************************
  75 ************************************************************************/
  76
  77 /*
  78  * Table with supported baudrates (defined in config_xyz.h)
  79  */
  80 static const unsigned long baudrate_table[] = CONFIG_SYS_BAUDRATE_TABLE;
  81 #define N_BAUDRATES (sizeof(baudrate_table) / sizeof(baudrate_table[0]))
  82
  83 /*
  84  * This variable is incremented on each do_setenv (), 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
  92 int get_env_id (void)
  93 {
  94         return env_id;
  95 }
  96 /************************************************************************
  97  * Command interface: print one or all environment variables
  98  */
  99
 100 /*
 101  * state 0: finish printing this string and return (matched!)
 102  * state 1: no matching to be done; print everything
 103  * state 2: continue searching for matched name
 104  */
 105 static int printenv(char *name, int state)
 106 {
 107         int i, j;
 108         char c, buf[17];
 109
 110         i = 0;
 111         buf[16] = '\0';
 112
 113         while (state && env_get_char(i) != '\0') {
 114                 if (state == 2 && envmatch((uchar *)name, i) >= 0)
 115                         state = 0;
 116
 117                 j = 0;
 118                 do {
 119                         buf[j++] = c = env_get_char(i++);
 120                         if (j == sizeof(buf) - 1) {
 121                                 if (state <= 1)
 122                                         puts(buf);
 123                                 j = 0;
 124                         }
 125                 } while (c != '\0');
 126
 127                 if (state <= 1) {
 128                         if (j)
 129                                 puts(buf);
 130                         putc('\n');
 131                 }
 132
 133                 if (ctrlc())
 134                         return -1;
 135         }
 136
 137         if (state == 0)
 138                 i = 0;
 139         return i;
 140 }
 141
 142 int do_printenv (cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 143 {
 144         int i;
 145         int rcode = 0;
 146
 147         if (argc == 1) {
 148                 /* print all env vars */
 149                 rcode = printenv(NULL, 1);
 150                 if (rcode < 0)
 151                         return 1;
 152                 printf("\nEnvironment size: %d/%ld bytes\n",
 153                         rcode, (ulong)ENV_SIZE);
 154                 return 0;
 155         }
 156
 157         /* print selected env vars */
 158         for (i = 1; i < argc; ++i) {
 159                 char *name = argv[i];
 160                 if (printenv(name, 2)) {
 161                         printf("## Error: \"%s\" not defined\n", name);
 162                         ++rcode;
 163                 }
 164         }
 165
 166         return rcode;
 167 }
 168
 169 /************************************************************************
 170  * Set a new environment variable,
 171  * or replace or delete an existing one.
 172  *
 173  * This function will ONLY work with a in-RAM copy of the environment
 174  */
 175
 176 int _do_setenv (int flag, int argc, char * const argv[])
 177 {
 178         int   i, len, oldval;
 179         int   console = -1;
 180         uchar *env, *nxt = NULL;
 181         char *name;
 182         bd_t *bd = gd->bd;
 183
 184         uchar *env_data = env_get_addr(0);
 185
 186         if (!env_data)  /* need copy in RAM */
 187                 return 1;
 188
 189         name = argv[1];
 190
 191         if (strchr(name, '=')) {
 192                 printf ("## Error: illegal character '=' in variable name \"%s\"\n", name);
 193                 return 1;
 194         }
 195
 196         env_id++;
 197         /*
 198          * search if variable with this name already exists
 199          */
 200         oldval = -1;
 201         for (env=env_data; *env; env=nxt+1) {
 202                 for (nxt=env; *nxt; ++nxt)
 203                         ;
 204                 if ((oldval = envmatch((uchar *)name, env-env_data)) >= 0)
 205                         break;
 206         }
 207
 208         /* Check for console redirection */
 209         if (strcmp(name,"stdin") == 0) {
 210                 console = stdin;
 211         } else if (strcmp(name,"stdout") == 0) {
 212                 console = stdout;
 213         } else if (strcmp(name,"stderr") == 0) {
 214                 console = stderr;
 215         }
 216
 217         if (console != -1) {
 218                 if (argc < 3) {         /* Cannot delete it! */
 219                         printf("Can't delete \"%s\"\n", name);
 220                         return 1;
 221                 }
 222
 223 #ifdef CONFIG_CONSOLE_MUX
 224                 i = iomux_doenv(console, argv[2]);
 225                 if (i)
 226                         return i;
 227 #else
 228                 /* Try assigning specified device */
 229                 if (console_assign (console, argv[2]) < 0)
 230                         return 1;
 231
 232 #ifdef CONFIG_SERIAL_MULTI
 233                 if (serial_assign (argv[2]) < 0)
 234                         return 1;
 235 #endif
 236 #endif /* CONFIG_CONSOLE_MUX */
 237         }
 238
 239         /*
 240          * Delete any existing definition
 241          */
 242         if (oldval >= 0) {
 243 #ifndef CONFIG_ENV_OVERWRITE
 244
 245                 /*
 246                  * Ethernet Address and serial# can be set only once,
 247                  * ver is readonly.
 248                  */
 249                 if (
 250 #ifdef CONFIG_HAS_UID
 251                 /* Allow serial# forced overwrite with 0xdeaf4add flag */
 252                     ((strcmp (name, "serial#") == 0) && (flag != 0xdeaf4add)) ||
 253 #else
 254                     (strcmp (name, "serial#") == 0) ||
 255 #endif
 256                     ((strcmp (name, "ethaddr") == 0)
 257 #if defined(CONFIG_OVERWRITE_ETHADDR_ONCE) && defined(CONFIG_ETHADDR)
 258                      && (strcmp ((char *)env_get_addr(oldval),MK_STR(CONFIG_ETHADDR)) != 0)
 259 #endif  /* CONFIG_OVERWRITE_ETHADDR_ONCE && CONFIG_ETHADDR */
 260                     ) ) {
 261                         printf ("Can't overwrite \"%s\"\n", name);
 262                         return 1;
 263                 }
 264 #endif
 265
 266                 /*
 267                  * Switch to new baudrate if new baudrate is supported
 268                  */
 269                 if (strcmp(argv[1],"baudrate") == 0) {
 270                         int baudrate = simple_strtoul(argv[2], NULL, 10);
 271                         int i;
 272                         for (i=0; i<N_BAUDRATES; ++i) {
 273                                 if (baudrate == baudrate_table[i])
 274                                         break;
 275                         }
 276                         if (i == N_BAUDRATES) {
 277                                 printf ("## Baudrate %d bps not supported\n",
 278                                         baudrate);
 279                                 return 1;
 280                         }
 281                         printf ("## Switch baudrate to %d bps and press ENTER ...\n",
 282                                 baudrate);
 283                         udelay(50000);
 284                         gd->baudrate = baudrate;
 285 #if defined(CONFIG_PPC) || defined(CONFIG_MCF52x2)
 286                         gd->bd->bi_baudrate = baudrate;
 287 #endif
 288
 289                         serial_setbrg ();
 290                         udelay(50000);
 291                         for (;;) {
 292                                 if (getc() == '\r')
 293                                       break;
 294                         }
 295                 }
 296
 297                 if (*++nxt == '\0') {
 298                         if (env > env_data) {
 299                                 env--;
 300                         } else {
 301                                 *env = '\0';
 302                         }
 303                 } else {
 304                         for (;;) {
 305                                 *env = *nxt++;
 306                                 if ((*env == '\0') && (*nxt == '\0'))
 307                                         break;
 308                                 ++env;
 309                         }
 310                 }
 311                 *++env = '\0';
 312         }
 313
 314         /* Delete only ? */
 315         if ((argc < 3) || argv[2] == NULL) {
 316                 env_crc_update ();
 317                 return 0;
 318         }
 319
 320         /*
 321          * Append new definition at the end
 322          */
 323         for (env=env_data; *env || *(env+1); ++env)
 324                 ;
 325         if (env > env_data)
 326                 ++env;
 327         /*
 328          * Overflow when:
 329          * "name" + "=" + "val" +"\0\0"  > ENV_SIZE - (env-env_data)
 330          */
 331         len = strlen(name) + 2;
 332         /* add '=' for first arg, ' ' for all others */
 333         for (i=2; i<argc; ++i) {
 334                 len += strlen(argv[i]) + 1;
 335         }
 336         if (len > (&env_data[ENV_SIZE]-env)) {
 337                 printf ("## Error: environment overflow, \"%s\" deleted\n", name);
 338                 return 1;
 339         }
 340         while ((*env = *name++) != '\0')
 341                 env++;
 342         for (i=2; i<argc; ++i) {
 343                 char *val = argv[i];
 344
 345                 *env = (i==2) ? '=' : ' ';
 346                 while ((*++env = *val++) != '\0')
 347                         ;
 348         }
 349
 350         /* end is marked with double '\0' */
 351         *++env = '\0';
 352
 353         /* Update CRC */
 354         env_crc_update ();
 355
 356         /*
 357          * Some variables should be updated when the corresponding
 358          * entry in the enviornment is changed
 359          */
 360
 361         if (strcmp(argv[1],"ethaddr") == 0)
 362                 return 0;
 363
 364         if (strcmp(argv[1],"ipaddr") == 0) {
 365                 char *s = argv[2];      /* always use only one arg */
 366                 char *e;
 367                 unsigned long addr;
 368                 bd->bi_ip_addr = 0;
 369                 for (addr=0, i=0; i<4; ++i) {
 370                         ulong val = s ? simple_strtoul(s, &e, 10) : 0;
 371                         addr <<= 8;
 372                         addr  |= (val & 0xFF);
 373                         if (s) s = (*e) ? e+1 : e;
 374                 }
 375                 bd->bi_ip_addr = htonl(addr);
 376                 return 0;
 377         }
 378         if (strcmp(argv[1],"loadaddr") == 0) {
 379                 load_addr = simple_strtoul(argv[2], NULL, 16);
 380                 return 0;
 381         }
 382 #if defined(CONFIG_CMD_NET)
 383         if (strcmp(argv[1],"bootfile") == 0) {
 384                 copy_filename (BootFile, argv[2], sizeof(BootFile));
 385                 return 0;
 386         }
 387 #endif
 388         return 0;
 389 }
 390
 391 int setenv (char *varname, char *varvalue)
 392 {
 393         char * const argv[4] = { "setenv", varname, varvalue, NULL };
 394         if ((varvalue == NULL) || (varvalue[0] == '\0'))
 395                 return _do_setenv (0, 2, argv);
 396         else
 397                 return _do_setenv (0, 3, argv);
 398 }
 399
 400 #ifdef CONFIG_HAS_UID
 401 void forceenv (char *varname, char *varvalue)
 402 {
 403         char * const argv[4] = { "forceenv", varname, varvalue, NULL };
 404         _do_setenv (0xdeaf4add, 3, argv);
 405 }
 406 #endif
 407
 408 int do_setenv (cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 409 {
 410         if (argc < 2)
 411                 return cmd_usage(cmdtp);
 412
 413         return _do_setenv (flag, argc, argv);
 414 }
 415
 416 /************************************************************************
 417  * Prompt for environment variable
 418  */
 419
 420 #if defined(CONFIG_CMD_ASKENV)
 421 int do_askenv ( cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 422 {
 423         extern char console_buffer[CONFIG_SYS_CBSIZE];
 424         char message[CONFIG_SYS_CBSIZE];
 425         int size = CONFIG_SYS_CBSIZE - 1;
 426         int len;
 427         char *local_args[4];
 428
 429         local_args[0] = argv[0];
 430         local_args[1] = argv[1];
 431         local_args[2] = NULL;
 432         local_args[3] = NULL;
 433
 434         if (argc < 2)
 435                 return cmd_usage(cmdtp);
 436
 437         /* Check the syntax */
 438         switch (argc) {
 439         case 1:
 440                 return cmd_usage(cmdtp);
 441
 442         case 2:         /* askenv envname */
 443                 sprintf (message, "Please enter '%s':", argv[1]);
 444                 break;
 445
 446         case 3:         /* askenv envname size */
 447                 sprintf (message, "Please enter '%s':", argv[1]);
 448                 size = simple_strtoul (argv[2], NULL, 10);
 449                 break;
 450
 451         default:        /* askenv envname message1 ... messagen size */
 452             {
 453                 int i;
 454                 int pos = 0;
 455
 456                 for (i = 2; i < argc - 1; i++) {
 457                         if (pos) {
 458                                 message[pos++] = ' ';
 459                         }
 460                         strcpy (message+pos, argv[i]);
 461                         pos += strlen(argv[i]);
 462                 }
 463                 message[pos] = '\0';
 464                 size = simple_strtoul (argv[argc - 1], NULL, 10);
 465             }
 466                 break;
 467         }
 468
 469         if (size >= CONFIG_SYS_CBSIZE)
 470                 size = CONFIG_SYS_CBSIZE - 1;
 471
 472         if (size <= 0)
 473                 return 1;
 474
 475         /* prompt for input */
 476         len = readline (message);
 477
 478         if (size < len)
 479                 console_buffer[size] = '\0';
 480
 481         len = 2;
 482         if (console_buffer[0] != '\0') {
 483                 local_args[2] = console_buffer;
 484                 len = 3;
 485         }
 486
 487         /* Continue calling setenv code */
 488         return _do_setenv (flag, len, local_args);
 489 }
 490 #endif
 491
 492 /************************************************************************
 493  * Interactively edit an environment variable
 494  */
 495 #if defined(CONFIG_CMD_EDITENV)
 496 int do_editenv(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 497 {
 498         char buffer[CONFIG_SYS_CBSIZE];
 499         char *init_val;
 500         int len;
 501
 502         if (argc < 2)
 503                 return cmd_usage(cmdtp);
 504
 505         /* Set read buffer to initial value or empty sting */
 506         init_val = getenv(argv[1]);
 507         if (init_val)
 508                 len = sprintf(buffer, "%s", init_val);
 509         else
 510                 buffer[0] = '\0';
 511
 512         readline_into_buffer("edit: ", buffer);
 513
 514         return setenv(argv[1], buffer);
 515 }
 516 #endif /* CONFIG_CMD_EDITENV */
 517
 518 /************************************************************************
 519  * Look up variable from environment,
 520  * return address of storage for that variable,
 521  * or NULL if not found
 522  */
 523
 524 char *getenv (char *name)
 525 {
 526         int i, nxt;
 527
 528         WATCHDOG_RESET();
 529
 530         for (i=0; env_get_char(i) != '\0'; i=nxt+1) {
 531                 int val;
 532
 533                 for (nxt=i; env_get_char(nxt) != '\0'; ++nxt) {
 534                         if (nxt >= CONFIG_ENV_SIZE) {
 535                                 return (NULL);
 536                         }
 537                 }
 538                 if ((val=envmatch((uchar *)name, i)) < 0)
 539                         continue;
 540                 return ((char *)env_get_addr(val));
 541         }
 542
 543         return (NULL);
 544 }
 545
 546 int getenv_r (char *name, char *buf, unsigned len)
 547 {
 548         int i, nxt;
 549
 550         for (i=0; env_get_char(i) != '\0'; i=nxt+1) {
 551                 int val, n;
 552
 553                 for (nxt=i; env_get_char(nxt) != '\0'; ++nxt) {
 554                         if (nxt >= CONFIG_ENV_SIZE) {
 555                                 return (-1);
 556                         }
 557                 }
 558                 if ((val=envmatch((uchar *)name, i)) < 0)
 559                         continue;
 560                 /* found; copy out */
 561                 n = 0;
 562                 while ((len > n++) && (*buf++ = env_get_char(val++)) != '\0')
 563                         ;
 564                 if (len == n)
 565                         *buf = '\0';
 566                 return (n);
 567         }
 568         return (-1);
 569 }
 570
 571 #if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE)
 572
 573 int do_saveenv (cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 574 {
 575         extern char * env_name_spec;
 576
 577         printf ("Saving Environment to %s...\n", env_name_spec);
 578
 579         return (saveenv() ? 1 : 0);
 580 }
 581
 582 U_BOOT_CMD(
 583         saveenv, 1, 0,  do_saveenv,
 584         "save environment variables to persistent storage",
 585         ""
 586 );
 587
 588 #endif
 589
 590
 591 /************************************************************************
 592  * Match a name / name=value pair
 593  *
 594  * s1 is either a simple 'name', or a 'name=value' pair.
 595  * i2 is the environment index for a 'name2=value2' pair.
 596  * If the names match, return the index for the value2, else NULL.
 597  */
 598
 599 int envmatch (uchar *s1, int i2)
 600 {
 601
 602         while (*s1 == env_get_char(i2++))
 603                 if (*s1++ == '=')
 604                         return(i2);
 605         if (*s1 == '\0' && env_get_char(i2-1) == '=')
 606                 return(i2);
 607         return(-1);
 608 }
 609
 610
 611 /**************************************************/
 612
 613 #if defined(CONFIG_CMD_EDITENV)
 614 U_BOOT_CMD(
 615         editenv, 2, 0,  do_editenv,
 616         "edit environment variable",
 617         "name\n"
 618         "    - edit environment variable 'name'"
 619 );
 620 #endif
 621
 622 U_BOOT_CMD(
 623         printenv, CONFIG_SYS_MAXARGS, 1,        do_printenv,
 624         "print environment variables",
 625         "\n    - print values of all environment variables\n"
 626         "printenv name ...\n"
 627         "    - print value of environment variable 'name'"
 628 );
 629
 630 U_BOOT_CMD(
 631         setenv, CONFIG_SYS_MAXARGS, 0,  do_setenv,
 632         "set environment variables",
 633         "name value ...\n"
 634         "    - set environment variable 'name' to 'value ...'\n"
 635         "setenv name\n"
 636         "    - delete environment variable 'name'"
 637 );
 638
 639 #if defined(CONFIG_CMD_ASKENV)
 640
 641 U_BOOT_CMD(
 642         askenv, CONFIG_SYS_MAXARGS,     1,      do_askenv,
 643         "get environment variables from stdin",
 644         "name [message] [size]\n"
 645         "    - get environment variable 'name' from stdin (max 'size' chars)\n"
 646         "askenv name\n"
 647         "    - get environment variable 'name' from stdin\n"
 648         "askenv name size\n"
 649         "    - get environment variable 'name' from stdin (max 'size' chars)\n"
 650         "askenv name [message] size\n"
 651         "    - display 'message' string and get environment variable 'name'"
 652         "from stdin (max 'size' chars)"
 653 );
 654 #endif
 655
 656 #if defined(CONFIG_CMD_RUN)
 657 int do_run (cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
 658 U_BOOT_CMD(
 659         run,    CONFIG_SYS_MAXARGS,     1,      do_run,
 660         "run commands in an environment variable",
 661         "var [...]\n"
 662         "    - run the commands in the environment variable(s) 'var'"
 663 );
 664 #endif