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