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