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