mmcsd_lld.h

Go to the documentation of this file.

/*
 * Copyright (C) 2024 Texas Instruments Incorporated
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *   Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 *
 *   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.
 *
 *   Neither the name of Texas Instruments Incorporated 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
 * OWNER 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 MMCSD_LLD_H_
#define MMCSD_LLD_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
#include <stdbool.h>
#include <stdlib.h>
#include <stddef.h>
#include <string.h>
#include <drivers/hw_include/cslr.h>
#include <drivers/hw_include/cslr64.h>
#include <drivers/hw_include/hw_types.h>
#include <drivers/hw_include/cslr_mmcsd.h>
#include <drivers/mmcsd/v0/cslr_mmcsd.h>
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
#define MMCSD_STS_SUCCESS                       ((int32_t) 0)
 
#define MMCSD_STS_ERR                           ((int32_t)-1)
 
#define MMCSD_STS_ERR_TIMEOUT                   ((int32_t)-2)
 
#define MMCSD_STS_ERR_INVALID_PARAM             ((int32_t)-3)
 
#define MMCSD_STS_ERR_BUSY                      ((int32_t)-4)
 
#define MMCSD_STS_ERR_CARD_NOT_FOUND            ((int32_t)-5)
 
#define MMCSD_STS_ERR_CARD_UNUSEABLE            ((int32_t)-6)
 
#define MMCSD_STS_ERR_CARD_UNLOCK_FAIL          ((int32_t)-7)
 
#define MMCSD_NO_WAIT                           ((uint32_t)0)
 
#define MMCSD_WAIT_FOREVER                      ((uint32_t)-1)
 
#define MMCSD_STATE_RESET                       ((uint8_t) 0U)
 
#define MMCSD_STATE_IDLE                        ((uint8_t) 1U)
 
#define MMCSD_STATE_BUSY                        ((uint8_t) 2U)
 
#define MMCSD_STATE_ERROR                       ((uint8_t) 3U)
 
#define MMCSD_XFER_IDLE_STATE                   ((uint8_t) 0U)
 
#define MMCSD_XFER_CMD_STATE                    ((uint8_t) 1U)
 
#define MMCSD_XFER_WRITE_STATE                  ((uint8_t) 2U)
 
#define MMCSD_XFER_READ_STATE                   ((uint8_t) 3U)
 
#define MMCSD_SLOT_TYPE_VAL_REMOVABLE           ((uint8_t) 0x0U)
#define MMCSD_SLOT_TYPE_VAL_EMBEDDED            ((uint8_t) 0x1U)
#define MMCSD_SLOT_TYPE_VAL_SHARED              ((uint8_t) 0x2U)
 
#define MMCSD_CARD_TYPE_SD                      ((uint32_t) 0U)
#define MMCSD_CARD_TYPE_EMMC                    ((uint32_t) 2U)
#define MMCSD_CARD_TYPE_NO_DEVICE               ((uint32_t) 3U)
 
#define MMCSD_PHY_TYPE_HW_PHY                   ((uint32_t) 0U)
#define MMCSD_PHY_TYPE_SW_PHY                   ((uint32_t) 1U)
#define MMCSD_PHY_TYPE_NO_PHY                   ((uint32_t) 2U)
 
#define MMCSD_BUS_WIDTH_4BIT                    ((uint32_t) 0x4U)
#define MMCSD_BUS_WIDTH_8BIT                    ((uint32_t) 0x8U)
#define MMCSD_BUS_WIDTH_1BIT                    ((uint32_t) 0x1U)
 
#define MMCSD_PHY_TUNING_TYPE_AUTO              ((uint32_t) 0U)
#define MMCSD_PHY_TUNING_TYPE_MANUAL            ((uint32_t) 1U)
 
#define MMCSD_SD_MODE_HS                        ((uint32_t) 10U)
#define MMCSD_SD_MODE_DS                        ((uint32_t) 11U)
#define MMCSD_SD_MODE_SDR12                     ((uint32_t) 12U)
#define MMCSD_SD_MODE_SDR25                     ((uint32_t) 13U)
#define MMCSD_SD_MODE_SDR50                     ((uint32_t) 14U)
#define MMCSD_SD_MODE_DDR50                     ((uint32_t) 15U)
#define MMCSD_SD_MODE_SDR104                    ((uint32_t) 16U)
 
#define MMCSD_MMC_MODE_SDR25                    ((uint32_t) 20U)
#define MMCSD_MMC_MODE_SDR50                    ((uint32_t) 21U)
#define MMCSD_MMC_MODE_HS200                    ((uint32_t) 23U)
 
/* ========================================================================== */
/*                      Function Pointers Declarations                        */
/* ========================================================================== */
 
typedef uint32_t (*MMCSD_Clock_getTicks) (void);
 
typedef uint32_t (*MMCSD_Clock_usecToTicks) (uint64_t usecs);
 
typedef void (*MMCSD_Clock_uSleep) (uint32_t usec);
 
typedef void (*MMCSD_lld_transferCompleteCallback) (void *args,
                                                    int32_t xferStatus);
 
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
 
typedef struct {
 
    uint32_t                ocr;
    uint32_t                rca;
    uint16_t                maxReadBlockLen;
    uint16_t                maxWriteBlockLen;
    char                    manuDate[9];
    uint8_t                 manuID;
    char                    productName[7];
    uint8_t                 specVersion;
    uint32_t                blockCount;
    uint8_t                 transferSpeed;
    uint8_t                 supportedModes;
    uint8_t                 eStrobeSupport;
    uint8_t                 driveStrength;
    bool                    isHC;
 
} MMCSD_EmmcDeviceData;
 
typedef struct {
 
    uint32_t                ocr;
    uint32_t                rca;
    uint16_t                maxReadBlockLen;
    uint16_t                maxWriteBlockLen;
    char                    manuDate[9];
    uint8_t                 manuID;
    char                    productName[6];
    uint8_t                 specVersion;
    uint32_t                blockCount;
    uint8_t                 transferSpeed;
    uint32_t                isCmd23;
    uint32_t                supportedDataWidths;
    bool                    isHC;
 
} MMCSD_SdDeviceData;
 
typedef struct {
 
    uint32_t                cmd;
    uint32_t                dir;
    uint32_t                arg;
    uint8_t                 *dataBuf;
    uint32_t                blockSize;
    uint32_t                blockCount;
    uint32_t                autoCmdEn;
    uint32_t                enableDma;
    uint32_t                isTuning;
    uint32_t                response[4];
 
} MMCSDLLD_Transaction;
 
typedef struct {
 
    uint32_t                ctrlBaseAddr;
    uint32_t                ssBaseAddr;
    uint32_t                inputClkFreq;
    uint32_t                cardType;
    bool                    autoAssignMaxSpeed;
    uint32_t                uaBusSpeed;
    uint32_t                tuningType;
    uint32_t                intrNum;
    uint32_t                slotType;
    uint32_t                busWidth;
    bool                    enableDma;
    uint32_t                phyType;
    bool                    pllEnableSD;
    void                    *deviceData;
    uint8_t                 *dataBuf;
    MMCSD_Clock_getTicks    Clock_getTicks;
    MMCSD_Clock_uSleep      Clock_uSleep;
 
} MMCSDLLD_InitObject, *MMCSDLLD_InitHandle;
 
 
typedef struct {
 
    uint16_t                cmdErrorStat;
    uint16_t                xferErrorStat;
    uint8_t                 *dataBufIdx;
    uint32_t                dataBlockCount;
    uint32_t                dataBlockSize;
    uint32_t                remainingBlockCount;
    MMCSDLLD_Transaction    *currentTxn;
    MMCSDLLD_Transaction    mmcsdTxn;
    uint32_t                setBusSpeed;
    uint32_t                setBusWidth;
    uint8_t                 xferState;
    uint8_t                 state;
    MMCSDLLD_InitHandle     initHandle;
    void                    *args;
    MMCSD_lld_transferCompleteCallback          transferCompleteCallback;
 
} MMCSDLLD_Object, *MMCSDLLD_Handle;
 
/* ========================================================================== */
/*                        API Function Declarations                           */
/* ========================================================================== */
 
int32_t MMCSD_lld_init(MMCSDLLD_Handle handle);
 
int32_t MMCSD_lld_deInit(MMCSDLLD_Handle handle);
 
uint32_t MMCSD_lld_getBlockSize(MMCSDLLD_Handle handle);
 
int32_t MMCSD_lld_write_SD_Poll(MMCSDLLD_Handle handle, uint8_t *buf,
                                uint32_t startBlk, uint32_t numBlks);
 
int32_t MMCSD_lld_read_SD_Poll(MMCSDLLD_Handle handle, uint8_t *buf,
                               uint32_t startBlk, uint32_t numBlks);
 
int32_t MMCSD_lld_write_MMC_Poll(MMCSDLLD_Handle handle, uint8_t *buf,
                                 uint32_t startBlk, uint32_t numBlks);
 
int32_t MMCSD_lld_read_MMC_Poll(MMCSDLLD_Handle handle, uint8_t *buf,
                                uint32_t startBlk, uint32_t numBlks);
 
int32_t MMCSD_lld_write_SD_Intr(MMCSDLLD_Handle handle, uint8_t *buf,
                                uint32_t startBlk, uint32_t numBlks);
 
int32_t MMCSD_lld_read_SD_Intr(MMCSDLLD_Handle handle, uint8_t *buf,
                               uint32_t startBlk, uint32_t numBlks);
 
int32_t MMCSD_lld_write_MMC_Intr(MMCSDLLD_Handle handle, uint8_t *buf,
                                 uint32_t startBlk, uint32_t numBlks);
 
int32_t MMCSD_lld_read_MMC_Intr(MMCSDLLD_Handle handle, uint8_t *buf,
                                uint32_t startBlk, uint32_t numBlks);
 
int32_t MMCSD_lld_change_Bus_Config_MMC(MMCSDLLD_Handle handle,
                                        uint32_t busSpeed, uint32_t busWidth);
 
int32_t MMCSD_lld_change_Bus_Config_SD(MMCSDLLD_Handle handle,
                                       uint32_t busSpeed);
 
int32_t MMCSD_lld_change_Tuning_Type(MMCSDLLD_Handle handle,
                                     uint32_t tuningType);
 
int32_t MMCSD_lld_enableBootPartition(MMCSDLLD_Handle handle,
                                      uint32_t partitionNum);
 
int32_t MMCSD_lld_disableBootPartition(MMCSDLLD_Handle handle);
 
/* ========================================================================== */
/*                        ISR Function Declarations                           */
/* ========================================================================== */
 
void MMCSD_lld_Isr(void *args);
 
#ifdef __cplusplus
}
#endif
 
#endif /* MMCSD_LLD_H_ */