xref: /freebsd-src/sys/contrib/device-tree/Bindings/sound/dmic-codec.yaml (revision 8bab661a3316d8bd9b9fbd11a3b4371b91507bd2)
1*8bab661aSEmmanuel Vadot# SPDX-License-Identifier: GPL-2.0
2*8bab661aSEmmanuel Vadot%YAML 1.2
3*8bab661aSEmmanuel Vadot---
4*8bab661aSEmmanuel Vadot$id: http://devicetree.org/schemas/sound/dmic-codec.yaml#
5*8bab661aSEmmanuel Vadot$schema: http://devicetree.org/meta-schemas/core.yaml#
6*8bab661aSEmmanuel Vadot
7*8bab661aSEmmanuel Vadottitle: Generic PDM Digital microphone (DMIC) codec
8*8bab661aSEmmanuel Vadot
9*8bab661aSEmmanuel Vadotmaintainers:
10*8bab661aSEmmanuel Vadot  - Arnaud Pouliquen <arnaud.pouliquen@foss.st.com>
11*8bab661aSEmmanuel Vadot
12*8bab661aSEmmanuel VadotallOf:
13*8bab661aSEmmanuel Vadot  - $ref: dai-common.yaml#
14*8bab661aSEmmanuel Vadot
15*8bab661aSEmmanuel Vadotproperties:
16*8bab661aSEmmanuel Vadot  compatible:
17*8bab661aSEmmanuel Vadot    const: dmic-codec
18*8bab661aSEmmanuel Vadot
19*8bab661aSEmmanuel Vadot  '#sound-dai-cells':
20*8bab661aSEmmanuel Vadot    const: 0
21*8bab661aSEmmanuel Vadot
22*8bab661aSEmmanuel Vadot  dmicen-gpios:
23*8bab661aSEmmanuel Vadot    description: GPIO specifier for DMIC to control start and stop
24*8bab661aSEmmanuel Vadot    maxItems: 1
25*8bab661aSEmmanuel Vadot
26*8bab661aSEmmanuel Vadot  num-channels:
27*8bab661aSEmmanuel Vadot    description: Number of microphones on this DAI
28*8bab661aSEmmanuel Vadot    $ref: /schemas/types.yaml#/definitions/uint32
29*8bab661aSEmmanuel Vadot    minimum: 1
30*8bab661aSEmmanuel Vadot    maximum: 8
31*8bab661aSEmmanuel Vadot    default: 8
32*8bab661aSEmmanuel Vadot
33*8bab661aSEmmanuel Vadot  modeswitch-delay-ms:
34*8bab661aSEmmanuel Vadot    description: Delay (in ms) to complete DMIC mode switch
35*8bab661aSEmmanuel Vadot
36*8bab661aSEmmanuel Vadot  wakeup-delay-ms:
37*8bab661aSEmmanuel Vadot    description: Delay (in ms) after enabling the DMIC
38*8bab661aSEmmanuel Vadot
39*8bab661aSEmmanuel Vadotrequired:
40*8bab661aSEmmanuel Vadot  - compatible
41*8bab661aSEmmanuel Vadot
42*8bab661aSEmmanuel VadotunevaluatedProperties: false
43*8bab661aSEmmanuel Vadot
44*8bab661aSEmmanuel Vadotexamples:
45*8bab661aSEmmanuel Vadot  - |
46*8bab661aSEmmanuel Vadot    #include <dt-bindings/gpio/gpio.h>
47*8bab661aSEmmanuel Vadot
48*8bab661aSEmmanuel Vadot    dmic {
49*8bab661aSEmmanuel Vadot        compatible = "dmic-codec";
50*8bab661aSEmmanuel Vadot        dmicen-gpios = <&gpio4 3 GPIO_ACTIVE_HIGH>;
51*8bab661aSEmmanuel Vadot        num-channels = <1>;
52*8bab661aSEmmanuel Vadot        wakeup-delay-ms = <50>;
53*8bab661aSEmmanuel Vadot        modeswitch-delay-ms = <35>;
54*8bab661aSEmmanuel Vadot    };
55*8bab661aSEmmanuel Vadot...
56