flash.c 9.2 KB

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