FsDriveSdio.hpp

//------------------------------------------------------------------------------
//This file is part of embKernel. 
//See license.txt for the full license governing this code.
//------------------------------------------------------------------------------

#ifndef FS_DRIVE_SDIO_HPP_
#define FS_DRIVE_SDIO_HPP_

#include "FsDrive.hpp"
#include "RtosInclude.hpp"

class FsDriveSdio: public FsDrive {
    friend class RtosInterrupt;

private:
    //Structures as defined in: "Physical Layer Simplified Specification Version 3.01"
    typedef enum {
        RESP_NONE,
        RESP_1,
        RESP_2,
        RESP_3,
        RESP_4,
        RESP_5,
        RESP_6,
        RESP_7
    } RESPONSE;

    typedef enum{
        SD_STATE_IDLE=0,
        SD_STATE_READY=1,
        SD_STATE_IDENT=2,
        SD_STATE_STBY=3,
        SD_STATE_TRAN=4,
        SD_STATE_DATA=5,
        SD_STATE_RCV=6,
        SD_STATE_PRG=7,
        SD_STATE_DIS=8,
    }SD_STATE; //4.10 page 75

    typedef union {
        struct {
            uint32_t res1 :3;
            uint32_t akeSeqError :1;
            uint32_t res2 :1;
            uint32_t appCmd :1;
            uint32_t res3 :2;

            uint32_t readyForData :1;
            SD_STATE currentState :4;
            uint32_t eraseReset :1;
            uint32_t cardEccDisabled :1;
            uint32_t wpEraseSkip :1;

            uint32_t csdOverwrite :1;
            uint32_t res4 :2;
            uint32_t error :1;
            uint32_t ccError :1;
            uint32_t cardEccFailed :1;
            uint32_t illegalCommand :1;
            uint32_t comCrcError :1;

            uint32_t lockUnlockFailed :1;
            uint32_t cardIsLocked :1;
            uint32_t wpViolation :1;
            uint32_t eraseParam :1;
            uint32_t eraseSeqError :1;
            uint32_t blockLenError :1;
            uint32_t addressError :1;
            uint32_t outOfRange :1;
        }bits;
        uint32_t value;
    }RESP_STATUS; //4.10 page 75

    const static uint32_t RESP_STATUS_ERROR_BITS = 0xFDFFE008;

    typedef struct {
        union {
            struct {
                uint8_t unused :1;
                uint8_t crc :7;

                uint8_t manufacturingDate[2];
                uint8_t productSerial[4];
                uint8_t productRevision;
                uint8_t productName[5];
                uint8_t oemId[2];
                uint8_t manufacturerId;
            }bits;
            uint32_t values[4];
        };
    }__attribute__((packed)) REG_CID;

    REG_CID mCid;

    typedef union {
        struct {
            struct {
                uint8_t res1 :3;
                uint8_t akeSeqError :1;
                uint8_t res2 :1;
                uint8_t appCmd :1;
                uint8_t res3 :2;

                uint8_t readyForData :1;
                uint8_t currentState :4;
                uint8_t error :1;
                uint8_t illegalCommand :1;
                uint8_t comCrcError :1;
            }status;
            uint16_t newRca;
        }bits;
        uint32_t value;
    }RESP_RCA;

    RESP_RCA mRca;

    //uint16_t mRca;

    typedef struct {
        union {
            struct {
                uint32_t unused :1;
                uint32_t crc :7;
                uint32_t res1 :2;
                uint32_t fileFormat :2;
                uint32_t tmpWriteProtect :1;
                uint32_t permWriteProtect :1;
                uint32_t copy :1;
                uint32_t fileFormatGrp :1;
                uint32_t res2 :5;
                uint32_t writeBlPartial :1;
                uint32_t writeBlLen :4;
                uint32_t r2wFactor :3;
                uint32_t res3 :2;
                uint32_t wpGrpEnable :1;

                uint32_t wpGrpSize :7;
                uint32_t sectorSize :7;
                uint32_t eraseBlkEnable :1;
                uint32_t cSizeMult :3;
                uint32_t vddWrCurrMax :3;
                uint32_t vddWrCurrMin :3;
                uint32_t vddRdCurrMax :3;
                uint32_t vddRdCurrMin :3;
                uint32_t cSizeLo :2;

                uint32_t cSizeHi :10;
                uint32_t res4 :2;
                uint32_t dsrImp :1;
                uint32_t readBlkMisalign :1;
                uint32_t writeBlkMissalign :1;
                uint32_t readBlPartial :1;
                uint32_t readBlLen :4;
                uint32_t ccc :12;

                uint32_t tranSpeed :8;
                uint32_t nsac :8;
                uint32_t taac :8;
                uint32_t res5 :6;
                uint32_t csdStruct :2;
            }bitsV1;
            struct {
                uint32_t unused :1;
                uint32_t crc :7;
                uint32_t res1 :2;
                uint32_t fileFormat :2;
                uint32_t tmpWriteProtect :1;
                uint32_t permWriteProtect :1;
                uint32_t copy :1;
                uint32_t fileFormatGrp :1;
                uint32_t res2 :5;
                uint32_t writeBlPartial :1;
                uint32_t writeBlLen :4;
                uint32_t r2wFactor :3;
                uint32_t res3 :2;
                uint32_t wpGrpEnable :1;

                uint32_t wpGrpSize :7;
                uint32_t sectorSize :7;
                uint32_t eraseBlkEnable :1;
                uint32_t res4 :1;
                uint32_t cSizeLo :16;

                uint32_t cSizeHi :6;
                uint32_t res5 :6;
                uint32_t dsrImp :1;
                uint32_t readBlkMisalign :1;
                uint32_t writeBlkMissalign :1;
                uint32_t readBlPartial :1;
                uint32_t readBlLen :4;
                uint32_t ccc :12;

                uint32_t tranSpeed :8;
                uint32_t nsac :8;
                uint32_t taac :8;
                uint32_t res6 :6;
                uint32_t csdStruct :2;
            }bitsV2;
            uint32_t values[4];
        };
    }__attribute__((packed)) REG_CSD;

    REG_CSD mCsd;

    typedef union {
        struct {
            uint32_t commandSupportBits :2;
            uint32_t res2 :9;
            uint32_t extendedSecuritySupport :4;
            uint32_t sdSpec3 :1;
            uint32_t datBusWidthSupport :4;
            uint32_t cprmSecuritySuppport :3;
            uint32_t dataStatusAfterErases :1;
            uint32_t sdSpecVersion :4;
            uint32_t scrStructure :4;

            uint32_t res1;
        }bits;
        uint32_t value[2];
    }__attribute__((packed)) RESP_SCR;

    RESP_SCR mScr;

    const static uint32_t RESP_RCA_STATUS_ERROR_BITS = 0x0000E000;

    struct {
        union {
            uint32_t isSdhc :1;
            uint32_t spare :31;
        }bits;
        uint32_t value;
    }mFlags;

public:
    FsDriveSdio();
    ~FsDriveSdio();

private:
    static FsDriveSdio* sInstances[];

    RtosSemaphore mSemaInt;

    void onIntSdio();

    bool waitInterrupt(uint32_t* status);
    bool sendCmd(uint32_t arg, uint32_t flags, RESPONSE response = RESP_NONE);
    bool getState(SD_STATE* state);
    void dataTransferConfig(uint32_t timer, uint32_t datalen, uint32_t ctrlFlags);

protected:
    virtual bool init();
    virtual bool readBlocks(FsDefs::SECTOR* buffer, unsigned int blockNumber, unsigned int blockCount);
    virtual bool writeBlocks(const FsDefs::SECTOR* buffer, unsigned int blockNumber, unsigned int blockCount);

private:
    const static uint32_t SDIO_STATIC_FLAGS = ((uint32_t) 0x000005FF);
    //CMD
    const static uint8_t CMD_GO_IDLE_STATE = ((uint8_t) 0);//
    const static uint8_t CMD_SEND_OP_COND = ((uint8_t) 1);//
    const static uint8_t CMD_ALL_SEND_CID = ((uint8_t) 2);//
    const static uint8_t CMD_SET_REL_ADDR = ((uint8_t) 3);// SDIO_SEND_REL_ADDR for SD Card
    const static uint8_t CMD_SET_DSR = ((uint8_t) 4);//
    const static uint8_t CMD_SDIO_SEN_OP_COND = ((uint8_t) 5);//
    const static uint8_t CMD_HS_SWITCH = ((uint8_t) 6);//
    const static uint8_t CMD_SEL_DESEL_CARD = ((uint8_t) 7);//
    const static uint8_t CMD_HS_SEND_EXT_CSD = ((uint8_t) 8);//
    const static uint8_t CMD_SEND_CSD = ((uint8_t) 9);//
    const static uint8_t CMD_SEND_CID = ((uint8_t) 10);//
    const static uint8_t CMD_READ_DAT_UNTIL_STOP = ((uint8_t) 11);//  SD Card doesn't support it
    const static uint8_t CMD_STOP_TRANSMISSION = ((uint8_t) 12);//
    const static uint8_t CMD_SEND_STATUS = ((uint8_t) 13);//
    const static uint8_t CMD_HS_BUSTEST_READ = ((uint8_t) 14);//
    const static uint8_t CMD_GO_INACTIVE_STATE = ((uint8_t) 15);//
    const static uint8_t CMD_SET_BLOCKLEN = ((uint8_t) 16);//
    const static uint8_t CMD_READ_SINGLE_BLOCK = ((uint8_t) 17);//
    const static uint8_t CMD_READ_MULT_BLOCK = ((uint8_t) 18);//
    const static uint8_t CMD_HS_BUSTEST_WRITE = ((uint8_t) 19);//
    const static uint8_t CMD_WRITE_DAT_UNTIL_STOP = ((uint8_t) 20);//  SD Card doesn't support it
    const static uint8_t CMD_SET_BLOCK_COUNT = ((uint8_t) 23);//  SD Card doesn't support it
    const static uint8_t CMD_WRITE_SINGLE_BLOCK = ((uint8_t) 24);//
    const static uint8_t CMD_WRITE_MULT_BLOCK = ((uint8_t) 25);//
    const static uint8_t CMD_PROG_CID = ((uint8_t) 26);//  reserved for manufacturers
    const static uint8_t CMD_PROG_CSD = ((uint8_t) 27);//
    const static uint8_t CMD_SET_WRITE_PROT = ((uint8_t) 28);//
    const static uint8_t CMD_CLR_WRITE_PROT = ((uint8_t) 29);//
    const static uint8_t CMD_SEND_WRITE_PROT = ((uint8_t) 30);//
    const static uint8_t CMD_SD_ERASE_GRP_START = ((uint8_t) 32);//  To set the address of the first write block to be erased. (For SD card only)
    const static uint8_t CMD_SD_ERASE_GRP_END = ((uint8_t) 33);//  To set the address of the last write block of the continuous range to be erased. (For SD card only)
    const static uint8_t CMD_ERASE_GRP_START = ((uint8_t) 35);//  To set the address of the first write block to be erased.(For MMC card only spec 3.31)
    const static uint8_t CMD_ERASE_GRP_END = ((uint8_t) 36);//  To set the address of the last write block of the continuous range to be erased. (For MMC card only spec 3.31)
    const static uint8_t CMD_ERASE = ((uint8_t) 38);//
    const static uint8_t CMD_FAST_IO = ((uint8_t) 39);//  SD Card doesn't support it
    const static uint8_t CMD_GO_IRQ_STATE = ((uint8_t) 40);//  SD Card doesn't support it
    const static uint8_t CMD_LOCK_UNLOCK = ((uint8_t) 42);//
    const static uint8_t CMD_APP_CMD = ((uint8_t) 55);//
    const static uint8_t CMD_GEN_CMD = ((uint8_t) 56);//
    const static uint8_t CMD_NO_CMD = ((uint8_t) 64);//
    const static uint8_t CMD_APP_SD_SET_BUSWIDTH = ((uint8_t) 6);//  For SD Card only
    const static uint8_t CMD_SD_APP_STAUS = ((uint8_t) 13);//  For SD Card only
    const static uint8_t CMD_SD_APP_SEND_NUM_WRITE_BLOCKS = ((uint8_t) 22);//  For SD Card only
    const static uint8_t CMD_SD_APP_OP_COND = ((uint8_t) 41);//  For SD Card only
    const static uint8_t CMD_SD_APP_SET_CLR_CARD_DETECT = ((uint8_t) 42);//  For SD Card only
    const static uint8_t CMD_SD_APP_SEND_SCR = ((uint8_t) 51);//  For SD Card only
    const static uint8_t CMD_SDIO_RW_DIRECT = ((uint8_t) 52);//  For SD I/O Card only
    const static uint8_t CMD_SDIO_RW_EXTENDED = ((uint8_t) 53);//  For SD I/O Card only
    const static uint8_t CMDA_SD_APP_GET_MKB = ((uint8_t) 43);//  For SD Card only
    const static uint8_t CMD_SD_APP_GET_MID = ((uint8_t) 44);//  For SD Card only
    const static uint8_t CMD_SD_APP_SET_CER_RN1 = ((uint8_t) 45);//  For SD Card only
    const static uint8_t CMD_SD_APP_GET_CER_RN2 = ((uint8_t) 46);//  For SD Card only
    const static uint8_t CMD_SD_APP_SET_CER_RES2 = ((uint8_t) 47);//  For SD Card only
    const static uint8_t CMD_SD_APP_GET_CER_RES1 = ((uint8_t) 48);//  For SD Card only
    const static uint8_t CMD_SD_APP_SECURE_READ_MULTIPLE_BLOCK = ((uint8_t) 18);//  For SD Card only
    const static uint8_t CMD_SD_APP_SECURE_WRITE_MULTIPLE_BLOCK = ((uint8_t) 25);//  For SD Card only
    const static uint8_t CMD_SD_APP_SECURE_ERASE = ((uint8_t) 38);//  For SD Card only
    const static uint8_t CMD_SD_APP_CHANGE_SECURE_AREA = ((uint8_t) 49);//  For SD Card only
    const static uint8_t CMD_SD_APP_SECURE_WRITE_MKB = ((uint8_t) 48);//  For SD Card only

    const static uint32_t SD_R6_GENERAL_UNKNOWN_ERROR = ((uint32_t) 0x00002000);
    const static uint32_t SD_R6_ILLEGAL_CMD = ((uint32_t) 0x00004000);
    const static uint32_t SD_R6_COM_CRC_FAILED = ((uint32_t) 0x00008000);

    const static uint32_t SD_VOLTAGE_WINDOW_SD = ((uint32_t) 0x80100000);
    const static uint32_t SD_HIGH_CAPACITY = ((uint32_t) 0x40000000);
    const static uint32_t SD_STD_CAPACITY = ((uint32_t) 0x00000000);
    const static uint32_t SD_CHECK_PATTERN = ((uint32_t) 0x000001AA);

    const static uint32_t SD_MAX_VOLT_TRIAL = ((uint32_t) 0x0000FFFF);
    const static uint32_t SD_ALLZERO = ((uint32_t) 0x00000000);

    const static uint32_t SD_WIDE_BUS_SUPPORT = ((uint32_t) 0x00040000);
    const static uint32_t SD_SINGLE_BUS_SUPPORT = ((uint32_t) 0x00010000);
    const static uint32_t SD_CARD_LOCKED = ((uint32_t) 0x02000000);

    const static uint32_t SD_DATATIMEOUT = ((uint32_t) 0xFFFFFFFF);
    const static uint32_t SD_0TO7BITS = ((uint32_t) 0x000000FF);
    const static uint32_t SD_8TO15BITS = ((uint32_t) 0x0000FF00);
    const static uint32_t SD_16TO23BITS = ((uint32_t) 0x00FF0000);
    const static uint32_t SD_24TO31BITS = ((uint32_t) 0xFF000000);
    const static uint32_t SD_MAX_DATA_LENGTH = ((uint32_t) 0x01FFFFFF);

    const static uint32_t SD_HALFFIFO = ((uint32_t) 0x00000008);
    const static uint32_t SD_HALFFIFOBYTES = ((uint32_t) 0x00000020);

    const static uint32_t SD_CCCC_LOCK_UNLOCK = ((uint32_t) 0x00000080);
    const static uint32_t SD_CCCC_WRITE_PROT = ((uint32_t) 0x00000040);
    const static uint32_t SD_CCCC_ERASE = ((uint32_t) 0x00000020);

    const static uint32_t SDIO_SEND_IF_COND = ((uint32_t) 0x00000008);

    const static uint32_t SDIO_IT_CCRCFAIL = 0x00000001;
    const static uint32_t SDIO_IT_DCRCFAIL = 0x00000002;
    const static uint32_t SDIO_IT_CTIMEOUT = 0x00000004;
    const static uint32_t SDIO_IT_DTIMEOUT = 0x00000008;
    const static uint32_t SDIO_IT_TXUNDERR = 0x00000010;
    const static uint32_t SDIO_IT_RXOVERR = 0x00000020;
    const static uint32_t SDIO_IT_CMDREND = 0x00000040;
    const static uint32_t SDIO_IT_CMDSENT = 0x00000080;
    const static uint32_t SDIO_IT_DATAEND = 0x00000100;
    const static uint32_t SDIO_IT_STBITERR = 0x00000200;
    const static uint32_t SDIO_IT_DBCKEND = 0x00000400;
    const static uint32_t SDIO_IT_CMDACT = 0x00000800;
    const static uint32_t SDIO_IT_TXACT = 0x00001000;
    const static uint32_t SDIO_IT_RXACT = 0x00002000;
    const static uint32_t SDIO_IT_TXFIFOHE = 0x00004000;
    const static uint32_t SDIO_IT_RXFIFOHF = 0x00008000;
    const static uint32_t SDIO_IT_TXFIFOF = 0x00010000;
    const static uint32_t SDIO_IT_RXFIFOF = 0x00020000;
    const static uint32_t SDIO_IT_TXFIFOE = 0x00040000;
    const static uint32_t SDIO_IT_RXFIFOE = 0x00080000;
    const static uint32_t SDIO_IT_TXDAVL = 0x00100000;
    const static uint32_t SDIO_IT_RXDAVL = 0x00200000;
    const static uint32_t SDIO_IT_SDIOIT = 0x00400000;
    const static uint32_t SDIO_IT_CEATAEND = 0x00800000;
};

#endif /* FS_DRIVE_SDIO_HPP_ */