2 * (C) Copyright 2000-2010
3 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
6 * Guennadi Liakhovetski, DENX Software Engineering, lg@denx.de.
8 * SPDX-License-Identifier: GPL-2.0+
15 #include <env_flags.h>
18 #include <linux/stringify.h>
24 #include <sys/types.h>
25 #include <sys/ioctl.h>
31 # include <linux/mtd/mtd.h>
33 # define __user /* nothing */
34 # include <mtd/mtd-user.h>
39 struct env_opts default_opts
= {
41 .config_file
= CONFIG_FILE
45 #define DIV_ROUND_UP(n, d) (((n) + (d) - 1) / (d))
47 #define min(x, y) ({ \
48 typeof(x) _min1 = (x); \
49 typeof(y) _min2 = (y); \
50 (void) (&_min1 == &_min2); \
51 _min1 < _min2 ? _min1 : _min2; })
54 const char *devname
; /* Device name */
55 long long devoff
; /* Device offset */
56 ulong env_size
; /* environment size */
57 ulong erase_size
; /* device erase size */
58 ulong env_sectors
; /* number of environment sectors */
59 uint8_t mtd_type
; /* type of the MTD device */
62 static struct envdev_s envdevices
[2] =
65 .mtd_type
= MTD_ABSENT
,
67 .mtd_type
= MTD_ABSENT
,
70 static int dev_current
;
72 #define DEVNAME(i) envdevices[(i)].devname
73 #define DEVOFFSET(i) envdevices[(i)].devoff
74 #define ENVSIZE(i) envdevices[(i)].env_size
75 #define DEVESIZE(i) envdevices[(i)].erase_size
76 #define ENVSECTORS(i) envdevices[(i)].env_sectors
77 #define DEVTYPE(i) envdevices[(i)].mtd_type
79 #define CUR_ENVSIZE ENVSIZE(dev_current)
81 static unsigned long usable_envsize
;
82 #define ENV_SIZE usable_envsize
84 struct env_image_single
{
85 uint32_t crc
; /* CRC32 over data bytes */
89 struct env_image_redundant
{
90 uint32_t crc
; /* CRC32 over data bytes */
91 unsigned char flags
; /* active or obsolete */
104 unsigned char *flags
;
106 enum flag_scheme flag_scheme
;
109 static struct environment environment
= {
110 .flag_scheme
= FLAG_NONE
,
113 static int env_aes_cbc_crypt(char *data
, const int enc
, uint8_t *key
);
115 static int HaveRedundEnv
= 0;
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;
121 #define DEFAULT_ENV_INSTANCE_STATIC
122 #include <env_default.h>
124 static int flash_io (int mode
);
125 static int parse_config(struct env_opts
*opts
);
127 #if defined(CONFIG_FILE)
128 static int get_config (char *);
131 static char *skip_chars(char *s
)
133 for (; *s
!= '\0'; s
++) {
140 static char *skip_blanks(char *s
)
142 for (; *s
!= '\0'; s
++) {
150 * s1 is either a simple 'name', or a 'name=value' pair.
151 * s2 is a 'name=value' pair.
152 * If the names match, return the value of s2, else NULL.
154 static char *envmatch(char *s1
, char *s2
)
156 if (s1
== NULL
|| s2
== NULL
)
162 if (*s1
== '\0' && *(s2
- 1) == '=')
168 * Search the environment for a variable.
169 * Return the value, if found, or NULL, if not found.
171 char *fw_getenv (char *name
)
175 for (env
= environment
.data
; *env
; env
= nxt
+ 1) {
178 for (nxt
= env
; *nxt
; ++nxt
) {
179 if (nxt
>= &environment
.data
[ENV_SIZE
]) {
180 fprintf (stderr
, "## Error: "
181 "environment not terminated\n");
185 val
= envmatch (name
, env
);
194 * Search the default environment for a variable.
195 * Return the value, if found, or NULL, if not found.
197 char *fw_getdefenv(char *name
)
201 for (env
= default_environment
; *env
; env
= nxt
+ 1) {
204 for (nxt
= env
; *nxt
; ++nxt
) {
205 if (nxt
>= &default_environment
[ENV_SIZE
]) {
206 fprintf(stderr
, "## Error: "
207 "default environment not terminated\n");
211 val
= envmatch(name
, env
);
219 int parse_aes_key(char *key
, uint8_t *bin_key
)
221 char tmp
[5] = { '0', 'x', 0, 0, 0 };
225 if (strnlen(key
, 64) != 32) {
227 "## Error: '-a' option requires 16-byte AES key\n");
231 for (i
= 0; i
< 16; i
++) {
235 ul
= strtoul(tmp
, NULL
, 16);
238 "## Error: '-a' option requires valid AES key\n");
241 bin_key
[i
] = ul
& 0xff;
248 * Print the current definition of one, or more, or all
249 * environment variables
251 int fw_printenv(int argc
, char *argv
[], int value_only
, struct env_opts
*opts
)
255 if (value_only
&& argc
!= 1) {
257 "## Error: `-n' option requires exactly one argument\n");
262 opts
= &default_opts
;
264 if (fw_env_open(opts
))
267 if (argc
== 0) { /* Print all env variables */
269 for (env
= environment
.data
; *env
; env
= nxt
+ 1) {
270 for (nxt
= env
; *nxt
; ++nxt
) {
271 if (nxt
>= &environment
.data
[ENV_SIZE
]) {
272 fprintf (stderr
, "## Error: "
273 "environment not terminated\n");
278 printf ("%s\n", env
);
283 for (i
= 0; i
< argc
; ++i
) { /* print a subset of env variables */
284 char *name
= argv
[i
];
287 val
= fw_getenv(name
);
289 fprintf (stderr
, "## Error: \"%s\" not defined\n", name
);
299 printf("%s=%s\n", name
, val
);
305 int fw_env_close(struct env_opts
*opts
)
310 opts
= &default_opts
;
312 if (opts
->aes_flag
) {
313 ret
= env_aes_cbc_crypt(environment
.data
, 1,
317 "Error: can't encrypt env for flash\n");
325 *environment
.crc
= crc32(0, (uint8_t *) environment
.data
, ENV_SIZE
);
327 /* write environment back to flash */
328 if (flash_io(O_RDWR
)) {
330 "Error: can't write fw_env to flash\n");
339 * Set/Clear a single variable in the environment.
340 * This is called in sequence to update the environment
341 * in RAM without updating the copy in flash after each set
343 int fw_env_write(char *name
, char *value
)
348 int deleting
, creating
, overwriting
;
351 * search if variable with this name already exists
353 for (nxt
= env
= environment
.data
; *env
; env
= nxt
+ 1) {
354 for (nxt
= env
; *nxt
; ++nxt
) {
355 if (nxt
>= &environment
.data
[ENV_SIZE
]) {
356 fprintf(stderr
, "## Error: "
357 "environment not terminated\n");
362 if ((oldval
= envmatch (name
, env
)) != NULL
)
366 deleting
= (oldval
&& !(value
&& strlen(value
)));
367 creating
= (!oldval
&& (value
&& strlen(value
)));
368 overwriting
= (oldval
&& (value
&& strlen(value
)));
370 /* check for permission */
372 if (env_flags_validate_varaccess(name
,
373 ENV_FLAGS_VARACCESS_PREVENT_DELETE
)) {
374 printf("Can't delete \"%s\"\n", name
);
378 } else if (overwriting
) {
379 if (env_flags_validate_varaccess(name
,
380 ENV_FLAGS_VARACCESS_PREVENT_OVERWR
)) {
381 printf("Can't overwrite \"%s\"\n", name
);
384 } else if (env_flags_validate_varaccess(name
,
385 ENV_FLAGS_VARACCESS_PREVENT_NONDEF_OVERWR
)) {
386 const char *defval
= fw_getdefenv(name
);
390 if (strcmp(oldval
, defval
)
392 printf("Can't overwrite \"%s\"\n", name
);
397 } else if (creating
) {
398 if (env_flags_validate_varaccess(name
,
399 ENV_FLAGS_VARACCESS_PREVENT_CREATE
)) {
400 printf("Can't create \"%s\"\n", name
);
408 if (deleting
|| overwriting
) {
409 if (*++nxt
== '\0') {
414 if ((*env
== '\0') && (*nxt
== '\0'))
423 if (!value
|| !strlen(value
))
427 * Append new definition at the end
429 for (env
= environment
.data
; *env
|| *(env
+ 1); ++env
);
430 if (env
> environment
.data
)
434 * "name" + "=" + "val" +"\0\0" > CUR_ENVSIZE - (env-environment)
436 len
= strlen (name
) + 2;
437 /* add '=' for first arg, ' ' for all others */
438 len
+= strlen(value
) + 1;
440 if (len
> (&environment
.data
[ENV_SIZE
] - env
)) {
442 "Error: environment overflow, \"%s\" deleted\n",
447 while ((*env
= *name
++) != '\0')
450 while ((*++env
= *value
++) != '\0')
453 /* end is marked with double '\0' */
460 * Deletes or sets environment variables. Returns -1 and sets errno error codes:
462 * EINVAL - need at least 1 argument
463 * EROFS - certain variables ("ethaddr", "serial#") cannot be
464 * modified or deleted
467 int fw_setenv(int argc
, char *argv
[], struct env_opts
*opts
)
476 opts
= &default_opts
;
479 fprintf(stderr
, "## Error: variable name missing\n");
484 if (fw_env_open(opts
)) {
485 fprintf(stderr
, "Error: environment not initialized\n");
493 if (env_flags_validate_env_set_params(name
, valv
, valc
) < 0)
497 for (i
= 0; i
< valc
; ++i
) {
499 size_t val_len
= strlen(val
);
502 value
[len
- 1] = ' ';
503 value
= realloc(value
, len
+ val_len
+ 1);
506 "Cannot malloc %zu bytes: %s\n",
507 len
, strerror(errno
));
511 memcpy(value
+ len
, val
, val_len
);
516 fw_env_write(name
, value
);
520 return fw_env_close(opts
);
524 * Parse a file and configure the u-boot variables.
525 * The script file has a very simple format, as follows:
527 * Each line has a couple with name, value:
528 * <white spaces>variable_name<white spaces>variable_value
530 * Both variable_name and variable_value are interpreted as strings.
531 * Any character after <white spaces> and before ending \r\n is interpreted
532 * as variable's value (no comment allowed on these lines !)
534 * Comments are allowed if the first character in the line is #
536 * Returns -1 and sets errno error codes:
540 int fw_parse_script(char *fname
, struct env_opts
*opts
)
543 char dump
[1024]; /* Maximum line length in the file */
551 opts
= &default_opts
;
553 if (fw_env_open(opts
)) {
554 fprintf(stderr
, "Error: environment not initialized\n");
558 if (strcmp(fname
, "-") == 0)
561 fp
= fopen(fname
, "r");
563 fprintf(stderr
, "I cannot open %s for reading\n",
569 while (fgets(dump
, sizeof(dump
), fp
)) {
574 * Read a whole line from the file. If the line is too long
575 * or is not terminated, reports an error and exit.
577 if (dump
[len
- 1] != '\n') {
579 "Line %d not corrected terminated or too long\n",
585 /* Drop ending line feed / carriage return */
587 if (len
&& dump
[len
- 1] == '\r')
590 /* Skip comment or empty lines */
591 if (len
== 0 || dump
[0] == '#')
595 * Search for variable's name,
596 * remove leading whitespaces
598 name
= skip_blanks(dump
);
602 /* The first white space is the end of variable name */
603 val
= skip_chars(name
);
607 if ((val
- name
) < len
)
608 val
= skip_blanks(val
);
614 fprintf(stderr
, "Setting %s : %s\n",
615 name
, val
? val
: " removed");
618 if (env_flags_validate_type(name
, val
) < 0) {
624 * If there is an error setting a variable,
625 * try to save the environment and returns an error
627 if (fw_env_write(name
, val
)) {
629 "fw_env_write returns with error : %s\n",
637 /* Close file if not stdin */
638 if (strcmp(fname
, "-") != 0)
641 ret
|= fw_env_close(opts
);
647 * Test for bad block on NAND, just returns 0 on NOR, on NAND:
650 * < 0 - failed to test
652 static int flash_bad_block (int fd
, uint8_t mtd_type
, loff_t
*blockstart
)
654 if (mtd_type
== MTD_NANDFLASH
) {
655 int badblock
= ioctl (fd
, MEMGETBADBLOCK
, blockstart
);
658 perror ("Cannot read bad block mark");
664 fprintf (stderr
, "Bad block at 0x%llx, skipping\n",
665 (unsigned long long) *blockstart
);
675 * Read data from flash at an offset into a provided buffer. On NAND it skips
676 * bad blocks but makes sure it stays within ENVSECTORS (dev) starting from
677 * the DEVOFFSET (dev) block. On NOR the loop is only run once.
679 static int flash_read_buf (int dev
, int fd
, void *buf
, size_t count
,
680 off_t offset
, uint8_t mtd_type
)
682 size_t blocklen
; /* erase / write length - one block on NAND,
684 size_t processed
= 0; /* progress counter */
685 size_t readlen
= count
; /* current read length */
686 off_t top_of_range
; /* end of the last block we may use */
687 off_t block_seek
; /* offset inside the current block to the start
689 loff_t blockstart
; /* running start of the current block -
690 MEMGETBADBLOCK needs 64 bits */
693 blockstart
= (offset
/ DEVESIZE (dev
)) * DEVESIZE (dev
);
695 /* Offset inside a block */
696 block_seek
= offset
- blockstart
;
698 if (mtd_type
== MTD_NANDFLASH
) {
700 * NAND: calculate which blocks we are reading. We have
701 * to read one block at a time to skip bad blocks.
703 blocklen
= DEVESIZE (dev
);
706 * To calculate the top of the range, we have to use the
707 * global DEVOFFSET (dev), which can be different from offset
709 top_of_range
= ((DEVOFFSET(dev
) / blocklen
) +
710 ENVSECTORS (dev
)) * blocklen
;
712 /* Limit to one block for the first read */
713 if (readlen
> blocklen
- block_seek
)
714 readlen
= blocklen
- block_seek
;
717 top_of_range
= offset
+ count
;
720 /* This only runs once on NOR flash */
721 while (processed
< count
) {
722 rc
= flash_bad_block (fd
, mtd_type
, &blockstart
);
723 if (rc
< 0) /* block test failed */
726 if (blockstart
+ block_seek
+ readlen
> top_of_range
) {
727 /* End of range is reached */
729 "Too few good blocks within range\n");
733 if (rc
) { /* block is bad */
734 blockstart
+= blocklen
;
739 * If a block is bad, we retry in the next block at the same
740 * offset - see common/env_nand.c::writeenv()
742 lseek (fd
, blockstart
+ block_seek
, SEEK_SET
);
744 rc
= read (fd
, buf
+ processed
, readlen
);
746 fprintf (stderr
, "Read error on %s: %s\n",
747 DEVNAME (dev
), strerror (errno
));
751 fprintf(stderr
, "Read 0x%x bytes at 0x%llx on %s\n",
752 rc
, (unsigned long long) blockstart
+ block_seek
,
755 processed
+= readlen
;
756 readlen
= min (blocklen
, count
- processed
);
758 blockstart
+= blocklen
;
765 * Write count bytes at offset, but stay within ENVSECTORS (dev) sectors of
766 * DEVOFFSET (dev). Similar to the read case above, on NOR and dataflash we
767 * erase and write the whole data at once.
769 static int flash_write_buf (int dev
, int fd
, void *buf
, size_t count
,
770 off_t offset
, uint8_t mtd_type
)
773 struct erase_info_user erase
;
774 size_t blocklen
; /* length of NAND block / NOR erase sector */
775 size_t erase_len
; /* whole area that can be erased - may include
777 size_t erasesize
; /* erase / write length - one block on NAND,
779 size_t processed
= 0; /* progress counter */
780 size_t write_total
; /* total size to actually write - excluding
782 off_t erase_offset
; /* offset to the first erase block (aligned)
784 off_t block_seek
; /* offset inside the erase block to the start
786 off_t top_of_range
; /* end of the last block we may use */
787 loff_t blockstart
; /* running start of the current block -
788 MEMGETBADBLOCK needs 64 bits */
792 * For mtd devices only offset and size of the environment do matter
794 if (mtd_type
== MTD_ABSENT
) {
796 top_of_range
= offset
+ count
;
797 erase_len
= blocklen
;
800 write_total
= blocklen
;
802 blocklen
= DEVESIZE(dev
);
804 top_of_range
= ((DEVOFFSET(dev
) / blocklen
) +
805 ENVSECTORS(dev
)) * blocklen
;
807 erase_offset
= (offset
/ blocklen
) * blocklen
;
809 /* Maximum area we may use */
810 erase_len
= top_of_range
- erase_offset
;
812 blockstart
= erase_offset
;
813 /* Offset inside a block */
814 block_seek
= offset
- erase_offset
;
817 * Data size we actually write: from the start of the block
818 * to the start of the data, then count bytes of data, and
819 * to the end of the block
821 write_total
= ((block_seek
+ count
+ blocklen
- 1) /
822 blocklen
) * blocklen
;
826 * Support data anywhere within erase sectors: read out the complete
827 * area to be erased, replace the environment image, write the whole
830 if (write_total
> count
) {
831 data
= malloc (erase_len
);
834 "Cannot malloc %zu bytes: %s\n",
835 erase_len
, strerror (errno
));
839 rc
= flash_read_buf (dev
, fd
, data
, write_total
, erase_offset
,
841 if (write_total
!= rc
)
845 fprintf(stderr
, "Preserving data ");
847 fprintf(stderr
, "0x%x - 0x%lx", 0, block_seek
- 1);
848 if (block_seek
+ count
!= write_total
) {
850 fprintf(stderr
, " and ");
851 fprintf(stderr
, "0x%lx - 0x%lx",
852 (unsigned long) block_seek
+ count
,
853 (unsigned long) write_total
- 1);
855 fprintf(stderr
, "\n");
857 /* Overwrite the old environment */
858 memcpy (data
+ block_seek
, buf
, count
);
861 * We get here, iff offset is block-aligned and count is a
862 * multiple of blocklen - see write_total calculation above
867 if (mtd_type
== MTD_NANDFLASH
) {
869 * NAND: calculate which blocks we are writing. We have
870 * to write one block at a time to skip bad blocks.
872 erasesize
= blocklen
;
874 erasesize
= erase_len
;
877 erase
.length
= erasesize
;
879 /* This only runs once on NOR flash and SPI-dataflash */
880 while (processed
< write_total
) {
881 rc
= flash_bad_block (fd
, mtd_type
, &blockstart
);
882 if (rc
< 0) /* block test failed */
885 if (blockstart
+ erasesize
> top_of_range
) {
886 fprintf (stderr
, "End of range reached, aborting\n");
890 if (rc
) { /* block is bad */
891 blockstart
+= blocklen
;
895 if (mtd_type
!= MTD_ABSENT
) {
896 erase
.start
= blockstart
;
897 ioctl(fd
, MEMUNLOCK
, &erase
);
898 /* These do not need an explicit erase cycle */
899 if (mtd_type
!= MTD_DATAFLASH
)
900 if (ioctl(fd
, MEMERASE
, &erase
) != 0) {
902 "MTD erase error on %s: %s\n",
903 DEVNAME(dev
), strerror(errno
));
908 if (lseek (fd
, blockstart
, SEEK_SET
) == -1) {
910 "Seek error on %s: %s\n",
911 DEVNAME (dev
), strerror (errno
));
916 fprintf(stderr
, "Write 0x%llx bytes at 0x%llx\n",
917 (unsigned long long) erasesize
,
918 (unsigned long long) blockstart
);
920 if (write (fd
, data
+ processed
, erasesize
) != erasesize
) {
921 fprintf (stderr
, "Write error on %s: %s\n",
922 DEVNAME (dev
), strerror (errno
));
926 if (mtd_type
!= MTD_ABSENT
)
927 ioctl(fd
, MEMLOCK
, &erase
);
929 processed
+= erasesize
;
931 blockstart
+= erasesize
;
934 if (write_total
> count
)
941 * Set obsolete flag at offset - NOR flash only
943 static int flash_flag_obsolete (int dev
, int fd
, off_t offset
)
946 struct erase_info_user erase
;
948 erase
.start
= DEVOFFSET (dev
);
949 erase
.length
= DEVESIZE (dev
);
950 /* This relies on the fact, that obsolete_flag == 0 */
951 rc
= lseek (fd
, offset
, SEEK_SET
);
953 fprintf (stderr
, "Cannot seek to set the flag on %s \n",
957 ioctl (fd
, MEMUNLOCK
, &erase
);
958 rc
= write (fd
, &obsolete_flag
, sizeof (obsolete_flag
));
959 ioctl (fd
, MEMLOCK
, &erase
);
961 perror ("Could not set obsolete flag");
966 /* Encrypt or decrypt the environment before writing or reading it. */
967 static int env_aes_cbc_crypt(char *payload
, const int enc
, uint8_t *key
)
969 uint8_t *data
= (uint8_t *)payload
;
970 const int len
= usable_envsize
;
971 uint8_t key_exp
[AES_EXPAND_KEY_LENGTH
];
974 /* First we expand the key. */
975 aes_expand_key(key
, key_exp
);
977 /* Calculate the number of AES blocks to encrypt. */
978 aes_blocks
= DIV_ROUND_UP(len
, AES_KEY_LENGTH
);
981 aes_cbc_encrypt_blocks(key_exp
, data
, data
, aes_blocks
);
983 aes_cbc_decrypt_blocks(key_exp
, data
, data
, aes_blocks
);
988 static int flash_write (int fd_current
, int fd_target
, int dev_target
)
992 switch (environment
.flag_scheme
) {
995 case FLAG_INCREMENTAL
:
996 (*environment
.flags
)++;
999 *environment
.flags
= active_flag
;
1002 fprintf (stderr
, "Unimplemented flash scheme %u \n",
1003 environment
.flag_scheme
);
1008 fprintf(stderr
, "Writing new environment at 0x%llx on %s\n",
1009 DEVOFFSET (dev_target
), DEVNAME (dev_target
));
1012 rc
= flash_write_buf(dev_target
, fd_target
, environment
.image
,
1013 CUR_ENVSIZE
, DEVOFFSET(dev_target
),
1014 DEVTYPE(dev_target
));
1018 if (environment
.flag_scheme
== FLAG_BOOLEAN
) {
1019 /* Have to set obsolete flag */
1020 off_t offset
= DEVOFFSET (dev_current
) +
1021 offsetof (struct env_image_redundant
, flags
);
1024 "Setting obsolete flag in environment at 0x%llx on %s\n",
1025 DEVOFFSET (dev_current
), DEVNAME (dev_current
));
1027 flash_flag_obsolete (dev_current
, fd_current
, offset
);
1033 static int flash_read (int fd
)
1037 rc
= flash_read_buf(dev_current
, fd
, environment
.image
, CUR_ENVSIZE
,
1038 DEVOFFSET(dev_current
), DEVTYPE(dev_current
));
1039 if (rc
!= CUR_ENVSIZE
)
1045 static int flash_io (int mode
)
1047 int fd_current
, fd_target
, rc
, dev_target
;
1049 /* dev_current: fd_current, erase_current */
1050 fd_current
= open (DEVNAME (dev_current
), mode
);
1051 if (fd_current
< 0) {
1053 "Can't open %s: %s\n",
1054 DEVNAME (dev_current
), strerror (errno
));
1058 if (mode
== O_RDWR
) {
1059 if (HaveRedundEnv
) {
1060 /* switch to next partition for writing */
1061 dev_target
= !dev_current
;
1062 /* dev_target: fd_target, erase_target */
1063 fd_target
= open (DEVNAME (dev_target
), mode
);
1064 if (fd_target
< 0) {
1066 "Can't open %s: %s\n",
1067 DEVNAME (dev_target
),
1073 dev_target
= dev_current
;
1074 fd_target
= fd_current
;
1077 rc
= flash_write (fd_current
, fd_target
, dev_target
);
1079 if (HaveRedundEnv
) {
1080 if (close (fd_target
)) {
1082 "I/O error on %s: %s\n",
1083 DEVNAME (dev_target
),
1089 rc
= flash_read (fd_current
);
1093 if (close (fd_current
)) {
1095 "I/O error on %s: %s\n",
1096 DEVNAME (dev_current
), strerror (errno
));
1104 * Prevent confusion if running from erased flash memory
1106 int fw_env_open(struct env_opts
*opts
)
1109 unsigned char flag0
;
1113 unsigned char flag1
;
1118 struct env_image_single
*single
;
1119 struct env_image_redundant
*redundant
;
1122 opts
= &default_opts
;
1124 if (parse_config(opts
)) /* should fill envdevices */
1127 addr0
= calloc(1, CUR_ENVSIZE
);
1128 if (addr0
== NULL
) {
1130 "Not enough memory for environment (%ld bytes)\n",
1135 /* read environment from FLASH to local buffer */
1136 environment
.image
= addr0
;
1138 if (HaveRedundEnv
) {
1140 environment
.crc
= &redundant
->crc
;
1141 environment
.flags
= &redundant
->flags
;
1142 environment
.data
= redundant
->data
;
1145 environment
.crc
= &single
->crc
;
1146 environment
.flags
= NULL
;
1147 environment
.data
= single
->data
;
1151 if (flash_io (O_RDONLY
))
1154 crc0
= crc32 (0, (uint8_t *) environment
.data
, ENV_SIZE
);
1156 if (opts
->aes_flag
) {
1157 ret
= env_aes_cbc_crypt(environment
.data
, 0,
1163 crc0_ok
= (crc0
== *environment
.crc
);
1164 if (!HaveRedundEnv
) {
1167 "Warning: Bad CRC, using default environment\n");
1168 memcpy(environment
.data
, default_environment
, sizeof default_environment
);
1171 flag0
= *environment
.flags
;
1174 addr1
= calloc(1, CUR_ENVSIZE
);
1175 if (addr1
== NULL
) {
1177 "Not enough memory for environment (%ld bytes)\n",
1184 * have to set environment.image for flash_read(), careful -
1185 * other pointers in environment still point inside addr0
1187 environment
.image
= addr1
;
1188 if (flash_io (O_RDONLY
))
1191 /* Check flag scheme compatibility */
1192 if (DEVTYPE(dev_current
) == MTD_NORFLASH
&&
1193 DEVTYPE(!dev_current
) == MTD_NORFLASH
) {
1194 environment
.flag_scheme
= FLAG_BOOLEAN
;
1195 } else if (DEVTYPE(dev_current
) == MTD_NANDFLASH
&&
1196 DEVTYPE(!dev_current
) == MTD_NANDFLASH
) {
1197 environment
.flag_scheme
= FLAG_INCREMENTAL
;
1198 } else if (DEVTYPE(dev_current
) == MTD_DATAFLASH
&&
1199 DEVTYPE(!dev_current
) == MTD_DATAFLASH
) {
1200 environment
.flag_scheme
= FLAG_BOOLEAN
;
1201 } else if (DEVTYPE(dev_current
) == MTD_UBIVOLUME
&&
1202 DEVTYPE(!dev_current
) == MTD_UBIVOLUME
) {
1203 environment
.flag_scheme
= FLAG_INCREMENTAL
;
1204 } else if (DEVTYPE(dev_current
) == MTD_ABSENT
&&
1205 DEVTYPE(!dev_current
) == MTD_ABSENT
) {
1206 environment
.flag_scheme
= FLAG_INCREMENTAL
;
1208 fprintf (stderr
, "Incompatible flash types!\n");
1212 crc1
= crc32 (0, (uint8_t *) redundant
->data
, ENV_SIZE
);
1214 if (opts
->aes_flag
) {
1215 ret
= env_aes_cbc_crypt(redundant
->data
, 0,
1221 crc1_ok
= (crc1
== redundant
->crc
);
1222 flag1
= redundant
->flags
;
1224 if (crc0_ok
&& !crc1_ok
) {
1226 } else if (!crc0_ok
&& crc1_ok
) {
1228 } else if (!crc0_ok
&& !crc1_ok
) {
1230 "Warning: Bad CRC, using default environment\n");
1231 memcpy (environment
.data
, default_environment
,
1232 sizeof default_environment
);
1235 switch (environment
.flag_scheme
) {
1237 if (flag0
== active_flag
&&
1238 flag1
== obsolete_flag
) {
1240 } else if (flag0
== obsolete_flag
&&
1241 flag1
== active_flag
) {
1243 } else if (flag0
== flag1
) {
1245 } else if (flag0
== 0xFF) {
1247 } else if (flag1
== 0xFF) {
1253 case FLAG_INCREMENTAL
:
1254 if (flag0
== 255 && flag1
== 0)
1256 else if ((flag1
== 255 && flag0
== 0) ||
1259 else /* flag1 > flag0 */
1263 fprintf (stderr
, "Unknown flag scheme %u \n",
1264 environment
.flag_scheme
);
1270 * If we are reading, we don't need the flag and the CRC any
1271 * more, if we are writing, we will re-calculate CRC and update
1272 * flags before writing out
1275 environment
.image
= addr1
;
1276 environment
.crc
= &redundant
->crc
;
1277 environment
.flags
= &redundant
->flags
;
1278 environment
.data
= redundant
->data
;
1281 environment
.image
= addr0
;
1282 /* Other pointers are already set */
1286 fprintf(stderr
, "Selected env in %s\n", DEVNAME(dev_current
));
1292 static int check_device_config(int dev
)
1297 if (DEVOFFSET(dev
) % DEVESIZE(dev
) != 0) {
1298 fprintf(stderr
, "Environment does not start on (erase) block boundary\n");
1303 if (ENVSIZE(dev
) > ENVSECTORS(dev
) * DEVESIZE(dev
)) {
1304 fprintf(stderr
, "Environment does not fit into available sectors\n");
1309 fd
= open(DEVNAME(dev
), O_RDONLY
);
1312 "Cannot open %s: %s\n",
1313 DEVNAME(dev
), strerror(errno
));
1317 rc
= fstat(fd
, &st
);
1319 fprintf(stderr
, "Cannot stat the file %s\n",
1324 if (S_ISCHR(st
.st_mode
)) {
1325 struct mtd_info_user mtdinfo
;
1326 rc
= ioctl(fd
, MEMGETINFO
, &mtdinfo
);
1328 fprintf(stderr
, "Cannot get MTD information for %s\n",
1332 if (mtdinfo
.type
!= MTD_NORFLASH
&&
1333 mtdinfo
.type
!= MTD_NANDFLASH
&&
1334 mtdinfo
.type
!= MTD_DATAFLASH
&&
1335 mtdinfo
.type
!= MTD_UBIVOLUME
) {
1336 fprintf(stderr
, "Unsupported flash type %u on %s\n",
1337 mtdinfo
.type
, DEVNAME(dev
));
1340 DEVTYPE(dev
) = mtdinfo
.type
;
1343 DEVTYPE(dev
) = MTD_ABSENT
;
1346 * Check for negative offsets, treat it as backwards offset
1347 * from the end of the block device
1349 if (DEVOFFSET(dev
) < 0) {
1350 rc
= ioctl(fd
, BLKGETSIZE64
, &size
);
1352 fprintf(stderr
, "Could not get block device size on %s\n",
1357 DEVOFFSET(dev
) = DEVOFFSET(dev
) + size
;
1359 fprintf(stderr
, "Calculated device offset 0x%llx on %s\n",
1360 DEVOFFSET(dev
), DEVNAME(dev
));
1370 static int parse_config(struct env_opts
*opts
)
1375 opts
= &default_opts
;
1377 #if defined(CONFIG_FILE)
1378 /* Fills in DEVNAME(), ENVSIZE(), DEVESIZE(). Or don't. */
1379 if (get_config(opts
->config_file
)) {
1380 fprintf(stderr
, "Cannot parse config file '%s': %m\n",
1385 DEVNAME (0) = DEVICE1_NAME
;
1386 DEVOFFSET (0) = DEVICE1_OFFSET
;
1387 ENVSIZE (0) = ENV1_SIZE
;
1388 /* Default values are: erase-size=env-size */
1389 DEVESIZE (0) = ENVSIZE (0);
1390 /* #sectors=env-size/erase-size (rounded up) */
1391 ENVSECTORS (0) = (ENVSIZE(0) + DEVESIZE(0) - 1) / DEVESIZE(0);
1392 #ifdef DEVICE1_ESIZE
1393 DEVESIZE (0) = DEVICE1_ESIZE
;
1395 #ifdef DEVICE1_ENVSECTORS
1396 ENVSECTORS (0) = DEVICE1_ENVSECTORS
;
1400 DEVNAME (1) = DEVICE2_NAME
;
1401 DEVOFFSET (1) = DEVICE2_OFFSET
;
1402 ENVSIZE (1) = ENV2_SIZE
;
1403 /* Default values are: erase-size=env-size */
1404 DEVESIZE (1) = ENVSIZE (1);
1405 /* #sectors=env-size/erase-size (rounded up) */
1406 ENVSECTORS (1) = (ENVSIZE(1) + DEVESIZE(1) - 1) / DEVESIZE(1);
1407 #ifdef DEVICE2_ESIZE
1408 DEVESIZE (1) = DEVICE2_ESIZE
;
1410 #ifdef DEVICE2_ENVSECTORS
1411 ENVSECTORS (1) = DEVICE2_ENVSECTORS
;
1416 rc
= check_device_config(0);
1420 if (HaveRedundEnv
) {
1421 rc
= check_device_config(1);
1425 if (ENVSIZE(0) != ENVSIZE(1)) {
1427 "Redundant environments have unequal size");
1432 usable_envsize
= CUR_ENVSIZE
- sizeof(uint32_t);
1434 usable_envsize
-= sizeof(char);
1437 usable_envsize
&= ~(AES_KEY_LENGTH
- 1);
1442 #if defined(CONFIG_FILE)
1443 static int get_config (char *fname
)
1451 fp
= fopen (fname
, "r");
1455 while (i
< 2 && fgets (dump
, sizeof (dump
), fp
)) {
1456 /* Skip incomplete conversions and comment strings */
1460 rc
= sscanf(dump
, "%ms %lli %lx %lx %lx",
1470 DEVNAME(i
) = devname
;
1473 /* Assume the erase size is the same as the env-size */
1474 DEVESIZE(i
) = ENVSIZE(i
);
1477 /* Assume enough env sectors to cover the environment */
1478 ENVSECTORS (i
) = (ENVSIZE(i
) + DEVESIZE(i
) - 1) / DEVESIZE(i
);
1484 HaveRedundEnv
= i
- 1;
1485 if (!i
) { /* No valid entries found */