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