You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

stm32l1xx_hal_sd.h 37KB

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