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 enum {
 131         IB_MGMT_MAD_HDR = 24,
 132         IB_MGMT_MAD_DATA = 232,
 133         IB_MGMT_RMPP_HDR = 36,
 134         IB_MGMT_RMPP_DATA = 220,
 135         IB_MGMT_VENDOR_HDR = 40,
 136         IB_MGMT_VENDOR_DATA = 216,
 137         IB_MGMT_SA_HDR = 56,
 138         IB_MGMT_SA_DATA = 200,
 139         IB_MGMT_DEVICE_HDR = 64,
 140         IB_MGMT_DEVICE_DATA = 192,
 141         IB_MGMT_MAD_SIZE = IB_MGMT_MAD_HDR + IB_MGMT_MAD_DATA,
 142         OPA_MGMT_MAD_DATA = 2024,
 143         OPA_MGMT_RMPP_DATA = 2012,
 144         OPA_MGMT_MAD_SIZE = IB_MGMT_MAD_HDR + OPA_MGMT_MAD_DATA,
 145 };
 146
 147 struct ib_mad_hdr {
 148         u8      base_version;
 149         u8      mgmt_class;
 150         u8      class_version;
 151         u8      method;
 152         __be16  status;
 153         __be16  class_specific;
 154         __be64  tid;
 155         __be16  attr_id;
 156         __be16  resv;
 157         __be32  attr_mod;
 158 };
 159
 160 struct ib_rmpp_hdr {
 161         u8      rmpp_version;
 162         u8      rmpp_type;
 163         u8      rmpp_rtime_flags;
 164         u8      rmpp_status;
 165         __be32  seg_num;
 166         __be32  paylen_newwin;
 167 };
 168
 169 typedef u64 __bitwise ib_sa_comp_mask;
 170
 171 #define IB_SA_COMP_MASK(n) ((__force ib_sa_comp_mask) cpu_to_be64(1ull << (n)))
 172
 173 /*
 174  * ib_sa_hdr and ib_sa_mad structures must be packed because they have
 175  * 64-bit fields that are only 32-bit aligned. 64-bit architectures will
 176  * lay them out wrong otherwise.  (And unfortunately they are sent on
 177  * the wire so we can't change the layout)
 178  */
 179 struct ib_sa_hdr {
 180         __be64                  sm_key;
 181         __be16                  attr_offset;
 182         __be16                  reserved;
 183         ib_sa_comp_mask         comp_mask;
 184 } __attribute__ ((packed));
 185
 186 struct ib_mad {
 187         struct ib_mad_hdr       mad_hdr;
 188         u8                      data[IB_MGMT_MAD_DATA];
 189 };
 190
 191 struct opa_mad {
 192         struct ib_mad_hdr       mad_hdr;
 193         u8                      data[OPA_MGMT_MAD_DATA];
 194 };
 195
 196 struct ib_rmpp_mad {
 197         struct ib_mad_hdr       mad_hdr;
 198         struct ib_rmpp_hdr      rmpp_hdr;
 199         u8                      data[IB_MGMT_RMPP_DATA];
 200 };
 201
 202 struct opa_rmpp_mad {
 203         struct ib_mad_hdr       mad_hdr;
 204         struct ib_rmpp_hdr      rmpp_hdr;
 205         u8                      data[OPA_MGMT_RMPP_DATA];
 206 };
 207
 208 struct ib_sa_mad {
 209         struct ib_mad_hdr       mad_hdr;
 210         struct ib_rmpp_hdr      rmpp_hdr;
 211         struct ib_sa_hdr        sa_hdr;
 212         u8                      data[IB_MGMT_SA_DATA];
 213 } __attribute__ ((packed));
 214
 215 struct ib_vendor_mad {
 216         struct ib_mad_hdr       mad_hdr;
 217         struct ib_rmpp_hdr      rmpp_hdr;
 218         u8                      reserved;
 219         u8                      oui[3];
 220         u8                      data[IB_MGMT_VENDOR_DATA];
 221 };
 222
 223 struct ib_class_port_info {
 224         u8                      base_version;
 225         u8                      class_version;
 226         __be16                  capability_mask;
 227         u8                      reserved[3];
 228         u8                      resp_time_value;
 229         u8                      redirect_gid[16];
 230         __be32                  redirect_tcslfl;
 231         __be16                  redirect_lid;
 232         __be16                  redirect_pkey;
 233         __be32                  redirect_qp;
 234         __be32                  redirect_qkey;
 235         u8                      trap_gid[16];
 236         __be32                  trap_tcslfl;
 237         __be16                  trap_lid;
 238         __be16                  trap_pkey;
 239         __be32                  trap_hlqp;
 240         __be32                  trap_qkey;
 241 };
 242
 243 /**
 244  * ib_mad_send_buf - MAD data buffer and work request for sends.
 245  * @next: A pointer used to chain together MADs for posting.
 246  * @mad: References an allocated MAD data buffer for MADs that do not have
 247  *   RMPP active.  For MADs using RMPP, references the common and management
 248  *   class specific headers.
 249  * @mad_agent: MAD agent that allocated the buffer.
 250  * @ah: The address handle to use when sending the MAD.
 251  * @context: User-controlled context fields.
 252  * @hdr_len: Indicates the size of the data header of the MAD.  This length
 253  *   includes the common MAD, RMPP, and class specific headers.
 254  * @data_len: Indicates the total size of user-transferred data.
 255  * @seg_count: The number of RMPP segments allocated for this send.
 256  * @seg_size: Size of the data in each RMPP segment.  This does not include
 257  *   class specific headers.
 258  * @seg_rmpp_size: Size of each RMPP segment including the class specific
 259  *   headers.
 260  * @timeout_ms: Time to wait for a response.
 261  * @retries: Number of times to retry a request for a response.  For MADs
 262  *   using RMPP, this applies per window.  On completion, returns the number
 263  *   of retries needed to complete the transfer.
 264  *
 265  * Users are responsible for initializing the MAD buffer itself, with the
 266  * exception of any RMPP header.  Additional segment buffer space allocated
 267  * beyond data_len is padding.
 268  */
 269 struct ib_mad_send_buf {
 270         struct ib_mad_send_buf  *next;
 271         void                    *mad;
 272         struct ib_mad_agent     *mad_agent;
 273         struct ib_ah            *ah;
 274         void                    *context[2];
 275         int                     hdr_len;
 276         int                     data_len;
 277         int                     seg_count;
 278         int                     seg_size;
 279         int                     seg_rmpp_size;
 280         int                     timeout_ms;
 281         int                     retries;
 282 };
 283
 284 /**
 285  * ib_response_mad - Returns if the specified MAD has been generated in
 286  *   response to a sent request or trap.
 287  */
 288 int ib_response_mad(const struct ib_mad_hdr *hdr);
 289
 290 /**
 291  * ib_get_rmpp_resptime - Returns the RMPP response time.
 292  * @rmpp_hdr: An RMPP header.
 293  */
 294 static inline u8 ib_get_rmpp_resptime(struct ib_rmpp_hdr *rmpp_hdr)
 295 {
 296         return rmpp_hdr->rmpp_rtime_flags >> 3;
 297 }
 298
 299 /**
 300  * ib_get_rmpp_flags - Returns the RMPP flags.
 301  * @rmpp_hdr: An RMPP header.
 302  */
 303 static inline u8 ib_get_rmpp_flags(struct ib_rmpp_hdr *rmpp_hdr)
 304 {
 305         return rmpp_hdr->rmpp_rtime_flags & 0x7;
 306 }
 307
 308 /**
 309  * ib_set_rmpp_resptime - Sets the response time in an RMPP header.
 310  * @rmpp_hdr: An RMPP header.
 311  * @rtime: The response time to set.
 312  */
 313 static inline void ib_set_rmpp_resptime(struct ib_rmpp_hdr *rmpp_hdr, u8 rtime)
 314 {
 315         rmpp_hdr->rmpp_rtime_flags = ib_get_rmpp_flags(rmpp_hdr) | (rtime << 3);
 316 }
 317
 318 /**
 319  * ib_set_rmpp_flags - Sets the flags in an RMPP header.
 320  * @rmpp_hdr: An RMPP header.
 321  * @flags: The flags to set.
 322  */
 323 static inline void ib_set_rmpp_flags(struct ib_rmpp_hdr *rmpp_hdr, u8 flags)
 324 {
 325         rmpp_hdr->rmpp_rtime_flags = (rmpp_hdr->rmpp_rtime_flags & 0xF8) |
 326                                      (flags & 0x7);
 327 }
 328
 329 struct ib_mad_agent;
 330 struct ib_mad_send_wc;
 331 struct ib_mad_recv_wc;
 332
 333 /**
 334  * ib_mad_send_handler - callback handler for a sent MAD.
 335  * @mad_agent: MAD agent that sent the MAD.
 336  * @mad_send_wc: Send work completion information on the sent MAD.
 337  */
 338 typedef void (*ib_mad_send_handler)(struct ib_mad_agent *mad_agent,
 339                                     struct ib_mad_send_wc *mad_send_wc);
 340
 341 /**
 342  * ib_mad_snoop_handler - Callback handler for snooping sent MADs.
 343  * @mad_agent: MAD agent that snooped the MAD.
 344  * @send_wr: Work request information on the sent MAD.
 345  * @mad_send_wc: Work completion information on the sent MAD.  Valid
 346  *   only for snooping that occurs on a send completion.
 347  *
 348  * Clients snooping MADs should not modify data referenced by the @send_wr
 349  * or @mad_send_wc.
 350  */
 351 typedef void (*ib_mad_snoop_handler)(struct ib_mad_agent *mad_agent,
 352                                      struct ib_mad_send_buf *send_buf,
 353                                      struct ib_mad_send_wc *mad_send_wc);
 354
 355 /**
 356  * ib_mad_recv_handler - callback handler for a received MAD.
 357  * @mad_agent: MAD agent requesting the received MAD.
 358  * @mad_recv_wc: Received work completion information on the received MAD.
 359  *
 360  * MADs received in response to a send request operation will be handed to
 361  * the user before the send operation completes.  All data buffers given
 362  * to registered agents through this routine are owned by the receiving
 363  * client, except for snooping agents.  Clients snooping MADs should not
 364  * modify the data referenced by @mad_recv_wc.
 365  */
 366 typedef void (*ib_mad_recv_handler)(struct ib_mad_agent *mad_agent,
 367                                     struct ib_mad_recv_wc *mad_recv_wc);
 368
 369 /**
 370  * ib_mad_agent - Used to track MAD registration with the access layer.
 371  * @device: Reference to device registration is on.
 372  * @qp: Reference to QP used for sending and receiving MADs.
 373  * @mr: Memory region for system memory usable for DMA.
 374  * @recv_handler: Callback handler for a received MAD.
 375  * @send_handler: Callback handler for a sent MAD.
 376  * @snoop_handler: Callback handler for snooped sent MADs.
 377  * @context: User-specified context associated with this registration.
 378  * @hi_tid: Access layer assigned transaction ID for this client.
 379  *   Unsolicited MADs sent by this client will have the upper 32-bits
 380  *   of their TID set to this value.
 381  * @flags: registration flags
 382  * @port_num: Port number on which QP is registered
 383  * @rmpp_version: If set, indicates the RMPP version used by this agent.
 384  */
 385 enum {
 386         IB_MAD_USER_RMPP = IB_USER_MAD_USER_RMPP,
 387 };
 388 struct ib_mad_agent {
 389         struct ib_device        *device;
 390         struct ib_qp            *qp;
 391         struct ib_mr            *mr;
 392         ib_mad_recv_handler     recv_handler;
 393         ib_mad_send_handler     send_handler;
 394         ib_mad_snoop_handler    snoop_handler;
 395         void                    *context;
 396         u32                     hi_tid;
 397         u32                     flags;
 398         u8                      port_num;
 399         u8                      rmpp_version;
 400 };
 401
 402 /**
 403  * ib_mad_send_wc - MAD send completion information.
 404  * @send_buf: Send MAD data buffer associated with the send MAD request.
 405  * @status: Completion status.
 406  * @vendor_err: Optional vendor error information returned with a failed
 407  *   request.
 408  */
 409 struct ib_mad_send_wc {
 410         struct ib_mad_send_buf  *send_buf;
 411         enum ib_wc_status       status;
 412         u32                     vendor_err;
 413 };
 414
 415 /**
 416  * ib_mad_recv_buf - received MAD buffer information.
 417  * @list: Reference to next data buffer for a received RMPP MAD.
 418  * @grh: References a data buffer containing the global route header.
 419  *   The data refereced by this buffer is only valid if the GRH is
 420  *   valid.
 421  * @mad: References the start of the received MAD.
 422  */
 423 struct ib_mad_recv_buf {
 424         struct list_head        list;
 425         struct ib_grh           *grh;
 426         union {
 427                 struct ib_mad   *mad;
 428                 struct opa_mad  *opa_mad;
 429         };
 430 };
 431
 432 /**
 433  * ib_mad_recv_wc - received MAD information.
 434  * @wc: Completion information for the received data.
 435  * @recv_buf: Specifies the location of the received data buffer(s).
 436  * @rmpp_list: Specifies a list of RMPP reassembled received MAD buffers.
 437  * @mad_len: The length of the received MAD, without duplicated headers.
 438  * @mad_seg_size: The size of individual MAD segments
 439  *
 440  * For received response, the wr_id contains a pointer to the ib_mad_send_buf
 441  *   for the corresponding send request.
 442  */
 443 struct ib_mad_recv_wc {
 444         struct ib_wc            *wc;
 445         struct ib_mad_recv_buf  recv_buf;
 446         struct list_head        rmpp_list;
 447         int                     mad_len;
 448         size_t                  mad_seg_size;
 449 };
 450
 451 /**
 452  * ib_mad_reg_req - MAD registration request
 453  * @mgmt_class: Indicates which management class of MADs should be receive
 454  *   by the caller.  This field is only required if the user wishes to
 455  *   receive unsolicited MADs, otherwise it should be 0.
 456  * @mgmt_class_version: Indicates which version of MADs for the given
 457  *   management class to receive.
 458  * @oui: Indicates IEEE OUI when mgmt_class is a vendor class
 459  *   in the range from 0x30 to 0x4f. Otherwise not used.
 460  * @method_mask: The caller will receive unsolicited MADs for any method
 461  *   where @method_mask = 1.
 462  *
 463  */
 464 struct ib_mad_reg_req {
 465         u8      mgmt_class;
 466         u8      mgmt_class_version;
 467         u8      oui[3];
 468         DECLARE_BITMAP(method_mask, IB_MGMT_MAX_METHODS);
 469 };
 470
 471 /**
 472  * ib_register_mad_agent - Register to send/receive MADs.
 473  * @device: The device to register with.
 474  * @port_num: The port on the specified device to use.
 475  * @qp_type: Specifies which QP to access.  Must be either
 476  *   IB_QPT_SMI or IB_QPT_GSI.
 477  * @mad_reg_req: Specifies which unsolicited MADs should be received
 478  *   by the caller.  This parameter may be NULL if the caller only
 479  *   wishes to receive solicited responses.
 480  * @rmpp_version: If set, indicates that the client will send
 481  *   and receive MADs that contain the RMPP header for the given version.
 482  *   If set to 0, indicates that RMPP is not used by this client.
 483  * @send_handler: The completion callback routine invoked after a send
 484  *   request has completed.
 485  * @recv_handler: The completion callback routine invoked for a received
 486  *   MAD.
 487  * @context: User specified context associated with the registration.
 488  * @registration_flags: Registration flags to set for this agent
 489  */
 490 struct ib_mad_agent *ib_register_mad_agent(struct ib_device *device,
 491                                            u8 port_num,
 492                                            enum ib_qp_type qp_type,
 493                                            struct ib_mad_reg_req *mad_reg_req,
 494                                            u8 rmpp_version,
 495                                            ib_mad_send_handler send_handler,
 496                                            ib_mad_recv_handler recv_handler,
 497                                            void *context,
 498                                            u32 registration_flags);
 499
 500 enum ib_mad_snoop_flags {
 501         /*IB_MAD_SNOOP_POSTED_SENDS        = 1,*/
 502         /*IB_MAD_SNOOP_RMPP_SENDS          = (1<<1),*/
 503         IB_MAD_SNOOP_SEND_COMPLETIONS      = (1<<2),
 504         /*IB_MAD_SNOOP_RMPP_SEND_COMPLETIONS = (1<<3),*/
 505         IB_MAD_SNOOP_RECVS                 = (1<<4)
 506         /*IB_MAD_SNOOP_RMPP_RECVS          = (1<<5),*/
 507         /*IB_MAD_SNOOP_REDIRECTED_QPS      = (1<<6)*/
 508 };
 509
 510 /**
 511  * ib_register_mad_snoop - Register to snoop sent and received MADs.
 512  * @device: The device to register with.
 513  * @port_num: The port on the specified device to use.
 514  * @qp_type: Specifies which QP traffic to snoop.  Must be either
 515  *   IB_QPT_SMI or IB_QPT_GSI.
 516  * @mad_snoop_flags: Specifies information where snooping occurs.
 517  * @send_handler: The callback routine invoked for a snooped send.
 518  * @recv_handler: The callback routine invoked for a snooped receive.
 519  * @context: User specified context associated with the registration.
 520  */
 521 struct ib_mad_agent *ib_register_mad_snoop(struct ib_device *device,
 522                                            u8 port_num,
 523                                            enum ib_qp_type qp_type,
 524                                            int mad_snoop_flags,
 525                                            ib_mad_snoop_handler snoop_handler,
 526                                            ib_mad_recv_handler recv_handler,
 527                                            void *context);
 528
 529 /**
 530  * ib_unregister_mad_agent - Unregisters a client from using MAD services.
 531  * @mad_agent: Corresponding MAD registration request to deregister.
 532  *
 533  * After invoking this routine, MAD services are no longer usable by the
 534  * client on the associated QP.
 535  */
 536 int ib_unregister_mad_agent(struct ib_mad_agent *mad_agent);
 537
 538 /**
 539  * ib_post_send_mad - Posts MAD(s) to the send queue of the QP associated
 540  *   with the registered client.
 541  * @send_buf: Specifies the information needed to send the MAD(s).
 542  * @bad_send_buf: Specifies the MAD on which an error was encountered.  This
 543  *   parameter is optional if only a single MAD is posted.
 544  *
 545  * Sent MADs are not guaranteed to complete in the order that they were posted.
 546  *
 547  * If the MAD requires RMPP, the data buffer should contain a single copy
 548  * of the common MAD, RMPP, and class specific headers, followed by the class
 549  * defined data.  If the class defined data would not divide evenly into
 550  * RMPP segments, then space must be allocated at the end of the referenced
 551  * buffer for any required padding.  To indicate the amount of class defined
 552  * data being transferred, the paylen_newwin field in the RMPP header should
 553  * be set to the size of the class specific header plus the amount of class
 554  * defined data being transferred.  The paylen_newwin field should be
 555  * specified in network-byte order.
 556  */
 557 int ib_post_send_mad(struct ib_mad_send_buf *send_buf,
 558                      struct ib_mad_send_buf **bad_send_buf);
 559
 560
 561 /**
 562  * ib_free_recv_mad - Returns data buffers used to receive a MAD.
 563  * @mad_recv_wc: Work completion information for a received MAD.
 564  *
 565  * Clients receiving MADs through their ib_mad_recv_handler must call this
 566  * routine to return the work completion buffers to the access layer.
 567  */
 568 void ib_free_recv_mad(struct ib_mad_recv_wc *mad_recv_wc);
 569
 570 /**
 571  * ib_cancel_mad - Cancels an outstanding send MAD operation.
 572  * @mad_agent: Specifies the registration associated with sent MAD.
 573  * @send_buf: Indicates the MAD to cancel.
 574  *
 575  * MADs will be returned to the user through the corresponding
 576  * ib_mad_send_handler.
 577  */
 578 void ib_cancel_mad(struct ib_mad_agent *mad_agent,
 579                    struct ib_mad_send_buf *send_buf);
 580
 581 /**
 582  * ib_modify_mad - Modifies an outstanding send MAD operation.
 583  * @mad_agent: Specifies the registration associated with sent MAD.
 584  * @send_buf: Indicates the MAD to modify.
 585  * @timeout_ms: New timeout value for sent MAD.
 586  *
 587  * This call will reset the timeout value for a sent MAD to the specified
 588  * value.
 589  */
 590 int ib_modify_mad(struct ib_mad_agent *mad_agent,
 591                   struct ib_mad_send_buf *send_buf, u32 timeout_ms);
 592
 593 /**
 594  * ib_redirect_mad_qp - Registers a QP for MAD services.
 595  * @qp: Reference to a QP that requires MAD services.
 596  * @rmpp_version: If set, indicates that the client will send
 597  *   and receive MADs that contain the RMPP header for the given version.
 598  *   If set to 0, indicates that RMPP is not used by this client.
 599  * @send_handler: The completion callback routine invoked after a send
 600  *   request has completed.
 601  * @recv_handler: The completion callback routine invoked for a received
 602  *   MAD.
 603  * @context: User specified context associated with the registration.
 604  *
 605  * Use of this call allows clients to use MAD services, such as RMPP,
 606  * on user-owned QPs.  After calling this routine, users may send
 607  * MADs on the specified QP by calling ib_mad_post_send.
 608  */
 609 struct ib_mad_agent *ib_redirect_mad_qp(struct ib_qp *qp,
 610                                         u8 rmpp_version,
 611                                         ib_mad_send_handler send_handler,
 612                                         ib_mad_recv_handler recv_handler,
 613                                         void *context);
 614
 615 /**
 616  * ib_process_mad_wc - Processes a work completion associated with a
 617  *   MAD sent or received on a redirected QP.
 618  * @mad_agent: Specifies the registered MAD service using the redirected QP.
 619  * @wc: References a work completion associated with a sent or received
 620  *   MAD segment.
 621  *
 622  * This routine is used to complete or continue processing on a MAD request.
 623  * If the work completion is associated with a send operation, calling
 624  * this routine is required to continue an RMPP transfer or to wait for a
 625  * corresponding response, if it is a request.  If the work completion is
 626  * associated with a receive operation, calling this routine is required to
 627  * process an inbound or outbound RMPP transfer, or to match a response MAD
 628  * with its corresponding request.
 629  */
 630 int ib_process_mad_wc(struct ib_mad_agent *mad_agent,
 631                       struct ib_wc *wc);
 632
 633 /**
 634  * ib_create_send_mad - Allocate and initialize a data buffer and work request
 635  *   for sending a MAD.
 636  * @mad_agent: Specifies the registered MAD service to associate with the MAD.
 637  * @remote_qpn: Specifies the QPN of the receiving node.
 638  * @pkey_index: Specifies which PKey the MAD will be sent using.  This field
 639  *   is valid only if the remote_qpn is QP 1.
 640  * @rmpp_active: Indicates if the send will enable RMPP.
 641  * @hdr_len: Indicates the size of the data header of the MAD.  This length
 642  *   should include the common MAD header, RMPP header, plus any class
 643  *   specific header.
 644  * @data_len: Indicates the size of any user-transferred data.  The call will
 645  *   automatically adjust the allocated buffer size to account for any
 646  *   additional padding that may be necessary.
 647  * @gfp_mask: GFP mask used for the memory allocation.
 648  * @base_version: Base Version of this MAD
 649  *
 650  * This routine allocates a MAD for sending.  The returned MAD send buffer
 651  * will reference a data buffer usable for sending a MAD, along
 652  * with an initialized work request structure.  Users may modify the returned
 653  * MAD data buffer before posting the send.
 654  *
 655  * The returned MAD header, class specific headers, and any padding will be
 656  * cleared.  Users are responsible for initializing the common MAD header,
 657  * any class specific header, and MAD data area.
 658  * If @rmpp_active is set, the RMPP header will be initialized for sending.
 659  */
 660 struct ib_mad_send_buf *ib_create_send_mad(struct ib_mad_agent *mad_agent,
 661                                            u32 remote_qpn, u16 pkey_index,
 662                                            int rmpp_active,
 663                                            int hdr_len, int data_len,
 664                                            gfp_t gfp_mask,
 665                                            u8 base_version);
 666
 667 /**
 668  * ib_is_mad_class_rmpp - returns whether given management class
 669  * supports RMPP.
 670  * @mgmt_class: management class
 671  *
 672  * This routine returns whether the management class supports RMPP.
 673  */
 674 int ib_is_mad_class_rmpp(u8 mgmt_class);
 675
 676 /**
 677  * ib_get_mad_data_offset - returns the data offset for a given
 678  * management class.
 679  * @mgmt_class: management class
 680  *
 681  * This routine returns the data offset in the MAD for the management
 682  * class requested.
 683  */
 684 int ib_get_mad_data_offset(u8 mgmt_class);
 685
 686 /**
 687  * ib_get_rmpp_segment - returns the data buffer for a given RMPP segment.
 688  * @send_buf: Previously allocated send data buffer.
 689  * @seg_num: number of segment to return
 690  *
 691  * This routine returns a pointer to the data buffer of an RMPP MAD.
 692  * Users must provide synchronization to @send_buf around this call.
 693  */
 694 void *ib_get_rmpp_segment(struct ib_mad_send_buf *send_buf, int seg_num);
 695
 696 /**
 697  * ib_free_send_mad - Returns data buffers used to send a MAD.
 698  * @send_buf: Previously allocated send data buffer.
 699  */
 700 void ib_free_send_mad(struct ib_mad_send_buf *send_buf);
 701
 702 /**
 703  * ib_mad_kernel_rmpp_agent - Returns if the agent is performing RMPP.
 704  * @agent: the agent in question
 705  * @return: true if agent is performing rmpp, false otherwise.
 706  */
 707 int ib_mad_kernel_rmpp_agent(const struct ib_mad_agent *agent);
 708
 709 #endif /* IB_MAD_H */