I2SCC26XX.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019, 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_I2SCC26XX__include
#define ti_drivers_i2s_I2SCC26XX__include

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

#ifdef __cplusplus
extern "C" {
#endif

typedef struct I2SCC26XX_HWAttrs_ {
    PIN_Id                           pinSD1;                  
    PIN_Id                           pinSD0;                  
    PIN_Id                           pinSCK;                  
    PIN_Id                           pinMCLK;                 
    PIN_Id                           pinWS;                   
    uint8_t                          intPriority;             
}I2SCC26XX_HWAttrs;

typedef struct I2SCC26XX_DataInterface_ {
    uint8_t                         numberOfChannelsUsed;     
    I2S_ChannelConfig               channelsUsed;             
    I2S_DataInterfaceUse            interfaceConfig;          
}I2SCC26XX_DataInterface;
typedef struct I2SCC26XX_Interface_ {
    uint16_t                        memoryStep;               
    uint16_t                        delay;                    
    I2S_Callback                    callback;                 
    I2S_RegUpdate                   pointerSet;               
    I2S_Transaction                *activeTransfer;           
}I2SCC26XX_Interface;
typedef void (*I2SCC26XX_PtrUpdate)(I2S_Handle handle, I2SCC26XX_Interface *interface);

typedef struct I2SCC26XX_Object_ {

    bool                            isOpen;                  
    bool                            invertWS;                
    uint8_t                         memorySlotLength;        
    uint8_t                         bitsPerWord;             
    uint8_t                         beforeWordPadding;       
    uint8_t                         afterWordPadding;        
    uint8_t                         dmaBuffSizeConfig;       
    I2S_SamplingEdge                samplingEdge;            
    I2S_Role                        moduleRole;              
    I2S_PhaseType                   phaseType;               
    uint16_t                        MCLKDivider;             
    uint16_t                        SCKDivider;              
    uint16_t                        WSDivider;               
    uint16_t                        startUpDelay;            
    I2SCC26XX_DataInterface         dataInterfaceSD0;        
    I2SCC26XX_DataInterface         dataInterfaceSD1;        
    /* PIN driver state object and handle */
    PIN_State                       pinState;                
    PIN_Handle                      hPin;                    
    /* I2S SYS/BIOS objects */
    HwiP_Struct                     hwi;                     
    I2SCC26XX_PtrUpdate             ptrUpdateFxn;            
    I2SCC26XX_Interface             read;                    
    I2SCC26XX_Interface             write;                   
    I2S_Callback                    errorCallback;           
    /* I2S pre and post notification functions */
    void                            *i2sPreFxn;              
    void                            *i2sPostFxn;             
    Power_NotifyObj                 i2sPreObj;               
    Power_NotifyObj                 i2sPostObj;              
    volatile bool                   i2sPowerConstraint;      
} I2SCC26XX_Object;
#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_i2s_I2SCC26XX__include */