treewide: remove redundant IS_ERR() before error code check
[linux/fpc-iii.git] / Documentation / devicetree / bindings / sound / rt5640.txt
blobe40e4893eed8014352cb81ab86c42f21da38e123
1 RT5640/RT5639 audio CODEC
3 This device supports I2C only.
5 Required properties:
7 - compatible : One of "realtek,rt5640" or "realtek,rt5639".
9 - reg : The I2C address of the device.
11 - interrupts : The CODEC's interrupt output.
13 Optional properties:
15 - clocks: The phandle of the master clock to the CODEC
16 - clock-names: Should be "mclk"
18 - realtek,in1-differential
19 - realtek,in2-differential
20 - realtek,in3-differential
21   Boolean. Indicate MIC1/2/3 input are differential, rather than single-ended.
23 - realtek,ldo1-en-gpios : The GPIO that controls the CODEC's LDO1_EN pin.
25 - realtek,dmic1-data-pin
26   0: dmic1 is not used
27   1: using IN1P pin as dmic1 data pin
28   2: using GPIO3 pin as dmic1 data pin
30 - realtek,dmic2-data-pin
31   0: dmic2 is not used
32   1: using IN1N pin as dmic2 data pin
33   2: using GPIO4 pin as dmic2 data pin
35 - realtek,jack-detect-source
36   u32. Valid values:
37   0: jack-detect is not used
38   1: Use GPIO1 for jack-detect
39   2: Use JD1_IN4P for jack-detect
40   3: Use JD2_IN4N for jack-detect
41   4: Use GPIO2 for jack-detect
42   5: Use GPIO3 for jack-detect
43   6: Use GPIO4 for jack-detect
45 - realtek,jack-detect-not-inverted
46   bool. Normal jack-detect switches give an inverted signal, set this bool
47   in the rare case you've a jack-detect switch which is not inverted.
49 - realtek,over-current-threshold-microamp
50   u32, micbias over-current detection threshold in µA, valid values are
51   600, 1500 and 2000µA.
53 - realtek,over-current-scale-factor
54   u32, micbias over-current detection scale-factor, valid values are:
55   0: Scale current by 0.5
56   1: Scale current by 0.75
57   2: Scale current by 1.0
58   3: Scale current by 1.5
60 Pins on the device (for linking into audio routes) for RT5639/RT5640:
62   * DMIC1
63   * DMIC2
64   * MICBIAS1
65   * IN1P
66   * IN1N
67   * IN2P
68   * IN2N
69   * IN3P
70   * IN3N
71   * HPOL
72   * HPOR
73   * LOUTL
74   * LOUTR
75   * SPOLP
76   * SPOLN
77   * SPORP
78   * SPORN
80 Additional pins on the device for RT5640:
82   * MONOP
83   * MONON
85 Example:
87 rt5640 {
88         compatible = "realtek,rt5640";
89         reg = <0x1c>;
90         interrupt-parent = <&gpio>;
91         interrupts = <TEGRA_GPIO(W, 3) GPIO_ACTIVE_HIGH>;
92         realtek,ldo1-en-gpios =
93                 <&gpio TEGRA_GPIO(V, 3) GPIO_ACTIVE_HIGH>;