nand.c 9.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412
  1. /*
  2. * (C) Copyright 2000-2010
  3. * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
  4. *
  5. * (C) Copyright 2008
  6. * Stuart Wood, Lab X Technologies <stuart.wood@labxtechnologies.com>
  7. *
  8. * (C) Copyright 2004
  9. * Jian Zhang, Texas Instruments, jzhang@ti.com.
  10. *
  11. * (C) Copyright 2001 Sysgo Real-Time Solutions, GmbH <www.elinos.com>
  12. * Andreas Heppel <aheppel@sysgo.de>
  13. *
  14. * SPDX-License-Identifier: GPL-2.0+
  15. */
  16. #include <common.h>
  17. #include <command.h>
  18. #include <environment.h>
  19. #include <linux/stddef.h>
  20. #include <malloc.h>
  21. #include <memalign.h>
  22. #include <nand.h>
  23. #include <search.h>
  24. #include <errno.h>
  25. #if defined(CONFIG_CMD_SAVEENV) && defined(CONFIG_CMD_NAND) && \
  26. !defined(CONFIG_SPL_BUILD)
  27. #define CMD_SAVEENV
  28. #elif defined(CONFIG_ENV_OFFSET_REDUND)
  29. #error CONFIG_ENV_OFFSET_REDUND must have CONFIG_CMD_SAVEENV & CONFIG_CMD_NAND
  30. #endif
  31. #if defined(CONFIG_ENV_SIZE_REDUND) && \
  32. (CONFIG_ENV_SIZE_REDUND != CONFIG_ENV_SIZE)
  33. #error CONFIG_ENV_SIZE_REDUND should be the same as CONFIG_ENV_SIZE
  34. #endif
  35. #ifndef CONFIG_ENV_RANGE
  36. #define CONFIG_ENV_RANGE CONFIG_ENV_SIZE
  37. #endif
  38. #if defined(ENV_IS_EMBEDDED)
  39. env_t *env_ptr = &environment;
  40. #elif defined(CONFIG_NAND_ENV_DST)
  41. env_t *env_ptr = (env_t *)CONFIG_NAND_ENV_DST;
  42. #else /* ! ENV_IS_EMBEDDED */
  43. env_t *env_ptr;
  44. #endif /* ENV_IS_EMBEDDED */
  45. DECLARE_GLOBAL_DATA_PTR;
  46. /*
  47. * This is called before nand_init() so we can't read NAND to
  48. * validate env data.
  49. *
  50. * Mark it OK for now. env_relocate() in env_common.c will call our
  51. * relocate function which does the real validation.
  52. *
  53. * When using a NAND boot image (like sequoia_nand), the environment
  54. * can be embedded or attached to the U-Boot image in NAND flash.
  55. * This way the SPL loads not only the U-Boot image from NAND but
  56. * also the environment.
  57. */
  58. static int env_nand_init(void)
  59. {
  60. #if defined(ENV_IS_EMBEDDED) || defined(CONFIG_NAND_ENV_DST)
  61. int crc1_ok = 0, crc2_ok = 0;
  62. env_t *tmp_env1;
  63. #ifdef CONFIG_ENV_OFFSET_REDUND
  64. env_t *tmp_env2;
  65. tmp_env2 = (env_t *)((ulong)env_ptr + CONFIG_ENV_SIZE);
  66. crc2_ok = crc32(0, tmp_env2->data, ENV_SIZE) == tmp_env2->crc;
  67. #endif
  68. tmp_env1 = env_ptr;
  69. crc1_ok = crc32(0, tmp_env1->data, ENV_SIZE) == tmp_env1->crc;
  70. if (!crc1_ok && !crc2_ok) {
  71. gd->env_addr = 0;
  72. gd->env_valid = ENV_INVALID;
  73. return 0;
  74. } else if (crc1_ok && !crc2_ok) {
  75. gd->env_valid = ENV_VALID;
  76. }
  77. #ifdef CONFIG_ENV_OFFSET_REDUND
  78. else if (!crc1_ok && crc2_ok) {
  79. gd->env_valid = ENV_REDUND;
  80. } else {
  81. /* both ok - check serial */
  82. if (tmp_env1->flags == 255 && tmp_env2->flags == 0)
  83. gd->env_valid = ENV_REDUND;
  84. else if (tmp_env2->flags == 255 && tmp_env1->flags == 0)
  85. gd->env_valid = ENV_VALID;
  86. else if (tmp_env1->flags > tmp_env2->flags)
  87. gd->env_valid = ENV_VALID;
  88. else if (tmp_env2->flags > tmp_env1->flags)
  89. gd->env_valid = ENV_REDUND;
  90. else /* flags are equal - almost impossible */
  91. gd->env_valid = ENV_VALID;
  92. }
  93. if (gd->env_valid == ENV_REDUND)
  94. env_ptr = tmp_env2;
  95. else
  96. #endif
  97. if (gd->env_valid == ENV_VALID)
  98. env_ptr = tmp_env1;
  99. gd->env_addr = (ulong)env_ptr->data;
  100. #else /* ENV_IS_EMBEDDED || CONFIG_NAND_ENV_DST */
  101. gd->env_addr = (ulong)&default_environment[0];
  102. gd->env_valid = ENV_VALID;
  103. #endif /* ENV_IS_EMBEDDED || CONFIG_NAND_ENV_DST */
  104. return 0;
  105. }
  106. #ifdef CMD_SAVEENV
  107. /*
  108. * The legacy NAND code saved the environment in the first NAND device i.e.,
  109. * nand_dev_desc + 0. This is also the behaviour using the new NAND code.
  110. */
  111. static int writeenv(size_t offset, u_char *buf)
  112. {
  113. size_t end = offset + CONFIG_ENV_RANGE;
  114. size_t amount_saved = 0;
  115. size_t blocksize, len;
  116. struct mtd_info *mtd;
  117. u_char *char_ptr;
  118. mtd = get_nand_dev_by_index(0);
  119. if (!mtd)
  120. return 1;
  121. blocksize = mtd->erasesize;
  122. len = min(blocksize, (size_t)CONFIG_ENV_SIZE);
  123. while (amount_saved < CONFIG_ENV_SIZE && offset < end) {
  124. if (nand_block_isbad(mtd, offset)) {
  125. offset += blocksize;
  126. } else {
  127. char_ptr = &buf[amount_saved];
  128. if (nand_write(mtd, offset, &len, char_ptr))
  129. return 1;
  130. offset += blocksize;
  131. amount_saved += len;
  132. }
  133. }
  134. if (amount_saved != CONFIG_ENV_SIZE)
  135. return 1;
  136. return 0;
  137. }
  138. struct nand_env_location {
  139. const char *name;
  140. const nand_erase_options_t erase_opts;
  141. };
  142. static int erase_and_write_env(const struct nand_env_location *location,
  143. u_char *env_new)
  144. {
  145. struct mtd_info *mtd;
  146. int ret = 0;
  147. mtd = get_nand_dev_by_index(0);
  148. if (!mtd)
  149. return 1;
  150. printf("Erasing %s...\n", location->name);
  151. if (nand_erase_opts(mtd, &location->erase_opts))
  152. return 1;
  153. printf("Writing to %s... ", location->name);
  154. ret = writeenv(location->erase_opts.offset, env_new);
  155. puts(ret ? "FAILED!\n" : "OK\n");
  156. return ret;
  157. }
  158. static int env_nand_save(void)
  159. {
  160. int ret = 0;
  161. ALLOC_CACHE_ALIGN_BUFFER(env_t, env_new, 1);
  162. int env_idx = 0;
  163. static const struct nand_env_location location[] = {
  164. {
  165. .name = "NAND",
  166. .erase_opts = {
  167. .length = CONFIG_ENV_RANGE,
  168. .offset = CONFIG_ENV_OFFSET,
  169. },
  170. },
  171. #ifdef CONFIG_ENV_OFFSET_REDUND
  172. {
  173. .name = "redundant NAND",
  174. .erase_opts = {
  175. .length = CONFIG_ENV_RANGE,
  176. .offset = CONFIG_ENV_OFFSET_REDUND,
  177. },
  178. },
  179. #endif
  180. };
  181. if (CONFIG_ENV_RANGE < CONFIG_ENV_SIZE)
  182. return 1;
  183. ret = env_export(env_new);
  184. if (ret)
  185. return ret;
  186. #ifdef CONFIG_ENV_OFFSET_REDUND
  187. env_idx = (gd->env_valid == ENV_VALID);
  188. #endif
  189. ret = erase_and_write_env(&location[env_idx], (u_char *)env_new);
  190. #ifdef CONFIG_ENV_OFFSET_REDUND
  191. if (!ret) {
  192. /* preset other copy for next write */
  193. gd->env_valid = gd->env_valid == ENV_REDUND ? ENV_VALID :
  194. ENV_REDUND;
  195. return ret;
  196. }
  197. env_idx = (env_idx + 1) & 1;
  198. ret = erase_and_write_env(&location[env_idx], (u_char *)env_new);
  199. if (!ret)
  200. printf("Warning: primary env write failed,"
  201. " redundancy is lost!\n");
  202. #endif
  203. return ret;
  204. }
  205. #endif /* CMD_SAVEENV */
  206. #if defined(CONFIG_SPL_BUILD)
  207. static int readenv(size_t offset, u_char *buf)
  208. {
  209. return nand_spl_load_image(offset, CONFIG_ENV_SIZE, buf);
  210. }
  211. #else
  212. static int readenv(size_t offset, u_char *buf)
  213. {
  214. size_t end = offset + CONFIG_ENV_RANGE;
  215. size_t amount_loaded = 0;
  216. size_t blocksize, len;
  217. struct mtd_info *mtd;
  218. u_char *char_ptr;
  219. mtd = get_nand_dev_by_index(0);
  220. if (!mtd)
  221. return 1;
  222. blocksize = mtd->erasesize;
  223. len = min(blocksize, (size_t)CONFIG_ENV_SIZE);
  224. while (amount_loaded < CONFIG_ENV_SIZE && offset < end) {
  225. if (nand_block_isbad(mtd, offset)) {
  226. offset += blocksize;
  227. } else {
  228. char_ptr = &buf[amount_loaded];
  229. if (nand_read_skip_bad(mtd, offset,
  230. &len, NULL,
  231. mtd->size, char_ptr))
  232. return 1;
  233. offset += blocksize;
  234. amount_loaded += len;
  235. }
  236. }
  237. if (amount_loaded != CONFIG_ENV_SIZE)
  238. return 1;
  239. return 0;
  240. }
  241. #endif /* #if defined(CONFIG_SPL_BUILD) */
  242. #ifdef CONFIG_ENV_OFFSET_OOB
  243. int get_nand_env_oob(struct mtd_info *mtd, unsigned long *result)
  244. {
  245. struct mtd_oob_ops ops;
  246. uint32_t oob_buf[ENV_OFFSET_SIZE / sizeof(uint32_t)];
  247. int ret;
  248. ops.datbuf = NULL;
  249. ops.mode = MTD_OOB_AUTO;
  250. ops.ooboffs = 0;
  251. ops.ooblen = ENV_OFFSET_SIZE;
  252. ops.oobbuf = (void *)oob_buf;
  253. ret = mtd->read_oob(mtd, ENV_OFFSET_SIZE, &ops);
  254. if (ret) {
  255. printf("error reading OOB block 0\n");
  256. return ret;
  257. }
  258. if (oob_buf[0] == ENV_OOB_MARKER) {
  259. *result = ovoid ob_buf[1] * mtd->erasesize;
  260. } else if (oob_buf[0] == ENV_OOB_MARKER_OLD) {
  261. *result = oob_buf[1];
  262. } else {
  263. printf("No dynamic environment marker in OOB block 0\n");
  264. return -ENOENT;
  265. }
  266. return 0;
  267. }
  268. #endif
  269. #ifdef CONFIG_ENV_OFFSET_REDUND
  270. static int env_nand_load(void)
  271. {
  272. #if defined(ENV_IS_EMBEDDED)
  273. return 0;
  274. #else
  275. int read1_fail = 0, read2_fail = 0;
  276. env_t *tmp_env1, *tmp_env2;
  277. int ret = 0;
  278. tmp_env1 = (env_t *)malloc(CONFIG_ENV_SIZE);
  279. tmp_env2 = (env_t *)malloc(CONFIG_ENV_SIZE);
  280. if (tmp_env1 == NULL || tmp_env2 == NULL) {
  281. puts("Can't allocate buffers for environment\n");
  282. set_default_env("!malloc() failed");
  283. ret = -EIO;
  284. goto done;
  285. }
  286. read1_fail = readenv(CONFIG_ENV_OFFSET, (u_char *) tmp_env1);
  287. read2_fail = readenv(CONFIG_ENV_OFFSET_REDUND, (u_char *) tmp_env2);
  288. if (read1_fail && read2_fail)
  289. puts("*** Error - No Valid Environment Area found\n");
  290. else if (read1_fail || read2_fail)
  291. puts("*** Warning - some problems detected "
  292. "reading environment; recovered successfully\n");
  293. if (read1_fail && read2_fail) {
  294. set_default_env("!bad env area");
  295. goto done;
  296. } else if (!read1_fail && read2_fail) {
  297. gd->env_valid = ENV_VALID;
  298. env_import((char *)tmp_env1, 1);
  299. } else if (read1_fail && !read2_fail) {
  300. gd->env_valid = ENV_REDUND;
  301. env_import((char *)tmp_env2, 1);
  302. } else {
  303. env_import_redund((char *)tmp_env1, (char *)tmp_env2);
  304. }
  305. done:
  306. free(tmp_env1);
  307. free(tmp_env2);
  308. return ret;
  309. #endif /* ! ENV_IS_EMBEDDED */
  310. }
  311. #else /* ! CONFIG_ENV_OFFSET_REDUND */
  312. /*
  313. * The legacy NAND code saved the environment in the first NAND
  314. * device i.e., nand_dev_desc + 0. This is also the behaviour using
  315. * the new NAND code.
  316. */
  317. static int env_nand_load(void)
  318. {
  319. #if !defined(ENV_IS_EMBEDDED)
  320. int ret;
  321. ALLOC_CACHE_ALIGN_BUFFER(char, buf, CONFIG_ENV_SIZE);
  322. #if defined(CONFIG_ENV_OFFSET_OOB)
  323. struct mtd_info *mtd = get_nand_dev_by_index(0);
  324. /*
  325. * If unable to read environment offset from NAND OOB then fall through
  326. * to the normal environment reading code below
  327. */
  328. if (mtd && !get_nand_env_oob(mtd, &nand_env_oob_offset)) {
  329. printf("Found Environment offset in OOB..\n");
  330. } else {
  331. set_default_env("!no env offset in OOB");
  332. return;
  333. }
  334. #endif
  335. ret = readenv(CONFIG_ENV_OFFSET, (u_char *)buf);
  336. if (ret) {
  337. set_default_env("!readenv() failed");
  338. return -EIO;
  339. }
  340. env_import(buf, 1);
  341. #endif /* ! ENV_IS_EMBEDDED */
  342. return 0;
  343. }
  344. #endif /* CONFIG_ENV_OFFSET_REDUND */
  345. U_BOOT_ENV_LOCATION(nand) = {
  346. .location = ENVL_NAND,
  347. ENV_NAME("NAND")
  348. .load = env_nand_load,
  349. #if defined(CMD_SAVEENV)
  350. .save = env_save_ptr(env_nand_save),
  351. #endif
  352. .init = env_nand_init,
  353. };