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)
66 struct mthca_dev *dev;
74 struct mthca_buf_list *page_list;
89 * Quick description of our CQ/QP locking scheme:
91 * We have one global lock that protects dev->cq/qp_table. Each
92 * struct mthca_cq/qp also has its own lock. An individual qp lock
93 * may be taken inside of an individual cq lock. Both cqs attached to
94 * a qp may be locked, with the send cq locked first. No other
95 * nesting should be done.
97 * Each struct mthca_cq/qp also has an atomic_t ref count. The
98 * pointer from the cq/qp_table to the struct counts as one reference.
99 * This reference also is good for access through the consumer API, so
100 * modifying the CQ/QP etc doesn't need to take another reference.
101 * Access because of a completion being polled does need a reference.
103 * Finally, each struct mthca_cq/qp has a wait_queue_head_t for the
104 * destroy function to sleep on.
106 * This means that access from the consumer API requires nothing but
107 * taking the struct's lock.
109 * Access because of a completion event should go as follows:
110 * - lock cq/qp_table and look up struct
111 * - increment ref count in struct
112 * - drop cq/qp_table lock
113 * - lock struct, do your thing, and unlock struct
114 * - decrement ref count; if zero, wake up waiters
116 * To destroy a CQ/QP, we can do the following:
117 * - lock cq/qp_table, remove pointer, unlock cq/qp_table lock
118 * - decrement ref count
119 * - wait_event until ref count is zero
121 * It is the consumer's responsibilty to make sure that no QP
122 * operations (WQE posting or state modification) are pending when the
123 * QP is destroyed. Also, the consumer must make sure that calls to
124 * qp_modify are serialized.
126 * Possible optimizations (wait for profile data to see if/where we
127 * have locks bouncing between CPUs):
128 * - split cq/qp table lock into n separate (cache-aligned) locks,
129 * indexed (say) by the page in the table
130 * - split QP struct lock into three (one for common info, one for the
131 * send queue and one for the receive queue)
142 struct mthca_buf_list direct;
143 struct mthca_buf_list *page_list;
146 wait_queue_head_t wait;
157 enum ib_sig_type policy;
179 struct mthca_buf_list direct;
180 struct mthca_buf_list *page_list;
183 wait_queue_head_t wait;
192 struct ib_ud_header ud_header;
195 dma_addr_t header_dma;
198 static inline struct mthca_mr *to_mmr(struct ib_mr *ibmr)
200 return container_of(ibmr, struct mthca_mr, ibmr);
203 static inline struct mthca_pd *to_mpd(struct ib_pd *ibpd)
205 return container_of(ibpd, struct mthca_pd, ibpd);
208 static inline struct mthca_ah *to_mah(struct ib_ah *ibah)
210 return container_of(ibah, struct mthca_ah, ibah);
213 static inline struct mthca_cq *to_mcq(struct ib_cq *ibcq)
215 return container_of(ibcq, struct mthca_cq, ibcq);
218 static inline struct mthca_qp *to_mqp(struct ib_qp *ibqp)
220 return container_of(ibqp, struct mthca_qp, ibqp);
223 static inline struct mthca_sqp *to_msqp(struct mthca_qp *qp)
225 return container_of(qp, struct mthca_sqp, qp);
228 #endif /* MTHCA_PROVIDER_H */