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