[linux.git] / include / net / smc.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 *  Shared Memory Communications over RDMA (SMC-R) and RoCE
 *
 *  Definitions for the SMC module (socket related)
 *
 *  Copyright IBM Corp. 2016
 *
 *  Author(s):  Ursula Braun <[email protected]>
 */
#ifndef _SMC_H
#define _SMC_H

#include <linux/device.h>
#include <linux/spinlock.h>
#include <linux/types.h>
#include <linux/wait.h>
#include "linux/ism.h"

struct sock;

#define SMC_MAX_PNETID_LEN	16	/* Max. length of PNET id */

struct smc_hashinfo {
	rwlock_t lock;
	struct hlist_head ht;
};

/* SMCD/ISM device driver interface */
struct smcd_dmb {
	u64 dmb_tok;
	u64 rgid;
	u32 dmb_len;
	u32 sba_idx;
	u32 vlan_valid;
	u32 vlan_id;
	void *cpu_addr;
	dma_addr_t dma_addr;
};

#define ISM_EVENT_DMB	0
#define ISM_EVENT_GID	1
#define ISM_EVENT_SWR	2

#define ISM_RESERVED_VLANID	0x1FFF

#define ISM_ERROR	0xFFFF

struct smcd_dev;

struct smcd_gid {
	u64	gid;
	u64	gid_ext;
};

struct smcd_ops {
	int (*query_remote_gid)(struct smcd_dev *dev, struct smcd_gid *rgid,
				u32 vid_valid, u32 vid);
	int (*register_dmb)(struct smcd_dev *dev, struct smcd_dmb *dmb,
			    void *client);
	int (*unregister_dmb)(struct smcd_dev *dev, struct smcd_dmb *dmb);
	int (*move_data)(struct smcd_dev *dev, u64 dmb_tok, unsigned int idx,
			 bool sf, unsigned int offset, void *data,
			 unsigned int size);
	int (*supports_v2)(void);
	void (*get_local_gid)(struct smcd_dev *dev, struct smcd_gid *gid);
	u16 (*get_chid)(struct smcd_dev *dev);
	struct device* (*get_dev)(struct smcd_dev *dev);

	/* optional operations */
	int (*add_vlan_id)(struct smcd_dev *dev, u64 vlan_id);
	int (*del_vlan_id)(struct smcd_dev *dev, u64 vlan_id);
	int (*set_vlan_required)(struct smcd_dev *dev);
	int (*reset_vlan_required)(struct smcd_dev *dev);
	int (*signal_event)(struct smcd_dev *dev, struct smcd_gid *rgid,
			    u32 trigger_irq, u32 event_code, u64 info);
	int (*support_dmb_nocopy)(struct smcd_dev *dev);
	int (*attach_dmb)(struct smcd_dev *dev, struct smcd_dmb *dmb);
	int (*detach_dmb)(struct smcd_dev *dev, u64 token);
};

struct smcd_dev {
	const struct smcd_ops *ops;
	void *priv;
	void *client;
	struct list_head list;
	spinlock_t lock;
	struct smc_connection **conn;
	struct list_head vlan;
	struct workqueue_struct *event_wq;
	u8 pnetid[SMC_MAX_PNETID_LEN];
	bool pnetid_by_user;
	struct list_head lgr_list;
	spinlock_t lgr_lock;
	atomic_t lgr_cnt;
	wait_queue_head_t lgrs_deleted;
	u8 going_away : 1;
};

#endif	/* _SMC_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
f16a7dd5 UB	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 <[email protected]>
	10	*/
	11	#ifndef _SMC_H
	12	#define _SMC_H
	13
949d6b40 JK	14	#include <linux/device.h>
	15	#include <linux/spinlock.h>
	16	#include <linux/types.h>
	17	#include <linux/wait.h>
89e7d2ba	18	#include "linux/ism.h"
949d6b40 JK	19
	20	struct sock;
	21
0afff91c UB	22	#define SMC_MAX_PNETID_LEN 16 /* Max. length of PNET id */
0afff91c UB	23
f16a7dd5 UB	24	struct smc_hashinfo {
	25	rwlock_t lock;
	26	struct hlist_head ht;
	27	};
	28
c6ba7c9b HW	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
201091eb UB	45	#define ISM_RESERVED_VLANID 0x1FFF
201091eb UB	46
42bfba9e UB	47	#define ISM_ERROR 0xFFFF
42bfba9e UB	48
c6ba7c9b HW	49	struct smcd_dev;
c6ba7c9b HW	50
b40584d1 WG	51	struct smcd_gid {
	52	u64 gid;
	53	u64 gid_ext;
	54	};
	55
c6ba7c9b	56	struct smcd_ops {
b40584d1 WG	57	int (query_remote_gid)(struct smcd_dev dev, struct smcd_gid *rgid,
b40584d1 WG	58	u32 vid_valid, u32 vid);
820f2100	59	int (register_dmb)(struct smcd_dev dev, struct smcd_dmb *dmb,
784c46f5	60	void *client);
c6ba7c9b	61	int (unregister_dmb)(struct smcd_dev dev, struct smcd_dmb *dmb);
c6ba7c9b HW	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);
f947568e	65	int (*supports_v2)(void);
b40584d1	66	void (get_local_gid)(struct smcd_dev dev, struct smcd_gid *gid);
8caaccf5	67	u16 (get_chid)(struct smcd_dev dev);
8c81ba20	68	struct device* (get_dev)(struct smcd_dev dev);
d1d8d0b6 WG	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);
43988882 WG	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);
c6ba7c9b HW	80	};
	81
	82	struct smcd_dev {
	83	const struct smcd_ops *ops;
c6ba7c9b	84	void *priv;
784c46f5	85	void *client;
c6ba7c9b HW	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;
1619f770	91	u8 pnetid[SMC_MAX_PNETID_LEN];
f3d74b22	92	bool pnetid_by_user;
a2351c5d	93	struct list_head lgr_list;
a0a62ee1	94	spinlock_t lgr_lock;
5edd6b9c UB	95	atomic_t lgr_cnt;
5edd6b9c UB	96	wait_queue_head_t lgrs_deleted;
c3d9494e	97	u8 going_away : 1;
c6ba7c9b HW	98	};
c6ba7c9b HW	99
f16a7dd5	100	#endif /* _SMC_H */