aasrc_ch.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2025 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 AASRC_CH_H_
#define AASRC_CH_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
#include <drivers/aasrc/v0/aasrc_transactions.h>
#include <drivers/aasrc/v0/aasrc_dma.h>
 
/* None */
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
#define AASRC_DEFAULT_IN_FIFO_THRESHOLD         (16U)
 
#define AASRC_DEFAULT_OUT_FIFO_THRESHOLD        (16U)
 
#define AASRC_MAX_IN_FIFO_THRESHOLD             (32U)
 
#define AASRC_MAX_OUT_FIFO_THRESHOLD            (16U)
 
#define AASRC_CHANNEL_0                         (0U)
#define AASRC_CHANNEL_1                         (1U)
#define AASRC_CHANNEL_2                         (2U)
#define AASRC_CHANNEL_3                         (3U)
#define AASRC_CHANNEL_4                         (4U)
#define AASRC_CHANNEL_5                         (5U)
#define AASRC_CHANNEL_6                         (6U)
#define AASRC_CHANNEL_7                         (7U)
 
#define AASRC_GROUP0                            (0U)
#define AASRC_GROUP1                            (1U)
#define AASRC_GROUP2                            (2U)
#define AASRC_GROUP3                            (3U)
 
#define AASRC_SAMPLE_WORD_LENGTH_24             (24U)
#define AASRC_SAMPLE_WORD_LENGTH_20             (20U)
#define AASRC_SAMPLE_WORD_LENGTH_18             (18U)
#define AASRC_SAMPLE_WORD_LENGTH_16             (16U)
 
#define AASRC_GROUP_DELAY_64                    (64U)
#define AASRC_GROUP_DELAY_32                    (32U)
#define AASRC_GROUP_DELAY_16                    (16U)
#define AASRC_GROUP_DELAY_8                     (8U)
 
#define AASRC_MAX_ATTENUATION                   (255U)
 
#define AASRC_MAX_DEEMPHASIS_MODES              (4U)
 
#define AASRC_SRC_FIFO_CONTROL_REG_OFFSET   (0x00000010U)
 
#define AASRC_SRC_FIFO_CONTROL(x)           ((uint32_t) CSL_AASRC_CFG_SRC_FIFO_CONTROL_0 + \
                                            (uint32_t) ((uint32_t) AASRC_SRC_FIFO_CONTROL_REG_OFFSET * \
                                                        (uint32_t) (x)))
 
#define AASRC_SRC_CONTROL_REG_OFFSET        (0x00000010U)
 
#define AASRC_SRC_CONTROL(x)                ((uint32_t) CSL_AASRC_CFG_SRC_CONTROL_0 + \
                                            (uint32_t) ((uint32_t) AASRC_SRC_CONTROL_REG_OFFSET * \
                                                        (uint32_t) (x)))
 
#define AASRC_SRC_STATUS_REG_OFFSET         (0x00000010U)
 
#define AASRC_SRC_STATUS(x)                 ((uint32_t) CSL_AASRC_CFG_SRC_STATUS_0 + \
                                            (uint32_t) ((uint32_t) AASRC_SRC_STATUS_REG_OFFSET * \
                                                        (uint32_t) (x)))
 
#define AASRC_GROUP_FIFO_CONTROL_REG_OFFSET (0x00000008U)
 
#define AASRC_GROUP_FIFO_CONTROL(x)         ((uint32_t) CSL_AASRC_CFG_GROUP_FIFO_CONTROL_0 + \
                                            (uint32_t) ((uint32_t) AASRC_GROUP_FIFO_CONTROL_REG_OFFSET * \
                                                        (uint32_t) (x)))
 
#define AASRC_GROUP_SRC_CONTROL_REG_OFFSET  (0x00000008U)
 
#define AASRC_GROUP_SRC_CONTROL(x)          ((uint32_t) CSL_AASRC_CFG_GROUP_SRC_CONTROL_0 + \
                                            (uint32_t) ((uint32_t) AASRC_GROUP_SRC_CONTROL_REG_OFFSET * \
                                                        (uint32_t) (x)))
 
#define AASRC_GROUP_SELECT_REG_OFFSET       (0x00000004U)
 
#define AASRC_INPUT_GROUP_SELECT(x)         ((uint32_t) CSL_AASRC_CFG_INPUT_GROUP_0_SELECT + \
                                            (uint32_t) ((uint32_t) AASRC_GROUP_SELECT_REG_OFFSET * \
                                                        (uint32_t) (x)))
 
#define AASRC_OUTPUT_GROUP_SELECT(x)        ((uint32_t) CSL_AASRC_CFG_OUTPUT_GROUP_0_SELECT + \
                                            (uint32_t) ((uint32_t) AASRC_GROUP_SELECT_REG_OFFSET * \
                                                        (uint32_t) (x)))
 
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
typedef struct
{
    void *lock;
    SemaphoreP_Object lockObj;
} AASRC_ChLockObj;
 
typedef struct
{
    uint32_t                inFifoThreshold;
    uint32_t                outFifoThreshold;
} AASRC_FifoCfg;
 
typedef struct
{
    uint8_t                 lChannelOverflow;
    uint8_t                 rChannelOverflow;
    uint8_t                 lChannelUnderflow;
    uint8_t                 rChannelUnderflow;
} AASRC_FifoErrorStatus;
 
typedef struct
{
    uint32_t                rateRatio;
    uint32_t                upsample;
} AASRC_ChStatus;
 
typedef struct
{
    /*
     * Primary user configs
     */
    uint32_t                chType;
    uint32_t                chCount;
    /*
     * Secondary user configs
     */
    AASRC_FifoCfg           fifoControl;
    uint8_t                inClkZone;
    uint8_t                outClkZone;
    uint32_t                inWordLen;
    uint32_t                ditherEnable;
    uint32_t                mute;
    uint32_t                directDownSample;
    uint32_t                attenuation;
    uint32_t                deEmphasisMode;
    uint32_t                groupDelay;
    uint32_t                outWordLen;
} AASRC_ChCfg;
 
typedef struct
{
    uint32_t clkZoneDiv;
    bool isClkZoneDivEnable;
    uint8_t syncPin;
    uint32_t extClkSrc;
    bool overrideClkSettle;
} AASRC_ClockZoneConfig;
 
 
 typedef struct
 {
     AASRC_ClockZoneConfig   rxClkZoneCfg;
     AASRC_ClockZoneConfig   txClkZoneCfg;
 } AASRC_ChClkCfg;
 
 
typedef struct
{
    /*
     * Linker variables
     */
    AASRC_Handle            drvHandle;
    /*
     * State variables
     */
    bool                    isOpen;
    AASRC_ChState           *chState;
    /*   User MUST not change this!*/
 
    /*
     * Channel Configuration variables
     */
    AASRC_ChCfg             chCfg;
 
 
    AASRC_DmaChCfg          *dmaChCfg;
    /*
     * Data transfer variables
     */
    AASRC_TransferObj       rcvObj;
    AASRC_TransferObj       xmtObj;
    /*
     * lock semaphore Obj
     */
    SemaphoreP_Object       transferSemObj;
    /*
     * Data holding queues
     */
    QueueP_Object           reqQueueObjRx;
    QueueP_Object           reqQueueObjTx;
    QueueP_Handle           reqQueueHandleRx;
    QueueP_Handle           reqQueueHandleTx;
    /*
     * Status variables
     */
    AASRC_ChStatus          chStatus;
    AASRC_FifoErrorStatus   inFifoErrorStatus;
    AASRC_FifoErrorStatus   outFifoErrorStatus;
    /*
     * Error call back function
     */
    AASRC_ChErrorCallbackFxn errCbFxn;
     uint32_t lastPlayed;
     uint32_t lastFilled;
     uint32_t lastReceived;
     uint32_t lastRecQueued;
     AASRC_DmaIcnt txDmaIcnt;
     AASRC_DmaIcnt rxDmaIcnt;
} AASRC_ChObj;
 
extern AASRC_ChObj *gConfigAasrcChObj[];
 
AASRC_ChLockObj gAasrcChLockObj;
 
/* ========================================================================== */
/*                      API Function Declarations                             */
/* ========================================================================== */
 
AASRC_ChHandle AASRC_chOpen(uint8_t chIdx, AASRC_Handle drvHandle);
 
AASRC_ChHandle AASRC_getChHandle(uint8_t instIdx, uint8_t chIdx);
 
int32_t AASRC_chConfigInit(AASRC_ChHandle chHandle);
 
int32_t AASRC_chConfig(AASRC_ChHandle chHandle);
 
int32_t AASRC_chEnable(AASRC_ChHandle chHandle);
 
int32_t AASRC_chDisable(AASRC_ChHandle chHandle);
 
int32_t AASRC_isChEnabled(AASRC_ChHandle chHandle, uint32_t *isEnabled);
 
int32_t AASRC_chClose(AASRC_ChHandle chHandle);
 
/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */
 
/* None */
 
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* #ifndef AASRC_CH_H_ */