Merge branch 'cpufreq/arm/linux-next' of git://git.kernel.org/pub/scm/linux/kernel...
[linux-2.6-microblaze.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 Optional properties:
12
13 - interrupts : The CODEC's interrupt output.
14
15 - realtek,dmic1-data-pin
16   0: dmic1 is not used
17   1: using GPIO2 pin as dmic1 data pin
18   2: using GPIO5 pin as dmic1 data pin
19
20 - realtek,dmic1-clk-pin
21   0: using GPIO1 pin as dmic1 clock pin
22   1: using GPIO3 pin as dmic1 clock pin
23
24 - realtek,jd-src
25   0: No JD is used
26   1: using JD1 as JD source
27
28 - realtek,ldo1-en-gpios : The GPIO that controls the CODEC's LDO1_EN pin.
29
30 - realtek,btndet-delay
31   The debounce delay for push button.
32   The delay time is realtek,btndet-delay value multiple of 8.192 ms.
33   If absent, the default is 16.
34
35 - #clock-cells : Should be set to '<1>',  wclk and bclk sources provided.
36 - clock-output-names : Name given for DAI clocks output.
37
38 - clocks : phandle and clock specifier for codec MCLK.
39 - clock-names : Clock name string for 'clocks' attribute, should be "mclk".
40
41 - realtek,dmic-clk-rate-hz : Set the clock rate (hz) for the requirement of
42   the particular DMIC.
43
44 - realtek,dmic-delay-ms : Set the delay time (ms) for the requirement of
45   the particular DMIC.
46
47 Pins on the device (for linking into audio routes) for RT5682:
48
49   * DMIC L1
50   * DMIC R1
51   * IN1P
52   * HPOL
53   * HPOR
54
55 Example:
56
57 rt5682 {
58         compatible = "realtek,rt5682i";
59         reg = <0x1a>;
60         interrupt-parent = <&gpio>;
61         interrupts = <TEGRA_GPIO(U, 6) GPIO_ACTIVE_HIGH>;
62         realtek,ldo1-en-gpios =
63                 <&gpio TEGRA_GPIO(R, 2) GPIO_ACTIVE_HIGH>;
64         realtek,dmic1-data-pin = <1>;
65         realtek,dmic1-clk-pin = <1>;
66         realtek,jd-src = <1>;
67         realtek,btndet-delay = <16>;
68
69         #clock-cells = <1>;
70         clock-output-names = "rt5682-dai-wclk", "rt5682-dai-bclk";
71
72         clocks = <&osc>;
73         clock-names = "mclk";
74 };