[mirror_ubuntu-bionic-kernel.git] / include / rdma / rdma_vt.h

#ifndef DEF_RDMA_VT_H
#define DEF_RDMA_VT_H

/*
 * Copyright(c) 2016 Intel Corporation.
 *
 * This file is provided under a dual BSD/GPLv2 license.  When using or
 * redistributing this file, you may do so under either license.
 *
 * GPL LICENSE SUMMARY
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of version 2 of the GNU General Public License as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * BSD LICENSE
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *  - Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *  - Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *  - Neither the name of Intel Corporation nor the names of its
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */

/*
 * Structure that low level drivers will populate in order to register with the
 * rdmavt layer.
 */

#include <linux/spinlock.h>
#include <linux/list.h>
#include <linux/hash.h>
#include <rdma/ib_verbs.h>
#include <rdma/rdmavt_mr.h>
#include <rdma/rdmavt_qp.h>

/*
 * For some of the IBTA objects there will likely be some
 * initializations required. We need flags to determine whether it is OK
 * for rdmavt to do this or not. This does not imply any functions of a
 * partiuclar IBTA object are overridden.
 */
#define RVT_FLAG_MR_INIT_DRIVER BIT(1)
#define RVT_FLAG_QP_INIT_DRIVER BIT(2)
#define RVT_FLAG_CQ_INIT_DRIVER BIT(3)

#define RVT_MAX_PKEY_VALUES 16

struct rvt_ibport {
	struct rvt_qp __rcu *qp[2];
	struct ib_mad_agent *send_agent;	/* agent for SMI (traps) */
	struct rb_root mcast_tree;
	spinlock_t lock;		/* protect changes in this struct */

	/* non-zero when timer is set */
	unsigned long mkey_lease_timeout;
	unsigned long trap_timeout;
	__be64 gid_prefix;      /* in network order */
	__be64 mkey;
	u64 tid;
	u32 port_cap_flags;
	u32 pma_sample_start;
	u32 pma_sample_interval;
	__be16 pma_counter_select[5];
	u16 pma_tag;
	u16 mkey_lease_period;
	u16 sm_lid;
	u8 sm_sl;
	u8 mkeyprot;
	u8 subnet_timeout;
	u8 vl_high_limit;

	/*
	 * Driver is expected to keep these up to date. These
	 * counters are informational only and not required to be
	 * completely accurate.
	 */
	u64 n_rc_resends;
	u64 n_seq_naks;
	u64 n_rdma_seq;
	u64 n_rnr_naks;
	u64 n_other_naks;
	u64 n_loop_pkts;
	u64 n_pkt_drops;
	u64 n_vl15_dropped;
	u64 n_rc_timeouts;
	u64 n_dmawait;
	u64 n_unaligned;
	u64 n_rc_dupreq;
	u64 n_rc_seqnak;
	u16 pkey_violations;
	u16 qkey_violations;
	u16 mkey_violations;

	/* Hot-path per CPU counters to avoid cacheline trading to update */
	u64 z_rc_acks;
	u64 z_rc_qacks;
	u64 z_rc_delayed_comp;
	u64 __percpu *rc_acks;
	u64 __percpu *rc_qacks;
	u64 __percpu *rc_delayed_comp;

	void *priv; /* driver private data */

	/*
	 * The pkey table is allocated and maintained by the driver. Drivers
	 * need to have access to this before registering with rdmav. However
	 * rdmavt will need access to it so drivers need to proviee this during
	 * the attach port API call.
	 */
	u16 *pkey_table;

	struct rvt_ah *sm_ah;
	struct rvt_ah *smi_ah;
};

#define RVT_CQN_MAX 16 /* maximum length of cq name */

/*
 * Things that are driver specific, module parameters in hfi1 and qib
 */
struct rvt_driver_params {
	/*
	 * driver required fields:
	 *	node_guid
	 *	phys_port_cnt
	 *	dma_device
	 *	owner
	 * driver optional fields (rvt will provide generic value if blank):
	 *	name
	 *	node_desc
	 * rvt fields, driver value ignored:
	 *	uverbs_abi_ver
	 *	node_type
	 *	num_comp_vectors
	 *	uverbs_cmd_mask
	 */
	struct ib_device_attr props;

	/*
	 * Drivers will need to support a number of notifications to rvt in
	 * accordance with certain events. This structure should contain a mask
	 * of the supported events. Such events that the rvt may need to know
	 * about include:
	 * port errors
	 * port active
	 * lid change
	 * sm change
	 * client reregister
	 * pkey change
	 *
	 * There may also be other events that the rvt layers needs to know
	 * about this is not an exhaustive list. Some events though rvt does not
	 * need to rely on the driver for such as completion queue error.
	 */
	 int rvt_signal_supported;

	/*
	 * Anything driver specific that is not covered by props
	 * For instance special module parameters. Goes here.
	 */
	unsigned int lkey_table_size;
	unsigned int qp_table_size;
	int qpn_start;
	int qpn_inc;
	int qpn_res_start;
	int qpn_res_end;
	int nports;
	int npkeys;
	u8 qos_shift;
	char cq_name[RVT_CQN_MAX];
	int node;
	int max_rdma_atomic;
	int psn_mask;
	int psn_shift;
	int psn_modify_mask;
	u32 core_cap_flags;
	u32 max_mad_size;
};

/* Protection domain */
struct rvt_pd {
	struct ib_pd ibpd;
	int user;               /* non-zero if created from user space */
};

/* Address handle */
struct rvt_ah {
	struct ib_ah ibah;
	struct ib_ah_attr attr;
	atomic_t refcount;
	u8 vl;
	u8 log_pmtu;
};

struct rvt_dev_info;
struct rvt_driver_provided {
	/*
	 * The work to create port files in /sys/class Infiniband is different
	 * depending on the driver. This should not be extracted away and
	 * instead drivers are responsible for setting the correct callback for
	 * this.
	 */

	/* -------------------*/
	/* Required functions */
	/* -------------------*/
	int (*port_callback)(struct ib_device *, u8, struct kobject *);
	const char * (*get_card_name)(struct rvt_dev_info *rdi);
	struct pci_dev * (*get_pci_dev)(struct rvt_dev_info *rdi);
	unsigned (*free_all_qps)(struct rvt_dev_info *rdi);
	void * (*qp_priv_alloc)(struct rvt_dev_info *rdi, struct rvt_qp *qp,
				gfp_t gfp);
	void (*qp_priv_free)(struct rvt_dev_info *rdi, struct rvt_qp *qp);
	void (*notify_qp_reset)(struct rvt_qp *qp);
	void (*schedule_send)(struct rvt_qp *qp);
	void (*do_send)(struct rvt_qp *qp);
	int (*get_pmtu_from_attr)(struct rvt_dev_info *rdi, struct rvt_qp *qp,
				  struct ib_qp_attr *attr);
	void (*flush_qp_waiters)(struct rvt_qp *qp);
	void (*stop_send_queue)(struct rvt_qp *qp);
	void (*quiesce_qp)(struct rvt_qp *qp);
	void (*notify_error_qp)(struct rvt_qp *qp);
	u32 (*mtu_from_qp)(struct rvt_dev_info *rdi, struct rvt_qp *qp,
			   u32 pmtu);
	int (*mtu_to_path_mtu)(u32 mtu);
	int (*get_guid_be)(struct rvt_dev_info *rdi, struct rvt_ibport *rvp,
			   int guid_index, __be64 *guid);
	int (*query_port_state)(struct rvt_dev_info *rdi, u8 port_num,
				struct ib_port_attr *props);
	int (*shut_down_port)(struct rvt_dev_info *rdi, u8 port_num);
	void (*cap_mask_chg)(struct rvt_dev_info *rdi, u8 port_num);

	/*--------------------*/
	/* Optional functions */
	/*--------------------*/
	int (*check_ah)(struct ib_device *, struct ib_ah_attr *);
	void (*notify_new_ah)(struct ib_device *, struct ib_ah_attr *,
			      struct rvt_ah *);
	int (*alloc_qpn)(struct rvt_dev_info *rdi, struct rvt_qpn_table *qpt,
			 enum ib_qp_type type, u8 port_num, gfp_t gfp);
	/**
	 * Return 0 if modification is valid, -errno otherwise
	 */
	int (*check_modify_qp)(struct rvt_qp *qp, struct ib_qp_attr *attr,
			       int attr_mask, struct ib_udata *udata);
	void (*modify_qp)(struct rvt_qp *qp, struct ib_qp_attr *attr,
			  int attr_mask, struct ib_udata *udata);

	int (*check_send_wr)(struct rvt_qp *qp, struct ib_send_wr *wr);

	void (*notify_create_mad_agent)(struct rvt_dev_info *rdi, int port_idx);
	void (*notify_free_mad_agent)(struct rvt_dev_info *rdi, int port_idx);
};

struct rvt_dev_info {
	struct ib_device ibdev; /* Keep this first. Nothing above here */

	/*
	 * Prior to calling for registration the driver will be responsible for
	 * allocating space for this structure.
	 *
	 * The driver will also be responsible for filling in certain members of
	 * dparms.props. The driver needs to fill in dparms exactly as it would
	 * want values reported to a ULP. This will be returned to the caller
	 * in rdmavt's device. The driver should also therefore refrain from
	 * modifying this directly after registration with rdmavt.
	 */

	/* Driver specific properties */
	struct rvt_driver_params dparms;

	struct rvt_mregion __rcu *dma_mr;
	struct rvt_lkey_table lkey_table;

	/* Driver specific helper functions */
	struct rvt_driver_provided driver_f;

	/* Internal use */
	int n_pds_allocated;
	spinlock_t n_pds_lock; /* Protect pd allocated count */

	int n_ahs_allocated;
	spinlock_t n_ahs_lock; /* Protect ah allocated count */

	u32 n_srqs_allocated;
	spinlock_t n_srqs_lock; /* Protect srqs allocated count */

	int flags;
	struct rvt_ibport **ports;

	/* QP */
	struct rvt_qp_ibdev *qp_dev;
	u32 n_qps_allocated;    /* number of QPs allocated for device */
	u32 n_rc_qps;		/* number of RC QPs allocated for device */
	u32 busy_jiffies;	/* timeout scaling based on RC QP count */
	spinlock_t n_qps_lock;	/* protect qps, rc qps and busy jiffy counts */

	/* memory maps */
	struct list_head pending_mmaps;
	spinlock_t mmap_offset_lock; /* protect mmap_offset */
	u32 mmap_offset;
	spinlock_t pending_lock; /* protect pending mmap list */

	/* CQ */
	struct kthread_worker *worker; /* per device cq worker */
	u32 n_cqs_allocated;    /* number of CQs allocated for device */
	spinlock_t n_cqs_lock; /* protect count of in use cqs */

	/* Multicast */
	u32 n_mcast_grps_allocated; /* number of mcast groups allocated */
	spinlock_t n_mcast_grps_lock;

};

static inline struct rvt_pd *ibpd_to_rvtpd(struct ib_pd *ibpd)
{
	return container_of(ibpd, struct rvt_pd, ibpd);
}

static inline struct rvt_ah *ibah_to_rvtah(struct ib_ah *ibah)
{
	return container_of(ibah, struct rvt_ah, ibah);
}

static inline struct rvt_dev_info *ib_to_rvt(struct ib_device *ibdev)
{
	return  container_of(ibdev, struct rvt_dev_info, ibdev);
}

static inline struct rvt_srq *ibsrq_to_rvtsrq(struct ib_srq *ibsrq)
{
	return container_of(ibsrq, struct rvt_srq, ibsrq);
}

static inline struct rvt_qp *ibqp_to_rvtqp(struct ib_qp *ibqp)
{
	return container_of(ibqp, struct rvt_qp, ibqp);
}

static inline unsigned rvt_get_npkeys(struct rvt_dev_info *rdi)
{
	/*
	 * All ports have same number of pkeys.
	 */
	return rdi->dparms.npkeys;
}

/*
 * Return the indexed PKEY from the port PKEY table.
 */
static inline u16 rvt_get_pkey(struct rvt_dev_info *rdi,
			       int port_index,
			       unsigned index)
{
	if (index >= rvt_get_npkeys(rdi))
		return 0;
	else
		return rdi->ports[port_index]->pkey_table[index];
}

/**
 * rvt_lookup_qpn - return the QP with the given QPN
 * @ibp: the ibport
 * @qpn: the QP number to look up
 *
 * The caller must hold the rcu_read_lock(), and keep the lock until
 * the returned qp is no longer in use.
 */
/* TODO: Remove this and put in rdmavt/qp.h when no longer needed by drivers */
static inline struct rvt_qp *rvt_lookup_qpn(struct rvt_dev_info *rdi,
					    struct rvt_ibport *rvp,
					    u32 qpn) __must_hold(RCU)
{
	struct rvt_qp *qp = NULL;

	if (unlikely(qpn <= 1)) {
		qp = rcu_dereference(rvp->qp[qpn]);
	} else {
		u32 n = hash_32(qpn, rdi->qp_dev->qp_table_bits);

		for (qp = rcu_dereference(rdi->qp_dev->qp_table[n]); qp;
			qp = rcu_dereference(qp->next))
			if (qp->ibqp.qp_num == qpn)
				break;
	}
	return qp;
}

struct rvt_dev_info *rvt_alloc_device(size_t size, int nports);
int rvt_register_device(struct rvt_dev_info *rvd);
void rvt_unregister_device(struct rvt_dev_info *rvd);
int rvt_check_ah(struct ib_device *ibdev, struct ib_ah_attr *ah_attr);
int rvt_init_port(struct rvt_dev_info *rdi, struct rvt_ibport *port,
		  int port_index, u16 *pkey_table);
int rvt_rkey_ok(struct rvt_qp *qp, struct rvt_sge *sge,
		u32 len, u64 vaddr, u32 rkey, int acc);
int rvt_lkey_ok(struct rvt_lkey_table *rkt, struct rvt_pd *pd,
		struct rvt_sge *isge, struct ib_sge *sge, int acc);
int rvt_mmap(struct ib_ucontext *context, struct vm_area_struct *vma);
void rvt_release_mmap_info(struct kref *ref);
struct rvt_mmap_info *rvt_create_mmap_info(struct rvt_dev_info *rdi,
					   u32 size,
					   struct ib_ucontext *context,
					   void *obj);
void rvt_update_mmap_info(struct rvt_dev_info *rdi, struct rvt_mmap_info *ip,
			  u32 size, void *obj);
int rvt_reg_mr(struct rvt_qp *qp, struct ib_reg_wr *wr);
struct rvt_mcast *rvt_mcast_find(struct rvt_ibport *ibp, union ib_gid *mgid);

/* Temporary export */
void rvt_reset_qp(struct rvt_dev_info *rdi, struct rvt_qp *qp,
		  enum ib_qp_type type);

#endif          /* DEF_RDMA_VT_H */
Commit	Line	Data
0194621b DD	1	#ifndef DEF_RDMA_VT_H
	2	#define DEF_RDMA_VT_H
	3
	4	/*
fe314195	5	* Copyright(c) 2016 Intel Corporation.
0194621b DD	6	*
	7	* This file is provided under a dual BSD/GPLv2 license. When using or
	8	* redistributing this file, you may do so under either license.
	9	*
	10	* GPL LICENSE SUMMARY
	11	*
	12	* This program is free software; you can redistribute it and/or modify
	13	* it under the terms of version 2 of the GNU General Public License as
	14	* published by the Free Software Foundation.
	15	*
	16	* This program is distributed in the hope that it will be useful, but
	17	* WITHOUT ANY WARRANTY; without even the implied warranty of
	18	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	19	* General Public License for more details.
	20	*
	21	* BSD LICENSE
	22	*
	23	* Redistribution and use in source and binary forms, with or without
	24	* modification, are permitted provided that the following conditions
	25	* are met:
	26	*
	27	* - Redistributions of source code must retain the above copyright
	28	* notice, this list of conditions and the following disclaimer.
	29	* - Redistributions in binary form must reproduce the above copyright
	30	* notice, this list of conditions and the following disclaimer in
	31	* the documentation and/or other materials provided with the
	32	* distribution.
	33	* - Neither the name of Intel Corporation nor the names of its
	34	* contributors may be used to endorse or promote products derived
	35	* from this software without specific prior written permission.
	36	*
	37	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
	38	* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
	39	* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
	40	* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
	41	* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
	42	* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
	43	* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
	44	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
	45	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	46	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
	47	* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	48	*
	49	*/
	50
	51	/*
	52	* Structure that low level drivers will populate in order to register with the
	53	* rdmavt layer.
	54	*/
	55
f3d01bbc DD	56	#include <linux/spinlock.h>
f3d01bbc DD	57	#include <linux/list.h>
3b0b3fb3	58	#include <linux/hash.h>
b4e64397 DD	59	#include <rdma/ib_verbs.h>
	60	#include <rdma/rdmavt_mr.h>
	61	#include <rdma/rdmavt_qp.h>
f2f34211	62
0b8a8aae DD	63	/*
	64	* For some of the IBTA objects there will likely be some
	65	* initializations required. We need flags to determine whether it is OK
	66	* for rdmavt to do this or not. This does not imply any functions of a
	67	* partiuclar IBTA object are overridden.
	68	*/
	69	#define RVT_FLAG_MR_INIT_DRIVER BIT(1)
	70	#define RVT_FLAG_QP_INIT_DRIVER BIT(2)
	71	#define RVT_FLAG_CQ_INIT_DRIVER BIT(3)
	72
38ce2c6f DD	73	#define RVT_MAX_PKEY_VALUES 16
38ce2c6f DD	74
f3d01bbc DD	75	struct rvt_ibport {
	76	struct rvt_qp __rcu *qp[2];
	77	struct ib_mad_agent send_agent; / agent for SMI (traps) */
	78	struct rb_root mcast_tree;
	79	spinlock_t lock; /* protect changes in this struct */
	80
	81	/* non-zero when timer is set */
	82	unsigned long mkey_lease_timeout;
	83	unsigned long trap_timeout;
	84	__be64 gid_prefix; /* in network order */
	85	__be64 mkey;
	86	u64 tid;
	87	u32 port_cap_flags;
	88	u32 pma_sample_start;
	89	u32 pma_sample_interval;
	90	__be16 pma_counter_select[5];
	91	u16 pma_tag;
	92	u16 mkey_lease_period;
	93	u16 sm_lid;
	94	u8 sm_sl;
	95	u8 mkeyprot;
	96	u8 subnet_timeout;
	97	u8 vl_high_limit;
	98
	99	/*
	100	* Driver is expected to keep these up to date. These
	101	* counters are informational only and not required to be
	102	* completely accurate.
	103	*/
	104	u64 n_rc_resends;
	105	u64 n_seq_naks;
	106	u64 n_rdma_seq;
	107	u64 n_rnr_naks;
	108	u64 n_other_naks;
	109	u64 n_loop_pkts;
	110	u64 n_pkt_drops;
	111	u64 n_vl15_dropped;
	112	u64 n_rc_timeouts;
	113	u64 n_dmawait;
	114	u64 n_unaligned;
	115	u64 n_rc_dupreq;
	116	u64 n_rc_seqnak;
	117	u16 pkey_violations;
	118	u16 qkey_violations;
	119	u16 mkey_violations;
	120
	121	/* Hot-path per CPU counters to avoid cacheline trading to update */
	122	u64 z_rc_acks;
	123	u64 z_rc_qacks;
	124	u64 z_rc_delayed_comp;
	125	u64 __percpu *rc_acks;
	126	u64 __percpu *rc_qacks;
	127	u64 __percpu *rc_delayed_comp;
	128
	129	void priv; / driver private data */
	130
38ce2c6f DD	131	/*
	132	* The pkey table is allocated and maintained by the driver. Drivers
	133	* need to have access to this before registering with rdmav. However
	134	* rdmavt will need access to it so drivers need to proviee this during
	135	* the attach port API call.
	136	*/
	137	u16 *pkey_table;
	138
3711baf2 DD	139	struct rvt_ah *sm_ah;
3711baf2 DD	140	struct rvt_ah *smi_ah;
f3d01bbc DD	141	};
f3d01bbc DD	142
6f6387ae DD	143	#define RVT_CQN_MAX 16 /* maximum length of cq name */
6f6387ae DD	144
8afd32eb DD	145	/*
	146	* Things that are driver specific, module parameters in hfi1 and qib
	147	*/
	148	struct rvt_driver_params {
b1070a7a DD	149	/*
	150	* driver required fields:
	151	* node_guid
	152	* phys_port_cnt
	153	* dma_device
	154	* owner
	155	* driver optional fields (rvt will provide generic value if blank):
	156	* name
	157	* node_desc
	158	* rvt fields, driver value ignored:
	159	* uverbs_abi_ver
	160	* node_type
	161	* num_comp_vectors
	162	* uverbs_cmd_mask
	163	*/
	164	struct ib_device_attr props;
	165
	166	/*
	167	* Drivers will need to support a number of notifications to rvt in
	168	* accordance with certain events. This structure should contain a mask
	169	* of the supported events. Such events that the rvt may need to know
	170	* about include:
	171	* port errors
	172	* port active
	173	* lid change
	174	* sm change
	175	* client reregister
	176	* pkey change
	177	*
	178	* There may also be other events that the rvt layers needs to know
	179	* about this is not an exhaustive list. Some events though rvt does not
	180	* need to rely on the driver for such as completion queue error.
	181	*/
	182	int rvt_signal_supported;
	183
	184	/*
	185	* Anything driver specific that is not covered by props
	186	* For instance special module parameters. Goes here.
	187	*/
7b1e2099	188	unsigned int lkey_table_size;
0acb0cc7 DD	189	unsigned int qp_table_size;
	190	int qpn_start;
	191	int qpn_inc;
	192	int qpn_res_start;
	193	int qpn_res_end;
f3d01bbc	194	int nports;
38ce2c6f	195	int npkeys;
0acb0cc7	196	u8 qos_shift;
6f6387ae DD	197	char cq_name[RVT_CQN_MAX];
6f6387ae DD	198	int node;
3b0b3fb3 DD	199	int max_rdma_atomic;
	200	int psn_mask;
	201	int psn_shift;
	202	int psn_modify_mask;
61a650c1 HC	203	u32 core_cap_flags;
61a650c1 HC	204	u32 max_mad_size;
8afd32eb DD	205	};
8afd32eb DD	206
b036db83 DD	207	/* Protection domain */
	208	struct rvt_pd {
	209	struct ib_pd ibpd;
	210	int user; /* non-zero if created from user space */
	211	};
	212
	213	/* Address handle */
	214	struct rvt_ah {
	215	struct ib_ah ibah;
	216	struct ib_ah_attr attr;
	217	atomic_t refcount;
	218	u8 vl;
	219	u8 log_pmtu;
	220	};
	221
b534875d	222	struct rvt_dev_info;
aec57787 DD	223	struct rvt_driver_provided {
	224	/*
	225	* The work to create port files in /sys/class Infiniband is different
	226	* depending on the driver. This should not be extracted away and
	227	* instead drivers are responsible for setting the correct callback for
	228	* this.
	229	*/
b036db83 DD	230
	231	/* -------------------*/
	232	/* Required functions */
	233	/* -------------------*/
aec57787	234	int (port_callback)(struct ib_device , u8, struct kobject *);
b534875d DD	235	const char * (get_card_name)(struct rvt_dev_info rdi);
b534875d DD	236	struct pci_dev * (get_pci_dev)(struct rvt_dev_info rdi);
515667f8	237	unsigned (free_all_qps)(struct rvt_dev_info rdi);
d2b8d4da MM	238	void * (qp_priv_alloc)(struct rvt_dev_info rdi, struct rvt_qp *qp,
d2b8d4da MM	239	gfp_t gfp);
515667f8 DD	240	void (qp_priv_free)(struct rvt_dev_info rdi, struct rvt_qp *qp);
515667f8 DD	241	void (notify_qp_reset)(struct rvt_qp qp);
bfbac097 DD	242	void (schedule_send)(struct rvt_qp qp);
bfbac097 DD	243	void (do_send)(struct rvt_qp qp);
3b0b3fb3 DD	244	int (get_pmtu_from_attr)(struct rvt_dev_info rdi, struct rvt_qp *qp,
	245	struct ib_qp_attr *attr);
	246	void (flush_qp_waiters)(struct rvt_qp qp);
	247	void (stop_send_queue)(struct rvt_qp qp);
	248	void (quiesce_qp)(struct rvt_qp qp);
	249	void (notify_error_qp)(struct rvt_qp qp);
	250	u32 (mtu_from_qp)(struct rvt_dev_info rdi, struct rvt_qp *qp,
	251	u32 pmtu);
	252	int (*mtu_to_path_mtu)(u32 mtu);
1f024992 DD	253	int (get_guid_be)(struct rvt_dev_info rdi, struct rvt_ibport *rvp,
1f024992 DD	254	int guid_index, __be64 *guid);
61a650c1 HC	255	int (query_port_state)(struct rvt_dev_info rdi, u8 port_num,
	256	struct ib_port_attr *props);
	257	int (shut_down_port)(struct rvt_dev_info rdi, u8 port_num);
	258	void (cap_mask_chg)(struct rvt_dev_info rdi, u8 port_num);
aec57787	259
b036db83 DD	260	/--------------------/
	261	/* Optional functions */
	262	/--------------------/
	263	int (check_ah)(struct ib_device , struct ib_ah_attr *);
	264	void (notify_new_ah)(struct ib_device , struct ib_ah_attr *,
	265	struct rvt_ah *);
515667f8	266	int (alloc_qpn)(struct rvt_dev_info rdi, struct rvt_qpn_table *qpt,
f1badc71	267	enum ib_qp_type type, u8 port_num, gfp_t gfp);
e85ec33d IW	268	/**
	269	* Return 0 if modification is valid, -errno otherwise
	270	*/
	271	int (check_modify_qp)(struct rvt_qp qp, struct ib_qp_attr *attr,
	272	int attr_mask, struct ib_udata *udata);
	273	void (modify_qp)(struct rvt_qp qp, struct ib_qp_attr *attr,
	274	int attr_mask, struct ib_udata *udata);
3711baf2	275
60c30f57 IW	276	int (check_send_wr)(struct rvt_qp qp, struct ib_send_wr *wr);
60c30f57 IW	277
3711baf2 DD	278	void (notify_create_mad_agent)(struct rvt_dev_info rdi, int port_idx);
3711baf2 DD	279	void (notify_free_mad_agent)(struct rvt_dev_info rdi, int port_idx);
119a8e70 KH	280	};
119a8e70 KH	281
0194621b	282	struct rvt_dev_info {
7b1e2099 DD	283	struct ib_device ibdev; /* Keep this first. Nothing above here */
7b1e2099 DD	284
b1070a7a DD	285	/*
	286	* Prior to calling for registration the driver will be responsible for
	287	* allocating space for this structure.
	288	*
	289	* The driver will also be responsible for filling in certain members of
feaeb6e2 HC	290	* dparms.props. The driver needs to fill in dparms exactly as it would
	291	* want values reported to a ULP. This will be returned to the caller
	292	* in rdmavt's device. The driver should also therefore refrain from
	293	* modifying this directly after registration with rdmavt.
b1070a7a	294	*/
8afd32eb	295
b1070a7a	296	/* Driver specific properties */
8afd32eb	297	struct rvt_driver_params dparms;
b1070a7a	298
b92a7568 DD	299	struct rvt_mregion __rcu *dma_mr;
	300	struct rvt_lkey_table lkey_table;
	301
aec57787 DD	302	/* Driver specific helper functions */
aec57787 DD	303	struct rvt_driver_provided driver_f;
0194621b	304
8afd32eb DD	305	/* Internal use */
	306	int n_pds_allocated;
	307	spinlock_t n_pds_lock; /* Protect pd allocated count */
0b8a8aae	308
119a8e70 KH	309	int n_ahs_allocated;
	310	spinlock_t n_ahs_lock; /* Protect ah allocated count */
	311
b8f881b9 JJ	312	u32 n_srqs_allocated;
	313	spinlock_t n_srqs_lock; /* Protect srqs allocated count */
	314
0b8a8aae	315	int flags;
f3d01bbc	316	struct rvt_ibport **ports;
0acb0cc7	317
515667f8	318	/* QP */
0acb0cc7	319	struct rvt_qp_ibdev *qp_dev;
515667f8	320	u32 n_qps_allocated; /* number of QPs allocated for device */
bfee5e32 VM	321	u32 n_rc_qps; /* number of RC QPs allocated for device */
	322	u32 busy_jiffies; /* timeout scaling based on RC QP count */
	323	spinlock_t n_qps_lock; /* protect qps, rc qps and busy jiffy counts */
822514d7 DD	324
	325	/* memory maps */
	326	struct list_head pending_mmaps;
	327	spinlock_t mmap_offset_lock; /* protect mmap_offset */
	328	u32 mmap_offset;
	329	spinlock_t pending_lock; /* protect pending mmap list */
6f6387ae DD	330
	331	/* CQ */
	332	struct kthread_worker worker; / per device cq worker */
	333	u32 n_cqs_allocated; /* number of CQs allocated for device */
	334	spinlock_t n_cqs_lock; /* protect count of in use cqs */
4e74080b DD	335
	336	/* Multicast */
	337	u32 n_mcast_grps_allocated; /* number of mcast groups allocated */
	338	spinlock_t n_mcast_grps_lock;
	339
0194621b DD	340	};
0194621b DD	341
8afd32eb DD	342	static inline struct rvt_pd ibpd_to_rvtpd(struct ib_pd ibpd)
	343	{
	344	return container_of(ibpd, struct rvt_pd, ibpd);
	345	}
	346
119a8e70 KH	347	static inline struct rvt_ah ibah_to_rvtah(struct ib_ah ibah)
	348	{
	349	return container_of(ibah, struct rvt_ah, ibah);
	350	}
	351
8afd32eb DD	352	static inline struct rvt_dev_info ib_to_rvt(struct ib_device ibdev)
	353	{
	354	return container_of(ibdev, struct rvt_dev_info, ibdev);
	355	}
	356
70a1a351 DD	357	static inline struct rvt_srq ibsrq_to_rvtsrq(struct ib_srq ibsrq)
	358	{
	359	return container_of(ibsrq, struct rvt_srq, ibsrq);
	360	}
	361
bfbac097 DD	362	static inline struct rvt_qp ibqp_to_rvtqp(struct ib_qp ibqp)
	363	{
	364	return container_of(ibqp, struct rvt_qp, ibqp);
	365	}
	366
38ce2c6f DD	367	static inline unsigned rvt_get_npkeys(struct rvt_dev_info *rdi)
	368	{
	369	/*
	370	* All ports have same number of pkeys.
	371	*/
	372	return rdi->dparms.npkeys;
	373	}
	374
	375	/*
	376	* Return the indexed PKEY from the port PKEY table.
	377	*/
	378	static inline u16 rvt_get_pkey(struct rvt_dev_info *rdi,
	379	int port_index,
	380	unsigned index)
	381	{
	382	if (index >= rvt_get_npkeys(rdi))
	383	return 0;
	384	else
	385	return rdi->ports[port_index]->pkey_table[index];
	386	}
	387
3b0b3fb3 DD	388	/**
	389	* rvt_lookup_qpn - return the QP with the given QPN
	390	* @ibp: the ibport
	391	* @qpn: the QP number to look up
	392	*
	393	* The caller must hold the rcu_read_lock(), and keep the lock until
	394	* the returned qp is no longer in use.
	395	*/
	396	/* TODO: Remove this and put in rdmavt/qp.h when no longer needed by drivers */
	397	static inline struct rvt_qp rvt_lookup_qpn(struct rvt_dev_info rdi,
	398	struct rvt_ibport *rvp,
	399	u32 qpn) __must_hold(RCU)
	400	{
	401	struct rvt_qp *qp = NULL;
	402
	403	if (unlikely(qpn <= 1)) {
	404	qp = rcu_dereference(rvp->qp[qpn]);
	405	} else {
	406	u32 n = hash_32(qpn, rdi->qp_dev->qp_table_bits);
	407
	408	for (qp = rcu_dereference(rdi->qp_dev->qp_table[n]); qp;
	409	qp = rcu_dereference(qp->next))
	410	if (qp->ibqp.qp_num == qpn)
	411	break;
	412	}
	413	return qp;
	414	}
	415
ff6acd69	416	struct rvt_dev_info *rvt_alloc_device(size_t size, int nports);
0194621b DD	417	int rvt_register_device(struct rvt_dev_info *rvd);
0194621b DD	418	void rvt_unregister_device(struct rvt_dev_info *rvd);
119a8e70	419	int rvt_check_ah(struct ib_device ibdev, struct ib_ah_attr ah_attr);
38ce2c6f	420	int rvt_init_port(struct rvt_dev_info rdi, struct rvt_ibport port,
f1badc71	421	int port_index, u16 *pkey_table);
7b1e2099 DD	422	int rvt_rkey_ok(struct rvt_qp qp, struct rvt_sge sge,
	423	u32 len, u64 vaddr, u32 rkey, int acc);
	424	int rvt_lkey_ok(struct rvt_lkey_table rkt, struct rvt_pd pd,
	425	struct rvt_sge isge, struct ib_sge sge, int acc);
822514d7 DD	426	int rvt_mmap(struct ib_ucontext context, struct vm_area_struct vma);
	427	void rvt_release_mmap_info(struct kref *ref);
	428	struct rvt_mmap_info rvt_create_mmap_info(struct rvt_dev_info rdi,
	429	u32 size,
	430	struct ib_ucontext *context,
	431	void *obj);
	432	void rvt_update_mmap_info(struct rvt_dev_info rdi, struct rvt_mmap_info ip,
	433	u32 size, void *obj);
4e74080b DD	434	int rvt_reg_mr(struct rvt_qp qp, struct ib_reg_wr wr);
4e74080b DD	435	struct rvt_mcast rvt_mcast_find(struct rvt_ibport ibp, union ib_gid *mgid);
822514d7	436
5a9cf6f2 DD	437	/* Temporary export */
	438	void rvt_reset_qp(struct rvt_dev_info rdi, struct rvt_qp qp,
	439	enum ib_qp_type type);
4e74080b	440
0194621b	441	#endif /* DEF_RDMA_VT_H */