DRV_I2S

DRV_I2S API Status

API
`i2s_init()`
`i2s_ctrl()`
`i2s_enable()`
`i2s_rx_int_enbale()`
`i2s_tx_int_enbale()`
`i2s_fifo_port_get()`

DRV_I2C UNIT Number

Capability	Number
UNIT Number	1

DRV_I2S Pin and GPIO Map

SPI Pin	Number
I2S0 BSCK	13
I2S0 SCLK	14
I2S0 DIN	15
I2S0 DOUT	16

DRV_I2S API Reference

Header File

driver/i2s/drv_i2s.h

Functions

int32_t i2s_init(I2S i, uint32_t mode, uint32_t sample_rate, uint32_t sample_width, uint32_t sample_ratio)

I2S initialization.

参见

I2S_ROLE

参数:

i – I2S index
mode – I2S mode,
sample_rate – sampel rate
sample_width – sample width
sample_ratio – sample ratio

返回:

error code

int32_t i2s_ctrl(I2S i, uint32_t cmd, uint32_t arg)

I2S control.

参见

I2S_CTRL_CMD

参数:

i – I2S index
cmd – control command,
arg – control argument

返回:

error code

void i2s_enable(I2S i, uint32_t enable)

I2S enable.

参数:

i – I2S index
enable – 0:disable, 1:enable

返回:

NULL

void i2s_rx_int_enbale(I2S i, uint32_t enable)

I2S rx interrupt enable.

参数:

i – I2S index
enable – 0:disable, 1:enable

返回:

NULL

void i2s_tx_int_enbale(I2S i, uint32_t enable)

I2S tx interrupt enable.

参数:

i – I2S index
enable – 0:disable, 1:enable

返回:

NULL

uint32_t i2s_fifo_port_get(I2S i, uint32_t n)

I2S FIFO port address get.

参数:

i – I2S index
n – I2S channel index, range form 0 ~ 3

返回:

I2S FIFO port address

Macros

i2s_master_init(i, sample_rate, sample_width, sample_ratio)

i2s_slaver_init(i, sample_rate, sample_width, sample_ratio)

Enumerations

enum I2S

I2S definition.

Values:

enumerator I2S0

enumerator I2S1

enumerator I2S2

enumerator I2S3

enumerator I2S4

enum I2S_ROLE

I2S role definition.

Values:

enumerator I2S_ROLE_MASTER

enumerator I2S_ROLE_SLAVE

enum I2S_MODE

I2S mode definition.

Values:

enumerator I2S_MODE_PHILIP

enumerator I2S_MODE_LEFT_JUSTIFIED

enumerator I2S_MODE_RIGHT_JUSTIFIED

enumerator I2S_MODE_SHORT_FRAME_SYNC

enumerator I2S_MODE_LONG_FRAME_SYNC

enumerator I2S_MODE_NORMAL_2B_D

enumerator I2S_MODE_DELAY_2B_D

enum I2S_ERROR_CODE

I2S error code definition.

Values:

enumerator I2S_ERROR_CODE_OK

enumerator I2S_ERROR_CODE_INVALID_PARAMETER

enum I2S_CTRL_CMD

I2S control command definition.

Values:

enumerator I2S_CTRL_CMD_SET_SMP_RATIO

enumerator I2S_CTRL_CMD_SET_DLEN

enumerator I2S_CTRL_CMD_SET_BIT_WIDTH

enumerator I2S_CTRL_CMD_SET_SLEN

enumerator I2S_CTRL_CMD_SET_LSB_FIRST

enumerator I2S_CTRL_CMD_SET_BIT_CLK_INV

enumerator I2S_CTRL_CMD_SET_LR_CLK_INV

enumerator I2S_CTRL_CMD_SET_MODE

enumerator I2S_CTRL_CMD_SET_RX_THRESHOLD

enumerator I2S_CTRL_CMD_SET_TX_THRESHOLD

enumerator I2S_CTRL_CMD_SET_DOWN_SAMPLE_RATIO

enumerator I2S_CTRL_CMD_SET_BIT_SEQ_MODE

enumerator I2S_CTRL_CMD_SET_TX_FIFO_MODE

enumerator I2S_CTRL_CMD_RX_TRIG

enumerator I2S_CTRL_CMD_LR_COM_STORE

enumerator I2S_CTRL_CMD_PARALLEL_EN