Merge tag 'hwlock-v6.1' of git://git.kernel.org/pub/scm/linux/kernel/git/remoteproc...
[platform/kernel/linux-starfive.git] / Documentation / devicetree / bindings / sound / tlv320aic31xx.txt
1 Texas Instruments - tlv320aic31xx Codec module
2
3 The tlv320aic31xx serial control bus communicates through I2C protocols
4
5 Required properties:
6
7 - compatible - "string" - One of:
8     "ti,tlv320aic310x" - Generic TLV320AIC31xx with mono speaker amp
9     "ti,tlv320aic311x" - Generic TLV320AIC31xx with stereo speaker amp
10     "ti,tlv320aic3100" - TLV320AIC3100 (mono speaker amp, no MiniDSP)
11     "ti,tlv320aic3110" - TLV320AIC3110 (stereo speaker amp, no MiniDSP)
12     "ti,tlv320aic3120" - TLV320AIC3120 (mono speaker amp, MiniDSP)
13     "ti,tlv320aic3111" - TLV320AIC3111 (stereo speaker amp, MiniDSP)
14     "ti,tlv320dac3100" - TLV320DAC3100 (no ADC, mono speaker amp, no MiniDSP)
15     "ti,tlv320dac3101" - TLV320DAC3101 (no ADC, stereo speaker amp, no MiniDSP)
16
17 - reg - <int> -  I2C slave address
18 - HPVDD-supply, SPRVDD-supply, SPLVDD-supply, AVDD-supply, IOVDD-supply,
19   DVDD-supply : power supplies for the device as covered in
20   Documentation/devicetree/bindings/regulator/regulator.txt
21
22
23 Optional properties:
24
25 - reset-gpios - GPIO specification for the active low RESET input.
26 - ai31xx-micbias-vg - MicBias Voltage setting
27         1 or MICBIAS_2_0V - MICBIAS output is powered to 2.0V
28         2 or MICBIAS_2_5V - MICBIAS output is powered to 2.5V
29         3 or MICBIAS_AVDD - MICBIAS output is connected to AVDD
30         If this node is not mentioned or if the value is unknown, then
31         micbias is set to 2.0V.
32 - ai31xx-ocmv - output common-mode voltage setting
33         0 - 1.35V,
34         1 - 1.5V,
35         2 - 1.65V,
36         3 - 1.8V
37
38 Deprecated properties:
39
40 - gpio-reset - gpio pin number used for codec reset
41
42 CODEC output pins:
43   * HPL
44   * HPR
45   * SPL, devices with stereo speaker amp
46   * SPR, devices with stereo speaker amp
47   * SPK, devices with mono speaker amp
48   * MICBIAS
49
50 CODEC input pins:
51   * MIC1LP, devices with ADC
52   * MIC1RP, devices with ADC
53   * MIC1LM, devices with ADC
54   * AIN1, devices without ADC
55   * AIN2, devices without ADC
56
57 The pins can be used in referring sound node's audio-routing property.
58
59 Example:
60 #include <dt-bindings/gpio/gpio.h>
61 #include <dt-bindings/sound/tlv320aic31xx.h>
62
63 tlv320aic31xx: tlv320aic31xx@18 {
64         compatible = "ti,tlv320aic311x";
65         reg = <0x18>;
66
67         ai31xx-micbias-vg = <MICBIAS_OFF>;
68
69         reset-gpios = <&gpio1 17 GPIO_ACTIVE_LOW>;
70
71         HPVDD-supply = <&regulator>;
72         SPRVDD-supply = <&regulator>;
73         SPLVDD-supply = <&regulator>;
74         AVDD-supply = <&regulator>;
75         IOVDD-supply = <&regulator>;
76         DVDD-supply = <&regulator>;
77 };