?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Merge pull request #11198 from SteveCEvans/sce_rc2
[betaflight.git] / lib / main / STM32F4 / Drivers / STM32F4xx_HAL_Driver / Inc / stm32f4xx_hal_sd.h
blob0d8daacc42392a946312bfd21b32935c6edd14ae
1 /**
2 ******************************************************************************
3 * @file stm32f4xx_hal_sd.h
4 * @author MCD Application Team
5 * @version V1.7.1
6 * @date 14-April-2017
7 * @brief Header file of SD HAL module.
8 ******************************************************************************
9 * @attention
10 *
11 * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
12 *
13 * Redistribution and use in source and binary forms, with or without modification,
14 * are permitted provided that the following conditions are met:
15 * 1. Redistributions of source code must retain the above copyright notice,
16 * this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright notice,
18 * this list of conditions and the following disclaimer in the documentation
19 * and/or other materials provided with the distribution.
20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
21 * may be used to endorse or promote products derived from this software
22 * without specific prior written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 *
35 ******************************************************************************
36 */
37
38 /* Define to prevent recursive inclusion -------------------------------------*/
39 #ifndef __STM32F4xx_HAL_SD_H
40 #define __STM32F4xx_HAL_SD_H
41
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45
46 #if defined(STM32F405xx) || defined(STM32F415xx) || defined(STM32F407xx) || defined(STM32F417xx) || \
47 defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx) || \
48 defined(STM32F401xC) || defined(STM32F401xE) || defined(STM32F411xE) || defined(STM32F446xx) || \
49 defined(STM32F469xx) || defined(STM32F479xx) || defined(STM32F412Zx) || defined(STM32F412Vx) || \
50 defined(STM32F412Rx) || defined(STM32F412Cx) || defined(STM32F413xx) || defined(STM32F423xx)
51
52 /* Includes ------------------------------------------------------------------*/
53 #include "stm32f4xx_ll_sdmmc.h"
54
55 /** @addtogroup STM32F4xx_HAL_Driver
56 * @{
57 */
58
59 /** @defgroup SD SD
60 * @brief SD HAL module driver
61 * @{
62 */
63
64 /* Exported types ------------------------------------------------------------*/
65 /** @defgroup SD_Exported_Types SD Exported Types
66 * @{
67 */
68
69 /** @defgroup SD_Exported_Types_Group1 SD State enumeration structure
70 * @{
71 */
72 typedef enum
73 {
74 HAL_SD_STATE_RESET = 0x00000000U, /*!< SD not yet initialized or disabled */
75 HAL_SD_STATE_READY = 0x00000001U, /*!< SD initialized and ready for use */
76 HAL_SD_STATE_TIMEOUT = 0x00000002U, /*!< SD Timeout state */
77 HAL_SD_STATE_BUSY = 0x00000003U, /*!< SD process ongoing */
78 HAL_SD_STATE_PROGRAMMING = 0x00000004U, /*!< SD Programming State */
79 HAL_SD_STATE_RECEIVING = 0x00000005U, /*!< SD Receinving State */
80 HAL_SD_STATE_TRANSFER = 0x00000006U, /*!< SD Transfert State */
81 HAL_SD_STATE_ERROR = 0x0000000FU /*!< SD is in error state */
82 }HAL_SD_StateTypeDef;
83 /**
84 * @}
85 */
86
87 /** @defgroup SD_Exported_Types_Group2 SD Card State enumeration structure
88 * @{
89 */
90 typedef enum
91 {
92 HAL_SD_CARD_READY = 0x00000001U, /*!< Card state is ready */
93 HAL_SD_CARD_IDENTIFICATION = 0x00000002U, /*!< Card is in identification state */
94 HAL_SD_CARD_STANDBY = 0x00000003U, /*!< Card is in standby state */
95 HAL_SD_CARD_TRANSFER = 0x00000004U, /*!< Card is in transfer state */
96 HAL_SD_CARD_SENDING = 0x00000005U, /*!< Card is sending an operation */
97 HAL_SD_CARD_RECEIVING = 0x00000006U, /*!< Card is receiving operation information */
98 HAL_SD_CARD_PROGRAMMING = 0x00000007U, /*!< Card is in programming state */
99 HAL_SD_CARD_DISCONNECTED = 0x00000008U, /*!< Card is disconnected */
100 HAL_SD_CARD_ERROR = 0x000000FFU /*!< Card response Error */
101 }HAL_SD_CardStateTypeDef;
102 /**
103 * @}
104 */
105
106 /** @defgroup SD_Exported_Types_Group3 SD Handle Structure definition
107 * @{
108 */
109 #define SD_InitTypeDef SDIO_InitTypeDef
110 #define SD_TypeDef SDIO_TypeDef
111
112 /**
113 * @brief SD Card Information Structure definition
114 */
115 typedef struct
116 {
117 uint32_t CardType; /*!< Specifies the card Type */
118
119 uint32_t CardVersion; /*!< Specifies the card version */
120
121 uint32_t Class; /*!< Specifies the class of the card class */
122
123 uint32_t RelCardAdd; /*!< Specifies the Relative Card Address */
124
125 uint32_t BlockNbr; /*!< Specifies the Card Capacity in blocks */
126
127 uint32_t BlockSize; /*!< Specifies one block size in bytes */
128
129 uint32_t LogBlockNbr; /*!< Specifies the Card logical Capacity in blocks */
130
131 uint32_t LogBlockSize; /*!< Specifies logical block size in bytes */
132
133 }HAL_SD_CardInfoTypeDef;
134
135 /**
136 * @brief SD handle Structure definition
137 */
138 typedef struct
139 {
140 SD_TypeDef *Instance; /*!< SD registers base address */
141
142 SD_InitTypeDef Init; /*!< SD required parameters */
143
144 HAL_LockTypeDef Lock; /*!< SD locking object */
145
146 uint32_t *pTxBuffPtr; /*!< Pointer to SD Tx transfer Buffer */
147
148 uint32_t TxXferSize; /*!< SD Tx Transfer size */
149
150 uint32_t *pRxBuffPtr; /*!< Pointer to SD Rx transfer Buffer */
151
152 uint32_t RxXferSize; /*!< SD Rx Transfer size */
153
154 __IO uint32_t Context; /*!< SD transfer context */
155
156 __IO HAL_SD_StateTypeDef State; /*!< SD card State */
157
158 __IO uint32_t ErrorCode; /*!< SD Card Error codes */
159
160 DMA_HandleTypeDef *hdmarx; /*!< SD Rx DMA handle parameters */
161
162 DMA_HandleTypeDef *hdmatx; /*!< SD Tx DMA handle parameters */
163
164 HAL_SD_CardInfoTypeDef SdCard; /*!< SD Card information */
165
166 uint32_t CSD[4]; /*!< SD card specific data table */
167
168 uint32_t CID[4]; /*!< SD card identification number table */
169
170 }SD_HandleTypeDef;
171
172 /**
173 * @}
174 */
175
176 /** @defgroup SD_Exported_Types_Group4 Card Specific Data: CSD Register
177 * @{
178 */
179 typedef struct
180 {
181 __IO uint8_t CSDStruct; /*!< CSD structure */
182 __IO uint8_t SysSpecVersion; /*!< System specification version */
183 __IO uint8_t Reserved1; /*!< Reserved */
184 __IO uint8_t TAAC; /*!< Data read access time 1 */
185 __IO uint8_t NSAC; /*!< Data read access time 2 in CLK cycles */
186 __IO uint8_t MaxBusClkFrec; /*!< Max. bus clock frequency */
187 __IO uint16_t CardComdClasses; /*!< Card command classes */
188 __IO uint8_t RdBlockLen; /*!< Max. read data block length */
189 __IO uint8_t PartBlockRead; /*!< Partial blocks for read allowed */
190 __IO uint8_t WrBlockMisalign; /*!< Write block misalignment */
191 __IO uint8_t RdBlockMisalign; /*!< Read block misalignment */
192 __IO uint8_t DSRImpl; /*!< DSR implemented */
193 __IO uint8_t Reserved2; /*!< Reserved */
194 __IO uint32_t DeviceSize; /*!< Device Size */
195 __IO uint8_t MaxRdCurrentVDDMin; /*!< Max. read current @ VDD min */
196 __IO uint8_t MaxRdCurrentVDDMax; /*!< Max. read current @ VDD max */
197 __IO uint8_t MaxWrCurrentVDDMin; /*!< Max. write current @ VDD min */
198 __IO uint8_t MaxWrCurrentVDDMax; /*!< Max. write current @ VDD max */
199 __IO uint8_t DeviceSizeMul; /*!< Device size multiplier */
200 __IO uint8_t EraseGrSize; /*!< Erase group size */
201 __IO uint8_t EraseGrMul; /*!< Erase group size multiplier */
202 __IO uint8_t WrProtectGrSize; /*!< Write protect group size */
203 __IO uint8_t WrProtectGrEnable; /*!< Write protect group enable */
204 __IO uint8_t ManDeflECC; /*!< Manufacturer default ECC */
205 __IO uint8_t WrSpeedFact; /*!< Write speed factor */
206 __IO uint8_t MaxWrBlockLen; /*!< Max. write data block length */
207 __IO uint8_t WriteBlockPaPartial; /*!< Partial blocks for write allowed */
208 __IO uint8_t Reserved3; /*!< Reserved */
209 __IO uint8_t ContentProtectAppli; /*!< Content protection application */
210 __IO uint8_t FileFormatGrouop; /*!< File format group */
211 __IO uint8_t CopyFlag; /*!< Copy flag (OTP) */
212 __IO uint8_t PermWrProtect; /*!< Permanent write protection */
213 __IO uint8_t TempWrProtect; /*!< Temporary write protection */
214 __IO uint8_t FileFormat; /*!< File format */
215 __IO uint8_t ECC; /*!< ECC code */
216 __IO uint8_t CSD_CRC; /*!< CSD CRC */
217 __IO uint8_t Reserved4; /*!< Always 1 */
218
219 }HAL_SD_CardCSDTypeDef;
220 /**
221 * @}
222 */
223
224 /** @defgroup SD_Exported_Types_Group5 Card Identification Data: CID Register
225 * @{
226 */
227 typedef struct
228 {
229 __IO uint8_t ManufacturerID; /*!< Manufacturer ID */
230 __IO uint16_t OEM_AppliID; /*!< OEM/Application ID */
231 __IO uint32_t ProdName1; /*!< Product Name part1 */
232 __IO uint8_t ProdName2; /*!< Product Name part2 */
233 __IO uint8_t ProdRev; /*!< Product Revision */
234 __IO uint32_t ProdSN; /*!< Product Serial Number */
235 __IO uint8_t Reserved1; /*!< Reserved1 */
236 __IO uint16_t ManufactDate; /*!< Manufacturing Date */
237 __IO uint8_t CID_CRC; /*!< CID CRC */
238 __IO uint8_t Reserved2; /*!< Always 1 */
239
240 }HAL_SD_CardCIDTypeDef;
241 /**
242 * @}
243 */
244
245 /** @defgroup SD_Exported_Types_Group6 SD Card Status returned by ACMD13
246 * @{
247 */
248 typedef struct
249 {
250 __IO uint8_t DataBusWidth; /*!< Shows the currently defined data bus width */
251 __IO uint8_t SecuredMode; /*!< Card is in secured mode of operation */
252 __IO uint16_t CardType; /*!< Carries information about card type */
253 __IO uint32_t ProtectedAreaSize; /*!< Carries information about the capacity of protected area */
254 __IO uint8_t SpeedClass; /*!< Carries information about the speed class of the card */
255 __IO uint8_t PerformanceMove; /*!< Carries information about the card's performance move */
256 __IO uint8_t AllocationUnitSize; /*!< Carries information about the card's allocation unit size */
257 __IO uint16_t EraseSize; /*!< Determines the number of AUs to be erased in one operation */
258 __IO uint8_t EraseTimeout; /*!< Determines the timeout for any number of AU erase */
259 __IO uint8_t EraseOffset; /*!< Carries information about the erase offset */
260
261 }HAL_SD_CardStatusTypeDef;
262 /**
263 * @}
264 */
265
266 /**
267 * @}
268 */
269
270 /* Exported constants --------------------------------------------------------*/
271 /** @defgroup SD_Exported_Constants Exported Constants
272 * @{
273 */
274
275 #define BLOCKSIZE 512U /*!< Block size is 512 bytes */
276
277 /** @defgroup SD_Exported_Constansts_Group1 SD Error status enumeration Structure definition
278 * @{
279 */
280 #define HAL_SD_ERROR_NONE SDMMC_ERROR_NONE /*!< No error */
281 #define HAL_SD_ERROR_CMD_CRC_FAIL SDMMC_ERROR_CMD_CRC_FAIL /*!< Command response received (but CRC check failed) */
282 #define HAL_SD_ERROR_DATA_CRC_FAIL SDMMC_ERROR_DATA_CRC_FAIL /*!< Data block sent/received (CRC check failed) */
283 #define HAL_SD_ERROR_CMD_RSP_TIMEOUT SDMMC_ERROR_CMD_RSP_TIMEOUT /*!< Command response timeout */
284 #define HAL_SD_ERROR_DATA_TIMEOUT SDMMC_ERROR_DATA_TIMEOUT /*!< Data timeout */
285 #define HAL_SD_ERROR_TX_UNDERRUN SDMMC_ERROR_TX_UNDERRUN /*!< Transmit FIFO underrun */
286 #define HAL_SD_ERROR_RX_OVERRUN SDMMC_ERROR_RX_OVERRUN /*!< Receive FIFO overrun */
287 #define HAL_SD_ERROR_ADDR_MISALIGNED SDMMC_ERROR_ADDR_MISALIGNED /*!< Misaligned address */
288 #define HAL_SD_ERROR_BLOCK_LEN_ERR SDMMC_ERROR_BLOCK_LEN_ERR /*!< Transferred block length is not allowed for the card or the
289 number of transferred bytes does not match the block length */
290 #define HAL_SD_ERROR_ERASE_SEQ_ERR SDMMC_ERROR_ERASE_SEQ_ERR /*!< An error in the sequence of erase command occurs */
291 #define HAL_SD_ERROR_BAD_ERASE_PARAM SDMMC_ERROR_BAD_ERASE_PARAM /*!< An invalid selection for erase groups */
292 #define HAL_SD_ERROR_WRITE_PROT_VIOLATION SDMMC_ERROR_WRITE_PROT_VIOLATION /*!< Attempt to program a write protect block */
293 #define HAL_SD_ERROR_LOCK_UNLOCK_FAILED SDMMC_ERROR_LOCK_UNLOCK_FAILED /*!< Sequence or password error has been detected in unlock
294 command or if there was an attempt to access a locked card */
295 #define HAL_SD_ERROR_COM_CRC_FAILED SDMMC_ERROR_COM_CRC_FAILED /*!< CRC check of the previous command failed */
296 #define HAL_SD_ERROR_ILLEGAL_CMD SDMMC_ERROR_ILLEGAL_CMD /*!< Command is not legal for the card state */
297 #define HAL_SD_ERROR_CARD_ECC_FAILED SDMMC_ERROR_CARD_ECC_FAILED /*!< Card internal ECC was applied but failed to correct the data */
298 #define HAL_SD_ERROR_CC_ERR SDMMC_ERROR_CC_ERR /*!< Internal card controller error */
299 #define HAL_SD_ERROR_GENERAL_UNKNOWN_ERR SDMMC_ERROR_GENERAL_UNKNOWN_ERR /*!< General or unknown error */
300 #define HAL_SD_ERROR_STREAM_READ_UNDERRUN SDMMC_ERROR_STREAM_READ_UNDERRUN /*!< The card could not sustain data reading in stream rmode */
301 #define HAL_SD_ERROR_STREAM_WRITE_OVERRUN SDMMC_ERROR_STREAM_WRITE_OVERRUN /*!< The card could not sustain data programming in stream mode */
302 #define HAL_SD_ERROR_CID_CSD_OVERWRITE SDMMC_ERROR_CID_CSD_OVERWRITE /*!< CID/CSD overwrite error */
303 #define HAL_SD_ERROR_WP_ERASE_SKIP SDMMC_ERROR_WP_ERASE_SKIP /*!< Only partial address space was erased */
304 #define HAL_SD_ERROR_CARD_ECC_DISABLED SDMMC_ERROR_CARD_ECC_DISABLED /*!< Command has been executed without using internal ECC */
305 #define HAL_SD_ERROR_ERASE_RESET SDMMC_ERROR_ERASE_RESET /*!< Erase sequence was cleared before executing because an out
306 of erase sequence command was received */
307 #define HAL_SD_ERROR_AKE_SEQ_ERR SDMMC_ERROR_AKE_SEQ_ERR /*!< Error in sequence of authentication */
308 #define HAL_SD_ERROR_INVALID_VOLTRANGE SDMMC_ERROR_INVALID_VOLTRANGE /*!< Error in case of invalid voltage range */
309 #define HAL_SD_ERROR_ADDR_OUT_OF_RANGE SDMMC_ERROR_ADDR_OUT_OF_RANGE /*!< Error when addressed block is out of range */
310 #define HAL_SD_ERROR_REQUEST_NOT_APPLICABLE SDMMC_ERROR_REQUEST_NOT_APPLICABLE /*!< Error when command request is not applicable */
311 #define HAL_SD_ERROR_PARAM SDMMC_ERROR_INVALID_PARAMETER /*!< the used parameter is not valid */
312 #define HAL_SD_ERROR_UNSUPPORTED_FEATURE SDMMC_ERROR_UNSUPPORTED_FEATURE /*!< Error when feature is not insupported */
313 #define HAL_SD_ERROR_BUSY SDMMC_ERROR_BUSY /*!< Error when transfer process is busy */
314 #define HAL_SD_ERROR_DMA SDMMC_ERROR_DMA /*!< Error while DMA transfer */
315 #define HAL_SD_ERROR_TIMEOUT SDMMC_ERROR_TIMEOUT /*!< Timeout error */
316
317 /**
318 * @}
319 */
320
321 /** @defgroup SD_Exported_Constansts_Group2 SD context enumeration
322 * @{
323 */
324 #define SD_CONTEXT_NONE 0x00000000U /*!< None */
325 #define SD_CONTEXT_READ_SINGLE_BLOCK 0x00000001U /*!< Read single block operation */
326 #define SD_CONTEXT_READ_MULTIPLE_BLOCK 0x00000002U /*!< Read multiple blocks operation */
327 #define SD_CONTEXT_WRITE_SINGLE_BLOCK 0x00000010U /*!< Write single block operation */
328 #define SD_CONTEXT_WRITE_MULTIPLE_BLOCK 0x00000020U /*!< Write multiple blocks operation */
329 #define SD_CONTEXT_IT 0x00000008U /*!< Process in Interrupt mode */
330 #define SD_CONTEXT_DMA 0x00000080U /*!< Process in DMA mode */
331
332 /**
333 * @}
334 */
335
336 /** @defgroup SD_Exported_Constansts_Group3 SD Supported Memory Cards
337 * @{
338 */
339 #define CARD_SDSC 0x00000000U
340 #define CARD_SDHC_SDXC 0x00000001U
341 #define CARD_SECURED 0x00000003U
342
343 /**
344 * @}
345 */
346
347 /** @defgroup SD_Exported_Constansts_Group4 SD Supported Version
348 * @{
349 */
350 #define CARD_V1_X 0x00000000U
351 #define CARD_V2_X 0x00000001U
352 /**
353 * @}
354 */
355
356 /**
357 * @}
358 */
359
360 /* Exported macro ------------------------------------------------------------*/
361 /** @defgroup SD_Exported_macros SD Exported Macros
362 * @brief macros to handle interrupts and specific clock configurations
363 * @{
364 */
365
366 /**
367 * @brief Enable the SD device.
368 * @retval None
369 */
370 #define __HAL_SD_ENABLE(__HANDLE__) __SDIO_ENABLE((__HANDLE__)->Instance)
371
372 /**
373 * @brief Disable the SD device.
374 * @retval None
375 */
376 #define __HAL_SD_DISABLE(__HANDLE__) __SDIO_DISABLE((__HANDLE__)->Instance)
377
378 /**
379 * @brief Enable the SDMMC DMA transfer.
380 * @retval None
381 */
382 #define __HAL_SD_DMA_ENABLE(__HANDLE__) __SDIO_DMA_ENABLE((__HANDLE__)->Instance)
383
384 /**
385 * @brief Disable the SDMMC DMA transfer.
386 * @retval None
387 */
388 #define __HAL_SD_DMA_DISABLE(__HANDLE__) __SDIO_DMA_DISABLE((__HANDLE__)->Instance)
389
390 /**
391 * @brief Enable the SD device interrupt.
392 * @param __HANDLE__: SD Handle
393 * @param __INTERRUPT__: specifies the SDMMC interrupt sources to be enabled.
394 * This parameter can be one or a combination of the following values:
395 * @arg SDIO_IT_CCRCFAIL: Command response received (CRC check failed) interrupt
396 * @arg SDIO_IT_DCRCFAIL: Data block sent/received (CRC check failed) interrupt
397 * @arg SDIO_IT_CTIMEOUT: Command response timeout interrupt
398 * @arg SDIO_IT_DTIMEOUT: Data timeout interrupt
399 * @arg SDIO_IT_TXUNDERR: Transmit FIFO underrun error interrupt
400 * @arg SDIO_IT_RXOVERR: Received FIFO overrun error interrupt
401 * @arg SDIO_IT_CMDREND: Command response received (CRC check passed) interrupt
402 * @arg SDIO_IT_CMDSENT: Command sent (no response required) interrupt
403 * @arg SDIO_IT_DATAEND: Data end (data counter, SDIDCOUNT, is zero) interrupt
404 * @arg SDIO_IT_DBCKEND: Data block sent/received (CRC check passed) interrupt
405 * @arg SDIO_IT_CMDACT: Command transfer in progress interrupt
406 * @arg SDIO_IT_TXACT: Data transmit in progress interrupt
407 * @arg SDIO_IT_RXACT: Data receive in progress interrupt
408 * @arg SDIO_IT_TXFIFOHE: Transmit FIFO Half Empty interrupt
409 * @arg SDIO_IT_RXFIFOHF: Receive FIFO Half Full interrupt
410 * @arg SDIO_IT_TXFIFOF: Transmit FIFO full interrupt
411 * @arg SDIO_IT_RXFIFOF: Receive FIFO full interrupt
412 * @arg SDIO_IT_TXFIFOE: Transmit FIFO empty interrupt
413 * @arg SDIO_IT_RXFIFOE: Receive FIFO empty interrupt
414 * @arg SDIO_IT_TXDAVL: Data available in transmit FIFO interrupt
415 * @arg SDIO_IT_RXDAVL: Data available in receive FIFO interrupt
416 * @arg SDIO_IT_SDIOIT: SD I/O interrupt received interrupt
417 * @retval None
418 */
419 #define __HAL_SD_ENABLE_IT(__HANDLE__, __INTERRUPT__) __SDIO_ENABLE_IT((__HANDLE__)->Instance, (__INTERRUPT__))
420
421 /**
422 * @brief Disable the SD device interrupt.
423 * @param __HANDLE__: SD Handle
424 * @param __INTERRUPT__: specifies the SDMMC interrupt sources to be disabled.
425 * This parameter can be one or a combination of the following values:
426 * @arg SDIO_IT_CCRCFAIL: Command response received (CRC check failed) interrupt
427 * @arg SDIO_IT_DCRCFAIL: Data block sent/received (CRC check failed) interrupt
428 * @arg SDIO_IT_CTIMEOUT: Command response timeout interrupt
429 * @arg SDIO_IT_DTIMEOUT: Data timeout interrupt
430 * @arg SDIO_IT_TXUNDERR: Transmit FIFO underrun error interrupt
431 * @arg SDIO_IT_RXOVERR: Received FIFO overrun error interrupt
432 * @arg SDIO_IT_CMDREND: Command response received (CRC check passed) interrupt
433 * @arg SDIO_IT_CMDSENT: Command sent (no response required) interrupt
434 * @arg SDIO_IT_DATAEND: Data end (data counter, SDIDCOUNT, is zero) interrupt
435 * @arg SDIO_IT_DBCKEND: Data block sent/received (CRC check passed) interrupt
436 * @arg SDIO_IT_CMDACT: Command transfer in progress interrupt
437 * @arg SDIO_IT_TXACT: Data transmit in progress interrupt
438 * @arg SDIO_IT_RXACT: Data receive in progress interrupt
439 * @arg SDIO_IT_TXFIFOHE: Transmit FIFO Half Empty interrupt
440 * @arg SDIO_IT_RXFIFOHF: Receive FIFO Half Full interrupt
441 * @arg SDIO_IT_TXFIFOF: Transmit FIFO full interrupt
442 * @arg SDIO_IT_RXFIFOF: Receive FIFO full interrupt
443 * @arg SDIO_IT_TXFIFOE: Transmit FIFO empty interrupt
444 * @arg SDIO_IT_RXFIFOE: Receive FIFO empty interrupt
445 * @arg SDIO_IT_TXDAVL: Data available in transmit FIFO interrupt
446 * @arg SDIO_IT_RXDAVL: Data available in receive FIFO interrupt
447 * @arg SDIO_IT_SDIOIT: SD I/O interrupt received interrupt
448 * @retval None
449 */
450 #define __HAL_SD_DISABLE_IT(__HANDLE__, __INTERRUPT__) __SDIO_DISABLE_IT((__HANDLE__)->Instance, (__INTERRUPT__))
451
452 /**
453 * @brief Check whether the specified SD flag is set or not.
454 * @param __HANDLE__: SD Handle
455 * @param __FLAG__: specifies the flag to check.
456 * This parameter can be one of the following values:
457 * @arg SDIO_FLAG_CCRCFAIL: Command response received (CRC check failed)
458 * @arg SDIO_FLAG_DCRCFAIL: Data block sent/received (CRC check failed)
459 * @arg SDIO_FLAG_CTIMEOUT: Command response timeout
460 * @arg SDIO_FLAG_DTIMEOUT: Data timeout
461 * @arg SDIO_FLAG_TXUNDERR: Transmit FIFO underrun error
462 * @arg SDIO_FLAG_RXOVERR: Received FIFO overrun error
463 * @arg SDIO_FLAG_CMDREND: Command response received (CRC check passed)
464 * @arg SDIO_FLAG_CMDSENT: Command sent (no response required)
465 * @arg SDIO_FLAG_DATAEND: Data end (data counter, SDIDCOUNT, is zero)
466 * @arg SDIO_FLAG_DBCKEND: Data block sent/received (CRC check passed)
467 * @arg SDIO_FLAG_CMDACT: Command transfer in progress
468 * @arg SDIO_FLAG_TXACT: Data transmit in progress
469 * @arg SDIO_FLAG_RXACT: Data receive in progress
470 * @arg SDIO_FLAG_TXFIFOHE: Transmit FIFO Half Empty
471 * @arg SDIO_FLAG_RXFIFOHF: Receive FIFO Half Full
472 * @arg SDIO_FLAG_TXFIFOF: Transmit FIFO full
473 * @arg SDIO_FLAG_RXFIFOF: Receive FIFO full
474 * @arg SDIO_FLAG_TXFIFOE: Transmit FIFO empty
475 * @arg SDIO_FLAG_RXFIFOE: Receive FIFO empty
476 * @arg SDIO_FLAG_TXDAVL: Data available in transmit FIFO
477 * @arg SDIO_FLAG_RXDAVL: Data available in receive FIFO
478 * @arg SDIO_FLAG_SDIOIT: SD I/O interrupt received
479 * @retval The new state of SD FLAG (SET or RESET).
480 */
481 #define __HAL_SD_GET_FLAG(__HANDLE__, __FLAG__) __SDIO_GET_FLAG((__HANDLE__)->Instance, (__FLAG__))
482
483 /**
484 * @brief Clear the SD's pending flags.
485 * @param __HANDLE__: SD Handle
486 * @param __FLAG__: specifies the flag to clear.
487 * This parameter can be one or a combination of the following values:
488 * @arg SDIO_FLAG_CCRCFAIL: Command response received (CRC check failed)
489 * @arg SDIO_FLAG_DCRCFAIL: Data block sent/received (CRC check failed)
490 * @arg SDIO_FLAG_CTIMEOUT: Command response timeout
491 * @arg SDIO_FLAG_DTIMEOUT: Data timeout
492 * @arg SDIO_FLAG_TXUNDERR: Transmit FIFO underrun error
493 * @arg SDIO_FLAG_RXOVERR: Received FIFO overrun error
494 * @arg SDIO_FLAG_CMDREND: Command response received (CRC check passed)
495 * @arg SDIO_FLAG_CMDSENT: Command sent (no response required)
496 * @arg SDIO_FLAG_DATAEND: Data end (data counter, SDIDCOUNT, is zero)
497 * @arg SDIO_FLAG_DBCKEND: Data block sent/received (CRC check passed)
498 * @arg SDIO_FLAG_SDIOIT: SD I/O interrupt received
499 * @retval None
500 */
501 #define __HAL_SD_CLEAR_FLAG(__HANDLE__, __FLAG__) __SDIO_CLEAR_FLAG((__HANDLE__)->Instance, (__FLAG__))
502
503 /**
504 * @brief Check whether the specified SD interrupt has occurred or not.
505 * @param __HANDLE__: SD Handle
506 * @param __INTERRUPT__: specifies the SDMMC interrupt source to check.
507 * This parameter can be one of the following values:
508 * @arg SDIO_IT_CCRCFAIL: Command response received (CRC check failed) interrupt
509 * @arg SDIO_IT_DCRCFAIL: Data block sent/received (CRC check failed) interrupt
510 * @arg SDIO_IT_CTIMEOUT: Command response timeout interrupt
511 * @arg SDIO_IT_DTIMEOUT: Data timeout interrupt
512 * @arg SDIO_IT_TXUNDERR: Transmit FIFO underrun error interrupt
513 * @arg SDIO_IT_RXOVERR: Received FIFO overrun error interrupt
514 * @arg SDIO_IT_CMDREND: Command response received (CRC check passed) interrupt
515 * @arg SDIO_IT_CMDSENT: Command sent (no response required) interrupt
516 * @arg SDIO_IT_DATAEND: Data end (data counter, SDIDCOUNT, is zero) interrupt
517 * @arg SDIO_IT_DBCKEND: Data block sent/received (CRC check passed) interrupt
518 * @arg SDIO_IT_CMDACT: Command transfer in progress interrupt
519 * @arg SDIO_IT_TXACT: Data transmit in progress interrupt
520 * @arg SDIO_IT_RXACT: Data receive in progress interrupt
521 * @arg SDIO_IT_TXFIFOHE: Transmit FIFO Half Empty interrupt
522 * @arg SDIO_IT_RXFIFOHF: Receive FIFO Half Full interrupt
523 * @arg SDIO_IT_TXFIFOF: Transmit FIFO full interrupt
524 * @arg SDIO_IT_RXFIFOF: Receive FIFO full interrupt
525 * @arg SDIO_IT_TXFIFOE: Transmit FIFO empty interrupt
526 * @arg SDIO_IT_RXFIFOE: Receive FIFO empty interrupt
527 * @arg SDIO_IT_TXDAVL: Data available in transmit FIFO interrupt
528 * @arg SDIO_IT_RXDAVL: Data available in receive FIFO interrupt
529 * @arg SDIO_IT_SDIOIT: SD I/O interrupt received interrupt
530 * @retval The new state of SD IT (SET or RESET).
531 */
532 #define __HAL_SD_GET_IT(__HANDLE__, __INTERRUPT__) __SDIO_GET_IT((__HANDLE__)->Instance, (__INTERRUPT__))
533
534 /**
535 * @brief Clear the SD's interrupt pending bits.
536 * @param __HANDLE__: SD Handle
537 * @param __INTERRUPT__: specifies the interrupt pending bit to clear.
538 * This parameter can be one or a combination of the following values:
539 * @arg SDIO_IT_CCRCFAIL: Command response received (CRC check failed) interrupt
540 * @arg SDIO_IT_DCRCFAIL: Data block sent/received (CRC check failed) interrupt
541 * @arg SDIO_IT_CTIMEOUT: Command response timeout interrupt
542 * @arg SDIO_IT_DTIMEOUT: Data timeout interrupt
543 * @arg SDIO_IT_TXUNDERR: Transmit FIFO underrun error interrupt
544 * @arg SDIO_IT_RXOVERR: Received FIFO overrun error interrupt
545 * @arg SDIO_IT_CMDREND: Command response received (CRC check passed) interrupt
546 * @arg SDIO_IT_CMDSENT: Command sent (no response required) interrupt
547 * @arg SDIO_IT_DATAEND: Data end (data counter, SDMMC_DCOUNT, is zero) interrupt
548 * @arg SDIO_IT_SDIOIT: SD I/O interrupt received interrupt
549 * @retval None
550 */
551 #define __HAL_SD_CLEAR_IT(__HANDLE__, __INTERRUPT__) __SDIO_CLEAR_IT((__HANDLE__)->Instance, (__INTERRUPT__))
552
553 /**
554 * @}
555 */
556
557 /* Exported functions --------------------------------------------------------*/
558 /** @defgroup SD_Exported_Functions SD Exported Functions
559 * @{
560 */
561
562 /** @defgroup SD_Exported_Functions_Group1 Initialization and de-initialization functions
563 * @{
564 */
565 HAL_StatusTypeDef HAL_SD_Init(SD_HandleTypeDef *hsd);
566 HAL_StatusTypeDef HAL_SD_InitCard(SD_HandleTypeDef *hsd);
567 HAL_StatusTypeDef HAL_SD_DeInit (SD_HandleTypeDef *hsd);
568 void HAL_SD_MspInit(SD_HandleTypeDef *hsd);
569 void HAL_SD_MspDeInit(SD_HandleTypeDef *hsd);
570 /**
571 * @}
572 */
573
574 /** @defgroup SD_Exported_Functions_Group2 Input and Output operation functions
575 * @{
576 */
577 /* Blocking mode: Polling */
578 HAL_StatusTypeDef HAL_SD_ReadBlocks(SD_HandleTypeDef *hsd, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks, uint32_t Timeout);
579 HAL_StatusTypeDef HAL_SD_WriteBlocks(SD_HandleTypeDef *hsd, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks, uint32_t Timeout);
580 HAL_StatusTypeDef HAL_SD_Erase(SD_HandleTypeDef *hsd, uint32_t BlockStartAdd, uint32_t BlockEndAdd);
581 /* Non-Blocking mode: IT */
582 HAL_StatusTypeDef HAL_SD_ReadBlocks_IT(SD_HandleTypeDef *hsd, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks);
583 HAL_StatusTypeDef HAL_SD_WriteBlocks_IT(SD_HandleTypeDef *hsd, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks);
584 /* Non-Blocking mode: DMA */
585 HAL_StatusTypeDef HAL_SD_ReadBlocks_DMA(SD_HandleTypeDef *hsd, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks);
586 HAL_StatusTypeDef HAL_SD_WriteBlocks_DMA(SD_HandleTypeDef *hsd, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks);
587
588 void HAL_SD_IRQHandler(SD_HandleTypeDef *hsd);
589
590 /* Callback in non blocking modes (DMA) */
591 void HAL_SD_TxCpltCallback(SD_HandleTypeDef *hsd);
592 void HAL_SD_RxCpltCallback(SD_HandleTypeDef *hsd);
593 void HAL_SD_ErrorCallback(SD_HandleTypeDef *hsd);
594 void HAL_SD_AbortCallback(SD_HandleTypeDef *hsd);
595 /**
596 * @}
597 */
598
599 /** @defgroup SD_Exported_Functions_Group3 Peripheral Control functions
600 * @{
601 */
602 HAL_StatusTypeDef HAL_SD_ConfigWideBusOperation(SD_HandleTypeDef *hsd, uint32_t WideMode);
603 /**
604 * @}
605 */
606
607 /** @defgroup SD_Exported_Functions_Group4 SD card related functions
608 * @{
609 */
610 HAL_StatusTypeDef HAL_SD_SendSDStatus(SD_HandleTypeDef *hsd, uint32_t *pSDstatus);
611 HAL_SD_CardStateTypeDef HAL_SD_GetCardState(SD_HandleTypeDef *hsd);
612 HAL_StatusTypeDef HAL_SD_GetCardCID(SD_HandleTypeDef *hsd, HAL_SD_CardCIDTypeDef *pCID);
613 HAL_StatusTypeDef HAL_SD_GetCardCSD(SD_HandleTypeDef *hsd, HAL_SD_CardCSDTypeDef *pCSD);
614 HAL_StatusTypeDef HAL_SD_GetCardStatus(SD_HandleTypeDef *hsd, HAL_SD_CardStatusTypeDef *pStatus);
615 HAL_StatusTypeDef HAL_SD_GetCardInfo(SD_HandleTypeDef *hsd, HAL_SD_CardInfoTypeDef *pCardInfo);
616 /**
617 * @}
618 */
619
620 /** @defgroup SD_Exported_Functions_Group5 Peripheral State and Errors functions
621 * @{
622 */
623 HAL_SD_StateTypeDef HAL_SD_GetState(SD_HandleTypeDef *hsd);
624 uint32_t HAL_SD_GetError(SD_HandleTypeDef *hsd);
625 /**
626 * @}
627 */
628
629 /** @defgroup SD_Exported_Functions_Group6 Perioheral Abort management
630 * @{
631 */
632 HAL_StatusTypeDef HAL_SD_Abort(SD_HandleTypeDef *hsd);
633 HAL_StatusTypeDef HAL_SD_Abort_IT(SD_HandleTypeDef *hsd);
634 /**
635 * @}
636 */
637
638 /* Private types -------------------------------------------------------------*/
639 /** @defgroup SD_Private_Types SD Private Types
640 * @{
641 */
642
643 /**
644 * @}
645 */
646
647 /* Private defines -----------------------------------------------------------*/
648 /** @defgroup SD_Private_Defines SD Private Defines
649 * @{
650 */
651
652 /**
653 * @}
654 */
655
656 /* Private variables ---------------------------------------------------------*/
657 /** @defgroup SD_Private_Variables SD Private Variables
658 * @{
659 */
660
661 /**
662 * @}
663 */
664
665 /* Private constants ---------------------------------------------------------*/
666 /** @defgroup SD_Private_Constants SD Private Constants
667 * @{
668 */
669
670 /**
671 * @}
672 */
673
674 /* Private macros ------------------------------------------------------------*/
675 /** @defgroup SD_Private_Macros SD Private Macros
676 * @{
677 */
678
679 /**
680 * @}
681 */
682
683 /* Private functions prototypes ----------------------------------------------*/
684 /** @defgroup SD_Private_Functions_Prototypes SD Private Functions Prototypes
685 * @{
686 */
687
688 /**
689 * @}
690 */
691
692 /* Private functions ---------------------------------------------------------*/
693 /** @defgroup SD_Private_Functions SD Private Functions
694 * @{
695 */
696
697 /**
698 * @}
699 */
700
701
702 /**
703 * @}
704 */
705
706 /**
707 * @}
708 */
709
710 /**
711 * @}
712 */
713
714 #endif /* STM32F405xx || STM32F415xx || STM32F407xx || STM32F417xx || STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx ||
715 STM32F401xC || STM32F401xE || STM32F411xE || STM32F446xx || STM32F469xx || STM32F479xx || STM32F412Zx || STM32F412Vx ||
716 STM32F412Rx || STM32F412Cx || STM32F413xx || STM32F423xx */
717
718 #ifdef __cplusplus
719 }
720 #endif
721
722
723 #endif /* __STM32F4xx_HAL_SD_H */
724
725 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/