blob: 74451ecb9457dff6cb850b8c14abf5e1845955ac [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001// SPDX-License-Identifier: GPL-2.0+
wdenk6aff3112002-12-17 01:51:00 +00002/*
Detlev Zundel0aef7bc2010-07-30 11:22:15 +02003 * (C) Copyright 2000-2010
wdenk6aff3112002-12-17 01:51:00 +00004 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
5 *
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02006 * (C) Copyright 2008
7 * Guennadi Liakhovetski, DENX Software Engineering, lg@denx.de.
wdenk6aff3112002-12-17 01:51:00 +00008 */
9
Jörg Krause26e355d2015-04-22 21:36:22 +020010#define _GNU_SOURCE
11
Peter Robinson69bf2d22015-12-09 07:15:33 +000012#include <compiler.h>
Simon Glass9fb625c2019-08-01 09:46:51 -060013#include <env.h>
wdenk6aff3112002-12-17 01:51:00 +000014#include <errno.h>
Joe Hershberger30fd4fad2012-12-11 22:16:32 -060015#include <env_flags.h>
wdenk6aff3112002-12-17 01:51:00 +000016#include <fcntl.h>
Alex Kiernandbc34322018-03-09 12:13:02 +000017#include <libgen.h>
Stefan Agnerf4742ca2016-07-13 17:14:38 -070018#include <linux/fs.h>
Joe Hershberger06134212012-10-12 10:23:37 +000019#include <linux/stringify.h>
Andreas Fenkart10667e12016-03-11 09:39:35 +010020#include <ctype.h>
wdenk6aff3112002-12-17 01:51:00 +000021#include <stdio.h>
22#include <stdlib.h>
23#include <stddef.h>
24#include <string.h>
25#include <sys/types.h>
26#include <sys/ioctl.h>
27#include <sys/stat.h>
Simon Glass3db71102019-11-14 12:57:16 -070028#include <u-boot/crc.h>
wdenk6aff3112002-12-17 01:51:00 +000029#include <unistd.h>
S. Lockwood-Childs34255b92017-11-14 23:01:26 -080030#include <dirent.h>
wdenk6aff3112002-12-17 01:51:00 +000031
Markus Klotzbücher6de66b32007-11-27 10:23:20 +010032#ifdef MTD_OLD
Wolfgang Denk1711f3b2008-09-02 21:17:36 +020033# include <stdint.h>
Markus Klotzbücher6de66b32007-11-27 10:23:20 +010034# include <linux/mtd/mtd.h>
35#else
Wolfgang Denkc83d7ca2008-01-08 22:58:27 +010036# define __user /* nothing */
Markus Klotzbücher6de66b32007-11-27 10:23:20 +010037# include <mtd/mtd-user.h>
38#endif
39
S. Lockwood-Childs34255b92017-11-14 23:01:26 -080040#include <mtd/ubi-user.h>
41
Stefano Babic9d80b492017-04-05 18:08:01 +020042#include "fw_env_private.h"
Markus Klotzbücher6de66b32007-11-27 10:23:20 +010043#include "fw_env.h"
wdenk6aff3112002-12-17 01:51:00 +000044
Andreas Fenkart14070e62016-05-31 09:21:56 +020045struct env_opts default_opts = {
46#ifdef CONFIG_FILE
47 .config_file = CONFIG_FILE
48#endif
49};
50
Marek Vasuta8a752c2014-03-05 19:59:52 +010051#define DIV_ROUND_UP(n, d) (((n) + (d) - 1) / (d))
52
Guennadi Liakhovetski56086922008-09-04 13:01:49 +020053#define min(x, y) ({ \
54 typeof(x) _min1 = (x); \
55 typeof(y) _min2 = (y); \
56 (void) (&_min1 == &_min2); \
57 _min1 < _min2 ? _min1 : _min2; })
58
59struct envdev_s {
Tom Rini229695f2014-03-28 12:03:33 -040060 const char *devname; /* Device name */
Stefan Agnerf4742ca2016-07-13 17:14:38 -070061 long long devoff; /* Device offset */
wdenk4a6fd342003-04-12 23:38:12 +000062 ulong env_size; /* environment size */
63 ulong erase_size; /* device erase size */
Guennadi Liakhovetski56086922008-09-04 13:01:49 +020064 ulong env_sectors; /* number of environment sectors */
65 uint8_t mtd_type; /* type of the MTD device */
S. Lockwood-Childs34255b92017-11-14 23:01:26 -080066 int is_ubi; /* set if we use UBI volume */
Guennadi Liakhovetski56086922008-09-04 13:01:49 +020067};
wdenk6aff3112002-12-17 01:51:00 +000068
Alex Kiernanc7f52c42018-03-09 12:12:59 +000069static struct envdev_s envdevices[2] = {
Guennadi Liakhovetski56086922008-09-04 13:01:49 +020070 {
71 .mtd_type = MTD_ABSENT,
72 }, {
73 .mtd_type = MTD_ABSENT,
74 },
75};
Alex Kiernanc7f52c42018-03-09 12:12:59 +000076
Guennadi Liakhovetski56086922008-09-04 13:01:49 +020077static int dev_current;
wdenk6aff3112002-12-17 01:51:00 +000078
79#define DEVNAME(i) envdevices[(i)].devname
wdenkd0fb80c2003-01-11 09:48:40 +000080#define DEVOFFSET(i) envdevices[(i)].devoff
wdenk6aff3112002-12-17 01:51:00 +000081#define ENVSIZE(i) envdevices[(i)].env_size
82#define DEVESIZE(i) envdevices[(i)].erase_size
Guennadi Liakhovetski56086922008-09-04 13:01:49 +020083#define ENVSECTORS(i) envdevices[(i)].env_sectors
84#define DEVTYPE(i) envdevices[(i)].mtd_type
S. Lockwood-Childs34255b92017-11-14 23:01:26 -080085#define IS_UBI(i) envdevices[(i)].is_ubi
wdenk6aff3112002-12-17 01:51:00 +000086
Joe Hershberger497f2052012-10-03 09:38:46 +000087#define CUR_ENVSIZE ENVSIZE(dev_current)
wdenk6aff3112002-12-17 01:51:00 +000088
Andreas Fenkartf71cee42016-04-19 22:43:42 +020089static unsigned long usable_envsize;
90#define ENV_SIZE usable_envsize
wdenk6aff3112002-12-17 01:51:00 +000091
Guennadi Liakhovetski56086922008-09-04 13:01:49 +020092struct env_image_single {
Alex Kiernanc7f52c42018-03-09 12:12:59 +000093 uint32_t crc; /* CRC32 over data bytes */
94 char data[];
Guennadi Liakhovetski56086922008-09-04 13:01:49 +020095};
wdenk6aff3112002-12-17 01:51:00 +000096
Guennadi Liakhovetski56086922008-09-04 13:01:49 +020097struct env_image_redundant {
Alex Kiernanc7f52c42018-03-09 12:12:59 +000098 uint32_t crc; /* CRC32 over data bytes */
99 unsigned char flags; /* active or obsolete */
100 char data[];
Guennadi Liakhovetski56086922008-09-04 13:01:49 +0200101};
102
103enum flag_scheme {
104 FLAG_NONE,
105 FLAG_BOOLEAN,
106 FLAG_INCREMENTAL,
107};
108
109struct environment {
Alex Kiernanc7f52c42018-03-09 12:12:59 +0000110 void *image;
111 uint32_t *crc;
112 unsigned char *flags;
113 char *data;
114 enum flag_scheme flag_scheme;
Rasmus Villemoesc62e6142018-09-27 22:45:26 +0200115 int dirty;
Guennadi Liakhovetski56086922008-09-04 13:01:49 +0200116};
117
118static struct environment environment = {
119 .flag_scheme = FLAG_NONE,
120};
wdenk6aff3112002-12-17 01:51:00 +0000121
Alex Kiernan2deb3ca2018-03-09 12:13:00 +0000122static int have_redund_env;
wdenkd0fb80c2003-01-11 09:48:40 +0000123
Joe Hershbergerddd84182012-10-12 08:48:51 +0000124#define DEFAULT_ENV_INSTANCE_STATIC
125#include <env_default.h>
wdenk6aff3112002-12-17 01:51:00 +0000126
S. Lockwood-Childs34255b92017-11-14 23:01:26 -0800127#define UBI_DEV_START "/dev/ubi"
128#define UBI_SYSFS "/sys/class/ubi"
129#define UBI_VOL_NAME_PATT "ubi%d_%d"
130
131static int is_ubi_devname(const char *devname)
132{
133 return !strncmp(devname, UBI_DEV_START, sizeof(UBI_DEV_START) - 1);
134}
135
136static int ubi_check_volume_sysfs_name(const char *volume_sysfs_name,
137 const char *volname)
138{
139 char path[256];
140 FILE *file;
141 char *name;
142 int ret;
143
144 strcpy(path, UBI_SYSFS "/");
145 strcat(path, volume_sysfs_name);
146 strcat(path, "/name");
147
148 file = fopen(path, "r");
149 if (!file)
150 return -1;
151
152 ret = fscanf(file, "%ms", &name);
153 fclose(file);
154 if (ret <= 0 || !name) {
155 fprintf(stderr,
156 "Failed to read from file %s, ret = %d, name = %s\n",
157 path, ret, name);
158 return -1;
159 }
160
161 if (!strcmp(name, volname)) {
162 free(name);
163 return 0;
164 }
165 free(name);
166
167 return -1;
168}
169
170static int ubi_get_volnum_by_name(int devnum, const char *volname)
171{
172 DIR *sysfs_ubi;
173 struct dirent *dirent;
174 int ret;
175 int tmp_devnum;
176 int volnum;
177
178 sysfs_ubi = opendir(UBI_SYSFS);
179 if (!sysfs_ubi)
180 return -1;
181
182#ifdef DEBUG
183 fprintf(stderr, "Looking for volume name \"%s\"\n", volname);
184#endif
185
186 while (1) {
187 dirent = readdir(sysfs_ubi);
188 if (!dirent)
189 return -1;
190
191 ret = sscanf(dirent->d_name, UBI_VOL_NAME_PATT,
192 &tmp_devnum, &volnum);
193 if (ret == 2 && devnum == tmp_devnum) {
194 if (ubi_check_volume_sysfs_name(dirent->d_name,
Miaoqian Lin316590d2022-09-19 08:28:09 +0400195 volname) == 0) {
196 closedir(sysfs_ubi);
S. Lockwood-Childs34255b92017-11-14 23:01:26 -0800197 return volnum;
Miaoqian Lin316590d2022-09-19 08:28:09 +0400198 }
S. Lockwood-Childs34255b92017-11-14 23:01:26 -0800199 }
200 }
Miaoqian Lin316590d2022-09-19 08:28:09 +0400201 closedir(sysfs_ubi);
S. Lockwood-Childs34255b92017-11-14 23:01:26 -0800202
203 return -1;
204}
205
206static int ubi_get_devnum_by_devname(const char *devname)
207{
208 int devnum;
209 int ret;
210
211 ret = sscanf(devname + sizeof(UBI_DEV_START) - 1, "%d", &devnum);
212 if (ret != 1)
213 return -1;
214
215 return devnum;
216}
217
218static const char *ubi_get_volume_devname(const char *devname,
219 const char *volname)
220{
221 char *volume_devname;
222 int volnum;
223 int devnum;
224 int ret;
225
226 devnum = ubi_get_devnum_by_devname(devname);
227 if (devnum < 0)
228 return NULL;
229
230 volnum = ubi_get_volnum_by_name(devnum, volname);
231 if (volnum < 0)
232 return NULL;
233
234 ret = asprintf(&volume_devname, "%s_%d", devname, volnum);
235 if (ret < 0)
236 return NULL;
237
238#ifdef DEBUG
239 fprintf(stderr, "Found ubi volume \"%s:%s\" -> %s\n",
240 devname, volname, volume_devname);
241#endif
242
243 return volume_devname;
244}
245
246static void ubi_check_dev(unsigned int dev_id)
247{
248 char *devname = (char *)DEVNAME(dev_id);
249 char *pname;
250 const char *volname = NULL;
251 const char *volume_devname;
252
253 if (!is_ubi_devname(DEVNAME(dev_id)))
254 return;
255
256 IS_UBI(dev_id) = 1;
257
258 for (pname = devname; *pname != '\0'; pname++) {
259 if (*pname == ':') {
260 *pname = '\0';
261 volname = pname + 1;
262 break;
263 }
264 }
265
266 if (volname) {
267 /* Let's find real volume device name */
268 volume_devname = ubi_get_volume_devname(devname, volname);
269 if (!volume_devname) {
270 fprintf(stderr, "Didn't found ubi volume \"%s\"\n",
271 volname);
272 return;
273 }
274
275 free(devname);
276 DEVNAME(dev_id) = volume_devname;
277 }
278}
279
280static int ubi_update_start(int fd, int64_t bytes)
281{
282 if (ioctl(fd, UBI_IOCVOLUP, &bytes))
283 return -1;
284 return 0;
285}
286
287static int ubi_read(int fd, void *buf, size_t count)
288{
289 ssize_t ret;
290
291 while (count > 0) {
292 ret = read(fd, buf, count);
293 if (ret > 0) {
294 count -= ret;
295 buf += ret;
296
297 continue;
298 }
299
300 if (ret == 0) {
301 /*
302 * Happens in case of too short volume data size. If we
303 * return error status we will fail it will be treated
304 * as UBI device error.
305 *
306 * Leave catching this error to CRC check.
307 */
308 fprintf(stderr, "Warning: end of data on ubi volume\n");
309 return 0;
310 } else if (errno == EBADF) {
311 /*
312 * Happens in case of corrupted volume. The same as
313 * above, we cannot return error now, as we will still
314 * be able to successfully write environment later.
315 */
316 fprintf(stderr, "Warning: corrupted volume?\n");
317 return 0;
318 } else if (errno == EINTR) {
319 continue;
320 }
321
322 fprintf(stderr, "Cannot read %u bytes from ubi volume, %s\n",
323 (unsigned int)count, strerror(errno));
324 return -1;
325 }
326
327 return 0;
328}
329
330static int ubi_write(int fd, const void *buf, size_t count)
331{
332 ssize_t ret;
333
334 while (count > 0) {
335 ret = write(fd, buf, count);
336 if (ret <= 0) {
337 if (ret < 0 && errno == EINTR)
338 continue;
339
340 fprintf(stderr, "Cannot write %u bytes to ubi volume\n",
341 (unsigned int)count);
342 return -1;
343 }
344
345 count -= ret;
346 buf += ret;
347 }
348
349 return 0;
350}
351
Rafał Miłeckif178f7c2022-01-12 12:47:05 +0100352static int flash_io(int mode, void *buf, size_t count);
Andreas Fenkart81974f42016-04-05 23:13:42 +0200353static int parse_config(struct env_opts *opts);
wdenk4a6fd342003-04-12 23:38:12 +0000354
wdenkd0fb80c2003-01-11 09:48:40 +0000355#if defined(CONFIG_FILE)
Alex Kiernanc7f52c42018-03-09 12:12:59 +0000356static int get_config(char *);
wdenkd0fb80c2003-01-11 09:48:40 +0000357#endif
wdenk6aff3112002-12-17 01:51:00 +0000358
Andreas Fenkart938c29f2016-03-11 09:39:37 +0100359static char *skip_chars(char *s)
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200360{
Andreas Fenkart938c29f2016-03-11 09:39:37 +0100361 for (; *s != '\0'; s++) {
Stefan Agnercd655512018-03-01 14:06:32 +0100362 if (isblank(*s) || *s == '=')
Andreas Fenkart938c29f2016-03-11 09:39:37 +0100363 return s;
364 }
365 return NULL;
366}
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200367
Andreas Fenkart938c29f2016-03-11 09:39:37 +0100368static char *skip_blanks(char *s)
369{
370 for (; *s != '\0'; s++) {
371 if (!isblank(*s))
Andreas Fenkart9583efc2016-03-11 09:39:36 +0100372 return s;
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200373 }
Andreas Fenkart9583efc2016-03-11 09:39:36 +0100374 return NULL;
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200375}
376
wdenk6aff3112002-12-17 01:51:00 +0000377/*
Andreas Fenkart1b7427c2016-07-16 17:06:14 +0200378 * s1 is either a simple 'name', or a 'name=value' pair.
379 * s2 is a 'name=value' pair.
380 * If the names match, return the value of s2, else NULL.
381 */
382static char *envmatch(char *s1, char *s2)
383{
384 if (s1 == NULL || s2 == NULL)
385 return NULL;
386
387 while (*s1 == *s2++)
388 if (*s1++ == '=')
389 return s2;
390 if (*s1 == '\0' && *(s2 - 1) == '=')
391 return s2;
392 return NULL;
393}
394
395/**
wdenk6aff3112002-12-17 01:51:00 +0000396 * Search the environment for a variable.
397 * Return the value, if found, or NULL, if not found.
398 */
Alex Kiernanc7f52c42018-03-09 12:12:59 +0000399char *fw_getenv(char *name)
wdenk6aff3112002-12-17 01:51:00 +0000400{
Markus Klotzbücher6de66b32007-11-27 10:23:20 +0100401 char *env, *nxt;
wdenk6aff3112002-12-17 01:51:00 +0000402
wdenk4a6fd342003-04-12 23:38:12 +0000403 for (env = environment.data; *env; env = nxt + 1) {
Markus Klotzbücher6de66b32007-11-27 10:23:20 +0100404 char *val;
wdenk6aff3112002-12-17 01:51:00 +0000405
wdenk4a6fd342003-04-12 23:38:12 +0000406 for (nxt = env; *nxt; ++nxt) {
wdenk6aff3112002-12-17 01:51:00 +0000407 if (nxt >= &environment.data[ENV_SIZE]) {
Alex Kiernanc7f52c42018-03-09 12:12:59 +0000408 fprintf(stderr, "## Error: "
wdenk6aff3112002-12-17 01:51:00 +0000409 "environment not terminated\n");
Guennadi Liakhovetski56086922008-09-04 13:01:49 +0200410 return NULL;
wdenk6aff3112002-12-17 01:51:00 +0000411 }
412 }
Alex Kiernanc7f52c42018-03-09 12:12:59 +0000413 val = envmatch(name, env);
wdenk6aff3112002-12-17 01:51:00 +0000414 if (!val)
415 continue;
Guennadi Liakhovetski56086922008-09-04 13:01:49 +0200416 return val;
wdenk6aff3112002-12-17 01:51:00 +0000417 }
Guennadi Liakhovetski56086922008-09-04 13:01:49 +0200418 return NULL;
wdenk6aff3112002-12-17 01:51:00 +0000419}
420
421/*
Joe Hershberger267541f2012-12-11 22:16:34 -0600422 * Search the default environment for a variable.
423 * Return the value, if found, or NULL, if not found.
424 */
425char *fw_getdefenv(char *name)
426{
427 char *env, *nxt;
428
429 for (env = default_environment; *env; env = nxt + 1) {
430 char *val;
431
432 for (nxt = env; *nxt; ++nxt) {
433 if (nxt >= &default_environment[ENV_SIZE]) {
434 fprintf(stderr, "## Error: "
435 "default environment not terminated\n");
436 return NULL;
437 }
438 }
439 val = envmatch(name, env);
440 if (!val)
441 continue;
442 return val;
443 }
444 return NULL;
445}
446
447/*
wdenk6aff3112002-12-17 01:51:00 +0000448 * Print the current definition of one, or more, or all
449 * environment variables
450 */
Andreas Fenkart81974f42016-04-05 23:13:42 +0200451int fw_printenv(int argc, char *argv[], int value_only, struct env_opts *opts)
wdenk6aff3112002-12-17 01:51:00 +0000452{
Andreas Fenkart371ee132015-12-09 13:13:24 +0100453 int i, rc = 0;
wdenk6aff3112002-12-17 01:51:00 +0000454
Andreas Fenkartc5c41c42016-07-16 17:06:15 +0200455 if (value_only && argc != 1) {
456 fprintf(stderr,
Alex Kiernand877a6c2018-02-11 17:16:46 +0000457 "## Error: `-n'/`--noheader' option requires exactly one argument\n");
Andreas Fenkartc5c41c42016-07-16 17:06:15 +0200458 return -1;
459 }
460
Andreas Fenkart14070e62016-05-31 09:21:56 +0200461 if (!opts)
462 opts = &default_opts;
463
Andreas Fenkart81974f42016-04-05 23:13:42 +0200464 if (fw_env_open(opts))
Guennadi Liakhovetski56086922008-09-04 13:01:49 +0200465 return -1;
wdenk6aff3112002-12-17 01:51:00 +0000466
Alex Kiernanc7f52c42018-03-09 12:12:59 +0000467 if (argc == 0) { /* Print all env variables */
Andreas Fenkartc5c41c42016-07-16 17:06:15 +0200468 char *env, *nxt;
wdenk4a6fd342003-04-12 23:38:12 +0000469 for (env = environment.data; *env; env = nxt + 1) {
470 for (nxt = env; *nxt; ++nxt) {
wdenk6aff3112002-12-17 01:51:00 +0000471 if (nxt >= &environment.data[ENV_SIZE]) {
Alex Kiernanc7f52c42018-03-09 12:12:59 +0000472 fprintf(stderr, "## Error: "
wdenk6aff3112002-12-17 01:51:00 +0000473 "environment not terminated\n");
Guennadi Liakhovetski56086922008-09-04 13:01:49 +0200474 return -1;
wdenk6aff3112002-12-17 01:51:00 +0000475 }
476 }
477
Alex Kiernanc7f52c42018-03-09 12:12:59 +0000478 printf("%s\n", env);
wdenk6aff3112002-12-17 01:51:00 +0000479 }
Stefano Babic33f00862017-04-05 18:08:03 +0200480 fw_env_close(opts);
Guennadi Liakhovetski56086922008-09-04 13:01:49 +0200481 return 0;
wdenk6aff3112002-12-17 01:51:00 +0000482 }
483
Andreas Fenkartc5c41c42016-07-16 17:06:15 +0200484 for (i = 0; i < argc; ++i) { /* print a subset of env variables */
Markus Klotzbücher6de66b32007-11-27 10:23:20 +0100485 char *name = argv[i];
486 char *val = NULL;
wdenk6aff3112002-12-17 01:51:00 +0000487
Andreas Fenkartc5c41c42016-07-16 17:06:15 +0200488 val = fw_getenv(name);
Grant Ericksonbc117562008-05-06 20:16:15 -0700489 if (!val) {
Alex Kiernanc7f52c42018-03-09 12:12:59 +0000490 fprintf(stderr, "## Error: \"%s\" not defined\n", name);
Grant Ericksonbc117562008-05-06 20:16:15 -0700491 rc = -1;
Andreas Fenkartc5c41c42016-07-16 17:06:15 +0200492 continue;
Grant Ericksonbc117562008-05-06 20:16:15 -0700493 }
Andreas Fenkartc5c41c42016-07-16 17:06:15 +0200494
495 if (value_only) {
496 puts(val);
497 break;
498 }
499
500 printf("%s=%s\n", name, val);
wdenk6aff3112002-12-17 01:51:00 +0000501 }
Grant Ericksonbc117562008-05-06 20:16:15 -0700502
Stefano Babic33f00862017-04-05 18:08:03 +0200503 fw_env_close(opts);
504
Guennadi Liakhovetski56086922008-09-04 13:01:49 +0200505 return rc;
wdenk6aff3112002-12-17 01:51:00 +0000506}
507
Stefano Babic33f00862017-04-05 18:08:03 +0200508int fw_env_flush(struct env_opts *opts)
wdenk6aff3112002-12-17 01:51:00 +0000509{
Andreas Fenkart14070e62016-05-31 09:21:56 +0200510 if (!opts)
511 opts = &default_opts;
512
Rasmus Villemoesc62e6142018-09-27 22:45:26 +0200513 if (!environment.dirty)
514 return 0;
515
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200516 /*
517 * Update CRC
518 */
519 *environment.crc = crc32(0, (uint8_t *) environment.data, ENV_SIZE);
wdenk6aff3112002-12-17 01:51:00 +0000520
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200521 /* write environment back to flash */
Rafał Miłeckif178f7c2022-01-12 12:47:05 +0100522 if (flash_io(O_RDWR, environment.image, CUR_ENVSIZE)) {
Alex Kiernanc7f52c42018-03-09 12:12:59 +0000523 fprintf(stderr, "Error: can't write fw_env to flash\n");
524 return -1;
wdenk6aff3112002-12-17 01:51:00 +0000525 }
526
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200527 return 0;
528}
wdenk6aff3112002-12-17 01:51:00 +0000529
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200530/*
531 * Set/Clear a single variable in the environment.
532 * This is called in sequence to update the environment
533 * in RAM without updating the copy in flash after each set
534 */
535int fw_env_write(char *name, char *value)
536{
537 int len;
538 char *env, *nxt;
539 char *oldval = NULL;
Joe Hershberger267541f2012-12-11 22:16:34 -0600540 int deleting, creating, overwriting;
wdenk6aff3112002-12-17 01:51:00 +0000541
542 /*
543 * search if variable with this name already exists
544 */
wdenk4a6fd342003-04-12 23:38:12 +0000545 for (nxt = env = environment.data; *env; env = nxt + 1) {
546 for (nxt = env; *nxt; ++nxt) {
wdenk6aff3112002-12-17 01:51:00 +0000547 if (nxt >= &environment.data[ENV_SIZE]) {
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200548 fprintf(stderr, "## Error: "
wdenk6aff3112002-12-17 01:51:00 +0000549 "environment not terminated\n");
Guennadi Liakhovetski56086922008-09-04 13:01:49 +0200550 errno = EINVAL;
551 return -1;
wdenk6aff3112002-12-17 01:51:00 +0000552 }
553 }
Alex Kiernanc7f52c42018-03-09 12:12:59 +0000554 oldval = envmatch(name, env);
555 if (oldval)
wdenk6aff3112002-12-17 01:51:00 +0000556 break;
557 }
558
Joe Hershberger267541f2012-12-11 22:16:34 -0600559 deleting = (oldval && !(value && strlen(value)));
560 creating = (!oldval && (value && strlen(value)));
Rasmus Villemoesc62e6142018-09-27 22:45:26 +0200561 overwriting = (oldval && (value && strlen(value) &&
562 strcmp(oldval, value)));
Joe Hershberger267541f2012-12-11 22:16:34 -0600563
564 /* check for permission */
565 if (deleting) {
566 if (env_flags_validate_varaccess(name,
567 ENV_FLAGS_VARACCESS_PREVENT_DELETE)) {
568 printf("Can't delete \"%s\"\n", name);
569 errno = EROFS;
570 return -1;
571 }
572 } else if (overwriting) {
573 if (env_flags_validate_varaccess(name,
574 ENV_FLAGS_VARACCESS_PREVENT_OVERWR)) {
575 printf("Can't overwrite \"%s\"\n", name);
576 errno = EROFS;
577 return -1;
578 } else if (env_flags_validate_varaccess(name,
Alex Kiernanc7f52c42018-03-09 12:12:59 +0000579 ENV_FLAGS_VARACCESS_PREVENT_NONDEF_OVERWR)) {
Joe Hershberger267541f2012-12-11 22:16:34 -0600580 const char *defval = fw_getdefenv(name);
581
582 if (defval == NULL)
583 defval = "";
584 if (strcmp(oldval, defval)
585 != 0) {
586 printf("Can't overwrite \"%s\"\n", name);
587 errno = EROFS;
588 return -1;
589 }
590 }
591 } else if (creating) {
592 if (env_flags_validate_varaccess(name,
593 ENV_FLAGS_VARACCESS_PREVENT_CREATE)) {
594 printf("Can't create \"%s\"\n", name);
595 errno = EROFS;
596 return -1;
597 }
598 } else
599 /* Nothing to do */
600 return 0;
601
Rasmus Villemoesc62e6142018-09-27 22:45:26 +0200602 environment.dirty = 1;
Joe Hershberger267541f2012-12-11 22:16:34 -0600603 if (deleting || overwriting) {
wdenk6aff3112002-12-17 01:51:00 +0000604 if (*++nxt == '\0') {
605 *env = '\0';
606 } else {
607 for (;;) {
608 *env = *nxt++;
609 if ((*env == '\0') && (*nxt == '\0'))
610 break;
611 ++env;
612 }
613 }
614 *++env = '\0';
615 }
616
617 /* Delete only ? */
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200618 if (!value || !strlen(value))
619 return 0;
wdenk6aff3112002-12-17 01:51:00 +0000620
621 /*
622 * Append new definition at the end
623 */
Alex Kiernanc7f52c42018-03-09 12:12:59 +0000624 for (env = environment.data; *env || *(env + 1); ++env)
625 ;
wdenk6aff3112002-12-17 01:51:00 +0000626 if (env > environment.data)
627 ++env;
628 /*
629 * Overflow when:
Joe Hershberger497f2052012-10-03 09:38:46 +0000630 * "name" + "=" + "val" +"\0\0" > CUR_ENVSIZE - (env-environment)
wdenk6aff3112002-12-17 01:51:00 +0000631 */
Alex Kiernanc7f52c42018-03-09 12:12:59 +0000632 len = strlen(name) + 2;
wdenk6aff3112002-12-17 01:51:00 +0000633 /* add '=' for first arg, ' ' for all others */
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200634 len += strlen(value) + 1;
635
wdenk4a6fd342003-04-12 23:38:12 +0000636 if (len > (&environment.data[ENV_SIZE] - env)) {
Alex Kiernanc7f52c42018-03-09 12:12:59 +0000637 fprintf(stderr,
638 "Error: environment overflow, \"%s\" deleted\n", name);
Guennadi Liakhovetski56086922008-09-04 13:01:49 +0200639 return -1;
wdenk6aff3112002-12-17 01:51:00 +0000640 }
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200641
wdenk6aff3112002-12-17 01:51:00 +0000642 while ((*env = *name++) != '\0')
643 env++;
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200644 *env = '=';
645 while ((*++env = *value++) != '\0')
646 ;
wdenk6aff3112002-12-17 01:51:00 +0000647
648 /* end is marked with double '\0' */
649 *++env = '\0';
650
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200651 return 0;
652}
wdenk6aff3112002-12-17 01:51:00 +0000653
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200654/*
655 * Deletes or sets environment variables. Returns -1 and sets errno error codes:
656 * 0 - OK
657 * EINVAL - need at least 1 argument
658 * EROFS - certain variables ("ethaddr", "serial#") cannot be
659 * modified or deleted
660 *
661 */
Simon Glass382bee52017-08-03 12:22:09 -0600662int fw_env_set(int argc, char *argv[], struct env_opts *opts)
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200663{
Andreas Fenkart371ee132015-12-09 13:13:24 +0100664 int i;
Mike Frysinger3779c8e2012-11-10 19:47:45 +0000665 size_t len;
Andreas Fenkart167f5252015-12-09 13:13:21 +0100666 char *name, **valv;
xypron.glpk@gmx.deddc6a9d2017-04-15 13:05:40 +0200667 char *oldval;
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200668 char *value = NULL;
Andreas Fenkart167f5252015-12-09 13:13:21 +0100669 int valc;
Stefano Babic33f00862017-04-05 18:08:03 +0200670 int ret;
wdenk6aff3112002-12-17 01:51:00 +0000671
Andreas Fenkart14070e62016-05-31 09:21:56 +0200672 if (!opts)
673 opts = &default_opts;
674
Andreas Fenkart1ce68692015-12-09 13:13:25 +0100675 if (argc < 1) {
676 fprintf(stderr, "## Error: variable name missing\n");
Marek Vasuta8a752c2014-03-05 19:59:52 +0100677 errno = EINVAL;
678 return -1;
679 }
680
Andreas Fenkart81974f42016-04-05 23:13:42 +0200681 if (fw_env_open(opts)) {
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200682 fprintf(stderr, "Error: environment not initialized\n");
683 return -1;
684 }
685
Andreas Fenkart1ce68692015-12-09 13:13:25 +0100686 name = argv[0];
687 valv = argv + 1;
688 valc = argc - 1;
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200689
Stefano Babic33f00862017-04-05 18:08:03 +0200690 if (env_flags_validate_env_set_params(name, valv, valc) < 0) {
691 fw_env_close(opts);
Andreas Fenkartfd4e3282016-07-16 17:06:13 +0200692 return -1;
Stefano Babic33f00862017-04-05 18:08:03 +0200693 }
Joe Hershberger30fd4fad2012-12-11 22:16:32 -0600694
Joe Hershberger62a34a02012-10-03 09:38:47 +0000695 len = 0;
Andreas Fenkart167f5252015-12-09 13:13:21 +0100696 for (i = 0; i < valc; ++i) {
697 char *val = valv[i];
Joe Hershberger62a34a02012-10-03 09:38:47 +0000698 size_t val_len = strlen(val);
699
Joe Hershbergerce2f5802012-10-15 15:29:24 +0000700 if (value)
701 value[len - 1] = ' ';
xypron.glpk@gmx.deddc6a9d2017-04-15 13:05:40 +0200702 oldval = value;
Joe Hershberger62a34a02012-10-03 09:38:47 +0000703 value = realloc(value, len + val_len + 1);
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200704 if (!value) {
Joe Hershberger62a34a02012-10-03 09:38:47 +0000705 fprintf(stderr,
Luka Perkov8603b692011-09-05 23:40:13 +0200706 "Cannot malloc %zu bytes: %s\n",
Joe Hershberger62a34a02012-10-03 09:38:47 +0000707 len, strerror(errno));
xypron.glpk@gmx.deddc6a9d2017-04-15 13:05:40 +0200708 free(oldval);
Joe Hershberger62a34a02012-10-03 09:38:47 +0000709 return -1;
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200710 }
Joe Hershberger62a34a02012-10-03 09:38:47 +0000711
712 memcpy(value + len, val, val_len);
713 len += val_len;
Joe Hershbergerce2f5802012-10-15 15:29:24 +0000714 value[len++] = '\0';
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200715 }
716
717 fw_env_write(name, value);
718
Joe Hershberger62a34a02012-10-03 09:38:47 +0000719 free(value);
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200720
Stefano Babic33f00862017-04-05 18:08:03 +0200721 ret = fw_env_flush(opts);
722 fw_env_close(opts);
723
724 return ret;
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200725}
726
727/*
728 * Parse a file and configure the u-boot variables.
729 * The script file has a very simple format, as follows:
730 *
731 * Each line has a couple with name, value:
732 * <white spaces>variable_name<white spaces>variable_value
733 *
734 * Both variable_name and variable_value are interpreted as strings.
735 * Any character after <white spaces> and before ending \r\n is interpreted
736 * as variable's value (no comment allowed on these lines !)
737 *
738 * Comments are allowed if the first character in the line is #
739 *
740 * Returns -1 and sets errno error codes:
741 * 0 - OK
742 * -1 - Error
743 */
Andreas Fenkart81974f42016-04-05 23:13:42 +0200744int fw_parse_script(char *fname, struct env_opts *opts)
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200745{
746 FILE *fp;
Alex Kiernan94b233f2018-06-07 12:20:05 +0000747 char *line = NULL;
748 size_t linesize = 0;
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200749 char *name;
750 char *val;
751 int lineno = 0;
752 int len;
753 int ret = 0;
754
Andreas Fenkart14070e62016-05-31 09:21:56 +0200755 if (!opts)
756 opts = &default_opts;
757
Andreas Fenkart81974f42016-04-05 23:13:42 +0200758 if (fw_env_open(opts)) {
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200759 fprintf(stderr, "Error: environment not initialized\n");
760 return -1;
761 }
762
763 if (strcmp(fname, "-") == 0)
764 fp = stdin;
765 else {
766 fp = fopen(fname, "r");
767 if (fp == NULL) {
768 fprintf(stderr, "I cannot open %s for reading\n",
Alex Kiernanc7f52c42018-03-09 12:12:59 +0000769 fname);
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200770 return -1;
771 }
772 }
773
Alex Kiernan94b233f2018-06-07 12:20:05 +0000774 while ((len = getline(&line, &linesize, fp)) != -1) {
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200775 lineno++;
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200776
777 /*
Alex Kiernan94b233f2018-06-07 12:20:05 +0000778 * Read a whole line from the file. If the line is not
779 * terminated, reports an error and exit.
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200780 */
Alex Kiernan94b233f2018-06-07 12:20:05 +0000781 if (line[len - 1] != '\n') {
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200782 fprintf(stderr,
Alex Kiernan94b233f2018-06-07 12:20:05 +0000783 "Line %d not correctly terminated\n",
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200784 lineno);
785 ret = -1;
786 break;
787 }
788
789 /* Drop ending line feed / carriage return */
Alex Kiernan94b233f2018-06-07 12:20:05 +0000790 line[--len] = '\0';
791 if (len && line[len - 1] == '\r')
792 line[--len] = '\0';
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200793
794 /* Skip comment or empty lines */
Alex Kiernan94b233f2018-06-07 12:20:05 +0000795 if (len == 0 || line[0] == '#')
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200796 continue;
797
798 /*
Alex Kiernan94b233f2018-06-07 12:20:05 +0000799 * Search for variable's name remove leading whitespaces
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200800 */
Alex Kiernan94b233f2018-06-07 12:20:05 +0000801 name = skip_blanks(line);
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200802 if (!name)
803 continue;
804
805 /* The first white space is the end of variable name */
Andreas Fenkart938c29f2016-03-11 09:39:37 +0100806 val = skip_chars(name);
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200807 len = strlen(name);
808 if (val) {
809 *val++ = '\0';
810 if ((val - name) < len)
Andreas Fenkart938c29f2016-03-11 09:39:37 +0100811 val = skip_blanks(val);
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200812 else
813 val = NULL;
814 }
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200815#ifdef DEBUG
816 fprintf(stderr, "Setting %s : %s\n",
817 name, val ? val : " removed");
818#endif
819
Joe Hershberger30fd4fad2012-12-11 22:16:32 -0600820 if (env_flags_validate_type(name, val) < 0) {
821 ret = -1;
822 break;
823 }
824
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200825 /*
826 * If there is an error setting a variable,
827 * try to save the environment and returns an error
828 */
829 if (fw_env_write(name, val)) {
830 fprintf(stderr,
Alex Kiernanc7f52c42018-03-09 12:12:59 +0000831 "fw_env_write returns with error : %s\n",
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200832 strerror(errno));
833 ret = -1;
834 break;
835 }
836
837 }
Alex Kiernan94b233f2018-06-07 12:20:05 +0000838 free(line);
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200839
840 /* Close file if not stdin */
841 if (strcmp(fname, "-") != 0)
842 fclose(fp);
843
Stefano Babic33f00862017-04-05 18:08:03 +0200844 ret |= fw_env_flush(opts);
845
846 fw_env_close(opts);
Stefano Babicbd7b26f2010-05-24 12:08:16 +0200847
848 return ret;
Guennadi Liakhovetski56086922008-09-04 13:01:49 +0200849}
850
Andreas Fenkarte2c93512016-08-29 23:16:57 +0200851/**
Shyam Saini919d25c2018-06-07 19:47:19 +0530852 * environment_end() - compute offset of first byte right after environment
Andreas Fenkarte2c93512016-08-29 23:16:57 +0200853 * @dev - index of enviroment buffer
854 * Return:
Shyam Saini919d25c2018-06-07 19:47:19 +0530855 * device offset of first byte right after environment
Andreas Fenkarte2c93512016-08-29 23:16:57 +0200856 */
857off_t environment_end(int dev)
858{
859 /* environment is block aligned */
860 return DEVOFFSET(dev) + ENVSECTORS(dev) * DEVESIZE(dev);
861}
862
Guennadi Liakhovetski56086922008-09-04 13:01:49 +0200863/*
864 * Test for bad block on NAND, just returns 0 on NOR, on NAND:
865 * 0 - block is good
866 * > 0 - block is bad
867 * < 0 - failed to test
868 */
Andreas Fenkartc6012bb2016-08-29 23:16:58 +0200869static int flash_bad_block(int fd, uint8_t mtd_type, loff_t blockstart)
Guennadi Liakhovetski56086922008-09-04 13:01:49 +0200870{
871 if (mtd_type == MTD_NANDFLASH) {
Andreas Fenkartc6012bb2016-08-29 23:16:58 +0200872 int badblock = ioctl(fd, MEMGETBADBLOCK, &blockstart);
Guennadi Liakhovetski56086922008-09-04 13:01:49 +0200873
874 if (badblock < 0) {
Alex Kiernanc7f52c42018-03-09 12:12:59 +0000875 perror("Cannot read bad block mark");
Guennadi Liakhovetski56086922008-09-04 13:01:49 +0200876 return badblock;
877 }
878
879 if (badblock) {
880#ifdef DEBUG
Alex Kiernanc7f52c42018-03-09 12:12:59 +0000881 fprintf(stderr, "Bad block at 0x%llx, skipping\n",
Andreas Fenkartc6012bb2016-08-29 23:16:58 +0200882 (unsigned long long)blockstart);
Guennadi Liakhovetski56086922008-09-04 13:01:49 +0200883#endif
884 return badblock;
885 }
886 }
887
888 return 0;
889}
890
891/*
892 * Read data from flash at an offset into a provided buffer. On NAND it skips
893 * bad blocks but makes sure it stays within ENVSECTORS (dev) starting from
894 * the DEVOFFSET (dev) block. On NOR the loop is only run once.
895 */
Alex Kiernanc7f52c42018-03-09 12:12:59 +0000896static int flash_read_buf(int dev, int fd, void *buf, size_t count,
897 off_t offset)
Guennadi Liakhovetski56086922008-09-04 13:01:49 +0200898{
899 size_t blocklen; /* erase / write length - one block on NAND,
900 0 on NOR */
901 size_t processed = 0; /* progress counter */
902 size_t readlen = count; /* current read length */
Guennadi Liakhovetski56086922008-09-04 13:01:49 +0200903 off_t block_seek; /* offset inside the current block to the start
904 of the data */
905 loff_t blockstart; /* running start of the current block -
906 MEMGETBADBLOCK needs 64 bits */
907 int rc;
908
Alex Kiernanc7f52c42018-03-09 12:12:59 +0000909 blockstart = (offset / DEVESIZE(dev)) * DEVESIZE(dev);
Guennadi Liakhovetski56086922008-09-04 13:01:49 +0200910
911 /* Offset inside a block */
912 block_seek = offset - blockstart;
913
Andreas Fenkartff95e572016-08-29 23:16:59 +0200914 if (DEVTYPE(dev) == MTD_NANDFLASH) {
Guennadi Liakhovetski56086922008-09-04 13:01:49 +0200915 /*
916 * NAND: calculate which blocks we are reading. We have
917 * to read one block at a time to skip bad blocks.
918 */
Alex Kiernanc7f52c42018-03-09 12:12:59 +0000919 blocklen = DEVESIZE(dev);
Guennadi Liakhovetski56086922008-09-04 13:01:49 +0200920
Guennadi Liakhovetski56086922008-09-04 13:01:49 +0200921 /* Limit to one block for the first read */
922 if (readlen > blocklen - block_seek)
923 readlen = blocklen - block_seek;
924 } else {
925 blocklen = 0;
Guennadi Liakhovetski56086922008-09-04 13:01:49 +0200926 }
927
928 /* This only runs once on NOR flash */
929 while (processed < count) {
Andreas Fenkartff95e572016-08-29 23:16:59 +0200930 rc = flash_bad_block(fd, DEVTYPE(dev), blockstart);
Alex Kiernanc7f52c42018-03-09 12:12:59 +0000931 if (rc < 0) /* block test failed */
Guennadi Liakhovetski56086922008-09-04 13:01:49 +0200932 return -1;
933
Andreas Fenkarte2c93512016-08-29 23:16:57 +0200934 if (blockstart + block_seek + readlen > environment_end(dev)) {
Guennadi Liakhovetski56086922008-09-04 13:01:49 +0200935 /* End of range is reached */
Alex Kiernanc7f52c42018-03-09 12:12:59 +0000936 fprintf(stderr, "Too few good blocks within range\n");
Guennadi Liakhovetski56086922008-09-04 13:01:49 +0200937 return -1;
938 }
939
Alex Kiernanc7f52c42018-03-09 12:12:59 +0000940 if (rc) { /* block is bad */
Guennadi Liakhovetski56086922008-09-04 13:01:49 +0200941 blockstart += blocklen;
942 continue;
943 }
944
945 /*
946 * If a block is bad, we retry in the next block at the same
Tom Rini2d3229b2017-09-05 14:01:29 -0400947 * offset - see env/nand.c::writeenv()
Guennadi Liakhovetski56086922008-09-04 13:01:49 +0200948 */
Alex Kiernanc7f52c42018-03-09 12:12:59 +0000949 lseek(fd, blockstart + block_seek, SEEK_SET);
Guennadi Liakhovetski56086922008-09-04 13:01:49 +0200950
Rafał Miłecki9e3003f2023-12-13 13:13:54 +0100951 while (readlen) {
952 rc = read(fd, buf + processed, readlen);
953 if (rc == -1) {
954 fprintf(stderr, "Read error on %s: %s\n",
955 DEVNAME(dev), strerror(errno));
956 return -1;
957 }
Guennadi Liakhovetski56086922008-09-04 13:01:49 +0200958#ifdef DEBUG
Rafał Miłecki9e3003f2023-12-13 13:13:54 +0100959 fprintf(stderr, "Read 0x%x bytes at 0x%llx on %s\n",
960 rc, (unsigned long long)blockstart + block_seek,
961 DEVNAME(dev));
Guennadi Liakhovetski56086922008-09-04 13:01:49 +0200962#endif
Rafał Miłecki9e3003f2023-12-13 13:13:54 +0100963 processed += rc;
Thibault Ferrante66288132021-08-24 17:29:50 +0200964 readlen -= rc;
Thibault Ferrante66288132021-08-24 17:29:50 +0200965 }
Rafał Miłecki9e3003f2023-12-13 13:13:54 +0100966
967 blockstart += blocklen;
968 readlen = min(blocklen, count - processed);
969 block_seek = 0;
Guennadi Liakhovetski56086922008-09-04 13:01:49 +0200970 }
971
972 return processed;
973}
974
975/*
Andreas Fenkart24307d62016-08-29 23:17:00 +0200976 * Write count bytes from begin of environment, but stay within
977 * ENVSECTORS(dev) sectors of
Remy Bohmer9eeaa8e2011-02-12 19:06:26 +0100978 * DEVOFFSET (dev). Similar to the read case above, on NOR and dataflash we
979 * erase and write the whole data at once.
Guennadi Liakhovetski56086922008-09-04 13:01:49 +0200980 */
Andreas Fenkart24307d62016-08-29 23:17:00 +0200981static int flash_write_buf(int dev, int fd, void *buf, size_t count)
Guennadi Liakhovetski56086922008-09-04 13:01:49 +0200982{
983 void *data;
984 struct erase_info_user erase;
985 size_t blocklen; /* length of NAND block / NOR erase sector */
986 size_t erase_len; /* whole area that can be erased - may include
987 bad blocks */
988 size_t erasesize; /* erase / write length - one block on NAND,
989 whole area on NOR */
990 size_t processed = 0; /* progress counter */
Remy Bohmer9eeaa8e2011-02-12 19:06:26 +0100991 size_t write_total; /* total size to actually write - excluding
Guennadi Liakhovetski56086922008-09-04 13:01:49 +0200992 bad blocks */
993 off_t erase_offset; /* offset to the first erase block (aligned)
994 below offset */
995 off_t block_seek; /* offset inside the erase block to the start
996 of the data */
Guennadi Liakhovetski56086922008-09-04 13:01:49 +0200997 loff_t blockstart; /* running start of the current block -
998 MEMGETBADBLOCK needs 64 bits */
Simon Glass7b27e0f2020-08-01 10:30:39 -0600999 int was_locked = 0; /* flash lock flag */
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001000 int rc;
1001
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001002 /*
Oliver Metze387efb2013-08-30 00:56:02 +02001003 * For mtd devices only offset and size of the environment do matter
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001004 */
Andreas Fenkartff95e572016-08-29 23:16:59 +02001005 if (DEVTYPE(dev) == MTD_ABSENT) {
Oliver Metze387efb2013-08-30 00:56:02 +02001006 blocklen = count;
Oliver Metze387efb2013-08-30 00:56:02 +02001007 erase_len = blocklen;
Andreas Fenkart24307d62016-08-29 23:17:00 +02001008 blockstart = DEVOFFSET(dev);
Oliver Metze387efb2013-08-30 00:56:02 +02001009 block_seek = 0;
1010 write_total = blocklen;
1011 } else {
1012 blocklen = DEVESIZE(dev);
1013
Andreas Fenkart24307d62016-08-29 23:17:00 +02001014 erase_offset = DEVOFFSET(dev);
Oliver Metze387efb2013-08-30 00:56:02 +02001015
1016 /* Maximum area we may use */
Andreas Fenkarte2c93512016-08-29 23:16:57 +02001017 erase_len = environment_end(dev) - erase_offset;
Oliver Metze387efb2013-08-30 00:56:02 +02001018
1019 blockstart = erase_offset;
Andreas Fenkart24307d62016-08-29 23:17:00 +02001020
Oliver Metze387efb2013-08-30 00:56:02 +02001021 /* Offset inside a block */
Andreas Fenkart24307d62016-08-29 23:17:00 +02001022 block_seek = DEVOFFSET(dev) - erase_offset;
Oliver Metze387efb2013-08-30 00:56:02 +02001023
1024 /*
1025 * Data size we actually write: from the start of the block
1026 * to the start of the data, then count bytes of data, and
1027 * to the end of the block
1028 */
1029 write_total = ((block_seek + count + blocklen - 1) /
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001030 blocklen) * blocklen;
Oliver Metze387efb2013-08-30 00:56:02 +02001031 }
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001032
1033 /*
1034 * Support data anywhere within erase sectors: read out the complete
1035 * area to be erased, replace the environment image, write the whole
1036 * block back again.
1037 */
1038 if (write_total > count) {
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001039 data = malloc(erase_len);
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001040 if (!data) {
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001041 fprintf(stderr,
1042 "Cannot malloc %zu bytes: %s\n",
1043 erase_len, strerror(errno));
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001044 return -1;
1045 }
1046
Andreas Fenkartff95e572016-08-29 23:16:59 +02001047 rc = flash_read_buf(dev, fd, data, write_total, erase_offset);
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001048 if (write_total != rc)
1049 return -1;
1050
Joe Hershberger74620e12012-10-15 15:29:25 +00001051#ifdef DEBUG
1052 fprintf(stderr, "Preserving data ");
1053 if (block_seek != 0)
1054 fprintf(stderr, "0x%x - 0x%lx", 0, block_seek - 1);
1055 if (block_seek + count != write_total) {
1056 if (block_seek != 0)
1057 fprintf(stderr, " and ");
Marcin Niestroj81c878d2016-05-06 14:58:29 +02001058 fprintf(stderr, "0x%lx - 0x%lx",
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001059 (unsigned long)block_seek + count,
1060 (unsigned long)write_total - 1);
Joe Hershberger74620e12012-10-15 15:29:25 +00001061 }
1062 fprintf(stderr, "\n");
1063#endif
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001064 /* Overwrite the old environment */
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001065 memcpy(data + block_seek, buf, count);
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001066 } else {
1067 /*
1068 * We get here, iff offset is block-aligned and count is a
1069 * multiple of blocklen - see write_total calculation above
1070 */
1071 data = buf;
1072 }
1073
Andreas Fenkartff95e572016-08-29 23:16:59 +02001074 if (DEVTYPE(dev) == MTD_NANDFLASH) {
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001075 /*
1076 * NAND: calculate which blocks we are writing. We have
1077 * to write one block at a time to skip bad blocks.
1078 */
1079 erasesize = blocklen;
1080 } else {
1081 erasesize = erase_len;
1082 }
1083
1084 erase.length = erasesize;
1085
Remy Bohmer9eeaa8e2011-02-12 19:06:26 +01001086 /* This only runs once on NOR flash and SPI-dataflash */
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001087 while (processed < write_total) {
Andreas Fenkartff95e572016-08-29 23:16:59 +02001088 rc = flash_bad_block(fd, DEVTYPE(dev), blockstart);
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001089 if (rc < 0) /* block test failed */
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001090 return rc;
1091
Andreas Fenkarte2c93512016-08-29 23:16:57 +02001092 if (blockstart + erasesize > environment_end(dev)) {
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001093 fprintf(stderr, "End of range reached, aborting\n");
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001094 return -1;
1095 }
1096
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001097 if (rc) { /* block is bad */
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001098 blockstart += blocklen;
1099 continue;
1100 }
1101
Andreas Fenkartff95e572016-08-29 23:16:59 +02001102 if (DEVTYPE(dev) != MTD_ABSENT) {
Oliver Metze387efb2013-08-30 00:56:02 +02001103 erase.start = blockstart;
Joakim Tjernlund08cf1a52021-12-08 15:33:11 +01001104 was_locked = ioctl(fd, MEMISLOCKED, &erase);
1105 /* treat any errors as unlocked flash */
1106 if (was_locked < 0)
1107 was_locked = 0;
Ivan Mikhaylovdb820152020-07-10 19:54:18 +03001108 if (was_locked)
1109 ioctl(fd, MEMUNLOCK, &erase);
Oliver Metze387efb2013-08-30 00:56:02 +02001110 /* These do not need an explicit erase cycle */
Andreas Fenkartff95e572016-08-29 23:16:59 +02001111 if (DEVTYPE(dev) != MTD_DATAFLASH)
Oliver Metze387efb2013-08-30 00:56:02 +02001112 if (ioctl(fd, MEMERASE, &erase) != 0) {
1113 fprintf(stderr,
1114 "MTD erase error on %s: %s\n",
1115 DEVNAME(dev), strerror(errno));
1116 return -1;
1117 }
1118 }
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001119
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001120 if (lseek(fd, blockstart, SEEK_SET) == -1) {
1121 fprintf(stderr,
1122 "Seek error on %s: %s\n",
1123 DEVNAME(dev), strerror(errno));
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001124 return -1;
1125 }
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001126#ifdef DEBUG
Marcin Niestroj81c878d2016-05-06 14:58:29 +02001127 fprintf(stderr, "Write 0x%llx bytes at 0x%llx\n",
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001128 (unsigned long long)erasesize,
1129 (unsigned long long)blockstart);
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001130#endif
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001131 if (write(fd, data + processed, erasesize) != erasesize) {
1132 fprintf(stderr, "Write error on %s: %s\n",
1133 DEVNAME(dev), strerror(errno));
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001134 return -1;
1135 }
1136
Ivan Mikhaylovdb820152020-07-10 19:54:18 +03001137 if (DEVTYPE(dev) != MTD_ABSENT) {
1138 if (was_locked)
1139 ioctl(fd, MEMLOCK, &erase);
1140 }
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001141
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001142 processed += erasesize;
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001143 block_seek = 0;
Dustin Byford4b774ff2014-03-06 20:48:23 -08001144 blockstart += erasesize;
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001145 }
1146
1147 if (write_total > count)
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001148 free(data);
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001149
1150 return processed;
1151}
1152
1153/*
1154 * Set obsolete flag at offset - NOR flash only
1155 */
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001156static int flash_flag_obsolete(int dev, int fd, off_t offset)
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001157{
1158 int rc;
Detlev Zundel0aef7bc2010-07-30 11:22:15 +02001159 struct erase_info_user erase;
Pierre-Jean Texier7ce01c72019-08-26 13:06:16 +02001160 char tmp = ENV_REDUND_OBSOLETE;
Ivan Mikhaylovdb820152020-07-10 19:54:18 +03001161 int was_locked; /* flash lock flag */
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001162
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001163 erase.start = DEVOFFSET(dev);
1164 erase.length = DEVESIZE(dev);
Simon Glassd3716dd2019-08-01 09:47:08 -06001165 /* This relies on the fact, that ENV_REDUND_OBSOLETE == 0 */
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001166 rc = lseek(fd, offset, SEEK_SET);
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001167 if (rc < 0) {
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001168 fprintf(stderr, "Cannot seek to set the flag on %s\n",
1169 DEVNAME(dev));
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001170 return rc;
1171 }
Joakim Tjernlund08cf1a52021-12-08 15:33:11 +01001172 was_locked = ioctl(fd, MEMISLOCKED, &erase);
1173 /* treat any errors as unlocked flash */
1174 if (was_locked < 0)
1175 was_locked = 0;
Ivan Mikhaylovdb820152020-07-10 19:54:18 +03001176 if (was_locked)
1177 ioctl(fd, MEMUNLOCK, &erase);
Pierre-Jean Texier7ce01c72019-08-26 13:06:16 +02001178 rc = write(fd, &tmp, sizeof(tmp));
Ivan Mikhaylovdb820152020-07-10 19:54:18 +03001179 if (was_locked)
1180 ioctl(fd, MEMLOCK, &erase);
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001181 if (rc < 0)
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001182 perror("Could not set obsolete flag");
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001183
1184 return rc;
1185}
1186
Rafał Miłeckif178f7c2022-01-12 12:47:05 +01001187static int flash_write(int fd_current, int fd_target, int dev_target, void *buf,
1188 size_t count)
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001189{
1190 int rc;
1191
1192 switch (environment.flag_scheme) {
1193 case FLAG_NONE:
1194 break;
1195 case FLAG_INCREMENTAL:
1196 (*environment.flags)++;
1197 break;
1198 case FLAG_BOOLEAN:
Simon Glassd3716dd2019-08-01 09:47:08 -06001199 *environment.flags = ENV_REDUND_ACTIVE;
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001200 break;
1201 default:
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001202 fprintf(stderr, "Unimplemented flash scheme %u\n",
1203 environment.flag_scheme);
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001204 return -1;
1205 }
1206
1207#ifdef DEBUG
Stefan Agnerf4742ca2016-07-13 17:14:38 -07001208 fprintf(stderr, "Writing new environment at 0x%llx on %s\n",
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001209 DEVOFFSET(dev_target), DEVNAME(dev_target));
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001210#endif
Marek Vasuta8a752c2014-03-05 19:59:52 +01001211
S. Lockwood-Childs34255b92017-11-14 23:01:26 -08001212 if (IS_UBI(dev_target)) {
1213 if (ubi_update_start(fd_target, CUR_ENVSIZE) < 0)
Martin Hundebøll09779482020-11-30 12:11:32 +01001214 return -1;
Rafał Miłeckif178f7c2022-01-12 12:47:05 +01001215 return ubi_write(fd_target, buf, count);
S. Lockwood-Childs34255b92017-11-14 23:01:26 -08001216 }
1217
Rafał Miłeckif178f7c2022-01-12 12:47:05 +01001218 rc = flash_write_buf(dev_target, fd_target, buf, count);
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001219 if (rc < 0)
1220 return rc;
1221
1222 if (environment.flag_scheme == FLAG_BOOLEAN) {
1223 /* Have to set obsolete flag */
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001224 off_t offset = DEVOFFSET(dev_current) +
1225 offsetof(struct env_image_redundant, flags);
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001226#ifdef DEBUG
Joe Hershberger74620e12012-10-15 15:29:25 +00001227 fprintf(stderr,
Stefan Agnerf4742ca2016-07-13 17:14:38 -07001228 "Setting obsolete flag in environment at 0x%llx on %s\n",
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001229 DEVOFFSET(dev_current), DEVNAME(dev_current));
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001230#endif
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001231 flash_flag_obsolete(dev_current, fd_current, offset);
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001232 }
1233
1234 return 0;
1235}
1236
Rafał Miłeckif178f7c2022-01-12 12:47:05 +01001237static int flash_read(int fd, void *buf, size_t count)
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001238{
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001239 int rc;
1240
S. Lockwood-Childs34255b92017-11-14 23:01:26 -08001241 if (IS_UBI(dev_current)) {
1242 DEVTYPE(dev_current) = MTD_ABSENT;
1243
Rafał Miłeckif178f7c2022-01-12 12:47:05 +01001244 return ubi_read(fd, buf, count);
S. Lockwood-Childs34255b92017-11-14 23:01:26 -08001245 }
1246
Rafał Miłeckif178f7c2022-01-12 12:47:05 +01001247 rc = flash_read_buf(dev_current, fd, buf, count,
Andreas Fenkartff95e572016-08-29 23:16:59 +02001248 DEVOFFSET(dev_current));
Marek Vasuta8a752c2014-03-05 19:59:52 +01001249 if (rc != CUR_ENVSIZE)
1250 return -1;
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001251
Marek Vasuta8a752c2014-03-05 19:59:52 +01001252 return 0;
wdenk6aff3112002-12-17 01:51:00 +00001253}
1254
Alex Kiernandbc34322018-03-09 12:13:02 +00001255static int flash_open_tempfile(const char **dname, const char **target_temp)
1256{
1257 char *dup_name = strdup(DEVNAME(dev_current));
1258 char *temp_name = NULL;
1259 int rc = -1;
1260
1261 if (!dup_name)
1262 return -1;
1263
1264 *dname = dirname(dup_name);
1265 if (!*dname)
1266 goto err;
1267
1268 rc = asprintf(&temp_name, "%s/XXXXXX", *dname);
1269 if (rc == -1)
1270 goto err;
1271
1272 rc = mkstemp(temp_name);
1273 if (rc == -1) {
1274 /* fall back to in place write */
1275 fprintf(stderr,
1276 "Can't create %s: %s\n", temp_name, strerror(errno));
1277 free(temp_name);
1278 } else {
1279 *target_temp = temp_name;
1280 /* deliberately leak dup_name as dname /might/ point into
1281 * it and we need it for our caller
1282 */
1283 dup_name = NULL;
1284 }
1285
1286err:
1287 if (dup_name)
1288 free(dup_name);
1289
1290 return rc;
1291}
1292
Rafał Miłeckif178f7c2022-01-12 12:47:05 +01001293static int flash_io_write(int fd_current, void *buf, size_t count)
Alex Kiernan899b5332018-03-09 12:13:01 +00001294{
Alex Kiernandbc34322018-03-09 12:13:02 +00001295 int fd_target = -1, rc, dev_target;
1296 const char *dname, *target_temp = NULL;
Alex Kiernan899b5332018-03-09 12:13:01 +00001297
1298 if (have_redund_env) {
1299 /* switch to next partition for writing */
1300 dev_target = !dev_current;
1301 /* dev_target: fd_target, erase_target */
1302 fd_target = open(DEVNAME(dev_target), O_RDWR);
1303 if (fd_target < 0) {
1304 fprintf(stderr,
1305 "Can't open %s: %s\n",
1306 DEVNAME(dev_target), strerror(errno));
1307 rc = -1;
1308 goto exit;
1309 }
1310 } else {
Alex Kiernandbc34322018-03-09 12:13:02 +00001311 struct stat sb;
1312
1313 if (fstat(fd_current, &sb) == 0 && S_ISREG(sb.st_mode)) {
1314 /* if any part of flash_open_tempfile() fails we fall
1315 * back to in-place writes
1316 */
1317 fd_target = flash_open_tempfile(&dname, &target_temp);
1318 }
Alex Kiernan899b5332018-03-09 12:13:01 +00001319 dev_target = dev_current;
Alex Kiernandbc34322018-03-09 12:13:02 +00001320 if (fd_target == -1)
1321 fd_target = fd_current;
Alex Kiernan899b5332018-03-09 12:13:01 +00001322 }
1323
Rafał Miłeckif178f7c2022-01-12 12:47:05 +01001324 rc = flash_write(fd_current, fd_target, dev_target, buf, count);
Alex Kiernan899b5332018-03-09 12:13:01 +00001325
1326 if (fsync(fd_current) && !(errno == EINVAL || errno == EROFS)) {
1327 fprintf(stderr,
1328 "fsync failed on %s: %s\n",
1329 DEVNAME(dev_current), strerror(errno));
1330 }
1331
Alex Kiernandbc34322018-03-09 12:13:02 +00001332 if (fd_current != fd_target) {
Alex Kiernan899b5332018-03-09 12:13:01 +00001333 if (fsync(fd_target) &&
1334 !(errno == EINVAL || errno == EROFS)) {
1335 fprintf(stderr,
1336 "fsync failed on %s: %s\n",
1337 DEVNAME(dev_current), strerror(errno));
1338 }
1339
1340 if (close(fd_target)) {
1341 fprintf(stderr,
1342 "I/O error on %s: %s\n",
1343 DEVNAME(dev_target), strerror(errno));
1344 rc = -1;
1345 }
Alex Kiernandbc34322018-03-09 12:13:02 +00001346
Alex Kiernana7623112019-06-12 15:27:55 +01001347 if (rc >= 0 && target_temp) {
Alex Kiernandbc34322018-03-09 12:13:02 +00001348 int dir_fd;
1349
1350 dir_fd = open(dname, O_DIRECTORY | O_RDONLY);
1351 if (dir_fd == -1)
1352 fprintf(stderr,
1353 "Can't open %s: %s\n",
1354 dname, strerror(errno));
1355
1356 if (rename(target_temp, DEVNAME(dev_target))) {
1357 fprintf(stderr,
1358 "rename failed %s => %s: %s\n",
1359 target_temp, DEVNAME(dev_target),
1360 strerror(errno));
1361 rc = -1;
1362 }
1363
1364 if (dir_fd != -1 && fsync(dir_fd))
1365 fprintf(stderr,
1366 "fsync failed on %s: %s\n",
1367 dname, strerror(errno));
1368
1369 if (dir_fd != -1 && close(dir_fd))
1370 fprintf(stderr,
1371 "I/O error on %s: %s\n",
1372 dname, strerror(errno));
1373 }
Alex Kiernan899b5332018-03-09 12:13:01 +00001374 }
1375 exit:
1376 return rc;
1377}
1378
Rafał Miłeckif178f7c2022-01-12 12:47:05 +01001379static int flash_io(int mode, void *buf, size_t count)
wdenk6aff3112002-12-17 01:51:00 +00001380{
Alex Kiernan899b5332018-03-09 12:13:01 +00001381 int fd_current, rc;
wdenk6aff3112002-12-17 01:51:00 +00001382
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001383 /* dev_current: fd_current, erase_current */
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001384 fd_current = open(DEVNAME(dev_current), mode);
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001385 if (fd_current < 0) {
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001386 fprintf(stderr,
1387 "Can't open %s: %s\n",
1388 DEVNAME(dev_current), strerror(errno));
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001389 return -1;
wdenkd0fb80c2003-01-11 09:48:40 +00001390 }
wdenk6aff3112002-12-17 01:51:00 +00001391
1392 if (mode == O_RDWR) {
Rafał Miłeckif178f7c2022-01-12 12:47:05 +01001393 rc = flash_io_write(fd_current, buf, count);
wdenk6aff3112002-12-17 01:51:00 +00001394 } else {
Rafał Miłeckif178f7c2022-01-12 12:47:05 +01001395 rc = flash_read(fd_current, buf, count);
wdenk6aff3112002-12-17 01:51:00 +00001396 }
1397
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001398 if (close(fd_current)) {
1399 fprintf(stderr,
1400 "I/O error on %s: %s\n",
1401 DEVNAME(dev_current), strerror(errno));
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001402 return -1;
wdenk6aff3112002-12-17 01:51:00 +00001403 }
1404
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001405 return rc;
wdenk6aff3112002-12-17 01:51:00 +00001406}
1407
1408/*
wdenk6aff3112002-12-17 01:51:00 +00001409 * Prevent confusion if running from erased flash memory
1410 */
Andreas Fenkart81974f42016-04-05 23:13:42 +02001411int fw_env_open(struct env_opts *opts)
wdenk6aff3112002-12-17 01:51:00 +00001412{
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001413 int crc0, crc0_ok;
Jon Povey735eb0f2011-03-11 14:10:56 +09001414 unsigned char flag0;
Rafał Miłecki73b30802023-12-13 10:23:44 +01001415 void *buf0 = NULL;
wdenkd0fb80c2003-01-11 09:48:40 +00001416
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001417 int crc1, crc1_ok;
Jon Povey735eb0f2011-03-11 14:10:56 +09001418 unsigned char flag1;
Rafał Miłecki73b30802023-12-13 10:23:44 +01001419 void *buf1 = NULL;
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001420
Marek Vasuta8a752c2014-03-05 19:59:52 +01001421 int ret;
1422
Andreas Fenkart14070e62016-05-31 09:21:56 +02001423 if (!opts)
1424 opts = &default_opts;
1425
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001426 if (parse_config(opts)) /* should fill envdevices */
Stefano Babic33f00862017-04-05 18:08:03 +02001427 return -EINVAL;
wdenk4a6fd342003-04-12 23:38:12 +00001428
Rafał Miłecki73b30802023-12-13 10:23:44 +01001429 buf0 = calloc(1, CUR_ENVSIZE);
1430 if (buf0 == NULL) {
Joe Hershberger497f2052012-10-03 09:38:46 +00001431 fprintf(stderr,
wdenk4a6fd342003-04-12 23:38:12 +00001432 "Not enough memory for environment (%ld bytes)\n",
Joe Hershberger497f2052012-10-03 09:38:46 +00001433 CUR_ENVSIZE);
Stefano Babic33f00862017-04-05 18:08:03 +02001434 ret = -ENOMEM;
1435 goto open_cleanup;
wdenkd0fb80c2003-01-11 09:48:40 +00001436 }
wdenk4a6fd342003-04-12 23:38:12 +00001437
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001438 dev_current = 0;
Rafał Miłecki73b30802023-12-13 10:23:44 +01001439 if (flash_io(O_RDONLY, buf0, CUR_ENVSIZE)) {
Stefano Babic33f00862017-04-05 18:08:03 +02001440 ret = -EIO;
1441 goto open_cleanup;
1442 }
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001443
Alex Kiernan2deb3ca2018-03-09 12:13:00 +00001444 if (!have_redund_env) {
Rafał Miłecki73b30802023-12-13 10:23:44 +01001445 struct env_image_single *single = buf0;
Rafał Miłecki07c79dd2022-01-12 12:47:06 +01001446
1447 crc0 = crc32(0, (uint8_t *)single->data, ENV_SIZE);
1448 crc0_ok = (crc0 == single->crc);
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001449 if (!crc0_ok) {
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001450 fprintf(stderr,
wdenk4a6fd342003-04-12 23:38:12 +00001451 "Warning: Bad CRC, using default environment\n");
Rafał Miłecki07c79dd2022-01-12 12:47:06 +01001452 memcpy(single->data, default_environment,
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001453 sizeof(default_environment));
Rasmus Villemoesc62e6142018-09-27 22:45:26 +02001454 environment.dirty = 1;
wdenk6aff3112002-12-17 01:51:00 +00001455 }
Rafał Miłecki07c79dd2022-01-12 12:47:06 +01001456
Rafał Miłecki73b30802023-12-13 10:23:44 +01001457 environment.image = buf0;
Rafał Miłecki07c79dd2022-01-12 12:47:06 +01001458 environment.crc = &single->crc;
1459 environment.flags = NULL;
1460 environment.data = single->data;
wdenkd0fb80c2003-01-11 09:48:40 +00001461 } else {
Rafał Miłecki73b30802023-12-13 10:23:44 +01001462 struct env_image_redundant *redundant0 = buf0;
Rafał Miłecki07c79dd2022-01-12 12:47:06 +01001463 struct env_image_redundant *redundant1;
1464
1465 crc0 = crc32(0, (uint8_t *)redundant0->data, ENV_SIZE);
1466 crc0_ok = (crc0 == redundant0->crc);
1467
1468 flag0 = redundant0->flags;
wdenk4a6fd342003-04-12 23:38:12 +00001469
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001470 dev_current = 1;
Rafał Miłecki73b30802023-12-13 10:23:44 +01001471 buf1 = calloc(1, CUR_ENVSIZE);
1472 if (buf1 == NULL) {
Joe Hershberger497f2052012-10-03 09:38:46 +00001473 fprintf(stderr,
wdenk4a6fd342003-04-12 23:38:12 +00001474 "Not enough memory for environment (%ld bytes)\n",
Joe Hershberger497f2052012-10-03 09:38:46 +00001475 CUR_ENVSIZE);
Stefano Babic33f00862017-04-05 18:08:03 +02001476 ret = -ENOMEM;
1477 goto open_cleanup;
wdenk4a6fd342003-04-12 23:38:12 +00001478 }
Rafał Miłecki73b30802023-12-13 10:23:44 +01001479 redundant1 = buf1;
wdenk4a6fd342003-04-12 23:38:12 +00001480
Rafał Miłecki73b30802023-12-13 10:23:44 +01001481 if (flash_io(O_RDONLY, buf1, CUR_ENVSIZE)) {
Tom Rini168de202018-07-01 22:10:33 -04001482 ret = -EIO;
1483 goto open_cleanup;
Stefano Babic33f00862017-04-05 18:08:03 +02001484 }
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001485
1486 /* Check flag scheme compatibility */
1487 if (DEVTYPE(dev_current) == MTD_NORFLASH &&
1488 DEVTYPE(!dev_current) == MTD_NORFLASH) {
1489 environment.flag_scheme = FLAG_BOOLEAN;
1490 } else if (DEVTYPE(dev_current) == MTD_NANDFLASH &&
1491 DEVTYPE(!dev_current) == MTD_NANDFLASH) {
1492 environment.flag_scheme = FLAG_INCREMENTAL;
Remy Bohmer9eeaa8e2011-02-12 19:06:26 +01001493 } else if (DEVTYPE(dev_current) == MTD_DATAFLASH &&
1494 DEVTYPE(!dev_current) == MTD_DATAFLASH) {
1495 environment.flag_scheme = FLAG_BOOLEAN;
Joe Hershberger785881f2013-04-08 10:32:52 +00001496 } else if (DEVTYPE(dev_current) == MTD_UBIVOLUME &&
1497 DEVTYPE(!dev_current) == MTD_UBIVOLUME) {
1498 environment.flag_scheme = FLAG_INCREMENTAL;
Oliver Metz23ef62d2013-08-30 00:56:01 +02001499 } else if (DEVTYPE(dev_current) == MTD_ABSENT &&
S. Lockwood-Childs34255b92017-11-14 23:01:26 -08001500 DEVTYPE(!dev_current) == MTD_ABSENT &&
1501 IS_UBI(dev_current) == IS_UBI(!dev_current)) {
Oliver Metz23ef62d2013-08-30 00:56:01 +02001502 environment.flag_scheme = FLAG_INCREMENTAL;
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001503 } else {
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001504 fprintf(stderr, "Incompatible flash types!\n");
Stefano Babic33f00862017-04-05 18:08:03 +02001505 ret = -EINVAL;
1506 goto open_cleanup;
wdenk6aff3112002-12-17 01:51:00 +00001507 }
wdenk4a6fd342003-04-12 23:38:12 +00001508
Rafał Miłecki07c79dd2022-01-12 12:47:06 +01001509 crc1 = crc32(0, (uint8_t *)redundant1->data, ENV_SIZE);
Tom Rini168de202018-07-01 22:10:33 -04001510
Rafał Miłecki07c79dd2022-01-12 12:47:06 +01001511 crc1_ok = (crc1 == redundant1->crc);
1512 flag1 = redundant1->flags;
wdenk4a6fd342003-04-12 23:38:12 +00001513
Rafał Miłecki07c79dd2022-01-12 12:47:06 +01001514 if (memcmp(redundant0->data, redundant1->data, ENV_SIZE) ||
Rasmus Villemoesc62e6142018-09-27 22:45:26 +02001515 !crc0_ok || !crc1_ok)
1516 environment.dirty = 1;
1517
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001518 if (crc0_ok && !crc1_ok) {
1519 dev_current = 0;
1520 } else if (!crc0_ok && crc1_ok) {
1521 dev_current = 1;
1522 } else if (!crc0_ok && !crc1_ok) {
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001523 fprintf(stderr,
wdenk4a6fd342003-04-12 23:38:12 +00001524 "Warning: Bad CRC, using default environment\n");
Rafał Miłecki07c79dd2022-01-12 12:47:06 +01001525 memcpy(redundant0->data, default_environment,
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001526 sizeof(default_environment));
Rasmus Villemoesc62e6142018-09-27 22:45:26 +02001527 environment.dirty = 1;
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001528 dev_current = 0;
1529 } else {
1530 switch (environment.flag_scheme) {
1531 case FLAG_BOOLEAN:
Simon Glassd3716dd2019-08-01 09:47:08 -06001532 if (flag0 == ENV_REDUND_ACTIVE &&
1533 flag1 == ENV_REDUND_OBSOLETE) {
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001534 dev_current = 0;
Simon Glassd3716dd2019-08-01 09:47:08 -06001535 } else if (flag0 == ENV_REDUND_OBSOLETE &&
1536 flag1 == ENV_REDUND_ACTIVE) {
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001537 dev_current = 1;
1538 } else if (flag0 == flag1) {
1539 dev_current = 0;
1540 } else if (flag0 == 0xFF) {
1541 dev_current = 0;
1542 } else if (flag1 == 0xFF) {
1543 dev_current = 1;
1544 } else {
1545 dev_current = 0;
1546 }
1547 break;
1548 case FLAG_INCREMENTAL:
Jon Povey735eb0f2011-03-11 14:10:56 +09001549 if (flag0 == 255 && flag1 == 0)
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001550 dev_current = 1;
1551 else if ((flag1 == 255 && flag0 == 0) ||
Jon Povey735eb0f2011-03-11 14:10:56 +09001552 flag0 >= flag1)
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001553 dev_current = 0;
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001554 else /* flag1 > flag0 */
Jon Povey735eb0f2011-03-11 14:10:56 +09001555 dev_current = 1;
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001556 break;
1557 default:
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001558 fprintf(stderr, "Unknown flag scheme %u\n",
1559 environment.flag_scheme);
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001560 return -1;
1561 }
1562 }
1563
1564 /*
1565 * If we are reading, we don't need the flag and the CRC any
1566 * more, if we are writing, we will re-calculate CRC and update
1567 * flags before writing out
1568 */
1569 if (dev_current) {
Rafał Miłecki73b30802023-12-13 10:23:44 +01001570 environment.image = buf1;
Rafał Miłecki07c79dd2022-01-12 12:47:06 +01001571 environment.crc = &redundant1->crc;
1572 environment.flags = &redundant1->flags;
1573 environment.data = redundant1->data;
Rafał Miłecki73b30802023-12-13 10:23:44 +01001574 free(buf0);
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001575 } else {
Rafał Miłecki73b30802023-12-13 10:23:44 +01001576 environment.image = buf0;
Rafał Miłecki07c79dd2022-01-12 12:47:06 +01001577 environment.crc = &redundant0->crc;
1578 environment.flags = &redundant0->flags;
1579 environment.data = redundant0->data;
Rafał Miłecki73b30802023-12-13 10:23:44 +01001580 free(buf1);
wdenk6aff3112002-12-17 01:51:00 +00001581 }
Joe Hershberger74620e12012-10-15 15:29:25 +00001582#ifdef DEBUG
1583 fprintf(stderr, "Selected env in %s\n", DEVNAME(dev_current));
1584#endif
wdenk6aff3112002-12-17 01:51:00 +00001585 }
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001586 return 0;
Stefano Babic33f00862017-04-05 18:08:03 +02001587
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001588 open_cleanup:
Rafał Miłecki73b30802023-12-13 10:23:44 +01001589 free(buf0);
1590 free(buf1);
Stefano Babic33f00862017-04-05 18:08:03 +02001591
1592 return ret;
1593}
1594
1595/*
1596 * Simply free allocated buffer with environment
1597 */
1598int fw_env_close(struct env_opts *opts)
1599{
1600 if (environment.image)
1601 free(environment.image);
1602
1603 environment.image = NULL;
1604
1605 return 0;
wdenk6aff3112002-12-17 01:51:00 +00001606}
1607
Stefan Agner14fb5b22016-07-13 17:14:37 -07001608static int check_device_config(int dev)
1609{
1610 struct stat st;
S. Lockwood-Childs34255b92017-11-14 23:01:26 -08001611 int32_t lnum = 0;
Stefan Agner14fb5b22016-07-13 17:14:37 -07001612 int fd, rc = 0;
1613
S. Lockwood-Childs34255b92017-11-14 23:01:26 -08001614 /* Fills in IS_UBI(), converts DEVNAME() with ubi volume name */
1615 ubi_check_dev(dev);
1616
Stefan Agner14fb5b22016-07-13 17:14:37 -07001617 fd = open(DEVNAME(dev), O_RDONLY);
1618 if (fd < 0) {
1619 fprintf(stderr,
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001620 "Cannot open %s: %s\n", DEVNAME(dev), strerror(errno));
Stefan Agner14fb5b22016-07-13 17:14:37 -07001621 return -1;
1622 }
1623
1624 rc = fstat(fd, &st);
1625 if (rc < 0) {
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001626 fprintf(stderr, "Cannot stat the file %s\n", DEVNAME(dev));
Stefan Agner14fb5b22016-07-13 17:14:37 -07001627 goto err;
1628 }
1629
S. Lockwood-Childs34255b92017-11-14 23:01:26 -08001630 if (IS_UBI(dev)) {
1631 rc = ioctl(fd, UBI_IOCEBISMAP, &lnum);
1632 if (rc < 0) {
1633 fprintf(stderr, "Cannot get UBI information for %s\n",
1634 DEVNAME(dev));
1635 goto err;
1636 }
1637 } else if (S_ISCHR(st.st_mode)) {
Stefan Agner14fb5b22016-07-13 17:14:37 -07001638 struct mtd_info_user mtdinfo;
1639 rc = ioctl(fd, MEMGETINFO, &mtdinfo);
1640 if (rc < 0) {
1641 fprintf(stderr, "Cannot get MTD information for %s\n",
1642 DEVNAME(dev));
1643 goto err;
1644 }
1645 if (mtdinfo.type != MTD_NORFLASH &&
1646 mtdinfo.type != MTD_NANDFLASH &&
1647 mtdinfo.type != MTD_DATAFLASH &&
1648 mtdinfo.type != MTD_UBIVOLUME) {
1649 fprintf(stderr, "Unsupported flash type %u on %s\n",
1650 mtdinfo.type, DEVNAME(dev));
1651 goto err;
1652 }
1653 DEVTYPE(dev) = mtdinfo.type;
Rasmus Villemoese282c422020-03-24 13:57:40 +01001654 if (DEVESIZE(dev) == 0 && ENVSECTORS(dev) == 0 &&
Anthony Loiseaud73a6642023-12-21 23:44:38 +01001655 mtdinfo.erasesize > 0) {
1656 if (mtdinfo.type == MTD_NORFLASH)
1657 DEVESIZE(dev) = mtdinfo.erasesize;
1658 else if (mtdinfo.type == MTD_NANDFLASH) {
1659 DEVESIZE(dev) = mtdinfo.erasesize;
1660 ENVSECTORS(dev) =
1661 mtdinfo.size / mtdinfo.erasesize;
1662 }
1663 }
Max Krummenacher333ee162016-11-19 13:58:56 +01001664 if (DEVESIZE(dev) == 0)
1665 /* Assume the erase size is the same as the env-size */
1666 DEVESIZE(dev) = ENVSIZE(dev);
Stefan Agner14fb5b22016-07-13 17:14:37 -07001667 } else {
Stefan Agnerf4742ca2016-07-13 17:14:38 -07001668 uint64_t size;
Stefan Agner14fb5b22016-07-13 17:14:37 -07001669 DEVTYPE(dev) = MTD_ABSENT;
Max Krummenacher333ee162016-11-19 13:58:56 +01001670 if (DEVESIZE(dev) == 0)
1671 /* Assume the erase size to be 512 bytes */
1672 DEVESIZE(dev) = 0x200;
Stefan Agnerf4742ca2016-07-13 17:14:38 -07001673
1674 /*
1675 * Check for negative offsets, treat it as backwards offset
1676 * from the end of the block device
1677 */
1678 if (DEVOFFSET(dev) < 0) {
1679 rc = ioctl(fd, BLKGETSIZE64, &size);
1680 if (rc < 0) {
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001681 fprintf(stderr,
1682 "Could not get block device size on %s\n",
Stefan Agnerf4742ca2016-07-13 17:14:38 -07001683 DEVNAME(dev));
1684 goto err;
1685 }
1686
1687 DEVOFFSET(dev) = DEVOFFSET(dev) + size;
1688#ifdef DEBUG
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001689 fprintf(stderr,
1690 "Calculated device offset 0x%llx on %s\n",
Stefan Agnerf4742ca2016-07-13 17:14:38 -07001691 DEVOFFSET(dev), DEVNAME(dev));
1692#endif
1693 }
Stefan Agner14fb5b22016-07-13 17:14:37 -07001694 }
1695
Max Krummenacher333ee162016-11-19 13:58:56 +01001696 if (ENVSECTORS(dev) == 0)
1697 /* Assume enough sectors to cover the environment */
1698 ENVSECTORS(dev) = DIV_ROUND_UP(ENVSIZE(dev), DEVESIZE(dev));
1699
1700 if (DEVOFFSET(dev) % DEVESIZE(dev) != 0) {
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001701 fprintf(stderr,
1702 "Environment does not start on (erase) block boundary\n");
Max Krummenacher333ee162016-11-19 13:58:56 +01001703 errno = EINVAL;
1704 return -1;
1705 }
1706
1707 if (ENVSIZE(dev) > ENVSECTORS(dev) * DEVESIZE(dev)) {
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001708 fprintf(stderr,
1709 "Environment does not fit into available sectors\n");
Max Krummenacher333ee162016-11-19 13:58:56 +01001710 errno = EINVAL;
1711 return -1;
1712 }
1713
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001714 err:
Stefan Agner14fb5b22016-07-13 17:14:37 -07001715 close(fd);
1716 return rc;
1717}
wdenk6aff3112002-12-17 01:51:00 +00001718
Rafał Miłecki8142c452022-06-16 20:59:03 +02001719static int find_nvmem_device(void)
1720{
1721 const char *path = "/sys/bus/nvmem/devices";
1722 struct dirent *dent;
1723 char *nvmem = NULL;
1724 char comp[256];
1725 char buf[32];
1726 int bytes;
1727 DIR *dir;
1728
1729 dir = opendir(path);
1730 if (!dir) {
1731 return -EIO;
1732 }
1733
1734 while (!nvmem && (dent = readdir(dir))) {
Rafał Miłeckif29c5ca2023-12-12 18:33:27 +01001735 struct stat s;
Rafał Miłecki8142c452022-06-16 20:59:03 +02001736 FILE *fp;
Jaehoon Chungc059a222022-10-13 17:41:21 +09001737 size_t size;
Rafał Miłecki8142c452022-06-16 20:59:03 +02001738
1739 if (!strcmp(dent->d_name, ".") || !strcmp(dent->d_name, "..")) {
1740 continue;
1741 }
1742
1743 bytes = snprintf(comp, sizeof(comp), "%s/%s/of_node/compatible", path, dent->d_name);
1744 if (bytes < 0 || bytes == sizeof(comp)) {
1745 continue;
1746 }
1747
1748 fp = fopen(comp, "r");
1749 if (!fp) {
1750 continue;
1751 }
1752
Rafał Miłeckif29c5ca2023-12-12 18:33:27 +01001753 if (fstat(fileno(fp), &s)) {
1754 fprintf(stderr, "Failed to fstat %s\n", comp);
1755 goto next;
1756 }
1757
1758 if (s.st_size >= sizeof(buf)) {
1759 goto next;
1760 }
1761
1762 size = fread(buf, s.st_size, 1, fp);
Jaehoon Chungc059a222022-10-13 17:41:21 +09001763 if (size != 1) {
1764 fprintf(stderr,
1765 "read failed about %s\n", comp);
Rafał Miłeckif29c5ca2023-12-12 18:33:27 +01001766 goto next;
Jaehoon Chungc059a222022-10-13 17:41:21 +09001767 }
Rafał Miłeckif29c5ca2023-12-12 18:33:27 +01001768 buf[s.st_size] = '\0';
Rafał Miłecki8142c452022-06-16 20:59:03 +02001769
1770 if (!strcmp(buf, "u-boot,env")) {
1771 bytes = asprintf(&nvmem, "%s/%s/nvmem", path, dent->d_name);
1772 if (bytes < 0) {
1773 nvmem = NULL;
1774 }
1775 }
1776
Rafał Miłeckif29c5ca2023-12-12 18:33:27 +01001777next:
Rafał Miłecki8142c452022-06-16 20:59:03 +02001778 fclose(fp);
1779 }
1780
1781 closedir(dir);
1782
1783 if (nvmem) {
1784 struct stat s;
1785
1786 stat(nvmem, &s);
1787
1788 DEVNAME(0) = nvmem;
1789 DEVOFFSET(0) = 0;
1790 ENVSIZE(0) = s.st_size;
1791
1792 return 0;
1793 }
1794
1795 return -ENOENT;
1796}
1797
Andreas Fenkart81974f42016-04-05 23:13:42 +02001798static int parse_config(struct env_opts *opts)
wdenk6aff3112002-12-17 01:51:00 +00001799{
Stefan Agner14fb5b22016-07-13 17:14:37 -07001800 int rc;
wdenk6aff3112002-12-17 01:51:00 +00001801
Andreas Fenkart14070e62016-05-31 09:21:56 +02001802 if (!opts)
1803 opts = &default_opts;
Anatolij Gustschin925c97c2016-04-29 22:00:11 +02001804
Andreas Fenkart14070e62016-05-31 09:21:56 +02001805#if defined(CONFIG_FILE)
wdenkd0fb80c2003-01-11 09:48:40 +00001806 /* Fills in DEVNAME(), ENVSIZE(), DEVESIZE(). Or don't. */
Andreas Fenkart81974f42016-04-05 23:13:42 +02001807 if (get_config(opts->config_file)) {
Rafał Miłecki8142c452022-06-16 20:59:03 +02001808 if (find_nvmem_device()) {
1809 fprintf(stderr, "Cannot parse config file '%s': %m\n",
1810 opts->config_file);
1811 fprintf(stderr, "Failed to find NVMEM device\n");
1812 return -1;
1813 }
wdenk6aff3112002-12-17 01:51:00 +00001814 }
wdenkd0fb80c2003-01-11 09:48:40 +00001815#else
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001816 DEVNAME(0) = DEVICE1_NAME;
1817 DEVOFFSET(0) = DEVICE1_OFFSET;
1818 ENVSIZE(0) = ENV1_SIZE;
Max Krummenacher333ee162016-11-19 13:58:56 +01001819
1820 /* Set defaults for DEVESIZE, ENVSECTORS later once we
1821 * know DEVTYPE
1822 */
Remy Bohmer9eeaa8e2011-02-12 19:06:26 +01001823#ifdef DEVICE1_ESIZE
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001824 DEVESIZE(0) = DEVICE1_ESIZE;
Remy Bohmer9eeaa8e2011-02-12 19:06:26 +01001825#endif
1826#ifdef DEVICE1_ENVSECTORS
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001827 ENVSECTORS(0) = DEVICE1_ENVSECTORS;
Remy Bohmer9eeaa8e2011-02-12 19:06:26 +01001828#endif
1829
wdenk6aff3112002-12-17 01:51:00 +00001830#ifdef HAVE_REDUND
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001831 DEVNAME(1) = DEVICE2_NAME;
1832 DEVOFFSET(1) = DEVICE2_OFFSET;
1833 ENVSIZE(1) = ENV2_SIZE;
Max Krummenacher333ee162016-11-19 13:58:56 +01001834
1835 /* Set defaults for DEVESIZE, ENVSECTORS later once we
1836 * know DEVTYPE
1837 */
Remy Bohmer9eeaa8e2011-02-12 19:06:26 +01001838#ifdef DEVICE2_ESIZE
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001839 DEVESIZE(1) = DEVICE2_ESIZE;
Remy Bohmer9eeaa8e2011-02-12 19:06:26 +01001840#endif
1841#ifdef DEVICE2_ENVSECTORS
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001842 ENVSECTORS(1) = DEVICE2_ENVSECTORS;
Remy Bohmer9eeaa8e2011-02-12 19:06:26 +01001843#endif
Alex Kiernan2deb3ca2018-03-09 12:13:00 +00001844 have_redund_env = 1;
wdenk6aff3112002-12-17 01:51:00 +00001845#endif
wdenkd0fb80c2003-01-11 09:48:40 +00001846#endif
Stefan Agner14fb5b22016-07-13 17:14:37 -07001847 rc = check_device_config(0);
1848 if (rc < 0)
1849 return rc;
wdenk4a6fd342003-04-12 23:38:12 +00001850
Alex Kiernan2deb3ca2018-03-09 12:13:00 +00001851 if (have_redund_env) {
Stefan Agner14fb5b22016-07-13 17:14:37 -07001852 rc = check_device_config(1);
1853 if (rc < 0)
1854 return rc;
Andreas Fenkartf71cee42016-04-19 22:43:42 +02001855
Stefan Agner14fb5b22016-07-13 17:14:37 -07001856 if (ENVSIZE(0) != ENVSIZE(1)) {
Stefan Agner14fb5b22016-07-13 17:14:37 -07001857 fprintf(stderr,
Philip Molloy9337a082019-03-31 03:44:57 +00001858 "Redundant environments have unequal size\n");
Andreas Fenkart490365c2016-08-17 23:41:53 +02001859 return -1;
Stefan Agner14fb5b22016-07-13 17:14:37 -07001860 }
Andreas Fenkartf71cee42016-04-19 22:43:42 +02001861 }
1862
1863 usable_envsize = CUR_ENVSIZE - sizeof(uint32_t);
Alex Kiernan2deb3ca2018-03-09 12:13:00 +00001864 if (have_redund_env)
Andreas Fenkartf71cee42016-04-19 22:43:42 +02001865 usable_envsize -= sizeof(char);
1866
wdenk6aff3112002-12-17 01:51:00 +00001867 return 0;
1868}
wdenkd0fb80c2003-01-11 09:48:40 +00001869
1870#if defined(CONFIG_FILE)
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001871static int get_config(char *fname)
wdenkd0fb80c2003-01-11 09:48:40 +00001872{
1873 FILE *fp;
1874 int i = 0;
1875 int rc;
Alex Kiernan94b233f2018-06-07 12:20:05 +00001876 char *line = NULL;
1877 size_t linesize = 0;
Tom Rini229695f2014-03-28 12:03:33 -04001878 char *devname;
wdenkd0fb80c2003-01-11 09:48:40 +00001879
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001880 fp = fopen(fname, "r");
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001881 if (fp == NULL)
1882 return -1;
wdenkd0fb80c2003-01-11 09:48:40 +00001883
Alex Kiernan94b233f2018-06-07 12:20:05 +00001884 while (i < 2 && getline(&line, &linesize, fp) != -1) {
1885 /* Skip comment strings */
1886 if (line[0] == '#')
wdenkd0fb80c2003-01-11 09:48:40 +00001887 continue;
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001888
Alex Kiernan94b233f2018-06-07 12:20:05 +00001889 rc = sscanf(line, "%ms %lli %lx %lx %lx",
Stefan Agnerf4742ca2016-07-13 17:14:38 -07001890 &devname,
1891 &DEVOFFSET(i),
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001892 &ENVSIZE(i), &DEVESIZE(i), &ENVSECTORS(i));
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001893
Remy Bohmer9eeaa8e2011-02-12 19:06:26 +01001894 if (rc < 3)
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001895 continue;
1896
Tom Rini229695f2014-03-28 12:03:33 -04001897 DEVNAME(i) = devname;
1898
Max Krummenacher333ee162016-11-19 13:58:56 +01001899 /* Set defaults for DEVESIZE, ENVSECTORS later once we
1900 * know DEVTYPE
1901 */
wdenkd0fb80c2003-01-11 09:48:40 +00001902
1903 i++;
1904 }
Alex Kiernan94b233f2018-06-07 12:20:05 +00001905 free(line);
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001906 fclose(fp);
wdenk4a6fd342003-04-12 23:38:12 +00001907
Alex Kiernan2deb3ca2018-03-09 12:13:00 +00001908 have_redund_env = i - 1;
Alex Kiernanc7f52c42018-03-09 12:12:59 +00001909 if (!i) { /* No valid entries found */
wdenkd0fb80c2003-01-11 09:48:40 +00001910 errno = EINVAL;
Guennadi Liakhovetski56086922008-09-04 13:01:49 +02001911 return -1;
wdenkd0fb80c2003-01-11 09:48:40 +00001912 } else
1913 return 0;
1914}
1915#endif