fw_env.c 30 KB

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