drivers/infiniband/hw/mthca/mthca_provider.h

   1 /*
   2  * Copyright (c) 2004 Topspin Communications.  All rights reserved.
   3  *
   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:
   9  *
  10  *     Redistribution and use in source and binary forms, with or
  11  *     without modification, are permitted provided that the following
  12  *     conditions are met:
  13  *
  14  *      - Redistributions of source code must retain the above
  15  *        copyright notice, this list of conditions and the following
  16  *        disclaimer.
  17  *
  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.
  22  *
  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
  30  * SOFTWARE.
  31  *
  32  * $Id: mthca_provider.h 1349 2004-12-16 21:09:43Z roland $
  33  */
  34
  35 #ifndef MTHCA_PROVIDER_H
  36 #define MTHCA_PROVIDER_H
  37
  38 #include <ib_verbs.h>
  39 #include <ib_pack.h>
  40
  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)
  46
  47 struct mthca_buf_list {
  48         void *buf;
  49         DECLARE_PCI_UNMAP_ADDR(mapping)
  50 };
  51
  52 struct mthca_mr {
  53         struct ib_mr ibmr;
  54         int order;
  55         u32 first_seg;
  56 };
  57
  58 struct mthca_pd {
  59         struct ib_pd    ibpd;
  60         u32             pd_num;
  61         atomic_t        sqp_count;
  62         struct mthca_mr ntmr;
  63 };
  64
  65 struct mthca_eq {
  66         struct mthca_dev      *dev;
  67         int                    eqn;
  68         u32                    ecr_mask;
  69         u32                    cons_index;
  70         u16                    msi_x_vector;
  71         u16                    msi_x_entry;
  72         int                    have_irq;
  73         int                    nent;
  74         struct mthca_buf_list *page_list;
  75         struct mthca_mr        mr;
  76 };
  77
  78 struct mthca_av;
  79
  80 struct mthca_ah {
  81         struct ib_ah     ibah;
  82         int              on_hca;
  83         u32              key;
  84         struct mthca_av *av;
  85         dma_addr_t       avdma;
  86 };
  87
  88 /*
  89  * Quick description of our CQ/QP locking scheme:
  90  *
  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.
  96  *
  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.
 102  *
 103  * Finally, each struct mthca_cq/qp has a wait_queue_head_t for the
 104  * destroy function to sleep on.
 105  *
 106  * This means that access from the consumer API requires nothing but
 107  * taking the struct's lock.
 108  *
 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
 115  *
 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
 120  *
 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.
 125  *
 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)
 132  */
 133
 134 struct mthca_cq {
 135         struct ib_cq           ibcq;
 136         spinlock_t             lock;
 137         atomic_t               refcount;
 138         int                    cqn;
 139         int                    cons_index;
 140         int                    is_direct;
 141         union {
 142                 struct mthca_buf_list direct;
 143                 struct mthca_buf_list *page_list;
 144         }                      queue;
 145         struct mthca_mr        mr;
 146         wait_queue_head_t      wait;
 147 };
 148
 149 struct mthca_wq {
 150         int   max;
 151         int   cur;
 152         int   next;
 153         int   last_comp;
 154         void *last;
 155         int   max_gs;
 156         int   wqe_shift;
 157         enum ib_sig_type policy;
 158 };
 159
 160 struct mthca_qp {
 161         struct ib_qp           ibqp;
 162         spinlock_t             lock;
 163         atomic_t               refcount;
 164         u32                    qpn;
 165         int                    is_direct;
 166         u8                     transport;
 167         u8                     state;
 168         u8                     atomic_rd_en;
 169         u8                     resp_depth;
 170
 171         struct mthca_mr        mr;
 172
 173         struct mthca_wq        rq;
 174         struct mthca_wq        sq;
 175         int                    send_wqe_offset;
 176
 177         u64                   *wrid;
 178         union {
 179                 struct mthca_buf_list direct;
 180                 struct mthca_buf_list *page_list;
 181         }                      queue;
 182
 183         wait_queue_head_t      wait;
 184 };
 185
 186 struct mthca_sqp {
 187         struct mthca_qp qp;
 188         int             port;
 189         int             pkey_index;
 190         u32             qkey;
 191         u32             send_psn;
 192         struct ib_ud_header ud_header;
 193         int             header_buf_size;
 194         void           *header_buf;
 195         dma_addr_t      header_dma;
 196 };
 197
 198 static inline struct mthca_mr *to_mmr(struct ib_mr *ibmr)
 199 {
 200         return container_of(ibmr, struct mthca_mr, ibmr);
 201 }
 202
 203 static inline struct mthca_pd *to_mpd(struct ib_pd *ibpd)
 204 {
 205         return container_of(ibpd, struct mthca_pd, ibpd);
 206 }
 207
 208 static inline struct mthca_ah *to_mah(struct ib_ah *ibah)
 209 {
 210         return container_of(ibah, struct mthca_ah, ibah);
 211 }
 212
 213 static inline struct mthca_cq *to_mcq(struct ib_cq *ibcq)
 214 {
 215         return container_of(ibcq, struct mthca_cq, ibcq);
 216 }
 217
 218 static inline struct mthca_qp *to_mqp(struct ib_qp *ibqp)
 219 {
 220         return container_of(ibqp, struct mthca_qp, ibqp);
 221 }
 222
 223 static inline struct mthca_sqp *to_msqp(struct mthca_qp *qp)
 224 {
 225         return container_of(qp, struct mthca_sqp, qp);
 226 }
 227
 228 #endif /* MTHCA_PROVIDER_H */