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>
37 #include "fw_env_private.h"
40 struct env_opts default_opts = {
42 .config_file = CONFIG_FILE
46 #define DIV_ROUND_UP(n, d) (((n) + (d) - 1) / (d))
48 #define min(x, y) ({ \
49 typeof(x) _min1 = (x); \
50 typeof(y) _min2 = (y); \
51 (void) (&_min1 == &_min2); \
52 _min1 < _min2 ? _min1 : _min2; })
55 const char *devname; /* Device name */
56 long long devoff; /* Device offset */
57 ulong env_size; /* environment size */
58 ulong erase_size; /* device erase size */
59 ulong env_sectors; /* number of environment sectors */
60 uint8_t mtd_type; /* type of the MTD device */
63 static struct envdev_s envdevices[2] =
66 .mtd_type = MTD_ABSENT,
68 .mtd_type = MTD_ABSENT,
71 static int dev_current;
73 #define DEVNAME(i) envdevices[(i)].devname
74 #define DEVOFFSET(i) envdevices[(i)].devoff
75 #define ENVSIZE(i) envdevices[(i)].env_size
76 #define DEVESIZE(i) envdevices[(i)].erase_size
77 #define ENVSECTORS(i) envdevices[(i)].env_sectors
78 #define DEVTYPE(i) envdevices[(i)].mtd_type
80 #define CUR_ENVSIZE ENVSIZE(dev_current)
82 static unsigned long usable_envsize;
83 #define ENV_SIZE usable_envsize
85 struct env_image_single {
86 uint32_t crc; /* CRC32 over data bytes */
90 struct env_image_redundant {
91 uint32_t crc; /* CRC32 over data bytes */
92 unsigned char flags; /* active or obsolete */
105 unsigned char *flags;
107 enum flag_scheme flag_scheme;
110 static struct environment environment = {
111 .flag_scheme = FLAG_NONE,
114 static int env_aes_cbc_crypt(char *data, const int enc, uint8_t *key);
116 static int HaveRedundEnv = 0;
118 static unsigned char active_flag = 1;
119 /* obsolete_flag must be 0 to efficiently set it on NOR flash without erasing */
120 static unsigned char obsolete_flag = 0;
122 #define DEFAULT_ENV_INSTANCE_STATIC
123 #include <env_default.h>
125 static int flash_io (int mode);
126 static int parse_config(struct env_opts *opts);
128 #if defined(CONFIG_FILE)
129 static int get_config (char *);
132 static char *skip_chars(char *s)
134 for (; *s != '\0'; s++) {
141 static char *skip_blanks(char *s)
143 for (; *s != '\0'; s++) {
151 * s1 is either a simple 'name', or a 'name=value' pair.
152 * s2 is a 'name=value' pair.
153 * If the names match, return the value of s2, else NULL.
155 static char *envmatch(char *s1, char *s2)
157 if (s1 == NULL || s2 == NULL)
163 if (*s1 == '\0' && *(s2 - 1) == '=')
169 * Search the environment for a variable.
170 * Return the value, if found, or NULL, if not found.
172 char *fw_getenv (char *name)
176 for (env = environment.data; *env; env = nxt + 1) {
179 for (nxt = env; *nxt; ++nxt) {
180 if (nxt >= &environment.data[ENV_SIZE]) {
181 fprintf (stderr, "## Error: "
182 "environment not terminated\n");
186 val = envmatch (name, env);
195 * Search the default environment for a variable.
196 * Return the value, if found, or NULL, if not found.
198 char *fw_getdefenv(char *name)
202 for (env = default_environment; *env; env = nxt + 1) {
205 for (nxt = env; *nxt; ++nxt) {
206 if (nxt >= &default_environment[ENV_SIZE]) {
207 fprintf(stderr, "## Error: "
208 "default environment not terminated\n");
212 val = envmatch(name, env);
220 int parse_aes_key(char *key, uint8_t *bin_key)
222 char tmp[5] = { '0', 'x', 0, 0, 0 };
226 if (strnlen(key, 64) != 32) {
228 "## Error: '-a' option requires 16-byte AES key\n");
232 for (i = 0; i < 16; i++) {
236 ul = strtoul(tmp, NULL, 16);
239 "## Error: '-a' option requires valid AES key\n");
242 bin_key[i] = ul & 0xff;
249 * Print the current definition of one, or more, or all
250 * environment variables
252 int fw_printenv(int argc, char *argv[], int value_only, struct env_opts *opts)
256 if (value_only && argc != 1) {
258 "## Error: `-n' option requires exactly one argument\n");
263 opts = &default_opts;
265 if (fw_env_open(opts))
268 if (argc == 0) { /* Print all env variables */
270 for (env = environment.data; *env; env = nxt + 1) {
271 for (nxt = env; *nxt; ++nxt) {
272 if (nxt >= &environment.data[ENV_SIZE]) {
273 fprintf (stderr, "## Error: "
274 "environment not terminated\n");
279 printf ("%s\n", env);
285 for (i = 0; i < argc; ++i) { /* print a subset of env variables */
286 char *name = argv[i];
289 val = fw_getenv(name);
291 fprintf (stderr, "## Error: \"%s\" not defined\n", name);
301 printf("%s=%s\n", name, val);
309 int fw_env_flush(struct env_opts *opts)
314 opts = &default_opts;
316 if (opts->aes_flag) {
317 ret = env_aes_cbc_crypt(environment.data, 1,
321 "Error: can't encrypt env for flash\n");
329 *environment.crc = crc32(0, (uint8_t *) environment.data, ENV_SIZE);
331 /* write environment back to flash */
332 if (flash_io(O_RDWR)) {
334 "Error: can't write fw_env to flash\n");
343 * Set/Clear a single variable in the environment.
344 * This is called in sequence to update the environment
345 * in RAM without updating the copy in flash after each set
347 int fw_env_write(char *name, char *value)
352 int deleting, creating, overwriting;
355 * search if variable with this name already exists
357 for (nxt = env = environment.data; *env; env = nxt + 1) {
358 for (nxt = env; *nxt; ++nxt) {
359 if (nxt >= &environment.data[ENV_SIZE]) {
360 fprintf(stderr, "## Error: "
361 "environment not terminated\n");
366 if ((oldval = envmatch (name, env)) != NULL)
370 deleting = (oldval && !(value && strlen(value)));
371 creating = (!oldval && (value && strlen(value)));
372 overwriting = (oldval && (value && strlen(value)));
374 /* check for permission */
376 if (env_flags_validate_varaccess(name,
377 ENV_FLAGS_VARACCESS_PREVENT_DELETE)) {
378 printf("Can't delete \"%s\"\n", name);
382 } else if (overwriting) {
383 if (env_flags_validate_varaccess(name,
384 ENV_FLAGS_VARACCESS_PREVENT_OVERWR)) {
385 printf("Can't overwrite \"%s\"\n", name);
388 } else if (env_flags_validate_varaccess(name,
389 ENV_FLAGS_VARACCESS_PREVENT_NONDEF_OVERWR)) {
390 const char *defval = fw_getdefenv(name);
394 if (strcmp(oldval, defval)
396 printf("Can't overwrite \"%s\"\n", name);
401 } else if (creating) {
402 if (env_flags_validate_varaccess(name,
403 ENV_FLAGS_VARACCESS_PREVENT_CREATE)) {
404 printf("Can't create \"%s\"\n", name);
412 if (deleting || overwriting) {
413 if (*++nxt == '\0') {
418 if ((*env == '\0') && (*nxt == '\0'))
427 if (!value || !strlen(value))
431 * Append new definition at the end
433 for (env = environment.data; *env || *(env + 1); ++env);
434 if (env > environment.data)
438 * "name" + "=" + "val" +"\0\0" > CUR_ENVSIZE - (env-environment)
440 len = strlen (name) + 2;
441 /* add '=' for first arg, ' ' for all others */
442 len += strlen(value) + 1;
444 if (len > (&environment.data[ENV_SIZE] - env)) {
446 "Error: environment overflow, \"%s\" deleted\n",
451 while ((*env = *name++) != '\0')
454 while ((*++env = *value++) != '\0')
457 /* end is marked with double '\0' */
464 * Deletes or sets environment variables. Returns -1 and sets errno error codes:
466 * EINVAL - need at least 1 argument
467 * EROFS - certain variables ("ethaddr", "serial#") cannot be
468 * modified or deleted
471 int fw_setenv(int argc, char *argv[], struct env_opts *opts)
481 opts = &default_opts;
484 fprintf(stderr, "## Error: variable name missing\n");
489 if (fw_env_open(opts)) {
490 fprintf(stderr, "Error: environment not initialized\n");
498 if (env_flags_validate_env_set_params(name, valv, valc) < 0) {
504 for (i = 0; i < valc; ++i) {
506 size_t val_len = strlen(val);
509 value[len - 1] = ' ';
510 value = realloc(value, len + val_len + 1);
513 "Cannot malloc %zu bytes: %s\n",
514 len, strerror(errno));
518 memcpy(value + len, val, val_len);
523 fw_env_write(name, value);
527 ret = fw_env_flush(opts);
534 * Parse a file and configure the u-boot variables.
535 * The script file has a very simple format, as follows:
537 * Each line has a couple with name, value:
538 * <white spaces>variable_name<white spaces>variable_value
540 * Both variable_name and variable_value are interpreted as strings.
541 * Any character after <white spaces> and before ending \r\n is interpreted
542 * as variable's value (no comment allowed on these lines !)
544 * Comments are allowed if the first character in the line is #
546 * Returns -1 and sets errno error codes:
550 int fw_parse_script(char *fname, struct env_opts *opts)
553 char dump[1024]; /* Maximum line length in the file */
561 opts = &default_opts;
563 if (fw_env_open(opts)) {
564 fprintf(stderr, "Error: environment not initialized\n");
568 if (strcmp(fname, "-") == 0)
571 fp = fopen(fname, "r");
573 fprintf(stderr, "I cannot open %s for reading\n",
579 while (fgets(dump, sizeof(dump), fp)) {
584 * Read a whole line from the file. If the line is too long
585 * or is not terminated, reports an error and exit.
587 if (dump[len - 1] != '\n') {
589 "Line %d not corrected terminated or too long\n",
595 /* Drop ending line feed / carriage return */
597 if (len && dump[len - 1] == '\r')
600 /* Skip comment or empty lines */
601 if (len == 0 || dump[0] == '#')
605 * Search for variable's name,
606 * remove leading whitespaces
608 name = skip_blanks(dump);
612 /* The first white space is the end of variable name */
613 val = skip_chars(name);
617 if ((val - name) < len)
618 val = skip_blanks(val);
624 fprintf(stderr, "Setting %s : %s\n",
625 name, val ? val : " removed");
628 if (env_flags_validate_type(name, val) < 0) {
634 * If there is an error setting a variable,
635 * try to save the environment and returns an error
637 if (fw_env_write(name, val)) {
639 "fw_env_write returns with error : %s\n",
647 /* Close file if not stdin */
648 if (strcmp(fname, "-") != 0)
651 ret |= fw_env_flush(opts);
659 * environment_end() - compute offset of first byte right after environemnt
660 * @dev - index of enviroment buffer
662 * device offset of first byte right after environemnt
664 off_t environment_end(int dev)
666 /* environment is block aligned */
667 return DEVOFFSET(dev) + ENVSECTORS(dev) * DEVESIZE(dev);
671 * Test for bad block on NAND, just returns 0 on NOR, on NAND:
674 * < 0 - failed to test
676 static int flash_bad_block(int fd, uint8_t mtd_type, loff_t blockstart)
678 if (mtd_type == MTD_NANDFLASH) {
679 int badblock = ioctl(fd, MEMGETBADBLOCK, &blockstart);
682 perror ("Cannot read bad block mark");
688 fprintf (stderr, "Bad block at 0x%llx, skipping\n",
689 (unsigned long long)blockstart);
699 * Read data from flash at an offset into a provided buffer. On NAND it skips
700 * bad blocks but makes sure it stays within ENVSECTORS (dev) starting from
701 * the DEVOFFSET (dev) block. On NOR the loop is only run once.
703 static int flash_read_buf (int dev, int fd, void *buf, size_t count,
706 size_t blocklen; /* erase / write length - one block on NAND,
708 size_t processed = 0; /* progress counter */
709 size_t readlen = count; /* current read length */
710 off_t block_seek; /* offset inside the current block to the start
712 loff_t blockstart; /* running start of the current block -
713 MEMGETBADBLOCK needs 64 bits */
716 blockstart = (offset / DEVESIZE (dev)) * DEVESIZE (dev);
718 /* Offset inside a block */
719 block_seek = offset - blockstart;
721 if (DEVTYPE(dev) == MTD_NANDFLASH) {
723 * NAND: calculate which blocks we are reading. We have
724 * to read one block at a time to skip bad blocks.
726 blocklen = DEVESIZE (dev);
728 /* Limit to one block for the first read */
729 if (readlen > blocklen - block_seek)
730 readlen = blocklen - block_seek;
735 /* This only runs once on NOR flash */
736 while (processed < count) {
737 rc = flash_bad_block(fd, DEVTYPE(dev), blockstart);
738 if (rc < 0) /* block test failed */
741 if (blockstart + block_seek + readlen > environment_end(dev)) {
742 /* End of range is reached */
744 "Too few good blocks within range\n");
748 if (rc) { /* block is bad */
749 blockstart += blocklen;
754 * If a block is bad, we retry in the next block at the same
755 * offset - see common/env_nand.c::writeenv()
757 lseek (fd, blockstart + block_seek, SEEK_SET);
759 rc = read (fd, buf + processed, readlen);
761 fprintf (stderr, "Read error on %s: %s\n",
762 DEVNAME (dev), strerror (errno));
766 fprintf(stderr, "Read 0x%x bytes at 0x%llx on %s\n",
767 rc, (unsigned long long) blockstart + block_seek,
770 processed += readlen;
771 readlen = min (blocklen, count - processed);
773 blockstart += blocklen;
780 * Write count bytes from begin of environment, but stay within
781 * ENVSECTORS(dev) sectors of
782 * DEVOFFSET (dev). Similar to the read case above, on NOR and dataflash we
783 * erase and write the whole data at once.
785 static int flash_write_buf(int dev, int fd, void *buf, size_t count)
788 struct erase_info_user erase;
789 size_t blocklen; /* length of NAND block / NOR erase sector */
790 size_t erase_len; /* whole area that can be erased - may include
792 size_t erasesize; /* erase / write length - one block on NAND,
794 size_t processed = 0; /* progress counter */
795 size_t write_total; /* total size to actually write - excluding
797 off_t erase_offset; /* offset to the first erase block (aligned)
799 off_t block_seek; /* offset inside the erase block to the start
801 loff_t blockstart; /* running start of the current block -
802 MEMGETBADBLOCK needs 64 bits */
806 * For mtd devices only offset and size of the environment do matter
808 if (DEVTYPE(dev) == MTD_ABSENT) {
810 erase_len = blocklen;
811 blockstart = DEVOFFSET(dev);
813 write_total = blocklen;
815 blocklen = DEVESIZE(dev);
817 erase_offset = DEVOFFSET(dev);
819 /* Maximum area we may use */
820 erase_len = environment_end(dev) - erase_offset;
822 blockstart = erase_offset;
824 /* Offset inside a block */
825 block_seek = DEVOFFSET(dev) - erase_offset;
828 * Data size we actually write: from the start of the block
829 * to the start of the data, then count bytes of data, and
830 * to the end of the block
832 write_total = ((block_seek + count + blocklen - 1) /
833 blocklen) * blocklen;
837 * Support data anywhere within erase sectors: read out the complete
838 * area to be erased, replace the environment image, write the whole
841 if (write_total > count) {
842 data = malloc (erase_len);
845 "Cannot malloc %zu bytes: %s\n",
846 erase_len, strerror (errno));
850 rc = flash_read_buf(dev, fd, data, write_total, erase_offset);
851 if (write_total != rc)
855 fprintf(stderr, "Preserving data ");
857 fprintf(stderr, "0x%x - 0x%lx", 0, block_seek - 1);
858 if (block_seek + count != write_total) {
860 fprintf(stderr, " and ");
861 fprintf(stderr, "0x%lx - 0x%lx",
862 (unsigned long) block_seek + count,
863 (unsigned long) write_total - 1);
865 fprintf(stderr, "\n");
867 /* Overwrite the old environment */
868 memcpy (data + block_seek, buf, count);
871 * We get here, iff offset is block-aligned and count is a
872 * multiple of blocklen - see write_total calculation above
877 if (DEVTYPE(dev) == MTD_NANDFLASH) {
879 * NAND: calculate which blocks we are writing. We have
880 * to write one block at a time to skip bad blocks.
882 erasesize = blocklen;
884 erasesize = erase_len;
887 erase.length = erasesize;
889 /* This only runs once on NOR flash and SPI-dataflash */
890 while (processed < write_total) {
891 rc = flash_bad_block(fd, DEVTYPE(dev), blockstart);
892 if (rc < 0) /* block test failed */
895 if (blockstart + erasesize > environment_end(dev)) {
896 fprintf (stderr, "End of range reached, aborting\n");
900 if (rc) { /* block is bad */
901 blockstart += blocklen;
905 if (DEVTYPE(dev) != MTD_ABSENT) {
906 erase.start = blockstart;
907 ioctl(fd, MEMUNLOCK, &erase);
908 /* These do not need an explicit erase cycle */
909 if (DEVTYPE(dev) != MTD_DATAFLASH)
910 if (ioctl(fd, MEMERASE, &erase) != 0) {
912 "MTD erase error on %s: %s\n",
913 DEVNAME(dev), strerror(errno));
918 if (lseek (fd, blockstart, SEEK_SET) == -1) {
920 "Seek error on %s: %s\n",
921 DEVNAME (dev), strerror (errno));
926 fprintf(stderr, "Write 0x%llx bytes at 0x%llx\n",
927 (unsigned long long) erasesize,
928 (unsigned long long) blockstart);
930 if (write (fd, data + processed, erasesize) != erasesize) {
931 fprintf (stderr, "Write error on %s: %s\n",
932 DEVNAME (dev), strerror (errno));
936 if (DEVTYPE(dev) != MTD_ABSENT)
937 ioctl(fd, MEMLOCK, &erase);
939 processed += erasesize;
941 blockstart += erasesize;
944 if (write_total > count)
951 * Set obsolete flag at offset - NOR flash only
953 static int flash_flag_obsolete (int dev, int fd, off_t offset)
956 struct erase_info_user erase;
958 erase.start = DEVOFFSET (dev);
959 erase.length = DEVESIZE (dev);
960 /* This relies on the fact, that obsolete_flag == 0 */
961 rc = lseek (fd, offset, SEEK_SET);
963 fprintf (stderr, "Cannot seek to set the flag on %s \n",
967 ioctl (fd, MEMUNLOCK, &erase);
968 rc = write (fd, &obsolete_flag, sizeof (obsolete_flag));
969 ioctl (fd, MEMLOCK, &erase);
971 perror ("Could not set obsolete flag");
976 /* Encrypt or decrypt the environment before writing or reading it. */
977 static int env_aes_cbc_crypt(char *payload, const int enc, uint8_t *key)
979 uint8_t *data = (uint8_t *)payload;
980 const int len = usable_envsize;
981 uint8_t key_exp[AES_EXPAND_KEY_LENGTH];
984 /* First we expand the key. */
985 aes_expand_key(key, key_exp);
987 /* Calculate the number of AES blocks to encrypt. */
988 aes_blocks = DIV_ROUND_UP(len, AES_KEY_LENGTH);
991 aes_cbc_encrypt_blocks(key_exp, data, data, aes_blocks);
993 aes_cbc_decrypt_blocks(key_exp, data, data, aes_blocks);
998 static int flash_write (int fd_current, int fd_target, int dev_target)
1002 switch (environment.flag_scheme) {
1005 case FLAG_INCREMENTAL:
1006 (*environment.flags)++;
1009 *environment.flags = active_flag;
1012 fprintf (stderr, "Unimplemented flash scheme %u \n",
1013 environment.flag_scheme);
1018 fprintf(stderr, "Writing new environment at 0x%llx on %s\n",
1019 DEVOFFSET (dev_target), DEVNAME (dev_target));
1022 rc = flash_write_buf(dev_target, fd_target, environment.image,
1027 if (environment.flag_scheme == FLAG_BOOLEAN) {
1028 /* Have to set obsolete flag */
1029 off_t offset = DEVOFFSET (dev_current) +
1030 offsetof (struct env_image_redundant, flags);
1033 "Setting obsolete flag in environment at 0x%llx on %s\n",
1034 DEVOFFSET (dev_current), DEVNAME (dev_current));
1036 flash_flag_obsolete (dev_current, fd_current, offset);
1042 static int flash_read (int fd)
1046 rc = flash_read_buf(dev_current, fd, environment.image, CUR_ENVSIZE,
1047 DEVOFFSET(dev_current));
1048 if (rc != CUR_ENVSIZE)
1054 static int flash_io (int mode)
1056 int fd_current, fd_target, rc, dev_target;
1058 /* dev_current: fd_current, erase_current */
1059 fd_current = open (DEVNAME (dev_current), mode);
1060 if (fd_current < 0) {
1062 "Can't open %s: %s\n",
1063 DEVNAME (dev_current), strerror (errno));
1067 if (mode == O_RDWR) {
1068 if (HaveRedundEnv) {
1069 /* switch to next partition for writing */
1070 dev_target = !dev_current;
1071 /* dev_target: fd_target, erase_target */
1072 fd_target = open (DEVNAME (dev_target), mode);
1073 if (fd_target < 0) {
1075 "Can't open %s: %s\n",
1076 DEVNAME (dev_target),
1082 dev_target = dev_current;
1083 fd_target = fd_current;
1086 rc = flash_write (fd_current, fd_target, dev_target);
1088 if (HaveRedundEnv) {
1089 if (close (fd_target)) {
1091 "I/O error on %s: %s\n",
1092 DEVNAME (dev_target),
1098 rc = flash_read (fd_current);
1102 if (close (fd_current)) {
1104 "I/O error on %s: %s\n",
1105 DEVNAME (dev_current), strerror (errno));
1113 * Prevent confusion if running from erased flash memory
1115 int fw_env_open(struct env_opts *opts)
1118 unsigned char flag0;
1122 unsigned char flag1;
1127 struct env_image_single *single;
1128 struct env_image_redundant *redundant;
1131 opts = &default_opts;
1133 if (parse_config(opts)) /* should fill envdevices */
1136 addr0 = calloc(1, CUR_ENVSIZE);
1137 if (addr0 == NULL) {
1139 "Not enough memory for environment (%ld bytes)\n",
1145 /* read environment from FLASH to local buffer */
1146 environment.image = addr0;
1148 if (HaveRedundEnv) {
1150 environment.crc = &redundant->crc;
1151 environment.flags = &redundant->flags;
1152 environment.data = redundant->data;
1155 environment.crc = &single->crc;
1156 environment.flags = NULL;
1157 environment.data = single->data;
1161 if (flash_io(O_RDONLY)) {
1166 crc0 = crc32 (0, (uint8_t *) environment.data, ENV_SIZE);
1168 if (opts->aes_flag) {
1169 ret = env_aes_cbc_crypt(environment.data, 0,
1175 crc0_ok = (crc0 == *environment.crc);
1176 if (!HaveRedundEnv) {
1179 "Warning: Bad CRC, using default environment\n");
1180 memcpy(environment.data, default_environment, sizeof default_environment);
1183 flag0 = *environment.flags;
1186 addr1 = calloc(1, CUR_ENVSIZE);
1187 if (addr1 == NULL) {
1189 "Not enough memory for environment (%ld bytes)\n",
1197 * have to set environment.image for flash_read(), careful -
1198 * other pointers in environment still point inside addr0
1200 environment.image = addr1;
1201 if (flash_io(O_RDONLY)) {
1206 /* Check flag scheme compatibility */
1207 if (DEVTYPE(dev_current) == MTD_NORFLASH &&
1208 DEVTYPE(!dev_current) == MTD_NORFLASH) {
1209 environment.flag_scheme = FLAG_BOOLEAN;
1210 } else if (DEVTYPE(dev_current) == MTD_NANDFLASH &&
1211 DEVTYPE(!dev_current) == MTD_NANDFLASH) {
1212 environment.flag_scheme = FLAG_INCREMENTAL;
1213 } else if (DEVTYPE(dev_current) == MTD_DATAFLASH &&
1214 DEVTYPE(!dev_current) == MTD_DATAFLASH) {
1215 environment.flag_scheme = FLAG_BOOLEAN;
1216 } else if (DEVTYPE(dev_current) == MTD_UBIVOLUME &&
1217 DEVTYPE(!dev_current) == MTD_UBIVOLUME) {
1218 environment.flag_scheme = FLAG_INCREMENTAL;
1219 } else if (DEVTYPE(dev_current) == MTD_ABSENT &&
1220 DEVTYPE(!dev_current) == MTD_ABSENT) {
1221 environment.flag_scheme = FLAG_INCREMENTAL;
1223 fprintf (stderr, "Incompatible flash types!\n");
1228 crc1 = crc32 (0, (uint8_t *) redundant->data, ENV_SIZE);
1230 if (opts->aes_flag) {
1231 ret = env_aes_cbc_crypt(redundant->data, 0,
1237 crc1_ok = (crc1 == redundant->crc);
1238 flag1 = redundant->flags;
1240 if (crc0_ok && !crc1_ok) {
1242 } else if (!crc0_ok && crc1_ok) {
1244 } else if (!crc0_ok && !crc1_ok) {
1246 "Warning: Bad CRC, using default environment\n");
1247 memcpy (environment.data, default_environment,
1248 sizeof default_environment);
1251 switch (environment.flag_scheme) {
1253 if (flag0 == active_flag &&
1254 flag1 == obsolete_flag) {
1256 } else if (flag0 == obsolete_flag &&
1257 flag1 == active_flag) {
1259 } else if (flag0 == flag1) {
1261 } else if (flag0 == 0xFF) {
1263 } else if (flag1 == 0xFF) {
1269 case FLAG_INCREMENTAL:
1270 if (flag0 == 255 && flag1 == 0)
1272 else if ((flag1 == 255 && flag0 == 0) ||
1275 else /* flag1 > flag0 */
1279 fprintf (stderr, "Unknown flag scheme %u \n",
1280 environment.flag_scheme);
1286 * If we are reading, we don't need the flag and the CRC any
1287 * more, if we are writing, we will re-calculate CRC and update
1288 * flags before writing out
1291 environment.image = addr1;
1292 environment.crc = &redundant->crc;
1293 environment.flags = &redundant->flags;
1294 environment.data = redundant->data;
1297 environment.image = addr0;
1298 /* Other pointers are already set */
1302 fprintf(stderr, "Selected env in %s\n", DEVNAME(dev_current));
1318 * Simply free allocated buffer with environment
1320 int fw_env_close(struct env_opts *opts)
1322 if (environment.image)
1323 free(environment.image);
1325 environment.image = NULL;
1330 static int check_device_config(int dev)
1335 fd = open(DEVNAME(dev), O_RDONLY);
1338 "Cannot open %s: %s\n",
1339 DEVNAME(dev), strerror(errno));
1343 rc = fstat(fd, &st);
1345 fprintf(stderr, "Cannot stat the file %s\n",
1350 if (S_ISCHR(st.st_mode)) {
1351 struct mtd_info_user mtdinfo;
1352 rc = ioctl(fd, MEMGETINFO, &mtdinfo);
1354 fprintf(stderr, "Cannot get MTD information for %s\n",
1358 if (mtdinfo.type != MTD_NORFLASH &&
1359 mtdinfo.type != MTD_NANDFLASH &&
1360 mtdinfo.type != MTD_DATAFLASH &&
1361 mtdinfo.type != MTD_UBIVOLUME) {
1362 fprintf(stderr, "Unsupported flash type %u on %s\n",
1363 mtdinfo.type, DEVNAME(dev));
1366 DEVTYPE(dev) = mtdinfo.type;
1367 if (DEVESIZE(dev) == 0)
1368 /* Assume the erase size is the same as the env-size */
1369 DEVESIZE(dev) = ENVSIZE(dev);
1372 DEVTYPE(dev) = MTD_ABSENT;
1373 if (DEVESIZE(dev) == 0)
1374 /* Assume the erase size to be 512 bytes */
1375 DEVESIZE(dev) = 0x200;
1378 * Check for negative offsets, treat it as backwards offset
1379 * from the end of the block device
1381 if (DEVOFFSET(dev) < 0) {
1382 rc = ioctl(fd, BLKGETSIZE64, &size);
1384 fprintf(stderr, "Could not get block device size on %s\n",
1389 DEVOFFSET(dev) = DEVOFFSET(dev) + size;
1391 fprintf(stderr, "Calculated device offset 0x%llx on %s\n",
1392 DEVOFFSET(dev), DEVNAME(dev));
1397 if (ENVSECTORS(dev) == 0)
1398 /* Assume enough sectors to cover the environment */
1399 ENVSECTORS(dev) = DIV_ROUND_UP(ENVSIZE(dev), DEVESIZE(dev));
1401 if (DEVOFFSET(dev) % DEVESIZE(dev) != 0) {
1402 fprintf(stderr, "Environment does not start on (erase) block boundary\n");
1407 if (ENVSIZE(dev) > ENVSECTORS(dev) * DEVESIZE(dev)) {
1408 fprintf(stderr, "Environment does not fit into available sectors\n");
1418 static int parse_config(struct env_opts *opts)
1423 opts = &default_opts;
1425 #if defined(CONFIG_FILE)
1426 /* Fills in DEVNAME(), ENVSIZE(), DEVESIZE(). Or don't. */
1427 if (get_config(opts->config_file)) {
1428 fprintf(stderr, "Cannot parse config file '%s': %m\n",
1433 DEVNAME (0) = DEVICE1_NAME;
1434 DEVOFFSET (0) = DEVICE1_OFFSET;
1435 ENVSIZE (0) = ENV1_SIZE;
1437 /* Set defaults for DEVESIZE, ENVSECTORS later once we
1440 #ifdef DEVICE1_ESIZE
1441 DEVESIZE (0) = DEVICE1_ESIZE;
1443 #ifdef DEVICE1_ENVSECTORS
1444 ENVSECTORS (0) = DEVICE1_ENVSECTORS;
1448 DEVNAME (1) = DEVICE2_NAME;
1449 DEVOFFSET (1) = DEVICE2_OFFSET;
1450 ENVSIZE (1) = ENV2_SIZE;
1452 /* Set defaults for DEVESIZE, ENVSECTORS later once we
1455 #ifdef DEVICE2_ESIZE
1456 DEVESIZE (1) = DEVICE2_ESIZE;
1458 #ifdef DEVICE2_ENVSECTORS
1459 ENVSECTORS (1) = DEVICE2_ENVSECTORS;
1464 rc = check_device_config(0);
1468 if (HaveRedundEnv) {
1469 rc = check_device_config(1);
1473 if (ENVSIZE(0) != ENVSIZE(1)) {
1475 "Redundant environments have unequal size");
1480 usable_envsize = CUR_ENVSIZE - sizeof(uint32_t);
1482 usable_envsize -= sizeof(char);
1485 usable_envsize &= ~(AES_KEY_LENGTH - 1);
1490 #if defined(CONFIG_FILE)
1491 static int get_config (char *fname)
1499 fp = fopen (fname, "r");
1503 while (i < 2 && fgets (dump, sizeof (dump), fp)) {
1504 /* Skip incomplete conversions and comment strings */
1508 rc = sscanf(dump, "%ms %lli %lx %lx %lx",
1518 DEVNAME(i) = devname;
1520 /* Set defaults for DEVESIZE, ENVSECTORS later once we
1528 HaveRedundEnv = i - 1;
1529 if (!i) { /* No valid entries found */