?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Merge pull request #11270 from haslinghuis/rename_attr
[betaflight.git] / lib / main / STM32F1 / Drivers / STM32F1xx_HAL_Driver / Inc / stm32f1xx_hal_mmc.h
blobe746eaafd0b3733545cbd96e2afcd8d34c3cd788
1 /**
2 ******************************************************************************
3 * @file stm32f1xx_hal_mmc.h
4 * @author MCD Application Team
5 * @version V1.1.1
6 * @date 12-May-2017
7 * @brief Header file of MMC 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_MMC_H
40 #define __STM32F1xx_HAL_MMC_H
41
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45
46 #if defined(STM32F103xE) || defined(STM32F103xG)
47
48 /* Includes ------------------------------------------------------------------*/
49 #include "stm32f1xx_ll_sdmmc.h"
50
51 /** @addtogroup STM32F1xx_HAL_Driver
52 * @{
53 */
54
55 /** @defgroup MMC MMC
56 * @brief MMC HAL module driver
57 * @{
58 */
59
60 /* Exported types ------------------------------------------------------------*/
61 /** @defgroup MMC_Exported_Types MMC Exported Types
62 * @{
63 */
64
65 /** @defgroup MMC_Exported_Types_Group1 MMC State enumeration structure
66 * @{
67 */
68 typedef enum
69 {
70 HAL_MMC_STATE_RESET = 0x00000000U, /*!< MMC not yet initialized or disabled */
71 HAL_MMC_STATE_READY = 0x00000001U, /*!< MMC initialized and ready for use */
72 HAL_MMC_STATE_TIMEOUT = 0x00000002U, /*!< MMC Timeout state */
73 HAL_MMC_STATE_BUSY = 0x00000003U, /*!< MMC process ongoing */
74 HAL_MMC_STATE_PROGRAMMING = 0x00000004U, /*!< MMC Programming State */
75 HAL_MMC_STATE_RECEIVING = 0x00000005U, /*!< MMC Receinving State */
76 HAL_MMC_STATE_TRANSFER = 0x00000006U, /*!< MMC Transfert State */
77 HAL_MMC_STATE_ERROR = 0x0000000FU /*!< MMC is in error state */
78 }HAL_MMC_StateTypeDef;
79 /**
80 * @}
81 */
82
83 /** @defgroup MMC_Exported_Types_Group2 MMC Card State enumeration structure
84 * @{
85 */
86 typedef enum
87 {
88 HAL_MMC_CARD_READY = 0x00000001U, /*!< Card state is ready */
89 HAL_MMC_CARD_IDENTIFICATION = 0x00000002U, /*!< Card is in identification state */
90 HAL_MMC_CARD_STANDBY = 0x00000003U, /*!< Card is in standby state */
91 HAL_MMC_CARD_TRANSFER = 0x00000004U, /*!< Card is in transfer state */
92 HAL_MMC_CARD_SENDING = 0x00000005U, /*!< Card is sending an operation */
93 HAL_MMC_CARD_RECEIVING = 0x00000006U, /*!< Card is receiving operation information */
94 HAL_MMC_CARD_PROGRAMMING = 0x00000007U, /*!< Card is in programming state */
95 HAL_MMC_CARD_DISCONNECTED = 0x00000008U, /*!< Card is disconnected */
96 HAL_MMC_CARD_ERROR = 0x000000FFU /*!< Card response Error */
97 }HAL_MMC_CardStateTypeDef;
98 /**
99 * @}
100 */
101
102 /** @defgroup MMC_Exported_Types_Group3 MMC Handle Structure definition
103 * @{
104 */
105 #define MMC_InitTypeDef SDIO_InitTypeDef
106 #define MMC_TypeDef SDIO_TypeDef
107
108 /**
109 * @brief MMC Card Information Structure definition
110 */
111 typedef struct
112 {
113 uint32_t CardType; /*!< Specifies the card Type */
114
115 uint32_t Class; /*!< Specifies the class of the card class */
116
117 uint32_t RelCardAdd; /*!< Specifies the Relative Card Address */
118
119 uint32_t BlockNbr; /*!< Specifies the Card Capacity in blocks */
120
121 uint32_t BlockSize; /*!< Specifies one block size in bytes */
122
123 uint32_t LogBlockNbr; /*!< Specifies the Card logical Capacity in blocks */
124
125 uint32_t LogBlockSize; /*!< Specifies logical block size in bytes */
126
127 }HAL_MMC_CardInfoTypeDef;
128
129 /**
130 * @brief MMC handle Structure definition
131 */
132 typedef struct
133 {
134 MMC_TypeDef *Instance; /*!< MMC registers base address */
135
136 MMC_InitTypeDef Init; /*!< MMC required parameters */
137
138 HAL_LockTypeDef Lock; /*!< MMC locking object */
139
140 uint32_t *pTxBuffPtr; /*!< Pointer to MMC Tx transfer Buffer */
141
142 uint32_t TxXferSize; /*!< MMC Tx Transfer size */
143
144 uint32_t *pRxBuffPtr; /*!< Pointer to MMC Rx transfer Buffer */
145
146 uint32_t RxXferSize; /*!< MMC Rx Transfer size */
147
148 __IO uint32_t Context; /*!< MMC transfer context */
149
150 __IO HAL_MMC_StateTypeDef State; /*!< MMC card State */
151
152 __IO uint32_t ErrorCode; /*!< MMC Card Error codes */
153
154 DMA_HandleTypeDef *hdmarx; /*!< MMC Rx DMA handle parameters */
155
156 DMA_HandleTypeDef *hdmatx; /*!< MMC Tx DMA handle parameters */
157
158 HAL_MMC_CardInfoTypeDef MmcCard; /*!< MMC Card information */
159
160 uint32_t CSD[4U]; /*!< MMC card specific data table */
161
162 uint32_t CID[4U]; /*!< MMC card identification number table */
163
164 }MMC_HandleTypeDef;
165
166 /**
167 * @}
168 */
169
170 /** @defgroup MMC_Exported_Types_Group4 Card Specific Data: CSD Register
171 * @{
172 */
173 typedef struct
174 {
175 __IO uint8_t CSDStruct; /*!< CSD structure */
176 __IO uint8_t SysSpecVersion; /*!< System specification version */
177 __IO uint8_t Reserved1; /*!< Reserved */
178 __IO uint8_t TAAC; /*!< Data read access time 1 */
179 __IO uint8_t NSAC; /*!< Data read access time 2 in CLK cycles */
180 __IO uint8_t MaxBusClkFrec; /*!< Max. bus clock frequency */
181 __IO uint16_t CardComdClasses; /*!< Card command classes */
182 __IO uint8_t RdBlockLen; /*!< Max. read data block length */
183 __IO uint8_t PartBlockRead; /*!< Partial blocks for read allowed */
184 __IO uint8_t WrBlockMisalign; /*!< Write block misalignment */
185 __IO uint8_t RdBlockMisalign; /*!< Read block misalignment */
186 __IO uint8_t DSRImpl; /*!< DSR implemented */
187 __IO uint8_t Reserved2; /*!< Reserved */
188 __IO uint32_t DeviceSize; /*!< Device Size */
189 __IO uint8_t MaxRdCurrentVDDMin; /*!< Max. read current @ VDD min */
190 __IO uint8_t MaxRdCurrentVDDMax; /*!< Max. read current @ VDD max */
191 __IO uint8_t MaxWrCurrentVDDMin; /*!< Max. write current @ VDD min */
192 __IO uint8_t MaxWrCurrentVDDMax; /*!< Max. write current @ VDD max */
193 __IO uint8_t DeviceSizeMul; /*!< Device size multiplier */
194 __IO uint8_t EraseGrSize; /*!< Erase group size */
195 __IO uint8_t EraseGrMul; /*!< Erase group size multiplier */
196 __IO uint8_t WrProtectGrSize; /*!< Write protect group size */
197 __IO uint8_t WrProtectGrEnable; /*!< Write protect group enable */
198 __IO uint8_t ManDeflECC; /*!< Manufacturer default ECC */
199 __IO uint8_t WrSpeedFact; /*!< Write speed factor */
200 __IO uint8_t MaxWrBlockLen; /*!< Max. write data block length */
201 __IO uint8_t WriteBlockPaPartial; /*!< Partial blocks for write allowed */
202 __IO uint8_t Reserved3; /*!< Reserved */
203 __IO uint8_t ContentProtectAppli; /*!< Content protection application */
204 __IO uint8_t FileFormatGrouop; /*!< File format group */
205 __IO uint8_t CopyFlag; /*!< Copy flag (OTP) */
206 __IO uint8_t PermWrProtect; /*!< Permanent write protection */
207 __IO uint8_t TempWrProtect; /*!< Temporary write protection */
208 __IO uint8_t FileFormat; /*!< File format */
209 __IO uint8_t ECC; /*!< ECC code */
210 __IO uint8_t CSD_CRC; /*!< CSD CRC */
211 __IO uint8_t Reserved4; /*!< Always 1 */
212
213 }HAL_MMC_CardCSDTypeDef;
214 /**
215 * @}
216 */
217
218 /** @defgroup MMC_Exported_Types_Group5 Card Identification Data: CID Register
219 * @{
220 */
221 typedef struct
222 {
223 __IO uint8_t ManufacturerID; /*!< Manufacturer ID */
224 __IO uint16_t OEM_AppliID; /*!< OEM/Application ID */
225 __IO uint32_t ProdName1; /*!< Product Name part1 */
226 __IO uint8_t ProdName2; /*!< Product Name part2 */
227 __IO uint8_t ProdRev; /*!< Product Revision */
228 __IO uint32_t ProdSN; /*!< Product Serial Number */
229 __IO uint8_t Reserved1; /*!< Reserved1 */
230 __IO uint16_t ManufactDate; /*!< Manufacturing Date */
231 __IO uint8_t CID_CRC; /*!< CID CRC */
232 __IO uint8_t Reserved2; /*!< Always 1 */
233
234 }HAL_MMC_CardCIDTypeDef;
235 /**
236 * @}
237 */
238
239 /** @defgroup MMC_Exported_Types_Group6 MMC Card Status returned by ACMD13
240 * @{
241 */
242 typedef struct
243 {
244 __IO uint8_t DataBusWidth; /*!< Shows the currently defined data bus width */
245 __IO uint8_t SecuredMode; /*!< Card is in secured mode of operation */
246 __IO uint16_t CardType; /*!< Carries information about card type */
247 __IO uint32_t ProtectedAreaSize; /*!< Carries information about the capacity of protected area */
248 __IO uint8_t SpeedClass; /*!< Carries information about the speed class of the card */
249 __IO uint8_t PerformanceMove; /*!< Carries information about the card's performance move */
250 __IO uint8_t AllocationUnitSize; /*!< Carries information about the card's allocation unit size */
251 __IO uint16_t EraseSize; /*!< Determines the number of AUs to be erased in one operation */
252 __IO uint8_t EraseTimeout; /*!< Determines the timeout for any number of AU erase */
253 __IO uint8_t EraseOffset; /*!< Carries information about the erase offset */
254
255 }HAL_MMC_CardStatusTypeDef;
256 /**
257 * @}
258 */
259
260 /**
261 * @}
262 */
263
264 /* Exported constants --------------------------------------------------------*/
265 /** @defgroup MMC_Exported_Constants Exported Constants
266 * @{
267 */
268
269 #define BLOCKSIZE 512U /*!< Block size is 512 bytes */
270
271 #define CAPACITY 0x400000U /*!< Log Block Nuumber for 2 G bytes Cards */
272
273 /** @defgroup MMC_Exported_Constansts_Group1 MMC Error status enumeration Structure definition
274 * @{
275 */
276 #define HAL_MMC_ERROR_NONE SDMMC_ERROR_NONE /*!< No error */
277 #define HAL_MMC_ERROR_CMD_CRC_FAIL SDMMC_ERROR_CMD_CRC_FAIL /*!< Command response received (but CRC check failed) */
278 #define HAL_MMC_ERROR_DATA_CRC_FAIL SDMMC_ERROR_DATA_CRC_FAIL /*!< Data block sent/received (CRC check failed) */
279 #define HAL_MMC_ERROR_CMD_RSP_TIMEOUT SDMMC_ERROR_CMD_RSP_TIMEOUT /*!< Command response timeout */
280 #define HAL_MMC_ERROR_DATA_TIMEOUT SDMMC_ERROR_DATA_TIMEOUT /*!< Data timeout */
281 #define HAL_MMC_ERROR_TX_UNDERRUN SDMMC_ERROR_TX_UNDERRUN /*!< Transmit FIFO underrun */
282 #define HAL_MMC_ERROR_RX_OVERRUN SDMMC_ERROR_RX_OVERRUN /*!< Receive FIFO overrun */
283 #define HAL_MMC_ERROR_ADDR_MISALIGNED SDMMC_ERROR_ADDR_MISALIGNED /*!< Misaligned address */
284 #define HAL_MMC_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_MMC_ERROR_ERASE_SEQ_ERR SDMMC_ERROR_ERASE_SEQ_ERR /*!< An error in the sequence of erase command occurs */
287 #define HAL_MMC_ERROR_BAD_ERASE_PARAM SDMMC_ERROR_BAD_ERASE_PARAM /*!< An invalid selection for erase groups */
288 #define HAL_MMC_ERROR_WRITE_PROT_VIOLATION SDMMC_ERROR_WRITE_PROT_VIOLATION /*!< Attempt to program a write protect block */
289 #define HAL_MMC_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_MMC_ERROR_COM_CRC_FAILED SDMMC_ERROR_COM_CRC_FAILED /*!< CRC check of the previous command failed */
292 #define HAL_MMC_ERROR_ILLEGAL_CMD SDMMC_ERROR_ILLEGAL_CMD /*!< Command is not legal for the card state */
293 #define HAL_MMC_ERROR_CARD_ECC_FAILED SDMMC_ERROR_CARD_ECC_FAILED /*!< Card internal ECC was applied but failed to correct the data */
294 #define HAL_MMC_ERROR_CC_ERR SDMMC_ERROR_CC_ERR /*!< Internal card controller error */
295 #define HAL_MMC_ERROR_GENERAL_UNKNOWN_ERR SDMMC_ERROR_GENERAL_UNKNOWN_ERR /*!< General or unknown error */
296 #define HAL_MMC_ERROR_STREAM_READ_UNDERRUN SDMMC_ERROR_STREAM_READ_UNDERRUN /*!< The card could not sustain data reading in stream rmode */
297 #define HAL_MMC_ERROR_STREAM_WRITE_OVERRUN SDMMC_ERROR_STREAM_WRITE_OVERRUN /*!< The card could not sustain data programming in stream mode */
298 #define HAL_MMC_ERROR_CID_CSD_OVERWRITE SDMMC_ERROR_CID_CSD_OVERWRITE /*!< CID/CSD overwrite error */
299 #define HAL_MMC_ERROR_WP_ERASE_SKIP SDMMC_ERROR_WP_ERASE_SKIP /*!< Only partial address space was erased */
300 #define HAL_MMC_ERROR_CARD_ECC_DISABLED SDMMC_ERROR_CARD_ECC_DISABLED /*!< Command has been executed without using internal ECC */
301 #define HAL_MMC_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_MMC_ERROR_AKE_SEQ_ERR SDMMC_ERROR_AKE_SEQ_ERR /*!< Error in sequence of authentication */
304 #define HAL_MMC_ERROR_INVALID_VOLTRANGE SDMMC_ERROR_INVALID_VOLTRANGE /*!< Error in case of invalid voltage range */
305 #define HAL_MMC_ERROR_ADDR_OUT_OF_RANGE SDMMC_ERROR_ADDR_OUT_OF_RANGE /*!< Error when addressed block is out of range */
306 #define HAL_MMC_ERROR_REQUEST_NOT_APPLICABLE SDMMC_ERROR_REQUEST_NOT_APPLICABLE /*!< Error when command request is not applicable */
307 #define HAL_MMC_ERROR_PARAM SDMMC_ERROR_INVALID_PARAMETER /*!< the used parameter is not valid */
308 #define HAL_MMC_ERROR_UNSUPPORTED_FEATURE SDMMC_ERROR_UNSUPPORTED_FEATURE /*!< Error when feature is not insupported */
309 #define HAL_MMC_ERROR_BUSY SDMMC_ERROR_BUSY /*!< Error when transfer process is busy */
310 #define HAL_MMC_ERROR_DMA SDMMC_ERROR_DMA /*!< Error while DMA transfer */
311 #define HAL_MMC_ERROR_TIMEOUT SDMMC_ERROR_TIMEOUT /*!< Timeout error */
312 /**
313 * @}
314 */
315
316 /** @defgroup MMC_Exported_Constansts_Group2 MMC context enumeration structure
317 * @{
318 */
319 #define MMC_CONTEXT_NONE 0x00000000U /*!< None */
320 #define MMC_CONTEXT_READ_SINGLE_BLOCK 0x00000001U /*!< Read single block operation */
321 #define MMC_CONTEXT_READ_MULTIPLE_BLOCK 0x00000002U /*!< Read multiple blocks operation */
322 #define MMC_CONTEXT_WRITE_SINGLE_BLOCK 0x00000010U /*!< Write single block operation */
323 #define MMC_CONTEXT_WRITE_MULTIPLE_BLOCK 0x00000020U /*!< Write multiple blocks operation */
324 #define MMC_CONTEXT_IT 0x00000008U /*!< Process in Interrupt mode */
325 #define MMC_CONTEXT_DMA 0x00000080U /*!< Process in DMA mode */
326 /**
327 * @}
328 */
329
330 /** @defgroup MMC_Exported_Constansts_Group3 MMC Voltage mode
331 * @{
332 */
333 /**
334 * @brief
335 */
336 #define MMC_HIGH_VOLTAGE_RANGE 0x80FF8000U /*!< VALUE OF ARGUMENT */
337 #define MMC_DUAL_VOLTAGE_RANGE 0x80FF8080U /*!< VALUE OF ARGUMENT */
338 #define eMMC_HIGH_VOLTAGE_RANGE 0xC0FF8000U /*!< for eMMC > 2Gb sector mode */
339 #define eMMC_DUAL_VOLTAGE_RANGE 0xC0FF8080U /*!< for eMMC > 2Gb sector mode */
340 #define MMC_INVALID_VOLTAGE_RANGE 0x0001FF01U
341 /**
342 * @}
343 */
344
345 /** @defgroup MMC_Exported_Constansts_Group4 MMC Memory Cards
346 * @{
347 */
348 #define MMC_HIGH_VOLTAGE_CARD 0x00000000U
349 #define MMC_DUAL_VOLTAGE_CARD 0x00000001U
350 /**
351 * @}
352 */
353
354 /**
355 * @}
356 */
357
358 /* Exported macro ------------------------------------------------------------*/
359 /** @defgroup MMC_Exported_macros MMC Exported Macros
360 * @brief macros to handle interrupts and specific clock configurations
361 * @{
362 */
363
364 /**
365 * @brief Enable the MMC device.
366 * @retval None
367 */
368 #define __HAL_MMC_ENABLE(__HANDLE__) __SDIO_ENABLE((__HANDLE__)->Instance)
369
370 /**
371 * @brief Disable the MMC device.
372 * @retval None
373 */
374 #define __HAL_MMC_DISABLE(__HANDLE__) __SDIO_DISABLE((__HANDLE__)->Instance)
375
376 /**
377 * @brief Enable the SDMMC DMA transfer.
378 * @retval None
379 */
380 #define __HAL_MMC_DMA_ENABLE(__HANDLE__) __SDIO_DMA_ENABLE((__HANDLE__)->Instance)
381
382 /**
383 * @brief Disable the SDMMC DMA transfer.
384 * @retval None
385 */
386 #define __HAL_MMC_DMA_DISABLE(__HANDLE__) __SDIO_DMA_DISABLE((__HANDLE__)->Instance)
387
388 /**
389 * @brief Enable the MMC device interrupt.
390 * @param __HANDLE__: MMC 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_MMC_ENABLE_IT(__HANDLE__, __INTERRUPT__) __SDIO_ENABLE_IT((__HANDLE__)->Instance, (__INTERRUPT__))
418
419 /**
420 * @brief Disable the MMC device interrupt.
421 * @param __HANDLE__: MMC 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_MMC_DISABLE_IT(__HANDLE__, __INTERRUPT__) __SDIO_DISABLE_IT((__HANDLE__)->Instance, (__INTERRUPT__))
449
450 /**
451 * @brief Check whether the specified MMC flag is set or not.
452 * @param __HANDLE__: MMC 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 MMC FLAG (SET or RESET).
478 */
479 #define __HAL_MMC_GET_FLAG(__HANDLE__, __FLAG__) __SDIO_GET_FLAG((__HANDLE__)->Instance, (__FLAG__))
480
481 /**
482 * @brief Clear the MMC's pending flags.
483 * @param __HANDLE__: MMC 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_MMC_CLEAR_FLAG(__HANDLE__, __FLAG__) __SDIO_CLEAR_FLAG((__HANDLE__)->Instance, (__FLAG__))
500
501 /**
502 * @brief Check whether the specified MMC interrupt has occurred or not.
503 * @param __HANDLE__: MMC 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 MMC IT (SET or RESET).
529 */
530 #define __HAL_MMC_GET_IT(__HANDLE__, __INTERRUPT__) __SDIO_GET_IT((__HANDLE__)->Instance, (__INTERRUPT__))
531
532 /**
533 * @brief Clear the MMC's interrupt pending bits.
534 * @param __HANDLE__: MMC 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_MMC_CLEAR_IT(__HANDLE__, __INTERRUPT__) __SDIO_CLEAR_IT((__HANDLE__)->Instance, (__INTERRUPT__))
550
551 /**
552 * @}
553 */
554
555 /* Exported functions --------------------------------------------------------*/
556 /** @defgroup MMC_Exported_Functions MMC Exported Functions
557 * @{
558 */
559
560 /** @defgroup MMC_Exported_Functions_Group1 Initialization and de-initialization functions
561 * @{
562 */
563 HAL_StatusTypeDef HAL_MMC_Init(MMC_HandleTypeDef *hmmc);
564 HAL_StatusTypeDef HAL_MMC_InitCard(MMC_HandleTypeDef *hmmc);
565 HAL_StatusTypeDef HAL_MMC_DeInit (MMC_HandleTypeDef *hmmc);
566 void HAL_MMC_MspInit(MMC_HandleTypeDef *hmmc);
567 void HAL_MMC_MspDeInit(MMC_HandleTypeDef *hmmc);
568 /**
569 * @}
570 */
571
572 /** @defgroup MMC_Exported_Functions_Group2 Input and Output operation functions
573 * @{
574 */
575 /* Blocking mode: Polling */
576 HAL_StatusTypeDef HAL_MMC_ReadBlocks(MMC_HandleTypeDef *hmmc, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks, uint32_t Timeout);
577 HAL_StatusTypeDef HAL_MMC_WriteBlocks(MMC_HandleTypeDef *hmmc, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks, uint32_t Timeout);
578 HAL_StatusTypeDef HAL_MMC_Erase(MMC_HandleTypeDef *hmmc, uint32_t BlockStartAdd, uint32_t BlockEndAdd);
579 /* Non-Blocking mode: IT */
580 HAL_StatusTypeDef HAL_MMC_ReadBlocks_IT(MMC_HandleTypeDef *hmmc, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks);
581 HAL_StatusTypeDef HAL_MMC_WriteBlocks_IT(MMC_HandleTypeDef *hmmc, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks);
582 /* Non-Blocking mode: DMA */
583 HAL_StatusTypeDef HAL_MMC_ReadBlocks_DMA(MMC_HandleTypeDef *hmmc, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks);
584 HAL_StatusTypeDef HAL_MMC_WriteBlocks_DMA(MMC_HandleTypeDef *hmmc, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks);
585
586 void HAL_MMC_IRQHandler(MMC_HandleTypeDef *hmmc);
587
588 /* Callback in non blocking modes (DMA) */
589 void HAL_MMC_TxCpltCallback(MMC_HandleTypeDef *hmmc);
590 void HAL_MMC_RxCpltCallback(MMC_HandleTypeDef *hmmc);
591 void HAL_MMC_ErrorCallback(MMC_HandleTypeDef *hmmc);
592 void HAL_MMC_AbortCallback(MMC_HandleTypeDef *hmmc);
593 /**
594 * @}
595 */
596
597 /** @defgroup MMC_Exported_Functions_Group3 Peripheral Control functions
598 * @{
599 */
600 HAL_StatusTypeDef HAL_MMC_ConfigWideBusOperation(MMC_HandleTypeDef *hmmc, uint32_t WideMode);
601 /**
602 * @}
603 */
604
605 /** @defgroup MMC_Exported_Functions_Group4 MMC card related functions
606 * @{
607 */
608 HAL_MMC_CardStateTypeDef HAL_MMC_GetCardState(MMC_HandleTypeDef *hmmc);
609 HAL_StatusTypeDef HAL_MMC_GetCardCID(MMC_HandleTypeDef *hmmc, HAL_MMC_CardCIDTypeDef *pCID);
610 HAL_StatusTypeDef HAL_MMC_GetCardCSD(MMC_HandleTypeDef *hmmc, HAL_MMC_CardCSDTypeDef *pCSD);
611 HAL_StatusTypeDef HAL_MMC_GetCardInfo(MMC_HandleTypeDef *hmmc, HAL_MMC_CardInfoTypeDef *pCardInfo);
612 /**
613 * @}
614 */
615
616 /** @defgroup MMC_Exported_Functions_Group5 Peripheral State and Errors functions
617 * @{
618 */
619 HAL_MMC_StateTypeDef HAL_MMC_GetState(MMC_HandleTypeDef *hmmc);
620 uint32_t HAL_MMC_GetError(MMC_HandleTypeDef *hmmc);
621 /**
622 * @}
623 */
624
625 /** @defgroup MMC_Exported_Functions_Group6 Perioheral Abort management
626 * @{
627 */
628 HAL_StatusTypeDef HAL_MMC_Abort(MMC_HandleTypeDef *hmmc);
629 HAL_StatusTypeDef HAL_MMC_Abort_IT(MMC_HandleTypeDef *hmmc);
630 /**
631 * @}
632 */
633
634 /* Private types -------------------------------------------------------------*/
635 /** @defgroup MMC_Private_Types MMC Private Types
636 * @{
637 */
638
639 /**
640 * @}
641 */
642
643 /* Private defines -----------------------------------------------------------*/
644 /** @defgroup MMC_Private_Defines MMC Private Defines
645 * @{
646 */
647
648 /**
649 * @}
650 */
651
652 /* Private variables ---------------------------------------------------------*/
653 /** @defgroup MMC_Private_Variables MMC Private Variables
654 * @{
655 */
656
657 /**
658 * @}
659 */
660
661 /* Private constants ---------------------------------------------------------*/
662 /** @defgroup MMC_Private_Constants MMC Private Constants
663 * @{
664 */
665
666 /**
667 * @}
668 */
669
670 /* Private macros ------------------------------------------------------------*/
671 /** @defgroup MMC_Private_Macros MMC Private Macros
672 * @{
673 */
674
675 /**
676 * @}
677 */
678
679 /* Private functions prototypes ----------------------------------------------*/
680 /** @defgroup MMC_Private_Functions_Prototypes MMC Private Functions Prototypes
681 * @{
682 */
683
684 /**
685 * @}
686 */
687
688 /* Private functions ---------------------------------------------------------*/
689 /** @defgroup MMC_Private_Functions MMC Private Functions
690 * @{
691 */
692
693 /**
694 * @}
695 */
696
697 /**
698 * @}
699 */
700
701 /**
702 * @}
703 */
704
705 /**
706 * @}
707 */
708
709 #endif /* STM32F103xE || STM32F103xG */
710
711 #ifdef __cplusplus
712 }
713 #endif
714
715
716 #endif /* __STM32F1xx_HAL_MMC_H */
717
718 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/