xref: /linux/Documentation/devicetree/bindings/sound/dmic-codec.yaml (revision 570f7e331f5febb30f1384817463c7e42b65ca7d) 
1# SPDX-License-Identifier: GPL-2.0
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/sound/dmic-codec.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Generic PDM Digital microphone (DMIC) codec
8
9maintainers:
10  - Arnaud Pouliquen <arnaud.pouliquen@foss.st.com>
11
12allOf:
13  - $ref: dai-common.yaml#
14
15properties:
16  compatible:
17    const: dmic-codec
18
19  '#sound-dai-cells':
20    const: 0
21
22  vref-supply:
23    description: Phandle to the digital microphone reference supply
24
25  dmicen-gpios:
26    description: GPIO specifier for DMIC to control start and stop
27    maxItems: 1
28
29  num-channels:
30    description: Number of microphones on this DAI
31    $ref: /schemas/types.yaml#/definitions/uint32
32    minimum: 1
33    maximum: 8
34    default: 8
35
36  modeswitch-delay-ms:
37    description: Delay (in ms) to complete DMIC mode switch
38
39  wakeup-delay-ms:
40    description: Delay (in ms) after enabling the DMIC
41
42  port:
43    $ref: audio-graph-port.yaml#
44    unevaluatedProperties: false
45
46required:
47  - compatible
48
49unevaluatedProperties: false
50
51examples:
52  - |
53    #include <dt-bindings/gpio/gpio.h>
54
55    dmic {
56        compatible = "dmic-codec";
57        dmicen-gpios = <&gpio4 3 GPIO_ACTIVE_HIGH>;
58        num-channels = <1>;
59        wakeup-delay-ms = <50>;
60        modeswitch-delay-ms = <35>;
61    };
62...
63