]> git.ipfire.org Git - people/ms/u-boot.git/blob - tools/env/fw_env.c
projects / people / ms / u-boot.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
NAND: add Toshiba TC58NVG0 identifier
[people/ms/u-boot.git] / tools / env / fw_env.c
1 /*
2 * (C) Copyright 2000-2008
3 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4 *
5 * (C) Copyright 2008
6 * Guennadi Liakhovetski, DENX Software Engineering, lg@denx.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 #include <errno.h>
28 #include <fcntl.h>
29 #include <stdio.h>
30 #include <stdlib.h>
31 #include <stddef.h>
32 #include <string.h>
33 #include <sys/types.h>
34 #include <sys/ioctl.h>
35 #include <sys/stat.h>
36 #include <unistd.h>
37
38 #ifdef MTD_OLD
39 # include <stdint.h>
40 # include <linux/mtd/mtd.h>
41 #else
42 # define __user /* nothing */
43 # include <mtd/mtd-user.h>
44 #endif
45
46 #include "fw_env.h"
47
48 #define WHITESPACE(c) ((c == '\t') || (c == ' '))
49
50 #define min(x, y) ({ \
51 typeof(x) _min1 = (x); \
52 typeof(y) _min2 = (y); \
53 (void) (&_min1 == &_min2); \
54 _min1 < _min2 ? _min1 : _min2; })
55
56 struct envdev_s {
57 char devname[16]; /* Device name */
58 ulong devoff; /* Device offset */
59 ulong env_size; /* environment size */
60 ulong erase_size; /* device erase size */
61 ulong env_sectors; /* number of environment sectors */
62 uint8_t mtd_type; /* type of the MTD device */
63 };
64
65 static struct envdev_s envdevices[2] =
66 {
67 {
68 .mtd_type = MTD_ABSENT,
69 }, {
70 .mtd_type = MTD_ABSENT,
71 },
72 };
73 static int dev_current;
74
75 #define DEVNAME(i) envdevices[(i)].devname
76 #define DEVOFFSET(i) envdevices[(i)].devoff
77 #define ENVSIZE(i) envdevices[(i)].env_size
78 #define DEVESIZE(i) envdevices[(i)].erase_size
79 #define ENVSECTORS(i) envdevices[(i)].env_sectors
80 #define DEVTYPE(i) envdevices[(i)].mtd_type
81
82 #define CONFIG_ENV_SIZE ENVSIZE(dev_current)
83
84 #define ENV_SIZE getenvsize()
85
86 struct env_image_single {
87 uint32_t crc; /* CRC32 over data bytes */
88 char data[];
89 };
90
91 struct env_image_redundant {
92 uint32_t crc; /* CRC32 over data bytes */
93 unsigned char flags; /* active or obsolete */
94 char data[];
95 };
96
97 enum flag_scheme {
98 FLAG_NONE,
99 FLAG_BOOLEAN,
100 FLAG_INCREMENTAL,
101 };
102
103 struct environment {
104 void *image;
105 uint32_t *crc;
106 unsigned char *flags;
107 char *data;
108 enum flag_scheme flag_scheme;
109 };
110
111 static struct environment environment = {
112 .flag_scheme = FLAG_NONE,
113 };
114
115 static int HaveRedundEnv = 0;
116
117 static unsigned char active_flag = 1;
118 /* obsolete_flag must be 0 to efficiently set it on NOR flash without erasing */
119 static unsigned char obsolete_flag = 0;
120
121
122 #define XMK_STR(x) #x
123 #define MK_STR(x) XMK_STR(x)
124
125 static char default_environment[] = {
126 #if defined(CONFIG_BOOTARGS)
127 "bootargs=" CONFIG_BOOTARGS "\0"
128 #endif
129 #if defined(CONFIG_BOOTCOMMAND)
130 "bootcmd=" CONFIG_BOOTCOMMAND "\0"
131 #endif
132 #if defined(CONFIG_RAMBOOTCOMMAND)
133 "ramboot=" CONFIG_RAMBOOTCOMMAND "\0"
134 #endif
135 #if defined(CONFIG_NFSBOOTCOMMAND)
136 "nfsboot=" CONFIG_NFSBOOTCOMMAND "\0"
137 #endif
138 #if defined(CONFIG_BOOTDELAY) && (CONFIG_BOOTDELAY >= 0)
139 "bootdelay=" MK_STR (CONFIG_BOOTDELAY) "\0"
140 #endif
141 #if defined(CONFIG_BAUDRATE) && (CONFIG_BAUDRATE >= 0)
142 "baudrate=" MK_STR (CONFIG_BAUDRATE) "\0"
143 #endif
144 #ifdef CONFIG_LOADS_ECHO
145 "loads_echo=" MK_STR (CONFIG_LOADS_ECHO) "\0"
146 #endif
147 #ifdef CONFIG_ETHADDR
148 "ethaddr=" MK_STR (CONFIG_ETHADDR) "\0"
149 #endif
150 #ifdef CONFIG_ETH1ADDR
151 "eth1addr=" MK_STR (CONFIG_ETH1ADDR) "\0"
152 #endif
153 #ifdef CONFIG_ETH2ADDR
154 "eth2addr=" MK_STR (CONFIG_ETH2ADDR) "\0"
155 #endif
156 #ifdef CONFIG_ETH3ADDR
157 "eth3addr=" MK_STR (CONFIG_ETH3ADDR) "\0"
158 #endif
159 #ifdef CONFIG_ETH4ADDR
160 "eth4addr=" MK_STR (CONFIG_ETH4ADDR) "\0"
161 #endif
162 #ifdef CONFIG_ETH5ADDR
163 "eth5addr=" MK_STR (CONFIG_ETH5ADDR) "\0"
164 #endif
165 #ifdef CONFIG_ETHPRIME
166 "ethprime=" CONFIG_ETHPRIME "\0"
167 #endif
168 #ifdef CONFIG_IPADDR
169 "ipaddr=" MK_STR (CONFIG_IPADDR) "\0"
170 #endif
171 #ifdef CONFIG_SERVERIP
172 "serverip=" MK_STR (CONFIG_SERVERIP) "\0"
173 #endif
174 #ifdef CONFIG_SYS_AUTOLOAD
175 "autoload=" CONFIG_SYS_AUTOLOAD "\0"
176 #endif
177 #ifdef CONFIG_ROOTPATH
178 "rootpath=" MK_STR (CONFIG_ROOTPATH) "\0"
179 #endif
180 #ifdef CONFIG_GATEWAYIP
181 "gatewayip=" MK_STR (CONFIG_GATEWAYIP) "\0"
182 #endif
183 #ifdef CONFIG_NETMASK
184 "netmask=" MK_STR (CONFIG_NETMASK) "\0"
185 #endif
186 #ifdef CONFIG_HOSTNAME
187 "hostname=" MK_STR (CONFIG_HOSTNAME) "\0"
188 #endif
189 #ifdef CONFIG_BOOTFILE
190 "bootfile=" MK_STR (CONFIG_BOOTFILE) "\0"
191 #endif
192 #ifdef CONFIG_LOADADDR
193 "loadaddr=" MK_STR (CONFIG_LOADADDR) "\0"
194 #endif
195 #ifdef CONFIG_PREBOOT
196 "preboot=" CONFIG_PREBOOT "\0"
197 #endif
198 #ifdef CONFIG_CLOCKS_IN_MHZ
199 "clocks_in_mhz=" "1" "\0"
200 #endif
201 #if defined(CONFIG_PCI_BOOTDELAY) && (CONFIG_PCI_BOOTDELAY > 0)
202 "pcidelay=" MK_STR (CONFIG_PCI_BOOTDELAY) "\0"
203 #endif
204 #ifdef CONFIG_EXTRA_ENV_SETTINGS
205 CONFIG_EXTRA_ENV_SETTINGS
206 #endif
207 "\0" /* Termimate struct environment data with 2 NULs */
208 };
209
210 static int flash_io (int mode);
211 static char *envmatch (char * s1, char * s2);
212 static int parse_config (void);
213
214 #if defined(CONFIG_FILE)
215 static int get_config (char *);
216 #endif
217 static inline ulong getenvsize (void)
218 {
219 ulong rc = CONFIG_ENV_SIZE - sizeof (long);
220
221 if (HaveRedundEnv)
222 rc -= sizeof (char);
223 return rc;
224 }
225
226 static char *fw_string_blank(char *s, int noblank)
227 {
228 int i;
229 int len = strlen(s);
230
231 for (i = 0; i < len; i++, s++) {
232 if ((noblank && !WHITESPACE(*s)) ||
233 (!noblank && WHITESPACE(*s)))
234 break;
235 }
236 if (i == len)
237 return NULL;
238
239 return s;
240 }
241
242 /*
243 * Search the environment for a variable.
244 * Return the value, if found, or NULL, if not found.
245 */
246 char *fw_getenv (char *name)
247 {
248 char *env, *nxt;
249
250 if (fw_env_open())
251 return NULL;
252
253 for (env = environment.data; *env; env = nxt + 1) {
254 char *val;
255
256 for (nxt = env; *nxt; ++nxt) {
257 if (nxt >= &environment.data[ENV_SIZE]) {
258 fprintf (stderr, "## Error: "
259 "environment not terminated\n");
260 return NULL;
261 }
262 }
263 val = envmatch (name, env);
264 if (!val)
265 continue;
266 return val;
267 }
268 return NULL;
269 }
270
271 /*
272 * Print the current definition of one, or more, or all
273 * environment variables
274 */
275 int fw_printenv (int argc, char *argv[])
276 {
277 char *env, *nxt;
278 int i, n_flag;
279 int rc = 0;
280
281 if (fw_env_open())
282 return -1;
283
284 if (argc == 1) { /* Print all env variables */
285 for (env = environment.data; *env; env = nxt + 1) {
286 for (nxt = env; *nxt; ++nxt) {
287 if (nxt >= &environment.data[ENV_SIZE]) {
288 fprintf (stderr, "## Error: "
289 "environment not terminated\n");
290 return -1;
291 }
292 }
293
294 printf ("%s\n", env);
295 }
296 return 0;
297 }
298
299 if (strcmp (argv[1], "-n") == 0) {
300 n_flag = 1;
301 ++argv;
302 --argc;
303 if (argc != 2) {
304 fprintf (stderr, "## Error: "
305 "`-n' option requires exactly one argument\n");
306 return -1;
307 }
308 } else {
309 n_flag = 0;
310 }
311
312 for (i = 1; i < argc; ++i) { /* print single env variables */
313 char *name = argv[i];
314 char *val = NULL;
315
316 for (env = environment.data; *env; env = nxt + 1) {
317
318 for (nxt = env; *nxt; ++nxt) {
319 if (nxt >= &environment.data[ENV_SIZE]) {
320 fprintf (stderr, "## Error: "
321 "environment not terminated\n");
322 return -1;
323 }
324 }
325 val = envmatch (name, env);
326 if (val) {
327 if (!n_flag) {
328 fputs (name, stdout);
329 putc ('=', stdout);
330 }
331 puts (val);
332 break;
333 }
334 }
335 if (!val) {
336 fprintf (stderr, "## Error: \"%s\" not defined\n", name);
337 rc = -1;
338 }
339 }
340
341 return rc;
342 }
343
344 int fw_env_close(void)
345 {
346 /*
347 * Update CRC
348 */
349 *environment.crc = crc32(0, (uint8_t *) environment.data, ENV_SIZE);
350
351 /* write environment back to flash */
352 if (flash_io(O_RDWR)) {
353 fprintf(stderr,
354 "Error: can't write fw_env to flash\n");
355 return -1;
356 }
357
358 return 0;
359 }
360
361
362 /*
363 * Set/Clear a single variable in the environment.
364 * This is called in sequence to update the environment
365 * in RAM without updating the copy in flash after each set
366 */
367 int fw_env_write(char *name, char *value)
368 {
369 int len;
370 char *env, *nxt;
371 char *oldval = NULL;
372
373 /*
374 * search if variable with this name already exists
375 */
376 for (nxt = env = environment.data; *env; env = nxt + 1) {
377 for (nxt = env; *nxt; ++nxt) {
378 if (nxt >= &environment.data[ENV_SIZE]) {
379 fprintf(stderr, "## Error: "
380 "environment not terminated\n");
381 errno = EINVAL;
382 return -1;
383 }
384 }
385 if ((oldval = envmatch (name, env)) != NULL)
386 break;
387 }
388
389 /*
390 * Delete any existing definition
391 */
392 if (oldval) {
393 /*
394 * Ethernet Address and serial# can be set only once
395 */
396 if ((strcmp (name, "ethaddr") == 0) ||
397 (strcmp (name, "serial#") == 0)) {
398 fprintf (stderr, "Can't overwrite \"%s\"\n", name);
399 errno = EROFS;
400 return -1;
401 }
402
403 if (*++nxt == '\0') {
404 *env = '\0';
405 } else {
406 for (;;) {
407 *env = *nxt++;
408 if ((*env == '\0') && (*nxt == '\0'))
409 break;
410 ++env;
411 }
412 }
413 *++env = '\0';
414 }
415
416 /* Delete only ? */
417 if (!value || !strlen(value))
418 return 0;
419
420 /*
421 * Append new definition at the end
422 */
423 for (env = environment.data; *env || *(env + 1); ++env);
424 if (env > environment.data)
425 ++env;
426 /*
427 * Overflow when:
428 * "name" + "=" + "val" +"\0\0" > CONFIG_ENV_SIZE - (env-environment)
429 */
430 len = strlen (name) + 2;
431 /* add '=' for first arg, ' ' for all others */
432 len += strlen(value) + 1;
433
434 if (len > (&environment.data[ENV_SIZE] - env)) {
435 fprintf (stderr,
436 "Error: environment overflow, \"%s\" deleted\n",
437 name);
438 return -1;
439 }
440
441 while ((*env = *name++) != '\0')
442 env++;
443 *env = '=';
444 while ((*++env = *value++) != '\0')
445 ;
446
447 /* end is marked with double '\0' */
448 *++env = '\0';
449
450 return 0;
451 }
452
453 /*
454 * Deletes or sets environment variables. Returns -1 and sets errno error codes:
455 * 0 - OK
456 * EINVAL - need at least 1 argument
457 * EROFS - certain variables ("ethaddr", "serial#") cannot be
458 * modified or deleted
459 *
460 */
461 int fw_setenv(int argc, char *argv[])
462 {
463 int i, len;
464 char *name;
465 char *value = NULL;
466 char *tmpval = NULL;
467
468 if (argc < 2) {
469 errno = EINVAL;
470 return -1;
471 }
472
473 if (fw_env_open()) {
474 fprintf(stderr, "Error: environment not initialized\n");
475 return -1;
476 }
477
478 name = argv[1];
479
480 len = strlen(name) + 2;
481 for (i = 2; i < argc; ++i)
482 len += strlen(argv[i]) + 1;
483
484 /* Allocate enough place to the data string */
485 for (i = 2; i < argc; ++i) {
486 char *val = argv[i];
487 if (!value) {
488 value = (char *)malloc(len - strlen(name));
489 if (!value) {
490 fprintf(stderr,
491 "Cannot malloc %u bytes: %s\n",
492 len - strlen(name), strerror(errno));
493 return -1;
494 }
495 memset(value, 0, len - strlen(name));
496 tmpval = value;
497 }
498 if (i != 2)
499 *tmpval++ = ' ';
500 while (*val != '\0')
501 *tmpval++ = *val++;
502 }
503
504 fw_env_write(name, value);
505
506 if (value)
507 free(value);
508
509 return fw_env_close();
510 }
511
512 /*
513 * Parse a file and configure the u-boot variables.
514 * The script file has a very simple format, as follows:
515 *
516 * Each line has a couple with name, value:
517 * <white spaces>variable_name<white spaces>variable_value
518 *
519 * Both variable_name and variable_value are interpreted as strings.
520 * Any character after <white spaces> and before ending \r\n is interpreted
521 * as variable's value (no comment allowed on these lines !)
522 *
523 * Comments are allowed if the first character in the line is #
524 *
525 * Returns -1 and sets errno error codes:
526 * 0 - OK
527 * -1 - Error
528 */
529 int fw_parse_script(char *fname)
530 {
531 FILE *fp;
532 char dump[1024]; /* Maximum line length in the file */
533 char *name;
534 char *val;
535 int lineno = 0;
536 int len;
537 int ret = 0;
538
539 if (fw_env_open()) {
540 fprintf(stderr, "Error: environment not initialized\n");
541 return -1;
542 }
543
544 if (strcmp(fname, "-") == 0)
545 fp = stdin;
546 else {
547 fp = fopen(fname, "r");
548 if (fp == NULL) {
549 fprintf(stderr, "I cannot open %s for reading\n",
550 fname);
551 return -1;
552 }
553 }
554
555 while (fgets(dump, sizeof(dump), fp)) {
556 lineno++;
557 len = strlen(dump);
558
559 /*
560 * Read a whole line from the file. If the line is too long
561 * or is not terminated, reports an error and exit.
562 */
563 if (dump[len - 1] != '\n') {
564 fprintf(stderr,
565 "Line %d not corrected terminated or too long\n",
566 lineno);
567 ret = -1;
568 break;
569 }
570
571 /* Drop ending line feed / carriage return */
572 while (len > 0 && (dump[len - 1] == '\n' ||
573 dump[len - 1] == '\r')) {
574 dump[len - 1] = '\0';
575 len--;
576 }
577
578 /* Skip comment or empty lines */
579 if ((len == 0) || dump[0] == '#')
580 continue;
581
582 /*
583 * Search for variable's name,
584 * remove leading whitespaces
585 */
586 name = fw_string_blank(dump, 1);
587 if (!name)
588 continue;
589
590 /* The first white space is the end of variable name */
591 val = fw_string_blank(name, 0);
592 len = strlen(name);
593 if (val) {
594 *val++ = '\0';
595 if ((val - name) < len)
596 val = fw_string_blank(val, 1);
597 else
598 val = NULL;
599 }
600
601 #ifdef DEBUG
602 fprintf(stderr, "Setting %s : %s\n",
603 name, val ? val : " removed");
604 #endif
605
606 /*
607 * If there is an error setting a variable,
608 * try to save the environment and returns an error
609 */
610 if (fw_env_write(name, val)) {
611 fprintf(stderr,
612 "fw_env_write returns with error : %s\n",
613 strerror(errno));
614 ret = -1;
615 break;
616 }
617
618 }
619
620 /* Close file if not stdin */
621 if (strcmp(fname, "-") != 0)
622 fclose(fp);
623
624 ret |= fw_env_close();
625
626 return ret;
627
628 }
629
630 /*
631 * Test for bad block on NAND, just returns 0 on NOR, on NAND:
632 * 0 - block is good
633 * > 0 - block is bad
634 * < 0 - failed to test
635 */
636 static int flash_bad_block (int fd, uint8_t mtd_type, loff_t *blockstart)
637 {
638 if (mtd_type == MTD_NANDFLASH) {
639 int badblock = ioctl (fd, MEMGETBADBLOCK, blockstart);
640
641 if (badblock < 0) {
642 perror ("Cannot read bad block mark");
643 return badblock;
644 }
645
646 if (badblock) {
647 #ifdef DEBUG
648 fprintf (stderr, "Bad block at 0x%llx, "
649 "skipping\n", *blockstart);
650 #endif
651 return badblock;
652 }
653 }
654
655 return 0;
656 }
657
658 /*
659 * Read data from flash at an offset into a provided buffer. On NAND it skips
660 * bad blocks but makes sure it stays within ENVSECTORS (dev) starting from
661 * the DEVOFFSET (dev) block. On NOR the loop is only run once.
662 */
663 static int flash_read_buf (int dev, int fd, void *buf, size_t count,
664 off_t offset, uint8_t mtd_type)
665 {
666 size_t blocklen; /* erase / write length - one block on NAND,
667 0 on NOR */
668 size_t processed = 0; /* progress counter */
669 size_t readlen = count; /* current read length */
670 off_t top_of_range; /* end of the last block we may use */
671 off_t block_seek; /* offset inside the current block to the start
672 of the data */
673 loff_t blockstart; /* running start of the current block -
674 MEMGETBADBLOCK needs 64 bits */
675 int rc;
676
677 /*
678 * Start of the first block to be read, relies on the fact, that
679 * erase sector size is always a power of 2
680 */
681 blockstart = offset & ~(DEVESIZE (dev) - 1);
682
683 /* Offset inside a block */
684 block_seek = offset - blockstart;
685
686 if (mtd_type == MTD_NANDFLASH) {
687 /*
688 * NAND: calculate which blocks we are reading. We have
689 * to read one block at a time to skip bad blocks.
690 */
691 blocklen = DEVESIZE (dev);
692
693 /*
694 * To calculate the top of the range, we have to use the
695 * global DEVOFFSET (dev), which can be different from offset
696 */
697 top_of_range = (DEVOFFSET (dev) & ~(blocklen - 1)) +
698 ENVSECTORS (dev) * blocklen;
699
700 /* Limit to one block for the first read */
701 if (readlen > blocklen - block_seek)
702 readlen = blocklen - block_seek;
703 } else {
704 blocklen = 0;
705 top_of_range = offset + count;
706 }
707
708 /* This only runs once on NOR flash */
709 while (processed < count) {
710 rc = flash_bad_block (fd, mtd_type, &blockstart);
711 if (rc < 0) /* block test failed */
712 return -1;
713
714 if (blockstart + block_seek + readlen > top_of_range) {
715 /* End of range is reached */
716 fprintf (stderr,
717 "Too few good blocks within range\n");
718 return -1;
719 }
720
721 if (rc) { /* block is bad */
722 blockstart += blocklen;
723 continue;
724 }
725
726 /*
727 * If a block is bad, we retry in the next block at the same
728 * offset - see common/env_nand.c::writeenv()
729 */
730 lseek (fd, blockstart + block_seek, SEEK_SET);
731
732 rc = read (fd, buf + processed, readlen);
733 if (rc != readlen) {
734 fprintf (stderr, "Read error on %s: %s\n",
735 DEVNAME (dev), strerror (errno));
736 return -1;
737 }
738 #ifdef DEBUG
739 fprintf (stderr, "Read 0x%x bytes at 0x%llx\n",
740 rc, blockstart + block_seek);
741 #endif
742 processed += readlen;
743 readlen = min (blocklen, count - processed);
744 block_seek = 0;
745 blockstart += blocklen;
746 }
747
748 return processed;
749 }
750
751 /*
752 * Write count bytes at offset, but stay within ENVSETCORS (dev) sectors of
753 * DEVOFFSET (dev). Similar to the read case above, on NOR we erase and write
754 * the whole data at once.
755 */
756 static int flash_write_buf (int dev, int fd, void *buf, size_t count,
757 off_t offset, uint8_t mtd_type)
758 {
759 void *data;
760 struct erase_info_user erase;
761 size_t blocklen; /* length of NAND block / NOR erase sector */
762 size_t erase_len; /* whole area that can be erased - may include
763 bad blocks */
764 size_t erasesize; /* erase / write length - one block on NAND,
765 whole area on NOR */
766 size_t processed = 0; /* progress counter */
767 size_t write_total; /* total size to actually write - excludinig
768 bad blocks */
769 off_t erase_offset; /* offset to the first erase block (aligned)
770 below offset */
771 off_t block_seek; /* offset inside the erase block to the start
772 of the data */
773 off_t top_of_range; /* end of the last block we may use */
774 loff_t blockstart; /* running start of the current block -
775 MEMGETBADBLOCK needs 64 bits */
776 int rc;
777
778 blocklen = DEVESIZE (dev);
779
780 /* Erase sector size is always a power of 2 */
781 top_of_range = (DEVOFFSET (dev) & ~(blocklen - 1)) +
782 ENVSECTORS (dev) * blocklen;
783
784 erase_offset = offset & ~(blocklen - 1);
785
786 /* Maximum area we may use */
787 erase_len = top_of_range - erase_offset;
788
789 blockstart = erase_offset;
790 /* Offset inside a block */
791 block_seek = offset - erase_offset;
792
793 /*
794 * Data size we actually have to write: from the start of the block
795 * to the start of the data, then count bytes of data, and to the
796 * end of the block
797 */
798 write_total = (block_seek + count + blocklen - 1) & ~(blocklen - 1);
799
800 /*
801 * Support data anywhere within erase sectors: read out the complete
802 * area to be erased, replace the environment image, write the whole
803 * block back again.
804 */
805 if (write_total > count) {
806 data = malloc (erase_len);
807 if (!data) {
808 fprintf (stderr,
809 "Cannot malloc %u bytes: %s\n",
810 erase_len, strerror (errno));
811 return -1;
812 }
813
814 rc = flash_read_buf (dev, fd, data, write_total, erase_offset,
815 mtd_type);
816 if (write_total != rc)
817 return -1;
818
819 /* Overwrite the old environment */
820 memcpy (data + block_seek, buf, count);
821 } else {
822 /*
823 * We get here, iff offset is block-aligned and count is a
824 * multiple of blocklen - see write_total calculation above
825 */
826 data = buf;
827 }
828
829 if (mtd_type == MTD_NANDFLASH) {
830 /*
831 * NAND: calculate which blocks we are writing. We have
832 * to write one block at a time to skip bad blocks.
833 */
834 erasesize = blocklen;
835 } else {
836 erasesize = erase_len;
837 }
838
839 erase.length = erasesize;
840
841 /* This only runs once on NOR flash */
842 while (processed < write_total) {
843 rc = flash_bad_block (fd, mtd_type, &blockstart);
844 if (rc < 0) /* block test failed */
845 return rc;
846
847 if (blockstart + erasesize > top_of_range) {
848 fprintf (stderr, "End of range reached, aborting\n");
849 return -1;
850 }
851
852 if (rc) { /* block is bad */
853 blockstart += blocklen;
854 continue;
855 }
856
857 erase.start = blockstart;
858 ioctl (fd, MEMUNLOCK, &erase);
859
860 if (ioctl (fd, MEMERASE, &erase) != 0) {
861 fprintf (stderr, "MTD erase error on %s: %s\n",
862 DEVNAME (dev),
863 strerror (errno));
864 return -1;
865 }
866
867 if (lseek (fd, blockstart, SEEK_SET) == -1) {
868 fprintf (stderr,
869 "Seek error on %s: %s\n",
870 DEVNAME (dev), strerror (errno));
871 return -1;
872 }
873
874 #ifdef DEBUG
875 printf ("Write 0x%x bytes at 0x%llx\n", erasesize, blockstart);
876 #endif
877 if (write (fd, data + processed, erasesize) != erasesize) {
878 fprintf (stderr, "Write error on %s: %s\n",
879 DEVNAME (dev), strerror (errno));
880 return -1;
881 }
882
883 ioctl (fd, MEMLOCK, &erase);
884
885 processed += blocklen;
886 block_seek = 0;
887 blockstart += blocklen;
888 }
889
890 if (write_total > count)
891 free (data);
892
893 return processed;
894 }
895
896 /*
897 * Set obsolete flag at offset - NOR flash only
898 */
899 static int flash_flag_obsolete (int dev, int fd, off_t offset)
900 {
901 int rc;
902
903 /* This relies on the fact, that obsolete_flag == 0 */
904 rc = lseek (fd, offset, SEEK_SET);
905 if (rc < 0) {
906 fprintf (stderr, "Cannot seek to set the flag on %s \n",
907 DEVNAME (dev));
908 return rc;
909 }
910 rc = write (fd, &obsolete_flag, sizeof (obsolete_flag));
911 if (rc < 0)
912 perror ("Could not set obsolete flag");
913
914 return rc;
915 }
916
917 static int flash_write (int fd_current, int fd_target, int dev_target)
918 {
919 int rc;
920
921 switch (environment.flag_scheme) {
922 case FLAG_NONE:
923 break;
924 case FLAG_INCREMENTAL:
925 (*environment.flags)++;
926 break;
927 case FLAG_BOOLEAN:
928 *environment.flags = active_flag;
929 break;
930 default:
931 fprintf (stderr, "Unimplemented flash scheme %u \n",
932 environment.flag_scheme);
933 return -1;
934 }
935
936 #ifdef DEBUG
937 printf ("Writing new environment at 0x%lx on %s\n",
938 DEVOFFSET (dev_target), DEVNAME (dev_target));
939 #endif
940 rc = flash_write_buf (dev_target, fd_target, environment.image,
941 CONFIG_ENV_SIZE, DEVOFFSET (dev_target),
942 DEVTYPE(dev_target));
943 if (rc < 0)
944 return rc;
945
946 if (environment.flag_scheme == FLAG_BOOLEAN) {
947 /* Have to set obsolete flag */
948 off_t offset = DEVOFFSET (dev_current) +
949 offsetof (struct env_image_redundant, flags);
950 #ifdef DEBUG
951 printf ("Setting obsolete flag in environment at 0x%lx on %s\n",
952 DEVOFFSET (dev_current), DEVNAME (dev_current));
953 #endif
954 flash_flag_obsolete (dev_current, fd_current, offset);
955 }
956
957 return 0;
958 }
959
960 static int flash_read (int fd)
961 {
962 struct mtd_info_user mtdinfo;
963 int rc;
964
965 rc = ioctl (fd, MEMGETINFO, &mtdinfo);
966 if (rc < 0) {
967 perror ("Cannot get MTD information");
968 return -1;
969 }
970
971 if (mtdinfo.type != MTD_NORFLASH && mtdinfo.type != MTD_NANDFLASH) {
972 fprintf (stderr, "Unsupported flash type %u\n", mtdinfo.type);
973 return -1;
974 }
975
976 DEVTYPE(dev_current) = mtdinfo.type;
977
978 rc = flash_read_buf (dev_current, fd, environment.image, CONFIG_ENV_SIZE,
979 DEVOFFSET (dev_current), mtdinfo.type);
980
981 return (rc != CONFIG_ENV_SIZE) ? -1 : 0;
982 }
983
984 static int flash_io (int mode)
985 {
986 int fd_current, fd_target, rc, dev_target;
987
988 /* dev_current: fd_current, erase_current */
989 fd_current = open (DEVNAME (dev_current), mode);
990 if (fd_current < 0) {
991 fprintf (stderr,
992 "Can't open %s: %s\n",
993 DEVNAME (dev_current), strerror (errno));
994 return -1;
995 }
996
997 if (mode == O_RDWR) {
998 if (HaveRedundEnv) {
999 /* switch to next partition for writing */
1000 dev_target = !dev_current;
1001 /* dev_target: fd_target, erase_target */
1002 fd_target = open (DEVNAME (dev_target), mode);
1003 if (fd_target < 0) {
1004 fprintf (stderr,
1005 "Can't open %s: %s\n",
1006 DEVNAME (dev_target),
1007 strerror (errno));
1008 rc = -1;
1009 goto exit;
1010 }
1011 } else {
1012 dev_target = dev_current;
1013 fd_target = fd_current;
1014 }
1015
1016 rc = flash_write (fd_current, fd_target, dev_target);
1017
1018 if (HaveRedundEnv) {
1019 if (close (fd_target)) {
1020 fprintf (stderr,
1021 "I/O error on %s: %s\n",
1022 DEVNAME (dev_target),
1023 strerror (errno));
1024 rc = -1;
1025 }
1026 }
1027 } else {
1028 rc = flash_read (fd_current);
1029 }
1030
1031 exit:
1032 if (close (fd_current)) {
1033 fprintf (stderr,
1034 "I/O error on %s: %s\n",
1035 DEVNAME (dev_current), strerror (errno));
1036 return -1;
1037 }
1038
1039 return rc;
1040 }
1041
1042 /*
1043 * s1 is either a simple 'name', or a 'name=value' pair.
1044 * s2 is a 'name=value' pair.
1045 * If the names match, return the value of s2, else NULL.
1046 */
1047
1048 static char *envmatch (char * s1, char * s2)
1049 {
1050
1051 while (*s1 == *s2++)
1052 if (*s1++ == '=')
1053 return s2;
1054 if (*s1 == '\0' && *(s2 - 1) == '=')
1055 return s2;
1056 return NULL;
1057 }
1058
1059 /*
1060 * Prevent confusion if running from erased flash memory
1061 */
1062 int fw_env_open(void)
1063 {
1064 int crc0, crc0_ok;
1065 char flag0;
1066 void *addr0;
1067
1068 int crc1, crc1_ok;
1069 char flag1;
1070 void *addr1;
1071
1072 struct env_image_single *single;
1073 struct env_image_redundant *redundant;
1074
1075 if (parse_config ()) /* should fill envdevices */
1076 return -1;
1077
1078 addr0 = calloc (1, CONFIG_ENV_SIZE);
1079 if (addr0 == NULL) {
1080 fprintf (stderr,
1081 "Not enough memory for environment (%ld bytes)\n",
1082 CONFIG_ENV_SIZE);
1083 return -1;
1084 }
1085
1086 /* read environment from FLASH to local buffer */
1087 environment.image = addr0;
1088
1089 if (HaveRedundEnv) {
1090 redundant = addr0;
1091 environment.crc = &redundant->crc;
1092 environment.flags = &redundant->flags;
1093 environment.data = redundant->data;
1094 } else {
1095 single = addr0;
1096 environment.crc = &single->crc;
1097 environment.flags = NULL;
1098 environment.data = single->data;
1099 }
1100
1101 dev_current = 0;
1102 if (flash_io (O_RDONLY))
1103 return -1;
1104
1105 crc0 = crc32 (0, (uint8_t *) environment.data, ENV_SIZE);
1106 crc0_ok = (crc0 == *environment.crc);
1107 if (!HaveRedundEnv) {
1108 if (!crc0_ok) {
1109 fprintf (stderr,
1110 "Warning: Bad CRC, using default environment\n");
1111 memcpy(environment.data, default_environment, sizeof default_environment);
1112 }
1113 } else {
1114 flag0 = *environment.flags;
1115
1116 dev_current = 1;
1117 addr1 = calloc (1, CONFIG_ENV_SIZE);
1118 if (addr1 == NULL) {
1119 fprintf (stderr,
1120 "Not enough memory for environment (%ld bytes)\n",
1121 CONFIG_ENV_SIZE);
1122 return -1;
1123 }
1124 redundant = addr1;
1125
1126 /*
1127 * have to set environment.image for flash_read(), careful -
1128 * other pointers in environment still point inside addr0
1129 */
1130 environment.image = addr1;
1131 if (flash_io (O_RDONLY))
1132 return -1;
1133
1134 /* Check flag scheme compatibility */
1135 if (DEVTYPE(dev_current) == MTD_NORFLASH &&
1136 DEVTYPE(!dev_current) == MTD_NORFLASH) {
1137 environment.flag_scheme = FLAG_BOOLEAN;
1138 } else if (DEVTYPE(dev_current) == MTD_NANDFLASH &&
1139 DEVTYPE(!dev_current) == MTD_NANDFLASH) {
1140 environment.flag_scheme = FLAG_INCREMENTAL;
1141 } else {
1142 fprintf (stderr, "Incompatible flash types!\n");
1143 return -1;
1144 }
1145
1146 crc1 = crc32 (0, (uint8_t *) redundant->data, ENV_SIZE);
1147 crc1_ok = (crc1 == redundant->crc);
1148 flag1 = redundant->flags;
1149
1150 if (crc0_ok && !crc1_ok) {
1151 dev_current = 0;
1152 } else if (!crc0_ok && crc1_ok) {
1153 dev_current = 1;
1154 } else if (!crc0_ok && !crc1_ok) {
1155 fprintf (stderr,
1156 "Warning: Bad CRC, using default environment\n");
1157 memcpy (environment.data, default_environment,
1158 sizeof default_environment);
1159 dev_current = 0;
1160 } else {
1161 switch (environment.flag_scheme) {
1162 case FLAG_BOOLEAN:
1163 if (flag0 == active_flag &&
1164 flag1 == obsolete_flag) {
1165 dev_current = 0;
1166 } else if (flag0 == obsolete_flag &&
1167 flag1 == active_flag) {
1168 dev_current = 1;
1169 } else if (flag0 == flag1) {
1170 dev_current = 0;
1171 } else if (flag0 == 0xFF) {
1172 dev_current = 0;
1173 } else if (flag1 == 0xFF) {
1174 dev_current = 1;
1175 } else {
1176 dev_current = 0;
1177 }
1178 break;
1179 case FLAG_INCREMENTAL:
1180 if ((flag0 == 255 && flag1 == 0) ||
1181 flag1 > flag0)
1182 dev_current = 1;
1183 else if ((flag1 == 255 && flag0 == 0) ||
1184 flag0 > flag1)
1185 dev_current = 0;
1186 else /* flags are equal - almost impossible */
1187 dev_current = 0;
1188 break;
1189 default:
1190 fprintf (stderr, "Unknown flag scheme %u \n",
1191 environment.flag_scheme);
1192 return -1;
1193 }
1194 }
1195
1196 /*
1197 * If we are reading, we don't need the flag and the CRC any
1198 * more, if we are writing, we will re-calculate CRC and update
1199 * flags before writing out
1200 */
1201 if (dev_current) {
1202 environment.image = addr1;
1203 environment.crc = &redundant->crc;
1204 environment.flags = &redundant->flags;
1205 environment.data = redundant->data;
1206 free (addr0);
1207 } else {
1208 environment.image = addr0;
1209 /* Other pointers are already set */
1210 free (addr1);
1211 }
1212 }
1213 return 0;
1214 }
1215
1216
1217 static int parse_config ()
1218 {
1219 struct stat st;
1220
1221 #if defined(CONFIG_FILE)
1222 /* Fills in DEVNAME(), ENVSIZE(), DEVESIZE(). Or don't. */
1223 if (get_config (CONFIG_FILE)) {
1224 fprintf (stderr,
1225 "Cannot parse config file: %s\n", strerror (errno));
1226 return -1;
1227 }
1228 #else
1229 strcpy (DEVNAME (0), DEVICE1_NAME);
1230 DEVOFFSET (0) = DEVICE1_OFFSET;
1231 ENVSIZE (0) = ENV1_SIZE;
1232 DEVESIZE (0) = DEVICE1_ESIZE;
1233 ENVSECTORS (0) = DEVICE1_ENVSECTORS;
1234 #ifdef HAVE_REDUND
1235 strcpy (DEVNAME (1), DEVICE2_NAME);
1236 DEVOFFSET (1) = DEVICE2_OFFSET;
1237 ENVSIZE (1) = ENV2_SIZE;
1238 DEVESIZE (1) = DEVICE2_ESIZE;
1239 ENVSECTORS (1) = DEVICE2_ENVSECTORS;
1240 HaveRedundEnv = 1;
1241 #endif
1242 #endif
1243 if (stat (DEVNAME (0), &st)) {
1244 fprintf (stderr,
1245 "Cannot access MTD device %s: %s\n",
1246 DEVNAME (0), strerror (errno));
1247 return -1;
1248 }
1249
1250 if (HaveRedundEnv && stat (DEVNAME (1), &st)) {
1251 fprintf (stderr,
1252 "Cannot access MTD device %s: %s\n",
1253 DEVNAME (1), strerror (errno));
1254 return -1;
1255 }
1256 return 0;
1257 }
1258
1259 #if defined(CONFIG_FILE)
1260 static int get_config (char *fname)
1261 {
1262 FILE *fp;
1263 int i = 0;
1264 int rc;
1265 char dump[128];
1266
1267 fp = fopen (fname, "r");
1268 if (fp == NULL)
1269 return -1;
1270
1271 while (i < 2 && fgets (dump, sizeof (dump), fp)) {
1272 /* Skip incomplete conversions and comment strings */
1273 if (dump[0] == '#')
1274 continue;
1275
1276 rc = sscanf (dump, "%s %lx %lx %lx %lx",
1277 DEVNAME (i),
1278 &DEVOFFSET (i),
1279 &ENVSIZE (i),
1280 &DEVESIZE (i),
1281 &ENVSECTORS (i));
1282
1283 if (rc < 4)
1284 continue;
1285
1286 if (rc < 5)
1287 /* Default - 1 sector */
1288 ENVSECTORS (i) = 1;
1289
1290 i++;
1291 }
1292 fclose (fp);
1293
1294 HaveRedundEnv = i - 1;
1295 if (!i) { /* No valid entries found */
1296 errno = EINVAL;
1297 return -1;
1298 } else
1299 return 0;
1300 }
1301 #endif
"Das U-Boot" Source Tree