GNU Linux-libre 5.10.217-gnu1
[releases.git] / sound / soc / codecs / rt711.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * rt711.h -- RT711 ALSA SoC audio driver header
4  *
5  * Copyright(c) 2019 Realtek Semiconductor Corp.
6  */
7
8 #ifndef __RT711_H__
9 #define __RT711_H__
10
11 extern const struct dev_pm_ops rt711_runtime_pm;
12
13 struct  rt711_priv {
14         struct regmap *regmap;
15         struct regmap *sdw_regmap;
16         struct snd_soc_component *component;
17         struct sdw_slave *slave;
18         enum sdw_slave_status status;
19         struct sdw_bus_params params;
20         bool hw_init;
21         bool first_hw_init;
22         struct snd_soc_jack *hs_jack;
23         struct delayed_work jack_detect_work;
24         struct delayed_work jack_btn_check_work;
25         struct work_struct calibration_work;
26         struct mutex calibrate_mutex; /* for headset calibration */
27         int jack_type, jd_src;
28 };
29
30 struct sdw_stream_data {
31         struct sdw_stream_runtime *sdw_stream;
32 };
33
34 /* NID */
35 #define RT711_AUDIO_FUNCTION_GROUP                      0x01
36 #define RT711_DAC_OUT2                                  0x03
37 #define RT711_ADC_IN1                                   0x09
38 #define RT711_ADC_IN2                                   0x08
39 #define RT711_DMIC1                                     0x12
40 #define RT711_DMIC2                                     0x13
41 #define RT711_MIC2                                      0x19
42 #define RT711_LINE1                                     0x1a
43 #define RT711_LINE2                                     0x1b
44 #define RT711_BEEP                                      0x1d
45 #define RT711_VENDOR_REG                                0x20
46 #define RT711_HP_OUT                                    0x21
47 #define RT711_MIXER_IN1                                 0x22
48 #define RT711_MIXER_IN2                                 0x23
49 #define RT711_INLINE_CMD                                0x55
50 #define RT711_VENDOR_CALI                               0x58
51 #define RT711_VENDOR_IMS_DRE                    0x5b
52
53 /* Index (NID:20h) */
54 #define RT711_DAC_DC_CALI_CTL1                          0x00
55 #define RT711_JD_CTL1                           0x08
56 #define RT711_JD_CTL2                           0x09
57 #define RT711_JD_CTL4                           0x0b
58 #define RT711_CC_DET1                           0x11
59 #define RT711_PARA_VERB_CTL                             0x1a
60 #define RT711_COMBO_JACK_AUTO_CTL1                              0x45
61 #define RT711_COMBO_JACK_AUTO_CTL2                              0x46
62 #define RT711_INLINE_CMD_CTL                            0x48
63 #define RT711_DIGITAL_MISC_CTRL4                        0x4a
64 #define RT711_VREFOUT_CTL                               0x6b
65 #define RT711_FSM_CTL                           0x6f
66 #define RT711_IRQ_FLAG_TABLE1                           0x80
67 #define RT711_IRQ_FLAG_TABLE2                           0x81
68 #define RT711_IRQ_FLAG_TABLE3                           0x82
69 #define RT711_TX_RX_MUX_CTL                             0x91
70
71 /* Index (NID:5bh) */
72 #define RT711_IMS_DIGITAL_CTL1                          0x00
73 #define RT711_HP_IMS_RESULT_L                           0x20
74 #define RT711_HP_IMS_RESULT_R                           0x21
75
76 /* Verb */
77 #define RT711_VERB_SET_CONNECT_SEL                      0x3100
78 #define RT711_VERB_SET_EAPD_BTLENABLE                   0x3c00
79 #define RT711_VERB_GET_CONNECT_SEL                      0xb100
80 #define RT711_VERB_SET_POWER_STATE                      0x3500
81 #define RT711_VERB_SET_CHANNEL_STREAMID                 0x3600
82 #define RT711_VERB_SET_PIN_WIDGET_CONTROL               0x3700
83 #define RT711_VERB_SET_UNSOLICITED_ENABLE               0x3800
84 #define RT711_SET_AMP_GAIN_MUTE_H                       0x7300
85 #define RT711_SET_AMP_GAIN_MUTE_L                       0x8380
86 #define RT711_VERB_GET_POWER_STATE                      0xb500
87 #define RT711_VERB_GET_CHANNEL_STREAMID                 0xb600
88 #define RT711_VERB_GET_PIN_SENSE                        0xb900
89 #define RT711_FUNC_RESET                        0xff01
90
91 #define RT711_READ_HDA_3                                0x2012
92 #define RT711_READ_HDA_2                                0x2013
93 #define RT711_READ_HDA_1                                0x2014
94 #define RT711_READ_HDA_0                                0x2015
95 #define RT711_PRIV_INDEX_W_H                            0x7500
96 #define RT711_PRIV_INDEX_W_L                            0x8580
97 #define RT711_PRIV_DATA_W_H                             0x7400
98 #define RT711_PRIV_DATA_W_L                             0x8480
99 #define RT711_PRIV_INDEX_R_H                            0x9d00
100 #define RT711_PRIV_INDEX_R_L                            0xad80
101 #define RT711_PRIV_DATA_R_H                             0x9c00
102 #define RT711_PRIV_DATA_R_L                             0xac80
103 #define RT711_DAC_FORMAT_H                              0x7203
104 #define RT711_DAC_FORMAT_L                              0x8283
105 #define RT711_ADC1_FORMAT_H                             0x7209
106 #define RT711_ADC1_FORMAT_L                             0x8289
107 #define RT711_ADC2_FORMAT_H                             0x7208
108 #define RT711_ADC2_FORMAT_L                             0x8288
109
110 #define RT711_SET_AUDIO_POWER_STATE\
111         (RT711_VERB_SET_POWER_STATE | RT711_AUDIO_FUNCTION_GROUP)
112 #define RT711_GET_AUDIO_POWER_STATE\
113                 (RT711_VERB_GET_POWER_STATE | RT711_AUDIO_FUNCTION_GROUP)
114 #define RT711_SET_PIN_DMIC1\
115         (RT711_VERB_SET_PIN_WIDGET_CONTROL | RT711_DMIC1)
116 #define RT711_SET_PIN_DMIC2\
117         (RT711_VERB_SET_PIN_WIDGET_CONTROL | RT711_DMIC2)
118 #define RT711_SET_PIN_HP\
119         (RT711_VERB_SET_PIN_WIDGET_CONTROL | RT711_HP_OUT)
120 #define RT711_SET_PIN_MIC2\
121         (RT711_VERB_SET_PIN_WIDGET_CONTROL | RT711_MIC2)
122 #define RT711_SET_PIN_LINE1\
123         (RT711_VERB_SET_PIN_WIDGET_CONTROL | RT711_LINE1)
124 #define RT711_SET_PIN_LINE2\
125         (RT711_VERB_SET_PIN_WIDGET_CONTROL | RT711_LINE2)
126 #define RT711_SET_MIC2_UNSOLICITED_ENABLE\
127         (RT711_VERB_SET_UNSOLICITED_ENABLE | RT711_MIC2)
128 #define RT711_SET_HP_UNSOLICITED_ENABLE\
129         (RT711_VERB_SET_UNSOLICITED_ENABLE | RT711_HP_OUT)
130 #define RT711_SET_INLINE_UNSOLICITED_ENABLE\
131         (RT711_VERB_SET_UNSOLICITED_ENABLE | RT711_INLINE_CMD)
132 #define RT711_SET_STREAMID_DAC2\
133         (RT711_VERB_SET_CHANNEL_STREAMID | RT711_DAC_OUT2)
134 #define RT711_SET_STREAMID_ADC1\
135         (RT711_VERB_SET_CHANNEL_STREAMID | RT711_ADC_IN1)
136 #define RT711_SET_STREAMID_ADC2\
137         (RT711_VERB_SET_CHANNEL_STREAMID | RT711_ADC_IN2)
138 #define RT711_GET_STREAMID_DAC2\
139         (RT711_VERB_GET_CHANNEL_STREAMID | RT711_DAC_OUT2)
140 #define RT711_GET_STREAMID_ADC1\
141         (RT711_VERB_GET_CHANNEL_STREAMID | RT711_ADC_IN1)
142 #define RT711_GET_STREAMID_ADC2\
143         (RT711_VERB_GET_CHANNEL_STREAMID | RT711_ADC_IN2)
144 #define RT711_SET_GAIN_DAC2_L\
145         (RT711_SET_AMP_GAIN_MUTE_L | RT711_DAC_OUT2)
146 #define RT711_SET_GAIN_DAC2_H\
147         (RT711_SET_AMP_GAIN_MUTE_H | RT711_DAC_OUT2)
148 #define RT711_SET_GAIN_ADC1_L\
149         (RT711_SET_AMP_GAIN_MUTE_L | RT711_ADC_IN1)
150 #define RT711_SET_GAIN_ADC1_H\
151         (RT711_SET_AMP_GAIN_MUTE_H | RT711_ADC_IN1)
152 #define RT711_SET_GAIN_ADC2_L\
153         (RT711_SET_AMP_GAIN_MUTE_L | RT711_ADC_IN2)
154 #define RT711_SET_GAIN_ADC2_H\
155         (RT711_SET_AMP_GAIN_MUTE_H | RT711_ADC_IN2)
156 #define RT711_SET_GAIN_AMIC_L\
157         (RT711_SET_AMP_GAIN_MUTE_L | RT711_MIC2)
158 #define RT711_SET_GAIN_AMIC_H\
159         (RT711_SET_AMP_GAIN_MUTE_H | RT711_MIC2)
160 #define RT711_SET_GAIN_DMIC1_L\
161         (RT711_SET_AMP_GAIN_MUTE_L | RT711_DMIC1)
162 #define RT711_SET_GAIN_DMIC1_H\
163         (RT711_SET_AMP_GAIN_MUTE_H | RT711_DMIC1)
164 #define RT711_SET_GAIN_DMIC2_L\
165         (RT711_SET_AMP_GAIN_MUTE_L | RT711_DMIC2)
166 #define RT711_SET_GAIN_DMIC2_H\
167         (RT711_SET_AMP_GAIN_MUTE_H | RT711_DMIC2)
168 #define RT711_SET_GAIN_HP_L\
169         (RT711_SET_AMP_GAIN_MUTE_L | RT711_HP_OUT)
170 #define RT711_SET_GAIN_HP_H\
171         (RT711_SET_AMP_GAIN_MUTE_H | RT711_HP_OUT)
172
173 /* DAC DC offset calibration control-1 (0x00)(NID:20h) */
174 #define RT711_DAC_DC_CALI_TRIGGER (0x1 << 15)
175
176 /* jack detect control 1 (0x08)(NID:20h) */
177 #define RT711_JD2_DIGITAL_JD_MODE_SEL (0x1 << 1)
178 #define RT711_JD2_1_JD_MODE (0x0 << 1)
179 #define RT711_JD2_2_JD_MODE (0x1 << 1)
180
181 /* jack detect control 2 (0x09)(NID:20h) */
182 #define RT711_JD2_2PORT_200K_DECODE_HP (0x1 << 13)
183 #define RT711_JD2_2PORT_100K_DECODE (0x1 << 12)
184 #define RT711_JD2_2PORT_100K_DECODE_HP (0x0 << 12)
185 #define RT711_HP_JD_SEL_JD1 (0x0 << 1)
186 #define RT711_HP_JD_SEL_JD2 (0x1 << 1)
187 #define RT711_JD2_1PORT_TYPE_DECODE (0x3 << 10)
188 #define RT711_JD2_1PORT_JD_LINE2 (0x0 << 10)
189 #define RT711_JD2_1PORT_JD_HP (0x1 << 10)
190 #define RT711_JD2_1PORT_JD_LINE1 (0x2 << 10)
191 #define RT711_JD1_2PORT_TYPE_100K_DECODE (0x1 << 0)
192 #define RT711_JD1_2PORT_JD_RESERVED (0x0 << 0)
193 #define RT711_JD1_2PORT_JD_LINE1 (0x1 << 0)
194
195 /* jack detect control 4 (0x0b)(NID:20h) */
196 #define RT711_JD2_PAD_PULL_UP_MASK (0x1 << 3)
197 #define RT711_JD2_PAD_NOT_PULL_UP (0x0 << 3)
198 #define RT711_JD2_PAD_PULL_UP (0x1 << 3)
199 #define RT711_JD2_MODE_SEL_MASK (0x3 << 0)
200 #define RT711_JD2_MODE0_2PORT (0x0 << 0)
201 #define RT711_JD2_MODE1_3P3V_1PORT (0x1 << 0)
202 #define RT711_JD2_MODE2_1P8V_1PORT (0x2 << 0)
203
204 /* CC DET1 (0x11)(NID:20h) */
205 #define RT711_HP_JD_FINAL_RESULT_CTL_JD12 (0x1 << 10)
206 #define RT711_HP_JD_FINAL_RESULT_CTL_CCDET (0x0 << 10)
207
208 /* Parameter & Verb control (0x1a)(NID:20h) */
209 #define RT711_HIDDEN_REG_SW_RESET (0x1 << 14)
210
211 /* combo jack auto switch control 2 (0x46)(NID:20h) */
212 #define RT711_COMBOJACK_AUTO_DET_STATUS                 (0x1 << 11)
213 #define RT711_COMBOJACK_AUTO_DET_TRS                    (0x1 << 10)
214 #define RT711_COMBOJACK_AUTO_DET_CTIA                   (0x1 << 9)
215 #define RT711_COMBOJACK_AUTO_DET_OMTP                   (0x1 << 8)
216
217 /* FSM control (0x6f)(NID:20h) */
218 #define RT711_CALI_CTL                  (0x0 << 0)
219 #define RT711_COMBOJACK_CTL                     (0x1 << 0)
220 #define RT711_IMS_CTL                   (0x2 << 0)
221 #define RT711_DEPOP_CTL                 (0x3 << 0)
222
223 /* Impedance Sense Digital Control 1 (0x00)(NID:5bh) */
224 #define RT711_TRIGGER_IMS                       (0x1 << 15)
225 #define RT711_IMS_EN                    (0x1 << 6)
226
227 #define RT711_EAPD_HIGH                                 0x2
228 #define RT711_EAPD_LOW                                  0x0
229 #define RT711_MUTE_SFT                                  7
230 /* set input/output mapping to payload[14][15] separately */
231 #define RT711_DIR_IN_SFT                                6
232 #define RT711_DIR_OUT_SFT                               7
233
234 enum {
235         RT711_AIF1,
236         RT711_AIF2,
237         RT711_AIFS,
238 };
239
240 enum rt711_jd_src {
241         RT711_JD_NULL,
242         RT711_JD1,
243         RT711_JD2,
244         RT711_JD2_100K,
245         RT711_JD2_1P8V_1PORT
246 };
247
248 int rt711_io_init(struct device *dev, struct sdw_slave *slave);
249 int rt711_init(struct device *dev, struct regmap *sdw_regmap,
250                struct regmap *regmap, struct sdw_slave *slave);
251
252 int rt711_jack_detect(struct rt711_priv *rt711, bool *hp, bool *mic);
253 int rt711_clock_config(struct device *dev);
254 #endif /* __RT711_H__ */