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

/*
 * Copyright (c) 2004 Topspin Communications.  All rights reserved.
 * Copyright (c) 2005 Cisco Systems.  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 <ib_verbs.h>
#include <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)
};

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 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;
		} arbel;
	} mem;
};

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

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 send cq locked first.  No other
 * nesting should be done.
 *
 * Each struct mthca_cq/qp also has an atomic_t ref count.  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 because of a completion being polled does need a reference.
 *
 * 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, unlock cq/qp_table lock
 * - decrement ref count
 * - 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 the
 * QP is destroyed.  Also, the consumer must make sure that calls to
 * qp_modify are serialized.
 *
 * 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 {
	struct ib_cq           ibcq;
	spinlock_t             lock;
	atomic_t               refcount;
	int                    cqn;
	u32                    cons_index;
	int                    is_direct;

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

	union {
		struct mthca_buf_list direct;
		struct mthca_buf_list *page_list;
	}                      queue;
	struct mthca_mr        mr;
	wait_queue_head_t      wait;
};

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 */
	u32       *db;
};

struct mthca_qp {
	struct ib_qp           ibqp;
	atomic_t               refcount;
	u32                    qpn;
	int                    is_direct;
	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;

	u64                   *wrid;
	union {
		struct mthca_buf_list direct;
		struct mthca_buf_list *page_list;
	}                      queue;

	wait_queue_head_t      wait;
};

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