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