1 // SPDX-License-Identifier: GPL-2.0-only 2 // 3 // rt721-sdca-sdw.c -- rt721 SDCA ALSA SoC audio driver 4 // 5 // Copyright(c) 2024 Realtek Semiconductor Corp. 6 // 7 // 8 9 #include <linux/cleanup.h> 10 #include <linux/delay.h> 11 #include <linux/device.h> 12 #include <linux/module.h> 13 #include <linux/pm_runtime.h> 14 #include <linux/soundwire/sdw_registers.h> 15 16 #include "rt721-sdca.h" 17 #include "rt721-sdca-sdw.h" 18 #include "rt-sdw-common.h" 19 20 static bool rt721_sdca_readable_register(struct device *dev, unsigned int reg) 21 { 22 switch (reg) { 23 case 0x2f01 ... 0x2f0a: 24 case 0x2f35: 25 case 0x2f50: 26 case 0x2f51: 27 case 0x2f58 ... 0x2f5d: 28 case SDW_SDCA_CTL(FUNC_NUM_JACK_CODEC, RT721_SDCA_ENT_XUV, 29 RT721_SDCA_CTL_XUV, 0): 30 case SDW_SDCA_CTL(FUNC_NUM_JACK_CODEC, RT721_SDCA_ENT_GE49, 31 RT721_SDCA_CTL_SELECTED_MODE, 0): 32 case SDW_SDCA_CTL(FUNC_NUM_JACK_CODEC, RT721_SDCA_ENT_GE49, 33 RT721_SDCA_CTL_DETECTED_MODE, 0): 34 case SDW_SDCA_CTL(FUNC_NUM_HID, RT721_SDCA_ENT_HID01, 35 RT721_SDCA_CTL_HIDTX_CURRENT_OWNER, 0) ... SDW_SDCA_CTL(FUNC_NUM_HID, 36 RT721_SDCA_ENT_HID01, RT721_SDCA_CTL_HIDTX_MESSAGE_LENGTH, 0): 37 case RT721_BUF_ADDR_HID1 ... RT721_BUF_ADDR_HID2: 38 return true; 39 default: 40 return false; 41 } 42 } 43 44 static bool rt721_sdca_volatile_register(struct device *dev, unsigned int reg) 45 { 46 switch (reg) { 47 case 0x2f01: 48 case 0x2f51: 49 case SDW_SDCA_CTL(FUNC_NUM_JACK_CODEC, RT721_SDCA_ENT_GE49, 50 RT721_SDCA_CTL_DETECTED_MODE, 0): 51 case SDW_SDCA_CTL(FUNC_NUM_JACK_CODEC, RT721_SDCA_ENT_XUV, 52 RT721_SDCA_CTL_XUV, 0): 53 case SDW_SDCA_CTL(FUNC_NUM_HID, RT721_SDCA_ENT_HID01, 54 RT721_SDCA_CTL_HIDTX_CURRENT_OWNER, 0) ... SDW_SDCA_CTL(FUNC_NUM_HID, 55 RT721_SDCA_ENT_HID01, RT721_SDCA_CTL_HIDTX_MESSAGE_LENGTH, 0): 56 case RT721_BUF_ADDR_HID1 ... RT721_BUF_ADDR_HID2: 57 return true; 58 default: 59 return false; 60 } 61 } 62 63 static bool rt721_sdca_mbq_readable_register(struct device *dev, unsigned int reg) 64 { 65 switch (reg) { 66 case 0x0900004 ... 0x0900009: 67 case 0x0a00005: 68 case 0x0c00005: 69 case 0x0d00014: 70 case 0x0310100: 71 case 0x2000000 ... 0x2000003: 72 case 0x2000013: 73 case 0x2000026: 74 case 0x200002c: 75 case 0x200003c: 76 case 0x2000046: 77 case 0x5810000: 78 case 0x5810036: 79 case 0x5810037: 80 case 0x5810038: 81 case 0x5810039: 82 case 0x5b10018: 83 case 0x5b10019: 84 case 0x5f00045: 85 case 0x5f00048: 86 case 0x6100000: 87 case 0x6100005: 88 case 0x6100006: 89 case 0x610000d: 90 case 0x6100010: 91 case 0x6100011: 92 case 0x6100013: 93 case 0x6100015: 94 case 0x6100017: 95 case 0x6100025: 96 case 0x6100029: 97 case 0x610002c ... 0x610002f: 98 case 0x6100053 ... 0x6100055: 99 case 0x6100057: 100 case 0x610005a: 101 case 0x610005b: 102 case 0x610006a: 103 case 0x610006d: 104 case 0x6100092: 105 case SDW_SDCA_CTL(FUNC_NUM_JACK_CODEC, RT721_SDCA_ENT_USER_FU05, RT721_SDCA_CTL_FU_VOLUME, 106 CH_L): 107 case SDW_SDCA_CTL(FUNC_NUM_JACK_CODEC, RT721_SDCA_ENT_USER_FU05, RT721_SDCA_CTL_FU_VOLUME, 108 CH_R): 109 case SDW_SDCA_CTL(FUNC_NUM_JACK_CODEC, RT721_SDCA_ENT_USER_FU0F, RT721_SDCA_CTL_FU_VOLUME, 110 CH_L): 111 case SDW_SDCA_CTL(FUNC_NUM_JACK_CODEC, RT721_SDCA_ENT_USER_FU0F, RT721_SDCA_CTL_FU_VOLUME, 112 CH_R): 113 case SDW_SDCA_CTL(FUNC_NUM_JACK_CODEC, RT721_SDCA_ENT_PLATFORM_FU44, 114 RT721_SDCA_CTL_FU_CH_GAIN, CH_L): 115 case SDW_SDCA_CTL(FUNC_NUM_JACK_CODEC, RT721_SDCA_ENT_PLATFORM_FU44, 116 RT721_SDCA_CTL_FU_CH_GAIN, CH_R): 117 case SDW_SDCA_CTL(FUNC_NUM_MIC_ARRAY, RT721_SDCA_ENT_USER_FU1E, RT721_SDCA_CTL_FU_VOLUME, 118 CH_01): 119 case SDW_SDCA_CTL(FUNC_NUM_MIC_ARRAY, RT721_SDCA_ENT_USER_FU1E, RT721_SDCA_CTL_FU_VOLUME, 120 CH_02): 121 case SDW_SDCA_CTL(FUNC_NUM_MIC_ARRAY, RT721_SDCA_ENT_USER_FU1E, RT721_SDCA_CTL_FU_VOLUME, 122 CH_03): 123 case SDW_SDCA_CTL(FUNC_NUM_MIC_ARRAY, RT721_SDCA_ENT_USER_FU1E, RT721_SDCA_CTL_FU_VOLUME, 124 CH_04): 125 case SDW_SDCA_CTL(FUNC_NUM_AMP, RT721_SDCA_ENT_USER_FU06, RT721_SDCA_CTL_FU_VOLUME, CH_L): 126 case SDW_SDCA_CTL(FUNC_NUM_AMP, RT721_SDCA_ENT_USER_FU06, RT721_SDCA_CTL_FU_VOLUME, CH_R): 127 return true; 128 default: 129 return false; 130 } 131 } 132 133 static bool rt721_sdca_mbq_volatile_register(struct device *dev, unsigned int reg) 134 { 135 switch (reg) { 136 case 0x0310100: 137 case 0x0900005: 138 case 0x0900009: 139 case 0x0a00005: 140 case 0x0c00005: 141 case 0x0d00014: 142 case 0x2000000: 143 case 0x200000d: 144 case 0x2000019: 145 case 0x2000020: 146 case 0x2000026: 147 case 0x200002c: 148 case 0x2000030: 149 case 0x2000046: 150 case 0x2000067: 151 case 0x2000084: 152 case 0x2000086: 153 case 0x5810000: 154 case 0x5810036: 155 case 0x5810037: 156 case 0x5810038: 157 case 0x5810039: 158 case 0x5b10018: 159 case 0x5b10019: 160 case 0x6100006: 161 return true; 162 default: 163 return false; 164 } 165 } 166 167 static const struct regmap_config rt721_sdca_regmap = { 168 .reg_bits = 32, 169 .val_bits = 8, 170 .readable_reg = rt721_sdca_readable_register, 171 .volatile_reg = rt721_sdca_volatile_register, 172 .max_register = 0x44ffffff, 173 .reg_defaults = rt721_sdca_reg_defaults, 174 .num_reg_defaults = ARRAY_SIZE(rt721_sdca_reg_defaults), 175 .cache_type = REGCACHE_MAPLE, 176 .use_single_read = true, 177 .use_single_write = true, 178 }; 179 180 static const struct regmap_config rt721_sdca_mbq_regmap = { 181 .name = "sdw-mbq", 182 .reg_bits = 32, 183 .val_bits = 16, 184 .readable_reg = rt721_sdca_mbq_readable_register, 185 .volatile_reg = rt721_sdca_mbq_volatile_register, 186 .max_register = 0x41000312, 187 .reg_defaults = rt721_sdca_mbq_defaults, 188 .num_reg_defaults = ARRAY_SIZE(rt721_sdca_mbq_defaults), 189 .cache_type = REGCACHE_MAPLE, 190 .use_single_read = true, 191 .use_single_write = true, 192 }; 193 194 static int rt721_sdca_update_status(struct sdw_slave *slave, 195 enum sdw_slave_status status) 196 { 197 struct rt721_sdca_priv *rt721 = dev_get_drvdata(&slave->dev); 198 199 if (status == SDW_SLAVE_UNATTACHED) 200 rt721->hw_init = false; 201 202 if (status == SDW_SLAVE_ATTACHED) { 203 if (rt721->hs_jack) { 204 /* 205 * Due to the SCP_SDCA_INTMASK will be cleared by any reset, and then 206 * if the device attached again, we will need to set the setting back. 207 * It could avoid losing the jack detection interrupt. 208 * This also could sync with the cache value as the rt721_sdca_jack_init set. 209 */ 210 sdw_write_no_pm(rt721->slave, SDW_SCP_SDCA_INTMASK1, 211 SDW_SCP_SDCA_INTMASK_SDCA_0); 212 sdw_write_no_pm(rt721->slave, SDW_SCP_SDCA_INTMASK2, 213 SDW_SCP_SDCA_INTMASK_SDCA_8); 214 } 215 } 216 217 /* 218 * Perform initialization only if slave status is present and 219 * hw_init flag is false 220 */ 221 if (rt721->hw_init || status != SDW_SLAVE_ATTACHED) 222 return 0; 223 224 /* perform I/O transfers required for Slave initialization */ 225 return rt721_sdca_io_init(&slave->dev, slave); 226 } 227 228 static int rt721_sdca_read_prop(struct sdw_slave *slave) 229 { 230 struct sdw_slave_prop *prop = &slave->prop; 231 int nval; 232 int i, j; 233 u32 bit; 234 unsigned long addr; 235 struct sdw_dpn_prop *dpn; 236 237 sdw_slave_read_prop(slave); 238 prop->scp_int1_mask = SDW_SCP_INT1_BUS_CLASH | SDW_SCP_INT1_PARITY; 239 prop->quirks = SDW_SLAVE_QUIRKS_INVALID_INITIAL_PARITY; 240 241 prop->paging_support = true; 242 243 /* 244 * port = 1 for headphone playback 245 * port = 2 for headset-mic capture 246 * port = 3 for speaker playback 247 * port = 6 for digital-mic capture 248 */ 249 prop->source_ports = BIT(6) | BIT(2); /* BITMAP: 01000100 */ 250 prop->sink_ports = BIT(3) | BIT(1); /* BITMAP: 00001010 */ 251 252 nval = hweight32(prop->source_ports); 253 prop->src_dpn_prop = devm_kcalloc(&slave->dev, nval, 254 sizeof(*prop->src_dpn_prop), GFP_KERNEL); 255 if (!prop->src_dpn_prop) 256 return -ENOMEM; 257 258 i = 0; 259 dpn = prop->src_dpn_prop; 260 addr = prop->source_ports; 261 for_each_set_bit(bit, &addr, 32) { 262 dpn[i].num = bit; 263 dpn[i].type = SDW_DPN_FULL; 264 dpn[i].simple_ch_prep_sm = true; 265 dpn[i].ch_prep_timeout = 10; 266 i++; 267 } 268 269 /* do this again for sink now */ 270 nval = hweight32(prop->sink_ports); 271 prop->sink_dpn_prop = devm_kcalloc(&slave->dev, nval, 272 sizeof(*prop->sink_dpn_prop), GFP_KERNEL); 273 if (!prop->sink_dpn_prop) 274 return -ENOMEM; 275 276 j = 0; 277 dpn = prop->sink_dpn_prop; 278 addr = prop->sink_ports; 279 for_each_set_bit(bit, &addr, 32) { 280 dpn[j].num = bit; 281 dpn[j].type = SDW_DPN_FULL; 282 dpn[j].simple_ch_prep_sm = true; 283 dpn[j].ch_prep_timeout = 10; 284 j++; 285 } 286 287 /* set the timeout values */ 288 prop->clk_stop_timeout = 1380; 289 290 /* wake-up event */ 291 prop->wake_capable = 1; 292 293 /* Three data lanes are supported by rt721-sdca codec */ 294 prop->lane_control_support = true; 295 296 return 0; 297 } 298 299 static int rt721_sdca_interrupt_callback(struct sdw_slave *slave, 300 struct sdw_slave_intr_status *status) 301 { 302 struct rt721_sdca_priv *rt721 = dev_get_drvdata(&slave->dev); 303 int ret, stat; 304 int count = 0, retry = 3; 305 unsigned int sdca_cascade, scp_sdca_stat1, scp_sdca_stat2 = 0; 306 307 if (cancel_delayed_work_sync(&rt721->jack_detect_work)) { 308 dev_warn(&slave->dev, "%s the pending delayed_work was cancelled", __func__); 309 /* avoid the HID owner doesn't change to device */ 310 if (rt721->scp_sdca_stat2) 311 scp_sdca_stat2 = rt721->scp_sdca_stat2; 312 } 313 314 /* 315 * The critical section below intentionally protects a rather large piece of code. 316 * We don't want to allow the system suspend to disable an interrupt while we are 317 * processing it, which could be problematic given the quirky SoundWire interrupt 318 * scheme. We do want however to prevent new workqueues from being scheduled if 319 * the disable_irq flag was set during system suspend. 320 */ 321 mutex_lock(&rt721->disable_irq_lock); 322 323 ret = sdw_read_no_pm(rt721->slave, SDW_SCP_SDCA_INT1); 324 if (ret < 0) 325 goto io_error; 326 327 rt721->scp_sdca_stat1 = ret; 328 ret = sdw_read_no_pm(rt721->slave, SDW_SCP_SDCA_INT2); 329 if (ret < 0) 330 goto io_error; 331 332 rt721->scp_sdca_stat2 = ret; 333 if (scp_sdca_stat2) 334 rt721->scp_sdca_stat2 |= scp_sdca_stat2; 335 do { 336 /* clear flag */ 337 ret = sdw_read_no_pm(rt721->slave, SDW_SCP_SDCA_INT1); 338 if (ret < 0) 339 goto io_error; 340 if (ret & SDW_SCP_SDCA_INTMASK_SDCA_0) { 341 ret = sdw_update_no_pm(rt721->slave, SDW_SCP_SDCA_INT1, 342 SDW_SCP_SDCA_INT_SDCA_0, SDW_SCP_SDCA_INT_SDCA_0); 343 if (ret < 0) 344 goto io_error; 345 } 346 ret = sdw_read_no_pm(rt721->slave, SDW_SCP_SDCA_INT2); 347 if (ret < 0) 348 goto io_error; 349 if (ret & SDW_SCP_SDCA_INTMASK_SDCA_8) { 350 ret = sdw_write_no_pm(rt721->slave, SDW_SCP_SDCA_INT2, 351 SDW_SCP_SDCA_INTMASK_SDCA_8); 352 if (ret < 0) 353 goto io_error; 354 } 355 356 /* check if flag clear or not */ 357 ret = sdw_read_no_pm(rt721->slave, SDW_DP0_INT); 358 if (ret < 0) 359 goto io_error; 360 sdca_cascade = ret & SDW_DP0_SDCA_CASCADE; 361 362 ret = sdw_read_no_pm(rt721->slave, SDW_SCP_SDCA_INT1); 363 if (ret < 0) 364 goto io_error; 365 scp_sdca_stat1 = ret & SDW_SCP_SDCA_INTMASK_SDCA_0; 366 367 ret = sdw_read_no_pm(rt721->slave, SDW_SCP_SDCA_INT2); 368 if (ret < 0) 369 goto io_error; 370 scp_sdca_stat2 = ret & SDW_SCP_SDCA_INTMASK_SDCA_8; 371 372 stat = scp_sdca_stat1 || scp_sdca_stat2 || sdca_cascade; 373 374 count++; 375 } while (stat != 0 && count < retry); 376 377 if (stat) 378 dev_warn(&slave->dev, 379 "%s scp_sdca_stat1=0x%x, scp_sdca_stat2=0x%x\n", __func__, 380 rt721->scp_sdca_stat1, rt721->scp_sdca_stat2); 381 ret = sdw_read_no_pm(rt721->slave, SDW_SCP_SDCA_INT1); 382 ret = sdw_read_no_pm(rt721->slave, SDW_SCP_SDCA_INT2); 383 384 if (status->sdca_cascade && !rt721->disable_irq) 385 mod_delayed_work(system_power_efficient_wq, 386 &rt721->jack_detect_work, msecs_to_jiffies(280)); 387 388 mutex_unlock(&rt721->disable_irq_lock); 389 390 return 0; 391 392 io_error: 393 mutex_unlock(&rt721->disable_irq_lock); 394 pr_err_ratelimited("IO error in %s, ret %d\n", __func__, ret); 395 return ret; 396 } 397 398 static const struct sdw_slave_ops rt721_sdca_slave_ops = { 399 .read_prop = rt721_sdca_read_prop, 400 .interrupt_callback = rt721_sdca_interrupt_callback, 401 .update_status = rt721_sdca_update_status, 402 }; 403 404 static int rt721_sdca_sdw_probe(struct sdw_slave *slave, 405 const struct sdw_device_id *id) 406 { 407 struct regmap *regmap, *mbq_regmap; 408 409 /* Regmap Initialization */ 410 mbq_regmap = devm_regmap_init_sdw_mbq(slave, &rt721_sdca_mbq_regmap); 411 if (IS_ERR(mbq_regmap)) 412 return PTR_ERR(mbq_regmap); 413 414 regmap = devm_regmap_init_sdw(slave, &rt721_sdca_regmap); 415 if (IS_ERR(regmap)) 416 return PTR_ERR(regmap); 417 418 return rt721_sdca_init(&slave->dev, regmap, mbq_regmap, slave); 419 } 420 421 static void rt721_sdca_sdw_remove(struct sdw_slave *slave) 422 { 423 struct rt721_sdca_priv *rt721 = dev_get_drvdata(&slave->dev); 424 425 if (rt721->hw_init) { 426 cancel_delayed_work_sync(&rt721->jack_detect_work); 427 cancel_delayed_work_sync(&rt721->jack_btn_check_work); 428 } 429 430 if (rt721->first_hw_init) 431 pm_runtime_disable(&slave->dev); 432 433 mutex_destroy(&rt721->calibrate_mutex); 434 mutex_destroy(&rt721->disable_irq_lock); 435 } 436 437 static const struct sdw_device_id rt721_sdca_id[] = { 438 SDW_SLAVE_ENTRY_EXT(0x025d, 0x721, 0x3, 0x1, 0), 439 {}, 440 }; 441 MODULE_DEVICE_TABLE(sdw, rt721_sdca_id); 442 443 static int rt721_sdca_dev_suspend(struct device *dev) 444 { 445 struct rt721_sdca_priv *rt721 = dev_get_drvdata(dev); 446 447 if (!rt721->hw_init) 448 return 0; 449 450 cancel_delayed_work_sync(&rt721->jack_detect_work); 451 cancel_delayed_work_sync(&rt721->jack_btn_check_work); 452 453 regcache_cache_only(rt721->regmap, true); 454 regcache_cache_only(rt721->mbq_regmap, true); 455 456 return 0; 457 } 458 459 static int rt721_sdca_dev_system_suspend(struct device *dev) 460 { 461 struct rt721_sdca_priv *rt721_sdca = dev_get_drvdata(dev); 462 struct sdw_slave *slave = dev_to_sdw_dev(dev); 463 int ret1, ret2; 464 465 if (!rt721_sdca->hw_init) 466 return 0; 467 468 /* 469 * prevent new interrupts from being handled after the 470 * deferred work completes and before the parent disables 471 * interrupts on the link 472 */ 473 scoped_guard(mutex, &rt721_sdca->disable_irq_lock) { 474 rt721_sdca->disable_irq = true; 475 ret1 = sdw_update_no_pm(slave, SDW_SCP_SDCA_INTMASK1, 476 SDW_SCP_SDCA_INTMASK_SDCA_0, 0); 477 ret2 = sdw_update_no_pm(slave, SDW_SCP_SDCA_INTMASK2, 478 SDW_SCP_SDCA_INTMASK_SDCA_8, 0); 479 } 480 481 if (ret1 < 0 || ret2 < 0) { 482 /* log but don't prevent suspend from happening */ 483 dev_dbg(&slave->dev, "%s: could not disable SDCA interrupts\n:", __func__); 484 } 485 486 return rt721_sdca_dev_suspend(dev); 487 } 488 489 #define RT721_PROBE_TIMEOUT 5000 490 491 static int rt721_sdca_dev_resume(struct device *dev) 492 { 493 struct sdw_slave *slave = dev_to_sdw_dev(dev); 494 struct rt721_sdca_priv *rt721 = dev_get_drvdata(dev); 495 int ret; 496 497 if (!rt721->first_hw_init) 498 return 0; 499 500 if (!slave->unattach_request) { 501 scoped_guard(mutex, &rt721->disable_irq_lock) { 502 if (rt721->disable_irq) { 503 sdw_write_no_pm(slave, SDW_SCP_SDCA_INTMASK1, 504 SDW_SCP_SDCA_INTMASK_SDCA_0); 505 sdw_write_no_pm(slave, SDW_SCP_SDCA_INTMASK2, 506 SDW_SCP_SDCA_INTMASK_SDCA_8); 507 rt721->disable_irq = false; 508 } 509 } 510 } 511 512 ret = sdw_slave_wait_for_init(slave, RT721_PROBE_TIMEOUT); 513 if (ret) { 514 sdw_show_ping_status(slave->bus, true); 515 return ret; 516 } 517 518 regcache_cache_only(rt721->regmap, false); 519 ret = regcache_sync(rt721->regmap); 520 if (ret) { 521 regcache_cache_only(rt721->regmap, true); 522 return ret; 523 } 524 525 regcache_cache_only(rt721->mbq_regmap, false); 526 ret = regcache_sync(rt721->mbq_regmap); 527 if (ret) { 528 regcache_cache_only(rt721->mbq_regmap, true); 529 regcache_cache_only(rt721->regmap, true); 530 return ret; 531 } 532 533 return 0; 534 } 535 536 static const struct dev_pm_ops rt721_sdca_pm = { 537 SYSTEM_SLEEP_PM_OPS(rt721_sdca_dev_system_suspend, rt721_sdca_dev_resume) 538 RUNTIME_PM_OPS(rt721_sdca_dev_suspend, rt721_sdca_dev_resume, NULL) 539 }; 540 541 static struct sdw_driver rt721_sdca_sdw_driver = { 542 .driver = { 543 .name = "rt721-sdca", 544 .owner = THIS_MODULE, 545 .pm = pm_ptr(&rt721_sdca_pm), 546 }, 547 .probe = rt721_sdca_sdw_probe, 548 .remove = rt721_sdca_sdw_remove, 549 .ops = &rt721_sdca_slave_ops, 550 .id_table = rt721_sdca_id, 551 }; 552 module_sdw_driver(rt721_sdca_sdw_driver); 553 554 MODULE_DESCRIPTION("ASoC RT721 SDCA SDW driver"); 555 MODULE_AUTHOR("Jack Yu <jack.yu@realtek.com>"); 556 MODULE_LICENSE("GPL"); 557