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.
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:
14 * Redistribution and use in source and binary forms, with or
15 * without modification, are permitted provided that the following
18 * - Redistributions of source code must retain the above
19 * copyright notice, this list of conditions and the following
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.
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
37 #if !defined(IB_MAD_H)
40 #include <linux/list.h>
42 #include <rdma/ib_verbs.h>
43 #include <uapi/rdma/ib_user_mad.h>
45 /* Management base versions */
46 #define IB_MGMT_BASE_VERSION 1
47 #define OPA_MGMT_BASE_VERSION 0x80
49 #define OPA_SMP_CLASS_VERSION 0x80
51 /* Management classes */
52 #define IB_MGMT_CLASS_SUBN_LID_ROUTED 0x01
53 #define IB_MGMT_CLASS_SUBN_DIRECTED_ROUTE 0x81
54 #define IB_MGMT_CLASS_SUBN_ADM 0x03
55 #define IB_MGMT_CLASS_PERF_MGMT 0x04
56 #define IB_MGMT_CLASS_BM 0x05
57 #define IB_MGMT_CLASS_DEVICE_MGMT 0x06
58 #define IB_MGMT_CLASS_CM 0x07
59 #define IB_MGMT_CLASS_SNMP 0x08
60 #define IB_MGMT_CLASS_DEVICE_ADM 0x10
61 #define IB_MGMT_CLASS_BOOT_MGMT 0x11
62 #define IB_MGMT_CLASS_BIS 0x12
63 #define IB_MGMT_CLASS_CONG_MGMT 0x21
64 #define IB_MGMT_CLASS_VENDOR_RANGE2_START 0x30
65 #define IB_MGMT_CLASS_VENDOR_RANGE2_END 0x4F
67 #define IB_OPENIB_OUI (0x001405)
69 /* Management methods */
70 #define IB_MGMT_METHOD_GET 0x01
71 #define IB_MGMT_METHOD_SET 0x02
72 #define IB_MGMT_METHOD_GET_RESP 0x81
73 #define IB_MGMT_METHOD_SEND 0x03
74 #define IB_MGMT_METHOD_TRAP 0x05
75 #define IB_MGMT_METHOD_REPORT 0x06
76 #define IB_MGMT_METHOD_REPORT_RESP 0x86
77 #define IB_MGMT_METHOD_TRAP_REPRESS 0x07
79 #define IB_MGMT_METHOD_RESP 0x80
80 #define IB_BM_ATTR_MOD_RESP cpu_to_be32(1)
82 #define IB_MGMT_MAX_METHODS 128
84 /* MAD Status field bit masks */
85 #define IB_MGMT_MAD_STATUS_SUCCESS 0x0000
86 #define IB_MGMT_MAD_STATUS_BUSY 0x0001
87 #define IB_MGMT_MAD_STATUS_REDIRECT_REQD 0x0002
88 #define IB_MGMT_MAD_STATUS_BAD_VERSION 0x0004
89 #define IB_MGMT_MAD_STATUS_UNSUPPORTED_METHOD 0x0008
90 #define IB_MGMT_MAD_STATUS_UNSUPPORTED_METHOD_ATTRIB 0x000c
91 #define IB_MGMT_MAD_STATUS_INVALID_ATTRIB_VALUE 0x001c
93 /* RMPP information */
94 #define IB_MGMT_RMPP_VERSION 1
96 #define IB_MGMT_RMPP_TYPE_DATA 1
97 #define IB_MGMT_RMPP_TYPE_ACK 2
98 #define IB_MGMT_RMPP_TYPE_STOP 3
99 #define IB_MGMT_RMPP_TYPE_ABORT 4
101 #define IB_MGMT_RMPP_FLAG_ACTIVE 1
102 #define IB_MGMT_RMPP_FLAG_FIRST (1<<1)
103 #define IB_MGMT_RMPP_FLAG_LAST (1<<2)
105 #define IB_MGMT_RMPP_NO_RESPTIME 0x1F
107 #define IB_MGMT_RMPP_STATUS_SUCCESS 0
108 #define IB_MGMT_RMPP_STATUS_RESX 1
109 #define IB_MGMT_RMPP_STATUS_ABORT_MIN 118
110 #define IB_MGMT_RMPP_STATUS_T2L 118
111 #define IB_MGMT_RMPP_STATUS_BAD_LEN 119
112 #define IB_MGMT_RMPP_STATUS_BAD_SEG 120
113 #define IB_MGMT_RMPP_STATUS_BADT 121
114 #define IB_MGMT_RMPP_STATUS_W2S 122
115 #define IB_MGMT_RMPP_STATUS_S2B 123
116 #define IB_MGMT_RMPP_STATUS_BAD_STATUS 124
117 #define IB_MGMT_RMPP_STATUS_UNV 125
118 #define IB_MGMT_RMPP_STATUS_TMR 126
119 #define IB_MGMT_RMPP_STATUS_UNSPEC 127
120 #define IB_MGMT_RMPP_STATUS_ABORT_MAX 127
123 #define IB_QP1 cpu_to_be32(1)
124 #define IB_QP1_QKEY 0x80010000
125 #define IB_QP_SET_QKEY 0x80000000
127 #define IB_DEFAULT_PKEY_PARTIAL 0x7FFF
128 #define IB_DEFAULT_PKEY_FULL 0xFFFF
131 * Generic trap/notice types
133 #define IB_NOTICE_TYPE_FATAL 0x80
134 #define IB_NOTICE_TYPE_URGENT 0x81
135 #define IB_NOTICE_TYPE_SECURITY 0x82
136 #define IB_NOTICE_TYPE_SM 0x83
137 #define IB_NOTICE_TYPE_INFO 0x84
140 * Generic trap/notice producers
142 #define IB_NOTICE_PROD_CA cpu_to_be16(1)
143 #define IB_NOTICE_PROD_SWITCH cpu_to_be16(2)
144 #define IB_NOTICE_PROD_ROUTER cpu_to_be16(3)
145 #define IB_NOTICE_PROD_CLASS_MGR cpu_to_be16(4)
148 * Generic trap/notice numbers
150 #define IB_NOTICE_TRAP_LLI_THRESH cpu_to_be16(129)
151 #define IB_NOTICE_TRAP_EBO_THRESH cpu_to_be16(130)
152 #define IB_NOTICE_TRAP_FLOW_UPDATE cpu_to_be16(131)
153 #define IB_NOTICE_TRAP_CAP_MASK_CHG cpu_to_be16(144)
154 #define IB_NOTICE_TRAP_SYS_GUID_CHG cpu_to_be16(145)
155 #define IB_NOTICE_TRAP_BAD_MKEY cpu_to_be16(256)
156 #define IB_NOTICE_TRAP_BAD_PKEY cpu_to_be16(257)
157 #define IB_NOTICE_TRAP_BAD_QKEY cpu_to_be16(258)
160 * Repress trap/notice flags
162 #define IB_NOTICE_REPRESS_LLI_THRESH (1 << 0)
163 #define IB_NOTICE_REPRESS_EBO_THRESH (1 << 1)
164 #define IB_NOTICE_REPRESS_FLOW_UPDATE (1 << 2)
165 #define IB_NOTICE_REPRESS_CAP_MASK_CHG (1 << 3)
166 #define IB_NOTICE_REPRESS_SYS_GUID_CHG (1 << 4)
167 #define IB_NOTICE_REPRESS_BAD_MKEY (1 << 5)
168 #define IB_NOTICE_REPRESS_BAD_PKEY (1 << 6)
169 #define IB_NOTICE_REPRESS_BAD_QKEY (1 << 7)
172 * Generic trap/notice other local changes flags (trap 144).
174 #define IB_NOTICE_TRAP_LSE_CHG 0x04 /* Link Speed Enable changed */
175 #define IB_NOTICE_TRAP_LWE_CHG 0x02 /* Link Width Enable changed */
176 #define IB_NOTICE_TRAP_NODE_DESC_CHG 0x01
179 * Generic trap/notice M_Key volation flags in dr_trunc_hop (trap 256).
181 #define IB_NOTICE_TRAP_DR_NOTICE 0x80
182 #define IB_NOTICE_TRAP_DR_TRUNC 0x40
185 IB_MGMT_MAD_HDR = 24,
186 IB_MGMT_MAD_DATA = 232,
187 IB_MGMT_RMPP_HDR = 36,
188 IB_MGMT_RMPP_DATA = 220,
189 IB_MGMT_VENDOR_HDR = 40,
190 IB_MGMT_VENDOR_DATA = 216,
192 IB_MGMT_SA_DATA = 200,
193 IB_MGMT_DEVICE_HDR = 64,
194 IB_MGMT_DEVICE_DATA = 192,
195 IB_MGMT_MAD_SIZE = IB_MGMT_MAD_HDR + IB_MGMT_MAD_DATA,
196 OPA_MGMT_MAD_DATA = 2024,
197 OPA_MGMT_RMPP_DATA = 2012,
198 OPA_MGMT_MAD_SIZE = IB_MGMT_MAD_HDR + OPA_MGMT_MAD_DATA,
207 __be16 class_specific;
220 __be32 paylen_newwin;
223 typedef u64 __bitwise ib_sa_comp_mask;
225 #define IB_SA_COMP_MASK(n) ((__force ib_sa_comp_mask) cpu_to_be64(1ull << (n)))
228 * ib_sa_hdr and ib_sa_mad structures must be packed because they have
229 * 64-bit fields that are only 32-bit aligned. 64-bit architectures will
230 * lay them out wrong otherwise. (And unfortunately they are sent on
231 * the wire so we can't change the layout)
237 ib_sa_comp_mask comp_mask;
238 } __attribute__ ((packed));
241 struct ib_mad_hdr mad_hdr;
242 u8 data[IB_MGMT_MAD_DATA];
246 struct ib_mad_hdr mad_hdr;
247 u8 data[OPA_MGMT_MAD_DATA];
251 struct ib_mad_hdr mad_hdr;
252 struct ib_rmpp_hdr rmpp_hdr;
253 u8 data[IB_MGMT_RMPP_DATA];
256 struct opa_rmpp_mad {
257 struct ib_mad_hdr mad_hdr;
258 struct ib_rmpp_hdr rmpp_hdr;
259 u8 data[OPA_MGMT_RMPP_DATA];
263 struct ib_mad_hdr mad_hdr;
264 struct ib_rmpp_hdr rmpp_hdr;
265 struct ib_sa_hdr sa_hdr;
266 u8 data[IB_MGMT_SA_DATA];
267 } __attribute__ ((packed));
269 struct ib_vendor_mad {
270 struct ib_mad_hdr mad_hdr;
271 struct ib_rmpp_hdr rmpp_hdr;
274 u8 data[IB_MGMT_VENDOR_DATA];
277 struct ib_class_port_info {
280 __be16 capability_mask;
284 __be32 redirect_tcslfl;
286 __be16 redirect_pkey;
288 __be32 redirect_qkey;
297 struct ib_node_info {
305 __be16 partition_cap;
312 struct ib_mad_notice_attr {
315 __be16 prod_type_lsb;
327 __be16 lid; /* where violation happened */
328 u8 port_num; /* where violation happened */
329 } __packed ntc_129_131;
333 __be16 lid; /* LID where change occurred */
335 u8 local_changes; /* low bit - local changes */
336 __be32 new_cap_mask; /* new capability mask */
338 u8 change_flags; /* low 3 bits only */
343 __be16 lid; /* lid where sys guid changed */
367 __be32 sl_qp1; /* SL: high 4 bits */
368 __be32 qp2; /* high 8 bits reserved */
371 } __packed ntc_257_258;
376 struct ib_vl_weight_elem {
377 u8 vl; /* VL is low 5 bits, upper 3 bits reserved */
382 * ib_mad_send_buf - MAD data buffer and work request for sends.
383 * @next: A pointer used to chain together MADs for posting.
384 * @mad: References an allocated MAD data buffer for MADs that do not have
385 * RMPP active. For MADs using RMPP, references the common and management
386 * class specific headers.
387 * @mad_agent: MAD agent that allocated the buffer.
388 * @ah: The address handle to use when sending the MAD.
389 * @context: User-controlled context fields.
390 * @hdr_len: Indicates the size of the data header of the MAD. This length
391 * includes the common MAD, RMPP, and class specific headers.
392 * @data_len: Indicates the total size of user-transferred data.
393 * @seg_count: The number of RMPP segments allocated for this send.
394 * @seg_size: Size of the data in each RMPP segment. This does not include
395 * class specific headers.
396 * @seg_rmpp_size: Size of each RMPP segment including the class specific
398 * @timeout_ms: Time to wait for a response.
399 * @retries: Number of times to retry a request for a response. For MADs
400 * using RMPP, this applies per window. On completion, returns the number
401 * of retries needed to complete the transfer.
403 * Users are responsible for initializing the MAD buffer itself, with the
404 * exception of any RMPP header. Additional segment buffer space allocated
405 * beyond data_len is padding.
407 struct ib_mad_send_buf {
408 struct ib_mad_send_buf *next;
410 struct ib_mad_agent *mad_agent;
423 * ib_response_mad - Returns if the specified MAD has been generated in
424 * response to a sent request or trap.
426 int ib_response_mad(const struct ib_mad_hdr *hdr);
429 * ib_get_rmpp_resptime - Returns the RMPP response time.
430 * @rmpp_hdr: An RMPP header.
432 static inline u8 ib_get_rmpp_resptime(struct ib_rmpp_hdr *rmpp_hdr)
434 return rmpp_hdr->rmpp_rtime_flags >> 3;
438 * ib_get_rmpp_flags - Returns the RMPP flags.
439 * @rmpp_hdr: An RMPP header.
441 static inline u8 ib_get_rmpp_flags(struct ib_rmpp_hdr *rmpp_hdr)
443 return rmpp_hdr->rmpp_rtime_flags & 0x7;
447 * ib_set_rmpp_resptime - Sets the response time in an RMPP header.
448 * @rmpp_hdr: An RMPP header.
449 * @rtime: The response time to set.
451 static inline void ib_set_rmpp_resptime(struct ib_rmpp_hdr *rmpp_hdr, u8 rtime)
453 rmpp_hdr->rmpp_rtime_flags = ib_get_rmpp_flags(rmpp_hdr) | (rtime << 3);
457 * ib_set_rmpp_flags - Sets the flags in an RMPP header.
458 * @rmpp_hdr: An RMPP header.
459 * @flags: The flags to set.
461 static inline void ib_set_rmpp_flags(struct ib_rmpp_hdr *rmpp_hdr, u8 flags)
463 rmpp_hdr->rmpp_rtime_flags = (rmpp_hdr->rmpp_rtime_flags & 0xF8) |
468 struct ib_mad_send_wc;
469 struct ib_mad_recv_wc;
472 * ib_mad_send_handler - callback handler for a sent MAD.
473 * @mad_agent: MAD agent that sent the MAD.
474 * @mad_send_wc: Send work completion information on the sent MAD.
476 typedef void (*ib_mad_send_handler)(struct ib_mad_agent *mad_agent,
477 struct ib_mad_send_wc *mad_send_wc);
480 * ib_mad_snoop_handler - Callback handler for snooping sent MADs.
481 * @mad_agent: MAD agent that snooped the MAD.
482 * @send_wr: Work request information on the sent MAD.
483 * @mad_send_wc: Work completion information on the sent MAD. Valid
484 * only for snooping that occurs on a send completion.
486 * Clients snooping MADs should not modify data referenced by the @send_wr
489 typedef void (*ib_mad_snoop_handler)(struct ib_mad_agent *mad_agent,
490 struct ib_mad_send_buf *send_buf,
491 struct ib_mad_send_wc *mad_send_wc);
494 * ib_mad_recv_handler - callback handler for a received MAD.
495 * @mad_agent: MAD agent requesting the received MAD.
496 * @mad_recv_wc: Received work completion information on the received MAD.
498 * MADs received in response to a send request operation will be handed to
499 * the user before the send operation completes. All data buffers given
500 * to registered agents through this routine are owned by the receiving
501 * client, except for snooping agents. Clients snooping MADs should not
502 * modify the data referenced by @mad_recv_wc.
504 typedef void (*ib_mad_recv_handler)(struct ib_mad_agent *mad_agent,
505 struct ib_mad_recv_wc *mad_recv_wc);
508 * ib_mad_agent - Used to track MAD registration with the access layer.
509 * @device: Reference to device registration is on.
510 * @qp: Reference to QP used for sending and receiving MADs.
511 * @mr: Memory region for system memory usable for DMA.
512 * @recv_handler: Callback handler for a received MAD.
513 * @send_handler: Callback handler for a sent MAD.
514 * @snoop_handler: Callback handler for snooped sent MADs.
515 * @context: User-specified context associated with this registration.
516 * @hi_tid: Access layer assigned transaction ID for this client.
517 * Unsolicited MADs sent by this client will have the upper 32-bits
518 * of their TID set to this value.
519 * @flags: registration flags
520 * @port_num: Port number on which QP is registered
521 * @rmpp_version: If set, indicates the RMPP version used by this agent.
524 IB_MAD_USER_RMPP = IB_USER_MAD_USER_RMPP,
526 struct ib_mad_agent {
527 struct ib_device *device;
530 ib_mad_recv_handler recv_handler;
531 ib_mad_send_handler send_handler;
532 ib_mad_snoop_handler snoop_handler;
541 * ib_mad_send_wc - MAD send completion information.
542 * @send_buf: Send MAD data buffer associated with the send MAD request.
543 * @status: Completion status.
544 * @vendor_err: Optional vendor error information returned with a failed
547 struct ib_mad_send_wc {
548 struct ib_mad_send_buf *send_buf;
549 enum ib_wc_status status;
554 * ib_mad_recv_buf - received MAD buffer information.
555 * @list: Reference to next data buffer for a received RMPP MAD.
556 * @grh: References a data buffer containing the global route header.
557 * The data refereced by this buffer is only valid if the GRH is
559 * @mad: References the start of the received MAD.
561 struct ib_mad_recv_buf {
562 struct list_head list;
566 struct opa_mad *opa_mad;
571 * ib_mad_recv_wc - received MAD information.
572 * @wc: Completion information for the received data.
573 * @recv_buf: Specifies the location of the received data buffer(s).
574 * @rmpp_list: Specifies a list of RMPP reassembled received MAD buffers.
575 * @mad_len: The length of the received MAD, without duplicated headers.
576 * @mad_seg_size: The size of individual MAD segments
578 * For received response, the wr_id contains a pointer to the ib_mad_send_buf
579 * for the corresponding send request.
581 struct ib_mad_recv_wc {
583 struct ib_mad_recv_buf recv_buf;
584 struct list_head rmpp_list;
590 * ib_mad_reg_req - MAD registration request
591 * @mgmt_class: Indicates which management class of MADs should be receive
592 * by the caller. This field is only required if the user wishes to
593 * receive unsolicited MADs, otherwise it should be 0.
594 * @mgmt_class_version: Indicates which version of MADs for the given
595 * management class to receive.
596 * @oui: Indicates IEEE OUI when mgmt_class is a vendor class
597 * in the range from 0x30 to 0x4f. Otherwise not used.
598 * @method_mask: The caller will receive unsolicited MADs for any method
599 * where @method_mask = 1.
602 struct ib_mad_reg_req {
604 u8 mgmt_class_version;
606 DECLARE_BITMAP(method_mask, IB_MGMT_MAX_METHODS);
610 * ib_register_mad_agent - Register to send/receive MADs.
611 * @device: The device to register with.
612 * @port_num: The port on the specified device to use.
613 * @qp_type: Specifies which QP to access. Must be either
614 * IB_QPT_SMI or IB_QPT_GSI.
615 * @mad_reg_req: Specifies which unsolicited MADs should be received
616 * by the caller. This parameter may be NULL if the caller only
617 * wishes to receive solicited responses.
618 * @rmpp_version: If set, indicates that the client will send
619 * and receive MADs that contain the RMPP header for the given version.
620 * If set to 0, indicates that RMPP is not used by this client.
621 * @send_handler: The completion callback routine invoked after a send
622 * request has completed.
623 * @recv_handler: The completion callback routine invoked for a received
625 * @context: User specified context associated with the registration.
626 * @registration_flags: Registration flags to set for this agent
628 struct ib_mad_agent *ib_register_mad_agent(struct ib_device *device,
630 enum ib_qp_type qp_type,
631 struct ib_mad_reg_req *mad_reg_req,
633 ib_mad_send_handler send_handler,
634 ib_mad_recv_handler recv_handler,
636 u32 registration_flags);
638 enum ib_mad_snoop_flags {
639 /*IB_MAD_SNOOP_POSTED_SENDS = 1,*/
640 /*IB_MAD_SNOOP_RMPP_SENDS = (1<<1),*/
641 IB_MAD_SNOOP_SEND_COMPLETIONS = (1<<2),
642 /*IB_MAD_SNOOP_RMPP_SEND_COMPLETIONS = (1<<3),*/
643 IB_MAD_SNOOP_RECVS = (1<<4)
644 /*IB_MAD_SNOOP_RMPP_RECVS = (1<<5),*/
645 /*IB_MAD_SNOOP_REDIRECTED_QPS = (1<<6)*/
649 * ib_register_mad_snoop - Register to snoop sent and received MADs.
650 * @device: The device to register with.
651 * @port_num: The port on the specified device to use.
652 * @qp_type: Specifies which QP traffic to snoop. Must be either
653 * IB_QPT_SMI or IB_QPT_GSI.
654 * @mad_snoop_flags: Specifies information where snooping occurs.
655 * @send_handler: The callback routine invoked for a snooped send.
656 * @recv_handler: The callback routine invoked for a snooped receive.
657 * @context: User specified context associated with the registration.
659 struct ib_mad_agent *ib_register_mad_snoop(struct ib_device *device,
661 enum ib_qp_type qp_type,
663 ib_mad_snoop_handler snoop_handler,
664 ib_mad_recv_handler recv_handler,
668 * ib_unregister_mad_agent - Unregisters a client from using MAD services.
669 * @mad_agent: Corresponding MAD registration request to deregister.
671 * After invoking this routine, MAD services are no longer usable by the
672 * client on the associated QP.
674 int ib_unregister_mad_agent(struct ib_mad_agent *mad_agent);
677 * ib_post_send_mad - Posts MAD(s) to the send queue of the QP associated
678 * with the registered client.
679 * @send_buf: Specifies the information needed to send the MAD(s).
680 * @bad_send_buf: Specifies the MAD on which an error was encountered. This
681 * parameter is optional if only a single MAD is posted.
683 * Sent MADs are not guaranteed to complete in the order that they were posted.
685 * If the MAD requires RMPP, the data buffer should contain a single copy
686 * of the common MAD, RMPP, and class specific headers, followed by the class
687 * defined data. If the class defined data would not divide evenly into
688 * RMPP segments, then space must be allocated at the end of the referenced
689 * buffer for any required padding. To indicate the amount of class defined
690 * data being transferred, the paylen_newwin field in the RMPP header should
691 * be set to the size of the class specific header plus the amount of class
692 * defined data being transferred. The paylen_newwin field should be
693 * specified in network-byte order.
695 int ib_post_send_mad(struct ib_mad_send_buf *send_buf,
696 struct ib_mad_send_buf **bad_send_buf);
700 * ib_free_recv_mad - Returns data buffers used to receive a MAD.
701 * @mad_recv_wc: Work completion information for a received MAD.
703 * Clients receiving MADs through their ib_mad_recv_handler must call this
704 * routine to return the work completion buffers to the access layer.
706 void ib_free_recv_mad(struct ib_mad_recv_wc *mad_recv_wc);
709 * ib_cancel_mad - Cancels an outstanding send MAD operation.
710 * @mad_agent: Specifies the registration associated with sent MAD.
711 * @send_buf: Indicates the MAD to cancel.
713 * MADs will be returned to the user through the corresponding
714 * ib_mad_send_handler.
716 void ib_cancel_mad(struct ib_mad_agent *mad_agent,
717 struct ib_mad_send_buf *send_buf);
720 * ib_modify_mad - Modifies an outstanding send MAD operation.
721 * @mad_agent: Specifies the registration associated with sent MAD.
722 * @send_buf: Indicates the MAD to modify.
723 * @timeout_ms: New timeout value for sent MAD.
725 * This call will reset the timeout value for a sent MAD to the specified
728 int ib_modify_mad(struct ib_mad_agent *mad_agent,
729 struct ib_mad_send_buf *send_buf, u32 timeout_ms);
732 * ib_redirect_mad_qp - Registers a QP for MAD services.
733 * @qp: Reference to a QP that requires MAD services.
734 * @rmpp_version: If set, indicates that the client will send
735 * and receive MADs that contain the RMPP header for the given version.
736 * If set to 0, indicates that RMPP is not used by this client.
737 * @send_handler: The completion callback routine invoked after a send
738 * request has completed.
739 * @recv_handler: The completion callback routine invoked for a received
741 * @context: User specified context associated with the registration.
743 * Use of this call allows clients to use MAD services, such as RMPP,
744 * on user-owned QPs. After calling this routine, users may send
745 * MADs on the specified QP by calling ib_mad_post_send.
747 struct ib_mad_agent *ib_redirect_mad_qp(struct ib_qp *qp,
749 ib_mad_send_handler send_handler,
750 ib_mad_recv_handler recv_handler,
754 * ib_process_mad_wc - Processes a work completion associated with a
755 * MAD sent or received on a redirected QP.
756 * @mad_agent: Specifies the registered MAD service using the redirected QP.
757 * @wc: References a work completion associated with a sent or received
760 * This routine is used to complete or continue processing on a MAD request.
761 * If the work completion is associated with a send operation, calling
762 * this routine is required to continue an RMPP transfer or to wait for a
763 * corresponding response, if it is a request. If the work completion is
764 * associated with a receive operation, calling this routine is required to
765 * process an inbound or outbound RMPP transfer, or to match a response MAD
766 * with its corresponding request.
768 int ib_process_mad_wc(struct ib_mad_agent *mad_agent,
772 * ib_create_send_mad - Allocate and initialize a data buffer and work request
774 * @mad_agent: Specifies the registered MAD service to associate with the MAD.
775 * @remote_qpn: Specifies the QPN of the receiving node.
776 * @pkey_index: Specifies which PKey the MAD will be sent using. This field
777 * is valid only if the remote_qpn is QP 1.
778 * @rmpp_active: Indicates if the send will enable RMPP.
779 * @hdr_len: Indicates the size of the data header of the MAD. This length
780 * should include the common MAD header, RMPP header, plus any class
782 * @data_len: Indicates the size of any user-transferred data. The call will
783 * automatically adjust the allocated buffer size to account for any
784 * additional padding that may be necessary.
785 * @gfp_mask: GFP mask used for the memory allocation.
786 * @base_version: Base Version of this MAD
788 * This routine allocates a MAD for sending. The returned MAD send buffer
789 * will reference a data buffer usable for sending a MAD, along
790 * with an initialized work request structure. Users may modify the returned
791 * MAD data buffer before posting the send.
793 * The returned MAD header, class specific headers, and any padding will be
794 * cleared. Users are responsible for initializing the common MAD header,
795 * any class specific header, and MAD data area.
796 * If @rmpp_active is set, the RMPP header will be initialized for sending.
798 struct ib_mad_send_buf *ib_create_send_mad(struct ib_mad_agent *mad_agent,
799 u32 remote_qpn, u16 pkey_index,
801 int hdr_len, int data_len,
806 * ib_is_mad_class_rmpp - returns whether given management class
808 * @mgmt_class: management class
810 * This routine returns whether the management class supports RMPP.
812 int ib_is_mad_class_rmpp(u8 mgmt_class);
815 * ib_get_mad_data_offset - returns the data offset for a given
817 * @mgmt_class: management class
819 * This routine returns the data offset in the MAD for the management
822 int ib_get_mad_data_offset(u8 mgmt_class);
825 * ib_get_rmpp_segment - returns the data buffer for a given RMPP segment.
826 * @send_buf: Previously allocated send data buffer.
827 * @seg_num: number of segment to return
829 * This routine returns a pointer to the data buffer of an RMPP MAD.
830 * Users must provide synchronization to @send_buf around this call.
832 void *ib_get_rmpp_segment(struct ib_mad_send_buf *send_buf, int seg_num);
835 * ib_free_send_mad - Returns data buffers used to send a MAD.
836 * @send_buf: Previously allocated send data buffer.
838 void ib_free_send_mad(struct ib_mad_send_buf *send_buf);
841 * ib_mad_kernel_rmpp_agent - Returns if the agent is performing RMPP.
842 * @agent: the agent in question
843 * @return: true if agent is performing rmpp, false otherwise.
845 int ib_mad_kernel_rmpp_agent(const struct ib_mad_agent *agent);
847 #endif /* IB_MAD_H */