1 // SPDX-License-Identifier: GPL-2.0-only
2 //
3 // rt722-sdca-sdw.c -- rt722 SDCA ALSA SoC audio driver
4 //
5 // Copyright(c) 2023 Realtek Semiconductor Corp.
6 //
7 //
8
9 #include <linux/delay.h>
10 #include <linux/device.h>
11 #include <linux/module.h>
12 #include <linux/mod_devicetable.h>
13 #include <linux/pm_runtime.h>
14 #include <linux/soundwire/sdw_registers.h>
15
16 #include "rt722-sdca.h"
17 #include "rt722-sdca-sdw.h"
18
rt722_sdca_readable_register(struct device * dev,unsigned int reg)19 static bool rt722_sdca_readable_register(struct device *dev, unsigned int reg)
20 {
21 switch (reg) {
22 case 0x2f01 ... 0x2f0a:
23 case 0x2f35 ... 0x2f36:
24 case 0x2f50:
25 case 0x2f54:
26 case 0x2f58 ... 0x2f5d:
27 case SDW_SDCA_CTL(FUNC_NUM_JACK_CODEC, RT722_SDCA_ENT_GE49, RT722_SDCA_CTL_SELECTED_MODE,
28 0):
29 case SDW_SDCA_CTL(FUNC_NUM_JACK_CODEC, RT722_SDCA_ENT_GE49, RT722_SDCA_CTL_DETECTED_MODE,
30 0):
31 case SDW_SDCA_CTL(FUNC_NUM_HID, RT722_SDCA_ENT_HID01, RT722_SDCA_CTL_HIDTX_CURRENT_OWNER,
32 0) ... SDW_SDCA_CTL(FUNC_NUM_HID, RT722_SDCA_ENT_HID01,
33 RT722_SDCA_CTL_HIDTX_MESSAGE_LENGTH, 0):
34 case RT722_BUF_ADDR_HID1 ... RT722_BUF_ADDR_HID2:
35 return true;
36 default:
37 return false;
38 }
39 }
40
rt722_sdca_volatile_register(struct device * dev,unsigned int reg)41 static bool rt722_sdca_volatile_register(struct device *dev, unsigned int reg)
42 {
43 switch (reg) {
44 case 0x2f01:
45 case 0x2f54:
46 case SDW_SDCA_CTL(FUNC_NUM_JACK_CODEC, RT722_SDCA_ENT_GE49, RT722_SDCA_CTL_DETECTED_MODE,
47 0):
48 case SDW_SDCA_CTL(FUNC_NUM_HID, RT722_SDCA_ENT_HID01, RT722_SDCA_CTL_HIDTX_CURRENT_OWNER,
49 0) ... SDW_SDCA_CTL(FUNC_NUM_HID, RT722_SDCA_ENT_HID01,
50 RT722_SDCA_CTL_HIDTX_MESSAGE_LENGTH, 0):
51 case RT722_BUF_ADDR_HID1 ... RT722_BUF_ADDR_HID2:
52 return true;
53 default:
54 return false;
55 }
56 }
57
rt722_sdca_mbq_readable_register(struct device * dev,unsigned int reg)58 static bool rt722_sdca_mbq_readable_register(struct device *dev, unsigned int reg)
59 {
60 switch (reg) {
61 case 0x2000000 ... 0x2000024:
62 case 0x2000029 ... 0x200004a:
63 case 0x2000051 ... 0x2000052:
64 case 0x200005a ... 0x200005b:
65 case 0x2000061 ... 0x2000069:
66 case 0x200006b:
67 case 0x2000070:
68 case 0x200007f:
69 case 0x2000082 ... 0x200008e:
70 case 0x2000090 ... 0x2000094:
71 case 0x3110000:
72 case 0x5300000 ... 0x5300002:
73 case 0x5400002:
74 case 0x5600000 ... 0x5600007:
75 case 0x5700000 ... 0x5700004:
76 case 0x5800000 ... 0x5800004:
77 case 0x5b00003:
78 case 0x5c00011:
79 case 0x5d00006:
80 case 0x5f00000 ... 0x5f0000d:
81 case 0x5f00030:
82 case 0x6100000 ... 0x6100051:
83 case 0x6100055 ... 0x6100057:
84 case 0x6100062:
85 case 0x6100064 ... 0x6100065:
86 case 0x6100067:
87 case 0x6100070 ... 0x610007c:
88 case 0x6100080:
89 case SDW_SDCA_CTL(FUNC_NUM_MIC_ARRAY, RT722_SDCA_ENT_FU15, RT722_SDCA_CTL_FU_CH_GAIN,
90 CH_01) ...
91 SDW_SDCA_CTL(FUNC_NUM_MIC_ARRAY, RT722_SDCA_ENT_FU15, RT722_SDCA_CTL_FU_CH_GAIN,
92 CH_04):
93 case SDW_SDCA_CTL(FUNC_NUM_MIC_ARRAY, RT722_SDCA_ENT_USER_FU1E, RT722_SDCA_CTL_FU_VOLUME,
94 CH_01):
95 case SDW_SDCA_CTL(FUNC_NUM_MIC_ARRAY, RT722_SDCA_ENT_USER_FU1E, RT722_SDCA_CTL_FU_VOLUME,
96 CH_02):
97 case SDW_SDCA_CTL(FUNC_NUM_MIC_ARRAY, RT722_SDCA_ENT_USER_FU1E, RT722_SDCA_CTL_FU_VOLUME,
98 CH_03):
99 case SDW_SDCA_CTL(FUNC_NUM_MIC_ARRAY, RT722_SDCA_ENT_USER_FU1E, RT722_SDCA_CTL_FU_VOLUME,
100 CH_04):
101 case SDW_SDCA_CTL(FUNC_NUM_AMP, RT722_SDCA_ENT_USER_FU06, RT722_SDCA_CTL_FU_VOLUME, CH_L):
102 case SDW_SDCA_CTL(FUNC_NUM_AMP, RT722_SDCA_ENT_USER_FU06, RT722_SDCA_CTL_FU_VOLUME, CH_R):
103 case SDW_SDCA_CTL(FUNC_NUM_JACK_CODEC, RT722_SDCA_ENT_USER_FU05, RT722_SDCA_CTL_FU_VOLUME,
104 CH_L):
105 case SDW_SDCA_CTL(FUNC_NUM_JACK_CODEC, RT722_SDCA_ENT_USER_FU05, RT722_SDCA_CTL_FU_VOLUME,
106 CH_R):
107 case SDW_SDCA_CTL(FUNC_NUM_JACK_CODEC, RT722_SDCA_ENT_USER_FU0F, RT722_SDCA_CTL_FU_VOLUME,
108 CH_L):
109 case SDW_SDCA_CTL(FUNC_NUM_JACK_CODEC, RT722_SDCA_ENT_USER_FU0F, RT722_SDCA_CTL_FU_VOLUME,
110 CH_R):
111 case SDW_SDCA_CTL(FUNC_NUM_JACK_CODEC, RT722_SDCA_ENT_PLATFORM_FU44,
112 RT722_SDCA_CTL_FU_CH_GAIN, CH_L):
113 case SDW_SDCA_CTL(FUNC_NUM_JACK_CODEC, RT722_SDCA_ENT_PLATFORM_FU44,
114 RT722_SDCA_CTL_FU_CH_GAIN, CH_R):
115 return true;
116 default:
117 return false;
118 }
119 }
120
rt722_sdca_mbq_volatile_register(struct device * dev,unsigned int reg)121 static bool rt722_sdca_mbq_volatile_register(struct device *dev, unsigned int reg)
122 {
123 switch (reg) {
124 case 0x2000000:
125 case 0x200000d:
126 case 0x2000019:
127 case 0x2000020:
128 case 0x2000030:
129 case 0x2000046:
130 case 0x2000067:
131 case 0x2000084:
132 case 0x2000086:
133 case 0x3110000:
134 return true;
135 default:
136 return false;
137 }
138 }
139
140 static const struct regmap_config rt722_sdca_regmap = {
141 .reg_bits = 32,
142 .val_bits = 8,
143 .readable_reg = rt722_sdca_readable_register,
144 .volatile_reg = rt722_sdca_volatile_register,
145 .max_register = 0x44ffffff,
146 .reg_defaults = rt722_sdca_reg_defaults,
147 .num_reg_defaults = ARRAY_SIZE(rt722_sdca_reg_defaults),
148 .cache_type = REGCACHE_MAPLE,
149 .use_single_read = true,
150 .use_single_write = true,
151 };
152
153 static const struct regmap_config rt722_sdca_mbq_regmap = {
154 .name = "sdw-mbq",
155 .reg_bits = 32,
156 .val_bits = 16,
157 .readable_reg = rt722_sdca_mbq_readable_register,
158 .volatile_reg = rt722_sdca_mbq_volatile_register,
159 .max_register = 0x41000312,
160 .reg_defaults = rt722_sdca_mbq_defaults,
161 .num_reg_defaults = ARRAY_SIZE(rt722_sdca_mbq_defaults),
162 .cache_type = REGCACHE_MAPLE,
163 .use_single_read = true,
164 .use_single_write = true,
165 };
166
rt722_sdca_update_status(struct sdw_slave * slave,enum sdw_slave_status status)167 static int rt722_sdca_update_status(struct sdw_slave *slave,
168 enum sdw_slave_status status)
169 {
170 struct rt722_sdca_priv *rt722 = dev_get_drvdata(&slave->dev);
171
172 if (status == SDW_SLAVE_UNATTACHED)
173 rt722->hw_init = false;
174
175 if (status == SDW_SLAVE_ATTACHED) {
176 if (rt722->hs_jack) {
177 /*
178 * Due to the SCP_SDCA_INTMASK will be cleared by any reset, and then
179 * if the device attached again, we will need to set the setting back.
180 * It could avoid losing the jack detection interrupt.
181 * This also could sync with the cache value as the rt722_sdca_jack_init set.
182 */
183 sdw_write_no_pm(rt722->slave, SDW_SCP_SDCA_INTMASK1,
184 SDW_SCP_SDCA_INTMASK_SDCA_0);
185 sdw_write_no_pm(rt722->slave, SDW_SCP_SDCA_INTMASK2,
186 SDW_SCP_SDCA_INTMASK_SDCA_8);
187 }
188 }
189
190 /*
191 * Perform initialization only if slave status is present and
192 * hw_init flag is false
193 */
194 if (rt722->hw_init || status != SDW_SLAVE_ATTACHED)
195 return 0;
196
197 /* perform I/O transfers required for Slave initialization */
198 return rt722_sdca_io_init(&slave->dev, slave);
199 }
200
rt722_sdca_read_prop(struct sdw_slave * slave)201 static int rt722_sdca_read_prop(struct sdw_slave *slave)
202 {
203 struct sdw_slave_prop *prop = &slave->prop;
204 int nval;
205 int i, j;
206 u32 bit;
207 unsigned long addr;
208 struct sdw_dpn_prop *dpn;
209
210 prop->scp_int1_mask = SDW_SCP_INT1_BUS_CLASH | SDW_SCP_INT1_PARITY;
211 prop->quirks = SDW_SLAVE_QUIRKS_INVALID_INITIAL_PARITY;
212
213 prop->paging_support = true;
214
215 /*
216 * port = 1 for headphone playback
217 * port = 2 for headset-mic capture
218 * port = 3 for speaker playback
219 * port = 6 for digital-mic capture
220 */
221 prop->source_ports = BIT(6) | BIT(2); /* BITMAP: 01000100 */
222 prop->sink_ports = BIT(3) | BIT(1); /* BITMAP: 00001010 */
223
224 nval = hweight32(prop->source_ports);
225 prop->src_dpn_prop = devm_kcalloc(&slave->dev, nval,
226 sizeof(*prop->src_dpn_prop), GFP_KERNEL);
227 if (!prop->src_dpn_prop)
228 return -ENOMEM;
229
230 i = 0;
231 dpn = prop->src_dpn_prop;
232 addr = prop->source_ports;
233 for_each_set_bit(bit, &addr, 32) {
234 dpn[i].num = bit;
235 dpn[i].type = SDW_DPN_FULL;
236 dpn[i].simple_ch_prep_sm = true;
237 dpn[i].ch_prep_timeout = 10;
238 i++;
239 }
240
241 /* do this again for sink now */
242 nval = hweight32(prop->sink_ports);
243 prop->sink_dpn_prop = devm_kcalloc(&slave->dev, nval,
244 sizeof(*prop->sink_dpn_prop), GFP_KERNEL);
245 if (!prop->sink_dpn_prop)
246 return -ENOMEM;
247
248 j = 0;
249 dpn = prop->sink_dpn_prop;
250 addr = prop->sink_ports;
251 for_each_set_bit(bit, &addr, 32) {
252 dpn[j].num = bit;
253 dpn[j].type = SDW_DPN_FULL;
254 dpn[j].simple_ch_prep_sm = true;
255 dpn[j].ch_prep_timeout = 10;
256 j++;
257 }
258
259 /* set the timeout values */
260 prop->clk_stop_timeout = 900;
261
262 /* wake-up event */
263 prop->wake_capable = 1;
264
265 /* Three data lanes are supported by rt722-sdca codec */
266 prop->lane_control_support = true;
267
268 return 0;
269 }
270
rt722_sdca_interrupt_callback(struct sdw_slave * slave,struct sdw_slave_intr_status * status)271 static int rt722_sdca_interrupt_callback(struct sdw_slave *slave,
272 struct sdw_slave_intr_status *status)
273 {
274 struct rt722_sdca_priv *rt722 = dev_get_drvdata(&slave->dev);
275 int ret, stat;
276 int count = 0, retry = 3;
277 unsigned int sdca_cascade, scp_sdca_stat1, scp_sdca_stat2 = 0;
278
279 if (cancel_delayed_work_sync(&rt722->jack_detect_work)) {
280 dev_warn(&slave->dev, "%s the pending delayed_work was cancelled", __func__);
281 /* avoid the HID owner doesn't change to device */
282 if (rt722->scp_sdca_stat2)
283 scp_sdca_stat2 = rt722->scp_sdca_stat2;
284 }
285
286 /*
287 * The critical section below intentionally protects a rather large piece of code.
288 * We don't want to allow the system suspend to disable an interrupt while we are
289 * processing it, which could be problematic given the quirky SoundWire interrupt
290 * scheme. We do want however to prevent new workqueues from being scheduled if
291 * the disable_irq flag was set during system suspend.
292 */
293 mutex_lock(&rt722->disable_irq_lock);
294
295 ret = sdw_read_no_pm(rt722->slave, SDW_SCP_SDCA_INT1);
296 if (ret < 0)
297 goto io_error;
298 rt722->scp_sdca_stat1 = ret;
299 ret = sdw_read_no_pm(rt722->slave, SDW_SCP_SDCA_INT2);
300 if (ret < 0)
301 goto io_error;
302 rt722->scp_sdca_stat2 = ret;
303 if (scp_sdca_stat2)
304 rt722->scp_sdca_stat2 |= scp_sdca_stat2;
305 do {
306 /* clear flag */
307 ret = sdw_read_no_pm(rt722->slave, SDW_SCP_SDCA_INT1);
308 if (ret < 0)
309 goto io_error;
310 if (ret & SDW_SCP_SDCA_INTMASK_SDCA_0) {
311 ret = sdw_update_no_pm(rt722->slave, SDW_SCP_SDCA_INT1,
312 SDW_SCP_SDCA_INT_SDCA_0, SDW_SCP_SDCA_INT_SDCA_0);
313 if (ret < 0)
314 goto io_error;
315 }
316
317 ret = sdw_read_no_pm(rt722->slave, SDW_SCP_SDCA_INT2);
318 if (ret < 0)
319 goto io_error;
320 if (ret & SDW_SCP_SDCA_INTMASK_SDCA_8) {
321 ret = sdw_write_no_pm(rt722->slave, SDW_SCP_SDCA_INT2,
322 SDW_SCP_SDCA_INTMASK_SDCA_8);
323 if (ret < 0)
324 goto io_error;
325 }
326
327 /* check if flag clear or not */
328 ret = sdw_read_no_pm(rt722->slave, SDW_DP0_INT);
329 if (ret < 0)
330 goto io_error;
331 sdca_cascade = ret & SDW_DP0_SDCA_CASCADE;
332
333 ret = sdw_read_no_pm(rt722->slave, SDW_SCP_SDCA_INT1);
334 if (ret < 0)
335 goto io_error;
336 scp_sdca_stat1 = ret & SDW_SCP_SDCA_INTMASK_SDCA_0;
337
338 ret = sdw_read_no_pm(rt722->slave, SDW_SCP_SDCA_INT2);
339 if (ret < 0)
340 goto io_error;
341 scp_sdca_stat2 = ret & SDW_SCP_SDCA_INTMASK_SDCA_8;
342
343 stat = scp_sdca_stat1 || scp_sdca_stat2 || sdca_cascade;
344
345 count++;
346 } while (stat != 0 && count < retry);
347
348 if (stat)
349 dev_warn(&slave->dev,
350 "%s scp_sdca_stat1=0x%x, scp_sdca_stat2=0x%x\n", __func__,
351 rt722->scp_sdca_stat1, rt722->scp_sdca_stat2);
352
353 if (status->sdca_cascade && !rt722->disable_irq)
354 mod_delayed_work(system_power_efficient_wq,
355 &rt722->jack_detect_work, msecs_to_jiffies(280));
356
357 mutex_unlock(&rt722->disable_irq_lock);
358
359 return 0;
360
361 io_error:
362 mutex_unlock(&rt722->disable_irq_lock);
363 pr_err_ratelimited("IO error in %s, ret %d\n", __func__, ret);
364 return ret;
365 }
366
367 static const struct sdw_slave_ops rt722_sdca_slave_ops = {
368 .read_prop = rt722_sdca_read_prop,
369 .interrupt_callback = rt722_sdca_interrupt_callback,
370 .update_status = rt722_sdca_update_status,
371 };
372
rt722_sdca_sdw_probe(struct sdw_slave * slave,const struct sdw_device_id * id)373 static int rt722_sdca_sdw_probe(struct sdw_slave *slave,
374 const struct sdw_device_id *id)
375 {
376 struct regmap *regmap, *mbq_regmap;
377
378 /* Regmap Initialization */
379 mbq_regmap = devm_regmap_init_sdw_mbq(slave, &rt722_sdca_mbq_regmap);
380 if (IS_ERR(mbq_regmap))
381 return PTR_ERR(mbq_regmap);
382
383 regmap = devm_regmap_init_sdw(slave, &rt722_sdca_regmap);
384 if (IS_ERR(regmap))
385 return PTR_ERR(regmap);
386
387 return rt722_sdca_init(&slave->dev, regmap, mbq_regmap, slave);
388 }
389
rt722_sdca_sdw_remove(struct sdw_slave * slave)390 static int rt722_sdca_sdw_remove(struct sdw_slave *slave)
391 {
392 struct rt722_sdca_priv *rt722 = dev_get_drvdata(&slave->dev);
393
394 if (rt722->hw_init) {
395 cancel_delayed_work_sync(&rt722->jack_detect_work);
396 cancel_delayed_work_sync(&rt722->jack_btn_check_work);
397 }
398
399 if (rt722->first_hw_init)
400 pm_runtime_disable(&slave->dev);
401
402 mutex_destroy(&rt722->calibrate_mutex);
403 mutex_destroy(&rt722->disable_irq_lock);
404
405 return 0;
406 }
407
408 static const struct sdw_device_id rt722_sdca_id[] = {
409 SDW_SLAVE_ENTRY_EXT(0x025d, 0x722, 0x3, 0x1, 0),
410 {},
411 };
412 MODULE_DEVICE_TABLE(sdw, rt722_sdca_id);
413
rt722_sdca_dev_suspend(struct device * dev)414 static int __maybe_unused rt722_sdca_dev_suspend(struct device *dev)
415 {
416 struct rt722_sdca_priv *rt722 = dev_get_drvdata(dev);
417
418 if (!rt722->hw_init)
419 return 0;
420
421 cancel_delayed_work_sync(&rt722->jack_detect_work);
422 cancel_delayed_work_sync(&rt722->jack_btn_check_work);
423
424 regcache_cache_only(rt722->regmap, true);
425 regcache_cache_only(rt722->mbq_regmap, true);
426
427 return 0;
428 }
429
rt722_sdca_dev_system_suspend(struct device * dev)430 static int __maybe_unused rt722_sdca_dev_system_suspend(struct device *dev)
431 {
432 struct rt722_sdca_priv *rt722_sdca = dev_get_drvdata(dev);
433 struct sdw_slave *slave = dev_to_sdw_dev(dev);
434 int ret1, ret2;
435
436 if (!rt722_sdca->hw_init)
437 return 0;
438
439 /*
440 * prevent new interrupts from being handled after the
441 * deferred work completes and before the parent disables
442 * interrupts on the link
443 */
444 mutex_lock(&rt722_sdca->disable_irq_lock);
445 rt722_sdca->disable_irq = true;
446 ret1 = sdw_update_no_pm(slave, SDW_SCP_SDCA_INTMASK1,
447 SDW_SCP_SDCA_INTMASK_SDCA_0, 0);
448 ret2 = sdw_update_no_pm(slave, SDW_SCP_SDCA_INTMASK2,
449 SDW_SCP_SDCA_INTMASK_SDCA_8, 0);
450 mutex_unlock(&rt722_sdca->disable_irq_lock);
451
452 if (ret1 < 0 || ret2 < 0) {
453 /* log but don't prevent suspend from happening */
454 dev_dbg(&slave->dev, "%s: could not disable SDCA interrupts\n:", __func__);
455 }
456
457 return rt722_sdca_dev_suspend(dev);
458 }
459
460 #define RT722_PROBE_TIMEOUT 5000
461
rt722_sdca_dev_resume(struct device * dev)462 static int __maybe_unused rt722_sdca_dev_resume(struct device *dev)
463 {
464 struct sdw_slave *slave = dev_to_sdw_dev(dev);
465 struct rt722_sdca_priv *rt722 = dev_get_drvdata(dev);
466 unsigned long time;
467
468 if (!rt722->first_hw_init)
469 return 0;
470
471 if (!slave->unattach_request) {
472 mutex_lock(&rt722->disable_irq_lock);
473 if (rt722->disable_irq == true) {
474 sdw_write_no_pm(slave, SDW_SCP_SDCA_INTMASK1, SDW_SCP_SDCA_INTMASK_SDCA_0);
475 sdw_write_no_pm(slave, SDW_SCP_SDCA_INTMASK2, SDW_SCP_SDCA_INTMASK_SDCA_8);
476 rt722->disable_irq = false;
477 }
478 mutex_unlock(&rt722->disable_irq_lock);
479 goto regmap_sync;
480 }
481
482 time = wait_for_completion_timeout(&slave->initialization_complete,
483 msecs_to_jiffies(RT722_PROBE_TIMEOUT));
484 if (!time) {
485 dev_err(&slave->dev, "Initialization not complete, timed out\n");
486 sdw_show_ping_status(slave->bus, true);
487
488 return -ETIMEDOUT;
489 }
490
491 regmap_sync:
492 slave->unattach_request = 0;
493 regcache_cache_only(rt722->regmap, false);
494 regcache_sync(rt722->regmap);
495 regcache_cache_only(rt722->mbq_regmap, false);
496 regcache_sync(rt722->mbq_regmap);
497 return 0;
498 }
499
500 static const struct dev_pm_ops rt722_sdca_pm = {
501 SET_SYSTEM_SLEEP_PM_OPS(rt722_sdca_dev_system_suspend, rt722_sdca_dev_resume)
502 SET_RUNTIME_PM_OPS(rt722_sdca_dev_suspend, rt722_sdca_dev_resume, NULL)
503 };
504
505 static struct sdw_driver rt722_sdca_sdw_driver = {
506 .driver = {
507 .name = "rt722-sdca",
508 .pm = &rt722_sdca_pm,
509 },
510 .probe = rt722_sdca_sdw_probe,
511 .remove = rt722_sdca_sdw_remove,
512 .ops = &rt722_sdca_slave_ops,
513 .id_table = rt722_sdca_id,
514 };
515 module_sdw_driver(rt722_sdca_sdw_driver);
516
517 MODULE_DESCRIPTION("ASoC RT722 SDCA SDW driver");
518 MODULE_AUTHOR("Jack Yu <[email protected]>");
519 MODULE_LICENSE("GPL");
520