spi_flash.h 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561
  1. // Copyright 2010-2016 Espressif Systems (Shanghai) PTE LTD
  2. //
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. //
  7. // http://www.apache.org/licenses/LICENSE-2.0
  8. //
  9. // Unless required by applicable law or agreed to in writing, software
  10. // distributed under the License is distributed on an "AS IS" BASIS,
  11. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. // See the License for the specific language governing permissions and
  13. // limitations under the License.
  14. #ifndef _ROM_SPI_FLASH_H_
  15. #define _ROM_SPI_FLASH_H_
  16. #include <stdint.h>
  17. #include <stdbool.h>
  18. #include "esp_attr.h"
  19. #include "soc/spi_reg.h"
  20. #ifdef __cplusplus
  21. extern "C" {
  22. #endif
  23. /** \defgroup spi_flash_apis, spi flash operation related apis
  24. * @brief spi_flash apis
  25. */
  26. /** @addtogroup spi_flash_apis
  27. * @{
  28. */
  29. /*************************************************************
  30. * Note
  31. *************************************************************
  32. * 1. ESP32 chip have 4 SPI slave/master, however, SPI0 is
  33. * used as an SPI master to access Flash and ext-SRAM by
  34. * Cache module. It will support Decryto read for Flash,
  35. * read/write for ext-SRAM. And SPI1 is also used as an
  36. * SPI master for Flash read/write and ext-SRAM read/write.
  37. * It will support Encrypto write for Flash.
  38. * 2. As an SPI master, SPI support Highest clock to 80M,
  39. * however, Flash with 80M Clock should be configured
  40. * for different Flash chips. If you want to use 80M
  41. * clock We should use the SPI that is certified by
  42. * Espressif. However, the certification is not started
  43. * at the time, so please use 40M clock at the moment.
  44. * 3. SPI Flash can use 2 lines or 4 lines mode. If you
  45. * use 2 lines mode, you can save two pad SPIHD and
  46. * SPIWP for gpio. ESP32 support configured SPI pad for
  47. * Flash, the configuration is stored in efuse and flash.
  48. * However, the configurations of pads should be certified
  49. * by Espressif. If you use this function, please use 40M
  50. * clock at the moment.
  51. * 4. ESP32 support to use Common SPI command to configure
  52. * Flash to QIO mode, if you failed to configure with fix
  53. * command. With Common SPI Command, ESP32 can also provide
  54. * a way to use same Common SPI command groups on different
  55. * Flash chips.
  56. * 5. This functions are not protected by packeting, Please use the
  57. *************************************************************
  58. */
  59. #define PERIPHS_SPI_FLASH_CMD SPI_CMD_REG(1)
  60. #define PERIPHS_SPI_FLASH_ADDR SPI_ADDR_REG(1)
  61. #define PERIPHS_SPI_FLASH_CTRL SPI_CTRL_REG(1)
  62. #define PERIPHS_SPI_FLASH_CTRL1 SPI_CTRL1_REG(1)
  63. #define PERIPHS_SPI_FLASH_STATUS SPI_RD_STATUS_REG(1)
  64. #define PERIPHS_SPI_FLASH_USRREG SPI_USER_REG(1)
  65. #define PERIPHS_SPI_FLASH_USRREG1 SPI_USER1_REG(1)
  66. #define PERIPHS_SPI_FLASH_USRREG2 SPI_USER2_REG(1)
  67. #define PERIPHS_SPI_FLASH_C0 SPI_W0_REG(1)
  68. #define PERIPHS_SPI_FLASH_C1 SPI_W1_REG(1)
  69. #define PERIPHS_SPI_FLASH_C2 SPI_W2_REG(1)
  70. #define PERIPHS_SPI_FLASH_C3 SPI_W3_REG(1)
  71. #define PERIPHS_SPI_FLASH_C4 SPI_W4_REG(1)
  72. #define PERIPHS_SPI_FLASH_C5 SPI_W5_REG(1)
  73. #define PERIPHS_SPI_FLASH_C6 SPI_W6_REG(1)
  74. #define PERIPHS_SPI_FLASH_C7 SPI_W7_REG(1)
  75. #define PERIPHS_SPI_FLASH_TX_CRC SPI_TX_CRC_REG(1)
  76. #define SPI0_R_QIO_DUMMY_CYCLELEN 3
  77. #define SPI0_R_QIO_ADDR_BITSLEN 31
  78. #define SPI0_R_FAST_DUMMY_CYCLELEN 7
  79. #define SPI0_R_DIO_DUMMY_CYCLELEN 1
  80. #define SPI0_R_DIO_ADDR_BITSLEN 27
  81. #define SPI0_R_FAST_ADDR_BITSLEN 23
  82. #define SPI0_R_SIO_ADDR_BITSLEN 23
  83. #define SPI1_R_QIO_DUMMY_CYCLELEN 3
  84. #define SPI1_R_QIO_ADDR_BITSLEN 31
  85. #define SPI1_R_FAST_DUMMY_CYCLELEN 7
  86. #define SPI1_R_DIO_DUMMY_CYCLELEN 3
  87. #define SPI1_R_DIO_ADDR_BITSLEN 31
  88. #define SPI1_R_FAST_ADDR_BITSLEN 23
  89. #define SPI1_R_SIO_ADDR_BITSLEN 23
  90. #define ESP_ROM_SPIFLASH_W_SIO_ADDR_BITSLEN 23
  91. #define ESP_ROM_SPIFLASH_TWO_BYTE_STATUS_EN SPI_WRSR_2B
  92. //SPI address register
  93. #define ESP_ROM_SPIFLASH_BYTES_LEN 24
  94. #define ESP_ROM_SPIFLASH_BUFF_BYTE_WRITE_NUM 32
  95. #define ESP_ROM_SPIFLASH_BUFF_BYTE_READ_NUM 64
  96. #define ESP_ROM_SPIFLASH_BUFF_BYTE_READ_BITS 0x3f
  97. //SPI status register
  98. #define ESP_ROM_SPIFLASH_BUSY_FLAG BIT0
  99. #define ESP_ROM_SPIFLASH_WRENABLE_FLAG BIT1
  100. #define ESP_ROM_SPIFLASH_BP0 BIT2
  101. #define ESP_ROM_SPIFLASH_BP1 BIT3
  102. #define ESP_ROM_SPIFLASH_BP2 BIT4
  103. #define ESP_ROM_SPIFLASH_WR_PROTECT (ESP_ROM_SPIFLASH_BP0|ESP_ROM_SPIFLASH_BP1|ESP_ROM_SPIFLASH_BP2)
  104. #define ESP_ROM_SPIFLASH_QE BIT9
  105. //Extra dummy for flash read
  106. #define ESP_ROM_SPIFLASH_DUMMY_LEN_PLUS_20M 0
  107. #define ESP_ROM_SPIFLASH_DUMMY_LEN_PLUS_40M 1
  108. #define ESP_ROM_SPIFLASH_DUMMY_LEN_PLUS_80M 2
  109. #define FLASH_ID_GD25LQ32C 0xC86016
  110. typedef enum {
  111. ESP_ROM_SPIFLASH_QIO_MODE = 0,
  112. ESP_ROM_SPIFLASH_QOUT_MODE,
  113. ESP_ROM_SPIFLASH_DIO_MODE,
  114. ESP_ROM_SPIFLASH_DOUT_MODE,
  115. ESP_ROM_SPIFLASH_FASTRD_MODE,
  116. ESP_ROM_SPIFLASH_SLOWRD_MODE
  117. } esp_rom_spiflash_read_mode_t;
  118. typedef enum {
  119. ESP_ROM_SPIFLASH_RESULT_OK,
  120. ESP_ROM_SPIFLASH_RESULT_ERR,
  121. ESP_ROM_SPIFLASH_RESULT_TIMEOUT
  122. } esp_rom_spiflash_result_t;
  123. typedef struct {
  124. uint32_t device_id;
  125. uint32_t chip_size; // chip size in bytes
  126. uint32_t block_size;
  127. uint32_t sector_size;
  128. uint32_t page_size;
  129. uint32_t status_mask;
  130. } esp_rom_spiflash_chip_t;
  131. typedef struct {
  132. uint8_t data_length;
  133. uint8_t read_cmd0;
  134. uint8_t read_cmd1;
  135. uint8_t write_cmd;
  136. uint16_t data_mask;
  137. uint16_t data;
  138. } esp_rom_spiflash_common_cmd_t;
  139. /**
  140. * @brief Fix the bug in SPI hardware communication with Flash/Ext-SRAM in High Speed.
  141. * Please do not call this function in SDK.
  142. *
  143. * @param uint8_t spi: 0 for SPI0(Cache Access), 1 for SPI1(Flash read/write).
  144. *
  145. * @param uint8_t freqdiv: Pll is 80M, 4 for 20M, 3 for 26.7M, 2 for 40M, 1 for 80M.
  146. *
  147. * @return None
  148. */
  149. void esp_rom_spiflash_fix_dummylen(uint8_t spi, uint8_t freqdiv);
  150. /**
  151. * @brief Select SPI Flash to QIO mode when WP pad is read from Flash.
  152. * Please do not call this function in SDK.
  153. *
  154. * @param uint8_t wp_gpio_num: WP gpio number.
  155. *
  156. * @param uint32_t ishspi: 0 for spi, 1 for hspi, flash pad decided by strapping
  157. * else, bit[5:0] spiclk, bit[11:6] spiq, bit[17:12] spid, bit[23:18] spics0, bit[29:24] spihd
  158. *
  159. * @return None
  160. */
  161. void esp_rom_spiflash_select_qiomode(uint8_t wp_gpio_num, uint32_t ishspi);
  162. /**
  163. * @brief Set SPI Flash pad drivers.
  164. * Please do not call this function in SDK.
  165. *
  166. * @param uint8_t wp_gpio_num: WP gpio number.
  167. *
  168. * @param uint32_t ishspi: 0 for spi, 1 for hspi, flash pad decided by strapping
  169. * else, bit[5:0] spiclk, bit[11:6] spiq, bit[17:12] spid, bit[23:18] spics0, bit[29:24] spihd
  170. *
  171. * @param uint8_t *drvs: drvs[0]-bit[3:0] for cpiclk, bit[7:4] for spiq, drvs[1]-bit[3:0] for spid, drvs[1]-bit[7:4] for spid
  172. * drvs[2]-bit[3:0] for spihd, drvs[2]-bit[7:4] for spiwp.
  173. * Values usually read from falsh by rom code, function usually callde by rom code.
  174. * if value with bit(3) set, the value is valid, bit[2:0] is the real value.
  175. *
  176. * @return None
  177. */
  178. void esp_rom_spiflash_set_drvs(uint8_t wp_gpio_num, uint32_t ishspi, uint8_t *drvs);
  179. /**
  180. * @brief Select SPI Flash function for pads.
  181. * Please do not call this function in SDK.
  182. *
  183. * @param uint32_t ishspi: 0 for spi, 1 for hspi, flash pad decided by strapping
  184. * else, bit[5:0] spiclk, bit[11:6] spiq, bit[17:12] spid, bit[23:18] spics0, bit[29:24] spihd
  185. *
  186. * @return None
  187. */
  188. void esp_rom_spiflash_select_padsfunc(uint32_t ishspi);
  189. /**
  190. * @brief SPI Flash init, clock divisor is 4, use 1 line Slow read mode.
  191. * Please do not call this function in SDK.
  192. *
  193. * @param uint32_t ishspi: 0 for spi, 1 for hspi, flash pad decided by strapping
  194. * else, bit[5:0] spiclk, bit[11:6] spiq, bit[17:12] spid, bit[23:18] spics0, bit[29:24] spihd
  195. *
  196. * @param uint8_t legacy: In legacy mode, more SPI command is used in line.
  197. *
  198. * @return None
  199. */
  200. void esp_rom_spiflash_attach(uint32_t ishspi, bool legacy);
  201. /**
  202. * @brief SPI Read Flash status register. We use CMD 0x05 (RDSR).
  203. * Please do not call this function in SDK.
  204. *
  205. * @param esp_rom_spiflash_chip_t *spi : The information for Flash, which is exported from ld file.
  206. *
  207. * @param uint32_t *status : The pointer to which to return the Flash status value.
  208. *
  209. * @return ESP_ROM_SPIFLASH_RESULT_OK : read OK.
  210. * ESP_ROM_SPIFLASH_RESULT_ERR : read error.
  211. * ESP_ROM_SPIFLASH_RESULT_TIMEOUT : read timeout.
  212. */
  213. esp_rom_spiflash_result_t esp_rom_spiflash_read_status(esp_rom_spiflash_chip_t *spi, uint32_t *status);
  214. /**
  215. * @brief SPI Read Flash status register bits 8-15. We use CMD 0x35 (RDSR2).
  216. * Please do not call this function in SDK.
  217. *
  218. * @param esp_rom_spiflash_chip_t *spi : The information for Flash, which is exported from ld file.
  219. *
  220. * @param uint32_t *status : The pointer to which to return the Flash status value.
  221. *
  222. * @return ESP_ROM_SPIFLASH_RESULT_OK : read OK.
  223. * ESP_ROM_SPIFLASH_RESULT_ERR : read error.
  224. * ESP_ROM_SPIFLASH_RESULT_TIMEOUT : read timeout.
  225. */
  226. esp_rom_spiflash_result_t esp_rom_spiflash_read_statushigh(esp_rom_spiflash_chip_t *spi, uint32_t *status);
  227. /**
  228. * @brief Write status to Falsh status register.
  229. * Please do not call this function in SDK.
  230. *
  231. * @param esp_rom_spiflash_chip_t *spi : The information for Flash, which is exported from ld file.
  232. *
  233. * @param uint32_t status_value : Value to .
  234. *
  235. * @return ESP_ROM_SPIFLASH_RESULT_OK : write OK.
  236. * ESP_ROM_SPIFLASH_RESULT_ERR : write error.
  237. * ESP_ROM_SPIFLASH_RESULT_TIMEOUT : write timeout.
  238. */
  239. esp_rom_spiflash_result_t esp_rom_spiflash_write_status(esp_rom_spiflash_chip_t *spi, uint32_t status_value);
  240. /**
  241. * @brief Use a command to Read Flash status register.
  242. * Please do not call this function in SDK.
  243. *
  244. * @param esp_rom_spiflash_chip_t *spi : The information for Flash, which is exported from ld file.
  245. *
  246. * @param uint32_t*status : The pointer to which to return the Flash status value.
  247. *
  248. * @return ESP_ROM_SPIFLASH_RESULT_OK : read OK.
  249. * ESP_ROM_SPIFLASH_RESULT_ERR : read error.
  250. * ESP_ROM_SPIFLASH_RESULT_TIMEOUT : read timeout.
  251. */
  252. esp_rom_spiflash_result_t esp_rom_spiflash_read_user_cmd(uint32_t *status, uint8_t cmd);
  253. /**
  254. * @brief Config SPI Flash read mode when init.
  255. * Please do not call this function in SDK.
  256. *
  257. * @param esp_rom_spiflash_read_mode_t mode : QIO/QOUT/DIO/DOUT/FastRD/SlowRD.
  258. *
  259. * This function does not try to set the QIO Enable bit in the status register, caller is responsible for this.
  260. *
  261. * @return ESP_ROM_SPIFLASH_RESULT_OK : config OK.
  262. * ESP_ROM_SPIFLASH_RESULT_ERR : config error.
  263. * ESP_ROM_SPIFLASH_RESULT_TIMEOUT : config timeout.
  264. */
  265. esp_rom_spiflash_result_t esp_rom_spiflash_config_readmode(esp_rom_spiflash_read_mode_t mode);
  266. /**
  267. * @brief Config SPI Flash clock divisor.
  268. * Please do not call this function in SDK.
  269. *
  270. * @param uint8_t freqdiv: clock divisor.
  271. *
  272. * @param uint8_t spi: 0 for SPI0, 1 for SPI1.
  273. *
  274. * @return ESP_ROM_SPIFLASH_RESULT_OK : config OK.
  275. * ESP_ROM_SPIFLASH_RESULT_ERR : config error.
  276. * ESP_ROM_SPIFLASH_RESULT_TIMEOUT : config timeout.
  277. */
  278. esp_rom_spiflash_result_t esp_rom_spiflash_config_clk(uint8_t freqdiv, uint8_t spi);
  279. /**
  280. * @brief Send CommonCmd to Flash so that is can go into QIO mode, some Flash use different CMD.
  281. * Please do not call this function in SDK.
  282. *
  283. * @param esp_rom_spiflash_common_cmd_t *cmd : A struct to show the action of a command.
  284. *
  285. * @return uint16_t 0 : do not send command any more.
  286. * 1 : go to the next command.
  287. * n > 1 : skip (n - 1) commands.
  288. */
  289. uint16_t esp_rom_spiflash_common_cmd(esp_rom_spiflash_common_cmd_t *cmd);
  290. /**
  291. * @brief Unlock SPI write protect.
  292. * Please do not call this function in SDK.
  293. *
  294. * @param None.
  295. *
  296. * @return ESP_ROM_SPIFLASH_RESULT_OK : Unlock OK.
  297. * ESP_ROM_SPIFLASH_RESULT_ERR : Unlock error.
  298. * ESP_ROM_SPIFLASH_RESULT_TIMEOUT : Unlock timeout.
  299. */
  300. esp_rom_spiflash_result_t esp_rom_spiflash_unlock(void);
  301. /**
  302. * @brief SPI write protect.
  303. * Please do not call this function in SDK.
  304. *
  305. * @param None.
  306. *
  307. * @return ESP_ROM_SPIFLASH_RESULT_OK : Lock OK.
  308. * ESP_ROM_SPIFLASH_RESULT_ERR : Lock error.
  309. * ESP_ROM_SPIFLASH_RESULT_TIMEOUT : Lock timeout.
  310. */
  311. esp_rom_spiflash_result_t esp_rom_spiflash_lock(void);
  312. /**
  313. * @brief Update SPI Flash parameter.
  314. * Please do not call this function in SDK.
  315. *
  316. * @param uint32_t deviceId : Device ID read from SPI, the low 32 bit.
  317. *
  318. * @param uint32_t chip_size : The Flash size.
  319. *
  320. * @param uint32_t block_size : The Flash block size.
  321. *
  322. * @param uint32_t sector_size : The Flash sector size.
  323. *
  324. * @param uint32_t page_size : The Flash page size.
  325. *
  326. * @param uint32_t status_mask : The Mask used when read status from Flash(use single CMD).
  327. *
  328. * @return ESP_ROM_SPIFLASH_RESULT_OK : Update OK.
  329. * ESP_ROM_SPIFLASH_RESULT_ERR : Update error.
  330. * ESP_ROM_SPIFLASH_RESULT_TIMEOUT : Update timeout.
  331. */
  332. esp_rom_spiflash_result_t esp_rom_spiflash_config_param(uint32_t deviceId, uint32_t chip_size, uint32_t block_size,
  333. uint32_t sector_size, uint32_t page_size, uint32_t status_mask);
  334. /**
  335. * @brief Erase whole flash chip.
  336. * Please do not call this function in SDK.
  337. *
  338. * @param None
  339. *
  340. * @return ESP_ROM_SPIFLASH_RESULT_OK : Erase OK.
  341. * ESP_ROM_SPIFLASH_RESULT_ERR : Erase error.
  342. * ESP_ROM_SPIFLASH_RESULT_TIMEOUT : Erase timeout.
  343. */
  344. esp_rom_spiflash_result_t esp_rom_spiflash_erase_chip(void);
  345. /**
  346. * @brief Erase a 64KB block of flash
  347. * Uses SPI flash command D8H.
  348. * Please do not call this function in SDK.
  349. *
  350. * @param uint32_t block_num : Which block to erase.
  351. *
  352. * @return ESP_ROM_SPIFLASH_RESULT_OK : Erase OK.
  353. * ESP_ROM_SPIFLASH_RESULT_ERR : Erase error.
  354. * ESP_ROM_SPIFLASH_RESULT_TIMEOUT : Erase timeout.
  355. */
  356. esp_rom_spiflash_result_t esp_rom_spiflash_erase_block(uint32_t block_num);
  357. /**
  358. * @brief Erase a sector of flash.
  359. * Uses SPI flash command 20H.
  360. * Please do not call this function in SDK.
  361. *
  362. * @param uint32_t sector_num : Which sector to erase.
  363. *
  364. * @return ESP_ROM_SPIFLASH_RESULT_OK : Erase OK.
  365. * ESP_ROM_SPIFLASH_RESULT_ERR : Erase error.
  366. * ESP_ROM_SPIFLASH_RESULT_TIMEOUT : Erase timeout.
  367. */
  368. esp_rom_spiflash_result_t esp_rom_spiflash_erase_sector(uint32_t sector_num);
  369. /**
  370. * @brief Erase some sectors.
  371. * Please do not call this function in SDK.
  372. *
  373. * @param uint32_t start_addr : Start addr to erase, should be sector aligned.
  374. *
  375. * @param uint32_t area_len : Length to erase, should be sector aligned.
  376. *
  377. * @return ESP_ROM_SPIFLASH_RESULT_OK : Erase OK.
  378. * ESP_ROM_SPIFLASH_RESULT_ERR : Erase error.
  379. * ESP_ROM_SPIFLASH_RESULT_TIMEOUT : Erase timeout.
  380. */
  381. esp_rom_spiflash_result_t esp_rom_spiflash_erase_area(uint32_t start_addr, uint32_t area_len);
  382. /**
  383. * @brief Write Data to Flash, you should Erase it yourself if need.
  384. * Please do not call this function in SDK.
  385. *
  386. * @param uint32_t dest_addr : Address to write, should be 4 bytes aligned.
  387. *
  388. * @param const uint32_t *src : The pointer to data which is to write.
  389. *
  390. * @param uint32_t len : Length to write, should be 4 bytes aligned.
  391. *
  392. * @return ESP_ROM_SPIFLASH_RESULT_OK : Write OK.
  393. * ESP_ROM_SPIFLASH_RESULT_ERR : Write error.
  394. * ESP_ROM_SPIFLASH_RESULT_TIMEOUT : Write timeout.
  395. */
  396. esp_rom_spiflash_result_t esp_rom_spiflash_write(uint32_t dest_addr, const uint32_t *src, int32_t len);
  397. /**
  398. * @brief Read Data from Flash, you should Erase it yourself if need.
  399. * Please do not call this function in SDK.
  400. *
  401. * @param uint32_t src_addr : Address to read, should be 4 bytes aligned.
  402. *
  403. * @param uint32_t *dest : The buf to read the data.
  404. *
  405. * @param uint32_t len : Length to read, should be 4 bytes aligned.
  406. *
  407. * @return ESP_ROM_SPIFLASH_RESULT_OK : Read OK.
  408. * ESP_ROM_SPIFLASH_RESULT_ERR : Read error.
  409. * ESP_ROM_SPIFLASH_RESULT_TIMEOUT : Read timeout.
  410. */
  411. esp_rom_spiflash_result_t esp_rom_spiflash_read(uint32_t src_addr, uint32_t *dest, int32_t len);
  412. /**
  413. * @brief SPI1 go into encrypto mode.
  414. * Please do not call this function in SDK.
  415. *
  416. * @param None
  417. *
  418. * @return None
  419. */
  420. void esp_rom_spiflash_write_encrypted_enable(void);
  421. /**
  422. * @brief Prepare 32 Bytes data to encrpto writing, you should Erase it yourself if need.
  423. * Please do not call this function in SDK.
  424. *
  425. * @param uint32_t flash_addr : Address to write, should be 32 bytes aligned.
  426. *
  427. * @param uint32_t *data : The pointer to data which is to write.
  428. *
  429. * @return ESP_ROM_SPIFLASH_RESULT_OK : Prepare OK.
  430. * ESP_ROM_SPIFLASH_RESULT_ERR : Prepare error.
  431. * ESP_ROM_SPIFLASH_RESULT_TIMEOUT : Prepare timeout.
  432. */
  433. esp_rom_spiflash_result_t esp_rom_spiflash_prepare_encrypted_data(uint32_t flash_addr, uint32_t *data);
  434. /**
  435. * @brief SPI1 go out of encrypto mode.
  436. * Please do not call this function in SDK.
  437. *
  438. * @param None
  439. *
  440. * @return None
  441. */
  442. void esp_rom_spiflash_write_encrypted_disable(void);
  443. /**
  444. * @brief Write data to flash with transparent encryption.
  445. * @note Sectors to be written should already be erased.
  446. *
  447. * @note Please do not call this function in SDK.
  448. *
  449. * @param uint32_t flash_addr : Address to write, should be 32 byte aligned.
  450. *
  451. * @param uint32_t *data : The pointer to data to write. Note, this pointer must
  452. * be 32 bit aligned and the content of the data will be
  453. * modified by the encryption function.
  454. *
  455. * @param uint32_t len : Length to write, should be 32 bytes aligned.
  456. *
  457. * @return ESP_ROM_SPIFLASH_RESULT_OK : Data written successfully.
  458. * ESP_ROM_SPIFLASH_RESULT_ERR : Encryption write error.
  459. * ESP_ROM_SPIFLASH_RESULT_TIMEOUT : Encrypto write timeout.
  460. */
  461. esp_rom_spiflash_result_t esp_rom_spiflash_write_encrypted(uint32_t flash_addr, uint32_t *data, uint32_t len);
  462. /** @brief Wait until SPI flash write operation is complete
  463. *
  464. * @note Please do not call this function in SDK.
  465. *
  466. * Reads the Write In Progress bit of the SPI flash status register,
  467. * repeats until this bit is zero (indicating write complete).
  468. *
  469. * @return ESP_ROM_SPIFLASH_RESULT_OK : Write is complete
  470. * ESP_ROM_SPIFLASH_RESULT_ERR : Error while reading status.
  471. */
  472. esp_rom_spiflash_result_t esp_rom_spiflash_wait_idle(esp_rom_spiflash_chip_t *spi);
  473. /** @brief Enable Quad I/O pin functions
  474. *
  475. * @note Please do not call this function in SDK.
  476. *
  477. * Sets the HD & WP pin functions for Quad I/O modes, based on the
  478. * efuse SPI pin configuration.
  479. *
  480. * @param wp_gpio_num - Number of the WP pin to reconfigure for quad I/O.
  481. *
  482. * @param spiconfig - Pin configuration, as returned from ets_efuse_get_spiconfig().
  483. * - If this parameter is 0, default SPI pins are used and wp_gpio_num parameter is ignored.
  484. * - If this parameter is 1, default HSPI pins are used and wp_gpio_num parameter is ignored.
  485. * - For other values, this parameter encodes the HD pin number and also the CLK pin number. CLK pin selection is used
  486. * to determine if HSPI or SPI peripheral will be used (use HSPI if CLK pin is the HSPI clock pin, otherwise use SPI).
  487. * Both HD & WP pins are configured via GPIO matrix to map to the selected peripheral.
  488. */
  489. void esp_rom_spiflash_select_qio_pins(uint8_t wp_gpio_num, uint32_t spiconfig);
  490. /**
  491. * @brief Clear WEL bit unconditionally.
  492. *
  493. * @return always ESP_ROM_SPIFLASH_RESULT_OK
  494. */
  495. esp_rom_spiflash_result_t esp_rom_spiflash_write_disable(void);
  496. /** @brief Global esp_rom_spiflash_chip_t structure used by ROM functions
  497. *
  498. */
  499. extern esp_rom_spiflash_chip_t g_rom_flashchip;
  500. /**
  501. * @}
  502. */
  503. #ifdef __cplusplus
  504. }
  505. #endif
  506. #endif /* _ROM_SPI_FLASH_H_ */