Linux 6.7-rc7
[linux-modified.git] / Documentation / devicetree / bindings / sound / rt5682.txt
1 RT5682 audio CODEC
2
3 This device supports I2C only.
4
5 Required properties:
6
7 - compatible : "realtek,rt5682" or "realtek,rt5682i"
8
9 - reg : The I2C address of the device.
10
11 - AVDD-supply: phandle to the regulator supplying analog power through the
12   AVDD pin
13
14 - MICVDD-supply: phandle to the regulator supplying power for the microphone
15   bias through the MICVDD pin. Either MICVDD or VBAT should be present.
16
17 - VBAT-supply: phandle to the regulator supplying battery power through the
18   VBAT pin. Either MICVDD or VBAT should be present.
19
20 - DBVDD-supply: phandle to the regulator supplying I/O power through the DBVDD
21   pin.
22
23 - LDO1-IN-supply: phandle to the regulator supplying power to the digital core
24   and charge pump through the LDO1_IN pin.
25
26 Optional properties:
27
28 - interrupts : The CODEC's interrupt output.
29
30 - realtek,dmic1-data-pin
31   0: dmic1 is not used
32   1: using GPIO2 pin as dmic1 data pin
33   2: using GPIO5 pin as dmic1 data pin
34
35 - realtek,dmic1-clk-pin
36   0: using GPIO1 pin as dmic1 clock pin
37   1: using GPIO3 pin as dmic1 clock pin
38
39 - realtek,jd-src
40   0: No JD is used
41   1: using JD1 as JD source
42
43 - realtek,ldo1-en-gpios : The GPIO that controls the CODEC's LDO1_EN pin.
44
45 - realtek,btndet-delay
46   The debounce delay for push button.
47   The delay time is realtek,btndet-delay value multiple of 8.192 ms.
48   If absent, the default is 16.
49
50 - #clock-cells : Should be set to '<1>',  wclk and bclk sources provided.
51 - clock-output-names : Name given for DAI clocks output.
52
53 - clocks : phandle and clock specifier for codec MCLK.
54 - clock-names : Clock name string for 'clocks' attribute, should be "mclk".
55
56 - realtek,dmic-clk-rate-hz : Set the clock rate (hz) for the requirement of
57   the particular DMIC.
58
59 - realtek,dmic-delay-ms : Set the delay time (ms) for the requirement of
60   the particular DMIC.
61
62 - realtek,dmic-clk-driving-high : Set the high driving of the DMIC clock out.
63
64 - #sound-dai-cells: Should be set to '<1>'.
65
66 Pins on the device (for linking into audio routes) for RT5682:
67
68   * DMIC L1
69   * DMIC R1
70   * IN1P
71   * HPOL
72   * HPOR
73
74 Example:
75
76 rt5682 {
77         compatible = "realtek,rt5682i";
78         reg = <0x1a>;
79         interrupt-parent = <&gpio>;
80         interrupts = <TEGRA_GPIO(U, 6) IRQ_TYPE_LEVEL_HIGH>;
81         realtek,ldo1-en-gpios =
82                 <&gpio TEGRA_GPIO(R, 2) GPIO_ACTIVE_HIGH>;
83         realtek,dmic1-data-pin = <1>;
84         realtek,dmic1-clk-pin = <1>;
85         realtek,jd-src = <1>;
86         realtek,btndet-delay = <16>;
87
88         #clock-cells = <1>;
89         clock-output-names = "rt5682-dai-wclk", "rt5682-dai-bclk";
90
91         clocks = <&osc>;
92         clock-names = "mclk";
93
94         AVDD-supply = <&avdd_reg>;
95         MICVDD-supply = <&micvdd_reg>;
96         DBVDD-supply = <&dbvdd_reg>;
97         LDO1-IN-supply = <&ldo1_in_reg>;
98 };