rt711-sdca-sdw.c

  1// SPDX-License-Identifier: GPL-2.0-only
  2//
  3// rt711-sdw-sdca.c -- rt711 SDCA ALSA SoC audio driver
  4//
  5// Copyright(c) 2021 Realtek Semiconductor Corp.
  6//
  7//
  8
  9#include <linux/delay.h>
 10#include <linux/device.h>
 11#include <linux/mod_devicetable.h>
 12#include <linux/soundwire/sdw_registers.h>
 13#include <linux/module.h>
 14#include <linux/pm_runtime.h>
 15
 16#include "rt711-sdca.h"
 17#include "rt711-sdca-sdw.h"
 18
 19static bool rt711_sdca_readable_register(struct device *dev, unsigned int reg)
 20{
 21	switch (reg) {
 22	case 0x201a ... 0x2027:
 23	case 0x2029 ... 0x202a:
 24	case 0x202d ... 0x2034:
 25	case 0x2200 ... 0x2204:
 26	case 0x2206 ... 0x2212:
 27	case 0x2220 ... 0x2223:
 28	case 0x2230 ... 0x2239:
 29	case 0x2f01 ... 0x2f0f:
 30	case 0x2f30 ... 0x2f36:
 31	case 0x2f50 ... 0x2f5a:
 32	case 0x2f60:
 33	case 0x3200 ... 0x3212:
 34	case SDW_SDCA_CTL(FUNC_NUM_JACK_CODEC, RT711_SDCA_ENT_GE49, RT711_SDCA_CTL_SELECTED_MODE, 0):
 35	case SDW_SDCA_CTL(FUNC_NUM_JACK_CODEC, RT711_SDCA_ENT_GE49, RT711_SDCA_CTL_DETECTED_MODE, 0):
 36	case SDW_SDCA_CTL(FUNC_NUM_HID, RT711_SDCA_ENT_HID01, RT711_SDCA_CTL_HIDTX_CURRENT_OWNER, 0) ...
 37		SDW_SDCA_CTL(FUNC_NUM_HID, RT711_SDCA_ENT_HID01, RT711_SDCA_CTL_HIDTX_MESSAGE_LENGTH, 0):
 38	case RT711_BUF_ADDR_HID1 ... RT711_BUF_ADDR_HID2:
 39		return true;
 40	default:
 41		return false;
 42	}
 43}
 44
 45static bool rt711_sdca_volatile_register(struct device *dev, unsigned int reg)
 46{
 47	switch (reg) {
 48	case 0x201b:
 49	case 0x201c:
 50	case 0x201d:
 51	case 0x201f:
 52	case 0x2021:
 53	case 0x2023:
 54	case 0x2230:
 55	case 0x202d ... 0x202f: /* BRA */
 56	case 0x2200 ... 0x2212: /* i2c debug */
 57	case RT711_RC_CAL_STATUS:
 58	case SDW_SDCA_CTL(FUNC_NUM_JACK_CODEC, RT711_SDCA_ENT_GE49, RT711_SDCA_CTL_DETECTED_MODE, 0):
 59	case SDW_SDCA_CTL(FUNC_NUM_HID, RT711_SDCA_ENT_HID01, RT711_SDCA_CTL_HIDTX_CURRENT_OWNER, 0) ...
 60		SDW_SDCA_CTL(FUNC_NUM_HID, RT711_SDCA_ENT_HID01, RT711_SDCA_CTL_HIDTX_MESSAGE_LENGTH, 0):
 61	case RT711_BUF_ADDR_HID1 ... RT711_BUF_ADDR_HID2:
 62		return true;
 63	default:
 64		return false;
 65	}
 66}
 67
 68static bool rt711_sdca_mbq_readable_register(struct device *dev, unsigned int reg)
 69{
 70	switch (reg) {
 71	case 0x2000000 ... 0x20000ff:
 72	case 0x5600000 ... 0x56000ff:
 73	case 0x5700000 ... 0x57000ff:
 74	case 0x5800000 ... 0x58000ff:
 75	case 0x5900000 ... 0x59000ff:
 76	case 0x5b00000 ... 0x5b000ff:
 77	case 0x5f00000 ... 0x5f000ff:
 78	case 0x6100000 ... 0x61000ff:
 79	case SDW_SDCA_CTL(FUNC_NUM_JACK_CODEC, RT711_SDCA_ENT_USER_FU05, RT711_SDCA_CTL_FU_VOLUME, CH_L):
 80	case SDW_SDCA_CTL(FUNC_NUM_JACK_CODEC, RT711_SDCA_ENT_USER_FU05, RT711_SDCA_CTL_FU_VOLUME, CH_R):
 81	case SDW_SDCA_CTL(FUNC_NUM_MIC_ARRAY, RT711_SDCA_ENT_USER_FU1E, RT711_SDCA_CTL_FU_VOLUME, CH_L):
 82	case SDW_SDCA_CTL(FUNC_NUM_MIC_ARRAY, RT711_SDCA_ENT_USER_FU1E, RT711_SDCA_CTL_FU_VOLUME, CH_R):
 83	case SDW_SDCA_CTL(FUNC_NUM_JACK_CODEC, RT711_SDCA_ENT_USER_FU0F, RT711_SDCA_CTL_FU_VOLUME, CH_L):
 84	case SDW_SDCA_CTL(FUNC_NUM_JACK_CODEC, RT711_SDCA_ENT_USER_FU0F, RT711_SDCA_CTL_FU_VOLUME, CH_R):
 85	case SDW_SDCA_CTL(FUNC_NUM_JACK_CODEC, RT711_SDCA_ENT_PLATFORM_FU44, RT711_SDCA_CTL_FU_CH_GAIN, CH_L):
 86	case SDW_SDCA_CTL(FUNC_NUM_JACK_CODEC, RT711_SDCA_ENT_PLATFORM_FU44, RT711_SDCA_CTL_FU_CH_GAIN, CH_R):
 87	case SDW_SDCA_CTL(FUNC_NUM_MIC_ARRAY, RT711_SDCA_ENT_PLATFORM_FU15, RT711_SDCA_CTL_FU_CH_GAIN, CH_L):
 88	case SDW_SDCA_CTL(FUNC_NUM_MIC_ARRAY, RT711_SDCA_ENT_PLATFORM_FU15, RT711_SDCA_CTL_FU_CH_GAIN, CH_R):
 89		return true;
 90	default:
 91		return false;
 92	}
 93}
 94
 95static bool rt711_sdca_mbq_volatile_register(struct device *dev, unsigned int reg)
 96{
 97	switch (reg) {
 98	case 0x2000000:
 99	case 0x200001a:
100	case 0x2000046:
101	case 0x2000080:
102	case 0x2000081:
103	case 0x2000083:
104	case 0x5800000:
105	case 0x5800001:
106	case 0x5f00001:
107	case 0x6100008:
108		return true;
109	default:
110		return false;
111	}
112}
113
114static const struct regmap_config rt711_sdca_regmap = {
115	.reg_bits = 32,
116	.val_bits = 8,
117	.readable_reg = rt711_sdca_readable_register,
118	.volatile_reg = rt711_sdca_volatile_register,
119	.max_register = 0x44ffffff,
120	.reg_defaults = rt711_sdca_reg_defaults,
121	.num_reg_defaults = ARRAY_SIZE(rt711_sdca_reg_defaults),
122	.cache_type = REGCACHE_MAPLE,
123	.use_single_read = true,
124	.use_single_write = true,
125};
126
127static const struct regmap_config rt711_sdca_mbq_regmap = {
128	.name = "sdw-mbq",
129	.reg_bits = 32,
130	.val_bits = 16,
131	.readable_reg = rt711_sdca_mbq_readable_register,
132	.volatile_reg = rt711_sdca_mbq_volatile_register,
133	.max_register = 0x40800f12,
134	.reg_defaults = rt711_sdca_mbq_defaults,
135	.num_reg_defaults = ARRAY_SIZE(rt711_sdca_mbq_defaults),
136	.cache_type = REGCACHE_MAPLE,
137	.use_single_read = true,
138	.use_single_write = true,
139};
140
141static int rt711_sdca_update_status(struct sdw_slave *slave,
142				enum sdw_slave_status status)
143{
144	struct rt711_sdca_priv *rt711 = dev_get_drvdata(&slave->dev);
145
146	if (status == SDW_SLAVE_UNATTACHED)
147		rt711->hw_init = false;
148
149	if (status == SDW_SLAVE_ATTACHED) {
150		if (rt711->hs_jack) {
151			/*
152			 * Due to the SCP_SDCA_INTMASK will be cleared by any reset, and then
153			 * if the device attached again, we will need to set the setting back.
154			 * It could avoid losing the jack detection interrupt.
155			 * This also could sync with the cache value as the rt711_sdca_jack_init set.
156			 */
157			sdw_write_no_pm(rt711->slave, SDW_SCP_SDCA_INTMASK1,
158				SDW_SCP_SDCA_INTMASK_SDCA_0);
159			sdw_write_no_pm(rt711->slave, SDW_SCP_SDCA_INTMASK2,
160				SDW_SCP_SDCA_INTMASK_SDCA_8);
161		}
162	}
163
164	/*
165	 * Perform initialization only if slave status is present and
166	 * hw_init flag is false
167	 */
168	if (rt711->hw_init || status != SDW_SLAVE_ATTACHED)
169		return 0;
170
171	/* perform I/O transfers required for Slave initialization */
172	return rt711_sdca_io_init(&slave->dev, slave);
173}
174
175static int rt711_sdca_read_prop(struct sdw_slave *slave)
176{
177	struct sdw_slave_prop *prop = &slave->prop;
178	int nval;
179	int i, j;
180	u32 bit;
181	unsigned long addr;
182	struct sdw_dpn_prop *dpn;
183
184	prop->scp_int1_mask = SDW_SCP_INT1_BUS_CLASH | SDW_SCP_INT1_PARITY;
185	prop->quirks = SDW_SLAVE_QUIRKS_INVALID_INITIAL_PARITY;
186
187	prop->paging_support = true;
188
189	/* first we need to allocate memory for set bits in port lists */
190	prop->source_ports = 0x14; /* BITMAP: 00010100 */
191	prop->sink_ports = 0x8; /* BITMAP:  00001000 */
192
193	nval = hweight32(prop->source_ports);
194	prop->src_dpn_prop = devm_kcalloc(&slave->dev, nval,
195		sizeof(*prop->src_dpn_prop), GFP_KERNEL);
196	if (!prop->src_dpn_prop)
197		return -ENOMEM;
198
199	i = 0;
200	dpn = prop->src_dpn_prop;
201	addr = prop->source_ports;
202	for_each_set_bit(bit, &addr, 32) {
203		dpn[i].num = bit;
204		dpn[i].type = SDW_DPN_FULL;
205		dpn[i].simple_ch_prep_sm = true;
206		dpn[i].ch_prep_timeout = 10;
207		i++;
208	}
209
210	/* do this again for sink now */
211	nval = hweight32(prop->sink_ports);
212	prop->sink_dpn_prop = devm_kcalloc(&slave->dev, nval,
213		sizeof(*prop->sink_dpn_prop), GFP_KERNEL);
214	if (!prop->sink_dpn_prop)
215		return -ENOMEM;
216
217	j = 0;
218	dpn = prop->sink_dpn_prop;
219	addr = prop->sink_ports;
220	for_each_set_bit(bit, &addr, 32) {
221		dpn[j].num = bit;
222		dpn[j].type = SDW_DPN_FULL;
223		dpn[j].simple_ch_prep_sm = true;
224		dpn[j].ch_prep_timeout = 10;
225		j++;
226	}
227
228	prop->dp0_prop = devm_kzalloc(&slave->dev, sizeof(*prop->dp0_prop),
229				      GFP_KERNEL);
230	if (!prop->dp0_prop)
231		return -ENOMEM;
232
233	prop->dp0_prop->simple_ch_prep_sm = true;
234	prop->dp0_prop->ch_prep_timeout = 10;
235
236	/* set the timeout values */
237	prop->clk_stop_timeout = 700;
238
239	/* wake-up event */
240	prop->wake_capable = 1;
241
242	return 0;
243}
244
245static int rt711_sdca_interrupt_callback(struct sdw_slave *slave,
246					struct sdw_slave_intr_status *status)
247{
248	struct rt711_sdca_priv *rt711 = dev_get_drvdata(&slave->dev);
249	int ret, stat;
250	int count = 0, retry = 3;
251	unsigned int sdca_cascade, scp_sdca_stat1, scp_sdca_stat2 = 0;
252
253	dev_dbg(&slave->dev,
254		"%s control_port_stat=%x, sdca_cascade=%x", __func__,
255		status->control_port, status->sdca_cascade);
256
257	if (cancel_delayed_work_sync(&rt711->jack_detect_work)) {
258		dev_warn(&slave->dev, "%s the pending delayed_work was cancelled", __func__);
259		/* avoid the HID owner doesn't change to device */
260		if (rt711->scp_sdca_stat2)
261			scp_sdca_stat2 = rt711->scp_sdca_stat2;
262	}
263
264	/*
265	 * The critical section below intentionally protects a rather large piece of code.
266	 * We don't want to allow the system suspend to disable an interrupt while we are
267	 * processing it, which could be problematic given the quirky SoundWire interrupt
268	 * scheme. We do want however to prevent new workqueues from being scheduled if
269	 * the disable_irq flag was set during system suspend.
270	 */
271	mutex_lock(&rt711->disable_irq_lock);
272
273	ret = sdw_read_no_pm(rt711->slave, SDW_SCP_SDCA_INT1);
274	if (ret < 0)
275		goto io_error;
276	rt711->scp_sdca_stat1 = ret;
277	ret = sdw_read_no_pm(rt711->slave, SDW_SCP_SDCA_INT2);
278	if (ret < 0)
279		goto io_error;
280	rt711->scp_sdca_stat2 = ret;
281	if (scp_sdca_stat2)
282		rt711->scp_sdca_stat2 |= scp_sdca_stat2;
283
284	do {
285		/* clear flag */
286		ret = sdw_read_no_pm(rt711->slave, SDW_SCP_SDCA_INT1);
287		if (ret < 0)
288			goto io_error;
289		if (ret & SDW_SCP_SDCA_INTMASK_SDCA_0) {
290			ret = sdw_write_no_pm(rt711->slave, SDW_SCP_SDCA_INT1,
291						SDW_SCP_SDCA_INTMASK_SDCA_0);
292			if (ret < 0)
293				goto io_error;
294		}
295		ret = sdw_read_no_pm(rt711->slave, SDW_SCP_SDCA_INT2);
296		if (ret < 0)
297			goto io_error;
298		if (ret & SDW_SCP_SDCA_INTMASK_SDCA_8) {
299			ret = sdw_write_no_pm(rt711->slave, SDW_SCP_SDCA_INT2,
300						SDW_SCP_SDCA_INTMASK_SDCA_8);
301			if (ret < 0)
302				goto io_error;
303		}
304
305		/* check if flag clear or not */
306		ret = sdw_read_no_pm(rt711->slave, SDW_DP0_INT);
307		if (ret < 0)
308			goto io_error;
309		sdca_cascade = ret & SDW_DP0_SDCA_CASCADE;
310
311		ret = sdw_read_no_pm(rt711->slave, SDW_SCP_SDCA_INT1);
312		if (ret < 0)
313			goto io_error;
314		scp_sdca_stat1 = ret & SDW_SCP_SDCA_INTMASK_SDCA_0;
315
316		ret = sdw_read_no_pm(rt711->slave, SDW_SCP_SDCA_INT2);
317		if (ret < 0)
318			goto io_error;
319		scp_sdca_stat2 = ret & SDW_SCP_SDCA_INTMASK_SDCA_8;
320
321		stat = scp_sdca_stat1 || scp_sdca_stat2 || sdca_cascade;
322
323		count++;
324	} while (stat != 0 && count < retry);
325
326	if (stat)
327		dev_warn(&slave->dev,
328			"%s scp_sdca_stat1=0x%x, scp_sdca_stat2=0x%x\n", __func__,
329			rt711->scp_sdca_stat1, rt711->scp_sdca_stat2);
330
331	if (status->sdca_cascade && !rt711->disable_irq)
332		mod_delayed_work(system_power_efficient_wq,
333			&rt711->jack_detect_work, msecs_to_jiffies(30));
334
335	mutex_unlock(&rt711->disable_irq_lock);
336
337	return 0;
338
339io_error:
340	mutex_unlock(&rt711->disable_irq_lock);
341	pr_err_ratelimited("IO error in %s, ret %d\n", __func__, ret);
342	return ret;
343}
344
345static const struct sdw_slave_ops rt711_sdca_slave_ops = {
346	.read_prop = rt711_sdca_read_prop,
347	.interrupt_callback = rt711_sdca_interrupt_callback,
348	.update_status = rt711_sdca_update_status,
349};
350
351static int rt711_sdca_sdw_probe(struct sdw_slave *slave,
352				const struct sdw_device_id *id)
353{
354	struct regmap *regmap, *mbq_regmap;
355
356	/* Regmap Initialization */
357	mbq_regmap = devm_regmap_init_sdw_mbq(slave, &rt711_sdca_mbq_regmap);
358	if (IS_ERR(mbq_regmap))
359		return PTR_ERR(mbq_regmap);
360
361	regmap = devm_regmap_init_sdw(slave, &rt711_sdca_regmap);
362	if (IS_ERR(regmap))
363		return PTR_ERR(regmap);
364
365	return rt711_sdca_init(&slave->dev, regmap, mbq_regmap, slave);
366}
367
368static int rt711_sdca_sdw_remove(struct sdw_slave *slave)
369{
370	struct rt711_sdca_priv *rt711 = dev_get_drvdata(&slave->dev);
371
372	if (rt711->hw_init) {
373		cancel_delayed_work_sync(&rt711->jack_detect_work);
374		cancel_delayed_work_sync(&rt711->jack_btn_check_work);
375	}
376
377	pm_runtime_disable(&slave->dev);
378
379	mutex_destroy(&rt711->calibrate_mutex);
380	mutex_destroy(&rt711->disable_irq_lock);
381
382	return 0;
383}
384
385static const struct sdw_device_id rt711_sdca_id[] = {
386	SDW_SLAVE_ENTRY_EXT(0x025d, 0x711, 0x3, 0x1, 0),
387	{},
388};
389MODULE_DEVICE_TABLE(sdw, rt711_sdca_id);
390
391static int rt711_sdca_dev_suspend(struct device *dev)
392{
393	struct rt711_sdca_priv *rt711 = dev_get_drvdata(dev);
394
395	if (!rt711->hw_init)
396		return 0;
397
398	cancel_delayed_work_sync(&rt711->jack_detect_work);
399	cancel_delayed_work_sync(&rt711->jack_btn_check_work);
400
401	regcache_cache_only(rt711->regmap, true);
402	regcache_cache_only(rt711->mbq_regmap, true);
403
404	return 0;
405}
406
407static int rt711_sdca_dev_system_suspend(struct device *dev)
408{
409	struct rt711_sdca_priv *rt711_sdca = dev_get_drvdata(dev);
410	struct sdw_slave *slave = dev_to_sdw_dev(dev);
411	int ret1, ret2;
412
413	if (!rt711_sdca->hw_init)
414		return 0;
415
416	/*
417	 * prevent new interrupts from being handled after the
418	 * deferred work completes and before the parent disables
419	 * interrupts on the link
420	 */
421	mutex_lock(&rt711_sdca->disable_irq_lock);
422	rt711_sdca->disable_irq = true;
423	ret1 = sdw_update_no_pm(slave, SDW_SCP_SDCA_INTMASK1,
424				SDW_SCP_SDCA_INTMASK_SDCA_0, 0);
425	ret2 = sdw_update_no_pm(slave, SDW_SCP_SDCA_INTMASK2,
426				SDW_SCP_SDCA_INTMASK_SDCA_8, 0);
427	mutex_unlock(&rt711_sdca->disable_irq_lock);
428
429	if (ret1 < 0 || ret2 < 0) {
430		/* log but don't prevent suspend from happening */
431		dev_dbg(&slave->dev, "%s: could not disable SDCA interrupts\n:", __func__);
432	}
433
434	return rt711_sdca_dev_suspend(dev);
435}
436
437#define RT711_PROBE_TIMEOUT 5000
438
439static int rt711_sdca_dev_resume(struct device *dev)
440{
441	struct sdw_slave *slave = dev_to_sdw_dev(dev);
442	struct rt711_sdca_priv *rt711 = dev_get_drvdata(dev);
443	unsigned long time;
444
445	if (!rt711->first_hw_init)
446		return 0;
447
448	if (!slave->unattach_request) {
449		mutex_lock(&rt711->disable_irq_lock);
450		if (rt711->disable_irq == true) {
451			sdw_write_no_pm(slave, SDW_SCP_SDCA_INTMASK1, SDW_SCP_SDCA_INTMASK_SDCA_0);
452			sdw_write_no_pm(slave, SDW_SCP_SDCA_INTMASK2, SDW_SCP_SDCA_INTMASK_SDCA_8);
453			rt711->disable_irq = false;
454		}
455		mutex_unlock(&rt711->disable_irq_lock);
456		goto regmap_sync;
457	}
458
459	time = wait_for_completion_timeout(&slave->initialization_complete,
460				msecs_to_jiffies(RT711_PROBE_TIMEOUT));
461	if (!time) {
462		dev_err(&slave->dev, "%s: Initialization not complete, timed out\n", __func__);
463		sdw_show_ping_status(slave->bus, true);
464
465		return -ETIMEDOUT;
466	}
467
468regmap_sync:
469	slave->unattach_request = 0;
470	regcache_cache_only(rt711->regmap, false);
471	regcache_sync(rt711->regmap);
472	regcache_cache_only(rt711->mbq_regmap, false);
473	regcache_sync(rt711->mbq_regmap);
474	return 0;
475}
476
477static const struct dev_pm_ops rt711_sdca_pm = {
478	SYSTEM_SLEEP_PM_OPS(rt711_sdca_dev_system_suspend, rt711_sdca_dev_resume)
479	RUNTIME_PM_OPS(rt711_sdca_dev_suspend, rt711_sdca_dev_resume, NULL)
480};
481
482static struct sdw_driver rt711_sdca_sdw_driver = {
483	.driver = {
484		.name = "rt711-sdca",
485		.pm = pm_ptr(&rt711_sdca_pm),
486	},
487	.probe = rt711_sdca_sdw_probe,
488	.remove = rt711_sdca_sdw_remove,
489	.ops = &rt711_sdca_slave_ops,
490	.id_table = rt711_sdca_id,
491};
492module_sdw_driver(rt711_sdca_sdw_driver);
493
494MODULE_DESCRIPTION("ASoC RT711 SDCA SDW driver");
495MODULE_AUTHOR("Shuming Fan <shumingf@realtek.com>");
496MODULE_LICENSE("GPL");