xref: /linux/include/linux/ism.h (revision 702648721db590b3425c31ade294000e18808345)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  *  Internal Shared Memory
4  *
5  *  Definitions for the ISM module
6  *
7  *  Copyright IBM Corp. 2022
8  */
9 #ifndef _ISM_H
10 #define _ISM_H
11 
12 #include <linux/workqueue.h>
13 
14 struct ism_dmb {
15 	u64 dmb_tok;
16 	u64 rgid;
17 	u32 dmb_len;
18 	u32 sba_idx;
19 	u32 vlan_valid;
20 	u32 vlan_id;
21 	void *cpu_addr;
22 	dma_addr_t dma_addr;
23 };
24 
25 /* Unless we gain unexpected popularity, this limit should hold for a while */
26 #define MAX_CLIENTS		8
27 #define ISM_NR_DMBS		1920
28 
29 struct ism_dev {
30 	spinlock_t lock; /* protects the ism device */
31 	struct list_head list;
32 	struct pci_dev *pdev;
33 
34 	struct ism_sba *sba;
35 	dma_addr_t sba_dma_addr;
36 	DECLARE_BITMAP(sba_bitmap, ISM_NR_DMBS);
37 	u8 *sba_client_arr;	/* entries are indices into 'clients' array */
38 	void *priv[MAX_CLIENTS];
39 
40 	struct ism_eq *ieq;
41 	dma_addr_t ieq_dma_addr;
42 
43 	struct device dev;
44 	u64 local_gid;
45 	int ieq_idx;
46 
47 	atomic_t free_clients_cnt;
48 	atomic_t add_dev_cnt;
49 	wait_queue_head_t waitq;
50 };
51 
52 struct ism_event {
53 	u32 type;
54 	u32 code;
55 	u64 tok;
56 	u64 time;
57 	u64 info;
58 };
59 
60 struct ism_client {
61 	const char *name;
62 	void (*add)(struct ism_dev *dev);
63 	void (*remove)(struct ism_dev *dev);
64 	void (*handle_event)(struct ism_dev *dev, struct ism_event *event);
65 	/* Parameter dmbemask contains a bit vector with updated DMBEs, if sent
66 	 * via ism_move_data(). Callback function must handle all active bits
67 	 * indicated by dmbemask.
68 	 */
69 	void (*handle_irq)(struct ism_dev *dev, unsigned int bit, u16 dmbemask);
70 	/* Private area - don't touch! */
71 	struct work_struct remove_work;
72 	struct work_struct add_work;
73 	struct ism_dev *tgt_ism;
74 	u8 id;
75 };
76 
77 int ism_register_client(struct ism_client *client);
78 int  ism_unregister_client(struct ism_client *client);
79 static inline void *ism_get_priv(struct ism_dev *dev,
80 				 struct ism_client *client) {
81 	return dev->priv[client->id];
82 }
83 
84 static inline void ism_set_priv(struct ism_dev *dev, struct ism_client *client,
85 				void *priv) {
86 	dev->priv[client->id] = priv;
87 }
88 
89 int  ism_register_dmb(struct ism_dev *dev, struct ism_dmb *dmb,
90 		      struct ism_client *client);
91 int  ism_unregister_dmb(struct ism_dev *dev, struct ism_dmb *dmb);
92 int  ism_move(struct ism_dev *dev, u64 dmb_tok, unsigned int idx, bool sf,
93 	      unsigned int offset, void *data, unsigned int size);
94 u8  *ism_get_seid(void);
95 
96 const struct smcd_ops *ism_get_smcd_ops(void);
97 
98 #endif	/* _ISM_H */
99