gd32f30x_exmc.c 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674
  1. /*!
  2. \file gd32f30x_exmc.c
  3. \brief EXMC driver
  4. \version 2023-12-30, V2.2.0, firmware for GD32F30x
  5. */
  6. /*
  7. Copyright (c) 2020, GigaDevice Semiconductor Inc.
  8. Redistribution and use in source and binary forms, with or without modification,
  9. are permitted provided that the following conditions are met:
  10. 1. Redistributions of source code must retain the above copyright notice, this
  11. list of conditions and the following disclaimer.
  12. 2. Redistributions in binary form must reproduce the above copyright notice,
  13. this list of conditions and the following disclaimer in the documentation
  14. and/or other materials provided with the distribution.
  15. 3. Neither the name of the copyright holder nor the names of its contributors
  16. may be used to endorse or promote products derived from this software without
  17. specific prior written permission.
  18. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  19. AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  20. WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  21. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
  22. INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  23. NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  24. PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  25. WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  26. ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
  27. OF SUCH DAMAGE.
  28. */
  29. #include "gd32f30x_exmc.h"
  30. /* EXMC bank0 register reset value */
  31. #define BANK0_SNCTL_REGION0_RESET ((uint32_t)0x000030DBU)
  32. #define BANK0_SNCTL_REGION1_2_3_RESET ((uint32_t)0x000030D2U)
  33. #define BANK0_SNTCFG_RESET ((uint32_t)0x0FFFFFFFU)
  34. #define BANK0_SNWTCFG_RESET ((uint32_t)0x0FFFFFFFU)
  35. /* EXMC bank1/2 register reset mask */
  36. #define BANK1_2_NPCTL_RESET ((uint32_t)0x00000018U)
  37. #define BANK1_2_NPINTEN_RESET ((uint32_t)0x00000042U)
  38. #define BANK1_2_NPCTCFG_RESET ((uint32_t)0xFCFCFCFCU)
  39. #define BANK1_2_NPATCFG_RESET ((uint32_t)0xFCFCFCFCU)
  40. /* EXMC bank3 register reset mask */
  41. #define BANK3_NPCTL_RESET ((uint32_t)0x00000018U)
  42. #define BANK3_NPINTEN_RESET ((uint32_t)0x00000043U)
  43. #define BANK3_NPCTCFG_RESET ((uint32_t)0xFCFCFCFCU)
  44. #define BANK3_NPATCFG_RESET ((uint32_t)0xFCFCFCFCU)
  45. #define BANK3_PIOTCFG3_RESET ((uint32_t)0xFCFCFCFCU)
  46. /* EXMC register bit offset */
  47. #define SNCTL_NRMUX_OFFSET ((uint32_t)1U)
  48. #define SNCTL_SBRSTEN_OFFSET ((uint32_t)8U)
  49. #define SNCTL_WRAPEN_OFFSET ((uint32_t)10U)
  50. #define SNCTL_WREN_OFFSET ((uint32_t)12U)
  51. #define SNCTL_NRWTEN_OFFSET ((uint32_t)13U)
  52. #define SNCTL_EXMODEN_OFFSET ((uint32_t)14U)
  53. #define SNCTL_ASYNCWAIT_OFFSET ((uint32_t)15U)
  54. #define SNTCFG_AHLD_OFFSET ((uint32_t)4U)
  55. #define SNTCFG_DSET_OFFSET ((uint32_t)8U)
  56. #define SNTCFG_BUSLAT_OFFSET ((uint32_t)16U)
  57. #define SNWTCFG_WAHLD_OFFSET ((uint32_t)4U)
  58. #define SNWTCFG_WDSET_OFFSET ((uint32_t)8U)
  59. #define SNWTCFG_WBUSLAT_OFFSET ((uint32_t)16U)
  60. #define NPCTL_NDWTEN_OFFSET ((uint32_t)1U)
  61. #define NPCTL_ECCEN_OFFSET ((uint32_t)6U)
  62. #define NPCTCFG_COMWAIT_OFFSET ((uint32_t)8U)
  63. #define NPCTCFG_COMHLD_OFFSET ((uint32_t)16U)
  64. #define NPCTCFG_COMHIZ_OFFSET ((uint32_t)24U)
  65. #define NPATCFG_ATTWAIT_OFFSET ((uint32_t)8U)
  66. #define NPATCFG_ATTHLD_OFFSET ((uint32_t)16U)
  67. #define NPATCFG_ATTHIZ_OFFSET ((uint32_t)24U)
  68. #define PIOTCFG_IOWAIT_OFFSET ((uint32_t)8U)
  69. #define PIOTCFG_IOHLD_OFFSET ((uint32_t)16U)
  70. #define PIOTCFG_IOHIZ_OFFSET ((uint32_t)24U)
  71. #define INTEN_INTS_OFFSET ((uint32_t)3U)
  72. /*!
  73. \brief deinitialize EXMC NOR/SRAM region
  74. \param[in] exmc_norsram_region: select the region of bank0
  75. only one parameter can be selected which is shown as below:
  76. \arg EXMC_BANK0_NORSRAM_REGIONx(x=0..3)
  77. \param[out] none
  78. \retval none
  79. */
  80. void exmc_norsram_deinit(uint32_t exmc_norsram_region)
  81. {
  82. /* reset the registers */
  83. if(EXMC_BANK0_NORSRAM_REGION0 == exmc_norsram_region){
  84. EXMC_SNCTL(exmc_norsram_region) = BANK0_SNCTL_REGION0_RESET;
  85. }else{
  86. EXMC_SNCTL(exmc_norsram_region) = BANK0_SNCTL_REGION1_2_3_RESET;
  87. }
  88. EXMC_SNTCFG(exmc_norsram_region) = BANK0_SNTCFG_RESET;
  89. EXMC_SNWTCFG(exmc_norsram_region) = BANK0_SNWTCFG_RESET;
  90. }
  91. /*!
  92. \brief initialize exmc_norsram_parameter_struct with the default values
  93. \param[in] none
  94. \param[out] exmc_norsram_init_struct: the initialized struct exmc_norsram_parameter_struct pointer
  95. \retval none
  96. */
  97. void exmc_norsram_struct_para_init(exmc_norsram_parameter_struct* exmc_norsram_init_struct)
  98. {
  99. /* configure the structure with default values */
  100. exmc_norsram_init_struct->norsram_region = EXMC_BANK0_NORSRAM_REGION0;
  101. exmc_norsram_init_struct->address_data_mux = ENABLE;
  102. exmc_norsram_init_struct->memory_type = EXMC_MEMORY_TYPE_SRAM;
  103. exmc_norsram_init_struct->databus_width = EXMC_NOR_DATABUS_WIDTH_8B;
  104. exmc_norsram_init_struct->burst_mode = DISABLE;
  105. exmc_norsram_init_struct->nwait_polarity = EXMC_NWAIT_POLARITY_LOW;
  106. exmc_norsram_init_struct->wrap_burst_mode = DISABLE;
  107. exmc_norsram_init_struct->nwait_config = EXMC_NWAIT_CONFIG_BEFORE;
  108. exmc_norsram_init_struct->memory_write = ENABLE;
  109. exmc_norsram_init_struct->nwait_signal = ENABLE;
  110. exmc_norsram_init_struct->extended_mode = DISABLE;
  111. exmc_norsram_init_struct->asyn_wait = DISABLE;
  112. exmc_norsram_init_struct->write_mode = EXMC_ASYN_WRITE;
  113. /* read/write timing configure */
  114. exmc_norsram_init_struct->read_write_timing->asyn_address_setuptime = 0xFU;
  115. exmc_norsram_init_struct->read_write_timing->asyn_address_holdtime = 0xFU;
  116. exmc_norsram_init_struct->read_write_timing->asyn_data_setuptime = 0xFFU;
  117. exmc_norsram_init_struct->read_write_timing->bus_latency = 0xFU;
  118. exmc_norsram_init_struct->read_write_timing->syn_clk_division = EXMC_SYN_CLOCK_RATIO_16_CLK;
  119. exmc_norsram_init_struct->read_write_timing->syn_data_latency = EXMC_DATALAT_17_CLK;
  120. exmc_norsram_init_struct->read_write_timing->asyn_access_mode = EXMC_ACCESS_MODE_A;
  121. /* write timing configure, when extended mode is used */
  122. exmc_norsram_init_struct->write_timing->asyn_address_setuptime = 0xFU;
  123. exmc_norsram_init_struct->write_timing->asyn_address_holdtime = 0xFU;
  124. exmc_norsram_init_struct->write_timing->asyn_data_setuptime = 0xFFU;
  125. exmc_norsram_init_struct->write_timing->bus_latency = 0xFU;
  126. exmc_norsram_init_struct->write_timing->asyn_access_mode = EXMC_ACCESS_MODE_A;
  127. }
  128. /*!
  129. \brief initialize EXMC NOR/SRAM region
  130. \param[in] exmc_norsram_parameter_struct: configure the EXMC NOR/SRAM parameter
  131. norsram_region: EXMC_BANK0_NORSRAM_REGIONx,x=0..3
  132. write_mode: EXMC_ASYN_WRITE,EXMC_SYN_WRITE
  133. extended_mode: ENABLE or DISABLE
  134. asyn_wait: ENABLE or DISABLE
  135. nwait_signal: ENABLE or DISABLE
  136. memory_write: ENABLE or DISABLE
  137. nwait_config: EXMC_NWAIT_CONFIG_BEFORE,EXMC_NWAIT_CONFIG_DURING
  138. wrap_burst_mode: ENABLE or DISABLE
  139. nwait_polarity: EXMC_NWAIT_POLARITY_LOW,EXMC_NWAIT_POLARITY_HIGH
  140. burst_mode: ENABLE or DISABLE
  141. databus_width: EXMC_NOR_DATABUS_WIDTH_8B,EXMC_NOR_DATABUS_WIDTH_16B
  142. memory_type: EXMC_MEMORY_TYPE_SRAM,EXMC_MEMORY_TYPE_PSRAM,EXMC_MEMORY_TYPE_NOR
  143. address_data_mux: ENABLE or DISABLE
  144. read_write_timing: struct exmc_norsram_timing_parameter_struct set the time
  145. write_timing: struct exmc_norsram_timing_parameter_struct set the time
  146. \param[out] none
  147. \retval none
  148. */
  149. void exmc_norsram_init(exmc_norsram_parameter_struct* exmc_norsram_init_struct)
  150. {
  151. uint32_t snctl = 0x00000000U,sntcfg = 0x00000000U,snwtcfg = 0x00000000U;
  152. /* get the register value */
  153. snctl = EXMC_SNCTL(exmc_norsram_init_struct->norsram_region);
  154. /* clear relative bits */
  155. snctl &= ((uint32_t)~(EXMC_SNCTL_NRMUX | EXMC_SNCTL_NRTP | EXMC_SNCTL_NRW | EXMC_SNCTL_SBRSTEN |
  156. EXMC_SNCTL_NREN | EXMC_SNCTL_NRWTPOL | EXMC_SNCTL_WRAPEN | EXMC_SNCTL_NRWTCFG |
  157. EXMC_SNCTL_WREN | EXMC_SNCTL_NRWTEN | EXMC_SNCTL_EXMODEN | EXMC_SNCTL_ASYNCWAIT |
  158. EXMC_SNCTL_SYNCWR ));
  159. snctl |= (uint32_t)(exmc_norsram_init_struct->address_data_mux << SNCTL_NRMUX_OFFSET) |
  160. exmc_norsram_init_struct->memory_type |
  161. exmc_norsram_init_struct->databus_width |
  162. (exmc_norsram_init_struct->burst_mode << SNCTL_SBRSTEN_OFFSET) |
  163. exmc_norsram_init_struct->nwait_polarity |
  164. (exmc_norsram_init_struct->wrap_burst_mode << SNCTL_WRAPEN_OFFSET) |
  165. exmc_norsram_init_struct->nwait_config |
  166. (exmc_norsram_init_struct->memory_write << SNCTL_WREN_OFFSET) |
  167. (exmc_norsram_init_struct->nwait_signal << SNCTL_NRWTEN_OFFSET) |
  168. (exmc_norsram_init_struct->extended_mode << SNCTL_EXMODEN_OFFSET) |
  169. (exmc_norsram_init_struct->asyn_wait << SNCTL_ASYNCWAIT_OFFSET) |
  170. exmc_norsram_init_struct->write_mode;
  171. sntcfg = (uint32_t)((exmc_norsram_init_struct->read_write_timing->asyn_address_setuptime - 1U ) & EXMC_SNTCFG_ASET )|
  172. (((exmc_norsram_init_struct->read_write_timing->asyn_address_holdtime - 1U ) << SNTCFG_AHLD_OFFSET ) & EXMC_SNTCFG_AHLD ) |
  173. (((exmc_norsram_init_struct->read_write_timing->asyn_data_setuptime - 1U ) << SNTCFG_DSET_OFFSET ) & EXMC_SNTCFG_DSET ) |
  174. (((exmc_norsram_init_struct->read_write_timing->bus_latency - 1U ) << SNTCFG_BUSLAT_OFFSET ) & EXMC_SNTCFG_BUSLAT )|
  175. exmc_norsram_init_struct->read_write_timing->syn_clk_division |
  176. exmc_norsram_init_struct->read_write_timing->syn_data_latency |
  177. exmc_norsram_init_struct->read_write_timing->asyn_access_mode;
  178. /* nor flash access enable */
  179. if(EXMC_MEMORY_TYPE_NOR == exmc_norsram_init_struct->memory_type){
  180. snctl |= (uint32_t)EXMC_SNCTL_NREN;
  181. }
  182. /* extended mode configure */
  183. if(ENABLE == exmc_norsram_init_struct->extended_mode){
  184. snwtcfg = (uint32_t)((exmc_norsram_init_struct->write_timing->asyn_address_setuptime - 1U) & EXMC_SNWTCFG_WASET ) |
  185. (((exmc_norsram_init_struct->write_timing->asyn_address_holdtime -1U ) << SNWTCFG_WAHLD_OFFSET ) & EXMC_SNWTCFG_WAHLD )|
  186. (((exmc_norsram_init_struct->write_timing->asyn_data_setuptime -1U ) << SNWTCFG_WDSET_OFFSET ) & EXMC_SNWTCFG_WDSET )|
  187. (((exmc_norsram_init_struct->write_timing->bus_latency - 1U ) << SNWTCFG_WBUSLAT_OFFSET ) & EXMC_SNWTCFG_WBUSLAT ) |
  188. exmc_norsram_init_struct->write_timing->asyn_access_mode;
  189. }else{
  190. snwtcfg = BANK0_SNWTCFG_RESET;
  191. }
  192. /* configure the registers */
  193. EXMC_SNCTL(exmc_norsram_init_struct->norsram_region) = snctl;
  194. EXMC_SNTCFG(exmc_norsram_init_struct->norsram_region) = sntcfg;
  195. EXMC_SNWTCFG(exmc_norsram_init_struct->norsram_region) = snwtcfg;
  196. }
  197. /*!
  198. \brief enable EXMC NOR/PSRAM bank region
  199. \param[in] exmc_norsram_region: specifie the region of NOR/PSRAM bank
  200. only one parameter can be selected which is shown as below:
  201. \arg EXMC_BANK0_NORSRAM_REGIONx(x=0..3)
  202. \param[out] none
  203. \retval none
  204. */
  205. void exmc_norsram_enable(uint32_t exmc_norsram_region)
  206. {
  207. EXMC_SNCTL(exmc_norsram_region) |= (uint32_t)EXMC_SNCTL_NRBKEN;
  208. }
  209. /*!
  210. \brief disable EXMC NOR/PSRAM bank region
  211. \param[in] exmc_norsram_region: specifie the region of NOR/PSRAM Bank
  212. only one parameter can be selected which is shown as below:
  213. \arg EXMC_BANK0_NORSRAM_REGIONx(x=0..3)
  214. \param[out] none
  215. \retval none
  216. */
  217. void exmc_norsram_disable(uint32_t exmc_norsram_region)
  218. {
  219. EXMC_SNCTL(exmc_norsram_region) &= ~(uint32_t)EXMC_SNCTL_NRBKEN;
  220. }
  221. /*!
  222. \brief deinitialize EXMC NAND bank
  223. \param[in] exmc_nand_bank: select the bank of NAND
  224. only one parameter can be selected which is shown as below:
  225. \arg EXMC_BANKx_NAND(x=1..2)
  226. \param[out] none
  227. \retval none
  228. */
  229. void exmc_nand_deinit(uint32_t exmc_nand_bank)
  230. {
  231. /* EXMC_BANK1_NAND or EXMC_BANK2_NAND */
  232. EXMC_NPCTL(exmc_nand_bank) = BANK1_2_NPCTL_RESET;
  233. EXMC_NPINTEN(exmc_nand_bank) = BANK1_2_NPINTEN_RESET;
  234. EXMC_NPCTCFG(exmc_nand_bank) = BANK1_2_NPCTCFG_RESET;
  235. EXMC_NPATCFG(exmc_nand_bank) = BANK1_2_NPATCFG_RESET;
  236. }
  237. /*!
  238. \brief initialize exmc_norsram_parameter_struct with the default values
  239. \param[in] none
  240. \param[out] the initialized struct exmc_norsram_parameter_struct pointer
  241. \retval none
  242. */
  243. void exmc_nand_struct_para_init(exmc_nand_parameter_struct* exmc_nand_init_struct)
  244. {
  245. /* configure the structure with default values */
  246. exmc_nand_init_struct->nand_bank = EXMC_BANK1_NAND;
  247. exmc_nand_init_struct->wait_feature = DISABLE;
  248. exmc_nand_init_struct->databus_width = EXMC_NAND_DATABUS_WIDTH_8B;
  249. exmc_nand_init_struct->ecc_logic = DISABLE;
  250. exmc_nand_init_struct->ecc_size = EXMC_ECC_SIZE_256BYTES;
  251. exmc_nand_init_struct->ctr_latency = 0x0U;
  252. exmc_nand_init_struct->atr_latency = 0x0U;
  253. exmc_nand_init_struct->common_space_timing->setuptime = 0xFCU;
  254. exmc_nand_init_struct->common_space_timing->waittime = 0xFCU;
  255. exmc_nand_init_struct->common_space_timing->holdtime = 0xFCU;
  256. exmc_nand_init_struct->common_space_timing->databus_hiztime = 0xFCU;
  257. exmc_nand_init_struct->attribute_space_timing->setuptime = 0xFCU;
  258. exmc_nand_init_struct->attribute_space_timing->waittime = 0xFCU;
  259. exmc_nand_init_struct->attribute_space_timing->holdtime = 0xFCU;
  260. exmc_nand_init_struct->attribute_space_timing->databus_hiztime = 0xFCU;
  261. }
  262. /*!
  263. \brief initialize EXMC NAND bank
  264. \param[in] exmc_nand_parameter_struct: configure the EXMC NAND parameter
  265. nand_bank: EXMC_BANK1_NAND,EXMC_BANK2_NAND
  266. ecc_size: EXMC_ECC_SIZE_xBYTES,x=256,512,1024,2048,4096
  267. atr_latency: EXMC_ALE_RE_DELAY_x_HCLK,x=1..16
  268. ctr_latency: EXMC_CLE_RE_DELAY_x_HCLK,x=1..16
  269. ecc_logic: ENABLE or DISABLE
  270. databus_width: EXMC_NAND_DATABUS_WIDTH_8B,EXMC_NAND_DATABUS_WIDTH_16B
  271. wait_feature: ENABLE or DISABLE
  272. common_space_timing: struct exmc_nand_pccard_timing_parameter_struct set the time
  273. attribute_space_timing: struct exmc_nand_pccard_timing_parameter_struct set the time
  274. \param[out] none
  275. \retval none
  276. */
  277. void exmc_nand_init(exmc_nand_parameter_struct* exmc_nand_init_struct)
  278. {
  279. uint32_t npctl = 0x00000000U, npctcfg = 0x00000000U, npatcfg = 0x00000000U;
  280. npctl = (uint32_t)(exmc_nand_init_struct->wait_feature << NPCTL_NDWTEN_OFFSET)|
  281. EXMC_NPCTL_NDTP |
  282. exmc_nand_init_struct->databus_width |
  283. (exmc_nand_init_struct->ecc_logic << NPCTL_ECCEN_OFFSET)|
  284. exmc_nand_init_struct->ecc_size |
  285. exmc_nand_init_struct->ctr_latency |
  286. exmc_nand_init_struct->atr_latency;
  287. npctcfg = (uint32_t)((exmc_nand_init_struct->common_space_timing->setuptime - 1U) & EXMC_NPCTCFG_COMSET ) |
  288. (((exmc_nand_init_struct->common_space_timing->waittime - 1U) << NPCTCFG_COMWAIT_OFFSET) & EXMC_NPCTCFG_COMWAIT ) |
  289. ((exmc_nand_init_struct->common_space_timing->holdtime << NPCTCFG_COMHLD_OFFSET) & EXMC_NPCTCFG_COMHLD ) |
  290. (((exmc_nand_init_struct->common_space_timing->databus_hiztime - 1U) << NPCTCFG_COMHIZ_OFFSET) & EXMC_NPCTCFG_COMHIZ );
  291. npatcfg = (uint32_t)((exmc_nand_init_struct->attribute_space_timing->setuptime - 1U) & EXMC_NPATCFG_ATTSET ) |
  292. (((exmc_nand_init_struct->attribute_space_timing->waittime - 1U) << NPATCFG_ATTWAIT_OFFSET) & EXMC_NPATCFG_ATTWAIT ) |
  293. ((exmc_nand_init_struct->attribute_space_timing->holdtime << NPATCFG_ATTHLD_OFFSET) & EXMC_NPATCFG_ATTHLD ) |
  294. (((exmc_nand_init_struct->attribute_space_timing->databus_hiztime -1U) << NPATCFG_ATTHIZ_OFFSET) & EXMC_NPATCFG_ATTHIZ );
  295. /* EXMC_BANK1_NAND or EXMC_BANK2_NAND initialize */
  296. EXMC_NPCTL(exmc_nand_init_struct->nand_bank) = npctl;
  297. EXMC_NPCTCFG(exmc_nand_init_struct->nand_bank) = npctcfg;
  298. EXMC_NPATCFG(exmc_nand_init_struct->nand_bank) = npatcfg;
  299. }
  300. /*!
  301. \brief enable NAND bank
  302. \param[in] exmc_nand_bank: specifie the NAND bank
  303. only one parameter can be selected which is shown as below:
  304. \arg EXMC_BANKx_NAND(x=1,2)
  305. \param[out] none
  306. \retval none
  307. */
  308. void exmc_nand_enable(uint32_t exmc_nand_bank)
  309. {
  310. EXMC_NPCTL(exmc_nand_bank) |= EXMC_NPCTL_NDBKEN;
  311. }
  312. /*!
  313. \brief disable NAND bank
  314. \param[in] exmc_nand_bank: specifie the NAND bank
  315. only one parameter can be selected which is shown as below:
  316. \arg EXMC_BANKx_NAND(x=1,2)
  317. \param[out] none
  318. \retval none
  319. */
  320. void exmc_nand_disable(uint32_t exmc_nand_bank)
  321. {
  322. EXMC_NPCTL(exmc_nand_bank) &= (~EXMC_NPCTL_NDBKEN);
  323. }
  324. /*!
  325. \brief deinitialize EXMC PC card bank
  326. \param[in] none
  327. \param[out] none
  328. \retval none
  329. */
  330. void exmc_pccard_deinit(void)
  331. {
  332. /* EXMC_BANK3_PCCARD */
  333. EXMC_NPCTL3 = BANK3_NPCTL_RESET;
  334. EXMC_NPINTEN3 = BANK3_NPINTEN_RESET;
  335. EXMC_NPCTCFG3 = BANK3_NPCTCFG_RESET;
  336. EXMC_NPATCFG3 = BANK3_NPATCFG_RESET;
  337. EXMC_PIOTCFG3 = BANK3_PIOTCFG3_RESET;
  338. }
  339. /*!
  340. \brief initialize exmc_pccard_parameter_struct parameter with the default values
  341. \param[in] none
  342. \param[out] the initialized struct exmc_pccard_parameter_struct pointer
  343. \retval none
  344. */
  345. void exmc_pccard_struct_para_init(exmc_pccard_parameter_struct* exmc_pccard_init_struct)
  346. {
  347. /* configure the structure with default values */
  348. exmc_pccard_init_struct->wait_feature = DISABLE;
  349. exmc_pccard_init_struct->ctr_latency = 0x0U;
  350. exmc_pccard_init_struct->atr_latency = 0x0U;
  351. exmc_pccard_init_struct->common_space_timing->setuptime = 0xFCU;
  352. exmc_pccard_init_struct->common_space_timing->waittime = 0xFCU;
  353. exmc_pccard_init_struct->common_space_timing->holdtime = 0xFCU;
  354. exmc_pccard_init_struct->common_space_timing->databus_hiztime = 0xFCU;
  355. exmc_pccard_init_struct->attribute_space_timing->setuptime = 0xFCU;
  356. exmc_pccard_init_struct->attribute_space_timing->waittime = 0xFCU;
  357. exmc_pccard_init_struct->attribute_space_timing->holdtime = 0xFCU;
  358. exmc_pccard_init_struct->attribute_space_timing->databus_hiztime = 0xFCU;
  359. exmc_pccard_init_struct->io_space_timing->setuptime = 0xFCU;
  360. exmc_pccard_init_struct->io_space_timing->waittime = 0xFCU;
  361. exmc_pccard_init_struct->io_space_timing->holdtime = 0xFCU;
  362. exmc_pccard_init_struct->io_space_timing->databus_hiztime = 0xFCU;
  363. }
  364. /*!
  365. \brief initialize EXMC PC card bank
  366. \param[in] exmc_pccard_parameter_struct: configure the EXMC NAND parameter
  367. atr_latency: EXMC_ALE_RE_DELAY_x_HCLK,x=1..16
  368. ctr_latency: EXMC_CLE_RE_DELAY_x_HCLK,x=1..16
  369. wait_feature: ENABLE or DISABLE
  370. common_space_timing: struct exmc_nand_pccard_timing_parameter_struct set the time
  371. attribute_space_timing: struct exmc_nand_pccard_timing_parameter_struct set the time
  372. io_space_timing: exmc_nand_pccard_timing_parameter_struct set the time
  373. \param[out] none
  374. \retval none
  375. */
  376. void exmc_pccard_init(exmc_pccard_parameter_struct* exmc_pccard_init_struct)
  377. {
  378. /* configure the EXMC bank3 PC card control register */
  379. EXMC_NPCTL3 = (uint32_t)(exmc_pccard_init_struct->wait_feature << NPCTL_NDWTEN_OFFSET) |
  380. EXMC_NAND_DATABUS_WIDTH_16B |
  381. exmc_pccard_init_struct->ctr_latency |
  382. exmc_pccard_init_struct->atr_latency ;
  383. /* configure the EXMC bank3 PC card common space timing configuration register */
  384. EXMC_NPCTCFG3 = (uint32_t)((exmc_pccard_init_struct->common_space_timing->setuptime - 1U)& EXMC_NPCTCFG_COMSET ) |
  385. (((exmc_pccard_init_struct->common_space_timing->waittime - 1U) << NPCTCFG_COMWAIT_OFFSET) & EXMC_NPCTCFG_COMWAIT ) |
  386. ((exmc_pccard_init_struct->common_space_timing->holdtime << NPCTCFG_COMHLD_OFFSET) & EXMC_NPCTCFG_COMHLD ) |
  387. (((exmc_pccard_init_struct->common_space_timing->databus_hiztime - 1U) << NPCTCFG_COMHIZ_OFFSET) & EXMC_NPCTCFG_COMHIZ );
  388. /* configure the EXMC bank3 PC card attribute space timing configuration register */
  389. EXMC_NPATCFG3 = (uint32_t)((exmc_pccard_init_struct->attribute_space_timing->setuptime - 1U) & EXMC_NPATCFG_ATTSET ) |
  390. (((exmc_pccard_init_struct->attribute_space_timing->waittime - 1U) << NPATCFG_ATTWAIT_OFFSET) & EXMC_NPATCFG_ATTWAIT ) |
  391. ((exmc_pccard_init_struct->attribute_space_timing->holdtime << NPATCFG_ATTHLD_OFFSET) & EXMC_NPATCFG_ATTHLD )|
  392. (((exmc_pccard_init_struct->attribute_space_timing->databus_hiztime -1U) << NPATCFG_ATTHIZ_OFFSET) & EXMC_NPATCFG_ATTHIZ );
  393. /* configure the EXMC bank3 PC card io space timing configuration register */
  394. EXMC_PIOTCFG3 = (uint32_t)((exmc_pccard_init_struct->io_space_timing->setuptime - 1U) & EXMC_PIOTCFG3_IOSET ) |
  395. (((exmc_pccard_init_struct->io_space_timing->waittime - 1U) << PIOTCFG_IOWAIT_OFFSET) & EXMC_PIOTCFG3_IOWAIT ) |
  396. ((exmc_pccard_init_struct->io_space_timing->holdtime << PIOTCFG_IOHLD_OFFSET) & EXMC_PIOTCFG3_IOHLD )|
  397. ((exmc_pccard_init_struct->io_space_timing->databus_hiztime << PIOTCFG_IOHIZ_OFFSET) & EXMC_PIOTCFG3_IOHIZ );
  398. }
  399. /*!
  400. \brief enable PC Card Bank
  401. \param[in] none
  402. \param[out] none
  403. \retval none
  404. */
  405. void exmc_pccard_enable(void)
  406. {
  407. EXMC_NPCTL3 |= EXMC_NPCTL_NDBKEN;
  408. }
  409. /*!
  410. \brief disable PC Card Bank
  411. \param[in] none
  412. \param[out] none
  413. \retval none
  414. */
  415. void exmc_pccard_disable(void)
  416. {
  417. EXMC_NPCTL3 &= (~EXMC_NPCTL_NDBKEN);
  418. }
  419. /*!
  420. \brief configure CRAM page size
  421. \param[in] exmc_norsram_region: specifie the region of NOR/PSRAM bank
  422. only one parameter can be selected which is shown as below:
  423. \arg EXMC_BANK0_NORSRAM_REGIONx(x=0..3)
  424. \param[in] page_size: CRAM page size
  425. only one parameter can be selected which is shown as below:
  426. \arg EXMC_CRAM_AUTO_SPLIT: the clock is generated only during synchronous access
  427. \arg EXMC_CRAM_PAGE_SIZE_128_BYTES: page size is 128 bytes
  428. \arg EXMC_CRAM_PAGE_SIZE_256_BYTES: page size is 256 bytes
  429. \arg EXMC_CRAM_PAGE_SIZE_512_BYTES: page size is 512 bytes
  430. \arg EXMC_CRAM_PAGE_SIZE_1024_BYTES: page size is 1024 bytes
  431. \param[out] none
  432. \retval none
  433. */
  434. void exmc_norsram_page_size_config(uint32_t exmc_norsram_region, uint32_t page_size)
  435. {
  436. /* reset the bits */
  437. EXMC_SNCTL(exmc_norsram_region) &= ~EXMC_SNCTL_CPS;
  438. /* set the CPS bits */
  439. EXMC_SNCTL(exmc_norsram_region) |= page_size;
  440. }
  441. /*!
  442. \brief enable or disable the EXMC NAND ECC function
  443. \param[in] exmc_nand_bank: specifie the NAND bank
  444. only one parameter can be selected which is shown as below:
  445. \arg EXMC_BANKx_NAND(x=1,2)
  446. \param[in] newvalue: ENABLE or DISABLE
  447. \param[out] none
  448. \retval none
  449. */
  450. void exmc_nand_ecc_config(uint32_t exmc_nand_bank, ControlStatus newvalue)
  451. {
  452. if (ENABLE == newvalue){
  453. /* enable the selected NAND bank ECC function */
  454. EXMC_NPCTL(exmc_nand_bank) |= EXMC_NPCTL_ECCEN;
  455. }else{
  456. /* disable the selected NAND bank ECC function */
  457. EXMC_NPCTL(exmc_nand_bank) &= (~EXMC_NPCTL_ECCEN);
  458. }
  459. }
  460. /*!
  461. \brief get the EXMC ECC value
  462. \param[in] exmc_nand_bank: specifie the NAND bank
  463. only one parameter can be selected which is shown as below:
  464. \arg EXMC_BANKx_NAND(x=1,2)
  465. \param[out] none
  466. \retval the error correction code(ECC) value
  467. */
  468. uint32_t exmc_ecc_get(uint32_t exmc_nand_bank)
  469. {
  470. return (EXMC_NECC(exmc_nand_bank));
  471. }
  472. /*!
  473. \brief enable EXMC interrupt
  474. \param[in] exmc_bank: specifies the NAND bank,PC card bank
  475. only one parameter can be selected which is shown as below:
  476. \arg EXMC_BANK1_NAND: the NAND bank1
  477. \arg EXMC_BANK2_NAND: the NAND bank2
  478. \arg EXMC_BANK3_PCCARD: the PC card bank
  479. \param[in] interrupt: EXMC interrupt flag
  480. only one parameter can be selected which are shown as below:
  481. \arg EXMC_NAND_PCCARD_INT_FLAG_RISE: rising edge interrupt and flag
  482. \arg EXMC_NAND_PCCARD_INT_FLAG_LEVEL: high-level interrupt and flag
  483. \arg EXMC_NAND_PCCARD_INT_FLAG_FALL: falling edge interrupt and flag
  484. \param[out] none
  485. \retval none
  486. */
  487. void exmc_interrupt_enable(uint32_t exmc_bank,uint32_t interrupt)
  488. {
  489. /* NAND bank1,bank2 or PC card bank3 */
  490. EXMC_NPINTEN(exmc_bank) |= interrupt;
  491. }
  492. /*!
  493. \brief disable EXMC interrupt
  494. \param[in] exmc_bank: specifies the NAND bank , PC card bank
  495. only one parameter can be selected which is shown as below:
  496. \arg EXMC_BANK1_NAND: the NAND bank1
  497. \arg EXMC_BANK2_NAND: the NAND bank2
  498. \arg EXMC_BANK3_PCCARD: the PC card bank
  499. \param[in] interrupt: EXMC interrupt flag
  500. only one parameter can be selected which are shown as below:
  501. \arg EXMC_NAND_PCCARD_INT_FLAG_RISE: rising edge interrupt and flag
  502. \arg EXMC_NAND_PCCARD_INT_FLAG_LEVEL: high-level interrupt and flag
  503. \arg EXMC_NAND_PCCARD_INT_FLAG_FALL: falling edge interrupt and flag
  504. \param[out] none
  505. \retval none
  506. */
  507. void exmc_interrupt_disable(uint32_t exmc_bank,uint32_t interrupt)
  508. {
  509. /* NAND bank1,bank2 or PC card bank3 */
  510. EXMC_NPINTEN(exmc_bank) &= (~interrupt);
  511. }
  512. /*!
  513. \brief get EXMC flag status
  514. \param[in] exmc_bank: specifies the NAND bank , PC card bank
  515. only one parameter can be selected which is shown as below:
  516. \arg EXMC_BANK1_NAND: the NAND bank1
  517. \arg EXMC_BANK2_NAND: the NAND bank2
  518. \arg EXMC_BANK3_PCCARD: the PC Card bank
  519. \param[in] flag: EXMC status and flag
  520. only one parameter can be selected which are shown as below:
  521. \arg EXMC_NAND_PCCARD_FLAG_RISE: interrupt rising edge status
  522. \arg EXMC_NAND_PCCARD_FLAG_LEVEL: interrupt high-level status
  523. \arg EXMC_NAND_PCCARD_FLAG_FALL: interrupt falling edge status
  524. \arg EXMC_NAND_PCCARD_FLAG_FIFOE: FIFO empty flag
  525. \param[out] none
  526. \retval FlagStatus: SET or RESET
  527. */
  528. FlagStatus exmc_flag_get(uint32_t exmc_bank,uint32_t flag)
  529. {
  530. uint32_t status = 0x00000000U;
  531. /* NAND bank1,bank2 or PC card bank3 */
  532. status = EXMC_NPINTEN(exmc_bank);
  533. if ((status & flag) != (uint32_t)flag ){
  534. /* flag is reset */
  535. return RESET;
  536. }else{
  537. /* flag is set */
  538. return SET;
  539. }
  540. }
  541. /*!
  542. \brief clear EXMC flag status
  543. \param[in] exmc_bank: specifie the NAND bank , PCCARD bank
  544. only one parameter can be selected which is shown as below:
  545. \arg EXMC_BANK1_NAND: the NAND bank1
  546. \arg EXMC_BANK2_NAND: the NAND bank2
  547. \arg EXMC_BANK3_PCCARD: the PC card bank
  548. \param[in] flag: EXMC status and flag
  549. only one parameter can be selected which are shown as below:
  550. \arg EXMC_NAND_PCCARD_FLAG_RISE: interrupt rising edge status
  551. \arg EXMC_NAND_PCCARD_FLAG_LEVEL: interrupt high-level status
  552. \arg EXMC_NAND_PCCARD_FLAG_FALL: interrupt falling edge status
  553. \arg EXMC_NAND_PCCARD_FLAG_FIFOE: FIFO empty flag
  554. \param[out] none
  555. \retval none
  556. */
  557. void exmc_flag_clear(uint32_t exmc_bank,uint32_t flag)
  558. {
  559. /* NAND bank1,bank2 or PC card bank3 */
  560. EXMC_NPINTEN(exmc_bank) &= (~flag);
  561. }
  562. /*!
  563. \brief get EXMC interrupt flag
  564. \param[in] exmc_bank: specifies the NAND bank , PC card bank
  565. only one parameter can be selected which is shown as below:
  566. \arg EXMC_BANK1_NAND: the NAND bank1
  567. \arg EXMC_BANK2_NAND: the NAND bank2
  568. \arg EXMC_BANK3_PCCARD: the PC card bank
  569. \param[in] interrupt: EXMC interrupt flag
  570. only one parameter can be selected which are shown as below:
  571. \arg EXMC_NAND_PCCARD_INT_FLAG_RISE: rising edge interrupt and flag
  572. \arg EXMC_NAND_PCCARD_INT_FLAG_LEVEL: high-level interrupt and flag
  573. \arg EXMC_NAND_PCCARD_INT_FLAG_FALL: falling edge interrupt and flag
  574. \param[out] none
  575. \retval FlagStatus: SET or RESET
  576. */
  577. FlagStatus exmc_interrupt_flag_get(uint32_t exmc_bank,uint32_t interrupt)
  578. {
  579. uint32_t status = 0x00000000U,interrupt_enable = 0x00000000U,interrupt_state = 0x00000000U;
  580. /* NAND bank1,bank2 or PC card bank3 */
  581. status = EXMC_NPINTEN(exmc_bank);
  582. interrupt_state = (status & (interrupt >> INTEN_INTS_OFFSET));
  583. interrupt_enable = (status & interrupt);
  584. if ((interrupt_enable) && (interrupt_state)){
  585. /* interrupt flag is set */
  586. return SET;
  587. }else{
  588. /* interrupt flag is reset */
  589. return RESET;
  590. }
  591. }
  592. /*!
  593. \brief clear EXMC interrupt flag
  594. \param[in] exmc_bank: specifies the NAND bank , PC card bank
  595. only one parameter can be selected which is shown as below:
  596. \arg EXMC_BANK1_NAND: the NAND bank1
  597. \arg EXMC_BANK2_NAND: the NAND bank2
  598. \arg EXMC_BANK3_PCCARD: the PC card bank
  599. \param[in] interrupt: EXMC interrupt flag
  600. only one parameter can be selected which are shown as below:
  601. \arg EXMC_NAND_PCCARD_INT_FLAG_RISE: rising edge interrupt and flag
  602. \arg EXMC_NAND_PCCARD_INT_FLAG_LEVEL: high-level interrupt and flag
  603. \arg EXMC_NAND_PCCARD_INT_FLAG_FALL: falling edge interrupt and flag
  604. \param[out] none
  605. \retval none
  606. */
  607. void exmc_interrupt_flag_clear(uint32_t exmc_bank,uint32_t interrupt)
  608. {
  609. /* NAND bank1,bank2 or PC card bank3 */
  610. EXMC_NPINTEN(exmc_bank) &= ~(interrupt >> INTEN_INTS_OFFSET);
  611. }