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 spinlock_t cmd_lock; /* serializes cmds */
32 struct list_head list;
33 struct pci_dev *pdev;
34
35 struct ism_sba *sba;
36 dma_addr_t sba_dma_addr;
37 DECLARE_BITMAP(sba_bitmap, ISM_NR_DMBS);
38 u8 *sba_client_arr; /* entries are indices into 'clients' array */
39 void *priv[MAX_CLIENTS];
40
41 struct ism_eq *ieq;
42 dma_addr_t ieq_dma_addr;
43
44 struct device dev;
45 u64 local_gid;
46 int ieq_idx;
47
48 struct ism_client *subs[MAX_CLIENTS];
49 };
50
51 struct ism_event {
52 u32 type;
53 u32 code;
54 u64 tok;
55 u64 time;
56 u64 info;
57 };
58
59 struct ism_client {
60 const char *name;
61 void (*add)(struct ism_dev *dev);
62 void (*remove)(struct ism_dev *dev);
63 void (*handle_event)(struct ism_dev *dev, struct ism_event *event);
64 /* Parameter dmbemask contains a bit vector with updated DMBEs, if sent
65 * via ism_move_data(). Callback function must handle all active bits
66 * indicated by dmbemask.
67 */
68 void (*handle_irq)(struct ism_dev *dev, unsigned int bit, u16 dmbemask);
69 /* Private area - don't touch! */
70 u8 id;
71 };
72
73 int ism_register_client(struct ism_client *client);
74 int ism_unregister_client(struct ism_client *client);
ism_get_priv(struct ism_dev * dev,struct ism_client * client)75 static inline void *ism_get_priv(struct ism_dev *dev,
76 struct ism_client *client) {
77 return dev->priv[client->id];
78 }
79
ism_set_priv(struct ism_dev * dev,struct ism_client * client,void * priv)80 static inline void ism_set_priv(struct ism_dev *dev, struct ism_client *client,
81 void *priv) {
82 dev->priv[client->id] = priv;
83 }
84
85 int ism_register_dmb(struct ism_dev *dev, struct ism_dmb *dmb,
86 struct ism_client *client);
87 int ism_unregister_dmb(struct ism_dev *dev, struct ism_dmb *dmb);
88 int ism_move(struct ism_dev *dev, u64 dmb_tok, unsigned int idx, bool sf,
89 unsigned int offset, void *data, unsigned int size);
90
91 const struct smcd_ops *ism_get_smcd_ops(void);
92
93 #endif /* _ISM_H */
94