2 * Copyright (c) 2004 Topspin Communications. All rights reserved.
3 * Copyright (c) 2005 Cisco Systems. All rights reserved.
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:
11 * Redistribution and use in source and binary forms, with or
12 * without modification, are permitted provided that the following
15 * - Redistributions of source code must retain the above
16 * copyright notice, this list of conditions and the following
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.
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
33 * $Id: mthca_provider.h 1349 2004-12-16 21:09:43Z roland $
36 #ifndef MTHCA_PROVIDER_H
37 #define MTHCA_PROVIDER_H
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)
48 struct mthca_buf_list {
50 DECLARE_PCI_UNMAP_ADDR(mapping)
58 struct mthca_user_db_table;
60 struct mthca_ucontext {
61 struct ib_ucontext ibucontext;
63 struct mthca_user_db_table *db_tab;
70 struct mthca_mtt *mtt;
75 struct ib_fmr_attr attr;
76 struct mthca_mtt *mtt;
80 struct mthca_mpt_entry __iomem *mpt;
84 struct mthca_mpt_entry *mpt;
99 struct mthca_dev *dev;
107 struct mthca_buf_list *page_list;
121 enum mthca_ah_type type;
128 * Quick description of our CQ/QP locking scheme:
130 * We have one global lock that protects dev->cq/qp_table. Each
131 * struct mthca_cq/qp also has its own lock. An individual qp lock
132 * may be taken inside of an individual cq lock. Both cqs attached to
133 * a qp may be locked, with the send cq locked first. No other
134 * nesting should be done.
136 * Each struct mthca_cq/qp also has an atomic_t ref count. The
137 * pointer from the cq/qp_table to the struct counts as one reference.
138 * This reference also is good for access through the consumer API, so
139 * modifying the CQ/QP etc doesn't need to take another reference.
140 * Access because of a completion being polled does need a reference.
142 * Finally, each struct mthca_cq/qp has a wait_queue_head_t for the
143 * destroy function to sleep on.
145 * This means that access from the consumer API requires nothing but
146 * taking the struct's lock.
148 * Access because of a completion event should go as follows:
149 * - lock cq/qp_table and look up struct
150 * - increment ref count in struct
151 * - drop cq/qp_table lock
152 * - lock struct, do your thing, and unlock struct
153 * - decrement ref count; if zero, wake up waiters
155 * To destroy a CQ/QP, we can do the following:
156 * - lock cq/qp_table, remove pointer, unlock cq/qp_table lock
157 * - decrement ref count
158 * - wait_event until ref count is zero
160 * It is the consumer's responsibilty to make sure that no QP
161 * operations (WQE posting or state modification) are pending when the
162 * QP is destroyed. Also, the consumer must make sure that calls to
163 * qp_modify are serialized.
165 * Possible optimizations (wait for profile data to see if/where we
166 * have locks bouncing between CPUs):
167 * - split cq/qp table lock into n separate (cache-aligned) locks,
168 * indexed (say) by the page in the table
169 * - split QP struct lock into three (one for common info, one for the
170 * send queue and one for the receive queue)
182 /* Next fields are Arbel only */
190 struct mthca_buf_list direct;
191 struct mthca_buf_list *page_list;
194 wait_queue_head_t wait;
208 int db_index; /* Arbel only */
226 enum ib_sig_type sq_policy;
231 struct mthca_buf_list direct;
232 struct mthca_buf_list *page_list;
235 wait_queue_head_t wait;
244 struct ib_ud_header ud_header;
247 dma_addr_t header_dma;
250 static inline struct mthca_ucontext *to_mucontext(struct ib_ucontext *ibucontext)
252 return container_of(ibucontext, struct mthca_ucontext, ibucontext);
255 static inline struct mthca_fmr *to_mfmr(struct ib_fmr *ibmr)
257 return container_of(ibmr, struct mthca_fmr, ibmr);
260 static inline struct mthca_mr *to_mmr(struct ib_mr *ibmr)
262 return container_of(ibmr, struct mthca_mr, ibmr);
265 static inline struct mthca_pd *to_mpd(struct ib_pd *ibpd)
267 return container_of(ibpd, struct mthca_pd, ibpd);
270 static inline struct mthca_ah *to_mah(struct ib_ah *ibah)
272 return container_of(ibah, struct mthca_ah, ibah);
275 static inline struct mthca_cq *to_mcq(struct ib_cq *ibcq)
277 return container_of(ibcq, struct mthca_cq, ibcq);
280 static inline struct mthca_qp *to_mqp(struct ib_qp *ibqp)
282 return container_of(ibqp, struct mthca_qp, ibqp);
285 static inline struct mthca_sqp *to_msqp(struct mthca_qp *qp)
287 return container_of(qp, struct mthca_sqp, qp);
290 #endif /* MTHCA_PROVIDER_H */