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