GNU Linux-libre 4.14.266-gnu1
[releases.git] / Documentation / devicetree / bindings / sound / rt5677.txt
1 RT5677 audio CODEC
2
3 This device supports I2C only.
4
5 Required properties:
6
7 - compatible : "realtek,rt5677".
8
9 - reg : The I2C address of the device.
10
11 - interrupts : The CODEC's interrupt output.
12
13 - gpio-controller : Indicates this device is a GPIO controller.
14
15 - #gpio-cells : Should be two. The first cell is the pin number and the
16   second cell is used to specify optional parameters (currently unused).
17
18 Optional properties:
19
20 - realtek,pow-ldo2-gpio : The GPIO that controls the CODEC's POW_LDO2 pin.
21 - realtek,reset-gpio : The GPIO that controls the CODEC's RESET pin. Active low.
22
23 - realtek,in1-differential
24 - realtek,in2-differential
25 - realtek,lout1-differential
26 - realtek,lout2-differential
27 - realtek,lout3-differential
28   Boolean. Indicate MIC1/2 input and LOUT1/2/3 outputs are differential,
29   rather than single-ended.
30
31 - realtek,gpio-config
32   Array of six 8bit elements that configures GPIO.
33     0 - floating (reset value)
34     1 - pull down
35     2 - pull up
36
37 - realtek,jd1-gpio
38   Configures GPIO Mic Jack detection 1.
39   Select 0 ~ 3 as OFF, GPIO1, GPIO2 and GPIO3 respectively.
40
41 - realtek,jd2-gpio
42 - realtek,jd3-gpio
43   Configures GPIO Mic Jack detection 2 and 3.
44   Select 0 ~ 3 as OFF, GPIO4, GPIO5 and GPIO6 respectively.
45
46 Pins on the device (for linking into audio routes):
47
48   * IN1P
49   * IN1N
50   * IN2P
51   * IN2N
52   * MICBIAS1
53   * DMIC1
54   * DMIC2
55   * DMIC3
56   * DMIC4
57   * LOUT1
58   * LOUT2
59   * LOUT3
60
61 Example:
62
63 rt5677 {
64         compatible = "realtek,rt5677";
65         reg = <0x2c>;
66         interrupt-parent = <&gpio>;
67         interrupts = <TEGRA_GPIO(W, 3) GPIO_ACTIVE_HIGH>;
68
69         gpio-controller;
70         #gpio-cells = <2>;
71
72         realtek,pow-ldo2-gpio =
73                 <&gpio TEGRA_GPIO(V, 3) GPIO_ACTIVE_HIGH>;
74         realtek,reset-gpio = <&gpio TEGRA_GPIO(BB, 3) GPIO_ACTIVE_LOW>;
75         realtek,in1-differential = "true";
76         realtek,gpio-config = /bits/ 8  <0 0 0 0 0 2>;   /* pull up GPIO6 */
77         realtek,jd2-gpio = <3>;  /* Enables Jack detection for GPIO6 */
78 };