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