fw_env.c 40 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905
  1. // SPDX-License-Identifier: GPL-2.0+
  2. /*
  3. * (C) Copyright 2000-2010
  4. * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
  5. *
  6. * (C) Copyright 2008
  7. * Guennadi Liakhovetski, DENX Software Engineering, lg@denx.de.
  8. */
  9. #define _GNU_SOURCE
  10. #include <compiler.h>
  11. #include <env.h>
  12. #include <errno.h>
  13. #include <env_flags.h>
  14. #include <fcntl.h>
  15. #include <libgen.h>
  16. #include <linux/fs.h>
  17. #include <linux/stringify.h>
  18. #include <ctype.h>
  19. #include <stdio.h>
  20. #include <stdlib.h>
  21. #include <stddef.h>
  22. #include <string.h>
  23. #include <sys/types.h>
  24. #include <sys/ioctl.h>
  25. #include <sys/stat.h>
  26. #include <u-boot/crc.h>
  27. #include <unistd.h>
  28. #include <dirent.h>
  29. #ifdef MTD_OLD
  30. # include <stdint.h>
  31. # include <linux/mtd/mtd.h>
  32. #else
  33. # define __user /* nothing */
  34. # include <mtd/mtd-user.h>
  35. #endif
  36. #include <mtd/ubi-user.h>
  37. #include "fw_env_private.h"
  38. #include "fw_env.h"
  39. struct env_opts default_opts = {
  40. #ifdef CONFIG_FILE
  41. .config_file = CONFIG_FILE
  42. #endif
  43. };
  44. #define DIV_ROUND_UP(n, d) (((n) + (d) - 1) / (d))
  45. #define min(x, y) ({ \
  46. typeof(x) _min1 = (x); \
  47. typeof(y) _min2 = (y); \
  48. (void) (&_min1 == &_min2); \
  49. _min1 < _min2 ? _min1 : _min2; })
  50. struct envdev_s {
  51. const char *devname; /* Device name */
  52. long long devoff; /* Device offset */
  53. ulong env_size; /* environment size */
  54. ulong erase_size; /* device erase size */
  55. ulong env_sectors; /* number of environment sectors */
  56. uint8_t mtd_type; /* type of the MTD device */
  57. int is_ubi; /* set if we use UBI volume */
  58. };
  59. static struct envdev_s envdevices[2] = {
  60. {
  61. .mtd_type = MTD_ABSENT,
  62. }, {
  63. .mtd_type = MTD_ABSENT,
  64. },
  65. };
  66. static int dev_current;
  67. #define DEVNAME(i) envdevices[(i)].devname
  68. #define DEVOFFSET(i) envdevices[(i)].devoff
  69. #define ENVSIZE(i) envdevices[(i)].env_size
  70. #define DEVESIZE(i) envdevices[(i)].erase_size
  71. #define ENVSECTORS(i) envdevices[(i)].env_sectors
  72. #define DEVTYPE(i) envdevices[(i)].mtd_type
  73. #define IS_UBI(i) envdevices[(i)].is_ubi
  74. #define CUR_ENVSIZE ENVSIZE(dev_current)
  75. static unsigned long usable_envsize;
  76. #define ENV_SIZE usable_envsize
  77. struct env_image_single {
  78. uint32_t crc; /* CRC32 over data bytes */
  79. char data[];
  80. };
  81. struct env_image_redundant {
  82. uint32_t crc; /* CRC32 over data bytes */
  83. unsigned char flags; /* active or obsolete */
  84. char data[];
  85. };
  86. enum flag_scheme {
  87. FLAG_NONE,
  88. FLAG_BOOLEAN,
  89. FLAG_INCREMENTAL,
  90. };
  91. struct environment {
  92. void *image;
  93. uint32_t *crc;
  94. unsigned char *flags;
  95. char *data;
  96. enum flag_scheme flag_scheme;
  97. int dirty;
  98. };
  99. static struct environment environment = {
  100. .flag_scheme = FLAG_NONE,
  101. };
  102. static int have_redund_env;
  103. #define DEFAULT_ENV_INSTANCE_STATIC
  104. #include <env_default.h>
  105. #define UBI_DEV_START "/dev/ubi"
  106. #define UBI_SYSFS "/sys/class/ubi"
  107. #define UBI_VOL_NAME_PATT "ubi%d_%d"
  108. static int is_ubi_devname(const char *devname)
  109. {
  110. return !strncmp(devname, UBI_DEV_START, sizeof(UBI_DEV_START) - 1);
  111. }
  112. static int ubi_check_volume_sysfs_name(const char *volume_sysfs_name,
  113. const char *volname)
  114. {
  115. char path[256];
  116. FILE *file;
  117. char *name;
  118. int ret;
  119. strcpy(path, UBI_SYSFS "/");
  120. strcat(path, volume_sysfs_name);
  121. strcat(path, "/name");
  122. file = fopen(path, "r");
  123. if (!file)
  124. return -1;
  125. ret = fscanf(file, "%ms", &name);
  126. fclose(file);
  127. if (ret <= 0 || !name) {
  128. fprintf(stderr,
  129. "Failed to read from file %s, ret = %d, name = %s\n",
  130. path, ret, name);
  131. return -1;
  132. }
  133. if (!strcmp(name, volname)) {
  134. free(name);
  135. return 0;
  136. }
  137. free(name);
  138. return -1;
  139. }
  140. static int ubi_get_volnum_by_name(int devnum, const char *volname)
  141. {
  142. DIR *sysfs_ubi;
  143. struct dirent *dirent;
  144. int ret;
  145. int tmp_devnum;
  146. int volnum;
  147. sysfs_ubi = opendir(UBI_SYSFS);
  148. if (!sysfs_ubi)
  149. return -1;
  150. #ifdef DEBUG
  151. fprintf(stderr, "Looking for volume name \"%s\"\n", volname);
  152. #endif
  153. while (1) {
  154. dirent = readdir(sysfs_ubi);
  155. if (!dirent)
  156. return -1;
  157. ret = sscanf(dirent->d_name, UBI_VOL_NAME_PATT,
  158. &tmp_devnum, &volnum);
  159. if (ret == 2 && devnum == tmp_devnum) {
  160. if (ubi_check_volume_sysfs_name(dirent->d_name,
  161. volname) == 0) {
  162. closedir(sysfs_ubi);
  163. return volnum;
  164. }
  165. }
  166. }
  167. closedir(sysfs_ubi);
  168. return -1;
  169. }
  170. static int ubi_get_devnum_by_devname(const char *devname)
  171. {
  172. int devnum;
  173. int ret;
  174. ret = sscanf(devname + sizeof(UBI_DEV_START) - 1, "%d", &devnum);
  175. if (ret != 1)
  176. return -1;
  177. return devnum;
  178. }
  179. static const char *ubi_get_volume_devname(const char *devname,
  180. const char *volname)
  181. {
  182. char *volume_devname;
  183. int volnum;
  184. int devnum;
  185. int ret;
  186. devnum = ubi_get_devnum_by_devname(devname);
  187. if (devnum < 0)
  188. return NULL;
  189. volnum = ubi_get_volnum_by_name(devnum, volname);
  190. if (volnum < 0)
  191. return NULL;
  192. ret = asprintf(&volume_devname, "%s_%d", devname, volnum);
  193. if (ret < 0)
  194. return NULL;
  195. #ifdef DEBUG
  196. fprintf(stderr, "Found ubi volume \"%s:%s\" -> %s\n",
  197. devname, volname, volume_devname);
  198. #endif
  199. return volume_devname;
  200. }
  201. static void ubi_check_dev(unsigned int dev_id)
  202. {
  203. char *devname = (char *)DEVNAME(dev_id);
  204. char *pname;
  205. const char *volname = NULL;
  206. const char *volume_devname;
  207. if (!is_ubi_devname(DEVNAME(dev_id)))
  208. return;
  209. IS_UBI(dev_id) = 1;
  210. for (pname = devname; *pname != '\0'; pname++) {
  211. if (*pname == ':') {
  212. *pname = '\0';
  213. volname = pname + 1;
  214. break;
  215. }
  216. }
  217. if (volname) {
  218. /* Let's find real volume device name */
  219. volume_devname = ubi_get_volume_devname(devname, volname);
  220. if (!volume_devname) {
  221. fprintf(stderr, "Didn't found ubi volume \"%s\"\n",
  222. volname);
  223. return;
  224. }
  225. free(devname);
  226. DEVNAME(dev_id) = volume_devname;
  227. }
  228. }
  229. static int ubi_update_start(int fd, int64_t bytes)
  230. {
  231. if (ioctl(fd, UBI_IOCVOLUP, &bytes))
  232. return -1;
  233. return 0;
  234. }
  235. static int ubi_read(int fd, void *buf, size_t count)
  236. {
  237. ssize_t ret;
  238. while (count > 0) {
  239. ret = read(fd, buf, count);
  240. if (ret > 0) {
  241. count -= ret;
  242. buf += ret;
  243. continue;
  244. }
  245. if (ret == 0) {
  246. /*
  247. * Happens in case of too short volume data size. If we
  248. * return error status we will fail it will be treated
  249. * as UBI device error.
  250. *
  251. * Leave catching this error to CRC check.
  252. */
  253. fprintf(stderr, "Warning: end of data on ubi volume\n");
  254. return 0;
  255. } else if (errno == EBADF) {
  256. /*
  257. * Happens in case of corrupted volume. The same as
  258. * above, we cannot return error now, as we will still
  259. * be able to successfully write environment later.
  260. */
  261. fprintf(stderr, "Warning: corrupted volume?\n");
  262. return 0;
  263. } else if (errno == EINTR) {
  264. continue;
  265. }
  266. fprintf(stderr, "Cannot read %u bytes from ubi volume, %s\n",
  267. (unsigned int)count, strerror(errno));
  268. return -1;
  269. }
  270. return 0;
  271. }
  272. static int ubi_write(int fd, const void *buf, size_t count)
  273. {
  274. ssize_t ret;
  275. while (count > 0) {
  276. ret = write(fd, buf, count);
  277. if (ret <= 0) {
  278. if (ret < 0 && errno == EINTR)
  279. continue;
  280. fprintf(stderr, "Cannot write %u bytes to ubi volume\n",
  281. (unsigned int)count);
  282. return -1;
  283. }
  284. count -= ret;
  285. buf += ret;
  286. }
  287. return 0;
  288. }
  289. static int flash_io(int mode, void *buf, size_t count);
  290. static int parse_config(struct env_opts *opts);
  291. #if defined(CONFIG_FILE)
  292. static int get_config(char *);
  293. #endif
  294. static char *skip_chars(char *s)
  295. {
  296. for (; *s != '\0'; s++) {
  297. if (isblank(*s) || *s == '=')
  298. return s;
  299. }
  300. return NULL;
  301. }
  302. static char *skip_blanks(char *s)
  303. {
  304. for (; *s != '\0'; s++) {
  305. if (!isblank(*s))
  306. return s;
  307. }
  308. return NULL;
  309. }
  310. /*
  311. * s1 is either a simple 'name', or a 'name=value' pair.
  312. * s2 is a 'name=value' pair.
  313. * If the names match, return the value of s2, else NULL.
  314. */
  315. static char *envmatch(char *s1, char *s2)
  316. {
  317. if (s1 == NULL || s2 == NULL)
  318. return NULL;
  319. while (*s1 == *s2++)
  320. if (*s1++ == '=')
  321. return s2;
  322. if (*s1 == '\0' && *(s2 - 1) == '=')
  323. return s2;
  324. return NULL;
  325. }
  326. /**
  327. * Search the environment for a variable.
  328. * Return the value, if found, or NULL, if not found.
  329. */
  330. char *fw_getenv(char *name)
  331. {
  332. char *env, *nxt;
  333. for (env = environment.data; *env; env = nxt + 1) {
  334. char *val;
  335. for (nxt = env; *nxt; ++nxt) {
  336. if (nxt >= &environment.data[ENV_SIZE]) {
  337. fprintf(stderr, "## Error: "
  338. "environment not terminated\n");
  339. return NULL;
  340. }
  341. }
  342. val = envmatch(name, env);
  343. if (!val)
  344. continue;
  345. return val;
  346. }
  347. return NULL;
  348. }
  349. /*
  350. * Search the default environment for a variable.
  351. * Return the value, if found, or NULL, if not found.
  352. */
  353. char *fw_getdefenv(char *name)
  354. {
  355. char *env, *nxt;
  356. for (env = default_environment; *env; env = nxt + 1) {
  357. char *val;
  358. for (nxt = env; *nxt; ++nxt) {
  359. if (nxt >= &default_environment[ENV_SIZE]) {
  360. fprintf(stderr, "## Error: "
  361. "default environment not terminated\n");
  362. return NULL;
  363. }
  364. }
  365. val = envmatch(name, env);
  366. if (!val)
  367. continue;
  368. return val;
  369. }
  370. return NULL;
  371. }
  372. /*
  373. * Print the current definition of one, or more, or all
  374. * environment variables
  375. */
  376. int fw_printenv(int argc, char *argv[], int value_only, struct env_opts *opts)
  377. {
  378. int i, rc = 0;
  379. if (value_only && argc != 1) {
  380. fprintf(stderr,
  381. "## Error: `-n'/`--noheader' option requires exactly one argument\n");
  382. return -1;
  383. }
  384. if (!opts)
  385. opts = &default_opts;
  386. if (fw_env_open(opts))
  387. return -1;
  388. if (argc == 0) { /* Print all env variables */
  389. char *env, *nxt;
  390. for (env = environment.data; *env; env = nxt + 1) {
  391. for (nxt = env; *nxt; ++nxt) {
  392. if (nxt >= &environment.data[ENV_SIZE]) {
  393. fprintf(stderr, "## Error: "
  394. "environment not terminated\n");
  395. return -1;
  396. }
  397. }
  398. printf("%s\n", env);
  399. }
  400. fw_env_close(opts);
  401. return 0;
  402. }
  403. for (i = 0; i < argc; ++i) { /* print a subset of env variables */
  404. char *name = argv[i];
  405. char *val = NULL;
  406. val = fw_getenv(name);
  407. if (!val) {
  408. fprintf(stderr, "## Error: \"%s\" not defined\n", name);
  409. rc = -1;
  410. continue;
  411. }
  412. if (value_only) {
  413. puts(val);
  414. break;
  415. }
  416. printf("%s=%s\n", name, val);
  417. }
  418. fw_env_close(opts);
  419. return rc;
  420. }
  421. int fw_env_flush(struct env_opts *opts)
  422. {
  423. if (!opts)
  424. opts = &default_opts;
  425. if (!environment.dirty)
  426. return 0;
  427. /*
  428. * Update CRC
  429. */
  430. *environment.crc = crc32(0, (uint8_t *) environment.data, ENV_SIZE);
  431. /* write environment back to flash */
  432. if (flash_io(O_RDWR, environment.image, CUR_ENVSIZE)) {
  433. fprintf(stderr, "Error: can't write fw_env to flash\n");
  434. return -1;
  435. }
  436. return 0;
  437. }
  438. /*
  439. * Set/Clear a single variable in the environment.
  440. * This is called in sequence to update the environment
  441. * in RAM without updating the copy in flash after each set
  442. */
  443. int fw_env_write(char *name, char *value)
  444. {
  445. int len;
  446. char *env, *nxt;
  447. char *oldval = NULL;
  448. int deleting, creating, overwriting;
  449. /*
  450. * search if variable with this name already exists
  451. */
  452. for (nxt = env = environment.data; *env; env = nxt + 1) {
  453. for (nxt = env; *nxt; ++nxt) {
  454. if (nxt >= &environment.data[ENV_SIZE]) {
  455. fprintf(stderr, "## Error: "
  456. "environment not terminated\n");
  457. errno = EINVAL;
  458. return -1;
  459. }
  460. }
  461. oldval = envmatch(name, env);
  462. if (oldval)
  463. break;
  464. }
  465. deleting = (oldval && !(value && strlen(value)));
  466. creating = (!oldval && (value && strlen(value)));
  467. overwriting = (oldval && (value && strlen(value) &&
  468. strcmp(oldval, value)));
  469. /* check for permission */
  470. if (deleting) {
  471. if (env_flags_validate_varaccess(name,
  472. ENV_FLAGS_VARACCESS_PREVENT_DELETE)) {
  473. printf("Can't delete \"%s\"\n", name);
  474. errno = EROFS;
  475. return -1;
  476. }
  477. } else if (overwriting) {
  478. if (env_flags_validate_varaccess(name,
  479. ENV_FLAGS_VARACCESS_PREVENT_OVERWR)) {
  480. printf("Can't overwrite \"%s\"\n", name);
  481. errno = EROFS;
  482. return -1;
  483. } else if (env_flags_validate_varaccess(name,
  484. ENV_FLAGS_VARACCESS_PREVENT_NONDEF_OVERWR)) {
  485. const char *defval = fw_getdefenv(name);
  486. if (defval == NULL)
  487. defval = "";
  488. if (strcmp(oldval, defval)
  489. != 0) {
  490. printf("Can't overwrite \"%s\"\n", name);
  491. errno = EROFS;
  492. return -1;
  493. }
  494. }
  495. } else if (creating) {
  496. if (env_flags_validate_varaccess(name,
  497. ENV_FLAGS_VARACCESS_PREVENT_CREATE)) {
  498. printf("Can't create \"%s\"\n", name);
  499. errno = EROFS;
  500. return -1;
  501. }
  502. } else
  503. /* Nothing to do */
  504. return 0;
  505. environment.dirty = 1;
  506. if (deleting || overwriting) {
  507. if (*++nxt == '\0') {
  508. *env = '\0';
  509. } else {
  510. for (;;) {
  511. *env = *nxt++;
  512. if ((*env == '\0') && (*nxt == '\0'))
  513. break;
  514. ++env;
  515. }
  516. }
  517. *++env = '\0';
  518. }
  519. /* Delete only ? */
  520. if (!value || !strlen(value))
  521. return 0;
  522. /*
  523. * Append new definition at the end
  524. */
  525. for (env = environment.data; *env || *(env + 1); ++env)
  526. ;
  527. if (env > environment.data)
  528. ++env;
  529. /*
  530. * Overflow when:
  531. * "name" + "=" + "val" +"\0\0" > CUR_ENVSIZE - (env-environment)
  532. */
  533. len = strlen(name) + 2;
  534. /* add '=' for first arg, ' ' for all others */
  535. len += strlen(value) + 1;
  536. if (len > (&environment.data[ENV_SIZE] - env)) {
  537. fprintf(stderr,
  538. "Error: environment overflow, \"%s\" deleted\n", name);
  539. return -1;
  540. }
  541. while ((*env = *name++) != '\0')
  542. env++;
  543. *env = '=';
  544. while ((*++env = *value++) != '\0')
  545. ;
  546. /* end is marked with double '\0' */
  547. *++env = '\0';
  548. return 0;
  549. }
  550. /*
  551. * Deletes or sets environment variables. Returns -1 and sets errno error codes:
  552. * 0 - OK
  553. * EINVAL - need at least 1 argument
  554. * EROFS - certain variables ("ethaddr", "serial#") cannot be
  555. * modified or deleted
  556. *
  557. */
  558. int fw_env_set(int argc, char *argv[], struct env_opts *opts)
  559. {
  560. int i;
  561. size_t len;
  562. char *name, **valv;
  563. char *oldval;
  564. char *value = NULL;
  565. int valc;
  566. int ret;
  567. if (!opts)
  568. opts = &default_opts;
  569. if (argc < 1) {
  570. fprintf(stderr, "## Error: variable name missing\n");
  571. errno = EINVAL;
  572. return -1;
  573. }
  574. if (fw_env_open(opts)) {
  575. fprintf(stderr, "Error: environment not initialized\n");
  576. return -1;
  577. }
  578. name = argv[0];
  579. valv = argv + 1;
  580. valc = argc - 1;
  581. if (env_flags_validate_env_set_params(name, valv, valc) < 0) {
  582. fw_env_close(opts);
  583. return -1;
  584. }
  585. len = 0;
  586. for (i = 0; i < valc; ++i) {
  587. char *val = valv[i];
  588. size_t val_len = strlen(val);
  589. if (value)
  590. value[len - 1] = ' ';
  591. oldval = value;
  592. value = realloc(value, len + val_len + 1);
  593. if (!value) {
  594. fprintf(stderr,
  595. "Cannot malloc %zu bytes: %s\n",
  596. len, strerror(errno));
  597. free(oldval);
  598. return -1;
  599. }
  600. memcpy(value + len, val, val_len);
  601. len += val_len;
  602. value[len++] = '\0';
  603. }
  604. fw_env_write(name, value);
  605. free(value);
  606. ret = fw_env_flush(opts);
  607. fw_env_close(opts);
  608. return ret;
  609. }
  610. /*
  611. * Parse a file and configure the u-boot variables.
  612. * The script file has a very simple format, as follows:
  613. *
  614. * Each line has a couple with name, value:
  615. * <white spaces>variable_name<white spaces>variable_value
  616. *
  617. * Both variable_name and variable_value are interpreted as strings.
  618. * Any character after <white spaces> and before ending \r\n is interpreted
  619. * as variable's value (no comment allowed on these lines !)
  620. *
  621. * Comments are allowed if the first character in the line is #
  622. *
  623. * Returns -1 and sets errno error codes:
  624. * 0 - OK
  625. * -1 - Error
  626. */
  627. int fw_parse_script(char *fname, struct env_opts *opts)
  628. {
  629. FILE *fp;
  630. char *line = NULL;
  631. size_t linesize = 0;
  632. char *name;
  633. char *val;
  634. int lineno = 0;
  635. int len;
  636. int ret = 0;
  637. if (!opts)
  638. opts = &default_opts;
  639. if (fw_env_open(opts)) {
  640. fprintf(stderr, "Error: environment not initialized\n");
  641. return -1;
  642. }
  643. if (strcmp(fname, "-") == 0)
  644. fp = stdin;
  645. else {
  646. fp = fopen(fname, "r");
  647. if (fp == NULL) {
  648. fprintf(stderr, "I cannot open %s for reading\n",
  649. fname);
  650. return -1;
  651. }
  652. }
  653. while ((len = getline(&line, &linesize, fp)) != -1) {
  654. lineno++;
  655. /*
  656. * Read a whole line from the file. If the line is not
  657. * terminated, reports an error and exit.
  658. */
  659. if (line[len - 1] != '\n') {
  660. fprintf(stderr,
  661. "Line %d not correctly terminated\n",
  662. lineno);
  663. ret = -1;
  664. break;
  665. }
  666. /* Drop ending line feed / carriage return */
  667. line[--len] = '\0';
  668. if (len && line[len - 1] == '\r')
  669. line[--len] = '\0';
  670. /* Skip comment or empty lines */
  671. if (len == 0 || line[0] == '#')
  672. continue;
  673. /*
  674. * Search for variable's name remove leading whitespaces
  675. */
  676. name = skip_blanks(line);
  677. if (!name)
  678. continue;
  679. /* The first white space is the end of variable name */
  680. val = skip_chars(name);
  681. len = strlen(name);
  682. if (val) {
  683. *val++ = '\0';
  684. if ((val - name) < len)
  685. val = skip_blanks(val);
  686. else
  687. val = NULL;
  688. }
  689. #ifdef DEBUG
  690. fprintf(stderr, "Setting %s : %s\n",
  691. name, val ? val : " removed");
  692. #endif
  693. if (env_flags_validate_type(name, val) < 0) {
  694. ret = -1;
  695. break;
  696. }
  697. /*
  698. * If there is an error setting a variable,
  699. * try to save the environment and returns an error
  700. */
  701. if (fw_env_write(name, val)) {
  702. fprintf(stderr,
  703. "fw_env_write returns with error : %s\n",
  704. strerror(errno));
  705. ret = -1;
  706. break;
  707. }
  708. }
  709. free(line);
  710. /* Close file if not stdin */
  711. if (strcmp(fname, "-") != 0)
  712. fclose(fp);
  713. ret |= fw_env_flush(opts);
  714. fw_env_close(opts);
  715. return ret;
  716. }
  717. /**
  718. * environment_end() - compute offset of first byte right after environment
  719. * @dev - index of enviroment buffer
  720. * Return:
  721. * device offset of first byte right after environment
  722. */
  723. off_t environment_end(int dev)
  724. {
  725. /* environment is block aligned */
  726. return DEVOFFSET(dev) + ENVSECTORS(dev) * DEVESIZE(dev);
  727. }
  728. /*
  729. * Test for bad block on NAND, just returns 0 on NOR, on NAND:
  730. * 0 - block is good
  731. * > 0 - block is bad
  732. * < 0 - failed to test
  733. */
  734. static int flash_bad_block(int fd, uint8_t mtd_type, loff_t blockstart)
  735. {
  736. if (mtd_type == MTD_NANDFLASH) {
  737. int badblock = ioctl(fd, MEMGETBADBLOCK, &blockstart);
  738. if (badblock < 0) {
  739. perror("Cannot read bad block mark");
  740. return badblock;
  741. }
  742. if (badblock) {
  743. #ifdef DEBUG
  744. fprintf(stderr, "Bad block at 0x%llx, skipping\n",
  745. (unsigned long long)blockstart);
  746. #endif
  747. return badblock;
  748. }
  749. }
  750. return 0;
  751. }
  752. /*
  753. * Read data from flash at an offset into a provided buffer. On NAND it skips
  754. * bad blocks but makes sure it stays within ENVSECTORS (dev) starting from
  755. * the DEVOFFSET (dev) block. On NOR the loop is only run once.
  756. */
  757. static int flash_read_buf(int dev, int fd, void *buf, size_t count,
  758. off_t offset)
  759. {
  760. size_t blocklen; /* erase / write length - one block on NAND,
  761. 0 on NOR */
  762. size_t processed = 0; /* progress counter */
  763. size_t readlen = count; /* current read length */
  764. off_t block_seek; /* offset inside the current block to the start
  765. of the data */
  766. loff_t blockstart; /* running start of the current block -
  767. MEMGETBADBLOCK needs 64 bits */
  768. int rc;
  769. blockstart = (offset / DEVESIZE(dev)) * DEVESIZE(dev);
  770. /* Offset inside a block */
  771. block_seek = offset - blockstart;
  772. if (DEVTYPE(dev) == MTD_NANDFLASH) {
  773. /*
  774. * NAND: calculate which blocks we are reading. We have
  775. * to read one block at a time to skip bad blocks.
  776. */
  777. blocklen = DEVESIZE(dev);
  778. /* Limit to one block for the first read */
  779. if (readlen > blocklen - block_seek)
  780. readlen = blocklen - block_seek;
  781. } else {
  782. blocklen = 0;
  783. }
  784. /* This only runs once on NOR flash */
  785. while (processed < count) {
  786. rc = flash_bad_block(fd, DEVTYPE(dev), blockstart);
  787. if (rc < 0) /* block test failed */
  788. return -1;
  789. if (blockstart + block_seek + readlen > environment_end(dev)) {
  790. /* End of range is reached */
  791. fprintf(stderr, "Too few good blocks within range\n");
  792. return -1;
  793. }
  794. if (rc) { /* block is bad */
  795. blockstart += blocklen;
  796. continue;
  797. }
  798. /*
  799. * If a block is bad, we retry in the next block at the same
  800. * offset - see env/nand.c::writeenv()
  801. */
  802. lseek(fd, blockstart + block_seek, SEEK_SET);
  803. rc = read(fd, buf + processed, readlen);
  804. if (rc == -1) {
  805. fprintf(stderr, "Read error on %s: %s\n",
  806. DEVNAME(dev), strerror(errno));
  807. return -1;
  808. }
  809. #ifdef DEBUG
  810. fprintf(stderr, "Read 0x%x bytes at 0x%llx on %s\n",
  811. rc, (unsigned long long)blockstart + block_seek,
  812. DEVNAME(dev));
  813. #endif
  814. processed += rc;
  815. if (rc != readlen) {
  816. fprintf(stderr,
  817. "Warning on %s: Attempted to read %zd bytes but got %d\n",
  818. DEVNAME(dev), readlen, rc);
  819. readlen -= rc;
  820. block_seek += rc;
  821. } else {
  822. blockstart += blocklen;
  823. readlen = min(blocklen, count - processed);
  824. block_seek = 0;
  825. }
  826. }
  827. return processed;
  828. }
  829. /*
  830. * Write count bytes from begin of environment, but stay within
  831. * ENVSECTORS(dev) sectors of
  832. * DEVOFFSET (dev). Similar to the read case above, on NOR and dataflash we
  833. * erase and write the whole data at once.
  834. */
  835. static int flash_write_buf(int dev, int fd, void *buf, size_t count)
  836. {
  837. void *data;
  838. struct erase_info_user erase;
  839. size_t blocklen; /* length of NAND block / NOR erase sector */
  840. size_t erase_len; /* whole area that can be erased - may include
  841. bad blocks */
  842. size_t erasesize; /* erase / write length - one block on NAND,
  843. whole area on NOR */
  844. size_t processed = 0; /* progress counter */
  845. size_t write_total; /* total size to actually write - excluding
  846. bad blocks */
  847. off_t erase_offset; /* offset to the first erase block (aligned)
  848. below offset */
  849. off_t block_seek; /* offset inside the erase block to the start
  850. of the data */
  851. loff_t blockstart; /* running start of the current block -
  852. MEMGETBADBLOCK needs 64 bits */
  853. int was_locked = 0; /* flash lock flag */
  854. int rc;
  855. /*
  856. * For mtd devices only offset and size of the environment do matter
  857. */
  858. if (DEVTYPE(dev) == MTD_ABSENT) {
  859. blocklen = count;
  860. erase_len = blocklen;
  861. blockstart = DEVOFFSET(dev);
  862. block_seek = 0;
  863. write_total = blocklen;
  864. } else {
  865. blocklen = DEVESIZE(dev);
  866. erase_offset = DEVOFFSET(dev);
  867. /* Maximum area we may use */
  868. erase_len = environment_end(dev) - erase_offset;
  869. blockstart = erase_offset;
  870. /* Offset inside a block */
  871. block_seek = DEVOFFSET(dev) - erase_offset;
  872. /*
  873. * Data size we actually write: from the start of the block
  874. * to the start of the data, then count bytes of data, and
  875. * to the end of the block
  876. */
  877. write_total = ((block_seek + count + blocklen - 1) /
  878. blocklen) * blocklen;
  879. }
  880. /*
  881. * Support data anywhere within erase sectors: read out the complete
  882. * area to be erased, replace the environment image, write the whole
  883. * block back again.
  884. */
  885. if (write_total > count) {
  886. data = malloc(erase_len);
  887. if (!data) {
  888. fprintf(stderr,
  889. "Cannot malloc %zu bytes: %s\n",
  890. erase_len, strerror(errno));
  891. return -1;
  892. }
  893. rc = flash_read_buf(dev, fd, data, write_total, erase_offset);
  894. if (write_total != rc)
  895. return -1;
  896. #ifdef DEBUG
  897. fprintf(stderr, "Preserving data ");
  898. if (block_seek != 0)
  899. fprintf(stderr, "0x%x - 0x%lx", 0, block_seek - 1);
  900. if (block_seek + count != write_total) {
  901. if (block_seek != 0)
  902. fprintf(stderr, " and ");
  903. fprintf(stderr, "0x%lx - 0x%lx",
  904. (unsigned long)block_seek + count,
  905. (unsigned long)write_total - 1);
  906. }
  907. fprintf(stderr, "\n");
  908. #endif
  909. /* Overwrite the old environment */
  910. memcpy(data + block_seek, buf, count);
  911. } else {
  912. /*
  913. * We get here, iff offset is block-aligned and count is a
  914. * multiple of blocklen - see write_total calculation above
  915. */
  916. data = buf;
  917. }
  918. if (DEVTYPE(dev) == MTD_NANDFLASH) {
  919. /*
  920. * NAND: calculate which blocks we are writing. We have
  921. * to write one block at a time to skip bad blocks.
  922. */
  923. erasesize = blocklen;
  924. } else {
  925. erasesize = erase_len;
  926. }
  927. erase.length = erasesize;
  928. /* This only runs once on NOR flash and SPI-dataflash */
  929. while (processed < write_total) {
  930. rc = flash_bad_block(fd, DEVTYPE(dev), blockstart);
  931. if (rc < 0) /* block test failed */
  932. return rc;
  933. if (blockstart + erasesize > environment_end(dev)) {
  934. fprintf(stderr, "End of range reached, aborting\n");
  935. return -1;
  936. }
  937. if (rc) { /* block is bad */
  938. blockstart += blocklen;
  939. continue;
  940. }
  941. if (DEVTYPE(dev) != MTD_ABSENT) {
  942. erase.start = blockstart;
  943. was_locked = ioctl(fd, MEMISLOCKED, &erase);
  944. /* treat any errors as unlocked flash */
  945. if (was_locked < 0)
  946. was_locked = 0;
  947. if (was_locked)
  948. ioctl(fd, MEMUNLOCK, &erase);
  949. /* These do not need an explicit erase cycle */
  950. if (DEVTYPE(dev) != MTD_DATAFLASH)
  951. if (ioctl(fd, MEMERASE, &erase) != 0) {
  952. fprintf(stderr,
  953. "MTD erase error on %s: %s\n",
  954. DEVNAME(dev), strerror(errno));
  955. return -1;
  956. }
  957. }
  958. if (lseek(fd, blockstart, SEEK_SET) == -1) {
  959. fprintf(stderr,
  960. "Seek error on %s: %s\n",
  961. DEVNAME(dev), strerror(errno));
  962. return -1;
  963. }
  964. #ifdef DEBUG
  965. fprintf(stderr, "Write 0x%llx bytes at 0x%llx\n",
  966. (unsigned long long)erasesize,
  967. (unsigned long long)blockstart);
  968. #endif
  969. if (write(fd, data + processed, erasesize) != erasesize) {
  970. fprintf(stderr, "Write error on %s: %s\n",
  971. DEVNAME(dev), strerror(errno));
  972. return -1;
  973. }
  974. if (DEVTYPE(dev) != MTD_ABSENT) {
  975. if (was_locked)
  976. ioctl(fd, MEMLOCK, &erase);
  977. }
  978. processed += erasesize;
  979. block_seek = 0;
  980. blockstart += erasesize;
  981. }
  982. if (write_total > count)
  983. free(data);
  984. return processed;
  985. }
  986. /*
  987. * Set obsolete flag at offset - NOR flash only
  988. */
  989. static int flash_flag_obsolete(int dev, int fd, off_t offset)
  990. {
  991. int rc;
  992. struct erase_info_user erase;
  993. char tmp = ENV_REDUND_OBSOLETE;
  994. int was_locked; /* flash lock flag */
  995. erase.start = DEVOFFSET(dev);
  996. erase.length = DEVESIZE(dev);
  997. /* This relies on the fact, that ENV_REDUND_OBSOLETE == 0 */
  998. rc = lseek(fd, offset, SEEK_SET);
  999. if (rc < 0) {
  1000. fprintf(stderr, "Cannot seek to set the flag on %s\n",
  1001. DEVNAME(dev));
  1002. return rc;
  1003. }
  1004. was_locked = ioctl(fd, MEMISLOCKED, &erase);
  1005. /* treat any errors as unlocked flash */
  1006. if (was_locked < 0)
  1007. was_locked = 0;
  1008. if (was_locked)
  1009. ioctl(fd, MEMUNLOCK, &erase);
  1010. rc = write(fd, &tmp, sizeof(tmp));
  1011. if (was_locked)
  1012. ioctl(fd, MEMLOCK, &erase);
  1013. if (rc < 0)
  1014. perror("Could not set obsolete flag");
  1015. return rc;
  1016. }
  1017. static int flash_write(int fd_current, int fd_target, int dev_target, void *buf,
  1018. size_t count)
  1019. {
  1020. int rc;
  1021. switch (environment.flag_scheme) {
  1022. case FLAG_NONE:
  1023. break;
  1024. case FLAG_INCREMENTAL:
  1025. (*environment.flags)++;
  1026. break;
  1027. case FLAG_BOOLEAN:
  1028. *environment.flags = ENV_REDUND_ACTIVE;
  1029. break;
  1030. default:
  1031. fprintf(stderr, "Unimplemented flash scheme %u\n",
  1032. environment.flag_scheme);
  1033. return -1;
  1034. }
  1035. #ifdef DEBUG
  1036. fprintf(stderr, "Writing new environment at 0x%llx on %s\n",
  1037. DEVOFFSET(dev_target), DEVNAME(dev_target));
  1038. #endif
  1039. if (IS_UBI(dev_target)) {
  1040. if (ubi_update_start(fd_target, CUR_ENVSIZE) < 0)
  1041. return -1;
  1042. return ubi_write(fd_target, buf, count);
  1043. }
  1044. rc = flash_write_buf(dev_target, fd_target, buf, count);
  1045. if (rc < 0)
  1046. return rc;
  1047. if (environment.flag_scheme == FLAG_BOOLEAN) {
  1048. /* Have to set obsolete flag */
  1049. off_t offset = DEVOFFSET(dev_current) +
  1050. offsetof(struct env_image_redundant, flags);
  1051. #ifdef DEBUG
  1052. fprintf(stderr,
  1053. "Setting obsolete flag in environment at 0x%llx on %s\n",
  1054. DEVOFFSET(dev_current), DEVNAME(dev_current));
  1055. #endif
  1056. flash_flag_obsolete(dev_current, fd_current, offset);
  1057. }
  1058. return 0;
  1059. }
  1060. static int flash_read(int fd, void *buf, size_t count)
  1061. {
  1062. int rc;
  1063. if (IS_UBI(dev_current)) {
  1064. DEVTYPE(dev_current) = MTD_ABSENT;
  1065. return ubi_read(fd, buf, count);
  1066. }
  1067. rc = flash_read_buf(dev_current, fd, buf, count,
  1068. DEVOFFSET(dev_current));
  1069. if (rc != CUR_ENVSIZE)
  1070. return -1;
  1071. return 0;
  1072. }
  1073. static int flash_open_tempfile(const char **dname, const char **target_temp)
  1074. {
  1075. char *dup_name = strdup(DEVNAME(dev_current));
  1076. char *temp_name = NULL;
  1077. int rc = -1;
  1078. if (!dup_name)
  1079. return -1;
  1080. *dname = dirname(dup_name);
  1081. if (!*dname)
  1082. goto err;
  1083. rc = asprintf(&temp_name, "%s/XXXXXX", *dname);
  1084. if (rc == -1)
  1085. goto err;
  1086. rc = mkstemp(temp_name);
  1087. if (rc == -1) {
  1088. /* fall back to in place write */
  1089. fprintf(stderr,
  1090. "Can't create %s: %s\n", temp_name, strerror(errno));
  1091. free(temp_name);
  1092. } else {
  1093. *target_temp = temp_name;
  1094. /* deliberately leak dup_name as dname /might/ point into
  1095. * it and we need it for our caller
  1096. */
  1097. dup_name = NULL;
  1098. }
  1099. err:
  1100. if (dup_name)
  1101. free(dup_name);
  1102. return rc;
  1103. }
  1104. static int flash_io_write(int fd_current, void *buf, size_t count)
  1105. {
  1106. int fd_target = -1, rc, dev_target;
  1107. const char *dname, *target_temp = NULL;
  1108. if (have_redund_env) {
  1109. /* switch to next partition for writing */
  1110. dev_target = !dev_current;
  1111. /* dev_target: fd_target, erase_target */
  1112. fd_target = open(DEVNAME(dev_target), O_RDWR);
  1113. if (fd_target < 0) {
  1114. fprintf(stderr,
  1115. "Can't open %s: %s\n",
  1116. DEVNAME(dev_target), strerror(errno));
  1117. rc = -1;
  1118. goto exit;
  1119. }
  1120. } else {
  1121. struct stat sb;
  1122. if (fstat(fd_current, &sb) == 0 && S_ISREG(sb.st_mode)) {
  1123. /* if any part of flash_open_tempfile() fails we fall
  1124. * back to in-place writes
  1125. */
  1126. fd_target = flash_open_tempfile(&dname, &target_temp);
  1127. }
  1128. dev_target = dev_current;
  1129. if (fd_target == -1)
  1130. fd_target = fd_current;
  1131. }
  1132. rc = flash_write(fd_current, fd_target, dev_target, buf, count);
  1133. if (fsync(fd_current) && !(errno == EINVAL || errno == EROFS)) {
  1134. fprintf(stderr,
  1135. "fsync failed on %s: %s\n",
  1136. DEVNAME(dev_current), strerror(errno));
  1137. }
  1138. if (fd_current != fd_target) {
  1139. if (fsync(fd_target) &&
  1140. !(errno == EINVAL || errno == EROFS)) {
  1141. fprintf(stderr,
  1142. "fsync failed on %s: %s\n",
  1143. DEVNAME(dev_current), strerror(errno));
  1144. }
  1145. if (close(fd_target)) {
  1146. fprintf(stderr,
  1147. "I/O error on %s: %s\n",
  1148. DEVNAME(dev_target), strerror(errno));
  1149. rc = -1;
  1150. }
  1151. if (rc >= 0 && target_temp) {
  1152. int dir_fd;
  1153. dir_fd = open(dname, O_DIRECTORY | O_RDONLY);
  1154. if (dir_fd == -1)
  1155. fprintf(stderr,
  1156. "Can't open %s: %s\n",
  1157. dname, strerror(errno));
  1158. if (rename(target_temp, DEVNAME(dev_target))) {
  1159. fprintf(stderr,
  1160. "rename failed %s => %s: %s\n",
  1161. target_temp, DEVNAME(dev_target),
  1162. strerror(errno));
  1163. rc = -1;
  1164. }
  1165. if (dir_fd != -1 && fsync(dir_fd))
  1166. fprintf(stderr,
  1167. "fsync failed on %s: %s\n",
  1168. dname, strerror(errno));
  1169. if (dir_fd != -1 && close(dir_fd))
  1170. fprintf(stderr,
  1171. "I/O error on %s: %s\n",
  1172. dname, strerror(errno));
  1173. }
  1174. }
  1175. exit:
  1176. return rc;
  1177. }
  1178. static int flash_io(int mode, void *buf, size_t count)
  1179. {
  1180. int fd_current, rc;
  1181. /* dev_current: fd_current, erase_current */
  1182. fd_current = open(DEVNAME(dev_current), mode);
  1183. if (fd_current < 0) {
  1184. fprintf(stderr,
  1185. "Can't open %s: %s\n",
  1186. DEVNAME(dev_current), strerror(errno));
  1187. return -1;
  1188. }
  1189. if (mode == O_RDWR) {
  1190. rc = flash_io_write(fd_current, buf, count);
  1191. } else {
  1192. rc = flash_read(fd_current, buf, count);
  1193. }
  1194. if (close(fd_current)) {
  1195. fprintf(stderr,
  1196. "I/O error on %s: %s\n",
  1197. DEVNAME(dev_current), strerror(errno));
  1198. return -1;
  1199. }
  1200. return rc;
  1201. }
  1202. /*
  1203. * Prevent confusion if running from erased flash memory
  1204. */
  1205. int fw_env_open(struct env_opts *opts)
  1206. {
  1207. int crc0, crc0_ok;
  1208. unsigned char flag0;
  1209. void *addr0 = NULL;
  1210. int crc1, crc1_ok;
  1211. unsigned char flag1;
  1212. void *addr1 = NULL;
  1213. int ret;
  1214. if (!opts)
  1215. opts = &default_opts;
  1216. if (parse_config(opts)) /* should fill envdevices */
  1217. return -EINVAL;
  1218. addr0 = calloc(1, CUR_ENVSIZE);
  1219. if (addr0 == NULL) {
  1220. fprintf(stderr,
  1221. "Not enough memory for environment (%ld bytes)\n",
  1222. CUR_ENVSIZE);
  1223. ret = -ENOMEM;
  1224. goto open_cleanup;
  1225. }
  1226. dev_current = 0;
  1227. if (flash_io(O_RDONLY, addr0, CUR_ENVSIZE)) {
  1228. ret = -EIO;
  1229. goto open_cleanup;
  1230. }
  1231. if (!have_redund_env) {
  1232. struct env_image_single *single = addr0;
  1233. crc0 = crc32(0, (uint8_t *)single->data, ENV_SIZE);
  1234. crc0_ok = (crc0 == single->crc);
  1235. if (!crc0_ok) {
  1236. fprintf(stderr,
  1237. "Warning: Bad CRC, using default environment\n");
  1238. memcpy(single->data, default_environment,
  1239. sizeof(default_environment));
  1240. environment.dirty = 1;
  1241. }
  1242. environment.image = addr0;
  1243. environment.crc = &single->crc;
  1244. environment.flags = NULL;
  1245. environment.data = single->data;
  1246. } else {
  1247. struct env_image_redundant *redundant0 = addr0;
  1248. struct env_image_redundant *redundant1;
  1249. crc0 = crc32(0, (uint8_t *)redundant0->data, ENV_SIZE);
  1250. crc0_ok = (crc0 == redundant0->crc);
  1251. flag0 = redundant0->flags;
  1252. dev_current = 1;
  1253. addr1 = calloc(1, CUR_ENVSIZE);
  1254. if (addr1 == NULL) {
  1255. fprintf(stderr,
  1256. "Not enough memory for environment (%ld bytes)\n",
  1257. CUR_ENVSIZE);
  1258. ret = -ENOMEM;
  1259. goto open_cleanup;
  1260. }
  1261. redundant1 = addr1;
  1262. if (flash_io(O_RDONLY, addr1, CUR_ENVSIZE)) {
  1263. ret = -EIO;
  1264. goto open_cleanup;
  1265. }
  1266. /* Check flag scheme compatibility */
  1267. if (DEVTYPE(dev_current) == MTD_NORFLASH &&
  1268. DEVTYPE(!dev_current) == MTD_NORFLASH) {
  1269. environment.flag_scheme = FLAG_BOOLEAN;
  1270. } else if (DEVTYPE(dev_current) == MTD_NANDFLASH &&
  1271. DEVTYPE(!dev_current) == MTD_NANDFLASH) {
  1272. environment.flag_scheme = FLAG_INCREMENTAL;
  1273. } else if (DEVTYPE(dev_current) == MTD_DATAFLASH &&
  1274. DEVTYPE(!dev_current) == MTD_DATAFLASH) {
  1275. environment.flag_scheme = FLAG_BOOLEAN;
  1276. } else if (DEVTYPE(dev_current) == MTD_UBIVOLUME &&
  1277. DEVTYPE(!dev_current) == MTD_UBIVOLUME) {
  1278. environment.flag_scheme = FLAG_INCREMENTAL;
  1279. } else if (DEVTYPE(dev_current) == MTD_ABSENT &&
  1280. DEVTYPE(!dev_current) == MTD_ABSENT &&
  1281. IS_UBI(dev_current) == IS_UBI(!dev_current)) {
  1282. environment.flag_scheme = FLAG_INCREMENTAL;
  1283. } else {
  1284. fprintf(stderr, "Incompatible flash types!\n");
  1285. ret = -EINVAL;
  1286. goto open_cleanup;
  1287. }
  1288. crc1 = crc32(0, (uint8_t *)redundant1->data, ENV_SIZE);
  1289. crc1_ok = (crc1 == redundant1->crc);
  1290. flag1 = redundant1->flags;
  1291. if (memcmp(redundant0->data, redundant1->data, ENV_SIZE) ||
  1292. !crc0_ok || !crc1_ok)
  1293. environment.dirty = 1;
  1294. if (crc0_ok && !crc1_ok) {
  1295. dev_current = 0;
  1296. } else if (!crc0_ok && crc1_ok) {
  1297. dev_current = 1;
  1298. } else if (!crc0_ok && !crc1_ok) {
  1299. fprintf(stderr,
  1300. "Warning: Bad CRC, using default environment\n");
  1301. memcpy(redundant0->data, default_environment,
  1302. sizeof(default_environment));
  1303. environment.dirty = 1;
  1304. dev_current = 0;
  1305. } else {
  1306. switch (environment.flag_scheme) {
  1307. case FLAG_BOOLEAN:
  1308. if (flag0 == ENV_REDUND_ACTIVE &&
  1309. flag1 == ENV_REDUND_OBSOLETE) {
  1310. dev_current = 0;
  1311. } else if (flag0 == ENV_REDUND_OBSOLETE &&
  1312. flag1 == ENV_REDUND_ACTIVE) {
  1313. dev_current = 1;
  1314. } else if (flag0 == flag1) {
  1315. dev_current = 0;
  1316. } else if (flag0 == 0xFF) {
  1317. dev_current = 0;
  1318. } else if (flag1 == 0xFF) {
  1319. dev_current = 1;
  1320. } else {
  1321. dev_current = 0;
  1322. }
  1323. break;
  1324. case FLAG_INCREMENTAL:
  1325. if (flag0 == 255 && flag1 == 0)
  1326. dev_current = 1;
  1327. else if ((flag1 == 255 && flag0 == 0) ||
  1328. flag0 >= flag1)
  1329. dev_current = 0;
  1330. else /* flag1 > flag0 */
  1331. dev_current = 1;
  1332. break;
  1333. default:
  1334. fprintf(stderr, "Unknown flag scheme %u\n",
  1335. environment.flag_scheme);
  1336. return -1;
  1337. }
  1338. }
  1339. /*
  1340. * If we are reading, we don't need the flag and the CRC any
  1341. * more, if we are writing, we will re-calculate CRC and update
  1342. * flags before writing out
  1343. */
  1344. if (dev_current) {
  1345. environment.image = addr1;
  1346. environment.crc = &redundant1->crc;
  1347. environment.flags = &redundant1->flags;
  1348. environment.data = redundant1->data;
  1349. free(addr0);
  1350. } else {
  1351. environment.image = addr0;
  1352. environment.crc = &redundant0->crc;
  1353. environment.flags = &redundant0->flags;
  1354. environment.data = redundant0->data;
  1355. free(addr1);
  1356. }
  1357. #ifdef DEBUG
  1358. fprintf(stderr, "Selected env in %s\n", DEVNAME(dev_current));
  1359. #endif
  1360. }
  1361. return 0;
  1362. open_cleanup:
  1363. if (addr0)
  1364. free(addr0);
  1365. if (addr1)
  1366. free(addr1);
  1367. return ret;
  1368. }
  1369. /*
  1370. * Simply free allocated buffer with environment
  1371. */
  1372. int fw_env_close(struct env_opts *opts)
  1373. {
  1374. if (environment.image)
  1375. free(environment.image);
  1376. environment.image = NULL;
  1377. return 0;
  1378. }
  1379. static int check_device_config(int dev)
  1380. {
  1381. struct stat st;
  1382. int32_t lnum = 0;
  1383. int fd, rc = 0;
  1384. /* Fills in IS_UBI(), converts DEVNAME() with ubi volume name */
  1385. ubi_check_dev(dev);
  1386. fd = open(DEVNAME(dev), O_RDONLY);
  1387. if (fd < 0) {
  1388. fprintf(stderr,
  1389. "Cannot open %s: %s\n", DEVNAME(dev), strerror(errno));
  1390. return -1;
  1391. }
  1392. rc = fstat(fd, &st);
  1393. if (rc < 0) {
  1394. fprintf(stderr, "Cannot stat the file %s\n", DEVNAME(dev));
  1395. goto err;
  1396. }
  1397. if (IS_UBI(dev)) {
  1398. rc = ioctl(fd, UBI_IOCEBISMAP, &lnum);
  1399. if (rc < 0) {
  1400. fprintf(stderr, "Cannot get UBI information for %s\n",
  1401. DEVNAME(dev));
  1402. goto err;
  1403. }
  1404. } else if (S_ISCHR(st.st_mode)) {
  1405. struct mtd_info_user mtdinfo;
  1406. rc = ioctl(fd, MEMGETINFO, &mtdinfo);
  1407. if (rc < 0) {
  1408. fprintf(stderr, "Cannot get MTD information for %s\n",
  1409. DEVNAME(dev));
  1410. goto err;
  1411. }
  1412. if (mtdinfo.type != MTD_NORFLASH &&
  1413. mtdinfo.type != MTD_NANDFLASH &&
  1414. mtdinfo.type != MTD_DATAFLASH &&
  1415. mtdinfo.type != MTD_UBIVOLUME) {
  1416. fprintf(stderr, "Unsupported flash type %u on %s\n",
  1417. mtdinfo.type, DEVNAME(dev));
  1418. goto err;
  1419. }
  1420. DEVTYPE(dev) = mtdinfo.type;
  1421. if (DEVESIZE(dev) == 0 && ENVSECTORS(dev) == 0 &&
  1422. mtdinfo.type == MTD_NORFLASH)
  1423. DEVESIZE(dev) = mtdinfo.erasesize;
  1424. if (DEVESIZE(dev) == 0)
  1425. /* Assume the erase size is the same as the env-size */
  1426. DEVESIZE(dev) = ENVSIZE(dev);
  1427. } else {
  1428. uint64_t size;
  1429. DEVTYPE(dev) = MTD_ABSENT;
  1430. if (DEVESIZE(dev) == 0)
  1431. /* Assume the erase size to be 512 bytes */
  1432. DEVESIZE(dev) = 0x200;
  1433. /*
  1434. * Check for negative offsets, treat it as backwards offset
  1435. * from the end of the block device
  1436. */
  1437. if (DEVOFFSET(dev) < 0) {
  1438. rc = ioctl(fd, BLKGETSIZE64, &size);
  1439. if (rc < 0) {
  1440. fprintf(stderr,
  1441. "Could not get block device size on %s\n",
  1442. DEVNAME(dev));
  1443. goto err;
  1444. }
  1445. DEVOFFSET(dev) = DEVOFFSET(dev) + size;
  1446. #ifdef DEBUG
  1447. fprintf(stderr,
  1448. "Calculated device offset 0x%llx on %s\n",
  1449. DEVOFFSET(dev), DEVNAME(dev));
  1450. #endif
  1451. }
  1452. }
  1453. if (ENVSECTORS(dev) == 0)
  1454. /* Assume enough sectors to cover the environment */
  1455. ENVSECTORS(dev) = DIV_ROUND_UP(ENVSIZE(dev), DEVESIZE(dev));
  1456. if (DEVOFFSET(dev) % DEVESIZE(dev) != 0) {
  1457. fprintf(stderr,
  1458. "Environment does not start on (erase) block boundary\n");
  1459. errno = EINVAL;
  1460. return -1;
  1461. }
  1462. if (ENVSIZE(dev) > ENVSECTORS(dev) * DEVESIZE(dev)) {
  1463. fprintf(stderr,
  1464. "Environment does not fit into available sectors\n");
  1465. errno = EINVAL;
  1466. return -1;
  1467. }
  1468. err:
  1469. close(fd);
  1470. return rc;
  1471. }
  1472. static int find_nvmem_device(void)
  1473. {
  1474. const char *path = "/sys/bus/nvmem/devices";
  1475. struct dirent *dent;
  1476. char *nvmem = NULL;
  1477. char comp[256];
  1478. char buf[32];
  1479. int bytes;
  1480. DIR *dir;
  1481. dir = opendir(path);
  1482. if (!dir) {
  1483. return -EIO;
  1484. }
  1485. while (!nvmem && (dent = readdir(dir))) {
  1486. FILE *fp;
  1487. size_t size;
  1488. if (!strcmp(dent->d_name, ".") || !strcmp(dent->d_name, "..")) {
  1489. continue;
  1490. }
  1491. bytes = snprintf(comp, sizeof(comp), "%s/%s/of_node/compatible", path, dent->d_name);
  1492. if (bytes < 0 || bytes == sizeof(comp)) {
  1493. continue;
  1494. }
  1495. fp = fopen(comp, "r");
  1496. if (!fp) {
  1497. continue;
  1498. }
  1499. size = fread(buf, sizeof(buf), 1, fp);
  1500. if (size != 1) {
  1501. fprintf(stderr,
  1502. "read failed about %s\n", comp);
  1503. fclose(fp);
  1504. return -EIO;
  1505. }
  1506. if (!strcmp(buf, "u-boot,env")) {
  1507. bytes = asprintf(&nvmem, "%s/%s/nvmem", path, dent->d_name);
  1508. if (bytes < 0) {
  1509. nvmem = NULL;
  1510. }
  1511. }
  1512. fclose(fp);
  1513. }
  1514. closedir(dir);
  1515. if (nvmem) {
  1516. struct stat s;
  1517. stat(nvmem, &s);
  1518. DEVNAME(0) = nvmem;
  1519. DEVOFFSET(0) = 0;
  1520. ENVSIZE(0) = s.st_size;
  1521. return 0;
  1522. }
  1523. return -ENOENT;
  1524. }
  1525. static int parse_config(struct env_opts *opts)
  1526. {
  1527. int rc;
  1528. if (!opts)
  1529. opts = &default_opts;
  1530. #if defined(CONFIG_FILE)
  1531. /* Fills in DEVNAME(), ENVSIZE(), DEVESIZE(). Or don't. */
  1532. if (get_config(opts->config_file)) {
  1533. if (find_nvmem_device()) {
  1534. fprintf(stderr, "Cannot parse config file '%s': %m\n",
  1535. opts->config_file);
  1536. fprintf(stderr, "Failed to find NVMEM device\n");
  1537. return -1;
  1538. }
  1539. }
  1540. #else
  1541. DEVNAME(0) = DEVICE1_NAME;
  1542. DEVOFFSET(0) = DEVICE1_OFFSET;
  1543. ENVSIZE(0) = ENV1_SIZE;
  1544. /* Set defaults for DEVESIZE, ENVSECTORS later once we
  1545. * know DEVTYPE
  1546. */
  1547. #ifdef DEVICE1_ESIZE
  1548. DEVESIZE(0) = DEVICE1_ESIZE;
  1549. #endif
  1550. #ifdef DEVICE1_ENVSECTORS
  1551. ENVSECTORS(0) = DEVICE1_ENVSECTORS;
  1552. #endif
  1553. #ifdef HAVE_REDUND
  1554. DEVNAME(1) = DEVICE2_NAME;
  1555. DEVOFFSET(1) = DEVICE2_OFFSET;
  1556. ENVSIZE(1) = ENV2_SIZE;
  1557. /* Set defaults for DEVESIZE, ENVSECTORS later once we
  1558. * know DEVTYPE
  1559. */
  1560. #ifdef DEVICE2_ESIZE
  1561. DEVESIZE(1) = DEVICE2_ESIZE;
  1562. #endif
  1563. #ifdef DEVICE2_ENVSECTORS
  1564. ENVSECTORS(1) = DEVICE2_ENVSECTORS;
  1565. #endif
  1566. have_redund_env = 1;
  1567. #endif
  1568. #endif
  1569. rc = check_device_config(0);
  1570. if (rc < 0)
  1571. return rc;
  1572. if (have_redund_env) {
  1573. rc = check_device_config(1);
  1574. if (rc < 0)
  1575. return rc;
  1576. if (ENVSIZE(0) != ENVSIZE(1)) {
  1577. fprintf(stderr,
  1578. "Redundant environments have unequal size\n");
  1579. return -1;
  1580. }
  1581. }
  1582. usable_envsize = CUR_ENVSIZE - sizeof(uint32_t);
  1583. if (have_redund_env)
  1584. usable_envsize -= sizeof(char);
  1585. return 0;
  1586. }
  1587. #if defined(CONFIG_FILE)
  1588. static int get_config(char *fname)
  1589. {
  1590. FILE *fp;
  1591. int i = 0;
  1592. int rc;
  1593. char *line = NULL;
  1594. size_t linesize = 0;
  1595. char *devname;
  1596. fp = fopen(fname, "r");
  1597. if (fp == NULL)
  1598. return -1;
  1599. while (i < 2 && getline(&line, &linesize, fp) != -1) {
  1600. /* Skip comment strings */
  1601. if (line[0] == '#')
  1602. continue;
  1603. rc = sscanf(line, "%ms %lli %lx %lx %lx",
  1604. &devname,
  1605. &DEVOFFSET(i),
  1606. &ENVSIZE(i), &DEVESIZE(i), &ENVSECTORS(i));
  1607. if (rc < 3)
  1608. continue;
  1609. DEVNAME(i) = devname;
  1610. /* Set defaults for DEVESIZE, ENVSECTORS later once we
  1611. * know DEVTYPE
  1612. */
  1613. i++;
  1614. }
  1615. free(line);
  1616. fclose(fp);
  1617. have_redund_env = i - 1;
  1618. if (!i) { /* No valid entries found */
  1619. errno = EINVAL;
  1620. return -1;
  1621. } else
  1622. return 0;
  1623. }
  1624. #endif