swr-haptics.c 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531
  1. // SPDX-License-Identifier: GPL-2.0-only
  2. /*
  3. * Copyright (c) 2020, The Linux Foundation. All rights reserved.
  4. */
  5. #include <linux/device.h>
  6. #include <linux/init.h>
  7. #include <linux/module.h>
  8. #include <linux/platform_device.h>
  9. #include <linux/regmap.h>
  10. #include <linux/regulator/consumer.h>
  11. #include <linux/slab.h>
  12. #include <soc/soundwire.h>
  13. #include <sound/soc.h>
  14. #include <sound/soc-dapm.h>
  15. #define HAPTICS_RATES (SNDRV_PCM_RATE_8000 | SNDRV_PCM_RATE_16000 |\
  16. SNDRV_PCM_RATE_32000 | SNDRV_PCM_RATE_48000 |\
  17. SNDRV_PCM_RATE_96000 | SNDRV_PCM_RATE_192000 |\
  18. SNDRV_PCM_RATE_384000)
  19. #define HAPTICS_FORMATS (SNDRV_PCM_FMTBIT_S16_LE |\
  20. SNDRV_PCM_FMTBIT_S24_LE |\
  21. SNDRV_PCM_FMTBIT_S24_3LE | SNDRV_PCM_FMTBIT_S32_LE)
  22. /* SWR register definition */
  23. #define SWR_HAP_ACCESS_BASE 0x3000
  24. #define FIFO_WR_READY_REG (SWR_HAP_ACCESS_BASE + 0x8)
  25. #define NUM_PAT_SMPL_REG (SWR_HAP_ACCESS_BASE + 0x9)
  26. #define SWR_WR_ACCESS_REG (SWR_HAP_ACCESS_BASE + 0xa)
  27. #define CAL_TLRA_STATUS_MSB_REG (SWR_HAP_ACCESS_BASE + 0xb)
  28. #define CAL_TLRA_STATUS_LSB_REG (SWR_HAP_ACCESS_BASE + 0xc)
  29. #define AUTO_RES_CAL_DONE_REG (SWR_HAP_ACCESS_BASE + 0xd)
  30. #define SWR_READ_DATA_REG (SWR_HAP_ACCESS_BASE + 0x80)
  31. #define SWR_PLAY_REG (SWR_HAP_ACCESS_BASE + 0x81)
  32. #define SWR_VMAX_REG (SWR_HAP_ACCESS_BASE + 0x82)
  33. #define SWR_PLAY_BIT BIT(7)
  34. #define SWR_BRAKE_EN_BIT BIT(3)
  35. #define SWR_PLAY_SRC_MASK GENMASK(2, 0)
  36. #define SWR_PLAY_SRC_VAL_SWR 4
  37. #define SWR_HAP_REG_MAX (SWR_HAP_ACCESS_BASE + 0xff)
  38. static struct reg_default swr_hap_reg_defaults[] = {
  39. {FIFO_WR_READY_REG, 1},
  40. {NUM_PAT_SMPL_REG, 8},
  41. {SWR_WR_ACCESS_REG, 1},
  42. {CAL_TLRA_STATUS_MSB_REG, 0},
  43. {CAL_TLRA_STATUS_LSB_REG, 0},
  44. {AUTO_RES_CAL_DONE_REG, 0},
  45. {SWR_READ_DATA_REG, 0},
  46. {SWR_PLAY_REG, 4},
  47. {SWR_VMAX_REG, 0},
  48. };
  49. enum {
  50. PORT_ID_DT_IDX,
  51. NUM_CH_DT_IDX,
  52. CH_MASK_DT_IDX,
  53. CH_RATE_DT_IDX,
  54. PORT_TYPE_DT_IDX,
  55. NUM_SWR_PORT_DT_PARAMS,
  56. };
  57. struct swr_port {
  58. u8 port_id;
  59. u8 ch_mask;
  60. u32 ch_rate;
  61. u8 num_ch;
  62. u8 port_type;
  63. };
  64. struct swr_haptics_dev {
  65. struct device *dev;
  66. struct swr_device *swr_slave;
  67. struct snd_soc_component *component;
  68. struct regmap *regmap;
  69. struct swr_port port;
  70. struct regulator *vdd;
  71. };
  72. static bool swr_hap_volatile_register(struct device *dev, unsigned int reg)
  73. {
  74. switch (reg) {
  75. case SWR_READ_DATA_REG:
  76. case SWR_PLAY_REG:
  77. case SWR_VMAX_REG:
  78. return 1;
  79. default:
  80. return 0;
  81. }
  82. }
  83. static bool swr_hap_readable_register(struct device *dev, unsigned int reg)
  84. {
  85. if (reg <= SWR_HAP_ACCESS_BASE)
  86. return 0;
  87. return 1;
  88. }
  89. static bool swr_hap_writeable_register(struct device *dev, unsigned int reg)
  90. {
  91. if (reg <= SWR_HAP_ACCESS_BASE)
  92. return 0;
  93. switch (reg) {
  94. case FIFO_WR_READY_REG:
  95. case NUM_PAT_SMPL_REG:
  96. case SWR_WR_ACCESS_REG:
  97. case CAL_TLRA_STATUS_MSB_REG:
  98. case CAL_TLRA_STATUS_LSB_REG:
  99. case AUTO_RES_CAL_DONE_REG:
  100. case SWR_READ_DATA_REG:
  101. return 0;
  102. }
  103. return 1;
  104. }
  105. struct regmap_config swr_hap_regmap_config = {
  106. .reg_bits = 16,
  107. .val_bits = 8,
  108. .cache_type = REGCACHE_RBTREE,
  109. .reg_defaults = swr_hap_reg_defaults,
  110. .num_reg_defaults = ARRAY_SIZE(swr_hap_reg_defaults),
  111. .max_register = SWR_HAP_REG_MAX,
  112. .volatile_reg = swr_hap_volatile_register,
  113. .readable_reg = swr_hap_readable_register,
  114. .writeable_reg = swr_hap_writeable_register,
  115. .reg_format_endian = REGMAP_ENDIAN_NATIVE,
  116. .val_format_endian = REGMAP_ENDIAN_NATIVE,
  117. .can_multi_write = true,
  118. };
  119. static const struct snd_kcontrol_new hap_swr_dac_port[] = {
  120. SOC_DAPM_SINGLE("Switch", SND_SOC_NOPM, 0, 1, 0)
  121. };
  122. static int hap_enable_swr_dac_port(struct snd_soc_dapm_widget *w,
  123. struct snd_kcontrol *kcontrol, int event)
  124. {
  125. struct snd_soc_component *swr_hap_comp =
  126. snd_soc_dapm_to_component(w->dapm);
  127. struct swr_haptics_dev *swr_hap;
  128. u8 port_id, ch_mask, num_ch, port_type, num_port;
  129. u32 ch_rate;
  130. unsigned int val;
  131. int rc;
  132. if (!swr_hap_comp) {
  133. pr_err("%s: swr_hap_component is NULL\n", __func__);
  134. return -EINVAL;
  135. }
  136. swr_hap = snd_soc_component_get_drvdata(swr_hap_comp);
  137. if (!swr_hap) {
  138. pr_err("%s: get swr_haptics_dev failed\n", __func__);
  139. return -ENODEV;
  140. }
  141. dev_dbg(swr_hap->dev, "%s: %s event %d\n", __func__, w->name, event);
  142. num_port = 1;
  143. port_id = swr_hap->port.port_id;
  144. ch_mask = swr_hap->port.ch_mask;
  145. ch_rate = swr_hap->port.ch_rate;
  146. num_ch = swr_hap->port.num_ch;
  147. port_type = swr_hap->port.port_type;
  148. switch (event) {
  149. case SND_SOC_DAPM_PRE_PMU:
  150. swr_device_wakeup_vote(swr_hap->swr_slave);
  151. swr_connect_port(swr_hap->swr_slave, &port_id, num_port,
  152. &ch_mask, &ch_rate, &num_ch, &port_type);
  153. break;
  154. case SND_SOC_DAPM_POST_PMU:
  155. swr_slvdev_datapath_control(swr_hap->swr_slave,
  156. swr_hap->swr_slave->dev_num, true);
  157. /* trigger SWR play */
  158. val = SWR_PLAY_BIT | SWR_PLAY_SRC_VAL_SWR;
  159. rc = regmap_write(swr_hap->regmap, SWR_PLAY_REG, val);
  160. if (rc) {
  161. dev_err(swr_hap->dev, "%s: Enable SWR_PLAY failed, rc=%d\n",
  162. __func__, rc);
  163. return rc;
  164. }
  165. break;
  166. case SND_SOC_DAPM_PRE_PMD:
  167. /* stop SWR play */
  168. val = 0;
  169. rc = regmap_write(swr_hap->regmap, SWR_PLAY_REG, val);
  170. if (rc) {
  171. dev_err(swr_hap->dev, "%s: Enable SWR_PLAY failed, rc=%d\n",
  172. __func__, rc);
  173. return rc;
  174. }
  175. break;
  176. case SND_SOC_DAPM_POST_PMD:
  177. swr_disconnect_port(swr_hap->swr_slave, &port_id, num_port,
  178. &ch_mask, &port_type);
  179. swr_slvdev_datapath_control(swr_hap->swr_slave,
  180. swr_hap->swr_slave->dev_num, false);
  181. swr_device_wakeup_unvote(swr_hap->swr_slave);
  182. break;
  183. default:
  184. break;
  185. }
  186. return 0;
  187. }
  188. static const struct snd_soc_dapm_widget haptics_comp_dapm_widgets[] = {
  189. SND_SOC_DAPM_INPUT("HAP_IN"),
  190. SND_SOC_DAPM_MIXER_E("SWR DAC_Port", SND_SOC_NOPM, 0, 0,
  191. hap_swr_dac_port, ARRAY_SIZE(hap_swr_dac_port),
  192. hap_enable_swr_dac_port,
  193. SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMU |
  194. SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMD),
  195. SND_SOC_DAPM_SPK("HAP_OUT", NULL),
  196. };
  197. static const struct snd_soc_dapm_route haptics_comp_dapm_route[] = {
  198. {"SWR DAC_Port", "Switch", "HAP_IN"},
  199. {"HAP_OUT", NULL, "SWR DAC_Port"},
  200. };
  201. static int haptics_comp_probe(struct snd_soc_component *component)
  202. {
  203. struct snd_soc_dapm_context *dapm;
  204. struct swr_haptics_dev *swr_hap =
  205. snd_soc_component_get_drvdata(component);
  206. if (!swr_hap) {
  207. pr_err("%s: get swr_haptics_dev failed\n", __func__);
  208. return -EINVAL;
  209. }
  210. snd_soc_component_init_regmap(component, swr_hap->regmap);
  211. dapm = snd_soc_component_get_dapm(component);
  212. if (dapm && dapm->component) {
  213. snd_soc_dapm_ignore_suspend(dapm, "HAP_IN");
  214. snd_soc_dapm_ignore_suspend(dapm, "HAP_OUT");
  215. }
  216. return 0;
  217. }
  218. static void haptics_comp_remove(struct snd_soc_component *component)
  219. {
  220. }
  221. static const struct snd_soc_component_driver swr_haptics_component = {
  222. .name = "swr-haptics",
  223. .probe = haptics_comp_probe,
  224. .remove = haptics_comp_remove,
  225. .dapm_widgets = haptics_comp_dapm_widgets,
  226. .num_dapm_widgets = ARRAY_SIZE(haptics_comp_dapm_widgets),
  227. .dapm_routes = haptics_comp_dapm_route,
  228. .num_dapm_routes = ARRAY_SIZE(haptics_comp_dapm_route),
  229. };
  230. static struct snd_soc_dai_driver haptics_dai[] = {
  231. {
  232. .name = "swr_haptics",
  233. .playback = {
  234. .stream_name = "HAPTICS_AIF Playback",
  235. .rates = HAPTICS_RATES,
  236. .formats = HAPTICS_FORMATS,
  237. .rate_max = 192000,
  238. .rate_min = 8000,
  239. .channels_min = 1,
  240. .channels_max = 1,
  241. },
  242. },
  243. };
  244. static int swr_haptics_parse_port_mapping(struct swr_device *sdev)
  245. {
  246. struct swr_haptics_dev *swr_hap = swr_get_dev_data(sdev);
  247. u32 port_cfg[NUM_SWR_PORT_DT_PARAMS];
  248. int rc;
  249. if (!swr_hap) {
  250. dev_err(&sdev->dev, "%s: get swr_haptics_dev failed\n",
  251. __func__);
  252. return -EINVAL;
  253. }
  254. rc = of_property_read_u32_array(sdev->dev.of_node, "qcom,rx_swr_ch_map",
  255. port_cfg, NUM_SWR_PORT_DT_PARAMS);
  256. if (rc < 0) {
  257. dev_err(swr_hap->dev, "%s: Get qcom,rx_swr_ch_map failed, rc=%d\n",
  258. __func__, rc);
  259. return -EINVAL;
  260. }
  261. swr_hap->port.port_id = (u8) port_cfg[PORT_ID_DT_IDX];
  262. swr_hap->port.num_ch = (u8) port_cfg[NUM_CH_DT_IDX];
  263. swr_hap->port.ch_mask = (u8) port_cfg[CH_MASK_DT_IDX];
  264. swr_hap->port.ch_rate = port_cfg[CH_RATE_DT_IDX];
  265. swr_hap->port.port_type = (u8) port_cfg[PORT_TYPE_DT_IDX];
  266. dev_dbg(swr_hap->dev, "%s: port_id = %d, ch_mask = %d, ch_rate = %d, num_ch = %d, port_type = %d\n",
  267. __func__, swr_hap->port.port_id,
  268. swr_hap->port.ch_mask, swr_hap->port.ch_rate,
  269. swr_hap->port.num_ch, swr_hap->port.port_type);
  270. return 0;
  271. }
  272. static int swr_haptics_probe(struct swr_device *sdev)
  273. {
  274. struct swr_haptics_dev *swr_hap;
  275. int rc;
  276. u8 devnum;
  277. int retry = 5;
  278. swr_hap = devm_kzalloc(&sdev->dev,
  279. sizeof(struct swr_haptics_dev), GFP_KERNEL);
  280. if (!swr_hap)
  281. return -ENOMEM;
  282. swr_hap->swr_slave = sdev;
  283. swr_hap->dev = &sdev->dev;
  284. swr_set_dev_data(sdev, swr_hap);
  285. rc = swr_haptics_parse_port_mapping(sdev);
  286. if (rc < 0) {
  287. dev_err(swr_hap->dev, "%s: failed to parse swr port mapping, rc=%d\n",
  288. __func__, rc);
  289. goto clean;
  290. }
  291. swr_hap->vdd = devm_regulator_get(swr_hap->dev, "swr-slave");
  292. if (IS_ERR(swr_hap->vdd)) {
  293. rc = PTR_ERR(swr_hap->vdd);
  294. if (rc != -EPROBE_DEFER)
  295. dev_err(swr_hap->dev, "%s: get swr-slave-supply failed, rc=%d\n",
  296. __func__, rc);
  297. goto clean;
  298. }
  299. rc = regulator_enable(swr_hap->vdd);
  300. if (rc < 0) {
  301. dev_err(swr_hap->dev, "%s: enable swr-slave-vdd failed, rc=%d\n",
  302. __func__, rc);
  303. goto clean;
  304. }
  305. do {
  306. /* Add delay for soundwire enumeration */
  307. usleep_range(500, 510);
  308. rc = swr_get_logical_dev_num(sdev, sdev->addr, &devnum);
  309. } while (rc && --retry);
  310. if (rc) {
  311. dev_err(swr_hap->dev, "%s: failed to get devnum for swr-haptics, rc=%d\n",
  312. __func__, rc);
  313. rc = -EPROBE_DEFER;
  314. goto clean;
  315. }
  316. sdev->dev_num = devnum;
  317. swr_hap->regmap = devm_regmap_init_swr(sdev, &swr_hap_regmap_config);
  318. if (IS_ERR(swr_hap->regmap)) {
  319. rc = PTR_ERR(swr_hap->regmap);
  320. dev_err(swr_hap->dev, "%s: init regmap failed, rc=%d\n",
  321. __func__, rc);
  322. goto dev_err;
  323. }
  324. rc = snd_soc_register_component(&sdev->dev,
  325. &swr_haptics_component, haptics_dai, ARRAY_SIZE(haptics_dai));
  326. if (rc) {
  327. dev_err(swr_hap->dev, "%s: register swr_haptics component failed, rc=%d\n",
  328. __func__, rc);
  329. goto dev_err;
  330. }
  331. return 0;
  332. dev_err:
  333. regulator_disable(swr_hap->vdd);
  334. swr_remove_device(sdev);
  335. clean:
  336. swr_set_dev_data(sdev, NULL);
  337. return rc;
  338. }
  339. static int swr_haptics_remove(struct swr_device *sdev)
  340. {
  341. struct swr_haptics_dev *swr_hap;
  342. int rc = 0;
  343. swr_hap = swr_get_dev_data(sdev);
  344. if (!swr_hap) {
  345. dev_err(&sdev->dev, "%s: no data for swr_hap\n", __func__);
  346. rc = -ENODEV;
  347. goto clean;
  348. }
  349. rc = regulator_disable(swr_hap->vdd);
  350. if (rc < 0) {
  351. dev_err(swr_hap->dev, "%s: disable swr-slave failed, rc=%d\n",
  352. __func__, rc);
  353. goto clean;
  354. }
  355. clean:
  356. snd_soc_unregister_component(&sdev->dev);
  357. swr_set_dev_data(sdev, NULL);
  358. return rc;
  359. }
  360. static int swr_haptics_device_up(struct swr_device *sdev)
  361. {
  362. struct swr_haptics_dev *swr_hap;
  363. int rc;
  364. swr_hap = swr_get_dev_data(sdev);
  365. if (!swr_hap) {
  366. dev_err(&sdev->dev, "%s: no data for swr_hap\n", __func__);
  367. return -ENODEV;
  368. }
  369. /* Take SWR slave out of reset */
  370. rc = regulator_enable(swr_hap->vdd);
  371. if (rc < 0) {
  372. dev_err(swr_hap->dev, "%s: enable swr-slave failed, rc=%d\n",
  373. __func__, rc);
  374. return rc;
  375. }
  376. return 0;
  377. }
  378. static int swr_haptics_device_down(struct swr_device *sdev)
  379. {
  380. struct swr_haptics_dev *swr_hap = swr_get_dev_data(sdev);
  381. int rc;
  382. if (!swr_hap) {
  383. dev_err(&sdev->dev, "%s: no data for swr_hap\n", __func__);
  384. return -ENODEV;
  385. }
  386. /* Put SWR slave into reset */
  387. rc = regulator_disable(swr_hap->vdd);
  388. if (rc < 0) {
  389. dev_err(swr_hap->dev, "%s: disable swr-slave failed, rc=%d\n",
  390. __func__, rc);
  391. return rc;
  392. }
  393. return 0;
  394. }
  395. static int swr_haptics_suspend(struct device *dev)
  396. {
  397. struct swr_haptics_dev *swr_hap;
  398. int rc = 0;
  399. swr_hap = swr_get_dev_data(to_swr_device(dev));
  400. if (!swr_hap) {
  401. dev_err(dev, "%s: no data for swr_hap\n", __func__);
  402. return -ENODEV;
  403. }
  404. trace_printk("%s: suspended\n", __func__);
  405. return rc;
  406. }
  407. static int swr_haptics_resume(struct device *dev)
  408. {
  409. struct swr_haptics_dev *swr_hap;
  410. int rc = 0;
  411. swr_hap = swr_get_dev_data(to_swr_device(dev));
  412. if (!swr_hap) {
  413. dev_err(dev, "%s: no data for swr_hap\n", __func__);
  414. return -ENODEV;
  415. }
  416. trace_printk("%s: resumed\n", __func__);
  417. return rc;
  418. }
  419. static const struct of_device_id swr_haptics_match_table[] = {
  420. { .compatible = "qcom,swr-haptics", },
  421. { .compatible = "qcom,pm8350b-swr-haptics", },
  422. { },
  423. };
  424. static const struct swr_device_id swr_haptics_id[] = {
  425. {"swr-haptics", 0},
  426. {"pm8350b-swr-haptics", 0},
  427. {},
  428. };
  429. static const struct dev_pm_ops swr_haptics_pm_ops = {
  430. .suspend = swr_haptics_suspend,
  431. .resume = swr_haptics_resume,
  432. };
  433. static struct swr_driver swr_haptics_driver = {
  434. .driver = {
  435. .name = "swr-haptics",
  436. .owner = THIS_MODULE,
  437. .pm = &swr_haptics_pm_ops,
  438. .of_match_table = swr_haptics_match_table,
  439. },
  440. .probe = swr_haptics_probe,
  441. .remove = swr_haptics_remove,
  442. .id_table = swr_haptics_id,
  443. .device_up = swr_haptics_device_up,
  444. .device_down = swr_haptics_device_down,
  445. };
  446. static int __init swr_haptics_init(void)
  447. {
  448. return swr_driver_register(&swr_haptics_driver);
  449. }
  450. static void __exit swr_haptics_exit(void)
  451. {
  452. swr_driver_unregister(&swr_haptics_driver);
  453. }
  454. module_init(swr_haptics_init);
  455. module_exit(swr_haptics_exit);
  456. MODULE_DESCRIPTION("SWR haptics driver");
  457. MODULE_LICENSE("GPL v2");