stm32f1xx_hal_sd.h 35 KB

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