stm32f1xx_hal_mmc.h 35 KB

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