2 * Copyright (c) 2004 Topspin Communications. All rights reserved.
3 * Copyright (c) 2005 Voltaire, Inc. All rights reserved.
5 * This software is available to you under a choice of one of two
6 * licenses. You may choose to be licensed under the terms of the GNU
7 * General Public License (GPL) Version 2, available from the file
8 * COPYING in the main directory of this source tree, or the
9 * OpenIB.org BSD license below:
11 * Redistribution and use in source and binary forms, with or
12 * without modification, are permitted provided that the following
15 * - Redistributions of source code must retain the above
16 * copyright notice, this list of conditions and the following
19 * - Redistributions in binary form must reproduce the above
20 * copyright notice, this list of conditions and the following
21 * disclaimer in the documentation and/or other materials
22 * provided with the distribution.
24 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
25 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
26 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
27 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
28 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
29 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
30 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
33 * $Id: ib_user_mad.h 2814 2005-07-06 19:14:09Z halr $
42 * Increment this value if any changes that break userspace ABI
43 * compatibility are made.
45 #define IB_USER_MAD_ABI_VERSION 5
48 * Make sure that all structs defined in this file remain laid out so
49 * that they pack the same way on 32-bit and 64-bit architectures (to
50 * avoid incompatibility between 32-bit userspace and 64-bit kernels).
54 * ib_user_mad_hdr - MAD packet header
55 * @id - ID of agent MAD received with/to be sent with
56 * @status - 0 on successful receive, ETIMEDOUT if no response
57 * received (transaction ID in data[] will be set to TID of original
58 * request) (ignored on send)
59 * @timeout_ms - Milliseconds to wait for response (unset on receive)
60 * @retries - Number of automatic retries to attempt
61 * @qpn - Remote QP number received from/to be sent to
62 * @qkey - Remote Q_Key to be sent with (unset on receive)
63 * @lid - Remote lid received from/to be sent to
64 * @sl - Service level received with/to be sent with
65 * @path_bits - Local path bits received with/to be sent with
66 * @grh_present - If set, GRH was received/should be sent
67 * @gid_index - Local GID index to send with (unset on receive)
68 * @hop_limit - Hop limit in GRH
69 * @traffic_class - Traffic class in GRH
70 * @gid - Remote GID in GRH
71 * @flow_label - Flow label in GRH
73 struct ib_user_mad_hdr {
93 * ib_user_mad - MAD packet
94 * @hdr - MAD packet header
95 * @data - Contents of MAD
99 struct ib_user_mad_hdr hdr;
104 * ib_user_mad_reg_req - MAD registration request
105 * @id - Set by the kernel; used to identify agent in future requests.
106 * @qpn - Queue pair number; must be 0 or 1.
107 * @method_mask - The caller will receive unsolicited MADs for any method
108 * where @method_mask = 1.
109 * @mgmt_class - Indicates which management class of MADs should be receive
110 * by the caller. This field is only required if the user wishes to
111 * receive unsolicited MADs, otherwise it should be 0.
112 * @mgmt_class_version - Indicates which version of MADs for the given
113 * management class to receive.
114 * @oui: Indicates IEEE OUI when mgmt_class is a vendor class
115 * in the range from 0x30 to 0x4f. Otherwise not used.
116 * @rmpp_version: If set, indicates the RMPP version used.
119 struct ib_user_mad_reg_req {
121 __u32 method_mask[4];
124 __u8 mgmt_class_version;
129 #define IB_IOCTL_MAGIC 0x1b
131 #define IB_USER_MAD_REGISTER_AGENT _IOWR(IB_IOCTL_MAGIC, 1, \
132 struct ib_user_mad_reg_req)
134 #define IB_USER_MAD_UNREGISTER_AGENT _IOW(IB_IOCTL_MAGIC, 2, __u32)
136 #endif /* IB_USER_MAD_H */