flash.c 9.1 KB

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