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