xref: /OK3568_Linux_fs/kernel/sound/soc/intel/common/sst-ipc.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-only */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * Intel SST generic IPC Support
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * Copyright (C) 2015, Intel Corporation. All rights reserved.
6*4882a593Smuzhiyun  */
7*4882a593Smuzhiyun 
8*4882a593Smuzhiyun #ifndef __SST_GENERIC_IPC_H
9*4882a593Smuzhiyun #define __SST_GENERIC_IPC_H
10*4882a593Smuzhiyun 
11*4882a593Smuzhiyun #include <linux/types.h>
12*4882a593Smuzhiyun #include <linux/kernel.h>
13*4882a593Smuzhiyun #include <linux/wait.h>
14*4882a593Smuzhiyun #include <linux/list.h>
15*4882a593Smuzhiyun #include <linux/workqueue.h>
16*4882a593Smuzhiyun #include <linux/sched.h>
17*4882a593Smuzhiyun 
18*4882a593Smuzhiyun struct sst_ipc_message {
19*4882a593Smuzhiyun 	u64 header;
20*4882a593Smuzhiyun 	void *data;
21*4882a593Smuzhiyun 	size_t size;
22*4882a593Smuzhiyun };
23*4882a593Smuzhiyun 
24*4882a593Smuzhiyun struct ipc_message {
25*4882a593Smuzhiyun 	struct list_head list;
26*4882a593Smuzhiyun 	struct sst_ipc_message tx;
27*4882a593Smuzhiyun 	struct sst_ipc_message rx;
28*4882a593Smuzhiyun 
29*4882a593Smuzhiyun 	wait_queue_head_t waitq;
30*4882a593Smuzhiyun 	bool pending;
31*4882a593Smuzhiyun 	bool complete;
32*4882a593Smuzhiyun 	bool wait;
33*4882a593Smuzhiyun 	int errno;
34*4882a593Smuzhiyun };
35*4882a593Smuzhiyun 
36*4882a593Smuzhiyun struct sst_generic_ipc;
37*4882a593Smuzhiyun struct sst_dsp;
38*4882a593Smuzhiyun 
39*4882a593Smuzhiyun struct sst_plat_ipc_ops {
40*4882a593Smuzhiyun 	void (*tx_msg)(struct sst_generic_ipc *, struct ipc_message *);
41*4882a593Smuzhiyun 	void (*shim_dbg)(struct sst_generic_ipc *, const char *);
42*4882a593Smuzhiyun 	void (*tx_data_copy)(struct ipc_message *, char *, size_t);
43*4882a593Smuzhiyun 	u64  (*reply_msg_match)(u64 header, u64 *mask);
44*4882a593Smuzhiyun 	bool (*is_dsp_busy)(struct sst_dsp *dsp);
45*4882a593Smuzhiyun 	int (*check_dsp_lp_on)(struct sst_dsp *dsp, bool state);
46*4882a593Smuzhiyun };
47*4882a593Smuzhiyun 
48*4882a593Smuzhiyun /* SST generic IPC data */
49*4882a593Smuzhiyun struct sst_generic_ipc {
50*4882a593Smuzhiyun 	struct device *dev;
51*4882a593Smuzhiyun 	struct sst_dsp *dsp;
52*4882a593Smuzhiyun 
53*4882a593Smuzhiyun 	/* IPC messaging */
54*4882a593Smuzhiyun 	struct list_head tx_list;
55*4882a593Smuzhiyun 	struct list_head rx_list;
56*4882a593Smuzhiyun 	struct list_head empty_list;
57*4882a593Smuzhiyun 	wait_queue_head_t wait_txq;
58*4882a593Smuzhiyun 	struct task_struct *tx_thread;
59*4882a593Smuzhiyun 	struct work_struct kwork;
60*4882a593Smuzhiyun 	bool pending;
61*4882a593Smuzhiyun 	struct ipc_message *msg;
62*4882a593Smuzhiyun 	int tx_data_max_size;
63*4882a593Smuzhiyun 	int rx_data_max_size;
64*4882a593Smuzhiyun 
65*4882a593Smuzhiyun 	struct sst_plat_ipc_ops ops;
66*4882a593Smuzhiyun };
67*4882a593Smuzhiyun 
68*4882a593Smuzhiyun int sst_ipc_tx_message_wait(struct sst_generic_ipc *ipc,
69*4882a593Smuzhiyun 	struct sst_ipc_message request, struct sst_ipc_message *reply);
70*4882a593Smuzhiyun 
71*4882a593Smuzhiyun int sst_ipc_tx_message_nowait(struct sst_generic_ipc *ipc,
72*4882a593Smuzhiyun 	struct sst_ipc_message request);
73*4882a593Smuzhiyun 
74*4882a593Smuzhiyun int sst_ipc_tx_message_nopm(struct sst_generic_ipc *ipc,
75*4882a593Smuzhiyun 	struct sst_ipc_message request, struct sst_ipc_message *reply);
76*4882a593Smuzhiyun 
77*4882a593Smuzhiyun struct ipc_message *sst_ipc_reply_find_msg(struct sst_generic_ipc *ipc,
78*4882a593Smuzhiyun 	u64 header);
79*4882a593Smuzhiyun 
80*4882a593Smuzhiyun void sst_ipc_tx_msg_reply_complete(struct sst_generic_ipc *ipc,
81*4882a593Smuzhiyun 	struct ipc_message *msg);
82*4882a593Smuzhiyun 
83*4882a593Smuzhiyun int sst_ipc_init(struct sst_generic_ipc *ipc);
84*4882a593Smuzhiyun void sst_ipc_fini(struct sst_generic_ipc *ipc);
85*4882a593Smuzhiyun 
86*4882a593Smuzhiyun #endif
87