If you need urgent consulting help click here

nordic,nrf-i2s

Vendor: Nordic Semiconductor

Description

These nodes are “i2s” bus nodes.

Nordic I2S (Inter-IC sound interface)

Properties

Properties not inherited from the base binding file.

Name

Type

Details

sck-pin

int

IMPORTANT: This option will only be used if the new pin control driver
is not enabled. It will be deprecated in the future.

The SCK pin to use.

For pins P0.0 through P0.31, use the pin number. For example,
to use P0.16 for SCK, set:

    sck-pin = <16>;

For pins P1.0 through P1.31, add 32 to the pin number. For
example, to use P1.2 for SCK, set:

    sck-pin = <34>;  /* 32 + 2 */

lrck-pin

int

IMPORTANT: This option will only be used if the new pin control driver
is not enabled. It will be deprecated in the future.

The LRCK pin to use. The pin numbering scheme is the same as
the sck-pin property's.

sdout-pin

int

IMPORTANT: This option will only be used if the new pin control driver
is not enabled. It will be deprecated in the future.

The SDOUT pin to use. The pin numbering scheme is the same as
the sck-pin property's.

sdin-pin

int

IMPORTANT: This option will only be used if the new pin control driver
is not enabled. It will be deprecated in the future.

The SDIN pin to use. The pin numbering scheme is the same as
the sck-pin property's.

mck-pin

int

IMPORTANT: This option will only be used if the new pin control driver
is not enabled. It will be deprecated in the future.

The MCK pin to use. The pin numbering scheme is the same as
the sck-pin property's.

clock-source

string

Clock source to be used by the I2S peripheral for the master clock
(MCK) generator. The generator is only needed when the I2S peripheral
is operating in Master mode. The following options are available:
- "PCLK32M": 32 MHz peripheral clock, synchronous to HFCLK
- "PCLK32M_HFXO": PCLK32M running off the 32 MHz crystal oscillator
  (HFXO) for better clock accuracy and jitter performance
- "ACLK": Audio PLL clock with configurable frequency (frequency for
  this clock must be set via the "hfclkaudio-frequency" property
  in the "nordic,nrf-clock" node); this clock source is only available
  in the nRF53 Series SoCs and it requires the use of HFXO

Default value: PCLK32M_HFXO

Legal values: 'PCLK32M', 'PCLK32M_HFXO', 'ACLK'

pinctrl-0

phandles

Pin configuration/s for the first state. Content is specific to the
selected pin controller driver implementation.

pinctrl-1

phandles

Pin configuration/s for the second state. See pinctrl-0.

pinctrl-2

phandles

Pin configuration/s for the third state. See pinctrl-0.

pinctrl-3

phandles

Pin configuration/s for the fourth state. See pinctrl-0.

pinctrl-4

phandles

Pin configuration/s for the fifth state. See pinctrl-0.

pinctrl-names

string-array

Names for the provided states. The number of names needs to match the
number of states.

Deprecated properties not inherited from the base binding file.

(None)

Properties inherited from the base binding file, which defines common properties that may be set on many nodes. Not all of these may apply to the “nordic,nrf-i2s” compatible.

Name

Type

Details

reg

array

register space

This property is required.

See Important properties for more information.

interrupts

array

interrupts for device

This property is required.

See Important properties for more information.

#address-cells

int

number of address cells in reg property

This property is required.

Constant value: 1

#size-cells

int

number of size cells in reg property

This property is required.

label

string

Human readable string describing the device (used as device_get_binding() argument)

This property is required.

See Important properties for more information.

status

string

indicates the operational status of a device

Legal values: 'ok', 'okay', 'disabled', 'reserved', 'fail', 'fail-sss'

See Important properties for more information.

compatible

string-array

compatible strings

This property is required.

See Important properties for more information.

reg-names

string-array

name of each register space

interrupts-extended

compound

extended interrupt specifier for device

interrupt-names

string-array

name of each interrupt

interrupt-parent

phandle

phandle to interrupt controller node

clocks

phandle-array

Clock gate information

clock-names

string-array

name of each clock

dmas

phandle-array

DMA channels specifiers

dma-names

string-array

Provided names of DMA channel specifiers

io-channels

phandle-array

IO channels specifiers

io-channel-names

string-array

Provided names of IO channel specifiers

mboxes

phandle-array

mailbox / IPM channels specifiers

mbox-names

string-array

Provided names of mailbox / IPM channel specifiers

wakeup-source

boolean

Property to identify that a device can be used as wake up source.

When this property is provided a specific flag is set into the
device that tells the system that the device is capable of
wake up the system.

Wake up capable devices are disabled (interruptions will not wake up
the system) by default but they can be enabled at runtime if necessary.

power-domain

phandle

Power domain the device belongs to.

The device will be notified when the power domain it belongs to is either
suspended or resumed.