| nRF5 SDK v12.0.0 |

Choose documentation: | nRF5 SDK | S130 SoftDevice API | S132 SoftDevice API | S212 SoftDevice API | S332 SoftDevice API

All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
Macros
I2S peripheral driver configuration
I2S driver

## Macros
#define | I2S_ENABLED
| Enable I2S driver * Set to 1 to activate. More...
#define | I2S_CONFIG_SCK_PIN
| SCK pin * Minimum value: 0 Maximum value: 31. More...
#define | I2S_CONFIG_LRCK_PIN
| LRCK pin * Minimum value: 1 Maximum value: 31. More...
#define | I2S_CONFIG_MCK_PIN
| MCK pin *. More...
#define | I2S_CONFIG_SDOUT_PIN
| SDOUT pin * Minimum value: 0 Maximum value: 31. More...
#define | I2S_CONFIG_SDIN_PIN
| SDIN pin * Minimum value: 0 Maximum value: 31. More...
#define | I2S_CONFIG_MASTER
| Mode * Following options are avaiable: More...
#define | I2S_CONFIG_FORMAT
| Format * Following options are avaiable: More...
#define | I2S_CONFIG_ALIGN
| Alignment * Following options are avaiable: More...
#define | I2S_CONFIG_SWIDTH
| Sample width (bits) * Following options are avaiable: More...
#define | I2S_CONFIG_CHANNELS
| Channels * Following options are avaiable: More...
#define | I2S_CONFIG_MCK_SETUP
| MCK behavior * Following options are avaiable: More...
#define | I2S_CONFIG_RATIO
| MCK/LRCK ratio * Following options are avaiable: More...
#define | I2S_CONFIG_IRQ_PRIORITY
| Interrupt priority. More...

## Detailed Description

## Macro Definition Documentation

#define I2S_CONFIG_ALIGN

Alignment * Following options are avaiable:

- 0 - Left
- 1 - Right

Note
  This is an NRF_CONFIG macro.

#define I2S_CONFIG_CHANNELS

Channels * Following options are avaiable:

- 0 - Stereo
- 1 - Left
- 2 - Right

Note
  This is an NRF_CONFIG macro.

#define I2S_CONFIG_FORMAT

Format * Following options are avaiable:

- 0 - I2S
- 1 - Aligned

Note
  This is an NRF_CONFIG macro.

#define I2S_CONFIG_IRQ_PRIORITY

Interrupt priority.

Priorities 0,2 (nRF51) and 0,1,4,5 (nRF52) are reserved for SoftDevice

Following options are avaiable:

- 0 - 0 (highest)
- 1 - 1
- 2 - 2
- 3 - 3
- 4 - 4 (except nRF51 family)
- 5 - 5 (except nRF51 family)
- 6 - 6 (except nRF51 family)
- 7 - 7 (except nRF51 family)

Note
  This is an NRF_CONFIG macro.

#define I2S_CONFIG_LRCK_PIN

LRCK pin * Minimum value: 1 Maximum value: 31.

Note
  This is an NRF_CONFIG macro.

#define I2S_CONFIG_MASTER

Mode * Following options are avaiable:

- 0 - Master
- 1 - Slave

Note
  This is an NRF_CONFIG macro.

#define I2S_CONFIG_MCK_PIN

MCK pin *.

Note
  This is an NRF_CONFIG macro.

#define I2S_CONFIG_MCK_SETUP

MCK behavior * Following options are avaiable:

- 0 - Disabled
- 2147483648 - 32MHz/2
- 1342177280 - 32MHz/3
- 1073741824 - 32MHz/4
- 805306368 - 32MHz/5
- 671088640 - 32MHz/6
- 536870912 - 32MHz/8
- 402653184 - 32MHz/10
- 369098752 - 32MHz/11
- 285212672 - 32MHz/15
- 268435456 - 32MHz/16
- 201326592 - 32MHz/21
- 184549376 - 32MHz/23
- 142606336 - 32MHz/30
- 138412032 - 32MHz/31
- 134217728 - 32MHz/32
- 100663296 - 32MHz/42
- 68157440 - 32MHz/63
- 34340864 - 32MHz/125

Note
  This is an NRF_CONFIG macro.

#define I2S_CONFIG_RATIO

MCK/LRCK ratio * Following options are avaiable:

- 0 - 32x
- 1 - 48x
- 2 - 64x
- 3 - 96x
- 4 - 128x
- 5 - 192x
- 6 - 256x
- 7 - 384x
- 8 - 512x

Note
  This is an NRF_CONFIG macro.

#define I2S_CONFIG_SCK_PIN

SCK pin * Minimum value: 0 Maximum value: 31.

Note
  This is an NRF_CONFIG macro.

#define I2S_CONFIG_SDIN_PIN

SDIN pin * Minimum value: 0 Maximum value: 31.

Note
  This is an NRF_CONFIG macro.

#define I2S_CONFIG_SDOUT_PIN

SDOUT pin * Minimum value: 0 Maximum value: 31.

Note
  This is an NRF_CONFIG macro.

#define I2S_CONFIG_SWIDTH

Sample width (bits) * Following options are avaiable:

- 0 - 8
- 1 - 16
- 2 - 24

Note
  This is an NRF_CONFIG macro.

#define I2S_ENABLED

Enable I2S driver * Set to 1 to activate.

Note
  This is an NRF_CONFIG macro.