stm32f1xx_ll_fsmc.c 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929
  1. /**
  2. ******************************************************************************
  3. * @file stm32f1xx_ll_fsmc.c
  4. * @author MCD Application Team
  5. * @brief FSMC Low Layer HAL module driver.
  6. *
  7. * This file provides firmware functions to manage the following
  8. * functionalities of the Flexible Static Memory Controller (FSMC) peripheral memories:
  9. * + Initialization/de-initialization functions
  10. * + Peripheral Control functions
  11. * + Peripheral State functions
  12. *
  13. @verbatim
  14. =============================================================================
  15. ##### FSMC peripheral features #####
  16. =============================================================================
  17. [..] The Flexible static memory controller (FSMC) includes following memory controllers:
  18. (+) The NOR/PSRAM memory controller
  19. (+) The PC Card memory controller
  20. (+) The NAND memory controller
  21. (PC Card and NAND controllers available only on STM32F101xE, STM32F103xE, STM32F101xG and STM32F103xG)
  22. [..] The FSMC functional block makes the interface with synchronous and asynchronous static
  23. memories and 16-bit PC memory cards. Its main purposes are:
  24. (+) to translate AHB transactions into the appropriate external device protocol.
  25. (+) to meet the access time requirements of the external memory devices.
  26. [..] All external memories share the addresses, data and control signals with the controller.
  27. Each external device is accessed by means of a unique Chip Select. The FSMC performs
  28. only one access at a time to an external device.
  29. The main features of the FSMC controller are the following:
  30. (+) Interface with static-memory mapped devices including:
  31. (++) Static random access memory (SRAM).
  32. (++) NOR Flash memory.
  33. (++) PSRAM (4 memory banks).
  34. (++) 16-bit PC Card compatible devices.
  35. (++) Two banks of NAND Flash memory with ECC hardware to check up to 8 Kbytes of
  36. data.
  37. (+) Independent Chip Select control for each memory bank.
  38. (+) Independent configuration for each memory bank.
  39. @endverbatim
  40. ******************************************************************************
  41. * @attention
  42. *
  43. * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
  44. *
  45. * Redistribution and use in source and binary forms, with or without modification,
  46. * are permitted provided that the following conditions are met:
  47. * 1. Redistributions of source code must retain the above copyright notice,
  48. * this list of conditions and the following disclaimer.
  49. * 2. Redistributions in binary form must reproduce the above copyright notice,
  50. * this list of conditions and the following disclaimer in the documentation
  51. * and/or other materials provided with the distribution.
  52. * 3. Neither the name of STMicroelectronics nor the names of its contributors
  53. * may be used to endorse or promote products derived from this software
  54. * without specific prior written permission.
  55. *
  56. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  57. * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  58. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  59. * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  60. * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  61. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  62. * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  63. * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  64. * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  65. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  66. *
  67. ******************************************************************************
  68. */
  69. /* Includes ------------------------------------------------------------------*/
  70. #include "stm32f1xx_hal.h"
  71. /** @addtogroup STM32F1xx_HAL_Driver
  72. * @{
  73. */
  74. #if defined(FSMC_BANK1)
  75. #if defined(HAL_SRAM_MODULE_ENABLED) || defined(HAL_NOR_MODULE_ENABLED) || defined(HAL_PCCARD_MODULE_ENABLED) || defined(HAL_NAND_MODULE_ENABLED)
  76. /** @defgroup FSMC_LL FSMC Low Layer
  77. * @brief FSMC driver modules
  78. * @{
  79. */
  80. /* Private typedef -----------------------------------------------------------*/
  81. /* Private define ------------------------------------------------------------*/
  82. /* Private macro -------------------------------------------------------------*/
  83. /* Private variables ---------------------------------------------------------*/
  84. /* Private function prototypes -----------------------------------------------*/
  85. /* Exported functions --------------------------------------------------------*/
  86. /** @defgroup FSMC_LL_Exported_Functions FSMC Low Layer Exported Functions
  87. * @{
  88. */
  89. /** @defgroup FSMC_NORSRAM FSMC NORSRAM Controller functions
  90. * @brief NORSRAM Controller functions
  91. *
  92. @verbatim
  93. ==============================================================================
  94. ##### How to use NORSRAM device driver #####
  95. ==============================================================================
  96. [..]
  97. This driver contains a set of APIs to interface with the FSMC NORSRAM banks in order
  98. to run the NORSRAM external devices.
  99. (+) FSMC NORSRAM bank reset using the function FSMC_NORSRAM_DeInit()
  100. (+) FSMC NORSRAM bank control configuration using the function FSMC_NORSRAM_Init()
  101. (+) FSMC NORSRAM bank timing configuration using the function FSMC_NORSRAM_Timing_Init()
  102. (+) FSMC NORSRAM bank extended timing configuration using the function
  103. FSMC_NORSRAM_Extended_Timing_Init()
  104. (+) FSMC NORSRAM bank enable/disable write operation using the functions
  105. FSMC_NORSRAM_WriteOperation_Enable()/FSMC_NORSRAM_WriteOperation_Disable()
  106. @endverbatim
  107. * @{
  108. */
  109. /** @addtogroup FSMC_LL_NORSRAM_Private_Functions_Group1
  110. * @brief Initialization and Configuration functions
  111. *
  112. @verbatim
  113. ==============================================================================
  114. ##### Initialization and de_initialization functions #####
  115. ==============================================================================
  116. [..]
  117. This section provides functions allowing to:
  118. (+) Initialize and configure the FSMC NORSRAM interface
  119. (+) De-initialize the FSMC NORSRAM interface
  120. (+) Configure the FSMC clock and associated GPIOs
  121. @endverbatim
  122. * @{
  123. */
  124. /**
  125. * @brief Initialize the FSMC_NORSRAM device according to the specified
  126. * control parameters in the FSMC_NORSRAM_InitTypeDef
  127. * @param Device: Pointer to NORSRAM device instance
  128. * @param Init: Pointer to NORSRAM Initialization structure
  129. * @retval HAL status
  130. */
  131. HAL_StatusTypeDef FSMC_NORSRAM_Init(FSMC_NORSRAM_TypeDef *Device, FSMC_NORSRAM_InitTypeDef *Init)
  132. {
  133. /* Check the parameters */
  134. assert_param(IS_FSMC_NORSRAM_DEVICE(Device));
  135. assert_param(IS_FSMC_NORSRAM_BANK(Init->NSBank));
  136. assert_param(IS_FSMC_MUX(Init->DataAddressMux));
  137. assert_param(IS_FSMC_MEMORY(Init->MemoryType));
  138. assert_param(IS_FSMC_NORSRAM_MEMORY_WIDTH(Init->MemoryDataWidth));
  139. assert_param(IS_FSMC_BURSTMODE(Init->BurstAccessMode));
  140. assert_param(IS_FSMC_WAIT_POLARITY(Init->WaitSignalPolarity));
  141. assert_param(IS_FSMC_WRAP_MODE(Init->WrapMode));
  142. assert_param(IS_FSMC_WAIT_SIGNAL_ACTIVE(Init->WaitSignalActive));
  143. assert_param(IS_FSMC_WRITE_OPERATION(Init->WriteOperation));
  144. assert_param(IS_FSMC_WAITE_SIGNAL(Init->WaitSignal));
  145. assert_param(IS_FSMC_EXTENDED_MODE(Init->ExtendedMode));
  146. assert_param(IS_FSMC_ASYNWAIT(Init->AsynchronousWait));
  147. assert_param(IS_FSMC_WRITE_BURST(Init->WriteBurst));
  148. /* Disable NORSRAM Device */
  149. __FSMC_NORSRAM_DISABLE(Device, Init->NSBank);
  150. /* Set NORSRAM device control parameters */
  151. if (Init->MemoryType == FSMC_MEMORY_TYPE_NOR)
  152. {
  153. MODIFY_REG(Device->BTCR[Init->NSBank], BCR_CLEAR_MASK, (uint32_t)(FSMC_NORSRAM_FLASH_ACCESS_ENABLE
  154. | Init->DataAddressMux
  155. | Init->MemoryType
  156. | Init->MemoryDataWidth
  157. | Init->BurstAccessMode
  158. | Init->WaitSignalPolarity
  159. | Init->WrapMode
  160. | Init->WaitSignalActive
  161. | Init->WriteOperation
  162. | Init->WaitSignal
  163. | Init->ExtendedMode
  164. | Init->AsynchronousWait
  165. | Init->WriteBurst
  166. )
  167. );
  168. }
  169. else
  170. {
  171. MODIFY_REG(Device->BTCR[Init->NSBank], BCR_CLEAR_MASK, (uint32_t)(FSMC_NORSRAM_FLASH_ACCESS_DISABLE
  172. | Init->DataAddressMux
  173. | Init->MemoryType
  174. | Init->MemoryDataWidth
  175. | Init->BurstAccessMode
  176. | Init->WaitSignalPolarity
  177. | Init->WrapMode
  178. | Init->WaitSignalActive
  179. | Init->WriteOperation
  180. | Init->WaitSignal
  181. | Init->ExtendedMode
  182. | Init->AsynchronousWait
  183. | Init->WriteBurst
  184. )
  185. );
  186. }
  187. return HAL_OK;
  188. }
  189. /**
  190. * @brief DeInitialize the FSMC_NORSRAM peripheral
  191. * @param Device: Pointer to NORSRAM device instance
  192. * @param ExDevice: Pointer to NORSRAM extended mode device instance
  193. * @param Bank: NORSRAM bank number
  194. * @retval HAL status
  195. */
  196. HAL_StatusTypeDef FSMC_NORSRAM_DeInit(FSMC_NORSRAM_TypeDef *Device, FSMC_NORSRAM_EXTENDED_TypeDef *ExDevice, uint32_t Bank)
  197. {
  198. /* Check the parameters */
  199. assert_param(IS_FSMC_NORSRAM_DEVICE(Device));
  200. assert_param(IS_FSMC_NORSRAM_EXTENDED_DEVICE(ExDevice));
  201. assert_param(IS_FSMC_NORSRAM_BANK(Bank));
  202. /* Disable the FSMC_NORSRAM device */
  203. __FSMC_NORSRAM_DISABLE(Device, Bank);
  204. /* De-initialize the FSMC_NORSRAM device */
  205. /* FSMC_NORSRAM_BANK1 */
  206. if(Bank == FSMC_NORSRAM_BANK1)
  207. {
  208. Device->BTCR[Bank] = 0x000030DBU;
  209. }
  210. /* FSMC_NORSRAM_BANK2, FSMC_NORSRAM_BANK3 or FSMC_NORSRAM_BANK4 */
  211. else
  212. {
  213. Device->BTCR[Bank] = 0x000030D2U;
  214. }
  215. Device->BTCR[Bank + 1U] = 0x0FFFFFFFU;
  216. ExDevice->BWTR[Bank] = 0x0FFFFFFFU;
  217. return HAL_OK;
  218. }
  219. /**
  220. * @brief Initialize the FSMC_NORSRAM Timing according to the specified
  221. * parameters in the FSMC_NORSRAM_TimingTypeDef
  222. * @param Device: Pointer to NORSRAM device instance
  223. * @param Timing: Pointer to NORSRAM Timing structure
  224. * @param Bank: NORSRAM bank number
  225. * @retval HAL status
  226. */
  227. HAL_StatusTypeDef FSMC_NORSRAM_Timing_Init(FSMC_NORSRAM_TypeDef *Device, FSMC_NORSRAM_TimingTypeDef *Timing, uint32_t Bank)
  228. {
  229. /* Check the parameters */
  230. assert_param(IS_FSMC_NORSRAM_DEVICE(Device));
  231. assert_param(IS_FSMC_ADDRESS_SETUP_TIME(Timing->AddressSetupTime));
  232. assert_param(IS_FSMC_ADDRESS_HOLD_TIME(Timing->AddressHoldTime));
  233. assert_param(IS_FSMC_DATASETUP_TIME(Timing->DataSetupTime));
  234. assert_param(IS_FSMC_TURNAROUND_TIME(Timing->BusTurnAroundDuration));
  235. assert_param(IS_FSMC_CLK_DIV(Timing->CLKDivision));
  236. assert_param(IS_FSMC_DATA_LATENCY(Timing->DataLatency));
  237. assert_param(IS_FSMC_ACCESS_MODE(Timing->AccessMode));
  238. assert_param(IS_FSMC_NORSRAM_BANK(Bank));
  239. /* Set FSMC_NORSRAM device timing parameters */
  240. MODIFY_REG(Device->BTCR[Bank + 1U], \
  241. BTR_CLEAR_MASK, \
  242. (uint32_t)(Timing->AddressSetupTime | \
  243. ((Timing->AddressHoldTime) << FSMC_BTRx_ADDHLD_Pos) | \
  244. ((Timing->DataSetupTime) << FSMC_BTRx_DATAST_Pos) | \
  245. ((Timing->BusTurnAroundDuration) << FSMC_BTRx_BUSTURN_Pos) | \
  246. (((Timing->CLKDivision) - 1U) << FSMC_BTRx_CLKDIV_Pos) | \
  247. (((Timing->DataLatency) - 2U) << FSMC_BTRx_DATLAT_Pos) | \
  248. (Timing->AccessMode)));
  249. return HAL_OK;
  250. }
  251. /**
  252. * @brief Initialize the FSMC_NORSRAM Extended mode Timing according to the specified
  253. * parameters in the FSMC_NORSRAM_TimingTypeDef
  254. * @param Device: Pointer to NORSRAM device instance
  255. * @param Timing: Pointer to NORSRAM Timing structure
  256. * @param Bank: NORSRAM bank number
  257. * @param ExtendedMode FSMC Extended Mode
  258. * This parameter can be one of the following values:
  259. * @arg FSMC_EXTENDED_MODE_DISABLE
  260. * @arg FSMC_EXTENDED_MODE_ENABLE
  261. * @retval HAL status
  262. */
  263. HAL_StatusTypeDef FSMC_NORSRAM_Extended_Timing_Init(FSMC_NORSRAM_EXTENDED_TypeDef *Device, FSMC_NORSRAM_TimingTypeDef *Timing, uint32_t Bank, uint32_t ExtendedMode)
  264. {
  265. /* Check the parameters */
  266. assert_param(IS_FSMC_EXTENDED_MODE(ExtendedMode));
  267. /* Set NORSRAM device timing register for write configuration, if extended mode is used */
  268. if(ExtendedMode == FSMC_EXTENDED_MODE_ENABLE)
  269. {
  270. /* Check the parameters */
  271. assert_param(IS_FSMC_NORSRAM_EXTENDED_DEVICE(Device));
  272. assert_param(IS_FSMC_ADDRESS_SETUP_TIME(Timing->AddressSetupTime));
  273. assert_param(IS_FSMC_ADDRESS_HOLD_TIME(Timing->AddressHoldTime));
  274. assert_param(IS_FSMC_DATASETUP_TIME(Timing->DataSetupTime));
  275. #if defined(STM32F101xE) || defined(STM32F103xE) || defined(STM32F101xG) || defined(STM32F103xG)
  276. assert_param(IS_FSMC_TURNAROUND_TIME(Timing->BusTurnAroundDuration));
  277. #else
  278. assert_param(IS_FSMC_CLK_DIV(Timing->CLKDivision));
  279. assert_param(IS_FSMC_DATA_LATENCY(Timing->DataLatency));
  280. #endif /* STM32F101xE || STM32F103xE || STM32F101xG || STM32F103xG */
  281. assert_param(IS_FSMC_ACCESS_MODE(Timing->AccessMode));
  282. assert_param(IS_FSMC_NORSRAM_BANK(Bank));
  283. /* Set NORSRAM device timing register for write configuration, if extended mode is used */
  284. #if defined(STM32F101xE) || defined(STM32F103xE) || defined(STM32F101xG) || defined(STM32F103xG)
  285. MODIFY_REG(Device->BWTR[Bank], \
  286. BWTR_CLEAR_MASK, \
  287. (uint32_t)(Timing->AddressSetupTime | \
  288. ((Timing->AddressHoldTime) << FSMC_BWTRx_ADDHLD_Pos) | \
  289. ((Timing->DataSetupTime) << FSMC_BWTRx_DATAST_Pos) | \
  290. Timing->AccessMode | \
  291. ((Timing->BusTurnAroundDuration) << FSMC_BWTRx_BUSTURN_Pos)));
  292. #else
  293. MODIFY_REG(Device->BWTR[Bank], \
  294. BWTR_CLEAR_MASK, \
  295. (uint32_t)(Timing->AddressSetupTime | \
  296. ((Timing->AddressHoldTime) << FSMC_BWTRx_ADDHLD_Pos) | \
  297. ((Timing->DataSetupTime) << FSMC_BWTRx_DATAST_Pos) | \
  298. Timing->AccessMode | \
  299. (((Timing->CLKDivision) - 1U) << FSMC_BTRx_CLKDIV_Pos) | \
  300. (((Timing->DataLatency) - 2U) << FSMC_BWTRx_DATLAT_Pos)));
  301. #endif /* STM32F101xE || STM32F103xE || STM32F101xG || STM32F103xG */
  302. }
  303. else
  304. {
  305. Device->BWTR[Bank] = 0x0FFFFFFFU;
  306. }
  307. return HAL_OK;
  308. }
  309. /**
  310. * @}
  311. */
  312. /** @defgroup FSMC_NORSRAM_Group2 Control functions
  313. * @brief management functions
  314. *
  315. @verbatim
  316. ==============================================================================
  317. ##### FSMC_NORSRAM Control functions #####
  318. ==============================================================================
  319. [..]
  320. This subsection provides a set of functions allowing to control dynamically
  321. the FSMC NORSRAM interface.
  322. @endverbatim
  323. * @{
  324. */
  325. /**
  326. * @brief Enables dynamically FSMC_NORSRAM write operation.
  327. * @param Device: Pointer to NORSRAM device instance
  328. * @param Bank: NORSRAM bank number
  329. * @retval HAL status
  330. */
  331. HAL_StatusTypeDef FSMC_NORSRAM_WriteOperation_Enable(FSMC_NORSRAM_TypeDef *Device, uint32_t Bank)
  332. {
  333. /* Check the parameters */
  334. assert_param(IS_FSMC_NORSRAM_DEVICE(Device));
  335. assert_param(IS_FSMC_NORSRAM_BANK(Bank));
  336. /* Enable write operation */
  337. SET_BIT(Device->BTCR[Bank], FSMC_WRITE_OPERATION_ENABLE);
  338. return HAL_OK;
  339. }
  340. /**
  341. * @brief Disables dynamically FSMC_NORSRAM write operation.
  342. * @param Device: Pointer to NORSRAM device instance
  343. * @param Bank: NORSRAM bank number
  344. * @retval HAL status
  345. */
  346. HAL_StatusTypeDef FSMC_NORSRAM_WriteOperation_Disable(FSMC_NORSRAM_TypeDef *Device, uint32_t Bank)
  347. {
  348. /* Check the parameters */
  349. assert_param(IS_FSMC_NORSRAM_DEVICE(Device));
  350. assert_param(IS_FSMC_NORSRAM_BANK(Bank));
  351. /* Disable write operation */
  352. CLEAR_BIT(Device->BTCR[Bank], FSMC_WRITE_OPERATION_ENABLE);
  353. return HAL_OK;
  354. }
  355. /**
  356. * @}
  357. */
  358. /**
  359. * @}
  360. */
  361. #if (defined (STM32F101xE) || defined(STM32F103xE) || defined(STM32F101xG) || defined(STM32F103xG))
  362. /** @defgroup FSMC_NAND FSMC NAND Controller functions
  363. * @brief NAND Controller functions
  364. *
  365. @verbatim
  366. ==============================================================================
  367. ##### How to use NAND device driver #####
  368. ==============================================================================
  369. [..]
  370. This driver contains a set of APIs to interface with the FSMC NAND banks in order
  371. to run the NAND external devices.
  372. (+) FSMC NAND bank reset using the function FSMC_NAND_DeInit()
  373. (+) FSMC NAND bank control configuration using the function FSMC_NAND_Init()
  374. (+) FSMC NAND bank common space timing configuration using the function
  375. FSMC_NAND_CommonSpace_Timing_Init()
  376. (+) FSMC NAND bank attribute space timing configuration using the function
  377. FSMC_NAND_AttributeSpace_Timing_Init()
  378. (+) FSMC NAND bank enable/disable ECC correction feature using the functions
  379. FSMC_NAND_ECC_Enable()/FSMC_NAND_ECC_Disable()
  380. (+) FSMC NAND bank get ECC correction code using the function FSMC_NAND_GetECC()
  381. @endverbatim
  382. * @{
  383. */
  384. /** @defgroup FSMC_NAND_Exported_Functions_Group1 Initialization and de-initialization functions
  385. * @brief Initialization and Configuration functions
  386. *
  387. @verbatim
  388. ==============================================================================
  389. ##### Initialization and de_initialization functions #####
  390. ==============================================================================
  391. [..]
  392. This section provides functions allowing to:
  393. (+) Initialize and configure the FSMC NAND interface
  394. (+) De-initialize the FSMC NAND interface
  395. (+) Configure the FSMC clock and associated GPIOs
  396. @endverbatim
  397. * @{
  398. */
  399. /**
  400. * @brief Initializes the FSMC_NAND device according to the specified
  401. * control parameters in the FSMC_NAND_HandleTypeDef
  402. * @param Device: Pointer to NAND device instance
  403. * @param Init: Pointer to NAND Initialization structure
  404. * @retval HAL status
  405. */
  406. HAL_StatusTypeDef FSMC_NAND_Init(FSMC_NAND_TypeDef *Device, FSMC_NAND_InitTypeDef *Init)
  407. {
  408. /* Check the parameters */
  409. assert_param(IS_FSMC_NAND_DEVICE(Device));
  410. assert_param(IS_FSMC_NAND_BANK(Init->NandBank));
  411. assert_param(IS_FSMC_WAIT_FEATURE(Init->Waitfeature));
  412. assert_param(IS_FSMC_NAND_MEMORY_WIDTH(Init->MemoryDataWidth));
  413. assert_param(IS_FSMC_ECC_STATE(Init->EccComputation));
  414. assert_param(IS_FSMC_ECCPAGE_SIZE(Init->ECCPageSize));
  415. assert_param(IS_FSMC_TCLR_TIME(Init->TCLRSetupTime));
  416. assert_param(IS_FSMC_TAR_TIME(Init->TARSetupTime));
  417. /* Set NAND device control parameters */
  418. if (Init->NandBank == FSMC_NAND_BANK2)
  419. {
  420. /* NAND bank 2 registers configuration */
  421. MODIFY_REG(Device->PCR2, PCR_CLEAR_MASK, (Init->Waitfeature |
  422. FSMC_PCR_MEMORY_TYPE_NAND |
  423. Init->MemoryDataWidth |
  424. Init->EccComputation |
  425. Init->ECCPageSize |
  426. ((Init->TCLRSetupTime) << FSMC_PCRx_TCLR_Pos) |
  427. ((Init->TARSetupTime) << FSMC_PCRx_TAR_Pos)));
  428. }
  429. else
  430. {
  431. /* NAND bank 3 registers configuration */
  432. MODIFY_REG(Device->PCR3, PCR_CLEAR_MASK, (Init->Waitfeature |
  433. FSMC_PCR_MEMORY_TYPE_NAND |
  434. Init->MemoryDataWidth |
  435. Init->EccComputation |
  436. Init->ECCPageSize |
  437. ((Init->TCLRSetupTime) << FSMC_PCRx_TCLR_Pos) |
  438. ((Init->TARSetupTime) << FSMC_PCRx_TAR_Pos)));
  439. }
  440. return HAL_OK;
  441. }
  442. /**
  443. * @brief Initializes the FSMC_NAND Common space Timing according to the specified
  444. * parameters in the FSMC_NAND_PCC_TimingTypeDef
  445. * @param Device: Pointer to NAND device instance
  446. * @param Timing: Pointer to NAND timing structure
  447. * @param Bank: NAND bank number
  448. * @retval HAL status
  449. */
  450. HAL_StatusTypeDef FSMC_NAND_CommonSpace_Timing_Init(FSMC_NAND_TypeDef *Device, FSMC_NAND_PCC_TimingTypeDef *Timing, uint32_t Bank)
  451. {
  452. /* Check the parameters */
  453. assert_param(IS_FSMC_NAND_DEVICE(Device));
  454. assert_param(IS_FSMC_SETUP_TIME(Timing->SetupTime));
  455. assert_param(IS_FSMC_WAIT_TIME(Timing->WaitSetupTime));
  456. assert_param(IS_FSMC_HOLD_TIME(Timing->HoldSetupTime));
  457. assert_param(IS_FSMC_HIZ_TIME(Timing->HiZSetupTime));
  458. assert_param(IS_FSMC_NAND_BANK(Bank));
  459. /* Set FMC_NAND device timing parameters */
  460. if(Bank == FSMC_NAND_BANK2)
  461. {
  462. /* NAND bank 2 registers configuration */
  463. MODIFY_REG(Device->PMEM2, PMEM_CLEAR_MASK, (Timing->SetupTime | \
  464. ((Timing->WaitSetupTime) << FSMC_PMEMx_MEMWAITx_Pos) | \
  465. ((Timing->HoldSetupTime) << FSMC_PMEMx_MEMHOLDx_Pos) | \
  466. ((Timing->HiZSetupTime) << FSMC_PMEMx_MEMHIZx_Pos)));
  467. }
  468. else
  469. {
  470. /* NAND bank 3 registers configuration */
  471. MODIFY_REG(Device->PMEM3, PMEM_CLEAR_MASK, (Timing->SetupTime | \
  472. ((Timing->WaitSetupTime) << FSMC_PMEMx_MEMWAITx_Pos) | \
  473. ((Timing->HoldSetupTime) << FSMC_PMEMx_MEMHOLDx_Pos) | \
  474. ((Timing->HiZSetupTime) << FSMC_PMEMx_MEMHIZx_Pos)));
  475. }
  476. return HAL_OK;
  477. }
  478. /**
  479. * @brief Initializes the FSMC_NAND Attribute space Timing according to the specified
  480. * parameters in the FSMC_NAND_PCC_TimingTypeDef
  481. * @param Device: Pointer to NAND device instance
  482. * @param Timing: Pointer to NAND timing structure
  483. * @param Bank: NAND bank number
  484. * @retval HAL status
  485. */
  486. HAL_StatusTypeDef FSMC_NAND_AttributeSpace_Timing_Init(FSMC_NAND_TypeDef *Device, FSMC_NAND_PCC_TimingTypeDef *Timing, uint32_t Bank)
  487. {
  488. /* Check the parameters */
  489. assert_param(IS_FSMC_NAND_DEVICE(Device));
  490. assert_param(IS_FSMC_SETUP_TIME(Timing->SetupTime));
  491. assert_param(IS_FSMC_WAIT_TIME(Timing->WaitSetupTime));
  492. assert_param(IS_FSMC_HOLD_TIME(Timing->HoldSetupTime));
  493. assert_param(IS_FSMC_HIZ_TIME(Timing->HiZSetupTime));
  494. assert_param(IS_FSMC_NAND_BANK(Bank));
  495. /* Set FMC_NAND device timing parameters */
  496. if(Bank == FSMC_NAND_BANK2)
  497. {
  498. /* NAND bank 2 registers configuration */
  499. MODIFY_REG(Device->PATT2, PATT_CLEAR_MASK, (Timing->SetupTime | \
  500. ((Timing->WaitSetupTime) << FSMC_PATTx_ATTWAITx_Pos) | \
  501. ((Timing->HoldSetupTime) << FSMC_PATTx_ATTHOLDx_Pos) | \
  502. ((Timing->HiZSetupTime) << FSMC_PATTx_ATTHIZx_Pos)));
  503. }
  504. else
  505. {
  506. /* NAND bank 3 registers configuration */
  507. MODIFY_REG(Device->PATT3, PATT_CLEAR_MASK, (Timing->SetupTime | \
  508. ((Timing->WaitSetupTime) << FSMC_PATTx_ATTWAITx_Pos) | \
  509. ((Timing->HoldSetupTime) << FSMC_PATTx_ATTHOLDx_Pos) | \
  510. ((Timing->HiZSetupTime) << FSMC_PATTx_ATTHIZx_Pos)));
  511. }
  512. return HAL_OK;
  513. }
  514. /**
  515. * @brief DeInitializes the FSMC_NAND device
  516. * @param Device: Pointer to NAND device instance
  517. * @param Bank: NAND bank number
  518. * @retval HAL status
  519. */
  520. HAL_StatusTypeDef FSMC_NAND_DeInit(FSMC_NAND_TypeDef *Device, uint32_t Bank)
  521. {
  522. /* Check the parameters */
  523. assert_param(IS_FSMC_NAND_DEVICE(Device));
  524. assert_param(IS_FSMC_NAND_BANK(Bank));
  525. /* Disable the NAND Bank */
  526. __FSMC_NAND_DISABLE(Device, Bank);
  527. /* De-initialize the NAND Bank */
  528. if(Bank == FSMC_NAND_BANK2)
  529. {
  530. /* Set the FSMC_NAND_BANK2 registers to their reset values */
  531. WRITE_REG(Device->PCR2, 0x00000018U);
  532. WRITE_REG(Device->SR2, 0x00000040U);
  533. WRITE_REG(Device->PMEM2, 0xFCFCFCFCU);
  534. WRITE_REG(Device->PATT2, 0xFCFCFCFCU);
  535. }
  536. /* FSMC_Bank3_NAND */
  537. else
  538. {
  539. /* Set the FSMC_NAND_BANK3 registers to their reset values */
  540. WRITE_REG(Device->PCR3, 0x00000018U);
  541. WRITE_REG(Device->SR3, 0x00000040U);
  542. WRITE_REG(Device->PMEM3, 0xFCFCFCFCU);
  543. WRITE_REG(Device->PATT3, 0xFCFCFCFCU);
  544. }
  545. return HAL_OK;
  546. }
  547. /**
  548. * @}
  549. */
  550. /** @defgroup FSMC_NAND_Exported_Functions_Group2 Peripheral Control functions
  551. * @brief management functions
  552. *
  553. @verbatim
  554. ==============================================================================
  555. ##### FSMC_NAND Control functions #####
  556. ==============================================================================
  557. [..]
  558. This subsection provides a set of functions allowing to control dynamically
  559. the FSMC NAND interface.
  560. @endverbatim
  561. * @{
  562. */
  563. /**
  564. * @brief Enables dynamically FSMC_NAND ECC feature.
  565. * @param Device: Pointer to NAND device instance
  566. * @param Bank: NAND bank number
  567. * @retval HAL status
  568. */
  569. HAL_StatusTypeDef FSMC_NAND_ECC_Enable(FSMC_NAND_TypeDef *Device, uint32_t Bank)
  570. {
  571. /* Check the parameters */
  572. assert_param(IS_FSMC_NAND_DEVICE(Device));
  573. assert_param(IS_FSMC_NAND_BANK(Bank));
  574. /* Enable ECC feature */
  575. if(Bank == FSMC_NAND_BANK2)
  576. {
  577. SET_BIT(Device->PCR2, FSMC_PCRx_ECCEN);
  578. }
  579. else
  580. {
  581. SET_BIT(Device->PCR3, FSMC_PCRx_ECCEN);
  582. }
  583. return HAL_OK;
  584. }
  585. /**
  586. * @brief Disables dynamically FSMC_NAND ECC feature.
  587. * @param Device: Pointer to NAND device instance
  588. * @param Bank: NAND bank number
  589. * @retval HAL status
  590. */
  591. HAL_StatusTypeDef FSMC_NAND_ECC_Disable(FSMC_NAND_TypeDef *Device, uint32_t Bank)
  592. {
  593. /* Check the parameters */
  594. assert_param(IS_FSMC_NAND_DEVICE(Device));
  595. assert_param(IS_FSMC_NAND_BANK(Bank));
  596. /* Disable ECC feature */
  597. if(Bank == FSMC_NAND_BANK2)
  598. {
  599. CLEAR_BIT(Device->PCR2, FSMC_PCRx_ECCEN);
  600. }
  601. else
  602. {
  603. CLEAR_BIT(Device->PCR3, FSMC_PCRx_ECCEN);
  604. }
  605. return HAL_OK;
  606. }
  607. /**
  608. * @brief Disables dynamically FSMC_NAND ECC feature.
  609. * @param Device: Pointer to NAND device instance
  610. * @param ECCval: Pointer to ECC value
  611. * @param Bank: NAND bank number
  612. * @param Timeout: Timeout wait value
  613. * @retval HAL status
  614. */
  615. HAL_StatusTypeDef FSMC_NAND_GetECC(FSMC_NAND_TypeDef *Device, uint32_t *ECCval, uint32_t Bank, uint32_t Timeout)
  616. {
  617. uint32_t tickstart = 0U;
  618. /* Check the parameters */
  619. assert_param(IS_FSMC_NAND_DEVICE(Device));
  620. assert_param(IS_FSMC_NAND_BANK(Bank));
  621. /* Get tick */
  622. tickstart = HAL_GetTick();
  623. /* Wait until FIFO is empty */
  624. while(__FSMC_NAND_GET_FLAG(Device, Bank, FSMC_FLAG_FEMPT) == RESET)
  625. {
  626. /* Check for the Timeout */
  627. if(Timeout != HAL_MAX_DELAY)
  628. {
  629. if((Timeout == 0U)||((HAL_GetTick() - tickstart ) > Timeout))
  630. {
  631. return HAL_TIMEOUT;
  632. }
  633. }
  634. }
  635. if(Bank == FSMC_NAND_BANK2)
  636. {
  637. /* Get the ECCR2 register value */
  638. *ECCval = (uint32_t)Device->ECCR2;
  639. }
  640. else
  641. {
  642. /* Get the ECCR3 register value */
  643. *ECCval = (uint32_t)Device->ECCR3;
  644. }
  645. return HAL_OK;
  646. }
  647. /**
  648. * @}
  649. */
  650. /**
  651. * @}
  652. */
  653. /** @defgroup FSMC_PCCARD FSMC PCCARD Controller functions
  654. * @brief PCCARD Controller functions
  655. *
  656. @verbatim
  657. ==============================================================================
  658. ##### How to use PCCARD device driver #####
  659. ==============================================================================
  660. [..]
  661. This driver contains a set of APIs to interface with the FSMC PCCARD bank in order
  662. to run the PCCARD/compact flash external devices.
  663. (+) FSMC PCCARD bank reset using the function FSMC_PCCARD_DeInit()
  664. (+) FSMC PCCARD bank control configuration using the function FSMC_PCCARD_Init()
  665. (+) FSMC PCCARD bank common space timing configuration using the function
  666. FSMC_PCCARD_CommonSpace_Timing_Init()
  667. (+) FSMC PCCARD bank attribute space timing configuration using the function
  668. FSMC_PCCARD_AttributeSpace_Timing_Init()
  669. (+) FSMC PCCARD bank IO space timing configuration using the function
  670. FSMC_PCCARD_IOSpace_Timing_Init()
  671. @endverbatim
  672. * @{
  673. */
  674. /** @defgroup FSMC_PCCARD_Exported_Functions_Group1 Initialization and de-initialization functions
  675. * @brief Initialization and Configuration functions
  676. *
  677. @verbatim
  678. ==============================================================================
  679. ##### Initialization and de_initialization functions #####
  680. ==============================================================================
  681. [..]
  682. This section provides functions allowing to:
  683. (+) Initialize and configure the FSMC PCCARD interface
  684. (+) De-initialize the FSMC PCCARD interface
  685. (+) Configure the FSMC clock and associated GPIOs
  686. @endverbatim
  687. * @{
  688. */
  689. /**
  690. * @brief Initializes the FSMC_PCCARD device according to the specified
  691. * control parameters in the FSMC_PCCARD_HandleTypeDef
  692. * @param Device: Pointer to PCCARD device instance
  693. * @param Init: Pointer to PCCARD Initialization structure
  694. * @retval HAL status
  695. */
  696. HAL_StatusTypeDef FSMC_PCCARD_Init(FSMC_PCCARD_TypeDef *Device, FSMC_PCCARD_InitTypeDef *Init)
  697. {
  698. /* Check the parameters */
  699. assert_param(IS_FSMC_PCCARD_DEVICE(Device));
  700. assert_param(IS_FSMC_WAIT_FEATURE(Init->Waitfeature));
  701. assert_param(IS_FSMC_TCLR_TIME(Init->TCLRSetupTime));
  702. assert_param(IS_FSMC_TAR_TIME(Init->TARSetupTime));
  703. /* Set FSMC_PCCARD device control parameters */
  704. MODIFY_REG(Device->PCR4,
  705. (FSMC_PCRx_PTYP | FSMC_PCRx_PWAITEN | FSMC_PCRx_PWID |
  706. FSMC_PCRx_TCLR | FSMC_PCRx_TAR),
  707. (FSMC_PCR_MEMORY_TYPE_PCCARD |
  708. Init->Waitfeature |
  709. FSMC_NAND_PCC_MEM_BUS_WIDTH_16 |
  710. (Init->TCLRSetupTime << FSMC_PCRx_TCLR_Pos) |
  711. (Init->TARSetupTime << FSMC_PCRx_TAR_Pos)));
  712. return HAL_OK;
  713. }
  714. /**
  715. * @brief Initializes the FSMC_PCCARD Common space Timing according to the specified
  716. * parameters in the FSMC_NAND_PCC_TimingTypeDef
  717. * @param Device: Pointer to PCCARD device instance
  718. * @param Timing: Pointer to PCCARD timing structure
  719. * @retval HAL status
  720. */
  721. HAL_StatusTypeDef FSMC_PCCARD_CommonSpace_Timing_Init(FSMC_PCCARD_TypeDef *Device, FSMC_NAND_PCC_TimingTypeDef *Timing)
  722. {
  723. /* Check the parameters */
  724. assert_param(IS_FSMC_PCCARD_DEVICE(Device));
  725. assert_param(IS_FSMC_SETUP_TIME(Timing->SetupTime));
  726. assert_param(IS_FSMC_WAIT_TIME(Timing->WaitSetupTime));
  727. assert_param(IS_FSMC_HOLD_TIME(Timing->HoldSetupTime));
  728. assert_param(IS_FSMC_HIZ_TIME(Timing->HiZSetupTime));
  729. /* Set PCCARD timing parameters */
  730. MODIFY_REG(Device->PMEM4, PMEM_CLEAR_MASK,
  731. (Timing->SetupTime |
  732. ((Timing->WaitSetupTime) << FSMC_PMEMx_MEMWAITx_Pos) |
  733. ((Timing->HoldSetupTime) << FSMC_PMEMx_MEMHOLDx_Pos) |
  734. ((Timing->HiZSetupTime) << FSMC_PMEMx_MEMHIZx_Pos)));
  735. return HAL_OK;
  736. }
  737. /**
  738. * @brief Initializes the FSMC_PCCARD Attribute space Timing according to the specified
  739. * parameters in the FSMC_NAND_PCC_TimingTypeDef
  740. * @param Device: Pointer to PCCARD device instance
  741. * @param Timing: Pointer to PCCARD timing structure
  742. * @retval HAL status
  743. */
  744. HAL_StatusTypeDef FSMC_PCCARD_AttributeSpace_Timing_Init(FSMC_PCCARD_TypeDef *Device, FSMC_NAND_PCC_TimingTypeDef *Timing)
  745. {
  746. /* Check the parameters */
  747. assert_param(IS_FSMC_PCCARD_DEVICE(Device));
  748. assert_param(IS_FSMC_SETUP_TIME(Timing->SetupTime));
  749. assert_param(IS_FSMC_WAIT_TIME(Timing->WaitSetupTime));
  750. assert_param(IS_FSMC_HOLD_TIME(Timing->HoldSetupTime));
  751. assert_param(IS_FSMC_HIZ_TIME(Timing->HiZSetupTime));
  752. /* Set PCCARD timing parameters */
  753. MODIFY_REG(Device->PATT4, PATT_CLEAR_MASK, \
  754. (Timing->SetupTime | \
  755. ((Timing->WaitSetupTime) << FSMC_PATTx_ATTWAITx_Pos) | \
  756. ((Timing->HoldSetupTime) << FSMC_PATTx_ATTHOLDx_Pos) | \
  757. ((Timing->HiZSetupTime) << FSMC_PATTx_ATTHIZx_Pos)));
  758. return HAL_OK;
  759. }
  760. /**
  761. * @brief Initializes the FSMC_PCCARD IO space Timing according to the specified
  762. * parameters in the FSMC_NAND_PCC_TimingTypeDef
  763. * @param Device: Pointer to PCCARD device instance
  764. * @param Timing: Pointer to PCCARD timing structure
  765. * @retval HAL status
  766. */
  767. HAL_StatusTypeDef FSMC_PCCARD_IOSpace_Timing_Init(FSMC_PCCARD_TypeDef *Device, FSMC_NAND_PCC_TimingTypeDef *Timing)
  768. {
  769. /* Check the parameters */
  770. assert_param(IS_FSMC_PCCARD_DEVICE(Device));
  771. assert_param(IS_FSMC_SETUP_TIME(Timing->SetupTime));
  772. assert_param(IS_FSMC_WAIT_TIME(Timing->WaitSetupTime));
  773. assert_param(IS_FSMC_HOLD_TIME(Timing->HoldSetupTime));
  774. assert_param(IS_FSMC_HIZ_TIME(Timing->HiZSetupTime));
  775. /* Set FSMC_PCCARD device timing parameters */
  776. MODIFY_REG(Device->PIO4, PIO4_CLEAR_MASK, \
  777. (Timing->SetupTime | \
  778. (Timing->WaitSetupTime << FSMC_PIO4_IOWAIT4_Pos) | \
  779. (Timing->HoldSetupTime << FSMC_PIO4_IOHOLD4_Pos) | \
  780. (Timing->HiZSetupTime << FSMC_PIO4_IOHIZ4_Pos)));
  781. return HAL_OK;
  782. }
  783. /**
  784. * @brief DeInitializes the FSMC_PCCARD device
  785. * @param Device: Pointer to PCCARD device instance
  786. * @retval HAL status
  787. */
  788. HAL_StatusTypeDef FSMC_PCCARD_DeInit(FSMC_PCCARD_TypeDef *Device)
  789. {
  790. /* Check the parameters */
  791. assert_param(IS_FSMC_PCCARD_DEVICE(Device));
  792. /* Disable the FSMC_PCCARD device */
  793. __FSMC_PCCARD_DISABLE(Device);
  794. /* De-initialize the FSMC_PCCARD device */
  795. WRITE_REG(Device->PCR4, 0x00000018U);
  796. WRITE_REG(Device->SR4, 0x00000040U);
  797. WRITE_REG(Device->PMEM4, 0xFCFCFCFCU);
  798. WRITE_REG(Device->PATT4, 0xFCFCFCFCU);
  799. WRITE_REG(Device->PIO4, 0xFCFCFCFCU);
  800. return HAL_OK;
  801. }
  802. /**
  803. * @}
  804. */
  805. /**
  806. * @}
  807. */
  808. #endif /* STM32F101xE || STM32F103xE || STM32F101xG || STM32F103xG */
  809. /**
  810. * @}
  811. */
  812. /**
  813. * @}
  814. */
  815. #endif /* HAL_SRAM_MODULE_ENABLED || HAL_NOR_MODULE_ENABLED || HAL_NAND_MODULE_ENABLED || HAL_PCCARD_MODULE_ENABLED */
  816. #endif /* FSMC_BANK1 */
  817. /**
  818. * @}
  819. */
  820. /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/