Merge with git://www.denx.de/git/u-boot.git
[platform/kernel/u-boot.git] / 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 (CONFIG_COMMANDS & CFG_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_NOWHERE)
61 # error Define one of CFG_ENV_IS_IN_{NVRAM|EEPROM|FLASH|DATAFLASH|NOWHERE}
62 #endif
63
64 #define XMK_STR(x)      #x
65 #define MK_STR(x)       XMK_STR(x)
66
67 /************************************************************************
68 ************************************************************************/
69
70 /* Function that returns a character from the environment */
71 extern uchar (*env_get_char)(int);
72
73 /* Function that returns a pointer to a value from the environment */
74 /* (Only memory version supported / needed). */
75 extern uchar *env_get_addr(int);
76
77 /* Function that updates CRC of the enironment */
78 extern void env_crc_update (void);
79
80 /************************************************************************
81 ************************************************************************/
82
83 static int envmatch (uchar *, int);
84
85 /*
86  * Table with supported baudrates (defined in config_xyz.h)
87  */
88 static const unsigned long baudrate_table[] = CFG_BAUDRATE_TABLE;
89 #define N_BAUDRATES (sizeof(baudrate_table) / sizeof(baudrate_table[0]))
90
91
92 /************************************************************************
93  * Command interface: print one or all environment variables
94  */
95
96 int do_printenv (cmd_tbl_t *cmdtp, int flag, int argc, char *argv[])
97 {
98         int i, j, k, nxt;
99         int rcode = 0;
100
101         if (argc == 1) {                /* Print all env variables      */
102                 for (i=0; env_get_char(i) != '\0'; i=nxt+1) {
103                         for (nxt=i; env_get_char(nxt) != '\0'; ++nxt)
104                                 ;
105                         for (k=i; k<nxt; ++k)
106                                 putc(env_get_char(k));
107                         putc  ('\n');
108
109                         if (ctrlc()) {
110                                 puts ("\n ** Abort\n");
111                                 return 1;
112                         }
113                 }
114
115                 printf("\nEnvironment size: %d/%d bytes\n", i, ENV_SIZE);
116
117                 return 0;
118         }
119
120         for (i=1; i<argc; ++i) {        /* print single env variables   */
121                 char *name = argv[i];
122
123                 k = -1;
124
125                 for (j=0; env_get_char(j) != '\0'; j=nxt+1) {
126
127                         for (nxt=j; env_get_char(nxt) != '\0'; ++nxt)
128                                 ;
129                         k = envmatch((uchar *)name, j);
130                         if (k < 0) {
131                                 continue;
132                         }
133                         puts (name);
134                         putc ('=');
135                         while (k < nxt)
136                                 putc(env_get_char(k++));
137                         putc ('\n');
138                         break;
139                 }
140                 if (k < 0) {
141                         printf ("## Error: \"%s\" not defined\n", name);
142                         rcode ++;
143                 }
144         }
145         return rcode;
146 }
147
148 /************************************************************************
149  * Set a new environment variable,
150  * or replace or delete an existing one.
151  *
152  * This function will ONLY work with a in-RAM copy of the environment
153  */
154
155 int _do_setenv (int flag, int argc, char *argv[])
156 {
157         int   i, len, oldval;
158         int   console = -1;
159         uchar *env, *nxt = NULL;
160         char *name;
161         bd_t *bd = gd->bd;
162
163         uchar *env_data = env_get_addr(0);
164
165         if (!env_data)  /* need copy in RAM */
166                 return 1;
167
168         name = argv[1];
169
170         if (strchr(name, '=')) {
171                 printf ("## Error: illegal character '=' in variable name \"%s\"\n", name);
172                 return 1;
173         }
174
175         /*
176          * search if variable with this name already exists
177          */
178         oldval = -1;
179         for (env=env_data; *env; env=nxt+1) {
180                 for (nxt=env; *nxt; ++nxt)
181                         ;
182                 if ((oldval = envmatch((uchar *)name, env-env_data)) >= 0)
183                         break;
184         }
185
186         /*
187          * Delete any existing definition
188          */
189         if (oldval >= 0) {
190 #ifndef CONFIG_ENV_OVERWRITE
191
192                 /*
193                  * Ethernet Address and serial# can be set only once,
194                  * ver is readonly.
195                  */
196                 if ( (strcmp (name, "serial#") == 0) ||
197                     ((strcmp (name, "ethaddr") == 0)
198 #if defined(CONFIG_OVERWRITE_ETHADDR_ONCE) && defined(CONFIG_ETHADDR)
199                      && (strcmp ((char *)env_get_addr(oldval),MK_STR(CONFIG_ETHADDR)) != 0)
200 #endif  /* CONFIG_OVERWRITE_ETHADDR_ONCE && CONFIG_ETHADDR */
201                     ) ) {
202                         printf ("Can't overwrite \"%s\"\n", name);
203                         return 1;
204                 }
205 #endif
206
207                 /* Check for console redirection */
208                 if (strcmp(name,"stdin") == 0) {
209                         console = stdin;
210                 } else if (strcmp(name,"stdout") == 0) {
211                         console = stdout;
212                 } else if (strcmp(name,"stderr") == 0) {
213                         console = stderr;
214                 }
215
216                 if (console != -1) {
217                         if (argc < 3) {         /* Cannot delete it! */
218                                 printf("Can't delete \"%s\"\n", name);
219                                 return 1;
220                         }
221
222                         /* Try assigning specified device */
223                         if (console_assign (console, argv[2]) < 0)
224                                 return 1;
225
226 #ifdef CONFIG_SERIAL_MULTI
227                         if (serial_assign (argv[2]) < 0)
228                                 return 1;
229 #endif
230                 }
231
232                 /*
233                  * Switch to new baudrate if new baudrate is supported
234                  */
235                 if (strcmp(argv[1],"baudrate") == 0) {
236                         int baudrate = simple_strtoul(argv[2], NULL, 10);
237                         int i;
238                         for (i=0; i<N_BAUDRATES; ++i) {
239                                 if (baudrate == baudrate_table[i])
240                                         break;
241                         }
242                         if (i == N_BAUDRATES) {
243                                 printf ("## Baudrate %d bps not supported\n",
244                                         baudrate);
245                                 return 1;
246                         }
247                         printf ("## Switch baudrate to %d bps and press ENTER ...\n",
248                                 baudrate);
249                         udelay(50000);
250                         gd->baudrate = baudrate;
251 #if defined(CONFIG_PPC) || defined(CONFIG_MCF52x2)
252                         gd->bd->bi_baudrate = baudrate;
253 #endif
254
255                         serial_setbrg ();
256                         udelay(50000);
257                         for (;;) {
258                                 if (getc() == '\r')
259                                       break;
260                         }
261                 }
262
263                 if (*++nxt == '\0') {
264                         if (env > env_data) {
265                                 env--;
266                         } else {
267                                 *env = '\0';
268                         }
269                 } else {
270                         for (;;) {
271                                 *env = *nxt++;
272                                 if ((*env == '\0') && (*nxt == '\0'))
273                                         break;
274                                 ++env;
275                         }
276                 }
277                 *++env = '\0';
278         }
279
280 #ifdef CONFIG_NET_MULTI
281         if (strncmp(name, "eth", 3) == 0) {
282                 char *end;
283                 int   num = simple_strtoul(name+3, &end, 10);
284
285                 if (strcmp(end, "addr") == 0) {
286                         eth_set_enetaddr(num, argv[2]);
287                 }
288         }
289 #endif
290
291
292         /* Delete only ? */
293         if ((argc < 3) || argv[2] == NULL) {
294                 env_crc_update ();
295                 return 0;
296         }
297
298         /*
299          * Append new definition at the end
300          */
301         for (env=env_data; *env || *(env+1); ++env)
302                 ;
303         if (env > env_data)
304                 ++env;
305         /*
306          * Overflow when:
307          * "name" + "=" + "val" +"\0\0"  > ENV_SIZE - (env-env_data)
308          */
309         len = strlen(name) + 2;
310         /* add '=' for first arg, ' ' for all others */
311         for (i=2; i<argc; ++i) {
312                 len += strlen(argv[i]) + 1;
313         }
314         if (len > (&env_data[ENV_SIZE]-env)) {
315                 printf ("## Error: environment overflow, \"%s\" deleted\n", name);
316                 return 1;
317         }
318         while ((*env = *name++) != '\0')
319                 env++;
320         for (i=2; i<argc; ++i) {
321                 char *val = argv[i];
322
323                 *env = (i==2) ? '=' : ' ';
324                 while ((*++env = *val++) != '\0')
325                         ;
326         }
327
328         /* end is marked with double '\0' */
329         *++env = '\0';
330
331         /* Update CRC */
332         env_crc_update ();
333
334         /*
335          * Some variables should be updated when the corresponding
336          * entry in the enviornment is changed
337          */
338
339         if (strcmp(argv[1],"ethaddr") == 0) {
340                 char *s = argv[2];      /* always use only one arg */
341                 char *e;
342                 for (i=0; i<6; ++i) {
343                         bd->bi_enetaddr[i] = s ? simple_strtoul(s, &e, 16) : 0;
344                         if (s) s = (*e) ? e+1 : e;
345                 }
346 #ifdef CONFIG_NET_MULTI
347                 eth_set_enetaddr(0, argv[2]);
348 #endif
349                 return 0;
350         }
351
352         if (strcmp(argv[1],"ipaddr") == 0) {
353                 char *s = argv[2];      /* always use only one arg */
354                 char *e;
355                 unsigned long addr;
356                 bd->bi_ip_addr = 0;
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) s = (*e) ? e+1 : e;
362                 }
363                 bd->bi_ip_addr = htonl(addr);
364                 return 0;
365         }
366         if (strcmp(argv[1],"loadaddr") == 0) {
367                 load_addr = simple_strtoul(argv[2], NULL, 16);
368                 return 0;
369         }
370 #if (CONFIG_COMMANDS & CFG_CMD_NET)
371         if (strcmp(argv[1],"bootfile") == 0) {
372                 copy_filename (BootFile, argv[2], sizeof(BootFile));
373                 return 0;
374         }
375 #endif  /* CFG_CMD_NET */
376
377 #ifdef CONFIG_AMIGAONEG3SE
378         if (strcmp(argv[1], "vga_fg_color") == 0 ||
379             strcmp(argv[1], "vga_bg_color") == 0 ) {
380                 extern void video_set_color(unsigned char attr);
381                 extern unsigned char video_get_attr(void);
382
383                 video_set_color(video_get_attr());
384                 return 0;
385         }
386 #endif  /* CONFIG_AMIGAONEG3SE */
387
388         return 0;
389 }
390
391 void setenv (char *varname, char *varvalue)
392 {
393         char *argv[4] = { "setenv", varname, varvalue, NULL };
394         if (varvalue == NULL)
395                 _do_setenv (0, 2, argv);
396         else
397                 _do_setenv (0, 3, argv);
398 }
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 (CONFIG_COMMANDS & CFG_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  /* CFG_CMD_ASKENV */
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     ((CONFIG_COMMANDS & (CFG_CMD_ENV|CFG_CMD_FLASH)) == \
543       (CFG_CMD_ENV|CFG_CMD_FLASH)) || \
544     ((CONFIG_COMMANDS & (CFG_CMD_ENV|CFG_CMD_NAND)) == \
545       (CFG_CMD_ENV|CFG_CMD_NAND))
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
556 #endif
557
558
559 /************************************************************************
560  * Match a name / name=value pair
561  *
562  * s1 is either a simple 'name', or a 'name=value' pair.
563  * i2 is the environment index for a 'name2=value2' pair.
564  * If the names match, return the index for the value2, else NULL.
565  */
566
567 static int
568 envmatch (uchar *s1, int i2)
569 {
570
571         while (*s1 == env_get_char(i2++))
572                 if (*s1++ == '=')
573                         return(i2);
574         if (*s1 == '\0' && env_get_char(i2-1) == '=')
575                 return(i2);
576         return(-1);
577 }
578
579
580 /**************************************************/
581
582 U_BOOT_CMD(
583         printenv, CFG_MAXARGS, 1,       do_printenv,
584         "printenv- print environment variables\n",
585         "\n    - print values of all environment variables\n"
586         "printenv name ...\n"
587         "    - print value of environment variable 'name'\n"
588 );
589
590 U_BOOT_CMD(
591         setenv, CFG_MAXARGS, 0, do_setenv,
592         "setenv  - set environment variables\n",
593         "name value ...\n"
594         "    - set environment variable 'name' to 'value ...'\n"
595         "setenv name\n"
596         "    - delete environment variable 'name'\n"
597 );
598
599 #if defined(CFG_ENV_IS_IN_NVRAM) || defined(CFG_ENV_IS_IN_EEPROM) || \
600     ((CONFIG_COMMANDS & (CFG_CMD_ENV|CFG_CMD_FLASH)) == \
601       (CFG_CMD_ENV|CFG_CMD_FLASH)) || \
602     ((CONFIG_COMMANDS & (CFG_CMD_ENV|CFG_CMD_NAND)) == \
603       (CFG_CMD_ENV|CFG_CMD_NAND))
604 U_BOOT_CMD(
605         saveenv, 1, 0,  do_saveenv,
606         "saveenv - save environment variables to persistent storage\n",
607         NULL
608 );
609
610 #endif  /* CFG_CMD_ENV */
611
612 #if (CONFIG_COMMANDS & CFG_CMD_ASKENV)
613
614 U_BOOT_CMD(
615         askenv, CFG_MAXARGS,    1,      do_askenv,
616         "askenv  - get environment variables from stdin\n",
617         "name [message] [size]\n"
618         "    - get environment variable 'name' from stdin (max 'size' chars)\n"
619         "askenv name\n"
620         "    - get environment variable 'name' from stdin\n"
621         "askenv name size\n"
622         "    - get environment variable 'name' from stdin (max 'size' chars)\n"
623         "askenv name [message] size\n"
624         "    - display 'message' string and get environment variable 'name'"
625         "from stdin (max 'size' chars)\n"
626 );
627 #endif  /* CFG_CMD_ASKENV */
628
629 #if (CONFIG_COMMANDS & CFG_CMD_RUN)
630 int do_run (cmd_tbl_t *cmdtp, int flag, int argc, char *argv[]);
631 U_BOOT_CMD(
632         run,    CFG_MAXARGS,    1,      do_run,
633         "run     - run commands in an environment variable\n",
634         "var [...]\n"
635         "    - run the commands in the environment variable(s) 'var'\n"
636 );
637 #endif  /* CFG_CMD_RUN */