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