/**************************************************************************//** * @file sdh.h * @version V1.00 * @brief M261 SDH driver header file * * @copyright (C) 2019 Nuvoton Technology Corp. All rights reserved. * * Redistribution and use in source and binary forms, with or without modification, * are permitted provided that the following conditions are met: * 1. Redistributions of source code must retain the above copyright notice, * this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright notice, * this list of conditions and the following disclaimer in the documentation * and/or other materials provided with the distribution. * 3. Neither the name of Nuvoton Technology Corp. nor the names of its contributors * may be used to endorse or promote products derived from this software * without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *****************************************************************************/ #ifndef __SDH_H__ #define __SDH_H__ #ifdef __cplusplus extern "C" { #endif #include /** @addtogroup Standard_Driver Standard Driver @{ */ /** @addtogroup SDH_Driver SDH Driver @{ */ /** @addtogroup SDH_EXPORTED_CONSTANTS SDH Exported Constants @{ */ #define SDH_ERR_ID 0xFFFF0100UL /*!< SDH error ID \hideinitializer */ #define SDH_TIMEOUT (SDH_ERR_ID|0x01UL) /*!< Timeout \hideinitializer */ #define SDH_NO_MEMORY (SDH_ERR_ID|0x02UL) /*!< OOM \hideinitializer */ /* -- function return value */ #define Successful 0U /*!< Success \hideinitializer */ #define Fail 1U /*!< Failed \hideinitializer */ /* --- define type of SD card or MMC */ #define SDH_TYPE_UNKNOWN 0UL /*!< Unknown card type \hideinitializer */ #define SDH_TYPE_SD_HIGH 1UL /*!< SDHC card \hideinitializer */ #define SDH_TYPE_SD_LOW 2UL /*!< SD card \hideinitializer */ #define SDH_TYPE_MMC 3UL /*!< MMC card \hideinitializer */ #define SDH_TYPE_EMMC 4UL /*!< eMMC card \hideinitializer */ /* SD error */ #define SDH_NO_SD_CARD (SDH_ERR_ID|0x10UL) /*!< Card removed \hideinitializer */ #define SDH_ERR_DEVICE (SDH_ERR_ID|0x11UL) /*!< Device error \hideinitializer */ #define SDH_INIT_TIMEOUT (SDH_ERR_ID|0x12UL) /*!< Card init timeout \hideinitializer */ #define SDH_SELECT_ERROR (SDH_ERR_ID|0x13UL) /*!< Card select error \hideinitializer */ #define SDH_WRITE_PROTECT (SDH_ERR_ID|0x14UL) /*!< Card write protect \hideinitializer */ #define SDH_INIT_ERROR (SDH_ERR_ID|0x15UL) /*!< Card init error \hideinitializer */ #define SDH_CRC7_ERROR (SDH_ERR_ID|0x16UL) /*!< CRC 7 error \hideinitializer */ #define SDH_CRC16_ERROR (SDH_ERR_ID|0x17UL) /*!< CRC 16 error \hideinitializer */ #define SDH_CRC_ERROR (SDH_ERR_ID|0x18UL) /*!< CRC error \hideinitializer */ #define SDH_CMD8_ERROR (SDH_ERR_ID|0x19UL) /*!< Command 8 error \hideinitializer */ #define MMC_FREQ 20000UL /*!< output 20MHz to MMC \hideinitializer */ #define SD_FREQ 25000UL /*!< output 25MHz to SD \hideinitializer */ #define SDHC_FREQ 50000UL /*!< output 50MHz to SDH \hideinitializer */ #define CardDetect_From_GPIO (1UL << 8) /*!< Card detection pin is GPIO \hideinitializer */ #define CardDetect_From_DAT3 (1UL << 9) /*!< Card detection pin is DAT3 \hideinitializer */ /*@}*/ /* end of group SDH_EXPORTED_CONSTANTS */ /** @addtogroup SDH_EXPORTED_TYPEDEF SDH Exported Type Defines @{ */ typedef struct SDH_info_t { unsigned int CardType; /*!< SDHC, SD, or MMC */ unsigned int RCA; /*!< Relative card address */ unsigned char IsCardInsert; /*!< Card insert state */ unsigned int totalSectorN; /*!< Total sector number */ unsigned int diskSize; /*!< Disk size in K bytes */ int sectorSize; /*!< Sector size in bytes */ } SDH_INFO_T; /*!< Structure holds SD card info */ /*@}*/ /* end of group SDH_EXPORTED_TYPEDEF */ /** @cond HIDDEN_SYMBOLS */ extern SDH_INFO_T SD0; /** @endcond HIDDEN_SYMBOLS */ /** @addtogroup SDH_EXPORTED_FUNCTIONS SDH Exported Functions @{ */ /** * @brief Enable specified interrupt. * * @param[in] sdh The pointer of the specified SDH module. * @param[in] u32IntMask Interrupt type mask: * \ref SDH_INTEN_BLKDIEN_Msk / \ref SDH_INTEN_CRCIEN_Msk / \ref SDH_INTEN_CDIEN_Msk / * \ref SDH_INTEN_CDSRC_Msk / \ref SDH_INTEN_RTOIEN_Msk / \ref SDH_INTEN_DITOIEN_Msk / * \ref SDH_INTEN_WKIEN_Msk * * @return None. * \hideinitializer */ #define SDH_ENABLE_INT(sdh, u32IntMask) ((sdh)->INTEN |= (u32IntMask)) /** * @brief Disable specified interrupt. * * @param[in] sdh The pointer of the specified SDH module. * @param[in] u32IntMask Interrupt type mask: * \ref SDH_INTEN_BLKDIEN_Msk / \ref SDH_INTEN_CRCIEN_Msk / \ref SDH_INTEN_CDIEN_Msk / * \ref SDH_INTEN_RTOIEN_Msk / \ref SDH_INTEN_DITOIEN_Msk / \ref SDH_INTEN_WKIEN_Msk / \ref SDH_INTEN_CDSRC_Msk / * * @return None. * \hideinitializer */ #define SDH_DISABLE_INT(sdh, u32IntMask) ((sdh)->INTEN &= ~(u32IntMask)) /** * @brief Get specified interrupt flag/status. * * @param[in] sdh The pointer of the specified SDH module. * @param[in] u32IntMask Interrupt type mask: * \ref SDH_INTSTS_BLKDIF_Msk / \ref SDH_INTSTS_CRCIF_Msk / \ref SDH_INTSTS_CRC7_Msk / * \ref SDH_INTSTS_CRC16_Msk / \ref SDH_INTSTS_CRCSTS_Msk / \ref SDH_INTSTS_DAT0STS_Msk / * \ref SDH_INTSTS_CDIF_Msk / \ref SDH_INTSTS_RTOIF_Msk / * \ref SDH_INTSTS_DITOIF_Msk / \ref SDH_INTSTS_CDSTS_Msk / * \ref SDH_INTSTS_DAT1STS_Msk * * * @return 0 = The specified interrupt is not happened. * 1 = The specified interrupt is happened. * \hideinitializer */ #define SDH_GET_INT_FLAG(sdh, u32IntMask) (((sdh)->INTSTS & (u32IntMask))?1:0) /** * @brief Clear specified interrupt flag/status. * * @param[in] sdh The pointer of the specified SDH module. * @param[in] u32IntMask Interrupt type mask: * \ref SDH_INTSTS_BLKDIF_Msk / \ref SDH_INTSTS_CRCIF_Msk / \ref SDH_INTSTS_CDIF_Msk / * \ref SDH_INTSTS_RTOIF_Msk / \ref SDH_INTSTS_DITOIF_Msk * * * @return None. * \hideinitializer */ #define SDH_CLR_INT_FLAG(sdh, u32IntMask) ((sdh)->INTSTS = (u32IntMask)) /** * @brief Check SD Card inserted or removed. * * @param[in] sdh The pointer of the specified SDH module. * * @return 1: Card inserted. * 0: Card removed. * \hideinitializer */ #define SDH_IS_CARD_PRESENT(sdh) ((((sdh) == SDH0)||((sdh) == SDH0_NS))? SD0.IsCardInsert : 0) /** * @brief Get SD Card capacity. * * @param[in] sdh The pointer of the specified SDH module. * * @return SD Card capacity. (unit: KByte) * \hideinitializer */ #define SDH_GET_CARD_CAPACITY(sdh) ((((sdh) == SDH0)||((sdh) == SDH0_NS))? SD0.diskSize : 0) void SDH_Open(SDH_T *sdh, uint32_t u32CardDetSrc); uint32_t SDH_Probe(SDH_T *sdh); uint32_t SDH_Read(SDH_T *sdh, uint8_t *pu8BufAddr, uint32_t u32StartSec, uint32_t u32SecCount); uint32_t SDH_Write(SDH_T *sdh, uint8_t *pu8BufAddr, uint32_t u32StartSec, uint32_t u32SecCount); uint32_t SDH_CardDetection(SDH_T *sdh); void SDH_Open_Disk(SDH_T *sdh, uint32_t u32CardDetSrc); void SDH_Close_Disk(SDH_T *sdh); /*@}*/ /* end of group SDH_EXPORTED_FUNCTIONS */ /*@}*/ /* end of group SDH_Driver */ /*@}*/ /* end of group Standard_Driver */ #ifdef __cplusplus } #endif #endif /* end of __SDH_H__ */ /*** (C) COPYRIGHT 2019 Nuvoton Technology Corp. ***/