stm32l4xx_hal_sd.h 47 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863
  1. /**
  2. ******************************************************************************
  3. * @file stm32l4xx_hal_sd.h
  4. * @author MCD Application Team
  5. * @brief Header file of SD HAL module.
  6. ******************************************************************************
  7. * @attention
  8. *
  9. * Copyright (c) 2017 STMicroelectronics.
  10. * All rights reserved.
  11. *
  12. * This software is licensed under terms that can be found in the LICENSE file
  13. * in the root directory of this software component.
  14. * If no LICENSE file comes with this software, it is provided AS-IS.
  15. *
  16. ******************************************************************************
  17. */
  18. /* Define to prevent recursive inclusion -------------------------------------*/
  19. #ifndef STM32L4xx_HAL_SD_H
  20. #define STM32L4xx_HAL_SD_H
  21. #ifdef __cplusplus
  22. extern "C" {
  23. #endif
  24. /* Includes ------------------------------------------------------------------*/
  25. #include "stm32l4xx_hal_def.h"
  26. #if defined(SDMMC1)
  27. #include "stm32l4xx_ll_sdmmc.h"
  28. /** @addtogroup STM32L4xx_HAL_Driver
  29. * @{
  30. */
  31. /** @defgroup SD SD
  32. * @brief SD HAL module driver
  33. * @{
  34. */
  35. /* Exported types ------------------------------------------------------------*/
  36. /** @defgroup SD_Exported_Types SD Exported Types
  37. * @{
  38. */
  39. /** @defgroup SD_Exported_Types_Group1 SD State enumeration structure
  40. * @{
  41. */
  42. typedef enum
  43. {
  44. HAL_SD_STATE_RESET = ((uint32_t)0x00000000U), /*!< SD not yet initialized or disabled */
  45. HAL_SD_STATE_READY = ((uint32_t)0x00000001U), /*!< SD initialized and ready for use */
  46. HAL_SD_STATE_TIMEOUT = ((uint32_t)0x00000002U), /*!< SD Timeout state */
  47. HAL_SD_STATE_BUSY = ((uint32_t)0x00000003U), /*!< SD process ongoing */
  48. HAL_SD_STATE_PROGRAMMING = ((uint32_t)0x00000004U), /*!< SD Programming State */
  49. HAL_SD_STATE_RECEIVING = ((uint32_t)0x00000005U), /*!< SD Receiving State */
  50. HAL_SD_STATE_TRANSFER = ((uint32_t)0x00000006U), /*!< SD Transfer State */
  51. HAL_SD_STATE_ERROR = ((uint32_t)0x0000000FU) /*!< SD is in error state */
  52. }HAL_SD_StateTypeDef;
  53. /**
  54. * @}
  55. */
  56. /** @defgroup SD_Exported_Types_Group2 SD Card State enumeration structure
  57. * @{
  58. */
  59. typedef uint32_t HAL_SD_CardStateTypeDef;
  60. #define HAL_SD_CARD_READY 0x00000001U /*!< Card state is ready */
  61. #define HAL_SD_CARD_IDENTIFICATION 0x00000002U /*!< Card is in identification state */
  62. #define HAL_SD_CARD_STANDBY 0x00000003U /*!< Card is in standby state */
  63. #define HAL_SD_CARD_TRANSFER 0x00000004U /*!< Card is in transfer state */
  64. #define HAL_SD_CARD_SENDING 0x00000005U /*!< Card is sending an operation */
  65. #define HAL_SD_CARD_RECEIVING 0x00000006U /*!< Card is receiving operation information */
  66. #define HAL_SD_CARD_PROGRAMMING 0x00000007U /*!< Card is in programming state */
  67. #define HAL_SD_CARD_DISCONNECTED 0x00000008U /*!< Card is disconnected */
  68. #define HAL_SD_CARD_ERROR 0x000000FFU /*!< Card response Error */
  69. /**
  70. * @}
  71. */
  72. /** @defgroup SD_Exported_Types_Group3 SD Handle Structure definition
  73. * @{
  74. */
  75. #define SD_InitTypeDef SDMMC_InitTypeDef
  76. #define SD_TypeDef SDMMC_TypeDef
  77. /**
  78. * @brief SD Card Information Structure definition
  79. */
  80. typedef struct
  81. {
  82. uint32_t CardType; /*!< Specifies the card Type */
  83. uint32_t CardVersion; /*!< Specifies the card version */
  84. uint32_t Class; /*!< Specifies the class of the card class */
  85. uint32_t RelCardAdd; /*!< Specifies the Relative Card Address */
  86. uint32_t BlockNbr; /*!< Specifies the Card Capacity in blocks */
  87. uint32_t BlockSize; /*!< Specifies one block size in bytes */
  88. uint32_t LogBlockNbr; /*!< Specifies the Card logical Capacity in blocks */
  89. uint32_t LogBlockSize; /*!< Specifies logical block size in bytes */
  90. #if defined(STM32L4P5xx) || defined(STM32L4Q5xx) || defined(STM32L4R5xx) || defined(STM32L4R7xx) || defined(STM32L4R9xx) || defined(STM32L4S5xx) || defined(STM32L4S7xx) || defined(STM32L4S9xx)
  91. uint32_t CardSpeed; /*!< Specifies the card Speed */
  92. #endif /* STM32L4P5xx || STM32L4Q5xx || STM32L4R5xx || STM32L4R7xx || STM32L4R9xx || STM32L4S5xx || STM32L4S7xx || STM32L4S9xx */
  93. }HAL_SD_CardInfoTypeDef;
  94. /**
  95. * @brief SD handle Structure definition
  96. */
  97. #if defined (USE_HAL_SD_REGISTER_CALLBACKS) && (USE_HAL_SD_REGISTER_CALLBACKS == 1U)
  98. typedef struct __SD_HandleTypeDef
  99. #else
  100. typedef struct
  101. #endif /* USE_HAL_SD_REGISTER_CALLBACKS */
  102. {
  103. SD_TypeDef *Instance; /*!< SD registers base address */
  104. SD_InitTypeDef Init; /*!< SD required parameters */
  105. HAL_LockTypeDef Lock; /*!< SD locking object */
  106. uint8_t *pTxBuffPtr; /*!< Pointer to SD Tx transfer Buffer */
  107. uint32_t TxXferSize; /*!< SD Tx Transfer size */
  108. uint8_t *pRxBuffPtr; /*!< Pointer to SD Rx transfer Buffer */
  109. uint32_t RxXferSize; /*!< SD Rx Transfer size */
  110. __IO uint32_t Context; /*!< SD transfer context */
  111. __IO HAL_SD_StateTypeDef State; /*!< SD card State */
  112. __IO uint32_t ErrorCode; /*!< SD Card Error codes */
  113. #if !defined(STM32L4P5xx) && !defined(STM32L4Q5xx) && !defined(STM32L4R5xx) && !defined(STM32L4R7xx) && !defined(STM32L4R9xx) && !defined(STM32L4S5xx) && !defined(STM32L4S7xx) && !defined(STM32L4S9xx)
  114. DMA_HandleTypeDef *hdmatx; /*!< SD Tx DMA handle parameters */
  115. DMA_HandleTypeDef *hdmarx; /*!< SD Rx DMA handle parameters */
  116. #endif /* !STM32L4P5xx && !STM32L4Q5xx && !STM32L4R5xx && !STM32L4R7xx && !STM32L4R9xx && !STM32L4S5xx && !STM32L4S7xx && !STM32L4S9xx */
  117. HAL_SD_CardInfoTypeDef SdCard; /*!< SD Card information */
  118. uint32_t CSD[4]; /*!< SD card specific data table */
  119. uint32_t CID[4]; /*!< SD card identification number table */
  120. #if defined (USE_HAL_SD_REGISTER_CALLBACKS) && (USE_HAL_SD_REGISTER_CALLBACKS == 1U)
  121. void (* TxCpltCallback) (struct __SD_HandleTypeDef *hsd);
  122. void (* RxCpltCallback) (struct __SD_HandleTypeDef *hsd);
  123. void (* ErrorCallback) (struct __SD_HandleTypeDef *hsd);
  124. void (* AbortCpltCallback) (struct __SD_HandleTypeDef *hsd);
  125. #if defined(STM32L4P5xx) || defined(STM32L4Q5xx) || defined(STM32L4R5xx) || defined(STM32L4R7xx) || defined(STM32L4R9xx) || defined(STM32L4S5xx) || defined(STM32L4S7xx) || defined(STM32L4S9xx)
  126. void (* Read_DMADblBuf0CpltCallback) (struct __SD_HandleTypeDef *hsd);
  127. void (* Read_DMADblBuf1CpltCallback) (struct __SD_HandleTypeDef *hsd);
  128. void (* Write_DMADblBuf0CpltCallback) (struct __SD_HandleTypeDef *hsd);
  129. void (* Write_DMADblBuf1CpltCallback) (struct __SD_HandleTypeDef *hsd);
  130. void (* DriveTransceiver_1_8V_Callback) (FlagStatus status);
  131. #endif
  132. void (* MspInitCallback) (struct __SD_HandleTypeDef *hsd);
  133. void (* MspDeInitCallback) (struct __SD_HandleTypeDef *hsd);
  134. #endif /* USE_HAL_SD_REGISTER_CALLBACKS */
  135. }SD_HandleTypeDef;
  136. /**
  137. * @}
  138. */
  139. /** @defgroup SD_Exported_Types_Group4 Card Specific Data: CSD Register
  140. * @{
  141. */
  142. typedef struct
  143. {
  144. __IO uint8_t CSDStruct; /*!< CSD structure */
  145. __IO uint8_t SysSpecVersion; /*!< System specification version */
  146. __IO uint8_t Reserved1; /*!< Reserved */
  147. __IO uint8_t TAAC; /*!< Data read access time 1 */
  148. __IO uint8_t NSAC; /*!< Data read access time 2 in CLK cycles */
  149. __IO uint8_t MaxBusClkFrec; /*!< Max. bus clock frequency */
  150. __IO uint16_t CardComdClasses; /*!< Card command classes */
  151. __IO uint8_t RdBlockLen; /*!< Max. read data block length */
  152. __IO uint8_t PartBlockRead; /*!< Partial blocks for read allowed */
  153. __IO uint8_t WrBlockMisalign; /*!< Write block misalignment */
  154. __IO uint8_t RdBlockMisalign; /*!< Read block misalignment */
  155. __IO uint8_t DSRImpl; /*!< DSR implemented */
  156. __IO uint8_t Reserved2; /*!< Reserved */
  157. __IO uint32_t DeviceSize; /*!< Device Size */
  158. __IO uint8_t MaxRdCurrentVDDMin; /*!< Max. read current @ VDD min */
  159. __IO uint8_t MaxRdCurrentVDDMax; /*!< Max. read current @ VDD max */
  160. __IO uint8_t MaxWrCurrentVDDMin; /*!< Max. write current @ VDD min */
  161. __IO uint8_t MaxWrCurrentVDDMax; /*!< Max. write current @ VDD max */
  162. __IO uint8_t DeviceSizeMul; /*!< Device size multiplier */
  163. __IO uint8_t EraseGrSize; /*!< Erase group size */
  164. __IO uint8_t EraseGrMul; /*!< Erase group size multiplier */
  165. __IO uint8_t WrProtectGrSize; /*!< Write protect group size */
  166. __IO uint8_t WrProtectGrEnable; /*!< Write protect group enable */
  167. __IO uint8_t ManDeflECC; /*!< Manufacturer default ECC */
  168. __IO uint8_t WrSpeedFact; /*!< Write speed factor */
  169. __IO uint8_t MaxWrBlockLen; /*!< Max. write data block length */
  170. __IO uint8_t WriteBlockPaPartial; /*!< Partial blocks for write allowed */
  171. __IO uint8_t Reserved3; /*!< Reserved */
  172. __IO uint8_t ContentProtectAppli; /*!< Content protection application */
  173. __IO uint8_t FileFormatGroup; /*!< File format group */
  174. __IO uint8_t CopyFlag; /*!< Copy flag (OTP) */
  175. __IO uint8_t PermWrProtect; /*!< Permanent write protection */
  176. __IO uint8_t TempWrProtect; /*!< Temporary write protection */
  177. __IO uint8_t FileFormat; /*!< File format */
  178. __IO uint8_t ECC; /*!< ECC code */
  179. __IO uint8_t CSD_CRC; /*!< CSD CRC */
  180. __IO uint8_t Reserved4; /*!< Always 1 */
  181. }HAL_SD_CardCSDTypeDef;
  182. /**
  183. * @}
  184. */
  185. /** @defgroup SD_Exported_Types_Group5 Card Identification Data: CID Register
  186. * @{
  187. */
  188. typedef struct
  189. {
  190. __IO uint8_t ManufacturerID; /*!< Manufacturer ID */
  191. __IO uint16_t OEM_AppliID; /*!< OEM/Application ID */
  192. __IO uint32_t ProdName1; /*!< Product Name part1 */
  193. __IO uint8_t ProdName2; /*!< Product Name part2 */
  194. __IO uint8_t ProdRev; /*!< Product Revision */
  195. __IO uint32_t ProdSN; /*!< Product Serial Number */
  196. __IO uint8_t Reserved1; /*!< Reserved1 */
  197. __IO uint16_t ManufactDate; /*!< Manufacturing Date */
  198. __IO uint8_t CID_CRC; /*!< CID CRC */
  199. __IO uint8_t Reserved2; /*!< Always 1 */
  200. }HAL_SD_CardCIDTypeDef;
  201. /**
  202. * @}
  203. */
  204. /** @defgroup SD_Exported_Types_Group6 SD Card Status returned by ACMD13
  205. * @{
  206. */
  207. typedef struct
  208. {
  209. __IO uint8_t DataBusWidth; /*!< Shows the currently defined data bus width */
  210. __IO uint8_t SecuredMode; /*!< Card is in secured mode of operation */
  211. __IO uint16_t CardType; /*!< Carries information about card type */
  212. __IO uint32_t ProtectedAreaSize; /*!< Carries information about the capacity of protected area */
  213. __IO uint8_t SpeedClass; /*!< Carries information about the speed class of the card */
  214. __IO uint8_t PerformanceMove; /*!< Carries information about the card's performance move */
  215. __IO uint8_t AllocationUnitSize; /*!< Carries information about the card's allocation unit size */
  216. __IO uint16_t EraseSize; /*!< Determines the number of AUs to be erased in one operation */
  217. __IO uint8_t EraseTimeout; /*!< Determines the timeout for any number of AU erase */
  218. __IO uint8_t EraseOffset; /*!< Carries information about the erase offset */
  219. #if defined(STM32L4P5xx) || defined(STM32L4Q5xx) || defined(STM32L4R5xx) || defined(STM32L4R7xx) || defined(STM32L4R9xx) || defined(STM32L4S5xx) || defined(STM32L4S7xx) || defined(STM32L4S9xx)
  220. __IO uint8_t UhsSpeedGrade; /*!< Carries information about the speed grade of UHS card */
  221. __IO uint8_t UhsAllocationUnitSize; /*!< Carries information about the UHS card's allocation unit size */
  222. __IO uint8_t VideoSpeedClass; /*!< Carries information about the Video Speed Class of UHS card */
  223. #endif
  224. }HAL_SD_CardStatusTypeDef;
  225. /**
  226. * @}
  227. */
  228. #if defined (USE_HAL_SD_REGISTER_CALLBACKS) && (USE_HAL_SD_REGISTER_CALLBACKS == 1U)
  229. /** @defgroup SD_Exported_Types_Group7 SD Callback ID enumeration definition
  230. * @{
  231. */
  232. typedef enum
  233. {
  234. HAL_SD_TX_CPLT_CB_ID = 0x00U, /*!< SD Tx Complete Callback ID */
  235. HAL_SD_RX_CPLT_CB_ID = 0x01U, /*!< SD Rx Complete Callback ID */
  236. HAL_SD_ERROR_CB_ID = 0x02U, /*!< SD Error Callback ID */
  237. HAL_SD_ABORT_CB_ID = 0x03U, /*!< SD Abort Callback ID */
  238. #if defined(STM32L4P5xx) || defined(STM32L4Q5xx) || defined(STM32L4R5xx) || defined(STM32L4R7xx) || defined(STM32L4R9xx) || defined(STM32L4S5xx) || defined(STM32L4S7xx) || defined(STM32L4S9xx)
  239. HAL_SD_READ_DMA_DBL_BUF0_CPLT_CB_ID = 0x04U, /*!< SD Rx DMA Double Buffer 0 Complete Callback ID */
  240. HAL_SD_READ_DMA_DBL_BUF1_CPLT_CB_ID = 0x05U, /*!< SD Rx DMA Double Buffer 1 Complete Callback ID */
  241. HAL_SD_WRITE_DMA_DBL_BUF0_CPLT_CB_ID = 0x06U, /*!< SD Tx DMA Double Buffer 0 Complete Callback ID */
  242. HAL_SD_WRITE_DMA_DBL_BUF1_CPLT_CB_ID = 0x07U, /*!< SD Tx DMA Double Buffer 1 Complete Callback ID */
  243. #endif
  244. HAL_SD_MSP_INIT_CB_ID = 0x10U, /*!< SD MspInit Callback ID */
  245. HAL_SD_MSP_DEINIT_CB_ID = 0x11U /*!< SD MspDeInit Callback ID */
  246. }HAL_SD_CallbackIDTypeDef;
  247. /**
  248. * @}
  249. */
  250. /** @defgroup SD_Exported_Types_Group8 SD Callback pointer definition
  251. * @{
  252. */
  253. typedef void (*pSD_CallbackTypeDef) (SD_HandleTypeDef *hsd);
  254. #if defined(STM32L4P5xx) || defined(STM32L4Q5xx) || defined(STM32L4R5xx) || defined(STM32L4R7xx) || defined(STM32L4R9xx) || defined(STM32L4S5xx) || defined(STM32L4S7xx) || defined(STM32L4S9xx)
  255. typedef void (*pSD_TransceiverCallbackTypeDef)(FlagStatus status);
  256. #endif
  257. /**
  258. * @}
  259. */
  260. #endif /* USE_HAL_SD_REGISTER_CALLBACKS */
  261. /**
  262. * @}
  263. */
  264. /* Exported constants --------------------------------------------------------*/
  265. /** @defgroup SD_Exported_Constants Exported Constants
  266. * @{
  267. */
  268. #define BLOCKSIZE ((uint32_t)512U) /*!< Block size is 512 bytes */
  269. /** @defgroup SD_Exported_Constansts_Group1 SD Error status enumeration Structure definition
  270. * @{
  271. */
  272. #define HAL_SD_ERROR_NONE SDMMC_ERROR_NONE /*!< No error */
  273. #define HAL_SD_ERROR_CMD_CRC_FAIL SDMMC_ERROR_CMD_CRC_FAIL /*!< Command response received (but CRC check failed) */
  274. #define HAL_SD_ERROR_DATA_CRC_FAIL SDMMC_ERROR_DATA_CRC_FAIL /*!< Data block sent/received (CRC check failed) */
  275. #define HAL_SD_ERROR_CMD_RSP_TIMEOUT SDMMC_ERROR_CMD_RSP_TIMEOUT /*!< Command response timeout */
  276. #define HAL_SD_ERROR_DATA_TIMEOUT SDMMC_ERROR_DATA_TIMEOUT /*!< Data timeout */
  277. #define HAL_SD_ERROR_TX_UNDERRUN SDMMC_ERROR_TX_UNDERRUN /*!< Transmit FIFO underrun */
  278. #define HAL_SD_ERROR_RX_OVERRUN SDMMC_ERROR_RX_OVERRUN /*!< Receive FIFO overrun */
  279. #define HAL_SD_ERROR_ADDR_MISALIGNED SDMMC_ERROR_ADDR_MISALIGNED /*!< Misaligned address */
  280. #define HAL_SD_ERROR_BLOCK_LEN_ERR SDMMC_ERROR_BLOCK_LEN_ERR /*!< Transferred block length is not allowed for the card or the
  281. number of transferred bytes does not match the block length */
  282. #define HAL_SD_ERROR_ERASE_SEQ_ERR SDMMC_ERROR_ERASE_SEQ_ERR /*!< An error in the sequence of erase command occurs */
  283. #define HAL_SD_ERROR_BAD_ERASE_PARAM SDMMC_ERROR_BAD_ERASE_PARAM /*!< An invalid selection for erase groups */
  284. #define HAL_SD_ERROR_WRITE_PROT_VIOLATION SDMMC_ERROR_WRITE_PROT_VIOLATION /*!< Attempt to program a write protect block */
  285. #define HAL_SD_ERROR_LOCK_UNLOCK_FAILED SDMMC_ERROR_LOCK_UNLOCK_FAILED /*!< Sequence or password error has been detected in unlock
  286. command or if there was an attempt to access a locked card */
  287. #define HAL_SD_ERROR_COM_CRC_FAILED SDMMC_ERROR_COM_CRC_FAILED /*!< CRC check of the previous command failed */
  288. #define HAL_SD_ERROR_ILLEGAL_CMD SDMMC_ERROR_ILLEGAL_CMD /*!< Command is not legal for the card state */
  289. #define HAL_SD_ERROR_CARD_ECC_FAILED SDMMC_ERROR_CARD_ECC_FAILED /*!< Card internal ECC was applied but failed to correct the data */
  290. #define HAL_SD_ERROR_CC_ERR SDMMC_ERROR_CC_ERR /*!< Internal card controller error */
  291. #define HAL_SD_ERROR_GENERAL_UNKNOWN_ERR SDMMC_ERROR_GENERAL_UNKNOWN_ERR /*!< General or unknown error */
  292. #define HAL_SD_ERROR_STREAM_READ_UNDERRUN SDMMC_ERROR_STREAM_READ_UNDERRUN /*!< The card could not sustain data reading in stream rmode */
  293. #define HAL_SD_ERROR_STREAM_WRITE_OVERRUN SDMMC_ERROR_STREAM_WRITE_OVERRUN /*!< The card could not sustain data programming in stream mode */
  294. #define HAL_SD_ERROR_CID_CSD_OVERWRITE SDMMC_ERROR_CID_CSD_OVERWRITE /*!< CID/CSD overwrite error */
  295. #define HAL_SD_ERROR_WP_ERASE_SKIP SDMMC_ERROR_WP_ERASE_SKIP /*!< Only partial address space was erased */
  296. #define HAL_SD_ERROR_CARD_ECC_DISABLED SDMMC_ERROR_CARD_ECC_DISABLED /*!< Command has been executed without using internal ECC */
  297. #define HAL_SD_ERROR_ERASE_RESET SDMMC_ERROR_ERASE_RESET /*!< Erase sequence was cleared before executing because an out
  298. of erase sequence command was received */
  299. #define HAL_SD_ERROR_AKE_SEQ_ERR SDMMC_ERROR_AKE_SEQ_ERR /*!< Error in sequence of authentication */
  300. #define HAL_SD_ERROR_INVALID_VOLTRANGE SDMMC_ERROR_INVALID_VOLTRANGE /*!< Error in case of invalid voltage range */
  301. #define HAL_SD_ERROR_ADDR_OUT_OF_RANGE SDMMC_ERROR_ADDR_OUT_OF_RANGE /*!< Error when addressed block is out of range */
  302. #define HAL_SD_ERROR_REQUEST_NOT_APPLICABLE SDMMC_ERROR_REQUEST_NOT_APPLICABLE /*!< Error when command request is not applicable */
  303. #define HAL_SD_ERROR_PARAM SDMMC_ERROR_INVALID_PARAMETER /*!< the used parameter is not valid */
  304. #define HAL_SD_ERROR_UNSUPPORTED_FEATURE SDMMC_ERROR_UNSUPPORTED_FEATURE /*!< Error when feature is not insupported */
  305. #define HAL_SD_ERROR_BUSY SDMMC_ERROR_BUSY /*!< Error when transfer process is busy */
  306. #define HAL_SD_ERROR_DMA SDMMC_ERROR_DMA /*!< Error while DMA transfer */
  307. #define HAL_SD_ERROR_TIMEOUT SDMMC_ERROR_TIMEOUT /*!< Timeout error */
  308. #if defined (USE_HAL_SD_REGISTER_CALLBACKS) && (USE_HAL_SD_REGISTER_CALLBACKS == 1U)
  309. #define HAL_SD_ERROR_INVALID_CALLBACK SDMMC_ERROR_INVALID_PARAMETER /*!< Invalid callback error */
  310. #endif /* USE_HAL_SD_REGISTER_CALLBACKS */
  311. /**
  312. * @}
  313. */
  314. /** @defgroup SD_Exported_Constansts_Group2 SD context enumeration
  315. * @{
  316. */
  317. #define SD_CONTEXT_NONE ((uint32_t)0x00000000U) /*!< None */
  318. #define SD_CONTEXT_READ_SINGLE_BLOCK ((uint32_t)0x00000001U) /*!< Read single block operation */
  319. #define SD_CONTEXT_READ_MULTIPLE_BLOCK ((uint32_t)0x00000002U) /*!< Read multiple blocks operation */
  320. #define SD_CONTEXT_WRITE_SINGLE_BLOCK ((uint32_t)0x00000010U) /*!< Write single block operation */
  321. #define SD_CONTEXT_WRITE_MULTIPLE_BLOCK ((uint32_t)0x00000020U) /*!< Write multiple blocks operation */
  322. #define SD_CONTEXT_IT ((uint32_t)0x00000008U) /*!< Process in Interrupt mode */
  323. #define SD_CONTEXT_DMA ((uint32_t)0x00000080U) /*!< Process in DMA mode */
  324. /**
  325. * @}
  326. */
  327. /** @defgroup SD_Exported_Constansts_Group3 SD Supported Memory Cards
  328. * @{
  329. */
  330. #if defined(STM32L4P5xx) || defined(STM32L4Q5xx) || defined(STM32L4R5xx) || defined(STM32L4R7xx) || defined(STM32L4R9xx) || defined(STM32L4S5xx) || defined(STM32L4S7xx) || defined(STM32L4S9xx)
  331. #define CARD_NORMAL_SPEED ((uint32_t)0x00000000U) /*!< Normal Speed Card <12.5Mo/s , Spec Version 1.01 */
  332. #define CARD_HIGH_SPEED ((uint32_t)0x00000100U) /*!< High Speed Card <25Mo/s , Spec version 2.00 */
  333. #define CARD_ULTRA_HIGH_SPEED ((uint32_t)0x00000200U) /*!< UHS-I SD Card <50Mo/s for SDR50, DDR5 Cards
  334. and <104Mo/s for SDR104, Spec version 3.01 */
  335. #endif /* STM32L4P5xx || STM32L4Q5xx || STM32L4R5xx || STM32L4R7xx || STM32L4R9xx || STM32L4S5xx || STM32L4S7xx || STM32L4S9xx */
  336. #define CARD_SDSC ((uint32_t)0x00000000U) /*!< SD Standard Capacity <2Go */
  337. #define CARD_SDHC_SDXC ((uint32_t)0x00000001U) /*!< SD High Capacity <32Go, SD Extended Capacity <2To */
  338. #define CARD_SECURED ((uint32_t)0x00000003U)
  339. /**
  340. * @}
  341. */
  342. /** @defgroup SD_Exported_Constansts_Group4 SD Supported Version
  343. * @{
  344. */
  345. #define CARD_V1_X ((uint32_t)0x00000000U)
  346. #define CARD_V2_X ((uint32_t)0x00000001U)
  347. /**
  348. * @}
  349. */
  350. /**
  351. * @}
  352. */
  353. /* Exported macro ------------------------------------------------------------*/
  354. /** @defgroup SD_Exported_macros SD Exported Macros
  355. * @brief macros to handle interrupts and specific clock configurations
  356. * @{
  357. */
  358. /** @brief Reset SD handle state.
  359. * @param __HANDLE__ : SD handle.
  360. * @retval None
  361. */
  362. #if defined (USE_HAL_SD_REGISTER_CALLBACKS) && (USE_HAL_SD_REGISTER_CALLBACKS == 1U)
  363. #define __HAL_SD_RESET_HANDLE_STATE(__HANDLE__) do { \
  364. (__HANDLE__)->State = HAL_SD_STATE_RESET; \
  365. (__HANDLE__)->MspInitCallback = NULL; \
  366. (__HANDLE__)->MspDeInitCallback = NULL; \
  367. } while(0)
  368. #else
  369. #define __HAL_SD_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_SD_STATE_RESET)
  370. #endif /* USE_HAL_SD_REGISTER_CALLBACKS */
  371. #if !defined(STM32L4P5xx) && !defined(STM32L4Q5xx) && !defined(STM32L4R5xx) && !defined(STM32L4R7xx) && !defined(STM32L4R9xx) && !defined(STM32L4S5xx) && !defined(STM32L4S7xx) && !defined(STM32L4S9xx)
  372. /**
  373. * @brief Enable the SD device.
  374. * @retval None
  375. */
  376. #define __HAL_SD_ENABLE(__HANDLE__) __SDMMC_ENABLE((__HANDLE__)->Instance)
  377. /**
  378. * @brief Disable the SD device.
  379. * @retval None
  380. */
  381. #define __HAL_SD_DISABLE(__HANDLE__) __SDMMC_DISABLE((__HANDLE__)->Instance)
  382. /**
  383. * @brief Enable the SDMMC DMA transfer.
  384. * @retval None
  385. */
  386. #define __HAL_SD_DMA_ENABLE(__HANDLE__) __SDMMC_DMA_ENABLE((__HANDLE__)->Instance)
  387. /**
  388. * @brief Disable the SDMMC DMA transfer.
  389. * @retval None
  390. */
  391. #define __HAL_SD_DMA_DISABLE(__HANDLE__) __SDMMC_DMA_DISABLE((__HANDLE__)->Instance)
  392. #endif /* !STM32L4P5xx && !STM32L4Q5xx && !STM32L4R5xx && !STM32L4R7xx && !STM32L4R9xx && !STM32L4S5xx && !STM32L4S7xx && !STM32L4S9xx */
  393. /**
  394. * @brief Enable the SD device interrupt.
  395. * @param __HANDLE__ SD Handle
  396. * @param __INTERRUPT__ specifies the SDMMC interrupt sources to be enabled.
  397. * This parameter can be one or a combination of the following values:
  398. * @arg SDMMC_IT_CCRCFAIL: Command response received (CRC check failed) interrupt
  399. * @arg SDMMC_IT_DCRCFAIL: Data block sent/received (CRC check failed) interrupt
  400. * @arg SDMMC_IT_CTIMEOUT: Command response timeout interrupt
  401. * @arg SDMMC_IT_DTIMEOUT: Data timeout interrupt
  402. * @arg SDMMC_IT_TXUNDERR: Transmit FIFO underrun error interrupt
  403. * @arg SDMMC_IT_RXOVERR: Received FIFO overrun error interrupt
  404. * @arg SDMMC_IT_CMDREND: Command response received (CRC check passed) interrupt
  405. * @arg SDMMC_IT_CMDSENT: Command sent (no response required) interrupt
  406. * @arg SDMMC_IT_DATAEND: Data end (data counter, DATACOUNT, is zero) interrupt
  407. * @arg SDMMC_IT_DHOLD: Data transfer Hold interrupt
  408. * @arg SDMMC_IT_DBCKEND: Data block sent/received (CRC check passed) interrupt
  409. * @arg SDMMC_IT_DABORT: Data transfer aborted by CMD12 interrupt
  410. * @arg SDMMC_IT_CMDACT: Command transfer in progress interrupt
  411. * @arg SDMMC_IT_TXACT: Data transmit in progress interrupt
  412. * @arg SDMMC_IT_RXACT: Data receive in progress interrupt
  413. * @arg SDMMC_IT_TXFIFOHE: Transmit FIFO Half Empty interrupt
  414. * @arg SDMMC_IT_RXFIFOHF: Receive FIFO Half Full interrupt
  415. * @arg SDMMC_IT_TXFIFOF: Transmit FIFO full interrupt
  416. * @arg SDMMC_IT_RXFIFOF: Receive FIFO full interrupt
  417. * @arg SDMMC_IT_TXFIFOE: Transmit FIFO empty interrupt
  418. * @arg SDMMC_IT_RXFIFOE: Receive FIFO empty interrupt
  419. * @arg SDMMC_IT_TXDAVL: Data available in transmit FIFO interrupt
  420. * @arg SDMMC_IT_RXDAVL: Data available in receive FIFO interrupt
  421. * @arg SDMMC_IT_BUSYD0END: End of SDMMC_D0 Busy following a CMD response detected interrupt
  422. * @arg SDMMC_IT_SDIOIT: SDIO interrupt received interrupt
  423. * @arg SDMMC_IT_ACKFAIL: Boot Acknowledgment received interrupt
  424. * @arg SDMMC_IT_ACKTIMEOUT: Boot Acknowledgment timeout interrupt
  425. * @arg SDMMC_IT_VSWEND: Voltage switch critical timing section completion interrupt
  426. * @arg SDMMC_IT_CKSTOP: SDMMC_CK stopped in Voltage switch procedure interrupt
  427. * @arg SDMMC_IT_IDMABTC: IDMA buffer transfer complete interrupt
  428. * @retval None
  429. */
  430. #define __HAL_SD_ENABLE_IT(__HANDLE__, __INTERRUPT__) __SDMMC_ENABLE_IT((__HANDLE__)->Instance, (__INTERRUPT__))
  431. /**
  432. * @brief Disable the SD device interrupt.
  433. * @param __HANDLE__ SD Handle
  434. * @param __INTERRUPT__ specifies the SDMMC interrupt sources to be disabled.
  435. * This parameter can be one or a combination of the following values:
  436. * @arg SDMMC_IT_CCRCFAIL: Command response received (CRC check failed) interrupt
  437. * @arg SDMMC_IT_DCRCFAIL: Data block sent/received (CRC check failed) interrupt
  438. * @arg SDMMC_IT_CTIMEOUT: Command response timeout interrupt
  439. * @arg SDMMC_IT_DTIMEOUT: Data timeout interrupt
  440. * @arg SDMMC_IT_TXUNDERR: Transmit FIFO underrun error interrupt
  441. * @arg SDMMC_IT_RXOVERR: Received FIFO overrun error interrupt
  442. * @arg SDMMC_IT_CMDREND: Command response received (CRC check passed) interrupt
  443. * @arg SDMMC_IT_CMDSENT: Command sent (no response required) interrupt
  444. * @arg SDMMC_IT_DATAEND: Data end (data counter, DATACOUNT, is zero) interrupt
  445. * @arg SDMMC_IT_DHOLD: Data transfer Hold interrupt
  446. * @arg SDMMC_IT_DBCKEND: Data block sent/received (CRC check passed) interrupt
  447. * @arg SDMMC_IT_DABORT: Data transfer aborted by CMD12 interrupt
  448. * @arg SDMMC_IT_CMDACT: Command transfer in progress interrupt
  449. * @arg SDMMC_IT_TXACT: Data transmit in progress interrupt
  450. * @arg SDMMC_IT_RXACT: Data receive in progress interrupt
  451. * @arg SDMMC_IT_TXFIFOHE: Transmit FIFO Half Empty interrupt
  452. * @arg SDMMC_IT_RXFIFOHF: Receive FIFO Half Full interrupt
  453. * @arg SDMMC_IT_TXFIFOF: Transmit FIFO full interrupt
  454. * @arg SDMMC_IT_RXFIFOF: Receive FIFO full interrupt
  455. * @arg SDMMC_IT_TXFIFOE: Transmit FIFO empty interrupt
  456. * @arg SDMMC_IT_RXFIFOE: Receive FIFO empty interrupt
  457. * @arg SDMMC_IT_TXDAVL: Data available in transmit FIFO interrupt
  458. * @arg SDMMC_IT_RXDAVL: Data available in receive FIFO interrupt
  459. * @arg SDMMC_IT_BUSYD0END: End of SDMMC_D0 Busy following a CMD response detected interrupt
  460. * @arg SDMMC_IT_SDIOIT: SDIO interrupt received interrupt
  461. * @arg SDMMC_IT_ACKFAIL: Boot Acknowledgment received interrupt
  462. * @arg SDMMC_IT_ACKTIMEOUT: Boot Acknowledgment timeout interrupt
  463. * @arg SDMMC_IT_VSWEND: Voltage switch critical timing section completion interrupt
  464. * @arg SDMMC_IT_CKSTOP: SDMMC_CK stopped in Voltage switch procedure interrupt
  465. * @arg SDMMC_IT_IDMABTC: IDMA buffer transfer complete interrupt
  466. * @retval None
  467. */
  468. #define __HAL_SD_DISABLE_IT(__HANDLE__, __INTERRUPT__) __SDMMC_DISABLE_IT((__HANDLE__)->Instance, (__INTERRUPT__))
  469. /**
  470. * @brief Check whether the specified SD flag is set or not.
  471. * @param __HANDLE__ SD Handle
  472. * @param __FLAG__ specifies the flag to check.
  473. * This parameter can be one of the following values:
  474. * @arg SDMMC_FLAG_CCRCFAIL: Command response received (CRC check failed)
  475. * @arg SDMMC_FLAG_DCRCFAIL: Data block sent/received (CRC check failed)
  476. * @arg SDMMC_FLAG_CTIMEOUT: Command response timeout
  477. * @arg SDMMC_FLAG_DTIMEOUT: Data timeout
  478. * @arg SDMMC_FLAG_TXUNDERR: Transmit FIFO underrun error
  479. * @arg SDMMC_FLAG_RXOVERR: Received FIFO overrun error
  480. * @arg SDMMC_FLAG_CMDREND: Command response received (CRC check passed)
  481. * @arg SDMMC_FLAG_CMDSENT: Command sent (no response required)
  482. * @arg SDMMC_FLAG_DATAEND: Data end (data counter, DATACOUNT, is zero)
  483. * @arg SDMMC_FLAG_DHOLD: Data transfer Hold
  484. * @arg SDMMC_FLAG_DBCKEND: Data block sent/received (CRC check passed)
  485. * @arg SDMMC_FLAG_DABORT: Data transfer aborted by CMD12
  486. * @arg SDMMC_FLAG_DPSMACT: Data path state machine active
  487. * @arg SDMMC_FLAG_CPSMACT: Command path state machine active
  488. * @arg SDMMC_FLAG_CMDACT: Command transfer in progress
  489. * @arg SDMMC_FLAG_TXACT: Data transmit in progress
  490. * @arg SDMMC_FLAG_RXACT: Data receive in progress
  491. * @arg SDMMC_FLAG_TXFIFOHE: Transmit FIFO Half Empty
  492. * @arg SDMMC_FLAG_RXFIFOHF: Receive FIFO Half Full
  493. * @arg SDMMC_FLAG_TXFIFOF: Transmit FIFO full
  494. * @arg SDMMC_FLAG_RXFIFOF: Receive FIFO full
  495. * @arg SDMMC_FLAG_TXFIFOE: Transmit FIFO empty
  496. * @arg SDMMC_FLAG_RXFIFOE: Receive FIFO empty
  497. * @arg SDMMC_FLAG_BUSYD0: Inverted value of SDMMC_D0 line (Busy)
  498. * @arg SDMMC_FLAG_BUSYD0END: End of SDMMC_D0 Busy following a CMD response detected
  499. * @arg SDMMC_FLAG_TXDAVL: Data available in transmit FIFO
  500. * @arg SDMMC_FLAG_RXDAVL: Data available in receive FIFO
  501. * @arg SDMMC_FLAG_SDIOIT: SDIO interrupt received
  502. * @arg SDMMC_FLAG_ACKFAIL: Boot Acknowledgment received
  503. * @arg SDMMC_FLAG_ACKTIMEOUT: Boot Acknowledgment timeout
  504. * @arg SDMMC_FLAG_VSWEND: Voltage switch critical timing section completion
  505. * @arg SDMMC_FLAG_CKSTOP: SDMMC_CK stopped in Voltage switch procedure
  506. * @arg SDMMC_FLAG_IDMATE: IDMA transfer error
  507. * @arg SDMMC_FLAG_IDMABTC: IDMA buffer transfer complete
  508. * @retval The new state of SD FLAG (SET or RESET).
  509. */
  510. #define __HAL_SD_GET_FLAG(__HANDLE__, __FLAG__) __SDMMC_GET_FLAG((__HANDLE__)->Instance, (__FLAG__))
  511. /**
  512. * @brief Clear the SD's pending flags.
  513. * @param __HANDLE__ SD Handle
  514. * @param __FLAG__ specifies the flag to clear.
  515. * This parameter can be one or a combination of the following values:
  516. * @arg SDMMC_FLAG_CCRCFAIL: Command response received (CRC check failed)
  517. * @arg SDMMC_FLAG_DCRCFAIL: Data block sent/received (CRC check failed)
  518. * @arg SDMMC_FLAG_CTIMEOUT: Command response timeout
  519. * @arg SDMMC_FLAG_DTIMEOUT: Data timeout
  520. * @arg SDMMC_FLAG_TXUNDERR: Transmit FIFO underrun error
  521. * @arg SDMMC_FLAG_RXOVERR: Received FIFO overrun error
  522. * @arg SDMMC_FLAG_CMDREND: Command response received (CRC check passed)
  523. * @arg SDMMC_FLAG_CMDSENT: Command sent (no response required)
  524. * @arg SDMMC_FLAG_DATAEND: Data end (data counter, DATACOUNT, is zero)
  525. * @arg SDMMC_FLAG_DHOLD: Data transfer Hold
  526. * @arg SDMMC_FLAG_DBCKEND: Data block sent/received (CRC check passed)
  527. * @arg SDMMC_FLAG_DABORT: Data transfer aborted by CMD12
  528. * @arg SDMMC_FLAG_BUSYD0END: End of SDMMC_D0 Busy following a CMD response detected
  529. * @arg SDMMC_FLAG_SDIOIT: SDIO interrupt received
  530. * @arg SDMMC_FLAG_ACKFAIL: Boot Acknowledgment received
  531. * @arg SDMMC_FLAG_ACKTIMEOUT: Boot Acknowledgment timeout
  532. * @arg SDMMC_FLAG_VSWEND: Voltage switch critical timing section completion
  533. * @arg SDMMC_FLAG_CKSTOP: SDMMC_CK stopped in Voltage switch procedure
  534. * @arg SDMMC_FLAG_IDMATE: IDMA transfer error
  535. * @arg SDMMC_FLAG_IDMABTC: IDMA buffer transfer complete
  536. * @retval None
  537. */
  538. #define __HAL_SD_CLEAR_FLAG(__HANDLE__, __FLAG__) __SDMMC_CLEAR_FLAG((__HANDLE__)->Instance, (__FLAG__))
  539. /**
  540. * @brief Check whether the specified SD interrupt has occurred or not.
  541. * @param __HANDLE__ SD Handle
  542. * @param __INTERRUPT__ specifies the SDMMC interrupt source to check.
  543. * This parameter can be one of the following values:
  544. * @arg SDMMC_IT_CCRCFAIL: Command response received (CRC check failed) interrupt
  545. * @arg SDMMC_IT_DCRCFAIL: Data block sent/received (CRC check failed) interrupt
  546. * @arg SDMMC_IT_CTIMEOUT: Command response timeout interrupt
  547. * @arg SDMMC_IT_DTIMEOUT: Data timeout interrupt
  548. * @arg SDMMC_IT_TXUNDERR: Transmit FIFO underrun error interrupt
  549. * @arg SDMMC_IT_RXOVERR: Received FIFO overrun error interrupt
  550. * @arg SDMMC_IT_CMDREND: Command response received (CRC check passed) interrupt
  551. * @arg SDMMC_IT_CMDSENT: Command sent (no response required) interrupt
  552. * @arg SDMMC_IT_DATAEND: Data end (data counter, DATACOUNT, is zero) interrupt
  553. * @arg SDMMC_IT_DHOLD: Data transfer Hold interrupt
  554. * @arg SDMMC_IT_DBCKEND: Data block sent/received (CRC check passed) interrupt
  555. * @arg SDMMC_IT_DABORT: Data transfer aborted by CMD12 interrupt
  556. * @arg SDMMC_IT_CMDACT: Command transfer in progress interrupt
  557. * @arg SDMMC_IT_TXACT: Data transmit in progress interrupt
  558. * @arg SDMMC_IT_RXACT: Data receive in progress interrupt
  559. * @arg SDMMC_IT_TXFIFOHE: Transmit FIFO Half Empty interrupt
  560. * @arg SDMMC_IT_RXFIFOHF: Receive FIFO Half Full interrupt
  561. * @arg SDMMC_IT_TXFIFOF: Transmit FIFO full interrupt
  562. * @arg SDMMC_IT_RXFIFOF: Receive FIFO full interrupt
  563. * @arg SDMMC_IT_TXFIFOE: Transmit FIFO empty interrupt
  564. * @arg SDMMC_IT_RXFIFOE: Receive FIFO empty interrupt
  565. * @arg SDMMC_IT_TXDAVL: Data available in transmit FIFO interrupt
  566. * @arg SDMMC_IT_RXDAVL: Data available in receive FIFO interrupt
  567. * @arg SDMMC_IT_BUSYD0END: End of SDMMC_D0 Busy following a CMD response detected interrupt
  568. * @arg SDMMC_IT_SDIOIT: SDIO interrupt received interrupt
  569. * @arg SDMMC_IT_ACKFAIL: Boot Acknowledgment received interrupt
  570. * @arg SDMMC_IT_ACKTIMEOUT: Boot Acknowledgment timeout interrupt
  571. * @arg SDMMC_IT_VSWEND: Voltage switch critical timing section completion interrupt
  572. * @arg SDMMC_IT_CKSTOP: SDMMC_CK stopped in Voltage switch procedure interrupt
  573. * @arg SDMMC_IT_IDMABTC: IDMA buffer transfer complete interrupt
  574. * @retval The new state of SD IT (SET or RESET).
  575. */
  576. #define __HAL_SD_GET_IT(__HANDLE__, __INTERRUPT__) __SDMMC_GET_IT((__HANDLE__)->Instance, (__INTERRUPT__))
  577. /**
  578. * @brief Clear the SD's interrupt pending bits.
  579. * @param __HANDLE__ SD Handle
  580. * @param __INTERRUPT__ specifies the interrupt pending bit to clear.
  581. * This parameter can be one or a combination of the following values:
  582. * @arg SDMMC_IT_CCRCFAIL: Command response received (CRC check failed) interrupt
  583. * @arg SDMMC_IT_DCRCFAIL: Data block sent/received (CRC check failed) interrupt
  584. * @arg SDMMC_IT_CTIMEOUT: Command response timeout interrupt
  585. * @arg SDMMC_IT_DTIMEOUT: Data timeout interrupt
  586. * @arg SDMMC_IT_TXUNDERR: Transmit FIFO underrun error interrupt
  587. * @arg SDMMC_IT_RXOVERR: Received FIFO overrun error interrupt
  588. * @arg SDMMC_IT_CMDREND: Command response received (CRC check passed) interrupt
  589. * @arg SDMMC_IT_CMDSENT: Command sent (no response required) interrupt
  590. * @arg SDMMC_IT_DATAEND: Data end (data counter, DATACOUNT, is zero) interrupt
  591. * @arg SDMMC_IT_DHOLD: Data transfer Hold interrupt
  592. * @arg SDMMC_IT_DBCKEND: Data block sent/received (CRC check passed) interrupt
  593. * @arg SDMMC_IT_DABORT: Data transfer aborted by CMD12 interrupt
  594. * @arg SDMMC_IT_BUSYD0END: End of SDMMC_D0 Busy following a CMD response detected interrupt
  595. * @arg SDMMC_IT_SDIOIT: SDIO interrupt received interrupt
  596. * @arg SDMMC_IT_ACKFAIL: Boot Acknowledgment received interrupt
  597. * @arg SDMMC_IT_ACKTIMEOUT: Boot Acknowledgment timeout interrupt
  598. * @arg SDMMC_IT_VSWEND: Voltage switch critical timing section completion interrupt
  599. * @arg SDMMC_IT_CKSTOP: SDMMC_CK stopped in Voltage switch procedure interrupt
  600. * @arg SDMMC_IT_IDMABTC: IDMA buffer transfer complete interrupt
  601. * @retval None
  602. */
  603. #define __HAL_SD_CLEAR_IT(__HANDLE__, __INTERRUPT__) __SDMMC_CLEAR_IT((__HANDLE__)->Instance, (__INTERRUPT__))
  604. /**
  605. * @}
  606. */
  607. #if defined(STM32L4P5xx) || defined(STM32L4Q5xx) || defined(STM32L4R5xx) || defined(STM32L4R7xx) || defined(STM32L4R9xx) || defined(STM32L4S5xx) || defined(STM32L4S7xx) || defined(STM32L4S9xx)
  608. /* Include SD HAL Extension module */
  609. #include "stm32l4xx_hal_sd_ex.h"
  610. #endif /* STM32L4P5xx || STM32L4Q5xx || STM32L4R5xx || STM32L4R7xx || STM32L4R9xx || STM32L4S5xx || STM32L4S7xx || STM32L4S9xx */
  611. /* Exported functions --------------------------------------------------------*/
  612. /** @defgroup SD_Exported_Functions SD Exported Functions
  613. * @{
  614. */
  615. /** @defgroup SD_Exported_Functions_Group1 Initialization and de-initialization functions
  616. * @{
  617. */
  618. HAL_StatusTypeDef HAL_SD_Init (SD_HandleTypeDef *hsd);
  619. HAL_StatusTypeDef HAL_SD_InitCard (SD_HandleTypeDef *hsd);
  620. HAL_StatusTypeDef HAL_SD_DeInit (SD_HandleTypeDef *hsd);
  621. void HAL_SD_MspInit (SD_HandleTypeDef *hsd);
  622. void HAL_SD_MspDeInit(SD_HandleTypeDef *hsd);
  623. /**
  624. * @}
  625. */
  626. /** @defgroup SD_Exported_Functions_Group2 Input and Output operation functions
  627. * @{
  628. */
  629. /* Blocking mode: Polling */
  630. HAL_StatusTypeDef HAL_SD_ReadBlocks (SD_HandleTypeDef *hsd, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks, uint32_t Timeout);
  631. HAL_StatusTypeDef HAL_SD_WriteBlocks (SD_HandleTypeDef *hsd, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks, uint32_t Timeout);
  632. HAL_StatusTypeDef HAL_SD_Erase (SD_HandleTypeDef *hsd, uint32_t BlockStartAdd, uint32_t BlockEndAdd);
  633. /* Non-Blocking mode: IT */
  634. HAL_StatusTypeDef HAL_SD_ReadBlocks_IT (SD_HandleTypeDef *hsd, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks);
  635. HAL_StatusTypeDef HAL_SD_WriteBlocks_IT (SD_HandleTypeDef *hsd, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks);
  636. /* Non-Blocking mode: DMA */
  637. HAL_StatusTypeDef HAL_SD_ReadBlocks_DMA (SD_HandleTypeDef *hsd, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks);
  638. HAL_StatusTypeDef HAL_SD_WriteBlocks_DMA(SD_HandleTypeDef *hsd, uint8_t *pData, uint32_t BlockAdd, uint32_t NumberOfBlocks);
  639. void HAL_SD_IRQHandler (SD_HandleTypeDef *hsd);
  640. /* Callback in non blocking modes (DMA) */
  641. void HAL_SD_TxCpltCallback (SD_HandleTypeDef *hsd);
  642. void HAL_SD_RxCpltCallback (SD_HandleTypeDef *hsd);
  643. void HAL_SD_ErrorCallback (SD_HandleTypeDef *hsd);
  644. void HAL_SD_AbortCallback (SD_HandleTypeDef *hsd);
  645. #if defined (USE_HAL_SD_REGISTER_CALLBACKS) && (USE_HAL_SD_REGISTER_CALLBACKS == 1U)
  646. /* SD callback registering/unregistering */
  647. HAL_StatusTypeDef HAL_SD_RegisterCallback (SD_HandleTypeDef *hsd, HAL_SD_CallbackIDTypeDef CallbackID, pSD_CallbackTypeDef pCallback);
  648. HAL_StatusTypeDef HAL_SD_UnRegisterCallback(SD_HandleTypeDef *hsd, HAL_SD_CallbackIDTypeDef CallbackID);
  649. #if defined(STM32L4P5xx) || defined(STM32L4Q5xx) || defined(STM32L4R5xx) || defined(STM32L4R7xx) || defined(STM32L4R9xx) || defined(STM32L4S5xx) || defined(STM32L4S7xx) || defined(STM32L4S9xx)
  650. HAL_StatusTypeDef HAL_SD_RegisterTransceiverCallback (SD_HandleTypeDef *hsd, pSD_TransceiverCallbackTypeDef pCallback);
  651. HAL_StatusTypeDef HAL_SD_UnRegisterTransceiverCallback(SD_HandleTypeDef *hsd);
  652. #endif
  653. #endif /* USE_HAL_SD_REGISTER_CALLBACKS */
  654. /**
  655. * @}
  656. */
  657. /** @defgroup SD_Exported_Functions_Group3 Peripheral Control functions
  658. * @{
  659. */
  660. HAL_StatusTypeDef HAL_SD_ConfigWideBusOperation(SD_HandleTypeDef *hsd, uint32_t WideMode);
  661. HAL_StatusTypeDef HAL_SD_ConfigSpeedBusOperation(SD_HandleTypeDef *hsd, uint32_t SpeedMode);
  662. /**
  663. * @}
  664. */
  665. /** @defgroup SD_Exported_Functions_Group4 SD card related functions
  666. * @{
  667. */
  668. HAL_SD_CardStateTypeDef HAL_SD_GetCardState (SD_HandleTypeDef *hsd);
  669. HAL_StatusTypeDef HAL_SD_GetCardCID (SD_HandleTypeDef *hsd, HAL_SD_CardCIDTypeDef *pCID);
  670. HAL_StatusTypeDef HAL_SD_GetCardCSD (SD_HandleTypeDef *hsd, HAL_SD_CardCSDTypeDef *pCSD);
  671. HAL_StatusTypeDef HAL_SD_GetCardStatus(SD_HandleTypeDef *hsd, HAL_SD_CardStatusTypeDef *pStatus);
  672. HAL_StatusTypeDef HAL_SD_GetCardInfo (SD_HandleTypeDef *hsd, HAL_SD_CardInfoTypeDef *pCardInfo);
  673. /**
  674. * @}
  675. */
  676. /** @defgroup SD_Exported_Functions_Group5 Peripheral State and Errors functions
  677. * @{
  678. */
  679. HAL_SD_StateTypeDef HAL_SD_GetState(SD_HandleTypeDef *hsd);
  680. uint32_t HAL_SD_GetError(SD_HandleTypeDef *hsd);
  681. /**
  682. * @}
  683. */
  684. /** @defgroup SD_Exported_Functions_Group6 Perioheral Abort management
  685. * @{
  686. */
  687. HAL_StatusTypeDef HAL_SD_Abort (SD_HandleTypeDef *hsd);
  688. HAL_StatusTypeDef HAL_SD_Abort_IT(SD_HandleTypeDef *hsd);
  689. /**
  690. * @}
  691. */
  692. /* Private types -------------------------------------------------------------*/
  693. /** @defgroup SD_Private_Types SD Private Types
  694. * @{
  695. */
  696. /**
  697. * @}
  698. */
  699. /* Private defines -----------------------------------------------------------*/
  700. /** @defgroup SD_Private_Defines SD Private Defines
  701. * @{
  702. */
  703. /**
  704. * @}
  705. */
  706. /* Private variables ---------------------------------------------------------*/
  707. /** @defgroup SD_Private_Variables SD Private Variables
  708. * @{
  709. */
  710. /**
  711. * @}
  712. */
  713. /* Private constants ---------------------------------------------------------*/
  714. /** @defgroup SD_Private_Constants SD Private Constants
  715. * @{
  716. */
  717. /**
  718. * @}
  719. */
  720. /* Private macros ------------------------------------------------------------*/
  721. /** @defgroup SD_Private_Macros SD Private Macros
  722. * @{
  723. */
  724. /**
  725. * @}
  726. */
  727. /* Private functions prototypes ----------------------------------------------*/
  728. /** @defgroup SD_Private_Functions_Prototypes SD Private Functions Prototypes
  729. * @{
  730. */
  731. /**
  732. * @}
  733. */
  734. /* Private functions ---------------------------------------------------------*/
  735. /** @defgroup SD_Private_Functions SD Private Functions
  736. * @{
  737. */
  738. #if defined(STM32L4P5xx) || defined(STM32L4Q5xx) || defined(STM32L4R5xx) || defined(STM32L4R7xx) || defined(STM32L4R9xx) || defined(STM32L4S5xx) || defined(STM32L4S7xx) || defined(STM32L4S9xx)
  739. uint32_t SD_HighSpeed(SD_HandleTypeDef *hsd);
  740. #endif /* STM32L4P5xx && STM32L4Q5xx && STM32L4R5xx && STM32L4R7xx && STM32L4R9xx && STM32L4S5xx && STM32L4S7xx && STM32L4S9xx */
  741. /**
  742. * @}
  743. */
  744. /**
  745. * @}
  746. */
  747. /**
  748. * @}
  749. */
  750. /**
  751. * @}
  752. */
  753. #endif /* SDMMC1 */
  754. #ifdef __cplusplus
  755. }
  756. #endif
  757. #endif /* STM32L4xx_HAL_SD_H */