Merge commit '949bdcc8a97c' into omap-for-v4.19/dt
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / sound / wm8994.txt
1 WM1811/WM8994/WM8958 audio CODEC
2
3 These devices support both I2C and SPI (configured with pin strapping
4 on the board).
5
6 Required properties:
7
8   - compatible : One of "wlf,wm1811", "wlf,wm8994" or "wlf,wm8958".
9
10   - reg : the I2C address of the device for I2C, the chip select
11           number for SPI.
12
13   - gpio-controller : Indicates this device is a GPIO controller.
14   - #gpio-cells : Must be 2. The first cell is the pin number and the
15     second cell is used to specify optional parameters (currently unused).
16
17   - AVDD2-supply, DBVDD1-supply, DBVDD2-supply, DBVDD3-supply, CPVDD-supply,
18     SPKVDD1-supply, SPKVDD2-supply : power supplies for the device, as covered
19     in Documentation/devicetree/bindings/regulator/regulator.txt
20
21 Optional properties:
22
23   - interrupts : The interrupt line the IRQ signal for the device is
24     connected to.  This is optional, if it is not connected then none
25     of the interrupt related properties should be specified.
26   - interrupt-controller : These devices contain interrupt controllers
27     and may provide interrupt services to other devices if they have an
28     interrupt line connected.
29   - interrupt-parent : The parent interrupt controller.
30   - #interrupt-cells: the number of cells to describe an IRQ, this should be 2.
31     The first cell is the IRQ number.
32     The second cell is the flags, encoded as the trigger masks from
33     Documentation/devicetree/bindings/interrupt-controller/interrupts.txt
34
35   - clocks : A list of up to two phandle and clock specifier pairs
36   - clock-names : A list of clock names sorted in the same order as clocks.
37                   Valid clock names are "MCLK1" and "MCLK2".
38
39   - wlf,gpio-cfg : A list of GPIO configuration register values. If absent,
40     no configuration of these registers is performed. If any value is
41     over 0xffff then the register will be left as default. If present 11
42     values must be supplied.
43
44   - wlf,micbias-cfg : Two MICBIAS register values for WM1811 or
45     WM8958.  If absent the register defaults will be used.
46
47   - wlf,ldo1ena : GPIO specifier for control of LDO1ENA input to device.
48   - wlf,ldo2ena : GPIO specifier for control of LDO2ENA input to device.
49
50   - wlf,lineout1-se : If present LINEOUT1 is in single ended mode.
51   - wlf,lineout2-se : If present LINEOUT2 is in single ended mode.
52
53   - wlf,lineout1-feedback : If present LINEOUT1 has common mode feedback
54     connected.
55   - wlf,lineout2-feedback : If present LINEOUT2 has common mode feedback
56     connected.
57
58   - wlf,ldoena-always-driven : If present LDOENA is always driven.
59
60 Example:
61
62 wm8994: codec@1a {
63         compatible = "wlf,wm8994";
64         reg = <0x1a>;
65
66         gpio-controller;
67         #gpio-cells = <2>;
68
69         lineout1-se;
70
71         AVDD2-supply = <&regulator>;
72         CPVDD-supply = <&regulator>;
73         DBVDD1-supply = <&regulator>;
74         DBVDD2-supply = <&regulator>;
75         DBVDD3-supply = <&regulator>;
76         SPKVDD1-supply = <&regulator>;
77         SPKVDD2-supply = <&regulator>;
78 };