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