sof-client.h 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  1. /* SPDX-License-Identifier: GPL-2.0-only */
  2. #ifndef __SOC_SOF_CLIENT_H
  3. #define __SOC_SOF_CLIENT_H
  4. #include <linux/auxiliary_bus.h>
  5. #include <linux/device.h>
  6. #include <linux/list.h>
  7. #include <sound/sof.h>
  8. struct sof_ipc_fw_version;
  9. struct sof_ipc_cmd_hdr;
  10. struct snd_sof_dev;
  11. struct dentry;
  12. /**
  13. * struct sof_client_dev - SOF client device
  14. * @auxdev: auxiliary device
  15. * @sdev: pointer to SOF core device struct
  16. * @list: item in SOF core client dev list
  17. * @data: device specific data
  18. */
  19. struct sof_client_dev {
  20. struct auxiliary_device auxdev;
  21. struct snd_sof_dev *sdev;
  22. struct list_head list;
  23. void *data;
  24. };
  25. #define sof_client_dev_to_sof_dev(cdev) ((cdev)->sdev)
  26. #define auxiliary_dev_to_sof_client_dev(auxiliary_dev) \
  27. container_of(auxiliary_dev, struct sof_client_dev, auxdev)
  28. #define dev_to_sof_client_dev(dev) \
  29. container_of(to_auxiliary_dev(dev), struct sof_client_dev, auxdev)
  30. int sof_client_ipc_tx_message(struct sof_client_dev *cdev, void *ipc_msg,
  31. void *reply_data, size_t reply_bytes);
  32. struct dentry *sof_client_get_debugfs_root(struct sof_client_dev *cdev);
  33. struct device *sof_client_get_dma_dev(struct sof_client_dev *cdev);
  34. const struct sof_ipc_fw_version *sof_client_get_fw_version(struct sof_client_dev *cdev);
  35. size_t sof_client_get_ipc_max_payload_size(struct sof_client_dev *cdev);
  36. enum sof_ipc_type sof_client_get_ipc_type(struct sof_client_dev *cdev);
  37. /* module refcount management of SOF core */
  38. int sof_client_core_module_get(struct sof_client_dev *cdev);
  39. void sof_client_core_module_put(struct sof_client_dev *cdev);
  40. /* IPC notification */
  41. typedef void (*sof_client_event_callback)(struct sof_client_dev *cdev, void *msg_buf);
  42. int sof_client_register_ipc_rx_handler(struct sof_client_dev *cdev,
  43. u32 ipc_msg_type,
  44. sof_client_event_callback callback);
  45. void sof_client_unregister_ipc_rx_handler(struct sof_client_dev *cdev,
  46. u32 ipc_msg_type);
  47. /* DSP state notification and query */
  48. typedef void (*sof_client_fw_state_callback)(struct sof_client_dev *cdev,
  49. enum sof_fw_state state);
  50. int sof_client_register_fw_state_handler(struct sof_client_dev *cdev,
  51. sof_client_fw_state_callback callback);
  52. void sof_client_unregister_fw_state_handler(struct sof_client_dev *cdev);
  53. enum sof_fw_state sof_client_get_fw_state(struct sof_client_dev *cdev);
  54. #endif /* __SOC_SOF_CLIENT_H */