sof-client.c 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523
  1. // SPDX-License-Identifier: GPL-2.0-only
  2. //
  3. // Copyright(c) 2022 Intel Corporation. All rights reserved.
  4. //
  5. // Authors: Ranjani Sridharan <[email protected]>
  6. // Peter Ujfalusi <[email protected]>
  7. //
  8. #include <linux/debugfs.h>
  9. #include <linux/errno.h>
  10. #include <linux/list.h>
  11. #include <linux/module.h>
  12. #include <linux/mutex.h>
  13. #include <linux/slab.h>
  14. #include <sound/sof/ipc4/header.h>
  15. #include "ops.h"
  16. #include "sof-client.h"
  17. #include "sof-priv.h"
  18. /**
  19. * struct sof_ipc_event_entry - IPC client event description
  20. * @ipc_msg_type: IPC msg type of the event the client is interested
  21. * @cdev: sof_client_dev of the requesting client
  22. * @callback: Callback function of the client
  23. * @list: item in SOF core client event list
  24. */
  25. struct sof_ipc_event_entry {
  26. u32 ipc_msg_type;
  27. struct sof_client_dev *cdev;
  28. sof_client_event_callback callback;
  29. struct list_head list;
  30. };
  31. /**
  32. * struct sof_state_event_entry - DSP panic event subscription entry
  33. * @cdev: sof_client_dev of the requesting client
  34. * @callback: Callback function of the client
  35. * @list: item in SOF core client event list
  36. */
  37. struct sof_state_event_entry {
  38. struct sof_client_dev *cdev;
  39. sof_client_fw_state_callback callback;
  40. struct list_head list;
  41. };
  42. static void sof_client_auxdev_release(struct device *dev)
  43. {
  44. struct auxiliary_device *auxdev = to_auxiliary_dev(dev);
  45. struct sof_client_dev *cdev = auxiliary_dev_to_sof_client_dev(auxdev);
  46. kfree(cdev->auxdev.dev.platform_data);
  47. kfree(cdev);
  48. }
  49. static int sof_client_dev_add_data(struct sof_client_dev *cdev, const void *data,
  50. size_t size)
  51. {
  52. void *d = NULL;
  53. if (data) {
  54. d = kmemdup(data, size, GFP_KERNEL);
  55. if (!d)
  56. return -ENOMEM;
  57. }
  58. cdev->auxdev.dev.platform_data = d;
  59. return 0;
  60. }
  61. #if IS_ENABLED(CONFIG_SND_SOC_SOF_DEBUG_IPC_FLOOD_TEST)
  62. static int sof_register_ipc_flood_test(struct snd_sof_dev *sdev)
  63. {
  64. int ret = 0;
  65. int i;
  66. if (sdev->pdata->ipc_type != SOF_IPC)
  67. return 0;
  68. for (i = 0; i < CONFIG_SND_SOC_SOF_DEBUG_IPC_FLOOD_TEST_NUM; i++) {
  69. ret = sof_client_dev_register(sdev, "ipc_flood", i, NULL, 0);
  70. if (ret < 0)
  71. break;
  72. }
  73. if (ret) {
  74. for (; i >= 0; --i)
  75. sof_client_dev_unregister(sdev, "ipc_flood", i);
  76. }
  77. return ret;
  78. }
  79. static void sof_unregister_ipc_flood_test(struct snd_sof_dev *sdev)
  80. {
  81. int i;
  82. for (i = 0; i < CONFIG_SND_SOC_SOF_DEBUG_IPC_FLOOD_TEST_NUM; i++)
  83. sof_client_dev_unregister(sdev, "ipc_flood", i);
  84. }
  85. #else
  86. static inline int sof_register_ipc_flood_test(struct snd_sof_dev *sdev)
  87. {
  88. return 0;
  89. }
  90. static inline void sof_unregister_ipc_flood_test(struct snd_sof_dev *sdev) {}
  91. #endif /* CONFIG_SND_SOC_SOF_DEBUG_IPC_FLOOD_TEST */
  92. #if IS_ENABLED(CONFIG_SND_SOC_SOF_DEBUG_IPC_MSG_INJECTOR)
  93. static int sof_register_ipc_msg_injector(struct snd_sof_dev *sdev)
  94. {
  95. return sof_client_dev_register(sdev, "msg_injector", 0, NULL, 0);
  96. }
  97. static void sof_unregister_ipc_msg_injector(struct snd_sof_dev *sdev)
  98. {
  99. sof_client_dev_unregister(sdev, "msg_injector", 0);
  100. }
  101. #else
  102. static inline int sof_register_ipc_msg_injector(struct snd_sof_dev *sdev)
  103. {
  104. return 0;
  105. }
  106. static inline void sof_unregister_ipc_msg_injector(struct snd_sof_dev *sdev) {}
  107. #endif /* CONFIG_SND_SOC_SOF_DEBUG_IPC_MSG_INJECTOR */
  108. int sof_register_clients(struct snd_sof_dev *sdev)
  109. {
  110. int ret;
  111. /* Register platform independent client devices */
  112. ret = sof_register_ipc_flood_test(sdev);
  113. if (ret) {
  114. dev_err(sdev->dev, "IPC flood test client registration failed\n");
  115. return ret;
  116. }
  117. ret = sof_register_ipc_msg_injector(sdev);
  118. if (ret) {
  119. dev_err(sdev->dev, "IPC message injector client registration failed\n");
  120. goto err_msg_injector;
  121. }
  122. /* Platform depndent client device registration */
  123. if (sof_ops(sdev) && sof_ops(sdev)->register_ipc_clients)
  124. ret = sof_ops(sdev)->register_ipc_clients(sdev);
  125. if (!ret)
  126. return 0;
  127. sof_unregister_ipc_msg_injector(sdev);
  128. err_msg_injector:
  129. sof_unregister_ipc_flood_test(sdev);
  130. return ret;
  131. }
  132. void sof_unregister_clients(struct snd_sof_dev *sdev)
  133. {
  134. if (sof_ops(sdev) && sof_ops(sdev)->unregister_ipc_clients)
  135. sof_ops(sdev)->unregister_ipc_clients(sdev);
  136. sof_unregister_ipc_msg_injector(sdev);
  137. sof_unregister_ipc_flood_test(sdev);
  138. }
  139. int sof_client_dev_register(struct snd_sof_dev *sdev, const char *name, u32 id,
  140. const void *data, size_t size)
  141. {
  142. struct auxiliary_device *auxdev;
  143. struct sof_client_dev *cdev;
  144. int ret;
  145. cdev = kzalloc(sizeof(*cdev), GFP_KERNEL);
  146. if (!cdev)
  147. return -ENOMEM;
  148. cdev->sdev = sdev;
  149. auxdev = &cdev->auxdev;
  150. auxdev->name = name;
  151. auxdev->dev.parent = sdev->dev;
  152. auxdev->dev.release = sof_client_auxdev_release;
  153. auxdev->id = id;
  154. ret = sof_client_dev_add_data(cdev, data, size);
  155. if (ret < 0)
  156. goto err_dev_add_data;
  157. ret = auxiliary_device_init(auxdev);
  158. if (ret < 0) {
  159. dev_err(sdev->dev, "failed to initialize client dev %s.%d\n", name, id);
  160. goto err_dev_init;
  161. }
  162. ret = auxiliary_device_add(&cdev->auxdev);
  163. if (ret < 0) {
  164. dev_err(sdev->dev, "failed to add client dev %s.%d\n", name, id);
  165. /*
  166. * sof_client_auxdev_release() will be invoked to free up memory
  167. * allocations through put_device()
  168. */
  169. auxiliary_device_uninit(&cdev->auxdev);
  170. return ret;
  171. }
  172. /* add to list of SOF client devices */
  173. mutex_lock(&sdev->ipc_client_mutex);
  174. list_add(&cdev->list, &sdev->ipc_client_list);
  175. mutex_unlock(&sdev->ipc_client_mutex);
  176. return 0;
  177. err_dev_init:
  178. kfree(cdev->auxdev.dev.platform_data);
  179. err_dev_add_data:
  180. kfree(cdev);
  181. return ret;
  182. }
  183. EXPORT_SYMBOL_NS_GPL(sof_client_dev_register, SND_SOC_SOF_CLIENT);
  184. void sof_client_dev_unregister(struct snd_sof_dev *sdev, const char *name, u32 id)
  185. {
  186. struct sof_client_dev *cdev;
  187. mutex_lock(&sdev->ipc_client_mutex);
  188. /*
  189. * sof_client_auxdev_release() will be invoked to free up memory
  190. * allocations through put_device()
  191. */
  192. list_for_each_entry(cdev, &sdev->ipc_client_list, list) {
  193. if (!strcmp(cdev->auxdev.name, name) && cdev->auxdev.id == id) {
  194. list_del(&cdev->list);
  195. auxiliary_device_delete(&cdev->auxdev);
  196. auxiliary_device_uninit(&cdev->auxdev);
  197. break;
  198. }
  199. }
  200. mutex_unlock(&sdev->ipc_client_mutex);
  201. }
  202. EXPORT_SYMBOL_NS_GPL(sof_client_dev_unregister, SND_SOC_SOF_CLIENT);
  203. int sof_client_ipc_tx_message(struct sof_client_dev *cdev, void *ipc_msg,
  204. void *reply_data, size_t reply_bytes)
  205. {
  206. if (cdev->sdev->pdata->ipc_type == SOF_IPC) {
  207. struct sof_ipc_cmd_hdr *hdr = ipc_msg;
  208. return sof_ipc_tx_message(cdev->sdev->ipc, ipc_msg, hdr->size,
  209. reply_data, reply_bytes);
  210. } else if (cdev->sdev->pdata->ipc_type == SOF_INTEL_IPC4) {
  211. struct sof_ipc4_msg *msg = ipc_msg;
  212. return sof_ipc_tx_message(cdev->sdev->ipc, ipc_msg, msg->data_size,
  213. reply_data, reply_bytes);
  214. }
  215. return -EINVAL;
  216. }
  217. EXPORT_SYMBOL_NS_GPL(sof_client_ipc_tx_message, SND_SOC_SOF_CLIENT);
  218. int sof_suspend_clients(struct snd_sof_dev *sdev, pm_message_t state)
  219. {
  220. struct auxiliary_driver *adrv;
  221. struct sof_client_dev *cdev;
  222. mutex_lock(&sdev->ipc_client_mutex);
  223. list_for_each_entry(cdev, &sdev->ipc_client_list, list) {
  224. /* Skip devices without loaded driver */
  225. if (!cdev->auxdev.dev.driver)
  226. continue;
  227. adrv = to_auxiliary_drv(cdev->auxdev.dev.driver);
  228. if (adrv->suspend)
  229. adrv->suspend(&cdev->auxdev, state);
  230. }
  231. mutex_unlock(&sdev->ipc_client_mutex);
  232. return 0;
  233. }
  234. EXPORT_SYMBOL_NS_GPL(sof_suspend_clients, SND_SOC_SOF_CLIENT);
  235. int sof_resume_clients(struct snd_sof_dev *sdev)
  236. {
  237. struct auxiliary_driver *adrv;
  238. struct sof_client_dev *cdev;
  239. mutex_lock(&sdev->ipc_client_mutex);
  240. list_for_each_entry(cdev, &sdev->ipc_client_list, list) {
  241. /* Skip devices without loaded driver */
  242. if (!cdev->auxdev.dev.driver)
  243. continue;
  244. adrv = to_auxiliary_drv(cdev->auxdev.dev.driver);
  245. if (adrv->resume)
  246. adrv->resume(&cdev->auxdev);
  247. }
  248. mutex_unlock(&sdev->ipc_client_mutex);
  249. return 0;
  250. }
  251. EXPORT_SYMBOL_NS_GPL(sof_resume_clients, SND_SOC_SOF_CLIENT);
  252. struct dentry *sof_client_get_debugfs_root(struct sof_client_dev *cdev)
  253. {
  254. return cdev->sdev->debugfs_root;
  255. }
  256. EXPORT_SYMBOL_NS_GPL(sof_client_get_debugfs_root, SND_SOC_SOF_CLIENT);
  257. /* DMA buffer allocation in client drivers must use the core SOF device */
  258. struct device *sof_client_get_dma_dev(struct sof_client_dev *cdev)
  259. {
  260. return cdev->sdev->dev;
  261. }
  262. EXPORT_SYMBOL_NS_GPL(sof_client_get_dma_dev, SND_SOC_SOF_CLIENT);
  263. const struct sof_ipc_fw_version *sof_client_get_fw_version(struct sof_client_dev *cdev)
  264. {
  265. struct snd_sof_dev *sdev = sof_client_dev_to_sof_dev(cdev);
  266. return &sdev->fw_ready.version;
  267. }
  268. EXPORT_SYMBOL_NS_GPL(sof_client_get_fw_version, SND_SOC_SOF_CLIENT);
  269. size_t sof_client_get_ipc_max_payload_size(struct sof_client_dev *cdev)
  270. {
  271. struct snd_sof_dev *sdev = sof_client_dev_to_sof_dev(cdev);
  272. return sdev->ipc->max_payload_size;
  273. }
  274. EXPORT_SYMBOL_NS_GPL(sof_client_get_ipc_max_payload_size, SND_SOC_SOF_CLIENT);
  275. enum sof_ipc_type sof_client_get_ipc_type(struct sof_client_dev *cdev)
  276. {
  277. struct snd_sof_dev *sdev = sof_client_dev_to_sof_dev(cdev);
  278. return sdev->pdata->ipc_type;
  279. }
  280. EXPORT_SYMBOL_NS_GPL(sof_client_get_ipc_type, SND_SOC_SOF_CLIENT);
  281. /* module refcount management of SOF core */
  282. int sof_client_core_module_get(struct sof_client_dev *cdev)
  283. {
  284. struct snd_sof_dev *sdev = sof_client_dev_to_sof_dev(cdev);
  285. if (!try_module_get(sdev->dev->driver->owner))
  286. return -ENODEV;
  287. return 0;
  288. }
  289. EXPORT_SYMBOL_NS_GPL(sof_client_core_module_get, SND_SOC_SOF_CLIENT);
  290. void sof_client_core_module_put(struct sof_client_dev *cdev)
  291. {
  292. struct snd_sof_dev *sdev = sof_client_dev_to_sof_dev(cdev);
  293. module_put(sdev->dev->driver->owner);
  294. }
  295. EXPORT_SYMBOL_NS_GPL(sof_client_core_module_put, SND_SOC_SOF_CLIENT);
  296. /* IPC event handling */
  297. void sof_client_ipc_rx_dispatcher(struct snd_sof_dev *sdev, void *msg_buf)
  298. {
  299. struct sof_ipc_event_entry *event;
  300. u32 msg_type;
  301. if (sdev->pdata->ipc_type == SOF_IPC) {
  302. struct sof_ipc_cmd_hdr *hdr = msg_buf;
  303. msg_type = hdr->cmd & SOF_GLB_TYPE_MASK;
  304. } else if (sdev->pdata->ipc_type == SOF_INTEL_IPC4) {
  305. struct sof_ipc4_msg *msg = msg_buf;
  306. msg_type = SOF_IPC4_NOTIFICATION_TYPE_GET(msg->primary);
  307. } else {
  308. dev_dbg_once(sdev->dev, "Not supported IPC version: %d\n",
  309. sdev->pdata->ipc_type);
  310. return;
  311. }
  312. mutex_lock(&sdev->client_event_handler_mutex);
  313. list_for_each_entry(event, &sdev->ipc_rx_handler_list, list) {
  314. if (event->ipc_msg_type == msg_type)
  315. event->callback(event->cdev, msg_buf);
  316. }
  317. mutex_unlock(&sdev->client_event_handler_mutex);
  318. }
  319. int sof_client_register_ipc_rx_handler(struct sof_client_dev *cdev,
  320. u32 ipc_msg_type,
  321. sof_client_event_callback callback)
  322. {
  323. struct snd_sof_dev *sdev = sof_client_dev_to_sof_dev(cdev);
  324. struct sof_ipc_event_entry *event;
  325. if (!callback)
  326. return -EINVAL;
  327. if (cdev->sdev->pdata->ipc_type == SOF_IPC) {
  328. if (!(ipc_msg_type & SOF_GLB_TYPE_MASK))
  329. return -EINVAL;
  330. } else if (cdev->sdev->pdata->ipc_type == SOF_INTEL_IPC4) {
  331. if (!(ipc_msg_type & SOF_IPC4_NOTIFICATION_TYPE_MASK))
  332. return -EINVAL;
  333. } else {
  334. dev_warn(sdev->dev, "%s: Not supported IPC version: %d\n",
  335. __func__, sdev->pdata->ipc_type);
  336. return -EINVAL;
  337. }
  338. event = kmalloc(sizeof(*event), GFP_KERNEL);
  339. if (!event)
  340. return -ENOMEM;
  341. event->ipc_msg_type = ipc_msg_type;
  342. event->cdev = cdev;
  343. event->callback = callback;
  344. /* add to list of SOF client devices */
  345. mutex_lock(&sdev->client_event_handler_mutex);
  346. list_add(&event->list, &sdev->ipc_rx_handler_list);
  347. mutex_unlock(&sdev->client_event_handler_mutex);
  348. return 0;
  349. }
  350. EXPORT_SYMBOL_NS_GPL(sof_client_register_ipc_rx_handler, SND_SOC_SOF_CLIENT);
  351. void sof_client_unregister_ipc_rx_handler(struct sof_client_dev *cdev,
  352. u32 ipc_msg_type)
  353. {
  354. struct snd_sof_dev *sdev = sof_client_dev_to_sof_dev(cdev);
  355. struct sof_ipc_event_entry *event;
  356. mutex_lock(&sdev->client_event_handler_mutex);
  357. list_for_each_entry(event, &sdev->ipc_rx_handler_list, list) {
  358. if (event->cdev == cdev && event->ipc_msg_type == ipc_msg_type) {
  359. list_del(&event->list);
  360. kfree(event);
  361. break;
  362. }
  363. }
  364. mutex_unlock(&sdev->client_event_handler_mutex);
  365. }
  366. EXPORT_SYMBOL_NS_GPL(sof_client_unregister_ipc_rx_handler, SND_SOC_SOF_CLIENT);
  367. /*DSP state notification and query */
  368. void sof_client_fw_state_dispatcher(struct snd_sof_dev *sdev)
  369. {
  370. struct sof_state_event_entry *event;
  371. mutex_lock(&sdev->client_event_handler_mutex);
  372. list_for_each_entry(event, &sdev->fw_state_handler_list, list)
  373. event->callback(event->cdev, sdev->fw_state);
  374. mutex_unlock(&sdev->client_event_handler_mutex);
  375. }
  376. int sof_client_register_fw_state_handler(struct sof_client_dev *cdev,
  377. sof_client_fw_state_callback callback)
  378. {
  379. struct snd_sof_dev *sdev = sof_client_dev_to_sof_dev(cdev);
  380. struct sof_state_event_entry *event;
  381. if (!callback)
  382. return -EINVAL;
  383. event = kmalloc(sizeof(*event), GFP_KERNEL);
  384. if (!event)
  385. return -ENOMEM;
  386. event->cdev = cdev;
  387. event->callback = callback;
  388. /* add to list of SOF client devices */
  389. mutex_lock(&sdev->client_event_handler_mutex);
  390. list_add(&event->list, &sdev->fw_state_handler_list);
  391. mutex_unlock(&sdev->client_event_handler_mutex);
  392. return 0;
  393. }
  394. EXPORT_SYMBOL_NS_GPL(sof_client_register_fw_state_handler, SND_SOC_SOF_CLIENT);
  395. void sof_client_unregister_fw_state_handler(struct sof_client_dev *cdev)
  396. {
  397. struct snd_sof_dev *sdev = sof_client_dev_to_sof_dev(cdev);
  398. struct sof_state_event_entry *event;
  399. mutex_lock(&sdev->client_event_handler_mutex);
  400. list_for_each_entry(event, &sdev->fw_state_handler_list, list) {
  401. if (event->cdev == cdev) {
  402. list_del(&event->list);
  403. kfree(event);
  404. break;
  405. }
  406. }
  407. mutex_unlock(&sdev->client_event_handler_mutex);
  408. }
  409. EXPORT_SYMBOL_NS_GPL(sof_client_unregister_fw_state_handler, SND_SOC_SOF_CLIENT);
  410. enum sof_fw_state sof_client_get_fw_state(struct sof_client_dev *cdev)
  411. {
  412. struct snd_sof_dev *sdev = sof_client_dev_to_sof_dev(cdev);
  413. return sdev->fw_state;
  414. }
  415. EXPORT_SYMBOL_NS_GPL(sof_client_get_fw_state, SND_SOC_SOF_CLIENT);