?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Updated and Validated
[betaflight.git] / lib / main / STM32F7 / Drivers / STM32F7xx_HAL_Driver / Inc / stm32f7xx_hal_sd.h
blobd02e38e4b91ded3233bfbea4709b5dedc37e95e9
1 /**
2 ******************************************************************************
3 * @file stm32f7xx_hal_sd.h
4 * @author MCD Application Team
5 * @brief Header file of SD HAL module.
6 ******************************************************************************
7 * @attention
8 *
9 * <h2><center>&copy; Copyright (c) 2017 STMicroelectronics.
10 * All rights reserved.</center></h2>
11 *
12 * This software component is licensed by ST under BSD 3-Clause license,
13 * the "License"; You may not use this file except in compliance with the
14 * License. You may obtain a copy of the License at:
15 * opensource.org/licenses/BSD-3-Clause
16 *
17 ******************************************************************************
18 */
19
20 /* Define to prevent recursive inclusion -------------------------------------*/
21 #ifndef __STM32F7xx_HAL_SD_H
22 #define __STM32F7xx_HAL_SD_H
23
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27
28 /* Includes ------------------------------------------------------------------*/
29 #include "stm32f7xx_ll_sdmmc.h"
30
31 /** @addtogroup STM32F7xx_HAL_Driver
32 * @{
33 */
34
35 /** @defgroup SD SD
36 * @brief SD HAL module driver
37 * @{
38 */
39
40 /* Exported types ------------------------------------------------------------*/
41 /** @defgroup SD_Exported_Types SD Exported Types
42 * @{
43 */
44
45 /** @defgroup SD_Exported_Types_Group1 SD State enumeration structure
46 * @{
47 */
48 typedef enum
49 {
50 HAL_SD_STATE_RESET = ((uint32_t)0x00000000U), /*!< SD not yet initialized or disabled */
51 HAL_SD_STATE_READY = ((uint32_t)0x00000001U), /*!< SD initialized and ready for use */
52 HAL_SD_STATE_TIMEOUT = ((uint32_t)0x00000002U), /*!< SD Timeout state */
53 HAL_SD_STATE_BUSY = ((uint32_t)0x00000003U), /*!< SD process ongoing */
54 HAL_SD_STATE_PROGRAMMING = ((uint32_t)0x00000004U), /*!< SD Programming State */
55 HAL_SD_STATE_RECEIVING = ((uint32_t)0x00000005U), /*!< SD Receinving State */
56 HAL_SD_STATE_TRANSFER = ((uint32_t)0x00000006U), /*!< SD Transfert State */
57 HAL_SD_STATE_ERROR = ((uint32_t)0x0000000FU) /*!< SD is in error state */
58 }HAL_SD_StateTypeDef;
59 /**
60 * @}
61 */
62
63 /** @defgroup SD_Exported_Types_Group2 SD Card State enumeration structure
64 * @{
65 */
66 typedef enum
67 {
68 HAL_SD_CARD_READY = ((uint32_t)0x00000001U), /*!< Card state is ready */
69 HAL_SD_CARD_IDENTIFICATION = ((uint32_t)0x00000002U), /*!< Card is in identification state */
70 HAL_SD_CARD_STANDBY = ((uint32_t)0x00000003U), /*!< Card is in standby state */
71 HAL_SD_CARD_TRANSFER = ((uint32_t)0x00000004U), /*!< Card is in transfer state */
72 HAL_SD_CARD_SENDING = ((uint32_t)0x00000005U), /*!< Card is sending an operation */
73 HAL_SD_CARD_RECEIVING = ((uint32_t)0x00000006U), /*!< Card is receiving operation information */
74 HAL_SD_CARD_PROGRAMMING = ((uint32_t)0x00000007U), /*!< Card is in programming state */
75 HAL_SD_CARD_DISCONNECTED = ((uint32_t)0x00000008U), /*!< Card is disconnected */
76 HAL_SD_CARD_ERROR = ((uint32_t)0x000000FFU) /*!< Card response Error */
77 }HAL_SD_CardStateTypeDef;
78 /**
79 * @}
80 */
81
82 /** @defgroup SD_Exported_Types_Group3 SD Handle Structure definition
83 * @{
84 */
85 #define SD_InitTypeDef SDMMC_InitTypeDef
86 #define SD_TypeDef SDMMC_TypeDef
87
88 /**
89 * @brief SD Card Information Structure definition
90 */
91 typedef struct
92 {
93 uint32_t CardType; /*!< Specifies the card Type */
94
95 uint32_t CardVersion; /*!< Specifies the card version */
96
97 uint32_t Class; /*!< Specifies the class of the card class */
98
99 uint32_t RelCardAdd; /*!< Specifies the Relative Card Address */
100
101 uint32_t BlockNbr; /*!< Specifies the Card Capacity in blocks */
102
103 uint32_t BlockSize; /*!< Specifies one block size in bytes */
104
105 uint32_t LogBlockNbr; /*!< Specifies the Card logical Capacity in blocks */
106
107 uint32_t LogBlockSize; /*!< Specifies logical block size in bytes */
108
109 }HAL_SD_CardInfoTypeDef;
110
111 /**
112 * @brief SD handle Structure definition
113 */
114 typedef struct __SD_HandleTypeDef
115 {
116 SD_TypeDef *Instance; /*!< SD registers base address */
117
118 SD_InitTypeDef Init; /*!< SD required parameters */
119
120 HAL_LockTypeDef Lock; /*!< SD locking object */
121
122 uint32_t *pTxBuffPtr; /*!< Pointer to SD Tx transfer Buffer */
123
124 uint32_t TxXferSize; /*!< SD Tx Transfer size */
125
126 uint32_t *pRxBuffPtr; /*!< Pointer to SD Rx transfer Buffer */
127
128 uint32_t RxXferSize; /*!< SD Rx Transfer size */
129
130 __IO uint32_t Context; /*!< SD transfer context */
131
132 __IO HAL_SD_StateTypeDef State; /*!< SD card State */
133
134 __IO uint32_t ErrorCode; /*!< SD Card Error codes */
135
136 DMA_HandleTypeDef *hdmarx; /*!< SD Rx DMA handle parameters */
137
138 DMA_HandleTypeDef *hdmatx; /*!< SD Tx DMA handle parameters */
139
140 HAL_SD_CardInfoTypeDef SdCard; /*!< SD Card information */
141
142 uint32_t CSD[4]; /*!< SD card specific data table */
143
144 uint32_t CID[4]; /*!< SD card identification number table */
145
146 #if (USE_HAL_SD_REGISTER_CALLBACKS == 1)
147 void (* TxCpltCallback) (struct __SD_HandleTypeDef *hsd);
148 void (* RxCpltCallback) (struct __SD_HandleTypeDef *hsd);
149 void (* ErrorCallback) (struct __SD_HandleTypeDef *hsd);
150 void (* AbortCpltCallback) (struct __SD_HandleTypeDef *hsd);
151
152 void (* MspInitCallback) (struct __SD_HandleTypeDef *hsd);
153 void (* MspDeInitCallback) (struct __SD_HandleTypeDef *hsd);
154 #endif
155 }SD_HandleTypeDef;
156
157 /**
158 * @}
159 */
160
161 /** @defgroup SD_Exported_Types_Group4 Card Specific Data: CSD Register
162 * @{
163 */
164 typedef struct
165 {
166 __IO uint8_t CSDStruct; /*!< CSD structure */
167 __IO uint8_t SysSpecVersion; /*!< System specification version */
168 __IO uint8_t Reserved1; /*!< Reserved */
169 __IO uint8_t TAAC; /*!< Data read access time 1 */
170 __IO uint8_t NSAC; /*!< Data read access time 2 in CLK cycles */
171 __IO uint8_t MaxBusClkFrec; /*!< Max. bus clock frequency */
172 __IO uint16_t CardComdClasses; /*!< Card command classes */
173 __IO uint8_t RdBlockLen; /*!< Max. read data block length */
174 __IO uint8_t PartBlockRead; /*!< Partial blocks for read allowed */
175 __IO uint8_t WrBlockMisalign; /*!< Write block misalignment */
176 __IO uint8_t RdBlockMisalign; /*!< Read block misalignment */
177 __IO uint8_t DSRImpl; /*!< DSR implemented */
178 __IO uint8_t Reserved2; /*!< Reserved */
179 __IO uint32_t DeviceSize; /*!< Device Size */
180 __IO uint8_t MaxRdCurrentVDDMin; /*!< Max. read current @ VDD min */
181 __IO uint8_t MaxRdCurrentVDDMax; /*!< Max. read current @ VDD max */
182 __IO uint8_t MaxWrCurrentVDDMin; /*!< Max. write current @ VDD min */
183 __IO uint8_t MaxWrCurrentVDDMax; /*!< Max. write current @ VDD max */
184 __IO uint8_t DeviceSizeMul; /*!< Device size multiplier */
185 __IO uint8_t EraseGrSize; /*!< Erase group size */
186 __IO uint8_t EraseGrMul; /*!< Erase group size multiplier */
187 __IO uint8_t WrProtectGrSize; /*!< Write protect group size */
188 __IO uint8_t WrProtectGrEnable; /*!< Write protect group enable */
189 __IO uint8_t ManDeflECC; /*!< Manufacturer default ECC */
190 __IO uint8_t WrSpeedFact; /*!< Write speed factor */
191 __IO uint8_t MaxWrBlockLen; /*!< Max. write data block length */
192 __IO uint8_t WriteBlockPaPartial; /*!< Partial blocks for write allowed */
193 __IO uint8_t Reserved3; /*!< Reserved */
194 __IO uint8_t ContentProtectAppli; /*!< Content protection application */
195 __IO uint8_t FileFormatGrouop; /*!< File format group */
196 __IO uint8_t CopyFlag; /*!< Copy flag (OTP) */
197 __IO uint8_t PermWrProtect; /*!< Permanent write protection */
198 __IO uint8_t TempWrProtect; /*!< Temporary write protection */
199 __IO uint8_t FileFormat; /*!< File format */
200 __IO uint8_t ECC; /*!< ECC code */
201 __IO uint8_t CSD_CRC; /*!< CSD CRC */
202 __IO uint8_t Reserved4; /*!< Always 1 */
203
204 }HAL_SD_CardCSDTypeDef;
205 /**
206 * @}
207 */
208
209 /** @defgroup SD_Exported_Types_Group5 Card Identification Data: CID Register
210 * @{
211 */
212 typedef struct
213 {
214 __IO uint8_t ManufacturerID; /*!< Manufacturer ID */
215 __IO uint16_t OEM_AppliID; /*!< OEM/Application ID */
216 __IO uint32_t ProdName1; /*!< Product Name part1 */
217 __IO uint8_t ProdName2; /*!< Product Name part2 */
218 __IO uint8_t ProdRev; /*!< Product Revision */
219 __IO uint32_t ProdSN; /*!< Product Serial Number */
220 __IO uint8_t Reserved1; /*!< Reserved1 */
221 __IO uint16_t ManufactDate; /*!< Manufacturing Date */
222 __IO uint8_t CID_CRC; /*!< CID CRC */
223 __IO uint8_t Reserved2; /*!< Always 1 */
224
225 }HAL_SD_CardCIDTypeDef;
226 /**
227 * @}
228 */
229
230 /** @defgroup SD_Exported_Types_Group6 SD Card Status returned by ACMD13
231 * @{
232 */
233 typedef struct
234 {
235 __IO uint8_t DataBusWidth; /*!< Shows the currently defined data bus width */
236 __IO uint8_t SecuredMode; /*!< Card is in secured mode of operation */
237 __IO uint16_t CardType; /*!< Carries information about card type */
238 __IO uint32_t ProtectedAreaSize; /*!< Carries information about the capacity of protected area */
239 __IO uint8_t SpeedClass; /*!< Carries information about the speed class of the card */
240 __IO uint8_t PerformanceMove; /*!< Carries information about the card's performance move */
241 __IO uint8_t AllocationUnitSize; /*!< Carries information about the card's allocation unit size */
242 __IO uint16_t EraseSize; /*!< Determines the number of AUs to be erased in one operation */
243 __IO uint8_t EraseTimeout; /*!< Determines the timeout for any number of AU erase */
244 __IO uint8_t EraseOffset; /*!< Carries information about the erase offset */
245
246 }HAL_SD_CardStatusTypeDef;
247 /**
248 * @}
249 */
250
251 #if (USE_HAL_SD_REGISTER_CALLBACKS == 1)
252 /** @defgroup SD_Exported_Types_Group7 SD Callback ID enumeration definition
253 * @{
254 */
255 typedef enum
256 {
257 HAL_SD_TX_CPLT_CB_ID = 0x00U, /*!< SD Tx Complete Callback ID */
258 HAL_SD_RX_CPLT_CB_ID = 0x01U, /*!< SD Rx Complete Callback ID */
259 HAL_SD_ERROR_CB_ID = 0x02U, /*!< SD Error Callback ID */
260 HAL_SD_ABORT_CB_ID = 0x03U, /*!< SD Abort Callback ID */
261
262 HAL_SD_MSP_INIT_CB_ID = 0x10U, /*!< SD MspInit Callback ID */
263 HAL_SD_MSP_DEINIT_CB_ID = 0x11U /*!< SD MspDeInit Callback ID */
264 }HAL_SD_CallbackIDTypeDef;
265 /**
266 * @}
267 */
268
269 /** @defgroup SD_Exported_Types_Group8 SD Callback pointer definition
270 * @{
271 */
272 typedef void (*pSD_CallbackTypeDef) (SD_HandleTypeDef *hsd);
273 /**
274 * @}
275 */
276 #endif
277 /**
278 * @}
279 */
280
281 /* Exported constants --------------------------------------------------------*/
282 /** @defgroup SD_Exported_Constants Exported Constants
283 * @{
284 */
285
286 #define BLOCKSIZE ((uint32_t)512U) /*!< Block size is 512 bytes */
287
288 /** @defgroup SD_Exported_Constansts_Group1 SD Error status enumeration Structure definition
289 * @{
290 */
291 #define HAL_SD_ERROR_NONE SDMMC_ERROR_NONE /*!< No error */
292 #define HAL_SD_ERROR_CMD_CRC_FAIL SDMMC_ERROR_CMD_CRC_FAIL /*!< Command response received (but CRC check failed) */
293 #define HAL_SD_ERROR_DATA_CRC_FAIL SDMMC_ERROR_DATA_CRC_FAIL /*!< Data block sent/received (CRC check failed) */
294 #define HAL_SD_ERROR_CMD_RSP_TIMEOUT SDMMC_ERROR_CMD_RSP_TIMEOUT /*!< Command response timeout */
295 #define HAL_SD_ERROR_DATA_TIMEOUT SDMMC_ERROR_DATA_TIMEOUT /*!< Data timeout */
296 #define HAL_SD_ERROR_TX_UNDERRUN SDMMC_ERROR_TX_UNDERRUN /*!< Transmit FIFO underrun */
297 #define HAL_SD_ERROR_RX_OVERRUN SDMMC_ERROR_RX_OVERRUN /*!< Receive FIFO overrun */
298 #define HAL_SD_ERROR_ADDR_MISALIGNED SDMMC_ERROR_ADDR_MISALIGNED /*!< Misaligned address */
299 #define HAL_SD_ERROR_BLOCK_LEN_ERR SDMMC_ERROR_BLOCK_LEN_ERR /*!< Transferred block length is not allowed for the card or the
300 number of transferred bytes does not match the block length */
301 #define HAL_SD_ERROR_ERASE_SEQ_ERR SDMMC_ERROR_ERASE_SEQ_ERR /*!< An error in the sequence of erase command occurs */
302 #define HAL_SD_ERROR_BAD_ERASE_PARAM SDMMC_ERROR_BAD_ERASE_PARAM /*!< An invalid selection for erase groups */
303 #define HAL_SD_ERROR_WRITE_PROT_VIOLATION SDMMC_ERROR_WRITE_PROT_VIOLATION /*!< Attempt to program a write protect block */
304 #define HAL_SD_ERROR_LOCK_UNLOCK_FAILED SDMMC_ERROR_LOCK_UNLOCK_FAILED /*!< Sequence or password error has been detected in unlock
305 command or if there was an attempt to access a locked card */
306 #define HAL_SD_ERROR_COM_CRC_FAILED SDMMC_ERROR_COM_CRC_FAILED /*!< CRC check of the previous command failed */
307 #define HAL_SD_ERROR_ILLEGAL_CMD SDMMC_ERROR_ILLEGAL_CMD /*!< Command is not legal for the card state */
308 #define HAL_SD_ERROR_CARD_ECC_FAILED SDMMC_ERROR_CARD_ECC_FAILED /*!< Card internal ECC was applied but failed to correct the data */
309 #define HAL_SD_ERROR_CC_ERR SDMMC_ERROR_CC_ERR /*!< Internal card controller error */
310 #define HAL_SD_ERROR_GENERAL_UNKNOWN_ERR SDMMC_ERROR_GENERAL_UNKNOWN_ERR /*!< General or unknown error */
311 #define HAL_SD_ERROR_STREAM_READ_UNDERRUN SDMMC_ERROR_STREAM_READ_UNDERRUN /*!< The card could not sustain data reading in stream rmode */
312 #define HAL_SD_ERROR_STREAM_WRITE_OVERRUN SDMMC_ERROR_STREAM_WRITE_OVERRUN /*!< The card could not sustain data programming in stream mode */
313 #define HAL_SD_ERROR_CID_CSD_OVERWRITE SDMMC_ERROR_CID_CSD_OVERWRITE /*!< CID/CSD overwrite error */
314 #define HAL_SD_ERROR_WP_ERASE_SKIP SDMMC_ERROR_WP_ERASE_SKIP /*!< Only partial address space was erased */
315 #define HAL_SD_ERROR_CARD_ECC_DISABLED SDMMC_ERROR_CARD_ECC_DISABLED /*!< Command has been executed without using internal ECC */
316 #define HAL_SD_ERROR_ERASE_RESET SDMMC_ERROR_ERASE_RESET /*!< Erase sequence was cleared before executing because an out
317 of erase sequence command was received */
318 #define HAL_SD_ERROR_AKE_SEQ_ERR SDMMC_ERROR_AKE_SEQ_ERR /*!< Error in sequence of authentication */
319 #define HAL_SD_ERROR_INVALID_VOLTRANGE SDMMC_ERROR_INVALID_VOLTRANGE /*!< Error in case of invalid voltage range */
320 #define HAL_SD_ERROR_ADDR_OUT_OF_RANGE SDMMC_ERROR_ADDR_OUT_OF_RANGE /*!< Error when addressed block is out of range */
321 #define HAL_SD_ERROR_REQUEST_NOT_APPLICABLE SDMMC_ERROR_REQUEST_NOT_APPLICABLE /*!< Error when command request is not applicable */
322 #define HAL_SD_ERROR_PARAM SDMMC_ERROR_INVALID_PARAMETER /*!< the used parameter is not valid */
323 #define HAL_SD_ERROR_UNSUPPORTED_FEATURE SDMMC_ERROR_UNSUPPORTED_FEATURE /*!< Error when feature is not insupported */
324 #define HAL_SD_ERROR_BUSY SDMMC_ERROR_BUSY /*!< Error when transfer process is busy */
325 #define HAL_SD_ERROR_DMA SDMMC_ERROR_DMA /*!< Error while DMA transfer */
326 #define HAL_SD_ERROR_TIMEOUT SDMMC_ERROR_TIMEOUT /*!< Timeout error */
327
328 #if (USE_HAL_SD_REGISTER_CALLBACKS == 1)
329 #define HAL_SD_ERROR_INVALID_CALLBACK SDMMC_ERROR_INVALID_PARAMETER /*!< Invalid callback error */
330 #endif
331
332 /**
333 * @}
334 */
335
336 /** @defgroup SD_Exported_Constansts_Group2 SD context enumeration
337 * @{
338 */
339 #define SD_CONTEXT_NONE ((uint32_t)0x00000000U) /*!< None */
340 #define SD_CONTEXT_READ_SINGLE_BLOCK ((uint32_t)0x00000001U) /*!< Read single block operation */
341 #define SD_CONTEXT_READ_MULTIPLE_BLOCK ((uint32_t)0x00000002U) /*!< Read multiple blocks operation */
342 #define SD_CONTEXT_WRITE_SINGLE_BLOCK ((uint32_t)0x00000010U) /*!< Write single block operation */
343 #define SD_CONTEXT_WRITE_MULTIPLE_BLOCK ((uint32_t)0x00000020U) /*!< Write multiple blocks operation */
344 #define SD_CONTEXT_IT ((uint32_t)0x00000008U) /*!< Process in Interrupt mode */
345 #define SD_CONTEXT_DMA ((uint32_t)0x00000080U) /*!< Process in DMA mode */
346
347 /**
348 * @}
349 */
350
351 /** @defgroup SD_Exported_Constansts_Group3 SD Supported Memory Cards
352 * @{
353 */
354 #define CARD_SDSC ((uint32_t)0x00000000U)
355 #define CARD_SDHC_SDXC ((uint32_t)0x00000001U)
356 #define CARD_SECURED ((uint32_t)0x00000003U)
357
358 /**
359 * @}
360 */
361
362 /** @defgroup SD_Exported_Constansts_Group4 SD Supported Version
363 * @{
364 */
365 #define CARD_V1_X ((uint32_t)0x00000000U)
366 #define CARD_V2_X ((uint32_t)0x00000001U)
367 /**
368 * @}
369 */
370
371 /**
372 * @}
373 */
374
375 /* Exported macro ------------------------------------------------------------*/
376 /** @defgroup SD_Exported_macros SD Exported Macros
377 * @brief macros to handle interrupts and specific clock configurations
378 * @{
379 */
380 /** @brief Reset SD handle state.
381 * @param __HANDLE__ : SD handle.
382 * @retval None
383 */
384 #if (USE_HAL_SD_REGISTER_CALLBACKS == 1)
385 #define __HAL_SD_RESET_HANDLE_STATE(__HANDLE__) do { \
386 (__HANDLE__)->State = HAL_SD_STATE_RESET; \
387 (__HANDLE__)->MspInitCallback = NULL; \
388 (__HANDLE__)->MspDeInitCallback = NULL; \
389 } while(0)
390 #else
391 #define __HAL_SD_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_SD_STATE_RESET)
392 #endif
393
394 /**
395 * @brief Enable the SD device.
396 * @retval None
397 */
398 #define __HAL_SD_ENABLE(__HANDLE__) __SDMMC_ENABLE((__HANDLE__)->Instance)
399
400 /**
401 * @brief Disable the SD device.
402 * @retval None
403 */
404 #define __HAL_SD_DISABLE(__HANDLE__) __SDMMC_DISABLE((__HANDLE__)->Instance)
405
406 /**
407 * @brief Enable the SDMMC DMA transfer.
408 * @retval None
409 */
410 #define __HAL_SD_DMA_ENABLE(__HANDLE__) __SDMMC_DMA_ENABLE((__HANDLE__)->Instance)
411
412 /**
413 * @brief Disable the SDMMC DMA transfer.
414 * @retval None
415 */
416 #define __HAL_SD_DMA_DISABLE(__HANDLE__) __SDMMC_DMA_DISABLE((__HANDLE__)->Instance)
417
418 /**
419 * @brief Enable the SD device interrupt.
420 * @param __HANDLE__ SD Handle
421 * @param __INTERRUPT__ specifies the SDMMC interrupt sources to be enabled.
422 * This parameter can be one or a combination of the following values:
423 * @arg SDMMC_IT_CCRCFAIL: Command response received (CRC check failed) interrupt
424 * @arg SDMMC_IT_DCRCFAIL: Data block sent/received (CRC check failed) interrupt
425 * @arg SDMMC_IT_CTIMEOUT: Command response timeout interrupt
426 * @arg SDMMC_IT_DTIMEOUT: Data timeout interrupt
427 * @arg SDMMC_IT_TXUNDERR: Transmit FIFO underrun error interrupt
428 * @arg SDMMC_IT_RXOVERR: Received FIFO overrun error interrupt
429 * @arg SDMMC_IT_CMDREND: Command response received (CRC check passed) interrupt
430 * @arg SDMMC_IT_CMDSENT: Command sent (no response required) interrupt
431 * @arg SDMMC_IT_DATAEND: Data end (data counter, SDIDCOUNT, is zero) interrupt
432 * @arg SDMMC_IT_DBCKEND: Data block sent/received (CRC check passed) interrupt
433 * @arg SDMMC_IT_CMDACT: Command transfer in progress interrupt
434 * @arg SDMMC_IT_TXACT: Data transmit in progress interrupt
435 * @arg SDMMC_IT_RXACT: Data receive in progress interrupt
436 * @arg SDMMC_IT_TXFIFOHE: Transmit FIFO Half Empty interrupt
437 * @arg SDMMC_IT_RXFIFOHF: Receive FIFO Half Full interrupt
438 * @arg SDMMC_IT_TXFIFOF: Transmit FIFO full interrupt
439 * @arg SDMMC_IT_RXFIFOF: Receive FIFO full interrupt
440 * @arg SDMMC_IT_TXFIFOE: Transmit FIFO empty interrupt
441 * @arg SDMMC_IT_RXFIFOE: Receive FIFO empty interrupt
442 * @arg SDMMC_IT_TXDAVL: Data available in transmit FIFO interrupt
443 * @arg SDMMC_IT_RXDAVL: Data available in receive FIFO interrupt
444 * @arg SDMMC_IT_SDIOIT: SD I/O interrupt received interrupt
445 * @retval None
446 */
447 #define __HAL_SD_ENABLE_IT(__HANDLE__, __INTERRUPT__) __SDMMC_ENABLE_IT((__HANDLE__)->Instance, (__INTERRUPT__))
448
449 /**
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, SDIDCOUNT, is zero) interrupt
463 * @arg SDMMC_IT_DBCKEND: Data block sent/received (CRC check passed) interrupt
464 * @arg SDMMC_IT_CMDACT: Command transfer in progress interrupt
465 * @arg SDMMC_IT_TXACT: Data transmit in progress interrupt
466 * @arg SDMMC_IT_RXACT: Data receive in progress interrupt
467 * @arg SDMMC_IT_TXFIFOHE: Transmit FIFO Half Empty interrupt
468 * @arg SDMMC_IT_RXFIFOHF: Receive FIFO Half Full interrupt
469 * @arg SDMMC_IT_TXFIFOF: Transmit FIFO full interrupt
470 * @arg SDMMC_IT_RXFIFOF: Receive FIFO full interrupt
471 * @arg SDMMC_IT_TXFIFOE: Transmit FIFO empty interrupt
472 * @arg SDMMC_IT_RXFIFOE: Receive FIFO empty interrupt
473 * @arg SDMMC_IT_TXDAVL: Data available in transmit FIFO interrupt
474 * @arg SDMMC_IT_RXDAVL: Data available in receive FIFO interrupt
475 * @arg SDMMC_IT_SDIOIT: SD I/O interrupt received interrupt
476 * @retval None
477 */
478 #define __HAL_SD_DISABLE_IT(__HANDLE__, __INTERRUPT__) __SDMMC_DISABLE_IT((__HANDLE__)->Instance, (__INTERRUPT__))
479
480 /**
481 * @brief Check whether the specified SD flag is set or not.
482 * @param __HANDLE__ SD Handle
483 * @param __FLAG__ specifies the flag to check.
484 * This parameter can be one of the following values:
485 * @arg SDMMC_FLAG_CCRCFAIL: Command response received (CRC check failed)
486 * @arg SDMMC_FLAG_DCRCFAIL: Data block sent/received (CRC check failed)
487 * @arg SDMMC_FLAG_CTIMEOUT: Command response timeout
488 * @arg SDMMC_FLAG_DTIMEOUT: Data timeout
489 * @arg SDMMC_FLAG_TXUNDERR: Transmit FIFO underrun error
490 * @arg SDMMC_FLAG_RXOVERR: Received FIFO overrun error
491 * @arg SDMMC_FLAG_CMDREND: Command response received (CRC check passed)
492 * @arg SDMMC_FLAG_CMDSENT: Command sent (no response required)
493 * @arg SDMMC_FLAG_DATAEND: Data end (data counter, SDIDCOUNT, is zero)
494 * @arg SDMMC_FLAG_DBCKEND: Data block sent/received (CRC check passed)
495 * @arg SDMMC_FLAG_CMDACT: Command transfer in progress
496 * @arg SDMMC_FLAG_TXACT: Data transmit in progress
497 * @arg SDMMC_FLAG_RXACT: Data receive in progress
498 * @arg SDMMC_FLAG_TXFIFOHE: Transmit FIFO Half Empty
499 * @arg SDMMC_FLAG_RXFIFOHF: Receive FIFO Half Full
500 * @arg SDMMC_FLAG_TXFIFOF: Transmit FIFO full
501 * @arg SDMMC_FLAG_RXFIFOF: Receive FIFO full
502 * @arg SDMMC_FLAG_TXFIFOE: Transmit FIFO empty
503 * @arg SDMMC_FLAG_RXFIFOE: Receive FIFO empty
504 * @arg SDMMC_FLAG_TXDAVL: Data available in transmit FIFO
505 * @arg SDMMC_FLAG_RXDAVL: Data available in receive FIFO
506 * @arg SDMMC_FLAG_SDIOIT: SD I/O interrupt received
507 * @retval The new state of SD FLAG (SET or RESET).
508 */
509 #define __HAL_SD_GET_FLAG(__HANDLE__, __FLAG__) __SDMMC_GET_FLAG((__HANDLE__)->Instance, (__FLAG__))
510
511 /**
512 * @brief Clear the SD's pending flags.
513 * @param __HANDLE__ SD Handle
514 * @param __FLAG__ specifies the flag to clear.
515 * This parameter can be one or a combination of the following values:
516 * @arg SDMMC_FLAG_CCRCFAIL: Command response received (CRC check failed)
517 * @arg SDMMC_FLAG_DCRCFAIL: Data block sent/received (CRC check failed)
518 * @arg SDMMC_FLAG_CTIMEOUT: Command response timeout
519 * @arg SDMMC_FLAG_DTIMEOUT: Data timeout
520 * @arg SDMMC_FLAG_TXUNDERR: Transmit FIFO underrun error
521 * @arg SDMMC_FLAG_RXOVERR: Received FIFO overrun error
522 * @arg SDMMC_FLAG_CMDREND: Command response received (CRC check passed)
523 * @arg SDMMC_FLAG_CMDSENT: Command sent (no response required)
524 * @arg SDMMC_FLAG_DATAEND: Data end (data counter, SDIDCOUNT, is zero)
525 * @arg SDMMC_FLAG_DBCKEND: Data block sent/received (CRC check passed)
526 * @arg SDMMC_FLAG_SDIOIT: SD I/O interrupt received
527 * @retval None
528 */
529 #define __HAL_SD_CLEAR_FLAG(__HANDLE__, __FLAG__) __SDMMC_CLEAR_FLAG((__HANDLE__)->Instance, (__FLAG__))
530
531 /**
532 * @brief Check whether the specified SD interrupt has occurred or not.
533 * @param __HANDLE__ SD Handle
534 * @param __INTERRUPT__ specifies the SDMMC interrupt source to check.
535 * This parameter can be one of the following values:
536 * @arg SDMMC_IT_CCRCFAIL: Command response received (CRC check failed) interrupt
537 * @arg SDMMC_IT_DCRCFAIL: Data block sent/received (CRC check failed) interrupt
538 * @arg SDMMC_IT_CTIMEOUT: Command response timeout interrupt
539 * @arg SDMMC_IT_DTIMEOUT: Data timeout interrupt
540 * @arg SDMMC_IT_TXUNDERR: Transmit FIFO underrun error interrupt
541 * @arg SDMMC_IT_RXOVERR: Received FIFO overrun error interrupt
542 * @arg SDMMC_IT_CMDREND: Command response received (CRC check passed) interrupt
543 * @arg SDMMC_IT_CMDSENT: Command sent (no response required) interrupt
544 * @arg SDMMC_IT_DATAEND: Data end (data counter, SDIDCOUNT, is zero) interrupt
545 * @arg SDMMC_IT_DBCKEND: Data block sent/received (CRC check passed) interrupt
546 * @arg SDMMC_IT_CMDACT: Command transfer in progress interrupt
547 * @arg SDMMC_IT_TXACT: Data transmit in progress interrupt
548 * @arg SDMMC_IT_RXACT: Data receive in progress interrupt
549 * @arg SDMMC_IT_TXFIFOHE: Transmit FIFO Half Empty interrupt
550 * @arg SDMMC_IT_RXFIFOHF: Receive FIFO Half Full interrupt
551 * @arg SDMMC_IT_TXFIFOF: Transmit FIFO full interrupt
552 * @arg SDMMC_IT_RXFIFOF: Receive FIFO full interrupt
553 * @arg SDMMC_IT_TXFIFOE: Transmit FIFO empty interrupt
554 * @arg SDMMC_IT_RXFIFOE: Receive FIFO empty interrupt
555 * @arg SDMMC_IT_TXDAVL: Data available in transmit FIFO interrupt
556 * @arg SDMMC_IT_RXDAVL: Data available in receive FIFO interrupt
557 * @arg SDMMC_IT_SDIOIT: SD I/O interrupt received interrupt
558 * @retval The new state of SD IT (SET or RESET).
559 */
560 #define __HAL_SD_GET_IT(__HANDLE__, __INTERRUPT__) __SDMMC_GET_IT((__HANDLE__)->Instance, (__INTERRUPT__))
561
562 /**
563 * @brief Clear the SD's interrupt pending bits.
564 * @param __HANDLE__ SD Handle
565 * @param __INTERRUPT__ specifies the interrupt pending bit to clear.
566 * This parameter can be one or a combination of the following values:
567 * @arg SDMMC_IT_CCRCFAIL: Command response received (CRC check failed) interrupt
568 * @arg SDMMC_IT_DCRCFAIL: Data block sent/received (CRC check failed) interrupt
569 * @arg SDMMC_IT_CTIMEOUT: Command response timeout interrupt
570 * @arg SDMMC_IT_DTIMEOUT: Data timeout interrupt
571 * @arg SDMMC_IT_TXUNDERR: Transmit FIFO underrun error interrupt
572 * @arg SDMMC_IT_RXOVERR: Received FIFO overrun error interrupt
573 * @arg SDMMC_IT_CMDREND: Command response received (CRC check passed) interrupt
574 * @arg SDMMC_IT_CMDSENT: Command sent (no response required) interrupt
575 * @arg SDMMC_IT_DATAEND: Data end (data counter, SDMMC_DCOUNT, is zero) interrupt
576 * @arg SDMMC_IT_SDIOIT: SD I/O interrupt received interrupt
577 * @retval None
578 */
579 #define __HAL_SD_CLEAR_IT(__HANDLE__, __INTERRUPT__) __SDMMC_CLEAR_IT((__HANDLE__)->Instance, (__INTERRUPT__))
580
581 /**
582 * @}
583 */
584
585 /* Exported functions --------------------------------------------------------*/
586 /** @defgroup SD_Exported_Functions SD Exported Functions
587 * @{
588 */
589
590 /** @defgroup SD_Exported_Functions_Group1 Initialization and de-initialization functions
591 * @{
592 */
593 HAL_StatusTypeDef HAL_SD_Init(SD_HandleTypeDef *hsd);
594 HAL_StatusTypeDef HAL_SD_InitCard(SD_HandleTypeDef *hsd);
595 HAL_StatusTypeDef HAL_SD_DeInit (SD_HandleTypeDef *hsd);
596 void HAL_SD_MspInit(SD_HandleTypeDef *hsd);
597 void HAL_SD_MspDeInit(SD_HandleTypeDef *hsd);
598 /**
599 * @}
600 */
601
602 /** @defgroup SD_Exported_Functions_Group2 Input and Output operation functions
603 * @{
604 */
605 /* Blocking mode: Polling */
606 HAL_StatusTypeDef HAL_SD_ReadBlocks(SD_HandleTypeDef *hsd, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks, uint32_t Timeout);
607 HAL_StatusTypeDef HAL_SD_WriteBlocks(SD_HandleTypeDef *hsd, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks, uint32_t Timeout);
608 HAL_StatusTypeDef HAL_SD_Erase(SD_HandleTypeDef *hsd, uint32_t BlockStartAdd, uint32_t BlockEndAdd);
609 /* Non-Blocking mode: IT */
610 HAL_StatusTypeDef HAL_SD_ReadBlocks_IT(SD_HandleTypeDef *hsd, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks);
611 HAL_StatusTypeDef HAL_SD_WriteBlocks_IT(SD_HandleTypeDef *hsd, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks);
612 /* Non-Blocking mode: DMA */
613 HAL_StatusTypeDef HAL_SD_ReadBlocks_DMA(SD_HandleTypeDef *hsd, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks);
614 HAL_StatusTypeDef HAL_SD_WriteBlocks_DMA(SD_HandleTypeDef *hsd, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks);
615
616 void HAL_SD_IRQHandler(SD_HandleTypeDef *hsd);
617
618 /* Callback in non blocking modes (DMA) */
619 void HAL_SD_TxCpltCallback(SD_HandleTypeDef *hsd);
620 void HAL_SD_RxCpltCallback(SD_HandleTypeDef *hsd);
621 void HAL_SD_ErrorCallback(SD_HandleTypeDef *hsd);
622 void HAL_SD_AbortCallback(SD_HandleTypeDef *hsd);
623
624 #if (USE_HAL_SD_REGISTER_CALLBACKS == 1)
625 /* SD callback registering/unregistering */
626 HAL_StatusTypeDef HAL_SD_RegisterCallback (SD_HandleTypeDef *hsd, HAL_SD_CallbackIDTypeDef CallbackId, pSD_CallbackTypeDef pCallback);
627 HAL_StatusTypeDef HAL_SD_UnRegisterCallback(SD_HandleTypeDef *hsd, HAL_SD_CallbackIDTypeDef CallbackId);
628 #endif
629 /**
630 * @}
631 */
632
633 /** @defgroup SD_Exported_Functions_Group3 Peripheral Control functions
634 * @{
635 */
636 HAL_StatusTypeDef HAL_SD_ConfigWideBusOperation(SD_HandleTypeDef *hsd, uint32_t WideMode);
637 /**
638 * @}
639 */
640
641 /** @defgroup SD_Exported_Functions_Group4 SD card related functions
642 * @{
643 */
644 HAL_StatusTypeDef HAL_SD_SendSDStatus(SD_HandleTypeDef *hsd, uint32_t *pSDstatus);
645 HAL_SD_CardStateTypeDef HAL_SD_GetCardState(SD_HandleTypeDef *hsd);
646 HAL_StatusTypeDef HAL_SD_GetCardCID(SD_HandleTypeDef *hsd, HAL_SD_CardCIDTypeDef *pCID);
647 HAL_StatusTypeDef HAL_SD_GetCardCSD(SD_HandleTypeDef *hsd, HAL_SD_CardCSDTypeDef *pCSD);
648 HAL_StatusTypeDef HAL_SD_GetCardStatus(SD_HandleTypeDef *hsd, HAL_SD_CardStatusTypeDef *pStatus);
649 HAL_StatusTypeDef HAL_SD_GetCardInfo(SD_HandleTypeDef *hsd, HAL_SD_CardInfoTypeDef *pCardInfo);
650 /**
651 * @}
652 */
653
654 /** @defgroup SD_Exported_Functions_Group5 Peripheral State and Errors functions
655 * @{
656 */
657 HAL_SD_StateTypeDef HAL_SD_GetState(SD_HandleTypeDef *hsd);
658 uint32_t HAL_SD_GetError(SD_HandleTypeDef *hsd);
659 /**
660 * @}
661 */
662
663 /** @defgroup SD_Exported_Functions_Group6 Perioheral Abort management
664 * @{
665 */
666 HAL_StatusTypeDef HAL_SD_Abort(SD_HandleTypeDef *hsd);
667 HAL_StatusTypeDef HAL_SD_Abort_IT(SD_HandleTypeDef *hsd);
668 /**
669 * @}
670 */
671
672 /* Private types -------------------------------------------------------------*/
673 /** @defgroup SD_Private_Types SD Private Types
674 * @{
675 */
676
677 /**
678 * @}
679 */
680
681 /* Private defines -----------------------------------------------------------*/
682 /** @defgroup SD_Private_Defines SD Private Defines
683 * @{
684 */
685
686 /**
687 * @}
688 */
689
690 /* Private variables ---------------------------------------------------------*/
691 /** @defgroup SD_Private_Variables SD Private Variables
692 * @{
693 */
694
695 /**
696 * @}
697 */
698
699 /* Private constants ---------------------------------------------------------*/
700 /** @defgroup SD_Private_Constants SD Private Constants
701 * @{
702 */
703
704 /**
705 * @}
706 */
707
708 /* Private macros ------------------------------------------------------------*/
709 /** @defgroup SD_Private_Macros SD Private Macros
710 * @{
711 */
712
713 /**
714 * @}
715 */
716
717 /* Private functions prototypes ----------------------------------------------*/
718 /** @defgroup SD_Private_Functions_Prototypes SD Private Functions Prototypes
719 * @{
720 */
721
722 /**
723 * @}
724 */
725
726 /* Private functions ---------------------------------------------------------*/
727 /** @defgroup SD_Private_Functions SD Private Functions
728 * @{
729 */
730
731 /**
732 * @}
733 */
734
735
736 /**
737 * @}
738 */
739
740 /**
741 * @}
742 */
743
744 /**
745 * @}
746 */
747
748
749 #ifdef __cplusplus
750 }
751 #endif
752
753
754 #endif /* __STM32F7xx_HAL_SD_H */
755
756 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/