mcasp/v1/mcasp.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2023 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 MCASP_H_
#define MCASP_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <drivers/mcasp.h>
#include <stdint.h>
#include <stdbool.h>
#include <kernel/dpl/HwiP.h>
#include <kernel/dpl/SemaphoreP.h>
#include <kernel/dpl/QueueP.h>
#include <drivers/hw_include/cslr_mcasp.h>
#include <drivers/hw_include/csl_types.h>
#include <drivers/udma.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
typedef void *MCASP_Handle;
 
#define MCASP_GBLCTL_TIMEOUT  (30000U)
 
#define MCASP_DATA_TIMEOUT  (30000U)
 
#define MCASP_RESET                             ((uint32_t) 0x00U)
#define MCASP_ENABLE                            ((uint32_t) 0x01U)
#define MCASP_DISABLE                           ((uint32_t) 0x00U)
 
/*
** McASP Register Offset
*/
#define MCASP_REG_OFFSET                         ((uint32_t)0x4U)
 
#define MCASP_TRANSFER_STATUS_COMPLETED        (0U)
 
#define MCASP_TRANSFER_STATUS_STARTED          (1U)
 
#define MCASP_TRANSFER_STATUS_CANCELLED        (2U)
 
#define MCASP_TRANSFER_STATUS_FAILED           (3U)
 
#define MCASP_TRANSFER_STATUS_TIMEOUT          (4U)
 
#define MCASP_TRANSFER_MODE_POLLING       (0U)
 
#define MCASP_TRANSFER_MODE_INTERRUPT     (1U)
 
#define MCASP_TRANSFER_MODE_DMA           (2U)
 
#define MCASP_OPMODE_MASTER             (0U)
 
#define MCASP_OPMODE_SLAVE              (1U)
 
#define MCASP_CHANNEL_INPUT             (0x0001U)
 
#define MCASP_CHANNEL_OUTPUT            (0x0002U)
 
#define MCASP_CHANNEL_INOUT             (MCASP_CHANNEL_INPUT | MCASP_CHANNEL_OUTPUT)
 
#define MCASP_DRIVER_STATE_DELETED          (0U)
#define MCASP_DRIVER_STATE_CREATED          (1U)
#define MCASP_DRIVER_STATE_INITIALIZED      (2U)
#define MCASP_DRIVER_STATE_OPENED           (3U)
#define MCASP_DRIVER_STATE_CLOSED           (4U)
#define MCASP_DRIVER_STATE_DEINITIALIZED    (5U)
#define MCASP_DRIVER_STATE_POWERED_DOWN     (6U)
#define MCASP_DRIVER_STATE_PWRM_SUSPEND     (7U)
 
#define MCASP_SERIALIZER_STATUS_FREE        (0U)
#define MCASP_SERIALIZER_STATUS_XMT         (1U)
#define MCASP_SERIALIZER_STATUS_RCV         (2U)
 
#define MCASP_CHANNEL_MODE_FREE             (0U)
#define MCASP_CHANNEL_MODE_XMT_DIT          (1U)
#define MCASP_CHANNEL_MODE_XMT_TDM          (2U)
#define MCASP_CHANNEL_MODE_RCV              (3U)
 
#define MCASP_WORD_SELECT_LSW               (0U)
#define MCASP_WORD_SELECT_MSW               (1U)
 
#define MCASP_AUDBUFF_FORMAT_1SER_MULTISLOT_NON_INTERLEAVED            (0U)
 
#define MCASP_AUDBUFF_FORMAT_1SER_MULTISLOT_INTERLEAVED                (1U)
 
#define MCASP_AUDBUFF_FORMAT_MULTISER_MULTISLOT_SEMI_INTERLEAVED_1     (2U)
 
#define MCASP_AUDBUFF_FORMAT_MULTISER_MULTISLOT_SEMI_INTERLEAVED_2     (3U)
 
#define MCASP_TRANSMIT_STATE_TX_RESET               (0U)
#define MCASP_TRANSMIT_STATE_TX_FLUSH               (1U)
#define MCASP_TRANSMIT_STATE_LOAD_INIT_BUFFER       (2U)
#define MCASP_TRANSMIT_STATE_RELEASE_FROM_RESET     (3U)
#define MCASP_TRANSMIT_STATE_WAIT_EVENT             (4U)
#define MCASP_TRANSMIT_STATE_PROCESS_EVENT          (5U)
#define MCASP_TRANSMIT_STATE_LOAD_ACTIVE_BUFFER     (6U)
#define MCASP_TRANSMIT_STATE_DONE                   (7U)
#define MCASP_TRANSMIT_STATE_SPIN_IDLE              (8U)
#define MCASP_TRANSMIT_STATE_ERROR                  (9U)
#define MCASP_TRANSMIT_STATE_EXIT                   (10U)
 
#define MCASP_RECEIVE_STATE_RX_RESET               (0U)
#define MCASP_RECEIVE_STATE_RX_FLUSH               (1U)
#define MCASP_RECEIVE_STATE_RELEASE_FROM_RESET     (2U)
#define MCASP_RECEIVE_STATE_WAIT_EVENT             (3U)
#define MCASP_RECEIVE_STATE_PROCESS_EVENT          (4U)
#define MCASP_RECEIVE_STATE_DONE                   (5U)
#define MCASP_RECEIVE_STATE_SPIN_IDLE              (6U)
#define MCASP_RECEIVE_STATE_ERROR                  (7U)
#define MCASP_RECEIVE_STATE_EXIT                   (8U)
 
#define MCASP_DIR_OUT   0
#define MCASP_DIR_IN    1
 
#define MCASP_TRPD_INVALID_PTR                      (0xFFFFFFFF)
 
/* ========================================================================== */
/*                             Structure Definitions                          */
/* ========================================================================== */
 
typedef struct
{
    QueueP_Elem qElem;
    void *buf;
    uint32_t count;
    uint32_t timeout;
    int32_t status;
    void *args;
} MCASP_Transaction;
 
typedef void (*MCASP_TxCallbackFxn) (MCASP_Handle handle,
                                  MCASP_Transaction *transaction);
 
typedef void (*MCASP_RxCallbackFxn) (MCASP_Handle handle,
                                  MCASP_Transaction *transaction);
 
typedef struct
{
    uint32_t aClk;
    uint32_t hiClk;
    uint32_t clkChk;
} MCASP_ClockConfig;
 
typedef struct
{
    uint32_t pfunc;
    uint32_t pdir;
    uint32_t gblCtl;
    uint32_t ditCtl;
    uint32_t dlbCtl;
    uint32_t amute;
    uint32_t serSetup[16u];
} MCASP_GlobalConfig;
 
typedef struct
{
    uint32_t fifoCtl;
    uint32_t fifoStatus;
}MCASP_FifoConfig;
 
typedef struct
{
    uint32_t mask;
    uint32_t fmt;
    uint32_t frSyncCtl;
    uint32_t tdm;
    uint32_t intCtl;
    uint32_t stat;
    uint32_t evtCtl;
    MCASP_ClockConfig clk;
    MCASP_FifoConfig fifoCfg;
} MCASP_DataConfig;
 
typedef struct
{
    MCASP_GlobalConfig gbl;
    MCASP_DataConfig rx;
    MCASP_DataConfig tx;
} MCASP_HwConfig;
 
typedef struct MCASP_DMAChConfig_s
{
    void            *txChHandle;
    void            *rxChHandle;
    void            *cqTxEvtHandle;
    void            *cqRxEvtHandle;
    void            *txTrpdMem;
    void            *rxTrpdMem;
    uint32_t        trpdMemSize;
    void            *txRingMem;
    void            *rxRingMem;
    uint32_t        ringMemSize;
    uint32_t        ringElemCnt;
    uint32_t        rxEvtNum;
    uint32_t        txEvtNum;
    uint32_t        isOpen;
}MCASP_DmaChConfig;
 
typedef struct
{
    uint8_t *pTrpdMem;
    uint8_t inUse;
} MCASP_DmaTrpdMemAlloc;
 
typedef struct
{
    uint32_t transferMode;
    uint8_t txBufferFormat;
    uint8_t rxBufferFormat;
    uint8_t txSerUsedCount;
    uint8_t rxSerUsedCount;
    uint8_t *txSerUsedArray;
    uint8_t *rxSerUsedArray;
    uint8_t txSlotCount;
    uint8_t rxSlotCount;
    MCASP_TxCallbackFxn        txCallbackFxn;
    MCASP_RxCallbackFxn        rxCallbackFxn;
    uint32_t txLoopjobEnable;
    uint8_t *txLoopjobBuf;
    uint32_t txLoopjobBufLength;
    uint32_t rxLoopjobEnable;
    uint8_t *rxLoopjobBuf;
    uint32_t rxLoopjobBufLength;
    MCASP_DmaChConfig *dmaChCfg;
    void *mcaspDmaDrvObj;
    uint8_t *cyclicBuffTx;
    uint32_t cyclicBuffSizeTx;
    uint32_t cyclicBuffCntTx;
    uint8_t *cyclicBuffRx;
    uint32_t cyclicBuffSizeRx;
    uint32_t cyclicBuffCntRx;
    Udma_ChHandle *cyclicTxFeedDMAHandle;
    Udma_ChHandle *cyclicRxFeedDMAHandle;
    Udma_EventHandle bcdmaTxCqEvtHandle;
    Udma_EventHandle bcdmaRxCqEvtHandle;
    Udma_DrvHandle bcdmaDrvHandle;
    MCASP_DmaTrpdMemAlloc *trpdMemAllocTx;
    MCASP_DmaTrpdMemAlloc *trpdMemAllocRx;
} MCASP_OpenParams;
 
typedef struct
{
    uint32_t intrNum;
    uint32_t evntNum;
    uint8_t intrPriority;
} MCASP_HwIntConfig;
 
typedef struct
{
    uint32_t inProgress;
    uint32_t state;
    int32_t status;
    uint32_t count;
    uint8_t slotCount;
    uint8_t slotIndex;
    uint8_t frameCount;
    uint8_t frameIndex;
    uint8_t serCount;
    uint8_t *serArray;
    uint8_t bufferFormat;
    MCASP_Transaction *transaction;
    MCASP_TxCallbackFxn cbFxn;
    MCASP_Transaction txnLoopjob;
    uint32_t loopjobEnable;
} MCASP_TransferObj;
 
typedef struct
{
    /*
     * User params
     */
    MCASP_Handle handle;
    uint16_t instNum;
    uint32_t drvState;
    uint32_t transferMode;
    void *mcaspDmaHandle;
    MCASP_DmaChConfig *dmaChCfg;
    MCASP_TransferObj XmtObj;
    MCASP_TransferObj RcvObj;
    /*
     * State variables
     */
    uint32_t isOpen;
    uint32_t isTxStarted;
    uint32_t isRxStarted;
    SemaphoreP_Object lockObj;
    SemaphoreP_Object transferSemObj;
    HwiP_Object hwiObjTx;
    HwiP_Object hwiObjRx;
    QueueP_Object reqQueueObjTx, curentQueueObjTx, reqQueueObjRx, curentQueueObjRx;
    QueueP_Handle reqQueueHandleTx, curentQueueHandleTx, reqQueueHandleRx, curentQueueHandleRx;
    QueueP_Object completedQueueObjRx;
    QueueP_Handle completedQueueHandleRx;
    uint8_t *cyclicBuffTx;
    uint32_t cyclicBuffSizeTx;
    uint32_t cyclicBuffCntTx;
    uint8_t *cyclicBuffRx;
    uint32_t cyclicBuffSizeRx;
    uint32_t cyclicBuffCntRx;
    MCASP_Transaction *currTransTx;
    MCASP_Transaction *currTransRx;
    uint32_t currTxTransRemCnt;
    uint32_t currRxTransRemCnt;
    Udma_ChHandle cyclicTxFeedDMAHandle;
    Udma_ChHandle cyclicRxFeedDMAHandle;
    uint8_t txTrCompletionIdx;
    uint8_t rxTrCompletionIdx;
    Udma_EventHandle bcdmaTxCyclicEvtHandle;
    Udma_EventHandle bcdmaRxCyclicEvtHandle;
 
    Udma_DrvHandle bcdmaDrvHandle;
    MCASP_DmaTrpdMemAlloc *trpdMemAllocTx;
    MCASP_DmaTrpdMemAlloc *trpdMemAllocRx;
} MCASP_Object;
 
typedef struct
{
    /*
     * SOC configuration
     */
    uintptr_t baseAddr;
    uintptr_t dataBaseAddr;
    uint16_t numOfSerializers;
    uint16_t serStatus[16];
    MCASP_HwConfig hwCfg;
    MCASP_HwIntConfig intCfgTx;
    MCASP_HwIntConfig intCfgRx;
    uint32_t txSlotSize;
    uint32_t rxSlotSize;
} MCASP_Attrs;
 
typedef struct
{
    const MCASP_Attrs *attrs;
    MCASP_Object *object;
} MCASP_Config;
 
extern MCASP_Config gMcaspConfig[];
extern uint32_t gMcaspConfigNum;
 
/* ========================================================================== */
/*                          Function Declarations */
/* ========================================================================== */
 
void MCASP_init(void);
 
void MCASP_deinit(void);
 
static inline void MCASP_openParamsInit(MCASP_OpenParams *openPrms);
 
MCASP_Handle MCASP_open(uint32_t index, const MCASP_OpenParams *openParams);
 
void MCASP_close(MCASP_Handle handle);
 
MCASP_Handle MCASP_getHandle(uint32_t index);
 
int32_t MCASP_submitTx(MCASP_Handle handle, MCASP_Transaction *txn);
 
int32_t MCASP_submitRx(MCASP_Handle handle, MCASP_Transaction *txn);
 
MCASP_Transaction* MCASP_withdrawTx(MCASP_Handle handle);
 
MCASP_Transaction* MCASP_withdrawRx(MCASP_Handle handle);
 
int32_t MCASP_startTransferTx(MCASP_Handle handle);
 
int32_t MCASP_startTransferRx(MCASP_Handle handle);
 
int32_t MCASP_stopTransferTx(MCASP_Handle handle);
 
int32_t MCASP_stopTransferRx(MCASP_Handle handle);
 
/* ========================================================================== */
/*                       Static Function Definitions */
/* ========================================================================== */
 
static inline void MCASP_openParamsInit(MCASP_OpenParams *openPrms)
{
    if (openPrms != NULL)
    {
        // Set Default values
    }
}
 
#ifdef __cplusplus
}
#endif
 
#endif /* #ifndef MCASP_H_ */