1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * rt711-sdca.h -- RT711 SDCA ALSA SoC audio driver header
5 * Copyright(c) 2021 Realtek Semiconductor Corp.
8 #ifndef __RT711_SDCA_H__
9 #define __RT711_SDCA_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>
18 struct rt711_sdca_priv {
19 struct regmap *regmap, *mbq_regmap;
20 struct snd_soc_component *component;
21 struct sdw_slave *slave;
22 enum sdw_slave_status status;
23 struct sdw_bus_params params;
26 struct snd_soc_jack *hs_jack;
27 struct delayed_work jack_detect_work;
28 struct delayed_work jack_btn_check_work;
29 struct mutex calibrate_mutex; /* for headset calibration */
30 int jack_type, jd_src;
31 unsigned int scp_sdca_stat1, scp_sdca_stat2;
33 bool fu0f_dapm_mute, fu0f_mixer_l_mute, fu0f_mixer_r_mute;
34 bool fu1e_dapm_mute, fu1e_mixer_l_mute, fu1e_mixer_r_mute;
37 struct sdw_stream_data {
38 struct sdw_stream_runtime *sdw_stream;
42 #define RT711_AUDIO_FUNCTION_GROUP 0x01
43 #define RT711_DAC_OUT2 0x03
44 #define RT711_ADC_IN1 0x09
45 #define RT711_ADC_IN2 0x08
46 #define RT711_DMIC1 0x12
47 #define RT711_DMIC2 0x13
48 #define RT711_MIC2 0x19
49 #define RT711_LINE1 0x1a
50 #define RT711_LINE2 0x1b
51 #define RT711_BEEP 0x1d
52 #define RT711_VENDOR_REG 0x20
53 #define RT711_HP_OUT 0x21
54 #define RT711_MIXER_IN1 0x22
55 #define RT711_MIXER_IN2 0x23
56 #define RT711_INLINE_CMD 0x55
57 #define RT711_VENDOR_CALI 0x58
58 #define RT711_VENDOR_IMS_DRE 0x5b
59 #define RT711_VENDOR_VAD 0x5e
60 #define RT711_VENDOR_ANALOG_CTL 0x5f
61 #define RT711_VENDOR_HDA_CTL 0x61
64 #define RT711_JD_PRODUCT_NUM 0x00
65 #define RT711_DMIC_CTL1 0x06
66 #define RT711_JD_CTL1 0x08
67 #define RT711_JD_CTL2 0x09
68 #define RT711_CC_DET1 0x11
69 #define RT711_PARA_VERB_CTL 0x1a
70 #define RT711_COMBO_JACK_AUTO_CTL1 0x45
71 #define RT711_COMBO_JACK_AUTO_CTL2 0x46
72 #define RT711_COMBO_JACK_AUTO_CTL3 0x47
73 #define RT711_INLINE_CMD_CTL 0x48
74 #define RT711_DIGITAL_MISC_CTRL4 0x4a
75 #define RT711_JD_CTRL6 0x6a
76 #define RT711_VREFOUT_CTL 0x6b
77 #define RT711_GPIO_TEST_MODE_CTL2 0x6d
78 #define RT711_FSM_CTL 0x6f
79 #define RT711_IRQ_FLAG_TABLE1 0x80
80 #define RT711_IRQ_FLAG_TABLE2 0x81
81 #define RT711_IRQ_FLAG_TABLE3 0x82
82 #define RT711_HP_FSM_CTL 0x83
83 #define RT711_TX_RX_MUX_CTL 0x91
84 #define RT711_FILTER_SRC_SEL 0xb0
85 #define RT711_ADC27_VOL_SET 0xb7
88 #define RT711_DAC_DC_CALI_CTL1 0x00
89 #define RT711_DAC_DC_CALI_CTL2 0x01
92 #define RT711_IMS_DIGITAL_CTL1 0x00
93 #define RT711_HP_IMS_RESULT_L 0x20
94 #define RT711_HP_IMS_RESULT_R 0x21
97 #define RT711_VAD_SRAM_CTL1 0x10
100 #define RT711_MISC_POWER_CTL0 0x01
101 #define RT711_MISC_POWER_CTL4 0x05
103 /* Index (NID:61h) */
104 #define RT711_HDA_LEGACY_MUX_CTL1 0x00
105 #define RT711_HDA_LEGACY_UNSOLICITED_CTL 0x03
106 #define RT711_HDA_LEGACY_CONFIG_CTL 0x06
107 #define RT711_HDA_LEGACY_RESET_CTL 0x08
108 #define RT711_HDA_LEGACY_GPIO_CTL 0x0a
109 #define RT711_ADC08_09_PDE_CTL 0x24
110 #define RT711_GE_MODE_RELATED_CTL 0x35
111 #define RT711_PUSH_BTN_INT_CTL0 0x36
112 #define RT711_PUSH_BTN_INT_CTL1 0x37
113 #define RT711_PUSH_BTN_INT_CTL2 0x38
114 #define RT711_PUSH_BTN_INT_CTL6 0x3c
115 #define RT711_PUSH_BTN_INT_CTL7 0x3d
116 #define RT711_PUSH_BTN_INT_CTL9 0x3f
118 /* DAC DC offset calibration control-1 (0x00)(NID:20h) */
119 #define RT711_DAC_DC_CALI_TRIGGER (0x1 << 15)
120 #define RT711_DAC_DC_CALI_CLK_EN (0x1 << 14)
121 #define RT711_DAC_DC_FORCE_CALI_RST (0x1 << 3)
123 /* jack detect control 1 (0x08)(NID:20h) */
124 #define RT711_JD2_DIGITAL_MODE_SEL (0x1 << 1)
126 /* jack detect control 2 (0x09)(NID:20h) */
127 #define RT711_JD2_2PORT_200K_DECODE_HP (0x1 << 13)
128 #define RT711_HP_JD_SEL_JD1 (0x0 << 1)
129 #define RT711_HP_JD_SEL_JD2 (0x1 << 1)
131 /* CC DET1 (0x11)(NID:20h) */
132 #define RT711_HP_JD_FINAL_RESULT_CTL_JD12 (0x1 << 10)
133 #define RT711_HP_JD_FINAL_RESULT_CTL_CCDET (0x0 << 10)
135 /* Parameter & Verb control (0x1a)(NID:20h) */
136 #define RT711_HIDDEN_REG_SW_RESET (0x1 << 14)
138 /* combo jack auto switch control 2 (0x46)(NID:20h) */
139 #define RT711_COMBOJACK_AUTO_DET_STATUS (0x1 << 11)
140 #define RT711_COMBOJACK_AUTO_DET_TRS (0x1 << 10)
141 #define RT711_COMBOJACK_AUTO_DET_CTIA (0x1 << 9)
142 #define RT711_COMBOJACK_AUTO_DET_OMTP (0x1 << 8)
144 /* FSM control (0x6f)(NID:20h) */
145 #define RT711_CALI_CTL (0x0 << 0)
146 #define RT711_COMBOJACK_CTL (0x1 << 0)
147 #define RT711_IMS_CTL (0x2 << 0)
148 #define RT711_DEPOP_CTL (0x3 << 0)
149 #define RT711_FSM_IMP_EN (0x1 << 6)
151 /* Impedance Sense Digital Control 1 (0x00)(NID:5bh) */
152 #define RT711_TRIGGER_IMS (0x1 << 15)
153 #define RT711_IMS_EN (0x1 << 6)
155 #define RT711_EAPD_HIGH 0x2
156 #define RT711_EAPD_LOW 0x0
157 #define RT711_MUTE_SFT 7
158 /* set input/output mapping to payload[14][15] separately */
159 #define RT711_DIR_IN_SFT 6
160 #define RT711_DIR_OUT_SFT 7
162 /* RC Calibration register */
163 #define RT711_RC_CAL_STATUS 0x320c
165 /* Buffer address for HID */
166 #define RT711_BUF_ADDR_HID1 0x44030000
167 #define RT711_BUF_ADDR_HID2 0x44030020
169 /* RT711 SDCA Control - function number */
170 #define FUNC_NUM_JACK_CODEC 0x01
171 #define FUNC_NUM_MIC_ARRAY 0x02
172 #define FUNC_NUM_HID 0x03
174 /* RT711 SDCA entity */
175 #define RT711_SDCA_ENT_HID01 0x01
176 #define RT711_SDCA_ENT_GE49 0x49
177 #define RT711_SDCA_ENT_USER_FU05 0x05
178 #define RT711_SDCA_ENT_USER_FU0F 0x0f
179 #define RT711_SDCA_ENT_USER_FU1E 0x1e
180 #define RT711_SDCA_ENT_PLATFORM_FU15 0x15
181 #define RT711_SDCA_ENT_PLATFORM_FU44 0x44
182 #define RT711_SDCA_ENT_PDE28 0x28
183 #define RT711_SDCA_ENT_PDE29 0x29
184 #define RT711_SDCA_ENT_PDE2A 0x2a
185 #define RT711_SDCA_ENT_CS01 0x01
186 #define RT711_SDCA_ENT_CS11 0x11
187 #define RT711_SDCA_ENT_CS1F 0x1f
188 #define RT711_SDCA_ENT_OT1 0x06
189 #define RT711_SDCA_ENT_LINE1 0x09
190 #define RT711_SDCA_ENT_LINE2 0x31
191 #define RT711_SDCA_ENT_PDELINE2 0x36
192 #define RT711_SDCA_ENT_USER_FU9 0x41
194 /* RT711 SDCA control */
195 #define RT711_SDCA_CTL_SAMPLE_FREQ_INDEX 0x10
196 #define RT711_SDCA_CTL_FU_CH_GAIN 0x0b
197 #define RT711_SDCA_CTL_FU_MUTE 0x01
198 #define RT711_SDCA_CTL_FU_VOLUME 0x02
199 #define RT711_SDCA_CTL_HIDTX_CURRENT_OWNER 0x10
200 #define RT711_SDCA_CTL_HIDTX_SET_OWNER_TO_DEVICE 0x11
201 #define RT711_SDCA_CTL_HIDTX_MESSAGE_OFFSET 0x12
202 #define RT711_SDCA_CTL_HIDTX_MESSAGE_LENGTH 0x13
203 #define RT711_SDCA_CTL_SELECTED_MODE 0x01
204 #define RT711_SDCA_CTL_DETECTED_MODE 0x02
205 #define RT711_SDCA_CTL_REQ_POWER_STATE 0x01
206 #define RT711_SDCA_CTL_VENDOR_DEF 0x30
208 /* RT711 SDCA channel */
212 /* sample frequency index */
213 #define RT711_SDCA_RATE_44100HZ 0x08
214 #define RT711_SDCA_RATE_48000HZ 0x09
215 #define RT711_SDCA_RATE_96000HZ 0x0b
216 #define RT711_SDCA_RATE_192000HZ 0x0d
224 enum rt711_sdca_jd_src {
230 enum rt711_sdca_ver {
235 int rt711_sdca_io_init(struct device *dev, struct sdw_slave *slave);
236 int rt711_sdca_init(struct device *dev, struct regmap *regmap,
237 struct regmap *mbq_regmap, struct sdw_slave *slave);
239 int rt711_sdca_jack_detect(struct rt711_sdca_priv *rt711, bool *hp, bool *mic);
240 #endif /* __RT711_SDCA_H__ */