rt715-sdw.c 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599
  1. // SPDX-License-Identifier: GPL-2.0
  2. /*
  3. * rt715-sdw.c -- rt715 ALSA SoC audio driver
  4. *
  5. * Copyright(c) 2019 Realtek Semiconductor Corp.
  6. *
  7. * ALC715 ASoC Codec Driver based Intel Dummy SdW codec driver
  8. *
  9. */
  10. #include <linux/delay.h>
  11. #include <linux/device.h>
  12. #include <linux/mod_devicetable.h>
  13. #include <linux/soundwire/sdw.h>
  14. #include <linux/soundwire/sdw_type.h>
  15. #include <linux/soundwire/sdw_registers.h>
  16. #include <linux/module.h>
  17. #include <linux/pm_runtime.h>
  18. #include <linux/of.h>
  19. #include <linux/regmap.h>
  20. #include <sound/soc.h>
  21. #include "rt715.h"
  22. #include "rt715-sdw.h"
  23. static bool rt715_readable_register(struct device *dev, unsigned int reg)
  24. {
  25. switch (reg) {
  26. case 0x00e0 ... 0x00e5:
  27. case 0x00ee ... 0x00ef:
  28. case 0x00f0 ... 0x00f5:
  29. case 0x00fe ... 0x00ff:
  30. case 0x02e0:
  31. case 0x02f0:
  32. case 0x04e0:
  33. case 0x04f0:
  34. case 0x06e0:
  35. case 0x06f0:
  36. case 0x2000 ... 0x2016:
  37. case 0x201a ... 0x2027:
  38. case 0x2029 ... 0x202a:
  39. case 0x202d ... 0x2034:
  40. case 0x2200 ... 0x2204:
  41. case 0x2206 ... 0x2212:
  42. case 0x2220 ... 0x2223:
  43. case 0x2230 ... 0x2239:
  44. case 0x22f0 ... 0x22f3:
  45. case 0x3122:
  46. case 0x3123:
  47. case 0x3124:
  48. case 0x3125:
  49. case 0x3607:
  50. case 0x3608:
  51. case 0x3609:
  52. case 0x3610:
  53. case 0x3611:
  54. case 0x3627:
  55. case 0x3712:
  56. case 0x3713:
  57. case 0x3718:
  58. case 0x3719:
  59. case 0x371a:
  60. case 0x371b:
  61. case 0x371d:
  62. case 0x3729:
  63. case 0x385e:
  64. case 0x3859:
  65. case 0x4c12:
  66. case 0x4c13:
  67. case 0x4c1d:
  68. case 0x4c29:
  69. case 0x4d12:
  70. case 0x4d13:
  71. case 0x4d1d:
  72. case 0x4d29:
  73. case 0x4e12:
  74. case 0x4e13:
  75. case 0x4e1d:
  76. case 0x4e29:
  77. case 0x4f12:
  78. case 0x4f13:
  79. case 0x4f1d:
  80. case 0x4f29:
  81. case 0x7207:
  82. case 0x7208:
  83. case 0x7209:
  84. case 0x7227:
  85. case 0x7307:
  86. case 0x7308:
  87. case 0x7309:
  88. case 0x7312:
  89. case 0x7313:
  90. case 0x7318:
  91. case 0x7319:
  92. case 0x731a:
  93. case 0x731b:
  94. case 0x731d:
  95. case 0x7327:
  96. case 0x7329:
  97. case 0x8287:
  98. case 0x8288:
  99. case 0x8289:
  100. case 0x82a7:
  101. case 0x8387:
  102. case 0x8388:
  103. case 0x8389:
  104. case 0x8392:
  105. case 0x8393:
  106. case 0x8398:
  107. case 0x8399:
  108. case 0x839a:
  109. case 0x839b:
  110. case 0x839d:
  111. case 0x83a7:
  112. case 0x83a9:
  113. case 0x752039:
  114. return true;
  115. default:
  116. return false;
  117. }
  118. }
  119. static bool rt715_volatile_register(struct device *dev, unsigned int reg)
  120. {
  121. switch (reg) {
  122. case 0x00e5:
  123. case 0x00f0:
  124. case 0x00f3:
  125. case 0x00f5:
  126. case 0x2009:
  127. case 0x2016:
  128. case 0x201b:
  129. case 0x201c:
  130. case 0x201d:
  131. case 0x201f:
  132. case 0x2023:
  133. case 0x2230:
  134. case 0x200b ... 0x200e: /* i2c read */
  135. case 0x2012 ... 0x2015: /* HD-A read */
  136. case 0x202d ... 0x202f: /* BRA */
  137. case 0x2201 ... 0x2212: /* i2c debug */
  138. case 0x2220 ... 0x2223: /* decoded HD-A */
  139. return true;
  140. default:
  141. return false;
  142. }
  143. }
  144. static int rt715_sdw_read(void *context, unsigned int reg, unsigned int *val)
  145. {
  146. struct device *dev = context;
  147. struct rt715_priv *rt715 = dev_get_drvdata(dev);
  148. unsigned int sdw_data_3, sdw_data_2, sdw_data_1, sdw_data_0;
  149. unsigned int reg2 = 0, reg3 = 0, reg4 = 0, mask, nid, val2;
  150. unsigned int is_hda_reg = 1, is_index_reg = 0;
  151. int ret;
  152. if (reg > 0xffff)
  153. is_index_reg = 1;
  154. mask = reg & 0xf000;
  155. if (is_index_reg) { /* index registers */
  156. val2 = reg & 0xff;
  157. reg = reg >> 8;
  158. nid = reg & 0xff;
  159. ret = regmap_write(rt715->sdw_regmap, reg, 0);
  160. if (ret < 0)
  161. return ret;
  162. reg2 = reg + 0x1000;
  163. reg2 |= 0x80;
  164. ret = regmap_write(rt715->sdw_regmap, reg2, val2);
  165. if (ret < 0)
  166. return ret;
  167. reg3 = RT715_PRIV_DATA_R_H | nid;
  168. ret = regmap_write(rt715->sdw_regmap, reg3,
  169. ((*val >> 8) & 0xff));
  170. if (ret < 0)
  171. return ret;
  172. reg4 = reg3 + 0x1000;
  173. reg4 |= 0x80;
  174. ret = regmap_write(rt715->sdw_regmap, reg4, (*val & 0xff));
  175. if (ret < 0)
  176. return ret;
  177. } else if (mask == 0x3000) {
  178. reg += 0x8000;
  179. ret = regmap_write(rt715->sdw_regmap, reg, *val);
  180. if (ret < 0)
  181. return ret;
  182. } else if (mask == 0x7000) {
  183. reg += 0x2000;
  184. reg |= 0x800;
  185. ret = regmap_write(rt715->sdw_regmap, reg,
  186. ((*val >> 8) & 0xff));
  187. if (ret < 0)
  188. return ret;
  189. reg2 = reg + 0x1000;
  190. reg2 |= 0x80;
  191. ret = regmap_write(rt715->sdw_regmap, reg2, (*val & 0xff));
  192. if (ret < 0)
  193. return ret;
  194. } else if ((reg & 0xff00) == 0x8300) { /* for R channel */
  195. reg2 = reg - 0x1000;
  196. reg2 &= ~0x80;
  197. ret = regmap_write(rt715->sdw_regmap, reg2,
  198. ((*val >> 8) & 0xff));
  199. if (ret < 0)
  200. return ret;
  201. ret = regmap_write(rt715->sdw_regmap, reg, (*val & 0xff));
  202. if (ret < 0)
  203. return ret;
  204. } else if (mask == 0x9000) {
  205. ret = regmap_write(rt715->sdw_regmap, reg,
  206. ((*val >> 8) & 0xff));
  207. if (ret < 0)
  208. return ret;
  209. reg2 = reg + 0x1000;
  210. reg2 |= 0x80;
  211. ret = regmap_write(rt715->sdw_regmap, reg2, (*val & 0xff));
  212. if (ret < 0)
  213. return ret;
  214. } else if (mask == 0xb000) {
  215. ret = regmap_write(rt715->sdw_regmap, reg, *val);
  216. if (ret < 0)
  217. return ret;
  218. } else {
  219. ret = regmap_read(rt715->sdw_regmap, reg, val);
  220. if (ret < 0)
  221. return ret;
  222. is_hda_reg = 0;
  223. }
  224. if (is_hda_reg || is_index_reg) {
  225. sdw_data_3 = 0;
  226. sdw_data_2 = 0;
  227. sdw_data_1 = 0;
  228. sdw_data_0 = 0;
  229. ret = regmap_read(rt715->sdw_regmap, RT715_READ_HDA_3,
  230. &sdw_data_3);
  231. if (ret < 0)
  232. return ret;
  233. ret = regmap_read(rt715->sdw_regmap, RT715_READ_HDA_2,
  234. &sdw_data_2);
  235. if (ret < 0)
  236. return ret;
  237. ret = regmap_read(rt715->sdw_regmap, RT715_READ_HDA_1,
  238. &sdw_data_1);
  239. if (ret < 0)
  240. return ret;
  241. ret = regmap_read(rt715->sdw_regmap, RT715_READ_HDA_0,
  242. &sdw_data_0);
  243. if (ret < 0)
  244. return ret;
  245. *val = ((sdw_data_3 & 0xff) << 24) |
  246. ((sdw_data_2 & 0xff) << 16) |
  247. ((sdw_data_1 & 0xff) << 8) | (sdw_data_0 & 0xff);
  248. }
  249. if (is_hda_reg == 0)
  250. dev_dbg(dev, "[%s] %04x => %08x\n", __func__, reg, *val);
  251. else if (is_index_reg)
  252. dev_dbg(dev, "[%s] %04x %04x %04x %04x => %08x\n", __func__,
  253. reg, reg2, reg3, reg4, *val);
  254. else
  255. dev_dbg(dev, "[%s] %04x %04x => %08x\n",
  256. __func__, reg, reg2, *val);
  257. return 0;
  258. }
  259. static int rt715_sdw_write(void *context, unsigned int reg, unsigned int val)
  260. {
  261. struct device *dev = context;
  262. struct rt715_priv *rt715 = dev_get_drvdata(dev);
  263. unsigned int reg2 = 0, reg3, reg4, nid, mask, val2;
  264. unsigned int is_index_reg = 0;
  265. int ret;
  266. if (reg > 0xffff)
  267. is_index_reg = 1;
  268. mask = reg & 0xf000;
  269. if (is_index_reg) { /* index registers */
  270. val2 = reg & 0xff;
  271. reg = reg >> 8;
  272. nid = reg & 0xff;
  273. ret = regmap_write(rt715->sdw_regmap, reg, 0);
  274. if (ret < 0)
  275. return ret;
  276. reg2 = reg + 0x1000;
  277. reg2 |= 0x80;
  278. ret = regmap_write(rt715->sdw_regmap, reg2, val2);
  279. if (ret < 0)
  280. return ret;
  281. reg3 = RT715_PRIV_DATA_W_H | nid;
  282. ret = regmap_write(rt715->sdw_regmap, reg3,
  283. ((val >> 8) & 0xff));
  284. if (ret < 0)
  285. return ret;
  286. reg4 = reg3 + 0x1000;
  287. reg4 |= 0x80;
  288. ret = regmap_write(rt715->sdw_regmap, reg4, (val & 0xff));
  289. if (ret < 0)
  290. return ret;
  291. is_index_reg = 1;
  292. } else if (reg < 0x4fff) {
  293. ret = regmap_write(rt715->sdw_regmap, reg, val);
  294. if (ret < 0)
  295. return ret;
  296. } else if (reg == RT715_FUNC_RESET) {
  297. ret = regmap_write(rt715->sdw_regmap, reg, val);
  298. if (ret < 0)
  299. return ret;
  300. } else if (mask == 0x7000) {
  301. ret = regmap_write(rt715->sdw_regmap, reg,
  302. ((val >> 8) & 0xff));
  303. if (ret < 0)
  304. return ret;
  305. reg2 = reg + 0x1000;
  306. reg2 |= 0x80;
  307. ret = regmap_write(rt715->sdw_regmap, reg2, (val & 0xff));
  308. if (ret < 0)
  309. return ret;
  310. } else if ((reg & 0xff00) == 0x8300) { /* for R channel */
  311. reg2 = reg - 0x1000;
  312. reg2 &= ~0x80;
  313. ret = regmap_write(rt715->sdw_regmap, reg2,
  314. ((val >> 8) & 0xff));
  315. if (ret < 0)
  316. return ret;
  317. ret = regmap_write(rt715->sdw_regmap, reg, (val & 0xff));
  318. if (ret < 0)
  319. return ret;
  320. }
  321. if (reg2 == 0)
  322. dev_dbg(dev, "[%s] %04x <= %04x\n", __func__, reg, val);
  323. else if (is_index_reg)
  324. dev_dbg(dev, "[%s] %04x %04x %04x %04x <= %04x %04x\n",
  325. __func__, reg, reg2, reg3, reg4, val2, val);
  326. else
  327. dev_dbg(dev, "[%s] %04x %04x <= %04x\n",
  328. __func__, reg, reg2, val);
  329. return 0;
  330. }
  331. static const struct regmap_config rt715_regmap = {
  332. .reg_bits = 24,
  333. .val_bits = 32,
  334. .readable_reg = rt715_readable_register, /* Readable registers */
  335. .volatile_reg = rt715_volatile_register, /* volatile register */
  336. .max_register = 0x752039, /* Maximum number of register */
  337. .reg_defaults = rt715_reg_defaults, /* Defaults */
  338. .num_reg_defaults = ARRAY_SIZE(rt715_reg_defaults),
  339. .cache_type = REGCACHE_RBTREE,
  340. .use_single_read = true,
  341. .use_single_write = true,
  342. .reg_read = rt715_sdw_read,
  343. .reg_write = rt715_sdw_write,
  344. };
  345. static const struct regmap_config rt715_sdw_regmap = {
  346. .name = "sdw",
  347. .reg_bits = 32, /* Total register space for SDW */
  348. .val_bits = 8, /* Total number of bits in register */
  349. .max_register = 0xff01, /* Maximum number of register */
  350. .cache_type = REGCACHE_NONE,
  351. .use_single_read = true,
  352. .use_single_write = true,
  353. };
  354. int hda_to_sdw(unsigned int nid, unsigned int verb, unsigned int payload,
  355. unsigned int *sdw_addr_h, unsigned int *sdw_data_h,
  356. unsigned int *sdw_addr_l, unsigned int *sdw_data_l)
  357. {
  358. unsigned int offset_h, offset_l, e_verb;
  359. if (((verb & 0xff) != 0) || verb == 0xf00) { /* 12 bits command */
  360. if (verb == 0x7ff) /* special case */
  361. offset_h = 0;
  362. else
  363. offset_h = 0x3000;
  364. if (verb & 0x800) /* get command */
  365. e_verb = (verb - 0xf00) | 0x80;
  366. else /* set command */
  367. e_verb = (verb - 0x700);
  368. *sdw_data_h = payload; /* 7 bits payload */
  369. *sdw_addr_l = *sdw_data_l = 0;
  370. } else { /* 4 bits command */
  371. if ((verb & 0x800) == 0x800) { /* read */
  372. offset_h = 0x9000;
  373. offset_l = 0xa000;
  374. } else { /* write */
  375. offset_h = 0x7000;
  376. offset_l = 0x8000;
  377. }
  378. e_verb = verb >> 8;
  379. *sdw_data_h = (payload >> 8); /* 16 bits payload [15:8] */
  380. *sdw_addr_l = (e_verb << 8) | nid | 0x80; /* 0x80: valid bit */
  381. *sdw_addr_l += offset_l;
  382. *sdw_data_l = payload & 0xff;
  383. }
  384. *sdw_addr_h = (e_verb << 8) | nid;
  385. *sdw_addr_h += offset_h;
  386. return 0;
  387. }
  388. EXPORT_SYMBOL(hda_to_sdw);
  389. static int rt715_update_status(struct sdw_slave *slave,
  390. enum sdw_slave_status status)
  391. {
  392. struct rt715_priv *rt715 = dev_get_drvdata(&slave->dev);
  393. /* Update the status */
  394. rt715->status = status;
  395. /*
  396. * Perform initialization only if slave status is present and
  397. * hw_init flag is false
  398. */
  399. if (rt715->hw_init || rt715->status != SDW_SLAVE_ATTACHED)
  400. return 0;
  401. /* perform I/O transfers required for Slave initialization */
  402. return rt715_io_init(&slave->dev, slave);
  403. }
  404. static int rt715_read_prop(struct sdw_slave *slave)
  405. {
  406. struct sdw_slave_prop *prop = &slave->prop;
  407. int nval, i;
  408. u32 bit;
  409. unsigned long addr;
  410. struct sdw_dpn_prop *dpn;
  411. prop->scp_int1_mask = SDW_SCP_INT1_IMPL_DEF | SDW_SCP_INT1_BUS_CLASH |
  412. SDW_SCP_INT1_PARITY;
  413. prop->quirks = SDW_SLAVE_QUIRKS_INVALID_INITIAL_PARITY;
  414. prop->paging_support = false;
  415. /* first we need to allocate memory for set bits in port lists */
  416. prop->source_ports = 0x50;/* BITMAP: 01010000 */
  417. prop->sink_ports = 0x0; /* BITMAP: 00000000 */
  418. nval = hweight32(prop->source_ports);
  419. prop->src_dpn_prop = devm_kcalloc(&slave->dev, nval,
  420. sizeof(*prop->src_dpn_prop),
  421. GFP_KERNEL);
  422. if (!prop->src_dpn_prop)
  423. return -ENOMEM;
  424. dpn = prop->src_dpn_prop;
  425. i = 0;
  426. addr = prop->source_ports;
  427. for_each_set_bit(bit, &addr, 32) {
  428. dpn[i].num = bit;
  429. dpn[i].simple_ch_prep_sm = true;
  430. dpn[i].ch_prep_timeout = 10;
  431. i++;
  432. }
  433. /* set the timeout values */
  434. prop->clk_stop_timeout = 20;
  435. /* wake-up event */
  436. prop->wake_capable = 1;
  437. return 0;
  438. }
  439. static int rt715_bus_config(struct sdw_slave *slave,
  440. struct sdw_bus_params *params)
  441. {
  442. struct rt715_priv *rt715 = dev_get_drvdata(&slave->dev);
  443. int ret;
  444. memcpy(&rt715->params, params, sizeof(*params));
  445. ret = rt715_clock_config(&slave->dev);
  446. if (ret < 0)
  447. dev_err(&slave->dev, "Invalid clk config");
  448. return 0;
  449. }
  450. static const struct sdw_slave_ops rt715_slave_ops = {
  451. .read_prop = rt715_read_prop,
  452. .update_status = rt715_update_status,
  453. .bus_config = rt715_bus_config,
  454. };
  455. static int rt715_sdw_probe(struct sdw_slave *slave,
  456. const struct sdw_device_id *id)
  457. {
  458. struct regmap *sdw_regmap, *regmap;
  459. /* Regmap Initialization */
  460. sdw_regmap = devm_regmap_init_sdw(slave, &rt715_sdw_regmap);
  461. if (IS_ERR(sdw_regmap))
  462. return PTR_ERR(sdw_regmap);
  463. regmap = devm_regmap_init(&slave->dev, NULL, &slave->dev,
  464. &rt715_regmap);
  465. if (IS_ERR(regmap))
  466. return PTR_ERR(regmap);
  467. rt715_init(&slave->dev, sdw_regmap, regmap, slave);
  468. return 0;
  469. }
  470. static int rt715_sdw_remove(struct sdw_slave *slave)
  471. {
  472. struct rt715_priv *rt715 = dev_get_drvdata(&slave->dev);
  473. if (rt715->first_hw_init)
  474. pm_runtime_disable(&slave->dev);
  475. return 0;
  476. }
  477. static const struct sdw_device_id rt715_id[] = {
  478. SDW_SLAVE_ENTRY_EXT(0x025d, 0x714, 0x2, 0, 0),
  479. SDW_SLAVE_ENTRY_EXT(0x025d, 0x715, 0x2, 0, 0),
  480. {},
  481. };
  482. MODULE_DEVICE_TABLE(sdw, rt715_id);
  483. static int __maybe_unused rt715_dev_suspend(struct device *dev)
  484. {
  485. struct rt715_priv *rt715 = dev_get_drvdata(dev);
  486. if (!rt715->hw_init)
  487. return 0;
  488. regcache_cache_only(rt715->regmap, true);
  489. return 0;
  490. }
  491. #define RT715_PROBE_TIMEOUT 5000
  492. static int __maybe_unused rt715_dev_resume(struct device *dev)
  493. {
  494. struct sdw_slave *slave = dev_to_sdw_dev(dev);
  495. struct rt715_priv *rt715 = dev_get_drvdata(dev);
  496. unsigned long time;
  497. if (!rt715->first_hw_init)
  498. return 0;
  499. if (!slave->unattach_request)
  500. goto regmap_sync;
  501. time = wait_for_completion_timeout(&slave->initialization_complete,
  502. msecs_to_jiffies(RT715_PROBE_TIMEOUT));
  503. if (!time) {
  504. dev_err(&slave->dev, "Initialization not complete, timed out\n");
  505. sdw_show_ping_status(slave->bus, true);
  506. return -ETIMEDOUT;
  507. }
  508. regmap_sync:
  509. slave->unattach_request = 0;
  510. regcache_cache_only(rt715->regmap, false);
  511. regcache_sync_region(rt715->regmap, 0x3000, 0x8fff);
  512. regcache_sync_region(rt715->regmap, 0x752039, 0x752039);
  513. return 0;
  514. }
  515. static const struct dev_pm_ops rt715_pm = {
  516. SET_SYSTEM_SLEEP_PM_OPS(rt715_dev_suspend, rt715_dev_resume)
  517. SET_RUNTIME_PM_OPS(rt715_dev_suspend, rt715_dev_resume, NULL)
  518. };
  519. static struct sdw_driver rt715_sdw_driver = {
  520. .driver = {
  521. .name = "rt715",
  522. .owner = THIS_MODULE,
  523. .pm = &rt715_pm,
  524. },
  525. .probe = rt715_sdw_probe,
  526. .remove = rt715_sdw_remove,
  527. .ops = &rt715_slave_ops,
  528. .id_table = rt715_id,
  529. };
  530. module_sdw_driver(rt715_sdw_driver);
  531. MODULE_DESCRIPTION("ASoC RT715 driver SDW");
  532. MODULE_AUTHOR("Jack Yu <[email protected]>");
  533. MODULE_LICENSE("GPL v2");