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