xref: /linux/include/net/smc.h (revision 845c334a0186a23c2ac4abfb444e499fec831b24)
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 #include <linux/dibs.h>
19 #include "linux/ism.h"
20 
21 struct sock;
22 
23 #define SMC_MAX_PNETID_LEN	16	/* Max. length of PNET id */
24 
25 struct smc_hashinfo {
26 	rwlock_t lock;
27 	struct hlist_head ht;
28 };
29 
30 /* SMCD/ISM device driver interface */
31 struct smcd_dmb {
32 	u64 dmb_tok;
33 	u64 rgid;
34 	u32 dmb_len;
35 	u32 sba_idx;
36 	u32 vlan_valid;
37 	u32 vlan_id;
38 	void *cpu_addr;
39 	dma_addr_t dma_addr;
40 };
41 
42 #define ISM_EVENT_DMB	0
43 #define ISM_EVENT_GID	1
44 #define ISM_EVENT_SWR	2
45 
46 #define ISM_RESERVED_VLANID	0x1FFF
47 
48 struct smcd_dev;
49 
50 struct smcd_gid {
51 	u64	gid;
52 	u64	gid_ext;
53 };
54 
55 struct smcd_ops {
56 	int (*query_remote_gid)(struct smcd_dev *dev, struct smcd_gid *rgid,
57 				u32 vid_valid, u32 vid);
58 	int (*register_dmb)(struct smcd_dev *dev, struct smcd_dmb *dmb,
59 			    void *client);
60 	int (*unregister_dmb)(struct smcd_dev *dev, struct smcd_dmb *dmb);
61 	int (*move_data)(struct smcd_dev *dev, u64 dmb_tok, unsigned int idx,
62 			 bool sf, unsigned int offset, void *data,
63 			 unsigned int size);
64 	int (*supports_v2)(void);
65 	void (*get_local_gid)(struct smcd_dev *dev, struct smcd_gid *gid);
66 
67 	/* optional operations */
68 	int (*add_vlan_id)(struct smcd_dev *dev, u64 vlan_id);
69 	int (*del_vlan_id)(struct smcd_dev *dev, u64 vlan_id);
70 	int (*set_vlan_required)(struct smcd_dev *dev);
71 	int (*reset_vlan_required)(struct smcd_dev *dev);
72 	int (*signal_event)(struct smcd_dev *dev, struct smcd_gid *rgid,
73 			    u32 trigger_irq, u32 event_code, u64 info);
74 	int (*support_dmb_nocopy)(struct smcd_dev *dev);
75 	int (*attach_dmb)(struct smcd_dev *dev, struct smcd_dmb *dmb);
76 	int (*detach_dmb)(struct smcd_dev *dev, u64 token);
77 };
78 
79 struct smcd_dev {
80 	const struct smcd_ops *ops;
81 	void *priv;
82 	void *client;
83 	struct dibs_dev *dibs;
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 #endif	/* _SMC_H */
99