Merge tag 'pwm/for-4.19-rc1' of git://git.kernel.org/pub/scm/linux/kernel/git/thierry...
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / sound / qcom,wcd9335.txt
1 QCOM WCD9335 Codec
2
3 Qualcomm WCD9335 Codec is a standalone Hi-Fi audio codec IC, supports
4 Qualcomm Technologies, Inc. (QTI) multimedia solutions, including
5 the MSM8996, MSM8976, and MSM8956 chipsets. It has in-built
6 Soundwire controller, interrupt mux. It supports both I2S/I2C and
7 SLIMbus audio interfaces.
8
9 Required properties with SLIMbus Interface:
10
11 - compatible:
12         Usage: required
13         Value type: <stringlist>
14         Definition: For SLIMbus interface it should be "slimMID,PID",
15                     textual representation of Manufacturer ID, Product Code,
16                     shall be in lower case hexadecimal with leading zeroes
17                     suppressed.  Refer to slimbus/bus.txt for details.
18                     Should be:
19                     "slim217,1a0" for MSM8996 and APQ8096 SoCs with SLIMbus.
20
21 - reg
22         Usage: required
23         Value type: <u32 u32>
24         Definition: Should be ('Device index', 'Instance ID')
25
26 - interrupts
27         Usage: required
28         Value type: <prop-encoded-array>
29         Definition: Interrupts via WCD INTR1 and INTR2 pins
30
31 - interrupt-names:
32         Usage: required
33         Value type: <String array>
34         Definition: Interrupt names of WCD INTR1 and INTR2
35         Should be: "intr1", "intr2"
36
37 - reset-gpio:
38         Usage: required
39         Value type: <String Array>
40         Definition: Reset gpio line
41
42 - qcom,ifd:
43         Usage: required
44         Value type: <phandle>
45         Definition: SLIM interface device
46
47 - clocks:
48         Usage: required
49         Value type: <prop-encoded-array>
50         Definition: See clock-bindings.txt section "consumers". List of
51                 three clock specifiers for mclk, mclk2 and slimbus clock.
52
53 - clock-names:
54         Usage: required
55         Value type: <string>
56         Definition: Must contain "mclk", "mclk2" and "slimbus" strings.
57
58 - vdd-buck-supply:
59         Usage: required
60         Value type: <phandle>
61         Definition: Should contain a reference to the 1.8V buck supply
62
63 - vdd-buck-sido-supply:
64         Usage: required
65         Value type: <phandle>
66         Definition: Should contain a reference to the 1.8V SIDO buck supply
67
68 - vdd-rx-supply:
69         Usage: required
70         Value type: <phandle>
71         Definition: Should contain a reference to the 1.8V rx supply
72
73 - vdd-tx-supply:
74         Usage: required
75         Value type: <phandle>
76         Definition: Should contain a reference to the 1.8V tx supply
77
78 - vdd-vbat-supply:
79         Usage: Optional
80         Value type: <phandle>
81         Definition: Should contain a reference to the vbat supply
82
83 - vdd-micbias-supply:
84         Usage: required
85         Value type: <phandle>
86         Definition: Should contain a reference to the micbias supply
87
88 - vdd-io-supply:
89         Usage: required
90         Value type: <phandle>
91         Definition: Should contain a reference to the 1.8V io supply
92
93 - interrupt-controller:
94         Usage: required
95         Definition: Indicating that this is a interrupt controller
96
97 - #interrupt-cells:
98         Usage: required
99         Value type: <int>
100         Definition: should be 1
101
102 #sound-dai-cells
103         Usage: required
104         Value type: <u32>
105         Definition: Must be 1
106
107 codec@1{
108         compatible = "slim217,1a0";
109         reg  = <1 0>;
110         interrupts = <&msmgpio 54 IRQ_TYPE_LEVEL_HIGH>;
111         interrupt-names = "intr2"
112         reset-gpio = <&msmgpio 64 0>;
113         qcom,ifd  = <&wc9335_ifd>;
114         clock-names = "mclk", "native";
115         clocks = <&rpmcc RPM_SMD_DIV_CLK1>,
116                  <&rpmcc RPM_SMD_BB_CLK1>;
117         vdd-buck-supply = <&pm8994_s4>;
118         vdd-rx-supply = <&pm8994_s4>;
119         vdd-buck-sido-supply = <&pm8994_s4>;
120         vdd-tx-supply = <&pm8994_s4>;
121         vdd-io-supply = <&pm8994_s4>;
122         #sound-dai-cells = <1>;
123 }