xref: /freebsd/sys/contrib/device-tree/Bindings/sound/rt5659.txt (revision 7ef62cebc2f965b0f640263e179276928885e33d)
1RT5659/RT5658 audio CODEC
2
3This device supports I2C only.
4
5Required properties:
6
7- compatible : One of "realtek,rt5659" or "realtek,rt5658".
8
9- reg : The I2C address of the device.
10
11- interrupts : The CODEC's interrupt output.
12
13Optional properties:
14
15- clocks: The phandle of the master clock to the CODEC
16- clock-names: Should be "mclk"
17
18- realtek,in1-differential
19- realtek,in3-differential
20- realtek,in4-differential
21  Boolean. Indicate MIC1/3/4 input are differential, rather than single-ended.
22
23- realtek,dmic1-data-pin
24  0: dmic1 is not used
25  1: using IN2N pin as dmic1 data pin
26  2: using GPIO5 pin as dmic1 data pin
27  3: using GPIO9 pin as dmic1 data pin
28  4: using GPIO11 pin as dmic1 data pin
29
30- realtek,dmic2-data-pin
31  0: dmic2 is not used
32  1: using IN2P pin as dmic2 data pin
33  2: using GPIO6 pin as dmic2 data pin
34  3: using GPIO10 pin as dmic2 data pin
35  4: using GPIO12 pin as dmic2 data pin
36
37- realtek,jd-src
38  0: No JD is used
39  1: using JD3 as JD source
40  2: JD source for Intel HDA header
41
42- realtek,ldo1-en-gpios : The GPIO that controls the CODEC's LDO1_EN pin.
43- realtek,reset-gpios : The GPIO that controls the CODEC's RESET pin.
44
45- sound-name-prefix: Please refer to name-prefix.yaml
46
47- ports: A Codec may have a single or multiple I2S interfaces. These
48  interfaces on Codec side can be described under 'ports' or 'port'.
49  When the SoC or host device is connected to multiple interfaces of
50  the Codec, the connectivity can be described using 'ports' property.
51  If a single interface is used, then 'port' can be used. The usage
52  depends on the platform or board design.
53  Please refer to Documentation/devicetree/bindings/graph.txt
54
55Pins on the device (for linking into audio routes) for RT5659/RT5658:
56
57  * DMIC L1
58  * DMIC R1
59  * DMIC L2
60  * DMIC R2
61  * IN1P
62  * IN1N
63  * IN2P
64  * IN2N
65  * IN3P
66  * IN3N
67  * IN4P
68  * IN4N
69  * HPOL
70  * HPOR
71  * SPOL
72  * SPOR
73  * LOUTL
74  * LOUTR
75  * MONOOUT
76  * PDML
77  * PDMR
78  * SPDIF
79
80Example:
81
82rt5659 {
83	compatible = "realtek,rt5659";
84	reg = <0x1b>;
85	interrupt-parent = <&gpio>;
86	interrupts = <TEGRA_GPIO(W, 3) IRQ_TYPE_LEVEL_HIGH>;
87	realtek,ldo1-en-gpios =
88		<&gpio TEGRA_GPIO(V, 3) GPIO_ACTIVE_HIGH>;
89};
90