drivers/infiniband/core/mad_priv.h

   1 /*
   2  * Copyright (c) 2004, 2005, Voltaire, Inc. All rights reserved.
   3  * Copyright (c) 2005 Intel Corporation. All rights reserved.
   4  * Copyright (c) 2005 Sun Microsystems, Inc. All rights reserved.
   5  * Copyright (c) 2009 HNR Consulting. All rights reserved.
   6  *
   7  * This software is available to you under a choice of one of two
   8  * licenses.  You may choose to be licensed under the terms of the GNU
   9  * General Public License (GPL) Version 2, available from the file
  10  * COPYING in the main directory of this source tree, or the
  11  * OpenIB.org BSD license below:
  12  *
  13  *     Redistribution and use in source and binary forms, with or
  14  *     without modification, are permitted provided that the following
  15  *     conditions are met:
  16  *
  17  *      - Redistributions of source code must retain the above
  18  *        copyright notice, this list of conditions and the following
  19  *        disclaimer.
  20  *
  21  *      - Redistributions in binary form must reproduce the above
  22  *        copyright notice, this list of conditions and the following
  23  *        disclaimer in the documentation and/or other materials
  24  *        provided with the distribution.
  25  *
  26  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  27  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  28  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  29  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  30  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  31  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  32  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  33  * SOFTWARE.
  34  */
  35
  36 #ifndef __IB_MAD_PRIV_H__
  37 #define __IB_MAD_PRIV_H__
  38
  39 #include <linux/completion.h>
  40 #include <linux/err.h>
  41 #include <linux/workqueue.h>
  42 #include <rdma/ib_mad.h>
  43 #include <rdma/ib_smi.h>
  44 #include <rdma/opa_smi.h>
  45
  46 #define IB_MAD_QPS_CORE         2 /* Always QP0 and QP1 as a minimum */
  47
  48 /* QP and CQ parameters */
  49 #define IB_MAD_QP_SEND_SIZE     128
  50 #define IB_MAD_QP_RECV_SIZE     512
  51 #define IB_MAD_QP_MIN_SIZE      64
  52 #define IB_MAD_QP_MAX_SIZE      8192
  53 #define IB_MAD_SEND_REQ_MAX_SG  2
  54 #define IB_MAD_RECV_REQ_MAX_SG  1
  55
  56 #define IB_MAD_SEND_Q_PSN       0
  57
  58 /* Registration table sizes */
  59 #define MAX_MGMT_CLASS          80
  60 #define MAX_MGMT_VERSION        0x83
  61 #define MAX_MGMT_OUI            8
  62 #define MAX_MGMT_VENDOR_RANGE2  (IB_MGMT_CLASS_VENDOR_RANGE2_END - \
  63                                 IB_MGMT_CLASS_VENDOR_RANGE2_START + 1)
  64
  65 struct ib_mad_list_head {
  66         struct list_head list;
  67         struct ib_cqe cqe;
  68         struct ib_mad_queue *mad_queue;
  69 };
  70
  71 struct ib_mad_private_header {
  72         struct ib_mad_list_head mad_list;
  73         struct ib_mad_recv_wc recv_wc;
  74         struct ib_wc wc;
  75         u64 mapping;
  76 } __packed;
  77
  78 struct ib_mad_private {
  79         struct ib_mad_private_header header;
  80         size_t mad_size;
  81         struct ib_grh grh;
  82         u8 mad[];
  83 } __packed;
  84
  85 struct ib_rmpp_segment {
  86         struct list_head list;
  87         u32 num;
  88         u8 data[];
  89 };
  90
  91 struct ib_mad_agent_private {
  92         struct ib_mad_agent agent;
  93         struct ib_mad_reg_req *reg_req;
  94         struct ib_mad_qp_info *qp_info;
  95
  96         spinlock_t lock;
  97         struct list_head send_list;
  98         struct list_head wait_list;
  99         struct list_head done_list;
 100         struct delayed_work timed_work;
 101         unsigned long timeout;
 102         struct list_head local_list;
 103         struct work_struct local_work;
 104         struct list_head rmpp_list;
 105
 106         refcount_t refcount;
 107         union {
 108                 struct completion comp;
 109                 struct rcu_head rcu;
 110         };
 111 };
 112
 113 struct ib_mad_snoop_private {
 114         struct ib_mad_agent agent;
 115         struct ib_mad_qp_info *qp_info;
 116         int snoop_index;
 117         int mad_snoop_flags;
 118         atomic_t refcount;
 119         struct completion comp;
 120 };
 121
 122 struct ib_mad_send_wr_private {
 123         struct ib_mad_list_head mad_list;
 124         struct list_head agent_list;
 125         struct ib_mad_agent_private *mad_agent_priv;
 126         struct ib_mad_send_buf send_buf;
 127         u64 header_mapping;
 128         u64 payload_mapping;
 129         struct ib_ud_wr send_wr;
 130         struct ib_sge sg_list[IB_MAD_SEND_REQ_MAX_SG];
 131         __be64 tid;
 132         unsigned long timeout;
 133         int max_retries;
 134         int retries_left;
 135         int retry;
 136         int refcount;
 137         enum ib_wc_status status;
 138
 139         /* RMPP control */
 140         struct list_head rmpp_list;
 141         struct ib_rmpp_segment *last_ack_seg;
 142         struct ib_rmpp_segment *cur_seg;
 143         int last_ack;
 144         int seg_num;
 145         int newwin;
 146         int pad;
 147 };
 148
 149 struct ib_mad_local_private {
 150         struct list_head completion_list;
 151         struct ib_mad_private *mad_priv;
 152         struct ib_mad_agent_private *recv_mad_agent;
 153         struct ib_mad_send_wr_private *mad_send_wr;
 154         size_t return_wc_byte_len;
 155 };
 156
 157 struct ib_mad_mgmt_method_table {
 158         struct ib_mad_agent_private *agent[IB_MGMT_MAX_METHODS];
 159 };
 160
 161 struct ib_mad_mgmt_class_table {
 162         struct ib_mad_mgmt_method_table *method_table[MAX_MGMT_CLASS];
 163 };
 164
 165 struct ib_mad_mgmt_vendor_class {
 166         u8      oui[MAX_MGMT_OUI][3];
 167         struct ib_mad_mgmt_method_table *method_table[MAX_MGMT_OUI];
 168 };
 169
 170 struct ib_mad_mgmt_vendor_class_table {
 171         struct ib_mad_mgmt_vendor_class *vendor_class[MAX_MGMT_VENDOR_RANGE2];
 172 };
 173
 174 struct ib_mad_mgmt_version_table {
 175         struct ib_mad_mgmt_class_table *class;
 176         struct ib_mad_mgmt_vendor_class_table *vendor;
 177 };
 178
 179 struct ib_mad_queue {
 180         spinlock_t lock;
 181         struct list_head list;
 182         int count;
 183         int max_active;
 184         struct ib_mad_qp_info *qp_info;
 185 };
 186
 187 struct ib_mad_qp_info {
 188         struct ib_mad_port_private *port_priv;
 189         struct ib_qp *qp;
 190         struct ib_mad_queue send_queue;
 191         struct ib_mad_queue recv_queue;
 192         struct list_head overflow_list;
 193         spinlock_t snoop_lock;
 194         struct ib_mad_snoop_private **snoop_table;
 195         int snoop_table_size;
 196         atomic_t snoop_count;
 197 };
 198
 199 struct ib_mad_port_private {
 200         struct list_head port_list;
 201         struct ib_device *device;
 202         int port_num;
 203         struct ib_cq *cq;
 204         struct ib_pd *pd;
 205
 206         spinlock_t reg_lock;
 207         struct ib_mad_mgmt_version_table version[MAX_MGMT_VERSION];
 208         struct workqueue_struct *wq;
 209         struct ib_mad_qp_info qp_info[IB_MAD_QPS_CORE];
 210 };
 211
 212 int ib_send_mad(struct ib_mad_send_wr_private *mad_send_wr);
 213
 214 struct ib_mad_send_wr_private *
 215 ib_find_send_mad(const struct ib_mad_agent_private *mad_agent_priv,
 216                  const struct ib_mad_recv_wc *mad_recv_wc);
 217
 218 void ib_mad_complete_send_wr(struct ib_mad_send_wr_private *mad_send_wr,
 219                              struct ib_mad_send_wc *mad_send_wc);
 220
 221 void ib_mark_mad_done(struct ib_mad_send_wr_private *mad_send_wr);
 222
 223 void ib_reset_mad_timeout(struct ib_mad_send_wr_private *mad_send_wr,
 224                           unsigned long timeout_ms);
 225
 226 #endif  /* __IB_MAD_PRIV_H__ */