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