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>
32 # include <linux/mtd/mtd.h>
34 # define __user /* nothing */
35 # include <mtd/mtd-user.h>
38 #include <mtd/ubi-user.h>
40 #include "fw_env_private.h"
43 struct env_opts default_opts = {
45 .config_file = CONFIG_FILE
49 #define DIV_ROUND_UP(n, d) (((n) + (d) - 1) / (d))
51 #define min(x, y) ({ \
52 typeof(x) _min1 = (x); \
53 typeof(y) _min2 = (y); \
54 (void) (&_min1 == &_min2); \
55 _min1 < _min2 ? _min1 : _min2; })
58 const char *devname; /* Device name */
59 long long devoff; /* Device offset */
60 ulong env_size; /* environment size */
61 ulong erase_size; /* device erase size */
62 ulong env_sectors; /* number of environment sectors */
63 uint8_t mtd_type; /* type of the MTD device */
64 int is_ubi; /* set if we use UBI volume */
67 static struct envdev_s envdevices[2] =
70 .mtd_type = MTD_ABSENT,
72 .mtd_type = MTD_ABSENT,
75 static int dev_current;
77 #define DEVNAME(i) envdevices[(i)].devname
78 #define DEVOFFSET(i) envdevices[(i)].devoff
79 #define ENVSIZE(i) envdevices[(i)].env_size
80 #define DEVESIZE(i) envdevices[(i)].erase_size
81 #define ENVSECTORS(i) envdevices[(i)].env_sectors
82 #define DEVTYPE(i) envdevices[(i)].mtd_type
83 #define IS_UBI(i) envdevices[(i)].is_ubi
85 #define CUR_ENVSIZE ENVSIZE(dev_current)
87 static unsigned long usable_envsize;
88 #define ENV_SIZE usable_envsize
90 struct env_image_single {
91 uint32_t crc; /* CRC32 over data bytes */
95 struct env_image_redundant {
96 uint32_t crc; /* CRC32 over data bytes */
97 unsigned char flags; /* active or obsolete */
110 unsigned char *flags;
112 enum flag_scheme flag_scheme;
115 static struct environment environment = {
116 .flag_scheme = FLAG_NONE,
119 static int HaveRedundEnv = 0;
121 static unsigned char active_flag = 1;
122 /* obsolete_flag must be 0 to efficiently set it on NOR flash without erasing */
123 static unsigned char obsolete_flag = 0;
125 #define DEFAULT_ENV_INSTANCE_STATIC
126 #include <env_default.h>
128 #define UBI_DEV_START "/dev/ubi"
129 #define UBI_SYSFS "/sys/class/ubi"
130 #define UBI_VOL_NAME_PATT "ubi%d_%d"
132 static int is_ubi_devname(const char *devname)
134 return !strncmp(devname, UBI_DEV_START, sizeof(UBI_DEV_START) - 1);
137 static int ubi_check_volume_sysfs_name(const char *volume_sysfs_name,
145 strcpy(path, UBI_SYSFS "/");
146 strcat(path, volume_sysfs_name);
147 strcat(path, "/name");
149 file = fopen(path, "r");
153 ret = fscanf(file, "%ms", &name);
155 if (ret <= 0 || !name) {
157 "Failed to read from file %s, ret = %d, name = %s\n",
162 if (!strcmp(name, volname)) {
171 static int ubi_get_volnum_by_name(int devnum, const char *volname)
174 struct dirent *dirent;
179 sysfs_ubi = opendir(UBI_SYSFS);
184 fprintf(stderr, "Looking for volume name \"%s\"\n", volname);
188 dirent = readdir(sysfs_ubi);
192 ret = sscanf(dirent->d_name, UBI_VOL_NAME_PATT,
193 &tmp_devnum, &volnum);
194 if (ret == 2 && devnum == tmp_devnum) {
195 if (ubi_check_volume_sysfs_name(dirent->d_name,
204 static int ubi_get_devnum_by_devname(const char *devname)
209 ret = sscanf(devname + sizeof(UBI_DEV_START) - 1, "%d", &devnum);
216 static const char *ubi_get_volume_devname(const char *devname,
219 char *volume_devname;
224 devnum = ubi_get_devnum_by_devname(devname);
228 volnum = ubi_get_volnum_by_name(devnum, volname);
232 ret = asprintf(&volume_devname, "%s_%d", devname, volnum);
237 fprintf(stderr, "Found ubi volume \"%s:%s\" -> %s\n",
238 devname, volname, volume_devname);
241 return volume_devname;
244 static void ubi_check_dev(unsigned int dev_id)
246 char *devname = (char *)DEVNAME(dev_id);
248 const char *volname = NULL;
249 const char *volume_devname;
251 if (!is_ubi_devname(DEVNAME(dev_id)))
256 for (pname = devname; *pname != '\0'; pname++) {
265 /* Let's find real volume device name */
266 volume_devname = ubi_get_volume_devname(devname, volname);
267 if (!volume_devname) {
268 fprintf(stderr, "Didn't found ubi volume \"%s\"\n",
274 DEVNAME(dev_id) = volume_devname;
278 static int ubi_update_start(int fd, int64_t bytes)
280 if (ioctl(fd, UBI_IOCVOLUP, &bytes))
285 static int ubi_read(int fd, void *buf, size_t count)
290 ret = read(fd, buf, count);
300 * Happens in case of too short volume data size. If we
301 * return error status we will fail it will be treated
302 * as UBI device error.
304 * Leave catching this error to CRC check.
306 fprintf(stderr, "Warning: end of data on ubi volume\n");
308 } else if (errno == EBADF) {
310 * Happens in case of corrupted volume. The same as
311 * above, we cannot return error now, as we will still
312 * be able to successfully write environment later.
314 fprintf(stderr, "Warning: corrupted volume?\n");
316 } else if (errno == EINTR) {
320 fprintf(stderr, "Cannot read %u bytes from ubi volume, %s\n",
321 (unsigned int)count, strerror(errno));
328 static int ubi_write(int fd, const void *buf, size_t count)
333 ret = write(fd, buf, count);
335 if (ret < 0 && errno == EINTR)
338 fprintf(stderr, "Cannot write %u bytes to ubi volume\n",
339 (unsigned int)count);
350 static int flash_io (int mode);
351 static int parse_config(struct env_opts *opts);
353 #if defined(CONFIG_FILE)
354 static int get_config (char *);
357 static char *skip_chars(char *s)
359 for (; *s != '\0'; s++) {
366 static char *skip_blanks(char *s)
368 for (; *s != '\0'; s++) {
376 * s1 is either a simple 'name', or a 'name=value' pair.
377 * s2 is a 'name=value' pair.
378 * If the names match, return the value of s2, else NULL.
380 static char *envmatch(char *s1, char *s2)
382 if (s1 == NULL || s2 == NULL)
388 if (*s1 == '\0' && *(s2 - 1) == '=')
394 * Search the environment for a variable.
395 * Return the value, if found, or NULL, if not found.
397 char *fw_getenv (char *name)
401 for (env = environment.data; *env; env = nxt + 1) {
404 for (nxt = env; *nxt; ++nxt) {
405 if (nxt >= &environment.data[ENV_SIZE]) {
406 fprintf (stderr, "## Error: "
407 "environment not terminated\n");
411 val = envmatch (name, env);
420 * Search the default environment for a variable.
421 * Return the value, if found, or NULL, if not found.
423 char *fw_getdefenv(char *name)
427 for (env = default_environment; *env; env = nxt + 1) {
430 for (nxt = env; *nxt; ++nxt) {
431 if (nxt >= &default_environment[ENV_SIZE]) {
432 fprintf(stderr, "## Error: "
433 "default environment not terminated\n");
437 val = envmatch(name, env);
446 * Print the current definition of one, or more, or all
447 * environment variables
449 int fw_printenv(int argc, char *argv[], int value_only, struct env_opts *opts)
453 if (value_only && argc != 1) {
455 "## Error: `-n' option requires exactly one argument\n");
460 opts = &default_opts;
462 if (fw_env_open(opts))
465 if (argc == 0) { /* Print all env variables */
467 for (env = environment.data; *env; env = nxt + 1) {
468 for (nxt = env; *nxt; ++nxt) {
469 if (nxt >= &environment.data[ENV_SIZE]) {
470 fprintf (stderr, "## Error: "
471 "environment not terminated\n");
476 printf ("%s\n", env);
482 for (i = 0; i < argc; ++i) { /* print a subset of env variables */
483 char *name = argv[i];
486 val = fw_getenv(name);
488 fprintf (stderr, "## Error: \"%s\" not defined\n", name);
498 printf("%s=%s\n", name, val);
506 int fw_env_flush(struct env_opts *opts)
511 opts = &default_opts;
516 *environment.crc = crc32(0, (uint8_t *) environment.data, ENV_SIZE);
518 /* write environment back to flash */
519 if (flash_io(O_RDWR)) {
521 "Error: can't write fw_env to flash\n");
530 * Set/Clear a single variable in the environment.
531 * This is called in sequence to update the environment
532 * in RAM without updating the copy in flash after each set
534 int fw_env_write(char *name, char *value)
539 int deleting, creating, overwriting;
542 * search if variable with this name already exists
544 for (nxt = env = environment.data; *env; env = nxt + 1) {
545 for (nxt = env; *nxt; ++nxt) {
546 if (nxt >= &environment.data[ENV_SIZE]) {
547 fprintf(stderr, "## Error: "
548 "environment not terminated\n");
553 if ((oldval = envmatch (name, env)) != NULL)
557 deleting = (oldval && !(value && strlen(value)));
558 creating = (!oldval && (value && strlen(value)));
559 overwriting = (oldval && (value && strlen(value)));
561 /* check for permission */
563 if (env_flags_validate_varaccess(name,
564 ENV_FLAGS_VARACCESS_PREVENT_DELETE)) {
565 printf("Can't delete \"%s\"\n", name);
569 } else if (overwriting) {
570 if (env_flags_validate_varaccess(name,
571 ENV_FLAGS_VARACCESS_PREVENT_OVERWR)) {
572 printf("Can't overwrite \"%s\"\n", name);
575 } else if (env_flags_validate_varaccess(name,
576 ENV_FLAGS_VARACCESS_PREVENT_NONDEF_OVERWR)) {
577 const char *defval = fw_getdefenv(name);
581 if (strcmp(oldval, defval)
583 printf("Can't overwrite \"%s\"\n", name);
588 } else if (creating) {
589 if (env_flags_validate_varaccess(name,
590 ENV_FLAGS_VARACCESS_PREVENT_CREATE)) {
591 printf("Can't create \"%s\"\n", name);
599 if (deleting || overwriting) {
600 if (*++nxt == '\0') {
605 if ((*env == '\0') && (*nxt == '\0'))
614 if (!value || !strlen(value))
618 * Append new definition at the end
620 for (env = environment.data; *env || *(env + 1); ++env);
621 if (env > environment.data)
625 * "name" + "=" + "val" +"\0\0" > CUR_ENVSIZE - (env-environment)
627 len = strlen (name) + 2;
628 /* add '=' for first arg, ' ' for all others */
629 len += strlen(value) + 1;
631 if (len > (&environment.data[ENV_SIZE] - env)) {
633 "Error: environment overflow, \"%s\" deleted\n",
638 while ((*env = *name++) != '\0')
641 while ((*++env = *value++) != '\0')
644 /* end is marked with double '\0' */
651 * Deletes or sets environment variables. Returns -1 and sets errno error codes:
653 * EINVAL - need at least 1 argument
654 * EROFS - certain variables ("ethaddr", "serial#") cannot be
655 * modified or deleted
658 int fw_env_set(int argc, char *argv[], struct env_opts *opts)
669 opts = &default_opts;
672 fprintf(stderr, "## Error: variable name missing\n");
677 if (fw_env_open(opts)) {
678 fprintf(stderr, "Error: environment not initialized\n");
686 if (env_flags_validate_env_set_params(name, valv, valc) < 0) {
692 for (i = 0; i < valc; ++i) {
694 size_t val_len = strlen(val);
697 value[len - 1] = ' ';
699 value = realloc(value, len + val_len + 1);
702 "Cannot malloc %zu bytes: %s\n",
703 len, strerror(errno));
708 memcpy(value + len, val, val_len);
713 fw_env_write(name, value);
717 ret = fw_env_flush(opts);
724 * Parse a file and configure the u-boot variables.
725 * The script file has a very simple format, as follows:
727 * Each line has a couple with name, value:
728 * <white spaces>variable_name<white spaces>variable_value
730 * Both variable_name and variable_value are interpreted as strings.
731 * Any character after <white spaces> and before ending \r\n is interpreted
732 * as variable's value (no comment allowed on these lines !)
734 * Comments are allowed if the first character in the line is #
736 * Returns -1 and sets errno error codes:
740 int fw_parse_script(char *fname, struct env_opts *opts)
743 char dump[1024]; /* Maximum line length in the file */
751 opts = &default_opts;
753 if (fw_env_open(opts)) {
754 fprintf(stderr, "Error: environment not initialized\n");
758 if (strcmp(fname, "-") == 0)
761 fp = fopen(fname, "r");
763 fprintf(stderr, "I cannot open %s for reading\n",
769 while (fgets(dump, sizeof(dump), fp)) {
774 * Read a whole line from the file. If the line is too long
775 * or is not terminated, reports an error and exit.
777 if (dump[len - 1] != '\n') {
779 "Line %d not corrected terminated or too long\n",
785 /* Drop ending line feed / carriage return */
787 if (len && dump[len - 1] == '\r')
790 /* Skip comment or empty lines */
791 if (len == 0 || dump[0] == '#')
795 * Search for variable's name,
796 * remove leading whitespaces
798 name = skip_blanks(dump);
802 /* The first white space is the end of variable name */
803 val = skip_chars(name);
807 if ((val - name) < len)
808 val = skip_blanks(val);
814 fprintf(stderr, "Setting %s : %s\n",
815 name, val ? val : " removed");
818 if (env_flags_validate_type(name, val) < 0) {
824 * If there is an error setting a variable,
825 * try to save the environment and returns an error
827 if (fw_env_write(name, val)) {
829 "fw_env_write returns with error : %s\n",
837 /* Close file if not stdin */
838 if (strcmp(fname, "-") != 0)
841 ret |= fw_env_flush(opts);
849 * environment_end() - compute offset of first byte right after environemnt
850 * @dev - index of enviroment buffer
852 * device offset of first byte right after environemnt
854 off_t environment_end(int dev)
856 /* environment is block aligned */
857 return DEVOFFSET(dev) + ENVSECTORS(dev) * DEVESIZE(dev);
861 * Test for bad block on NAND, just returns 0 on NOR, on NAND:
864 * < 0 - failed to test
866 static int flash_bad_block(int fd, uint8_t mtd_type, loff_t blockstart)
868 if (mtd_type == MTD_NANDFLASH) {
869 int badblock = ioctl(fd, MEMGETBADBLOCK, &blockstart);
872 perror ("Cannot read bad block mark");
878 fprintf (stderr, "Bad block at 0x%llx, skipping\n",
879 (unsigned long long)blockstart);
889 * Read data from flash at an offset into a provided buffer. On NAND it skips
890 * bad blocks but makes sure it stays within ENVSECTORS (dev) starting from
891 * the DEVOFFSET (dev) block. On NOR the loop is only run once.
893 static int flash_read_buf (int dev, int fd, void *buf, size_t count,
896 size_t blocklen; /* erase / write length - one block on NAND,
898 size_t processed = 0; /* progress counter */
899 size_t readlen = count; /* current read length */
900 off_t block_seek; /* offset inside the current block to the start
902 loff_t blockstart; /* running start of the current block -
903 MEMGETBADBLOCK needs 64 bits */
906 blockstart = (offset / DEVESIZE (dev)) * DEVESIZE (dev);
908 /* Offset inside a block */
909 block_seek = offset - blockstart;
911 if (DEVTYPE(dev) == MTD_NANDFLASH) {
913 * NAND: calculate which blocks we are reading. We have
914 * to read one block at a time to skip bad blocks.
916 blocklen = DEVESIZE (dev);
918 /* Limit to one block for the first read */
919 if (readlen > blocklen - block_seek)
920 readlen = blocklen - block_seek;
925 /* This only runs once on NOR flash */
926 while (processed < count) {
927 rc = flash_bad_block(fd, DEVTYPE(dev), blockstart);
928 if (rc < 0) /* block test failed */
931 if (blockstart + block_seek + readlen > environment_end(dev)) {
932 /* End of range is reached */
934 "Too few good blocks within range\n");
938 if (rc) { /* block is bad */
939 blockstart += blocklen;
944 * If a block is bad, we retry in the next block at the same
945 * offset - see env/nand.c::writeenv()
947 lseek (fd, blockstart + block_seek, SEEK_SET);
949 rc = read (fd, buf + processed, readlen);
951 fprintf (stderr, "Read error on %s: %s\n",
952 DEVNAME (dev), strerror (errno));
956 fprintf(stderr, "Read 0x%x bytes at 0x%llx on %s\n",
957 rc, (unsigned long long) blockstart + block_seek,
960 processed += readlen;
961 readlen = min (blocklen, count - processed);
963 blockstart += blocklen;
970 * Write count bytes from begin of environment, but stay within
971 * ENVSECTORS(dev) sectors of
972 * DEVOFFSET (dev). Similar to the read case above, on NOR and dataflash we
973 * erase and write the whole data at once.
975 static int flash_write_buf(int dev, int fd, void *buf, size_t count)
978 struct erase_info_user erase;
979 size_t blocklen; /* length of NAND block / NOR erase sector */
980 size_t erase_len; /* whole area that can be erased - may include
982 size_t erasesize; /* erase / write length - one block on NAND,
984 size_t processed = 0; /* progress counter */
985 size_t write_total; /* total size to actually write - excluding
987 off_t erase_offset; /* offset to the first erase block (aligned)
989 off_t block_seek; /* offset inside the erase block to the start
991 loff_t blockstart; /* running start of the current block -
992 MEMGETBADBLOCK needs 64 bits */
996 * For mtd devices only offset and size of the environment do matter
998 if (DEVTYPE(dev) == MTD_ABSENT) {
1000 erase_len = blocklen;
1001 blockstart = DEVOFFSET(dev);
1003 write_total = blocklen;
1005 blocklen = DEVESIZE(dev);
1007 erase_offset = DEVOFFSET(dev);
1009 /* Maximum area we may use */
1010 erase_len = environment_end(dev) - erase_offset;
1012 blockstart = erase_offset;
1014 /* Offset inside a block */
1015 block_seek = DEVOFFSET(dev) - erase_offset;
1018 * Data size we actually write: from the start of the block
1019 * to the start of the data, then count bytes of data, and
1020 * to the end of the block
1022 write_total = ((block_seek + count + blocklen - 1) /
1023 blocklen) * blocklen;
1027 * Support data anywhere within erase sectors: read out the complete
1028 * area to be erased, replace the environment image, write the whole
1031 if (write_total > count) {
1032 data = malloc (erase_len);
1035 "Cannot malloc %zu bytes: %s\n",
1036 erase_len, strerror (errno));
1040 rc = flash_read_buf(dev, fd, data, write_total, erase_offset);
1041 if (write_total != rc)
1045 fprintf(stderr, "Preserving data ");
1046 if (block_seek != 0)
1047 fprintf(stderr, "0x%x - 0x%lx", 0, block_seek - 1);
1048 if (block_seek + count != write_total) {
1049 if (block_seek != 0)
1050 fprintf(stderr, " and ");
1051 fprintf(stderr, "0x%lx - 0x%lx",
1052 (unsigned long) block_seek + count,
1053 (unsigned long) write_total - 1);
1055 fprintf(stderr, "\n");
1057 /* Overwrite the old environment */
1058 memcpy (data + block_seek, buf, count);
1061 * We get here, iff offset is block-aligned and count is a
1062 * multiple of blocklen - see write_total calculation above
1067 if (DEVTYPE(dev) == MTD_NANDFLASH) {
1069 * NAND: calculate which blocks we are writing. We have
1070 * to write one block at a time to skip bad blocks.
1072 erasesize = blocklen;
1074 erasesize = erase_len;
1077 erase.length = erasesize;
1079 /* This only runs once on NOR flash and SPI-dataflash */
1080 while (processed < write_total) {
1081 rc = flash_bad_block(fd, DEVTYPE(dev), blockstart);
1082 if (rc < 0) /* block test failed */
1085 if (blockstart + erasesize > environment_end(dev)) {
1086 fprintf (stderr, "End of range reached, aborting\n");
1090 if (rc) { /* block is bad */
1091 blockstart += blocklen;
1095 if (DEVTYPE(dev) != MTD_ABSENT) {
1096 erase.start = blockstart;
1097 ioctl(fd, MEMUNLOCK, &erase);
1098 /* These do not need an explicit erase cycle */
1099 if (DEVTYPE(dev) != MTD_DATAFLASH)
1100 if (ioctl(fd, MEMERASE, &erase) != 0) {
1102 "MTD erase error on %s: %s\n",
1103 DEVNAME(dev), strerror(errno));
1108 if (lseek (fd, blockstart, SEEK_SET) == -1) {
1110 "Seek error on %s: %s\n",
1111 DEVNAME (dev), strerror (errno));
1116 fprintf(stderr, "Write 0x%llx bytes at 0x%llx\n",
1117 (unsigned long long) erasesize,
1118 (unsigned long long) blockstart);
1120 if (write (fd, data + processed, erasesize) != erasesize) {
1121 fprintf (stderr, "Write error on %s: %s\n",
1122 DEVNAME (dev), strerror (errno));
1126 if (DEVTYPE(dev) != MTD_ABSENT)
1127 ioctl(fd, MEMLOCK, &erase);
1129 processed += erasesize;
1131 blockstart += erasesize;
1134 if (write_total > count)
1141 * Set obsolete flag at offset - NOR flash only
1143 static int flash_flag_obsolete (int dev, int fd, off_t offset)
1146 struct erase_info_user erase;
1148 erase.start = DEVOFFSET (dev);
1149 erase.length = DEVESIZE (dev);
1150 /* This relies on the fact, that obsolete_flag == 0 */
1151 rc = lseek (fd, offset, SEEK_SET);
1153 fprintf (stderr, "Cannot seek to set the flag on %s \n",
1157 ioctl (fd, MEMUNLOCK, &erase);
1158 rc = write (fd, &obsolete_flag, sizeof (obsolete_flag));
1159 ioctl (fd, MEMLOCK, &erase);
1161 perror ("Could not set obsolete flag");
1166 static int flash_write (int fd_current, int fd_target, int dev_target)
1170 switch (environment.flag_scheme) {
1173 case FLAG_INCREMENTAL:
1174 (*environment.flags)++;
1177 *environment.flags = active_flag;
1180 fprintf (stderr, "Unimplemented flash scheme %u \n",
1181 environment.flag_scheme);
1186 fprintf(stderr, "Writing new environment at 0x%llx on %s\n",
1187 DEVOFFSET (dev_target), DEVNAME (dev_target));
1190 if (IS_UBI(dev_target)) {
1191 if (ubi_update_start(fd_target, CUR_ENVSIZE) < 0)
1193 return ubi_write(fd_target, environment.image, CUR_ENVSIZE);
1196 rc = flash_write_buf(dev_target, fd_target, environment.image,
1201 if (environment.flag_scheme == FLAG_BOOLEAN) {
1202 /* Have to set obsolete flag */
1203 off_t offset = DEVOFFSET (dev_current) +
1204 offsetof (struct env_image_redundant, flags);
1207 "Setting obsolete flag in environment at 0x%llx on %s\n",
1208 DEVOFFSET (dev_current), DEVNAME (dev_current));
1210 flash_flag_obsolete (dev_current, fd_current, offset);
1216 static int flash_read (int fd)
1220 if (IS_UBI(dev_current)) {
1221 DEVTYPE(dev_current) = MTD_ABSENT;
1223 return ubi_read(fd, environment.image, CUR_ENVSIZE);
1226 rc = flash_read_buf(dev_current, fd, environment.image, CUR_ENVSIZE,
1227 DEVOFFSET(dev_current));
1228 if (rc != CUR_ENVSIZE)
1234 static int flash_io (int mode)
1236 int fd_current, fd_target, rc, dev_target;
1238 /* dev_current: fd_current, erase_current */
1239 fd_current = open (DEVNAME (dev_current), mode);
1240 if (fd_current < 0) {
1242 "Can't open %s: %s\n",
1243 DEVNAME (dev_current), strerror (errno));
1247 if (mode == O_RDWR) {
1248 if (HaveRedundEnv) {
1249 /* switch to next partition for writing */
1250 dev_target = !dev_current;
1251 /* dev_target: fd_target, erase_target */
1252 fd_target = open (DEVNAME (dev_target), mode);
1253 if (fd_target < 0) {
1255 "Can't open %s: %s\n",
1256 DEVNAME (dev_target),
1262 dev_target = dev_current;
1263 fd_target = fd_current;
1266 rc = flash_write (fd_current, fd_target, dev_target);
1268 if (fsync(fd_current) &&
1269 !(errno == EINVAL || errno == EROFS)) {
1271 "fsync failed on %s: %s\n",
1272 DEVNAME (dev_current), strerror (errno));
1275 if (HaveRedundEnv) {
1276 if (fsync(fd_target) &&
1277 !(errno == EINVAL || errno == EROFS)) {
1279 "fsync failed on %s: %s\n",
1280 DEVNAME (dev_current), strerror (errno));
1283 if (close (fd_target)) {
1285 "I/O error on %s: %s\n",
1286 DEVNAME (dev_target),
1292 rc = flash_read (fd_current);
1296 if (close (fd_current)) {
1298 "I/O error on %s: %s\n",
1299 DEVNAME (dev_current), strerror (errno));
1307 * Prevent confusion if running from erased flash memory
1309 int fw_env_open(struct env_opts *opts)
1312 unsigned char flag0;
1316 unsigned char flag1;
1321 struct env_image_single *single;
1322 struct env_image_redundant *redundant;
1325 opts = &default_opts;
1327 if (parse_config(opts)) /* should fill envdevices */
1330 addr0 = calloc(1, CUR_ENVSIZE);
1331 if (addr0 == NULL) {
1333 "Not enough memory for environment (%ld bytes)\n",
1339 /* read environment from FLASH to local buffer */
1340 environment.image = addr0;
1342 if (HaveRedundEnv) {
1344 environment.crc = &redundant->crc;
1345 environment.flags = &redundant->flags;
1346 environment.data = redundant->data;
1349 environment.crc = &single->crc;
1350 environment.flags = NULL;
1351 environment.data = single->data;
1355 if (flash_io(O_RDONLY)) {
1360 crc0 = crc32 (0, (uint8_t *) environment.data, ENV_SIZE);
1362 crc0_ok = (crc0 == *environment.crc);
1363 if (!HaveRedundEnv) {
1366 "Warning: Bad CRC, using default environment\n");
1367 memcpy(environment.data, default_environment, sizeof default_environment);
1370 flag0 = *environment.flags;
1373 addr1 = calloc(1, CUR_ENVSIZE);
1374 if (addr1 == NULL) {
1376 "Not enough memory for environment (%ld bytes)\n",
1384 * have to set environment.image for flash_read(), careful -
1385 * other pointers in environment still point inside addr0
1387 environment.image = addr1;
1388 if (flash_io(O_RDONLY)) {
1393 /* Check flag scheme compatibility */
1394 if (DEVTYPE(dev_current) == MTD_NORFLASH &&
1395 DEVTYPE(!dev_current) == MTD_NORFLASH) {
1396 environment.flag_scheme = FLAG_BOOLEAN;
1397 } else if (DEVTYPE(dev_current) == MTD_NANDFLASH &&
1398 DEVTYPE(!dev_current) == MTD_NANDFLASH) {
1399 environment.flag_scheme = FLAG_INCREMENTAL;
1400 } else if (DEVTYPE(dev_current) == MTD_DATAFLASH &&
1401 DEVTYPE(!dev_current) == MTD_DATAFLASH) {
1402 environment.flag_scheme = FLAG_BOOLEAN;
1403 } else if (DEVTYPE(dev_current) == MTD_UBIVOLUME &&
1404 DEVTYPE(!dev_current) == MTD_UBIVOLUME) {
1405 environment.flag_scheme = FLAG_INCREMENTAL;
1406 } else if (DEVTYPE(dev_current) == MTD_ABSENT &&
1407 DEVTYPE(!dev_current) == MTD_ABSENT &&
1408 IS_UBI(dev_current) == IS_UBI(!dev_current)) {
1409 environment.flag_scheme = FLAG_INCREMENTAL;
1411 fprintf (stderr, "Incompatible flash types!\n");
1416 crc1 = crc32 (0, (uint8_t *) redundant->data, ENV_SIZE);
1418 crc1_ok = (crc1 == redundant->crc);
1419 flag1 = redundant->flags;
1421 if (crc0_ok && !crc1_ok) {
1423 } else if (!crc0_ok && crc1_ok) {
1425 } else if (!crc0_ok && !crc1_ok) {
1427 "Warning: Bad CRC, using default environment\n");
1428 memcpy (environment.data, default_environment,
1429 sizeof default_environment);
1432 switch (environment.flag_scheme) {
1434 if (flag0 == active_flag &&
1435 flag1 == obsolete_flag) {
1437 } else if (flag0 == obsolete_flag &&
1438 flag1 == active_flag) {
1440 } else if (flag0 == flag1) {
1442 } else if (flag0 == 0xFF) {
1444 } else if (flag1 == 0xFF) {
1450 case FLAG_INCREMENTAL:
1451 if (flag0 == 255 && flag1 == 0)
1453 else if ((flag1 == 255 && flag0 == 0) ||
1456 else /* flag1 > flag0 */
1460 fprintf (stderr, "Unknown flag scheme %u \n",
1461 environment.flag_scheme);
1467 * If we are reading, we don't need the flag and the CRC any
1468 * more, if we are writing, we will re-calculate CRC and update
1469 * flags before writing out
1472 environment.image = addr1;
1473 environment.crc = &redundant->crc;
1474 environment.flags = &redundant->flags;
1475 environment.data = redundant->data;
1478 environment.image = addr0;
1479 /* Other pointers are already set */
1483 fprintf(stderr, "Selected env in %s\n", DEVNAME(dev_current));
1499 * Simply free allocated buffer with environment
1501 int fw_env_close(struct env_opts *opts)
1503 if (environment.image)
1504 free(environment.image);
1506 environment.image = NULL;
1511 static int check_device_config(int dev)
1517 /* Fills in IS_UBI(), converts DEVNAME() with ubi volume name */
1520 fd = open(DEVNAME(dev), O_RDONLY);
1523 "Cannot open %s: %s\n",
1524 DEVNAME(dev), strerror(errno));
1528 rc = fstat(fd, &st);
1530 fprintf(stderr, "Cannot stat the file %s\n",
1536 rc = ioctl(fd, UBI_IOCEBISMAP, &lnum);
1538 fprintf(stderr, "Cannot get UBI information for %s\n",
1542 } else if (S_ISCHR(st.st_mode)) {
1543 struct mtd_info_user mtdinfo;
1544 rc = ioctl(fd, MEMGETINFO, &mtdinfo);
1546 fprintf(stderr, "Cannot get MTD information for %s\n",
1550 if (mtdinfo.type != MTD_NORFLASH &&
1551 mtdinfo.type != MTD_NANDFLASH &&
1552 mtdinfo.type != MTD_DATAFLASH &&
1553 mtdinfo.type != MTD_UBIVOLUME) {
1554 fprintf(stderr, "Unsupported flash type %u on %s\n",
1555 mtdinfo.type, DEVNAME(dev));
1558 DEVTYPE(dev) = mtdinfo.type;
1559 if (DEVESIZE(dev) == 0)
1560 /* Assume the erase size is the same as the env-size */
1561 DEVESIZE(dev) = ENVSIZE(dev);
1564 DEVTYPE(dev) = MTD_ABSENT;
1565 if (DEVESIZE(dev) == 0)
1566 /* Assume the erase size to be 512 bytes */
1567 DEVESIZE(dev) = 0x200;
1570 * Check for negative offsets, treat it as backwards offset
1571 * from the end of the block device
1573 if (DEVOFFSET(dev) < 0) {
1574 rc = ioctl(fd, BLKGETSIZE64, &size);
1576 fprintf(stderr, "Could not get block device size on %s\n",
1581 DEVOFFSET(dev) = DEVOFFSET(dev) + size;
1583 fprintf(stderr, "Calculated device offset 0x%llx on %s\n",
1584 DEVOFFSET(dev), DEVNAME(dev));
1589 if (ENVSECTORS(dev) == 0)
1590 /* Assume enough sectors to cover the environment */
1591 ENVSECTORS(dev) = DIV_ROUND_UP(ENVSIZE(dev), DEVESIZE(dev));
1593 if (DEVOFFSET(dev) % DEVESIZE(dev) != 0) {
1594 fprintf(stderr, "Environment does not start on (erase) block boundary\n");
1599 if (ENVSIZE(dev) > ENVSECTORS(dev) * DEVESIZE(dev)) {
1600 fprintf(stderr, "Environment does not fit into available sectors\n");
1610 static int parse_config(struct env_opts *opts)
1615 opts = &default_opts;
1617 #if defined(CONFIG_FILE)
1618 /* Fills in DEVNAME(), ENVSIZE(), DEVESIZE(). Or don't. */
1619 if (get_config(opts->config_file)) {
1620 fprintf(stderr, "Cannot parse config file '%s': %m\n",
1625 DEVNAME (0) = DEVICE1_NAME;
1626 DEVOFFSET (0) = DEVICE1_OFFSET;
1627 ENVSIZE (0) = ENV1_SIZE;
1629 /* Set defaults for DEVESIZE, ENVSECTORS later once we
1632 #ifdef DEVICE1_ESIZE
1633 DEVESIZE (0) = DEVICE1_ESIZE;
1635 #ifdef DEVICE1_ENVSECTORS
1636 ENVSECTORS (0) = DEVICE1_ENVSECTORS;
1640 DEVNAME (1) = DEVICE2_NAME;
1641 DEVOFFSET (1) = DEVICE2_OFFSET;
1642 ENVSIZE (1) = ENV2_SIZE;
1644 /* Set defaults for DEVESIZE, ENVSECTORS later once we
1647 #ifdef DEVICE2_ESIZE
1648 DEVESIZE (1) = DEVICE2_ESIZE;
1650 #ifdef DEVICE2_ENVSECTORS
1651 ENVSECTORS (1) = DEVICE2_ENVSECTORS;
1656 rc = check_device_config(0);
1660 if (HaveRedundEnv) {
1661 rc = check_device_config(1);
1665 if (ENVSIZE(0) != ENVSIZE(1)) {
1667 "Redundant environments have unequal size");
1672 usable_envsize = CUR_ENVSIZE - sizeof(uint32_t);
1674 usable_envsize -= sizeof(char);
1679 #if defined(CONFIG_FILE)
1680 static int get_config (char *fname)
1688 fp = fopen (fname, "r");
1692 while (i < 2 && fgets (dump, sizeof (dump), fp)) {
1693 /* Skip incomplete conversions and comment strings */
1697 rc = sscanf(dump, "%ms %lli %lx %lx %lx",
1707 DEVNAME(i) = devname;
1709 /* Set defaults for DEVESIZE, ENVSECTORS later once we
1717 HaveRedundEnv = i - 1;
1718 if (!i) { /* No valid entries found */