Mercurial > public > ostc4

comparison Common/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_mmc.h @ 160:e3ca52b8e7fa

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Merge with FlipDisplay
author heinrichsweikamp
date Thu, 07 Mar 2019 15:06:43 +0100
parents c78bcbd5deda
children
comparison
equal deleted inserted replaced
80:cc2bb7bb8456 160:e3ca52b8e7fa
1 /**
2 ******************************************************************************
3 * @file stm32f4xx_hal_mmc.h
4 * @author MCD Application Team
5 * @brief Header file of MMC 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_MMC_H
38 #define __STM32F4xx_HAL_MMC_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 MMC MMC
58 * @brief MMC HAL module driver
59 * @{
60 */
61
62 /* Exported types ------------------------------------------------------------*/
63 /** @defgroup MMC_Exported_Types MMC Exported Types
64 * @{
65 */
66
67 /** @defgroup MMC_Exported_Types_Group1 MMC State enumeration structure
68 * @{
69 */
70 typedef enum
71 {
72 HAL_MMC_STATE_RESET = 0x00000000U, /*!< MMC not yet initialized or disabled */
73 HAL_MMC_STATE_READY = 0x00000001U, /*!< MMC initialized and ready for use */
74 HAL_MMC_STATE_TIMEOUT = 0x00000002U, /*!< MMC Timeout state */
75 HAL_MMC_STATE_BUSY = 0x00000003U, /*!< MMC process ongoing */
76 HAL_MMC_STATE_PROGRAMMING = 0x00000004U, /*!< MMC Programming State */
77 HAL_MMC_STATE_RECEIVING = 0x00000005U, /*!< MMC Receinving State */
78 HAL_MMC_STATE_TRANSFER = 0x00000006U, /*!< MMC Transfert State */
79 HAL_MMC_STATE_ERROR = 0x0000000FU /*!< MMC is in error state */
80 }HAL_MMC_StateTypeDef;
81 /**
82 * @}
83 */
84
85 /** @defgroup MMC_Exported_Types_Group2 MMC Card State enumeration structure
86 * @{
87 */
88 typedef enum
89 {
90 HAL_MMC_CARD_READY = 0x00000001U, /*!< Card state is ready */
91 HAL_MMC_CARD_IDENTIFICATION = 0x00000002U, /*!< Card is in identification state */
92 HAL_MMC_CARD_STANDBY = 0x00000003U, /*!< Card is in standby state */
93 HAL_MMC_CARD_TRANSFER = 0x00000004U, /*!< Card is in transfer state */
94 HAL_MMC_CARD_SENDING = 0x00000005U, /*!< Card is sending an operation */
95 HAL_MMC_CARD_RECEIVING = 0x00000006U, /*!< Card is receiving operation information */
96 HAL_MMC_CARD_PROGRAMMING = 0x00000007U, /*!< Card is in programming state */
97 HAL_MMC_CARD_DISCONNECTED = 0x00000008U, /*!< Card is disconnected */
98 HAL_MMC_CARD_ERROR = 0x000000FFU /*!< Card response Error */
99 }HAL_MMC_CardStateTypeDef;
100 /**
101 * @}
102 */
103
104 /** @defgroup MMC_Exported_Types_Group3 MMC Handle Structure definition
105 * @{
106 */
107 #define MMC_InitTypeDef SDIO_InitTypeDef
108 #define MMC_TypeDef SDIO_TypeDef
109
110 /**
111 * @brief MMC Card Information Structure definition
112 */
113 typedef struct
114 {
115 uint32_t CardType; /*!< Specifies the card Type */
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_MMC_CardInfoTypeDef;
130
131 /**
132 * @brief MMC handle Structure definition
133 */
134 typedef struct
135 {
136 MMC_TypeDef *Instance; /*!< MMC registers base address */
137
138 MMC_InitTypeDef Init; /*!< MMC required parameters */
139
140 HAL_LockTypeDef Lock; /*!< MMC locking object */
141
142 uint32_t *pTxBuffPtr; /*!< Pointer to MMC Tx transfer Buffer */
143
144 uint32_t TxXferSize; /*!< MMC Tx Transfer size */
145
146 uint32_t *pRxBuffPtr; /*!< Pointer to MMC Rx transfer Buffer */
147
148 uint32_t RxXferSize; /*!< MMC Rx Transfer size */
149
150 __IO uint32_t Context; /*!< MMC transfer context */
151
152 __IO HAL_MMC_StateTypeDef State; /*!< MMC card State */
153
154 __IO uint32_t ErrorCode; /*!< MMC Card Error codes */
155
156 DMA_HandleTypeDef *hdmarx; /*!< MMC Rx DMA handle parameters */
157
158 DMA_HandleTypeDef *hdmatx; /*!< MMC Tx DMA handle parameters */
159
160 HAL_MMC_CardInfoTypeDef MmcCard; /*!< MMC Card information */
161
162 uint32_t CSD[4U]; /*!< MMC card specific data table */
163
164 uint32_t CID[4U]; /*!< MMC card identification number table */
165
166 }MMC_HandleTypeDef;
167
168 /**
169 * @}
170 */
171
172 /** @defgroup MMC_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_MMC_CardCSDTypeDef;
216 /**
217 * @}
218 */
219
220 /** @defgroup MMC_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_MMC_CardCIDTypeDef;
237 /**
238 * @}
239 */
240
241 /** @defgroup MMC_Exported_Types_Group6 MMC 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_MMC_CardStatusTypeDef;
258 /**
259 * @}
260 */
261
262 /**
263 * @}
264 */
265
266 /* Exported constants --------------------------------------------------------*/
267 /** @defgroup MMC_Exported_Constants Exported Constants
268 * @{
269 */
270
271 #define BLOCKSIZE 512U /*!< Block size is 512 bytes */
272
273 #define CAPACITY 0x400000U /*!< Log Block Nuumber for 2 G bytes Cards */
274
275 /** @defgroup MMC_Exported_Constansts_Group1 MMC Error status enumeration Structure definition
276 * @{
277 */
278 #define HAL_MMC_ERROR_NONE SDMMC_ERROR_NONE /*!< No error */
279 #define HAL_MMC_ERROR_CMD_CRC_FAIL SDMMC_ERROR_CMD_CRC_FAIL /*!< Command response received (but CRC check failed) */
280 #define HAL_MMC_ERROR_DATA_CRC_FAIL SDMMC_ERROR_DATA_CRC_FAIL /*!< Data block sent/received (CRC check failed) */
281 #define HAL_MMC_ERROR_CMD_RSP_TIMEOUT SDMMC_ERROR_CMD_RSP_TIMEOUT /*!< Command response timeout */
282 #define HAL_MMC_ERROR_DATA_TIMEOUT SDMMC_ERROR_DATA_TIMEOUT /*!< Data timeout */
283 #define HAL_MMC_ERROR_TX_UNDERRUN SDMMC_ERROR_TX_UNDERRUN /*!< Transmit FIFO underrun */
284 #define HAL_MMC_ERROR_RX_OVERRUN SDMMC_ERROR_RX_OVERRUN /*!< Receive FIFO overrun */
285 #define HAL_MMC_ERROR_ADDR_MISALIGNED SDMMC_ERROR_ADDR_MISALIGNED /*!< Misaligned address */
286 #define HAL_MMC_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_MMC_ERROR_ERASE_SEQ_ERR SDMMC_ERROR_ERASE_SEQ_ERR /*!< An error in the sequence of erase command occurs */
289 #define HAL_MMC_ERROR_BAD_ERASE_PARAM SDMMC_ERROR_BAD_ERASE_PARAM /*!< An invalid selection for erase groups */
290 #define HAL_MMC_ERROR_WRITE_PROT_VIOLATION SDMMC_ERROR_WRITE_PROT_VIOLATION /*!< Attempt to program a write protect block */
291 #define HAL_MMC_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_MMC_ERROR_COM_CRC_FAILED SDMMC_ERROR_COM_CRC_FAILED /*!< CRC check of the previous command failed */
294 #define HAL_MMC_ERROR_ILLEGAL_CMD SDMMC_ERROR_ILLEGAL_CMD /*!< Command is not legal for the card state */
295 #define HAL_MMC_ERROR_CARD_ECC_FAILED SDMMC_ERROR_CARD_ECC_FAILED /*!< Card internal ECC was applied but failed to correct the data */
296 #define HAL_MMC_ERROR_CC_ERR SDMMC_ERROR_CC_ERR /*!< Internal card controller error */
297 #define HAL_MMC_ERROR_GENERAL_UNKNOWN_ERR SDMMC_ERROR_GENERAL_UNKNOWN_ERR /*!< General or unknown error */
298 #define HAL_MMC_ERROR_STREAM_READ_UNDERRUN SDMMC_ERROR_STREAM_READ_UNDERRUN /*!< The card could not sustain data reading in stream rmode */
299 #define HAL_MMC_ERROR_STREAM_WRITE_OVERRUN SDMMC_ERROR_STREAM_WRITE_OVERRUN /*!< The card could not sustain data programming in stream mode */
300 #define HAL_MMC_ERROR_CID_CSD_OVERWRITE SDMMC_ERROR_CID_CSD_OVERWRITE /*!< CID/CSD overwrite error */
301 #define HAL_MMC_ERROR_WP_ERASE_SKIP SDMMC_ERROR_WP_ERASE_SKIP /*!< Only partial address space was erased */
302 #define HAL_MMC_ERROR_CARD_ECC_DISABLED SDMMC_ERROR_CARD_ECC_DISABLED /*!< Command has been executed without using internal ECC */
303 #define HAL_MMC_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_MMC_ERROR_AKE_SEQ_ERR SDMMC_ERROR_AKE_SEQ_ERR /*!< Error in sequence of authentication */
306 #define HAL_MMC_ERROR_INVALID_VOLTRANGE SDMMC_ERROR_INVALID_VOLTRANGE /*!< Error in case of invalid voltage range */
307 #define HAL_MMC_ERROR_ADDR_OUT_OF_RANGE SDMMC_ERROR_ADDR_OUT_OF_RANGE /*!< Error when addressed block is out of range */
308 #define HAL_MMC_ERROR_REQUEST_NOT_APPLICABLE SDMMC_ERROR_REQUEST_NOT_APPLICABLE /*!< Error when command request is not applicable */
309 #define HAL_MMC_ERROR_PARAM SDMMC_ERROR_INVALID_PARAMETER /*!< the used parameter is not valid */
310 #define HAL_MMC_ERROR_UNSUPPORTED_FEATURE SDMMC_ERROR_UNSUPPORTED_FEATURE /*!< Error when feature is not insupported */
311 #define HAL_MMC_ERROR_BUSY SDMMC_ERROR_BUSY /*!< Error when transfer process is busy */
312 #define HAL_MMC_ERROR_DMA SDMMC_ERROR_DMA /*!< Error while DMA transfer */
313 #define HAL_MMC_ERROR_TIMEOUT SDMMC_ERROR_TIMEOUT /*!< Timeout error */
314
315 /**
316 * @}
317 */
318
319 /** @defgroup MMC_Exported_Constansts_Group2 MMC context enumeration structure
320 * @{
321 */
322 #define MMC_CONTEXT_NONE 0x00000000U /*!< None */
323 #define MMC_CONTEXT_READ_SINGLE_BLOCK 0x00000001U /*!< Read single block operation */
324 #define MMC_CONTEXT_READ_MULTIPLE_BLOCK 0x00000002U /*!< Read multiple blocks operation */
325 #define MMC_CONTEXT_WRITE_SINGLE_BLOCK 0x00000010U /*!< Write single block operation */
326 #define MMC_CONTEXT_WRITE_MULTIPLE_BLOCK 0x00000020U /*!< Write multiple blocks operation */
327 #define MMC_CONTEXT_IT 0x00000008U /*!< Process in Interrupt mode */
328 #define MMC_CONTEXT_DMA 0x00000080U /*!< Process in DMA mode */
329
330 /**
331 * @}
332 */
333
334 /** @defgroup MMC_Exported_Constansts_Group3 MMC Voltage mode
335 * @{
336 */
337 /**
338 * @brief
339 */
340 #define MMC_HIGH_VOLTAGE_RANGE 0x80FF8000U /*!< VALUE OF ARGUMENT */
341 #define MMC_DUAL_VOLTAGE_RANGE 0x80FF8080U /*!< VALUE OF ARGUMENT */
342 #define eMMC_HIGH_VOLTAGE_RANGE 0xC0FF8000U /*!< for eMMC > 2Gb sector mode */
343 #define eMMC_DUAL_VOLTAGE_RANGE 0xC0FF8080U /*!< for eMMC > 2Gb sector mode */
344 #define MMC_INVALID_VOLTAGE_RANGE 0x0001FF01U
345 /**
346 * @}
347 */
348
349 /** @defgroup MMC_Exported_Constansts_Group4 MMC Memory Cards
350 * @{
351 */
352 #define MMC_HIGH_VOLTAGE_CARD 0x00000000U
353 #define MMC_DUAL_VOLTAGE_CARD 0x00000001U
354 /**
355 * @}
356 */
357
358 /**
359 * @}
360 */
361
362 /* Exported macro ------------------------------------------------------------*/
363 /** @defgroup MMC_Exported_macros MMC Exported Macros
364 * @brief macros to handle interrupts and specific clock configurations
365 * @{
366 */
367
368 /**
369 * @brief Enable the MMC device.
370 * @retval None
371 */
372 #define __HAL_MMC_ENABLE(__HANDLE__) __SDIO_ENABLE((__HANDLE__)->Instance)
373
374 /**
375 * @brief Disable the MMC device.
376 * @retval None
377 */
378 #define __HAL_MMC_DISABLE(__HANDLE__) __SDIO_DISABLE((__HANDLE__)->Instance)
379
380 /**
381 * @brief Enable the SDMMC DMA transfer.
382 * @retval None
383 */
384 #define __HAL_MMC_DMA_ENABLE(__HANDLE__) __SDIO_DMA_ENABLE((__HANDLE__)->Instance)
385
386 /**
387 * @brief Disable the SDMMC DMA transfer.
388 * @retval None
389 */
390 #define __HAL_MMC_DMA_DISABLE(__HANDLE__) __SDIO_DMA_DISABLE((__HANDLE__)->Instance)
391
392 /**
393 * @brief Enable the MMC device interrupt.
394 * @param __HANDLE__ MMC Handle
395 * @param __INTERRUPT__ specifies the SDMMC interrupt sources to be enabled.
396 * This parameter can be one or a combination of the following values:
397 * @arg SDIO_IT_CCRCFAIL: Command response received (CRC check failed) interrupt
398 * @arg SDIO_IT_DCRCFAIL: Data block sent/received (CRC check failed) interrupt
399 * @arg SDIO_IT_CTIMEOUT: Command response timeout interrupt
400 * @arg SDIO_IT_DTIMEOUT: Data timeout interrupt
401 * @arg SDIO_IT_TXUNDERR: Transmit FIFO underrun error interrupt
402 * @arg SDIO_IT_RXOVERR: Received FIFO overrun error interrupt
403 * @arg SDIO_IT_CMDREND: Command response received (CRC check passed) interrupt
404 * @arg SDIO_IT_CMDSENT: Command sent (no response required) interrupt
405 * @arg SDIO_IT_DATAEND: Data end (data counter, SDIDCOUNT, is zero) interrupt
406 * @arg SDIO_IT_DBCKEND: Data block sent/received (CRC check passed) interrupt
407 * @arg SDIO_IT_CMDACT: Command transfer in progress interrupt
408 * @arg SDIO_IT_TXACT: Data transmit in progress interrupt
409 * @arg SDIO_IT_RXACT: Data receive in progress interrupt
410 * @arg SDIO_IT_TXFIFOHE: Transmit FIFO Half Empty interrupt
411 * @arg SDIO_IT_RXFIFOHF: Receive FIFO Half Full interrupt
412 * @arg SDIO_IT_TXFIFOF: Transmit FIFO full interrupt
413 * @arg SDIO_IT_RXFIFOF: Receive FIFO full interrupt
414 * @arg SDIO_IT_TXFIFOE: Transmit FIFO empty interrupt
415 * @arg SDIO_IT_RXFIFOE: Receive FIFO empty interrupt
416 * @arg SDIO_IT_TXDAVL: Data available in transmit FIFO interrupt
417 * @arg SDIO_IT_RXDAVL: Data available in receive FIFO interrupt
418 * @arg SDIO_IT_SDIOIT: SD I/O interrupt received interrupt
419 * @retval None
420 */
421 #define __HAL_MMC_ENABLE_IT(__HANDLE__, __INTERRUPT__) __SDIO_ENABLE_IT((__HANDLE__)->Instance, (__INTERRUPT__))
422
423 /**
424 * @brief Disable the MMC device interrupt.
425 * @param __HANDLE__ MMC Handle
426 * @param __INTERRUPT__ specifies the SDMMC interrupt sources to be disabled.
427 * This parameter can be one or a combination of the following values:
428 * @arg SDIO_IT_CCRCFAIL: Command response received (CRC check failed) interrupt
429 * @arg SDIO_IT_DCRCFAIL: Data block sent/received (CRC check failed) interrupt
430 * @arg SDIO_IT_CTIMEOUT: Command response timeout interrupt
431 * @arg SDIO_IT_DTIMEOUT: Data timeout interrupt
432 * @arg SDIO_IT_TXUNDERR: Transmit FIFO underrun error interrupt
433 * @arg SDIO_IT_RXOVERR: Received FIFO overrun error interrupt
434 * @arg SDIO_IT_CMDREND: Command response received (CRC check passed) interrupt
435 * @arg SDIO_IT_CMDSENT: Command sent (no response required) interrupt
436 * @arg SDIO_IT_DATAEND: Data end (data counter, SDIDCOUNT, is zero) interrupt
437 * @arg SDIO_IT_DBCKEND: Data block sent/received (CRC check passed) interrupt
438 * @arg SDIO_IT_CMDACT: Command transfer in progress interrupt
439 * @arg SDIO_IT_TXACT: Data transmit in progress interrupt
440 * @arg SDIO_IT_RXACT: Data receive in progress interrupt
441 * @arg SDIO_IT_TXFIFOHE: Transmit FIFO Half Empty interrupt
442 * @arg SDIO_IT_RXFIFOHF: Receive FIFO Half Full interrupt
443 * @arg SDIO_IT_TXFIFOF: Transmit FIFO full interrupt
444 * @arg SDIO_IT_RXFIFOF: Receive FIFO full interrupt
445 * @arg SDIO_IT_TXFIFOE: Transmit FIFO empty interrupt
446 * @arg SDIO_IT_RXFIFOE: Receive FIFO empty interrupt
447 * @arg SDIO_IT_TXDAVL: Data available in transmit FIFO interrupt
448 * @arg SDIO_IT_RXDAVL: Data available in receive FIFO interrupt
449 * @arg SDIO_IT_SDIOIT: SD I/O interrupt received interrupt
450 * @retval None
451 */
452 #define __HAL_MMC_DISABLE_IT(__HANDLE__, __INTERRUPT__) __SDIO_DISABLE_IT((__HANDLE__)->Instance, (__INTERRUPT__))
453
454 /**
455 * @brief Check whether the specified MMC flag is set or not.
456 * @param __HANDLE__ MMC Handle
457 * @param __FLAG__ specifies the flag to check.
458 * This parameter can be one of the following values:
459 * @arg SDIO_FLAG_CCRCFAIL: Command response received (CRC check failed)
460 * @arg SDIO_FLAG_DCRCFAIL: Data block sent/received (CRC check failed)
461 * @arg SDIO_FLAG_CTIMEOUT: Command response timeout
462 * @arg SDIO_FLAG_DTIMEOUT: Data timeout
463 * @arg SDIO_FLAG_TXUNDERR: Transmit FIFO underrun error
464 * @arg SDIO_FLAG_RXOVERR: Received FIFO overrun error
465 * @arg SDIO_FLAG_CMDREND: Command response received (CRC check passed)
466 * @arg SDIO_FLAG_CMDSENT: Command sent (no response required)
467 * @arg SDIO_FLAG_DATAEND: Data end (data counter, SDIDCOUNT, is zero)
468 * @arg SDIO_FLAG_DBCKEND: Data block sent/received (CRC check passed)
469 * @arg SDIO_FLAG_CMDACT: Command transfer in progress
470 * @arg SDIO_FLAG_TXACT: Data transmit in progress
471 * @arg SDIO_FLAG_RXACT: Data receive in progress
472 * @arg SDIO_FLAG_TXFIFOHE: Transmit FIFO Half Empty
473 * @arg SDIO_FLAG_RXFIFOHF: Receive FIFO Half Full
474 * @arg SDIO_FLAG_TXFIFOF: Transmit FIFO full
475 * @arg SDIO_FLAG_RXFIFOF: Receive FIFO full
476 * @arg SDIO_FLAG_TXFIFOE: Transmit FIFO empty
477 * @arg SDIO_FLAG_RXFIFOE: Receive FIFO empty
478 * @arg SDIO_FLAG_TXDAVL: Data available in transmit FIFO
479 * @arg SDIO_FLAG_RXDAVL: Data available in receive FIFO
480 * @arg SDIO_FLAG_SDIOIT: SD I/O interrupt received
481 * @retval The new state of MMC FLAG (SET or RESET).
482 */
483 #define __HAL_MMC_GET_FLAG(__HANDLE__, __FLAG__) __SDIO_GET_FLAG((__HANDLE__)->Instance, (__FLAG__))
484
485 /**
486 * @brief Clear the MMC's pending flags.
487 * @param __HANDLE__ MMC Handle
488 * @param __FLAG__ specifies the flag to clear.
489 * This parameter can be one or a combination of the following values:
490 * @arg SDIO_FLAG_CCRCFAIL: Command response received (CRC check failed)
491 * @arg SDIO_FLAG_DCRCFAIL: Data block sent/received (CRC check failed)
492 * @arg SDIO_FLAG_CTIMEOUT: Command response timeout
493 * @arg SDIO_FLAG_DTIMEOUT: Data timeout
494 * @arg SDIO_FLAG_TXUNDERR: Transmit FIFO underrun error
495 * @arg SDIO_FLAG_RXOVERR: Received FIFO overrun error
496 * @arg SDIO_FLAG_CMDREND: Command response received (CRC check passed)
497 * @arg SDIO_FLAG_CMDSENT: Command sent (no response required)
498 * @arg SDIO_FLAG_DATAEND: Data end (data counter, SDIDCOUNT, is zero)
499 * @arg SDIO_FLAG_DBCKEND: Data block sent/received (CRC check passed)
500 * @arg SDIO_FLAG_SDIOIT: SD I/O interrupt received
501 * @retval None
502 */
503 #define __HAL_MMC_CLEAR_FLAG(__HANDLE__, __FLAG__) __SDIO_CLEAR_FLAG((__HANDLE__)->Instance, (__FLAG__))
504
505 /**
506 * @brief Check whether the specified MMC interrupt has occurred or not.
507 * @param __HANDLE__ MMC Handle
508 * @param __INTERRUPT__ specifies the SDMMC interrupt source to check.
509 * This parameter can be one of the following values:
510 * @arg SDIO_IT_CCRCFAIL: Command response received (CRC check failed) interrupt
511 * @arg SDIO_IT_DCRCFAIL: Data block sent/received (CRC check failed) interrupt
512 * @arg SDIO_IT_CTIMEOUT: Command response timeout interrupt
513 * @arg SDIO_IT_DTIMEOUT: Data timeout interrupt
514 * @arg SDIO_IT_TXUNDERR: Transmit FIFO underrun error interrupt
515 * @arg SDIO_IT_RXOVERR: Received FIFO overrun error interrupt
516 * @arg SDIO_IT_CMDREND: Command response received (CRC check passed) interrupt
517 * @arg SDIO_IT_CMDSENT: Command sent (no response required) interrupt
518 * @arg SDIO_IT_DATAEND: Data end (data counter, SDIDCOUNT, is zero) interrupt
519 * @arg SDIO_IT_DBCKEND: Data block sent/received (CRC check passed) interrupt
520 * @arg SDIO_IT_CMDACT: Command transfer in progress interrupt
521 * @arg SDIO_IT_TXACT: Data transmit in progress interrupt
522 * @arg SDIO_IT_RXACT: Data receive in progress interrupt
523 * @arg SDIO_IT_TXFIFOHE: Transmit FIFO Half Empty interrupt
524 * @arg SDIO_IT_RXFIFOHF: Receive FIFO Half Full interrupt
525 * @arg SDIO_IT_TXFIFOF: Transmit FIFO full interrupt
526 * @arg SDIO_IT_RXFIFOF: Receive FIFO full interrupt
527 * @arg SDIO_IT_TXFIFOE: Transmit FIFO empty interrupt
528 * @arg SDIO_IT_RXFIFOE: Receive FIFO empty interrupt
529 * @arg SDIO_IT_TXDAVL: Data available in transmit FIFO interrupt
530 * @arg SDIO_IT_RXDAVL: Data available in receive FIFO interrupt
531 * @arg SDIO_IT_SDIOIT: SD I/O interrupt received interrupt
532 * @retval The new state of MMC IT (SET or RESET).
533 */
534 #define __HAL_MMC_GET_IT(__HANDLE__, __INTERRUPT__) __SDIO_GET_IT((__HANDLE__)->Instance, (__INTERRUPT__))
535
536 /**
537 * @brief Clear the MMC's interrupt pending bits.
538 * @param __HANDLE__ MMC Handle
539 * @param __INTERRUPT__ specifies the interrupt pending bit to clear.
540 * This parameter can be one or a combination of the following values:
541 * @arg SDIO_IT_CCRCFAIL: Command response received (CRC check failed) interrupt
542 * @arg SDIO_IT_DCRCFAIL: Data block sent/received (CRC check failed) interrupt
543 * @arg SDIO_IT_CTIMEOUT: Command response timeout interrupt
544 * @arg SDIO_IT_DTIMEOUT: Data timeout interrupt
545 * @arg SDIO_IT_TXUNDERR: Transmit FIFO underrun error interrupt
546 * @arg SDIO_IT_RXOVERR: Received FIFO overrun error interrupt
547 * @arg SDIO_IT_CMDREND: Command response received (CRC check passed) interrupt
548 * @arg SDIO_IT_CMDSENT: Command sent (no response required) interrupt
549 * @arg SDIO_IT_DATAEND: Data end (data counter, SDMMC_DCOUNT, is zero) interrupt
550 * @arg SDIO_IT_SDIOIT: SD I/O interrupt received interrupt
551 * @retval None
552 */
553 #define __HAL_MMC_CLEAR_IT(__HANDLE__, __INTERRUPT__) __SDIO_CLEAR_IT((__HANDLE__)->Instance, (__INTERRUPT__))
554
555 /**
556 * @}
557 */
558
559 /* Exported functions --------------------------------------------------------*/
560 /** @defgroup MMC_Exported_Functions MMC Exported Functions
561 * @{
562 */
563
564 /** @defgroup MMC_Exported_Functions_Group1 Initialization and de-initialization functions
565 * @{
566 */
567 HAL_StatusTypeDef HAL_MMC_Init(MMC_HandleTypeDef *hmmc);
568 HAL_StatusTypeDef HAL_MMC_InitCard(MMC_HandleTypeDef *hmmc);
569 HAL_StatusTypeDef HAL_MMC_DeInit (MMC_HandleTypeDef *hmmc);
570 void HAL_MMC_MspInit(MMC_HandleTypeDef *hmmc);
571 void HAL_MMC_MspDeInit(MMC_HandleTypeDef *hmmc);
572 /**
573 * @}
574 */
575
576 /** @defgroup MMC_Exported_Functions_Group2 Input and Output operation functions
577 * @{
578 */
579 /* Blocking mode: Polling */
580 HAL_StatusTypeDef HAL_MMC_ReadBlocks(MMC_HandleTypeDef *hmmc, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks, uint32_t Timeout);
581 HAL_StatusTypeDef HAL_MMC_WriteBlocks(MMC_HandleTypeDef *hmmc, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks, uint32_t Timeout);
582 HAL_StatusTypeDef HAL_MMC_Erase(MMC_HandleTypeDef *hmmc, uint32_t BlockStartAdd, uint32_t BlockEndAdd);
583 /* Non-Blocking mode: IT */
584 HAL_StatusTypeDef HAL_MMC_ReadBlocks_IT(MMC_HandleTypeDef *hmmc, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks);
585 HAL_StatusTypeDef HAL_MMC_WriteBlocks_IT(MMC_HandleTypeDef *hmmc, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks);
586 /* Non-Blocking mode: DMA */
587 HAL_StatusTypeDef HAL_MMC_ReadBlocks_DMA(MMC_HandleTypeDef *hmmc, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks);
588 HAL_StatusTypeDef HAL_MMC_WriteBlocks_DMA(MMC_HandleTypeDef *hmmc, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks);
589
590 void HAL_MMC_IRQHandler(MMC_HandleTypeDef *hmmc);
591
592 /* Callback in non blocking modes (DMA) */
593 void HAL_MMC_TxCpltCallback(MMC_HandleTypeDef *hmmc);
594 void HAL_MMC_RxCpltCallback(MMC_HandleTypeDef *hmmc);
595 void HAL_MMC_ErrorCallback(MMC_HandleTypeDef *hmmc);
596 void HAL_MMC_AbortCallback(MMC_HandleTypeDef *hmmc);
597 /**
598 * @}
599 */
600
601 /** @defgroup MMC_Exported_Functions_Group3 Peripheral Control functions
602 * @{
603 */
604 HAL_StatusTypeDef HAL_MMC_ConfigWideBusOperation(MMC_HandleTypeDef *hmmc, uint32_t WideMode);
605 /**
606 * @}
607 */
608
609 /** @defgroup MMC_Exported_Functions_Group4 MMC card related functions
610 * @{
611 */
612 HAL_MMC_CardStateTypeDef HAL_MMC_GetCardState(MMC_HandleTypeDef *hmmc);
613 HAL_StatusTypeDef HAL_MMC_GetCardCID(MMC_HandleTypeDef *hmmc, HAL_MMC_CardCIDTypeDef *pCID);
614 HAL_StatusTypeDef HAL_MMC_GetCardCSD(MMC_HandleTypeDef *hmmc, HAL_MMC_CardCSDTypeDef *pCSD);
615 HAL_StatusTypeDef HAL_MMC_GetCardInfo(MMC_HandleTypeDef *hmmc, HAL_MMC_CardInfoTypeDef *pCardInfo);
616 /**
617 * @}
618 */
619
620 /** @defgroup MMC_Exported_Functions_Group5 Peripheral State and Errors functions
621 * @{
622 */
623 HAL_MMC_StateTypeDef HAL_MMC_GetState(MMC_HandleTypeDef *hmmc);
624 uint32_t HAL_MMC_GetError(MMC_HandleTypeDef *hmmc);
625 /**
626 * @}
627 */
628
629 /** @defgroup MMC_Exported_Functions_Group6 Perioheral Abort management
630 * @{
631 */
632 HAL_StatusTypeDef HAL_MMC_Abort(MMC_HandleTypeDef *hmmc);
633 HAL_StatusTypeDef HAL_MMC_Abort_IT(MMC_HandleTypeDef *hmmc);
634 /**
635 * @}
636 */
637
638 /* Private types -------------------------------------------------------------*/
639 /** @defgroup MMC_Private_Types MMC Private Types
640 * @{
641 */
642
643 /**
644 * @}
645 */
646
647 /* Private defines -----------------------------------------------------------*/
648 /** @defgroup MMC_Private_Defines MMC Private Defines
649 * @{
650 */
651
652 /**
653 * @}
654 */
655
656 /* Private variables ---------------------------------------------------------*/
657 /** @defgroup MMC_Private_Variables MMC Private Variables
658 * @{
659 */
660
661 /**
662 * @}
663 */
664
665 /* Private constants ---------------------------------------------------------*/
666 /** @defgroup MMC_Private_Constants MMC Private Constants
667 * @{
668 */
669
670 /**
671 * @}
672 */
673
674 /* Private macros ------------------------------------------------------------*/
675 /** @defgroup MMC_Private_Macros MMC Private Macros
676 * @{
677 */
678
679 /**
680 * @}
681 */
682
683 /* Private functions prototypes ----------------------------------------------*/
684 /** @defgroup MMC_Private_Functions_Prototypes MMC Private Functions Prototypes
685 * @{
686 */
687
688 /**
689 * @}
690 */
691
692 /* Private functions ---------------------------------------------------------*/
693 /** @defgroup MMC_Private_Functions MMC Private Functions
694 * @{
695 */
696
697 /**
698 * @}
699 */
700
701 /**
702 * @}
703 */
704
705 /**
706 * @}
707 */
708
709 /**
710 * @}
711 */
712
713 #endif /* STM32F405xx || STM32F415xx || STM32F407xx || STM32F417xx || STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx ||
714 STM32F401xC || STM32F401xE || STM32F411xE || STM32F446xx || STM32F469xx || STM32F479xx || STM32F412Zx || STM32F412Vx ||
715 STM32F412Rx || STM32F412Cx || STM32F413xx || STM32F423xx */
716
717 #ifdef __cplusplus
718 }
719 #endif
720
721
722 #endif /* __STM32F4xx_HAL_MMC_H */
723
724 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/