c926d3313e0516ed4905b3b21f9f9e4f2b8bcd54
[releases.git] / smc.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  *  Shared Memory Communications over RDMA (SMC-R) and RoCE
4  *
5  *  Definitions for the SMC module (socket related)
6  *
7  *  Copyright IBM Corp. 2016
8  *
9  *  Author(s):  Ursula Braun <ubraun@linux.vnet.ibm.com>
10  */
11 #ifndef _SMC_H
12 #define _SMC_H
13
14 #include <linux/device.h>
15 #include <linux/spinlock.h>
16 #include <linux/types.h>
17 #include <linux/wait.h>
18
19 struct sock;
20
21 #define SMC_MAX_PNETID_LEN      16      /* Max. length of PNET id */
22
23 struct smc_hashinfo {
24         rwlock_t lock;
25         struct hlist_head ht;
26 };
27
28 int smc_hash_sk(struct sock *sk);
29 void smc_unhash_sk(struct sock *sk);
30
31 /* SMCD/ISM device driver interface */
32 struct smcd_dmb {
33         u64 dmb_tok;
34         u64 rgid;
35         u32 dmb_len;
36         u32 sba_idx;
37         u32 vlan_valid;
38         u32 vlan_id;
39         void *cpu_addr;
40         dma_addr_t dma_addr;
41 };
42
43 #define ISM_EVENT_DMB   0
44 #define ISM_EVENT_GID   1
45 #define ISM_EVENT_SWR   2
46
47 #define ISM_RESERVED_VLANID     0x1FFF
48
49 #define ISM_ERROR       0xFFFF
50
51 struct smcd_event {
52         u32 type;
53         u32 code;
54         u64 tok;
55         u64 time;
56         u64 info;
57 };
58
59 struct smcd_dev;
60
61 struct smcd_ops {
62         int (*query_remote_gid)(struct smcd_dev *dev, u64 rgid, u32 vid_valid,
63                                 u32 vid);
64         int (*register_dmb)(struct smcd_dev *dev, struct smcd_dmb *dmb);
65         int (*unregister_dmb)(struct smcd_dev *dev, struct smcd_dmb *dmb);
66         int (*add_vlan_id)(struct smcd_dev *dev, u64 vlan_id);
67         int (*del_vlan_id)(struct smcd_dev *dev, u64 vlan_id);
68         int (*set_vlan_required)(struct smcd_dev *dev);
69         int (*reset_vlan_required)(struct smcd_dev *dev);
70         int (*signal_event)(struct smcd_dev *dev, u64 rgid, u32 trigger_irq,
71                             u32 event_code, u64 info);
72         int (*move_data)(struct smcd_dev *dev, u64 dmb_tok, unsigned int idx,
73                          bool sf, unsigned int offset, void *data,
74                          unsigned int size);
75         u8* (*get_system_eid)(void);
76         u16 (*get_chid)(struct smcd_dev *dev);
77 };
78
79 struct smcd_dev {
80         const struct smcd_ops *ops;
81         struct device dev;
82         void *priv;
83         u64 local_gid;
84         struct list_head list;
85         spinlock_t lock;
86         struct smc_connection **conn;
87         struct list_head vlan;
88         struct workqueue_struct *event_wq;
89         u8 pnetid[SMC_MAX_PNETID_LEN];
90         bool pnetid_by_user;
91         struct list_head lgr_list;
92         spinlock_t lgr_lock;
93         atomic_t lgr_cnt;
94         wait_queue_head_t lgrs_deleted;
95         u8 going_away : 1;
96 };
97
98 struct smcd_dev *smcd_alloc_dev(struct device *parent, const char *name,
99                                 const struct smcd_ops *ops, int max_dmbs);
100 int smcd_register_dev(struct smcd_dev *smcd);
101 void smcd_unregister_dev(struct smcd_dev *smcd);
102 void smcd_free_dev(struct smcd_dev *smcd);
103 void smcd_handle_event(struct smcd_dev *dev, struct smcd_event *event);
104 void smcd_handle_irq(struct smcd_dev *dev, unsigned int bit, u16 dmbemask);
105 #endif  /* _SMC_H */