I2SWFF3.h

Go to the documentation of this file.

/*
 * Copyright (c) 2025 Texas Instruments Incorporated
 * All rights reserved.
 *
 * 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 ti_drivers_i2s_I2SWFF3__include
#define ti_drivers_i2s_I2SWFF3__include

#include <stdint.h>
#include <stdbool.h>

#include <ti/drivers/I2S.h>
#include <ti/drivers/dpl/SemaphoreP.h>
#include <ti/drivers/dpl/HwiP.h>
#include <ti/drivers/Power.h>

#include <ti/devices/DeviceFamily.h>
#include DeviceFamily_constructPath(driverlib/i2s.h)

#ifdef __cplusplus
extern "C" {
#endif

typedef enum
{
    I2SWFF3_CLK_SRC_SOC_CLK     = I2S_CLK_SRC_SOC_CLK,
    I2SWFF3_CLK_SRC_SOC_PLL_CLK = I2S_CLK_SRC_SOC_PLL_CLK,
    I2SWFF3_CLK_SRC_HFXT_CLK    = I2S_CLK_SRC_HFXT_CLK,
} I2SWFF3_ClkSrc;

typedef struct
{
    uint32_t tref:21;
    uint32_t reserved0:11;
    uint32_t delta:17;
    uint32_t deltaSign:1;
    uint32_t reserved1:2;
    uint32_t div:10;
    uint32_t reserved2:2;

} I2SWFF3_ADFS;

typedef struct
{
    I2SWFF3_ClkSrc clkSrc;    
    I2SWFF3_ADFS adfs;        
    uint32_t audioClkFreq;    
    uint_least8_t sd1Pin;     
    uint_least8_t sd1PinMux;  
    uint_least8_t sd0Pin;     
    uint_least8_t sd0PinMux;  
    uint_least8_t sckPin;     
    uint_least8_t sckPinMux;  
    uint_least8_t cclkPin;    
    uint_least8_t cclkPinMux; 
    uint_least8_t wsPin;      
    uint_least8_t wsPinMux;   
    uint8_t intPriority;      
} I2SWFF3_HWAttrs;

typedef struct
{
    uint8_t numberOfChannelsUsed;         
    I2S_ChannelConfig channelsUsed;       
    I2S_DataInterfaceUse interfaceConfig; 
} I2SWFF3_DataInterface;
typedef struct
{
    uint16_t memoryStep;

    uint16_t delay;

    I2S_Callback callback;

    I2S_RegUpdate pointerSet;

    I2S_StopInterface stopInterface;

    I2S_Transaction *activeTransfer;
} I2SWFF3_Interface;
typedef void (*I2SWFF3_PtrUpdate)(I2S_Handle handle, I2SWFF3_Interface *interface);

typedef struct
{
    volatile bool isOpen;

    bool invertWS;

    uint32_t memorySlotLength;

    uint8_t dataShift;

    uint8_t bitsPerWord;

    uint8_t beforeWordPadding;

    uint8_t afterWordPadding;

    uint16_t dmaBuffSizeConfig;

    I2S_SamplingEdge samplingEdge;

    I2S_Role moduleRole;

    I2S_PhaseType phaseType;

    uint16_t CCLKDivider;

    uint16_t SCKDivider;

    uint16_t WSDivider;

    uint16_t startUpDelay;

    I2SWFF3_DataInterface dataInterfaceSD0;

    I2SWFF3_DataInterface dataInterfaceSD1;

    /*
     * I2S SYS/BIOS objects
     */
    HwiP_Struct hwi;

    I2SWFF3_PtrUpdate ptrUpdateFxn;

    I2SWFF3_Interface read;

    I2SWFF3_Interface write;

    I2S_Callback errorCallback;

    /*
     * I2S pre and post notification functions
     */
    void *i2sPreFxn;

    void *i2sPostFxn;

    Power_NotifyObj i2sPreObj;

    Power_NotifyObj i2sPostObj;

    volatile bool i2sPowerConstraint;

} I2SWFF3_Object;
#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_i2s_I2SWFF3__include */