1 // SPDX-License-Identifier: GPL-2.0-only
3 // Copyright(c) 2022 Intel Corporation. All rights reserved.
5 // Authors: Ranjani Sridharan <ranjani.sridharan@linux.intel.com>
6 // Peter Ujfalusi <peter.ujfalusi@linux.intel.com>
9 #include <linux/debugfs.h>
10 #include <linux/errno.h>
11 #include <linux/list.h>
12 #include <linux/module.h>
13 #include <linux/mutex.h>
14 #include <linux/slab.h>
15 #include <sound/sof/ipc4/header.h>
17 #include "sof-client.h"
19 #include "ipc4-priv.h"
22 * struct sof_ipc_event_entry - IPC client event description
23 * @ipc_msg_type: IPC msg type of the event the client is interested
24 * @cdev: sof_client_dev of the requesting client
25 * @callback: Callback function of the client
26 * @list: item in SOF core client event list
28 struct sof_ipc_event_entry {
30 struct sof_client_dev *cdev;
31 sof_client_event_callback callback;
32 struct list_head list;
36 * struct sof_state_event_entry - DSP panic event subscription entry
37 * @cdev: sof_client_dev of the requesting client
38 * @callback: Callback function of the client
39 * @list: item in SOF core client event list
41 struct sof_state_event_entry {
42 struct sof_client_dev *cdev;
43 sof_client_fw_state_callback callback;
44 struct list_head list;
47 static void sof_client_auxdev_release(struct device *dev)
49 struct auxiliary_device *auxdev = to_auxiliary_dev(dev);
50 struct sof_client_dev *cdev = auxiliary_dev_to_sof_client_dev(auxdev);
52 kfree(cdev->auxdev.dev.platform_data);
56 static int sof_client_dev_add_data(struct sof_client_dev *cdev, const void *data,
62 d = kmemdup(data, size, GFP_KERNEL);
67 cdev->auxdev.dev.platform_data = d;
71 #if IS_ENABLED(CONFIG_SND_SOC_SOF_DEBUG_IPC_FLOOD_TEST)
72 static int sof_register_ipc_flood_test(struct snd_sof_dev *sdev)
77 if (sdev->pdata->ipc_type != SOF_IPC)
80 for (i = 0; i < CONFIG_SND_SOC_SOF_DEBUG_IPC_FLOOD_TEST_NUM; i++) {
81 ret = sof_client_dev_register(sdev, "ipc_flood", i, NULL, 0);
88 sof_client_dev_unregister(sdev, "ipc_flood", i);
94 static void sof_unregister_ipc_flood_test(struct snd_sof_dev *sdev)
98 for (i = 0; i < CONFIG_SND_SOC_SOF_DEBUG_IPC_FLOOD_TEST_NUM; i++)
99 sof_client_dev_unregister(sdev, "ipc_flood", i);
102 static inline int sof_register_ipc_flood_test(struct snd_sof_dev *sdev)
107 static inline void sof_unregister_ipc_flood_test(struct snd_sof_dev *sdev) {}
108 #endif /* CONFIG_SND_SOC_SOF_DEBUG_IPC_FLOOD_TEST */
110 #if IS_ENABLED(CONFIG_SND_SOC_SOF_DEBUG_IPC_MSG_INJECTOR)
111 static int sof_register_ipc_msg_injector(struct snd_sof_dev *sdev)
113 return sof_client_dev_register(sdev, "msg_injector", 0, NULL, 0);
116 static void sof_unregister_ipc_msg_injector(struct snd_sof_dev *sdev)
118 sof_client_dev_unregister(sdev, "msg_injector", 0);
121 static inline int sof_register_ipc_msg_injector(struct snd_sof_dev *sdev)
126 static inline void sof_unregister_ipc_msg_injector(struct snd_sof_dev *sdev) {}
127 #endif /* CONFIG_SND_SOC_SOF_DEBUG_IPC_MSG_INJECTOR */
129 int sof_register_clients(struct snd_sof_dev *sdev)
133 /* Register platform independent client devices */
134 ret = sof_register_ipc_flood_test(sdev);
136 dev_err(sdev->dev, "IPC flood test client registration failed\n");
140 ret = sof_register_ipc_msg_injector(sdev);
142 dev_err(sdev->dev, "IPC message injector client registration failed\n");
143 goto err_msg_injector;
146 /* Platform depndent client device registration */
148 if (sof_ops(sdev) && sof_ops(sdev)->register_ipc_clients)
149 ret = sof_ops(sdev)->register_ipc_clients(sdev);
154 sof_unregister_ipc_msg_injector(sdev);
157 sof_unregister_ipc_flood_test(sdev);
162 void sof_unregister_clients(struct snd_sof_dev *sdev)
164 if (sof_ops(sdev) && sof_ops(sdev)->unregister_ipc_clients)
165 sof_ops(sdev)->unregister_ipc_clients(sdev);
167 sof_unregister_ipc_msg_injector(sdev);
168 sof_unregister_ipc_flood_test(sdev);
171 int sof_client_dev_register(struct snd_sof_dev *sdev, const char *name, u32 id,
172 const void *data, size_t size)
174 struct auxiliary_device *auxdev;
175 struct sof_client_dev *cdev;
178 cdev = kzalloc(sizeof(*cdev), GFP_KERNEL);
183 auxdev = &cdev->auxdev;
185 auxdev->dev.parent = sdev->dev;
186 auxdev->dev.release = sof_client_auxdev_release;
189 ret = sof_client_dev_add_data(cdev, data, size);
191 goto err_dev_add_data;
193 ret = auxiliary_device_init(auxdev);
195 dev_err(sdev->dev, "failed to initialize client dev %s.%d\n", name, id);
199 ret = auxiliary_device_add(&cdev->auxdev);
201 dev_err(sdev->dev, "failed to add client dev %s.%d\n", name, id);
203 * sof_client_auxdev_release() will be invoked to free up memory
204 * allocations through put_device()
206 auxiliary_device_uninit(&cdev->auxdev);
210 /* add to list of SOF client devices */
211 mutex_lock(&sdev->ipc_client_mutex);
212 list_add(&cdev->list, &sdev->ipc_client_list);
213 mutex_unlock(&sdev->ipc_client_mutex);
218 kfree(cdev->auxdev.dev.platform_data);
225 EXPORT_SYMBOL_NS_GPL(sof_client_dev_register, SND_SOC_SOF_CLIENT);
227 void sof_client_dev_unregister(struct snd_sof_dev *sdev, const char *name, u32 id)
229 struct sof_client_dev *cdev;
231 mutex_lock(&sdev->ipc_client_mutex);
234 * sof_client_auxdev_release() will be invoked to free up memory
235 * allocations through put_device()
237 list_for_each_entry(cdev, &sdev->ipc_client_list, list) {
238 if (!strcmp(cdev->auxdev.name, name) && cdev->auxdev.id == id) {
239 list_del(&cdev->list);
240 auxiliary_device_delete(&cdev->auxdev);
241 auxiliary_device_uninit(&cdev->auxdev);
246 mutex_unlock(&sdev->ipc_client_mutex);
248 EXPORT_SYMBOL_NS_GPL(sof_client_dev_unregister, SND_SOC_SOF_CLIENT);
250 int sof_client_ipc_tx_message(struct sof_client_dev *cdev, void *ipc_msg,
251 void *reply_data, size_t reply_bytes)
253 if (cdev->sdev->pdata->ipc_type == SOF_IPC) {
254 struct sof_ipc_cmd_hdr *hdr = ipc_msg;
256 return sof_ipc_tx_message(cdev->sdev->ipc, ipc_msg, hdr->size,
257 reply_data, reply_bytes);
258 } else if (cdev->sdev->pdata->ipc_type == SOF_INTEL_IPC4) {
259 struct sof_ipc4_msg *msg = ipc_msg;
261 return sof_ipc_tx_message(cdev->sdev->ipc, ipc_msg, msg->data_size,
262 reply_data, reply_bytes);
267 EXPORT_SYMBOL_NS_GPL(sof_client_ipc_tx_message, SND_SOC_SOF_CLIENT);
269 int sof_client_ipc_set_get_data(struct sof_client_dev *cdev, void *ipc_msg,
272 if (cdev->sdev->pdata->ipc_type == SOF_IPC) {
273 struct sof_ipc_cmd_hdr *hdr = ipc_msg;
275 return sof_ipc_set_get_data(cdev->sdev->ipc, ipc_msg, hdr->size,
277 } else if (cdev->sdev->pdata->ipc_type == SOF_INTEL_IPC4) {
278 struct sof_ipc4_msg *msg = ipc_msg;
280 return sof_ipc_set_get_data(cdev->sdev->ipc, ipc_msg,
281 msg->data_size, set);
286 EXPORT_SYMBOL_NS_GPL(sof_client_ipc_set_get_data, SND_SOC_SOF_CLIENT);
288 #ifdef CONFIG_SND_SOC_SOF_INTEL_IPC4
289 struct sof_ipc4_fw_module *sof_client_ipc4_find_module(struct sof_client_dev *c, const guid_t *uuid)
291 struct snd_sof_dev *sdev = c->sdev;
293 if (sdev->pdata->ipc_type == SOF_INTEL_IPC4)
294 return sof_ipc4_find_module_by_uuid(sdev, uuid);
295 dev_err(sdev->dev, "Only supported with IPC4\n");
299 EXPORT_SYMBOL_NS_GPL(sof_client_ipc4_find_module, SND_SOC_SOF_CLIENT);
302 int sof_suspend_clients(struct snd_sof_dev *sdev, pm_message_t state)
304 struct auxiliary_driver *adrv;
305 struct sof_client_dev *cdev;
307 mutex_lock(&sdev->ipc_client_mutex);
309 list_for_each_entry(cdev, &sdev->ipc_client_list, list) {
310 /* Skip devices without loaded driver */
311 if (!cdev->auxdev.dev.driver)
314 adrv = to_auxiliary_drv(cdev->auxdev.dev.driver);
316 adrv->suspend(&cdev->auxdev, state);
319 mutex_unlock(&sdev->ipc_client_mutex);
323 EXPORT_SYMBOL_NS_GPL(sof_suspend_clients, SND_SOC_SOF_CLIENT);
325 int sof_resume_clients(struct snd_sof_dev *sdev)
327 struct auxiliary_driver *adrv;
328 struct sof_client_dev *cdev;
330 mutex_lock(&sdev->ipc_client_mutex);
332 list_for_each_entry(cdev, &sdev->ipc_client_list, list) {
333 /* Skip devices without loaded driver */
334 if (!cdev->auxdev.dev.driver)
337 adrv = to_auxiliary_drv(cdev->auxdev.dev.driver);
339 adrv->resume(&cdev->auxdev);
342 mutex_unlock(&sdev->ipc_client_mutex);
346 EXPORT_SYMBOL_NS_GPL(sof_resume_clients, SND_SOC_SOF_CLIENT);
348 struct dentry *sof_client_get_debugfs_root(struct sof_client_dev *cdev)
350 return cdev->sdev->debugfs_root;
352 EXPORT_SYMBOL_NS_GPL(sof_client_get_debugfs_root, SND_SOC_SOF_CLIENT);
354 /* DMA buffer allocation in client drivers must use the core SOF device */
355 struct device *sof_client_get_dma_dev(struct sof_client_dev *cdev)
357 return cdev->sdev->dev;
359 EXPORT_SYMBOL_NS_GPL(sof_client_get_dma_dev, SND_SOC_SOF_CLIENT);
361 const struct sof_ipc_fw_version *sof_client_get_fw_version(struct sof_client_dev *cdev)
363 struct snd_sof_dev *sdev = sof_client_dev_to_sof_dev(cdev);
365 return &sdev->fw_ready.version;
367 EXPORT_SYMBOL_NS_GPL(sof_client_get_fw_version, SND_SOC_SOF_CLIENT);
369 size_t sof_client_get_ipc_max_payload_size(struct sof_client_dev *cdev)
371 struct snd_sof_dev *sdev = sof_client_dev_to_sof_dev(cdev);
373 return sdev->ipc->max_payload_size;
375 EXPORT_SYMBOL_NS_GPL(sof_client_get_ipc_max_payload_size, SND_SOC_SOF_CLIENT);
377 enum sof_ipc_type sof_client_get_ipc_type(struct sof_client_dev *cdev)
379 struct snd_sof_dev *sdev = sof_client_dev_to_sof_dev(cdev);
381 return sdev->pdata->ipc_type;
383 EXPORT_SYMBOL_NS_GPL(sof_client_get_ipc_type, SND_SOC_SOF_CLIENT);
385 /* module refcount management of SOF core */
386 int sof_client_core_module_get(struct sof_client_dev *cdev)
388 struct snd_sof_dev *sdev = sof_client_dev_to_sof_dev(cdev);
390 if (!try_module_get(sdev->dev->driver->owner))
395 EXPORT_SYMBOL_NS_GPL(sof_client_core_module_get, SND_SOC_SOF_CLIENT);
397 void sof_client_core_module_put(struct sof_client_dev *cdev)
399 struct snd_sof_dev *sdev = sof_client_dev_to_sof_dev(cdev);
401 module_put(sdev->dev->driver->owner);
403 EXPORT_SYMBOL_NS_GPL(sof_client_core_module_put, SND_SOC_SOF_CLIENT);
405 /* IPC event handling */
406 void sof_client_ipc_rx_dispatcher(struct snd_sof_dev *sdev, void *msg_buf)
408 struct sof_ipc_event_entry *event;
411 if (sdev->pdata->ipc_type == SOF_IPC) {
412 struct sof_ipc_cmd_hdr *hdr = msg_buf;
414 msg_type = hdr->cmd & SOF_GLB_TYPE_MASK;
415 } else if (sdev->pdata->ipc_type == SOF_INTEL_IPC4) {
416 struct sof_ipc4_msg *msg = msg_buf;
418 msg_type = SOF_IPC4_NOTIFICATION_TYPE_GET(msg->primary);
420 dev_dbg_once(sdev->dev, "Not supported IPC version: %d\n",
421 sdev->pdata->ipc_type);
425 mutex_lock(&sdev->client_event_handler_mutex);
427 list_for_each_entry(event, &sdev->ipc_rx_handler_list, list) {
428 if (event->ipc_msg_type == msg_type)
429 event->callback(event->cdev, msg_buf);
432 mutex_unlock(&sdev->client_event_handler_mutex);
435 int sof_client_register_ipc_rx_handler(struct sof_client_dev *cdev,
437 sof_client_event_callback callback)
439 struct snd_sof_dev *sdev = sof_client_dev_to_sof_dev(cdev);
440 struct sof_ipc_event_entry *event;
445 if (cdev->sdev->pdata->ipc_type == SOF_IPC) {
446 if (!(ipc_msg_type & SOF_GLB_TYPE_MASK))
448 } else if (cdev->sdev->pdata->ipc_type == SOF_INTEL_IPC4) {
449 if (!(ipc_msg_type & SOF_IPC4_NOTIFICATION_TYPE_MASK))
452 dev_warn(sdev->dev, "%s: Not supported IPC version: %d\n",
453 __func__, sdev->pdata->ipc_type);
457 event = kmalloc(sizeof(*event), GFP_KERNEL);
461 event->ipc_msg_type = ipc_msg_type;
463 event->callback = callback;
465 /* add to list of SOF client devices */
466 mutex_lock(&sdev->client_event_handler_mutex);
467 list_add(&event->list, &sdev->ipc_rx_handler_list);
468 mutex_unlock(&sdev->client_event_handler_mutex);
472 EXPORT_SYMBOL_NS_GPL(sof_client_register_ipc_rx_handler, SND_SOC_SOF_CLIENT);
474 void sof_client_unregister_ipc_rx_handler(struct sof_client_dev *cdev,
477 struct snd_sof_dev *sdev = sof_client_dev_to_sof_dev(cdev);
478 struct sof_ipc_event_entry *event;
480 mutex_lock(&sdev->client_event_handler_mutex);
482 list_for_each_entry(event, &sdev->ipc_rx_handler_list, list) {
483 if (event->cdev == cdev && event->ipc_msg_type == ipc_msg_type) {
484 list_del(&event->list);
490 mutex_unlock(&sdev->client_event_handler_mutex);
492 EXPORT_SYMBOL_NS_GPL(sof_client_unregister_ipc_rx_handler, SND_SOC_SOF_CLIENT);
494 /*DSP state notification and query */
495 void sof_client_fw_state_dispatcher(struct snd_sof_dev *sdev)
497 struct sof_state_event_entry *event;
499 mutex_lock(&sdev->client_event_handler_mutex);
501 list_for_each_entry(event, &sdev->fw_state_handler_list, list)
502 event->callback(event->cdev, sdev->fw_state);
504 mutex_unlock(&sdev->client_event_handler_mutex);
507 int sof_client_register_fw_state_handler(struct sof_client_dev *cdev,
508 sof_client_fw_state_callback callback)
510 struct snd_sof_dev *sdev = sof_client_dev_to_sof_dev(cdev);
511 struct sof_state_event_entry *event;
516 event = kmalloc(sizeof(*event), GFP_KERNEL);
521 event->callback = callback;
523 /* add to list of SOF client devices */
524 mutex_lock(&sdev->client_event_handler_mutex);
525 list_add(&event->list, &sdev->fw_state_handler_list);
526 mutex_unlock(&sdev->client_event_handler_mutex);
530 EXPORT_SYMBOL_NS_GPL(sof_client_register_fw_state_handler, SND_SOC_SOF_CLIENT);
532 void sof_client_unregister_fw_state_handler(struct sof_client_dev *cdev)
534 struct snd_sof_dev *sdev = sof_client_dev_to_sof_dev(cdev);
535 struct sof_state_event_entry *event;
537 mutex_lock(&sdev->client_event_handler_mutex);
539 list_for_each_entry(event, &sdev->fw_state_handler_list, list) {
540 if (event->cdev == cdev) {
541 list_del(&event->list);
547 mutex_unlock(&sdev->client_event_handler_mutex);
549 EXPORT_SYMBOL_NS_GPL(sof_client_unregister_fw_state_handler, SND_SOC_SOF_CLIENT);
551 enum sof_fw_state sof_client_get_fw_state(struct sof_client_dev *cdev)
553 struct snd_sof_dev *sdev = sof_client_dev_to_sof_dev(cdev);
555 return sdev->fw_state;
557 EXPORT_SYMBOL_NS_GPL(sof_client_get_fw_state, SND_SOC_SOF_CLIENT);