flash.c 9.1 KB

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