1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3 * rt712-sdca.h -- RT712 SDCA ALSA SoC audio driver header
4 *
5 * Copyright(c) 2023 Realtek Semiconductor Corp.
6 */
7
8 #ifndef __RT712_H__
9 #define __RT712_H__
10
11 #include <linux/pm.h>
12 #include <linux/regmap.h>
13 #include <linux/soundwire/sdw.h>
14 #include <linux/soundwire/sdw_type.h>
15 #include <sound/soc.h>
16 #include <linux/workqueue.h>
17
18 struct rt712_sdca_priv {
19 struct regmap *regmap;
20 struct regmap *mbq_regmap;
21 struct snd_soc_component *component;
22 struct snd_soc_component *dmic_component;
23 struct sdw_slave *slave;
24 struct sdw_bus_params params;
25 bool hw_init;
26 bool first_hw_init;
27 struct snd_soc_jack *hs_jack;
28 struct delayed_work jack_detect_work;
29 struct delayed_work jack_btn_check_work;
30 struct mutex calibrate_mutex; /* for headset calibration */
31 struct mutex disable_irq_lock; /* SDCA irq lock protection */
32 bool disable_irq;
33 int jack_type;
34 int jd_src;
35 unsigned int scp_sdca_stat1;
36 unsigned int scp_sdca_stat2;
37 unsigned int hw_id;
38 unsigned int version_id;
39 bool fu0f_dapm_mute;
40 bool fu0f_mixer_l_mute;
41 bool fu0f_mixer_r_mute;
42 bool fu1e_dapm_mute;
43 bool fu1e_mixer_mute[4];
44 };
45
46 struct rt712_dmic_kctrl_priv {
47 unsigned int reg_base;
48 unsigned int count;
49 unsigned int max;
50 unsigned int invert;
51 };
52
53 /* SDCA (Channel) */
54 #define CH_01 0x01
55 #define CH_02 0x02
56 #define CH_03 0x03
57 #define CH_04 0x04
58
59 /* NID */
60 #define RT712_VENDOR_REG 0x20
61 #define RT712_EQ_CTRL 0x53
62 #define RT712_CHARGE_PUMP 0x57
63 #define RT712_VENDOR_CALI 0x58
64 #define RT712_ULTRA_SOUND_DET 0x59
65 #define RT712_VENDOR_IMS_DRE 0x5b
66 #define RT712_VENDOR_ANALOG_CTL 0x5f
67 #define RT712_VENDOR_HDA_CTL 0x61
68
69 /* Index (NID:20h) */
70 #define RT712_JD_PRODUCT_NUM 0x00
71 #define RT712_ANALOG_BIAS_CTL3 0x04
72 #define RT712_JD_CTL1 0x09
73 #define RT712_IO_CTL 0x0c
74 #define RT712_LDO2_3_CTL1 0x0e
75 #define RT712_PARA_VERB_CTL 0x1a
76 #define RT712_CC_DET1 0x24
77 #define RT712_CLASSD_AMP_CTL1 0x37
78 #define RT712_CLASSD_AMP_CTL6 0x3c
79 #define RT712_COMBO_JACK_AUTO_CTL1 0x45
80 #define RT712_COMBO_JACK_AUTO_CTL2 0x46
81 #define RT712_COMBO_JACK_AUTO_CTL3 0x47
82 #define RT712_DIGITAL_MISC_CTRL4 0x4a
83 #define RT712_FSM_CTL 0x67
84 #define RT712_SW_CONFIG1 0x8a
85 #define RT712_SW_CONFIG2 0x8b
86
87 /* Index (NID:57h) */
88 #define RT712_HP_DET_CTL3 0x0c
89
90 /* Index (NID:58h) */
91 #define RT712_DAC_DC_CALI_CTL1 0x00
92 #define RT712_DAC_DC_CALI_CTL2 0x01
93
94 /* Index (NID:59h) */
95 #define RT712_ULTRA_SOUND_DETECTOR6 0x1e
96
97 /* Index (NID:5bh) */
98 #define RT712_IMS_DIGITAL_CTL1 0x00
99 #define RT712_IMS_DIGITAL_CTL5 0x05
100 #define RT712_SEL_VEE2_HP_CTL1 0x23
101 #define RT712_HP_DETECT_RLDET_CTL1 0x29
102 #define RT712_HP_DETECT_RLDET_CTL2 0x2a
103
104 /* Index (NID:5fh) */
105 #define RT712_MISC_POWER_CTL0 0x00
106 #define RT712_MISC_POWER_CTL7 0x08
107
108 /* Index (NID:61h) */
109 #define RT712_HDA_LEGACY_MUX_CTL0 0x00
110 #define RT712_HDA_LEGACY_CONFIG_CTL0 0x06
111 #define RT712_HDA_LEGACY_RESET_CTL 0x08
112 #define RT712_HDA_LEGACY_GPIO_WAKE_EN_CTL 0x0e
113 #define RT712_DMIC_ENT_FLOAT_CTL 0x10
114 #define RT712_DMIC_GAIN_ENT_FLOAT_CTL0 0x11
115 #define RT712_DMIC_GAIN_ENT_FLOAT_CTL2 0x13
116 #define RT712_ADC_ENT_FLOAT_CTL 0x15
117 #define RT712_ADC_VOL_CH_FLOAT_CTL2 0x18
118 #define RT712_DAC03_HP_PDE_FLOAT_CTL 0x22
119 #define RT712_MIC2_LINE2_PDE_FLOAT_CTL 0x23
120 #define RT712_ADC0A_08_PDE_FLOAT_CTL 0x26
121 #define RT712_ADC0B_11_PDE_FLOAT_CTL 0x27
122 #define RT712_DMIC1_2_PDE_FLOAT_CTL 0x2b
123 #define RT712_AMP_PDE_FLOAT_CTL 0x2c
124 #define RT712_I2S_IN_OUT_PDE_FLOAT_CTL 0x2f
125 #define RT712_GE_RELATED_CTL1 0x45
126 #define RT712_GE_RELATED_CTL2 0x46
127 #define RT712_MIXER_CTL0 0x52
128 #define RT712_MIXER_CTL1 0x53
129 #define RT712_EAPD_CTL 0x55
130 #define RT712_UMP_HID_CTL0 0x60
131 #define RT712_UMP_HID_CTL1 0x61
132 #define RT712_UMP_HID_CTL2 0x62
133 #define RT712_UMP_HID_CTL3 0x63
134 #define RT712_UMP_HID_CTL4 0x64
135 #define RT712_UMP_HID_CTL5 0x65
136 #define RT712_UMP_HID_CTL6 0x66
137 #define RT712_UMP_HID_CTL7 0x67
138 #define RT712_UMP_HID_CTL8 0x68
139 #define RT712_MISC_CTL_FOR_UAJ 0x72
140 #define RT712_ADC0A_CS_ADC0B_FU_FLOAT_CTL 0xa2
141 #define RT712_DMIC2_FU_IT_FLOAT_CTL 0xa6
142 #define RT712_ADC0B_FU_CH12_FLOAT_CTL 0xb0
143 #define RT712_DMIC2_FU_CH12_FLOAT_CTL 0xb1
144
145 /* Parameter & Verb control 01 (0x1a)(NID:20h) */
146 #define RT712_HIDDEN_REG_SW_RESET (0x1 << 14)
147
148 /* combo jack auto switch control 2 (0x46)(NID:20h) */
149 #define RT712_COMBOJACK_AUTO_DET_STATUS (0x1 << 11)
150 #define RT712_COMBOJACK_AUTO_DET_TRS (0x1 << 10)
151 #define RT712_COMBOJACK_AUTO_DET_CTIA (0x1 << 9)
152 #define RT712_COMBOJACK_AUTO_DET_OMTP (0x1 << 8)
153
154 /* DAC DC offset calibration control-1 (0x00)(NID:58h) */
155 #define RT712_DAC_DC_CALI_TRIGGER (0x1 << 15)
156
157 #define RT712_EAPD_HIGH 0x2
158 #define RT712_EAPD_LOW 0x0
159
160 /* RC Calibration register */
161 #define RT712_RC_CAL 0x3201
162
163 /* Buffer address for HID */
164 #define RT712_BUF_ADDR_HID1 0x44030000
165 #define RT712_BUF_ADDR_HID2 0x44030020
166
167 /* RT712 SDCA Control - function number */
168 #define FUNC_NUM_JACK_CODEC 0x01
169 #define FUNC_NUM_MIC_ARRAY 0x02
170 #define FUNC_NUM_HID 0x03
171 #define FUNC_NUM_AMP 0x04
172
173 /* RT712 SDCA entity */
174 #define RT712_SDCA_ENT0 0x00
175 #define RT712_SDCA_ENT_HID01 0x01
176 #define RT712_SDCA_ENT_GE49 0x49
177 #define RT712_SDCA_ENT_USER_FU05 0x05
178 #define RT712_SDCA_ENT_USER_FU06 0x06
179 #define RT712_SDCA_ENT_USER_FU0F 0x0f
180 #define RT712_SDCA_ENT_USER_FU10 0x19
181 #define RT712_SDCA_ENT_USER_FU1E 0x1e
182 #define RT712_SDCA_ENT_FU15 0x15
183 #define RT712_SDCA_ENT_PDE23 0x23
184 #define RT712_SDCA_ENT_PDE40 0x40
185 #define RT712_SDCA_ENT_PDE11 0x11
186 #define RT712_SDCA_ENT_PDE12 0x12
187 #define RT712_SDCA_ENT_CS01 0x01
188 #define RT712_SDCA_ENT_CS11 0x11
189 #define RT712_SDCA_ENT_CS1F 0x1f
190 #define RT712_SDCA_ENT_CS1C 0x1c
191 #define RT712_SDCA_ENT_CS31 0x31
192 #define RT712_SDCA_ENT_OT23 0x42
193 #define RT712_SDCA_ENT_IT11 0x26
194 #define RT712_SDCA_ENT_IT26 0x26
195 #define RT712_SDCA_ENT_IT09 0x09
196 #define RT712_SDCA_ENT_PLATFORM_FU15 0x15
197 #define RT712_SDCA_ENT_PLATFORM_FU44 0x44
198
199 /* RT712 SDCA control */
200 #define RT712_SDCA_CTL_SAMPLE_FREQ_INDEX 0x10
201 #define RT712_SDCA_CTL_FU_MUTE 0x01
202 #define RT712_SDCA_CTL_FU_VOLUME 0x02
203 #define RT712_SDCA_CTL_HIDTX_CURRENT_OWNER 0x10
204 #define RT712_SDCA_CTL_HIDTX_SET_OWNER_TO_DEVICE 0x11
205 #define RT712_SDCA_CTL_HIDTX_MESSAGE_OFFSET 0x12
206 #define RT712_SDCA_CTL_HIDTX_MESSAGE_LENGTH 0x13
207 #define RT712_SDCA_CTL_SELECTED_MODE 0x01
208 #define RT712_SDCA_CTL_DETECTED_MODE 0x02
209 #define RT712_SDCA_CTL_REQ_POWER_STATE 0x01
210 #define RT712_SDCA_CTL_VENDOR_DEF 0x30
211 #define RT712_SDCA_CTL_FU_CH_GAIN 0x0b
212 #define RT712_SDCA_CTL_FUNC_STATUS 0x10
213
214 /* Function_Status */
215 #define FUNCTION_NEEDS_INITIALIZATION BIT(5)
216 #define FUNCTION_HAS_BEEN_RESET BIT(6)
217 #define FUNCTION_BUSY BIT(7)
218
219 /* sample frequency index */
220 #define RT712_SDCA_RATE_16000HZ 0x04
221 #define RT712_SDCA_RATE_32000HZ 0x07
222 #define RT712_SDCA_RATE_44100HZ 0x08
223 #define RT712_SDCA_RATE_48000HZ 0x09
224 #define RT712_SDCA_RATE_96000HZ 0x0b
225 #define RT712_SDCA_RATE_192000HZ 0x0d
226
227 enum {
228 RT712_AIF1,
229 RT712_AIF2,
230 RT712_AIF3,
231 };
232
233 enum rt712_sdca_jd_src {
234 RT712_JD_NULL,
235 RT712_JD1,
236 };
237
238 enum rt712_sdca_hw_id {
239 RT712_DEV_ID_712 = 0x7,
240 RT712_DEV_ID_713 = 0x6,
241 RT712_DEV_ID_716 = 0x5,
242 RT712_DEV_ID_717 = 0x4,
243 };
244
245 #define RT712_PART_ID_713 0x713
246
247 enum rt712_sdca_version {
248 RT712_VA,
249 RT712_VB,
250 };
251
252 int rt712_sdca_io_init(struct device *dev, struct sdw_slave *slave);
253 int rt712_sdca_init(struct device *dev, struct regmap *regmap,
254 struct regmap *mbq_regmap, struct sdw_slave *slave);
255
256 int rt712_sdca_jack_detect(struct rt712_sdca_priv *rt712, bool *hp, bool *mic);
257 #endif /* __RT712_H__ */
258
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.