rt711-sdw.c 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590
  1. // SPDX-License-Identifier: GPL-2.0
  2. //
  3. // rt711-sdw.c -- rt711 ALSA SoC audio driver
  4. //
  5. // Copyright(c) 2019 Realtek Semiconductor Corp.
  6. //
  7. //
  8. #include <linux/delay.h>
  9. #include <linux/device.h>
  10. #include <linux/mod_devicetable.h>
  11. #include <linux/soundwire/sdw.h>
  12. #include <linux/soundwire/sdw_type.h>
  13. #include <linux/soundwire/sdw_registers.h>
  14. #include <linux/module.h>
  15. #include <linux/pm_runtime.h>
  16. #include <linux/regmap.h>
  17. #include <sound/soc.h>
  18. #include "rt711.h"
  19. #include "rt711-sdw.h"
  20. static bool rt711_readable_register(struct device *dev, unsigned int reg)
  21. {
  22. switch (reg) {
  23. case 0x00e0:
  24. case 0x00f0:
  25. case 0x2012 ... 0x2016:
  26. case 0x201a ... 0x2027:
  27. case 0x2029 ... 0x202a:
  28. case 0x202d ... 0x2034:
  29. case 0x2201 ... 0x2204:
  30. case 0x2206 ... 0x2212:
  31. case 0x2220 ... 0x2223:
  32. case 0x2230 ... 0x2239:
  33. case 0x2f01 ... 0x2f0f:
  34. case 0x3000 ... 0x3fff:
  35. case 0x7000 ... 0x7fff:
  36. case 0x8300 ... 0x83ff:
  37. case 0x9c00 ... 0x9cff:
  38. case 0xb900 ... 0xb9ff:
  39. case 0x752009:
  40. case 0x752011:
  41. case 0x75201a:
  42. case 0x752045:
  43. case 0x752046:
  44. case 0x752048:
  45. case 0x75204a:
  46. case 0x75206b:
  47. case 0x75206f:
  48. case 0x752080:
  49. case 0x752081:
  50. case 0x752091:
  51. case 0x755800:
  52. return true;
  53. default:
  54. return false;
  55. }
  56. }
  57. static bool rt711_volatile_register(struct device *dev, unsigned int reg)
  58. {
  59. switch (reg) {
  60. case 0x2016:
  61. case 0x201b:
  62. case 0x201c:
  63. case 0x201d:
  64. case 0x201f:
  65. case 0x2021:
  66. case 0x2023:
  67. case 0x2230:
  68. case 0x2012 ... 0x2015: /* HD-A read */
  69. case 0x202d ... 0x202f: /* BRA */
  70. case 0x2201 ... 0x2212: /* i2c debug */
  71. case 0x2220 ... 0x2223: /* decoded HD-A */
  72. case 0x9c00 ... 0x9cff:
  73. case 0xb900 ... 0xb9ff:
  74. case 0xff01:
  75. case 0x75201a:
  76. case 0x752046:
  77. case 0x752080:
  78. case 0x752081:
  79. case 0x755800:
  80. return true;
  81. default:
  82. return false;
  83. }
  84. }
  85. static int rt711_sdw_read(void *context, unsigned int reg, unsigned int *val)
  86. {
  87. struct device *dev = context;
  88. struct rt711_priv *rt711 = dev_get_drvdata(dev);
  89. unsigned int sdw_data_3, sdw_data_2, sdw_data_1, sdw_data_0;
  90. unsigned int reg2 = 0, reg3 = 0, reg4 = 0, mask, nid, val2;
  91. unsigned int is_hda_reg = 1, is_index_reg = 0;
  92. int ret;
  93. if (reg > 0xffff)
  94. is_index_reg = 1;
  95. mask = reg & 0xf000;
  96. if (is_index_reg) { /* index registers */
  97. val2 = reg & 0xff;
  98. reg = reg >> 8;
  99. nid = reg & 0xff;
  100. ret = regmap_write(rt711->sdw_regmap, reg, 0);
  101. if (ret < 0)
  102. return ret;
  103. reg2 = reg + 0x1000;
  104. reg2 |= 0x80;
  105. ret = regmap_write(rt711->sdw_regmap, reg2, val2);
  106. if (ret < 0)
  107. return ret;
  108. reg3 = RT711_PRIV_DATA_R_H | nid;
  109. ret = regmap_write(rt711->sdw_regmap,
  110. reg3, ((*val >> 8) & 0xff));
  111. if (ret < 0)
  112. return ret;
  113. reg4 = reg3 + 0x1000;
  114. reg4 |= 0x80;
  115. ret = regmap_write(rt711->sdw_regmap, reg4, (*val & 0xff));
  116. if (ret < 0)
  117. return ret;
  118. } else if (mask == 0x3000) {
  119. reg += 0x8000;
  120. ret = regmap_write(rt711->sdw_regmap, reg, *val);
  121. if (ret < 0)
  122. return ret;
  123. } else if (mask == 0x7000) {
  124. reg += 0x2000;
  125. reg |= 0x800;
  126. ret = regmap_write(rt711->sdw_regmap,
  127. reg, ((*val >> 8) & 0xff));
  128. if (ret < 0)
  129. return ret;
  130. reg2 = reg + 0x1000;
  131. reg2 |= 0x80;
  132. ret = regmap_write(rt711->sdw_regmap, reg2, (*val & 0xff));
  133. if (ret < 0)
  134. return ret;
  135. } else if ((reg & 0xff00) == 0x8300) { /* for R channel */
  136. reg2 = reg - 0x1000;
  137. reg2 &= ~0x80;
  138. ret = regmap_write(rt711->sdw_regmap,
  139. reg2, ((*val >> 8) & 0xff));
  140. if (ret < 0)
  141. return ret;
  142. ret = regmap_write(rt711->sdw_regmap, reg, (*val & 0xff));
  143. if (ret < 0)
  144. return ret;
  145. } else if (mask == 0x9000) {
  146. ret = regmap_write(rt711->sdw_regmap,
  147. reg, ((*val >> 8) & 0xff));
  148. if (ret < 0)
  149. return ret;
  150. reg2 = reg + 0x1000;
  151. reg2 |= 0x80;
  152. ret = regmap_write(rt711->sdw_regmap, reg2, (*val & 0xff));
  153. if (ret < 0)
  154. return ret;
  155. } else if (mask == 0xb000) {
  156. ret = regmap_write(rt711->sdw_regmap, reg, *val);
  157. if (ret < 0)
  158. return ret;
  159. } else {
  160. ret = regmap_read(rt711->sdw_regmap, reg, val);
  161. if (ret < 0)
  162. return ret;
  163. is_hda_reg = 0;
  164. }
  165. if (is_hda_reg || is_index_reg) {
  166. sdw_data_3 = 0;
  167. sdw_data_2 = 0;
  168. sdw_data_1 = 0;
  169. sdw_data_0 = 0;
  170. ret = regmap_read(rt711->sdw_regmap,
  171. RT711_READ_HDA_3, &sdw_data_3);
  172. if (ret < 0)
  173. return ret;
  174. ret = regmap_read(rt711->sdw_regmap,
  175. RT711_READ_HDA_2, &sdw_data_2);
  176. if (ret < 0)
  177. return ret;
  178. ret = regmap_read(rt711->sdw_regmap,
  179. RT711_READ_HDA_1, &sdw_data_1);
  180. if (ret < 0)
  181. return ret;
  182. ret = regmap_read(rt711->sdw_regmap,
  183. RT711_READ_HDA_0, &sdw_data_0);
  184. if (ret < 0)
  185. return ret;
  186. *val = ((sdw_data_3 & 0xff) << 24) |
  187. ((sdw_data_2 & 0xff) << 16) |
  188. ((sdw_data_1 & 0xff) << 8) | (sdw_data_0 & 0xff);
  189. }
  190. if (is_hda_reg == 0)
  191. dev_dbg(dev, "[%s] %04x => %08x\n", __func__, reg, *val);
  192. else if (is_index_reg)
  193. dev_dbg(dev, "[%s] %04x %04x %04x %04x => %08x\n",
  194. __func__, reg, reg2, reg3, reg4, *val);
  195. else
  196. dev_dbg(dev, "[%s] %04x %04x => %08x\n",
  197. __func__, reg, reg2, *val);
  198. return 0;
  199. }
  200. static int rt711_sdw_write(void *context, unsigned int reg, unsigned int val)
  201. {
  202. struct device *dev = context;
  203. struct rt711_priv *rt711 = dev_get_drvdata(dev);
  204. unsigned int reg2 = 0, reg3, reg4, nid, mask, val2;
  205. unsigned int is_index_reg = 0;
  206. int ret;
  207. if (reg > 0xffff)
  208. is_index_reg = 1;
  209. mask = reg & 0xf000;
  210. if (is_index_reg) { /* index registers */
  211. val2 = reg & 0xff;
  212. reg = reg >> 8;
  213. nid = reg & 0xff;
  214. ret = regmap_write(rt711->sdw_regmap, reg, 0);
  215. if (ret < 0)
  216. return ret;
  217. reg2 = reg + 0x1000;
  218. reg2 |= 0x80;
  219. ret = regmap_write(rt711->sdw_regmap, reg2, val2);
  220. if (ret < 0)
  221. return ret;
  222. reg3 = RT711_PRIV_DATA_W_H | nid;
  223. ret = regmap_write(rt711->sdw_regmap,
  224. reg3, ((val >> 8) & 0xff));
  225. if (ret < 0)
  226. return ret;
  227. reg4 = reg3 + 0x1000;
  228. reg4 |= 0x80;
  229. ret = regmap_write(rt711->sdw_regmap, reg4, (val & 0xff));
  230. if (ret < 0)
  231. return ret;
  232. is_index_reg = 1;
  233. } else if (reg < 0x4fff) {
  234. ret = regmap_write(rt711->sdw_regmap, reg, val);
  235. if (ret < 0)
  236. return ret;
  237. } else if (reg == RT711_FUNC_RESET) {
  238. ret = regmap_write(rt711->sdw_regmap, reg, val);
  239. if (ret < 0)
  240. return ret;
  241. } else if (mask == 0x7000) {
  242. ret = regmap_write(rt711->sdw_regmap,
  243. reg, ((val >> 8) & 0xff));
  244. if (ret < 0)
  245. return ret;
  246. reg2 = reg + 0x1000;
  247. reg2 |= 0x80;
  248. ret = regmap_write(rt711->sdw_regmap, reg2, (val & 0xff));
  249. if (ret < 0)
  250. return ret;
  251. } else if ((reg & 0xff00) == 0x8300) { /* for R channel */
  252. reg2 = reg - 0x1000;
  253. reg2 &= ~0x80;
  254. ret = regmap_write(rt711->sdw_regmap,
  255. reg2, ((val >> 8) & 0xff));
  256. if (ret < 0)
  257. return ret;
  258. ret = regmap_write(rt711->sdw_regmap, reg, (val & 0xff));
  259. if (ret < 0)
  260. return ret;
  261. }
  262. if (reg2 == 0)
  263. dev_dbg(dev, "[%s] %04x <= %04x\n", __func__, reg, val);
  264. else if (is_index_reg)
  265. dev_dbg(dev, "[%s] %04x %04x %04x %04x <= %04x %04x\n",
  266. __func__, reg, reg2, reg3, reg4, val2, val);
  267. else
  268. dev_dbg(dev, "[%s] %04x %04x <= %04x\n",
  269. __func__, reg, reg2, val);
  270. return 0;
  271. }
  272. static const struct regmap_config rt711_regmap = {
  273. .reg_bits = 24,
  274. .val_bits = 32,
  275. .readable_reg = rt711_readable_register,
  276. .volatile_reg = rt711_volatile_register,
  277. .max_register = 0x755800,
  278. .reg_defaults = rt711_reg_defaults,
  279. .num_reg_defaults = ARRAY_SIZE(rt711_reg_defaults),
  280. .cache_type = REGCACHE_RBTREE,
  281. .use_single_read = true,
  282. .use_single_write = true,
  283. .reg_read = rt711_sdw_read,
  284. .reg_write = rt711_sdw_write,
  285. };
  286. static const struct regmap_config rt711_sdw_regmap = {
  287. .name = "sdw",
  288. .reg_bits = 32,
  289. .val_bits = 8,
  290. .readable_reg = rt711_readable_register,
  291. .max_register = 0xff01,
  292. .cache_type = REGCACHE_NONE,
  293. .use_single_read = true,
  294. .use_single_write = true,
  295. };
  296. static int rt711_update_status(struct sdw_slave *slave,
  297. enum sdw_slave_status status)
  298. {
  299. struct rt711_priv *rt711 = dev_get_drvdata(&slave->dev);
  300. /* Update the status */
  301. rt711->status = status;
  302. if (status == SDW_SLAVE_UNATTACHED)
  303. rt711->hw_init = false;
  304. /*
  305. * Perform initialization only if slave status is present and
  306. * hw_init flag is false
  307. */
  308. if (rt711->hw_init || rt711->status != SDW_SLAVE_ATTACHED)
  309. return 0;
  310. /* perform I/O transfers required for Slave initialization */
  311. return rt711_io_init(&slave->dev, slave);
  312. }
  313. static int rt711_read_prop(struct sdw_slave *slave)
  314. {
  315. struct sdw_slave_prop *prop = &slave->prop;
  316. int nval;
  317. int i, j;
  318. u32 bit;
  319. unsigned long addr;
  320. struct sdw_dpn_prop *dpn;
  321. prop->scp_int1_mask = SDW_SCP_INT1_IMPL_DEF | SDW_SCP_INT1_BUS_CLASH |
  322. SDW_SCP_INT1_PARITY;
  323. prop->quirks = SDW_SLAVE_QUIRKS_INVALID_INITIAL_PARITY;
  324. prop->paging_support = false;
  325. /* first we need to allocate memory for set bits in port lists */
  326. prop->source_ports = 0x14; /* BITMAP: 00010100 */
  327. prop->sink_ports = 0x8; /* BITMAP: 00001000 */
  328. nval = hweight32(prop->source_ports);
  329. prop->src_dpn_prop = devm_kcalloc(&slave->dev, nval,
  330. sizeof(*prop->src_dpn_prop),
  331. GFP_KERNEL);
  332. if (!prop->src_dpn_prop)
  333. return -ENOMEM;
  334. i = 0;
  335. dpn = prop->src_dpn_prop;
  336. addr = prop->source_ports;
  337. for_each_set_bit(bit, &addr, 32) {
  338. dpn[i].num = bit;
  339. dpn[i].type = SDW_DPN_FULL;
  340. dpn[i].simple_ch_prep_sm = true;
  341. dpn[i].ch_prep_timeout = 10;
  342. i++;
  343. }
  344. /* do this again for sink now */
  345. nval = hweight32(prop->sink_ports);
  346. prop->sink_dpn_prop = devm_kcalloc(&slave->dev, nval,
  347. sizeof(*prop->sink_dpn_prop),
  348. GFP_KERNEL);
  349. if (!prop->sink_dpn_prop)
  350. return -ENOMEM;
  351. j = 0;
  352. dpn = prop->sink_dpn_prop;
  353. addr = prop->sink_ports;
  354. for_each_set_bit(bit, &addr, 32) {
  355. dpn[j].num = bit;
  356. dpn[j].type = SDW_DPN_FULL;
  357. dpn[j].simple_ch_prep_sm = true;
  358. dpn[j].ch_prep_timeout = 10;
  359. j++;
  360. }
  361. /* set the timeout values */
  362. prop->clk_stop_timeout = 20;
  363. /* wake-up event */
  364. prop->wake_capable = 1;
  365. return 0;
  366. }
  367. static int rt711_bus_config(struct sdw_slave *slave,
  368. struct sdw_bus_params *params)
  369. {
  370. struct rt711_priv *rt711 = dev_get_drvdata(&slave->dev);
  371. int ret;
  372. memcpy(&rt711->params, params, sizeof(*params));
  373. ret = rt711_clock_config(&slave->dev);
  374. if (ret < 0)
  375. dev_err(&slave->dev, "Invalid clk config");
  376. return ret;
  377. }
  378. static int rt711_interrupt_callback(struct sdw_slave *slave,
  379. struct sdw_slave_intr_status *status)
  380. {
  381. struct rt711_priv *rt711 = dev_get_drvdata(&slave->dev);
  382. dev_dbg(&slave->dev,
  383. "%s control_port_stat=%x", __func__, status->control_port);
  384. mutex_lock(&rt711->disable_irq_lock);
  385. if (status->control_port & 0x4 && !rt711->disable_irq) {
  386. mod_delayed_work(system_power_efficient_wq,
  387. &rt711->jack_detect_work, msecs_to_jiffies(250));
  388. }
  389. mutex_unlock(&rt711->disable_irq_lock);
  390. return 0;
  391. }
  392. static const struct sdw_slave_ops rt711_slave_ops = {
  393. .read_prop = rt711_read_prop,
  394. .interrupt_callback = rt711_interrupt_callback,
  395. .update_status = rt711_update_status,
  396. .bus_config = rt711_bus_config,
  397. };
  398. static int rt711_sdw_probe(struct sdw_slave *slave,
  399. const struct sdw_device_id *id)
  400. {
  401. struct regmap *sdw_regmap, *regmap;
  402. /* Regmap Initialization */
  403. sdw_regmap = devm_regmap_init_sdw(slave, &rt711_sdw_regmap);
  404. if (IS_ERR(sdw_regmap))
  405. return PTR_ERR(sdw_regmap);
  406. regmap = devm_regmap_init(&slave->dev, NULL,
  407. &slave->dev, &rt711_regmap);
  408. if (IS_ERR(regmap))
  409. return PTR_ERR(regmap);
  410. rt711_init(&slave->dev, sdw_regmap, regmap, slave);
  411. return 0;
  412. }
  413. static int rt711_sdw_remove(struct sdw_slave *slave)
  414. {
  415. struct rt711_priv *rt711 = dev_get_drvdata(&slave->dev);
  416. if (rt711->hw_init) {
  417. cancel_delayed_work_sync(&rt711->jack_detect_work);
  418. cancel_delayed_work_sync(&rt711->jack_btn_check_work);
  419. cancel_work_sync(&rt711->calibration_work);
  420. }
  421. if (rt711->first_hw_init)
  422. pm_runtime_disable(&slave->dev);
  423. mutex_destroy(&rt711->calibrate_mutex);
  424. mutex_destroy(&rt711->disable_irq_lock);
  425. return 0;
  426. }
  427. static const struct sdw_device_id rt711_id[] = {
  428. SDW_SLAVE_ENTRY_EXT(0x025d, 0x711, 0x2, 0, 0),
  429. {},
  430. };
  431. MODULE_DEVICE_TABLE(sdw, rt711_id);
  432. static int __maybe_unused rt711_dev_suspend(struct device *dev)
  433. {
  434. struct rt711_priv *rt711 = dev_get_drvdata(dev);
  435. if (!rt711->hw_init)
  436. return 0;
  437. cancel_delayed_work_sync(&rt711->jack_detect_work);
  438. cancel_delayed_work_sync(&rt711->jack_btn_check_work);
  439. cancel_work_sync(&rt711->calibration_work);
  440. regcache_cache_only(rt711->regmap, true);
  441. return 0;
  442. }
  443. static int __maybe_unused rt711_dev_system_suspend(struct device *dev)
  444. {
  445. struct rt711_priv *rt711 = dev_get_drvdata(dev);
  446. struct sdw_slave *slave = dev_to_sdw_dev(dev);
  447. int ret;
  448. if (!rt711->hw_init)
  449. return 0;
  450. /*
  451. * prevent new interrupts from being handled after the
  452. * deferred work completes and before the parent disables
  453. * interrupts on the link
  454. */
  455. mutex_lock(&rt711->disable_irq_lock);
  456. rt711->disable_irq = true;
  457. ret = sdw_update_no_pm(slave, SDW_SCP_INTMASK1,
  458. SDW_SCP_INT1_IMPL_DEF, 0);
  459. mutex_unlock(&rt711->disable_irq_lock);
  460. if (ret < 0) {
  461. /* log but don't prevent suspend from happening */
  462. dev_dbg(&slave->dev, "%s: could not disable imp-def interrupts\n:", __func__);
  463. }
  464. return rt711_dev_suspend(dev);
  465. }
  466. #define RT711_PROBE_TIMEOUT 5000
  467. static int __maybe_unused rt711_dev_resume(struct device *dev)
  468. {
  469. struct sdw_slave *slave = dev_to_sdw_dev(dev);
  470. struct rt711_priv *rt711 = dev_get_drvdata(dev);
  471. unsigned long time;
  472. if (!rt711->first_hw_init)
  473. return 0;
  474. if (!slave->unattach_request) {
  475. if (rt711->disable_irq == true) {
  476. mutex_lock(&rt711->disable_irq_lock);
  477. sdw_write_no_pm(slave, SDW_SCP_INTMASK1, SDW_SCP_INT1_IMPL_DEF);
  478. rt711->disable_irq = false;
  479. mutex_unlock(&rt711->disable_irq_lock);
  480. }
  481. goto regmap_sync;
  482. }
  483. time = wait_for_completion_timeout(&slave->initialization_complete,
  484. msecs_to_jiffies(RT711_PROBE_TIMEOUT));
  485. if (!time) {
  486. dev_err(&slave->dev, "Initialization not complete, timed out\n");
  487. return -ETIMEDOUT;
  488. }
  489. regmap_sync:
  490. slave->unattach_request = 0;
  491. regcache_cache_only(rt711->regmap, false);
  492. regcache_sync_region(rt711->regmap, 0x3000, 0x8fff);
  493. regcache_sync_region(rt711->regmap, 0x752009, 0x752091);
  494. return 0;
  495. }
  496. static const struct dev_pm_ops rt711_pm = {
  497. SET_SYSTEM_SLEEP_PM_OPS(rt711_dev_system_suspend, rt711_dev_resume)
  498. SET_RUNTIME_PM_OPS(rt711_dev_suspend, rt711_dev_resume, NULL)
  499. };
  500. static struct sdw_driver rt711_sdw_driver = {
  501. .driver = {
  502. .name = "rt711",
  503. .owner = THIS_MODULE,
  504. .pm = &rt711_pm,
  505. },
  506. .probe = rt711_sdw_probe,
  507. .remove = rt711_sdw_remove,
  508. .ops = &rt711_slave_ops,
  509. .id_table = rt711_id,
  510. };
  511. module_sdw_driver(rt711_sdw_driver);
  512. MODULE_DESCRIPTION("ASoC RT711 SDW driver");
  513. MODULE_AUTHOR("Shuming Fan <[email protected]>");
  514. MODULE_LICENSE("GPL");