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