TI-RTOS Drivers  tidrivers_full_2_20_01_10
Data Fields
PDMCC26XX_I2S_Object Struct Reference

PDMCC26XX_I2S Object. More...

#include <PDMCC26XX_util.h>

Collaboration diagram for PDMCC26XX_I2S_Object:
Collaboration graph
[legend]

Data Fields

PDMCC26XX_I2S_RequestMode requestMode
 
uint32_t ui32requestTimeout
 
PDMCC26XX_I2S_CallbackFxn callbackFxn
 
int32_t i32SampleRate
 
PDMCC26XX_I2S_AudioClockConfig audioClkCfg
 
PDMCC26XX_I2S_AudioPinConfig audioPinCfg
 
PDMCC26XX_I2S_AudioFormatConfig audioFmtCfg
 
PDMCC26XX_I2S_TransferSize blockSize
 
void * pvContBuffer
 
uint32_t ui32conBufTotalSize
 
void * pvContMgtBuffer
 
uint32_t ui32conMgtBufTotalSize
 
PDMCC26XX_I2S_StreamNotificationcurrentStream
 
ti_sysbios_family_arm_m3_Hwi_Struct hwi
 
Semaphore_Struct blockComplete
 
Semaphore_Struct semStopping
 
PIN_State pinState
 
PIN_Handle pinHandle
 
bool isOpen
 

Detailed Description

PDMCC26XX_I2S Object.

The application must not access any member variables of this structure!

Field Documentation

PDMCC26XX_I2S_RequestMode PDMCC26XX_I2S_Object::requestMode

Blocking or return mode

uint32_t PDMCC26XX_I2S_Object::ui32requestTimeout

Timeout for the request when in blocking mode

PDMCC26XX_I2S_CallbackFxn PDMCC26XX_I2S_Object::callbackFxn

Callback function pointer

int32_t PDMCC26XX_I2S_Object::i32SampleRate

I2S bit clock frequency in Hz. If negative, or not one of I2S_SAMPLE_RATE_16K/_24K/_32K/_48K then use user configured clock division.

PDMCC26XX_I2S_AudioClockConfig PDMCC26XX_I2S_Object::audioClkCfg

I2S clock division override and clock config

PDMCC26XX_I2S_AudioPinConfig PDMCC26XX_I2S_Object::audioPinCfg

I2S pin configuration

PDMCC26XX_I2S_AudioFormatConfig PDMCC26XX_I2S_Object::audioFmtCfg

I2S audio format configuration

PDMCC26XX_I2S_TransferSize PDMCC26XX_I2S_Object::blockSize

I2S DMA transfer size, determines the block size in number of samples. Each sample consumes either 16 or 24 bits, set by PDMCC26XX_I2S_AudioFormatConfig.memLen

void* PDMCC26XX_I2S_Object::pvContBuffer

Pointer to consecutive buffer in memory. Driver will chunk it into the queue

uint32_t PDMCC26XX_I2S_Object::ui32conBufTotalSize

Size of consecutive buffer must match total available sample size: block * number of samples * samplesize(in bytes) * number of channels

void* PDMCC26XX_I2S_Object::pvContMgtBuffer

Pointer to consecutive buffer in memory. Driver will use this to manage buffer

uint32_t PDMCC26XX_I2S_Object::ui32conMgtBufTotalSize

Size of consecutive buffer must match total available sample size: wanted number of blocks in and out (must be same number in and out) * overhead size ()

PDMCC26XX_I2S_StreamNotification* PDMCC26XX_I2S_Object::currentStream

Ptr to information about the current transaction

ti_sysbios_family_arm_m3_Hwi_Struct PDMCC26XX_I2S_Object::hwi

Hwi object handle

Semaphore_Struct PDMCC26XX_I2S_Object::blockComplete

Notify complete PDMCC26XX_I2S block transfer

Semaphore_Struct PDMCC26XX_I2S_Object::semStopping

PDMCC26XX_I2S stopping sequence semaphore

PIN_State PDMCC26XX_I2S_Object::pinState

PIN driver state object

PIN_Handle PDMCC26XX_I2S_Object::pinHandle

PIN driver handle

bool PDMCC26XX_I2S_Object::isOpen

Has the object been opened


The documentation for this struct was generated from the following file:
Copyright 2016, Texas Instruments Incorporated