stm32f7xx_hal_mmc.h 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695
  1. /**
  2. ******************************************************************************
  3. * @file stm32f7xx_hal_mmc.h
  4. * @author MCD Application Team
  5. * @version V1.2.0
  6. * @date 30-December-2016
  7. * @brief Header file of MMC HAL module.
  8. ******************************************************************************
  9. * @attention
  10. *
  11. * <h2><center>&copy; COPYRIGHT(c) 2016 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 __STM32F7xx_HAL_MMC_H
  39. #define __STM32F7xx_HAL_MMC_H
  40. #ifdef __cplusplus
  41. extern "C" {
  42. #endif
  43. /* Includes ------------------------------------------------------------------*/
  44. #include "stm32f7xx_ll_sdmmc.h"
  45. /** @addtogroup STM32F7xx_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. DMA_HandleTypeDef *hdmarx; /*!< MMC Rx DMA handle parameters */
  124. DMA_HandleTypeDef *hdmatx; /*!< MMC Tx DMA handle parameters */
  125. HAL_MMC_CardInfoTypeDef MmcCard; /*!< MMC Card information */
  126. uint32_t CSD[4]; /*!< MMC card specific data table */
  127. uint32_t CID[4]; /*!< MMC card identification number table */
  128. }MMC_HandleTypeDef;
  129. /**
  130. * @}
  131. */
  132. /** @defgroup MMC_Exported_Types_Group4 Card Specific Data: CSD Register
  133. * @{
  134. */
  135. typedef struct
  136. {
  137. __IO uint8_t CSDStruct; /*!< CSD structure */
  138. __IO uint8_t SysSpecVersion; /*!< System specification version */
  139. __IO uint8_t Reserved1; /*!< Reserved */
  140. __IO uint8_t TAAC; /*!< Data read access time 1 */
  141. __IO uint8_t NSAC; /*!< Data read access time 2 in CLK cycles */
  142. __IO uint8_t MaxBusClkFrec; /*!< Max. bus clock frequency */
  143. __IO uint16_t CardComdClasses; /*!< Card command classes */
  144. __IO uint8_t RdBlockLen; /*!< Max. read data block length */
  145. __IO uint8_t PartBlockRead; /*!< Partial blocks for read allowed */
  146. __IO uint8_t WrBlockMisalign; /*!< Write block misalignment */
  147. __IO uint8_t RdBlockMisalign; /*!< Read block misalignment */
  148. __IO uint8_t DSRImpl; /*!< DSR implemented */
  149. __IO uint8_t Reserved2; /*!< Reserved */
  150. __IO uint32_t DeviceSize; /*!< Device Size */
  151. __IO uint8_t MaxRdCurrentVDDMin; /*!< Max. read current @ VDD min */
  152. __IO uint8_t MaxRdCurrentVDDMax; /*!< Max. read current @ VDD max */
  153. __IO uint8_t MaxWrCurrentVDDMin; /*!< Max. write current @ VDD min */
  154. __IO uint8_t MaxWrCurrentVDDMax; /*!< Max. write current @ VDD max */
  155. __IO uint8_t DeviceSizeMul; /*!< Device size multiplier */
  156. __IO uint8_t EraseGrSize; /*!< Erase group size */
  157. __IO uint8_t EraseGrMul; /*!< Erase group size multiplier */
  158. __IO uint8_t WrProtectGrSize; /*!< Write protect group size */
  159. __IO uint8_t WrProtectGrEnable; /*!< Write protect group enable */
  160. __IO uint8_t ManDeflECC; /*!< Manufacturer default ECC */
  161. __IO uint8_t WrSpeedFact; /*!< Write speed factor */
  162. __IO uint8_t MaxWrBlockLen; /*!< Max. write data block length */
  163. __IO uint8_t WriteBlockPaPartial; /*!< Partial blocks for write allowed */
  164. __IO uint8_t Reserved3; /*!< Reserved */
  165. __IO uint8_t ContentProtectAppli; /*!< Content protection application */
  166. __IO uint8_t FileFormatGrouop; /*!< File format group */
  167. __IO uint8_t CopyFlag; /*!< Copy flag (OTP) */
  168. __IO uint8_t PermWrProtect; /*!< Permanent write protection */
  169. __IO uint8_t TempWrProtect; /*!< Temporary write protection */
  170. __IO uint8_t FileFormat; /*!< File format */
  171. __IO uint8_t ECC; /*!< ECC code */
  172. __IO uint8_t CSD_CRC; /*!< CSD CRC */
  173. __IO uint8_t Reserved4; /*!< Always 1 */
  174. }HAL_MMC_CardCSDTypeDef;
  175. /**
  176. * @}
  177. */
  178. /** @defgroup MMC_Exported_Types_Group5 Card Identification Data: CID Register
  179. * @{
  180. */
  181. typedef struct
  182. {
  183. __IO uint8_t ManufacturerID; /*!< Manufacturer ID */
  184. __IO uint16_t OEM_AppliID; /*!< OEM/Application ID */
  185. __IO uint32_t ProdName1; /*!< Product Name part1 */
  186. __IO uint8_t ProdName2; /*!< Product Name part2 */
  187. __IO uint8_t ProdRev; /*!< Product Revision */
  188. __IO uint32_t ProdSN; /*!< Product Serial Number */
  189. __IO uint8_t Reserved1; /*!< Reserved1 */
  190. __IO uint16_t ManufactDate; /*!< Manufacturing Date */
  191. __IO uint8_t CID_CRC; /*!< CID CRC */
  192. __IO uint8_t Reserved2; /*!< Always 1 */
  193. }HAL_MMC_CardCIDTypeDef;
  194. /**
  195. * @}
  196. */
  197. /**
  198. * @}
  199. */
  200. /* Exported constants --------------------------------------------------------*/
  201. /** @defgroup MMC_Exported_Constants Exported Constants
  202. * @{
  203. */
  204. #define BLOCKSIZE ((uint32_t)512U) /*!< Block size is 512 bytes */
  205. #define CAPACITY ((uint32_t)0x80000000U) /*!< 2 G bytes constant */
  206. /** @defgroup MMC_Exported_Constansts_Group1 MMC Error status enumeration Structure definition
  207. * @{
  208. */
  209. #define HAL_MMC_ERROR_NONE SDMMC_ERROR_NONE /*!< No error */
  210. #define HAL_MMC_ERROR_CMD_CRC_FAIL SDMMC_ERROR_CMD_CRC_FAIL /*!< Command response received (but CRC check failed) */
  211. #define HAL_MMC_ERROR_DATA_CRC_FAIL SDMMC_ERROR_DATA_CRC_FAIL /*!< Data block sent/received (CRC check failed) */
  212. #define HAL_MMC_ERROR_CMD_RSP_TIMEOUT SDMMC_ERROR_CMD_RSP_TIMEOUT /*!< Command response timeout */
  213. #define HAL_MMC_ERROR_DATA_TIMEOUT SDMMC_ERROR_DATA_TIMEOUT /*!< Data timeout */
  214. #define HAL_MMC_ERROR_TX_UNDERRUN SDMMC_ERROR_TX_UNDERRUN /*!< Transmit FIFO underrun */
  215. #define HAL_MMC_ERROR_RX_OVERRUN SDMMC_ERROR_RX_OVERRUN /*!< Receive FIFO overrun */
  216. #define HAL_MMC_ERROR_ADDR_MISALIGNED SDMMC_ERROR_ADDR_MISALIGNED /*!< Misaligned address */
  217. #define HAL_MMC_ERROR_BLOCK_LEN_ERR SDMMC_ERROR_BLOCK_LEN_ERR /*!< Transferred block length is not allowed for the card or the
  218. number of transferred bytes does not match the block length */
  219. #define HAL_MMC_ERROR_ERASE_SEQ_ERR SDMMC_ERROR_ERASE_SEQ_ERR /*!< An error in the sequence of erase command occurs */
  220. #define HAL_MMC_ERROR_BAD_ERASE_PARAM SDMMC_ERROR_BAD_ERASE_PARAM /*!< An invalid selection for erase groups */
  221. #define HAL_MMC_ERROR_WRITE_PROT_VIOLATION SDMMC_ERROR_WRITE_PROT_VIOLATION /*!< Attempt to program a write protect block */
  222. #define HAL_MMC_ERROR_LOCK_UNLOCK_FAILED SDMMC_ERROR_LOCK_UNLOCK_FAILED /*!< Sequence or password error has been detected in unlock
  223. command or if there was an attempt to access a locked card */
  224. #define HAL_MMC_ERROR_COM_CRC_FAILED SDMMC_ERROR_COM_CRC_FAILED /*!< CRC check of the previous command failed */
  225. #define HAL_MMC_ERROR_ILLEGAL_CMD SDMMC_ERROR_ILLEGAL_CMD /*!< Command is not legal for the card state */
  226. #define HAL_MMC_ERROR_CARD_ECC_FAILED SDMMC_ERROR_CARD_ECC_FAILED /*!< Card internal ECC was applied but failed to correct the data */
  227. #define HAL_MMC_ERROR_CC_ERR SDMMC_ERROR_CC_ERR /*!< Internal card controller error */
  228. #define HAL_MMC_ERROR_GENERAL_UNKNOWN_ERR SDMMC_ERROR_GENERAL_UNKNOWN_ERR /*!< General or unknown error */
  229. #define HAL_MMC_ERROR_STREAM_READ_UNDERRUN SDMMC_ERROR_STREAM_READ_UNDERRUN /*!< The card could not sustain data reading in stream rmode */
  230. #define HAL_MMC_ERROR_STREAM_WRITE_OVERRUN SDMMC_ERROR_STREAM_WRITE_OVERRUN /*!< The card could not sustain data programming in stream mode */
  231. #define HAL_MMC_ERROR_CID_CSD_OVERWRITE SDMMC_ERROR_CID_CSD_OVERWRITE /*!< CID/CSD overwrite error */
  232. #define HAL_MMC_ERROR_WP_ERASE_SKIP SDMMC_ERROR_WP_ERASE_SKIP /*!< Only partial address space was erased */
  233. #define HAL_MMC_ERROR_CARD_ECC_DISABLED SDMMC_ERROR_CARD_ECC_DISABLED /*!< Command has been executed without using internal ECC */
  234. #define HAL_MMC_ERROR_ERASE_RESET SDMMC_ERROR_ERASE_RESET /*!< Erase sequence was cleared before executing because an out
  235. of erase sequence command was received */
  236. #define HAL_MMC_ERROR_AKE_SEQ_ERR SDMMC_ERROR_AKE_SEQ_ERR /*!< Error in sequence of authentication */
  237. #define HAL_MMC_ERROR_INVALID_VOLTRANGE SDMMC_ERROR_INVALID_VOLTRANGE /*!< Error in case of invalid voltage range */
  238. #define HAL_MMC_ERROR_ADDR_OUT_OF_RANGE SDMMC_ERROR_ADDR_OUT_OF_RANGE /*!< Error when addressed block is out of range */
  239. #define HAL_MMC_ERROR_REQUEST_NOT_APPLICABLE SDMMC_ERROR_REQUEST_NOT_APPLICABLE /*!< Error when command request is not applicable */
  240. #define HAL_MMC_ERROR_PARAM SDMMC_ERROR_INVALID_PARAMETER /*!< the used parameter is not valid */
  241. #define HAL_MMC_ERROR_UNSUPPORTED_FEATURE SDMMC_ERROR_UNSUPPORTED_FEATURE /*!< Error when feature is not insupported */
  242. #define HAL_MMC_ERROR_BUSY SDMMC_ERROR_BUSY /*!< Error when transfer process is busy */
  243. #define HAL_MMC_ERROR_DMA SDMMC_ERROR_DMA /*!< Error while DMA transfer */
  244. #define HAL_MMC_ERROR_TIMEOUT SDMMC_ERROR_TIMEOUT /*!< Timeout error */
  245. /**
  246. * @}
  247. */
  248. /** @defgroup MMC_Exported_Constansts_Group2 MMC context enumeration
  249. * @{
  250. */
  251. #define MMC_CONTEXT_NONE ((uint32_t)0x00000000U) /*!< None */
  252. #define MMC_CONTEXT_READ_SINGLE_BLOCK ((uint32_t)0x00000001U) /*!< Read single block operation */
  253. #define MMC_CONTEXT_READ_MULTIPLE_BLOCK ((uint32_t)0x00000002U) /*!< Read multiple blocks operation */
  254. #define MMC_CONTEXT_WRITE_SINGLE_BLOCK ((uint32_t)0x00000010U) /*!< Write single block operation */
  255. #define MMC_CONTEXT_WRITE_MULTIPLE_BLOCK ((uint32_t)0x00000020U) /*!< Write multiple blocks operation */
  256. #define MMC_CONTEXT_IT ((uint32_t)0x00000008U) /*!< Process in Interrupt mode */
  257. #define MMC_CONTEXT_DMA ((uint32_t)0x00000080U) /*!< Process in DMA mode */
  258. /**
  259. * @}
  260. */
  261. /** @defgroup MMC_Exported_Constansts_Group3 MMC Voltage mode
  262. * @{
  263. */
  264. /**
  265. * @brief
  266. */
  267. #define MMC_HIGH_VOLTAGE_RANGE 0x80FF8000U /*!< VALUE OF ARGUMENT */
  268. #define MMC_DUAL_VOLTAGE_RANGE 0x80FF8080U /*!< VALUE OF ARGUMENT */
  269. #define eMMC_HIGH_VOLTAGE_RANGE 0xC0FF8000U /*!< for eMMC > 2Gb sector mode */
  270. #define eMMC_DUAL_VOLTAGE_RANGE 0xC0FF8080U /*!< for eMMC > 2Gb sector mode */
  271. #define MMC_INVALID_VOLTAGE_RANGE 0x0001FF01U
  272. /**
  273. * @}
  274. */
  275. /** @defgroup MMC_Exported_Constansts_Group4 MMC Memory Cards
  276. * @{
  277. */
  278. #define MMC_HIGH_VOLTAGE_CARD ((uint32_t)0x00000000U)
  279. #define MMC_DUAL_VOLTAGE_CARD ((uint32_t)0x00000001U)
  280. /**
  281. * @}
  282. */
  283. /**
  284. * @}
  285. */
  286. /* Exported macro ------------------------------------------------------------*/
  287. /** @defgroup MMC_Exported_macros MMC Exported Macros
  288. * @brief macros to handle interrupts and specific clock configurations
  289. * @{
  290. */
  291. /**
  292. * @brief Enable the MMC device.
  293. * @retval None
  294. */
  295. #define __HAL_MMC_ENABLE(__HANDLE__) __SDMMC_ENABLE((__HANDLE__)->Instance)
  296. /**
  297. * @brief Disable the MMC device.
  298. * @retval None
  299. */
  300. #define __HAL_MMC_DISABLE(__HANDLE__) __SDMMC_DISABLE((__HANDLE__)->Instance)
  301. /**
  302. * @brief Enable the SDMMC DMA transfer.
  303. * @retval None
  304. */
  305. #define __HAL_MMC_DMA_ENABLE(__HANDLE__) __SDMMC_DMA_ENABLE((__HANDLE__)->Instance)
  306. /**
  307. * @brief Disable the SDMMC DMA transfer.
  308. * @retval None
  309. */
  310. #define __HAL_MMC_DMA_DISABLE(__HANDLE__) __SDMMC_DMA_DISABLE((__HANDLE__)->Instance)
  311. /**
  312. * @brief Enable the MMC device interrupt.
  313. * @param __HANDLE__: MMC Handle
  314. * @param __INTERRUPT__: specifies the SDMMC interrupt sources to be enabled.
  315. * This parameter can be one or a combination of the following values:
  316. * @arg SDMMC_IT_CCRCFAIL: Command response received (CRC check failed) interrupt
  317. * @arg SDMMC_IT_DCRCFAIL: Data block sent/received (CRC check failed) interrupt
  318. * @arg SDMMC_IT_CTIMEOUT: Command response timeout interrupt
  319. * @arg SDMMC_IT_DTIMEOUT: Data timeout interrupt
  320. * @arg SDMMC_IT_TXUNDERR: Transmit FIFO underrun error interrupt
  321. * @arg SDMMC_IT_RXOVERR: Received FIFO overrun error interrupt
  322. * @arg SDMMC_IT_CMDREND: Command response received (CRC check passed) interrupt
  323. * @arg SDMMC_IT_CMDSENT: Command sent (no response required) interrupt
  324. * @arg SDMMC_IT_DATAEND: Data end (data counter, SDIDCOUNT, is zero) interrupt
  325. * @arg SDMMC_IT_DBCKEND: Data block sent/received (CRC check passed) interrupt
  326. * @arg SDMMC_IT_CMDACT: Command transfer in progress interrupt
  327. * @arg SDMMC_IT_TXACT: Data transmit in progress interrupt
  328. * @arg SDMMC_IT_RXACT: Data receive in progress interrupt
  329. * @arg SDMMC_IT_TXFIFOHE: Transmit FIFO Half Empty interrupt
  330. * @arg SDMMC_IT_RXFIFOHF: Receive FIFO Half Full interrupt
  331. * @arg SDMMC_IT_TXFIFOF: Transmit FIFO full interrupt
  332. * @arg SDMMC_IT_RXFIFOF: Receive FIFO full interrupt
  333. * @arg SDMMC_IT_TXFIFOE: Transmit FIFO empty interrupt
  334. * @arg SDMMC_IT_RXFIFOE: Receive FIFO empty interrupt
  335. * @arg SDMMC_IT_TXDAVL: Data available in transmit FIFO interrupt
  336. * @arg SDMMC_IT_RXDAVL: Data available in receive FIFO interrupt
  337. * @arg SDMMC_IT_SDIOIT: SD I/O interrupt received interrupt
  338. * @retval None
  339. */
  340. #define __HAL_MMC_ENABLE_IT(__HANDLE__, __INTERRUPT__) __SDMMC_ENABLE_IT((__HANDLE__)->Instance, (__INTERRUPT__))
  341. /**
  342. * @brief Disable the MMC device interrupt.
  343. * @param __HANDLE__: MMC Handle
  344. * @param __INTERRUPT__: specifies the SDMMC interrupt sources to be disabled.
  345. * This parameter can be one or a combination of the following values:
  346. * @arg SDMMC_IT_CCRCFAIL: Command response received (CRC check failed) interrupt
  347. * @arg SDMMC_IT_DCRCFAIL: Data block sent/received (CRC check failed) interrupt
  348. * @arg SDMMC_IT_CTIMEOUT: Command response timeout interrupt
  349. * @arg SDMMC_IT_DTIMEOUT: Data timeout interrupt
  350. * @arg SDMMC_IT_TXUNDERR: Transmit FIFO underrun error interrupt
  351. * @arg SDMMC_IT_RXOVERR: Received FIFO overrun error interrupt
  352. * @arg SDMMC_IT_CMDREND: Command response received (CRC check passed) interrupt
  353. * @arg SDMMC_IT_CMDSENT: Command sent (no response required) interrupt
  354. * @arg SDMMC_IT_DATAEND: Data end (data counter, SDIDCOUNT, is zero) interrupt
  355. * @arg SDMMC_IT_DBCKEND: Data block sent/received (CRC check passed) interrupt
  356. * @arg SDMMC_IT_CMDACT: Command transfer in progress interrupt
  357. * @arg SDMMC_IT_TXACT: Data transmit in progress interrupt
  358. * @arg SDMMC_IT_RXACT: Data receive in progress interrupt
  359. * @arg SDMMC_IT_TXFIFOHE: Transmit FIFO Half Empty interrupt
  360. * @arg SDMMC_IT_RXFIFOHF: Receive FIFO Half Full interrupt
  361. * @arg SDMMC_IT_TXFIFOF: Transmit FIFO full interrupt
  362. * @arg SDMMC_IT_RXFIFOF: Receive FIFO full interrupt
  363. * @arg SDMMC_IT_TXFIFOE: Transmit FIFO empty interrupt
  364. * @arg SDMMC_IT_RXFIFOE: Receive FIFO empty interrupt
  365. * @arg SDMMC_IT_TXDAVL: Data available in transmit FIFO interrupt
  366. * @arg SDMMC_IT_RXDAVL: Data available in receive FIFO interrupt
  367. * @arg SDMMC_IT_SDIOIT: SD I/O interrupt received interrupt
  368. * @retval None
  369. */
  370. #define __HAL_MMC_DISABLE_IT(__HANDLE__, __INTERRUPT__) __SDMMC_DISABLE_IT((__HANDLE__)->Instance, (__INTERRUPT__))
  371. /**
  372. * @brief Check whether the specified MMC flag is set or not.
  373. * @param __HANDLE__: MMC Handle
  374. * @param __FLAG__: specifies the flag to check.
  375. * This parameter can be one of the following values:
  376. * @arg SDMMC_FLAG_CCRCFAIL: Command response received (CRC check failed)
  377. * @arg SDMMC_FLAG_DCRCFAIL: Data block sent/received (CRC check failed)
  378. * @arg SDMMC_FLAG_CTIMEOUT: Command response timeout
  379. * @arg SDMMC_FLAG_DTIMEOUT: Data timeout
  380. * @arg SDMMC_FLAG_TXUNDERR: Transmit FIFO underrun error
  381. * @arg SDMMC_FLAG_RXOVERR: Received FIFO overrun error
  382. * @arg SDMMC_FLAG_CMDREND: Command response received (CRC check passed)
  383. * @arg SDMMC_FLAG_CMDSENT: Command sent (no response required)
  384. * @arg SDMMC_FLAG_DATAEND: Data end (data counter, SDIDCOUNT, is zero)
  385. * @arg SDMMC_FLAG_DBCKEND: Data block sent/received (CRC check passed)
  386. * @arg SDMMC_FLAG_CMDACT: Command transfer in progress
  387. * @arg SDMMC_FLAG_TXACT: Data transmit in progress
  388. * @arg SDMMC_FLAG_RXACT: Data receive in progress
  389. * @arg SDMMC_FLAG_TXFIFOHE: Transmit FIFO Half Empty
  390. * @arg SDMMC_FLAG_RXFIFOHF: Receive FIFO Half Full
  391. * @arg SDMMC_FLAG_TXFIFOF: Transmit FIFO full
  392. * @arg SDMMC_FLAG_RXFIFOF: Receive FIFO full
  393. * @arg SDMMC_FLAG_TXFIFOE: Transmit FIFO empty
  394. * @arg SDMMC_FLAG_RXFIFOE: Receive FIFO empty
  395. * @arg SDMMC_FLAG_TXDAVL: Data available in transmit FIFO
  396. * @arg SDMMC_FLAG_RXDAVL: Data available in receive FIFO
  397. * @arg SDMMC_FLAG_SDIOIT: SD I/O interrupt received
  398. * @retval The new state of MMC FLAG (SET or RESET).
  399. */
  400. #define __HAL_MMC_GET_FLAG(__HANDLE__, __FLAG__) __SDMMC_GET_FLAG((__HANDLE__)->Instance, (__FLAG__))
  401. /**
  402. * @brief Clear the MMC's pending flags.
  403. * @param __HANDLE__: MMC Handle
  404. * @param __FLAG__: specifies the flag to clear.
  405. * This parameter can be one or a combination of the following values:
  406. * @arg SDMMC_FLAG_CCRCFAIL: Command response received (CRC check failed)
  407. * @arg SDMMC_FLAG_DCRCFAIL: Data block sent/received (CRC check failed)
  408. * @arg SDMMC_FLAG_CTIMEOUT: Command response timeout
  409. * @arg SDMMC_FLAG_DTIMEOUT: Data timeout
  410. * @arg SDMMC_FLAG_TXUNDERR: Transmit FIFO underrun error
  411. * @arg SDMMC_FLAG_RXOVERR: Received FIFO overrun error
  412. * @arg SDMMC_FLAG_CMDREND: Command response received (CRC check passed)
  413. * @arg SDMMC_FLAG_CMDSENT: Command sent (no response required)
  414. * @arg SDMMC_FLAG_DATAEND: Data end (data counter, SDIDCOUNT, is zero)
  415. * @arg SDMMC_FLAG_DBCKEND: Data block sent/received (CRC check passed)
  416. * @arg SDMMC_FLAG_SDIOIT: SD I/O interrupt received
  417. * @retval None
  418. */
  419. #define __HAL_MMC_CLEAR_FLAG(__HANDLE__, __FLAG__) __SDMMC_CLEAR_FLAG((__HANDLE__)->Instance, (__FLAG__))
  420. /**
  421. * @brief Check whether the specified MMC interrupt has occurred or not.
  422. * @param __HANDLE__: MMC Handle
  423. * @param __INTERRUPT__: specifies the SDMMC interrupt source to check.
  424. * This parameter can be one of the following values:
  425. * @arg SDMMC_IT_CCRCFAIL: Command response received (CRC check failed) interrupt
  426. * @arg SDMMC_IT_DCRCFAIL: Data block sent/received (CRC check failed) interrupt
  427. * @arg SDMMC_IT_CTIMEOUT: Command response timeout interrupt
  428. * @arg SDMMC_IT_DTIMEOUT: Data timeout interrupt
  429. * @arg SDMMC_IT_TXUNDERR: Transmit FIFO underrun error interrupt
  430. * @arg SDMMC_IT_RXOVERR: Received FIFO overrun error interrupt
  431. * @arg SDMMC_IT_CMDREND: Command response received (CRC check passed) interrupt
  432. * @arg SDMMC_IT_CMDSENT: Command sent (no response required) interrupt
  433. * @arg SDMMC_IT_DATAEND: Data end (data counter, SDIDCOUNT, is zero) interrupt
  434. * @arg SDMMC_IT_DBCKEND: Data block sent/received (CRC check passed) interrupt
  435. * @arg SDMMC_IT_CMDACT: Command transfer in progress interrupt
  436. * @arg SDMMC_IT_TXACT: Data transmit in progress interrupt
  437. * @arg SDMMC_IT_RXACT: Data receive in progress interrupt
  438. * @arg SDMMC_IT_TXFIFOHE: Transmit FIFO Half Empty interrupt
  439. * @arg SDMMC_IT_RXFIFOHF: Receive FIFO Half Full interrupt
  440. * @arg SDMMC_IT_TXFIFOF: Transmit FIFO full interrupt
  441. * @arg SDMMC_IT_RXFIFOF: Receive FIFO full interrupt
  442. * @arg SDMMC_IT_TXFIFOE: Transmit FIFO empty interrupt
  443. * @arg SDMMC_IT_RXFIFOE: Receive FIFO empty interrupt
  444. * @arg SDMMC_IT_TXDAVL: Data available in transmit FIFO interrupt
  445. * @arg SDMMC_IT_RXDAVL: Data available in receive FIFO interrupt
  446. * @arg SDMMC_IT_SDIOIT: SD I/O interrupt received interrupt
  447. * @retval The new state of SD IT (SET or RESET).
  448. */
  449. #define __HAL_MMC_GET_IT(__HANDLE__, __INTERRUPT__) __SDMMC_GET_IT((__HANDLE__)->Instance, (__INTERRUPT__))
  450. /**
  451. * @brief Clear the MMC's interrupt pending bits.
  452. * @param __HANDLE__: MMC Handle
  453. * @param __INTERRUPT__: specifies the interrupt pending bit to clear.
  454. * This parameter can be one or a combination of the following values:
  455. * @arg SDMMC_IT_CCRCFAIL: Command response received (CRC check failed) interrupt
  456. * @arg SDMMC_IT_DCRCFAIL: Data block sent/received (CRC check failed) interrupt
  457. * @arg SDMMC_IT_CTIMEOUT: Command response timeout interrupt
  458. * @arg SDMMC_IT_DTIMEOUT: Data timeout interrupt
  459. * @arg SDMMC_IT_TXUNDERR: Transmit FIFO underrun error interrupt
  460. * @arg SDMMC_IT_RXOVERR: Received FIFO overrun error interrupt
  461. * @arg SDMMC_IT_CMDREND: Command response received (CRC check passed) interrupt
  462. * @arg SDMMC_IT_CMDSENT: Command sent (no response required) interrupt
  463. * @arg SDMMC_IT_DATAEND: Data end (data counter, SDMMC_DCOUNT, is zero) interrupt
  464. * @arg SDMMC_IT_SDIOIT: SD I/O interrupt received interrupt
  465. * @retval None
  466. */
  467. #define __HAL_MMC_CLEAR_IT(__HANDLE__, __INTERRUPT__) __SDMMC_CLEAR_IT((__HANDLE__)->Instance, (__INTERRUPT__))
  468. /**
  469. * @}
  470. */
  471. /* Exported functions --------------------------------------------------------*/
  472. /** @defgroup MMC_Exported_Functions MMC Exported Functions
  473. * @{
  474. */
  475. /** @defgroup MMC_Exported_Functions_Group1 Initialization and de-initialization functions
  476. * @{
  477. */
  478. HAL_StatusTypeDef HAL_MMC_Init(MMC_HandleTypeDef *hmmc);
  479. HAL_StatusTypeDef HAL_MMC_InitCard(MMC_HandleTypeDef *hmmc);
  480. HAL_StatusTypeDef HAL_MMC_DeInit (MMC_HandleTypeDef *hmmc);
  481. void HAL_MMC_MspInit(MMC_HandleTypeDef *hmmc);
  482. void HAL_MMC_MspDeInit(MMC_HandleTypeDef *hmmc);
  483. /**
  484. * @}
  485. */
  486. /** @defgroup MMC_Exported_Functions_Group2 Input and Output operation functions
  487. * @{
  488. */
  489. /* Blocking mode: Polling */
  490. HAL_StatusTypeDef HAL_MMC_ReadBlocks(MMC_HandleTypeDef *hmmc, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks, uint32_t Timeout);
  491. HAL_StatusTypeDef HAL_MMC_WriteBlocks(MMC_HandleTypeDef *hmmc, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks, uint32_t Timeout);
  492. HAL_StatusTypeDef HAL_MMC_Erase(MMC_HandleTypeDef *hmmc, uint32_t BlockStartAdd, uint32_t BlockEndAdd);
  493. /* Non-Blocking mode: IT */
  494. HAL_StatusTypeDef HAL_MMC_ReadBlocks_IT(MMC_HandleTypeDef *hmmc, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks);
  495. HAL_StatusTypeDef HAL_MMC_WriteBlocks_IT(MMC_HandleTypeDef *hmmc, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks);
  496. /* Non-Blocking mode: DMA */
  497. HAL_StatusTypeDef HAL_MMC_ReadBlocks_DMA(MMC_HandleTypeDef *hmmc, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks);
  498. HAL_StatusTypeDef HAL_MMC_WriteBlocks_DMA(MMC_HandleTypeDef *hmmc, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks);
  499. void HAL_MMC_IRQHandler(MMC_HandleTypeDef *hmmc);
  500. /* Callback in non blocking modes (DMA) */
  501. void HAL_MMC_TxCpltCallback(MMC_HandleTypeDef *hmmc);
  502. void HAL_MMC_RxCpltCallback(MMC_HandleTypeDef *hmmc);
  503. void HAL_MMC_ErrorCallback(MMC_HandleTypeDef *hmmc);
  504. void HAL_MMC_AbortCallback(MMC_HandleTypeDef *hmmc);
  505. /**
  506. * @}
  507. */
  508. /** @defgroup MMC_Exported_Functions_Group3 Peripheral Control functions
  509. * @{
  510. */
  511. HAL_StatusTypeDef HAL_MMC_ConfigWideBusOperation(MMC_HandleTypeDef *hmmc, uint32_t WideMode);
  512. /**
  513. * @}
  514. */
  515. /** @defgroup MMC_Exported_Functions_Group4 MMC card related functions
  516. * @{
  517. */
  518. HAL_MMC_CardStateTypeDef HAL_MMC_GetCardState(MMC_HandleTypeDef *hmmc);
  519. HAL_StatusTypeDef HAL_MMC_GetCardCID(MMC_HandleTypeDef *hmmc, HAL_MMC_CardCIDTypeDef *pCID);
  520. HAL_StatusTypeDef HAL_MMC_GetCardCSD(MMC_HandleTypeDef *hmmc, HAL_MMC_CardCSDTypeDef *pCSD);
  521. HAL_StatusTypeDef HAL_MMC_GetCardInfo(MMC_HandleTypeDef *hmmc, HAL_MMC_CardInfoTypeDef *pCardInfo);
  522. /**
  523. * @}
  524. */
  525. /** @defgroup MMC_Exported_Functions_Group5 Peripheral State and Errors functions
  526. * @{
  527. */
  528. HAL_MMC_StateTypeDef HAL_MMC_GetState(MMC_HandleTypeDef *hmmc);
  529. uint32_t HAL_MMC_GetError(MMC_HandleTypeDef *hmmc);
  530. /**
  531. * @}
  532. */
  533. /** @defgroup MMC_Exported_Functions_Group6 Perioheral Abort management
  534. * @{
  535. */
  536. HAL_StatusTypeDef HAL_MMC_Abort(MMC_HandleTypeDef *hmmc);
  537. HAL_StatusTypeDef HAL_MMC_Abort_IT(MMC_HandleTypeDef *hmmc);
  538. /**
  539. * @}
  540. */
  541. /* Private types -------------------------------------------------------------*/
  542. /** @defgroup MMC_Private_Types MMC Private Types
  543. * @{
  544. */
  545. /**
  546. * @}
  547. */
  548. /* Private defines -----------------------------------------------------------*/
  549. /** @defgroup MMC_Private_Defines MMC Private Defines
  550. * @{
  551. */
  552. /**
  553. * @}
  554. */
  555. /* Private variables ---------------------------------------------------------*/
  556. /** @defgroup MMC_Private_Variables MMC Private Variables
  557. * @{
  558. */
  559. /**
  560. * @}
  561. */
  562. /* Private constants ---------------------------------------------------------*/
  563. /** @defgroup MMC_Private_Constants MMC Private Constants
  564. * @{
  565. */
  566. /**
  567. * @}
  568. */
  569. /* Private macros ------------------------------------------------------------*/
  570. /** @defgroup MMC_Private_Macros MMC Private Macros
  571. * @{
  572. */
  573. /**
  574. * @}
  575. */
  576. /* Private functions prototypes ----------------------------------------------*/
  577. /** @defgroup MMC_Private_Functions_Prototypes MMC Private Functions Prototypes
  578. * @{
  579. */
  580. /**
  581. * @}
  582. */
  583. /* Private functions ---------------------------------------------------------*/
  584. /** @defgroup MMC_Private_Functions MMC Private Functions
  585. * @{
  586. */
  587. /**
  588. * @}
  589. */
  590. /**
  591. * @}
  592. */
  593. /**
  594. * @}
  595. */
  596. /**
  597. * @}
  598. */
  599. #ifdef __cplusplus
  600. }
  601. #endif
  602. #endif /* __STM32F7xx_HAL_MMC_H */
  603. /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/