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