mmcsd.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2021-24 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_H_
#define MMCSD_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
#include <kernel/dpl/SystemP.h>
#include <kernel/dpl/SemaphoreP.h>
#include <kernel/dpl/HwiP.h>
#include <drivers/hw_include/csl_types.h>
#include <drivers/hw_include/cslr_mmcsd.h>
#include <drivers/mmcsd/v0/lld/mmcsd_lld.h>
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
#define MMCSD_MODE_BLOCKING                       ((uint32_t) 0U)
#define MMCSD_MODE_CALLBACK                       ((uint32_t) 1U)
 
typedef void* MMCSD_Handle;
 
/* ========================================================================== */
/*                      Function Pointers Declarations                        */
/* ========================================================================== */
 
typedef void (*MMCSD_txnCallbackFxn) (MMCSD_Handle mmcsdHandle,
                                      int32_t transferStatus);
 
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
 
typedef struct
{
    void                    *deviceData;
    /*  Pointer to a 512 byte dataBuffer used for temporary data transactions
     *  internal to driver like ECSD read, tuning etc.
     *  To be allocated by application */
    uint8_t                 *dataBuf;
    uint8_t                 transferMode;
    MMCSD_txnCallbackFxn    txnCallbackFxn;
 
} MMCSD_Params;
 
typedef struct
{
    uint32_t                ctrlBaseAddr;
    uint32_t                ssBaseAddr;
    uint32_t                inputClkFreq;
    bool                    enableDma;
    bool                    intrEnable;
    uint32_t                intrNum;
    uint32_t                eventId;
    uint32_t                cardType;
    uint32_t                busWidth;
    uint32_t                phyType;
    uint32_t                tuningType;
    bool                    autoAssignMaxSpeed;
    uint32_t                uaBusSpeed;
    uint32_t                slotType;
    bool                    pllEnableSD;
    uint32_t                intrPriority;
} MMCSD_Attrs;
 
typedef struct
{
    uint32_t                cardType;
    bool                    isOpen;
    SemaphoreP_Object       mutex;
    SemaphoreP_Object       xferCompleteSemObj;
    HwiP_Object             hwiObj;
    MMCSDLLD_Object         mmcsdLldObject;
    MMCSDLLD_Handle         mmcsdLldHandle;
    MMCSDLLD_InitObject     mmcsdLldInitObject;
    uint32_t                transferMode;
    MMCSD_txnCallbackFxn    txnCallbackFxn;
} MMCSD_Object;
 
typedef struct
{
    const MMCSD_Attrs       *attrs;
    MMCSD_Object            *object;
} MMCSD_Config;
 
/* ========================================================================== */
/*                                Externs                                     */
/* ========================================================================== */
 
extern MMCSD_Config         gMmcsdConfig[];
extern uint32_t             gMmcsdConfigNum;
 
/* ========================================================================== */
/*                       Function Declarations                                */
/* ========================================================================== */
 
void MMCSD_init(void);
 
void MMCSD_deinit(void);
 
void MMCSD_Params_init(MMCSD_Params *mmcsdParams);
 
MMCSD_Handle MMCSD_open(uint32_t index, const MMCSD_Params *openParams);
 
void MMCSD_close(MMCSD_Handle handle);
 
MMCSD_Handle MMCSD_getHandle(uint32_t index);
 
int32_t MMCSD_read(MMCSD_Handle handle, uint8_t *buf, uint32_t startBlk, uint32_t numBlks);
 
int32_t MMCSD_write(MMCSD_Handle handle, uint8_t *buf, uint32_t startBlk, uint32_t numBlks);
 
uint32_t MMCSD_getBlockSize(MMCSD_Handle handle);
 
uint32_t MMCSD_getBlockCount(MMCSD_Handle handle);
 
uint32_t MMCSD_isHC(MMCSD_Handle handle);
 
int32_t MMCSD_change_Bus_Config(MMCSD_Handle handle, uint32_t busSpeed,
                                uint32_t busWidth);
 
int32_t MMCSD_change_Tuning_Type(MMCSD_Handle handle, uint32_t tuningType);
 
int32_t MMCSD_enableBootPartition(MMCSD_Handle handle, uint32_t partitionNum);
 
int32_t MMCSD_disableBootPartition(MMCSD_Handle handle);
 
#ifdef __cplusplus
}
#endif
#endif /* MMCSD_H_ */