fw_env.c 30 KB

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