xref: /linux/sound/soc/codecs/cs42l43-jack.c (revision 6fac1139d99e283ba0c7ed2d1acad9ec2807ba3a)
1 // SPDX-License-Identifier: GPL-2.0
2 //
3 // CS42L43 CODEC driver jack handling
4 //
5 // Copyright (C) 2022-2023 Cirrus Logic, Inc. and
6 //                         Cirrus Logic International Semiconductor Ltd.
7 
8 #include <linux/build_bug.h>
9 #include <linux/completion.h>
10 #include <linux/delay.h>
11 #include <linux/errno.h>
12 #include <linux/irq.h>
13 #include <linux/jiffies.h>
14 #include <linux/mfd/cs42l43.h>
15 #include <linux/mfd/cs42l43-regs.h>
16 #include <linux/mutex.h>
17 #include <linux/pm_runtime.h>
18 #include <linux/property.h>
19 #include <linux/regmap.h>
20 #include <linux/time.h>
21 #include <linux/workqueue.h>
22 #include <sound/control.h>
23 #include <sound/jack.h>
24 #include <sound/pcm.h>
25 #include <sound/pcm_params.h>
26 #include <sound/soc-component.h>
27 #include <sound/soc-jack.h>
28 #include <sound/soc.h>
29 
30 #include "cs42l43.h"
31 
32 static const unsigned int cs42l43_accdet_us[] = {
33 	20, 100, 1000, 10000, 50000, 75000, 100000, 200000,
34 };
35 
36 static const unsigned int cs42l43_accdet_db_ms[] = {
37 	0, 125, 250, 500, 750, 1000, 1250, 1500,
38 };
39 
40 static const unsigned int cs42l43_accdet_ramp_ms[] = { 10, 40, 90, 170 };
41 
42 static const unsigned int cs42l43_accdet_bias_sense[] = {
43 	14, 24, 43, 52, 61, 71, 90, 99, 0,
44 };
45 
cs42l43_find_index(struct cs42l43_codec * priv,const char * const prop,unsigned int defval,unsigned int * val,const unsigned int * values,const int nvalues)46 static int cs42l43_find_index(struct cs42l43_codec *priv, const char * const prop,
47 			      unsigned int defval, unsigned int *val,
48 			      const unsigned int *values, const int nvalues)
49 {
50 	struct cs42l43 *cs42l43 = priv->core;
51 	int i, ret;
52 
53 	ret = device_property_read_u32(cs42l43->dev, prop, &defval);
54 	if (ret != -EINVAL && ret < 0) {
55 		dev_err(priv->dev, "Property %s malformed: %d\n", prop, ret);
56 		return ret;
57 	}
58 
59 	if (val)
60 		*val = defval;
61 
62 	for (i = 0; i < nvalues; i++)
63 		if (defval == values[i])
64 			return i;
65 
66 	dev_err(priv->dev, "Invalid value for property %s: %d\n", prop, defval);
67 	return -EINVAL;
68 }
69 
cs42l43_set_jack(struct snd_soc_component * component,struct snd_soc_jack * jack,void * d)70 int cs42l43_set_jack(struct snd_soc_component *component,
71 		     struct snd_soc_jack *jack, void *d)
72 {
73 	struct cs42l43_codec *priv = snd_soc_component_get_drvdata(component);
74 	struct cs42l43 *cs42l43 = priv->core;
75 	/* This tip sense invert is always set, HW wants an inverted signal */
76 	unsigned int tip_deb = CS42L43_TIPSENSE_INV_MASK;
77 	unsigned int hs2 = 0x2 << CS42L43_HSDET_MODE_SHIFT;
78 	unsigned int autocontrol = 0, pdncntl = 0;
79 	int ret;
80 
81 	dev_dbg(priv->dev, "Configure accessory detect\n");
82 
83 	ret = pm_runtime_resume_and_get(priv->dev);
84 	if (ret) {
85 		dev_err(priv->dev, "Failed to resume for jack config: %d\n", ret);
86 		return ret;
87 	}
88 
89 	mutex_lock(&priv->jack_lock);
90 
91 	priv->jack_hp = jack;
92 
93 	if (!jack)
94 		goto done;
95 
96 	ret = device_property_count_u32(cs42l43->dev, "cirrus,buttons-ohms");
97 	if (ret != -EINVAL) {
98 		if (ret < 0) {
99 			dev_err(priv->dev, "Property cirrus,buttons-ohms malformed: %d\n",
100 				ret);
101 			goto error;
102 		}
103 
104 		if (ret > CS42L43_N_BUTTONS) {
105 			ret = -EINVAL;
106 			dev_err(priv->dev, "Property cirrus,buttons-ohms too many entries\n");
107 			goto error;
108 		}
109 
110 		ret = device_property_read_u32_array(cs42l43->dev, "cirrus,buttons-ohms",
111 						     priv->buttons, ret);
112 		if (ret < 0) {
113 			dev_err(priv->dev, "Property cirrus,button-ohms malformed: %d\n",
114 				ret);
115 			goto error;
116 		}
117 	} else {
118 		priv->buttons[0] = 70;
119 		priv->buttons[1] = 185;
120 		priv->buttons[2] = 355;
121 		priv->buttons[3] = 735;
122 	}
123 
124 	ret = cs42l43_find_index(priv, "cirrus,detect-us", 50000, &priv->detect_us,
125 				 cs42l43_accdet_us, ARRAY_SIZE(cs42l43_accdet_us));
126 	if (ret < 0)
127 		goto error;
128 
129 	hs2 |= ret << CS42L43_AUTO_HSDET_TIME_SHIFT;
130 
131 	priv->bias_low = device_property_read_bool(cs42l43->dev, "cirrus,bias-low");
132 
133 	ret = cs42l43_find_index(priv, "cirrus,bias-ramp-ms", 170,
134 				 &priv->bias_ramp_ms, cs42l43_accdet_ramp_ms,
135 				 ARRAY_SIZE(cs42l43_accdet_ramp_ms));
136 	if (ret < 0)
137 		goto error;
138 
139 	hs2 |= ret << CS42L43_HSBIAS_RAMP_SHIFT;
140 
141 	ret = cs42l43_find_index(priv, "cirrus,bias-sense-microamp", 14,
142 				 &priv->bias_sense_ua, cs42l43_accdet_bias_sense,
143 				 ARRAY_SIZE(cs42l43_accdet_bias_sense));
144 	if (ret < 0)
145 		goto error;
146 
147 	if (priv->bias_sense_ua)
148 		autocontrol |= ret << CS42L43_HSBIAS_SENSE_TRIP_SHIFT;
149 
150 	if (!device_property_read_bool(cs42l43->dev, "cirrus,button-automute"))
151 		autocontrol |= CS42L43_S0_AUTO_ADCMUTE_DISABLE_MASK;
152 
153 	ret = device_property_read_u32(cs42l43->dev, "cirrus,tip-debounce-ms",
154 				       &priv->tip_debounce_ms);
155 	if (ret < 0 && ret != -EINVAL) {
156 		dev_err(priv->dev, "Property cirrus,tip-debounce-ms malformed: %d\n", ret);
157 		goto error;
158 	}
159 
160 	/* This tip sense invert is set normally, as TIPSENSE_INV already inverted */
161 	if (device_property_read_bool(cs42l43->dev, "cirrus,tip-invert"))
162 		autocontrol |= 0x1 << CS42L43_JACKDET_INV_SHIFT;
163 
164 	if (device_property_read_bool(cs42l43->dev, "cirrus,tip-disable-pullup"))
165 		autocontrol |= 0x1 << CS42L43_JACKDET_MODE_SHIFT;
166 	else
167 		autocontrol |= 0x3 << CS42L43_JACKDET_MODE_SHIFT;
168 
169 	ret = cs42l43_find_index(priv, "cirrus,tip-fall-db-ms", 500,
170 				 &priv->tip_fall_db_ms, cs42l43_accdet_db_ms,
171 				 ARRAY_SIZE(cs42l43_accdet_db_ms));
172 	if (ret < 0)
173 		goto error;
174 
175 	tip_deb |= ret << CS42L43_TIPSENSE_FALLING_DB_TIME_SHIFT;
176 
177 	ret = cs42l43_find_index(priv, "cirrus,tip-rise-db-ms", 500,
178 				 &priv->tip_rise_db_ms, cs42l43_accdet_db_ms,
179 				 ARRAY_SIZE(cs42l43_accdet_db_ms));
180 	if (ret < 0)
181 		goto error;
182 
183 	tip_deb |= ret << CS42L43_TIPSENSE_RISING_DB_TIME_SHIFT;
184 
185 	if (device_property_read_bool(cs42l43->dev, "cirrus,use-ring-sense")) {
186 		unsigned int ring_deb = 0;
187 
188 		priv->use_ring_sense = true;
189 
190 		/* HW wants an inverted signal, so invert the invert */
191 		if (!device_property_read_bool(cs42l43->dev, "cirrus,ring-invert"))
192 			ring_deb |= CS42L43_RINGSENSE_INV_MASK;
193 
194 		if (!device_property_read_bool(cs42l43->dev,
195 					       "cirrus,ring-disable-pullup"))
196 			ring_deb |= CS42L43_RINGSENSE_PULLUP_PDNB_MASK;
197 
198 		ret = cs42l43_find_index(priv, "cirrus,ring-fall-db-ms", 500,
199 					 NULL, cs42l43_accdet_db_ms,
200 					 ARRAY_SIZE(cs42l43_accdet_db_ms));
201 		if (ret < 0)
202 			goto error;
203 
204 		ring_deb |= ret << CS42L43_RINGSENSE_FALLING_DB_TIME_SHIFT;
205 
206 		ret = cs42l43_find_index(priv, "cirrus,ring-rise-db-ms", 500,
207 					 NULL, cs42l43_accdet_db_ms,
208 					 ARRAY_SIZE(cs42l43_accdet_db_ms));
209 		if (ret < 0)
210 			goto error;
211 
212 		ring_deb |= ret << CS42L43_RINGSENSE_RISING_DB_TIME_SHIFT;
213 		pdncntl |= CS42L43_RING_SENSE_EN_MASK;
214 
215 		regmap_update_bits(cs42l43->regmap, CS42L43_RINGSENSE_DEB_CTRL,
216 				   CS42L43_RINGSENSE_INV_MASK |
217 				   CS42L43_RINGSENSE_PULLUP_PDNB_MASK |
218 				   CS42L43_RINGSENSE_FALLING_DB_TIME_MASK |
219 				   CS42L43_RINGSENSE_RISING_DB_TIME_MASK,
220 				   ring_deb);
221 	}
222 
223 	regmap_update_bits(cs42l43->regmap, CS42L43_TIPSENSE_DEB_CTRL,
224 			   CS42L43_TIPSENSE_INV_MASK |
225 			   CS42L43_TIPSENSE_FALLING_DB_TIME_MASK |
226 			   CS42L43_TIPSENSE_RISING_DB_TIME_MASK, tip_deb);
227 	regmap_update_bits(cs42l43->regmap, CS42L43_HS2,
228 			   CS42L43_HSBIAS_RAMP_MASK | CS42L43_HSDET_MODE_MASK |
229 			   CS42L43_AUTO_HSDET_TIME_MASK, hs2);
230 
231 done:
232 	ret = 0;
233 
234 	regmap_update_bits(cs42l43->regmap, CS42L43_HS_BIAS_SENSE_AND_CLAMP_AUTOCONTROL,
235 			   CS42L43_JACKDET_MODE_MASK | CS42L43_S0_AUTO_ADCMUTE_DISABLE_MASK |
236 			   CS42L43_HSBIAS_SENSE_TRIP_MASK, autocontrol);
237 	regmap_update_bits(cs42l43->regmap, CS42L43_PDNCNTL,
238 			   CS42L43_RING_SENSE_EN_MASK, pdncntl);
239 
240 	dev_dbg(priv->dev, "Successfully configured accessory detect\n");
241 
242 error:
243 	mutex_unlock(&priv->jack_lock);
244 
245 	pm_runtime_put_autosuspend(priv->dev);
246 
247 	return ret;
248 }
249 
cs42l43_start_hs_bias(struct cs42l43_codec * priv,bool type_detect)250 static void cs42l43_start_hs_bias(struct cs42l43_codec *priv, bool type_detect)
251 {
252 	struct cs42l43 *cs42l43 = priv->core;
253 	unsigned int val = 0x3 << CS42L43_HSBIAS_MODE_SHIFT;
254 
255 	dev_dbg(priv->dev, "Start headset bias\n");
256 
257 	regmap_update_bits(cs42l43->regmap, CS42L43_HS2,
258 			   CS42L43_HS_CLAMP_DISABLE_MASK, CS42L43_HS_CLAMP_DISABLE_MASK);
259 
260 	if (!type_detect) {
261 		if (priv->bias_low)
262 			val = 0x2 << CS42L43_HSBIAS_MODE_SHIFT;
263 
264 		if (priv->bias_sense_ua)
265 			regmap_update_bits(cs42l43->regmap,
266 					   CS42L43_HS_BIAS_SENSE_AND_CLAMP_AUTOCONTROL,
267 					   CS42L43_HSBIAS_SENSE_EN_MASK |
268 					   CS42L43_AUTO_HSBIAS_CLAMP_EN_MASK,
269 					   CS42L43_HSBIAS_SENSE_EN_MASK |
270 					   CS42L43_AUTO_HSBIAS_CLAMP_EN_MASK);
271 	}
272 
273 	regmap_update_bits(cs42l43->regmap, CS42L43_MIC_DETECT_CONTROL_1,
274 			   CS42L43_HSBIAS_MODE_MASK, val);
275 
276 	msleep(priv->bias_ramp_ms);
277 }
278 
cs42l43_stop_hs_bias(struct cs42l43_codec * priv)279 static void cs42l43_stop_hs_bias(struct cs42l43_codec *priv)
280 {
281 	struct cs42l43 *cs42l43 = priv->core;
282 
283 	dev_dbg(priv->dev, "Stop headset bias\n");
284 
285 	regmap_update_bits(cs42l43->regmap, CS42L43_MIC_DETECT_CONTROL_1,
286 			   CS42L43_HSBIAS_MODE_MASK, 0x1 << CS42L43_HSBIAS_MODE_SHIFT);
287 
288 	regmap_update_bits(cs42l43->regmap, CS42L43_HS2,
289 			   CS42L43_HS_CLAMP_DISABLE_MASK, 0);
290 
291 	if (priv->bias_sense_ua) {
292 		regmap_update_bits(cs42l43->regmap,
293 				   CS42L43_HS_BIAS_SENSE_AND_CLAMP_AUTOCONTROL,
294 				   CS42L43_HSBIAS_SENSE_EN_MASK |
295 				   CS42L43_AUTO_HSBIAS_CLAMP_EN_MASK, 0);
296 	}
297 }
298 
cs42l43_bias_detect_clamp(int irq,void * data)299 irqreturn_t cs42l43_bias_detect_clamp(int irq, void *data)
300 {
301 	struct cs42l43_codec *priv = data;
302 
303 	queue_delayed_work(system_wq, &priv->bias_sense_timeout,
304 			   msecs_to_jiffies(1000));
305 
306 	return IRQ_HANDLED;
307 }
308 
309 #define CS42L43_JACK_PRESENT 0x3
310 #define CS42L43_JACK_ABSENT 0x0
311 
312 #define CS42L43_JACK_OPTICAL (SND_JACK_MECHANICAL | SND_JACK_AVOUT)
313 #define CS42L43_JACK_HEADPHONE (SND_JACK_MECHANICAL | SND_JACK_HEADPHONE)
314 #define CS42L43_JACK_HEADSET (SND_JACK_MECHANICAL | SND_JACK_HEADSET)
315 #define CS42L43_JACK_LINEOUT (SND_JACK_MECHANICAL | SND_JACK_LINEOUT)
316 #define CS42L43_JACK_LINEIN (SND_JACK_MECHANICAL | SND_JACK_LINEIN)
317 #define CS42L43_JACK_EXTENSION (SND_JACK_MECHANICAL)
318 #define CS42L43_JACK_BUTTONS (SND_JACK_BTN_0 | SND_JACK_BTN_1 | SND_JACK_BTN_2 | \
319 			      SND_JACK_BTN_3 | SND_JACK_BTN_4 | SND_JACK_BTN_5)
320 
cs42l43_jack_present(struct cs42l43_codec * priv)321 static inline bool cs42l43_jack_present(struct cs42l43_codec *priv)
322 {
323 	struct cs42l43 *cs42l43 = priv->core;
324 	unsigned int sts = 0;
325 
326 	regmap_read(cs42l43->regmap, CS42L43_TIP_RING_SENSE_INTERRUPT_STATUS, &sts);
327 
328 	sts = (sts >> CS42L43_TIPSENSE_PLUG_DB_STS_SHIFT) & CS42L43_JACK_PRESENT;
329 
330 	return sts == CS42L43_JACK_PRESENT;
331 }
332 
cs42l43_start_button_detect(struct cs42l43_codec * priv)333 static void cs42l43_start_button_detect(struct cs42l43_codec *priv)
334 {
335 	struct cs42l43 *cs42l43 = priv->core;
336 	unsigned int val = 0x3 << CS42L43_BUTTON_DETECT_MODE_SHIFT;
337 
338 	dev_dbg(priv->dev, "Start button detect\n");
339 
340 	priv->button_detect_running = true;
341 
342 	if (priv->bias_low)
343 		val = 0x1 << CS42L43_BUTTON_DETECT_MODE_SHIFT;
344 
345 	regmap_update_bits(cs42l43->regmap, CS42L43_MIC_DETECT_CONTROL_1,
346 			   CS42L43_BUTTON_DETECT_MODE_MASK |
347 			   CS42L43_MIC_LVL_DET_DISABLE_MASK, val);
348 }
349 
cs42l43_stop_button_detect(struct cs42l43_codec * priv)350 static void cs42l43_stop_button_detect(struct cs42l43_codec *priv)
351 {
352 	struct cs42l43 *cs42l43 = priv->core;
353 
354 	dev_dbg(priv->dev, "Stop button detect\n");
355 
356 	regmap_update_bits(cs42l43->regmap, CS42L43_MIC_DETECT_CONTROL_1,
357 			   CS42L43_BUTTON_DETECT_MODE_MASK |
358 			   CS42L43_MIC_LVL_DET_DISABLE_MASK,
359 			   CS42L43_MIC_LVL_DET_DISABLE_MASK);
360 
361 	priv->button_detect_running = false;
362 }
363 
364 #define CS42L43_BUTTON_COMB_US 11000
365 #define CS42L43_BUTTON_COMB_MAX 512
366 #define CS42L43_BUTTON_ROUT 2210
367 
cs42l43_button_press(int irq,void * data)368 irqreturn_t cs42l43_button_press(int irq, void *data)
369 {
370 	struct cs42l43_codec *priv = data;
371 	struct cs42l43 *cs42l43 = priv->core;
372 	irqreturn_t iret = IRQ_NONE;
373 	unsigned int buttons = 0;
374 	unsigned int val = 0;
375 	int i, ret;
376 
377 	ret = pm_runtime_resume_and_get(priv->dev);
378 	if (ret) {
379 		dev_err(priv->dev, "Failed to resume for button press: %d\n", ret);
380 		return iret;
381 	}
382 
383 	mutex_lock(&priv->jack_lock);
384 
385 	if (!priv->button_detect_running) {
386 		dev_dbg(priv->dev, "Spurious button press IRQ\n");
387 		goto error;
388 	}
389 
390 	// Wait for 2 full cycles of comb filter to ensure good reading
391 	usleep_range(2 * CS42L43_BUTTON_COMB_US, 2 * CS42L43_BUTTON_COMB_US + 50);
392 
393 	regmap_read(cs42l43->regmap, CS42L43_DETECT_STATUS_1, &val);
394 
395 	/* Bail if jack removed, the button is irrelevant and likely invalid */
396 	if (!cs42l43_jack_present(priv)) {
397 		dev_dbg(priv->dev, "Button ignored due to removal\n");
398 		goto error;
399 	}
400 
401 	if (val & CS42L43_HSBIAS_CLAMP_STS_MASK) {
402 		dev_dbg(priv->dev, "Button ignored due to bias sense\n");
403 		goto error;
404 	}
405 
406 	val = (val & CS42L43_HSDET_DC_STS_MASK) >> CS42L43_HSDET_DC_STS_SHIFT;
407 	val = ((CS42L43_BUTTON_COMB_MAX << 20) / (val + 1)) - (1 << 20);
408 	if (val)
409 		val = (CS42L43_BUTTON_ROUT << 20) / val;
410 	else
411 		val = UINT_MAX;
412 
413 	for (i = 0; i < CS42L43_N_BUTTONS; i++) {
414 		if (val < priv->buttons[i]) {
415 			buttons = SND_JACK_BTN_0 >> i;
416 			dev_dbg(priv->dev, "Detected button %d at %d Ohms\n", i, val);
417 			break;
418 		}
419 	}
420 
421 	if (!buttons)
422 		dev_dbg(priv->dev, "Unrecognised button: %d Ohms\n", val);
423 
424 	snd_soc_jack_report(priv->jack_hp, buttons, CS42L43_JACK_BUTTONS);
425 
426 	iret = IRQ_HANDLED;
427 
428 error:
429 	mutex_unlock(&priv->jack_lock);
430 
431 	pm_runtime_put_autosuspend(priv->dev);
432 
433 	return iret;
434 }
435 
cs42l43_button_release(int irq,void * data)436 irqreturn_t cs42l43_button_release(int irq, void *data)
437 {
438 	struct cs42l43_codec *priv = data;
439 	irqreturn_t iret = IRQ_NONE;
440 	int ret;
441 
442 	ret = pm_runtime_resume_and_get(priv->dev);
443 	if (ret) {
444 		dev_err(priv->dev, "Failed to resume for button release: %d\n", ret);
445 		return iret;
446 	}
447 
448 	mutex_lock(&priv->jack_lock);
449 
450 	if (priv->button_detect_running) {
451 		dev_dbg(priv->dev, "Button release IRQ\n");
452 
453 		snd_soc_jack_report(priv->jack_hp, 0, CS42L43_JACK_BUTTONS);
454 
455 		iret = IRQ_HANDLED;
456 	} else {
457 		dev_dbg(priv->dev, "Spurious button release IRQ\n");
458 	}
459 
460 	mutex_unlock(&priv->jack_lock);
461 
462 	pm_runtime_put_autosuspend(priv->dev);
463 
464 	return iret;
465 }
466 
cs42l43_bias_sense_timeout(struct work_struct * work)467 void cs42l43_bias_sense_timeout(struct work_struct *work)
468 {
469 	struct cs42l43_codec *priv = container_of(work, struct cs42l43_codec,
470 						  bias_sense_timeout.work);
471 	struct cs42l43 *cs42l43 = priv->core;
472 	int ret;
473 
474 	ret = pm_runtime_resume_and_get(priv->dev);
475 	if (ret) {
476 		dev_err(priv->dev, "Failed to resume for bias sense: %d\n", ret);
477 		return;
478 	}
479 
480 	mutex_lock(&priv->jack_lock);
481 
482 	if (cs42l43_jack_present(priv) && priv->button_detect_running) {
483 		dev_dbg(priv->dev, "Bias sense timeout out, restore bias\n");
484 
485 		regmap_update_bits(cs42l43->regmap,
486 				   CS42L43_HS_BIAS_SENSE_AND_CLAMP_AUTOCONTROL,
487 				   CS42L43_AUTO_HSBIAS_CLAMP_EN_MASK, 0);
488 		regmap_update_bits(cs42l43->regmap,
489 				   CS42L43_HS_BIAS_SENSE_AND_CLAMP_AUTOCONTROL,
490 				   CS42L43_AUTO_HSBIAS_CLAMP_EN_MASK,
491 				   CS42L43_AUTO_HSBIAS_CLAMP_EN_MASK);
492 	}
493 
494 	mutex_unlock(&priv->jack_lock);
495 
496 	pm_runtime_put_autosuspend(priv->dev);
497 }
498 
cs42l43_start_load_detect(struct cs42l43_codec * priv)499 static void cs42l43_start_load_detect(struct cs42l43_codec *priv)
500 {
501 	struct cs42l43 *cs42l43 = priv->core;
502 
503 	dev_dbg(priv->dev, "Start load detect\n");
504 
505 	snd_soc_dapm_mutex_lock(snd_soc_component_get_dapm(priv->component));
506 
507 	priv->load_detect_running = true;
508 
509 	if (priv->hp_ena && !priv->hp_ilimited) {
510 		unsigned long time_left;
511 
512 		reinit_completion(&priv->hp_shutdown);
513 
514 		regmap_update_bits(cs42l43->regmap, CS42L43_BLOCK_EN8,
515 				   CS42L43_HP_EN_MASK, 0);
516 
517 		time_left = wait_for_completion_timeout(&priv->hp_shutdown,
518 							msecs_to_jiffies(CS42L43_HP_TIMEOUT_MS));
519 		if (!time_left)
520 			dev_err(priv->dev, "Load detect HP power down timed out\n");
521 	}
522 
523 	regmap_update_bits(cs42l43->regmap, CS42L43_BLOCK_EN3,
524 			   CS42L43_ADC1_EN_MASK | CS42L43_ADC2_EN_MASK, 0);
525 	regmap_update_bits(cs42l43->regmap, CS42L43_DACCNFG2, CS42L43_HP_HPF_EN_MASK, 0);
526 	regmap_update_bits(cs42l43->regmap, CS42L43_MIC_DETECT_CONTROL_1,
527 			   CS42L43_HSBIAS_MODE_MASK, 0);
528 	regmap_update_bits(cs42l43->regmap, CS42L43_CTRL,
529 			   CS42L43_ADPTPWR_MODE_MASK, 0x4 << CS42L43_ADPTPWR_MODE_SHIFT);
530 	regmap_update_bits(cs42l43->regmap, CS42L43_PGAVOL,
531 			   CS42L43_HP_DIG_VOL_RAMP_MASK | CS42L43_HP_ANA_VOL_RAMP_MASK, 0x6);
532 	regmap_update_bits(cs42l43->regmap, CS42L43_DACCNFG1,
533 			   CS42L43_HP_MSTR_VOL_CTRL_EN_MASK, 0);
534 
535 	regmap_update_bits(cs42l43->regmap, CS42L43_HS2,
536 			   CS42L43_HS_CLAMP_DISABLE_MASK, CS42L43_HS_CLAMP_DISABLE_MASK);
537 
538 	regmap_update_bits(cs42l43->regmap, CS42L43_LOADDETENA,
539 			   CS42L43_HPLOAD_DET_EN_MASK,
540 			   CS42L43_HPLOAD_DET_EN_MASK);
541 
542 	snd_soc_dapm_mutex_unlock(snd_soc_component_get_dapm(priv->component));
543 }
544 
cs42l43_stop_load_detect(struct cs42l43_codec * priv)545 static void cs42l43_stop_load_detect(struct cs42l43_codec *priv)
546 {
547 	struct cs42l43 *cs42l43 = priv->core;
548 
549 	dev_dbg(priv->dev, "Stop load detect\n");
550 
551 	snd_soc_dapm_mutex_lock(snd_soc_component_get_dapm(priv->component));
552 
553 	regmap_update_bits(cs42l43->regmap, CS42L43_LOADDETENA,
554 			   CS42L43_HPLOAD_DET_EN_MASK, 0);
555 	regmap_update_bits(cs42l43->regmap, CS42L43_HS2,
556 			   CS42L43_HS_CLAMP_DISABLE_MASK, 0);
557 	regmap_update_bits(cs42l43->regmap, CS42L43_DACCNFG1,
558 			   CS42L43_HP_MSTR_VOL_CTRL_EN_MASK,
559 			   CS42L43_HP_MSTR_VOL_CTRL_EN_MASK);
560 	regmap_update_bits(cs42l43->regmap, CS42L43_PGAVOL,
561 			   CS42L43_HP_DIG_VOL_RAMP_MASK | CS42L43_HP_ANA_VOL_RAMP_MASK,
562 			   0x4 << CS42L43_HP_DIG_VOL_RAMP_SHIFT);
563 	regmap_update_bits(cs42l43->regmap, CS42L43_CTRL,
564 			   CS42L43_ADPTPWR_MODE_MASK, 0x7 << CS42L43_ADPTPWR_MODE_SHIFT);
565 	regmap_update_bits(cs42l43->regmap, CS42L43_MIC_DETECT_CONTROL_1,
566 			   CS42L43_HSBIAS_MODE_MASK, 0x1 << CS42L43_HSBIAS_MODE_SHIFT);
567 	regmap_update_bits(cs42l43->regmap, CS42L43_DACCNFG2,
568 			   CS42L43_HP_HPF_EN_MASK, CS42L43_HP_HPF_EN_MASK);
569 
570 	regmap_update_bits(cs42l43->regmap, CS42L43_BLOCK_EN3,
571 			   CS42L43_ADC1_EN_MASK | CS42L43_ADC2_EN_MASK,
572 			   priv->adc_ena);
573 
574 	if (priv->hp_ena && !priv->hp_ilimited) {
575 		unsigned long time_left;
576 
577 		reinit_completion(&priv->hp_startup);
578 
579 		regmap_update_bits(cs42l43->regmap, CS42L43_BLOCK_EN8,
580 				   CS42L43_HP_EN_MASK, priv->hp_ena);
581 
582 		time_left = wait_for_completion_timeout(&priv->hp_startup,
583 							msecs_to_jiffies(CS42L43_HP_TIMEOUT_MS));
584 		if (!time_left)
585 			dev_err(priv->dev, "Load detect HP restore timed out\n");
586 	}
587 
588 	priv->load_detect_running = false;
589 
590 	snd_soc_dapm_mutex_unlock(snd_soc_component_get_dapm(priv->component));
591 }
592 
cs42l43_run_load_detect(struct cs42l43_codec * priv,bool mic)593 static int cs42l43_run_load_detect(struct cs42l43_codec *priv, bool mic)
594 {
595 	struct cs42l43 *cs42l43 = priv->core;
596 	unsigned int val = 0;
597 	unsigned long time_left;
598 
599 	reinit_completion(&priv->load_detect);
600 
601 	cs42l43_start_load_detect(priv);
602 	time_left = wait_for_completion_timeout(&priv->load_detect,
603 						msecs_to_jiffies(CS42L43_LOAD_TIMEOUT_MS));
604 	cs42l43_stop_load_detect(priv);
605 
606 	if (!time_left)
607 		return -ETIMEDOUT;
608 
609 	regmap_read(cs42l43->regmap, CS42L43_LOADDETRESULTS, &val);
610 
611 	dev_dbg(priv->dev, "Headphone load detect: 0x%x\n", val);
612 
613 	/* Bail if jack removed, the load is irrelevant and likely invalid */
614 	if (!cs42l43_jack_present(priv))
615 		return -ENODEV;
616 
617 	if (mic) {
618 		cs42l43_start_hs_bias(priv, false);
619 		cs42l43_start_button_detect(priv);
620 
621 		return CS42L43_JACK_HEADSET;
622 	}
623 
624 	switch (val & CS42L43_AMP3_RES_DET_MASK) {
625 	case 0x0: // low impedance
626 	case 0x1: // high impedance
627 		return CS42L43_JACK_HEADPHONE;
628 	case 0x2: // lineout
629 	case 0x3: // Open circuit
630 		return CS42L43_JACK_LINEOUT;
631 	default:
632 		return -EINVAL;
633 	}
634 }
635 
cs42l43_run_type_detect(struct cs42l43_codec * priv)636 static int cs42l43_run_type_detect(struct cs42l43_codec *priv)
637 {
638 	struct cs42l43 *cs42l43 = priv->core;
639 	int timeout_ms = ((2 * priv->detect_us) / USEC_PER_MSEC) + 200;
640 	unsigned int type = 0xff;
641 	unsigned long time_left;
642 
643 	reinit_completion(&priv->type_detect);
644 
645 	regmap_update_bits(cs42l43->regmap, CS42L43_STEREO_MIC_CLAMP_CTRL,
646 			   CS42L43_SMIC_HPAMP_CLAMP_DIS_FRC_VAL_MASK,
647 			   CS42L43_SMIC_HPAMP_CLAMP_DIS_FRC_VAL_MASK);
648 
649 	cs42l43_start_hs_bias(priv, true);
650 	regmap_update_bits(cs42l43->regmap, CS42L43_HS2,
651 			   CS42L43_HSDET_MODE_MASK, 0x3 << CS42L43_HSDET_MODE_SHIFT);
652 
653 	time_left = wait_for_completion_timeout(&priv->type_detect,
654 						msecs_to_jiffies(timeout_ms));
655 
656 	regmap_update_bits(cs42l43->regmap, CS42L43_HS2,
657 			   CS42L43_HSDET_MODE_MASK, 0x2 << CS42L43_HSDET_MODE_SHIFT);
658 	cs42l43_stop_hs_bias(priv);
659 
660 	regmap_update_bits(cs42l43->regmap, CS42L43_STEREO_MIC_CLAMP_CTRL,
661 			   CS42L43_SMIC_HPAMP_CLAMP_DIS_FRC_VAL_MASK, 0);
662 
663 	if (!time_left)
664 		return -ETIMEDOUT;
665 
666 	regmap_read(cs42l43->regmap, CS42L43_HS_STAT, &type);
667 
668 	dev_dbg(priv->dev, "Type detect: 0x%x\n", type);
669 
670 	/* Bail if jack removed, the type is irrelevant and likely invalid */
671 	if (!cs42l43_jack_present(priv))
672 		return -ENODEV;
673 
674 	switch (type & CS42L43_HSDET_TYPE_STS_MASK) {
675 	case 0x0: // CTIA
676 	case 0x1: // OMTP
677 		return cs42l43_run_load_detect(priv, true);
678 	case 0x2: // 3-pole
679 		return cs42l43_run_load_detect(priv, false);
680 	case 0x3: // Open-circuit
681 		return CS42L43_JACK_EXTENSION;
682 	default:
683 		return -EINVAL;
684 	}
685 }
686 
cs42l43_clear_jack(struct cs42l43_codec * priv)687 static void cs42l43_clear_jack(struct cs42l43_codec *priv)
688 {
689 	struct cs42l43 *cs42l43 = priv->core;
690 
691 	cs42l43_stop_button_detect(priv);
692 	cs42l43_stop_hs_bias(priv);
693 
694 	regmap_update_bits(cs42l43->regmap, CS42L43_ADC_B_CTRL1,
695 			   CS42L43_PGA_WIDESWING_MODE_EN_MASK, 0);
696 	regmap_update_bits(cs42l43->regmap, CS42L43_ADC_B_CTRL2,
697 			   CS42L43_PGA_WIDESWING_MODE_EN_MASK, 0);
698 	regmap_update_bits(cs42l43->regmap, CS42L43_STEREO_MIC_CTRL,
699 			   CS42L43_JACK_STEREO_CONFIG_MASK, 0);
700 	regmap_update_bits(cs42l43->regmap, CS42L43_STEREO_MIC_CLAMP_CTRL,
701 			   CS42L43_SMIC_HPAMP_CLAMP_DIS_FRC_MASK,
702 			   CS42L43_SMIC_HPAMP_CLAMP_DIS_FRC_MASK);
703 	regmap_update_bits(cs42l43->regmap, CS42L43_HS2,
704 			   CS42L43_HSDET_MODE_MASK | CS42L43_HSDET_MANUAL_MODE_MASK,
705 			   0x2 << CS42L43_HSDET_MODE_SHIFT);
706 
707 	snd_soc_jack_report(priv->jack_hp, 0, 0xFFFF);
708 }
709 
cs42l43_tip_sense_work(struct work_struct * work)710 void cs42l43_tip_sense_work(struct work_struct *work)
711 {
712 	struct cs42l43_codec *priv = container_of(work, struct cs42l43_codec,
713 						  tip_sense_work.work);
714 	struct cs42l43 *cs42l43 = priv->core;
715 	unsigned int sts = 0;
716 	unsigned int tip, ring;
717 	int ret, report;
718 
719 	ret = pm_runtime_resume_and_get(priv->dev);
720 	if (ret) {
721 		dev_err(priv->dev, "Failed to resume for tip work: %d\n", ret);
722 		return;
723 	}
724 
725 	mutex_lock(&priv->jack_lock);
726 
727 	regmap_read(cs42l43->regmap, CS42L43_TIP_RING_SENSE_INTERRUPT_STATUS, &sts);
728 
729 	dev_dbg(priv->dev, "Tip sense: 0x%x\n", sts);
730 
731 	tip = (sts >> CS42L43_TIPSENSE_PLUG_DB_STS_SHIFT) & CS42L43_JACK_PRESENT;
732 	ring = (sts >> CS42L43_RINGSENSE_PLUG_DB_STS_SHIFT) & CS42L43_JACK_PRESENT;
733 
734 	if (tip == CS42L43_JACK_PRESENT) {
735 		if (cs42l43->sdw && !priv->jack_present) {
736 			priv->jack_present = true;
737 			pm_runtime_get(priv->dev);
738 		}
739 
740 		if (priv->use_ring_sense && ring == CS42L43_JACK_ABSENT) {
741 			report = CS42L43_JACK_OPTICAL;
742 		} else {
743 			report = cs42l43_run_type_detect(priv);
744 			if (report < 0) {
745 				dev_err(priv->dev, "Jack detect failed: %d\n", report);
746 				goto error;
747 			}
748 		}
749 
750 		snd_soc_jack_report(priv->jack_hp, report, report);
751 	} else {
752 		priv->jack_override = 0;
753 
754 		cs42l43_clear_jack(priv);
755 
756 		if (cs42l43->sdw && priv->jack_present) {
757 			pm_runtime_put(priv->dev);
758 			priv->jack_present = false;
759 		}
760 	}
761 
762 error:
763 	mutex_unlock(&priv->jack_lock);
764 
765 	priv->suspend_jack_debounce = false;
766 
767 	pm_runtime_put_autosuspend(priv->dev);
768 }
769 
cs42l43_tip_sense(int irq,void * data)770 irqreturn_t cs42l43_tip_sense(int irq, void *data)
771 {
772 	struct cs42l43_codec *priv = data;
773 	unsigned int db_delay = priv->tip_debounce_ms;
774 
775 	cancel_delayed_work(&priv->bias_sense_timeout);
776 	cancel_delayed_work(&priv->tip_sense_work);
777 
778 	// Ensure delay after suspend is long enough to avoid false detection
779 	if (priv->suspend_jack_debounce)
780 		db_delay += priv->tip_fall_db_ms + priv->tip_rise_db_ms;
781 
782 	queue_delayed_work(system_long_wq, &priv->tip_sense_work,
783 			   msecs_to_jiffies(db_delay));
784 
785 	return IRQ_HANDLED;
786 }
787 
788 enum cs42l43_raw_jack {
789 	CS42L43_JACK_RAW_CTIA = 0,
790 	CS42L43_JACK_RAW_OMTP,
791 	CS42L43_JACK_RAW_HEADPHONE,
792 	CS42L43_JACK_RAW_LINE_OUT,
793 	CS42L43_JACK_RAW_LINE_IN,
794 	CS42L43_JACK_RAW_MICROPHONE,
795 	CS42L43_JACK_RAW_OPTICAL,
796 };
797 
798 #define CS42L43_JACK_3_POLE_SWITCHES ((0x2 << CS42L43_HSDET_MANUAL_MODE_SHIFT) | \
799 				      CS42L43_AMP3_4_GNDREF_HS3_SEL_MASK | \
800 				      CS42L43_AMP3_4_GNDREF_HS4_SEL_MASK | \
801 				      CS42L43_HSBIAS_GNDREF_HS3_SEL_MASK | \
802 				      CS42L43_HSBIAS_GNDREF_HS4_SEL_MASK | \
803 				      CS42L43_HSGND_HS3_SEL_MASK | \
804 				      CS42L43_HSGND_HS4_SEL_MASK)
805 
806 static const struct cs42l43_jack_override_mode {
807 	unsigned int hsdet_mode;
808 	unsigned int mic_ctrl;
809 	unsigned int clamp_ctrl;
810 	int report;
811 } cs42l43_jack_override_modes[] = {
812 	[CS42L43_JACK_RAW_CTIA] = {
813 		.hsdet_mode = CS42L43_AMP3_4_GNDREF_HS3_SEL_MASK |
814 			      CS42L43_HSBIAS_GNDREF_HS3_SEL_MASK |
815 			      CS42L43_HSBIAS_OUT_HS4_SEL_MASK |
816 			      CS42L43_HSGND_HS3_SEL_MASK,
817 		.clamp_ctrl = CS42L43_SMIC_HPAMP_CLAMP_DIS_FRC_MASK,
818 		.report = CS42L43_JACK_HEADSET,
819 	},
820 	[CS42L43_JACK_RAW_OMTP] = {
821 		.hsdet_mode = (0x1 << CS42L43_HSDET_MANUAL_MODE_SHIFT) |
822 			       CS42L43_AMP3_4_GNDREF_HS4_SEL_MASK |
823 			       CS42L43_HSBIAS_GNDREF_HS4_SEL_MASK |
824 			       CS42L43_HSBIAS_OUT_HS3_SEL_MASK |
825 			       CS42L43_HSGND_HS4_SEL_MASK,
826 		.clamp_ctrl = CS42L43_SMIC_HPAMP_CLAMP_DIS_FRC_MASK,
827 		.report = CS42L43_JACK_HEADSET,
828 	},
829 	[CS42L43_JACK_RAW_HEADPHONE] = {
830 		.hsdet_mode = CS42L43_JACK_3_POLE_SWITCHES,
831 		.clamp_ctrl = CS42L43_SMIC_HPAMP_CLAMP_DIS_FRC_MASK,
832 		.report = CS42L43_JACK_HEADPHONE,
833 	},
834 	[CS42L43_JACK_RAW_LINE_OUT] = {
835 		.hsdet_mode = CS42L43_JACK_3_POLE_SWITCHES,
836 		.clamp_ctrl = CS42L43_SMIC_HPAMP_CLAMP_DIS_FRC_MASK,
837 		.report = CS42L43_JACK_LINEOUT,
838 	},
839 	[CS42L43_JACK_RAW_LINE_IN] = {
840 		.hsdet_mode = CS42L43_JACK_3_POLE_SWITCHES,
841 		.mic_ctrl = 0x2 << CS42L43_JACK_STEREO_CONFIG_SHIFT,
842 		.report = CS42L43_JACK_LINEIN,
843 	},
844 	[CS42L43_JACK_RAW_MICROPHONE] = {
845 		.hsdet_mode = CS42L43_JACK_3_POLE_SWITCHES,
846 		.mic_ctrl = (0x3 << CS42L43_JACK_STEREO_CONFIG_SHIFT) |
847 			    CS42L43_HS1_BIAS_EN_MASK | CS42L43_HS2_BIAS_EN_MASK,
848 		.report = CS42L43_JACK_LINEIN,
849 	},
850 	[CS42L43_JACK_RAW_OPTICAL] = {
851 		.hsdet_mode = CS42L43_JACK_3_POLE_SWITCHES,
852 		.clamp_ctrl = CS42L43_SMIC_HPAMP_CLAMP_DIS_FRC_MASK,
853 		.report = CS42L43_JACK_OPTICAL,
854 	},
855 };
856 
857 static const char * const cs42l43_jack_text[] = {
858 	"None", "CTIA", "OMTP", "Headphone", "Line-Out",
859 	"Line-In", "Microphone", "Optical",
860 };
861 
862 static_assert(ARRAY_SIZE(cs42l43_jack_override_modes) ==
863 	      ARRAY_SIZE(cs42l43_jack_text) - 1);
864 
865 SOC_ENUM_SINGLE_VIRT_DECL(cs42l43_jack_enum, cs42l43_jack_text);
866 
cs42l43_jack_get(struct snd_kcontrol * kcontrol,struct snd_ctl_elem_value * ucontrol)867 int cs42l43_jack_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
868 {
869 	struct snd_soc_component *component = snd_soc_kcontrol_component(kcontrol);
870 	struct cs42l43_codec *priv = snd_soc_component_get_drvdata(component);
871 
872 	mutex_lock(&priv->jack_lock);
873 	ucontrol->value.integer.value[0] = priv->jack_override;
874 	mutex_unlock(&priv->jack_lock);
875 
876 	return 0;
877 }
878 
cs42l43_jack_put(struct snd_kcontrol * kcontrol,struct snd_ctl_elem_value * ucontrol)879 int cs42l43_jack_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
880 {
881 	struct snd_soc_component *component = snd_soc_kcontrol_component(kcontrol);
882 	struct cs42l43_codec *priv = snd_soc_component_get_drvdata(component);
883 	struct cs42l43 *cs42l43 = priv->core;
884 	struct soc_enum *e = (struct soc_enum *)kcontrol->private_value;
885 	unsigned int override = ucontrol->value.integer.value[0];
886 
887 	if (override >= e->items)
888 		return -EINVAL;
889 
890 	mutex_lock(&priv->jack_lock);
891 
892 	if (!cs42l43_jack_present(priv)) {
893 		mutex_unlock(&priv->jack_lock);
894 		return -EBUSY;
895 	}
896 
897 	if (override == priv->jack_override) {
898 		mutex_unlock(&priv->jack_lock);
899 		return 0;
900 	}
901 
902 	priv->jack_override = override;
903 
904 	cs42l43_clear_jack(priv);
905 
906 	if (!override) {
907 		queue_delayed_work(system_long_wq, &priv->tip_sense_work, 0);
908 	} else {
909 		override--;
910 
911 		regmap_update_bits(cs42l43->regmap, CS42L43_HS2,
912 				   CS42L43_HSDET_MODE_MASK |
913 				   CS42L43_HSDET_MANUAL_MODE_MASK |
914 				   CS42L43_AMP3_4_GNDREF_HS3_SEL_MASK |
915 				   CS42L43_AMP3_4_GNDREF_HS4_SEL_MASK |
916 				   CS42L43_HSBIAS_GNDREF_HS3_SEL_MASK |
917 				   CS42L43_HSBIAS_GNDREF_HS4_SEL_MASK |
918 				   CS42L43_HSBIAS_OUT_HS3_SEL_MASK |
919 				   CS42L43_HSBIAS_OUT_HS4_SEL_MASK |
920 				   CS42L43_HSGND_HS3_SEL_MASK |
921 				   CS42L43_HSGND_HS4_SEL_MASK,
922 				   cs42l43_jack_override_modes[override].hsdet_mode);
923 		regmap_update_bits(cs42l43->regmap, CS42L43_STEREO_MIC_CTRL,
924 				   CS42L43_HS2_BIAS_EN_MASK | CS42L43_HS1_BIAS_EN_MASK |
925 				   CS42L43_JACK_STEREO_CONFIG_MASK,
926 				   cs42l43_jack_override_modes[override].mic_ctrl);
927 		regmap_update_bits(cs42l43->regmap, CS42L43_STEREO_MIC_CLAMP_CTRL,
928 				   CS42L43_SMIC_HPAMP_CLAMP_DIS_FRC_MASK,
929 				   cs42l43_jack_override_modes[override].clamp_ctrl);
930 
931 		switch (override) {
932 		case CS42L43_JACK_RAW_CTIA:
933 		case CS42L43_JACK_RAW_OMTP:
934 			cs42l43_start_hs_bias(priv, false);
935 			cs42l43_start_button_detect(priv);
936 			break;
937 		case CS42L43_JACK_RAW_LINE_IN:
938 			regmap_update_bits(cs42l43->regmap, CS42L43_ADC_B_CTRL1,
939 					   CS42L43_PGA_WIDESWING_MODE_EN_MASK,
940 					   CS42L43_PGA_WIDESWING_MODE_EN_MASK);
941 			regmap_update_bits(cs42l43->regmap, CS42L43_ADC_B_CTRL2,
942 					   CS42L43_PGA_WIDESWING_MODE_EN_MASK,
943 					   CS42L43_PGA_WIDESWING_MODE_EN_MASK);
944 			break;
945 		case CS42L43_JACK_RAW_MICROPHONE:
946 			cs42l43_start_hs_bias(priv, false);
947 			break;
948 		default:
949 			break;
950 		}
951 
952 		snd_soc_jack_report(priv->jack_hp,
953 				    cs42l43_jack_override_modes[override].report,
954 				    cs42l43_jack_override_modes[override].report);
955 	}
956 
957 	mutex_unlock(&priv->jack_lock);
958 
959 	return 1;
960 }
961