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_SM_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 IB_MGMT_MAD_HDR
= 24,
149 IB_MGMT_MAD_DATA
= 232,
150 IB_MGMT_RMPP_HDR
= 36,
151 IB_MGMT_RMPP_DATA
= 220,
152 IB_MGMT_VENDOR_HDR
= 40,
153 IB_MGMT_VENDOR_DATA
= 216,
155 IB_MGMT_SA_DATA
= 200,
156 IB_MGMT_DEVICE_HDR
= 64,
157 IB_MGMT_DEVICE_DATA
= 192,
158 IB_MGMT_MAD_SIZE
= IB_MGMT_MAD_HDR
+ IB_MGMT_MAD_DATA
,
159 OPA_MGMT_MAD_DATA
= 2024,
160 OPA_MGMT_RMPP_DATA
= 2012,
161 OPA_MGMT_MAD_SIZE
= IB_MGMT_MAD_HDR
+ OPA_MGMT_MAD_DATA
,
170 __be16 class_specific
;
183 __be32 paylen_newwin
;
186 typedef u64 __bitwise ib_sa_comp_mask
;
188 #define IB_SA_COMP_MASK(n) ((__force ib_sa_comp_mask) cpu_to_be64(1ull << (n)))
191 * ib_sa_hdr and ib_sa_mad structures must be packed because they have
192 * 64-bit fields that are only 32-bit aligned. 64-bit architectures will
193 * lay them out wrong otherwise. (And unfortunately they are sent on
194 * the wire so we can't change the layout)
200 ib_sa_comp_mask comp_mask
;
201 } __attribute__ ((packed
));
204 struct ib_mad_hdr mad_hdr
;
205 u8 data
[IB_MGMT_MAD_DATA
];
209 struct ib_mad_hdr mad_hdr
;
210 u8 data
[OPA_MGMT_MAD_DATA
];
214 struct ib_mad_hdr mad_hdr
;
215 struct ib_rmpp_hdr rmpp_hdr
;
216 u8 data
[IB_MGMT_RMPP_DATA
];
219 struct opa_rmpp_mad
{
220 struct ib_mad_hdr mad_hdr
;
221 struct ib_rmpp_hdr rmpp_hdr
;
222 u8 data
[OPA_MGMT_RMPP_DATA
];
226 struct ib_mad_hdr mad_hdr
;
227 struct ib_rmpp_hdr rmpp_hdr
;
228 struct ib_sa_hdr sa_hdr
;
229 u8 data
[IB_MGMT_SA_DATA
];
230 } __attribute__ ((packed
));
232 struct ib_vendor_mad
{
233 struct ib_mad_hdr mad_hdr
;
234 struct ib_rmpp_hdr rmpp_hdr
;
237 u8 data
[IB_MGMT_VENDOR_DATA
];
240 #define IB_MGMT_CLASSPORTINFO_ATTR_ID cpu_to_be16(0x0001)
242 #define IB_CLASS_PORT_INFO_RESP_TIME_MASK 0x1F
243 #define IB_CLASS_PORT_INFO_RESP_TIME_FIELD_SIZE 5
245 struct ib_class_port_info
{
248 __be16 capability_mask
;
249 /* 27 bits for cap_mask2, 5 bits for resp_time */
250 __be32 cap_mask2_resp_time
;
252 __be32 redirect_tcslfl
;
254 __be16 redirect_pkey
;
256 __be32 redirect_qkey
;
266 * ib_get_cpi_resp_time - Returns the resp_time value from
267 * cap_mask2_resp_time in ib_class_port_info.
268 * @cpi: A struct ib_class_port_info mad.
270 static inline u8
ib_get_cpi_resp_time(struct ib_class_port_info
*cpi
)
272 return (u8
)(be32_to_cpu(cpi
->cap_mask2_resp_time
) &
273 IB_CLASS_PORT_INFO_RESP_TIME_MASK
);
277 * ib_set_cpi_resptime - Sets the response time in an
278 * ib_class_port_info mad.
279 * @cpi: A struct ib_class_port_info.
280 * @rtime: The response time to set.
282 static inline void ib_set_cpi_resp_time(struct ib_class_port_info
*cpi
,
285 cpi
->cap_mask2_resp_time
=
286 (cpi
->cap_mask2_resp_time
&
287 cpu_to_be32(~IB_CLASS_PORT_INFO_RESP_TIME_MASK
)) |
288 cpu_to_be32(rtime
& IB_CLASS_PORT_INFO_RESP_TIME_MASK
);
292 * ib_get_cpi_capmask2 - Returns the capmask2 value from
293 * cap_mask2_resp_time in ib_class_port_info.
294 * @cpi: A struct ib_class_port_info mad.
296 static inline u32
ib_get_cpi_capmask2(struct ib_class_port_info
*cpi
)
298 return (be32_to_cpu(cpi
->cap_mask2_resp_time
) >>
299 IB_CLASS_PORT_INFO_RESP_TIME_FIELD_SIZE
);
303 * ib_set_cpi_capmask2 - Sets the capmask2 in an
304 * ib_class_port_info mad.
305 * @cpi: A struct ib_class_port_info.
306 * @capmask2: The capmask2 to set.
308 static inline void ib_set_cpi_capmask2(struct ib_class_port_info
*cpi
,
311 cpi
->cap_mask2_resp_time
=
312 (cpi
->cap_mask2_resp_time
&
313 cpu_to_be32(IB_CLASS_PORT_INFO_RESP_TIME_MASK
)) |
314 cpu_to_be32(capmask2
<<
315 IB_CLASS_PORT_INFO_RESP_TIME_FIELD_SIZE
);
318 struct ib_mad_notice_attr
{
321 __be16 prod_type_lsb
;
333 __be16 lid
; /* where violation happened */
334 u8 port_num
; /* where violation happened */
335 } __packed ntc_129_131
;
339 __be16 lid
; /* LID where change occurred */
341 u8 local_changes
; /* low bit - local changes */
342 __be32 new_cap_mask
; /* new capability mask */
344 u8 change_flags
; /* low 3 bits only */
349 __be16 lid
; /* lid where sys guid changed */
373 __be32 sl_qp1
; /* SL: high 4 bits */
374 __be32 qp2
; /* high 8 bits reserved */
377 } __packed ntc_257_258
;
383 * ib_mad_send_buf - MAD data buffer and work request for sends.
384 * @next: A pointer used to chain together MADs for posting.
385 * @mad: References an allocated MAD data buffer for MADs that do not have
386 * RMPP active. For MADs using RMPP, references the common and management
387 * class specific headers.
388 * @mad_agent: MAD agent that allocated the buffer.
389 * @ah: The address handle to use when sending the MAD.
390 * @context: User-controlled context fields.
391 * @hdr_len: Indicates the size of the data header of the MAD. This length
392 * includes the common MAD, RMPP, and class specific headers.
393 * @data_len: Indicates the total size of user-transferred data.
394 * @seg_count: The number of RMPP segments allocated for this send.
395 * @seg_size: Size of the data in each RMPP segment. This does not include
396 * class specific headers.
397 * @seg_rmpp_size: Size of each RMPP segment including the class specific
399 * @timeout_ms: Time to wait for a response.
400 * @retries: Number of times to retry a request for a response. For MADs
401 * using RMPP, this applies per window. On completion, returns the number
402 * of retries needed to complete the transfer.
404 * Users are responsible for initializing the MAD buffer itself, with the
405 * exception of any RMPP header. Additional segment buffer space allocated
406 * beyond data_len is padding.
408 struct ib_mad_send_buf
{
409 struct ib_mad_send_buf
*next
;
411 struct ib_mad_agent
*mad_agent
;
424 * ib_response_mad - Returns if the specified MAD has been generated in
425 * response to a sent request or trap.
427 int ib_response_mad(const struct ib_mad_hdr
*hdr
);
430 * ib_get_rmpp_resptime - Returns the RMPP response time.
431 * @rmpp_hdr: An RMPP header.
433 static inline u8
ib_get_rmpp_resptime(struct ib_rmpp_hdr
*rmpp_hdr
)
435 return rmpp_hdr
->rmpp_rtime_flags
>> 3;
439 * ib_get_rmpp_flags - Returns the RMPP flags.
440 * @rmpp_hdr: An RMPP header.
442 static inline u8
ib_get_rmpp_flags(struct ib_rmpp_hdr
*rmpp_hdr
)
444 return rmpp_hdr
->rmpp_rtime_flags
& 0x7;
448 * ib_set_rmpp_resptime - Sets the response time in an RMPP header.
449 * @rmpp_hdr: An RMPP header.
450 * @rtime: The response time to set.
452 static inline void ib_set_rmpp_resptime(struct ib_rmpp_hdr
*rmpp_hdr
, u8 rtime
)
454 rmpp_hdr
->rmpp_rtime_flags
= ib_get_rmpp_flags(rmpp_hdr
) | (rtime
<< 3);
458 * ib_set_rmpp_flags - Sets the flags in an RMPP header.
459 * @rmpp_hdr: An RMPP header.
460 * @flags: The flags to set.
462 static inline void ib_set_rmpp_flags(struct ib_rmpp_hdr
*rmpp_hdr
, u8 flags
)
464 rmpp_hdr
->rmpp_rtime_flags
= (rmpp_hdr
->rmpp_rtime_flags
& 0xF8) |
469 struct ib_mad_send_wc
;
470 struct ib_mad_recv_wc
;
473 * ib_mad_send_handler - callback handler for a sent MAD.
474 * @mad_agent: MAD agent that sent the MAD.
475 * @mad_send_wc: Send work completion information on the sent MAD.
477 typedef void (*ib_mad_send_handler
)(struct ib_mad_agent
*mad_agent
,
478 struct ib_mad_send_wc
*mad_send_wc
);
481 * ib_mad_snoop_handler - Callback handler for snooping sent MADs.
482 * @mad_agent: MAD agent that snooped the MAD.
483 * @send_buf: send MAD data buffer.
484 * @mad_send_wc: Work completion information on the sent MAD. Valid
485 * only for snooping that occurs on a send completion.
487 * Clients snooping MADs should not modify data referenced by the @send_buf
490 typedef void (*ib_mad_snoop_handler
)(struct ib_mad_agent
*mad_agent
,
491 struct ib_mad_send_buf
*send_buf
,
492 struct ib_mad_send_wc
*mad_send_wc
);
495 * ib_mad_recv_handler - callback handler for a received MAD.
496 * @mad_agent: MAD agent requesting the received MAD.
497 * @send_buf: Send buffer if found, else NULL
498 * @mad_recv_wc: Received work completion information on the received MAD.
500 * MADs received in response to a send request operation will be handed to
501 * the user before the send operation completes. All data buffers given
502 * to registered agents through this routine are owned by the receiving
503 * client, except for snooping agents. Clients snooping MADs should not
504 * modify the data referenced by @mad_recv_wc.
506 typedef void (*ib_mad_recv_handler
)(struct ib_mad_agent
*mad_agent
,
507 struct ib_mad_send_buf
*send_buf
,
508 struct ib_mad_recv_wc
*mad_recv_wc
);
511 * ib_mad_agent - Used to track MAD registration with the access layer.
512 * @device: Reference to device registration is on.
513 * @qp: Reference to QP used for sending and receiving MADs.
514 * @mr: Memory region for system memory usable for DMA.
515 * @recv_handler: Callback handler for a received MAD.
516 * @send_handler: Callback handler for a sent MAD.
517 * @snoop_handler: Callback handler for snooped sent MADs.
518 * @context: User-specified context associated with this registration.
519 * @hi_tid: Access layer assigned transaction ID for this client.
520 * Unsolicited MADs sent by this client will have the upper 32-bits
521 * of their TID set to this value.
522 * @flags: registration flags
523 * @port_num: Port number on which QP is registered
524 * @rmpp_version: If set, indicates the RMPP version used by this agent.
527 IB_MAD_USER_RMPP
= IB_USER_MAD_USER_RMPP
,
529 struct ib_mad_agent
{
530 struct ib_device
*device
;
532 ib_mad_recv_handler recv_handler
;
533 ib_mad_send_handler send_handler
;
534 ib_mad_snoop_handler snoop_handler
;
543 * ib_mad_send_wc - MAD send completion information.
544 * @send_buf: Send MAD data buffer associated with the send MAD request.
545 * @status: Completion status.
546 * @vendor_err: Optional vendor error information returned with a failed
549 struct ib_mad_send_wc
{
550 struct ib_mad_send_buf
*send_buf
;
551 enum ib_wc_status status
;
556 * ib_mad_recv_buf - received MAD buffer information.
557 * @list: Reference to next data buffer for a received RMPP MAD.
558 * @grh: References a data buffer containing the global route header.
559 * The data refereced by this buffer is only valid if the GRH is
561 * @mad: References the start of the received MAD.
563 struct ib_mad_recv_buf
{
564 struct list_head list
;
568 struct opa_mad
*opa_mad
;
573 * ib_mad_recv_wc - received MAD information.
574 * @wc: Completion information for the received data.
575 * @recv_buf: Specifies the location of the received data buffer(s).
576 * @rmpp_list: Specifies a list of RMPP reassembled received MAD buffers.
577 * @mad_len: The length of the received MAD, without duplicated headers.
578 * @mad_seg_size: The size of individual MAD segments
580 * For received response, the wr_id contains a pointer to the ib_mad_send_buf
581 * for the corresponding send request.
583 struct ib_mad_recv_wc
{
585 struct ib_mad_recv_buf recv_buf
;
586 struct list_head rmpp_list
;
592 * ib_mad_reg_req - MAD registration request
593 * @mgmt_class: Indicates which management class of MADs should be receive
594 * by the caller. This field is only required if the user wishes to
595 * receive unsolicited MADs, otherwise it should be 0.
596 * @mgmt_class_version: Indicates which version of MADs for the given
597 * management class to receive.
598 * @oui: Indicates IEEE OUI when mgmt_class is a vendor class
599 * in the range from 0x30 to 0x4f. Otherwise not used.
600 * @method_mask: The caller will receive unsolicited MADs for any method
601 * where @method_mask = 1.
604 struct ib_mad_reg_req
{
606 u8 mgmt_class_version
;
608 DECLARE_BITMAP(method_mask
, IB_MGMT_MAX_METHODS
);
612 * ib_register_mad_agent - Register to send/receive MADs.
613 * @device: The device to register with.
614 * @port_num: The port on the specified device to use.
615 * @qp_type: Specifies which QP to access. Must be either
616 * IB_QPT_SMI or IB_QPT_GSI.
617 * @mad_reg_req: Specifies which unsolicited MADs should be received
618 * by the caller. This parameter may be NULL if the caller only
619 * wishes to receive solicited responses.
620 * @rmpp_version: If set, indicates that the client will send
621 * and receive MADs that contain the RMPP header for the given version.
622 * If set to 0, indicates that RMPP is not used by this client.
623 * @send_handler: The completion callback routine invoked after a send
624 * request has completed.
625 * @recv_handler: The completion callback routine invoked for a received
627 * @context: User specified context associated with the registration.
628 * @registration_flags: Registration flags to set for this agent
630 struct ib_mad_agent
*ib_register_mad_agent(struct ib_device
*device
,
632 enum ib_qp_type qp_type
,
633 struct ib_mad_reg_req
*mad_reg_req
,
635 ib_mad_send_handler send_handler
,
636 ib_mad_recv_handler recv_handler
,
638 u32 registration_flags
);
640 enum ib_mad_snoop_flags
{
641 /*IB_MAD_SNOOP_POSTED_SENDS = 1,*/
642 /*IB_MAD_SNOOP_RMPP_SENDS = (1<<1),*/
643 IB_MAD_SNOOP_SEND_COMPLETIONS
= (1<<2),
644 /*IB_MAD_SNOOP_RMPP_SEND_COMPLETIONS = (1<<3),*/
645 IB_MAD_SNOOP_RECVS
= (1<<4)
646 /*IB_MAD_SNOOP_RMPP_RECVS = (1<<5),*/
647 /*IB_MAD_SNOOP_REDIRECTED_QPS = (1<<6)*/
651 * ib_register_mad_snoop - Register to snoop sent and received MADs.
652 * @device: The device to register with.
653 * @port_num: The port on the specified device to use.
654 * @qp_type: Specifies which QP traffic to snoop. Must be either
655 * IB_QPT_SMI or IB_QPT_GSI.
656 * @mad_snoop_flags: Specifies information where snooping occurs.
657 * @send_handler: The callback routine invoked for a snooped send.
658 * @recv_handler: The callback routine invoked for a snooped receive.
659 * @context: User specified context associated with the registration.
661 struct ib_mad_agent
*ib_register_mad_snoop(struct ib_device
*device
,
663 enum ib_qp_type qp_type
,
665 ib_mad_snoop_handler snoop_handler
,
666 ib_mad_recv_handler recv_handler
,
670 * ib_unregister_mad_agent - Unregisters a client from using MAD services.
671 * @mad_agent: Corresponding MAD registration request to deregister.
673 * After invoking this routine, MAD services are no longer usable by the
674 * client on the associated QP.
676 int ib_unregister_mad_agent(struct ib_mad_agent
*mad_agent
);
679 * ib_post_send_mad - Posts MAD(s) to the send queue of the QP associated
680 * with the registered client.
681 * @send_buf: Specifies the information needed to send the MAD(s).
682 * @bad_send_buf: Specifies the MAD on which an error was encountered. This
683 * parameter is optional if only a single MAD is posted.
685 * Sent MADs are not guaranteed to complete in the order that they were posted.
687 * If the MAD requires RMPP, the data buffer should contain a single copy
688 * of the common MAD, RMPP, and class specific headers, followed by the class
689 * defined data. If the class defined data would not divide evenly into
690 * RMPP segments, then space must be allocated at the end of the referenced
691 * buffer for any required padding. To indicate the amount of class defined
692 * data being transferred, the paylen_newwin field in the RMPP header should
693 * be set to the size of the class specific header plus the amount of class
694 * defined data being transferred. The paylen_newwin field should be
695 * specified in network-byte order.
697 int ib_post_send_mad(struct ib_mad_send_buf
*send_buf
,
698 struct ib_mad_send_buf
**bad_send_buf
);
702 * ib_free_recv_mad - Returns data buffers used to receive a MAD.
703 * @mad_recv_wc: Work completion information for a received MAD.
705 * Clients receiving MADs through their ib_mad_recv_handler must call this
706 * routine to return the work completion buffers to the access layer.
708 void ib_free_recv_mad(struct ib_mad_recv_wc
*mad_recv_wc
);
711 * ib_cancel_mad - Cancels an outstanding send MAD operation.
712 * @mad_agent: Specifies the registration associated with sent MAD.
713 * @send_buf: Indicates the MAD to cancel.
715 * MADs will be returned to the user through the corresponding
716 * ib_mad_send_handler.
718 void ib_cancel_mad(struct ib_mad_agent
*mad_agent
,
719 struct ib_mad_send_buf
*send_buf
);
722 * ib_modify_mad - Modifies an outstanding send MAD operation.
723 * @mad_agent: Specifies the registration associated with sent MAD.
724 * @send_buf: Indicates the MAD to modify.
725 * @timeout_ms: New timeout value for sent MAD.
727 * This call will reset the timeout value for a sent MAD to the specified
730 int ib_modify_mad(struct ib_mad_agent
*mad_agent
,
731 struct ib_mad_send_buf
*send_buf
, u32 timeout_ms
);
734 * ib_redirect_mad_qp - Registers a QP for MAD services.
735 * @qp: Reference to a QP that requires MAD services.
736 * @rmpp_version: If set, indicates that the client will send
737 * and receive MADs that contain the RMPP header for the given version.
738 * If set to 0, indicates that RMPP is not used by this client.
739 * @send_handler: The completion callback routine invoked after a send
740 * request has completed.
741 * @recv_handler: The completion callback routine invoked for a received
743 * @context: User specified context associated with the registration.
745 * Use of this call allows clients to use MAD services, such as RMPP,
746 * on user-owned QPs. After calling this routine, users may send
747 * MADs on the specified QP by calling ib_mad_post_send.
749 struct ib_mad_agent
*ib_redirect_mad_qp(struct ib_qp
*qp
,
751 ib_mad_send_handler send_handler
,
752 ib_mad_recv_handler recv_handler
,
756 * ib_process_mad_wc - Processes a work completion associated with a
757 * MAD sent or received on a redirected QP.
758 * @mad_agent: Specifies the registered MAD service using the redirected QP.
759 * @wc: References a work completion associated with a sent or received
762 * This routine is used to complete or continue processing on a MAD request.
763 * If the work completion is associated with a send operation, calling
764 * this routine is required to continue an RMPP transfer or to wait for a
765 * corresponding response, if it is a request. If the work completion is
766 * associated with a receive operation, calling this routine is required to
767 * process an inbound or outbound RMPP transfer, or to match a response MAD
768 * with its corresponding request.
770 int ib_process_mad_wc(struct ib_mad_agent
*mad_agent
,
774 * ib_create_send_mad - Allocate and initialize a data buffer and work request
776 * @mad_agent: Specifies the registered MAD service to associate with the MAD.
777 * @remote_qpn: Specifies the QPN of the receiving node.
778 * @pkey_index: Specifies which PKey the MAD will be sent using. This field
779 * is valid only if the remote_qpn is QP 1.
780 * @rmpp_active: Indicates if the send will enable RMPP.
781 * @hdr_len: Indicates the size of the data header of the MAD. This length
782 * should include the common MAD header, RMPP header, plus any class
784 * @data_len: Indicates the size of any user-transferred data. The call will
785 * automatically adjust the allocated buffer size to account for any
786 * additional padding that may be necessary.
787 * @gfp_mask: GFP mask used for the memory allocation.
788 * @base_version: Base Version of this MAD
790 * This routine allocates a MAD for sending. The returned MAD send buffer
791 * will reference a data buffer usable for sending a MAD, along
792 * with an initialized work request structure. Users may modify the returned
793 * MAD data buffer before posting the send.
795 * The returned MAD header, class specific headers, and any padding will be
796 * cleared. Users are responsible for initializing the common MAD header,
797 * any class specific header, and MAD data area.
798 * If @rmpp_active is set, the RMPP header will be initialized for sending.
800 struct ib_mad_send_buf
*ib_create_send_mad(struct ib_mad_agent
*mad_agent
,
801 u32 remote_qpn
, u16 pkey_index
,
803 int hdr_len
, int data_len
,
808 * ib_is_mad_class_rmpp - returns whether given management class
810 * @mgmt_class: management class
812 * This routine returns whether the management class supports RMPP.
814 int ib_is_mad_class_rmpp(u8 mgmt_class
);
817 * ib_get_mad_data_offset - returns the data offset for a given
819 * @mgmt_class: management class
821 * This routine returns the data offset in the MAD for the management
824 int ib_get_mad_data_offset(u8 mgmt_class
);
827 * ib_get_rmpp_segment - returns the data buffer for a given RMPP segment.
828 * @send_buf: Previously allocated send data buffer.
829 * @seg_num: number of segment to return
831 * This routine returns a pointer to the data buffer of an RMPP MAD.
832 * Users must provide synchronization to @send_buf around this call.
834 void *ib_get_rmpp_segment(struct ib_mad_send_buf
*send_buf
, int seg_num
);
837 * ib_free_send_mad - Returns data buffers used to send a MAD.
838 * @send_buf: Previously allocated send data buffer.
840 void ib_free_send_mad(struct ib_mad_send_buf
*send_buf
);
843 * ib_mad_kernel_rmpp_agent - Returns if the agent is performing RMPP.
844 * @agent: the agent in question
845 * @return: true if agent is performing rmpp, false otherwise.
847 int ib_mad_kernel_rmpp_agent(const struct ib_mad_agent
*agent
);
849 #endif /* IB_MAD_H */