I2SControlTable Struct Reference

A structure that defines an audio control table. Note: Memory for this structure must be initialized by user application. See detailed description! More...

#include <i2s.h>

Data Fields
uint16_t	ui16DMABufSize
	Size of DMA buffer in number of samples. More...
uint16_t	ui16ChBufSize
	Size of Channel buffer. More...
uint8_t	ui8InChan
	Input Channel. More...
uint8_t	ui8OutChan
	Output Channel. More...
uint16_t	ui16MemLen
	Length of the audio words stored in memory. More...
uint32_t	ui32InBase
	Base address of the input buffer. More...
uint32_t	ui32InOffset
	Value of the current input pointer offset. More...
uint32_t	ui32OutBase
	Base address of the output buffer. More...
uint32_t	ui32OutOffset
	Value of the current output pointer offset. More...

Detailed Description

A structure that defines an audio control table. Note: Memory for this structure must be initialized by user application. See detailed description!

Deprecated:

This structure will be removed in a future release.

These fields are used by the I2S and normally it is not necessary for software to directly read or write fields in the table.

Note

The control table must be defined by the user as a global variable and the global pointer must then be assigned the address of the control table inside a user function (but before calling any I2S-function).

 I2SControlTable g_controlTable;    // Define global
 g_pControlTable = &g_controlTable; // Assign pointer (inside a function)

Field Documentation

uint16_t I2SControlTable::ui16ChBufSize

Size of Channel buffer.

Referenced by I2SBufferConfig(), I2SPointerUpdate(), and I2SSampleStampConfigure().

uint16_t I2SControlTable::ui16DMABufSize

Size of DMA buffer in number of samples.

Referenced by I2SBufferConfig(), I2SEnable(), and I2SPointerUpdate().

uint16_t I2SControlTable::ui16MemLen

Length of the audio words stored in memory.

Referenced by I2SAudioFormatConfigure(), and I2SPointerUpdate().

uint32_t I2SControlTable::ui32InBase

Base address of the input buffer.

Referenced by I2SBufferConfig(), I2SEnable(), and I2SPointerUpdate().

uint32_t I2SControlTable::ui32InOffset

Value of the current input pointer offset.

Referenced by I2SEnable(), and I2SPointerUpdate().

uint32_t I2SControlTable::ui32OutBase

Base address of the output buffer.

Referenced by I2SBufferConfig(), I2SEnable(), and I2SPointerUpdate().

uint32_t I2SControlTable::ui32OutOffset

Value of the current output pointer offset.

Referenced by I2SEnable(), and I2SPointerUpdate().

uint8_t I2SControlTable::ui8InChan

Input Channel.

Referenced by I2SChannelConfigure(), and I2SPointerUpdate().

uint8_t I2SControlTable::ui8OutChan

Output Channel.

Referenced by I2SChannelConfigure(), and I2SPointerUpdate().