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/ism.h"
19  
20  struct sock;
21  
22  #define SMC_MAX_PNETID_LEN	16	/* Max. length of PNET id */
23  
24  struct smc_hashinfo {
25  	rwlock_t lock;
26  	struct hlist_head ht;
27  };
28  
29  /* SMCD/ISM device driver interface */
30  struct smcd_dmb {
31  	u64 dmb_tok;
32  	u64 rgid;
33  	u32 dmb_len;
34  	u32 sba_idx;
35  	u32 vlan_valid;
36  	u32 vlan_id;
37  	void *cpu_addr;
38  	dma_addr_t dma_addr;
39  };
40  
41  #define ISM_EVENT_DMB	0
42  #define ISM_EVENT_GID	1
43  #define ISM_EVENT_SWR	2
44  
45  #define ISM_RESERVED_VLANID	0x1FFF
46  
47  #define ISM_ERROR	0xFFFF
48  
49  struct smcd_dev;
50  
51  struct smcd_gid {
52  	u64	gid;
53  	u64	gid_ext;
54  };
55  
56  struct smcd_ops {
57  	int (*query_remote_gid)(struct smcd_dev *dev, struct smcd_gid *rgid,
58  				u32 vid_valid, u32 vid);
59  	int (*register_dmb)(struct smcd_dev *dev, struct smcd_dmb *dmb,
60  			    void *client);
61  	int (*unregister_dmb)(struct smcd_dev *dev, struct smcd_dmb *dmb);
62  	int (*move_data)(struct smcd_dev *dev, u64 dmb_tok, unsigned int idx,
63  			 bool sf, unsigned int offset, void *data,
64  			 unsigned int size);
65  	int (*supports_v2)(void);
66  	void (*get_local_gid)(struct smcd_dev *dev, struct smcd_gid *gid);
67  	u16 (*get_chid)(struct smcd_dev *dev);
68  	struct device* (*get_dev)(struct smcd_dev *dev);
69  
70  	/* optional operations */
71  	int (*add_vlan_id)(struct smcd_dev *dev, u64 vlan_id);
72  	int (*del_vlan_id)(struct smcd_dev *dev, u64 vlan_id);
73  	int (*set_vlan_required)(struct smcd_dev *dev);
74  	int (*reset_vlan_required)(struct smcd_dev *dev);
75  	int (*signal_event)(struct smcd_dev *dev, struct smcd_gid *rgid,
76  			    u32 trigger_irq, u32 event_code, u64 info);
77  	int (*support_dmb_nocopy)(struct smcd_dev *dev);
78  	int (*attach_dmb)(struct smcd_dev *dev, struct smcd_dmb *dmb);
79  	int (*detach_dmb)(struct smcd_dev *dev, u64 token);
80  };
81  
82  struct smcd_dev {
83  	const struct smcd_ops *ops;
84  	void *priv;
85  	void *client;
86  	struct list_head list;
87  	spinlock_t lock;
88  	struct smc_connection **conn;
89  	struct list_head vlan;
90  	struct workqueue_struct *event_wq;
91  	u8 pnetid[SMC_MAX_PNETID_LEN];
92  	bool pnetid_by_user;
93  	struct list_head lgr_list;
94  	spinlock_t lgr_lock;
95  	atomic_t lgr_cnt;
96  	wait_queue_head_t lgrs_deleted;
97  	u8 going_away : 1;
98  };
99  
100  #endif	/* _SMC_H */
101