This is the documentation for the latest (main) development branch of Zephyr. If you are looking for the documentation of previous releases, use the drop-down menu on the left and select the desired version.

nxp,dmic

Vendor: NXP Semiconductors

Description

NXP DMIC

Properties

Top level properties

These property descriptions apply to “nxp,dmic” nodes themselves. This page also describes child node properties in the following sections.

Properties not inherited from the base binding file.

Name

Type

Details

pinctrl-0

phandles

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

This property is required.

use2fs

boolean

Use 2FS output, and bypass final half band decimator. This will reduce
the required PDM bit clock frequency by a factor of two, and can reduce
power consumption.

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.

Child node properties

Name

Type

Details

reg

array

register space

This property is required.

See Important properties for more information.

dmas

phandle-array

DMA channels specifiers

This property is required.

gainshift

int

Decimator gain shift. Sets the number of bits to shift decimated PCM
data by, as a positive or negative number. Range of [-15,15]. Default
is reset value of register

compensation-2fs

string

2FS compensation filter. See SOC reference manual for filter response
of each value. Default value is reset value of register, and
recommended filter setting.

Default value: zero

Legal values: 'zero', '-0.16', '-0.15', '-0.13'

compensation-4fs

string

4FS compensation filter. See SOC reference manual for filter response
of each value. Default value is reset value of register, and
recommended filter setting.

Default value: zero

Legal values: 'zero', '-0.16', '-0.15', '-0.13'

dc-cutoff

string

DC cutoff filter setting. Default is reset value of register. Note that
each cutoff frequency is based on a sample frequency of 16KHz, so
actual cutoff values will scale up or down based on your sampling
frequency

Default value: flat

Legal values: 'flat', '155hz', '78hz', '39hz'

dc-gain

int

DC gain fine adjustment. Number of bits to downshift the final
conversion result. Max value of 15. Default is reset value of
register

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

array

interrupts for device

See Important properties for more information.

interrupts-extended

compound

extended interrupt specifier for device

interrupt-names

string-array

name of each interrupt

interrupt-parent

phandle

phandle to interrupt controller node

label

string

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

See Important properties for more information.

This property is deprecated.

clocks

phandle-array

Clock gate information

clock-names

string-array

name of each clock

#address-cells

int

number of address cells in reg property

#size-cells

int

number of size cells in reg property

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

zephyr,deferred-init

boolean

Do not initialize device automatically on boot. Device should be manually
initialized using device_init().

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.

zephyr,pm-device-runtime-auto

boolean

Automatically configure the device for runtime power management after the
init function runs.