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