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