include/rdma/ib_mad.h

   1 /*
   2  * Copyright (c) 2004 Mellanox Technologies Ltd.  All rights reserved.
   3  * Copyright (c) 2004 Infinicon Corporation.  All rights reserved.
   4  * Copyright (c) 2004 Intel Corporation.  All rights reserved.
   5  * Copyright (c) 2004 Topspin Corporation.  All rights reserved.
   6  * Copyright (c) 2004-2006 Voltaire Corporation.  All rights reserved.
   7  *
   8  * This software is available to you under a choice of one of two
   9  * licenses.  You may choose to be licensed under the terms of the GNU
  10  * General Public License (GPL) Version 2, available from the file
  11  * COPYING in the main directory of this source tree, or the
  12  * OpenIB.org BSD license below:
  13  *
  14  *     Redistribution and use in source and binary forms, with or
  15  *     without modification, are permitted provided that the following
  16  *     conditions are met:
  17  *
  18  *      - Redistributions of source code must retain the above
  19  *        copyright notice, this list of conditions and the following
  20  *        disclaimer.
  21  *
  22  *      - Redistributions in binary form must reproduce the above
  23  *        copyright notice, this list of conditions and the following
  24  *        disclaimer in the documentation and/or other materials
  25  *        provided with the distribution.
  26  *
  27  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  28  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  29  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  30  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  31  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  32  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  33  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  34  * SOFTWARE.
  35  */
  36
  37 #if !defined(IB_MAD_H)
  38 #define IB_MAD_H
  39
  40 #include <linux/list.h>
  41
  42 #include <rdma/ib_verbs.h>
  43 #include <uapi/rdma/ib_user_mad.h>
  44
  45 /* Management base versions */
  46 #define IB_MGMT_BASE_VERSION                    1
  47 #define OPA_MGMT_BASE_VERSION                   0x80
  48
  49 #define OPA_SMP_CLASS_VERSION                   0x80
  50
  51 /* Management classes */
  52 #define IB_MGMT_CLASS_SUBN_LID_ROUTED           0x01
  53 #define IB_MGMT_CLASS_SUBN_DIRECTED_ROUTE       0x81
  54 #define IB_MGMT_CLASS_SUBN_ADM                  0x03
  55 #define IB_MGMT_CLASS_PERF_MGMT                 0x04
  56 #define IB_MGMT_CLASS_BM                        0x05
  57 #define IB_MGMT_CLASS_DEVICE_MGMT               0x06
  58 #define IB_MGMT_CLASS_CM                        0x07
  59 #define IB_MGMT_CLASS_SNMP                      0x08
  60 #define IB_MGMT_CLASS_DEVICE_ADM                0x10
  61 #define IB_MGMT_CLASS_BOOT_MGMT                 0x11
  62 #define IB_MGMT_CLASS_BIS                       0x12
  63 #define IB_MGMT_CLASS_CONG_MGMT                 0x21
  64 #define IB_MGMT_CLASS_VENDOR_RANGE2_START       0x30
  65 #define IB_MGMT_CLASS_VENDOR_RANGE2_END         0x4F
  66
  67 #define IB_OPENIB_OUI                           (0x001405)
  68
  69 /* Management methods */
  70 #define IB_MGMT_METHOD_GET                      0x01
  71 #define IB_MGMT_METHOD_SET                      0x02
  72 #define IB_MGMT_METHOD_GET_RESP                 0x81
  73 #define IB_MGMT_METHOD_SEND                     0x03
  74 #define IB_MGMT_METHOD_TRAP                     0x05
  75 #define IB_MGMT_METHOD_REPORT                   0x06
  76 #define IB_MGMT_METHOD_REPORT_RESP              0x86
  77 #define IB_MGMT_METHOD_TRAP_REPRESS             0x07
  78
  79 #define IB_MGMT_METHOD_RESP                     0x80
  80 #define IB_BM_ATTR_MOD_RESP                     cpu_to_be32(1)
  81
  82 #define IB_MGMT_MAX_METHODS                     128
  83
  84 /* MAD Status field bit masks */
  85 #define IB_MGMT_MAD_STATUS_SUCCESS                      0x0000
  86 #define IB_MGMT_MAD_STATUS_BUSY                         0x0001
  87 #define IB_MGMT_MAD_STATUS_REDIRECT_REQD                0x0002
  88 #define IB_MGMT_MAD_STATUS_BAD_VERSION                  0x0004
  89 #define IB_MGMT_MAD_STATUS_UNSUPPORTED_METHOD           0x0008
  90 #define IB_MGMT_MAD_STATUS_UNSUPPORTED_METHOD_ATTRIB    0x000c
  91 #define IB_MGMT_MAD_STATUS_INVALID_ATTRIB_VALUE         0x001c
  92
  93 /* RMPP information */
  94 #define IB_MGMT_RMPP_VERSION                    1
  95
  96 #define IB_MGMT_RMPP_TYPE_DATA                  1
  97 #define IB_MGMT_RMPP_TYPE_ACK                   2
  98 #define IB_MGMT_RMPP_TYPE_STOP                  3
  99 #define IB_MGMT_RMPP_TYPE_ABORT                 4
 100
 101 #define IB_MGMT_RMPP_FLAG_ACTIVE                1
 102 #define IB_MGMT_RMPP_FLAG_FIRST                 (1<<1)
 103 #define IB_MGMT_RMPP_FLAG_LAST                  (1<<2)
 104
 105 #define IB_MGMT_RMPP_NO_RESPTIME                0x1F
 106
 107 #define IB_MGMT_RMPP_STATUS_SUCCESS             0
 108 #define IB_MGMT_RMPP_STATUS_RESX                1
 109 #define IB_MGMT_RMPP_STATUS_ABORT_MIN           118
 110 #define IB_MGMT_RMPP_STATUS_T2L                 118
 111 #define IB_MGMT_RMPP_STATUS_BAD_LEN             119
 112 #define IB_MGMT_RMPP_STATUS_BAD_SEG             120
 113 #define IB_MGMT_RMPP_STATUS_BADT                121
 114 #define IB_MGMT_RMPP_STATUS_W2S                 122
 115 #define IB_MGMT_RMPP_STATUS_S2B                 123
 116 #define IB_MGMT_RMPP_STATUS_BAD_STATUS          124
 117 #define IB_MGMT_RMPP_STATUS_UNV                 125
 118 #define IB_MGMT_RMPP_STATUS_TMR                 126
 119 #define IB_MGMT_RMPP_STATUS_UNSPEC              127
 120 #define IB_MGMT_RMPP_STATUS_ABORT_MAX           127
 121
 122 #define IB_QP0          0
 123 #define IB_QP1          cpu_to_be32(1)
 124 #define IB_QP1_QKEY     0x80010000
 125 #define IB_QP_SET_QKEY  0x80000000
 126
 127 #define IB_DEFAULT_PKEY_PARTIAL 0x7FFF
 128 #define IB_DEFAULT_PKEY_FULL    0xFFFF
 129
 130 /*
 131  * Generic trap/notice types
 132  */
 133 #define IB_NOTICE_TYPE_FATAL    0x80
 134 #define IB_NOTICE_TYPE_URGENT   0x81
 135 #define IB_NOTICE_TYPE_SECURITY 0x82
 136 #define IB_NOTICE_TYPE_SM       0x83
 137 #define IB_NOTICE_TYPE_INFO     0x84
 138
 139 /*
 140  * Generic trap/notice producers
 141  */
 142 #define IB_NOTICE_PROD_CA               cpu_to_be16(1)
 143 #define IB_NOTICE_PROD_SWITCH           cpu_to_be16(2)
 144 #define IB_NOTICE_PROD_ROUTER           cpu_to_be16(3)
 145 #define IB_NOTICE_PROD_CLASS_MGR        cpu_to_be16(4)
 146
 147 enum {
 148         IB_MGMT_MAD_HDR = 24,
 149         IB_MGMT_MAD_DATA = 232,
 150         IB_MGMT_RMPP_HDR = 36,
 151         IB_MGMT_RMPP_DATA = 220,
 152         IB_MGMT_VENDOR_HDR = 40,
 153         IB_MGMT_VENDOR_DATA = 216,
 154         IB_MGMT_SA_HDR = 56,
 155         IB_MGMT_SA_DATA = 200,
 156         IB_MGMT_DEVICE_HDR = 64,
 157         IB_MGMT_DEVICE_DATA = 192,
 158         IB_MGMT_MAD_SIZE = IB_MGMT_MAD_HDR + IB_MGMT_MAD_DATA,
 159         OPA_MGMT_MAD_DATA = 2024,
 160         OPA_MGMT_RMPP_DATA = 2012,
 161         OPA_MGMT_MAD_SIZE = IB_MGMT_MAD_HDR + OPA_MGMT_MAD_DATA,
 162 };
 163
 164 struct ib_mad_hdr {
 165         u8      base_version;
 166         u8      mgmt_class;
 167         u8      class_version;
 168         u8      method;
 169         __be16  status;
 170         __be16  class_specific;
 171         __be64  tid;
 172         __be16  attr_id;
 173         __be16  resv;
 174         __be32  attr_mod;
 175 };
 176
 177 struct ib_rmpp_hdr {
 178         u8      rmpp_version;
 179         u8      rmpp_type;
 180         u8      rmpp_rtime_flags;
 181         u8      rmpp_status;
 182         __be32  seg_num;
 183         __be32  paylen_newwin;
 184 };
 185
 186 typedef u64 __bitwise ib_sa_comp_mask;
 187
 188 #define IB_SA_COMP_MASK(n) ((__force ib_sa_comp_mask) cpu_to_be64(1ull << (n)))
 189
 190 /*
 191  * ib_sa_hdr and ib_sa_mad structures must be packed because they have
 192  * 64-bit fields that are only 32-bit aligned. 64-bit architectures will
 193  * lay them out wrong otherwise.  (And unfortunately they are sent on
 194  * the wire so we can't change the layout)
 195  */
 196 struct ib_sa_hdr {
 197         __be64                  sm_key;
 198         __be16                  attr_offset;
 199         __be16                  reserved;
 200         ib_sa_comp_mask         comp_mask;
 201 } __attribute__ ((packed));
 202
 203 struct ib_mad {
 204         struct ib_mad_hdr       mad_hdr;
 205         u8                      data[IB_MGMT_MAD_DATA];
 206 };
 207
 208 struct opa_mad {
 209         struct ib_mad_hdr       mad_hdr;
 210         u8                      data[OPA_MGMT_MAD_DATA];
 211 };
 212
 213 struct ib_rmpp_mad {
 214         struct ib_mad_hdr       mad_hdr;
 215         struct ib_rmpp_hdr      rmpp_hdr;
 216         u8                      data[IB_MGMT_RMPP_DATA];
 217 };
 218
 219 struct opa_rmpp_mad {
 220         struct ib_mad_hdr       mad_hdr;
 221         struct ib_rmpp_hdr      rmpp_hdr;
 222         u8                      data[OPA_MGMT_RMPP_DATA];
 223 };
 224
 225 struct ib_sa_mad {
 226         struct ib_mad_hdr       mad_hdr;
 227         struct ib_rmpp_hdr      rmpp_hdr;
 228         struct ib_sa_hdr        sa_hdr;
 229         u8                      data[IB_MGMT_SA_DATA];
 230 } __attribute__ ((packed));
 231
 232 struct ib_vendor_mad {
 233         struct ib_mad_hdr       mad_hdr;
 234         struct ib_rmpp_hdr      rmpp_hdr;
 235         u8                      reserved;
 236         u8                      oui[3];
 237         u8                      data[IB_MGMT_VENDOR_DATA];
 238 };
 239
 240 #define IB_MGMT_CLASSPORTINFO_ATTR_ID   cpu_to_be16(0x0001)
 241
 242 struct ib_class_port_info {
 243         u8                      base_version;
 244         u8                      class_version;
 245         __be16                  capability_mask;
 246         u8                      reserved[3];
 247         u8                      resp_time_value;
 248         u8                      redirect_gid[16];
 249         __be32                  redirect_tcslfl;
 250         __be16                  redirect_lid;
 251         __be16                  redirect_pkey;
 252         __be32                  redirect_qp;
 253         __be32                  redirect_qkey;
 254         u8                      trap_gid[16];
 255         __be32                  trap_tcslfl;
 256         __be16                  trap_lid;
 257         __be16                  trap_pkey;
 258         __be32                  trap_hlqp;
 259         __be32                  trap_qkey;
 260 };
 261
 262 struct ib_mad_notice_attr {
 263         u8 generic_type;
 264         u8 prod_type_msb;
 265         __be16 prod_type_lsb;
 266         __be16 trap_num;
 267         __be16 issuer_lid;
 268         __be16 toggle_count;
 269
 270         union {
 271                 struct {
 272                         u8      details[54];
 273                 } raw_data;
 274
 275                 struct {
 276                         __be16  reserved;
 277                         __be16  lid;            /* where violation happened */
 278                         u8      port_num;       /* where violation happened */
 279                 } __packed ntc_129_131;
 280
 281                 struct {
 282                         __be16  reserved;
 283                         __be16  lid;            /* LID where change occurred */
 284                         u8      reserved2;
 285                         u8      local_changes;  /* low bit - local changes */
 286                         __be32  new_cap_mask;   /* new capability mask */
 287                         u8      reserved3;
 288                         u8      change_flags;   /* low 3 bits only */
 289                 } __packed ntc_144;
 290
 291                 struct {
 292                         __be16  reserved;
 293                         __be16  lid;            /* lid where sys guid changed */
 294                         __be16  reserved2;
 295                         __be64  new_sys_guid;
 296                 } __packed ntc_145;
 297
 298                 struct {
 299                         __be16  reserved;
 300                         __be16  lid;
 301                         __be16  dr_slid;
 302                         u8      method;
 303                         u8      reserved2;
 304                         __be16  attr_id;
 305                         __be32  attr_mod;
 306                         __be64  mkey;
 307                         u8      reserved3;
 308                         u8      dr_trunc_hop;
 309                         u8      dr_rtn_path[30];
 310                 } __packed ntc_256;
 311
 312                 struct {
 313                         __be16          reserved;
 314                         __be16          lid1;
 315                         __be16          lid2;
 316                         __be32          key;
 317                         __be32          sl_qp1; /* SL: high 4 bits */
 318                         __be32          qp2;    /* high 8 bits reserved */
 319                         union ib_gid    gid1;
 320                         union ib_gid    gid2;
 321                 } __packed ntc_257_258;
 322
 323         } details;
 324 };
 325
 326 /**
 327  * ib_mad_send_buf - MAD data buffer and work request for sends.
 328  * @next: A pointer used to chain together MADs for posting.
 329  * @mad: References an allocated MAD data buffer for MADs that do not have
 330  *   RMPP active.  For MADs using RMPP, references the common and management
 331  *   class specific headers.
 332  * @mad_agent: MAD agent that allocated the buffer.
 333  * @ah: The address handle to use when sending the MAD.
 334  * @context: User-controlled context fields.
 335  * @hdr_len: Indicates the size of the data header of the MAD.  This length
 336  *   includes the common MAD, RMPP, and class specific headers.
 337  * @data_len: Indicates the total size of user-transferred data.
 338  * @seg_count: The number of RMPP segments allocated for this send.
 339  * @seg_size: Size of the data in each RMPP segment.  This does not include
 340  *   class specific headers.
 341  * @seg_rmpp_size: Size of each RMPP segment including the class specific
 342  *   headers.
 343  * @timeout_ms: Time to wait for a response.
 344  * @retries: Number of times to retry a request for a response.  For MADs
 345  *   using RMPP, this applies per window.  On completion, returns the number
 346  *   of retries needed to complete the transfer.
 347  *
 348  * Users are responsible for initializing the MAD buffer itself, with the
 349  * exception of any RMPP header.  Additional segment buffer space allocated
 350  * beyond data_len is padding.
 351  */
 352 struct ib_mad_send_buf {
 353         struct ib_mad_send_buf  *next;
 354         void                    *mad;
 355         struct ib_mad_agent     *mad_agent;
 356         struct ib_ah            *ah;
 357         void                    *context[2];
 358         int                     hdr_len;
 359         int                     data_len;
 360         int                     seg_count;
 361         int                     seg_size;
 362         int                     seg_rmpp_size;
 363         int                     timeout_ms;
 364         int                     retries;
 365 };
 366
 367 /**
 368  * ib_response_mad - Returns if the specified MAD has been generated in
 369  *   response to a sent request or trap.
 370  */
 371 int ib_response_mad(const struct ib_mad_hdr *hdr);
 372
 373 /**
 374  * ib_get_rmpp_resptime - Returns the RMPP response time.
 375  * @rmpp_hdr: An RMPP header.
 376  */
 377 static inline u8 ib_get_rmpp_resptime(struct ib_rmpp_hdr *rmpp_hdr)
 378 {
 379         return rmpp_hdr->rmpp_rtime_flags >> 3;
 380 }
 381
 382 /**
 383  * ib_get_rmpp_flags - Returns the RMPP flags.
 384  * @rmpp_hdr: An RMPP header.
 385  */
 386 static inline u8 ib_get_rmpp_flags(struct ib_rmpp_hdr *rmpp_hdr)
 387 {
 388         return rmpp_hdr->rmpp_rtime_flags & 0x7;
 389 }
 390
 391 /**
 392  * ib_set_rmpp_resptime - Sets the response time in an RMPP header.
 393  * @rmpp_hdr: An RMPP header.
 394  * @rtime: The response time to set.
 395  */
 396 static inline void ib_set_rmpp_resptime(struct ib_rmpp_hdr *rmpp_hdr, u8 rtime)
 397 {
 398         rmpp_hdr->rmpp_rtime_flags = ib_get_rmpp_flags(rmpp_hdr) | (rtime << 3);
 399 }
 400
 401 /**
 402  * ib_set_rmpp_flags - Sets the flags in an RMPP header.
 403  * @rmpp_hdr: An RMPP header.
 404  * @flags: The flags to set.
 405  */
 406 static inline void ib_set_rmpp_flags(struct ib_rmpp_hdr *rmpp_hdr, u8 flags)
 407 {
 408         rmpp_hdr->rmpp_rtime_flags = (rmpp_hdr->rmpp_rtime_flags & 0xF8) |
 409                                      (flags & 0x7);
 410 }
 411
 412 struct ib_mad_agent;
 413 struct ib_mad_send_wc;
 414 struct ib_mad_recv_wc;
 415
 416 /**
 417  * ib_mad_send_handler - callback handler for a sent MAD.
 418  * @mad_agent: MAD agent that sent the MAD.
 419  * @mad_send_wc: Send work completion information on the sent MAD.
 420  */
 421 typedef void (*ib_mad_send_handler)(struct ib_mad_agent *mad_agent,
 422                                     struct ib_mad_send_wc *mad_send_wc);
 423
 424 /**
 425  * ib_mad_snoop_handler - Callback handler for snooping sent MADs.
 426  * @mad_agent: MAD agent that snooped the MAD.
 427  * @send_wr: Work request information on the sent MAD.
 428  * @mad_send_wc: Work completion information on the sent MAD.  Valid
 429  *   only for snooping that occurs on a send completion.
 430  *
 431  * Clients snooping MADs should not modify data referenced by the @send_wr
 432  * or @mad_send_wc.
 433  */
 434 typedef void (*ib_mad_snoop_handler)(struct ib_mad_agent *mad_agent,
 435                                      struct ib_mad_send_buf *send_buf,
 436                                      struct ib_mad_send_wc *mad_send_wc);
 437
 438 /**
 439  * ib_mad_recv_handler - callback handler for a received MAD.
 440  * @mad_agent: MAD agent requesting the received MAD.
 441  * @send_buf: Send buffer if found, else NULL
 442  * @mad_recv_wc: Received work completion information on the received MAD.
 443  *
 444  * MADs received in response to a send request operation will be handed to
 445  * the user before the send operation completes.  All data buffers given
 446  * to registered agents through this routine are owned by the receiving
 447  * client, except for snooping agents.  Clients snooping MADs should not
 448  * modify the data referenced by @mad_recv_wc.
 449  */
 450 typedef void (*ib_mad_recv_handler)(struct ib_mad_agent *mad_agent,
 451                                     struct ib_mad_send_buf *send_buf,
 452                                     struct ib_mad_recv_wc *mad_recv_wc);
 453
 454 /**
 455  * ib_mad_agent - Used to track MAD registration with the access layer.
 456  * @device: Reference to device registration is on.
 457  * @qp: Reference to QP used for sending and receiving MADs.
 458  * @mr: Memory region for system memory usable for DMA.
 459  * @recv_handler: Callback handler for a received MAD.
 460  * @send_handler: Callback handler for a sent MAD.
 461  * @snoop_handler: Callback handler for snooped sent MADs.
 462  * @context: User-specified context associated with this registration.
 463  * @hi_tid: Access layer assigned transaction ID for this client.
 464  *   Unsolicited MADs sent by this client will have the upper 32-bits
 465  *   of their TID set to this value.
 466  * @flags: registration flags
 467  * @port_num: Port number on which QP is registered
 468  * @rmpp_version: If set, indicates the RMPP version used by this agent.
 469  */
 470 enum {
 471         IB_MAD_USER_RMPP = IB_USER_MAD_USER_RMPP,
 472 };
 473 struct ib_mad_agent {
 474         struct ib_device        *device;
 475         struct ib_qp            *qp;
 476         ib_mad_recv_handler     recv_handler;
 477         ib_mad_send_handler     send_handler;
 478         ib_mad_snoop_handler    snoop_handler;
 479         void                    *context;
 480         u32                     hi_tid;
 481         u32                     flags;
 482         u8                      port_num;
 483         u8                      rmpp_version;
 484 };
 485
 486 /**
 487  * ib_mad_send_wc - MAD send completion information.
 488  * @send_buf: Send MAD data buffer associated with the send MAD request.
 489  * @status: Completion status.
 490  * @vendor_err: Optional vendor error information returned with a failed
 491  *   request.
 492  */
 493 struct ib_mad_send_wc {
 494         struct ib_mad_send_buf  *send_buf;
 495         enum ib_wc_status       status;
 496         u32                     vendor_err;
 497 };
 498
 499 /**
 500  * ib_mad_recv_buf - received MAD buffer information.
 501  * @list: Reference to next data buffer for a received RMPP MAD.
 502  * @grh: References a data buffer containing the global route header.
 503  *   The data refereced by this buffer is only valid if the GRH is
 504  *   valid.
 505  * @mad: References the start of the received MAD.
 506  */
 507 struct ib_mad_recv_buf {
 508         struct list_head        list;
 509         struct ib_grh           *grh;
 510         union {
 511                 struct ib_mad   *mad;
 512                 struct opa_mad  *opa_mad;
 513         };
 514 };
 515
 516 /**
 517  * ib_mad_recv_wc - received MAD information.
 518  * @wc: Completion information for the received data.
 519  * @recv_buf: Specifies the location of the received data buffer(s).
 520  * @rmpp_list: Specifies a list of RMPP reassembled received MAD buffers.
 521  * @mad_len: The length of the received MAD, without duplicated headers.
 522  * @mad_seg_size: The size of individual MAD segments
 523  *
 524  * For received response, the wr_id contains a pointer to the ib_mad_send_buf
 525  *   for the corresponding send request.
 526  */
 527 struct ib_mad_recv_wc {
 528         struct ib_wc            *wc;
 529         struct ib_mad_recv_buf  recv_buf;
 530         struct list_head        rmpp_list;
 531         int                     mad_len;
 532         size_t                  mad_seg_size;
 533 };
 534
 535 /**
 536  * ib_mad_reg_req - MAD registration request
 537  * @mgmt_class: Indicates which management class of MADs should be receive
 538  *   by the caller.  This field is only required if the user wishes to
 539  *   receive unsolicited MADs, otherwise it should be 0.
 540  * @mgmt_class_version: Indicates which version of MADs for the given
 541  *   management class to receive.
 542  * @oui: Indicates IEEE OUI when mgmt_class is a vendor class
 543  *   in the range from 0x30 to 0x4f. Otherwise not used.
 544  * @method_mask: The caller will receive unsolicited MADs for any method
 545  *   where @method_mask = 1.
 546  *
 547  */
 548 struct ib_mad_reg_req {
 549         u8      mgmt_class;
 550         u8      mgmt_class_version;
 551         u8      oui[3];
 552         DECLARE_BITMAP(method_mask, IB_MGMT_MAX_METHODS);
 553 };
 554
 555 /**
 556  * ib_register_mad_agent - Register to send/receive MADs.
 557  * @device: The device to register with.
 558  * @port_num: The port on the specified device to use.
 559  * @qp_type: Specifies which QP to access.  Must be either
 560  *   IB_QPT_SMI or IB_QPT_GSI.
 561  * @mad_reg_req: Specifies which unsolicited MADs should be received
 562  *   by the caller.  This parameter may be NULL if the caller only
 563  *   wishes to receive solicited responses.
 564  * @rmpp_version: If set, indicates that the client will send
 565  *   and receive MADs that contain the RMPP header for the given version.
 566  *   If set to 0, indicates that RMPP is not used by this client.
 567  * @send_handler: The completion callback routine invoked after a send
 568  *   request has completed.
 569  * @recv_handler: The completion callback routine invoked for a received
 570  *   MAD.
 571  * @context: User specified context associated with the registration.
 572  * @registration_flags: Registration flags to set for this agent
 573  */
 574 struct ib_mad_agent *ib_register_mad_agent(struct ib_device *device,
 575                                            u8 port_num,
 576                                            enum ib_qp_type qp_type,
 577                                            struct ib_mad_reg_req *mad_reg_req,
 578                                            u8 rmpp_version,
 579                                            ib_mad_send_handler send_handler,
 580                                            ib_mad_recv_handler recv_handler,
 581                                            void *context,
 582                                            u32 registration_flags);
 583
 584 enum ib_mad_snoop_flags {
 585         /*IB_MAD_SNOOP_POSTED_SENDS        = 1,*/
 586         /*IB_MAD_SNOOP_RMPP_SENDS          = (1<<1),*/
 587         IB_MAD_SNOOP_SEND_COMPLETIONS      = (1<<2),
 588         /*IB_MAD_SNOOP_RMPP_SEND_COMPLETIONS = (1<<3),*/
 589         IB_MAD_SNOOP_RECVS                 = (1<<4)
 590         /*IB_MAD_SNOOP_RMPP_RECVS          = (1<<5),*/
 591         /*IB_MAD_SNOOP_REDIRECTED_QPS      = (1<<6)*/
 592 };
 593
 594 /**
 595  * ib_register_mad_snoop - Register to snoop sent and received MADs.
 596  * @device: The device to register with.
 597  * @port_num: The port on the specified device to use.
 598  * @qp_type: Specifies which QP traffic to snoop.  Must be either
 599  *   IB_QPT_SMI or IB_QPT_GSI.
 600  * @mad_snoop_flags: Specifies information where snooping occurs.
 601  * @send_handler: The callback routine invoked for a snooped send.
 602  * @recv_handler: The callback routine invoked for a snooped receive.
 603  * @context: User specified context associated with the registration.
 604  */
 605 struct ib_mad_agent *ib_register_mad_snoop(struct ib_device *device,
 606                                            u8 port_num,
 607                                            enum ib_qp_type qp_type,
 608                                            int mad_snoop_flags,
 609                                            ib_mad_snoop_handler snoop_handler,
 610                                            ib_mad_recv_handler recv_handler,
 611                                            void *context);
 612
 613 /**
 614  * ib_unregister_mad_agent - Unregisters a client from using MAD services.
 615  * @mad_agent: Corresponding MAD registration request to deregister.
 616  *
 617  * After invoking this routine, MAD services are no longer usable by the
 618  * client on the associated QP.
 619  */
 620 int ib_unregister_mad_agent(struct ib_mad_agent *mad_agent);
 621
 622 /**
 623  * ib_post_send_mad - Posts MAD(s) to the send queue of the QP associated
 624  *   with the registered client.
 625  * @send_buf: Specifies the information needed to send the MAD(s).
 626  * @bad_send_buf: Specifies the MAD on which an error was encountered.  This
 627  *   parameter is optional if only a single MAD is posted.
 628  *
 629  * Sent MADs are not guaranteed to complete in the order that they were posted.
 630  *
 631  * If the MAD requires RMPP, the data buffer should contain a single copy
 632  * of the common MAD, RMPP, and class specific headers, followed by the class
 633  * defined data.  If the class defined data would not divide evenly into
 634  * RMPP segments, then space must be allocated at the end of the referenced
 635  * buffer for any required padding.  To indicate the amount of class defined
 636  * data being transferred, the paylen_newwin field in the RMPP header should
 637  * be set to the size of the class specific header plus the amount of class
 638  * defined data being transferred.  The paylen_newwin field should be
 639  * specified in network-byte order.
 640  */
 641 int ib_post_send_mad(struct ib_mad_send_buf *send_buf,
 642                      struct ib_mad_send_buf **bad_send_buf);
 643
 644
 645 /**
 646  * ib_free_recv_mad - Returns data buffers used to receive a MAD.
 647  * @mad_recv_wc: Work completion information for a received MAD.
 648  *
 649  * Clients receiving MADs through their ib_mad_recv_handler must call this
 650  * routine to return the work completion buffers to the access layer.
 651  */
 652 void ib_free_recv_mad(struct ib_mad_recv_wc *mad_recv_wc);
 653
 654 /**
 655  * ib_cancel_mad - Cancels an outstanding send MAD operation.
 656  * @mad_agent: Specifies the registration associated with sent MAD.
 657  * @send_buf: Indicates the MAD to cancel.
 658  *
 659  * MADs will be returned to the user through the corresponding
 660  * ib_mad_send_handler.
 661  */
 662 void ib_cancel_mad(struct ib_mad_agent *mad_agent,
 663                    struct ib_mad_send_buf *send_buf);
 664
 665 /**
 666  * ib_modify_mad - Modifies an outstanding send MAD operation.
 667  * @mad_agent: Specifies the registration associated with sent MAD.
 668  * @send_buf: Indicates the MAD to modify.
 669  * @timeout_ms: New timeout value for sent MAD.
 670  *
 671  * This call will reset the timeout value for a sent MAD to the specified
 672  * value.
 673  */
 674 int ib_modify_mad(struct ib_mad_agent *mad_agent,
 675                   struct ib_mad_send_buf *send_buf, u32 timeout_ms);
 676
 677 /**
 678  * ib_redirect_mad_qp - Registers a QP for MAD services.
 679  * @qp: Reference to a QP that requires MAD services.
 680  * @rmpp_version: If set, indicates that the client will send
 681  *   and receive MADs that contain the RMPP header for the given version.
 682  *   If set to 0, indicates that RMPP is not used by this client.
 683  * @send_handler: The completion callback routine invoked after a send
 684  *   request has completed.
 685  * @recv_handler: The completion callback routine invoked for a received
 686  *   MAD.
 687  * @context: User specified context associated with the registration.
 688  *
 689  * Use of this call allows clients to use MAD services, such as RMPP,
 690  * on user-owned QPs.  After calling this routine, users may send
 691  * MADs on the specified QP by calling ib_mad_post_send.
 692  */
 693 struct ib_mad_agent *ib_redirect_mad_qp(struct ib_qp *qp,
 694                                         u8 rmpp_version,
 695                                         ib_mad_send_handler send_handler,
 696                                         ib_mad_recv_handler recv_handler,
 697                                         void *context);
 698
 699 /**
 700  * ib_process_mad_wc - Processes a work completion associated with a
 701  *   MAD sent or received on a redirected QP.
 702  * @mad_agent: Specifies the registered MAD service using the redirected QP.
 703  * @wc: References a work completion associated with a sent or received
 704  *   MAD segment.
 705  *
 706  * This routine is used to complete or continue processing on a MAD request.
 707  * If the work completion is associated with a send operation, calling
 708  * this routine is required to continue an RMPP transfer or to wait for a
 709  * corresponding response, if it is a request.  If the work completion is
 710  * associated with a receive operation, calling this routine is required to
 711  * process an inbound or outbound RMPP transfer, or to match a response MAD
 712  * with its corresponding request.
 713  */
 714 int ib_process_mad_wc(struct ib_mad_agent *mad_agent,
 715                       struct ib_wc *wc);
 716
 717 /**
 718  * ib_create_send_mad - Allocate and initialize a data buffer and work request
 719  *   for sending a MAD.
 720  * @mad_agent: Specifies the registered MAD service to associate with the MAD.
 721  * @remote_qpn: Specifies the QPN of the receiving node.
 722  * @pkey_index: Specifies which PKey the MAD will be sent using.  This field
 723  *   is valid only if the remote_qpn is QP 1.
 724  * @rmpp_active: Indicates if the send will enable RMPP.
 725  * @hdr_len: Indicates the size of the data header of the MAD.  This length
 726  *   should include the common MAD header, RMPP header, plus any class
 727  *   specific header.
 728  * @data_len: Indicates the size of any user-transferred data.  The call will
 729  *   automatically adjust the allocated buffer size to account for any
 730  *   additional padding that may be necessary.
 731  * @gfp_mask: GFP mask used for the memory allocation.
 732  * @base_version: Base Version of this MAD
 733  *
 734  * This routine allocates a MAD for sending.  The returned MAD send buffer
 735  * will reference a data buffer usable for sending a MAD, along
 736  * with an initialized work request structure.  Users may modify the returned
 737  * MAD data buffer before posting the send.
 738  *
 739  * The returned MAD header, class specific headers, and any padding will be
 740  * cleared.  Users are responsible for initializing the common MAD header,
 741  * any class specific header, and MAD data area.
 742  * If @rmpp_active is set, the RMPP header will be initialized for sending.
 743  */
 744 struct ib_mad_send_buf *ib_create_send_mad(struct ib_mad_agent *mad_agent,
 745                                            u32 remote_qpn, u16 pkey_index,
 746                                            int rmpp_active,
 747                                            int hdr_len, int data_len,
 748                                            gfp_t gfp_mask,
 749                                            u8 base_version);
 750
 751 /**
 752  * ib_is_mad_class_rmpp - returns whether given management class
 753  * supports RMPP.
 754  * @mgmt_class: management class
 755  *
 756  * This routine returns whether the management class supports RMPP.
 757  */
 758 int ib_is_mad_class_rmpp(u8 mgmt_class);
 759
 760 /**
 761  * ib_get_mad_data_offset - returns the data offset for a given
 762  * management class.
 763  * @mgmt_class: management class
 764  *
 765  * This routine returns the data offset in the MAD for the management
 766  * class requested.
 767  */
 768 int ib_get_mad_data_offset(u8 mgmt_class);
 769
 770 /**
 771  * ib_get_rmpp_segment - returns the data buffer for a given RMPP segment.
 772  * @send_buf: Previously allocated send data buffer.
 773  * @seg_num: number of segment to return
 774  *
 775  * This routine returns a pointer to the data buffer of an RMPP MAD.
 776  * Users must provide synchronization to @send_buf around this call.
 777  */
 778 void *ib_get_rmpp_segment(struct ib_mad_send_buf *send_buf, int seg_num);
 779
 780 /**
 781  * ib_free_send_mad - Returns data buffers used to send a MAD.
 782  * @send_buf: Previously allocated send data buffer.
 783  */
 784 void ib_free_send_mad(struct ib_mad_send_buf *send_buf);
 785
 786 /**
 787  * ib_mad_kernel_rmpp_agent - Returns if the agent is performing RMPP.
 788  * @agent: the agent in question
 789  * @return: true if agent is performing rmpp, false otherwise.
 790  */
 791 int ib_mad_kernel_rmpp_agent(const struct ib_mad_agent *agent);
 792
 793 #endif /* IB_MAD_H */