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