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