GNU Linux-libre 4.19.264-gnu1
[releases.git] / sound / soc / codecs / tlv320aic31xx.h
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * ALSA SoC TLV320AIC31xx CODEC Driver Definitions
4  *
5  * Copyright (C) 2014-2017 Texas Instruments Incorporated - http://www.ti.com/
6  */
7
8 #ifndef _TLV320AIC31XX_H
9 #define _TLV320AIC31XX_H
10
11 #define AIC31XX_RATES   SNDRV_PCM_RATE_8000_192000
12
13 #define AIC31XX_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | \
14                          SNDRV_PCM_FMTBIT_S20_3LE | \
15                          SNDRV_PCM_FMTBIT_S24_3LE | \
16                          SNDRV_PCM_FMTBIT_S24_LE | \
17                          SNDRV_PCM_FMTBIT_S32_LE)
18
19 #define AIC31XX_STEREO_CLASS_D_BIT      BIT(1)
20 #define AIC31XX_MINIDSP_BIT             BIT(2)
21 #define DAC31XX_BIT                     BIT(3)
22
23 enum aic31xx_type {
24         AIC3100 = 0,
25         AIC3110 = AIC31XX_STEREO_CLASS_D_BIT,
26         AIC3120 = AIC31XX_MINIDSP_BIT,
27         AIC3111 = AIC31XX_STEREO_CLASS_D_BIT | AIC31XX_MINIDSP_BIT,
28         DAC3100 = DAC31XX_BIT,
29         DAC3101 = DAC31XX_BIT | AIC31XX_STEREO_CLASS_D_BIT,
30 };
31
32 struct aic31xx_pdata {
33         enum aic31xx_type codec_type;
34         unsigned int gpio_reset;
35         int micbias_vg;
36 };
37
38 #define AIC31XX_REG(page, reg)  ((page * 128) + reg)
39
40 #define AIC31XX_PAGECTL         AIC31XX_REG(0, 0) /* Page Control Register */
41
42 /* Page 0 Registers */
43 #define AIC31XX_RESET           AIC31XX_REG(0, 1) /* Software reset register */
44 #define AIC31XX_OT_FLAG         AIC31XX_REG(0, 3) /* OT FLAG register */
45 #define AIC31XX_CLKMUX          AIC31XX_REG(0, 4) /* Clock clock Gen muxing, Multiplexers*/
46 #define AIC31XX_PLLPR           AIC31XX_REG(0, 5) /* PLL P and R-VAL register */
47 #define AIC31XX_PLLJ            AIC31XX_REG(0, 6) /* PLL J-VAL register */
48 #define AIC31XX_PLLDMSB         AIC31XX_REG(0, 7) /* PLL D-VAL MSB register */
49 #define AIC31XX_PLLDLSB         AIC31XX_REG(0, 8) /* PLL D-VAL LSB register */
50 #define AIC31XX_NDAC            AIC31XX_REG(0, 11) /* DAC NDAC_VAL register*/
51 #define AIC31XX_MDAC            AIC31XX_REG(0, 12) /* DAC MDAC_VAL register */
52 #define AIC31XX_DOSRMSB         AIC31XX_REG(0, 13) /* DAC OSR setting register 1, MSB value */
53 #define AIC31XX_DOSRLSB         AIC31XX_REG(0, 14) /* DAC OSR setting register 2, LSB value */
54 #define AIC31XX_MINI_DSP_INPOL  AIC31XX_REG(0, 16)
55 #define AIC31XX_NADC            AIC31XX_REG(0, 18) /* Clock setting register 8, PLL */
56 #define AIC31XX_MADC            AIC31XX_REG(0, 19) /* Clock setting register 9, PLL */
57 #define AIC31XX_AOSR            AIC31XX_REG(0, 20) /* ADC Oversampling (AOSR) Register */
58 #define AIC31XX_CLKOUTMUX       AIC31XX_REG(0, 25) /* Clock setting register 9, Multiplexers */
59 #define AIC31XX_CLKOUTMVAL      AIC31XX_REG(0, 26) /* Clock setting register 10, CLOCKOUT M divider value */
60 #define AIC31XX_IFACE1          AIC31XX_REG(0, 27) /* Audio Interface Setting Register 1 */
61 #define AIC31XX_DATA_OFFSET     AIC31XX_REG(0, 28) /* Audio Data Slot Offset Programming */
62 #define AIC31XX_IFACE2          AIC31XX_REG(0, 29) /* Audio Interface Setting Register 2 */
63 #define AIC31XX_BCLKN           AIC31XX_REG(0, 30) /* Clock setting register 11, BCLK N Divider */
64 #define AIC31XX_IFACESEC1       AIC31XX_REG(0, 31) /* Audio Interface Setting Register 3, Secondary Audio Interface */
65 #define AIC31XX_IFACESEC2       AIC31XX_REG(0, 32) /* Audio Interface Setting Register 4 */
66 #define AIC31XX_IFACESEC3       AIC31XX_REG(0, 33) /* Audio Interface Setting Register 5 */
67 #define AIC31XX_I2C             AIC31XX_REG(0, 34) /* I2C Bus Condition */
68 #define AIC31XX_ADCFLAG         AIC31XX_REG(0, 36) /* ADC FLAG */
69 #define AIC31XX_DACFLAG1        AIC31XX_REG(0, 37) /* DAC Flag Registers */
70 #define AIC31XX_DACFLAG2        AIC31XX_REG(0, 38)
71 #define AIC31XX_OFFLAG          AIC31XX_REG(0, 39) /* Sticky Interrupt flag (overflow) */
72 #define AIC31XX_INTRDACFLAG     AIC31XX_REG(0, 44) /* Sticy DAC Interrupt flags */
73 #define AIC31XX_INTRADCFLAG     AIC31XX_REG(0, 45) /* Sticy ADC Interrupt flags */
74 #define AIC31XX_INTRDACFLAG2    AIC31XX_REG(0, 46) /* DAC Interrupt flags 2 */
75 #define AIC31XX_INTRADCFLAG2    AIC31XX_REG(0, 47) /* ADC Interrupt flags 2 */
76 #define AIC31XX_INT1CTRL        AIC31XX_REG(0, 48) /* INT1 interrupt control */
77 #define AIC31XX_INT2CTRL        AIC31XX_REG(0, 49) /* INT2 interrupt control */
78 #define AIC31XX_GPIO1           AIC31XX_REG(0, 51) /* GPIO1 control */
79 #define AIC31XX_DACPRB          AIC31XX_REG(0, 60)
80 #define AIC31XX_ADCPRB          AIC31XX_REG(0, 61) /* ADC Instruction Set Register */
81 #define AIC31XX_DACSETUP        AIC31XX_REG(0, 63) /* DAC channel setup register */
82 #define AIC31XX_DACMUTE         AIC31XX_REG(0, 64) /* DAC Mute and volume control register */
83 #define AIC31XX_LDACVOL         AIC31XX_REG(0, 65) /* Left DAC channel digital volume control */
84 #define AIC31XX_RDACVOL         AIC31XX_REG(0, 66) /* Right DAC channel digital volume control */
85 #define AIC31XX_HSDETECT        AIC31XX_REG(0, 67) /* Headset detection */
86 #define AIC31XX_ADCSETUP        AIC31XX_REG(0, 81) /* ADC Digital Mic */
87 #define AIC31XX_ADCFGA          AIC31XX_REG(0, 82) /* ADC Digital Volume Control Fine Adjust */
88 #define AIC31XX_ADCVOL          AIC31XX_REG(0, 83) /* ADC Digital Volume Control Coarse Adjust */
89
90 /* Page 1 Registers */
91 #define AIC31XX_HPDRIVER        AIC31XX_REG(1, 31) /* Headphone drivers */
92 #define AIC31XX_SPKAMP          AIC31XX_REG(1, 32) /* Class-D Speakear Amplifier */
93 #define AIC31XX_HPPOP           AIC31XX_REG(1, 33) /* HP Output Drivers POP Removal Settings */
94 #define AIC31XX_SPPGARAMP       AIC31XX_REG(1, 34) /* Output Driver PGA Ramp-Down Period Control */
95 #define AIC31XX_DACMIXERROUTE   AIC31XX_REG(1, 35) /* DAC_L and DAC_R Output Mixer Routing */
96 #define AIC31XX_LANALOGHPL      AIC31XX_REG(1, 36) /* Left Analog Vol to HPL */
97 #define AIC31XX_RANALOGHPR      AIC31XX_REG(1, 37) /* Right Analog Vol to HPR */
98 #define AIC31XX_LANALOGSPL      AIC31XX_REG(1, 38) /* Left Analog Vol to SPL */
99 #define AIC31XX_RANALOGSPR      AIC31XX_REG(1, 39) /* Right Analog Vol to SPR */
100 #define AIC31XX_HPLGAIN         AIC31XX_REG(1, 40) /* HPL Driver */
101 #define AIC31XX_HPRGAIN         AIC31XX_REG(1, 41) /* HPR Driver */
102 #define AIC31XX_SPLGAIN         AIC31XX_REG(1, 42) /* SPL Driver */
103 #define AIC31XX_SPRGAIN         AIC31XX_REG(1, 43) /* SPR Driver */
104 #define AIC31XX_HPCONTROL       AIC31XX_REG(1, 44) /* HP Driver Control */
105 #define AIC31XX_MICBIAS         AIC31XX_REG(1, 46) /* MIC Bias Control */
106 #define AIC31XX_MICPGA          AIC31XX_REG(1, 47) /* MIC PGA*/
107 #define AIC31XX_MICPGAPI        AIC31XX_REG(1, 48) /* Delta-Sigma Mono ADC Channel Fine-Gain Input Selection for P-Terminal */
108 #define AIC31XX_MICPGAMI        AIC31XX_REG(1, 49) /* ADC Input Selection for M-Terminal */
109 #define AIC31XX_MICPGACM        AIC31XX_REG(1, 50) /* Input CM Settings */
110
111 /* Bits, masks, and shifts */
112
113 /* AIC31XX_CLKMUX */
114 #define AIC31XX_PLL_CLKIN_MASK          GENMASK(3, 2)
115 #define AIC31XX_PLL_CLKIN_SHIFT         (2)
116 #define AIC31XX_PLL_CLKIN_MCLK          0x00
117 #define AIC31XX_PLL_CLKIN_BCKL          0x01
118 #define AIC31XX_PLL_CLKIN_GPIO1         0x02
119 #define AIC31XX_PLL_CLKIN_DIN           0x03
120 #define AIC31XX_CODEC_CLKIN_MASK        GENMASK(1, 0)
121 #define AIC31XX_CODEC_CLKIN_SHIFT       (0)
122 #define AIC31XX_CODEC_CLKIN_MCLK        0x00
123 #define AIC31XX_CODEC_CLKIN_BCLK        0x01
124 #define AIC31XX_CODEC_CLKIN_GPIO1       0x02
125 #define AIC31XX_CODEC_CLKIN_PLL         0x03
126
127 /* AIC31XX_PLLPR */
128 /* AIC31XX_NDAC */
129 /* AIC31XX_MDAC */
130 /* AIC31XX_NADC */
131 /* AIC31XX_MADC */
132 /* AIC31XX_BCLKN */
133 #define AIC31XX_PLL_MASK                GENMASK(6, 0)
134 #define AIC31XX_PM_MASK                 BIT(7)
135
136 /* AIC31XX_IFACE1 */
137 #define AIC31XX_IFACE1_DATATYPE_MASK    GENMASK(7, 6)
138 #define AIC31XX_IFACE1_DATATYPE_SHIFT   (6)
139 #define AIC31XX_I2S_MODE                0x00
140 #define AIC31XX_DSP_MODE                0x01
141 #define AIC31XX_RIGHT_JUSTIFIED_MODE    0x02
142 #define AIC31XX_LEFT_JUSTIFIED_MODE     0x03
143 #define AIC31XX_IFACE1_DATALEN_MASK     GENMASK(5, 4)
144 #define AIC31XX_IFACE1_DATALEN_SHIFT    (4)
145 #define AIC31XX_WORD_LEN_16BITS         0x00
146 #define AIC31XX_WORD_LEN_20BITS         0x01
147 #define AIC31XX_WORD_LEN_24BITS         0x02
148 #define AIC31XX_WORD_LEN_32BITS         0x03
149 #define AIC31XX_IFACE1_MASTER_MASK      GENMASK(3, 2)
150 #define AIC31XX_BCLK_MASTER             BIT(3)
151 #define AIC31XX_WCLK_MASTER             BIT(2)
152
153 /* AIC31XX_DATA_OFFSET */
154 #define AIC31XX_DATA_OFFSET_MASK        GENMASK(7, 0)
155
156 /* AIC31XX_IFACE2 */
157 #define AIC31XX_BCLKINV_MASK            BIT(3)
158 #define AIC31XX_BDIVCLK_MASK            GENMASK(1, 0)
159 #define AIC31XX_DAC2BCLK                0x00
160 #define AIC31XX_DACMOD2BCLK             0x01
161 #define AIC31XX_ADC2BCLK                0x02
162 #define AIC31XX_ADCMOD2BCLK             0x03
163 #define AIC31XX_KEEP_I2SCLK             BIT(2)
164
165 /* AIC31XX_ADCFLAG */
166 #define AIC31XX_ADCPWRSTATUS_MASK       BIT(6)
167
168 /* AIC31XX_DACFLAG1 */
169 #define AIC31XX_LDACPWRSTATUS_MASK      BIT(7)
170 #define AIC31XX_HPLDRVPWRSTATUS_MASK    BIT(5)
171 #define AIC31XX_SPLDRVPWRSTATUS_MASK    BIT(4)
172 #define AIC31XX_RDACPWRSTATUS_MASK      BIT(3)
173 #define AIC31XX_HPRDRVPWRSTATUS_MASK    BIT(1)
174 #define AIC31XX_SPRDRVPWRSTATUS_MASK    BIT(0)
175
176 /* AIC31XX_INTRDACFLAG */
177 #define AIC31XX_HPLSCDETECT             BIT(7)
178 #define AIC31XX_HPRSCDETECT             BIT(6)
179 #define AIC31XX_BUTTONPRESS             BIT(5)
180 #define AIC31XX_HSPLUG                  BIT(4)
181 #define AIC31XX_LDRCTHRES               BIT(3)
182 #define AIC31XX_RDRCTHRES               BIT(2)
183 #define AIC31XX_DACSINT                 BIT(1)
184 #define AIC31XX_DACAINT                 BIT(0)
185
186 /* AIC31XX_INT1CTRL */
187 #define AIC31XX_HSPLUGDET               BIT(7)
188 #define AIC31XX_BUTTONPRESSDET          BIT(6)
189 #define AIC31XX_DRCTHRES                BIT(5)
190 #define AIC31XX_AGCNOISE                BIT(4)
191 #define AIC31XX_SC                      BIT(3)
192 #define AIC31XX_ENGINE                  BIT(2)
193
194 /* AIC31XX_DACSETUP */
195 #define AIC31XX_SOFTSTEP_MASK           GENMASK(1, 0)
196
197 /* AIC31XX_DACMUTE */
198 #define AIC31XX_DACMUTE_MASK            GENMASK(3, 2)
199
200 /* AIC31XX_MICBIAS */
201 #define AIC31XX_MICBIAS_MASK            GENMASK(1, 0)
202 #define AIC31XX_MICBIAS_SHIFT           0
203
204 #endif  /* _TLV320AIC31XX_H */