154 #ifndef ti_drivers_I2S__include
155 #define ti_drivers_I2S__include
164 #include <ti/drivers/utils/List.h>
177 #define I2S_CMD_RESERVED 32
191 #define I2S_STATUS_RESERVED -32
199 #define I2S_STATUS_SUCCESS 0
207 #define I2S_STATUS_ERROR -1
216 #define I2S_STATUS_UNDEFINEDCMD -2
218 #define I2S_ERROR I2S_STATUS_ERROR
223 #define I2S_WAIT_FOREVER ~(0)
465 extern void I2S_close(I2S_Handle handle);
485 extern int I2S_control(I2S_Handle handle,
unsigned int cmd,
void *arg);
int I2S_write(I2S_Handle handle, I2S_BufDesc *desc)
Function to queue a buffer of data to the I2S in callback mode for writing.
The definition of a I2S function table that contains the required set of functions to control a speci...
Definition: I2S.h:406
void * object
Definition: I2S.h:449
void(* I2S_CloseFxn)(I2S_Handle handle)
A function pointer to a driver specific implementation of I2S_CloseFxn().
Definition: I2S.h:366
struct I2S_Config * I2S_Handle
A handle that is returned from a I2S_open() call.
Definition: I2S.h:228
int I2S_writeIssue(I2S_Handle handle, I2S_BufDesc *desc)
Function to queue a buffer of data to the I2S in Issue/Reclaim mode for writing.
size_t I2S_readReclaim(I2S_Handle handle, I2S_BufDesc **pDesc)
Function to retrieve a full buffer of data read by the I2S.
int I2S_read(I2S_Handle handle, I2S_BufDesc *desc)
Function to queue a buffer of data to the I2S in callback mode for reading.
unsigned char slotLength
Definition: I2S.h:332
I2S_DataMode readMode
Definition: I2S.h:341
struct I2S_Config I2S_Config
I2S Global configuration.
struct I2S_Params I2S_Params
Basic I2S Parameters.
I2S_InitFxn initFxn
Definition: I2S.h:414
I2S_DataMode writeMode
Definition: I2S.h:350
I2S_Handle(* I2S_OpenFxn)(I2S_Handle handle, I2S_Params *params)
A function pointer to a driver specific implementation of I2S_OpenFxn().
Definition: I2S.h:386
unsigned char bitsPerSample
Definition: I2S.h:335
unsigned char numChannels
Definition: I2S.h:338
size_t I2S_writeReclaim(I2S_Handle handle, I2S_BufDesc **pDesc)
Function to retrieve a buffer that the I2S has finished writing.
uint32_t samplingFrequency
Definition: I2S.h:329
I2S Global configuration.
Definition: I2S.h:443
I2S_ReclaimFxn readReclaimFxn
Definition: I2S.h:423
size_t bufSize
Definition: I2S.h:242
struct I2S_BufDesc I2S_BufDesc
I2S buffer descriptor for issue/reclaim mode.
I2S_IssueFxn readIssueFxn
Definition: I2S.h:420
I2S buffer descriptor for issue/reclaim mode.
Definition: I2S.h:233
void(* I2S_InitFxn)(I2S_Handle handle)
A function pointer to a driver specific implementation of I2S_init().
Definition: I2S.h:380
I2S_FxnTable const * fxnTablePtr
Definition: I2S.h:446
void I2S_init(void)
Function to initializes the I2S module.
List_Elem qElem
Definition: I2S.h:236
I2S_DataMode
I2S mode settings.
Definition: I2S.h:266
I2S_OpMode
I2S mode settings.
Definition: I2S.h:287
void * customParams
Definition: I2S.h:359
I2S_Handle I2S_open(unsigned int index, I2S_Params *params)
Function to initialize a given I2S peripheral specified by the particular index value. The parameter specifies which mode the I2S will operate.
I2S_CloseFxn closeFxn
Definition: I2S.h:408
struct I2S_FxnTable I2S_FxnTable
The definition of a I2S function table that contains the required set of functions to control a speci...
uint32_t writeTimeout
Definition: I2S.h:356
int I2S_control(I2S_Handle handle, unsigned int cmd, void *arg)
Function performs implementation specific features on a given I2S_Handle.
int I2S_readIssue(I2S_Handle handle, I2S_BufDesc *desc)
Function to queue a buffer of data to the I2S in Issue/Reclaim mode for reading.
I2S_IssueFxn writeIssueFxn
Definition: I2S.h:426
I2S_SerInActiveConfig
I2S Serializer InActive state settings.
Definition: I2S.h:299
int(* I2S_IssueFxn)(I2S_Handle handle, I2S_BufDesc *desc)
A function pointer to a driver specific implementation of I2S_IssueFxn().
Definition: I2S.h:393
void(* I2S_Callback)(I2S_Handle, I2S_BufDesc *desc)
The definition of a callback function used by the I2S driver when used in I2S_MODE_CALLBACK.
Definition: I2S.h:258
void I2S_Params_init(I2S_Params *params)
Function to initialize the I2S_Params struct to its defaults.
I2S_Callback writeCallback
Definition: I2S.h:353
uint32_t readTimeout
Definition: I2S.h:347
I2S_Callback readCallback
Definition: I2S.h:344
I2S_ReclaimFxn writeReclaimFxn
Definition: I2S.h:429
I2S_ControlFxn controlFxn
Definition: I2S.h:411
I2S_PinMode
I2S serial pin mode.
Definition: I2S.h:310
void const * hwAttrs
Definition: I2S.h:452
I2S_OpMode operationMode
Definition: I2S.h:326
I2S_OpenFxn openFxn
Definition: I2S.h:417
void I2S_close(I2S_Handle handle)
Function to close a given I2S peripheral specified by the I2S handle.
int(* I2S_ControlFxn)(I2S_Handle handle, unsigned int cmd, void *arg)
A function pointer to a driver specific implementation of I2S_control().
Definition: I2S.h:372
void * bufPtr
Definition: I2S.h:239
size_t(* I2S_ReclaimFxn)(I2S_Handle handle, I2S_BufDesc **desc)
A function pointer to a driver specific implementation of I2S_ReclaimFxn().
Definition: I2S.h:399
Basic I2S Parameters.
Definition: I2S.h:324
uintptr_t arg
Definition: I2S.h:245