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                  */
 185                 if ( (strcmp (name, "serial#") == 0) ||
 186                     ((strcmp (name, "ethaddr") == 0)
 187 #if defined(CONFIG_OVERWRITE_ETHADDR_ONCE) && defined(CONFIG_ETHADDR)
 188                      && (strcmp (env_get_addr(oldval),MK_STR(CONFIG_ETHADDR)) != 0)
 189 #endif  /* CONFIG_OVERWRITE_ETHADDR_ONCE && CONFIG_ETHADDR */
 190                     ) ) {
 191                         printf ("Can't overwrite \"%s\"\n", name);
 192                         return 1;
 193                 }
 194 #endif
 195
 196                 /* Check for console redirection */
 197                 if (strcmp(name,"stdin") == 0) {
 198                         console = stdin;
 199                 } else if (strcmp(name,"stdout") == 0) {
 200                         console = stdout;
 201                 } else if (strcmp(name,"stderr") == 0) {
 202                         console = stderr;
 203                 }
 204
 205                 if (console != -1) {
 206                         if (argc < 3) {         /* Cannot delete it! */
 207                                 printf("Can't delete \"%s\"\n", name);
 208                                 return 1;
 209                         }
 210
 211                         /* Try assigning specified device */
 212                         if (console_assign (console, argv[2]) < 0)
 213                                 return 1;
 214                 }
 215
 216                 /*
 217                  * Switch to new baudrate if new baudrate is supported
 218                  */
 219                 if (strcmp(argv[1],"baudrate") == 0) {
 220                         int baudrate = simple_strtoul(argv[2], NULL, 10);
 221                         int i;
 222                         for (i=0; i<N_BAUDRATES; ++i) {
 223                                 if (baudrate == baudrate_table[i])
 224                                         break;
 225                         }
 226                         if (i == N_BAUDRATES) {
 227                                 printf ("## Baudrate %d bps not supported\n",
 228                                         baudrate);
 229                                 return 1;
 230                         }
 231                         printf ("## Switch baudrate to %d bps and press ENTER ...\n",
 232                                 baudrate);
 233                         udelay(50000);
 234                         gd->baudrate = baudrate;
 235                         serial_setbrg ();
 236                         udelay(50000);
 237                         for (;;) {
 238                                 if (getc() == '\r')
 239                                       break;
 240                         }
 241                 }
 242
 243                 if (*++nxt == '\0') {
 244                         if (env > env_data) {
 245                                 env--;
 246                         } else {
 247                                 *env = '\0';
 248                         }
 249                 } else {
 250                         for (;;) {
 251                                 *env = *nxt++;
 252                                 if ((*env == '\0') && (*nxt == '\0'))
 253                                         break;
 254                                 ++env;
 255                         }
 256                 }
 257                 *++env = '\0';
 258         }
 259
 260 #ifdef CONFIG_NET_MULTI
 261         if (strncmp(name, "eth", 3) == 0) {
 262                 char *end;
 263                 int   num = simple_strtoul(name+3, &end, 10);
 264
 265                 if (strcmp(end, "addr") == 0) {
 266                         eth_set_enetaddr(num, argv[2]);
 267                 }
 268         }
 269 #endif
 270
 271
 272         /* Delete only ? */
 273         if ((argc < 3) || argv[2] == NULL) {
 274                 env_crc_update ();
 275                 return 0;
 276         }
 277
 278         /*
 279          * Append new definition at the end
 280          */
 281         for (env=env_data; *env || *(env+1); ++env)
 282                 ;
 283         if (env > env_data)
 284                 ++env;
 285         /*
 286          * Overflow when:
 287          * "name" + "=" + "val" +"\0\0"  > ENV_SIZE - (env-env_data)
 288          */
 289         len = strlen(name) + 2;
 290         /* add '=' for first arg, ' ' for all others */
 291         for (i=2; i<argc; ++i) {
 292                 len += strlen(argv[i]) + 1;
 293         }
 294         if (len > (&env_data[ENV_SIZE]-env)) {
 295                 printf ("## Error: environment overflow, \"%s\" deleted\n", name);
 296                 return 1;
 297         }
 298         while ((*env = *name++) != '\0')
 299                 env++;
 300         for (i=2; i<argc; ++i) {
 301                 char *val = argv[i];
 302
 303                 *env = (i==2) ? '=' : ' ';
 304                 while ((*++env = *val++) != '\0')
 305                         ;
 306         }
 307
 308         /* end is marked with double '\0' */
 309         *++env = '\0';
 310
 311         /* Update CRC */
 312         env_crc_update ();
 313
 314         /*
 315          * Some variables should be updated when the corresponding
 316          * entry in the enviornment is changed
 317          */
 318
 319         if (strcmp(argv[1],"ethaddr") == 0) {
 320                 char *s = argv[2];      /* always use only one arg */
 321                 char *e;
 322                 for (i=0; i<6; ++i) {
 323                         bd->bi_enetaddr[i] = s ? simple_strtoul(s, &e, 16) : 0;
 324                         if (s) s = (*e) ? e+1 : e;
 325                 }
 326 #ifdef CONFIG_NET_MULTI
 327                 eth_set_enetaddr(0, argv[2]);
 328 #endif
 329                 return 0;
 330         }
 331
 332         if (strcmp(argv[1],"ipaddr") == 0) {
 333                 char *s = argv[2];      /* always use only one arg */
 334                 char *e;
 335                 unsigned long addr;
 336                 bd->bi_ip_addr = 0;
 337                 for (addr=0, i=0; i<4; ++i) {
 338                         ulong val = s ? simple_strtoul(s, &e, 10) : 0;
 339                         addr <<= 8;
 340                         addr  |= (val & 0xFF);
 341                         if (s) s = (*e) ? e+1 : e;
 342                 }
 343                 bd->bi_ip_addr = htonl(addr);
 344                 return 0;
 345         }
 346         if (strcmp(argv[1],"loadaddr") == 0) {
 347                 load_addr = simple_strtoul(argv[2], NULL, 16);
 348                 return 0;
 349         }
 350 #if (CONFIG_COMMANDS & CFG_CMD_NET)
 351         if (strcmp(argv[1],"bootfile") == 0) {
 352                 copy_filename (BootFile, argv[2], sizeof(BootFile));
 353                 return 0;
 354         }
 355 #endif  /* CFG_CMD_NET */
 356         return 0;
 357 }
 358
 359 void setenv (char *varname, char *varvalue)
 360 {
 361         char *argv[4] = { "setenv", varname, varvalue, NULL };
 362         _do_setenv (0, 3, argv);
 363 }
 364
 365 int do_setenv ( cmd_tbl_t *cmdtp, int flag, int argc, char *argv[])
 366 {
 367         if (argc < 2) {
 368                 printf ("Usage:\n%s\n", cmdtp->usage);
 369                 return 1;
 370         }
 371
 372         return _do_setenv (flag, argc, argv);
 373 }
 374
 375 /************************************************************************
 376  * Prompt for environment variable
 377  */
 378
 379 #if (CONFIG_COMMANDS & CFG_CMD_ASKENV)
 380 int do_askenv ( cmd_tbl_t *cmdtp, int flag, int argc, char *argv[])
 381 {
 382         extern char console_buffer[CFG_CBSIZE];
 383         char message[CFG_CBSIZE];
 384         int size = CFG_CBSIZE - 1;
 385         int len;
 386         char *local_args[4];
 387
 388         local_args[0] = argv[0];
 389         local_args[1] = argv[1];
 390         local_args[2] = NULL;
 391         local_args[3] = NULL;
 392
 393         if (argc < 2) {
 394                 printf ("Usage:\n%s\n", cmdtp->usage);
 395                 return 1;
 396         }
 397         /* Check the syntax */
 398         switch (argc) {
 399         case 1:
 400                 printf ("Usage:\n%s\n", cmdtp->usage);
 401                 return 1;
 402
 403         case 2:         /* askenv envname */
 404                 sprintf (message, "Please enter '%s':", argv[1]);
 405                 break;
 406
 407         case 3:         /* askenv envname size */
 408                 sprintf (message, "Please enter '%s':", argv[1]);
 409                 size = simple_strtoul (argv[2], NULL, 10);
 410                 break;
 411
 412         default:        /* askenv envname message1 ... messagen size */
 413             {
 414                 int i;
 415                 int pos = 0;
 416
 417                 for (i = 2; i < argc - 1; i++) {
 418                         if (pos) {
 419                                 message[pos++] = ' ';
 420                         }
 421                         strcpy (message+pos, argv[i]);
 422                         pos += strlen(argv[i]);
 423                 }
 424                 message[pos] = '\0';
 425                 size = simple_strtoul (argv[argc - 1], NULL, 10);
 426             }
 427                 break;
 428         }
 429
 430         if (size >= CFG_CBSIZE)
 431                 size = CFG_CBSIZE - 1;
 432
 433         if (size <= 0)
 434                 return 1;
 435
 436         /* prompt for input */
 437         len = readline (message);
 438
 439         if (size < len)
 440                 console_buffer[size] = '\0';
 441
 442         len = 2;
 443         if (console_buffer[0] != '\0') {
 444                 local_args[2] = console_buffer;
 445                 len = 3;
 446         }
 447
 448         /* Continue calling setenv code */
 449         return _do_setenv (flag, len, local_args);
 450 }
 451 #endif  /* CFG_CMD_ASKENV */
 452
 453 /************************************************************************
 454  * Look up variable from environment,
 455  * return address of storage for that variable,
 456  * or NULL if not found
 457  */
 458
 459 char *getenv (uchar *name)
 460 {
 461         int i, nxt;
 462
 463         WATCHDOG_RESET();
 464
 465         for (i=0; env_get_char(i) != '\0'; i=nxt+1) {
 466                 int val;
 467
 468                 for (nxt=i; env_get_char(nxt) != '\0'; ++nxt) {
 469                         if (nxt >= CFG_ENV_SIZE) {
 470                                 return (NULL);
 471                         }
 472                 }
 473                 if ((val=envmatch(name, i)) < 0)
 474                         continue;
 475                 return (env_get_addr(val));
 476         }
 477
 478         return (NULL);
 479 }
 480
 481 int getenv_r (uchar *name, uchar *buf, unsigned len)
 482 {
 483         int i, nxt;
 484
 485         for (i=0; env_get_char(i) != '\0'; i=nxt+1) {
 486                 int val, n;
 487
 488                 for (nxt=i; env_get_char(nxt) != '\0'; ++nxt) {
 489                         if (nxt >= CFG_ENV_SIZE) {
 490                                 return (-1);
 491                         }
 492                 }
 493                 if ((val=envmatch(name, i)) < 0)
 494                         continue;
 495                 /* found; copy out */
 496                 n = 0;
 497                 while ((len > n++) && (*buf++ = env_get_char(val++)) != '\0')
 498                         ;
 499                 if (len == n)
 500                         *buf = '\0';
 501                 return (n);
 502         }
 503         return (-1);
 504 }
 505
 506 #if defined(CFG_ENV_IS_IN_NVRAM) || defined(CFG_ENV_IS_IN_EEPROM) || \
 507     ((CONFIG_COMMANDS & (CFG_CMD_ENV|CFG_CMD_FLASH)) == \
 508       (CFG_CMD_ENV|CFG_CMD_FLASH))
 509 int do_saveenv (cmd_tbl_t *cmdtp, int flag, int argc, char *argv[])
 510 {
 511         extern char * env_name_spec;
 512
 513         printf ("Saving Environment to %s...\n", env_name_spec);
 514
 515         return (saveenv() ? 1 : 0);
 516 }
 517 #endif
 518
 519
 520 /************************************************************************
 521  * Match a name / name=value pair
 522  *
 523  * s1 is either a simple 'name', or a 'name=value' pair.
 524  * i2 is the environment index for a 'name2=value2' pair.
 525  * If the names match, return the index for the value2, else NULL.
 526  */
 527
 528 static int
 529 envmatch (uchar *s1, int i2)
 530 {
 531
 532         while (*s1 == env_get_char(i2++))
 533                 if (*s1++ == '=')
 534                         return(i2);
 535         if (*s1 == '\0' && env_get_char(i2-1) == '=')
 536                 return(i2);
 537         return(-1);
 538 }