Nelze vybrat více než 25 témat Téma musí začínat písmenem nebo číslem, může obsahovat pomlčky („-“) a může být dlouhé až 35 znaků.
 
 

767 řádky
38 KiB

  1. /**
  2. ******************************************************************************
  3. * @file stm32f4xx_hal_mmc.h
  4. * @author MCD Application Team
  5. * @brief Header file of MMC HAL module.
  6. ******************************************************************************
  7. * @attention
  8. *
  9. * <h2><center>&copy; Copyright (c) 2017 STMicroelectronics.
  10. * All rights reserved.</center></h2>
  11. *
  12. * This software component is licensed by ST under BSD 3-Clause license,
  13. * the "License"; You may not use this file except in compliance with the
  14. * License. You may obtain a copy of the License at:
  15. * opensource.org/licenses/BSD-3-Clause
  16. *
  17. ******************************************************************************
  18. */
  19. /* Define to prevent recursive inclusion -------------------------------------*/
  20. #ifndef __STM32F4xx_HAL_MMC_H
  21. #define __STM32F4xx_HAL_MMC_H
  22. #ifdef __cplusplus
  23. extern "C" {
  24. #endif
  25. #if defined(STM32F405xx) || defined(STM32F415xx) || defined(STM32F407xx) || defined(STM32F417xx) || \
  26. defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx) || \
  27. defined(STM32F401xC) || defined(STM32F401xE) || defined(STM32F411xE) || defined(STM32F446xx) || \
  28. defined(STM32F469xx) || defined(STM32F479xx) || defined(STM32F412Zx) || defined(STM32F412Vx) || \
  29. defined(STM32F412Rx) || defined(STM32F412Cx) || defined(STM32F413xx) || defined(STM32F423xx)
  30. /* Includes ------------------------------------------------------------------*/
  31. #include "stm32f4xx_ll_sdmmc.h"
  32. /** @addtogroup STM32F4xx_HAL_Driver
  33. * @{
  34. */
  35. /** @defgroup MMC MMC
  36. * @brief MMC HAL module driver
  37. * @{
  38. */
  39. /* Exported types ------------------------------------------------------------*/
  40. /** @defgroup MMC_Exported_Types MMC Exported Types
  41. * @{
  42. */
  43. /** @defgroup MMC_Exported_Types_Group1 MMC State enumeration structure
  44. * @{
  45. */
  46. typedef enum
  47. {
  48. HAL_MMC_STATE_RESET = 0x00000000U, /*!< MMC not yet initialized or disabled */
  49. HAL_MMC_STATE_READY = 0x00000001U, /*!< MMC initialized and ready for use */
  50. HAL_MMC_STATE_TIMEOUT = 0x00000002U, /*!< MMC Timeout state */
  51. HAL_MMC_STATE_BUSY = 0x00000003U, /*!< MMC process ongoing */
  52. HAL_MMC_STATE_PROGRAMMING = 0x00000004U, /*!< MMC Programming State */
  53. HAL_MMC_STATE_RECEIVING = 0x00000005U, /*!< MMC Receinving State */
  54. HAL_MMC_STATE_TRANSFER = 0x00000006U, /*!< MMC Transfert State */
  55. HAL_MMC_STATE_ERROR = 0x0000000FU /*!< MMC is in error state */
  56. }HAL_MMC_StateTypeDef;
  57. /**
  58. * @}
  59. */
  60. /** @defgroup MMC_Exported_Types_Group2 MMC Card State enumeration structure
  61. * @{
  62. */
  63. typedef enum
  64. {
  65. HAL_MMC_CARD_READY = 0x00000001U, /*!< Card state is ready */
  66. HAL_MMC_CARD_IDENTIFICATION = 0x00000002U, /*!< Card is in identification state */
  67. HAL_MMC_CARD_STANDBY = 0x00000003U, /*!< Card is in standby state */
  68. HAL_MMC_CARD_TRANSFER = 0x00000004U, /*!< Card is in transfer state */
  69. HAL_MMC_CARD_SENDING = 0x00000005U, /*!< Card is sending an operation */
  70. HAL_MMC_CARD_RECEIVING = 0x00000006U, /*!< Card is receiving operation information */
  71. HAL_MMC_CARD_PROGRAMMING = 0x00000007U, /*!< Card is in programming state */
  72. HAL_MMC_CARD_DISCONNECTED = 0x00000008U, /*!< Card is disconnected */
  73. HAL_MMC_CARD_ERROR = 0x000000FFU /*!< Card response Error */
  74. }HAL_MMC_CardStateTypeDef;
  75. /**
  76. * @}
  77. */
  78. /** @defgroup MMC_Exported_Types_Group3 MMC Handle Structure definition
  79. * @{
  80. */
  81. #define MMC_InitTypeDef SDIO_InitTypeDef
  82. #define MMC_TypeDef SDIO_TypeDef
  83. /**
  84. * @brief MMC Card Information Structure definition
  85. */
  86. typedef struct
  87. {
  88. uint32_t CardType; /*!< Specifies the card Type */
  89. uint32_t Class; /*!< Specifies the class of the card class */
  90. uint32_t RelCardAdd; /*!< Specifies the Relative Card Address */
  91. uint32_t BlockNbr; /*!< Specifies the Card Capacity in blocks */
  92. uint32_t BlockSize; /*!< Specifies one block size in bytes */
  93. uint32_t LogBlockNbr; /*!< Specifies the Card logical Capacity in blocks */
  94. uint32_t LogBlockSize; /*!< Specifies logical block size in bytes */
  95. }HAL_MMC_CardInfoTypeDef;
  96. /**
  97. * @brief MMC handle Structure definition
  98. */
  99. #if defined (USE_HAL_MMC_REGISTER_CALLBACKS) && (USE_HAL_MMC_REGISTER_CALLBACKS == 1U)
  100. typedef struct __MMC_HandleTypeDef
  101. #else
  102. typedef struct
  103. #endif /* USE_HAL_MMC_REGISTER_CALLBACKS */
  104. {
  105. MMC_TypeDef *Instance; /*!< MMC registers base address */
  106. MMC_InitTypeDef Init; /*!< MMC required parameters */
  107. HAL_LockTypeDef Lock; /*!< MMC locking object */
  108. uint32_t *pTxBuffPtr; /*!< Pointer to MMC Tx transfer Buffer */
  109. uint32_t TxXferSize; /*!< MMC Tx Transfer size */
  110. uint32_t *pRxBuffPtr; /*!< Pointer to MMC Rx transfer Buffer */
  111. uint32_t RxXferSize; /*!< MMC Rx Transfer size */
  112. __IO uint32_t Context; /*!< MMC transfer context */
  113. __IO HAL_MMC_StateTypeDef State; /*!< MMC card State */
  114. __IO uint32_t ErrorCode; /*!< MMC Card Error codes */
  115. DMA_HandleTypeDef *hdmarx; /*!< MMC Rx DMA handle parameters */
  116. DMA_HandleTypeDef *hdmatx; /*!< MMC Tx DMA handle parameters */
  117. HAL_MMC_CardInfoTypeDef MmcCard; /*!< MMC Card information */
  118. uint32_t CSD[4U]; /*!< MMC card specific data table */
  119. uint32_t CID[4U]; /*!< MMC card identification number table */
  120. #if defined (USE_HAL_MMC_REGISTER_CALLBACKS) && (USE_HAL_MMC_REGISTER_CALLBACKS == 1U)
  121. void (* TxCpltCallback) (struct __MMC_HandleTypeDef *hmmc);
  122. void (* RxCpltCallback) (struct __MMC_HandleTypeDef *hmmc);
  123. void (* ErrorCallback) (struct __MMC_HandleTypeDef *hmmc);
  124. void (* AbortCpltCallback) (struct __MMC_HandleTypeDef *hmmc);
  125. void (* MspInitCallback) (struct __MMC_HandleTypeDef *hmmc);
  126. void (* MspDeInitCallback) (struct __MMC_HandleTypeDef *hmmc);
  127. #endif
  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. /** @defgroup MMC_Exported_Types_Group6 MMC Card Status returned by ACMD13
  198. * @{
  199. */
  200. typedef struct
  201. {
  202. __IO uint8_t DataBusWidth; /*!< Shows the currently defined data bus width */
  203. __IO uint8_t SecuredMode; /*!< Card is in secured mode of operation */
  204. __IO uint16_t CardType; /*!< Carries information about card type */
  205. __IO uint32_t ProtectedAreaSize; /*!< Carries information about the capacity of protected area */
  206. __IO uint8_t SpeedClass; /*!< Carries information about the speed class of the card */
  207. __IO uint8_t PerformanceMove; /*!< Carries information about the card's performance move */
  208. __IO uint8_t AllocationUnitSize; /*!< Carries information about the card's allocation unit size */
  209. __IO uint16_t EraseSize; /*!< Determines the number of AUs to be erased in one operation */
  210. __IO uint8_t EraseTimeout; /*!< Determines the timeout for any number of AU erase */
  211. __IO uint8_t EraseOffset; /*!< Carries information about the erase offset */
  212. }HAL_MMC_CardStatusTypeDef;
  213. /**
  214. * @}
  215. */
  216. #if defined (USE_HAL_MMC_REGISTER_CALLBACKS) && (USE_HAL_MMC_REGISTER_CALLBACKS == 1U)
  217. /** @defgroup MMC_Exported_Types_Group7 MMC Callback ID enumeration definition
  218. * @{
  219. */
  220. typedef enum
  221. {
  222. HAL_MMC_TX_CPLT_CB_ID = 0x00U, /*!< MMC Tx Complete Callback ID */
  223. HAL_MMC_RX_CPLT_CB_ID = 0x01U, /*!< MMC Rx Complete Callback ID */
  224. HAL_MMC_ERROR_CB_ID = 0x02U, /*!< MMC Error Callback ID */
  225. HAL_MMC_ABORT_CB_ID = 0x03U, /*!< MMC Abort Callback ID */
  226. HAL_MMC_MSP_INIT_CB_ID = 0x10U, /*!< MMC MspInit Callback ID */
  227. HAL_MMC_MSP_DEINIT_CB_ID = 0x11U /*!< MMC MspDeInit Callback ID */
  228. }HAL_MMC_CallbackIDTypeDef;
  229. /**
  230. * @}
  231. */
  232. /** @defgroup MMC_Exported_Types_Group7 MMC Callback pointer definition
  233. * @{
  234. */
  235. typedef void (*pMMC_CallbackTypeDef) (MMC_HandleTypeDef *hmmc);
  236. /**
  237. * @}
  238. */
  239. #endif
  240. /**
  241. * @}
  242. */
  243. /* Exported constants --------------------------------------------------------*/
  244. /** @defgroup MMC_Exported_Constants Exported Constants
  245. * @{
  246. */
  247. #define BLOCKSIZE 512U /*!< Block size is 512 bytes */
  248. #define CAPACITY 0x400000U /*!< Log Block Nuumber for 2 G bytes Cards */
  249. /** @defgroup MMC_Exported_Constansts_Group1 MMC Error status enumeration Structure definition
  250. * @{
  251. */
  252. #define HAL_MMC_ERROR_NONE SDMMC_ERROR_NONE /*!< No error */
  253. #define HAL_MMC_ERROR_CMD_CRC_FAIL SDMMC_ERROR_CMD_CRC_FAIL /*!< Command response received (but CRC check failed) */
  254. #define HAL_MMC_ERROR_DATA_CRC_FAIL SDMMC_ERROR_DATA_CRC_FAIL /*!< Data block sent/received (CRC check failed) */
  255. #define HAL_MMC_ERROR_CMD_RSP_TIMEOUT SDMMC_ERROR_CMD_RSP_TIMEOUT /*!< Command response timeout */
  256. #define HAL_MMC_ERROR_DATA_TIMEOUT SDMMC_ERROR_DATA_TIMEOUT /*!< Data timeout */
  257. #define HAL_MMC_ERROR_TX_UNDERRUN SDMMC_ERROR_TX_UNDERRUN /*!< Transmit FIFO underrun */
  258. #define HAL_MMC_ERROR_RX_OVERRUN SDMMC_ERROR_RX_OVERRUN /*!< Receive FIFO overrun */
  259. #define HAL_MMC_ERROR_ADDR_MISALIGNED SDMMC_ERROR_ADDR_MISALIGNED /*!< Misaligned address */
  260. #define HAL_MMC_ERROR_BLOCK_LEN_ERR SDMMC_ERROR_BLOCK_LEN_ERR /*!< Transferred block length is not allowed for the card or the
  261. number of transferred bytes does not match the block length */
  262. #define HAL_MMC_ERROR_ERASE_SEQ_ERR SDMMC_ERROR_ERASE_SEQ_ERR /*!< An error in the sequence of erase command occurs */
  263. #define HAL_MMC_ERROR_BAD_ERASE_PARAM SDMMC_ERROR_BAD_ERASE_PARAM /*!< An invalid selection for erase groups */
  264. #define HAL_MMC_ERROR_WRITE_PROT_VIOLATION SDMMC_ERROR_WRITE_PROT_VIOLATION /*!< Attempt to program a write protect block */
  265. #define HAL_MMC_ERROR_LOCK_UNLOCK_FAILED SDMMC_ERROR_LOCK_UNLOCK_FAILED /*!< Sequence or password error has been detected in unlock
  266. command or if there was an attempt to access a locked card */
  267. #define HAL_MMC_ERROR_COM_CRC_FAILED SDMMC_ERROR_COM_CRC_FAILED /*!< CRC check of the previous command failed */
  268. #define HAL_MMC_ERROR_ILLEGAL_CMD SDMMC_ERROR_ILLEGAL_CMD /*!< Command is not legal for the card state */
  269. #define HAL_MMC_ERROR_CARD_ECC_FAILED SDMMC_ERROR_CARD_ECC_FAILED /*!< Card internal ECC was applied but failed to correct the data */
  270. #define HAL_MMC_ERROR_CC_ERR SDMMC_ERROR_CC_ERR /*!< Internal card controller error */
  271. #define HAL_MMC_ERROR_GENERAL_UNKNOWN_ERR SDMMC_ERROR_GENERAL_UNKNOWN_ERR /*!< General or unknown error */
  272. #define HAL_MMC_ERROR_STREAM_READ_UNDERRUN SDMMC_ERROR_STREAM_READ_UNDERRUN /*!< The card could not sustain data reading in stream rmode */
  273. #define HAL_MMC_ERROR_STREAM_WRITE_OVERRUN SDMMC_ERROR_STREAM_WRITE_OVERRUN /*!< The card could not sustain data programming in stream mode */
  274. #define HAL_MMC_ERROR_CID_CSD_OVERWRITE SDMMC_ERROR_CID_CSD_OVERWRITE /*!< CID/CSD overwrite error */
  275. #define HAL_MMC_ERROR_WP_ERASE_SKIP SDMMC_ERROR_WP_ERASE_SKIP /*!< Only partial address space was erased */
  276. #define HAL_MMC_ERROR_CARD_ECC_DISABLED SDMMC_ERROR_CARD_ECC_DISABLED /*!< Command has been executed without using internal ECC */
  277. #define HAL_MMC_ERROR_ERASE_RESET SDMMC_ERROR_ERASE_RESET /*!< Erase sequence was cleared before executing because an out
  278. of erase sequence command was received */
  279. #define HAL_MMC_ERROR_AKE_SEQ_ERR SDMMC_ERROR_AKE_SEQ_ERR /*!< Error in sequence of authentication */
  280. #define HAL_MMC_ERROR_INVALID_VOLTRANGE SDMMC_ERROR_INVALID_VOLTRANGE /*!< Error in case of invalid voltage range */
  281. #define HAL_MMC_ERROR_ADDR_OUT_OF_RANGE SDMMC_ERROR_ADDR_OUT_OF_RANGE /*!< Error when addressed block is out of range */
  282. #define HAL_MMC_ERROR_REQUEST_NOT_APPLICABLE SDMMC_ERROR_REQUEST_NOT_APPLICABLE /*!< Error when command request is not applicable */
  283. #define HAL_MMC_ERROR_PARAM SDMMC_ERROR_INVALID_PARAMETER /*!< the used parameter is not valid */
  284. #define HAL_MMC_ERROR_UNSUPPORTED_FEATURE SDMMC_ERROR_UNSUPPORTED_FEATURE /*!< Error when feature is not insupported */
  285. #define HAL_MMC_ERROR_BUSY SDMMC_ERROR_BUSY /*!< Error when transfer process is busy */
  286. #define HAL_MMC_ERROR_DMA SDMMC_ERROR_DMA /*!< Error while DMA transfer */
  287. #define HAL_MMC_ERROR_TIMEOUT SDMMC_ERROR_TIMEOUT /*!< Timeout error */
  288. #if defined (USE_HAL_MMC_REGISTER_CALLBACKS) && (USE_HAL_MMC_REGISTER_CALLBACKS == 1U)
  289. #define HAL_MMC_ERROR_INVALID_CALLBACK SDMMC_ERROR_INVALID_PARAMETER /*!< Invalid callback error */
  290. #endif
  291. /**
  292. * @}
  293. */
  294. /** @defgroup MMC_Exported_Constansts_Group2 MMC context enumeration structure
  295. * @{
  296. */
  297. #define MMC_CONTEXT_NONE 0x00000000U /*!< None */
  298. #define MMC_CONTEXT_READ_SINGLE_BLOCK 0x00000001U /*!< Read single block operation */
  299. #define MMC_CONTEXT_READ_MULTIPLE_BLOCK 0x00000002U /*!< Read multiple blocks operation */
  300. #define MMC_CONTEXT_WRITE_SINGLE_BLOCK 0x00000010U /*!< Write single block operation */
  301. #define MMC_CONTEXT_WRITE_MULTIPLE_BLOCK 0x00000020U /*!< Write multiple blocks operation */
  302. #define MMC_CONTEXT_IT 0x00000008U /*!< Process in Interrupt mode */
  303. #define MMC_CONTEXT_DMA 0x00000080U /*!< Process in DMA mode */
  304. /**
  305. * @}
  306. */
  307. /** @defgroup MMC_Exported_Constansts_Group3 MMC Voltage mode
  308. * @{
  309. */
  310. /**
  311. * @brief
  312. */
  313. #define MMC_HIGH_VOLTAGE_RANGE 0x80FF8000U /*!< VALUE OF ARGUMENT */
  314. #define MMC_DUAL_VOLTAGE_RANGE 0x80FF8080U /*!< VALUE OF ARGUMENT */
  315. #define eMMC_HIGH_VOLTAGE_RANGE 0xC0FF8000U /*!< for eMMC > 2Gb sector mode */
  316. #define eMMC_DUAL_VOLTAGE_RANGE 0xC0FF8080U /*!< for eMMC > 2Gb sector mode */
  317. #define MMC_INVALID_VOLTAGE_RANGE 0x0001FF01U
  318. /**
  319. * @}
  320. */
  321. /** @defgroup MMC_Exported_Constansts_Group4 MMC Memory Cards
  322. * @{
  323. */
  324. #define MMC_HIGH_VOLTAGE_CARD 0x00000000U
  325. #define MMC_DUAL_VOLTAGE_CARD 0x00000001U
  326. /**
  327. * @}
  328. */
  329. /**
  330. * @}
  331. */
  332. /* Exported macro ------------------------------------------------------------*/
  333. /** @defgroup MMC_Exported_macros MMC Exported Macros
  334. * @brief macros to handle interrupts and specific clock configurations
  335. * @{
  336. */
  337. /** @brief Reset MMC handle state.
  338. * @param __HANDLE__ : MMC handle.
  339. * @retval None
  340. */
  341. #if defined (USE_HAL_MMC_REGISTER_CALLBACKS) && (USE_HAL_MMC_REGISTER_CALLBACKS == 1U)
  342. #define __HAL_MMC_RESET_HANDLE_STATE(__HANDLE__) do { \
  343. (__HANDLE__)->State = HAL_MMC_STATE_RESET; \
  344. (__HANDLE__)->MspInitCallback = NULL; \
  345. (__HANDLE__)->MspDeInitCallback = NULL; \
  346. } while(0)
  347. #else
  348. #define __HAL_MMC_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_MMC_STATE_RESET)
  349. #endif
  350. /**
  351. * @brief Enable the MMC device.
  352. * @retval None
  353. */
  354. #define __HAL_MMC_ENABLE(__HANDLE__) __SDIO_ENABLE((__HANDLE__)->Instance)
  355. /**
  356. * @brief Disable the MMC device.
  357. * @retval None
  358. */
  359. #define __HAL_MMC_DISABLE(__HANDLE__) __SDIO_DISABLE((__HANDLE__)->Instance)
  360. /**
  361. * @brief Enable the SDMMC DMA transfer.
  362. * @retval None
  363. */
  364. #define __HAL_MMC_DMA_ENABLE(__HANDLE__) __SDIO_DMA_ENABLE((__HANDLE__)->Instance)
  365. /**
  366. * @brief Disable the SDMMC DMA transfer.
  367. * @retval None
  368. */
  369. #define __HAL_MMC_DMA_DISABLE(__HANDLE__) __SDIO_DMA_DISABLE((__HANDLE__)->Instance)
  370. /**
  371. * @brief Enable the MMC device interrupt.
  372. * @param __HANDLE__ MMC Handle
  373. * @param __INTERRUPT__ specifies the SDMMC interrupt sources to be enabled.
  374. * This parameter can be one or a combination of the following values:
  375. * @arg SDIO_IT_CCRCFAIL: Command response received (CRC check failed) interrupt
  376. * @arg SDIO_IT_DCRCFAIL: Data block sent/received (CRC check failed) interrupt
  377. * @arg SDIO_IT_CTIMEOUT: Command response timeout interrupt
  378. * @arg SDIO_IT_DTIMEOUT: Data timeout interrupt
  379. * @arg SDIO_IT_TXUNDERR: Transmit FIFO underrun error interrupt
  380. * @arg SDIO_IT_RXOVERR: Received FIFO overrun error interrupt
  381. * @arg SDIO_IT_CMDREND: Command response received (CRC check passed) interrupt
  382. * @arg SDIO_IT_CMDSENT: Command sent (no response required) interrupt
  383. * @arg SDIO_IT_DATAEND: Data end (data counter, SDIDCOUNT, is zero) interrupt
  384. * @arg SDIO_IT_DBCKEND: Data block sent/received (CRC check passed) interrupt
  385. * @arg SDIO_IT_CMDACT: Command transfer in progress interrupt
  386. * @arg SDIO_IT_TXACT: Data transmit in progress interrupt
  387. * @arg SDIO_IT_RXACT: Data receive in progress interrupt
  388. * @arg SDIO_IT_TXFIFOHE: Transmit FIFO Half Empty interrupt
  389. * @arg SDIO_IT_RXFIFOHF: Receive FIFO Half Full interrupt
  390. * @arg SDIO_IT_TXFIFOF: Transmit FIFO full interrupt
  391. * @arg SDIO_IT_RXFIFOF: Receive FIFO full interrupt
  392. * @arg SDIO_IT_TXFIFOE: Transmit FIFO empty interrupt
  393. * @arg SDIO_IT_RXFIFOE: Receive FIFO empty interrupt
  394. * @arg SDIO_IT_TXDAVL: Data available in transmit FIFO interrupt
  395. * @arg SDIO_IT_RXDAVL: Data available in receive FIFO interrupt
  396. * @arg SDIO_IT_SDIOIT: SD I/O interrupt received interrupt
  397. * @retval None
  398. */
  399. #define __HAL_MMC_ENABLE_IT(__HANDLE__, __INTERRUPT__) __SDIO_ENABLE_IT((__HANDLE__)->Instance, (__INTERRUPT__))
  400. /**
  401. * @brief Disable the MMC device interrupt.
  402. * @param __HANDLE__ MMC Handle
  403. * @param __INTERRUPT__ specifies the SDMMC interrupt sources to be disabled.
  404. * This parameter can be one or a combination of the following values:
  405. * @arg SDIO_IT_CCRCFAIL: Command response received (CRC check failed) interrupt
  406. * @arg SDIO_IT_DCRCFAIL: Data block sent/received (CRC check failed) interrupt
  407. * @arg SDIO_IT_CTIMEOUT: Command response timeout interrupt
  408. * @arg SDIO_IT_DTIMEOUT: Data timeout interrupt
  409. * @arg SDIO_IT_TXUNDERR: Transmit FIFO underrun error interrupt
  410. * @arg SDIO_IT_RXOVERR: Received FIFO overrun error interrupt
  411. * @arg SDIO_IT_CMDREND: Command response received (CRC check passed) interrupt
  412. * @arg SDIO_IT_CMDSENT: Command sent (no response required) interrupt
  413. * @arg SDIO_IT_DATAEND: Data end (data counter, SDIDCOUNT, is zero) interrupt
  414. * @arg SDIO_IT_DBCKEND: Data block sent/received (CRC check passed) interrupt
  415. * @arg SDIO_IT_CMDACT: Command transfer in progress interrupt
  416. * @arg SDIO_IT_TXACT: Data transmit in progress interrupt
  417. * @arg SDIO_IT_RXACT: Data receive in progress interrupt
  418. * @arg SDIO_IT_TXFIFOHE: Transmit FIFO Half Empty interrupt
  419. * @arg SDIO_IT_RXFIFOHF: Receive FIFO Half Full interrupt
  420. * @arg SDIO_IT_TXFIFOF: Transmit FIFO full interrupt
  421. * @arg SDIO_IT_RXFIFOF: Receive FIFO full interrupt
  422. * @arg SDIO_IT_TXFIFOE: Transmit FIFO empty interrupt
  423. * @arg SDIO_IT_RXFIFOE: Receive FIFO empty interrupt
  424. * @arg SDIO_IT_TXDAVL: Data available in transmit FIFO interrupt
  425. * @arg SDIO_IT_RXDAVL: Data available in receive FIFO interrupt
  426. * @arg SDIO_IT_SDIOIT: SD I/O interrupt received interrupt
  427. * @retval None
  428. */
  429. #define __HAL_MMC_DISABLE_IT(__HANDLE__, __INTERRUPT__) __SDIO_DISABLE_IT((__HANDLE__)->Instance, (__INTERRUPT__))
  430. /**
  431. * @brief Check whether the specified MMC flag is set or not.
  432. * @param __HANDLE__ MMC Handle
  433. * @param __FLAG__ specifies the flag to check.
  434. * This parameter can be one of the following values:
  435. * @arg SDIO_FLAG_CCRCFAIL: Command response received (CRC check failed)
  436. * @arg SDIO_FLAG_DCRCFAIL: Data block sent/received (CRC check failed)
  437. * @arg SDIO_FLAG_CTIMEOUT: Command response timeout
  438. * @arg SDIO_FLAG_DTIMEOUT: Data timeout
  439. * @arg SDIO_FLAG_TXUNDERR: Transmit FIFO underrun error
  440. * @arg SDIO_FLAG_RXOVERR: Received FIFO overrun error
  441. * @arg SDIO_FLAG_CMDREND: Command response received (CRC check passed)
  442. * @arg SDIO_FLAG_CMDSENT: Command sent (no response required)
  443. * @arg SDIO_FLAG_DATAEND: Data end (data counter, SDIDCOUNT, is zero)
  444. * @arg SDIO_FLAG_DBCKEND: Data block sent/received (CRC check passed)
  445. * @arg SDIO_FLAG_CMDACT: Command transfer in progress
  446. * @arg SDIO_FLAG_TXACT: Data transmit in progress
  447. * @arg SDIO_FLAG_RXACT: Data receive in progress
  448. * @arg SDIO_FLAG_TXFIFOHE: Transmit FIFO Half Empty
  449. * @arg SDIO_FLAG_RXFIFOHF: Receive FIFO Half Full
  450. * @arg SDIO_FLAG_TXFIFOF: Transmit FIFO full
  451. * @arg SDIO_FLAG_RXFIFOF: Receive FIFO full
  452. * @arg SDIO_FLAG_TXFIFOE: Transmit FIFO empty
  453. * @arg SDIO_FLAG_RXFIFOE: Receive FIFO empty
  454. * @arg SDIO_FLAG_TXDAVL: Data available in transmit FIFO
  455. * @arg SDIO_FLAG_RXDAVL: Data available in receive FIFO
  456. * @arg SDIO_FLAG_SDIOIT: SD I/O interrupt received
  457. * @retval The new state of MMC FLAG (SET or RESET).
  458. */
  459. #define __HAL_MMC_GET_FLAG(__HANDLE__, __FLAG__) __SDIO_GET_FLAG((__HANDLE__)->Instance, (__FLAG__))
  460. /**
  461. * @brief Clear the MMC's pending flags.
  462. * @param __HANDLE__ MMC Handle
  463. * @param __FLAG__ specifies the flag to clear.
  464. * This parameter can be one or a combination of the following values:
  465. * @arg SDIO_FLAG_CCRCFAIL: Command response received (CRC check failed)
  466. * @arg SDIO_FLAG_DCRCFAIL: Data block sent/received (CRC check failed)
  467. * @arg SDIO_FLAG_CTIMEOUT: Command response timeout
  468. * @arg SDIO_FLAG_DTIMEOUT: Data timeout
  469. * @arg SDIO_FLAG_TXUNDERR: Transmit FIFO underrun error
  470. * @arg SDIO_FLAG_RXOVERR: Received FIFO overrun error
  471. * @arg SDIO_FLAG_CMDREND: Command response received (CRC check passed)
  472. * @arg SDIO_FLAG_CMDSENT: Command sent (no response required)
  473. * @arg SDIO_FLAG_DATAEND: Data end (data counter, SDIDCOUNT, is zero)
  474. * @arg SDIO_FLAG_DBCKEND: Data block sent/received (CRC check passed)
  475. * @arg SDIO_FLAG_SDIOIT: SD I/O interrupt received
  476. * @retval None
  477. */
  478. #define __HAL_MMC_CLEAR_FLAG(__HANDLE__, __FLAG__) __SDIO_CLEAR_FLAG((__HANDLE__)->Instance, (__FLAG__))
  479. /**
  480. * @brief Check whether the specified MMC interrupt has occurred or not.
  481. * @param __HANDLE__ MMC Handle
  482. * @param __INTERRUPT__ specifies the SDMMC interrupt source to check.
  483. * This parameter can be one of the following values:
  484. * @arg SDIO_IT_CCRCFAIL: Command response received (CRC check failed) interrupt
  485. * @arg SDIO_IT_DCRCFAIL: Data block sent/received (CRC check failed) interrupt
  486. * @arg SDIO_IT_CTIMEOUT: Command response timeout interrupt
  487. * @arg SDIO_IT_DTIMEOUT: Data timeout interrupt
  488. * @arg SDIO_IT_TXUNDERR: Transmit FIFO underrun error interrupt
  489. * @arg SDIO_IT_RXOVERR: Received FIFO overrun error interrupt
  490. * @arg SDIO_IT_CMDREND: Command response received (CRC check passed) interrupt
  491. * @arg SDIO_IT_CMDSENT: Command sent (no response required) interrupt
  492. * @arg SDIO_IT_DATAEND: Data end (data counter, SDIDCOUNT, is zero) interrupt
  493. * @arg SDIO_IT_DBCKEND: Data block sent/received (CRC check passed) interrupt
  494. * @arg SDIO_IT_CMDACT: Command transfer in progress interrupt
  495. * @arg SDIO_IT_TXACT: Data transmit in progress interrupt
  496. * @arg SDIO_IT_RXACT: Data receive in progress interrupt
  497. * @arg SDIO_IT_TXFIFOHE: Transmit FIFO Half Empty interrupt
  498. * @arg SDIO_IT_RXFIFOHF: Receive FIFO Half Full interrupt
  499. * @arg SDIO_IT_TXFIFOF: Transmit FIFO full interrupt
  500. * @arg SDIO_IT_RXFIFOF: Receive FIFO full interrupt
  501. * @arg SDIO_IT_TXFIFOE: Transmit FIFO empty interrupt
  502. * @arg SDIO_IT_RXFIFOE: Receive FIFO empty interrupt
  503. * @arg SDIO_IT_TXDAVL: Data available in transmit FIFO interrupt
  504. * @arg SDIO_IT_RXDAVL: Data available in receive FIFO interrupt
  505. * @arg SDIO_IT_SDIOIT: SD I/O interrupt received interrupt
  506. * @retval The new state of MMC IT (SET or RESET).
  507. */
  508. #define __HAL_MMC_GET_IT(__HANDLE__, __INTERRUPT__) __SDIO_GET_IT((__HANDLE__)->Instance, (__INTERRUPT__))
  509. /**
  510. * @brief Clear the MMC's interrupt pending bits.
  511. * @param __HANDLE__ MMC Handle
  512. * @param __INTERRUPT__ specifies the interrupt pending bit to clear.
  513. * This parameter can be one or a combination of the following values:
  514. * @arg SDIO_IT_CCRCFAIL: Command response received (CRC check failed) interrupt
  515. * @arg SDIO_IT_DCRCFAIL: Data block sent/received (CRC check failed) interrupt
  516. * @arg SDIO_IT_CTIMEOUT: Command response timeout interrupt
  517. * @arg SDIO_IT_DTIMEOUT: Data timeout interrupt
  518. * @arg SDIO_IT_TXUNDERR: Transmit FIFO underrun error interrupt
  519. * @arg SDIO_IT_RXOVERR: Received FIFO overrun error interrupt
  520. * @arg SDIO_IT_CMDREND: Command response received (CRC check passed) interrupt
  521. * @arg SDIO_IT_CMDSENT: Command sent (no response required) interrupt
  522. * @arg SDIO_IT_DATAEND: Data end (data counter, SDMMC_DCOUNT, is zero) interrupt
  523. * @arg SDIO_IT_SDIOIT: SD I/O interrupt received interrupt
  524. * @retval None
  525. */
  526. #define __HAL_MMC_CLEAR_IT(__HANDLE__, __INTERRUPT__) __SDIO_CLEAR_IT((__HANDLE__)->Instance, (__INTERRUPT__))
  527. /**
  528. * @}
  529. */
  530. /* Exported functions --------------------------------------------------------*/
  531. /** @defgroup MMC_Exported_Functions MMC Exported Functions
  532. * @{
  533. */
  534. /** @defgroup MMC_Exported_Functions_Group1 Initialization and de-initialization functions
  535. * @{
  536. */
  537. HAL_StatusTypeDef HAL_MMC_Init(MMC_HandleTypeDef *hmmc);
  538. HAL_StatusTypeDef HAL_MMC_InitCard(MMC_HandleTypeDef *hmmc);
  539. HAL_StatusTypeDef HAL_MMC_DeInit (MMC_HandleTypeDef *hmmc);
  540. void HAL_MMC_MspInit(MMC_HandleTypeDef *hmmc);
  541. void HAL_MMC_MspDeInit(MMC_HandleTypeDef *hmmc);
  542. /**
  543. * @}
  544. */
  545. /** @defgroup MMC_Exported_Functions_Group2 Input and Output operation functions
  546. * @{
  547. */
  548. /* Blocking mode: Polling */
  549. HAL_StatusTypeDef HAL_MMC_ReadBlocks(MMC_HandleTypeDef *hmmc, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks, uint32_t Timeout);
  550. HAL_StatusTypeDef HAL_MMC_WriteBlocks(MMC_HandleTypeDef *hmmc, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks, uint32_t Timeout);
  551. HAL_StatusTypeDef HAL_MMC_Erase(MMC_HandleTypeDef *hmmc, uint32_t BlockStartAdd, uint32_t BlockEndAdd);
  552. /* Non-Blocking mode: IT */
  553. HAL_StatusTypeDef HAL_MMC_ReadBlocks_IT(MMC_HandleTypeDef *hmmc, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks);
  554. HAL_StatusTypeDef HAL_MMC_WriteBlocks_IT(MMC_HandleTypeDef *hmmc, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks);
  555. /* Non-Blocking mode: DMA */
  556. HAL_StatusTypeDef HAL_MMC_ReadBlocks_DMA(MMC_HandleTypeDef *hmmc, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks);
  557. HAL_StatusTypeDef HAL_MMC_WriteBlocks_DMA(MMC_HandleTypeDef *hmmc, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks);
  558. void HAL_MMC_IRQHandler(MMC_HandleTypeDef *hmmc);
  559. /* Callback in non blocking modes (DMA) */
  560. void HAL_MMC_TxCpltCallback(MMC_HandleTypeDef *hmmc);
  561. void HAL_MMC_RxCpltCallback(MMC_HandleTypeDef *hmmc);
  562. void HAL_MMC_ErrorCallback(MMC_HandleTypeDef *hmmc);
  563. void HAL_MMC_AbortCallback(MMC_HandleTypeDef *hmmc);
  564. #if defined (USE_HAL_MMC_REGISTER_CALLBACKS) && (USE_HAL_MMC_REGISTER_CALLBACKS == 1U)
  565. /* MMC callback registering/unregistering */
  566. HAL_StatusTypeDef HAL_MMC_RegisterCallback (MMC_HandleTypeDef *hmmc, HAL_MMC_CallbackIDTypeDef CallbackId, pMMC_CallbackTypeDef pCallback);
  567. HAL_StatusTypeDef HAL_MMC_UnRegisterCallback(MMC_HandleTypeDef *hmmc, HAL_MMC_CallbackIDTypeDef CallbackId);
  568. #endif
  569. /**
  570. * @}
  571. */
  572. /** @defgroup MMC_Exported_Functions_Group3 Peripheral Control functions
  573. * @{
  574. */
  575. HAL_StatusTypeDef HAL_MMC_ConfigWideBusOperation(MMC_HandleTypeDef *hmmc, uint32_t WideMode);
  576. /**
  577. * @}
  578. */
  579. /** @defgroup MMC_Exported_Functions_Group4 MMC card related functions
  580. * @{
  581. */
  582. HAL_MMC_CardStateTypeDef HAL_MMC_GetCardState(MMC_HandleTypeDef *hmmc);
  583. HAL_StatusTypeDef HAL_MMC_GetCardCID(MMC_HandleTypeDef *hmmc, HAL_MMC_CardCIDTypeDef *pCID);
  584. HAL_StatusTypeDef HAL_MMC_GetCardCSD(MMC_HandleTypeDef *hmmc, HAL_MMC_CardCSDTypeDef *pCSD);
  585. HAL_StatusTypeDef HAL_MMC_GetCardInfo(MMC_HandleTypeDef *hmmc, HAL_MMC_CardInfoTypeDef *pCardInfo);
  586. /**
  587. * @}
  588. */
  589. /** @defgroup MMC_Exported_Functions_Group5 Peripheral State and Errors functions
  590. * @{
  591. */
  592. HAL_MMC_StateTypeDef HAL_MMC_GetState(MMC_HandleTypeDef *hmmc);
  593. uint32_t HAL_MMC_GetError(MMC_HandleTypeDef *hmmc);
  594. /**
  595. * @}
  596. */
  597. /** @defgroup MMC_Exported_Functions_Group6 Perioheral Abort management
  598. * @{
  599. */
  600. HAL_StatusTypeDef HAL_MMC_Abort(MMC_HandleTypeDef *hmmc);
  601. HAL_StatusTypeDef HAL_MMC_Abort_IT(MMC_HandleTypeDef *hmmc);
  602. /**
  603. * @}
  604. */
  605. /* Private types -------------------------------------------------------------*/
  606. /** @defgroup MMC_Private_Types MMC Private Types
  607. * @{
  608. */
  609. /**
  610. * @}
  611. */
  612. /* Private defines -----------------------------------------------------------*/
  613. /** @defgroup MMC_Private_Defines MMC Private Defines
  614. * @{
  615. */
  616. /**
  617. * @}
  618. */
  619. /* Private variables ---------------------------------------------------------*/
  620. /** @defgroup MMC_Private_Variables MMC Private Variables
  621. * @{
  622. */
  623. /**
  624. * @}
  625. */
  626. /* Private constants ---------------------------------------------------------*/
  627. /** @defgroup MMC_Private_Constants MMC Private Constants
  628. * @{
  629. */
  630. /**
  631. * @}
  632. */
  633. /* Private macros ------------------------------------------------------------*/
  634. /** @defgroup MMC_Private_Macros MMC Private Macros
  635. * @{
  636. */
  637. /**
  638. * @}
  639. */
  640. /* Private functions prototypes ----------------------------------------------*/
  641. /** @defgroup MMC_Private_Functions_Prototypes MMC Private Functions Prototypes
  642. * @{
  643. */
  644. /**
  645. * @}
  646. */
  647. /* Private functions ---------------------------------------------------------*/
  648. /** @defgroup MMC_Private_Functions MMC Private Functions
  649. * @{
  650. */
  651. /**
  652. * @}
  653. */
  654. /**
  655. * @}
  656. */
  657. /**
  658. * @}
  659. */
  660. /**
  661. * @}
  662. */
  663. #endif /* STM32F405xx || STM32F415xx || STM32F407xx || STM32F417xx || STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx ||
  664. STM32F401xC || STM32F401xE || STM32F411xE || STM32F446xx || STM32F469xx || STM32F479xx || STM32F412Zx || STM32F412Vx ||
  665. STM32F412Rx || STM32F412Cx || STM32F413xx || STM32F423xx */
  666. #ifdef __cplusplus
  667. }
  668. #endif
  669. #endif /* __STM32F4xx_HAL_MMC_H */
  670. /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/