240 #ifndef ti_drivers_I2S__include 241 #define ti_drivers_I2S__include 269 #define I2S_CMD_RESERVED (32) 283 #define I2S_STATUS_RESERVED (-32) 298 #define I2S_STATUS_SUCCESS (0) 306 #define I2S_STATUS_ERROR (-1) 315 #define I2S_STATUS_UNDEFINEDCMD (-2) 332 #define I2S_ERROR (I2S_STATUS_ERROR) 337 #define I2S_WAIT_FOREVER (~(0U)) 578 extern void I2S_close(I2S_Handle handle);
I2S_DataMode_
I2S mode settings.
Definition: I2S.h:380
I2S_Callback writeCallback
Definition: I2S.h:467
struct I2S_Params_ I2S_Params
Basic I2S Parameters.
I2S_Handle I2S_open(uint_least8_t 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.
int_fast16_t(* I2S_ControlFxn)(I2S_Handle handle, uint_fast16_t cmd, void *arg)
A function pointer to a driver specific implementation of I2S_control().
Definition: I2S.h:486
int_fast16_t I2S_read(I2S_Handle handle, I2S_BufDesc *desc)
Function to queue a buffer of data to the I2S in callback mode for reading.
void(* I2S_CloseFxn)(I2S_Handle handle)
A function pointer to a driver specific implementation of I2S_CloseFxn().
Definition: I2S.h:480
size_t I2S_readReclaim(I2S_Handle handle, I2S_BufDesc **pDesc)
Function to retrieve a full buffer of data read by the I2S.
void * bufPtr
Definition: I2S.h:353
I2S_IssueFxn readIssueFxn
Definition: I2S.h:533
int_fast16_t(* I2S_IssueFxn)(I2S_Handle handle, I2S_BufDesc *desc)
A function pointer to a driver specific implementation of I2S_IssueFxn().
Definition: I2S.h:506
I2S_InitFxn initFxn
Definition: I2S.h:527
void(* I2S_Callback)(I2S_Handle handle, I2S_BufDesc *desc)
The definition of a callback function used by the I2S driver when used in I2S_MODE_CALLBACK.
Definition: I2S.h:372
I2S_OpMode operationMode
Definition: I2S.h:440
Basic I2S Parameters.
Definition: I2S.h:438
int_fast16_t I2S_writeIssue(I2S_Handle handle, I2S_BufDesc *desc)
Function to queue a buffer of data to the I2S in Issue/Reclaim mode for writing.
I2S_Handle(* I2S_OpenFxn)(I2S_Handle handle, I2S_Params *params)
A function pointer to a driver specific implementation of I2S_OpenFxn().
Definition: I2S.h:500
uintptr_t descArg
Definition: I2S.h:359
int_fast16_t I2S_control(I2S_Handle handle, uint_fast16_t cmd, void *arg)
Function performs implementation specific features on a given I2S_Handle.
I2S_ControlFxn controlFxn
Definition: I2S.h:524
uint8_t slotLength
Definition: I2S.h:446
size_t I2S_writeReclaim(I2S_Handle handle, I2S_BufDesc **pDesc)
Function to retrieve a buffer that the I2S has finished writing.
uint8_t numChannels
Definition: I2S.h:452
I2S_OpMode_
I2S mode settings.
Definition: I2S.h:401
I2S_OpenFxn openFxn
Definition: I2S.h:530
enum I2S_PinMode_ I2S_PinMode
I2S serial pin mode.
size_t bufSize
Definition: I2S.h:356
void(* I2S_InitFxn)(I2S_Handle handle)
A function pointer to a driver specific implementation of I2S_init().
Definition: I2S.h:494
I2S_PinMode_
I2S serial pin mode.
Definition: I2S.h:424
I2S_IssueFxn writeIssueFxn
Definition: I2S.h:539
uint8_t bitsPerSample
Definition: I2S.h:449
void I2S_init(void)
Function to initializes the I2S module.
uint32_t writeTimeout
Definition: I2S.h:470
void const * hwAttrs
Definition: I2S.h:565
void * customParams
Definition: I2S.h:473
I2S_ReclaimFxn writeReclaimFxn
Definition: I2S.h:542
List_Elem qElem
Definition: I2S.h:350
uint32_t readTimeout
Definition: I2S.h:461
The definition of a I2S function table that contains the required set of functions to control a speci...
Definition: I2S.h:519
enum I2S_DataMode_ I2S_DataMode
I2S mode settings.
I2S_SerInActiveConfig_
I2S Serializer InActive state settings.
Definition: I2S.h:413
I2S Global configuration.
Definition: I2S.h:556
enum I2S_SerInActiveConfig_ I2S_SerInActiveConfig
I2S Serializer InActive state settings.
void I2S_Params_init(I2S_Params *params)
Function to initialize the I2S_Params struct to its defaults.
I2S_DataMode readMode
Definition: I2S.h:455
struct I2S_BufDesc_ I2S_BufDesc
I2S buffer descriptor for issue/reclaim mode.
uint32_t samplingFrequency
Definition: I2S.h:443
I2S_Callback readCallback
Definition: I2S.h:458
I2S_CloseFxn closeFxn
Definition: I2S.h:521
I2S_FxnTable const * fxnTablePtr
Definition: I2S.h:559
void * object
Definition: I2S.h:562
struct I2S_FxnTable_ I2S_FxnTable
The definition of a I2S function table that contains the required set of functions to control a speci...
I2S_ReclaimFxn readReclaimFxn
Definition: I2S.h:536
int_fast16_t 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 buffer descriptor for issue/reclaim mode.
Definition: I2S.h:347
enum I2S_OpMode_ I2S_OpMode
I2S mode settings.
void I2S_close(I2S_Handle handle)
Function to close a given I2S peripheral specified by the I2S handle.
struct I2S_Config_ * I2S_Handle
A handle that is returned from a I2S_open() call.
Definition: I2S.h:342
struct I2S_Config_ I2S_Config
I2S Global configuration.
I2S_DataMode writeMode
Definition: I2S.h:464
int_fast16_t I2S_write(I2S_Handle handle, I2S_BufDesc *desc)
Function to queue a buffer of data to the I2S in callback mode for writing.
size_t(* I2S_ReclaimFxn)(I2S_Handle handle, I2S_BufDesc **desc)
A function pointer to a driver specific implementation of I2S_ReclaimFxn().
Definition: I2S.h:512
Linked List interface for use in drivers.