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