xref: /OK3568_Linux_fs/kernel/drivers/net/wireless/quantenna/qtnfmac/shm_ipc.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0+ */
2*4882a593Smuzhiyun /* Copyright (c) 2015-2016 Quantenna Communications. All rights reserved. */
3*4882a593Smuzhiyun 
4*4882a593Smuzhiyun #ifndef _QTN_FMAC_SHM_IPC_H_
5*4882a593Smuzhiyun #define _QTN_FMAC_SHM_IPC_H_
6*4882a593Smuzhiyun 
7*4882a593Smuzhiyun #include <linux/workqueue.h>
8*4882a593Smuzhiyun #include <linux/completion.h>
9*4882a593Smuzhiyun #include <linux/mutex.h>
10*4882a593Smuzhiyun #include <linux/spinlock.h>
11*4882a593Smuzhiyun 
12*4882a593Smuzhiyun #include "shm_ipc_defs.h"
13*4882a593Smuzhiyun 
14*4882a593Smuzhiyun #define QTN_SHM_IPC_ACK_TIMEOUT		(2 * HZ)
15*4882a593Smuzhiyun 
16*4882a593Smuzhiyun struct qtnf_shm_ipc_int {
17*4882a593Smuzhiyun 	void (*fn)(void *arg);
18*4882a593Smuzhiyun 	void *arg;
19*4882a593Smuzhiyun };
20*4882a593Smuzhiyun 
21*4882a593Smuzhiyun struct qtnf_shm_ipc_rx_callback {
22*4882a593Smuzhiyun 	void (*fn)(void *arg, const u8 __iomem *buf, size_t len);
23*4882a593Smuzhiyun 	void *arg;
24*4882a593Smuzhiyun };
25*4882a593Smuzhiyun 
26*4882a593Smuzhiyun enum qtnf_shm_ipc_direction {
27*4882a593Smuzhiyun 	QTNF_SHM_IPC_OUTBOUND		= BIT(0),
28*4882a593Smuzhiyun 	QTNF_SHM_IPC_INBOUND		= BIT(1),
29*4882a593Smuzhiyun };
30*4882a593Smuzhiyun 
31*4882a593Smuzhiyun struct qtnf_shm_ipc {
32*4882a593Smuzhiyun 	struct qtnf_shm_ipc_region __iomem *shm_region;
33*4882a593Smuzhiyun 	enum qtnf_shm_ipc_direction direction;
34*4882a593Smuzhiyun 	size_t tx_packet_count;
35*4882a593Smuzhiyun 	size_t rx_packet_count;
36*4882a593Smuzhiyun 
37*4882a593Smuzhiyun 	size_t tx_timeout_count;
38*4882a593Smuzhiyun 
39*4882a593Smuzhiyun 	u8 waiting_for_ack;
40*4882a593Smuzhiyun 
41*4882a593Smuzhiyun 	struct qtnf_shm_ipc_int interrupt;
42*4882a593Smuzhiyun 	struct qtnf_shm_ipc_rx_callback rx_callback;
43*4882a593Smuzhiyun 
44*4882a593Smuzhiyun 	void (*irq_handler)(struct qtnf_shm_ipc *ipc);
45*4882a593Smuzhiyun 
46*4882a593Smuzhiyun 	struct workqueue_struct *workqueue;
47*4882a593Smuzhiyun 	struct work_struct irq_work;
48*4882a593Smuzhiyun 	struct completion tx_completion;
49*4882a593Smuzhiyun };
50*4882a593Smuzhiyun 
51*4882a593Smuzhiyun int qtnf_shm_ipc_init(struct qtnf_shm_ipc *ipc,
52*4882a593Smuzhiyun 		      enum qtnf_shm_ipc_direction direction,
53*4882a593Smuzhiyun 		      struct qtnf_shm_ipc_region __iomem *shm_region,
54*4882a593Smuzhiyun 		      struct workqueue_struct *workqueue,
55*4882a593Smuzhiyun 		      const struct qtnf_shm_ipc_int *interrupt,
56*4882a593Smuzhiyun 		      const struct qtnf_shm_ipc_rx_callback *rx_callback);
57*4882a593Smuzhiyun void qtnf_shm_ipc_free(struct qtnf_shm_ipc *ipc);
58*4882a593Smuzhiyun int qtnf_shm_ipc_send(struct qtnf_shm_ipc *ipc, const u8 *buf, size_t size);
59*4882a593Smuzhiyun 
qtnf_shm_ipc_irq_handler(struct qtnf_shm_ipc * ipc)60*4882a593Smuzhiyun static inline void qtnf_shm_ipc_irq_handler(struct qtnf_shm_ipc *ipc)
61*4882a593Smuzhiyun {
62*4882a593Smuzhiyun 	ipc->irq_handler(ipc);
63*4882a593Smuzhiyun }
64*4882a593Smuzhiyun 
65*4882a593Smuzhiyun #endif /* _QTN_FMAC_SHM_IPC_H_ */
66