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 version */ 46 #define IB_MGMT_BASE_VERSION 1 47 48 /* Management classes */ 49 #define IB_MGMT_CLASS_SUBN_LID_ROUTED 0x01 50 #define IB_MGMT_CLASS_SUBN_DIRECTED_ROUTE 0x81 51 #define IB_MGMT_CLASS_SUBN_ADM 0x03 52 #define IB_MGMT_CLASS_PERF_MGMT 0x04 53 #define IB_MGMT_CLASS_BM 0x05 54 #define IB_MGMT_CLASS_DEVICE_MGMT 0x06 55 #define IB_MGMT_CLASS_CM 0x07 56 #define IB_MGMT_CLASS_SNMP 0x08 57 #define IB_MGMT_CLASS_DEVICE_ADM 0x10 58 #define IB_MGMT_CLASS_BOOT_MGMT 0x11 59 #define IB_MGMT_CLASS_BIS 0x12 60 #define IB_MGMT_CLASS_CONG_MGMT 0x21 61 #define IB_MGMT_CLASS_VENDOR_RANGE2_START 0x30 62 #define IB_MGMT_CLASS_VENDOR_RANGE2_END 0x4F 63 64 #define IB_OPENIB_OUI (0x001405) 65 66 /* Management methods */ 67 #define IB_MGMT_METHOD_GET 0x01 68 #define IB_MGMT_METHOD_SET 0x02 69 #define IB_MGMT_METHOD_GET_RESP 0x81 70 #define IB_MGMT_METHOD_SEND 0x03 71 #define IB_MGMT_METHOD_TRAP 0x05 72 #define IB_MGMT_METHOD_REPORT 0x06 73 #define IB_MGMT_METHOD_REPORT_RESP 0x86 74 #define IB_MGMT_METHOD_TRAP_REPRESS 0x07 75 76 #define IB_MGMT_METHOD_RESP 0x80 77 #define IB_BM_ATTR_MOD_RESP cpu_to_be32(1) 78 79 #define IB_MGMT_MAX_METHODS 128 80 81 /* MAD Status field bit masks */ 82 #define IB_MGMT_MAD_STATUS_SUCCESS 0x0000 83 #define IB_MGMT_MAD_STATUS_BUSY 0x0001 84 #define IB_MGMT_MAD_STATUS_REDIRECT_REQD 0x0002 85 #define IB_MGMT_MAD_STATUS_BAD_VERSION 0x0004 86 #define IB_MGMT_MAD_STATUS_UNSUPPORTED_METHOD 0x0008 87 #define IB_MGMT_MAD_STATUS_UNSUPPORTED_METHOD_ATTRIB 0x000c 88 #define IB_MGMT_MAD_STATUS_INVALID_ATTRIB_VALUE 0x001c 89 90 /* RMPP information */ 91 #define IB_MGMT_RMPP_VERSION 1 92 93 #define IB_MGMT_RMPP_TYPE_DATA 1 94 #define IB_MGMT_RMPP_TYPE_ACK 2 95 #define IB_MGMT_RMPP_TYPE_STOP 3 96 #define IB_MGMT_RMPP_TYPE_ABORT 4 97 98 #define IB_MGMT_RMPP_FLAG_ACTIVE 1 99 #define IB_MGMT_RMPP_FLAG_FIRST (1<<1) 100 #define IB_MGMT_RMPP_FLAG_LAST (1<<2) 101 102 #define IB_MGMT_RMPP_NO_RESPTIME 0x1F 103 104 #define IB_MGMT_RMPP_STATUS_SUCCESS 0 105 #define IB_MGMT_RMPP_STATUS_RESX 1 106 #define IB_MGMT_RMPP_STATUS_ABORT_MIN 118 107 #define IB_MGMT_RMPP_STATUS_T2L 118 108 #define IB_MGMT_RMPP_STATUS_BAD_LEN 119 109 #define IB_MGMT_RMPP_STATUS_BAD_SEG 120 110 #define IB_MGMT_RMPP_STATUS_BADT 121 111 #define IB_MGMT_RMPP_STATUS_W2S 122 112 #define IB_MGMT_RMPP_STATUS_S2B 123 113 #define IB_MGMT_RMPP_STATUS_BAD_STATUS 124 114 #define IB_MGMT_RMPP_STATUS_UNV 125 115 #define IB_MGMT_RMPP_STATUS_TMR 126 116 #define IB_MGMT_RMPP_STATUS_UNSPEC 127 117 #define IB_MGMT_RMPP_STATUS_ABORT_MAX 127 118 119 #define IB_QP0 0 120 #define IB_QP1 cpu_to_be32(1) 121 #define IB_QP1_QKEY 0x80010000 122 #define IB_QP_SET_QKEY 0x80000000 123 124 #define IB_DEFAULT_PKEY_PARTIAL 0x7FFF 125 #define IB_DEFAULT_PKEY_FULL 0xFFFF 126 127 enum { 128 IB_MGMT_MAD_HDR = 24, 129 IB_MGMT_MAD_DATA = 232, 130 IB_MGMT_RMPP_HDR = 36, 131 IB_MGMT_RMPP_DATA = 220, 132 IB_MGMT_VENDOR_HDR = 40, 133 IB_MGMT_VENDOR_DATA = 216, 134 IB_MGMT_SA_HDR = 56, 135 IB_MGMT_SA_DATA = 200, 136 IB_MGMT_DEVICE_HDR = 64, 137 IB_MGMT_DEVICE_DATA = 192, 138 }; 139 140 struct 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 153 struct 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 162 typedef 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 */ 172 struct 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 179 struct ib_mad { 180 struct ib_mad_hdr mad_hdr; 181 u8 data[IB_MGMT_MAD_DATA]; 182 }; 183 184 struct 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 190 struct 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 197 struct 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 205 struct 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 */ 248 struct 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 */ 266 int 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 */ 272 static 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 */ 281 static 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 */ 291 static 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 */ 301 static 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 307 struct ib_mad_agent; 308 struct ib_mad_send_wc; 309 struct 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 */ 316 typedef 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 */ 329 typedef 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 */ 344 typedef 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 * @flags: registration flags 360 * @port_num: Port number on which QP is registered 361 * @rmpp_version: If set, indicates the RMPP version used by this agent. 362 */ 363 enum { 364 IB_MAD_USER_RMPP = IB_USER_MAD_USER_RMPP, 365 }; 366 struct ib_mad_agent { 367 struct ib_device *device; 368 struct ib_qp *qp; 369 struct ib_mr *mr; 370 ib_mad_recv_handler recv_handler; 371 ib_mad_send_handler send_handler; 372 ib_mad_snoop_handler snoop_handler; 373 void *context; 374 u32 hi_tid; 375 u32 flags; 376 u8 port_num; 377 u8 rmpp_version; 378 }; 379 380 /** 381 * ib_mad_send_wc - MAD send completion information. 382 * @send_buf: Send MAD data buffer associated with the send MAD request. 383 * @status: Completion status. 384 * @vendor_err: Optional vendor error information returned with a failed 385 * request. 386 */ 387 struct ib_mad_send_wc { 388 struct ib_mad_send_buf *send_buf; 389 enum ib_wc_status status; 390 u32 vendor_err; 391 }; 392 393 /** 394 * ib_mad_recv_buf - received MAD buffer information. 395 * @list: Reference to next data buffer for a received RMPP MAD. 396 * @grh: References a data buffer containing the global route header. 397 * The data refereced by this buffer is only valid if the GRH is 398 * valid. 399 * @mad: References the start of the received MAD. 400 */ 401 struct ib_mad_recv_buf { 402 struct list_head list; 403 struct ib_grh *grh; 404 struct ib_mad *mad; 405 }; 406 407 /** 408 * ib_mad_recv_wc - received MAD information. 409 * @wc: Completion information for the received data. 410 * @recv_buf: Specifies the location of the received data buffer(s). 411 * @rmpp_list: Specifies a list of RMPP reassembled received MAD buffers. 412 * @mad_len: The length of the received MAD, without duplicated headers. 413 * 414 * For received response, the wr_id contains a pointer to the ib_mad_send_buf 415 * for the corresponding send request. 416 */ 417 struct ib_mad_recv_wc { 418 struct ib_wc *wc; 419 struct ib_mad_recv_buf recv_buf; 420 struct list_head rmpp_list; 421 int mad_len; 422 }; 423 424 /** 425 * ib_mad_reg_req - MAD registration request 426 * @mgmt_class: Indicates which management class of MADs should be receive 427 * by the caller. This field is only required if the user wishes to 428 * receive unsolicited MADs, otherwise it should be 0. 429 * @mgmt_class_version: Indicates which version of MADs for the given 430 * management class to receive. 431 * @oui: Indicates IEEE OUI when mgmt_class is a vendor class 432 * in the range from 0x30 to 0x4f. Otherwise not used. 433 * @method_mask: The caller will receive unsolicited MADs for any method 434 * where @method_mask = 1. 435 * 436 */ 437 struct ib_mad_reg_req { 438 u8 mgmt_class; 439 u8 mgmt_class_version; 440 u8 oui[3]; 441 DECLARE_BITMAP(method_mask, IB_MGMT_MAX_METHODS); 442 }; 443 444 /** 445 * ib_register_mad_agent - Register to send/receive MADs. 446 * @device: The device to register with. 447 * @port_num: The port on the specified device to use. 448 * @qp_type: Specifies which QP to access. Must be either 449 * IB_QPT_SMI or IB_QPT_GSI. 450 * @mad_reg_req: Specifies which unsolicited MADs should be received 451 * by the caller. This parameter may be NULL if the caller only 452 * wishes to receive solicited responses. 453 * @rmpp_version: If set, indicates that the client will send 454 * and receive MADs that contain the RMPP header for the given version. 455 * If set to 0, indicates that RMPP is not used by this client. 456 * @send_handler: The completion callback routine invoked after a send 457 * request has completed. 458 * @recv_handler: The completion callback routine invoked for a received 459 * MAD. 460 * @context: User specified context associated with the registration. 461 * @registration_flags: Registration flags to set for this agent 462 */ 463 struct ib_mad_agent *ib_register_mad_agent(struct ib_device *device, 464 u8 port_num, 465 enum ib_qp_type qp_type, 466 struct ib_mad_reg_req *mad_reg_req, 467 u8 rmpp_version, 468 ib_mad_send_handler send_handler, 469 ib_mad_recv_handler recv_handler, 470 void *context, 471 u32 registration_flags); 472 473 enum ib_mad_snoop_flags { 474 /*IB_MAD_SNOOP_POSTED_SENDS = 1,*/ 475 /*IB_MAD_SNOOP_RMPP_SENDS = (1<<1),*/ 476 IB_MAD_SNOOP_SEND_COMPLETIONS = (1<<2), 477 /*IB_MAD_SNOOP_RMPP_SEND_COMPLETIONS = (1<<3),*/ 478 IB_MAD_SNOOP_RECVS = (1<<4) 479 /*IB_MAD_SNOOP_RMPP_RECVS = (1<<5),*/ 480 /*IB_MAD_SNOOP_REDIRECTED_QPS = (1<<6)*/ 481 }; 482 483 /** 484 * ib_register_mad_snoop - Register to snoop sent and received MADs. 485 * @device: The device to register with. 486 * @port_num: The port on the specified device to use. 487 * @qp_type: Specifies which QP traffic to snoop. Must be either 488 * IB_QPT_SMI or IB_QPT_GSI. 489 * @mad_snoop_flags: Specifies information where snooping occurs. 490 * @send_handler: The callback routine invoked for a snooped send. 491 * @recv_handler: The callback routine invoked for a snooped receive. 492 * @context: User specified context associated with the registration. 493 */ 494 struct ib_mad_agent *ib_register_mad_snoop(struct ib_device *device, 495 u8 port_num, 496 enum ib_qp_type qp_type, 497 int mad_snoop_flags, 498 ib_mad_snoop_handler snoop_handler, 499 ib_mad_recv_handler recv_handler, 500 void *context); 501 502 /** 503 * ib_unregister_mad_agent - Unregisters a client from using MAD services. 504 * @mad_agent: Corresponding MAD registration request to deregister. 505 * 506 * After invoking this routine, MAD services are no longer usable by the 507 * client on the associated QP. 508 */ 509 int ib_unregister_mad_agent(struct ib_mad_agent *mad_agent); 510 511 /** 512 * ib_post_send_mad - Posts MAD(s) to the send queue of the QP associated 513 * with the registered client. 514 * @send_buf: Specifies the information needed to send the MAD(s). 515 * @bad_send_buf: Specifies the MAD on which an error was encountered. This 516 * parameter is optional if only a single MAD is posted. 517 * 518 * Sent MADs are not guaranteed to complete in the order that they were posted. 519 * 520 * If the MAD requires RMPP, the data buffer should contain a single copy 521 * of the common MAD, RMPP, and class specific headers, followed by the class 522 * defined data. If the class defined data would not divide evenly into 523 * RMPP segments, then space must be allocated at the end of the referenced 524 * buffer for any required padding. To indicate the amount of class defined 525 * data being transferred, the paylen_newwin field in the RMPP header should 526 * be set to the size of the class specific header plus the amount of class 527 * defined data being transferred. The paylen_newwin field should be 528 * specified in network-byte order. 529 */ 530 int ib_post_send_mad(struct ib_mad_send_buf *send_buf, 531 struct ib_mad_send_buf **bad_send_buf); 532 533 534 /** 535 * ib_free_recv_mad - Returns data buffers used to receive a MAD. 536 * @mad_recv_wc: Work completion information for a received MAD. 537 * 538 * Clients receiving MADs through their ib_mad_recv_handler must call this 539 * routine to return the work completion buffers to the access layer. 540 */ 541 void ib_free_recv_mad(struct ib_mad_recv_wc *mad_recv_wc); 542 543 /** 544 * ib_cancel_mad - Cancels an outstanding send MAD operation. 545 * @mad_agent: Specifies the registration associated with sent MAD. 546 * @send_buf: Indicates the MAD to cancel. 547 * 548 * MADs will be returned to the user through the corresponding 549 * ib_mad_send_handler. 550 */ 551 void ib_cancel_mad(struct ib_mad_agent *mad_agent, 552 struct ib_mad_send_buf *send_buf); 553 554 /** 555 * ib_modify_mad - Modifies an outstanding send MAD operation. 556 * @mad_agent: Specifies the registration associated with sent MAD. 557 * @send_buf: Indicates the MAD to modify. 558 * @timeout_ms: New timeout value for sent MAD. 559 * 560 * This call will reset the timeout value for a sent MAD to the specified 561 * value. 562 */ 563 int ib_modify_mad(struct ib_mad_agent *mad_agent, 564 struct ib_mad_send_buf *send_buf, u32 timeout_ms); 565 566 /** 567 * ib_redirect_mad_qp - Registers a QP for MAD services. 568 * @qp: Reference to a QP that requires MAD services. 569 * @rmpp_version: If set, indicates that the client will send 570 * and receive MADs that contain the RMPP header for the given version. 571 * If set to 0, indicates that RMPP is not used by this client. 572 * @send_handler: The completion callback routine invoked after a send 573 * request has completed. 574 * @recv_handler: The completion callback routine invoked for a received 575 * MAD. 576 * @context: User specified context associated with the registration. 577 * 578 * Use of this call allows clients to use MAD services, such as RMPP, 579 * on user-owned QPs. After calling this routine, users may send 580 * MADs on the specified QP by calling ib_mad_post_send. 581 */ 582 struct ib_mad_agent *ib_redirect_mad_qp(struct ib_qp *qp, 583 u8 rmpp_version, 584 ib_mad_send_handler send_handler, 585 ib_mad_recv_handler recv_handler, 586 void *context); 587 588 /** 589 * ib_process_mad_wc - Processes a work completion associated with a 590 * MAD sent or received on a redirected QP. 591 * @mad_agent: Specifies the registered MAD service using the redirected QP. 592 * @wc: References a work completion associated with a sent or received 593 * MAD segment. 594 * 595 * This routine is used to complete or continue processing on a MAD request. 596 * If the work completion is associated with a send operation, calling 597 * this routine is required to continue an RMPP transfer or to wait for a 598 * corresponding response, if it is a request. If the work completion is 599 * associated with a receive operation, calling this routine is required to 600 * process an inbound or outbound RMPP transfer, or to match a response MAD 601 * with its corresponding request. 602 */ 603 int ib_process_mad_wc(struct ib_mad_agent *mad_agent, 604 struct ib_wc *wc); 605 606 /** 607 * ib_create_send_mad - Allocate and initialize a data buffer and work request 608 * for sending a MAD. 609 * @mad_agent: Specifies the registered MAD service to associate with the MAD. 610 * @remote_qpn: Specifies the QPN of the receiving node. 611 * @pkey_index: Specifies which PKey the MAD will be sent using. This field 612 * is valid only if the remote_qpn is QP 1. 613 * @rmpp_active: Indicates if the send will enable RMPP. 614 * @hdr_len: Indicates the size of the data header of the MAD. This length 615 * should include the common MAD header, RMPP header, plus any class 616 * specific header. 617 * @data_len: Indicates the size of any user-transferred data. The call will 618 * automatically adjust the allocated buffer size to account for any 619 * additional padding that may be necessary. 620 * @gfp_mask: GFP mask used for the memory allocation. 621 * 622 * This routine allocates a MAD for sending. The returned MAD send buffer 623 * will reference a data buffer usable for sending a MAD, along 624 * with an initialized work request structure. Users may modify the returned 625 * MAD data buffer before posting the send. 626 * 627 * The returned MAD header, class specific headers, and any padding will be 628 * cleared. Users are responsible for initializing the common MAD header, 629 * any class specific header, and MAD data area. 630 * If @rmpp_active is set, the RMPP header will be initialized for sending. 631 */ 632 struct ib_mad_send_buf *ib_create_send_mad(struct ib_mad_agent *mad_agent, 633 u32 remote_qpn, u16 pkey_index, 634 int rmpp_active, 635 int hdr_len, int data_len, 636 gfp_t gfp_mask); 637 638 /** 639 * ib_is_mad_class_rmpp - returns whether given management class 640 * supports RMPP. 641 * @mgmt_class: management class 642 * 643 * This routine returns whether the management class supports RMPP. 644 */ 645 int ib_is_mad_class_rmpp(u8 mgmt_class); 646 647 /** 648 * ib_get_mad_data_offset - returns the data offset for a given 649 * management class. 650 * @mgmt_class: management class 651 * 652 * This routine returns the data offset in the MAD for the management 653 * class requested. 654 */ 655 int ib_get_mad_data_offset(u8 mgmt_class); 656 657 /** 658 * ib_get_rmpp_segment - returns the data buffer for a given RMPP segment. 659 * @send_buf: Previously allocated send data buffer. 660 * @seg_num: number of segment to return 661 * 662 * This routine returns a pointer to the data buffer of an RMPP MAD. 663 * Users must provide synchronization to @send_buf around this call. 664 */ 665 void *ib_get_rmpp_segment(struct ib_mad_send_buf *send_buf, int seg_num); 666 667 /** 668 * ib_free_send_mad - Returns data buffers used to send a MAD. 669 * @send_buf: Previously allocated send data buffer. 670 */ 671 void ib_free_send_mad(struct ib_mad_send_buf *send_buf); 672 673 /** 674 * ib_mad_kernel_rmpp_agent - Returns if the agent is performing RMPP. 675 * @agent: the agent in question 676 * @return: true if agent is performing rmpp, false otherwise. 677 */ 678 int ib_mad_kernel_rmpp_agent(struct ib_mad_agent *agent); 679 680 #endif /* IB_MAD_H */ 681