1 /* 2 * Copyright (c) 2004 Topspin Communications. All rights reserved. 3 * Copyright (c) 2005, 2006 Cisco Systems. All rights reserved. 4 * Copyright (c) 2005 Mellanox Technologies. All rights reserved. 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 40 #include <rdma/ib_verbs.h> 41 #include <rdma/ib_pack.h> 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 54 union mthca_buf { 55 struct mthca_buf_list direct; 56 struct mthca_buf_list *page_list; 57 }; 58 59 struct mthca_uar { 60 unsigned long pfn; 61 int index; 62 }; 63 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 int reg_mr_warned; 71 }; 72 73 struct mthca_mtt; 74 75 struct mthca_mr { 76 struct ib_mr ibmr; 77 struct ib_umem *umem; 78 struct mthca_mtt *mtt; 79 }; 80 81 struct mthca_fmr { 82 struct ib_fmr ibmr; 83 struct ib_fmr_attr attr; 84 struct mthca_mtt *mtt; 85 int maps; 86 union { 87 struct { 88 struct mthca_mpt_entry __iomem *mpt; 89 u64 __iomem *mtts; 90 } tavor; 91 struct { 92 struct mthca_mpt_entry *mpt; 93 __be64 *mtts; 94 dma_addr_t dma_handle; 95 } arbel; 96 } mem; 97 }; 98 99 struct mthca_pd { 100 struct ib_pd ibpd; 101 u32 pd_num; 102 atomic_t sqp_count; 103 struct mthca_mr ntmr; 104 int privileged; 105 }; 106 107 struct mthca_eq { 108 struct mthca_dev *dev; 109 int eqn; 110 u32 eqn_mask; 111 u32 cons_index; 112 u16 msi_x_vector; 113 u16 msi_x_entry; 114 int have_irq; 115 int nent; 116 struct mthca_buf_list *page_list; 117 struct mthca_mr mr; 118 }; 119 120 struct mthca_av; 121 122 enum mthca_ah_type { 123 MTHCA_AH_ON_HCA, 124 MTHCA_AH_PCI_POOL, 125 MTHCA_AH_KMALLOC 126 }; 127 128 struct mthca_ah { 129 struct ib_ah ibah; 130 enum mthca_ah_type type; 131 u32 key; 132 struct mthca_av *av; 133 dma_addr_t avdma; 134 }; 135 136 /* 137 * Quick description of our CQ/QP locking scheme: 138 * 139 * We have one global lock that protects dev->cq/qp_table. Each 140 * struct mthca_cq/qp also has its own lock. An individual qp lock 141 * may be taken inside of an individual cq lock. Both cqs attached to 142 * a qp may be locked, with the cq with the lower cqn locked first. 143 * No other nesting should be done. 144 * 145 * Each struct mthca_cq/qp also has an ref count, protected by the 146 * corresponding table lock. The pointer from the cq/qp_table to the 147 * struct counts as one reference. This reference also is good for 148 * access through the consumer API, so modifying the CQ/QP etc doesn't 149 * need to take another reference. Access to a QP because of a 150 * completion being polled does not need a reference either. 151 * 152 * Finally, each struct mthca_cq/qp has a wait_queue_head_t for the 153 * destroy function to sleep on. 154 * 155 * This means that access from the consumer API requires nothing but 156 * taking the struct's lock. 157 * 158 * Access because of a completion event should go as follows: 159 * - lock cq/qp_table and look up struct 160 * - increment ref count in struct 161 * - drop cq/qp_table lock 162 * - lock struct, do your thing, and unlock struct 163 * - decrement ref count; if zero, wake up waiters 164 * 165 * To destroy a CQ/QP, we can do the following: 166 * - lock cq/qp_table 167 * - remove pointer and decrement ref count 168 * - unlock cq/qp_table lock 169 * - wait_event until ref count is zero 170 * 171 * It is the consumer's responsibilty to make sure that no QP 172 * operations (WQE posting or state modification) are pending when a 173 * QP is destroyed. Also, the consumer must make sure that calls to 174 * qp_modify are serialized. Similarly, the consumer is responsible 175 * for ensuring that no CQ resize operations are pending when a CQ 176 * is destroyed. 177 * 178 * Possible optimizations (wait for profile data to see if/where we 179 * have locks bouncing between CPUs): 180 * - split cq/qp table lock into n separate (cache-aligned) locks, 181 * indexed (say) by the page in the table 182 * - split QP struct lock into three (one for common info, one for the 183 * send queue and one for the receive queue) 184 */ 185 186 struct mthca_cq_buf { 187 union mthca_buf queue; 188 struct mthca_mr mr; 189 int is_direct; 190 }; 191 192 struct mthca_cq_resize { 193 struct mthca_cq_buf buf; 194 int cqe; 195 enum { 196 CQ_RESIZE_ALLOC, 197 CQ_RESIZE_READY, 198 CQ_RESIZE_SWAPPED 199 } state; 200 }; 201 202 struct mthca_cq { 203 struct ib_cq ibcq; 204 spinlock_t lock; 205 int refcount; 206 int cqn; 207 u32 cons_index; 208 struct mthca_cq_buf buf; 209 struct mthca_cq_resize *resize_buf; 210 int is_kernel; 211 212 /* Next fields are Arbel only */ 213 int set_ci_db_index; 214 __be32 *set_ci_db; 215 int arm_db_index; 216 __be32 *arm_db; 217 int arm_sn; 218 219 wait_queue_head_t wait; 220 struct mutex mutex; 221 }; 222 223 struct mthca_srq { 224 struct ib_srq ibsrq; 225 spinlock_t lock; 226 int refcount; 227 int srqn; 228 int max; 229 int max_gs; 230 int wqe_shift; 231 int first_free; 232 int last_free; 233 u16 counter; /* Arbel only */ 234 int db_index; /* Arbel only */ 235 __be32 *db; /* Arbel only */ 236 void *last; 237 238 int is_direct; 239 u64 *wrid; 240 union mthca_buf queue; 241 struct mthca_mr mr; 242 243 wait_queue_head_t wait; 244 struct mutex mutex; 245 }; 246 247 struct mthca_wq { 248 spinlock_t lock; 249 int max; 250 unsigned next_ind; 251 unsigned last_comp; 252 unsigned head; 253 unsigned tail; 254 void *last; 255 int max_gs; 256 int wqe_shift; 257 258 int db_index; /* Arbel only */ 259 __be32 *db; 260 }; 261 262 struct mthca_qp { 263 struct ib_qp ibqp; 264 int refcount; 265 u32 qpn; 266 int is_direct; 267 u8 port; /* for SQP and memfree use only */ 268 u8 alt_port; /* for memfree use only */ 269 u8 transport; 270 u8 state; 271 u8 atomic_rd_en; 272 u8 resp_depth; 273 274 struct mthca_mr mr; 275 276 struct mthca_wq rq; 277 struct mthca_wq sq; 278 enum ib_sig_type sq_policy; 279 int send_wqe_offset; 280 int max_inline_data; 281 282 u64 *wrid; 283 union mthca_buf queue; 284 285 wait_queue_head_t wait; 286 struct mutex mutex; 287 }; 288 289 struct mthca_sqp { 290 struct mthca_qp qp; 291 int pkey_index; 292 u32 qkey; 293 u32 send_psn; 294 struct ib_ud_header ud_header; 295 int header_buf_size; 296 void *header_buf; 297 dma_addr_t header_dma; 298 }; 299 300 static inline struct mthca_ucontext *to_mucontext(struct ib_ucontext *ibucontext) 301 { 302 return container_of(ibucontext, struct mthca_ucontext, ibucontext); 303 } 304 305 static inline struct mthca_fmr *to_mfmr(struct ib_fmr *ibmr) 306 { 307 return container_of(ibmr, struct mthca_fmr, ibmr); 308 } 309 310 static inline struct mthca_mr *to_mmr(struct ib_mr *ibmr) 311 { 312 return container_of(ibmr, struct mthca_mr, ibmr); 313 } 314 315 static inline struct mthca_pd *to_mpd(struct ib_pd *ibpd) 316 { 317 return container_of(ibpd, struct mthca_pd, ibpd); 318 } 319 320 static inline struct mthca_ah *to_mah(struct ib_ah *ibah) 321 { 322 return container_of(ibah, struct mthca_ah, ibah); 323 } 324 325 static inline struct mthca_cq *to_mcq(struct ib_cq *ibcq) 326 { 327 return container_of(ibcq, struct mthca_cq, ibcq); 328 } 329 330 static inline struct mthca_srq *to_msrq(struct ib_srq *ibsrq) 331 { 332 return container_of(ibsrq, struct mthca_srq, ibsrq); 333 } 334 335 static inline struct mthca_qp *to_mqp(struct ib_qp *ibqp) 336 { 337 return container_of(ibqp, struct mthca_qp, ibqp); 338 } 339 340 static inline struct mthca_sqp *to_msqp(struct mthca_qp *qp) 341 { 342 return container_of(qp, struct mthca_sqp, qp); 343 } 344 345 #endif /* MTHCA_PROVIDER_H */ 346