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