stm32f4xx_hal_mmc.h 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724
  1. /**
  2. ******************************************************************************
  3. * @file stm32f4xx_hal_mmc.h
  4. * @author MCD Application Team
  5. * @brief Header file of MMC HAL module.
  6. ******************************************************************************
  7. * @attention
  8. *
  9. * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
  10. *
  11. * Redistribution and use in source and binary forms, with or without modification,
  12. * are permitted provided that the following conditions are met:
  13. * 1. Redistributions of source code must retain the above copyright notice,
  14. * this list of conditions and the following disclaimer.
  15. * 2. Redistributions in binary form must reproduce the above copyright notice,
  16. * this list of conditions and the following disclaimer in the documentation
  17. * and/or other materials provided with the distribution.
  18. * 3. Neither the name of STMicroelectronics nor the names of its contributors
  19. * may be used to endorse or promote products derived from this software
  20. * without specific prior written permission.
  21. *
  22. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  23. * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  25. * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  26. * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  28. * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  29. * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  30. * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32. *
  33. ******************************************************************************
  34. */
  35. /* Define to prevent recursive inclusion -------------------------------------*/
  36. #ifndef __STM32F4xx_HAL_MMC_H
  37. #define __STM32F4xx_HAL_MMC_H
  38. #ifdef __cplusplus
  39. extern "C" {
  40. #endif
  41. #if defined(STM32F405xx) || defined(STM32F415xx) || defined(STM32F407xx) || defined(STM32F417xx) || \
  42. defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx) || \
  43. defined(STM32F401xC) || defined(STM32F401xE) || defined(STM32F411xE) || defined(STM32F446xx) || \
  44. defined(STM32F469xx) || defined(STM32F479xx) || defined(STM32F412Zx) || defined(STM32F412Vx) || \
  45. defined(STM32F412Rx) || defined(STM32F412Cx) || defined(STM32F413xx) || defined(STM32F423xx)
  46. /* Includes ------------------------------------------------------------------*/
  47. #include "stm32f4xx_ll_sdmmc.h"
  48. /** @addtogroup STM32F4xx_HAL_Driver
  49. * @{
  50. */
  51. /** @defgroup MMC MMC
  52. * @brief MMC HAL module driver
  53. * @{
  54. */
  55. /* Exported types ------------------------------------------------------------*/
  56. /** @defgroup MMC_Exported_Types MMC Exported Types
  57. * @{
  58. */
  59. /** @defgroup MMC_Exported_Types_Group1 MMC State enumeration structure
  60. * @{
  61. */
  62. typedef enum
  63. {
  64. HAL_MMC_STATE_RESET = 0x00000000U, /*!< MMC not yet initialized or disabled */
  65. HAL_MMC_STATE_READY = 0x00000001U, /*!< MMC initialized and ready for use */
  66. HAL_MMC_STATE_TIMEOUT = 0x00000002U, /*!< MMC Timeout state */
  67. HAL_MMC_STATE_BUSY = 0x00000003U, /*!< MMC process ongoing */
  68. HAL_MMC_STATE_PROGRAMMING = 0x00000004U, /*!< MMC Programming State */
  69. HAL_MMC_STATE_RECEIVING = 0x00000005U, /*!< MMC Receinving State */
  70. HAL_MMC_STATE_TRANSFER = 0x00000006U, /*!< MMC Transfert State */
  71. HAL_MMC_STATE_ERROR = 0x0000000FU /*!< MMC is in error state */
  72. }HAL_MMC_StateTypeDef;
  73. /**
  74. * @}
  75. */
  76. /** @defgroup MMC_Exported_Types_Group2 MMC Card State enumeration structure
  77. * @{
  78. */
  79. typedef enum
  80. {
  81. HAL_MMC_CARD_READY = 0x00000001U, /*!< Card state is ready */
  82. HAL_MMC_CARD_IDENTIFICATION = 0x00000002U, /*!< Card is in identification state */
  83. HAL_MMC_CARD_STANDBY = 0x00000003U, /*!< Card is in standby state */
  84. HAL_MMC_CARD_TRANSFER = 0x00000004U, /*!< Card is in transfer state */
  85. HAL_MMC_CARD_SENDING = 0x00000005U, /*!< Card is sending an operation */
  86. HAL_MMC_CARD_RECEIVING = 0x00000006U, /*!< Card is receiving operation information */
  87. HAL_MMC_CARD_PROGRAMMING = 0x00000007U, /*!< Card is in programming state */
  88. HAL_MMC_CARD_DISCONNECTED = 0x00000008U, /*!< Card is disconnected */
  89. HAL_MMC_CARD_ERROR = 0x000000FFU /*!< Card response Error */
  90. }HAL_MMC_CardStateTypeDef;
  91. /**
  92. * @}
  93. */
  94. /** @defgroup MMC_Exported_Types_Group3 MMC Handle Structure definition
  95. * @{
  96. */
  97. #define MMC_InitTypeDef SDIO_InitTypeDef
  98. #define MMC_TypeDef SDIO_TypeDef
  99. /**
  100. * @brief MMC Card Information Structure definition
  101. */
  102. typedef struct
  103. {
  104. uint32_t CardType; /*!< Specifies the card Type */
  105. uint32_t Class; /*!< Specifies the class of the card class */
  106. uint32_t RelCardAdd; /*!< Specifies the Relative Card Address */
  107. uint32_t BlockNbr; /*!< Specifies the Card Capacity in blocks */
  108. uint32_t BlockSize; /*!< Specifies one block size in bytes */
  109. uint32_t LogBlockNbr; /*!< Specifies the Card logical Capacity in blocks */
  110. uint32_t LogBlockSize; /*!< Specifies logical block size in bytes */
  111. }HAL_MMC_CardInfoTypeDef;
  112. /**
  113. * @brief MMC handle Structure definition
  114. */
  115. typedef struct
  116. {
  117. MMC_TypeDef *Instance; /*!< MMC registers base address */
  118. MMC_InitTypeDef Init; /*!< MMC required parameters */
  119. HAL_LockTypeDef Lock; /*!< MMC locking object */
  120. uint32_t *pTxBuffPtr; /*!< Pointer to MMC Tx transfer Buffer */
  121. uint32_t TxXferSize; /*!< MMC Tx Transfer size */
  122. uint32_t *pRxBuffPtr; /*!< Pointer to MMC Rx transfer Buffer */
  123. uint32_t RxXferSize; /*!< MMC Rx Transfer size */
  124. __IO uint32_t Context; /*!< MMC transfer context */
  125. __IO HAL_MMC_StateTypeDef State; /*!< MMC card State */
  126. __IO uint32_t ErrorCode; /*!< MMC Card Error codes */
  127. DMA_HandleTypeDef *hdmarx; /*!< MMC Rx DMA handle parameters */
  128. DMA_HandleTypeDef *hdmatx; /*!< MMC Tx DMA handle parameters */
  129. HAL_MMC_CardInfoTypeDef MmcCard; /*!< MMC Card information */
  130. uint32_t CSD[4U]; /*!< MMC card specific data table */
  131. uint32_t CID[4U]; /*!< MMC card identification number table */
  132. }MMC_HandleTypeDef;
  133. /**
  134. * @}
  135. */
  136. /** @defgroup MMC_Exported_Types_Group4 Card Specific Data: CSD Register
  137. * @{
  138. */
  139. typedef struct
  140. {
  141. __IO uint8_t CSDStruct; /*!< CSD structure */
  142. __IO uint8_t SysSpecVersion; /*!< System specification version */
  143. __IO uint8_t Reserved1; /*!< Reserved */
  144. __IO uint8_t TAAC; /*!< Data read access time 1 */
  145. __IO uint8_t NSAC; /*!< Data read access time 2 in CLK cycles */
  146. __IO uint8_t MaxBusClkFrec; /*!< Max. bus clock frequency */
  147. __IO uint16_t CardComdClasses; /*!< Card command classes */
  148. __IO uint8_t RdBlockLen; /*!< Max. read data block length */
  149. __IO uint8_t PartBlockRead; /*!< Partial blocks for read allowed */
  150. __IO uint8_t WrBlockMisalign; /*!< Write block misalignment */
  151. __IO uint8_t RdBlockMisalign; /*!< Read block misalignment */
  152. __IO uint8_t DSRImpl; /*!< DSR implemented */
  153. __IO uint8_t Reserved2; /*!< Reserved */
  154. __IO uint32_t DeviceSize; /*!< Device Size */
  155. __IO uint8_t MaxRdCurrentVDDMin; /*!< Max. read current @ VDD min */
  156. __IO uint8_t MaxRdCurrentVDDMax; /*!< Max. read current @ VDD max */
  157. __IO uint8_t MaxWrCurrentVDDMin; /*!< Max. write current @ VDD min */
  158. __IO uint8_t MaxWrCurrentVDDMax; /*!< Max. write current @ VDD max */
  159. __IO uint8_t DeviceSizeMul; /*!< Device size multiplier */
  160. __IO uint8_t EraseGrSize; /*!< Erase group size */
  161. __IO uint8_t EraseGrMul; /*!< Erase group size multiplier */
  162. __IO uint8_t WrProtectGrSize; /*!< Write protect group size */
  163. __IO uint8_t WrProtectGrEnable; /*!< Write protect group enable */
  164. __IO uint8_t ManDeflECC; /*!< Manufacturer default ECC */
  165. __IO uint8_t WrSpeedFact; /*!< Write speed factor */
  166. __IO uint8_t MaxWrBlockLen; /*!< Max. write data block length */
  167. __IO uint8_t WriteBlockPaPartial; /*!< Partial blocks for write allowed */
  168. __IO uint8_t Reserved3; /*!< Reserved */
  169. __IO uint8_t ContentProtectAppli; /*!< Content protection application */
  170. __IO uint8_t FileFormatGrouop; /*!< File format group */
  171. __IO uint8_t CopyFlag; /*!< Copy flag (OTP) */
  172. __IO uint8_t PermWrProtect; /*!< Permanent write protection */
  173. __IO uint8_t TempWrProtect; /*!< Temporary write protection */
  174. __IO uint8_t FileFormat; /*!< File format */
  175. __IO uint8_t ECC; /*!< ECC code */
  176. __IO uint8_t CSD_CRC; /*!< CSD CRC */
  177. __IO uint8_t Reserved4; /*!< Always 1 */
  178. }HAL_MMC_CardCSDTypeDef;
  179. /**
  180. * @}
  181. */
  182. /** @defgroup MMC_Exported_Types_Group5 Card Identification Data: CID Register
  183. * @{
  184. */
  185. typedef struct
  186. {
  187. __IO uint8_t ManufacturerID; /*!< Manufacturer ID */
  188. __IO uint16_t OEM_AppliID; /*!< OEM/Application ID */
  189. __IO uint32_t ProdName1; /*!< Product Name part1 */
  190. __IO uint8_t ProdName2; /*!< Product Name part2 */
  191. __IO uint8_t ProdRev; /*!< Product Revision */
  192. __IO uint32_t ProdSN; /*!< Product Serial Number */
  193. __IO uint8_t Reserved1; /*!< Reserved1 */
  194. __IO uint16_t ManufactDate; /*!< Manufacturing Date */
  195. __IO uint8_t CID_CRC; /*!< CID CRC */
  196. __IO uint8_t Reserved2; /*!< Always 1 */
  197. }HAL_MMC_CardCIDTypeDef;
  198. /**
  199. * @}
  200. */
  201. /** @defgroup MMC_Exported_Types_Group6 MMC Card Status returned by ACMD13
  202. * @{
  203. */
  204. typedef struct
  205. {
  206. __IO uint8_t DataBusWidth; /*!< Shows the currently defined data bus width */
  207. __IO uint8_t SecuredMode; /*!< Card is in secured mode of operation */
  208. __IO uint16_t CardType; /*!< Carries information about card type */
  209. __IO uint32_t ProtectedAreaSize; /*!< Carries information about the capacity of protected area */
  210. __IO uint8_t SpeedClass; /*!< Carries information about the speed class of the card */
  211. __IO uint8_t PerformanceMove; /*!< Carries information about the card's performance move */
  212. __IO uint8_t AllocationUnitSize; /*!< Carries information about the card's allocation unit size */
  213. __IO uint16_t EraseSize; /*!< Determines the number of AUs to be erased in one operation */
  214. __IO uint8_t EraseTimeout; /*!< Determines the timeout for any number of AU erase */
  215. __IO uint8_t EraseOffset; /*!< Carries information about the erase offset */
  216. }HAL_MMC_CardStatusTypeDef;
  217. /**
  218. * @}
  219. */
  220. /**
  221. * @}
  222. */
  223. /* Exported constants --------------------------------------------------------*/
  224. /** @defgroup MMC_Exported_Constants Exported Constants
  225. * @{
  226. */
  227. #define BLOCKSIZE 512U /*!< Block size is 512 bytes */
  228. #define CAPACITY 0x400000U /*!< Log Block Nuumber for 2 G bytes Cards */
  229. /** @defgroup MMC_Exported_Constansts_Group1 MMC Error status enumeration Structure definition
  230. * @{
  231. */
  232. #define HAL_MMC_ERROR_NONE SDMMC_ERROR_NONE /*!< No error */
  233. #define HAL_MMC_ERROR_CMD_CRC_FAIL SDMMC_ERROR_CMD_CRC_FAIL /*!< Command response received (but CRC check failed) */
  234. #define HAL_MMC_ERROR_DATA_CRC_FAIL SDMMC_ERROR_DATA_CRC_FAIL /*!< Data block sent/received (CRC check failed) */
  235. #define HAL_MMC_ERROR_CMD_RSP_TIMEOUT SDMMC_ERROR_CMD_RSP_TIMEOUT /*!< Command response timeout */
  236. #define HAL_MMC_ERROR_DATA_TIMEOUT SDMMC_ERROR_DATA_TIMEOUT /*!< Data timeout */
  237. #define HAL_MMC_ERROR_TX_UNDERRUN SDMMC_ERROR_TX_UNDERRUN /*!< Transmit FIFO underrun */
  238. #define HAL_MMC_ERROR_RX_OVERRUN SDMMC_ERROR_RX_OVERRUN /*!< Receive FIFO overrun */
  239. #define HAL_MMC_ERROR_ADDR_MISALIGNED SDMMC_ERROR_ADDR_MISALIGNED /*!< Misaligned address */
  240. #define HAL_MMC_ERROR_BLOCK_LEN_ERR SDMMC_ERROR_BLOCK_LEN_ERR /*!< Transferred block length is not allowed for the card or the
  241. number of transferred bytes does not match the block length */
  242. #define HAL_MMC_ERROR_ERASE_SEQ_ERR SDMMC_ERROR_ERASE_SEQ_ERR /*!< An error in the sequence of erase command occurs */
  243. #define HAL_MMC_ERROR_BAD_ERASE_PARAM SDMMC_ERROR_BAD_ERASE_PARAM /*!< An invalid selection for erase groups */
  244. #define HAL_MMC_ERROR_WRITE_PROT_VIOLATION SDMMC_ERROR_WRITE_PROT_VIOLATION /*!< Attempt to program a write protect block */
  245. #define HAL_MMC_ERROR_LOCK_UNLOCK_FAILED SDMMC_ERROR_LOCK_UNLOCK_FAILED /*!< Sequence or password error has been detected in unlock
  246. command or if there was an attempt to access a locked card */
  247. #define HAL_MMC_ERROR_COM_CRC_FAILED SDMMC_ERROR_COM_CRC_FAILED /*!< CRC check of the previous command failed */
  248. #define HAL_MMC_ERROR_ILLEGAL_CMD SDMMC_ERROR_ILLEGAL_CMD /*!< Command is not legal for the card state */
  249. #define HAL_MMC_ERROR_CARD_ECC_FAILED SDMMC_ERROR_CARD_ECC_FAILED /*!< Card internal ECC was applied but failed to correct the data */
  250. #define HAL_MMC_ERROR_CC_ERR SDMMC_ERROR_CC_ERR /*!< Internal card controller error */
  251. #define HAL_MMC_ERROR_GENERAL_UNKNOWN_ERR SDMMC_ERROR_GENERAL_UNKNOWN_ERR /*!< General or unknown error */
  252. #define HAL_MMC_ERROR_STREAM_READ_UNDERRUN SDMMC_ERROR_STREAM_READ_UNDERRUN /*!< The card could not sustain data reading in stream rmode */
  253. #define HAL_MMC_ERROR_STREAM_WRITE_OVERRUN SDMMC_ERROR_STREAM_WRITE_OVERRUN /*!< The card could not sustain data programming in stream mode */
  254. #define HAL_MMC_ERROR_CID_CSD_OVERWRITE SDMMC_ERROR_CID_CSD_OVERWRITE /*!< CID/CSD overwrite error */
  255. #define HAL_MMC_ERROR_WP_ERASE_SKIP SDMMC_ERROR_WP_ERASE_SKIP /*!< Only partial address space was erased */
  256. #define HAL_MMC_ERROR_CARD_ECC_DISABLED SDMMC_ERROR_CARD_ECC_DISABLED /*!< Command has been executed without using internal ECC */
  257. #define HAL_MMC_ERROR_ERASE_RESET SDMMC_ERROR_ERASE_RESET /*!< Erase sequence was cleared before executing because an out
  258. of erase sequence command was received */
  259. #define HAL_MMC_ERROR_AKE_SEQ_ERR SDMMC_ERROR_AKE_SEQ_ERR /*!< Error in sequence of authentication */
  260. #define HAL_MMC_ERROR_INVALID_VOLTRANGE SDMMC_ERROR_INVALID_VOLTRANGE /*!< Error in case of invalid voltage range */
  261. #define HAL_MMC_ERROR_ADDR_OUT_OF_RANGE SDMMC_ERROR_ADDR_OUT_OF_RANGE /*!< Error when addressed block is out of range */
  262. #define HAL_MMC_ERROR_REQUEST_NOT_APPLICABLE SDMMC_ERROR_REQUEST_NOT_APPLICABLE /*!< Error when command request is not applicable */
  263. #define HAL_MMC_ERROR_PARAM SDMMC_ERROR_INVALID_PARAMETER /*!< the used parameter is not valid */
  264. #define HAL_MMC_ERROR_UNSUPPORTED_FEATURE SDMMC_ERROR_UNSUPPORTED_FEATURE /*!< Error when feature is not insupported */
  265. #define HAL_MMC_ERROR_BUSY SDMMC_ERROR_BUSY /*!< Error when transfer process is busy */
  266. #define HAL_MMC_ERROR_DMA SDMMC_ERROR_DMA /*!< Error while DMA transfer */
  267. #define HAL_MMC_ERROR_TIMEOUT SDMMC_ERROR_TIMEOUT /*!< Timeout error */
  268. /**
  269. * @}
  270. */
  271. /** @defgroup MMC_Exported_Constansts_Group2 MMC context enumeration structure
  272. * @{
  273. */
  274. #define MMC_CONTEXT_NONE 0x00000000U /*!< None */
  275. #define MMC_CONTEXT_READ_SINGLE_BLOCK 0x00000001U /*!< Read single block operation */
  276. #define MMC_CONTEXT_READ_MULTIPLE_BLOCK 0x00000002U /*!< Read multiple blocks operation */
  277. #define MMC_CONTEXT_WRITE_SINGLE_BLOCK 0x00000010U /*!< Write single block operation */
  278. #define MMC_CONTEXT_WRITE_MULTIPLE_BLOCK 0x00000020U /*!< Write multiple blocks operation */
  279. #define MMC_CONTEXT_IT 0x00000008U /*!< Process in Interrupt mode */
  280. #define MMC_CONTEXT_DMA 0x00000080U /*!< Process in DMA mode */
  281. /**
  282. * @}
  283. */
  284. /** @defgroup MMC_Exported_Constansts_Group3 MMC Voltage mode
  285. * @{
  286. */
  287. /**
  288. * @brief
  289. */
  290. #define MMC_HIGH_VOLTAGE_RANGE 0x80FF8000U /*!< VALUE OF ARGUMENT */
  291. #define MMC_DUAL_VOLTAGE_RANGE 0x80FF8080U /*!< VALUE OF ARGUMENT */
  292. #define eMMC_HIGH_VOLTAGE_RANGE 0xC0FF8000U /*!< for eMMC > 2Gb sector mode */
  293. #define eMMC_DUAL_VOLTAGE_RANGE 0xC0FF8080U /*!< for eMMC > 2Gb sector mode */
  294. #define MMC_INVALID_VOLTAGE_RANGE 0x0001FF01U
  295. /**
  296. * @}
  297. */
  298. /** @defgroup MMC_Exported_Constansts_Group4 MMC Memory Cards
  299. * @{
  300. */
  301. #define MMC_HIGH_VOLTAGE_CARD 0x00000000U
  302. #define MMC_DUAL_VOLTAGE_CARD 0x00000001U
  303. /**
  304. * @}
  305. */
  306. /**
  307. * @}
  308. */
  309. /* Exported macro ------------------------------------------------------------*/
  310. /** @defgroup MMC_Exported_macros MMC Exported Macros
  311. * @brief macros to handle interrupts and specific clock configurations
  312. * @{
  313. */
  314. /**
  315. * @brief Enable the MMC device.
  316. * @retval None
  317. */
  318. #define __HAL_MMC_ENABLE(__HANDLE__) __SDIO_ENABLE((__HANDLE__)->Instance)
  319. /**
  320. * @brief Disable the MMC device.
  321. * @retval None
  322. */
  323. #define __HAL_MMC_DISABLE(__HANDLE__) __SDIO_DISABLE((__HANDLE__)->Instance)
  324. /**
  325. * @brief Enable the SDMMC DMA transfer.
  326. * @retval None
  327. */
  328. #define __HAL_MMC_DMA_ENABLE(__HANDLE__) __SDIO_DMA_ENABLE((__HANDLE__)->Instance)
  329. /**
  330. * @brief Disable the SDMMC DMA transfer.
  331. * @retval None
  332. */
  333. #define __HAL_MMC_DMA_DISABLE(__HANDLE__) __SDIO_DMA_DISABLE((__HANDLE__)->Instance)
  334. /**
  335. * @brief Enable the MMC device interrupt.
  336. * @param __HANDLE__ MMC Handle
  337. * @param __INTERRUPT__ specifies the SDMMC interrupt sources to be enabled.
  338. * This parameter can be one or a combination of the following values:
  339. * @arg SDIO_IT_CCRCFAIL: Command response received (CRC check failed) interrupt
  340. * @arg SDIO_IT_DCRCFAIL: Data block sent/received (CRC check failed) interrupt
  341. * @arg SDIO_IT_CTIMEOUT: Command response timeout interrupt
  342. * @arg SDIO_IT_DTIMEOUT: Data timeout interrupt
  343. * @arg SDIO_IT_TXUNDERR: Transmit FIFO underrun error interrupt
  344. * @arg SDIO_IT_RXOVERR: Received FIFO overrun error interrupt
  345. * @arg SDIO_IT_CMDREND: Command response received (CRC check passed) interrupt
  346. * @arg SDIO_IT_CMDSENT: Command sent (no response required) interrupt
  347. * @arg SDIO_IT_DATAEND: Data end (data counter, SDIDCOUNT, is zero) interrupt
  348. * @arg SDIO_IT_DBCKEND: Data block sent/received (CRC check passed) interrupt
  349. * @arg SDIO_IT_CMDACT: Command transfer in progress interrupt
  350. * @arg SDIO_IT_TXACT: Data transmit in progress interrupt
  351. * @arg SDIO_IT_RXACT: Data receive in progress interrupt
  352. * @arg SDIO_IT_TXFIFOHE: Transmit FIFO Half Empty interrupt
  353. * @arg SDIO_IT_RXFIFOHF: Receive FIFO Half Full interrupt
  354. * @arg SDIO_IT_TXFIFOF: Transmit FIFO full interrupt
  355. * @arg SDIO_IT_RXFIFOF: Receive FIFO full interrupt
  356. * @arg SDIO_IT_TXFIFOE: Transmit FIFO empty interrupt
  357. * @arg SDIO_IT_RXFIFOE: Receive FIFO empty interrupt
  358. * @arg SDIO_IT_TXDAVL: Data available in transmit FIFO interrupt
  359. * @arg SDIO_IT_RXDAVL: Data available in receive FIFO interrupt
  360. * @arg SDIO_IT_SDIOIT: SD I/O interrupt received interrupt
  361. * @retval None
  362. */
  363. #define __HAL_MMC_ENABLE_IT(__HANDLE__, __INTERRUPT__) __SDIO_ENABLE_IT((__HANDLE__)->Instance, (__INTERRUPT__))
  364. /**
  365. * @brief Disable the MMC device interrupt.
  366. * @param __HANDLE__ MMC Handle
  367. * @param __INTERRUPT__ specifies the SDMMC interrupt sources to be disabled.
  368. * This parameter can be one or a combination of the following values:
  369. * @arg SDIO_IT_CCRCFAIL: Command response received (CRC check failed) interrupt
  370. * @arg SDIO_IT_DCRCFAIL: Data block sent/received (CRC check failed) interrupt
  371. * @arg SDIO_IT_CTIMEOUT: Command response timeout interrupt
  372. * @arg SDIO_IT_DTIMEOUT: Data timeout interrupt
  373. * @arg SDIO_IT_TXUNDERR: Transmit FIFO underrun error interrupt
  374. * @arg SDIO_IT_RXOVERR: Received FIFO overrun error interrupt
  375. * @arg SDIO_IT_CMDREND: Command response received (CRC check passed) interrupt
  376. * @arg SDIO_IT_CMDSENT: Command sent (no response required) interrupt
  377. * @arg SDIO_IT_DATAEND: Data end (data counter, SDIDCOUNT, is zero) interrupt
  378. * @arg SDIO_IT_DBCKEND: Data block sent/received (CRC check passed) interrupt
  379. * @arg SDIO_IT_CMDACT: Command transfer in progress interrupt
  380. * @arg SDIO_IT_TXACT: Data transmit in progress interrupt
  381. * @arg SDIO_IT_RXACT: Data receive in progress interrupt
  382. * @arg SDIO_IT_TXFIFOHE: Transmit FIFO Half Empty interrupt
  383. * @arg SDIO_IT_RXFIFOHF: Receive FIFO Half Full interrupt
  384. * @arg SDIO_IT_TXFIFOF: Transmit FIFO full interrupt
  385. * @arg SDIO_IT_RXFIFOF: Receive FIFO full interrupt
  386. * @arg SDIO_IT_TXFIFOE: Transmit FIFO empty interrupt
  387. * @arg SDIO_IT_RXFIFOE: Receive FIFO empty interrupt
  388. * @arg SDIO_IT_TXDAVL: Data available in transmit FIFO interrupt
  389. * @arg SDIO_IT_RXDAVL: Data available in receive FIFO interrupt
  390. * @arg SDIO_IT_SDIOIT: SD I/O interrupt received interrupt
  391. * @retval None
  392. */
  393. #define __HAL_MMC_DISABLE_IT(__HANDLE__, __INTERRUPT__) __SDIO_DISABLE_IT((__HANDLE__)->Instance, (__INTERRUPT__))
  394. /**
  395. * @brief Check whether the specified MMC flag is set or not.
  396. * @param __HANDLE__ MMC Handle
  397. * @param __FLAG__ specifies the flag to check.
  398. * This parameter can be one of the following values:
  399. * @arg SDIO_FLAG_CCRCFAIL: Command response received (CRC check failed)
  400. * @arg SDIO_FLAG_DCRCFAIL: Data block sent/received (CRC check failed)
  401. * @arg SDIO_FLAG_CTIMEOUT: Command response timeout
  402. * @arg SDIO_FLAG_DTIMEOUT: Data timeout
  403. * @arg SDIO_FLAG_TXUNDERR: Transmit FIFO underrun error
  404. * @arg SDIO_FLAG_RXOVERR: Received FIFO overrun error
  405. * @arg SDIO_FLAG_CMDREND: Command response received (CRC check passed)
  406. * @arg SDIO_FLAG_CMDSENT: Command sent (no response required)
  407. * @arg SDIO_FLAG_DATAEND: Data end (data counter, SDIDCOUNT, is zero)
  408. * @arg SDIO_FLAG_DBCKEND: Data block sent/received (CRC check passed)
  409. * @arg SDIO_FLAG_CMDACT: Command transfer in progress
  410. * @arg SDIO_FLAG_TXACT: Data transmit in progress
  411. * @arg SDIO_FLAG_RXACT: Data receive in progress
  412. * @arg SDIO_FLAG_TXFIFOHE: Transmit FIFO Half Empty
  413. * @arg SDIO_FLAG_RXFIFOHF: Receive FIFO Half Full
  414. * @arg SDIO_FLAG_TXFIFOF: Transmit FIFO full
  415. * @arg SDIO_FLAG_RXFIFOF: Receive FIFO full
  416. * @arg SDIO_FLAG_TXFIFOE: Transmit FIFO empty
  417. * @arg SDIO_FLAG_RXFIFOE: Receive FIFO empty
  418. * @arg SDIO_FLAG_TXDAVL: Data available in transmit FIFO
  419. * @arg SDIO_FLAG_RXDAVL: Data available in receive FIFO
  420. * @arg SDIO_FLAG_SDIOIT: SD I/O interrupt received
  421. * @retval The new state of MMC FLAG (SET or RESET).
  422. */
  423. #define __HAL_MMC_GET_FLAG(__HANDLE__, __FLAG__) __SDIO_GET_FLAG((__HANDLE__)->Instance, (__FLAG__))
  424. /**
  425. * @brief Clear the MMC's pending flags.
  426. * @param __HANDLE__ MMC Handle
  427. * @param __FLAG__ specifies the flag to clear.
  428. * This parameter can be one or a combination of the following values:
  429. * @arg SDIO_FLAG_CCRCFAIL: Command response received (CRC check failed)
  430. * @arg SDIO_FLAG_DCRCFAIL: Data block sent/received (CRC check failed)
  431. * @arg SDIO_FLAG_CTIMEOUT: Command response timeout
  432. * @arg SDIO_FLAG_DTIMEOUT: Data timeout
  433. * @arg SDIO_FLAG_TXUNDERR: Transmit FIFO underrun error
  434. * @arg SDIO_FLAG_RXOVERR: Received FIFO overrun error
  435. * @arg SDIO_FLAG_CMDREND: Command response received (CRC check passed)
  436. * @arg SDIO_FLAG_CMDSENT: Command sent (no response required)
  437. * @arg SDIO_FLAG_DATAEND: Data end (data counter, SDIDCOUNT, is zero)
  438. * @arg SDIO_FLAG_DBCKEND: Data block sent/received (CRC check passed)
  439. * @arg SDIO_FLAG_SDIOIT: SD I/O interrupt received
  440. * @retval None
  441. */
  442. #define __HAL_MMC_CLEAR_FLAG(__HANDLE__, __FLAG__) __SDIO_CLEAR_FLAG((__HANDLE__)->Instance, (__FLAG__))
  443. /**
  444. * @brief Check whether the specified MMC interrupt has occurred or not.
  445. * @param __HANDLE__ MMC Handle
  446. * @param __INTERRUPT__ specifies the SDMMC interrupt source to check.
  447. * This parameter can be one of the following values:
  448. * @arg SDIO_IT_CCRCFAIL: Command response received (CRC check failed) interrupt
  449. * @arg SDIO_IT_DCRCFAIL: Data block sent/received (CRC check failed) interrupt
  450. * @arg SDIO_IT_CTIMEOUT: Command response timeout interrupt
  451. * @arg SDIO_IT_DTIMEOUT: Data timeout interrupt
  452. * @arg SDIO_IT_TXUNDERR: Transmit FIFO underrun error interrupt
  453. * @arg SDIO_IT_RXOVERR: Received FIFO overrun error interrupt
  454. * @arg SDIO_IT_CMDREND: Command response received (CRC check passed) interrupt
  455. * @arg SDIO_IT_CMDSENT: Command sent (no response required) interrupt
  456. * @arg SDIO_IT_DATAEND: Data end (data counter, SDIDCOUNT, is zero) interrupt
  457. * @arg SDIO_IT_DBCKEND: Data block sent/received (CRC check passed) interrupt
  458. * @arg SDIO_IT_CMDACT: Command transfer in progress interrupt
  459. * @arg SDIO_IT_TXACT: Data transmit in progress interrupt
  460. * @arg SDIO_IT_RXACT: Data receive in progress interrupt
  461. * @arg SDIO_IT_TXFIFOHE: Transmit FIFO Half Empty interrupt
  462. * @arg SDIO_IT_RXFIFOHF: Receive FIFO Half Full interrupt
  463. * @arg SDIO_IT_TXFIFOF: Transmit FIFO full interrupt
  464. * @arg SDIO_IT_RXFIFOF: Receive FIFO full interrupt
  465. * @arg SDIO_IT_TXFIFOE: Transmit FIFO empty interrupt
  466. * @arg SDIO_IT_RXFIFOE: Receive FIFO empty interrupt
  467. * @arg SDIO_IT_TXDAVL: Data available in transmit FIFO interrupt
  468. * @arg SDIO_IT_RXDAVL: Data available in receive FIFO interrupt
  469. * @arg SDIO_IT_SDIOIT: SD I/O interrupt received interrupt
  470. * @retval The new state of MMC IT (SET or RESET).
  471. */
  472. #define __HAL_MMC_GET_IT(__HANDLE__, __INTERRUPT__) __SDIO_GET_IT((__HANDLE__)->Instance, (__INTERRUPT__))
  473. /**
  474. * @brief Clear the MMC's interrupt pending bits.
  475. * @param __HANDLE__ MMC Handle
  476. * @param __INTERRUPT__ specifies the interrupt pending bit to clear.
  477. * This parameter can be one or a combination of the following values:
  478. * @arg SDIO_IT_CCRCFAIL: Command response received (CRC check failed) interrupt
  479. * @arg SDIO_IT_DCRCFAIL: Data block sent/received (CRC check failed) interrupt
  480. * @arg SDIO_IT_CTIMEOUT: Command response timeout interrupt
  481. * @arg SDIO_IT_DTIMEOUT: Data timeout interrupt
  482. * @arg SDIO_IT_TXUNDERR: Transmit FIFO underrun error interrupt
  483. * @arg SDIO_IT_RXOVERR: Received FIFO overrun error interrupt
  484. * @arg SDIO_IT_CMDREND: Command response received (CRC check passed) interrupt
  485. * @arg SDIO_IT_CMDSENT: Command sent (no response required) interrupt
  486. * @arg SDIO_IT_DATAEND: Data end (data counter, SDMMC_DCOUNT, is zero) interrupt
  487. * @arg SDIO_IT_SDIOIT: SD I/O interrupt received interrupt
  488. * @retval None
  489. */
  490. #define __HAL_MMC_CLEAR_IT(__HANDLE__, __INTERRUPT__) __SDIO_CLEAR_IT((__HANDLE__)->Instance, (__INTERRUPT__))
  491. /**
  492. * @}
  493. */
  494. /* Exported functions --------------------------------------------------------*/
  495. /** @defgroup MMC_Exported_Functions MMC Exported Functions
  496. * @{
  497. */
  498. /** @defgroup MMC_Exported_Functions_Group1 Initialization and de-initialization functions
  499. * @{
  500. */
  501. HAL_StatusTypeDef HAL_MMC_Init(MMC_HandleTypeDef *hmmc);
  502. HAL_StatusTypeDef HAL_MMC_InitCard(MMC_HandleTypeDef *hmmc);
  503. HAL_StatusTypeDef HAL_MMC_DeInit (MMC_HandleTypeDef *hmmc);
  504. void HAL_MMC_MspInit(MMC_HandleTypeDef *hmmc);
  505. void HAL_MMC_MspDeInit(MMC_HandleTypeDef *hmmc);
  506. /**
  507. * @}
  508. */
  509. /** @defgroup MMC_Exported_Functions_Group2 Input and Output operation functions
  510. * @{
  511. */
  512. /* Blocking mode: Polling */
  513. HAL_StatusTypeDef HAL_MMC_ReadBlocks(MMC_HandleTypeDef *hmmc, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks, uint32_t Timeout);
  514. HAL_StatusTypeDef HAL_MMC_WriteBlocks(MMC_HandleTypeDef *hmmc, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks, uint32_t Timeout);
  515. HAL_StatusTypeDef HAL_MMC_Erase(MMC_HandleTypeDef *hmmc, uint32_t BlockStartAdd, uint32_t BlockEndAdd);
  516. /* Non-Blocking mode: IT */
  517. HAL_StatusTypeDef HAL_MMC_ReadBlocks_IT(MMC_HandleTypeDef *hmmc, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks);
  518. HAL_StatusTypeDef HAL_MMC_WriteBlocks_IT(MMC_HandleTypeDef *hmmc, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks);
  519. /* Non-Blocking mode: DMA */
  520. HAL_StatusTypeDef HAL_MMC_ReadBlocks_DMA(MMC_HandleTypeDef *hmmc, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks);
  521. HAL_StatusTypeDef HAL_MMC_WriteBlocks_DMA(MMC_HandleTypeDef *hmmc, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks);
  522. void HAL_MMC_IRQHandler(MMC_HandleTypeDef *hmmc);
  523. /* Callback in non blocking modes (DMA) */
  524. void HAL_MMC_TxCpltCallback(MMC_HandleTypeDef *hmmc);
  525. void HAL_MMC_RxCpltCallback(MMC_HandleTypeDef *hmmc);
  526. void HAL_MMC_ErrorCallback(MMC_HandleTypeDef *hmmc);
  527. void HAL_MMC_AbortCallback(MMC_HandleTypeDef *hmmc);
  528. /**
  529. * @}
  530. */
  531. /** @defgroup MMC_Exported_Functions_Group3 Peripheral Control functions
  532. * @{
  533. */
  534. HAL_StatusTypeDef HAL_MMC_ConfigWideBusOperation(MMC_HandleTypeDef *hmmc, uint32_t WideMode);
  535. /**
  536. * @}
  537. */
  538. /** @defgroup MMC_Exported_Functions_Group4 MMC card related functions
  539. * @{
  540. */
  541. HAL_MMC_CardStateTypeDef HAL_MMC_GetCardState(MMC_HandleTypeDef *hmmc);
  542. HAL_StatusTypeDef HAL_MMC_GetCardCID(MMC_HandleTypeDef *hmmc, HAL_MMC_CardCIDTypeDef *pCID);
  543. HAL_StatusTypeDef HAL_MMC_GetCardCSD(MMC_HandleTypeDef *hmmc, HAL_MMC_CardCSDTypeDef *pCSD);
  544. HAL_StatusTypeDef HAL_MMC_GetCardInfo(MMC_HandleTypeDef *hmmc, HAL_MMC_CardInfoTypeDef *pCardInfo);
  545. /**
  546. * @}
  547. */
  548. /** @defgroup MMC_Exported_Functions_Group5 Peripheral State and Errors functions
  549. * @{
  550. */
  551. HAL_MMC_StateTypeDef HAL_MMC_GetState(MMC_HandleTypeDef *hmmc);
  552. uint32_t HAL_MMC_GetError(MMC_HandleTypeDef *hmmc);
  553. /**
  554. * @}
  555. */
  556. /** @defgroup MMC_Exported_Functions_Group6 Perioheral Abort management
  557. * @{
  558. */
  559. HAL_StatusTypeDef HAL_MMC_Abort(MMC_HandleTypeDef *hmmc);
  560. HAL_StatusTypeDef HAL_MMC_Abort_IT(MMC_HandleTypeDef *hmmc);
  561. /**
  562. * @}
  563. */
  564. /* Private types -------------------------------------------------------------*/
  565. /** @defgroup MMC_Private_Types MMC Private Types
  566. * @{
  567. */
  568. /**
  569. * @}
  570. */
  571. /* Private defines -----------------------------------------------------------*/
  572. /** @defgroup MMC_Private_Defines MMC Private Defines
  573. * @{
  574. */
  575. /**
  576. * @}
  577. */
  578. /* Private variables ---------------------------------------------------------*/
  579. /** @defgroup MMC_Private_Variables MMC Private Variables
  580. * @{
  581. */
  582. /**
  583. * @}
  584. */
  585. /* Private constants ---------------------------------------------------------*/
  586. /** @defgroup MMC_Private_Constants MMC Private Constants
  587. * @{
  588. */
  589. /**
  590. * @}
  591. */
  592. /* Private macros ------------------------------------------------------------*/
  593. /** @defgroup MMC_Private_Macros MMC Private Macros
  594. * @{
  595. */
  596. /**
  597. * @}
  598. */
  599. /* Private functions prototypes ----------------------------------------------*/
  600. /** @defgroup MMC_Private_Functions_Prototypes MMC Private Functions Prototypes
  601. * @{
  602. */
  603. /**
  604. * @}
  605. */
  606. /* Private functions ---------------------------------------------------------*/
  607. /** @defgroup MMC_Private_Functions MMC Private Functions
  608. * @{
  609. */
  610. /**
  611. * @}
  612. */
  613. /**
  614. * @}
  615. */
  616. /**
  617. * @}
  618. */
  619. /**
  620. * @}
  621. */
  622. #endif /* STM32F405xx || STM32F415xx || STM32F407xx || STM32F417xx || STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx ||
  623. STM32F401xC || STM32F401xE || STM32F411xE || STM32F446xx || STM32F469xx || STM32F479xx || STM32F412Zx || STM32F412Vx ||
  624. STM32F412Rx || STM32F412Cx || STM32F413xx || STM32F423xx */
  625. #ifdef __cplusplus
  626. }
  627. #endif
  628. #endif /* __STM32F4xx_HAL_MMC_H */
  629. /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/