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