sf.c 9.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462
  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. * (C) Copyright 2008 Atmel Corporation
  10. */
  11. #include <common.h>
  12. #include <dm.h>
  13. #include <env.h>
  14. #include <env_internal.h>
  15. #include <flash.h>
  16. #include <malloc.h>
  17. #include <spi.h>
  18. #include <spi_flash.h>
  19. #include <search.h>
  20. #include <errno.h>
  21. #include <uuid.h>
  22. #include <asm/cache.h>
  23. #include <asm/global_data.h>
  24. #include <dm/device-internal.h>
  25. #include <u-boot/crc.h>
  26. #ifndef CONFIG_SPL_BUILD
  27. #define INITENV
  28. #endif
  29. #define OFFSET_INVALID (~(u32)0)
  30. #ifdef CONFIG_ENV_OFFSET_REDUND
  31. #define ENV_OFFSET_REDUND CONFIG_ENV_OFFSET_REDUND
  32. static ulong env_offset = CONFIG_ENV_OFFSET;
  33. static ulong env_new_offset = CONFIG_ENV_OFFSET_REDUND;
  34. #else
  35. #define ENV_OFFSET_REDUND OFFSET_INVALID
  36. #endif /* CONFIG_ENV_OFFSET_REDUND */
  37. DECLARE_GLOBAL_DATA_PTR;
  38. static struct spi_flash *env_flash;
  39. static int setup_flash_device(void)
  40. {
  41. #if CONFIG_IS_ENABLED(DM_SPI_FLASH)
  42. struct udevice *new;
  43. int ret;
  44. /* speed and mode will be read from DT */
  45. ret = spi_flash_probe_bus_cs(CONFIG_ENV_SPI_BUS, CONFIG_ENV_SPI_CS,
  46. CONFIG_ENV_SPI_MAX_HZ, CONFIG_ENV_SPI_MODE,
  47. &new);
  48. if (ret) {
  49. env_set_default("spi_flash_probe_bus_cs() failed", 0);
  50. return ret;
  51. }
  52. env_flash = dev_get_uclass_priv(new);
  53. #else
  54. if (env_flash)
  55. spi_flash_free(env_flash);
  56. env_flash = spi_flash_probe(CONFIG_ENV_SPI_BUS, CONFIG_ENV_SPI_CS,
  57. CONFIG_ENV_SPI_MAX_HZ, CONFIG_ENV_SPI_MODE);
  58. if (!env_flash) {
  59. env_set_default("spi_flash_probe() failed", 0);
  60. return -EIO;
  61. }
  62. #endif
  63. return 0;
  64. }
  65. #if defined(CONFIG_ENV_OFFSET_REDUND)
  66. static int env_sf_save(void)
  67. {
  68. env_t env_new;
  69. char *saved_buffer = NULL, flag = ENV_REDUND_OBSOLETE;
  70. u32 saved_size = 0, saved_offset = 0, sector;
  71. u32 sect_size = CONFIG_ENV_SECT_SIZE;
  72. int ret;
  73. ret = setup_flash_device();
  74. if (ret)
  75. return ret;
  76. if (IS_ENABLED(CONFIG_ENV_SECT_SIZE_AUTO))
  77. sect_size = env_flash->mtd.erasesize;
  78. ret = env_export(&env_new);
  79. if (ret)
  80. return -EIO;
  81. env_new.flags = ENV_REDUND_ACTIVE;
  82. if (gd->env_valid == ENV_VALID) {
  83. env_new_offset = CONFIG_ENV_OFFSET_REDUND;
  84. env_offset = CONFIG_ENV_OFFSET;
  85. } else {
  86. env_new_offset = CONFIG_ENV_OFFSET;
  87. env_offset = CONFIG_ENV_OFFSET_REDUND;
  88. }
  89. /* Is the sector larger than the env (i.e. embedded) */
  90. if (sect_size > CONFIG_ENV_SIZE) {
  91. saved_size = sect_size - CONFIG_ENV_SIZE;
  92. saved_offset = env_new_offset + CONFIG_ENV_SIZE;
  93. saved_buffer = memalign(ARCH_DMA_MINALIGN, saved_size);
  94. if (!saved_buffer) {
  95. ret = -ENOMEM;
  96. goto done;
  97. }
  98. ret = spi_flash_read(env_flash, saved_offset,
  99. saved_size, saved_buffer);
  100. if (ret)
  101. goto done;
  102. }
  103. sector = DIV_ROUND_UP(CONFIG_ENV_SIZE, sect_size);
  104. puts("Erasing SPI flash...");
  105. ret = spi_flash_erase(env_flash, env_new_offset,
  106. sector * sect_size);
  107. if (ret)
  108. goto done;
  109. puts("Writing to SPI flash...");
  110. ret = spi_flash_write(env_flash, env_new_offset,
  111. CONFIG_ENV_SIZE, &env_new);
  112. if (ret)
  113. goto done;
  114. if (sect_size > CONFIG_ENV_SIZE) {
  115. ret = spi_flash_write(env_flash, saved_offset,
  116. saved_size, saved_buffer);
  117. if (ret)
  118. goto done;
  119. }
  120. ret = spi_flash_write(env_flash, env_offset + offsetof(env_t, flags),
  121. sizeof(env_new.flags), &flag);
  122. if (ret)
  123. goto done;
  124. puts("done\n");
  125. gd->env_valid = gd->env_valid == ENV_REDUND ? ENV_VALID : ENV_REDUND;
  126. printf("Valid environment: %d\n", (int)gd->env_valid);
  127. done:
  128. spi_flash_free(env_flash);
  129. env_flash = NULL;
  130. if (saved_buffer)
  131. free(saved_buffer);
  132. return ret;
  133. }
  134. static int env_sf_load(void)
  135. {
  136. int ret;
  137. int read1_fail, read2_fail;
  138. env_t *tmp_env1, *tmp_env2;
  139. tmp_env1 = (env_t *)memalign(ARCH_DMA_MINALIGN,
  140. CONFIG_ENV_SIZE);
  141. tmp_env2 = (env_t *)memalign(ARCH_DMA_MINALIGN,
  142. CONFIG_ENV_SIZE);
  143. if (!tmp_env1 || !tmp_env2) {
  144. env_set_default("malloc() failed", 0);
  145. ret = -EIO;
  146. goto out;
  147. }
  148. ret = setup_flash_device();
  149. if (ret)
  150. goto out;
  151. read1_fail = spi_flash_read(env_flash, CONFIG_ENV_OFFSET,
  152. CONFIG_ENV_SIZE, tmp_env1);
  153. read2_fail = spi_flash_read(env_flash, CONFIG_ENV_OFFSET_REDUND,
  154. CONFIG_ENV_SIZE, tmp_env2);
  155. ret = env_import_redund((char *)tmp_env1, read1_fail, (char *)tmp_env2,
  156. read2_fail, H_EXTERNAL);
  157. spi_flash_free(env_flash);
  158. env_flash = NULL;
  159. out:
  160. free(tmp_env1);
  161. free(tmp_env2);
  162. return ret;
  163. }
  164. #else
  165. static int env_sf_save(void)
  166. {
  167. u32 saved_size = 0, saved_offset = 0, sector;
  168. u32 sect_size = CONFIG_ENV_SECT_SIZE;
  169. char *saved_buffer = NULL;
  170. int ret = 1;
  171. env_t env_new;
  172. ret = setup_flash_device();
  173. if (ret)
  174. return ret;
  175. if (IS_ENABLED(CONFIG_ENV_SECT_SIZE_AUTO))
  176. sect_size = env_flash->mtd.erasesize;
  177. /* Is the sector larger than the env (i.e. embedded) */
  178. if (sect_size > CONFIG_ENV_SIZE) {
  179. saved_size = sect_size - CONFIG_ENV_SIZE;
  180. saved_offset = CONFIG_ENV_OFFSET + CONFIG_ENV_SIZE;
  181. saved_buffer = malloc(saved_size);
  182. if (!saved_buffer)
  183. goto done;
  184. ret = spi_flash_read(env_flash, saved_offset,
  185. saved_size, saved_buffer);
  186. if (ret)
  187. goto done;
  188. }
  189. ret = env_export(&env_new);
  190. if (ret)
  191. goto done;
  192. sector = DIV_ROUND_UP(CONFIG_ENV_SIZE, sect_size);
  193. puts("Erasing SPI flash...");
  194. ret = spi_flash_erase(env_flash, CONFIG_ENV_OFFSET,
  195. sector * sect_size);
  196. if (ret)
  197. goto done;
  198. puts("Writing to SPI flash...");
  199. ret = spi_flash_write(env_flash, CONFIG_ENV_OFFSET,
  200. CONFIG_ENV_SIZE, &env_new);
  201. if (ret)
  202. goto done;
  203. if (sect_size > CONFIG_ENV_SIZE) {
  204. ret = spi_flash_write(env_flash, saved_offset,
  205. saved_size, saved_buffer);
  206. if (ret)
  207. goto done;
  208. }
  209. ret = 0;
  210. puts("done\n");
  211. done:
  212. spi_flash_free(env_flash);
  213. env_flash = NULL;
  214. if (saved_buffer)
  215. free(saved_buffer);
  216. return ret;
  217. }
  218. static int env_sf_load(void)
  219. {
  220. int ret;
  221. char *buf = NULL;
  222. buf = (char *)memalign(ARCH_DMA_MINALIGN, CONFIG_ENV_SIZE);
  223. if (!buf) {
  224. env_set_default("malloc() failed", 0);
  225. return -EIO;
  226. }
  227. ret = setup_flash_device();
  228. if (ret)
  229. goto out;
  230. ret = spi_flash_read(env_flash,
  231. CONFIG_ENV_OFFSET, CONFIG_ENV_SIZE, buf);
  232. if (ret) {
  233. env_set_default("spi_flash_read() failed", 0);
  234. goto err_read;
  235. }
  236. ret = env_import(buf, 1, H_EXTERNAL);
  237. if (!ret)
  238. gd->env_valid = ENV_VALID;
  239. err_read:
  240. spi_flash_free(env_flash);
  241. env_flash = NULL;
  242. out:
  243. free(buf);
  244. return ret;
  245. }
  246. #endif
  247. static int env_sf_erase(void)
  248. {
  249. int ret;
  250. env_t env;
  251. ret = setup_flash_device();
  252. if (ret)
  253. return ret;
  254. memset(&env, 0, sizeof(env_t));
  255. ret = spi_flash_write(env_flash, CONFIG_ENV_OFFSET, CONFIG_ENV_SIZE, &env);
  256. if (ret)
  257. goto done;
  258. if (ENV_OFFSET_REDUND != OFFSET_INVALID)
  259. ret = spi_flash_write(env_flash, ENV_OFFSET_REDUND, CONFIG_ENV_SIZE, &env);
  260. done:
  261. spi_flash_free(env_flash);
  262. env_flash = NULL;
  263. return ret;
  264. }
  265. #if CONFIG_ENV_ADDR != 0x0
  266. __weak void *env_sf_get_env_addr(void)
  267. {
  268. return (void *)CONFIG_ENV_ADDR;
  269. }
  270. #endif
  271. #if defined(INITENV) && (CONFIG_ENV_ADDR != 0x0)
  272. /*
  273. * check if Environment on CONFIG_ENV_ADDR is valid.
  274. */
  275. static int env_sf_init_addr(void)
  276. {
  277. env_t *env_ptr = (env_t *)env_sf_get_env_addr();
  278. if (crc32(0, env_ptr->data, ENV_SIZE) == env_ptr->crc) {
  279. gd->env_addr = (ulong)&(env_ptr->data);
  280. gd->env_valid = 1;
  281. } else {
  282. gd->env_addr = (ulong)&default_environment[0];
  283. gd->env_valid = 1;
  284. }
  285. return 0;
  286. }
  287. #endif
  288. #if defined(CONFIG_ENV_SPI_EARLY)
  289. /*
  290. * early load environment from SPI flash (before relocation)
  291. * and check if it is valid.
  292. */
  293. static int env_sf_init_early(void)
  294. {
  295. int ret;
  296. int read1_fail;
  297. int read2_fail;
  298. int crc1_ok;
  299. env_t *tmp_env2 = NULL;
  300. env_t *tmp_env1;
  301. /*
  302. * if malloc is not ready yet, we cannot use
  303. * this part yet.
  304. */
  305. if (!gd->malloc_limit)
  306. return -ENOENT;
  307. tmp_env1 = (env_t *)memalign(ARCH_DMA_MINALIGN,
  308. CONFIG_ENV_SIZE);
  309. if (IS_ENABLED(CONFIG_SYS_REDUNDAND_ENVIRONMENT))
  310. tmp_env2 = (env_t *)memalign(ARCH_DMA_MINALIGN,
  311. CONFIG_ENV_SIZE);
  312. if (!tmp_env1 || !tmp_env2)
  313. goto out;
  314. ret = setup_flash_device();
  315. if (ret)
  316. goto out;
  317. read1_fail = spi_flash_read(env_flash, CONFIG_ENV_OFFSET,
  318. CONFIG_ENV_SIZE, tmp_env1);
  319. if (IS_ENABLED(CONFIG_SYS_REDUNDAND_ENVIRONMENT)) {
  320. read2_fail = spi_flash_read(env_flash,
  321. CONFIG_ENV_OFFSET_REDUND,
  322. CONFIG_ENV_SIZE, tmp_env2);
  323. ret = env_check_redund((char *)tmp_env1, read1_fail,
  324. (char *)tmp_env2, read2_fail);
  325. if (ret < 0)
  326. goto err_read;
  327. if (gd->env_valid == ENV_VALID)
  328. gd->env_addr = (unsigned long)&tmp_env1->data;
  329. else
  330. gd->env_addr = (unsigned long)&tmp_env2->data;
  331. } else {
  332. if (read1_fail)
  333. goto err_read;
  334. crc1_ok = crc32(0, tmp_env1->data, ENV_SIZE) ==
  335. tmp_env1->crc;
  336. if (!crc1_ok)
  337. goto err_read;
  338. /* if valid -> this is our env */
  339. gd->env_valid = ENV_VALID;
  340. gd->env_addr = (unsigned long)&tmp_env1->data;
  341. }
  342. spi_flash_free(env_flash);
  343. env_flash = NULL;
  344. return 0;
  345. err_read:
  346. spi_flash_free(env_flash);
  347. env_flash = NULL;
  348. free(tmp_env1);
  349. if (IS_ENABLED(CONFIG_SYS_REDUNDAND_ENVIRONMENT))
  350. free(tmp_env2);
  351. out:
  352. /* env is not valid. always return 0 */
  353. gd->env_valid = ENV_INVALID;
  354. return 0;
  355. }
  356. #endif
  357. static int env_sf_init(void)
  358. {
  359. #if defined(INITENV) && (CONFIG_ENV_ADDR != 0x0)
  360. return env_sf_init_addr();
  361. #elif defined(CONFIG_ENV_SPI_EARLY)
  362. return env_sf_init_early();
  363. #endif
  364. /*
  365. * return here -ENOENT, so env_init()
  366. * can set the init bit and later if no
  367. * other Environment storage is defined
  368. * can set the default environment
  369. */
  370. return -ENOENT;
  371. }
  372. U_BOOT_ENV_LOCATION(sf) = {
  373. .location = ENVL_SPI_FLASH,
  374. ENV_NAME("SPIFlash")
  375. .load = env_sf_load,
  376. .save = ENV_SAVE_PTR(env_sf_save),
  377. .erase = ENV_ERASE_PTR(env_sf_erase),
  378. .init = env_sf_init,
  379. };