TI-RTOS Drivers  tidrivers_full_2_20_01_10
Data Fields
PDMCC26XX_I2S_Params Struct Reference

PDMCC26XX I2S Parameters are used when calling PDMCC26XX_I2S_open(). More...

#include <PDMCC26XX_util.h>

Collaboration diagram for PDMCC26XX_I2S_Params:
Collaboration graph
[legend]

Data Fields

PDMCC26XX_I2S_RequestMode requestMode
 
uint32_t ui32requestTimeout
 
PDMCC26XX_I2S_CallbackFxn callbackFxn
 
PDMCC26XX_I2S_TransferSize blockSize
 
void * pvContBuffer
 
uint32_t ui32conBufTotalSize
 
void * pvContMgtBuffer
 
uint32_t ui32conMgtBufTotalSize
 
PDMCC26XX_I2S_StreamNotificationcurrentStream
 

Detailed Description

PDMCC26XX I2S Parameters are used when calling PDMCC26XX_I2S_open().

Field Documentation

PDMCC26XX_I2S_RequestMode PDMCC26XX_I2S_Params::requestMode

Blocking or Callback mode

uint32_t PDMCC26XX_I2S_Params::ui32requestTimeout

Timeout for the request when in blocking mode

PDMCC26XX_I2S_CallbackFxn PDMCC26XX_I2S_Params::callbackFxn

Callback function pointer

PDMCC26XX_I2S_TransferSize PDMCC26XX_I2S_Params::blockSize

I2S DMA transfer size in number of samples. Each sample consumes either 16 or 24 bits per channel, set by PDMCC26XX_I2S_AudioFormatConfig.memLen. Number of channels are set in PDMCC26XX_I2S_AudioPinConfig.ad0NumOfChannels and PDMCC26XX_I2S_AudioPinConfig.ad1NumOfChannels

void* PDMCC26XX_I2S_Params::pvContBuffer

Pointer to consecutive buffer in memory. Driver will chunk it into the queue. Make sure to provide correct buffer size PDMCC26XX_I2S_Params.ui32conBufTotalSize

uint32_t PDMCC26XX_I2S_Params::ui32conBufTotalSize

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

void* PDMCC26XX_I2S_Params::pvContMgtBuffer

Pointer to consecutive buffer in memory. Driver will use this to manage buffer. Make sure to provide correct buffer size PDMCC26XX_I2S_Params.ui32conMgtBufTotalSize

uint32_t PDMCC26XX_I2S_Params::ui32conMgtBufTotalSize

Size of consecutive buffer must match total available sample size: (wanted number of blocks IN and OUT, it must be same number IN and OUT) * overhead size I2S_BLOCK_OVERHEAD_IN_BYTES

PDMCC26XX_I2S_StreamNotification* PDMCC26XX_I2S_Params::currentStream

Pointer to information about the current state of the stream


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