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/regmap.h>
17 #include <sound/soc.h>
19 #include "rt711-sdw.h"
21 static bool rt711_readable_register(struct device *dev, unsigned int reg)
26 case 0x2012 ... 0x2016:
27 case 0x201a ... 0x2027:
28 case 0x2029 ... 0x202a:
29 case 0x202d ... 0x2034:
30 case 0x2201 ... 0x2204:
31 case 0x2206 ... 0x2212:
32 case 0x2220 ... 0x2223:
33 case 0x2230 ... 0x2239:
34 case 0x2f01 ... 0x2f0f:
35 case 0x3000 ... 0x3fff:
36 case 0x7000 ... 0x7fff:
37 case 0x8300 ... 0x83ff:
38 case 0x9c00 ... 0x9cff:
39 case 0xb900 ... 0xb9ff:
59 static bool rt711_volatile_register(struct device *dev, unsigned int reg)
70 case 0x2012 ... 0x2015: /* HD-A read */
71 case 0x202d ... 0x202f: /* BRA */
72 case 0x2201 ... 0x2212: /* i2c debug */
73 case 0x2220 ... 0x2223: /* decoded HD-A */
74 case 0x9c00 ... 0x9cff:
75 case 0xb900 ... 0xb9ff:
88 static int rt711_sdw_read(void *context, unsigned int reg, unsigned int *val)
90 struct device *dev = context;
91 struct rt711_priv *rt711 = dev_get_drvdata(dev);
92 unsigned int sdw_data_3, sdw_data_2, sdw_data_1, sdw_data_0;
93 unsigned int reg2 = 0, reg3 = 0, reg4 = 0, mask, nid, val2;
94 unsigned int is_hda_reg = 1, is_index_reg = 0;
102 if (is_index_reg) { /* index registers */
106 ret = regmap_write(rt711->sdw_regmap, reg, 0);
111 ret = regmap_write(rt711->sdw_regmap, reg2, val2);
115 reg3 = RT711_PRIV_DATA_R_H | nid;
116 ret = regmap_write(rt711->sdw_regmap,
117 reg3, ((*val >> 8) & 0xff));
120 reg4 = reg3 + 0x1000;
122 ret = regmap_write(rt711->sdw_regmap, reg4, (*val & 0xff));
125 } else if (mask == 0x3000) {
127 ret = regmap_write(rt711->sdw_regmap, reg, *val);
130 } else if (mask == 0x7000) {
133 ret = regmap_write(rt711->sdw_regmap,
134 reg, ((*val >> 8) & 0xff));
139 ret = regmap_write(rt711->sdw_regmap, reg2, (*val & 0xff));
142 } else if ((reg & 0xff00) == 0x8300) { /* for R channel */
145 ret = regmap_write(rt711->sdw_regmap,
146 reg2, ((*val >> 8) & 0xff));
149 ret = regmap_write(rt711->sdw_regmap, reg, (*val & 0xff));
152 } else if (mask == 0x9000) {
153 ret = regmap_write(rt711->sdw_regmap,
154 reg, ((*val >> 8) & 0xff));
159 ret = regmap_write(rt711->sdw_regmap, reg2, (*val & 0xff));
162 } else if (mask == 0xb000) {
163 ret = regmap_write(rt711->sdw_regmap, reg, *val);
167 ret = regmap_read(rt711->sdw_regmap, reg, val);
173 if (is_hda_reg || is_index_reg) {
178 ret = regmap_read(rt711->sdw_regmap,
179 RT711_READ_HDA_3, &sdw_data_3);
182 ret = regmap_read(rt711->sdw_regmap,
183 RT711_READ_HDA_2, &sdw_data_2);
186 ret = regmap_read(rt711->sdw_regmap,
187 RT711_READ_HDA_1, &sdw_data_1);
190 ret = regmap_read(rt711->sdw_regmap,
191 RT711_READ_HDA_0, &sdw_data_0);
194 *val = ((sdw_data_3 & 0xff) << 24) |
195 ((sdw_data_2 & 0xff) << 16) |
196 ((sdw_data_1 & 0xff) << 8) | (sdw_data_0 & 0xff);
200 dev_dbg(dev, "[%s] %04x => %08x\n", __func__, reg, *val);
201 else if (is_index_reg)
202 dev_dbg(dev, "[%s] %04x %04x %04x %04x => %08x\n",
203 __func__, reg, reg2, reg3, reg4, *val);
205 dev_dbg(dev, "[%s] %04x %04x => %08x\n",
206 __func__, reg, reg2, *val);
211 static int rt711_sdw_write(void *context, unsigned int reg, unsigned int val)
213 struct device *dev = context;
214 struct rt711_priv *rt711 = dev_get_drvdata(dev);
215 unsigned int reg2 = 0, reg3, reg4, nid, mask, val2;
216 unsigned int is_index_reg = 0;
224 if (is_index_reg) { /* index registers */
228 ret = regmap_write(rt711->sdw_regmap, reg, 0);
233 ret = regmap_write(rt711->sdw_regmap, reg2, val2);
237 reg3 = RT711_PRIV_DATA_W_H | nid;
238 ret = regmap_write(rt711->sdw_regmap,
239 reg3, ((val >> 8) & 0xff));
242 reg4 = reg3 + 0x1000;
244 ret = regmap_write(rt711->sdw_regmap, reg4, (val & 0xff));
248 } else if (reg < 0x4fff) {
249 ret = regmap_write(rt711->sdw_regmap, reg, val);
252 } else if (reg == RT711_FUNC_RESET) {
253 ret = regmap_write(rt711->sdw_regmap, reg, val);
256 } else if (mask == 0x7000) {
257 ret = regmap_write(rt711->sdw_regmap,
258 reg, ((val >> 8) & 0xff));
263 ret = regmap_write(rt711->sdw_regmap, reg2, (val & 0xff));
266 } else if ((reg & 0xff00) == 0x8300) { /* for R channel */
269 ret = regmap_write(rt711->sdw_regmap,
270 reg2, ((val >> 8) & 0xff));
273 ret = regmap_write(rt711->sdw_regmap, reg, (val & 0xff));
279 dev_dbg(dev, "[%s] %04x <= %04x\n", __func__, reg, val);
280 else if (is_index_reg)
281 dev_dbg(dev, "[%s] %04x %04x %04x %04x <= %04x %04x\n",
282 __func__, reg, reg2, reg3, reg4, val2, val);
284 dev_dbg(dev, "[%s] %04x %04x <= %04x\n",
285 __func__, reg, reg2, val);
290 static const struct regmap_config rt711_regmap = {
293 .readable_reg = rt711_readable_register,
294 .volatile_reg = rt711_volatile_register,
295 .max_register = 0x755800,
296 .reg_defaults = rt711_reg_defaults,
297 .num_reg_defaults = ARRAY_SIZE(rt711_reg_defaults),
298 .cache_type = REGCACHE_RBTREE,
299 .use_single_read = true,
300 .use_single_write = true,
301 .reg_read = rt711_sdw_read,
302 .reg_write = rt711_sdw_write,
305 static const struct regmap_config rt711_sdw_regmap = {
309 .readable_reg = rt711_readable_register,
310 .max_register = 0xff01,
311 .cache_type = REGCACHE_NONE,
312 .use_single_read = true,
313 .use_single_write = true,
316 static int rt711_update_status(struct sdw_slave *slave,
317 enum sdw_slave_status status)
319 struct rt711_priv *rt711 = dev_get_drvdata(&slave->dev);
321 /* Update the status */
322 rt711->status = status;
324 if (status == SDW_SLAVE_UNATTACHED)
325 rt711->hw_init = false;
328 * Perform initialization only if slave status is present and
329 * hw_init flag is false
331 if (rt711->hw_init || rt711->status != SDW_SLAVE_ATTACHED)
334 /* perform I/O transfers required for Slave initialization */
335 return rt711_io_init(&slave->dev, slave);
338 static int rt711_read_prop(struct sdw_slave *slave)
340 struct sdw_slave_prop *prop = &slave->prop;
344 struct sdw_dpn_prop *dpn;
346 prop->scp_int1_mask = SDW_SCP_INT1_IMPL_DEF | SDW_SCP_INT1_BUS_CLASH |
348 prop->quirks = SDW_SLAVE_QUIRKS_INVALID_INITIAL_PARITY;
350 prop->paging_support = false;
352 /* first we need to allocate memory for set bits in port lists */
353 prop->source_ports = 0x14; /* BITMAP: 00010100 */
354 prop->sink_ports = 0x8; /* BITMAP: 00001000 */
356 nval = hweight32(prop->source_ports);
357 prop->src_dpn_prop = devm_kcalloc(&slave->dev, nval,
358 sizeof(*prop->src_dpn_prop),
360 if (!prop->src_dpn_prop)
364 dpn = prop->src_dpn_prop;
365 addr = prop->source_ports;
366 for_each_set_bit(bit, &addr, 32) {
368 dpn[i].type = SDW_DPN_FULL;
369 dpn[i].simple_ch_prep_sm = true;
370 dpn[i].ch_prep_timeout = 10;
374 /* do this again for sink now */
375 nval = hweight32(prop->sink_ports);
376 prop->sink_dpn_prop = devm_kcalloc(&slave->dev, nval,
377 sizeof(*prop->sink_dpn_prop),
379 if (!prop->sink_dpn_prop)
383 dpn = prop->sink_dpn_prop;
384 addr = prop->sink_ports;
385 for_each_set_bit(bit, &addr, 32) {
387 dpn[i].type = SDW_DPN_FULL;
388 dpn[i].simple_ch_prep_sm = true;
389 dpn[i].ch_prep_timeout = 10;
393 /* set the timeout values */
394 prop->clk_stop_timeout = 20;
397 prop->wake_capable = 1;
402 static int rt711_bus_config(struct sdw_slave *slave,
403 struct sdw_bus_params *params)
405 struct rt711_priv *rt711 = dev_get_drvdata(&slave->dev);
408 memcpy(&rt711->params, params, sizeof(*params));
410 ret = rt711_clock_config(&slave->dev);
412 dev_err(&slave->dev, "Invalid clk config");
417 static int rt711_interrupt_callback(struct sdw_slave *slave,
418 struct sdw_slave_intr_status *status)
420 struct rt711_priv *rt711 = dev_get_drvdata(&slave->dev);
423 "%s control_port_stat=%x", __func__, status->control_port);
425 if (status->control_port & 0x4) {
426 mod_delayed_work(system_power_efficient_wq,
427 &rt711->jack_detect_work, msecs_to_jiffies(250));
433 static struct sdw_slave_ops rt711_slave_ops = {
434 .read_prop = rt711_read_prop,
435 .interrupt_callback = rt711_interrupt_callback,
436 .update_status = rt711_update_status,
437 .bus_config = rt711_bus_config,
440 static int rt711_sdw_probe(struct sdw_slave *slave,
441 const struct sdw_device_id *id)
443 struct regmap *sdw_regmap, *regmap;
445 /* Regmap Initialization */
446 sdw_regmap = devm_regmap_init_sdw(slave, &rt711_sdw_regmap);
447 if (IS_ERR(sdw_regmap))
448 return PTR_ERR(sdw_regmap);
450 regmap = devm_regmap_init(&slave->dev, NULL,
451 &slave->dev, &rt711_regmap);
453 return PTR_ERR(regmap);
455 rt711_init(&slave->dev, sdw_regmap, regmap, slave);
460 static int rt711_sdw_remove(struct sdw_slave *slave)
462 struct rt711_priv *rt711 = dev_get_drvdata(&slave->dev);
464 if (rt711 && rt711->hw_init) {
465 cancel_delayed_work(&rt711->jack_detect_work);
466 cancel_delayed_work(&rt711->jack_btn_check_work);
467 cancel_work_sync(&rt711->calibration_work);
473 static const struct sdw_device_id rt711_id[] = {
474 SDW_SLAVE_ENTRY_EXT(0x025d, 0x711, 0x2, 0, 0),
477 MODULE_DEVICE_TABLE(sdw, rt711_id);
479 static int __maybe_unused rt711_dev_suspend(struct device *dev)
481 struct rt711_priv *rt711 = dev_get_drvdata(dev);
486 cancel_delayed_work_sync(&rt711->jack_detect_work);
487 cancel_delayed_work_sync(&rt711->jack_btn_check_work);
488 cancel_work_sync(&rt711->calibration_work);
490 regcache_cache_only(rt711->regmap, true);
495 #define RT711_PROBE_TIMEOUT 2000
497 static int __maybe_unused rt711_dev_resume(struct device *dev)
499 struct sdw_slave *slave = dev_to_sdw_dev(dev);
500 struct rt711_priv *rt711 = dev_get_drvdata(dev);
503 if (!rt711->first_hw_init)
506 if (!slave->unattach_request)
509 time = wait_for_completion_timeout(&slave->initialization_complete,
510 msecs_to_jiffies(RT711_PROBE_TIMEOUT));
512 dev_err(&slave->dev, "Initialization not complete, timed out\n");
517 slave->unattach_request = 0;
518 regcache_cache_only(rt711->regmap, false);
519 regcache_sync_region(rt711->regmap, 0x3000, 0x8fff);
520 regcache_sync_region(rt711->regmap, 0x752009, 0x752091);
525 static const struct dev_pm_ops rt711_pm = {
526 SET_SYSTEM_SLEEP_PM_OPS(rt711_dev_suspend, rt711_dev_resume)
527 SET_RUNTIME_PM_OPS(rt711_dev_suspend, rt711_dev_resume, NULL)
530 static struct sdw_driver rt711_sdw_driver = {
533 .owner = THIS_MODULE,
536 .probe = rt711_sdw_probe,
537 .remove = rt711_sdw_remove,
538 .ops = &rt711_slave_ops,
539 .id_table = rt711_id,
541 module_sdw_driver(rt711_sdw_driver);
543 MODULE_DESCRIPTION("ASoC RT711 SDW driver");
544 MODULE_AUTHOR("Shuming Fan <shumingf@realtek.com>");
545 MODULE_LICENSE("GPL");