2 * Copyright (c) 2004 Topspin Communications. All rights reserved.
4 * This software is available to you under a choice of one of two
5 * licenses. You may choose to be licensed under the terms of the GNU
6 * General Public License (GPL) Version 2, available from the file
7 * COPYING in the main directory of this source tree, or the
8 * OpenIB.org BSD license below:
10 * Redistribution and use in source and binary forms, with or
11 * without modification, are permitted provided that the following
14 * - Redistributions of source code must retain the above
15 * copyright notice, this list of conditions and the following
18 * - Redistributions in binary form must reproduce the above
19 * copyright notice, this list of conditions and the following
20 * disclaimer in the documentation and/or other materials
21 * provided with the distribution.
23 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
24 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
25 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
26 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
27 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
28 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
29 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
32 * $Id: mthca_provider.h 1349 2004-12-16 21:09:43Z roland $
35 #ifndef MTHCA_PROVIDER_H
36 #define MTHCA_PROVIDER_H
41 #define MTHCA_MPT_FLAG_ATOMIC (1 << 14)
42 #define MTHCA_MPT_FLAG_REMOTE_WRITE (1 << 13)
43 #define MTHCA_MPT_FLAG_REMOTE_READ (1 << 12)
44 #define MTHCA_MPT_FLAG_LOCAL_WRITE (1 << 11)
45 #define MTHCA_MPT_FLAG_LOCAL_READ (1 << 10)
47 struct mthca_buf_list {
49 DECLARE_PCI_UNMAP_ADDR(mapping)
71 struct mthca_dev *dev;
79 struct mthca_buf_list *page_list;
93 enum mthca_ah_type type;
100 * Quick description of our CQ/QP locking scheme:
102 * We have one global lock that protects dev->cq/qp_table. Each
103 * struct mthca_cq/qp also has its own lock. An individual qp lock
104 * may be taken inside of an individual cq lock. Both cqs attached to
105 * a qp may be locked, with the send cq locked first. No other
106 * nesting should be done.
108 * Each struct mthca_cq/qp also has an atomic_t ref count. The
109 * pointer from the cq/qp_table to the struct counts as one reference.
110 * This reference also is good for access through the consumer API, so
111 * modifying the CQ/QP etc doesn't need to take another reference.
112 * Access because of a completion being polled does need a reference.
114 * Finally, each struct mthca_cq/qp has a wait_queue_head_t for the
115 * destroy function to sleep on.
117 * This means that access from the consumer API requires nothing but
118 * taking the struct's lock.
120 * Access because of a completion event should go as follows:
121 * - lock cq/qp_table and look up struct
122 * - increment ref count in struct
123 * - drop cq/qp_table lock
124 * - lock struct, do your thing, and unlock struct
125 * - decrement ref count; if zero, wake up waiters
127 * To destroy a CQ/QP, we can do the following:
128 * - lock cq/qp_table, remove pointer, unlock cq/qp_table lock
129 * - decrement ref count
130 * - wait_event until ref count is zero
132 * It is the consumer's responsibilty to make sure that no QP
133 * operations (WQE posting or state modification) are pending when the
134 * QP is destroyed. Also, the consumer must make sure that calls to
135 * qp_modify are serialized.
137 * Possible optimizations (wait for profile data to see if/where we
138 * have locks bouncing between CPUs):
139 * - split cq/qp table lock into n separate (cache-aligned) locks,
140 * indexed (say) by the page in the table
141 * - split QP struct lock into three (one for common info, one for the
142 * send queue and one for the receive queue)
153 /* Next fields are Arbel only */
161 struct mthca_buf_list direct;
162 struct mthca_buf_list *page_list;
165 wait_queue_head_t wait;
179 int db_index; /* Arbel only */
197 enum ib_sig_type sq_policy;
202 struct mthca_buf_list direct;
203 struct mthca_buf_list *page_list;
206 wait_queue_head_t wait;
215 struct ib_ud_header ud_header;
218 dma_addr_t header_dma;
221 static inline struct mthca_mr *to_mmr(struct ib_mr *ibmr)
223 return container_of(ibmr, struct mthca_mr, ibmr);
226 static inline struct mthca_pd *to_mpd(struct ib_pd *ibpd)
228 return container_of(ibpd, struct mthca_pd, ibpd);
231 static inline struct mthca_ah *to_mah(struct ib_ah *ibah)
233 return container_of(ibah, struct mthca_ah, ibah);
236 static inline struct mthca_cq *to_mcq(struct ib_cq *ibcq)
238 return container_of(ibcq, struct mthca_cq, ibcq);
241 static inline struct mthca_qp *to_mqp(struct ib_qp *ibqp)
243 return container_of(ibqp, struct mthca_qp, ibqp);
246 static inline struct mthca_sqp *to_msqp(struct mthca_qp *qp)
248 return container_of(qp, struct mthca_sqp, qp);
251 #endif /* MTHCA_PROVIDER_H */