GNU Linux-libre 4.9.318-gnu1
[releases.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   - power supplies for the device, as covered in
18     Documentation/devicetree/bindings/regulator/regulator.txt, depending
19     on compatible:
20     - for wlf,wm1811 and wlf,wm8958:
21       AVDD1-supply, AVDD2-supply, DBVDD1-supply, DBVDD2-supply, DBVDD3-supply,
22       DCVDD-supply, CPVDD-supply, SPKVDD1-supply, SPKVDD2-supply
23     - for wlf,wm8994:
24       AVDD1-supply, AVDD2-supply, DBVDD-supply, DCVDD-supply, CPVDD-supply,
25       SPKVDD1-supply, SPKVDD2-supply
26
27 Optional properties:
28
29   - interrupts : The interrupt line the IRQ signal for the device is
30     connected to.  This is optional, if it is not connected then none
31     of the interrupt related properties should be specified.
32   - interrupt-controller : These devices contain interrupt controllers
33     and may provide interrupt services to other devices if they have an
34     interrupt line connected.
35   - interrupt-parent : The parent interrupt controller.
36   - #interrupt-cells: the number of cells to describe an IRQ, this should be 2.
37     The first cell is the IRQ number.
38     The second cell is the flags, encoded as the trigger masks from
39     Documentation/devicetree/bindings/interrupt-controller/interrupts.txt
40
41   - clocks : A list of up to two phandle and clock specifier pairs
42   - clock-names : A list of clock names sorted in the same order as clocks.
43                   Valid clock names are "MCLK1" and "MCLK2".
44
45   - wlf,gpio-cfg : A list of GPIO configuration register values. If absent,
46     no configuration of these registers is performed. If any value is
47     over 0xffff then the register will be left as default. If present 11
48     values must be supplied.
49
50   - wlf,micbias-cfg : Two MICBIAS register values for WM1811 or
51     WM8958.  If absent the register defaults will be used.
52
53   - wlf,ldo1ena : GPIO specifier for control of LDO1ENA input to device.
54   - wlf,ldo2ena : GPIO specifier for control of LDO2ENA input to device.
55
56   - wlf,lineout1-se : If present LINEOUT1 is in single ended mode.
57   - wlf,lineout2-se : If present LINEOUT2 is in single ended mode.
58
59   - wlf,lineout1-feedback : If present LINEOUT1 has common mode feedback
60     connected.
61   - wlf,lineout2-feedback : If present LINEOUT2 has common mode feedback
62     connected.
63
64   - wlf,ldoena-always-driven : If present LDOENA is always driven.
65
66 Example:
67
68 codec: wm8994@1a {
69         compatible = "wlf,wm8994";
70         reg = <0x1a>;
71
72         gpio-controller;
73         #gpio-cells = <2>;
74
75         lineout1-se;
76
77         AVDD1-supply = <&regulator>;
78         AVDD2-supply = <&regulator>;
79         CPVDD-supply = <&regulator>;
80         DBVDD-supply = <&regulator>;
81         DCVDD-supply = <&regulator>;
82         SPKVDD1-supply = <&regulator>;
83         SPKVDD2-supply = <&regulator>;
84 };