| Nano100BN Series BSP V3.03.002 The Board Support Package for Nano100BN Series

Macros
I2S Exported Constants
NANO100 Device Driver » I2S Driver

## Macros
#define | I2S_DATABIT_8 (0 << I2S_CTRL_WORDWIDTH_Pos)
#define | I2S_DATABIT_16 (1 << I2S_CTRL_WORDWIDTH_Pos)
#define | I2S_DATABIT_24 (2 << I2S_CTRL_WORDWIDTH_Pos)
#define | I2S_DATABIT_32 (3 << I2S_CTRL_WORDWIDTH_Pos)
#define | I2S_MONO I2S_CTRL_MONO_Msk
#define | I2S_STEREO 0
#define | I2S_FORMAT_MSB I2S_CTRL_FORMAT_Msk
#define | I2S_FORMAT_I2S 0
#define | I2S_I2S 0
#define | I2S_MODE_SLAVE I2S_CTRL_SLAVE_Msk
#define | I2S_MODE_MASTER 0
#define | I2S_FIFO_TX_LEVEL_WORD_0 0
#define | I2S_FIFO_TX_LEVEL_WORD_1 (1 << I2S_CTRL_TXTH_Pos)
#define | I2S_FIFO_TX_LEVEL_WORD_2 (2 << I2S_CTRL_TXTH_Pos)
#define | I2S_FIFO_TX_LEVEL_WORD_3 (3 << I2S_CTRL_TXTH_Pos)
#define | I2S_FIFO_TX_LEVEL_WORD_4 (4 << I2S_CTRL_TXTH_Pos)
#define | I2S_FIFO_TX_LEVEL_WORD_5 (5 << I2S_CTRL_TXTH_Pos)
#define | I2S_FIFO_TX_LEVEL_WORD_6 (6 << I2S_CTRL_TXTH_Pos)
#define | I2S_FIFO_TX_LEVEL_WORD_7 (7 << I2S_CTRL_TXTH_Pos)
#define | I2S_FIFO_RX_LEVEL_WORD_1 0
#define | I2S_FIFO_RX_LEVEL_WORD_2 (1 << I2S_CTRL_RXTH_Pos)
#define | I2S_FIFO_RX_LEVEL_WORD_3 (2 << I2S_CTRL_RXTH_Pos)
#define | I2S_FIFO_RX_LEVEL_WORD_4 (3 << I2S_CTRL_RXTH_Pos)
#define | I2S_FIFO_RX_LEVEL_WORD_5 (4 << I2S_CTRL_RXTH_Pos)
#define | I2S_FIFO_RX_LEVEL_WORD_6 (5 << I2S_CTRL_RXTH_Pos)
#define | I2S_FIFO_RX_LEVEL_WORD_7 (6 << I2S_CTRL_RXTH_Pos)
#define | I2S_FIFO_RX_LEVEL_WORD_8 (7 << I2S_CTRL_RXTH_Pos)
#define | I2S_MONO_RIGHT 0
#define | I2S_MONO_LEFT I2S_CTRL_RXLCH_Msk
#define | I2S_RIGHT 0
#define | I2S_LEFT 1

## Detailed Description

## Macro Definition Documentation

## ◆ I2S_DATABIT_16

#define I2S_DATABIT_16 (1 << I2S_CTRL_WORDWIDTH_Pos)

I2S data width is 16-bit

Definition at line 32 of file i2s.h.

## ◆ I2S_DATABIT_24

#define I2S_DATABIT_24 (2 << I2S_CTRL_WORDWIDTH_Pos)

I2S data width is 24-bit

Definition at line 33 of file i2s.h.

## ◆ I2S_DATABIT_32

#define I2S_DATABIT_32 (3 << I2S_CTRL_WORDWIDTH_Pos)

I2S data width is 32-bit

Definition at line 34 of file i2s.h.

## ◆ I2S_DATABIT_8

#define I2S_DATABIT_8 (0 << I2S_CTRL_WORDWIDTH_Pos)

I2S data width is 8-bit

Definition at line 31 of file i2s.h.

## ◆ I2S_FIFO_RX_LEVEL_WORD_1

#define I2S_FIFO_RX_LEVEL_WORD_1 0

RX threshold is 1 word

Definition at line 61 of file i2s.h.

## ◆ I2S_FIFO_RX_LEVEL_WORD_2

#define I2S_FIFO_RX_LEVEL_WORD_2 (1 << I2S_CTRL_RXTH_Pos)

RX threshold is 2 words

Definition at line 62 of file i2s.h.

## ◆ I2S_FIFO_RX_LEVEL_WORD_3

#define I2S_FIFO_RX_LEVEL_WORD_3 (2 << I2S_CTRL_RXTH_Pos)

RX threshold is 3 words

Definition at line 63 of file i2s.h.

## ◆ I2S_FIFO_RX_LEVEL_WORD_4

#define I2S_FIFO_RX_LEVEL_WORD_4 (3 << I2S_CTRL_RXTH_Pos)

RX threshold is 4 words

Definition at line 64 of file i2s.h.

## ◆ I2S_FIFO_RX_LEVEL_WORD_5

#define I2S_FIFO_RX_LEVEL_WORD_5 (4 << I2S_CTRL_RXTH_Pos)

RX threshold is 5 words

Definition at line 65 of file i2s.h.

## ◆ I2S_FIFO_RX_LEVEL_WORD_6

#define I2S_FIFO_RX_LEVEL_WORD_6 (5 << I2S_CTRL_RXTH_Pos)

RX threshold is 6 words

Definition at line 66 of file i2s.h.

## ◆ I2S_FIFO_RX_LEVEL_WORD_7

#define I2S_FIFO_RX_LEVEL_WORD_7 (6 << I2S_CTRL_RXTH_Pos)

RX threshold is 7 words

Definition at line 67 of file i2s.h.

## ◆ I2S_FIFO_RX_LEVEL_WORD_8

#define I2S_FIFO_RX_LEVEL_WORD_8 (7 << I2S_CTRL_RXTH_Pos)

RX threshold is 8 words

Definition at line 68 of file i2s.h.

## ◆ I2S_FIFO_TX_LEVEL_WORD_0

#define I2S_FIFO_TX_LEVEL_WORD_0 0

TX threshold is 0 word

Definition at line 52 of file i2s.h.

## ◆ I2S_FIFO_TX_LEVEL_WORD_1

#define I2S_FIFO_TX_LEVEL_WORD_1 (1 << I2S_CTRL_TXTH_Pos)

TX threshold is 1 word

Definition at line 53 of file i2s.h.

## ◆ I2S_FIFO_TX_LEVEL_WORD_2

#define I2S_FIFO_TX_LEVEL_WORD_2 (2 << I2S_CTRL_TXTH_Pos)

TX threshold is 2 words

Definition at line 54 of file i2s.h.

## ◆ I2S_FIFO_TX_LEVEL_WORD_3

#define I2S_FIFO_TX_LEVEL_WORD_3 (3 << I2S_CTRL_TXTH_Pos)

TX threshold is 3 words

Definition at line 55 of file i2s.h.

## ◆ I2S_FIFO_TX_LEVEL_WORD_4

#define I2S_FIFO_TX_LEVEL_WORD_4 (4 << I2S_CTRL_TXTH_Pos)

TX threshold is 4 words

Definition at line 56 of file i2s.h.

## ◆ I2S_FIFO_TX_LEVEL_WORD_5

#define I2S_FIFO_TX_LEVEL_WORD_5 (5 << I2S_CTRL_TXTH_Pos)

TX threshold is 5 words

Definition at line 57 of file i2s.h.

## ◆ I2S_FIFO_TX_LEVEL_WORD_6

#define I2S_FIFO_TX_LEVEL_WORD_6 (6 << I2S_CTRL_TXTH_Pos)

TX threshold is 6 words

Definition at line 58 of file i2s.h.

## ◆ I2S_FIFO_TX_LEVEL_WORD_7

#define I2S_FIFO_TX_LEVEL_WORD_7 (7 << I2S_CTRL_TXTH_Pos)

TX threshold is 7 words

Definition at line 59 of file i2s.h.

## ◆ I2S_FORMAT_I2S

#define I2S_FORMAT_I2S 0

I2S data format

Definition at line 42 of file i2s.h.

## ◆ I2S_FORMAT_MSB

#define I2S_FORMAT_MSB I2S_CTRL_FORMAT_Msk

MSB data format

Definition at line 41 of file i2s.h.

## ◆ I2S_I2S

#define I2S_I2S 0

I2S interface is selected

Definition at line 45 of file i2s.h.

## ◆ I2S_LEFT

#define I2S_LEFT 1

Select left channel

Definition at line 76 of file i2s.h.

## ◆ I2S_MODE_MASTER

#define I2S_MODE_MASTER 0

As master mode

Definition at line 49 of file i2s.h.

## ◆ I2S_MODE_SLAVE

#define I2S_MODE_SLAVE I2S_CTRL_SLAVE_Msk

As slave mode

Definition at line 48 of file i2s.h.

## ◆ I2S_MONO

#define I2S_MONO I2S_CTRL_MONO_Msk

Mono channel

Definition at line 37 of file i2s.h.

## ◆ I2S_MONO_LEFT

#define I2S_MONO_LEFT I2S_CTRL_RXLCH_Msk

Record mono left channel

Definition at line 72 of file i2s.h.

## ◆ I2S_MONO_RIGHT

#define I2S_MONO_RIGHT 0

Record mono right channel

Definition at line 71 of file i2s.h.

## ◆ I2S_RIGHT

#define I2S_RIGHT 0

Select right channel

Definition at line 75 of file i2s.h.

## ◆ I2S_STEREO

#define I2S_STEREO 0

Stereo channel

Definition at line 38 of file i2s.h.