[deliverable/linux.git] / drivers / infiniband / hw / mthca / mthca_provider.h

/*
 * Copyright (c) 2004 Topspin Communications.  All rights reserved.
 * Copyright (c) 2005, 2006 Cisco Systems.  All rights reserved.
 * Copyright (c) 2005 Mellanox Technologies. All rights reserved.
 *
 * This software is available to you under a choice of one of two
 * licenses.  You may choose to be licensed under the terms of the GNU
 * General Public License (GPL) Version 2, available from the file
 * COPYING in the main directory of this source tree, or the
 * OpenIB.org BSD license below:
 *
 *     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.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *
 * $Id: mthca_provider.h 1349 2004-12-16 21:09:43Z roland $
 */

#ifndef MTHCA_PROVIDER_H
#define MTHCA_PROVIDER_H

#include <rdma/ib_verbs.h>
#include <rdma/ib_pack.h>

#define MTHCA_MPT_FLAG_ATOMIC        (1 << 14)
#define MTHCA_MPT_FLAG_REMOTE_WRITE  (1 << 13)
#define MTHCA_MPT_FLAG_REMOTE_READ   (1 << 12)
#define MTHCA_MPT_FLAG_LOCAL_WRITE   (1 << 11)
#define MTHCA_MPT_FLAG_LOCAL_READ    (1 << 10)

struct mthca_buf_list {
	void *buf;
	DECLARE_PCI_UNMAP_ADDR(mapping)
};

union mthca_buf {
	struct mthca_buf_list direct;
	struct mthca_buf_list *page_list;
};

struct mthca_uar {
	unsigned long pfn;
	int           index;
};

struct mthca_user_db_table;

struct mthca_ucontext {
	struct ib_ucontext          ibucontext;
	struct mthca_uar            uar;
	struct mthca_user_db_table *db_tab;
};

struct mthca_mtt;

struct mthca_mr {
	struct ib_mr      ibmr;
	struct ib_umem   *umem;
	struct mthca_mtt *mtt;
};

struct mthca_fmr {
	struct ib_fmr      ibmr;
	struct ib_fmr_attr attr;
	struct mthca_mtt  *mtt;
	int                maps;
	union {
		struct {
			struct mthca_mpt_entry __iomem *mpt;
			u64 __iomem *mtts;
		} tavor;
		struct {
			struct mthca_mpt_entry *mpt;
			__be64 *mtts;
			dma_addr_t dma_handle;
		} arbel;
	} mem;
};

struct mthca_pd {
	struct ib_pd    ibpd;
	u32             pd_num;
	atomic_t        sqp_count;
	struct mthca_mr ntmr;
	int             privileged;
};

struct mthca_eq {
	struct mthca_dev      *dev;
	int                    eqn;
	u32                    eqn_mask;
	u32                    cons_index;
	u16                    msi_x_vector;
	u16                    msi_x_entry;
	int                    have_irq;
	int                    nent;
	struct mthca_buf_list *page_list;
	struct mthca_mr        mr;
};

struct mthca_av;

enum mthca_ah_type {
	MTHCA_AH_ON_HCA,
	MTHCA_AH_PCI_POOL,
	MTHCA_AH_KMALLOC
};

struct mthca_ah {
	struct ib_ah       ibah;
	enum mthca_ah_type type;
	u32                key;
	struct mthca_av   *av;
	dma_addr_t         avdma;
};

/*
 * Quick description of our CQ/QP locking scheme:
 *
 * We have one global lock that protects dev->cq/qp_table.  Each
 * struct mthca_cq/qp also has its own lock.  An individual qp lock
 * may be taken inside of an individual cq lock.  Both cqs attached to
 * a qp may be locked, with the cq with the lower cqn locked first.
 * No other nesting should be done.
 *
 * Each struct mthca_cq/qp also has an ref count, protected by the
 * corresponding table lock.  The pointer from the cq/qp_table to the
 * struct counts as one reference.  This reference also is good for
 * access through the consumer API, so modifying the CQ/QP etc doesn't
 * need to take another reference.  Access to a QP because of a
 * completion being polled does not need a reference either.
 *
 * Finally, each struct mthca_cq/qp has a wait_queue_head_t for the
 * destroy function to sleep on.
 *
 * This means that access from the consumer API requires nothing but
 * taking the struct's lock.
 *
 * Access because of a completion event should go as follows:
 * - lock cq/qp_table and look up struct
 * - increment ref count in struct
 * - drop cq/qp_table lock
 * - lock struct, do your thing, and unlock struct
 * - decrement ref count; if zero, wake up waiters
 *
 * To destroy a CQ/QP, we can do the following:
 * - lock cq/qp_table
 * - remove pointer and decrement ref count
 * - unlock cq/qp_table lock
 * - wait_event until ref count is zero
 *
 * It is the consumer's responsibilty to make sure that no QP
 * operations (WQE posting or state modification) are pending when a
 * QP is destroyed.  Also, the consumer must make sure that calls to
 * qp_modify are serialized.  Similarly, the consumer is responsible
 * for ensuring that no CQ resize operations are pending when a CQ
 * is destroyed.
 *
 * Possible optimizations (wait for profile data to see if/where we
 * have locks bouncing between CPUs):
 * - split cq/qp table lock into n separate (cache-aligned) locks,
 *   indexed (say) by the page in the table
 * - split QP struct lock into three (one for common info, one for the
 *   send queue and one for the receive queue)
 */

struct mthca_cq_buf {
	union mthca_buf		queue;
	struct mthca_mr		mr;
	int			is_direct;
};

struct mthca_cq_resize {
	struct mthca_cq_buf	buf;
	int			cqe;
	enum {
		CQ_RESIZE_ALLOC,
		CQ_RESIZE_READY,
		CQ_RESIZE_SWAPPED
	}			state;
};

struct mthca_cq {
	struct ib_cq		ibcq;
	spinlock_t		lock;
	int			refcount;
	int			cqn;
	u32			cons_index;
	struct mthca_cq_buf	buf;
	struct mthca_cq_resize *resize_buf;
	int			is_kernel;

	/* Next fields are Arbel only */
	int			set_ci_db_index;
	__be32		       *set_ci_db;
	int			arm_db_index;
	__be32		       *arm_db;
	int			arm_sn;

	wait_queue_head_t	wait;
	struct mutex		mutex;
};

struct mthca_srq {
	struct ib_srq		ibsrq;
	spinlock_t		lock;
	int			refcount;
	int			srqn;
	int			max;
	int			max_gs;
	int			wqe_shift;
	int			first_free;
	int			last_free;
	u16			counter;  /* Arbel only */
	int			db_index; /* Arbel only */
	__be32		       *db;       /* Arbel only */
	void		       *last;

	int			is_direct;
	u64		       *wrid;
	union mthca_buf		queue;
	struct mthca_mr		mr;

	wait_queue_head_t	wait;
	struct mutex		mutex;
};

struct mthca_wq {
	spinlock_t lock;
	int        max;
	unsigned   next_ind;
	unsigned   last_comp;
	unsigned   head;
	unsigned   tail;
	void      *last;
	int        max_gs;
	int        wqe_shift;

	int        db_index;	/* Arbel only */
	__be32    *db;
};

struct mthca_qp {
	struct ib_qp           ibqp;
	int                    refcount;
	u32                    qpn;
	int                    is_direct;
	u8                     port; /* for SQP and memfree use only */
	u8                     alt_port; /* for memfree use only */
	u8                     transport;
	u8                     state;
	u8                     atomic_rd_en;
	u8                     resp_depth;

	struct mthca_mr        mr;

	struct mthca_wq        rq;
	struct mthca_wq        sq;
	enum ib_sig_type       sq_policy;
	int                    send_wqe_offset;
	int                    max_inline_data;

	u64                   *wrid;
	union mthca_buf	       queue;

	wait_queue_head_t      wait;
	struct mutex	       mutex;
};

struct mthca_sqp {
	struct mthca_qp qp;
	int             pkey_index;
	u32             qkey;
	u32             send_psn;
	struct ib_ud_header ud_header;
	int             header_buf_size;
	void           *header_buf;
	dma_addr_t      header_dma;
};

static inline struct mthca_ucontext *to_mucontext(struct ib_ucontext *ibucontext)
{
	return container_of(ibucontext, struct mthca_ucontext, ibucontext);
}

static inline struct mthca_fmr *to_mfmr(struct ib_fmr *ibmr)
{
	return container_of(ibmr, struct mthca_fmr, ibmr);
}

static inline struct mthca_mr *to_mmr(struct ib_mr *ibmr)
{
	return container_of(ibmr, struct mthca_mr, ibmr);
}

static inline struct mthca_pd *to_mpd(struct ib_pd *ibpd)
{
	return container_of(ibpd, struct mthca_pd, ibpd);
}

static inline struct mthca_ah *to_mah(struct ib_ah *ibah)
{
	return container_of(ibah, struct mthca_ah, ibah);
}

static inline struct mthca_cq *to_mcq(struct ib_cq *ibcq)
{
	return container_of(ibcq, struct mthca_cq, ibcq);
}

static inline struct mthca_srq *to_msrq(struct ib_srq *ibsrq)
{
	return container_of(ibsrq, struct mthca_srq, ibsrq);
}

static inline struct mthca_qp *to_mqp(struct ib_qp *ibqp)
{
	return container_of(ibqp, struct mthca_qp, ibqp);
}

static inline struct mthca_sqp *to_msqp(struct mthca_qp *qp)
{
	return container_of(qp, struct mthca_sqp, qp);
}

#endif /* MTHCA_PROVIDER_H */
Commit	Line	Data
1da177e4 LT	1	/*
1da177e4 LT	2	* Copyright (c) 2004 Topspin Communications. All rights reserved.
4885bf64	3	* Copyright (c) 2005, 2006 Cisco Systems. All rights reserved.
2a1d9b7f	4	* Copyright (c) 2005 Mellanox Technologies. All rights reserved.
1da177e4 LT	5	*
	6	* This software is available to you under a choice of one of two
	7	* licenses. You may choose to be licensed under the terms of the GNU
	8	* General Public License (GPL) Version 2, available from the file
	9	* COPYING in the main directory of this source tree, or the
	10	* OpenIB.org BSD license below:
	11	*
	12	* Redistribution and use in source and binary forms, with or
	13	* without modification, are permitted provided that the following
	14	* conditions are met:
	15	*
	16	* - Redistributions of source code must retain the above
	17	* copyright notice, this list of conditions and the following
	18	* disclaimer.
	19	*
	20	* - Redistributions in binary form must reproduce the above
	21	* copyright notice, this list of conditions and the following
	22	* disclaimer in the documentation and/or other materials
	23	* provided with the distribution.
	24	*
	25	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
	26	* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
	27	* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
	28	* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
	29	* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
	30	* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
	31	* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	32	* SOFTWARE.
	33	*
	34	* $Id: mthca_provider.h 1349 2004-12-16 21:09:43Z roland $
	35	*/
	36
	37	#ifndef MTHCA_PROVIDER_H
	38	#define MTHCA_PROVIDER_H
	39
a4d61e84 RD	40	#include <rdma/ib_verbs.h>
a4d61e84 RD	41	#include <rdma/ib_pack.h>
1da177e4 LT	42
	43	#define MTHCA_MPT_FLAG_ATOMIC (1 << 14)
	44	#define MTHCA_MPT_FLAG_REMOTE_WRITE (1 << 13)
	45	#define MTHCA_MPT_FLAG_REMOTE_READ (1 << 12)
	46	#define MTHCA_MPT_FLAG_LOCAL_WRITE (1 << 11)
	47	#define MTHCA_MPT_FLAG_LOCAL_READ (1 << 10)
	48
	49	struct mthca_buf_list {
	50	void *buf;
	51	DECLARE_PCI_UNMAP_ADDR(mapping)
	52	};
	53
87b81670 RD	54	union mthca_buf {
	55	struct mthca_buf_list direct;
	56	struct mthca_buf_list *page_list;
	57	};
	58
1da177e4 LT	59	struct mthca_uar {
	60	unsigned long pfn;
	61	int index;
	62	};
	63
5e0b537c RD	64	struct mthca_user_db_table;
	65
	66	struct mthca_ucontext {
	67	struct ib_ucontext ibucontext;
	68	struct mthca_uar uar;
	69	struct mthca_user_db_table *db_tab;
	70	};
	71
d56d6f95 RD	72	struct mthca_mtt;
d56d6f95 RD	73
1da177e4	74	struct mthca_mr {
d56d6f95	75	struct ib_mr ibmr;
f7c6a7b5	76	struct ib_umem *umem;
d56d6f95	77	struct mthca_mtt *mtt;
1da177e4 LT	78	};
1da177e4 LT	79
e0f5fdca	80	struct mthca_fmr {
d56d6f95	81	struct ib_fmr ibmr;
e0f5fdca	82	struct ib_fmr_attr attr;
d56d6f95 RD	83	struct mthca_mtt *mtt;
d56d6f95 RD	84	int maps;
e0f5fdca MT	85	union {
	86	struct {
	87	struct mthca_mpt_entry __iomem *mpt;
	88	u64 __iomem *mtts;
	89	} tavor;
	90	struct {
	91	struct mthca_mpt_entry *mpt;
	92	__be64 *mtts;
391e4dea	93	dma_addr_t dma_handle;
e0f5fdca MT	94	} arbel;
	95	} mem;
	96	};
	97
1da177e4 LT	98	struct mthca_pd {
	99	struct ib_pd ibpd;
	100	u32 pd_num;
	101	atomic_t sqp_count;
	102	struct mthca_mr ntmr;
99264c1e	103	int privileged;
1da177e4 LT	104	};
	105
	106	struct mthca_eq {
	107	struct mthca_dev *dev;
	108	int eqn;
	109	u32 eqn_mask;
	110	u32 cons_index;
	111	u16 msi_x_vector;
	112	u16 msi_x_entry;
	113	int have_irq;
	114	int nent;
	115	struct mthca_buf_list *page_list;
	116	struct mthca_mr mr;
	117	};
	118
	119	struct mthca_av;
	120
	121	enum mthca_ah_type {
	122	MTHCA_AH_ON_HCA,
	123	MTHCA_AH_PCI_POOL,
	124	MTHCA_AH_KMALLOC
	125	};
	126
	127	struct mthca_ah {
	128	struct ib_ah ibah;
	129	enum mthca_ah_type type;
	130	u32 key;
	131	struct mthca_av *av;
	132	dma_addr_t avdma;
	133	};
	134
	135	/*
	136	* Quick description of our CQ/QP locking scheme:
	137	*
	138	* We have one global lock that protects dev->cq/qp_table. Each
	139	* struct mthca_cq/qp also has its own lock. An individual qp lock
	140	* may be taken inside of an individual cq lock. Both cqs attached to
a19aa5c5 RD	141	* a qp may be locked, with the cq with the lower cqn locked first.
a19aa5c5 RD	142	* No other nesting should be done.
1da177e4	143	*
a3285aa4 RD	144	* Each struct mthca_cq/qp also has an ref count, protected by the
	145	* corresponding table lock. The pointer from the cq/qp_table to the
	146	* struct counts as one reference. This reference also is good for
	147	* access through the consumer API, so modifying the CQ/QP etc doesn't
	148	* need to take another reference. Access to a QP because of a
	149	* completion being polled does not need a reference either.
1da177e4 LT	150	*
	151	* Finally, each struct mthca_cq/qp has a wait_queue_head_t for the
	152	* destroy function to sleep on.
	153	*
	154	* This means that access from the consumer API requires nothing but
	155	* taking the struct's lock.
	156	*
	157	* Access because of a completion event should go as follows:
	158	* - lock cq/qp_table and look up struct
	159	* - increment ref count in struct
	160	* - drop cq/qp_table lock
	161	* - lock struct, do your thing, and unlock struct
	162	* - decrement ref count; if zero, wake up waiters
	163	*
	164	* To destroy a CQ/QP, we can do the following:
a3285aa4 RD	165	* - lock cq/qp_table
	166	* - remove pointer and decrement ref count
	167	* - unlock cq/qp_table lock
1da177e4 LT	168	* - wait_event until ref count is zero
	169	*
	170	* It is the consumer's responsibilty to make sure that no QP
4885bf64	171	* operations (WQE posting or state modification) are pending when a
1da177e4	172	* QP is destroyed. Also, the consumer must make sure that calls to
4885bf64 RD	173	* qp_modify are serialized. Similarly, the consumer is responsible
	174	* for ensuring that no CQ resize operations are pending when a CQ
	175	* is destroyed.
1da177e4 LT	176	*
	177	* Possible optimizations (wait for profile data to see if/where we
	178	* have locks bouncing between CPUs):
	179	* - split cq/qp table lock into n separate (cache-aligned) locks,
	180	* indexed (say) by the page in the table
	181	* - split QP struct lock into three (one for common info, one for the
	182	* send queue and one for the receive queue)
	183	*/
	184
4885bf64 RD	185	struct mthca_cq_buf {
	186	union mthca_buf queue;
	187	struct mthca_mr mr;
	188	int is_direct;
	189	};
	190
	191	struct mthca_cq_resize {
	192	struct mthca_cq_buf buf;
	193	int cqe;
	194	enum {
	195	CQ_RESIZE_ALLOC,
	196	CQ_RESIZE_READY,
	197	CQ_RESIZE_SWAPPED
	198	} state;
	199	};
	200
1da177e4	201	struct mthca_cq {
4885bf64 RD	202	struct ib_cq ibcq;
4885bf64 RD	203	spinlock_t lock;
a3285aa4	204	int refcount;
4885bf64 RD	205	int cqn;
	206	u32 cons_index;
	207	struct mthca_cq_buf buf;
	208	struct mthca_cq_resize *resize_buf;
	209	int is_kernel;
1da177e4 LT	210
1da177e4 LT	211	/* Next fields are Arbel only */
4885bf64 RD	212	int set_ci_db_index;
	213	__be32 *set_ci_db;
	214	int arm_db_index;
	215	__be32 *arm_db;
	216	int arm_sn;
1da177e4	217
4885bf64	218	wait_queue_head_t wait;
c93b6fba	219	struct mutex mutex;
1da177e4 LT	220	};
1da177e4 LT	221
ec34a922 RD	222	struct mthca_srq {
	223	struct ib_srq ibsrq;
	224	spinlock_t lock;
a3285aa4	225	int refcount;
ec34a922 RD	226	int srqn;
	227	int max;
	228	int max_gs;
	229	int wqe_shift;
	230	int first_free;
	231	int last_free;
	232	u16 counter; /* Arbel only */
	233	int db_index; /* Arbel only */
	234	__be32 db; / Arbel only */
	235	void *last;
	236
	237	int is_direct;
	238	u64 *wrid;
	239	union mthca_buf queue;
	240	struct mthca_mr mr;
	241
	242	wait_queue_head_t wait;
c93b6fba	243	struct mutex mutex;
ec34a922 RD	244	};
ec34a922 RD	245
1da177e4 LT	246	struct mthca_wq {
	247	spinlock_t lock;
	248	int max;
	249	unsigned next_ind;
	250	unsigned last_comp;
	251	unsigned head;
	252	unsigned tail;
	253	void *last;
	254	int max_gs;
	255	int wqe_shift;
	256
	257	int db_index; /* Arbel only */
97f52eb4	258	__be32 *db;
1da177e4 LT	259	};
	260
	261	struct mthca_qp {
	262	struct ib_qp ibqp;
a3285aa4	263	int refcount;
1da177e4 LT	264	u32 qpn;
1da177e4 LT	265	int is_direct;
bf6a9e31 JM	266	u8 port; /* for SQP and memfree use only */
bf6a9e31 JM	267	u8 alt_port; /* for memfree use only */
1da177e4 LT	268	u8 transport;
	269	u8 state;
	270	u8 atomic_rd_en;
	271	u8 resp_depth;
	272
	273	struct mthca_mr mr;
	274
	275	struct mthca_wq rq;
	276	struct mthca_wq sq;
	277	enum ib_sig_type sq_policy;
	278	int send_wqe_offset;
77369ed3	279	int max_inline_data;
1da177e4 LT	280
1da177e4 LT	281	u64 *wrid;
87b81670	282	union mthca_buf queue;
1da177e4 LT	283
1da177e4 LT	284	wait_queue_head_t wait;
c93b6fba	285	struct mutex mutex;
1da177e4 LT	286	};
	287
	288	struct mthca_sqp {
	289	struct mthca_qp qp;
1da177e4 LT	290	int pkey_index;
	291	u32 qkey;
	292	u32 send_psn;
	293	struct ib_ud_header ud_header;
	294	int header_buf_size;
	295	void *header_buf;
	296	dma_addr_t header_dma;
	297	};
	298
5e0b537c RD	299	static inline struct mthca_ucontext to_mucontext(struct ib_ucontext ibucontext)
	300	{
	301	return container_of(ibucontext, struct mthca_ucontext, ibucontext);
	302	}
	303
e0f5fdca MT	304	static inline struct mthca_fmr to_mfmr(struct ib_fmr ibmr)
	305	{
	306	return container_of(ibmr, struct mthca_fmr, ibmr);
	307	}
	308
1da177e4 LT	309	static inline struct mthca_mr to_mmr(struct ib_mr ibmr)
	310	{
	311	return container_of(ibmr, struct mthca_mr, ibmr);
	312	}
	313
	314	static inline struct mthca_pd to_mpd(struct ib_pd ibpd)
	315	{
	316	return container_of(ibpd, struct mthca_pd, ibpd);
	317	}
	318
	319	static inline struct mthca_ah to_mah(struct ib_ah ibah)
	320	{
	321	return container_of(ibah, struct mthca_ah, ibah);
	322	}
	323
	324	static inline struct mthca_cq to_mcq(struct ib_cq ibcq)
	325	{
	326	return container_of(ibcq, struct mthca_cq, ibcq);
	327	}
	328
ec34a922 RD	329	static inline struct mthca_srq to_msrq(struct ib_srq ibsrq)
	330	{
	331	return container_of(ibsrq, struct mthca_srq, ibsrq);
	332	}
	333
1da177e4 LT	334	static inline struct mthca_qp to_mqp(struct ib_qp ibqp)
	335	{
	336	return container_of(ibqp, struct mthca_qp, ibqp);
	337	}
	338
	339	static inline struct mthca_sqp to_msqp(struct mthca_qp qp)
	340	{
	341	return container_of(qp, struct mthca_sqp, qp);
	342	}
	343
	344	#endif /* MTHCA_PROVIDER_H */