nrfx 2.10
Data Fields
nrfx_i2s_config_t Struct Reference

I2S driver configuration structure. More...

#include <nrfx_i2s.h>

Data Fields

uint8_t sck_pin
 SCK pin number.
 
uint8_t lrck_pin
 LRCK pin number.
 
uint8_t mck_pin
 MCK pin number. More...
 
uint8_t sdout_pin
 SDOUT pin number. More...
 
uint8_t sdin_pin
 SDIN pin number. More...
 
uint8_t irq_priority
 Interrupt priority.
 
nrf_i2s_mode_t mode
 Mode of operation.
 
nrf_i2s_format_t format
 Frame format.
 
nrf_i2s_align_t alignment
 Alignment of sample within a frame.
 
nrf_i2s_swidth_t sample_width
 Sample width.
 
nrf_i2s_channels_t channels
 Enabled channels.
 
nrf_i2s_mck_t mck_setup
 Master clock setup.
 
nrf_i2s_ratio_t ratio
 MCK/LRCK ratio.
 
bool skip_gpio_cfg
 Skip GPIO configuration of pins. More...
 
bool skip_psel_cfg
 Skip pin selection configuration. More...
 

Detailed Description

I2S driver configuration structure.

Field Documentation

◆ mck_pin

uint8_t nrfx_i2s_config_t::mck_pin

MCK pin number.

Optional. Use NRFX_I2S_PIN_NOT_USED if this signal is not needed.

◆ sdin_pin

uint8_t nrfx_i2s_config_t::sdin_pin

SDIN pin number.

Optional. Use NRFX_I2S_PIN_NOT_USED if this signal is not needed.

◆ sdout_pin

uint8_t nrfx_i2s_config_t::sdout_pin

SDOUT pin number.

Optional. Use NRFX_I2S_PIN_NOT_USED if this signal is not needed.

◆ skip_gpio_cfg

bool nrfx_i2s_config_t::skip_gpio_cfg

Skip GPIO configuration of pins.

When set to true, the driver does not modify any GPIO parameters of the used pins. Those parameters are supposed to be configured externally before the driver is initialized.

◆ skip_psel_cfg

bool nrfx_i2s_config_t::skip_psel_cfg

Skip pin selection configuration.

When set to true, the driver does not modify pin select registers in the peripheral. Those registers are supposed to be set up externally before the driver is initialized.

Note
When both GPIO configuration and pin selection are to be skipped, the structure fields that specify pins can be omitted, as they are ignored anyway.

The documentation for this struct was generated from the following file:

Documentation feedback | Developer Zone | Subscribe | Updated