fw_env.c 30 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336
  1. /*
  2. * (C) Copyright 2000-2010
  3. * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
  4. *
  5. * (C) Copyright 2008
  6. * Guennadi Liakhovetski, DENX Software Engineering, lg@denx.de.
  7. *
  8. * See file CREDITS for list of people who contributed to this
  9. * project.
  10. *
  11. * This program is free software; you can redistribute it and/or
  12. * modify it under the terms of the GNU General Public License as
  13. * published by the Free Software Foundation; either version 2 of
  14. * the License, or (at your option) any later version.
  15. *
  16. * This program is distributed in the hope that it will be useful,
  17. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  19. * GNU General Public License for more details.
  20. *
  21. * You should have received a copy of the GNU General Public License
  22. * along with this program; if not, write to the Free Software
  23. * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  24. * MA 02111-1307 USA
  25. */
  26. #include <errno.h>
  27. #include <fcntl.h>
  28. #include <stdio.h>
  29. #include <stdlib.h>
  30. #include <stddef.h>
  31. #include <string.h>
  32. #include <sys/types.h>
  33. #include <sys/ioctl.h>
  34. #include <sys/stat.h>
  35. #include <unistd.h>
  36. #ifdef MTD_OLD
  37. # include <stdint.h>
  38. # include <linux/mtd/mtd.h>
  39. #else
  40. # define __user /* nothing */
  41. # include <mtd/mtd-user.h>
  42. #endif
  43. #include "fw_env.h"
  44. #include <config.h>
  45. #define WHITESPACE(c) ((c == '\t') || (c == ' '))
  46. #define min(x, y) ({ \
  47. typeof(x) _min1 = (x); \
  48. typeof(y) _min2 = (y); \
  49. (void) (&_min1 == &_min2); \
  50. _min1 < _min2 ? _min1 : _min2; })
  51. struct envdev_s {
  52. char devname[16]; /* Device name */
  53. ulong devoff; /* Device offset */
  54. ulong env_size; /* environment size */
  55. ulong erase_size; /* device erase size */
  56. ulong env_sectors; /* number of environment sectors */
  57. uint8_t mtd_type; /* type of the MTD device */
  58. };
  59. static struct envdev_s envdevices[2] =
  60. {
  61. {
  62. .mtd_type = MTD_ABSENT,
  63. }, {
  64. .mtd_type = MTD_ABSENT,
  65. },
  66. };
  67. static int dev_current;
  68. #define DEVNAME(i) envdevices[(i)].devname
  69. #define DEVOFFSET(i) envdevices[(i)].devoff
  70. #define ENVSIZE(i) envdevices[(i)].env_size
  71. #define DEVESIZE(i) envdevices[(i)].erase_size
  72. #define ENVSECTORS(i) envdevices[(i)].env_sectors
  73. #define DEVTYPE(i) envdevices[(i)].mtd_type
  74. #define CONFIG_ENV_SIZE ENVSIZE(dev_current)
  75. #define ENV_SIZE getenvsize()
  76. struct env_image_single {
  77. uint32_t crc; /* CRC32 over data bytes */
  78. char data[];
  79. };
  80. struct env_image_redundant {
  81. uint32_t crc; /* CRC32 over data bytes */
  82. unsigned char flags; /* active or obsolete */
  83. char data[];
  84. };
  85. enum flag_scheme {
  86. FLAG_NONE,
  87. FLAG_BOOLEAN,
  88. FLAG_INCREMENTAL,
  89. };
  90. struct environment {
  91. void *image;
  92. uint32_t *crc;
  93. unsigned char *flags;
  94. char *data;
  95. enum flag_scheme flag_scheme;
  96. };
  97. static struct environment environment = {
  98. .flag_scheme = FLAG_NONE,
  99. };
  100. static int HaveRedundEnv = 0;
  101. static unsigned char active_flag = 1;
  102. /* obsolete_flag must be 0 to efficiently set it on NOR flash without erasing */
  103. static unsigned char obsolete_flag = 0;
  104. #define XMK_STR(x) #x
  105. #define MK_STR(x) XMK_STR(x)
  106. static char default_environment[] = {
  107. #if defined(CONFIG_BOOTARGS)
  108. "bootargs=" CONFIG_BOOTARGS "\0"
  109. #endif
  110. #if defined(CONFIG_BOOTCOMMAND)
  111. "bootcmd=" CONFIG_BOOTCOMMAND "\0"
  112. #endif
  113. #if defined(CONFIG_RAMBOOTCOMMAND)
  114. "ramboot=" CONFIG_RAMBOOTCOMMAND "\0"
  115. #endif
  116. #if defined(CONFIG_NFSBOOTCOMMAND)
  117. "nfsboot=" CONFIG_NFSBOOTCOMMAND "\0"
  118. #endif
  119. #if defined(CONFIG_BOOTDELAY) && (CONFIG_BOOTDELAY >= 0)
  120. "bootdelay=" MK_STR (CONFIG_BOOTDELAY) "\0"
  121. #endif
  122. #if defined(CONFIG_BAUDRATE) && (CONFIG_BAUDRATE >= 0)
  123. "baudrate=" MK_STR (CONFIG_BAUDRATE) "\0"
  124. #endif
  125. #ifdef CONFIG_LOADS_ECHO
  126. "loads_echo=" MK_STR (CONFIG_LOADS_ECHO) "\0"
  127. #endif
  128. #ifdef CONFIG_ETHADDR
  129. "ethaddr=" MK_STR (CONFIG_ETHADDR) "\0"
  130. #endif
  131. #ifdef CONFIG_ETH1ADDR
  132. "eth1addr=" MK_STR (CONFIG_ETH1ADDR) "\0"
  133. #endif
  134. #ifdef CONFIG_ETH2ADDR
  135. "eth2addr=" MK_STR (CONFIG_ETH2ADDR) "\0"
  136. #endif
  137. #ifdef CONFIG_ETH3ADDR
  138. "eth3addr=" MK_STR (CONFIG_ETH3ADDR) "\0"
  139. #endif
  140. #ifdef CONFIG_ETH4ADDR
  141. "eth4addr=" MK_STR (CONFIG_ETH4ADDR) "\0"
  142. #endif
  143. #ifdef CONFIG_ETH5ADDR
  144. "eth5addr=" MK_STR (CONFIG_ETH5ADDR) "\0"
  145. #endif
  146. #ifdef CONFIG_ETHPRIME
  147. "ethprime=" CONFIG_ETHPRIME "\0"
  148. #endif
  149. #ifdef CONFIG_IPADDR
  150. "ipaddr=" MK_STR (CONFIG_IPADDR) "\0"
  151. #endif
  152. #ifdef CONFIG_SERVERIP
  153. "serverip=" MK_STR (CONFIG_SERVERIP) "\0"
  154. #endif
  155. #ifdef CONFIG_SYS_AUTOLOAD
  156. "autoload=" CONFIG_SYS_AUTOLOAD "\0"
  157. #endif
  158. #ifdef CONFIG_ROOTPATH
  159. "rootpath=" CONFIG_ROOTPATH "\0"
  160. #endif
  161. #ifdef CONFIG_GATEWAYIP
  162. "gatewayip=" MK_STR (CONFIG_GATEWAYIP) "\0"
  163. #endif
  164. #ifdef CONFIG_NETMASK
  165. "netmask=" MK_STR (CONFIG_NETMASK) "\0"
  166. #endif
  167. #ifdef CONFIG_HOSTNAME
  168. "hostname=" MK_STR (CONFIG_HOSTNAME) "\0"
  169. #endif
  170. #ifdef CONFIG_BOOTFILE
  171. "bootfile=" CONFIG_BOOTFILE "\0"
  172. #endif
  173. #ifdef CONFIG_LOADADDR
  174. "loadaddr=" MK_STR (CONFIG_LOADADDR) "\0"
  175. #endif
  176. #ifdef CONFIG_PREBOOT
  177. "preboot=" CONFIG_PREBOOT "\0"
  178. #endif
  179. #ifdef CONFIG_CLOCKS_IN_MHZ
  180. "clocks_in_mhz=" "1" "\0"
  181. #endif
  182. #if defined(CONFIG_PCI_BOOTDELAY) && (CONFIG_PCI_BOOTDELAY > 0)
  183. "pcidelay=" MK_STR (CONFIG_PCI_BOOTDELAY) "\0"
  184. #endif
  185. #ifdef CONFIG_EXTRA_ENV_SETTINGS
  186. CONFIG_EXTRA_ENV_SETTINGS
  187. #endif
  188. "\0" /* Termimate struct environment data with 2 NULs */
  189. };
  190. static int flash_io (int mode);
  191. static char *envmatch (char * s1, char * s2);
  192. static int parse_config (void);
  193. #if defined(CONFIG_FILE)
  194. static int get_config (char *);
  195. #endif
  196. static inline ulong getenvsize (void)
  197. {
  198. ulong rc = CONFIG_ENV_SIZE - sizeof (long);
  199. if (HaveRedundEnv)
  200. rc -= sizeof (char);
  201. return rc;
  202. }
  203. static char *fw_string_blank(char *s, int noblank)
  204. {
  205. int i;
  206. int len = strlen(s);
  207. for (i = 0; i < len; i++, s++) {
  208. if ((noblank && !WHITESPACE(*s)) ||
  209. (!noblank && WHITESPACE(*s)))
  210. break;
  211. }
  212. if (i == len)
  213. return NULL;
  214. return s;
  215. }
  216. /*
  217. * Search the environment for a variable.
  218. * Return the value, if found, or NULL, if not found.
  219. */
  220. char *fw_getenv (char *name)
  221. {
  222. char *env, *nxt;
  223. if (fw_env_open())
  224. return NULL;
  225. for (env = environment.data; *env; env = nxt + 1) {
  226. char *val;
  227. for (nxt = env; *nxt; ++nxt) {
  228. if (nxt >= &environment.data[ENV_SIZE]) {
  229. fprintf (stderr, "## Error: "
  230. "environment not terminated\n");
  231. return NULL;
  232. }
  233. }
  234. val = envmatch (name, env);
  235. if (!val)
  236. continue;
  237. return val;
  238. }
  239. return NULL;
  240. }
  241. /*
  242. * Print the current definition of one, or more, or all
  243. * environment variables
  244. */
  245. int fw_printenv (int argc, char *argv[])
  246. {
  247. char *env, *nxt;
  248. int i, n_flag;
  249. int rc = 0;
  250. if (fw_env_open())
  251. return -1;
  252. if (argc == 1) { /* Print all env variables */
  253. for (env = environment.data; *env; env = nxt + 1) {
  254. for (nxt = env; *nxt; ++nxt) {
  255. if (nxt >= &environment.data[ENV_SIZE]) {
  256. fprintf (stderr, "## Error: "
  257. "environment not terminated\n");
  258. return -1;
  259. }
  260. }
  261. printf ("%s\n", env);
  262. }
  263. return 0;
  264. }
  265. if (strcmp (argv[1], "-n") == 0) {
  266. n_flag = 1;
  267. ++argv;
  268. --argc;
  269. if (argc != 2) {
  270. fprintf (stderr, "## Error: "
  271. "`-n' option requires exactly one argument\n");
  272. return -1;
  273. }
  274. } else {
  275. n_flag = 0;
  276. }
  277. for (i = 1; i < argc; ++i) { /* print single env variables */
  278. char *name = argv[i];
  279. char *val = NULL;
  280. for (env = environment.data; *env; env = nxt + 1) {
  281. for (nxt = env; *nxt; ++nxt) {
  282. if (nxt >= &environment.data[ENV_SIZE]) {
  283. fprintf (stderr, "## Error: "
  284. "environment not terminated\n");
  285. return -1;
  286. }
  287. }
  288. val = envmatch (name, env);
  289. if (val) {
  290. if (!n_flag) {
  291. fputs (name, stdout);
  292. putc ('=', stdout);
  293. }
  294. puts (val);
  295. break;
  296. }
  297. }
  298. if (!val) {
  299. fprintf (stderr, "## Error: \"%s\" not defined\n", name);
  300. rc = -1;
  301. }
  302. }
  303. return rc;
  304. }
  305. int fw_env_close(void)
  306. {
  307. /*
  308. * Update CRC
  309. */
  310. *environment.crc = crc32(0, (uint8_t *) environment.data, ENV_SIZE);
  311. /* write environment back to flash */
  312. if (flash_io(O_RDWR)) {
  313. fprintf(stderr,
  314. "Error: can't write fw_env to flash\n");
  315. return -1;
  316. }
  317. return 0;
  318. }
  319. /*
  320. * Set/Clear a single variable in the environment.
  321. * This is called in sequence to update the environment
  322. * in RAM without updating the copy in flash after each set
  323. */
  324. int fw_env_write(char *name, char *value)
  325. {
  326. int len;
  327. char *env, *nxt;
  328. char *oldval = NULL;
  329. /*
  330. * search if variable with this name already exists
  331. */
  332. for (nxt = env = environment.data; *env; env = nxt + 1) {
  333. for (nxt = env; *nxt; ++nxt) {
  334. if (nxt >= &environment.data[ENV_SIZE]) {
  335. fprintf(stderr, "## Error: "
  336. "environment not terminated\n");
  337. errno = EINVAL;
  338. return -1;
  339. }
  340. }
  341. if ((oldval = envmatch (name, env)) != NULL)
  342. break;
  343. }
  344. /*
  345. * Delete any existing definition
  346. */
  347. if (oldval) {
  348. #ifndef CONFIG_ENV_OVERWRITE
  349. /*
  350. * Ethernet Address and serial# can be set only once
  351. */
  352. if (
  353. (strcmp(name, "serial#") == 0) ||
  354. ((strcmp(name, "ethaddr") == 0)
  355. #if defined(CONFIG_OVERWRITE_ETHADDR_ONCE) && defined(CONFIG_ETHADDR)
  356. && (strcmp(oldval, MK_STR(CONFIG_ETHADDR)) != 0)
  357. #endif /* CONFIG_OVERWRITE_ETHADDR_ONCE && CONFIG_ETHADDR */
  358. ) ) {
  359. fprintf (stderr, "Can't overwrite \"%s\"\n", name);
  360. errno = EROFS;
  361. return -1;
  362. }
  363. #endif /* CONFIG_ENV_OVERWRITE */
  364. if (*++nxt == '\0') {
  365. *env = '\0';
  366. } else {
  367. for (;;) {
  368. *env = *nxt++;
  369. if ((*env == '\0') && (*nxt == '\0'))
  370. break;
  371. ++env;
  372. }
  373. }
  374. *++env = '\0';
  375. }
  376. /* Delete only ? */
  377. if (!value || !strlen(value))
  378. return 0;
  379. /*
  380. * Append new definition at the end
  381. */
  382. for (env = environment.data; *env || *(env + 1); ++env);
  383. if (env > environment.data)
  384. ++env;
  385. /*
  386. * Overflow when:
  387. * "name" + "=" + "val" +"\0\0" > CONFIG_ENV_SIZE - (env-environment)
  388. */
  389. len = strlen (name) + 2;
  390. /* add '=' for first arg, ' ' for all others */
  391. len += strlen(value) + 1;
  392. if (len > (&environment.data[ENV_SIZE] - env)) {
  393. fprintf (stderr,
  394. "Error: environment overflow, \"%s\" deleted\n",
  395. name);
  396. return -1;
  397. }
  398. while ((*env = *name++) != '\0')
  399. env++;
  400. *env = '=';
  401. while ((*++env = *value++) != '\0')
  402. ;
  403. /* end is marked with double '\0' */
  404. *++env = '\0';
  405. return 0;
  406. }
  407. /*
  408. * Deletes or sets environment variables. Returns -1 and sets errno error codes:
  409. * 0 - OK
  410. * EINVAL - need at least 1 argument
  411. * EROFS - certain variables ("ethaddr", "serial#") cannot be
  412. * modified or deleted
  413. *
  414. */
  415. int fw_setenv(int argc, char *argv[])
  416. {
  417. int i, len;
  418. char *name;
  419. char *value = NULL;
  420. char *tmpval = NULL;
  421. if (argc < 2) {
  422. errno = EINVAL;
  423. return -1;
  424. }
  425. if (fw_env_open()) {
  426. fprintf(stderr, "Error: environment not initialized\n");
  427. return -1;
  428. }
  429. name = argv[1];
  430. len = strlen(name) + 2;
  431. for (i = 2; i < argc; ++i)
  432. len += strlen(argv[i]) + 1;
  433. /* Allocate enough place to the data string */
  434. for (i = 2; i < argc; ++i) {
  435. char *val = argv[i];
  436. if (!value) {
  437. value = (char *)malloc(len - strlen(name));
  438. if (!value) {
  439. fprintf(stderr,
  440. "Cannot malloc %zu bytes: %s\n",
  441. len - strlen(name), strerror(errno));
  442. return -1;
  443. }
  444. memset(value, 0, len - strlen(name));
  445. tmpval = value;
  446. }
  447. if (i != 2)
  448. *tmpval++ = ' ';
  449. while (*val != '\0')
  450. *tmpval++ = *val++;
  451. }
  452. fw_env_write(name, value);
  453. if (value)
  454. free(value);
  455. return fw_env_close();
  456. }
  457. /*
  458. * Parse a file and configure the u-boot variables.
  459. * The script file has a very simple format, as follows:
  460. *
  461. * Each line has a couple with name, value:
  462. * <white spaces>variable_name<white spaces>variable_value
  463. *
  464. * Both variable_name and variable_value are interpreted as strings.
  465. * Any character after <white spaces> and before ending \r\n is interpreted
  466. * as variable's value (no comment allowed on these lines !)
  467. *
  468. * Comments are allowed if the first character in the line is #
  469. *
  470. * Returns -1 and sets errno error codes:
  471. * 0 - OK
  472. * -1 - Error
  473. */
  474. int fw_parse_script(char *fname)
  475. {
  476. FILE *fp;
  477. char dump[1024]; /* Maximum line length in the file */
  478. char *name;
  479. char *val;
  480. int lineno = 0;
  481. int len;
  482. int ret = 0;
  483. if (fw_env_open()) {
  484. fprintf(stderr, "Error: environment not initialized\n");
  485. return -1;
  486. }
  487. if (strcmp(fname, "-") == 0)
  488. fp = stdin;
  489. else {
  490. fp = fopen(fname, "r");
  491. if (fp == NULL) {
  492. fprintf(stderr, "I cannot open %s for reading\n",
  493. fname);
  494. return -1;
  495. }
  496. }
  497. while (fgets(dump, sizeof(dump), fp)) {
  498. lineno++;
  499. len = strlen(dump);
  500. /*
  501. * Read a whole line from the file. If the line is too long
  502. * or is not terminated, reports an error and exit.
  503. */
  504. if (dump[len - 1] != '\n') {
  505. fprintf(stderr,
  506. "Line %d not corrected terminated or too long\n",
  507. lineno);
  508. ret = -1;
  509. break;
  510. }
  511. /* Drop ending line feed / carriage return */
  512. while (len > 0 && (dump[len - 1] == '\n' ||
  513. dump[len - 1] == '\r')) {
  514. dump[len - 1] = '\0';
  515. len--;
  516. }
  517. /* Skip comment or empty lines */
  518. if ((len == 0) || dump[0] == '#')
  519. continue;
  520. /*
  521. * Search for variable's name,
  522. * remove leading whitespaces
  523. */
  524. name = fw_string_blank(dump, 1);
  525. if (!name)
  526. continue;
  527. /* The first white space is the end of variable name */
  528. val = fw_string_blank(name, 0);
  529. len = strlen(name);
  530. if (val) {
  531. *val++ = '\0';
  532. if ((val - name) < len)
  533. val = fw_string_blank(val, 1);
  534. else
  535. val = NULL;
  536. }
  537. #ifdef DEBUG
  538. fprintf(stderr, "Setting %s : %s\n",
  539. name, val ? val : " removed");
  540. #endif
  541. /*
  542. * If there is an error setting a variable,
  543. * try to save the environment and returns an error
  544. */
  545. if (fw_env_write(name, val)) {
  546. fprintf(stderr,
  547. "fw_env_write returns with error : %s\n",
  548. strerror(errno));
  549. ret = -1;
  550. break;
  551. }
  552. }
  553. /* Close file if not stdin */
  554. if (strcmp(fname, "-") != 0)
  555. fclose(fp);
  556. ret |= fw_env_close();
  557. return ret;
  558. }
  559. /*
  560. * Test for bad block on NAND, just returns 0 on NOR, on NAND:
  561. * 0 - block is good
  562. * > 0 - block is bad
  563. * < 0 - failed to test
  564. */
  565. static int flash_bad_block (int fd, uint8_t mtd_type, loff_t *blockstart)
  566. {
  567. if (mtd_type == MTD_NANDFLASH) {
  568. int badblock = ioctl (fd, MEMGETBADBLOCK, blockstart);
  569. if (badblock < 0) {
  570. perror ("Cannot read bad block mark");
  571. return badblock;
  572. }
  573. if (badblock) {
  574. #ifdef DEBUG
  575. fprintf (stderr, "Bad block at 0x%llx, "
  576. "skipping\n", *blockstart);
  577. #endif
  578. return badblock;
  579. }
  580. }
  581. return 0;
  582. }
  583. /*
  584. * Read data from flash at an offset into a provided buffer. On NAND it skips
  585. * bad blocks but makes sure it stays within ENVSECTORS (dev) starting from
  586. * the DEVOFFSET (dev) block. On NOR the loop is only run once.
  587. */
  588. static int flash_read_buf (int dev, int fd, void *buf, size_t count,
  589. off_t offset, uint8_t mtd_type)
  590. {
  591. size_t blocklen; /* erase / write length - one block on NAND,
  592. 0 on NOR */
  593. size_t processed = 0; /* progress counter */
  594. size_t readlen = count; /* current read length */
  595. off_t top_of_range; /* end of the last block we may use */
  596. off_t block_seek; /* offset inside the current block to the start
  597. of the data */
  598. loff_t blockstart; /* running start of the current block -
  599. MEMGETBADBLOCK needs 64 bits */
  600. int rc;
  601. blockstart = (offset / DEVESIZE (dev)) * DEVESIZE (dev);
  602. /* Offset inside a block */
  603. block_seek = offset - blockstart;
  604. if (mtd_type == MTD_NANDFLASH) {
  605. /*
  606. * NAND: calculate which blocks we are reading. We have
  607. * to read one block at a time to skip bad blocks.
  608. */
  609. blocklen = DEVESIZE (dev);
  610. /*
  611. * To calculate the top of the range, we have to use the
  612. * global DEVOFFSET (dev), which can be different from offset
  613. */
  614. top_of_range = ((DEVOFFSET(dev) / blocklen) +
  615. ENVSECTORS (dev)) * blocklen;
  616. /* Limit to one block for the first read */
  617. if (readlen > blocklen - block_seek)
  618. readlen = blocklen - block_seek;
  619. } else {
  620. blocklen = 0;
  621. top_of_range = offset + count;
  622. }
  623. /* This only runs once on NOR flash */
  624. while (processed < count) {
  625. rc = flash_bad_block (fd, mtd_type, &blockstart);
  626. if (rc < 0) /* block test failed */
  627. return -1;
  628. if (blockstart + block_seek + readlen > top_of_range) {
  629. /* End of range is reached */
  630. fprintf (stderr,
  631. "Too few good blocks within range\n");
  632. return -1;
  633. }
  634. if (rc) { /* block is bad */
  635. blockstart += blocklen;
  636. continue;
  637. }
  638. /*
  639. * If a block is bad, we retry in the next block at the same
  640. * offset - see common/env_nand.c::writeenv()
  641. */
  642. lseek (fd, blockstart + block_seek, SEEK_SET);
  643. rc = read (fd, buf + processed, readlen);
  644. if (rc != readlen) {
  645. fprintf (stderr, "Read error on %s: %s\n",
  646. DEVNAME (dev), strerror (errno));
  647. return -1;
  648. }
  649. #ifdef DEBUG
  650. fprintf (stderr, "Read 0x%x bytes at 0x%llx\n",
  651. rc, blockstart + block_seek);
  652. #endif
  653. processed += readlen;
  654. readlen = min (blocklen, count - processed);
  655. block_seek = 0;
  656. blockstart += blocklen;
  657. }
  658. return processed;
  659. }
  660. /*
  661. * Write count bytes at offset, but stay within ENVSECTORS (dev) sectors of
  662. * DEVOFFSET (dev). Similar to the read case above, on NOR and dataflash we
  663. * erase and write the whole data at once.
  664. */
  665. static int flash_write_buf (int dev, int fd, void *buf, size_t count,
  666. off_t offset, uint8_t mtd_type)
  667. {
  668. void *data;
  669. struct erase_info_user erase;
  670. size_t blocklen; /* length of NAND block / NOR erase sector */
  671. size_t erase_len; /* whole area that can be erased - may include
  672. bad blocks */
  673. size_t erasesize; /* erase / write length - one block on NAND,
  674. whole area on NOR */
  675. size_t processed = 0; /* progress counter */
  676. size_t write_total; /* total size to actually write - excluding
  677. bad blocks */
  678. off_t erase_offset; /* offset to the first erase block (aligned)
  679. below offset */
  680. off_t block_seek; /* offset inside the erase block to the start
  681. of the data */
  682. off_t top_of_range; /* end of the last block we may use */
  683. loff_t blockstart; /* running start of the current block -
  684. MEMGETBADBLOCK needs 64 bits */
  685. int rc;
  686. blocklen = DEVESIZE (dev);
  687. top_of_range = ((DEVOFFSET(dev) / blocklen) +
  688. ENVSECTORS (dev)) * blocklen;
  689. erase_offset = (offset / blocklen) * blocklen;
  690. /* Maximum area we may use */
  691. erase_len = top_of_range - erase_offset;
  692. blockstart = erase_offset;
  693. /* Offset inside a block */
  694. block_seek = offset - erase_offset;
  695. /*
  696. * Data size we actually have to write: from the start of the block
  697. * to the start of the data, then count bytes of data, and to the
  698. * end of the block
  699. */
  700. write_total = ((block_seek + count + blocklen - 1) /
  701. blocklen) * blocklen;
  702. /*
  703. * Support data anywhere within erase sectors: read out the complete
  704. * area to be erased, replace the environment image, write the whole
  705. * block back again.
  706. */
  707. if (write_total > count) {
  708. data = malloc (erase_len);
  709. if (!data) {
  710. fprintf (stderr,
  711. "Cannot malloc %zu bytes: %s\n",
  712. erase_len, strerror (errno));
  713. return -1;
  714. }
  715. rc = flash_read_buf (dev, fd, data, write_total, erase_offset,
  716. mtd_type);
  717. if (write_total != rc)
  718. return -1;
  719. /* Overwrite the old environment */
  720. memcpy (data + block_seek, buf, count);
  721. } else {
  722. /*
  723. * We get here, iff offset is block-aligned and count is a
  724. * multiple of blocklen - see write_total calculation above
  725. */
  726. data = buf;
  727. }
  728. if (mtd_type == MTD_NANDFLASH) {
  729. /*
  730. * NAND: calculate which blocks we are writing. We have
  731. * to write one block at a time to skip bad blocks.
  732. */
  733. erasesize = blocklen;
  734. } else {
  735. erasesize = erase_len;
  736. }
  737. erase.length = erasesize;
  738. /* This only runs once on NOR flash and SPI-dataflash */
  739. while (processed < write_total) {
  740. rc = flash_bad_block (fd, mtd_type, &blockstart);
  741. if (rc < 0) /* block test failed */
  742. return rc;
  743. if (blockstart + erasesize > top_of_range) {
  744. fprintf (stderr, "End of range reached, aborting\n");
  745. return -1;
  746. }
  747. if (rc) { /* block is bad */
  748. blockstart += blocklen;
  749. continue;
  750. }
  751. erase.start = blockstart;
  752. ioctl (fd, MEMUNLOCK, &erase);
  753. /* Dataflash does not need an explicit erase cycle */
  754. if (mtd_type != MTD_DATAFLASH)
  755. if (ioctl (fd, MEMERASE, &erase) != 0) {
  756. fprintf (stderr, "MTD erase error on %s: %s\n",
  757. DEVNAME (dev),
  758. strerror (errno));
  759. return -1;
  760. }
  761. if (lseek (fd, blockstart, SEEK_SET) == -1) {
  762. fprintf (stderr,
  763. "Seek error on %s: %s\n",
  764. DEVNAME (dev), strerror (errno));
  765. return -1;
  766. }
  767. #ifdef DEBUG
  768. printf ("Write 0x%x bytes at 0x%llx\n", erasesize, blockstart);
  769. #endif
  770. if (write (fd, data + processed, erasesize) != erasesize) {
  771. fprintf (stderr, "Write error on %s: %s\n",
  772. DEVNAME (dev), strerror (errno));
  773. return -1;
  774. }
  775. ioctl (fd, MEMLOCK, &erase);
  776. processed += blocklen;
  777. block_seek = 0;
  778. blockstart += blocklen;
  779. }
  780. if (write_total > count)
  781. free (data);
  782. return processed;
  783. }
  784. /*
  785. * Set obsolete flag at offset - NOR flash only
  786. */
  787. static int flash_flag_obsolete (int dev, int fd, off_t offset)
  788. {
  789. int rc;
  790. struct erase_info_user erase;
  791. erase.start = DEVOFFSET (dev);
  792. erase.length = DEVESIZE (dev);
  793. /* This relies on the fact, that obsolete_flag == 0 */
  794. rc = lseek (fd, offset, SEEK_SET);
  795. if (rc < 0) {
  796. fprintf (stderr, "Cannot seek to set the flag on %s \n",
  797. DEVNAME (dev));
  798. return rc;
  799. }
  800. ioctl (fd, MEMUNLOCK, &erase);
  801. rc = write (fd, &obsolete_flag, sizeof (obsolete_flag));
  802. ioctl (fd, MEMLOCK, &erase);
  803. if (rc < 0)
  804. perror ("Could not set obsolete flag");
  805. return rc;
  806. }
  807. static int flash_write (int fd_current, int fd_target, int dev_target)
  808. {
  809. int rc;
  810. switch (environment.flag_scheme) {
  811. case FLAG_NONE:
  812. break;
  813. case FLAG_INCREMENTAL:
  814. (*environment.flags)++;
  815. break;
  816. case FLAG_BOOLEAN:
  817. *environment.flags = active_flag;
  818. break;
  819. default:
  820. fprintf (stderr, "Unimplemented flash scheme %u \n",
  821. environment.flag_scheme);
  822. return -1;
  823. }
  824. #ifdef DEBUG
  825. printf ("Writing new environment at 0x%lx on %s\n",
  826. DEVOFFSET (dev_target), DEVNAME (dev_target));
  827. #endif
  828. rc = flash_write_buf (dev_target, fd_target, environment.image,
  829. CONFIG_ENV_SIZE, DEVOFFSET (dev_target),
  830. DEVTYPE(dev_target));
  831. if (rc < 0)
  832. return rc;
  833. if (environment.flag_scheme == FLAG_BOOLEAN) {
  834. /* Have to set obsolete flag */
  835. off_t offset = DEVOFFSET (dev_current) +
  836. offsetof (struct env_image_redundant, flags);
  837. #ifdef DEBUG
  838. printf ("Setting obsolete flag in environment at 0x%lx on %s\n",
  839. DEVOFFSET (dev_current), DEVNAME (dev_current));
  840. #endif
  841. flash_flag_obsolete (dev_current, fd_current, offset);
  842. }
  843. return 0;
  844. }
  845. static int flash_read (int fd)
  846. {
  847. struct mtd_info_user mtdinfo;
  848. int rc;
  849. rc = ioctl (fd, MEMGETINFO, &mtdinfo);
  850. if (rc < 0) {
  851. perror ("Cannot get MTD information");
  852. return -1;
  853. }
  854. if (mtdinfo.type != MTD_NORFLASH &&
  855. mtdinfo.type != MTD_NANDFLASH &&
  856. mtdinfo.type != MTD_DATAFLASH) {
  857. fprintf (stderr, "Unsupported flash type %u\n", mtdinfo.type);
  858. return -1;
  859. }
  860. DEVTYPE(dev_current) = mtdinfo.type;
  861. rc = flash_read_buf (dev_current, fd, environment.image, CONFIG_ENV_SIZE,
  862. DEVOFFSET (dev_current), mtdinfo.type);
  863. return (rc != CONFIG_ENV_SIZE) ? -1 : 0;
  864. }
  865. static int flash_io (int mode)
  866. {
  867. int fd_current, fd_target, rc, dev_target;
  868. /* dev_current: fd_current, erase_current */
  869. fd_current = open (DEVNAME (dev_current), mode);
  870. if (fd_current < 0) {
  871. fprintf (stderr,
  872. "Can't open %s: %s\n",
  873. DEVNAME (dev_current), strerror (errno));
  874. return -1;
  875. }
  876. if (mode == O_RDWR) {
  877. if (HaveRedundEnv) {
  878. /* switch to next partition for writing */
  879. dev_target = !dev_current;
  880. /* dev_target: fd_target, erase_target */
  881. fd_target = open (DEVNAME (dev_target), mode);
  882. if (fd_target < 0) {
  883. fprintf (stderr,
  884. "Can't open %s: %s\n",
  885. DEVNAME (dev_target),
  886. strerror (errno));
  887. rc = -1;
  888. goto exit;
  889. }
  890. } else {
  891. dev_target = dev_current;
  892. fd_target = fd_current;
  893. }
  894. rc = flash_write (fd_current, fd_target, dev_target);
  895. if (HaveRedundEnv) {
  896. if (close (fd_target)) {
  897. fprintf (stderr,
  898. "I/O error on %s: %s\n",
  899. DEVNAME (dev_target),
  900. strerror (errno));
  901. rc = -1;
  902. }
  903. }
  904. } else {
  905. rc = flash_read (fd_current);
  906. }
  907. exit:
  908. if (close (fd_current)) {
  909. fprintf (stderr,
  910. "I/O error on %s: %s\n",
  911. DEVNAME (dev_current), strerror (errno));
  912. return -1;
  913. }
  914. return rc;
  915. }
  916. /*
  917. * s1 is either a simple 'name', or a 'name=value' pair.
  918. * s2 is a 'name=value' pair.
  919. * If the names match, return the value of s2, else NULL.
  920. */
  921. static char *envmatch (char * s1, char * s2)
  922. {
  923. while (*s1 == *s2++)
  924. if (*s1++ == '=')
  925. return s2;
  926. if (*s1 == '\0' && *(s2 - 1) == '=')
  927. return s2;
  928. return NULL;
  929. }
  930. /*
  931. * Prevent confusion if running from erased flash memory
  932. */
  933. int fw_env_open(void)
  934. {
  935. int crc0, crc0_ok;
  936. unsigned char flag0;
  937. void *addr0;
  938. int crc1, crc1_ok;
  939. unsigned char flag1;
  940. void *addr1;
  941. struct env_image_single *single;
  942. struct env_image_redundant *redundant;
  943. if (parse_config ()) /* should fill envdevices */
  944. return -1;
  945. addr0 = calloc (1, CONFIG_ENV_SIZE);
  946. if (addr0 == NULL) {
  947. fprintf (stderr,
  948. "Not enough memory for environment (%ld bytes)\n",
  949. CONFIG_ENV_SIZE);
  950. return -1;
  951. }
  952. /* read environment from FLASH to local buffer */
  953. environment.image = addr0;
  954. if (HaveRedundEnv) {
  955. redundant = addr0;
  956. environment.crc = &redundant->crc;
  957. environment.flags = &redundant->flags;
  958. environment.data = redundant->data;
  959. } else {
  960. single = addr0;
  961. environment.crc = &single->crc;
  962. environment.flags = NULL;
  963. environment.data = single->data;
  964. }
  965. dev_current = 0;
  966. if (flash_io (O_RDONLY))
  967. return -1;
  968. crc0 = crc32 (0, (uint8_t *) environment.data, ENV_SIZE);
  969. crc0_ok = (crc0 == *environment.crc);
  970. if (!HaveRedundEnv) {
  971. if (!crc0_ok) {
  972. fprintf (stderr,
  973. "Warning: Bad CRC, using default environment\n");
  974. memcpy(environment.data, default_environment, sizeof default_environment);
  975. }
  976. } else {
  977. flag0 = *environment.flags;
  978. dev_current = 1;
  979. addr1 = calloc (1, CONFIG_ENV_SIZE);
  980. if (addr1 == NULL) {
  981. fprintf (stderr,
  982. "Not enough memory for environment (%ld bytes)\n",
  983. CONFIG_ENV_SIZE);
  984. return -1;
  985. }
  986. redundant = addr1;
  987. /*
  988. * have to set environment.image for flash_read(), careful -
  989. * other pointers in environment still point inside addr0
  990. */
  991. environment.image = addr1;
  992. if (flash_io (O_RDONLY))
  993. return -1;
  994. /* Check flag scheme compatibility */
  995. if (DEVTYPE(dev_current) == MTD_NORFLASH &&
  996. DEVTYPE(!dev_current) == MTD_NORFLASH) {
  997. environment.flag_scheme = FLAG_BOOLEAN;
  998. } else if (DEVTYPE(dev_current) == MTD_NANDFLASH &&
  999. DEVTYPE(!dev_current) == MTD_NANDFLASH) {
  1000. environment.flag_scheme = FLAG_INCREMENTAL;
  1001. } else if (DEVTYPE(dev_current) == MTD_DATAFLASH &&
  1002. DEVTYPE(!dev_current) == MTD_DATAFLASH) {
  1003. environment.flag_scheme = FLAG_BOOLEAN;
  1004. } else {
  1005. fprintf (stderr, "Incompatible flash types!\n");
  1006. return -1;
  1007. }
  1008. crc1 = crc32 (0, (uint8_t *) redundant->data, ENV_SIZE);
  1009. crc1_ok = (crc1 == redundant->crc);
  1010. flag1 = redundant->flags;
  1011. if (crc0_ok && !crc1_ok) {
  1012. dev_current = 0;
  1013. } else if (!crc0_ok && crc1_ok) {
  1014. dev_current = 1;
  1015. } else if (!crc0_ok && !crc1_ok) {
  1016. fprintf (stderr,
  1017. "Warning: Bad CRC, using default environment\n");
  1018. memcpy (environment.data, default_environment,
  1019. sizeof default_environment);
  1020. dev_current = 0;
  1021. } else {
  1022. switch (environment.flag_scheme) {
  1023. case FLAG_BOOLEAN:
  1024. if (flag0 == active_flag &&
  1025. flag1 == obsolete_flag) {
  1026. dev_current = 0;
  1027. } else if (flag0 == obsolete_flag &&
  1028. flag1 == active_flag) {
  1029. dev_current = 1;
  1030. } else if (flag0 == flag1) {
  1031. dev_current = 0;
  1032. } else if (flag0 == 0xFF) {
  1033. dev_current = 0;
  1034. } else if (flag1 == 0xFF) {
  1035. dev_current = 1;
  1036. } else {
  1037. dev_current = 0;
  1038. }
  1039. break;
  1040. case FLAG_INCREMENTAL:
  1041. if (flag0 == 255 && flag1 == 0)
  1042. dev_current = 1;
  1043. else if ((flag1 == 255 && flag0 == 0) ||
  1044. flag0 >= flag1)
  1045. dev_current = 0;
  1046. else /* flag1 > flag0 */
  1047. dev_current = 1;
  1048. break;
  1049. default:
  1050. fprintf (stderr, "Unknown flag scheme %u \n",
  1051. environment.flag_scheme);
  1052. return -1;
  1053. }
  1054. }
  1055. /*
  1056. * If we are reading, we don't need the flag and the CRC any
  1057. * more, if we are writing, we will re-calculate CRC and update
  1058. * flags before writing out
  1059. */
  1060. if (dev_current) {
  1061. environment.image = addr1;
  1062. environment.crc = &redundant->crc;
  1063. environment.flags = &redundant->flags;
  1064. environment.data = redundant->data;
  1065. free (addr0);
  1066. } else {
  1067. environment.image = addr0;
  1068. /* Other pointers are already set */
  1069. free (addr1);
  1070. }
  1071. }
  1072. return 0;
  1073. }
  1074. static int parse_config ()
  1075. {
  1076. struct stat st;
  1077. #if defined(CONFIG_FILE)
  1078. /* Fills in DEVNAME(), ENVSIZE(), DEVESIZE(). Or don't. */
  1079. if (get_config (CONFIG_FILE)) {
  1080. fprintf (stderr,
  1081. "Cannot parse config file: %s\n", strerror (errno));
  1082. return -1;
  1083. }
  1084. #else
  1085. strcpy (DEVNAME (0), DEVICE1_NAME);
  1086. DEVOFFSET (0) = DEVICE1_OFFSET;
  1087. ENVSIZE (0) = ENV1_SIZE;
  1088. /* Default values are: erase-size=env-size, #sectors=1 */
  1089. DEVESIZE (0) = ENVSIZE (0);
  1090. ENVSECTORS (0) = 1;
  1091. #ifdef DEVICE1_ESIZE
  1092. DEVESIZE (0) = DEVICE1_ESIZE;
  1093. #endif
  1094. #ifdef DEVICE1_ENVSECTORS
  1095. ENVSECTORS (0) = DEVICE1_ENVSECTORS;
  1096. #endif
  1097. #ifdef HAVE_REDUND
  1098. strcpy (DEVNAME (1), DEVICE2_NAME);
  1099. DEVOFFSET (1) = DEVICE2_OFFSET;
  1100. ENVSIZE (1) = ENV2_SIZE;
  1101. /* Default values are: erase-size=env-size, #sectors=1 */
  1102. DEVESIZE (1) = ENVSIZE (1);
  1103. ENVSECTORS (1) = 1;
  1104. #ifdef DEVICE2_ESIZE
  1105. DEVESIZE (1) = DEVICE2_ESIZE;
  1106. #endif
  1107. #ifdef DEVICE2_ENVSECTORS
  1108. ENVSECTORS (1) = DEVICE2_ENVSECTORS;
  1109. #endif
  1110. HaveRedundEnv = 1;
  1111. #endif
  1112. #endif
  1113. if (stat (DEVNAME (0), &st)) {
  1114. fprintf (stderr,
  1115. "Cannot access MTD device %s: %s\n",
  1116. DEVNAME (0), strerror (errno));
  1117. return -1;
  1118. }
  1119. if (HaveRedundEnv && stat (DEVNAME (1), &st)) {
  1120. fprintf (stderr,
  1121. "Cannot access MTD device %s: %s\n",
  1122. DEVNAME (1), strerror (errno));
  1123. return -1;
  1124. }
  1125. return 0;
  1126. }
  1127. #if defined(CONFIG_FILE)
  1128. static int get_config (char *fname)
  1129. {
  1130. FILE *fp;
  1131. int i = 0;
  1132. int rc;
  1133. char dump[128];
  1134. fp = fopen (fname, "r");
  1135. if (fp == NULL)
  1136. return -1;
  1137. while (i < 2 && fgets (dump, sizeof (dump), fp)) {
  1138. /* Skip incomplete conversions and comment strings */
  1139. if (dump[0] == '#')
  1140. continue;
  1141. rc = sscanf (dump, "%s %lx %lx %lx %lx",
  1142. DEVNAME (i),
  1143. &DEVOFFSET (i),
  1144. &ENVSIZE (i),
  1145. &DEVESIZE (i),
  1146. &ENVSECTORS (i));
  1147. if (rc < 3)
  1148. continue;
  1149. if (rc < 4)
  1150. /* Assume the erase size is the same as the env-size */
  1151. DEVESIZE(i) = ENVSIZE(i);
  1152. if (rc < 5)
  1153. /* Default - 1 sector */
  1154. ENVSECTORS (i) = 1;
  1155. i++;
  1156. }
  1157. fclose (fp);
  1158. HaveRedundEnv = i - 1;
  1159. if (!i) { /* No valid entries found */
  1160. errno = EINVAL;
  1161. return -1;
  1162. } else
  1163. return 0;
  1164. }
  1165. #endif