flash.c 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369
  1. // SPDX-License-Identifier: GPL-2.0+
  2. /*
  3. * (C) Copyright 2000-2010
  4. * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
  5. *
  6. * (C) Copyright 2001 Sysgo Real-Time Solutions, GmbH <www.elinos.com>
  7. * Andreas Heppel <aheppel@sysgo.de>
  8. */
  9. /* #define DEBUG */
  10. #include <common.h>
  11. #include <command.h>
  12. #include <env.h>
  13. #include <env_internal.h>
  14. #include <flash.h>
  15. #include <linux/stddef.h>
  16. #include <malloc.h>
  17. #include <search.h>
  18. #include <errno.h>
  19. #include <u-boot/crc.h>
  20. DECLARE_GLOBAL_DATA_PTR;
  21. #ifndef CONFIG_SPL_BUILD
  22. # if defined(CONFIG_CMD_SAVEENV) && defined(CONFIG_CMD_FLASH)
  23. # define CMD_SAVEENV
  24. # elif defined(CONFIG_ENV_ADDR_REDUND)
  25. # error CONFIG_ENV_ADDR_REDUND must have CONFIG_CMD_SAVEENV & CONFIG_CMD_FLASH
  26. # endif
  27. #endif
  28. /* TODO(sjg@chromium.org): Figure out all these special cases */
  29. #if (!defined(CONFIG_MICROBLAZE) && !defined(CONFIG_ARCH_ZYNQ) && \
  30. !defined(CONFIG_TARGET_MCCMON6) && !defined(CONFIG_TARGET_X600) && \
  31. !defined(CONFIG_TARGET_EDMINIV2)) || \
  32. !defined(CONFIG_SPL_BUILD)
  33. #define LOADENV
  34. #endif
  35. #if !defined(CONFIG_TARGET_X600) || !defined(CONFIG_SPL_BUILD)
  36. #define INITENV
  37. #endif
  38. #if defined(CONFIG_ENV_ADDR_REDUND) && defined(CMD_SAVEENV) || \
  39. !defined(CONFIG_ENV_ADDR_REDUND) && defined(INITENV)
  40. #ifdef ENV_IS_EMBEDDED
  41. static env_t *env_ptr = &embedded_environment;
  42. #else /* ! ENV_IS_EMBEDDED */
  43. static env_t *env_ptr = (env_t *)CONFIG_ENV_ADDR;
  44. #endif /* ENV_IS_EMBEDDED */
  45. #endif
  46. static __maybe_unused env_t *flash_addr = (env_t *)CONFIG_ENV_ADDR;
  47. /* CONFIG_ENV_ADDR is supposed to be on sector boundary */
  48. static ulong __maybe_unused end_addr =
  49. CONFIG_ENV_ADDR + CONFIG_ENV_SECT_SIZE - 1;
  50. #ifdef CONFIG_ENV_ADDR_REDUND
  51. static env_t __maybe_unused *flash_addr_new = (env_t *)CONFIG_ENV_ADDR_REDUND;
  52. /* CONFIG_ENV_ADDR_REDUND is supposed to be on sector boundary */
  53. static ulong __maybe_unused end_addr_new =
  54. CONFIG_ENV_ADDR_REDUND + CONFIG_ENV_SECT_SIZE - 1;
  55. #endif /* CONFIG_ENV_ADDR_REDUND */
  56. #ifdef CONFIG_ENV_ADDR_REDUND
  57. #ifdef INITENV
  58. static int env_flash_init(void)
  59. {
  60. int crc1_ok = 0, crc2_ok = 0;
  61. uchar flag1 = flash_addr->flags;
  62. uchar flag2 = flash_addr_new->flags;
  63. ulong addr_default = (ulong)&default_environment[0];
  64. ulong addr1 = (ulong)&(flash_addr->data);
  65. ulong addr2 = (ulong)&(flash_addr_new->data);
  66. crc1_ok = crc32(0, flash_addr->data, ENV_SIZE) == flash_addr->crc;
  67. crc2_ok =
  68. crc32(0, flash_addr_new->data, ENV_SIZE) == flash_addr_new->crc;
  69. if (crc1_ok && !crc2_ok) {
  70. gd->env_addr = addr1;
  71. gd->env_valid = ENV_VALID;
  72. } else if (!crc1_ok && crc2_ok) {
  73. gd->env_addr = addr2;
  74. gd->env_valid = ENV_VALID;
  75. } else if (!crc1_ok && !crc2_ok) {
  76. gd->env_addr = addr_default;
  77. gd->env_valid = ENV_INVALID;
  78. } else if (flag1 == ENV_REDUND_ACTIVE &&
  79. flag2 == ENV_REDUND_OBSOLETE) {
  80. gd->env_addr = addr1;
  81. gd->env_valid = ENV_VALID;
  82. } else if (flag1 == ENV_REDUND_OBSOLETE &&
  83. flag2 == ENV_REDUND_ACTIVE) {
  84. gd->env_addr = addr2;
  85. gd->env_valid = ENV_VALID;
  86. } else if (flag1 == flag2) {
  87. gd->env_addr = addr1;
  88. gd->env_valid = ENV_REDUND;
  89. } else if (flag1 == 0xFF) {
  90. gd->env_addr = addr1;
  91. gd->env_valid = ENV_REDUND;
  92. } else if (flag2 == 0xFF) {
  93. gd->env_addr = addr2;
  94. gd->env_valid = ENV_REDUND;
  95. }
  96. return 0;
  97. }
  98. #endif
  99. #ifdef CMD_SAVEENV
  100. static int env_flash_save(void)
  101. {
  102. env_t env_new;
  103. char *saved_data = NULL;
  104. char flag = ENV_REDUND_OBSOLETE, new_flag = ENV_REDUND_ACTIVE;
  105. int rc = 1;
  106. #if CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE
  107. ulong up_data = 0;
  108. #endif
  109. debug("Protect off %08lX ... %08lX\n", (ulong)flash_addr, end_addr);
  110. if (flash_sect_protect(0, (ulong)flash_addr, end_addr))
  111. goto done;
  112. debug("Protect off %08lX ... %08lX\n",
  113. (ulong)flash_addr_new, end_addr_new);
  114. if (flash_sect_protect(0, (ulong)flash_addr_new, end_addr_new))
  115. goto done;
  116. rc = env_export(&env_new);
  117. if (rc)
  118. return rc;
  119. env_new.flags = new_flag;
  120. #if CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE
  121. up_data = end_addr_new + 1 - ((long)flash_addr_new + CONFIG_ENV_SIZE);
  122. debug("Data to save 0x%lX\n", up_data);
  123. if (up_data) {
  124. saved_data = malloc(up_data);
  125. if (saved_data == NULL) {
  126. printf("Unable to save the rest of sector (%ld)\n",
  127. up_data);
  128. goto done;
  129. }
  130. memcpy(saved_data,
  131. (void *)((long)flash_addr_new + CONFIG_ENV_SIZE),
  132. up_data);
  133. debug("Data (start 0x%lX, len 0x%lX) saved at 0x%p\n",
  134. (long)flash_addr_new + CONFIG_ENV_SIZE,
  135. up_data, saved_data);
  136. }
  137. #endif
  138. puts("Erasing Flash...");
  139. debug(" %08lX ... %08lX ...", (ulong)flash_addr_new, end_addr_new);
  140. if (flash_sect_erase((ulong)flash_addr_new, end_addr_new))
  141. goto done;
  142. puts("Writing to Flash... ");
  143. debug(" %08lX ... %08lX ...",
  144. (ulong)&(flash_addr_new->data),
  145. sizeof(env_ptr->data) + (ulong)&(flash_addr_new->data));
  146. rc = flash_write((char *)&env_new, (ulong)flash_addr_new,
  147. sizeof(env_new));
  148. if (rc)
  149. goto perror;
  150. rc = flash_write(&flag, (ulong)&(flash_addr->flags),
  151. sizeof(flash_addr->flags));
  152. if (rc)
  153. goto perror;
  154. #if CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE
  155. if (up_data) { /* restore the rest of sector */
  156. debug("Restoring the rest of data to 0x%lX len 0x%lX\n",
  157. (long)flash_addr_new + CONFIG_ENV_SIZE, up_data);
  158. if (flash_write(saved_data,
  159. (long)flash_addr_new + CONFIG_ENV_SIZE,
  160. up_data))
  161. goto perror;
  162. }
  163. #endif
  164. puts("done\n");
  165. {
  166. env_t *etmp = flash_addr;
  167. ulong ltmp = end_addr;
  168. flash_addr = flash_addr_new;
  169. flash_addr_new = etmp;
  170. end_addr = end_addr_new;
  171. end_addr_new = ltmp;
  172. }
  173. rc = 0;
  174. goto done;
  175. perror:
  176. flash_perror(rc);
  177. done:
  178. if (saved_data)
  179. free(saved_data);
  180. /* try to re-protect */
  181. flash_sect_protect(1, (ulong)flash_addr, end_addr);
  182. flash_sect_protect(1, (ulong)flash_addr_new, end_addr_new);
  183. return rc;
  184. }
  185. #endif /* CMD_SAVEENV */
  186. #else /* ! CONFIG_ENV_ADDR_REDUND */
  187. #ifdef INITENV
  188. static int env_flash_init(void)
  189. {
  190. if (crc32(0, env_ptr->data, ENV_SIZE) == env_ptr->crc) {
  191. gd->env_addr = (ulong)&(env_ptr->data);
  192. gd->env_valid = ENV_VALID;
  193. return 0;
  194. }
  195. gd->env_addr = (ulong)&default_environment[0];
  196. gd->env_valid = ENV_INVALID;
  197. return 0;
  198. }
  199. #endif
  200. #ifdef CMD_SAVEENV
  201. static int env_flash_save(void)
  202. {
  203. env_t env_new;
  204. int rc = 1;
  205. char *saved_data = NULL;
  206. #if CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE
  207. ulong up_data = 0;
  208. up_data = end_addr + 1 - ((long)flash_addr + CONFIG_ENV_SIZE);
  209. debug("Data to save 0x%lx\n", up_data);
  210. if (up_data) {
  211. saved_data = malloc(up_data);
  212. if (saved_data == NULL) {
  213. printf("Unable to save the rest of sector (%ld)\n",
  214. up_data);
  215. goto done;
  216. }
  217. memcpy(saved_data,
  218. (void *)((long)flash_addr + CONFIG_ENV_SIZE), up_data);
  219. debug("Data (start 0x%lx, len 0x%lx) saved at 0x%lx\n",
  220. (ulong)flash_addr + CONFIG_ENV_SIZE,
  221. up_data,
  222. (ulong)saved_data);
  223. }
  224. #endif /* CONFIG_ENV_SECT_SIZE */
  225. debug("Protect off %08lX ... %08lX\n", (ulong)flash_addr, end_addr);
  226. if (flash_sect_protect(0, (long)flash_addr, end_addr))
  227. goto done;
  228. rc = env_export(&env_new);
  229. if (rc)
  230. goto done;
  231. puts("Erasing Flash...");
  232. if (flash_sect_erase((long)flash_addr, end_addr))
  233. goto done;
  234. puts("Writing to Flash... ");
  235. rc = flash_write((char *)&env_new, (long)flash_addr, CONFIG_ENV_SIZE);
  236. if (rc != 0)
  237. goto perror;
  238. #if CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE
  239. if (up_data) { /* restore the rest of sector */
  240. debug("Restoring the rest of data to 0x%lx len 0x%lx\n",
  241. (ulong)flash_addr + CONFIG_ENV_SIZE, up_data);
  242. if (flash_write(saved_data,
  243. (long)flash_addr + CONFIG_ENV_SIZE,
  244. up_data))
  245. goto perror;
  246. }
  247. #endif
  248. puts("done\n");
  249. rc = 0;
  250. goto done;
  251. perror:
  252. flash_perror(rc);
  253. done:
  254. if (saved_data)
  255. free(saved_data);
  256. /* try to re-protect */
  257. flash_sect_protect(1, (long)flash_addr, end_addr);
  258. return rc;
  259. }
  260. #endif /* CMD_SAVEENV */
  261. #endif /* CONFIG_ENV_ADDR_REDUND */
  262. #ifdef LOADENV
  263. static int env_flash_load(void)
  264. {
  265. #ifdef CONFIG_ENV_ADDR_REDUND
  266. if (gd->env_addr != (ulong)&(flash_addr->data)) {
  267. env_t *etmp = flash_addr;
  268. ulong ltmp = end_addr;
  269. flash_addr = flash_addr_new;
  270. flash_addr_new = etmp;
  271. end_addr = end_addr_new;
  272. end_addr_new = ltmp;
  273. }
  274. if (flash_addr_new->flags != ENV_REDUND_OBSOLETE &&
  275. crc32(0, flash_addr_new->data, ENV_SIZE) == flash_addr_new->crc) {
  276. char flag = ENV_REDUND_OBSOLETE;
  277. gd->env_valid = ENV_REDUND;
  278. flash_sect_protect(0, (ulong)flash_addr_new, end_addr_new);
  279. flash_write(&flag,
  280. (ulong)&(flash_addr_new->flags),
  281. sizeof(flash_addr_new->flags));
  282. flash_sect_protect(1, (ulong)flash_addr_new, end_addr_new);
  283. }
  284. if (flash_addr->flags != ENV_REDUND_ACTIVE &&
  285. (flash_addr->flags & ENV_REDUND_ACTIVE) == ENV_REDUND_ACTIVE) {
  286. char flag = ENV_REDUND_ACTIVE;
  287. gd->env_valid = ENV_REDUND;
  288. flash_sect_protect(0, (ulong)flash_addr, end_addr);
  289. flash_write(&flag,
  290. (ulong)&(flash_addr->flags),
  291. sizeof(flash_addr->flags));
  292. flash_sect_protect(1, (ulong)flash_addr, end_addr);
  293. }
  294. if (gd->env_valid == ENV_REDUND)
  295. puts("*** Warning - some problems detected "
  296. "reading environment; recovered successfully\n\n");
  297. #endif /* CONFIG_ENV_ADDR_REDUND */
  298. return env_import((char *)flash_addr, 1);
  299. }
  300. #endif /* LOADENV */
  301. U_BOOT_ENV_LOCATION(flash) = {
  302. .location = ENVL_FLASH,
  303. ENV_NAME("Flash")
  304. #ifdef LOADENV
  305. .load = env_flash_load,
  306. #endif
  307. #ifdef CMD_SAVEENV
  308. .save = env_save_ptr(env_flash_save),
  309. #endif
  310. #ifdef INITENV
  311. .init = env_flash_init,
  312. #endif
  313. };