Merge pull request #11270 from haslinghuis/rename_attr
[betaflight.git] / lib / main / STM32H7 / Drivers / STM32H7xx_HAL_Driver / Inc / stm32h7xx_hal_mmc.h
blobb3dc7cc114a27d5a5912719f1e639e028b93d146
1 /**
2 ******************************************************************************
3 * @file stm32h7xx_hal_mmc.h
4 * @author MCD Application Team
5 * @brief Header file of MMC HAL module.
6 ******************************************************************************
7 * @attention
9 * <h2><center>&copy; Copyright (c) 2017 STMicroelectronics.
10 * All rights reserved.</center></h2>
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
17 ******************************************************************************
18 */
20 /* Define to prevent recursive inclusion -------------------------------------*/
21 #ifndef STM32H7xx_HAL_MMC_H
22 #define STM32H7xx_HAL_MMC_H
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
28 /* Includes ------------------------------------------------------------------*/
29 #include "stm32h7xx_ll_sdmmc.h"
31 /** @addtogroup STM32H7xx_HAL_Driver
32 * @{
35 /** @addtogroup MMC
36 * @{
39 /* Exported types ------------------------------------------------------------*/
40 /** @defgroup MMC_Exported_Types MMC Exported Types
41 * @{
44 /** @defgroup MMC_Exported_Types_Group1 MMC State enumeration structure
45 * @{
47 typedef enum
49 HAL_MMC_STATE_RESET = ((uint32_t)0x00000000U), /*!< MMC not yet initialized or disabled */
50 HAL_MMC_STATE_READY = ((uint32_t)0x00000001U), /*!< MMC initialized and ready for use */
51 HAL_MMC_STATE_TIMEOUT = ((uint32_t)0x00000002U), /*!< MMC Timeout state */
52 HAL_MMC_STATE_BUSY = ((uint32_t)0x00000003U), /*!< MMC process ongoing */
53 HAL_MMC_STATE_PROGRAMMING = ((uint32_t)0x00000004U), /*!< MMC Programming State */
54 HAL_MMC_STATE_RECEIVING = ((uint32_t)0x00000005U), /*!< MMC Receinving State */
55 HAL_MMC_STATE_TRANSFER = ((uint32_t)0x00000006U), /*!< MMC Transfert State */
56 HAL_MMC_STATE_ERROR = ((uint32_t)0x0000000FU) /*!< MMC is in error state */
57 }HAL_MMC_StateTypeDef;
58 /**
59 * @}
62 /** @defgroup MMC_Exported_Types_Group2 MMC Card State enumeration structure
63 * @{
65 typedef uint32_t HAL_MMC_CardStateTypeDef;
67 #define HAL_MMC_CARD_READY 0x00000001U /*!< Card state is ready */
68 #define HAL_MMC_CARD_IDENTIFICATION 0x00000002U /*!< Card is in identification state */
69 #define HAL_MMC_CARD_STANDBY 0x00000003U /*!< Card is in standby state */
70 #define HAL_MMC_CARD_TRANSFER 0x00000004U /*!< Card is in transfer state */
71 #define HAL_MMC_CARD_SENDING 0x00000005U /*!< Card is sending an operation */
72 #define HAL_MMC_CARD_RECEIVING 0x00000006U /*!< Card is receiving operation information */
73 #define HAL_MMC_CARD_PROGRAMMING 0x00000007U /*!< Card is in programming state */
74 #define HAL_MMC_CARD_DISCONNECTED 0x00000008U /*!< Card is disconnected */
75 #define HAL_MMC_CARD_ERROR 0x000000FFU /*!< Card response Error */
76 /**
77 * @}
80 /** @defgroup MMC_Exported_Types_Group3 MMC Handle Structure definition
81 * @{
83 #define MMC_InitTypeDef SDMMC_InitTypeDef
84 #define MMC_TypeDef SDMMC_TypeDef
86 /**
87 * @brief MMC Card Information Structure definition
89 typedef struct
91 uint32_t CardType; /*!< Specifies the card Type */
93 uint32_t Class; /*!< Specifies the class of the card class */
95 uint32_t RelCardAdd; /*!< Specifies the Relative Card Address */
97 uint32_t BlockNbr; /*!< Specifies the Card Capacity in blocks */
99 uint32_t BlockSize; /*!< Specifies one block size in bytes */
101 uint32_t LogBlockNbr; /*!< Specifies the Card logical Capacity in blocks */
103 uint32_t LogBlockSize; /*!< Specifies logical block size in bytes */
105 }HAL_MMC_CardInfoTypeDef;
108 * @brief MMC handle Structure definition
110 #if defined (USE_HAL_MMC_REGISTER_CALLBACKS) && (USE_HAL_MMC_REGISTER_CALLBACKS == 1U)
111 typedef struct __MMC_HandleTypeDef
112 #else
113 typedef struct
114 #endif /* USE_HAL_MMC_REGISTER_CALLBACKS */
116 MMC_TypeDef *Instance; /*!< MMC registers base address */
118 MMC_InitTypeDef Init; /*!< MMC required parameters */
120 HAL_LockTypeDef Lock; /*!< MMC locking object */
122 uint8_t *pTxBuffPtr; /*!< Pointer to MMC Tx transfer Buffer */
124 uint32_t TxXferSize; /*!< MMC Tx Transfer size */
126 uint8_t *pRxBuffPtr; /*!< Pointer to MMC Rx transfer Buffer */
128 uint32_t RxXferSize; /*!< MMC Rx Transfer size */
130 __IO uint32_t Context; /*!< MMC transfer context */
132 __IO HAL_MMC_StateTypeDef State; /*!< MMC card State */
134 __IO uint32_t ErrorCode; /*!< MMC Card Error codes */
136 HAL_MMC_CardInfoTypeDef MmcCard; /*!< MMC Card information */
138 uint32_t CSD[4U]; /*!< MMC card specific data table */
140 uint32_t CID[4U]; /*!< MMC card identification number table */
142 uint32_t Ext_CSD[128];
144 #if defined (USE_HAL_MMC_REGISTER_CALLBACKS) && (USE_HAL_MMC_REGISTER_CALLBACKS == 1U)
145 void (* TxCpltCallback) (struct __MMC_HandleTypeDef *hmmc);
146 void (* RxCpltCallback) (struct __MMC_HandleTypeDef *hmmc);
147 void (* ErrorCallback) (struct __MMC_HandleTypeDef *hmmc);
148 void (* AbortCpltCallback) (struct __MMC_HandleTypeDef *hmmc);
149 void (* Read_DMADblBuf0CpltCallback) (struct __MMC_HandleTypeDef *hmmc);
150 void (* Read_DMADblBuf1CpltCallback) (struct __MMC_HandleTypeDef *hmmc);
151 void (* Write_DMADblBuf0CpltCallback) (struct __MMC_HandleTypeDef *hmmc);
152 void (* Write_DMADblBuf1CpltCallback) (struct __MMC_HandleTypeDef *hmmc);
154 void (* MspInitCallback) (struct __MMC_HandleTypeDef *hmmc);
155 void (* MspDeInitCallback) (struct __MMC_HandleTypeDef *hmmc);
156 #endif
157 }MMC_HandleTypeDef;
161 * @}
164 /** @defgroup MMC_Exported_Types_Group4 Card Specific Data: CSD Register
165 * @{
167 typedef struct
169 __IO uint8_t CSDStruct; /*!< CSD structure */
170 __IO uint8_t SysSpecVersion; /*!< System specification version */
171 __IO uint8_t Reserved1; /*!< Reserved */
172 __IO uint8_t TAAC; /*!< Data read access time 1 */
173 __IO uint8_t NSAC; /*!< Data read access time 2 in CLK cycles */
174 __IO uint8_t MaxBusClkFrec; /*!< Max. bus clock frequency */
175 __IO uint16_t CardComdClasses; /*!< Card command classes */
176 __IO uint8_t RdBlockLen; /*!< Max. read data block length */
177 __IO uint8_t PartBlockRead; /*!< Partial blocks for read allowed */
178 __IO uint8_t WrBlockMisalign; /*!< Write block misalignment */
179 __IO uint8_t RdBlockMisalign; /*!< Read block misalignment */
180 __IO uint8_t DSRImpl; /*!< DSR implemented */
181 __IO uint8_t Reserved2; /*!< Reserved */
182 __IO uint32_t DeviceSize; /*!< Device Size */
183 __IO uint8_t MaxRdCurrentVDDMin; /*!< Max. read current @ VDD min */
184 __IO uint8_t MaxRdCurrentVDDMax; /*!< Max. read current @ VDD max */
185 __IO uint8_t MaxWrCurrentVDDMin; /*!< Max. write current @ VDD min */
186 __IO uint8_t MaxWrCurrentVDDMax; /*!< Max. write current @ VDD max */
187 __IO uint8_t DeviceSizeMul; /*!< Device size multiplier */
188 __IO uint8_t EraseGrSize; /*!< Erase group size */
189 __IO uint8_t EraseGrMul; /*!< Erase group size multiplier */
190 __IO uint8_t WrProtectGrSize; /*!< Write protect group size */
191 __IO uint8_t WrProtectGrEnable; /*!< Write protect group enable */
192 __IO uint8_t ManDeflECC; /*!< Manufacturer default ECC */
193 __IO uint8_t WrSpeedFact; /*!< Write speed factor */
194 __IO uint8_t MaxWrBlockLen; /*!< Max. write data block length */
195 __IO uint8_t WriteBlockPaPartial; /*!< Partial blocks for write allowed */
196 __IO uint8_t Reserved3; /*!< Reserved */
197 __IO uint8_t ContentProtectAppli; /*!< Content protection application */
198 __IO uint8_t FileFormatGroup; /*!< File format group */
199 __IO uint8_t CopyFlag; /*!< Copy flag (OTP) */
200 __IO uint8_t PermWrProtect; /*!< Permanent write protection */
201 __IO uint8_t TempWrProtect; /*!< Temporary write protection */
202 __IO uint8_t FileFormat; /*!< File format */
203 __IO uint8_t ECC; /*!< ECC code */
204 __IO uint8_t CSD_CRC; /*!< CSD CRC */
205 __IO uint8_t Reserved4; /*!< Always 1 */
207 }HAL_MMC_CardCSDTypeDef;
209 * @}
212 /** @defgroup MMC_Exported_Types_Group5 Card Identification Data: CID Register
213 * @{
215 typedef struct
217 __IO uint8_t ManufacturerID; /*!< Manufacturer ID */
218 __IO uint16_t OEM_AppliID; /*!< OEM/Application ID */
219 __IO uint32_t ProdName1; /*!< Product Name part1 */
220 __IO uint8_t ProdName2; /*!< Product Name part2 */
221 __IO uint8_t ProdRev; /*!< Product Revision */
222 __IO uint32_t ProdSN; /*!< Product Serial Number */
223 __IO uint8_t Reserved1; /*!< Reserved1 */
224 __IO uint16_t ManufactDate; /*!< Manufacturing Date */
225 __IO uint8_t CID_CRC; /*!< CID CRC */
226 __IO uint8_t Reserved2; /*!< Always 1 */
228 }HAL_MMC_CardCIDTypeDef;
230 * @}
233 #if defined (USE_HAL_MMC_REGISTER_CALLBACKS) && (USE_HAL_MMC_REGISTER_CALLBACKS == 1U)
234 /** @defgroup MMC_Exported_Types_Group6 MMC Callback ID enumeration definition
235 * @{
237 typedef enum
239 HAL_MMC_TX_CPLT_CB_ID = 0x00U, /*!< MMC Tx Complete Callback ID */
240 HAL_MMC_RX_CPLT_CB_ID = 0x01U, /*!< MMC Rx Complete Callback ID */
241 HAL_MMC_ERROR_CB_ID = 0x02U, /*!< MMC Error Callback ID */
242 HAL_MMC_ABORT_CB_ID = 0x03U, /*!< MMC Abort Callback ID */
243 HAL_MMC_READ_DMA_DBL_BUF0_CPLT_CB_ID = 0x04U, /*!< MMC Rx DMA Double Buffer 0 Complete Callback ID */
244 HAL_MMC_READ_DMA_DBL_BUF1_CPLT_CB_ID = 0x05U, /*!< MMC Rx DMA Double Buffer 1 Complete Callback ID */
245 HAL_MMC_WRITE_DMA_DBL_BUF0_CPLT_CB_ID = 0x06U, /*!< MMC Tx DMA Double Buffer 0 Complete Callback ID */
246 HAL_MMC_WRITE_DMA_DBL_BUF1_CPLT_CB_ID = 0x07U, /*!< MMC Tx DMA Double Buffer 1 Complete Callback ID */
248 HAL_MMC_MSP_INIT_CB_ID = 0x10U, /*!< MMC MspInit Callback ID */
249 HAL_MMC_MSP_DEINIT_CB_ID = 0x11U /*!< MMC MspDeInit Callback ID */
250 }HAL_MMC_CallbackIDTypeDef;
252 * @}
255 /** @defgroup MMC_Exported_Types_Group7 MMC Callback pointer definition
256 * @{
258 typedef void (*pMMC_CallbackTypeDef) (MMC_HandleTypeDef *hmmc);
260 * @}
262 #endif
264 * @}
267 /* Exported constants --------------------------------------------------------*/
268 /** @defgroup MMC_Exported_Constants Exported Constants
269 * @{
272 #define MMC_BLOCKSIZE ((uint32_t)512U) /*!< Block size is 512 bytes */
274 /** @defgroup MMC_Exported_Constansts_Group1 MMC Error status enumeration Structure definition
275 * @{
277 #define HAL_MMC_ERROR_NONE SDMMC_ERROR_NONE /*!< No error */
278 #define HAL_MMC_ERROR_CMD_CRC_FAIL SDMMC_ERROR_CMD_CRC_FAIL /*!< Command response received (but CRC check failed) */
279 #define HAL_MMC_ERROR_DATA_CRC_FAIL SDMMC_ERROR_DATA_CRC_FAIL /*!< Data block sent/received (CRC check failed) */
280 #define HAL_MMC_ERROR_CMD_RSP_TIMEOUT SDMMC_ERROR_CMD_RSP_TIMEOUT /*!< Command response timeout */
281 #define HAL_MMC_ERROR_DATA_TIMEOUT SDMMC_ERROR_DATA_TIMEOUT /*!< Data timeout */
282 #define HAL_MMC_ERROR_TX_UNDERRUN SDMMC_ERROR_TX_UNDERRUN /*!< Transmit FIFO underrun */
283 #define HAL_MMC_ERROR_RX_OVERRUN SDMMC_ERROR_RX_OVERRUN /*!< Receive FIFO overrun */
284 #define HAL_MMC_ERROR_ADDR_MISALIGNED SDMMC_ERROR_ADDR_MISALIGNED /*!< Misaligned address */
285 #define HAL_MMC_ERROR_BLOCK_LEN_ERR SDMMC_ERROR_BLOCK_LEN_ERR /*!< Transferred block length is not allowed for the card or the
286 number of transferred bytes does not match the block length */
287 #define HAL_MMC_ERROR_ERASE_SEQ_ERR SDMMC_ERROR_ERASE_SEQ_ERR /*!< An error in the sequence of erase command occurs */
288 #define HAL_MMC_ERROR_BAD_ERASE_PARAM SDMMC_ERROR_BAD_ERASE_PARAM /*!< An invalid selection for erase groups */
289 #define HAL_MMC_ERROR_WRITE_PROT_VIOLATION SDMMC_ERROR_WRITE_PROT_VIOLATION /*!< Attempt to program a write protect block */
290 #define HAL_MMC_ERROR_LOCK_UNLOCK_FAILED SDMMC_ERROR_LOCK_UNLOCK_FAILED /*!< Sequence or password error has been detected in unlock
291 command or if there was an attempt to access a locked card */
292 #define HAL_MMC_ERROR_COM_CRC_FAILED SDMMC_ERROR_COM_CRC_FAILED /*!< CRC check of the previous command failed */
293 #define HAL_MMC_ERROR_ILLEGAL_CMD SDMMC_ERROR_ILLEGAL_CMD /*!< Command is not legal for the card state */
294 #define HAL_MMC_ERROR_CARD_ECC_FAILED SDMMC_ERROR_CARD_ECC_FAILED /*!< Card internal ECC was applied but failed to correct the data */
295 #define HAL_MMC_ERROR_CC_ERR SDMMC_ERROR_CC_ERR /*!< Internal card controller error */
296 #define HAL_MMC_ERROR_GENERAL_UNKNOWN_ERR SDMMC_ERROR_GENERAL_UNKNOWN_ERR /*!< General or unknown error */
297 #define HAL_MMC_ERROR_STREAM_READ_UNDERRUN SDMMC_ERROR_STREAM_READ_UNDERRUN /*!< The card could not sustain data reading in stream rmode */
298 #define HAL_MMC_ERROR_STREAM_WRITE_OVERRUN SDMMC_ERROR_STREAM_WRITE_OVERRUN /*!< The card could not sustain data programming in stream mode */
299 #define HAL_MMC_ERROR_CID_CSD_OVERWRITE SDMMC_ERROR_CID_CSD_OVERWRITE /*!< CID/CSD overwrite error */
300 #define HAL_MMC_ERROR_WP_ERASE_SKIP SDMMC_ERROR_WP_ERASE_SKIP /*!< Only partial address space was erased */
301 #define HAL_MMC_ERROR_CARD_ECC_DISABLED SDMMC_ERROR_CARD_ECC_DISABLED /*!< Command has been executed without using internal ECC */
302 #define HAL_MMC_ERROR_ERASE_RESET SDMMC_ERROR_ERASE_RESET /*!< Erase sequence was cleared before executing because an out
303 of erase sequence command was received */
304 #define HAL_MMC_ERROR_AKE_SEQ_ERR SDMMC_ERROR_AKE_SEQ_ERR /*!< Error in sequence of authentication */
305 #define HAL_MMC_ERROR_INVALID_VOLTRANGE SDMMC_ERROR_INVALID_VOLTRANGE /*!< Error in case of invalid voltage range */
306 #define HAL_MMC_ERROR_ADDR_OUT_OF_RANGE SDMMC_ERROR_ADDR_OUT_OF_RANGE /*!< Error when addressed block is out of range */
307 #define HAL_MMC_ERROR_REQUEST_NOT_APPLICABLE SDMMC_ERROR_REQUEST_NOT_APPLICABLE /*!< Error when command request is not applicable */
308 #define HAL_MMC_ERROR_PARAM SDMMC_ERROR_INVALID_PARAMETER /*!< the used parameter is not valid */
309 #define HAL_MMC_ERROR_UNSUPPORTED_FEATURE SDMMC_ERROR_UNSUPPORTED_FEATURE /*!< Error when feature is not insupported */
310 #define HAL_MMC_ERROR_BUSY SDMMC_ERROR_BUSY /*!< Error when transfer process is busy */
311 #define HAL_MMC_ERROR_DMA SDMMC_ERROR_DMA /*!< Error while DMA transfer */
312 #define HAL_MMC_ERROR_TIMEOUT SDMMC_ERROR_TIMEOUT /*!< Timeout error */
314 #if defined (USE_HAL_MMC_REGISTER_CALLBACKS) && (USE_HAL_MMC_REGISTER_CALLBACKS == 1U)
315 #define HAL_MMC_ERROR_INVALID_CALLBACK SDMMC_ERROR_INVALID_PARAMETER /*!< Invalid callback error */
316 #endif
318 * @}
321 /** @defgroup MMC_Exported_Constansts_Group2 MMC context enumeration
322 * @{
324 #define MMC_CONTEXT_NONE ((uint32_t)0x00000000U) /*!< None */
325 #define MMC_CONTEXT_READ_SINGLE_BLOCK ((uint32_t)0x00000001U) /*!< Read single block operation */
326 #define MMC_CONTEXT_READ_MULTIPLE_BLOCK ((uint32_t)0x00000002U) /*!< Read multiple blocks operation */
327 #define MMC_CONTEXT_WRITE_SINGLE_BLOCK ((uint32_t)0x00000010U) /*!< Write single block operation */
328 #define MMC_CONTEXT_WRITE_MULTIPLE_BLOCK ((uint32_t)0x00000020U) /*!< Write multiple blocks operation */
329 #define MMC_CONTEXT_IT ((uint32_t)0x00000008U) /*!< Process in Interrupt mode */
330 #define MMC_CONTEXT_DMA ((uint32_t)0x00000080U) /*!< Process in DMA mode */
333 * @}
336 /** @defgroup MMC_Exported_Constansts_Group3 MMC Voltage mode
337 * @{
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_LOW_CAPACITY_CARD ((uint32_t)0x00000000U) /*!< MMC Card Capacity <=2Gbytes */
355 #define MMC_HIGH_CAPACITY_CARD ((uint32_t)0x00000001U) /*!< MMC Card Capacity >2Gbytes and <2Tbytes */
358 * @}
361 /** @defgroup MMC_Exported_Constansts_Group5 MMC Erase Type
362 * @{
364 #define HAL_MMC_ERASE 0x00000000U /*!< Erase the erase groups identified by CMD35 & 36 */
365 #define HAL_MMC_TRIM 0x00000001U /*!< Erase the write blocks identified by CMD35 & 36 */
366 #define HAL_MMC_DISCARD 0x00000003U /*!< Discard the write blocks identified by CMD35 & 36 */
367 #define HAL_MMC_SECURE_ERASE 0x80000000U /*!< Perform a secure purge according SRT on the erase groups identified by CMD35 & 36 */
368 #define HAL_MMC_SECURE_TRIM_STEP1 0x80000001U /*!< Mark the write blocks identified by CMD35 & 36 for secure erase */
369 #define HAL_MMC_SECURE_TRIM_STEP2 0x80008000U /*!< Perform a secure purge according SRT on the write blocks previously identified */
371 #define IS_MMC_ERASE_TYPE(TYPE) (((TYPE) == HAL_MMC_ERASE) || \
372 ((TYPE) == HAL_MMC_TRIM) || \
373 ((TYPE) == HAL_MMC_DISCARD) || \
374 ((TYPE) == HAL_MMC_SECURE_ERASE) || \
375 ((TYPE) == HAL_MMC_SECURE_TRIM_STEP1) || \
376 ((TYPE) == HAL_MMC_SECURE_TRIM_STEP2))
378 * @}
381 /** @defgroup MMC_Exported_Constansts_Group6 MMC Secure Removal Type
382 * @{
384 #define HAL_MMC_SRT_ERASE 0x00000001U /*!< Information removed by an erase */
385 #define HAL_MMC_SRT_WRITE_CHAR_ERASE 0x00000002U /*!< Information removed by an overwriting with a character followed by an erase */
386 #define HAL_MMC_SRT_WRITE_CHAR_COMPL_RANDOM 0x00000004U /*!< Information removed by an overwriting with a character, its complement then a random character */
387 #define HAL_MMC_SRT_VENDOR_DEFINED 0x00000008U /*!< Information removed using a vendor defined */
390 #define IS_MMC_SRT_TYPE(TYPE) (((TYPE) == HAL_MMC_SRT_ERASE) || \
391 ((TYPE) == HAL_MMC_SRT_WRITE_CHAR_ERASE) || \
392 ((TYPE) == HAL_MMC_SRT_WRITE_CHAR_COMPL_RANDOM) || \
393 ((TYPE) == HAL_MMC_SRT_VENDOR_DEFINED))
395 * @}
399 * @}
402 /* Exported macro ------------------------------------------------------------*/
403 /** @defgroup MMC_Exported_macros MMC Exported Macros
404 * @brief macros to handle interrupts and specific clock configurations
405 * @{
407 /** @brief Reset MMC handle state.
408 * @param __HANDLE__ MMC Handle.
409 * @retval None
411 #if defined (USE_HAL_MMC_REGISTER_CALLBACKS) && (USE_HAL_MMC_REGISTER_CALLBACKS == 1U)
412 #define __HAL_MMC_RESET_HANDLE_STATE(__HANDLE__) do { \
413 (__HANDLE__)->State = HAL_MMC_STATE_RESET; \
414 (__HANDLE__)->MspInitCallback = NULL; \
415 (__HANDLE__)->MspDeInitCallback = NULL; \
416 } while(0)
417 #else
418 #define __HAL_MMC_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_MMC_STATE_RESET)
419 #endif
422 * @brief Enable the MMC device interrupt.
423 * @param __HANDLE__ MMC Handle.
424 * @param __INTERRUPT__ specifies the SDMMC interrupt sources to be enabled.
425 * This parameter can be one or a combination of the following values:
426 * @arg SDMMC_IT_CCRCFAIL: Command response received (CRC check failed) interrupt
427 * @arg SDMMC_IT_DCRCFAIL: Data block sent/received (CRC check failed) interrupt
428 * @arg SDMMC_IT_CTIMEOUT: Command response timeout interrupt
429 * @arg SDMMC_IT_DTIMEOUT: Data timeout interrupt
430 * @arg SDMMC_IT_TXUNDERR: Transmit FIFO underrun error interrupt
431 * @arg SDMMC_IT_RXOVERR: Received FIFO overrun error interrupt
432 * @arg SDMMC_IT_CMDREND: Command response received (CRC check passed) interrupt
433 * @arg SDMMC_IT_CMDSENT: Command sent (no response required) interrupt
434 * @arg SDMMC_IT_DATAEND: Data end (data counter, DATACOUNT, is zero) interrupt
435 * @arg SDMMC_IT_DHOLD: Data transfer Hold interrupt
436 * @arg SDMMC_IT_DBCKEND: Data block sent/received (CRC check passed) interrupt
437 * @arg SDMMC_IT_DABORT: Data transfer aborted by CMD12 interrupt
438 * @arg SDMMC_IT_TXFIFOHE: Transmit FIFO Half Empty interrupt
439 * @arg SDMMC_IT_RXFIFOHF: Receive FIFO Half Full interrupt
440 * @arg SDMMC_IT_RXFIFOF: Receive FIFO full interrupt
441 * @arg SDMMC_IT_TXFIFOE: Transmit FIFO empty interrupt
442 * @arg SDMMC_IT_BUSYD0END: End of SDMMC_D0 Busy following a CMD response detected interrupt
443 * @arg SDMMC_IT_SDIOIT: SD I/O interrupt received interrupt
444 * @arg SDMMC_IT_ACKFAIL: Boot Acknowledgment received interrupt
445 * @arg SDMMC_IT_ACKTIMEOUT: Boot Acknowledgment timeout interrupt
446 * @arg SDMMC_IT_VSWEND: Voltage switch critical timing section completion interrupt
447 * @arg SDMMC_IT_CKSTOP: SDMMC_CK stopped in Voltage switch procedure interrupt
448 * @arg SDMMC_IT_IDMABTC: IDMA buffer transfer complete interrupt
449 * @retval None
451 #define __HAL_MMC_ENABLE_IT(__HANDLE__, __INTERRUPT__) __SDMMC_ENABLE_IT((__HANDLE__)->Instance, (__INTERRUPT__))
454 * @brief Disable the MMC device interrupt.
455 * @param __HANDLE__ MMC Handle.
456 * @param __INTERRUPT__ specifies the SDMMC interrupt sources to be disabled.
457 * This parameter can be one or a combination of the following values:
458 * @arg SDMMC_IT_CCRCFAIL: Command response received (CRC check failed) interrupt
459 * @arg SDMMC_IT_DCRCFAIL: Data block sent/received (CRC check failed) interrupt
460 * @arg SDMMC_IT_CTIMEOUT: Command response timeout interrupt
461 * @arg SDMMC_IT_DTIMEOUT: Data timeout interrupt
462 * @arg SDMMC_IT_TXUNDERR: Transmit FIFO underrun error interrupt
463 * @arg SDMMC_IT_RXOVERR: Received FIFO overrun error interrupt
464 * @arg SDMMC_IT_CMDREND: Command response received (CRC check passed) interrupt
465 * @arg SDMMC_IT_CMDSENT: Command sent (no response required) interrupt
466 * @arg SDMMC_IT_DATAEND: Data end (data counter, DATACOUNT, is zero) interrupt
467 * @arg SDMMC_IT_DHOLD: Data transfer Hold interrupt
468 * @arg SDMMC_IT_DBCKEND: Data block sent/received (CRC check passed) interrupt
469 * @arg SDMMC_IT_DABORT: Data transfer aborted by CMD12 interrupt
470 * @arg SDMMC_IT_TXFIFOHE: Transmit FIFO Half Empty interrupt
471 * @arg SDMMC_IT_RXFIFOHF: Receive FIFO Half Full interrupt
472 * @arg SDMMC_IT_RXFIFOF: Receive FIFO full interrupt
473 * @arg SDMMC_IT_TXFIFOE: Transmit FIFO empty interrupt
474 * @arg SDMMC_IT_BUSYD0END: End of SDMMC_D0 Busy following a CMD response detected interrupt
475 * @arg SDMMC_IT_SDIOIT: SD I/O interrupt received interrupt
476 * @arg SDMMC_IT_ACKFAIL: Boot Acknowledgment received interrupt
477 * @arg SDMMC_IT_ACKTIMEOUT: Boot Acknowledgment timeout interrupt
478 * @arg SDMMC_IT_VSWEND: Voltage switch critical timing section completion interrupt
479 * @arg SDMMC_IT_CKSTOP: SDMMC_CK stopped in Voltage switch procedure interrupt
480 * @arg SDMMC_IT_IDMABTC: IDMA buffer transfer complete interrupt
481 * @retval None
483 #define __HAL_MMC_DISABLE_IT(__HANDLE__, __INTERRUPT__) __SDMMC_DISABLE_IT((__HANDLE__)->Instance, (__INTERRUPT__))
486 * @brief Check whether the specified MMC flag is set or not.
487 * @param __HANDLE__ MMC Handle.
488 * @param __FLAG__ specifies the flag to check.
489 * This parameter can be one of the following values:
490 * @arg SDMMC_FLAG_CCRCFAIL: Command response received (CRC check failed)
491 * @arg SDMMC_FLAG_DCRCFAIL: Data block sent/received (CRC check failed)
492 * @arg SDMMC_FLAG_CTIMEOUT: Command response timeout
493 * @arg SDMMC_FLAG_DTIMEOUT: Data timeout
494 * @arg SDMMC_FLAG_TXUNDERR: Transmit FIFO underrun error
495 * @arg SDMMC_FLAG_RXOVERR: Received FIFO overrun error
496 * @arg SDMMC_FLAG_CMDREND: Command response received (CRC check passed)
497 * @arg SDMMC_FLAG_CMDSENT: Command sent (no response required)
498 * @arg SDMMC_FLAG_DATAEND: Data end (data counter, DATACOUNT, is zero)
499 * @arg SDMMC_FLAG_DHOLD: Data transfer Hold
500 * @arg SDMMC_FLAG_DBCKEND: Data block sent/received (CRC check passed)
501 * @arg SDMMC_FLAG_DABORT: Data transfer aborted by CMD12
502 * @arg SDMMC_FLAG_DPSMACT: Data path state machine active
503 * @arg SDMMC_FLAG_CPSMACT: Command path state machine active
504 * @arg SDMMC_FLAG_TXFIFOHE: Transmit FIFO Half Empty
505 * @arg SDMMC_FLAG_RXFIFOHF: Receive FIFO Half Full
506 * @arg SDMMC_FLAG_TXFIFOF: Transmit FIFO full
507 * @arg SDMMC_FLAG_RXFIFOF: Receive FIFO full
508 * @arg SDMMC_FLAG_TXFIFOE: Transmit FIFO empty
509 * @arg SDMMC_FLAG_RXFIFOE: Receive FIFO empty
510 * @arg SDMMC_FLAG_BUSYD0: Inverted value of SDMMC_D0 line (Busy)
511 * @arg SDMMC_FLAG_BUSYD0END: End of SDMMC_D0 Busy following a CMD response detected
512 * @arg SDMMC_FLAG_SDIOIT: SD I/O interrupt received
513 * @arg SDMMC_FLAG_ACKFAIL: Boot Acknowledgment received
514 * @arg SDMMC_FLAG_ACKTIMEOUT: Boot Acknowledgment timeout
515 * @arg SDMMC_FLAG_VSWEND: Voltage switch critical timing section completion
516 * @arg SDMMC_FLAG_CKSTOP: SDMMC_CK stopped in Voltage switch procedure
517 * @arg SDMMC_FLAG_IDMATE: IDMA transfer error
518 * @arg SDMMC_FLAG_IDMABTC: IDMA buffer transfer complete
519 * @retval The new state of MMC FLAG (SET or RESET).
521 #define __HAL_MMC_GET_FLAG(__HANDLE__, __FLAG__) __SDMMC_GET_FLAG((__HANDLE__)->Instance, (__FLAG__))
524 * @brief Clear the MMC's pending flags.
525 * @param __HANDLE__ MMC Handle.
526 * @param __FLAG__ specifies the flag to clear.
527 * This parameter can be one or a combination of the following values:
528 * @arg SDMMC_FLAG_CCRCFAIL: Command response received (CRC check failed)
529 * @arg SDMMC_FLAG_DCRCFAIL: Data block sent/received (CRC check failed)
530 * @arg SDMMC_FLAG_CTIMEOUT: Command response timeout
531 * @arg SDMMC_FLAG_DTIMEOUT: Data timeout
532 * @arg SDMMC_FLAG_TXUNDERR: Transmit FIFO underrun error
533 * @arg SDMMC_FLAG_RXOVERR: Received FIFO overrun error
534 * @arg SDMMC_FLAG_CMDREND: Command response received (CRC check passed)
535 * @arg SDMMC_FLAG_CMDSENT: Command sent (no response required)
536 * @arg SDMMC_FLAG_DATAEND: Data end (data counter, DATACOUNT, is zero)
537 * @arg SDMMC_FLAG_DHOLD: Data transfer Hold
538 * @arg SDMMC_FLAG_DBCKEND: Data block sent/received (CRC check passed)
539 * @arg SDMMC_FLAG_DABORT: Data transfer aborted by CMD12
540 * @arg SDMMC_FLAG_BUSYD0END: End of SDMMC_D0 Busy following a CMD response detected
541 * @arg SDMMC_FLAG_SDIOIT: SD I/O interrupt received
542 * @arg SDMMC_FLAG_ACKFAIL: Boot Acknowledgment received
543 * @arg SDMMC_FLAG_ACKTIMEOUT: Boot Acknowledgment timeout
544 * @arg SDMMC_FLAG_VSWEND: Voltage switch critical timing section completion
545 * @arg SDMMC_FLAG_CKSTOP: SDMMC_CK stopped in Voltage switch procedure
546 * @arg SDMMC_FLAG_IDMATE: IDMA transfer error
547 * @arg SDMMC_FLAG_IDMABTC: IDMA buffer transfer complete
548 * @retval None
550 #define __HAL_MMC_CLEAR_FLAG(__HANDLE__, __FLAG__) __SDMMC_CLEAR_FLAG((__HANDLE__)->Instance, (__FLAG__))
553 * @brief Check whether the specified MMC interrupt has occurred or not.
554 * @param __HANDLE__ MMC Handle.
555 * @param __INTERRUPT__ specifies the SDMMC interrupt source to check.
556 * This parameter can be one of the following values:
557 * @arg SDMMC_IT_CCRCFAIL: Command response received (CRC check failed) interrupt
558 * @arg SDMMC_IT_DCRCFAIL: Data block sent/received (CRC check failed) interrupt
559 * @arg SDMMC_IT_CTIMEOUT: Command response timeout interrupt
560 * @arg SDMMC_IT_DTIMEOUT: Data timeout interrupt
561 * @arg SDMMC_IT_TXUNDERR: Transmit FIFO underrun error interrupt
562 * @arg SDMMC_IT_RXOVERR: Received FIFO overrun error interrupt
563 * @arg SDMMC_IT_CMDREND: Command response received (CRC check passed) interrupt
564 * @arg SDMMC_IT_CMDSENT: Command sent (no response required) interrupt
565 * @arg SDMMC_IT_DATAEND: Data end (data counter, DATACOUNT, is zero) interrupt
566 * @arg SDMMC_IT_DHOLD: Data transfer Hold interrupt
567 * @arg SDMMC_IT_DBCKEND: Data block sent/received (CRC check passed) interrupt
568 * @arg SDMMC_IT_DABORT: Data transfer aborted by CMD12 interrupt
569 * @arg SDMMC_IT_TXFIFOHE: Transmit FIFO Half Empty interrupt
570 * @arg SDMMC_IT_RXFIFOHF: Receive FIFO Half Full interrupt
571 * @arg SDMMC_IT_RXFIFOF: Receive FIFO full interrupt
572 * @arg SDMMC_IT_TXFIFOE: Transmit FIFO empty interrupt
573 * @arg SDMMC_IT_BUSYD0END: End of SDMMC_D0 Busy following a CMD response detected interrupt
574 * @arg SDMMC_IT_SDIOIT: SD I/O interrupt received interrupt
575 * @arg SDMMC_IT_ACKFAIL: Boot Acknowledgment received interrupt
576 * @arg SDMMC_IT_ACKTIMEOUT: Boot Acknowledgment timeout interrupt
577 * @arg SDMMC_IT_VSWEND: Voltage switch critical timing section completion interrupt
578 * @arg SDMMC_IT_CKSTOP: SDMMC_CK stopped in Voltage switch procedure interrupt
579 * @arg SDMMC_IT_IDMABTC: IDMA buffer transfer complete interrupt
580 * @retval The new state of MMC IT (SET or RESET).
582 #define __HAL_MMC_GET_IT(__HANDLE__, __INTERRUPT__) __SDMMC_GET_IT((__HANDLE__)->Instance, (__INTERRUPT__))
585 * @brief Clear the MMC's interrupt pending bits.
586 * @param __HANDLE__ MMC Handle.
587 * @param __INTERRUPT__ specifies the interrupt pending bit to clear.
588 * This parameter can be one or a combination of the following values:
589 * @arg SDMMC_IT_CCRCFAIL: Command response received (CRC check failed) interrupt
590 * @arg SDMMC_IT_DCRCFAIL: Data block sent/received (CRC check failed) interrupt
591 * @arg SDMMC_IT_CTIMEOUT: Command response timeout interrupt
592 * @arg SDMMC_IT_DTIMEOUT: Data timeout interrupt
593 * @arg SDMMC_IT_TXUNDERR: Transmit FIFO underrun error interrupt
594 * @arg SDMMC_IT_RXOVERR: Received FIFO overrun error interrupt
595 * @arg SDMMC_IT_CMDREND: Command response received (CRC check passed) interrupt
596 * @arg SDMMC_IT_CMDSENT: Command sent (no response required) interrupt
597 * @arg SDMMC_IT_DATAEND: Data end (data counter, DATACOUNT, is zero) interrupt
598 * @arg SDMMC_IT_DHOLD: Data transfer Hold interrupt
599 * @arg SDMMC_IT_DBCKEND: Data block sent/received (CRC check passed) interrupt
600 * @arg SDMMC_IT_DABORT: Data transfer aborted by CMD12 interrupt
601 * @arg SDMMC_IT_TXFIFOHE: Transmit FIFO Half Empty interrupt
602 * @arg SDMMC_IT_RXFIFOHF: Receive FIFO Half Full interrupt
603 * @arg SDMMC_IT_RXFIFOF: Receive FIFO full interrupt
604 * @arg SDMMC_IT_TXFIFOE: Transmit FIFO empty interrupt
605 * @arg SDMMC_IT_BUSYD0END: End of SDMMC_D0 Busy following a CMD response detected interrupt
606 * @arg SDMMC_IT_SDIOIT: SD I/O interrupt received interrupt
607 * @arg SDMMC_IT_ACKFAIL: Boot Acknowledgment received interrupt
608 * @arg SDMMC_IT_ACKTIMEOUT: Boot Acknowledgment timeout interrupt
609 * @arg SDMMC_IT_VSWEND: Voltage switch critical timing section completion interrupt
610 * @arg SDMMC_IT_CKSTOP: SDMMC_CK stopped in Voltage switch procedure interrupt
611 * @arg SDMMC_IT_IDMABTC: IDMA buffer transfer complete interrupt
612 * @retval None
614 #define __HAL_MMC_CLEAR_IT(__HANDLE__, __INTERRUPT__) __SDMMC_CLEAR_IT((__HANDLE__)->Instance, (__INTERRUPT__))
617 * @}
620 /* Include MMC HAL Extension module */
621 #include "stm32h7xx_hal_mmc_ex.h"
623 /* Exported functions --------------------------------------------------------*/
624 /** @defgroup MMC_Exported_Functions MMC Exported Functions
625 * @{
628 /** @defgroup MMC_Exported_Functions_Group1 Initialization and de-initialization functions
629 * @{
631 HAL_StatusTypeDef HAL_MMC_Init(MMC_HandleTypeDef *hmmc);
632 HAL_StatusTypeDef HAL_MMC_InitCard(MMC_HandleTypeDef *hmmc);
633 HAL_StatusTypeDef HAL_MMC_DeInit (MMC_HandleTypeDef *hmmc);
634 void HAL_MMC_MspInit(MMC_HandleTypeDef *hmmc);
635 void HAL_MMC_MspDeInit(MMC_HandleTypeDef *hmmc);
638 * @}
641 /** @defgroup MMC_Exported_Functions_Group2 Input and Output operation functions
642 * @{
644 /* Blocking mode: Polling */
645 HAL_StatusTypeDef HAL_MMC_ReadBlocks(MMC_HandleTypeDef *hmmc, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks, uint32_t Timeout);
646 HAL_StatusTypeDef HAL_MMC_WriteBlocks(MMC_HandleTypeDef *hmmc, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks, uint32_t Timeout);
647 HAL_StatusTypeDef HAL_MMC_Erase(MMC_HandleTypeDef *hmmc, uint32_t BlockStartAdd, uint32_t BlockEndAdd);
648 /* Non-Blocking mode: IT */
649 HAL_StatusTypeDef HAL_MMC_ReadBlocks_IT(MMC_HandleTypeDef *hmmc, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks);
650 HAL_StatusTypeDef HAL_MMC_WriteBlocks_IT(MMC_HandleTypeDef *hmmc, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks);
651 /* Non-Blocking mode: DMA */
652 HAL_StatusTypeDef HAL_MMC_ReadBlocks_DMA(MMC_HandleTypeDef *hmmc, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks);
653 HAL_StatusTypeDef HAL_MMC_WriteBlocks_DMA(MMC_HandleTypeDef *hmmc, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks);
655 void HAL_MMC_IRQHandler(MMC_HandleTypeDef *hmmc);
657 /* Callback in non blocking modes (DMA) */
658 void HAL_MMC_TxCpltCallback(MMC_HandleTypeDef *hmmc);
659 void HAL_MMC_RxCpltCallback(MMC_HandleTypeDef *hmmc);
660 void HAL_MMC_ErrorCallback(MMC_HandleTypeDef *hmmc);
661 void HAL_MMC_AbortCallback(MMC_HandleTypeDef *hmmc);
663 #if defined (USE_HAL_MMC_REGISTER_CALLBACKS) && (USE_HAL_MMC_REGISTER_CALLBACKS == 1U)
664 /* MMC callback registering/unregistering */
665 HAL_StatusTypeDef HAL_MMC_RegisterCallback (MMC_HandleTypeDef *hmmc, HAL_MMC_CallbackIDTypeDef CallbackId, pMMC_CallbackTypeDef pCallback);
666 HAL_StatusTypeDef HAL_MMC_UnRegisterCallback(MMC_HandleTypeDef *hmmc, HAL_MMC_CallbackIDTypeDef CallbackId);
667 #endif
669 * @}
672 /** @defgroup MMC_Exported_Functions_Group3 Peripheral Control functions
673 * @{
675 HAL_StatusTypeDef HAL_MMC_ConfigWideBusOperation(MMC_HandleTypeDef *hmmc, uint32_t WideMode);
676 HAL_StatusTypeDef HAL_MMC_ConfigSpeedBusOperation(MMC_HandleTypeDef *hmmc, uint32_t SpeedMode);
678 * @}
681 /** @defgroup MMC_Exported_Functions_Group4 MMC card related functions
682 * @{
684 HAL_MMC_CardStateTypeDef HAL_MMC_GetCardState(MMC_HandleTypeDef *hmmc);
685 HAL_StatusTypeDef HAL_MMC_GetCardCID(MMC_HandleTypeDef *hmmc, HAL_MMC_CardCIDTypeDef *pCID);
686 HAL_StatusTypeDef HAL_MMC_GetCardCSD(MMC_HandleTypeDef *hmmc, HAL_MMC_CardCSDTypeDef *pCSD);
687 HAL_StatusTypeDef HAL_MMC_GetCardInfo(MMC_HandleTypeDef *hmmc, HAL_MMC_CardInfoTypeDef *pCardInfo);
689 * @}
692 /** @defgroup MMC_Exported_Functions_Group5 Peripheral State and Errors functions
693 * @{
695 HAL_MMC_StateTypeDef HAL_MMC_GetState(MMC_HandleTypeDef *hmmc);
696 uint32_t HAL_MMC_GetError(MMC_HandleTypeDef *hmmc);
698 * @}
701 /** @defgroup MMC_Exported_Functions_Group6 Peripheral Abort management
702 * @{
704 HAL_StatusTypeDef HAL_MMC_Abort(MMC_HandleTypeDef *hmmc);
705 HAL_StatusTypeDef HAL_MMC_Abort_IT(MMC_HandleTypeDef *hmmc);
707 * @}
710 /** @defgroup MMC_Exported_Functions_Group7 Peripheral Erase management
711 * @{
713 HAL_StatusTypeDef HAL_MMC_EraseSequence(MMC_HandleTypeDef *hmmc, uint32_t EraseType, uint32_t BlockStartAdd, uint32_t BlockEndAdd);
714 HAL_StatusTypeDef HAL_MMC_Sanitize(MMC_HandleTypeDef *hmmc);
715 HAL_StatusTypeDef HAL_MMC_ConfigSecRemovalType(MMC_HandleTypeDef *hmmc, uint32_t SRTMode);
716 HAL_StatusTypeDef HAL_MMC_GetSupportedSecRemovalType(MMC_HandleTypeDef *hmmc, uint32_t *SupportedSRT);
718 * @}
721 /* Private types -------------------------------------------------------------*/
722 /** @defgroup MMC_Private_Types MMC Private Types
723 * @{
727 * @}
730 /* Private defines -----------------------------------------------------------*/
731 /** @defgroup MMC_Private_Defines MMC Private Defines
732 * @{
736 * @}
739 /* Private variables ---------------------------------------------------------*/
740 /** @defgroup MMC_Private_Variables MMC Private Variables
741 * @{
745 * @}
748 /* Private constants ---------------------------------------------------------*/
749 /** @defgroup MMC_Private_Constants MMC Private Constants
750 * @{
754 * @}
757 /* Private macros ------------------------------------------------------------*/
758 /** @defgroup MMC_Private_Macros MMC Private Macros
759 * @{
763 * @}
766 /* Private functions prototypes ----------------------------------------------*/
767 /** @defgroup MMC_Private_Functions_Prototypes MMC Private Functions Prototypes
768 * @{
772 * @}
775 /* Private functions ---------------------------------------------------------*/
776 /** @defgroup MMC_Private_Functions MMC Private Functions
777 * @{
781 * @}
786 * @}
790 * @}
794 * @}
797 #ifdef __cplusplus
799 #endif
802 #endif /* STM32H7xx_HAL_MMC_H */
804 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/