csl_i2s.h

Go to the documentation of this file.

/*  ============================================================================
 *   Copyright (c) Texas Instruments Inc 2002, 2003, 2004, 2005, 2008
 *
 *   Use of this software is controlled by the terms and conditions found in the
 *   license agreement under which this software has been supplied.
 *  ============================================================================
 */

/* ============================================================================
 * Revision History
 * ================
 * 22-Aug-2008 Created
 * ============================================================================
 */

#ifndef _CSL_I2S_H_
#define _CSL_I2S_H_


#ifdef __cplusplus
extern "C" {
#endif

#include "soc.h"
#include "csl_error.h"
#include "csl_types.h"
#include "csl_general.h"

/*****************************************************************************\
*         I2S global macro declarations
\*****************************************************************************/
#define CSL_I2S_SCRL_ENABLE_DISABLE         (Uint16)0

#define CSL_I2S_SCRL_ENABLE_ENABLE          (Uint16)1

#define CSL_I2S_SCRL_MONO_DISABLE           (Uint16)0

#define CSL_I2S_SCRL_MONO_ENABLE            (Uint16)1

#define CSL_I2S_SCRL_LOOPBACK_DISABLE       (Uint16)0

#define CSL_I2S_SCRL_LOOPBACK_ENABLE        (Uint16)1

#define CSL_I2S_SCRL_FSPOL_DISABLE          (Uint16)0

#define CSL_I2S_SCRL_FSPOL_ENABLE           (Uint16)1

#define CSL_I2S_SCRL_CLOCKPOL_DISABLE       (Uint16)0

#define CSL_I2S_SCRL_CLOCKPOL_ENABLE        (Uint16)1

#define CSL_I2S_SCRL_DATADELAY_DISABLE      (Uint16)0

#define CSL_I2S_SCRL_DATADELAY_ENABLE       (Uint16)1

#define CSL_I2S_SCRL_PACK_DISABLE           (Uint16)0

#define CSL_I2S_SCRL_PACK_ENABLE            (Uint16)1

#define CSL_I2S_SCRL_SIGNEXT_DISABLE        (Uint16)0

#define CSL_I2S_SCRL_SIGNEXT_ENABLE         (Uint16)1

#define CSL_I2S_SCRL_WORDLENGTH_DISABLE     (Uint16)0

#define CSL_I2S_SCRL_WORDLENGTH_ENABLE      (Uint16)1

#define CSL_I2S_SCRL_MODE_DISABLE           (Uint16)0

#define CSL_I2S_SCRL_MODE_ENABLE            (Uint16)1

#define CSL_I2S_SCRL_FORMAT_DISABLE         (Uint16)0

#define CSL_I2S_SCRL_FORMAT_ENABLE          (Uint16)1

#define CSL_I2S_ICMRL_XMIT0_DISABLE         (Uint16)0

#define CSL_I2S_ICMRL_XMIT0_ENABLE          (Uint16)1

#define CSL_I2S_ICMRL_XMIT1_DISABLE         (Uint16)0

#define CSL_I2S_ICMRL_XMIT1_ENABLE          (Uint16)1

#define CSL_I2S_ICMRL_RCV0_DISABLE          (Uint16)0

#define CSL_I2S_ICMRL_RCV0_ENABLE           (Uint16)1

#define CSL_I2S_ICMRL_RCV1_DISABLE          (Uint16)0

#define CSL_I2S_ICMRL_RCV1_ENABLE           (Uint16)1

#define CSL_I2S_ICMRL_FERR_DISABLE          (Uint16)0

#define CSL_I2S_ICMRL_FERR_ENABLE           (Uint16)1

#define CSL_I2S_ICMRL_O_U_DISABLE           (Uint16)0

#define CSL_I2S_ICMRL_O_U_ENABLE            (Uint16)1

#define CSL_I2S_LATENCY_2                   (2)

#define CSL_I2S_LATENCY_3                   (3)

#define CSL_I2S_LATENCY_5                   (5)

#define CSL_I2S_LATENCY_6                   (6)

/**************************************************************************\
* I2S global enum declaration                                             *
\**************************************************************************/
typedef enum
{
     I2S_INSTANCE0,         
     I2S_INSTANCE1,         
     I2S_INSTANCE2,         
     I2S_INSTANCE3,         
     I2S_INVALID            
} I2S_Instance;

typedef enum
{
    I2S_CHAN_MONO,          
    I2S_CHAN_STEREO,        
    I2S_CHAN_UNDEF          
} I2S_ChanType;

typedef enum
{
    I2S_POLLED,             
    I2S_INTERRUPT,          
    DMA_POLLED,             
    DMA_INTERRUPT,          
    I2S_OPMODE_OTHER        
}I2S_OpMode;


typedef enum
{
    I2S_LOOPBACK_DISABLE,   
    I2S_LOOPBACK_ENABLE     
}I2S_LoopbackType;


typedef enum
{
    I2S_SERIAL_DISABLE,     
    I2S_SERIAL_ENABLE       
}I2S_SerialEna;

typedef enum
{
    I2S_STEREO_ENABLE ,      
    I2S_MONO_ENABLE          
} I2S_MonoType;

typedef enum
{
    I2S_FSPOL_LOW,          
    I2S_FSPOL_HIGH          
}I2S_FsyncPol;

typedef enum
{
    I2S_RISING_EDGE,        
    I2S_FALLING_EDGE        
}I2S_ClkPol;

typedef enum
{
    I2S_DATADELAY_ONEBIT,   
    I2S_DATADELAY_TWOBIT    
} I2S_DataDelay;

typedef enum
{
    I2S_DATAPACK_DISABLE,   
    I2S_DATAPACK_ENABLE     
} I2S_DatapackType;

typedef enum
{
    I2S_SIGNEXT_DISABLE,    
    I2S_SIGNEXT_ENABLE      
} I2S_SignextType;

typedef enum
{
    I2S_WORDLEN_8,          
    I2S_WORDLEN_10,         
    I2S_WORDLEN_12,         
    I2S_WORDLEN_14,         
    I2S_WORDLEN_16,         
    I2S_WORDLEN_18,         
    I2S_WORDLEN_20,         
    I2S_WORDLEN_24,         
    I2S_WORDLEN_32,         
    I2S_WORDLEN_INVALID     
} I2S_WordLen;

typedef enum
{
    I2S_SLAVE,              
    I2S_MASTER              
} I2S_Mode;

typedef enum
{
    I2S_DATAFORMAT_LJUST,   
    I2S_DATAFORMAT_DSP      
} I2S_DataFormat;

typedef enum
{
    I2S_FSDIV8,             
    I2S_FSDIV16,            
    I2S_FSDIV32,            
    I2S_FSDIV64,            
    I2S_FSDIV128,           
    I2S_FSDIV256,           
    I2S_FSDIV_RESERVE       
} I2S_Fsdiv;

typedef enum
{
    I2S_CLKDIV2,            
    I2S_CLKDIV4,            
    I2S_CLKDIV8,            
    I2S_CLKDIV16,           
    I2S_CLKDIV32,           
    I2S_CLKDIV64,           
    I2S_CLKDIV128,          
    I2S_CLKDIV256           
} I2S_Clkdiv;


typedef enum
{
    I2S_FSERROR_DISABLE,    
    I2S_FSERROR_ENABLE      
} I2S_FsErr;

typedef enum
{
    I2S_OUERROR_DISABLE,    
    I2S_OUERROR_ENABLE      
} I2S_OuErr;

/**************************************************************************\
*               I2S global data structures                                *
\**************************************************************************/
typedef struct {
    I2S_Instance          i2sNum;       
    I2S_OpMode            opMode;       
    I2S_ChanType          chType;       
    ioport CSL_I2sRegs    *hwRegs;      
    Uint16                configured;   
    I2S_DatapackType      datapack;     
    I2S_Fsdiv             fsDiv;        
    I2S_WordLen           wordLen;      
    I2S_LoopbackType      loopBackMode; 
    Bool                  firstRead;    
}CSL_I2sObj;


typedef struct{
    I2S_MonoType        dataType;       
    I2S_LoopbackType    loopBackMode;   
    I2S_FsyncPol        fsPol;          
    I2S_ClkPol          clkPol;         
    I2S_DataDelay       datadelay;      
    I2S_DatapackType    datapack;       
    I2S_SignextType     signext;        
    I2S_WordLen         wordLen;        
    I2S_Mode            i2sMode;        
    I2S_DataFormat      dataFormat;     
    I2S_Fsdiv           fsDiv;          
    I2S_Clkdiv          clkDiv;         
    I2S_FsErr           FError;         
    I2S_OuErr           OuError;        
}I2S_Config;

typedef CSL_I2sObj *CSL_I2sHandle;

/*****************************************************************************\
 * I2S function declarations                                                  *
\*****************************************************************************/

CSL_I2sHandle I2S_open(I2S_Instance     i2sInstNum,
                       I2S_OpMode       opMode,
                       I2S_ChanType     chType);

CSL_Status I2S_setup(CSL_I2sHandle  i2sHandle,
                    I2S_Config      *i2sHwConfig);

CSL_Status I2S_close(CSL_I2sHandle  i2sHandle);

CSL_Status I2S_read (CSL_I2sHandle  i2sHandle,
                    Uint16 *readBuff, Uint16 buffLen);

CSL_Status I2S_write(CSL_I2sHandle  i2sHandle,
                    Uint16 *writeBuff, Uint16 buffLen);

CSL_Status I2S_reset(CSL_I2sHandle  hI2S);

CSL_Status I2S_transEnable(CSL_I2sHandle    i2sHandle, Uint16 enableBit);
/*****************************************************************************\
 * I2S Global variable                                                   *
\*****************************************************************************/
static CSL_I2sObj I2S_InstanceNum[4];
#ifdef __cplusplus
}
#endif
#endif /* _CSL_I2S_H_ */