Merge pull request #11270 from haslinghuis/rename_attr
[betaflight.git] / lib / main / STM32H7 / Drivers / STM32H7xx_HAL_Driver / Inc / stm32h7xx_hal_sd.h
blobdd06788c8c0af4b1791da5148d337507fbfcbc43
1 /**
2 ******************************************************************************
3 * @file stm32h7xx_hal_sd.h
4 * @author MCD Application Team
5 * @brief Header file of SD 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 ******************************************************************************
20 /* Define to prevent recursive inclusion -------------------------------------*/
21 #ifndef STM32H7xx_HAL_SD_H
22 #define STM32H7xx_HAL_SD_H
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
28 /* Includes ------------------------------------------------------------------*/
29 #include "stm32h7xx_ll_sdmmc.h"
30 #if defined (DLYB_SDMMC1) || defined (DLYB_SDMMC2) || defined (DLYB_SDMMC3)
31 #include "stm32h7xx_ll_delayblock.h"
32 #endif /* (DLYB_SDMMC1) || (DLYB_SDMMC2) */
34 /** @addtogroup STM32H7xx_HAL_Driver
35 * @{
38 /** @defgroup SD SD
39 * @brief SD HAL module driver
40 * @{
43 /* Exported types ------------------------------------------------------------*/
44 /** @defgroup SD_Exported_Types SD Exported Types
45 * @{
48 /** @defgroup SD_Exported_Types_Group1 SD State enumeration structure
49 * @{
51 typedef enum
53 HAL_SD_STATE_RESET = ((uint32_t)0x00000000U), /*!< SD not yet initialized or disabled */
54 HAL_SD_STATE_READY = ((uint32_t)0x00000001U), /*!< SD initialized and ready for use */
55 HAL_SD_STATE_TIMEOUT = ((uint32_t)0x00000002U), /*!< SD Timeout state */
56 HAL_SD_STATE_BUSY = ((uint32_t)0x00000003U), /*!< SD process ongoing */
57 HAL_SD_STATE_PROGRAMMING = ((uint32_t)0x00000004U), /*!< SD Programming State */
58 HAL_SD_STATE_RECEIVING = ((uint32_t)0x00000005U), /*!< SD Receiving State */
59 HAL_SD_STATE_TRANSFER = ((uint32_t)0x00000006U), /*!< SD Transfert State */
60 HAL_SD_STATE_ERROR = ((uint32_t)0x0000000FU) /*!< SD is in error state */
61 }HAL_SD_StateTypeDef;
62 /**
63 * @}
66 /** @defgroup SD_Exported_Types_Group2 SD Card State enumeration structure
67 * @{
69 typedef uint32_t HAL_SD_CardStateTypeDef;
71 #define HAL_SD_CARD_READY 0x00000001U /*!< Card state is ready */
72 #define HAL_SD_CARD_IDENTIFICATION 0x00000002U /*!< Card is in identification state */
73 #define HAL_SD_CARD_STANDBY 0x00000003U /*!< Card is in standby state */
74 #define HAL_SD_CARD_TRANSFER 0x00000004U /*!< Card is in transfer state */
75 #define HAL_SD_CARD_SENDING 0x00000005U /*!< Card is sending an operation */
76 #define HAL_SD_CARD_RECEIVING 0x00000006U /*!< Card is receiving operation information */
77 #define HAL_SD_CARD_PROGRAMMING 0x00000007U /*!< Card is in programming state */
78 #define HAL_SD_CARD_DISCONNECTED 0x00000008U /*!< Card is disconnected */
79 #define HAL_SD_CARD_ERROR 0x000000FFU /*!< Card response Error */
80 /**
81 * @}
84 /** @defgroup SD_Exported_Types_Group3 SD Handle Structure definition
85 * @{
87 #define SD_InitTypeDef SDMMC_InitTypeDef
88 #define SD_TypeDef SDMMC_TypeDef
90 /**
91 * @brief SD Card Information Structure definition
93 typedef struct
95 uint32_t CardType; /*!< Specifies the card Type */
97 uint32_t CardVersion; /*!< Specifies the card version */
99 uint32_t Class; /*!< Specifies the class of the card class */
101 uint32_t RelCardAdd; /*!< Specifies the Relative Card Address */
103 uint32_t BlockNbr; /*!< Specifies the Card Capacity in blocks */
105 uint32_t BlockSize; /*!< Specifies one block size in bytes */
107 uint32_t LogBlockNbr; /*!< Specifies the Card logical Capacity in blocks */
109 uint32_t LogBlockSize; /*!< Specifies logical block size in bytes */
111 uint32_t CardSpeed; /*!< Specifies the card Speed */
113 }HAL_SD_CardInfoTypeDef;
116 * @brief SD handle Structure definition
118 #if defined (USE_HAL_SD_REGISTER_CALLBACKS) && (USE_HAL_SD_REGISTER_CALLBACKS == 1U)
119 typedef struct __SD_HandleTypeDef
120 #else
121 typedef struct
122 #endif /* USE_HAL_SD_REGISTER_CALLBACKS */
124 SD_TypeDef *Instance; /*!< SD registers base address */
126 SD_InitTypeDef Init; /*!< SD required parameters */
128 HAL_LockTypeDef Lock; /*!< SD locking object */
130 uint8_t *pTxBuffPtr; /*!< Pointer to SD Tx transfer Buffer */
132 uint32_t TxXferSize; /*!< SD Tx Transfer size */
134 uint8_t *pRxBuffPtr; /*!< Pointer to SD Rx transfer Buffer */
136 uint32_t RxXferSize; /*!< SD Rx Transfer size */
138 __IO uint32_t Context; /*!< SD transfer context */
140 __IO HAL_SD_StateTypeDef State; /*!< SD card State */
142 __IO uint32_t ErrorCode; /*!< SD Card Error codes */
144 HAL_SD_CardInfoTypeDef SdCard; /*!< SD Card information */
146 uint32_t CSD[4]; /*!< SD card specific data table */
148 uint32_t CID[4]; /*!< SD card identification number table */
150 #if defined (USE_HAL_SD_REGISTER_CALLBACKS) && (USE_HAL_SD_REGISTER_CALLBACKS == 1U)
151 void (* TxCpltCallback) (struct __SD_HandleTypeDef *hsd);
152 void (* RxCpltCallback) (struct __SD_HandleTypeDef *hsd);
153 void (* ErrorCallback) (struct __SD_HandleTypeDef *hsd);
154 void (* AbortCpltCallback) (struct __SD_HandleTypeDef *hsd);
155 void (* Read_DMADblBuf0CpltCallback) (struct __SD_HandleTypeDef *hsd);
156 void (* Read_DMADblBuf1CpltCallback) (struct __SD_HandleTypeDef *hsd);
157 void (* Write_DMADblBuf0CpltCallback) (struct __SD_HandleTypeDef *hsd);
158 void (* Write_DMADblBuf1CpltCallback) (struct __SD_HandleTypeDef *hsd);
159 #if (USE_SD_TRANSCEIVER != 0U)
160 void (* DriveTransceiver_1_8V_Callback) (FlagStatus status);
161 #endif /* USE_SD_TRANSCEIVER */
163 void (* MspInitCallback) (struct __SD_HandleTypeDef *hsd);
164 void (* MspDeInitCallback) (struct __SD_HandleTypeDef *hsd);
165 #endif /* USE_HAL_SD_REGISTER_CALLBACKS */
166 }SD_HandleTypeDef;
169 * @}
172 /** @defgroup SD_Exported_Types_Group4 Card Specific Data: CSD Register
173 * @{
175 typedef struct
177 __IO uint8_t CSDStruct; /*!< CSD structure */
178 __IO uint8_t SysSpecVersion; /*!< System specification version */
179 __IO uint8_t Reserved1; /*!< Reserved */
180 __IO uint8_t TAAC; /*!< Data read access time 1 */
181 __IO uint8_t NSAC; /*!< Data read access time 2 in CLK cycles */
182 __IO uint8_t MaxBusClkFrec; /*!< Max. bus clock frequency */
183 __IO uint16_t CardComdClasses; /*!< Card command classes */
184 __IO uint8_t RdBlockLen; /*!< Max. read data block length */
185 __IO uint8_t PartBlockRead; /*!< Partial blocks for read allowed */
186 __IO uint8_t WrBlockMisalign; /*!< Write block misalignment */
187 __IO uint8_t RdBlockMisalign; /*!< Read block misalignment */
188 __IO uint8_t DSRImpl; /*!< DSR implemented */
189 __IO uint8_t Reserved2; /*!< Reserved */
190 __IO uint32_t DeviceSize; /*!< Device Size */
191 __IO uint8_t MaxRdCurrentVDDMin; /*!< Max. read current @ VDD min */
192 __IO uint8_t MaxRdCurrentVDDMax; /*!< Max. read current @ VDD max */
193 __IO uint8_t MaxWrCurrentVDDMin; /*!< Max. write current @ VDD min */
194 __IO uint8_t MaxWrCurrentVDDMax; /*!< Max. write current @ VDD max */
195 __IO uint8_t DeviceSizeMul; /*!< Device size multiplier */
196 __IO uint8_t EraseGrSize; /*!< Erase group size */
197 __IO uint8_t EraseGrMul; /*!< Erase group size multiplier */
198 __IO uint8_t WrProtectGrSize; /*!< Write protect group size */
199 __IO uint8_t WrProtectGrEnable; /*!< Write protect group enable */
200 __IO uint8_t ManDeflECC; /*!< Manufacturer default ECC */
201 __IO uint8_t WrSpeedFact; /*!< Write speed factor */
202 __IO uint8_t MaxWrBlockLen; /*!< Max. write data block length */
203 __IO uint8_t WriteBlockPaPartial; /*!< Partial blocks for write allowed */
204 __IO uint8_t Reserved3; /*!< Reserved */
205 __IO uint8_t ContentProtectAppli; /*!< Content protection application */
206 __IO uint8_t FileFormatGroup; /*!< File format group */
207 __IO uint8_t CopyFlag; /*!< Copy flag (OTP) */
208 __IO uint8_t PermWrProtect; /*!< Permanent write protection */
209 __IO uint8_t TempWrProtect; /*!< Temporary write protection */
210 __IO uint8_t FileFormat; /*!< File format */
211 __IO uint8_t ECC; /*!< ECC code */
212 __IO uint8_t CSD_CRC; /*!< CSD CRC */
213 __IO uint8_t Reserved4; /*!< Always 1 */
214 }HAL_SD_CardCSDTypeDef;
216 * @}
219 /** @defgroup SD_Exported_Types_Group5 Card Identification Data: CID Register
220 * @{
222 typedef struct
224 __IO uint8_t ManufacturerID; /*!< Manufacturer ID */
225 __IO uint16_t OEM_AppliID; /*!< OEM/Application ID */
226 __IO uint32_t ProdName1; /*!< Product Name part1 */
227 __IO uint8_t ProdName2; /*!< Product Name part2 */
228 __IO uint8_t ProdRev; /*!< Product Revision */
229 __IO uint32_t ProdSN; /*!< Product Serial Number */
230 __IO uint8_t Reserved1; /*!< Reserved1 */
231 __IO uint16_t ManufactDate; /*!< Manufacturing Date */
232 __IO uint8_t CID_CRC; /*!< CID CRC */
233 __IO uint8_t Reserved2; /*!< Always 1 */
235 }HAL_SD_CardCIDTypeDef;
237 * @}
240 /** @defgroup SD_Exported_Types_Group6 SD Card Status returned by ACMD13
241 * @{
243 typedef struct
245 __IO uint8_t DataBusWidth; /*!< Shows the currently defined data bus width */
246 __IO uint8_t SecuredMode; /*!< Card is in secured mode of operation */
247 __IO uint16_t CardType; /*!< Carries information about card type */
248 __IO uint32_t ProtectedAreaSize; /*!< Carries information about the capacity of protected area */
249 __IO uint8_t SpeedClass; /*!< Carries information about the speed class of the card */
250 __IO uint8_t PerformanceMove; /*!< Carries information about the card's performance move */
251 __IO uint8_t AllocationUnitSize; /*!< Carries information about the card's allocation unit size */
252 __IO uint16_t EraseSize; /*!< Determines the number of AUs to be erased in one operation */
253 __IO uint8_t EraseTimeout; /*!< Determines the timeout for any number of AU erase */
254 __IO uint8_t EraseOffset; /*!< Carries information about the erase offset */
255 __IO uint8_t UhsSpeedGrade; /*!< Carries information about the speed grade of UHS card */
256 __IO uint8_t UhsAllocationUnitSize; /*!< Carries information about the UHS card's allocation unit size */
257 __IO uint8_t VideoSpeedClass; /*!< Carries information about the Video Speed Class of UHS card */
258 }HAL_SD_CardStatusTypeDef;
260 * @}
263 #if defined (USE_HAL_SD_REGISTER_CALLBACKS) && (USE_HAL_SD_REGISTER_CALLBACKS == 1U)
264 /** @defgroup SD_Exported_Types_Group7 SD Callback ID enumeration definition
265 * @{
267 typedef enum
269 HAL_SD_TX_CPLT_CB_ID = 0x00U, /*!< SD Tx Complete Callback ID */
270 HAL_SD_RX_CPLT_CB_ID = 0x01U, /*!< SD Rx Complete Callback ID */
271 HAL_SD_ERROR_CB_ID = 0x02U, /*!< SD Error Callback ID */
272 HAL_SD_ABORT_CB_ID = 0x03U, /*!< SD Abort Callback ID */
273 HAL_SD_READ_DMA_DBL_BUF0_CPLT_CB_ID = 0x04U, /*!< SD Rx DMA Double Buffer 0 Complete Callback ID */
274 HAL_SD_READ_DMA_DBL_BUF1_CPLT_CB_ID = 0x05U, /*!< SD Rx DMA Double Buffer 1 Complete Callback ID */
275 HAL_SD_WRITE_DMA_DBL_BUF0_CPLT_CB_ID = 0x06U, /*!< SD Tx DMA Double Buffer 0 Complete Callback ID */
276 HAL_SD_WRITE_DMA_DBL_BUF1_CPLT_CB_ID = 0x07U, /*!< SD Tx DMA Double Buffer 1 Complete Callback ID */
278 HAL_SD_MSP_INIT_CB_ID = 0x10U, /*!< SD MspInit Callback ID */
279 HAL_SD_MSP_DEINIT_CB_ID = 0x11U /*!< SD MspDeInit Callback ID */
280 }HAL_SD_CallbackIDTypeDef;
282 * @}
285 /** @defgroup SD_Exported_Types_Group8 SD Callback pointer definition
286 * @{
288 typedef void (*pSD_CallbackTypeDef) (SD_HandleTypeDef *hsd);
289 #if (USE_SD_TRANSCEIVER != 0U)
290 typedef void (*pSD_TransceiverCallbackTypeDef)(FlagStatus status);
291 #endif /* USE_SD_TRANSCEIVER */
293 * @}
295 #endif /* USE_HAL_SD_REGISTER_CALLBACKS */
297 * @}
300 /* Exported constants --------------------------------------------------------*/
301 /** @defgroup SD_Exported_Constants Exported Constants
302 * @{
305 #define BLOCKSIZE ((uint32_t)512U) /*!< Block size is 512 bytes */
307 /** @defgroup SD_Exported_Constansts_Group1 SD Error status enumeration Structure definition
308 * @{
310 #define HAL_SD_ERROR_NONE SDMMC_ERROR_NONE /*!< No error */
311 #define HAL_SD_ERROR_CMD_CRC_FAIL SDMMC_ERROR_CMD_CRC_FAIL /*!< Command response received (but CRC check failed) */
312 #define HAL_SD_ERROR_DATA_CRC_FAIL SDMMC_ERROR_DATA_CRC_FAIL /*!< Data block sent/received (CRC check failed) */
313 #define HAL_SD_ERROR_CMD_RSP_TIMEOUT SDMMC_ERROR_CMD_RSP_TIMEOUT /*!< Command response timeout */
314 #define HAL_SD_ERROR_DATA_TIMEOUT SDMMC_ERROR_DATA_TIMEOUT /*!< Data timeout */
315 #define HAL_SD_ERROR_TX_UNDERRUN SDMMC_ERROR_TX_UNDERRUN /*!< Transmit FIFO underrun */
316 #define HAL_SD_ERROR_RX_OVERRUN SDMMC_ERROR_RX_OVERRUN /*!< Receive FIFO overrun */
317 #define HAL_SD_ERROR_ADDR_MISALIGNED SDMMC_ERROR_ADDR_MISALIGNED /*!< Misaligned address */
318 #define HAL_SD_ERROR_BLOCK_LEN_ERR SDMMC_ERROR_BLOCK_LEN_ERR /*!< Transferred block length is not allowed for the card or the
319 number of transferred bytes does not match the block length */
320 #define HAL_SD_ERROR_ERASE_SEQ_ERR SDMMC_ERROR_ERASE_SEQ_ERR /*!< An error in the sequence of erase command occurs */
321 #define HAL_SD_ERROR_BAD_ERASE_PARAM SDMMC_ERROR_BAD_ERASE_PARAM /*!< An invalid selection for erase groups */
322 #define HAL_SD_ERROR_WRITE_PROT_VIOLATION SDMMC_ERROR_WRITE_PROT_VIOLATION /*!< Attempt to program a write protect block */
323 #define HAL_SD_ERROR_LOCK_UNLOCK_FAILED SDMMC_ERROR_LOCK_UNLOCK_FAILED /*!< Sequence or password error has been detected in unlock
324 command or if there was an attempt to access a locked card */
325 #define HAL_SD_ERROR_COM_CRC_FAILED SDMMC_ERROR_COM_CRC_FAILED /*!< CRC check of the previous command failed */
326 #define HAL_SD_ERROR_ILLEGAL_CMD SDMMC_ERROR_ILLEGAL_CMD /*!< Command is not legal for the card state */
327 #define HAL_SD_ERROR_CARD_ECC_FAILED SDMMC_ERROR_CARD_ECC_FAILED /*!< Card internal ECC was applied but failed to correct the data */
328 #define HAL_SD_ERROR_CC_ERR SDMMC_ERROR_CC_ERR /*!< Internal card controller error */
329 #define HAL_SD_ERROR_GENERAL_UNKNOWN_ERR SDMMC_ERROR_GENERAL_UNKNOWN_ERR /*!< General or unknown error */
330 #define HAL_SD_ERROR_STREAM_READ_UNDERRUN SDMMC_ERROR_STREAM_READ_UNDERRUN /*!< The card could not sustain data reading in stream rmode */
331 #define HAL_SD_ERROR_STREAM_WRITE_OVERRUN SDMMC_ERROR_STREAM_WRITE_OVERRUN /*!< The card could not sustain data programming in stream mode */
332 #define HAL_SD_ERROR_CID_CSD_OVERWRITE SDMMC_ERROR_CID_CSD_OVERWRITE /*!< CID/CSD overwrite error */
333 #define HAL_SD_ERROR_WP_ERASE_SKIP SDMMC_ERROR_WP_ERASE_SKIP /*!< Only partial address space was erased */
334 #define HAL_SD_ERROR_CARD_ECC_DISABLED SDMMC_ERROR_CARD_ECC_DISABLED /*!< Command has been executed without using internal ECC */
335 #define HAL_SD_ERROR_ERASE_RESET SDMMC_ERROR_ERASE_RESET /*!< Erase sequence was cleared before executing because an out
336 of erase sequence command was received */
337 #define HAL_SD_ERROR_AKE_SEQ_ERR SDMMC_ERROR_AKE_SEQ_ERR /*!< Error in sequence of authentication */
338 #define HAL_SD_ERROR_INVALID_VOLTRANGE SDMMC_ERROR_INVALID_VOLTRANGE /*!< Error in case of invalid voltage range */
339 #define HAL_SD_ERROR_ADDR_OUT_OF_RANGE SDMMC_ERROR_ADDR_OUT_OF_RANGE /*!< Error when addressed block is out of range */
340 #define HAL_SD_ERROR_REQUEST_NOT_APPLICABLE SDMMC_ERROR_REQUEST_NOT_APPLICABLE /*!< Error when command request is not applicable */
341 #define HAL_SD_ERROR_PARAM SDMMC_ERROR_INVALID_PARAMETER /*!< the used parameter is not valid */
342 #define HAL_SD_ERROR_UNSUPPORTED_FEATURE SDMMC_ERROR_UNSUPPORTED_FEATURE /*!< Error when feature is not insupported */
343 #define HAL_SD_ERROR_BUSY SDMMC_ERROR_BUSY /*!< Error when transfer process is busy */
344 #define HAL_SD_ERROR_DMA SDMMC_ERROR_DMA /*!< Error while DMA transfer */
345 #define HAL_SD_ERROR_TIMEOUT SDMMC_ERROR_TIMEOUT /*!< Timeout error */
347 #if defined (USE_HAL_SD_REGISTER_CALLBACKS) && (USE_HAL_SD_REGISTER_CALLBACKS == 1U)
348 #define HAL_SD_ERROR_INVALID_CALLBACK SDMMC_ERROR_INVALID_PARAMETER /*!< Invalid callback error */
349 #endif /* USE_HAL_SD_REGISTER_CALLBACKS */
351 * @}
354 /** @defgroup SD_Exported_Constansts_Group2 SD context enumeration
355 * @{
357 #define SD_CONTEXT_NONE ((uint32_t)0x00000000U) /*!< None */
358 #define SD_CONTEXT_READ_SINGLE_BLOCK ((uint32_t)0x00000001U) /*!< Read single block operation */
359 #define SD_CONTEXT_READ_MULTIPLE_BLOCK ((uint32_t)0x00000002U) /*!< Read multiple blocks operation */
360 #define SD_CONTEXT_WRITE_SINGLE_BLOCK ((uint32_t)0x00000010U) /*!< Write single block operation */
361 #define SD_CONTEXT_WRITE_MULTIPLE_BLOCK ((uint32_t)0x00000020U) /*!< Write multiple blocks operation */
362 #define SD_CONTEXT_IT ((uint32_t)0x00000008U) /*!< Process in Interrupt mode */
363 #define SD_CONTEXT_DMA ((uint32_t)0x00000080U) /*!< Process in DMA mode */
366 * @}
369 /** @defgroup SD_Exported_Constansts_Group3 SD Supported Memory Cards
370 * @{
372 #define CARD_NORMAL_SPEED ((uint32_t)0x00000000U) /*!< Normal Speed Card <12.5Mo/s , Spec Version 1.01 */
373 #define CARD_HIGH_SPEED ((uint32_t)0x00000100U) /*!< High Speed Card <25Mo/s , Spec version 2.00 */
374 #define CARD_ULTRA_HIGH_SPEED ((uint32_t)0x00000200U) /*!< UHS-I SD Card <50Mo/s for SDR50, DDR5 Cards
375 and <104Mo/s for SDR104, Spec version 3.01 */
377 #define CARD_SDSC ((uint32_t)0x00000000U) /*!< SD Standard Capacity <2Go */
378 #define CARD_SDHC_SDXC ((uint32_t)0x00000001U) /*!< SD High Capacity <32Go, SD Extended Capacity <2To */
379 #define CARD_SECURED ((uint32_t)0x00000003U)
382 * @}
385 /** @defgroup SD_Exported_Constansts_Group4 SD Supported Version
386 * @{
388 #define CARD_V1_X ((uint32_t)0x00000000U)
389 #define CARD_V2_X ((uint32_t)0x00000001U)
391 * @}
395 * @}
398 /* Exported macro ------------------------------------------------------------*/
399 /** @defgroup SD_Exported_macros SD Exported Macros
400 * @brief macros to handle interrupts and specific clock configurations
401 * @{
403 /** @brief Reset SD handle state.
404 * @param __HANDLE__ SD Handle.
405 * @retval None
407 #if defined (USE_HAL_SD_REGISTER_CALLBACKS) && (USE_HAL_SD_REGISTER_CALLBACKS == 1U)
408 #define __HAL_SD_RESET_HANDLE_STATE(__HANDLE__) do { \
409 (__HANDLE__)->State = HAL_SD_STATE_RESET; \
410 (__HANDLE__)->MspInitCallback = NULL; \
411 (__HANDLE__)->MspDeInitCallback = NULL; \
412 } while(0)
413 #else
414 #define __HAL_SD_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_SD_STATE_RESET)
415 #endif /* USE_HAL_SD_REGISTER_CALLBACKS */
418 * @brief Enable the SD device interrupt.
419 * @param __HANDLE__ SD Handle.
420 * @param __INTERRUPT__ specifies the SDMMC interrupt sources to be enabled.
421 * This parameter can be one or a combination of the following values:
422 * @arg SDMMC_IT_CCRCFAIL: Command response received (CRC check failed) interrupt
423 * @arg SDMMC_IT_DCRCFAIL: Data block sent/received (CRC check failed) interrupt
424 * @arg SDMMC_IT_CTIMEOUT: Command response timeout interrupt
425 * @arg SDMMC_IT_DTIMEOUT: Data timeout interrupt
426 * @arg SDMMC_IT_TXUNDERR: Transmit FIFO underrun error interrupt
427 * @arg SDMMC_IT_RXOVERR: Received FIFO overrun error interrupt
428 * @arg SDMMC_IT_CMDREND: Command response received (CRC check passed) interrupt
429 * @arg SDMMC_IT_CMDSENT: Command sent (no response required) interrupt
430 * @arg SDMMC_IT_DATAEND: Data end (data counter, DATACOUNT, is zero) interrupt
431 * @arg SDMMC_IT_DHOLD: Data transfer Hold interrupt
432 * @arg SDMMC_IT_DBCKEND: Data block sent/received (CRC check passed) interrupt
433 * @arg SDMMC_IT_DABORT: Data transfer aborted by CMD12 interrupt
434 * @arg SDMMC_IT_TXFIFOHE: Transmit FIFO Half Empty interrupt
435 * @arg SDMMC_IT_RXFIFOHF: Receive FIFO Half Full interrupt
436 * @arg SDMMC_IT_RXFIFOF: Receive FIFO full interrupt
437 * @arg SDMMC_IT_TXFIFOE: Transmit FIFO empty interrupt
438 * @arg SDMMC_IT_BUSYD0END: End of SDMMC_D0 Busy following a CMD response detected interrupt
439 * @arg SDMMC_IT_SDIOIT: SDIO interrupt received interrupt
440 * @arg SDMMC_IT_ACKFAIL: Boot Acknowledgment received interrupt
441 * @arg SDMMC_IT_ACKTIMEOUT: Boot Acknowledgment timeout interrupt
442 * @arg SDMMC_IT_VSWEND: Voltage switch critical timing section completion interrupt
443 * @arg SDMMC_IT_CKSTOP: SDMMC_CK stopped in Voltage switch procedure interrupt
444 * @arg SDMMC_IT_IDMABTC: IDMA buffer transfer complete interrupt
445 * @retval None
447 #define __HAL_SD_ENABLE_IT(__HANDLE__, __INTERRUPT__) __SDMMC_ENABLE_IT((__HANDLE__)->Instance, (__INTERRUPT__))
450 * @brief Disable the SD device interrupt.
451 * @param __HANDLE__ SD Handle.
452 * @param __INTERRUPT__ specifies the SDMMC interrupt sources to be disabled.
453 * This parameter can be one or a combination of the following values:
454 * @arg SDMMC_IT_CCRCFAIL: Command response received (CRC check failed) interrupt
455 * @arg SDMMC_IT_DCRCFAIL: Data block sent/received (CRC check failed) interrupt
456 * @arg SDMMC_IT_CTIMEOUT: Command response timeout interrupt
457 * @arg SDMMC_IT_DTIMEOUT: Data timeout interrupt
458 * @arg SDMMC_IT_TXUNDERR: Transmit FIFO underrun error interrupt
459 * @arg SDMMC_IT_RXOVERR: Received FIFO overrun error interrupt
460 * @arg SDMMC_IT_CMDREND: Command response received (CRC check passed) interrupt
461 * @arg SDMMC_IT_CMDSENT: Command sent (no response required) interrupt
462 * @arg SDMMC_IT_DATAEND: Data end (data counter, DATACOUNT, is zero) interrupt
463 * @arg SDMMC_IT_DHOLD: Data transfer Hold interrupt
464 * @arg SDMMC_IT_DBCKEND: Data block sent/received (CRC check passed) interrupt
465 * @arg SDMMC_IT_DABORT: Data transfer aborted by CMD12 interrupt
466 * @arg SDMMC_IT_TXFIFOHE: Transmit FIFO Half Empty interrupt
467 * @arg SDMMC_IT_RXFIFOHF: Receive FIFO Half Full interrupt
468 * @arg SDMMC_IT_RXFIFOF: Receive FIFO full interrupt
469 * @arg SDMMC_IT_TXFIFOE: Transmit FIFO empty interrupt
470 * @arg SDMMC_IT_BUSYD0END: End of SDMMC_D0 Busy following a CMD response detected interrupt
471 * @arg SDMMC_IT_SDIOIT: SDIO interrupt received interrupt
472 * @arg SDMMC_IT_ACKFAIL: Boot Acknowledgment received interrupt
473 * @arg SDMMC_IT_ACKTIMEOUT: Boot Acknowledgment timeout interrupt
474 * @arg SDMMC_IT_VSWEND: Voltage switch critical timing section completion interrupt
475 * @arg SDMMC_IT_CKSTOP: SDMMC_CK stopped in Voltage switch procedure interrupt
476 * @arg SDMMC_IT_IDMABTC: IDMA buffer transfer complete interrupt
477 * @retval None
479 #define __HAL_SD_DISABLE_IT(__HANDLE__, __INTERRUPT__) __SDMMC_DISABLE_IT((__HANDLE__)->Instance, (__INTERRUPT__))
482 * @brief Check whether the specified SD flag is set or not.
483 * @param __HANDLE__ SD Handle.
484 * @param __FLAG__ specifies the flag to check.
485 * This parameter can be one of the following values:
486 * @arg SDMMC_FLAG_CCRCFAIL: Command response received (CRC check failed)
487 * @arg SDMMC_FLAG_DCRCFAIL: Data block sent/received (CRC check failed)
488 * @arg SDMMC_FLAG_CTIMEOUT: Command response timeout
489 * @arg SDMMC_FLAG_DTIMEOUT: Data timeout
490 * @arg SDMMC_FLAG_TXUNDERR: Transmit FIFO underrun error
491 * @arg SDMMC_FLAG_RXOVERR: Received FIFO overrun error
492 * @arg SDMMC_FLAG_CMDREND: Command response received (CRC check passed)
493 * @arg SDMMC_FLAG_CMDSENT: Command sent (no response required)
494 * @arg SDMMC_FLAG_DATAEND: Data end (data counter, DATACOUNT, is zero)
495 * @arg SDMMC_FLAG_DHOLD: Data transfer Hold
496 * @arg SDMMC_FLAG_DBCKEND: Data block sent/received (CRC check passed)
497 * @arg SDMMC_FLAG_DABORT: Data transfer aborted by CMD12
498 * @arg SDMMC_FLAG_DPSMACT: Data path state machine active
499 * @arg SDMMC_FLAG_CPSMACT: Command path state machine active
500 * @arg SDMMC_FLAG_TXFIFOHE: Transmit FIFO Half Empty
501 * @arg SDMMC_FLAG_RXFIFOHF: Receive FIFO Half Full
502 * @arg SDMMC_FLAG_TXFIFOF: Transmit FIFO full
503 * @arg SDMMC_FLAG_RXFIFOF: Receive FIFO full
504 * @arg SDMMC_FLAG_TXFIFOE: Transmit FIFO empty
505 * @arg SDMMC_FLAG_RXFIFOE: Receive FIFO empty
506 * @arg SDMMC_FLAG_BUSYD0: Inverted value of SDMMC_D0 line (Busy)
507 * @arg SDMMC_FLAG_BUSYD0END: End of SDMMC_D0 Busy following a CMD response detected
508 * @arg SDMMC_FLAG_SDIOIT: SDIO interrupt received
509 * @arg SDMMC_FLAG_ACKFAIL: Boot Acknowledgment received
510 * @arg SDMMC_FLAG_ACKTIMEOUT: Boot Acknowledgment timeout
511 * @arg SDMMC_FLAG_VSWEND: Voltage switch critical timing section completion
512 * @arg SDMMC_FLAG_CKSTOP: SDMMC_CK stopped in Voltage switch procedure
513 * @arg SDMMC_FLAG_IDMATE: IDMA transfer error
514 * @arg SDMMC_FLAG_IDMABTC: IDMA buffer transfer complete
515 * @retval The new state of SD FLAG (SET or RESET).
517 #define __HAL_SD_GET_FLAG(__HANDLE__, __FLAG__) __SDMMC_GET_FLAG((__HANDLE__)->Instance, (__FLAG__))
520 * @brief Clear the SD's pending flags.
521 * @param __HANDLE__ SD Handle.
522 * @param __FLAG__ specifies the flag to clear.
523 * This parameter can be one or a combination of the following values:
524 * @arg SDMMC_FLAG_CCRCFAIL: Command response received (CRC check failed)
525 * @arg SDMMC_FLAG_DCRCFAIL: Data block sent/received (CRC check failed)
526 * @arg SDMMC_FLAG_CTIMEOUT: Command response timeout
527 * @arg SDMMC_FLAG_DTIMEOUT: Data timeout
528 * @arg SDMMC_FLAG_TXUNDERR: Transmit FIFO underrun error
529 * @arg SDMMC_FLAG_RXOVERR: Received FIFO overrun error
530 * @arg SDMMC_FLAG_CMDREND: Command response received (CRC check passed)
531 * @arg SDMMC_FLAG_CMDSENT: Command sent (no response required)
532 * @arg SDMMC_FLAG_DATAEND: Data end (data counter, DATACOUNT, is zero)
533 * @arg SDMMC_FLAG_DHOLD: Data transfer Hold
534 * @arg SDMMC_FLAG_DBCKEND: Data block sent/received (CRC check passed)
535 * @arg SDMMC_FLAG_DABORT: Data transfer aborted by CMD12
536 * @arg SDMMC_FLAG_BUSYD0END: End of SDMMC_D0 Busy following a CMD response detected
537 * @arg SDMMC_FLAG_SDIOIT: SDIO interrupt received
538 * @arg SDMMC_FLAG_ACKFAIL: Boot Acknowledgment received
539 * @arg SDMMC_FLAG_ACKTIMEOUT: Boot Acknowledgment timeout
540 * @arg SDMMC_FLAG_VSWEND: Voltage switch critical timing section completion
541 * @arg SDMMC_FLAG_CKSTOP: SDMMC_CK stopped in Voltage switch procedure
542 * @arg SDMMC_FLAG_IDMATE: IDMA transfer error
543 * @arg SDMMC_FLAG_IDMABTC: IDMA buffer transfer complete
544 * @retval None
546 #define __HAL_SD_CLEAR_FLAG(__HANDLE__, __FLAG__) __SDMMC_CLEAR_FLAG((__HANDLE__)->Instance, (__FLAG__))
549 * @brief Check whether the specified SD interrupt has occurred or not.
550 * @param __HANDLE__ SD Handle.
551 * @param __INTERRUPT__ specifies the SDMMC interrupt source to check.
552 * This parameter can be one of the following values:
553 * @arg SDMMC_IT_CCRCFAIL: Command response received (CRC check failed) interrupt
554 * @arg SDMMC_IT_DCRCFAIL: Data block sent/received (CRC check failed) interrupt
555 * @arg SDMMC_IT_CTIMEOUT: Command response timeout interrupt
556 * @arg SDMMC_IT_DTIMEOUT: Data timeout interrupt
557 * @arg SDMMC_IT_TXUNDERR: Transmit FIFO underrun error interrupt
558 * @arg SDMMC_IT_RXOVERR: Received FIFO overrun error interrupt
559 * @arg SDMMC_IT_CMDREND: Command response received (CRC check passed) interrupt
560 * @arg SDMMC_IT_CMDSENT: Command sent (no response required) interrupt
561 * @arg SDMMC_IT_DATAEND: Data end (data counter, DATACOUNT, is zero) interrupt
562 * @arg SDMMC_IT_DHOLD: Data transfer Hold interrupt
563 * @arg SDMMC_IT_DBCKEND: Data block sent/received (CRC check passed) interrupt
564 * @arg SDMMC_IT_DABORT: Data transfer aborted by CMD12 interrupt
565 * @arg SDMMC_IT_TXFIFOHE: Transmit FIFO Half Empty interrupt
566 * @arg SDMMC_IT_RXFIFOHF: Receive FIFO Half Full interrupt
567 * @arg SDMMC_IT_RXFIFOF: Receive FIFO full interrupt
568 * @arg SDMMC_IT_TXFIFOE: Transmit FIFO empty interrupt
569 * @arg SDMMC_IT_BUSYD0END: End of SDMMC_D0 Busy following a CMD response detected interrupt
570 * @arg SDMMC_IT_SDIOIT: SDIO interrupt received interrupt
571 * @arg SDMMC_IT_ACKFAIL: Boot Acknowledgment received interrupt
572 * @arg SDMMC_IT_ACKTIMEOUT: Boot Acknowledgment timeout interrupt
573 * @arg SDMMC_IT_VSWEND: Voltage switch critical timing section completion interrupt
574 * @arg SDMMC_IT_CKSTOP: SDMMC_CK stopped in Voltage switch procedure interrupt
575 * @arg SDMMC_IT_IDMABTC: IDMA buffer transfer complete interrupt
576 * @retval The new state of SD IT (SET or RESET).
578 #define __HAL_SD_GET_IT(__HANDLE__, __INTERRUPT__) __SDMMC_GET_IT((__HANDLE__)->Instance, (__INTERRUPT__))
581 * @brief Clear the SD's interrupt pending bits.
582 * @param __HANDLE__ SD Handle.
583 * @param __INTERRUPT__ specifies the interrupt pending bit to clear.
584 * This parameter can be one or a combination of the following values:
585 * @arg SDMMC_IT_CCRCFAIL: Command response received (CRC check failed) interrupt
586 * @arg SDMMC_IT_DCRCFAIL: Data block sent/received (CRC check failed) interrupt
587 * @arg SDMMC_IT_CTIMEOUT: Command response timeout interrupt
588 * @arg SDMMC_IT_DTIMEOUT: Data timeout interrupt
589 * @arg SDMMC_IT_TXUNDERR: Transmit FIFO underrun error interrupt
590 * @arg SDMMC_IT_RXOVERR: Received FIFO overrun error interrupt
591 * @arg SDMMC_IT_CMDREND: Command response received (CRC check passed) interrupt
592 * @arg SDMMC_IT_CMDSENT: Command sent (no response required) interrupt
593 * @arg SDMMC_IT_DATAEND: Data end (data counter, DATACOUNT, is zero) interrupt
594 * @arg SDMMC_IT_DHOLD: Data transfer Hold interrupt
595 * @arg SDMMC_IT_DBCKEND: Data block sent/received (CRC check passed) interrupt
596 * @arg SDMMC_IT_DABORT: Data transfer aborted by CMD12 interrupt
597 * @arg SDMMC_IT_BUSYD0END: End of SDMMC_D0 Busy following a CMD response detected interrupt
598 * @arg SDMMC_IT_SDIOIT: SDIO interrupt received interrupt
599 * @arg SDMMC_IT_ACKFAIL: Boot Acknowledgment received interrupt
600 * @arg SDMMC_IT_ACKTIMEOUT: Boot Acknowledgment timeout interrupt
601 * @arg SDMMC_IT_VSWEND: Voltage switch critical timing section completion interrupt
602 * @arg SDMMC_IT_CKSTOP: SDMMC_CK stopped in Voltage switch procedure interrupt
603 * @arg SDMMC_IT_IDMABTC: IDMA buffer transfer complete interrupt
604 * @retval None
606 #define __HAL_SD_CLEAR_IT(__HANDLE__, __INTERRUPT__) __SDMMC_CLEAR_IT((__HANDLE__)->Instance, (__INTERRUPT__))
609 * @}
612 /* Include SD HAL Extension module */
613 #include "stm32h7xx_hal_sd_ex.h"
615 /* Exported functions --------------------------------------------------------*/
616 /** @defgroup SD_Exported_Functions SD Exported Functions
617 * @{
620 /** @defgroup SD_Exported_Functions_Group1 Initialization and de-initialization functions
621 * @{
623 HAL_StatusTypeDef HAL_SD_Init (SD_HandleTypeDef *hsd);
624 HAL_StatusTypeDef HAL_SD_InitCard (SD_HandleTypeDef *hsd);
625 HAL_StatusTypeDef HAL_SD_DeInit (SD_HandleTypeDef *hsd);
626 void HAL_SD_MspInit (SD_HandleTypeDef *hsd);
627 void HAL_SD_MspDeInit(SD_HandleTypeDef *hsd);
629 * @}
632 /** @defgroup SD_Exported_Functions_Group2 Input and Output operation functions
633 * @{
635 /* Blocking mode: Polling */
636 HAL_StatusTypeDef HAL_SD_ReadBlocks (SD_HandleTypeDef *hsd, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks, uint32_t Timeout);
637 HAL_StatusTypeDef HAL_SD_WriteBlocks (SD_HandleTypeDef *hsd, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks, uint32_t Timeout);
638 HAL_StatusTypeDef HAL_SD_Erase (SD_HandleTypeDef *hsd, uint32_t BlockStartAdd, uint32_t BlockEndAdd);
639 /* Non-Blocking mode: IT */
640 HAL_StatusTypeDef HAL_SD_ReadBlocks_IT (SD_HandleTypeDef *hsd, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks);
641 HAL_StatusTypeDef HAL_SD_WriteBlocks_IT (SD_HandleTypeDef *hsd, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks);
642 /* Non-Blocking mode: DMA */
643 HAL_StatusTypeDef HAL_SD_ReadBlocks_DMA (SD_HandleTypeDef *hsd, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks);
644 HAL_StatusTypeDef HAL_SD_WriteBlocks_DMA(SD_HandleTypeDef *hsd, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks);
646 void HAL_SD_IRQHandler (SD_HandleTypeDef *hsd);
648 /* Callback in non blocking modes (DMA) */
649 void HAL_SD_TxCpltCallback (SD_HandleTypeDef *hsd);
650 void HAL_SD_RxCpltCallback (SD_HandleTypeDef *hsd);
651 void HAL_SD_ErrorCallback (SD_HandleTypeDef *hsd);
652 void HAL_SD_AbortCallback (SD_HandleTypeDef *hsd);
654 #if (USE_SD_TRANSCEIVER != 0U)
655 /* Callback to switch in 1.8V mode */
656 void HAL_SD_DriveTransceiver_1_8V_Callback(FlagStatus status);
657 #endif /* USE_SD_TRANSCEIVER */
659 #if defined (USE_HAL_SD_REGISTER_CALLBACKS) && (USE_HAL_SD_REGISTER_CALLBACKS == 1U)
660 /* SD callback registering/unregistering */
661 HAL_StatusTypeDef HAL_SD_RegisterCallback (SD_HandleTypeDef *hsd, HAL_SD_CallbackIDTypeDef CallbackID, pSD_CallbackTypeDef pCallback);
662 HAL_StatusTypeDef HAL_SD_UnRegisterCallback(SD_HandleTypeDef *hsd, HAL_SD_CallbackIDTypeDef CallbackID);
664 #if (USE_SD_TRANSCEIVER != 0U)
665 HAL_StatusTypeDef HAL_SD_RegisterTransceiverCallback (SD_HandleTypeDef *hsd, pSD_TransceiverCallbackTypeDef pCallback);
666 HAL_StatusTypeDef HAL_SD_UnRegisterTransceiverCallback(SD_HandleTypeDef *hsd);
667 #endif /* USE_SD_TRANSCEIVER */
668 #endif /* USE_HAL_SD_REGISTER_CALLBACKS */
671 * @}
674 /** @defgroup SD_Exported_Functions_Group3 Peripheral Control functions
675 * @{
677 HAL_StatusTypeDef HAL_SD_ConfigWideBusOperation(SD_HandleTypeDef *hsd, uint32_t WideMode);
678 HAL_StatusTypeDef HAL_SD_ConfigSpeedBusOperation(SD_HandleTypeDef *hsd, uint32_t SpeedMode);
680 * @}
683 /** @defgroup SD_Exported_Functions_Group4 SD card related functions
684 * @{
686 HAL_SD_CardStateTypeDef HAL_SD_GetCardState(SD_HandleTypeDef *hsd);
687 HAL_StatusTypeDef HAL_SD_GetCardCID (SD_HandleTypeDef *hsd, HAL_SD_CardCIDTypeDef *pCID);
688 HAL_StatusTypeDef HAL_SD_GetCardCSD (SD_HandleTypeDef *hsd, HAL_SD_CardCSDTypeDef *pCSD);
689 HAL_StatusTypeDef HAL_SD_GetCardStatus(SD_HandleTypeDef *hsd, HAL_SD_CardStatusTypeDef *pStatus);
690 HAL_StatusTypeDef HAL_SD_GetCardInfo (SD_HandleTypeDef *hsd, HAL_SD_CardInfoTypeDef *pCardInfo);
692 * @}
695 /** @defgroup SD_Exported_Functions_Group5 Peripheral State and Errors functions
696 * @{
698 HAL_SD_StateTypeDef HAL_SD_GetState(SD_HandleTypeDef *hsd);
699 uint32_t HAL_SD_GetError(SD_HandleTypeDef *hsd);
701 * @}
704 /** @defgroup SD_Exported_Functions_Group6 Perioheral Abort management
705 * @{
707 HAL_StatusTypeDef HAL_SD_Abort (SD_HandleTypeDef *hsd);
708 HAL_StatusTypeDef HAL_SD_Abort_IT(SD_HandleTypeDef *hsd);
710 * @}
713 /* Private types -------------------------------------------------------------*/
714 /** @defgroup SD_Private_Types SD Private Types
715 * @{
719 * @}
722 /* Private defines -----------------------------------------------------------*/
723 /** @defgroup SD_Private_Defines SD Private Defines
724 * @{
728 * @}
731 /* Private variables ---------------------------------------------------------*/
732 /** @defgroup SD_Private_Variables SD Private Variables
733 * @{
737 * @}
740 /* Private constants ---------------------------------------------------------*/
741 /** @defgroup SD_Private_Constants SD Private Constants
742 * @{
746 * @}
749 /* Private macros ------------------------------------------------------------*/
750 /** @defgroup SD_Private_Macros SD Private Macros
751 * @{
755 * @}
758 /* Private functions prototypes ----------------------------------------------*/
759 /** @defgroup SD_Private_Functions_Prototypes SD Private Functions Prototypes
760 * @{
764 * @}
767 /* Private functions ---------------------------------------------------------*/
768 /** @defgroup SD_Private_Functions SD Private Functions
769 * @{
773 * @}
778 * @}
782 * @}
786 * @}
789 #ifdef __cplusplus
791 #endif
794 #endif /* STM32H7xx_HAL_SD_H */
796 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/