Mercurial > public > ostc4

comparison Common/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_sd.h @ 128:c78bcbd5deda FlipDisplay

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