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