1 // SPDX-License-Identifier: GPL-2.0
3 // rt711-sdw.c -- rt711 ALSA SoC audio driver
5 // Copyright(c) 2019 Realtek Semiconductor Corp.
9 #include <linux/delay.h>
10 #include <linux/device.h>
11 #include <linux/mod_devicetable.h>
12 #include <linux/soundwire/sdw.h>
13 #include <linux/soundwire/sdw_type.h>
14 #include <linux/soundwire/sdw_registers.h>
15 #include <linux/module.h>
16 #include <linux/pm_runtime.h>
17 #include <linux/regmap.h>
18 #include <sound/soc.h>
20 #include "rt711-sdw.h"
22 static bool rt711_readable_register(struct device *dev, unsigned int reg)
27 case 0x2012 ... 0x2016:
28 case 0x201a ... 0x2027:
29 case 0x2029 ... 0x202a:
30 case 0x202d ... 0x2034:
31 case 0x2201 ... 0x2204:
32 case 0x2206 ... 0x2212:
33 case 0x2220 ... 0x2223:
34 case 0x2230 ... 0x2239:
35 case 0x2f01 ... 0x2f0f:
36 case 0x3000 ... 0x3fff:
37 case 0x7000 ... 0x7fff:
38 case 0x8300 ... 0x83ff:
39 case 0x9c00 ... 0x9cff:
40 case 0xb900 ... 0xb9ff:
60 static bool rt711_volatile_register(struct device *dev, unsigned int reg)
71 case 0x2012 ... 0x2015: /* HD-A read */
72 case 0x202d ... 0x202f: /* BRA */
73 case 0x2201 ... 0x2212: /* i2c debug */
74 case 0x2220 ... 0x2223: /* decoded HD-A */
75 case 0x9c00 ... 0x9cff:
76 case 0xb900 ... 0xb9ff:
89 static int rt711_sdw_read(void *context, unsigned int reg, unsigned int *val)
91 struct device *dev = context;
92 struct rt711_priv *rt711 = dev_get_drvdata(dev);
93 unsigned int sdw_data_3, sdw_data_2, sdw_data_1, sdw_data_0;
94 unsigned int reg2 = 0, reg3 = 0, reg4 = 0, mask, nid, val2;
95 unsigned int is_hda_reg = 1, is_index_reg = 0;
103 if (is_index_reg) { /* index registers */
107 ret = regmap_write(rt711->sdw_regmap, reg, 0);
112 ret = regmap_write(rt711->sdw_regmap, reg2, val2);
116 reg3 = RT711_PRIV_DATA_R_H | nid;
117 ret = regmap_write(rt711->sdw_regmap,
118 reg3, ((*val >> 8) & 0xff));
121 reg4 = reg3 + 0x1000;
123 ret = regmap_write(rt711->sdw_regmap, reg4, (*val & 0xff));
126 } else if (mask == 0x3000) {
128 ret = regmap_write(rt711->sdw_regmap, reg, *val);
131 } else if (mask == 0x7000) {
134 ret = regmap_write(rt711->sdw_regmap,
135 reg, ((*val >> 8) & 0xff));
140 ret = regmap_write(rt711->sdw_regmap, reg2, (*val & 0xff));
143 } else if ((reg & 0xff00) == 0x8300) { /* for R channel */
146 ret = regmap_write(rt711->sdw_regmap,
147 reg2, ((*val >> 8) & 0xff));
150 ret = regmap_write(rt711->sdw_regmap, reg, (*val & 0xff));
153 } else if (mask == 0x9000) {
154 ret = regmap_write(rt711->sdw_regmap,
155 reg, ((*val >> 8) & 0xff));
160 ret = regmap_write(rt711->sdw_regmap, reg2, (*val & 0xff));
163 } else if (mask == 0xb000) {
164 ret = regmap_write(rt711->sdw_regmap, reg, *val);
168 ret = regmap_read(rt711->sdw_regmap, reg, val);
174 if (is_hda_reg || is_index_reg) {
179 ret = regmap_read(rt711->sdw_regmap,
180 RT711_READ_HDA_3, &sdw_data_3);
183 ret = regmap_read(rt711->sdw_regmap,
184 RT711_READ_HDA_2, &sdw_data_2);
187 ret = regmap_read(rt711->sdw_regmap,
188 RT711_READ_HDA_1, &sdw_data_1);
191 ret = regmap_read(rt711->sdw_regmap,
192 RT711_READ_HDA_0, &sdw_data_0);
195 *val = ((sdw_data_3 & 0xff) << 24) |
196 ((sdw_data_2 & 0xff) << 16) |
197 ((sdw_data_1 & 0xff) << 8) | (sdw_data_0 & 0xff);
201 dev_dbg(dev, "[%s] %04x => %08x\n", __func__, reg, *val);
202 else if (is_index_reg)
203 dev_dbg(dev, "[%s] %04x %04x %04x %04x => %08x\n",
204 __func__, reg, reg2, reg3, reg4, *val);
206 dev_dbg(dev, "[%s] %04x %04x => %08x\n",
207 __func__, reg, reg2, *val);
212 static int rt711_sdw_write(void *context, unsigned int reg, unsigned int val)
214 struct device *dev = context;
215 struct rt711_priv *rt711 = dev_get_drvdata(dev);
216 unsigned int reg2 = 0, reg3, reg4, nid, mask, val2;
217 unsigned int is_index_reg = 0;
225 if (is_index_reg) { /* index registers */
229 ret = regmap_write(rt711->sdw_regmap, reg, 0);
234 ret = regmap_write(rt711->sdw_regmap, reg2, val2);
238 reg3 = RT711_PRIV_DATA_W_H | nid;
239 ret = regmap_write(rt711->sdw_regmap,
240 reg3, ((val >> 8) & 0xff));
243 reg4 = reg3 + 0x1000;
245 ret = regmap_write(rt711->sdw_regmap, reg4, (val & 0xff));
249 } else if (reg < 0x4fff) {
250 ret = regmap_write(rt711->sdw_regmap, reg, val);
253 } else if (reg == RT711_FUNC_RESET) {
254 ret = regmap_write(rt711->sdw_regmap, reg, val);
257 } else if (mask == 0x7000) {
258 ret = regmap_write(rt711->sdw_regmap,
259 reg, ((val >> 8) & 0xff));
264 ret = regmap_write(rt711->sdw_regmap, reg2, (val & 0xff));
267 } else if ((reg & 0xff00) == 0x8300) { /* for R channel */
270 ret = regmap_write(rt711->sdw_regmap,
271 reg2, ((val >> 8) & 0xff));
274 ret = regmap_write(rt711->sdw_regmap, reg, (val & 0xff));
280 dev_dbg(dev, "[%s] %04x <= %04x\n", __func__, reg, val);
281 else if (is_index_reg)
282 dev_dbg(dev, "[%s] %04x %04x %04x %04x <= %04x %04x\n",
283 __func__, reg, reg2, reg3, reg4, val2, val);
285 dev_dbg(dev, "[%s] %04x %04x <= %04x\n",
286 __func__, reg, reg2, val);
291 static const struct regmap_config rt711_regmap = {
294 .readable_reg = rt711_readable_register,
295 .volatile_reg = rt711_volatile_register,
296 .max_register = 0x755800,
297 .reg_defaults = rt711_reg_defaults,
298 .num_reg_defaults = ARRAY_SIZE(rt711_reg_defaults),
299 .cache_type = REGCACHE_MAPLE,
300 .use_single_read = true,
301 .use_single_write = true,
302 .reg_read = rt711_sdw_read,
303 .reg_write = rt711_sdw_write,
306 static const struct regmap_config rt711_sdw_regmap = {
310 .readable_reg = rt711_readable_register,
311 .max_register = 0xff01,
312 .cache_type = REGCACHE_NONE,
313 .use_single_read = true,
314 .use_single_write = true,
317 static int rt711_update_status(struct sdw_slave *slave,
318 enum sdw_slave_status status)
320 struct rt711_priv *rt711 = dev_get_drvdata(&slave->dev);
322 if (status == SDW_SLAVE_UNATTACHED)
323 rt711->hw_init = false;
326 * Perform initialization only if slave status is present and
327 * hw_init flag is false
329 if (rt711->hw_init || status != SDW_SLAVE_ATTACHED)
332 /* perform I/O transfers required for Slave initialization */
333 return rt711_io_init(&slave->dev, slave);
336 static int rt711_read_prop(struct sdw_slave *slave)
338 struct sdw_slave_prop *prop = &slave->prop;
343 struct sdw_dpn_prop *dpn;
345 prop->scp_int1_mask = SDW_SCP_INT1_IMPL_DEF | SDW_SCP_INT1_BUS_CLASH |
347 prop->quirks = SDW_SLAVE_QUIRKS_INVALID_INITIAL_PARITY;
349 prop->paging_support = false;
351 /* first we need to allocate memory for set bits in port lists */
352 prop->source_ports = 0x14; /* BITMAP: 00010100 */
353 prop->sink_ports = 0x8; /* BITMAP: 00001000 */
355 nval = hweight32(prop->source_ports);
356 prop->src_dpn_prop = devm_kcalloc(&slave->dev, nval,
357 sizeof(*prop->src_dpn_prop),
359 if (!prop->src_dpn_prop)
363 dpn = prop->src_dpn_prop;
364 addr = prop->source_ports;
365 for_each_set_bit(bit, &addr, 32) {
367 dpn[i].type = SDW_DPN_FULL;
368 dpn[i].simple_ch_prep_sm = true;
369 dpn[i].ch_prep_timeout = 10;
373 /* do this again for sink now */
374 nval = hweight32(prop->sink_ports);
375 prop->sink_dpn_prop = devm_kcalloc(&slave->dev, nval,
376 sizeof(*prop->sink_dpn_prop),
378 if (!prop->sink_dpn_prop)
382 dpn = prop->sink_dpn_prop;
383 addr = prop->sink_ports;
384 for_each_set_bit(bit, &addr, 32) {
386 dpn[j].type = SDW_DPN_FULL;
387 dpn[j].simple_ch_prep_sm = true;
388 dpn[j].ch_prep_timeout = 10;
392 /* set the timeout values */
393 prop->clk_stop_timeout = 20;
396 prop->wake_capable = 1;
401 static int rt711_bus_config(struct sdw_slave *slave,
402 struct sdw_bus_params *params)
404 struct rt711_priv *rt711 = dev_get_drvdata(&slave->dev);
407 memcpy(&rt711->params, params, sizeof(*params));
409 ret = rt711_clock_config(&slave->dev);
411 dev_err(&slave->dev, "Invalid clk config");
416 static int rt711_interrupt_callback(struct sdw_slave *slave,
417 struct sdw_slave_intr_status *status)
419 struct rt711_priv *rt711 = dev_get_drvdata(&slave->dev);
422 "%s control_port_stat=%x", __func__, status->control_port);
424 mutex_lock(&rt711->disable_irq_lock);
425 if (status->control_port & 0x4 && !rt711->disable_irq) {
426 mod_delayed_work(system_power_efficient_wq,
427 &rt711->jack_detect_work, msecs_to_jiffies(250));
429 mutex_unlock(&rt711->disable_irq_lock);
434 static const struct sdw_slave_ops rt711_slave_ops = {
435 .read_prop = rt711_read_prop,
436 .interrupt_callback = rt711_interrupt_callback,
437 .update_status = rt711_update_status,
438 .bus_config = rt711_bus_config,
441 static int rt711_sdw_probe(struct sdw_slave *slave,
442 const struct sdw_device_id *id)
444 struct regmap *sdw_regmap, *regmap;
446 /* Regmap Initialization */
447 sdw_regmap = devm_regmap_init_sdw(slave, &rt711_sdw_regmap);
448 if (IS_ERR(sdw_regmap))
449 return PTR_ERR(sdw_regmap);
451 regmap = devm_regmap_init(&slave->dev, NULL,
452 &slave->dev, &rt711_regmap);
454 return PTR_ERR(regmap);
456 rt711_init(&slave->dev, sdw_regmap, regmap, slave);
461 static int rt711_sdw_remove(struct sdw_slave *slave)
463 struct rt711_priv *rt711 = dev_get_drvdata(&slave->dev);
465 if (rt711->hw_init) {
466 cancel_delayed_work_sync(&rt711->jack_detect_work);
467 cancel_delayed_work_sync(&rt711->jack_btn_check_work);
468 cancel_work_sync(&rt711->calibration_work);
471 if (rt711->first_hw_init)
472 pm_runtime_disable(&slave->dev);
474 mutex_destroy(&rt711->calibrate_mutex);
475 mutex_destroy(&rt711->disable_irq_lock);
480 static const struct sdw_device_id rt711_id[] = {
481 SDW_SLAVE_ENTRY_EXT(0x025d, 0x711, 0x2, 0, 0),
484 MODULE_DEVICE_TABLE(sdw, rt711_id);
486 static int __maybe_unused rt711_dev_suspend(struct device *dev)
488 struct rt711_priv *rt711 = dev_get_drvdata(dev);
493 cancel_delayed_work_sync(&rt711->jack_detect_work);
494 cancel_delayed_work_sync(&rt711->jack_btn_check_work);
495 cancel_work_sync(&rt711->calibration_work);
497 regcache_cache_only(rt711->regmap, true);
502 static int __maybe_unused rt711_dev_system_suspend(struct device *dev)
504 struct rt711_priv *rt711 = dev_get_drvdata(dev);
505 struct sdw_slave *slave = dev_to_sdw_dev(dev);
512 * prevent new interrupts from being handled after the
513 * deferred work completes and before the parent disables
514 * interrupts on the link
516 mutex_lock(&rt711->disable_irq_lock);
517 rt711->disable_irq = true;
518 ret = sdw_update_no_pm(slave, SDW_SCP_INTMASK1,
519 SDW_SCP_INT1_IMPL_DEF, 0);
520 mutex_unlock(&rt711->disable_irq_lock);
523 /* log but don't prevent suspend from happening */
524 dev_dbg(&slave->dev, "%s: could not disable imp-def interrupts\n:", __func__);
527 return rt711_dev_suspend(dev);
530 #define RT711_PROBE_TIMEOUT 5000
532 static int __maybe_unused rt711_dev_resume(struct device *dev)
534 struct sdw_slave *slave = dev_to_sdw_dev(dev);
535 struct rt711_priv *rt711 = dev_get_drvdata(dev);
538 if (!rt711->first_hw_init)
541 if (!slave->unattach_request)
544 time = wait_for_completion_timeout(&slave->initialization_complete,
545 msecs_to_jiffies(RT711_PROBE_TIMEOUT));
547 dev_err(&slave->dev, "Initialization not complete, timed out\n");
552 slave->unattach_request = 0;
553 regcache_cache_only(rt711->regmap, false);
554 regcache_sync_region(rt711->regmap, 0x3000, 0x8fff);
555 regcache_sync_region(rt711->regmap, 0x752009, 0x752091);
560 static const struct dev_pm_ops rt711_pm = {
561 SET_SYSTEM_SLEEP_PM_OPS(rt711_dev_system_suspend, rt711_dev_resume)
562 SET_RUNTIME_PM_OPS(rt711_dev_suspend, rt711_dev_resume, NULL)
565 static struct sdw_driver rt711_sdw_driver = {
568 .owner = THIS_MODULE,
571 .probe = rt711_sdw_probe,
572 .remove = rt711_sdw_remove,
573 .ops = &rt711_slave_ops,
574 .id_table = rt711_id,
576 module_sdw_driver(rt711_sdw_driver);
578 MODULE_DESCRIPTION("ASoC RT711 SDW driver");
579 MODULE_AUTHOR("Shuming Fan <shumingf@realtek.com>");
580 MODULE_LICENSE("GPL");