stm32h7xx_hal_mmc.h 37 KB

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