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.
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
36 * $Id: ib_mad.h 2775 2005-07-02 13:42:12Z halr $
39 #if !defined( IB_MAD_H )
42 #include <linux/pci.h>
44 #include <rdma/ib_verbs.h>
46 /* Management base version */
47 #define IB_MGMT_BASE_VERSION 1
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
61 #define IB_OPENIB_OUI (0x001405)
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
73 #define IB_MGMT_METHOD_RESP 0x80
75 #define IB_MGMT_MAX_METHODS 128
77 /* RMPP information */
78 #define IB_MGMT_RMPP_VERSION 1
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
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)
89 #define IB_MGMT_RMPP_NO_RESPTIME 0x1F
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
107 #define IB_QP1 __constant_htonl(1)
108 #define IB_QP1_QKEY 0x80010000
109 #define IB_QP_SET_QKEY 0x80000000
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,
119 IB_MGMT_SA_DATA
= 200,
128 __be16 class_specific
;
141 __be32 paylen_newwin
;
144 typedef u64 __bitwise ib_sa_comp_mask
;
146 #define IB_SA_COMP_MASK(n) ((__force ib_sa_comp_mask) cpu_to_be64(1ull << n))
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)
158 ib_sa_comp_mask comp_mask
;
159 } __attribute__ ((packed
));
162 struct ib_mad_hdr mad_hdr
;
163 u8 data
[IB_MGMT_MAD_DATA
];
167 struct ib_mad_hdr mad_hdr
;
168 struct ib_rmpp_hdr rmpp_hdr
;
169 u8 data
[IB_MGMT_RMPP_DATA
];
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
));
179 struct ib_vendor_mad
{
180 struct ib_mad_hdr mad_hdr
;
181 struct ib_rmpp_hdr rmpp_hdr
;
184 u8 data
[IB_MGMT_VENDOR_DATA
];
187 struct ib_class_port_info
191 __be16 capability_mask
;
195 __be32 redirect_tcslfl
;
197 __be16 redirect_pkey
;
199 __be32 redirect_qkey
;
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.
212 * @mad_agent: MAD agent that allocated the buffer.
213 * @ah: The address handle to use when sending the MAD.
214 * @context: User-controlled context fields.
215 * @timeout_ms: Time to wait for a response.
216 * @retries: Number of times to retry a request for a response.
218 * Users are responsible for initializing the MAD buffer itself, with the
219 * exception of specifying the payload length field in any RMPP MAD.
221 struct ib_mad_send_buf
{
222 struct ib_mad_send_buf
*next
;
224 struct ib_mad_agent
*mad_agent
;
232 * ib_get_rmpp_resptime - Returns the RMPP response time.
233 * @rmpp_hdr: An RMPP header.
235 static inline u8
ib_get_rmpp_resptime(struct ib_rmpp_hdr
*rmpp_hdr
)
237 return rmpp_hdr
->rmpp_rtime_flags
>> 3;
241 * ib_get_rmpp_flags - Returns the RMPP flags.
242 * @rmpp_hdr: An RMPP header.
244 static inline u8
ib_get_rmpp_flags(struct ib_rmpp_hdr
*rmpp_hdr
)
246 return rmpp_hdr
->rmpp_rtime_flags
& 0x7;
250 * ib_set_rmpp_resptime - Sets the response time in an RMPP header.
251 * @rmpp_hdr: An RMPP header.
252 * @rtime: The response time to set.
254 static inline void ib_set_rmpp_resptime(struct ib_rmpp_hdr
*rmpp_hdr
, u8 rtime
)
256 rmpp_hdr
->rmpp_rtime_flags
= ib_get_rmpp_flags(rmpp_hdr
) | (rtime
<< 3);
260 * ib_set_rmpp_flags - Sets the flags in an RMPP header.
261 * @rmpp_hdr: An RMPP header.
262 * @flags: The flags to set.
264 static inline void ib_set_rmpp_flags(struct ib_rmpp_hdr
*rmpp_hdr
, u8 flags
)
266 rmpp_hdr
->rmpp_rtime_flags
= (rmpp_hdr
->rmpp_rtime_flags
& 0xF1) |
271 struct ib_mad_send_wc
;
272 struct ib_mad_recv_wc
;
275 * ib_mad_send_handler - callback handler for a sent MAD.
276 * @mad_agent: MAD agent that sent the MAD.
277 * @mad_send_wc: Send work completion information on the sent MAD.
279 typedef void (*ib_mad_send_handler
)(struct ib_mad_agent
*mad_agent
,
280 struct ib_mad_send_wc
*mad_send_wc
);
283 * ib_mad_snoop_handler - Callback handler for snooping sent MADs.
284 * @mad_agent: MAD agent that snooped the MAD.
285 * @send_wr: Work request information on the sent MAD.
286 * @mad_send_wc: Work completion information on the sent MAD. Valid
287 * only for snooping that occurs on a send completion.
289 * Clients snooping MADs should not modify data referenced by the @send_wr
292 typedef void (*ib_mad_snoop_handler
)(struct ib_mad_agent
*mad_agent
,
293 struct ib_mad_send_buf
*send_buf
,
294 struct ib_mad_send_wc
*mad_send_wc
);
297 * ib_mad_recv_handler - callback handler for a received MAD.
298 * @mad_agent: MAD agent requesting the received MAD.
299 * @mad_recv_wc: Received work completion information on the received MAD.
301 * MADs received in response to a send request operation will be handed to
302 * the user after the send operation completes. All data buffers given
303 * to registered agents through this routine are owned by the receiving
304 * client, except for snooping agents. Clients snooping MADs should not
305 * modify the data referenced by @mad_recv_wc.
307 typedef void (*ib_mad_recv_handler
)(struct ib_mad_agent
*mad_agent
,
308 struct ib_mad_recv_wc
*mad_recv_wc
);
311 * ib_mad_agent - Used to track MAD registration with the access layer.
312 * @device: Reference to device registration is on.
313 * @qp: Reference to QP used for sending and receiving MADs.
314 * @mr: Memory region for system memory usable for DMA.
315 * @recv_handler: Callback handler for a received MAD.
316 * @send_handler: Callback handler for a sent MAD.
317 * @snoop_handler: Callback handler for snooped sent MADs.
318 * @context: User-specified context associated with this registration.
319 * @hi_tid: Access layer assigned transaction ID for this client.
320 * Unsolicited MADs sent by this client will have the upper 32-bits
321 * of their TID set to this value.
322 * @port_num: Port number on which QP is registered
323 * @rmpp_version: If set, indicates the RMPP version used by this agent.
325 struct ib_mad_agent
{
326 struct ib_device
*device
;
329 ib_mad_recv_handler recv_handler
;
330 ib_mad_send_handler send_handler
;
331 ib_mad_snoop_handler snoop_handler
;
339 * ib_mad_send_wc - MAD send completion information.
340 * @send_buf: Send MAD data buffer associated with the send MAD request.
341 * @status: Completion status.
342 * @vendor_err: Optional vendor error information returned with a failed
345 struct ib_mad_send_wc
{
346 struct ib_mad_send_buf
*send_buf
;
347 enum ib_wc_status status
;
352 * ib_mad_recv_buf - received MAD buffer information.
353 * @list: Reference to next data buffer for a received RMPP MAD.
354 * @grh: References a data buffer containing the global route header.
355 * The data refereced by this buffer is only valid if the GRH is
357 * @mad: References the start of the received MAD.
359 struct ib_mad_recv_buf
{
360 struct list_head list
;
366 * ib_mad_recv_wc - received MAD information.
367 * @wc: Completion information for the received data.
368 * @recv_buf: Specifies the location of the received data buffer(s).
369 * @rmpp_list: Specifies a list of RMPP reassembled received MAD buffers.
370 * @mad_len: The length of the received MAD, without duplicated headers.
372 * For received response, the wr_id contains a pointer to the ib_mad_send_buf
373 * for the corresponding send request.
375 struct ib_mad_recv_wc
{
377 struct ib_mad_recv_buf recv_buf
;
378 struct list_head rmpp_list
;
383 * ib_mad_reg_req - MAD registration request
384 * @mgmt_class: Indicates which management class of MADs should be receive
385 * by the caller. This field is only required if the user wishes to
386 * receive unsolicited MADs, otherwise it should be 0.
387 * @mgmt_class_version: Indicates which version of MADs for the given
388 * management class to receive.
389 * @oui: Indicates IEEE OUI when mgmt_class is a vendor class
390 * in the range from 0x30 to 0x4f. Otherwise not used.
391 * @method_mask: The caller will receive unsolicited MADs for any method
392 * where @method_mask = 1.
394 struct ib_mad_reg_req
{
396 u8 mgmt_class_version
;
398 DECLARE_BITMAP(method_mask
, IB_MGMT_MAX_METHODS
);
402 * ib_register_mad_agent - Register to send/receive MADs.
403 * @device: The device to register with.
404 * @port_num: The port on the specified device to use.
405 * @qp_type: Specifies which QP to access. Must be either
406 * IB_QPT_SMI or IB_QPT_GSI.
407 * @mad_reg_req: Specifies which unsolicited MADs should be received
408 * by the caller. This parameter may be NULL if the caller only
409 * wishes to receive solicited responses.
410 * @rmpp_version: If set, indicates that the client will send
411 * and receive MADs that contain the RMPP header for the given version.
412 * If set to 0, indicates that RMPP is not used by this client.
413 * @send_handler: The completion callback routine invoked after a send
414 * request has completed.
415 * @recv_handler: The completion callback routine invoked for a received
417 * @context: User specified context associated with the registration.
419 struct ib_mad_agent
*ib_register_mad_agent(struct ib_device
*device
,
421 enum ib_qp_type qp_type
,
422 struct ib_mad_reg_req
*mad_reg_req
,
424 ib_mad_send_handler send_handler
,
425 ib_mad_recv_handler recv_handler
,
428 enum ib_mad_snoop_flags
{
429 /*IB_MAD_SNOOP_POSTED_SENDS = 1,*/
430 /*IB_MAD_SNOOP_RMPP_SENDS = (1<<1),*/
431 IB_MAD_SNOOP_SEND_COMPLETIONS
= (1<<2),
432 /*IB_MAD_SNOOP_RMPP_SEND_COMPLETIONS = (1<<3),*/
433 IB_MAD_SNOOP_RECVS
= (1<<4)
434 /*IB_MAD_SNOOP_RMPP_RECVS = (1<<5),*/
435 /*IB_MAD_SNOOP_REDIRECTED_QPS = (1<<6)*/
439 * ib_register_mad_snoop - Register to snoop sent and received MADs.
440 * @device: The device to register with.
441 * @port_num: The port on the specified device to use.
442 * @qp_type: Specifies which QP traffic to snoop. Must be either
443 * IB_QPT_SMI or IB_QPT_GSI.
444 * @mad_snoop_flags: Specifies information where snooping occurs.
445 * @send_handler: The callback routine invoked for a snooped send.
446 * @recv_handler: The callback routine invoked for a snooped receive.
447 * @context: User specified context associated with the registration.
449 struct ib_mad_agent
*ib_register_mad_snoop(struct ib_device
*device
,
451 enum ib_qp_type qp_type
,
453 ib_mad_snoop_handler snoop_handler
,
454 ib_mad_recv_handler recv_handler
,
458 * ib_unregister_mad_agent - Unregisters a client from using MAD services.
459 * @mad_agent: Corresponding MAD registration request to deregister.
461 * After invoking this routine, MAD services are no longer usable by the
462 * client on the associated QP.
464 int ib_unregister_mad_agent(struct ib_mad_agent
*mad_agent
);
467 * ib_post_send_mad - Posts MAD(s) to the send queue of the QP associated
468 * with the registered client.
469 * @send_buf: Specifies the information needed to send the MAD(s).
470 * @bad_send_buf: Specifies the MAD on which an error was encountered. This
471 * parameter is optional if only a single MAD is posted.
473 * Sent MADs are not guaranteed to complete in the order that they were posted.
475 * If the MAD requires RMPP, the data buffer should contain a single copy
476 * of the common MAD, RMPP, and class specific headers, followed by the class
477 * defined data. If the class defined data would not divide evenly into
478 * RMPP segments, then space must be allocated at the end of the referenced
479 * buffer for any required padding. To indicate the amount of class defined
480 * data being transferred, the paylen_newwin field in the RMPP header should
481 * be set to the size of the class specific header plus the amount of class
482 * defined data being transferred. The paylen_newwin field should be
483 * specified in network-byte order.
485 int ib_post_send_mad(struct ib_mad_send_buf
*send_buf
,
486 struct ib_mad_send_buf
**bad_send_buf
);
489 * ib_coalesce_recv_mad - Coalesces received MAD data into a single buffer.
490 * @mad_recv_wc: Work completion information for a received MAD.
491 * @buf: User-provided data buffer to receive the coalesced buffers. The
492 * referenced buffer should be at least the size of the mad_len specified
495 * This call copies a chain of received MAD segments into a single data buffer,
496 * removing duplicated headers.
498 void ib_coalesce_recv_mad(struct ib_mad_recv_wc
*mad_recv_wc
, void *buf
);
501 * ib_free_recv_mad - Returns data buffers used to receive a MAD.
502 * @mad_recv_wc: Work completion information for a received MAD.
504 * Clients receiving MADs through their ib_mad_recv_handler must call this
505 * routine to return the work completion buffers to the access layer.
507 void ib_free_recv_mad(struct ib_mad_recv_wc
*mad_recv_wc
);
510 * ib_cancel_mad - Cancels an outstanding send MAD operation.
511 * @mad_agent: Specifies the registration associated with sent MAD.
512 * @send_buf: Indicates the MAD to cancel.
514 * MADs will be returned to the user through the corresponding
515 * ib_mad_send_handler.
517 void ib_cancel_mad(struct ib_mad_agent
*mad_agent
,
518 struct ib_mad_send_buf
*send_buf
);
521 * ib_modify_mad - Modifies an outstanding send MAD operation.
522 * @mad_agent: Specifies the registration associated with sent MAD.
523 * @send_buf: Indicates the MAD to modify.
524 * @timeout_ms: New timeout value for sent MAD.
526 * This call will reset the timeout value for a sent MAD to the specified
529 int ib_modify_mad(struct ib_mad_agent
*mad_agent
,
530 struct ib_mad_send_buf
*send_buf
, u32 timeout_ms
);
533 * ib_redirect_mad_qp - Registers a QP for MAD services.
534 * @qp: Reference to a QP that requires MAD services.
535 * @rmpp_version: If set, indicates that the client will send
536 * and receive MADs that contain the RMPP header for the given version.
537 * If set to 0, indicates that RMPP is not used by this client.
538 * @send_handler: The completion callback routine invoked after a send
539 * request has completed.
540 * @recv_handler: The completion callback routine invoked for a received
542 * @context: User specified context associated with the registration.
544 * Use of this call allows clients to use MAD services, such as RMPP,
545 * on user-owned QPs. After calling this routine, users may send
546 * MADs on the specified QP by calling ib_mad_post_send.
548 struct ib_mad_agent
*ib_redirect_mad_qp(struct ib_qp
*qp
,
550 ib_mad_send_handler send_handler
,
551 ib_mad_recv_handler recv_handler
,
555 * ib_process_mad_wc - Processes a work completion associated with a
556 * MAD sent or received on a redirected QP.
557 * @mad_agent: Specifies the registered MAD service using the redirected QP.
558 * @wc: References a work completion associated with a sent or received
561 * This routine is used to complete or continue processing on a MAD request.
562 * If the work completion is associated with a send operation, calling
563 * this routine is required to continue an RMPP transfer or to wait for a
564 * corresponding response, if it is a request. If the work completion is
565 * associated with a receive operation, calling this routine is required to
566 * process an inbound or outbound RMPP transfer, or to match a response MAD
567 * with its corresponding request.
569 int ib_process_mad_wc(struct ib_mad_agent
*mad_agent
,
573 * ib_create_send_mad - Allocate and initialize a data buffer and work request
575 * @mad_agent: Specifies the registered MAD service to associate with the MAD.
576 * @remote_qpn: Specifies the QPN of the receiving node.
577 * @pkey_index: Specifies which PKey the MAD will be sent using. This field
578 * is valid only if the remote_qpn is QP 1.
579 * @rmpp_active: Indicates if the send will enable RMPP.
580 * @hdr_len: Indicates the size of the data header of the MAD. This length
581 * should include the common MAD header, RMPP header, plus any class
583 * @data_len: Indicates the size of any user-transferred data. The call will
584 * automatically adjust the allocated buffer size to account for any
585 * additional padding that may be necessary.
586 * @gfp_mask: GFP mask used for the memory allocation.
588 * This routine allocates a MAD for sending. The returned MAD send buffer
589 * will reference a data buffer usable for sending a MAD, along
590 * with an initialized work request structure. Users may modify the returned
591 * MAD data buffer before posting the send.
593 * The returned data buffer will be cleared. Users are responsible for
594 * initializing the common MAD and any class specific headers. If @rmpp_active
595 * is set, the RMPP header will be initialized for sending.
597 struct ib_mad_send_buf
* ib_create_send_mad(struct ib_mad_agent
*mad_agent
,
598 u32 remote_qpn
, u16 pkey_index
,
600 int hdr_len
, int data_len
,
604 * ib_free_send_mad - Returns data buffers used to send a MAD.
605 * @send_buf: Previously allocated send data buffer.
607 void ib_free_send_mad(struct ib_mad_send_buf
*send_buf
);
609 #endif /* IB_MAD_H */