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 struct ib_class_port_info {
 241         u8                      base_version;
 242         u8                      class_version;
 243         __be16                  capability_mask;
 244         u8                      reserved[3];
 245         u8                      resp_time_value;
 246         u8                      redirect_gid[16];
 247         __be32                  redirect_tcslfl;
 248         __be16                  redirect_lid;
 249         __be16                  redirect_pkey;
 250         __be32                  redirect_qp;
 251         __be32                  redirect_qkey;
 252         u8                      trap_gid[16];
 253         __be32                  trap_tcslfl;
 254         __be16                  trap_lid;
 255         __be16                  trap_pkey;
 256         __be32                  trap_hlqp;
 257         __be32                  trap_qkey;
 258 };
 259
 260 struct ib_mad_notice_attr {
 261         u8 generic_type;
 262         u8 prod_type_msb;
 263         __be16 prod_type_lsb;
 264         __be16 trap_num;
 265         __be16 issuer_lid;
 266         __be16 toggle_count;
 267
 268         union {
 269                 struct {
 270                         u8      details[54];
 271                 } raw_data;
 272
 273                 struct {
 274                         __be16  reserved;
 275                         __be16  lid;            /* where violation happened */
 276                         u8      port_num;       /* where violation happened */
 277                 } __packed ntc_129_131;
 278
 279                 struct {
 280                         __be16  reserved;
 281                         __be16  lid;            /* LID where change occurred */
 282                         u8      reserved2;
 283                         u8      local_changes;  /* low bit - local changes */
 284                         __be32  new_cap_mask;   /* new capability mask */
 285                         u8      reserved3;
 286                         u8      change_flags;   /* low 3 bits only */
 287                 } __packed ntc_144;
 288
 289                 struct {
 290                         __be16  reserved;
 291                         __be16  lid;            /* lid where sys guid changed */
 292                         __be16  reserved2;
 293                         __be64  new_sys_guid;
 294                 } __packed ntc_145;
 295
 296                 struct {
 297                         __be16  reserved;
 298                         __be16  lid;
 299                         __be16  dr_slid;
 300                         u8      method;
 301                         u8      reserved2;
 302                         __be16  attr_id;
 303                         __be32  attr_mod;
 304                         __be64  mkey;
 305                         u8      reserved3;
 306                         u8      dr_trunc_hop;
 307                         u8      dr_rtn_path[30];
 308                 } __packed ntc_256;
 309
 310                 struct {
 311                         __be16          reserved;
 312                         __be16          lid1;
 313                         __be16          lid2;
 314                         __be32          key;
 315                         __be32          sl_qp1; /* SL: high 4 bits */
 316                         __be32          qp2;    /* high 8 bits reserved */
 317                         union ib_gid    gid1;
 318                         union ib_gid    gid2;
 319                 } __packed ntc_257_258;
 320
 321         } details;
 322 };
 323
 324 /**
 325  * ib_mad_send_buf - MAD data buffer and work request for sends.
 326  * @next: A pointer used to chain together MADs for posting.
 327  * @mad: References an allocated MAD data buffer for MADs that do not have
 328  *   RMPP active.  For MADs using RMPP, references the common and management
 329  *   class specific headers.
 330  * @mad_agent: MAD agent that allocated the buffer.
 331  * @ah: The address handle to use when sending the MAD.
 332  * @context: User-controlled context fields.
 333  * @hdr_len: Indicates the size of the data header of the MAD.  This length
 334  *   includes the common MAD, RMPP, and class specific headers.
 335  * @data_len: Indicates the total size of user-transferred data.
 336  * @seg_count: The number of RMPP segments allocated for this send.
 337  * @seg_size: Size of the data in each RMPP segment.  This does not include
 338  *   class specific headers.
 339  * @seg_rmpp_size: Size of each RMPP segment including the class specific
 340  *   headers.
 341  * @timeout_ms: Time to wait for a response.
 342  * @retries: Number of times to retry a request for a response.  For MADs
 343  *   using RMPP, this applies per window.  On completion, returns the number
 344  *   of retries needed to complete the transfer.
 345  *
 346  * Users are responsible for initializing the MAD buffer itself, with the
 347  * exception of any RMPP header.  Additional segment buffer space allocated
 348  * beyond data_len is padding.
 349  */
 350 struct ib_mad_send_buf {
 351         struct ib_mad_send_buf  *next;
 352         void                    *mad;
 353         struct ib_mad_agent     *mad_agent;
 354         struct ib_ah            *ah;
 355         void                    *context[2];
 356         int                     hdr_len;
 357         int                     data_len;
 358         int                     seg_count;
 359         int                     seg_size;
 360         int                     seg_rmpp_size;
 361         int                     timeout_ms;
 362         int                     retries;
 363 };
 364
 365 /**
 366  * ib_response_mad - Returns if the specified MAD has been generated in
 367  *   response to a sent request or trap.
 368  */
 369 int ib_response_mad(const struct ib_mad_hdr *hdr);
 370
 371 /**
 372  * ib_get_rmpp_resptime - Returns the RMPP response time.
 373  * @rmpp_hdr: An RMPP header.
 374  */
 375 static inline u8 ib_get_rmpp_resptime(struct ib_rmpp_hdr *rmpp_hdr)
 376 {
 377         return rmpp_hdr->rmpp_rtime_flags >> 3;
 378 }
 379
 380 /**
 381  * ib_get_rmpp_flags - Returns the RMPP flags.
 382  * @rmpp_hdr: An RMPP header.
 383  */
 384 static inline u8 ib_get_rmpp_flags(struct ib_rmpp_hdr *rmpp_hdr)
 385 {
 386         return rmpp_hdr->rmpp_rtime_flags & 0x7;
 387 }
 388
 389 /**
 390  * ib_set_rmpp_resptime - Sets the response time in an RMPP header.
 391  * @rmpp_hdr: An RMPP header.
 392  * @rtime: The response time to set.
 393  */
 394 static inline void ib_set_rmpp_resptime(struct ib_rmpp_hdr *rmpp_hdr, u8 rtime)
 395 {
 396         rmpp_hdr->rmpp_rtime_flags = ib_get_rmpp_flags(rmpp_hdr) | (rtime << 3);
 397 }
 398
 399 /**
 400  * ib_set_rmpp_flags - Sets the flags in an RMPP header.
 401  * @rmpp_hdr: An RMPP header.
 402  * @flags: The flags to set.
 403  */
 404 static inline void ib_set_rmpp_flags(struct ib_rmpp_hdr *rmpp_hdr, u8 flags)
 405 {
 406         rmpp_hdr->rmpp_rtime_flags = (rmpp_hdr->rmpp_rtime_flags & 0xF8) |
 407                                      (flags & 0x7);
 408 }
 409
 410 struct ib_mad_agent;
 411 struct ib_mad_send_wc;
 412 struct ib_mad_recv_wc;
 413
 414 /**
 415  * ib_mad_send_handler - callback handler for a sent MAD.
 416  * @mad_agent: MAD agent that sent the MAD.
 417  * @mad_send_wc: Send work completion information on the sent MAD.
 418  */
 419 typedef void (*ib_mad_send_handler)(struct ib_mad_agent *mad_agent,
 420                                     struct ib_mad_send_wc *mad_send_wc);
 421
 422 /**
 423  * ib_mad_snoop_handler - Callback handler for snooping sent MADs.
 424  * @mad_agent: MAD agent that snooped the MAD.
 425  * @send_wr: Work request information on the sent MAD.
 426  * @mad_send_wc: Work completion information on the sent MAD.  Valid
 427  *   only for snooping that occurs on a send completion.
 428  *
 429  * Clients snooping MADs should not modify data referenced by the @send_wr
 430  * or @mad_send_wc.
 431  */
 432 typedef void (*ib_mad_snoop_handler)(struct ib_mad_agent *mad_agent,
 433                                      struct ib_mad_send_buf *send_buf,
 434                                      struct ib_mad_send_wc *mad_send_wc);
 435
 436 /**
 437  * ib_mad_recv_handler - callback handler for a received MAD.
 438  * @mad_agent: MAD agent requesting the received MAD.
 439  * @mad_recv_wc: Received work completion information on the received MAD.
 440  *
 441  * MADs received in response to a send request operation will be handed to
 442  * the user before the send operation completes.  All data buffers given
 443  * to registered agents through this routine are owned by the receiving
 444  * client, except for snooping agents.  Clients snooping MADs should not
 445  * modify the data referenced by @mad_recv_wc.
 446  */
 447 typedef void (*ib_mad_recv_handler)(struct ib_mad_agent *mad_agent,
 448                                     struct ib_mad_recv_wc *mad_recv_wc);
 449
 450 /**
 451  * ib_mad_agent - Used to track MAD registration with the access layer.
 452  * @device: Reference to device registration is on.
 453  * @qp: Reference to QP used for sending and receiving MADs.
 454  * @mr: Memory region for system memory usable for DMA.
 455  * @recv_handler: Callback handler for a received MAD.
 456  * @send_handler: Callback handler for a sent MAD.
 457  * @snoop_handler: Callback handler for snooped sent MADs.
 458  * @context: User-specified context associated with this registration.
 459  * @hi_tid: Access layer assigned transaction ID for this client.
 460  *   Unsolicited MADs sent by this client will have the upper 32-bits
 461  *   of their TID set to this value.
 462  * @flags: registration flags
 463  * @port_num: Port number on which QP is registered
 464  * @rmpp_version: If set, indicates the RMPP version used by this agent.
 465  */
 466 enum {
 467         IB_MAD_USER_RMPP = IB_USER_MAD_USER_RMPP,
 468 };
 469 struct ib_mad_agent {
 470         struct ib_device        *device;
 471         struct ib_qp            *qp;
 472         ib_mad_recv_handler     recv_handler;
 473         ib_mad_send_handler     send_handler;
 474         ib_mad_snoop_handler    snoop_handler;
 475         void                    *context;
 476         u32                     hi_tid;
 477         u32                     flags;
 478         u8                      port_num;
 479         u8                      rmpp_version;
 480 };
 481
 482 /**
 483  * ib_mad_send_wc - MAD send completion information.
 484  * @send_buf: Send MAD data buffer associated with the send MAD request.
 485  * @status: Completion status.
 486  * @vendor_err: Optional vendor error information returned with a failed
 487  *   request.
 488  */
 489 struct ib_mad_send_wc {
 490         struct ib_mad_send_buf  *send_buf;
 491         enum ib_wc_status       status;
 492         u32                     vendor_err;
 493 };
 494
 495 /**
 496  * ib_mad_recv_buf - received MAD buffer information.
 497  * @list: Reference to next data buffer for a received RMPP MAD.
 498  * @grh: References a data buffer containing the global route header.
 499  *   The data refereced by this buffer is only valid if the GRH is
 500  *   valid.
 501  * @mad: References the start of the received MAD.
 502  */
 503 struct ib_mad_recv_buf {
 504         struct list_head        list;
 505         struct ib_grh           *grh;
 506         union {
 507                 struct ib_mad   *mad;
 508                 struct opa_mad  *opa_mad;
 509         };
 510 };
 511
 512 /**
 513  * ib_mad_recv_wc - received MAD information.
 514  * @wc: Completion information for the received data.
 515  * @recv_buf: Specifies the location of the received data buffer(s).
 516  * @rmpp_list: Specifies a list of RMPP reassembled received MAD buffers.
 517  * @mad_len: The length of the received MAD, without duplicated headers.
 518  * @mad_seg_size: The size of individual MAD segments
 519  *
 520  * For received response, the wr_id contains a pointer to the ib_mad_send_buf
 521  *   for the corresponding send request.
 522  */
 523 struct ib_mad_recv_wc {
 524         struct ib_wc            *wc;
 525         struct ib_mad_recv_buf  recv_buf;
 526         struct list_head        rmpp_list;
 527         int                     mad_len;
 528         size_t                  mad_seg_size;
 529 };
 530
 531 /**
 532  * ib_mad_reg_req - MAD registration request
 533  * @mgmt_class: Indicates which management class of MADs should be receive
 534  *   by the caller.  This field is only required if the user wishes to
 535  *   receive unsolicited MADs, otherwise it should be 0.
 536  * @mgmt_class_version: Indicates which version of MADs for the given
 537  *   management class to receive.
 538  * @oui: Indicates IEEE OUI when mgmt_class is a vendor class
 539  *   in the range from 0x30 to 0x4f. Otherwise not used.
 540  * @method_mask: The caller will receive unsolicited MADs for any method
 541  *   where @method_mask = 1.
 542  *
 543  */
 544 struct ib_mad_reg_req {
 545         u8      mgmt_class;
 546         u8      mgmt_class_version;
 547         u8      oui[3];
 548         DECLARE_BITMAP(method_mask, IB_MGMT_MAX_METHODS);
 549 };
 550
 551 /**
 552  * ib_register_mad_agent - Register to send/receive MADs.
 553  * @device: The device to register with.
 554  * @port_num: The port on the specified device to use.
 555  * @qp_type: Specifies which QP to access.  Must be either
 556  *   IB_QPT_SMI or IB_QPT_GSI.
 557  * @mad_reg_req: Specifies which unsolicited MADs should be received
 558  *   by the caller.  This parameter may be NULL if the caller only
 559  *   wishes to receive solicited responses.
 560  * @rmpp_version: If set, indicates that the client will send
 561  *   and receive MADs that contain the RMPP header for the given version.
 562  *   If set to 0, indicates that RMPP is not used by this client.
 563  * @send_handler: The completion callback routine invoked after a send
 564  *   request has completed.
 565  * @recv_handler: The completion callback routine invoked for a received
 566  *   MAD.
 567  * @context: User specified context associated with the registration.
 568  * @registration_flags: Registration flags to set for this agent
 569  */
 570 struct ib_mad_agent *ib_register_mad_agent(struct ib_device *device,
 571                                            u8 port_num,
 572                                            enum ib_qp_type qp_type,
 573                                            struct ib_mad_reg_req *mad_reg_req,
 574                                            u8 rmpp_version,
 575                                            ib_mad_send_handler send_handler,
 576                                            ib_mad_recv_handler recv_handler,
 577                                            void *context,
 578                                            u32 registration_flags);
 579
 580 enum ib_mad_snoop_flags {
 581         /*IB_MAD_SNOOP_POSTED_SENDS        = 1,*/
 582         /*IB_MAD_SNOOP_RMPP_SENDS          = (1<<1),*/
 583         IB_MAD_SNOOP_SEND_COMPLETIONS      = (1<<2),
 584         /*IB_MAD_SNOOP_RMPP_SEND_COMPLETIONS = (1<<3),*/
 585         IB_MAD_SNOOP_RECVS                 = (1<<4)
 586         /*IB_MAD_SNOOP_RMPP_RECVS          = (1<<5),*/
 587         /*IB_MAD_SNOOP_REDIRECTED_QPS      = (1<<6)*/
 588 };
 589
 590 /**
 591  * ib_register_mad_snoop - Register to snoop sent and received MADs.
 592  * @device: The device to register with.
 593  * @port_num: The port on the specified device to use.
 594  * @qp_type: Specifies which QP traffic to snoop.  Must be either
 595  *   IB_QPT_SMI or IB_QPT_GSI.
 596  * @mad_snoop_flags: Specifies information where snooping occurs.
 597  * @send_handler: The callback routine invoked for a snooped send.
 598  * @recv_handler: The callback routine invoked for a snooped receive.
 599  * @context: User specified context associated with the registration.
 600  */
 601 struct ib_mad_agent *ib_register_mad_snoop(struct ib_device *device,
 602                                            u8 port_num,
 603                                            enum ib_qp_type qp_type,
 604                                            int mad_snoop_flags,
 605                                            ib_mad_snoop_handler snoop_handler,
 606                                            ib_mad_recv_handler recv_handler,
 607                                            void *context);
 608
 609 /**
 610  * ib_unregister_mad_agent - Unregisters a client from using MAD services.
 611  * @mad_agent: Corresponding MAD registration request to deregister.
 612  *
 613  * After invoking this routine, MAD services are no longer usable by the
 614  * client on the associated QP.
 615  */
 616 int ib_unregister_mad_agent(struct ib_mad_agent *mad_agent);
 617
 618 /**
 619  * ib_post_send_mad - Posts MAD(s) to the send queue of the QP associated
 620  *   with the registered client.
 621  * @send_buf: Specifies the information needed to send the MAD(s).
 622  * @bad_send_buf: Specifies the MAD on which an error was encountered.  This
 623  *   parameter is optional if only a single MAD is posted.
 624  *
 625  * Sent MADs are not guaranteed to complete in the order that they were posted.
 626  *
 627  * If the MAD requires RMPP, the data buffer should contain a single copy
 628  * of the common MAD, RMPP, and class specific headers, followed by the class
 629  * defined data.  If the class defined data would not divide evenly into
 630  * RMPP segments, then space must be allocated at the end of the referenced
 631  * buffer for any required padding.  To indicate the amount of class defined
 632  * data being transferred, the paylen_newwin field in the RMPP header should
 633  * be set to the size of the class specific header plus the amount of class
 634  * defined data being transferred.  The paylen_newwin field should be
 635  * specified in network-byte order.
 636  */
 637 int ib_post_send_mad(struct ib_mad_send_buf *send_buf,
 638                      struct ib_mad_send_buf **bad_send_buf);
 639
 640
 641 /**
 642  * ib_free_recv_mad - Returns data buffers used to receive a MAD.
 643  * @mad_recv_wc: Work completion information for a received MAD.
 644  *
 645  * Clients receiving MADs through their ib_mad_recv_handler must call this
 646  * routine to return the work completion buffers to the access layer.
 647  */
 648 void ib_free_recv_mad(struct ib_mad_recv_wc *mad_recv_wc);
 649
 650 /**
 651  * ib_cancel_mad - Cancels an outstanding send MAD operation.
 652  * @mad_agent: Specifies the registration associated with sent MAD.
 653  * @send_buf: Indicates the MAD to cancel.
 654  *
 655  * MADs will be returned to the user through the corresponding
 656  * ib_mad_send_handler.
 657  */
 658 void ib_cancel_mad(struct ib_mad_agent *mad_agent,
 659                    struct ib_mad_send_buf *send_buf);
 660
 661 /**
 662  * ib_modify_mad - Modifies an outstanding send MAD operation.
 663  * @mad_agent: Specifies the registration associated with sent MAD.
 664  * @send_buf: Indicates the MAD to modify.
 665  * @timeout_ms: New timeout value for sent MAD.
 666  *
 667  * This call will reset the timeout value for a sent MAD to the specified
 668  * value.
 669  */
 670 int ib_modify_mad(struct ib_mad_agent *mad_agent,
 671                   struct ib_mad_send_buf *send_buf, u32 timeout_ms);
 672
 673 /**
 674  * ib_redirect_mad_qp - Registers a QP for MAD services.
 675  * @qp: Reference to a QP that requires MAD services.
 676  * @rmpp_version: If set, indicates that the client will send
 677  *   and receive MADs that contain the RMPP header for the given version.
 678  *   If set to 0, indicates that RMPP is not used by this client.
 679  * @send_handler: The completion callback routine invoked after a send
 680  *   request has completed.
 681  * @recv_handler: The completion callback routine invoked for a received
 682  *   MAD.
 683  * @context: User specified context associated with the registration.
 684  *
 685  * Use of this call allows clients to use MAD services, such as RMPP,
 686  * on user-owned QPs.  After calling this routine, users may send
 687  * MADs on the specified QP by calling ib_mad_post_send.
 688  */
 689 struct ib_mad_agent *ib_redirect_mad_qp(struct ib_qp *qp,
 690                                         u8 rmpp_version,
 691                                         ib_mad_send_handler send_handler,
 692                                         ib_mad_recv_handler recv_handler,
 693                                         void *context);
 694
 695 /**
 696  * ib_process_mad_wc - Processes a work completion associated with a
 697  *   MAD sent or received on a redirected QP.
 698  * @mad_agent: Specifies the registered MAD service using the redirected QP.
 699  * @wc: References a work completion associated with a sent or received
 700  *   MAD segment.
 701  *
 702  * This routine is used to complete or continue processing on a MAD request.
 703  * If the work completion is associated with a send operation, calling
 704  * this routine is required to continue an RMPP transfer or to wait for a
 705  * corresponding response, if it is a request.  If the work completion is
 706  * associated with a receive operation, calling this routine is required to
 707  * process an inbound or outbound RMPP transfer, or to match a response MAD
 708  * with its corresponding request.
 709  */
 710 int ib_process_mad_wc(struct ib_mad_agent *mad_agent,
 711                       struct ib_wc *wc);
 712
 713 /**
 714  * ib_create_send_mad - Allocate and initialize a data buffer and work request
 715  *   for sending a MAD.
 716  * @mad_agent: Specifies the registered MAD service to associate with the MAD.
 717  * @remote_qpn: Specifies the QPN of the receiving node.
 718  * @pkey_index: Specifies which PKey the MAD will be sent using.  This field
 719  *   is valid only if the remote_qpn is QP 1.
 720  * @rmpp_active: Indicates if the send will enable RMPP.
 721  * @hdr_len: Indicates the size of the data header of the MAD.  This length
 722  *   should include the common MAD header, RMPP header, plus any class
 723  *   specific header.
 724  * @data_len: Indicates the size of any user-transferred data.  The call will
 725  *   automatically adjust the allocated buffer size to account for any
 726  *   additional padding that may be necessary.
 727  * @gfp_mask: GFP mask used for the memory allocation.
 728  * @base_version: Base Version of this MAD
 729  *
 730  * This routine allocates a MAD for sending.  The returned MAD send buffer
 731  * will reference a data buffer usable for sending a MAD, along
 732  * with an initialized work request structure.  Users may modify the returned
 733  * MAD data buffer before posting the send.
 734  *
 735  * The returned MAD header, class specific headers, and any padding will be
 736  * cleared.  Users are responsible for initializing the common MAD header,
 737  * any class specific header, and MAD data area.
 738  * If @rmpp_active is set, the RMPP header will be initialized for sending.
 739  */
 740 struct ib_mad_send_buf *ib_create_send_mad(struct ib_mad_agent *mad_agent,
 741                                            u32 remote_qpn, u16 pkey_index,
 742                                            int rmpp_active,
 743                                            int hdr_len, int data_len,
 744                                            gfp_t gfp_mask,
 745                                            u8 base_version);
 746
 747 /**
 748  * ib_is_mad_class_rmpp - returns whether given management class
 749  * supports RMPP.
 750  * @mgmt_class: management class
 751  *
 752  * This routine returns whether the management class supports RMPP.
 753  */
 754 int ib_is_mad_class_rmpp(u8 mgmt_class);
 755
 756 /**
 757  * ib_get_mad_data_offset - returns the data offset for a given
 758  * management class.
 759  * @mgmt_class: management class
 760  *
 761  * This routine returns the data offset in the MAD for the management
 762  * class requested.
 763  */
 764 int ib_get_mad_data_offset(u8 mgmt_class);
 765
 766 /**
 767  * ib_get_rmpp_segment - returns the data buffer for a given RMPP segment.
 768  * @send_buf: Previously allocated send data buffer.
 769  * @seg_num: number of segment to return
 770  *
 771  * This routine returns a pointer to the data buffer of an RMPP MAD.
 772  * Users must provide synchronization to @send_buf around this call.
 773  */
 774 void *ib_get_rmpp_segment(struct ib_mad_send_buf *send_buf, int seg_num);
 775
 776 /**
 777  * ib_free_send_mad - Returns data buffers used to send a MAD.
 778  * @send_buf: Previously allocated send data buffer.
 779  */
 780 void ib_free_send_mad(struct ib_mad_send_buf *send_buf);
 781
 782 /**
 783  * ib_mad_kernel_rmpp_agent - Returns if the agent is performing RMPP.
 784  * @agent: the agent in question
 785  * @return: true if agent is performing rmpp, false otherwise.
 786  */
 787 int ib_mad_kernel_rmpp_agent(const struct ib_mad_agent *agent);
 788
 789 #endif /* IB_MAD_H */