- Main Page
- Modules
- Data Structures
- Files

Enumerations
I2S Enumerated Data Types
I2S

## Enumerations
enum | I2S_Instance { I2S_INSTANCE0, I2S_INSTANCE1, I2S_INSTANCE2, I2S_INSTANCE3, I2S_INVALID }
| I2S Instance Number. More...
enum | I2S_ChanType { I2S_CHAN_MONO, I2S_CHAN_STEREO, I2S_CHAN_UNDEF }
| I2S Audio channel type. More...
enum | I2S_OpMode { I2S_POLLED, I2S_INTERRUPT, DMA_POLLED, DMA_INTERRUPT, I2S_OPMODE_OTHER }
| I2S Device mode of transmission. More...
enum | I2S_LoopbackType { I2S_LOOPBACK_DISABLE, I2S_LOOPBACK_ENABLE }
| I2S Loop back mode bit. More...
enum | I2S_SerialEna { I2S_SERIAL_DISABLE, I2S_SERIAL_ENABLE }
| Serial transmission mode. More...
enum | I2S_MonoType { I2S_STEREO_ENABLE, I2S_MONO_ENABLE }
| I2S transmission data type(Mono/Stereo) More...
enum | I2S_FsyncPol { I2S_FSPOL_LOW, I2S_FSPOL_HIGH }
| I2S FSYNC Bit Polarity. More...
enum | I2S_ClkPol { I2S_RISING_EDGE, I2S_FALLING_EDGE }
| I2S Clock Polarity. More...
enum | I2S_DataDelay { I2S_DATADELAY_ONEBIT, I2S_DATADELAY_TWOBIT }
| I2S Data transmission delay. More...
enum | I2S_DatapackType { I2S_DATAPACK_DISABLE, I2S_DATAPACK_ENABLE }
| I2S Data packing bit. More...
enum | I2S_SignextType { I2S_SIGNEXT_DISABLE, I2S_SIGNEXT_ENABLE }
| I2S Sign extension bit. More...
enum | I2S_WordLen { I2S_WORDLEN_8, I2S_WORDLEN_10, I2S_WORDLEN_12, I2S_WORDLEN_14, I2S_WORDLEN_16, I2S_WORDLEN_18, I2S_WORDLEN_20, I2S_WORDLEN_24, I2S_WORDLEN_32, I2S_WORDLEN_INVALID }
| I2S data word length. More...
enum | I2S_Mode { I2S_SLAVE, I2S_MASTER }
| I2S Device mode of operation. More...
enum | I2S_DataFormat { I2S_DATAFORMAT_LJUST, I2S_DATAFORMAT_DSP }
| I2S Data format. More...
enum | I2S_Fsdiv { I2S_FSDIV8, I2S_FSDIV16, I2S_FSDIV32, I2S_FSDIV64, I2S_FSDIV128, I2S_FSDIV256, I2S_FSDIV_RESERVE }
| Serializer frame sync divider. More...
enum | I2S_Clkdiv { I2S_CLKDIV2, I2S_CLKDIV4, I2S_CLKDIV8, I2S_CLKDIV16, I2S_CLKDIV32, I2S_CLKDIV64, I2S_CLKDIV128, I2S_CLKDIV256 }
| Serializer clock divider. More...
enum | I2S_FsErr { I2S_FSERROR_DISABLE, I2S_FSERROR_ENABLE }
| FSYNC Error. More...
enum | I2S_OuErr { I2S_OUERROR_DISABLE, I2S_OUERROR_ENABLE }
| Over or under run error. More...

## Enumeration Type Documentation

enum I2S_ChanType

I2S Audio channel type.

This is used at h/w open for the Audio channel type

Enumerator:

  I2S_CHAN_MONO | Audio data to be transfered is mono
  I2S_CHAN_STEREO | Audio data to be transfered is stereo
  I2S_CHAN_UNDEF | Undefined channel

enum I2S_Clkdiv

Serializer clock divider.

This value is used as the divide-down number of the internally generated clock to the serializer.

Enumerator:

  I2S_CLKDIV2 | CLK Divide ratio is 2
  I2S_CLKDIV4 | CLK Divide ratio is 4
  I2S_CLKDIV8 | CLK Divide ratio is 8
  I2S_CLKDIV16 | CLK Divide ratio is 16
  I2S_CLKDIV32 | CLK Divide ratio is 32
  I2S_CLKDIV64 | CLK Divide ratio is 64
  I2S_CLKDIV128 | CLK Divide ratio is 128
  I2S_CLKDIV256 | CLK Divide ratio is 256

enum I2S_ClkPol

I2S Clock Polarity.

This is used to configure I2S Clock polarity

Enumerator:

  I2S_RISING_EDGE | Tx on Rising Edge
  I2S_FALLING_EDGE | Tx Polarity on Falling Edge

enum I2S_DataDelay

I2S Data transmission delay.

This is used to configure I2S data delay

Enumerator:

  I2S_DATADELAY_ONEBIT | One bit delay in data transmission
  I2S_DATADELAY_TWOBIT | Two bits delay in data transmission

enum I2S_DataFormat

I2S Data format.

This is used to configure I2S data format

Enumerator:

  I2S_DATAFORMAT_LJUST | Data format is left justified
  I2S_DATAFORMAT_DSP | Data format is DSP

enum I2S_DatapackType

I2S Data packing bit.

This is used to enable or disable data packing

Enumerator:

  I2S_DATAPACK_DISABLE | No data packing
  I2S_DATAPACK_ENABLE | Data is packed depending on word length

enum I2S_Fsdiv

Serializer frame sync divider.

This value is used as the divide-down number of the internally generated frame sync to the serializer.

Enumerator:

  I2S_FSDIV8 | FS Divide ratio is 8
  I2S_FSDIV16 | FS Divide ratio is 16
  I2S_FSDIV32 | FS Divide ratio is 32
  I2S_FSDIV64 | FS Divide ratio is 64
  I2S_FSDIV128 | FS Divide ratio is 128
  I2S_FSDIV256 | FS Divide ratio is 256
  I2S_FSDIV_RESERVE | FS Divide ratio is Reserved

enum I2S_FsErr

FSYNC Error.

Set FSYNC error bit as enable or disable

Enumerator:

  I2S_FSERROR_DISABLE | Frame-sync error disable
  I2S_FSERROR_ENABLE | Frame-sync error Enable

enum I2S_FsyncPol

I2S FSYNC Bit Polarity.

This is used to configure FSYNC polarity

Enumerator:

  I2S_FSPOL_LOW | Left chan. is transmitted when fs is low
  I2S_FSPOL_HIGH | Left chan. is transmitted when fs is high

enum I2S_Instance

I2S Instance Number.

This is the Instance Ids for each I2S module and unique to each module

Enumerator:

  I2S_INSTANCE0 | I2S device instance number 0
  I2S_INSTANCE1 | I2S device instance number 1
  I2S_INSTANCE2 | I2S device instance number 2
  I2S_INSTANCE3 | I2S device instance number 3
  I2S_INVALID | Invalid I2S device instance number

enum I2S_LoopbackType

I2S Loop back mode bit.

This is used to enable or disable loop back mode

Enumerator:

  I2S_LOOPBACK_DISABLE | Loopback mode is disabled
  I2S_LOOPBACK_ENABLE | Loopback mode is enabled

enum I2S_Mode

I2S Device mode of operation.

This is used at device init and to configure the I2S device

Enumerator:

  I2S_SLAVE | I2S device clk and FSYNC as slave device
  I2S_MASTER | I2S device is clk master and FSYNC master

enum I2S_MonoType

I2S transmission data type(Mono/Stereo)

This is used to configure transmission data type of I2S data.

Enumerator:

  I2S_STEREO_ENABLE | Data to be transmitted is Stereo
  I2S_MONO_ENABLE | Data to be transmitted is Mono

enum I2S_OpMode

I2S Device mode of transmission.

This is used at device open and to configure the I2S device

Enumerator:

  I2S_POLLED | I2S transfer is through I2S polled mode
  I2S_INTERRUPT | I2S transfer is through I2S intr mode
  DMA_POLLED | I2S transfer is through DMA polled mode
  DMA_INTERRUPT | I2S transfer is through DMA intr mode
  I2S_OPMODE_OTHER | Undefined transfer mode

enum I2S_OuErr

Over or under run error.

Set Over or under run bit enable or disable.

Enumerator:

  I2S_OUERROR_DISABLE | Overrun or under-run error disable
  I2S_OUERROR_ENABLE | Overrun or under-run error Enable

enum I2S_SerialEna

Serial transmission mode.

This is used to enable or disable Serial transmission or receive

Enumerator:

  I2S_SERIAL_DISABLE | Serializer transmission/reception diable
  I2S_SERIAL_ENABLE | Serializer transmission/reception enable

enum I2S_SignextType

I2S Sign extension bit.

This is used to set sign extension of data

Enumerator:

  I2S_SIGNEXT_DISABLE | No sign extension for data
  I2S_SIGNEXT_ENABLE | Data is sign extended

enum I2S_WordLen

I2S data word length.

This is used to configure word length.

Enumerator:

  I2S_WORDLEN_8 | Number of bits in each word of data is 8
  I2S_WORDLEN_10 | Number of bits in each word of data is 10
  I2S_WORDLEN_12 | Number of bits in each word of data is 12
  I2S_WORDLEN_14 | Number of bits in each word of data is 14
  I2S_WORDLEN_16 | Number of bits in each word of data is 16
  I2S_WORDLEN_18 | Number of bits in each word of data is 18
  I2S_WORDLEN_20 | Number of bits in each word of data is 20
  I2S_WORDLEN_24 | Number of bits in each word of data is 24
  I2S_WORDLEN_32 | Number of bits in each word of data is 32
  I2S_WORDLEN_INVALID | Invalid word length