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