GNU Linux-libre 6.1.90-gnu
[releases.git] / Documentation / devicetree / bindings / sound / wlf,wm8731.yaml
1 # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2 %YAML 1.2
3 ---
4 $id: http://devicetree.org/schemas/sound/wlf,wm8731.yaml#
5 $schema: http://devicetree.org/meta-schemas/core.yaml#
6
7 title: Wolfson Microelectromics WM8731 audio CODEC
8
9 maintainers:
10   - patches@opensource.cirrus.com
11
12 description: |
13   Wolfson Microelectronics WM8731 audio CODEC
14
15   Pins on the device (for linking into audio routes):
16     * LOUT: Left Channel Line Output
17     * ROUT: Right Channel Line Output
18     * LHPOUT: Left Channel Headphone Output
19     * RHPOUT: Right Channel Headphone Output
20     * LLINEIN: Left Channel Line Input
21     * RLINEIN: Right Channel Line Input
22     * MICIN: Microphone Input
23
24 properties:
25   compatible:
26     enum:
27       - wlf,wm8731
28
29   reg:
30     maxItems: 1
31
32   "#sound-dai-cells":
33     const: 0
34
35   clocks:
36     description: Clock provider for MCLK pin.
37     maxItems: 1
38
39   clock-names:
40     items:
41       - const: mclk
42
43   AVDD-supply:
44     description: Analog power supply regulator on the AVDD pin.
45
46   HPVDD-supply:
47     description: Headphone power supply regulator on the HPVDD pin.
48
49   DBVDD-supply:
50     description: Digital buffer supply regulator for the DBVDD pin.
51
52   DCVDD-supply:
53     description: Digital core supply regulator for the DCVDD pin.
54
55 required:
56   - reg
57   - compatible
58   - AVDD-supply
59   - HPVDD-supply
60   - DBVDD-supply
61   - DCVDD-supply
62
63 allOf:
64   - $ref: /schemas/spi/spi-peripheral-props.yaml#
65
66 unevaluatedProperties: false
67
68 examples:
69   - |
70     spi {
71         #address-cells = <1>;
72         #size-cells = <0>;
73         wm8731_i2c: codec@0 {
74             compatible = "wlf,wm8731";
75             reg = <0>;
76             spi-max-frequency = <12500000>;
77
78             AVDD-supply = <&avdd_reg>;
79             HPVDD-supply = <&hpvdd_reg>;
80             DCVDD-supply = <&dcvdd_reg>;
81             DBVDD-supply = <&dbvdd_reg>;
82         };
83     };
84   - |
85
86     i2c {
87         #address-cells = <1>;
88         #size-cells = <0>;
89         wm8731_spi: codec@1b {
90             compatible = "wlf,wm8731";
91             reg = <0x1b>;
92
93             AVDD-supply = <&avdd_reg>;
94             HPVDD-supply = <&hpvdd_reg>;
95             DCVDD-supply = <&dcvdd_reg>;
96             DBVDD-supply = <&dbvdd_reg>;
97         };
98     };