SAFE public projects git trees. - safe/jmp/linux-2.6/blob - 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 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  * $Id: ib_mad.h 2775 2005-07-02 13:42:12Z halr $
  37  */
  38
  39 #if !defined( IB_MAD_H )
  40 #define IB_MAD_H
  41
  42 #include <linux/pci.h>
  43
  44 #include <rdma/ib_verbs.h>
  45
  46 /* Management base version */
  47 #define IB_MGMT_BASE_VERSION                    1
  48
  49 /* Management classes */
  50 #define IB_MGMT_CLASS_SUBN_LID_ROUTED           0x01
  51 #define IB_MGMT_CLASS_SUBN_DIRECTED_ROUTE       0x81
  52 #define IB_MGMT_CLASS_SUBN_ADM                  0x03
  53 #define IB_MGMT_CLASS_PERF_MGMT                 0x04
  54 #define IB_MGMT_CLASS_BM                        0x05
  55 #define IB_MGMT_CLASS_DEVICE_MGMT               0x06
  56 #define IB_MGMT_CLASS_CM                        0x07
  57 #define IB_MGMT_CLASS_SNMP                      0x08
  58 #define IB_MGMT_CLASS_VENDOR_RANGE2_START       0x30
  59 #define IB_MGMT_CLASS_VENDOR_RANGE2_END         0x4F
  60
  61 #define IB_OPENIB_OUI                           (0x001405)
  62
  63 /* Management methods */
  64 #define IB_MGMT_METHOD_GET                      0x01
  65 #define IB_MGMT_METHOD_SET                      0x02
  66 #define IB_MGMT_METHOD_GET_RESP                 0x81
  67 #define IB_MGMT_METHOD_SEND                     0x03
  68 #define IB_MGMT_METHOD_TRAP                     0x05
  69 #define IB_MGMT_METHOD_REPORT                   0x06
  70 #define IB_MGMT_METHOD_REPORT_RESP              0x86
  71 #define IB_MGMT_METHOD_TRAP_REPRESS             0x07
  72
  73 #define IB_MGMT_METHOD_RESP                     0x80
  74
  75 #define IB_MGMT_MAX_METHODS                     128
  76
  77 /* RMPP information */
  78 #define IB_MGMT_RMPP_VERSION                    1
  79
  80 #define IB_MGMT_RMPP_TYPE_DATA                  1
  81 #define IB_MGMT_RMPP_TYPE_ACK                   2
  82 #define IB_MGMT_RMPP_TYPE_STOP                  3
  83 #define IB_MGMT_RMPP_TYPE_ABORT                 4
  84
  85 #define IB_MGMT_RMPP_FLAG_ACTIVE                1
  86 #define IB_MGMT_RMPP_FLAG_FIRST                 (1<<1)
  87 #define IB_MGMT_RMPP_FLAG_LAST                  (1<<2)
  88
  89 #define IB_MGMT_RMPP_NO_RESPTIME                0x1F
  90
  91 #define IB_MGMT_RMPP_STATUS_SUCCESS             0
  92 #define IB_MGMT_RMPP_STATUS_RESX                1
  93 #define IB_MGMT_RMPP_STATUS_ABORT_MIN           118
  94 #define IB_MGMT_RMPP_STATUS_T2L                 118
  95 #define IB_MGMT_RMPP_STATUS_BAD_LEN             119
  96 #define IB_MGMT_RMPP_STATUS_BAD_SEG             120
  97 #define IB_MGMT_RMPP_STATUS_BADT                121
  98 #define IB_MGMT_RMPP_STATUS_W2S                 122
  99 #define IB_MGMT_RMPP_STATUS_S2B                 123
 100 #define IB_MGMT_RMPP_STATUS_BAD_STATUS          124
 101 #define IB_MGMT_RMPP_STATUS_UNV                 125
 102 #define IB_MGMT_RMPP_STATUS_TMR                 126
 103 #define IB_MGMT_RMPP_STATUS_UNSPEC              127
 104 #define IB_MGMT_RMPP_STATUS_ABORT_MAX           127
 105
 106 #define IB_QP0          0
 107 #define IB_QP1          __constant_htonl(1)
 108 #define IB_QP1_QKEY     0x80010000
 109 #define IB_QP_SET_QKEY  0x80000000
 110
 111 enum {
 112         IB_MGMT_MAD_DATA = 232,
 113         IB_MGMT_RMPP_DATA = 220,
 114         IB_MGMT_VENDOR_DATA = 216,
 115         IB_MGMT_SA_DATA = 200
 116 };
 117
 118 struct ib_mad_hdr {
 119         u8      base_version;
 120         u8      mgmt_class;
 121         u8      class_version;
 122         u8      method;
 123         __be16  status;
 124         __be16  class_specific;
 125         __be64  tid;
 126         __be16  attr_id;
 127         __be16  resv;
 128         __be32  attr_mod;
 129 };
 130
 131 struct ib_rmpp_hdr {
 132         u8      rmpp_version;
 133         u8      rmpp_type;
 134         u8      rmpp_rtime_flags;
 135         u8      rmpp_status;
 136         __be32  seg_num;
 137         __be32  paylen_newwin;
 138 };
 139
 140 typedef u64 __bitwise ib_sa_comp_mask;
 141
 142 #define IB_SA_COMP_MASK(n) ((__force ib_sa_comp_mask) cpu_to_be64(1ull << n))
 143
 144 /*
 145  * ib_sa_hdr and ib_sa_mad structures must be packed because they have
 146  * 64-bit fields that are only 32-bit aligned. 64-bit architectures will
 147  * lay them out wrong otherwise.  (And unfortunately they are sent on
 148  * the wire so we can't change the layout)
 149  */
 150 struct ib_sa_hdr {
 151         __be64                  sm_key;
 152         __be16                  attr_offset;
 153         __be16                  reserved;
 154         ib_sa_comp_mask         comp_mask;
 155 } __attribute__ ((packed));
 156
 157 struct ib_mad {
 158         struct ib_mad_hdr       mad_hdr;
 159         u8                      data[IB_MGMT_MAD_DATA];
 160 };
 161
 162 struct ib_rmpp_mad {
 163         struct ib_mad_hdr       mad_hdr;
 164         struct ib_rmpp_hdr      rmpp_hdr;
 165         u8                      data[IB_MGMT_RMPP_DATA];
 166 };
 167
 168 struct ib_sa_mad {
 169         struct ib_mad_hdr       mad_hdr;
 170         struct ib_rmpp_hdr      rmpp_hdr;
 171         struct ib_sa_hdr        sa_hdr;
 172         u8                      data[IB_MGMT_SA_DATA];
 173 } __attribute__ ((packed));
 174
 175 struct ib_vendor_mad {
 176         struct ib_mad_hdr       mad_hdr;
 177         struct ib_rmpp_hdr      rmpp_hdr;
 178         u8                      reserved;
 179         u8                      oui[3];
 180         u8                      data[IB_MGMT_VENDOR_DATA];
 181 };
 182
 183 struct ib_class_port_info
 184 {
 185         u8                      base_version;
 186         u8                      class_version;
 187         __be16                  capability_mask;
 188         u8                      reserved[3];
 189         u8                      resp_time_value;
 190         u8                      redirect_gid[16];
 191         __be32                  redirect_tcslfl;
 192         __be16                  redirect_lid;
 193         __be16                  redirect_pkey;
 194         __be32                  redirect_qp;
 195         __be32                  redirect_qkey;
 196         u8                      trap_gid[16];
 197         __be32                  trap_tcslfl;
 198         __be16                  trap_lid;
 199         __be16                  trap_pkey;
 200         __be32                  trap_hlqp;
 201         __be32                  trap_qkey;
 202 };
 203
 204 /**
 205  * ib_mad_send_buf - MAD data buffer and work request for sends.
 206  * @mad: References an allocated MAD data buffer.  The size of the data
 207  *   buffer is specified in the @send_wr.length field.
 208  * @mapping: DMA mapping information.
 209  * @mad_agent: MAD agent that allocated the buffer.
 210  * @context: User-controlled context fields.
 211  * @send_wr: An initialized work request structure used when sending the MAD.
 212  *   The wr_id field of the work request is initialized to reference this
 213  *   data structure.
 214  * @sge: A scatter-gather list referenced by the work request.
 215  *
 216  * Users are responsible for initializing the MAD buffer itself, with the
 217  * exception of specifying the payload length field in any RMPP MAD.
 218  */
 219 struct ib_mad_send_buf {
 220         struct ib_mad           *mad;
 221         DECLARE_PCI_UNMAP_ADDR(mapping)
 222         struct ib_mad_agent     *mad_agent;
 223         void                    *context[2];
 224         struct ib_send_wr       send_wr;
 225         struct ib_sge           sge;
 226 };
 227
 228 /**
 229  * ib_get_rmpp_resptime - Returns the RMPP response time.
 230  * @rmpp_hdr: An RMPP header.
 231  */
 232 static inline u8 ib_get_rmpp_resptime(struct ib_rmpp_hdr *rmpp_hdr)
 233 {
 234         return rmpp_hdr->rmpp_rtime_flags >> 3;
 235 }
 236
 237 /**
 238  * ib_get_rmpp_flags - Returns the RMPP flags.
 239  * @rmpp_hdr: An RMPP header.
 240  */
 241 static inline u8 ib_get_rmpp_flags(struct ib_rmpp_hdr *rmpp_hdr)
 242 {
 243         return rmpp_hdr->rmpp_rtime_flags & 0x7;
 244 }
 245
 246 /**
 247  * ib_set_rmpp_resptime - Sets the response time in an RMPP header.
 248  * @rmpp_hdr: An RMPP header.
 249  * @rtime: The response time to set.
 250  */
 251 static inline void ib_set_rmpp_resptime(struct ib_rmpp_hdr *rmpp_hdr, u8 rtime)
 252 {
 253         rmpp_hdr->rmpp_rtime_flags = ib_get_rmpp_flags(rmpp_hdr) | (rtime << 3);
 254 }
 255
 256 /**
 257  * ib_set_rmpp_flags - Sets the flags in an RMPP header.
 258  * @rmpp_hdr: An RMPP header.
 259  * @flags: The flags to set.
 260  */
 261 static inline void ib_set_rmpp_flags(struct ib_rmpp_hdr *rmpp_hdr, u8 flags)
 262 {
 263         rmpp_hdr->rmpp_rtime_flags = (rmpp_hdr->rmpp_rtime_flags & 0xF1) |
 264                                      (flags & 0x7);
 265 }
 266
 267 struct ib_mad_agent;
 268 struct ib_mad_send_wc;
 269 struct ib_mad_recv_wc;
 270
 271 /**
 272  * ib_mad_send_handler - callback handler for a sent MAD.
 273  * @mad_agent: MAD agent that sent the MAD.
 274  * @mad_send_wc: Send work completion information on the sent MAD.
 275  */
 276 typedef void (*ib_mad_send_handler)(struct ib_mad_agent *mad_agent,
 277                                     struct ib_mad_send_wc *mad_send_wc);
 278
 279 /**
 280  * ib_mad_snoop_handler - Callback handler for snooping sent MADs.
 281  * @mad_agent: MAD agent that snooped the MAD.
 282  * @send_wr: Work request information on the sent MAD.
 283  * @mad_send_wc: Work completion information on the sent MAD.  Valid
 284  *   only for snooping that occurs on a send completion.
 285  *
 286  * Clients snooping MADs should not modify data referenced by the @send_wr
 287  * or @mad_send_wc.
 288  */
 289 typedef void (*ib_mad_snoop_handler)(struct ib_mad_agent *mad_agent,
 290                                      struct ib_send_wr *send_wr,
 291                                      struct ib_mad_send_wc *mad_send_wc);
 292
 293 /**
 294  * ib_mad_recv_handler - callback handler for a received MAD.
 295  * @mad_agent: MAD agent requesting the received MAD.
 296  * @mad_recv_wc: Received work completion information on the received MAD.
 297  *
 298  * MADs received in response to a send request operation will be handed to
 299  * the user after the send operation completes.  All data buffers given
 300  * to registered agents through this routine are owned by the receiving
 301  * client, except for snooping agents.  Clients snooping MADs should not
 302  * modify the data referenced by @mad_recv_wc.
 303  */
 304 typedef void (*ib_mad_recv_handler)(struct ib_mad_agent *mad_agent,
 305                                     struct ib_mad_recv_wc *mad_recv_wc);
 306
 307 /**
 308  * ib_mad_agent - Used to track MAD registration with the access layer.
 309  * @device: Reference to device registration is on.
 310  * @qp: Reference to QP used for sending and receiving MADs.
 311  * @mr: Memory region for system memory usable for DMA.
 312  * @recv_handler: Callback handler for a received MAD.
 313  * @send_handler: Callback handler for a sent MAD.
 314  * @snoop_handler: Callback handler for snooped sent MADs.
 315  * @context: User-specified context associated with this registration.
 316  * @hi_tid: Access layer assigned transaction ID for this client.
 317  *   Unsolicited MADs sent by this client will have the upper 32-bits
 318  *   of their TID set to this value.
 319  * @port_num: Port number on which QP is registered
 320  * @rmpp_version: If set, indicates the RMPP version used by this agent.
 321  */
 322 struct ib_mad_agent {
 323         struct ib_device        *device;
 324         struct ib_qp            *qp;
 325         struct ib_mr            *mr;
 326         ib_mad_recv_handler     recv_handler;
 327         ib_mad_send_handler     send_handler;
 328         ib_mad_snoop_handler    snoop_handler;
 329         void                    *context;
 330         u32                     hi_tid;
 331         u8                      port_num;
 332         u8                      rmpp_version;
 333 };
 334
 335 /**
 336  * ib_mad_send_wc - MAD send completion information.
 337  * @wr_id: Work request identifier associated with the send MAD request.
 338  * @status: Completion status.
 339  * @vendor_err: Optional vendor error information returned with a failed
 340  *   request.
 341  */
 342 struct ib_mad_send_wc {
 343         u64                     wr_id;
 344         enum ib_wc_status       status;
 345         u32                     vendor_err;
 346 };
 347
 348 /**
 349  * ib_mad_recv_buf - received MAD buffer information.
 350  * @list: Reference to next data buffer for a received RMPP MAD.
 351  * @grh: References a data buffer containing the global route header.
 352  *   The data refereced by this buffer is only valid if the GRH is
 353  *   valid.
 354  * @mad: References the start of the received MAD.
 355  */
 356 struct ib_mad_recv_buf {
 357         struct list_head        list;
 358         struct ib_grh           *grh;
 359         struct ib_mad           *mad;
 360 };
 361
 362 /**
 363  * ib_mad_recv_wc - received MAD information.
 364  * @wc: Completion information for the received data.
 365  * @recv_buf: Specifies the location of the received data buffer(s).
 366  * @rmpp_list: Specifies a list of RMPP reassembled received MAD buffers.
 367  * @mad_len: The length of the received MAD, without duplicated headers.
 368  *
 369  * For received response, the wr_id field of the wc is set to the wr_id
 370  *   for the corresponding send request.
 371  */
 372 struct ib_mad_recv_wc {
 373         struct ib_wc            *wc;
 374         struct ib_mad_recv_buf  recv_buf;
 375         struct list_head        rmpp_list;
 376         int                     mad_len;
 377 };
 378
 379 /**
 380  * ib_mad_reg_req - MAD registration request
 381  * @mgmt_class: Indicates which management class of MADs should be receive
 382  *   by the caller.  This field is only required if the user wishes to
 383  *   receive unsolicited MADs, otherwise it should be 0.
 384  * @mgmt_class_version: Indicates which version of MADs for the given
 385  *   management class to receive.
 386  * @oui: Indicates IEEE OUI when mgmt_class is a vendor class
 387  *   in the range from 0x30 to 0x4f. Otherwise not used.
 388  * @method_mask: The caller will receive unsolicited MADs for any method
 389  *   where @method_mask = 1.
 390  */
 391 struct ib_mad_reg_req {
 392         u8      mgmt_class;
 393         u8      mgmt_class_version;
 394         u8      oui[3];
 395         DECLARE_BITMAP(method_mask, IB_MGMT_MAX_METHODS);
 396 };
 397
 398 /**
 399  * ib_register_mad_agent - Register to send/receive MADs.
 400  * @device: The device to register with.
 401  * @port_num: The port on the specified device to use.
 402  * @qp_type: Specifies which QP to access.  Must be either
 403  *   IB_QPT_SMI or IB_QPT_GSI.
 404  * @mad_reg_req: Specifies which unsolicited MADs should be received
 405  *   by the caller.  This parameter may be NULL if the caller only
 406  *   wishes to receive solicited responses.
 407  * @rmpp_version: If set, indicates that the client will send
 408  *   and receive MADs that contain the RMPP header for the given version.
 409  *   If set to 0, indicates that RMPP is not used by this client.
 410  * @send_handler: The completion callback routine invoked after a send
 411  *   request has completed.
 412  * @recv_handler: The completion callback routine invoked for a received
 413  *   MAD.
 414  * @context: User specified context associated with the registration.
 415  */
 416 struct ib_mad_agent *ib_register_mad_agent(struct ib_device *device,
 417                                            u8 port_num,
 418                                            enum ib_qp_type qp_type,
 419                                            struct ib_mad_reg_req *mad_reg_req,
 420                                            u8 rmpp_version,
 421                                            ib_mad_send_handler send_handler,
 422                                            ib_mad_recv_handler recv_handler,
 423                                            void *context);
 424
 425 enum ib_mad_snoop_flags {
 426         /*IB_MAD_SNOOP_POSTED_SENDS        = 1,*/
 427         /*IB_MAD_SNOOP_RMPP_SENDS          = (1<<1),*/
 428         IB_MAD_SNOOP_SEND_COMPLETIONS      = (1<<2),
 429         /*IB_MAD_SNOOP_RMPP_SEND_COMPLETIONS = (1<<3),*/
 430         IB_MAD_SNOOP_RECVS                 = (1<<4)
 431         /*IB_MAD_SNOOP_RMPP_RECVS          = (1<<5),*/
 432         /*IB_MAD_SNOOP_REDIRECTED_QPS      = (1<<6)*/
 433 };
 434
 435 /**
 436  * ib_register_mad_snoop - Register to snoop sent and received MADs.
 437  * @device: The device to register with.
 438  * @port_num: The port on the specified device to use.
 439  * @qp_type: Specifies which QP traffic to snoop.  Must be either
 440  *   IB_QPT_SMI or IB_QPT_GSI.
 441  * @mad_snoop_flags: Specifies information where snooping occurs.
 442  * @send_handler: The callback routine invoked for a snooped send.
 443  * @recv_handler: The callback routine invoked for a snooped receive.
 444  * @context: User specified context associated with the registration.
 445  */
 446 struct ib_mad_agent *ib_register_mad_snoop(struct ib_device *device,
 447                                            u8 port_num,
 448                                            enum ib_qp_type qp_type,
 449                                            int mad_snoop_flags,
 450                                            ib_mad_snoop_handler snoop_handler,
 451                                            ib_mad_recv_handler recv_handler,
 452                                            void *context);
 453
 454 /**
 455  * ib_unregister_mad_agent - Unregisters a client from using MAD services.
 456  * @mad_agent: Corresponding MAD registration request to deregister.
 457  *
 458  * After invoking this routine, MAD services are no longer usable by the
 459  * client on the associated QP.
 460  */
 461 int ib_unregister_mad_agent(struct ib_mad_agent *mad_agent);
 462
 463 /**
 464  * ib_post_send_mad - Posts MAD(s) to the send queue of the QP associated
 465  *   with the registered client.
 466  * @mad_agent: Specifies the associated registration to post the send to.
 467  * @send_wr: Specifies the information needed to send the MAD(s).
 468  * @bad_send_wr: Specifies the MAD on which an error was encountered.
 469  *
 470  * Sent MADs are not guaranteed to complete in the order that they were posted.
 471  *
 472  * If the MAD requires RMPP, the data buffer should contain a single copy
 473  * of the common MAD, RMPP, and class specific headers, followed by the class
 474  * defined data.  If the class defined data would not divide evenly into
 475  * RMPP segments, then space must be allocated at the end of the referenced
 476  * buffer for any required padding.  To indicate the amount of class defined
 477  * data being transferred, the paylen_newwin field in the RMPP header should
 478  * be set to the size of the class specific header plus the amount of class
 479  * defined data being transferred.  The paylen_newwin field should be
 480  * specified in network-byte order.
 481  */
 482 int ib_post_send_mad(struct ib_mad_agent *mad_agent,
 483                      struct ib_send_wr *send_wr,
 484                      struct ib_send_wr **bad_send_wr);
 485
 486 /**
 487  * ib_coalesce_recv_mad - Coalesces received MAD data into a single buffer.
 488  * @mad_recv_wc: Work completion information for a received MAD.
 489  * @buf: User-provided data buffer to receive the coalesced buffers.  The
 490  *   referenced buffer should be at least the size of the mad_len specified
 491  *   by @mad_recv_wc.
 492  *
 493  * This call copies a chain of received MAD segments into a single data buffer,
 494  * removing duplicated headers.
 495  */
 496 void ib_coalesce_recv_mad(struct ib_mad_recv_wc *mad_recv_wc, void *buf);
 497
 498 /**
 499  * ib_free_recv_mad - Returns data buffers used to receive a MAD.
 500  * @mad_recv_wc: Work completion information for a received MAD.
 501  *
 502  * Clients receiving MADs through their ib_mad_recv_handler must call this
 503  * routine to return the work completion buffers to the access layer.
 504  */
 505 void ib_free_recv_mad(struct ib_mad_recv_wc *mad_recv_wc);
 506
 507 /**
 508  * ib_cancel_mad - Cancels an outstanding send MAD operation.
 509  * @mad_agent: Specifies the registration associated with sent MAD.
 510  * @wr_id: Indicates the work request identifier of the MAD to cancel.
 511  *
 512  * MADs will be returned to the user through the corresponding
 513  * ib_mad_send_handler.
 514  */
 515 void ib_cancel_mad(struct ib_mad_agent *mad_agent, u64 wr_id);
 516
 517 /**
 518  * ib_modify_mad - Modifies an outstanding send MAD operation.
 519  * @mad_agent: Specifies the registration associated with sent MAD.
 520  * @wr_id: Indicates the work request identifier of the MAD to modify.
 521  * @timeout_ms: New timeout value for sent MAD.
 522  *
 523  * This call will reset the timeout value for a sent MAD to the specified
 524  * value.
 525  */
 526 int ib_modify_mad(struct ib_mad_agent *mad_agent, u64 wr_id, u32 timeout_ms);
 527
 528 /**
 529  * ib_redirect_mad_qp - Registers a QP for MAD services.
 530  * @qp: Reference to a QP that requires MAD services.
 531  * @rmpp_version: If set, indicates that the client will send
 532  *   and receive MADs that contain the RMPP header for the given version.
 533  *   If set to 0, indicates that RMPP is not used by this client.
 534  * @send_handler: The completion callback routine invoked after a send
 535  *   request has completed.
 536  * @recv_handler: The completion callback routine invoked for a received
 537  *   MAD.
 538  * @context: User specified context associated with the registration.
 539  *
 540  * Use of this call allows clients to use MAD services, such as RMPP,
 541  * on user-owned QPs.  After calling this routine, users may send
 542  * MADs on the specified QP by calling ib_mad_post_send.
 543  */
 544 struct ib_mad_agent *ib_redirect_mad_qp(struct ib_qp *qp,
 545                                         u8 rmpp_version,
 546                                         ib_mad_send_handler send_handler,
 547                                         ib_mad_recv_handler recv_handler,
 548                                         void *context);
 549
 550 /**
 551  * ib_process_mad_wc - Processes a work completion associated with a
 552  *   MAD sent or received on a redirected QP.
 553  * @mad_agent: Specifies the registered MAD service using the redirected QP.
 554  * @wc: References a work completion associated with a sent or received
 555  *   MAD segment.
 556  *
 557  * This routine is used to complete or continue processing on a MAD request.
 558  * If the work completion is associated with a send operation, calling
 559  * this routine is required to continue an RMPP transfer or to wait for a
 560  * corresponding response, if it is a request.  If the work completion is
 561  * associated with a receive operation, calling this routine is required to
 562  * process an inbound or outbound RMPP transfer, or to match a response MAD
 563  * with its corresponding request.
 564  */
 565 int ib_process_mad_wc(struct ib_mad_agent *mad_agent,
 566                       struct ib_wc *wc);
 567
 568 /**
 569  * ib_create_send_mad - Allocate and initialize a data buffer and work request
 570  *   for sending a MAD.
 571  * @mad_agent: Specifies the registered MAD service to associate with the MAD.
 572  * @remote_qpn: Specifies the QPN of the receiving node.
 573  * @pkey_index: Specifies which PKey the MAD will be sent using.  This field
 574  *   is valid only if the remote_qpn is QP 1.
 575  * @ah: References the address handle used to transfer to the remote node.
 576  * @rmpp_active: Indicates if the send will enable RMPP.
 577  * @hdr_len: Indicates the size of the data header of the MAD.  This length
 578  *   should include the common MAD header, RMPP header, plus any class
 579  *   specific header.
 580  * @data_len: Indicates the size of any user-transferred data.  The call will
 581  *   automatically adjust the allocated buffer size to account for any
 582  *   additional padding that may be necessary.
 583  * @gfp_mask: GFP mask used for the memory allocation.
 584  *
 585  * This is a helper routine that may be used to allocate a MAD.  Users are
 586  * not required to allocate outbound MADs using this call.  The returned
 587  * MAD send buffer will reference a data buffer usable for sending a MAD, along
 588  * with an initialized work request structure.  Users may modify the returned
 589  * MAD data buffer or work request before posting the send.
 590  *
 591  * The returned data buffer will be cleared.  Users are responsible for
 592  * initializing the common MAD and any class specific headers.  If @rmpp_active
 593  * is set, the RMPP header will be initialized for sending.
 594  */
 595 struct ib_mad_send_buf * ib_create_send_mad(struct ib_mad_agent *mad_agent,
 596                                             u32 remote_qpn, u16 pkey_index,
 597                                             struct ib_ah *ah, int rmpp_active,
 598                                             int hdr_len, int data_len,
 599                                             unsigned int __nocast gfp_mask);
 600
 601 /**
 602  * ib_free_send_mad - Returns data buffers used to send a MAD.
 603  * @send_buf: Previously allocated send data buffer.
 604  */
 605 void ib_free_send_mad(struct ib_mad_send_buf *send_buf);
 606
 607 #endif /* IB_MAD_H */