---

---

---

001: /*
002:  * Copyright (c) 2004 Topspin Communications.  All rights reserved.
003:  * Copyright (c) 2005 Voltaire, Inc. All rights reserved.
004:  *
005:  * This software is available to you under a choice of one of two
006:  * licenses.  You may choose to be licensed under the terms of the GNU
007:  * General Public License (GPL) Version 2, available from the file
008:  * COPYING in the main directory of this source tree, or the
009:  * OpenIB.org BSD license below:
010:  *
011:  *     Redistribution and use in source and binary forms, with or
012:  *     without modification, are permitted provided that the following
013:  *     conditions are met:
014:  *
015:  *      - Redistributions of source code must retain the above
016:  *        copyright notice, this list of conditions and the following
017:  *        disclaimer.
018:  *
019:  *      - Redistributions in binary form must reproduce the above
020:  *        copyright notice, this list of conditions and the following
021:  *        disclaimer in the documentation and/or other materials
022:  *        provided with the distribution.
023:  *
024:  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
025:  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
026:  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
027:  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
028:  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
029:  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
030:  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
031:  * SOFTWARE.
032:  */
033: 
034: #ifndef IB_USER_MAD_H
035: #define IB_USER_MAD_H
036: 
037: #include <linux/types.h>
038: #include <linux/ioctl.h>
039: 
040: /*
041:  * Increment this value if any changes that break userspace ABI
042:  * compatibility are made.
043:  */
044: #define IB_USER_MAD_ABI_VERSION 5
045: 
046: /*
047:  * Make sure that all structs defined in this file remain laid out so
048:  * that they pack the same way on 32-bit and 64-bit architectures (to
049:  * avoid incompatibility between 32-bit userspace and 64-bit kernels).
050:  */
051: 
052: /**
053:  * ib_user_mad_hdr_old - Old version of MAD packet header without pkey_index
054:  * @id - ID of agent MAD received with/to be sent with
055:  * @status - 0 on successful receive, ETIMEDOUT if no response
056:  *   received (transaction ID in data[] will be set to TID of original
057:  *   request) (ignored on send)
058:  * @timeout_ms - Milliseconds to wait for response (unset on receive)
059:  * @retries - Number of automatic retries to attempt
060:  * @qpn - Remote QP number received from/to be sent to
061:  * @qkey - Remote Q_Key to be sent with (unset on receive)
062:  * @lid - Remote lid received from/to be sent to
063:  * @sl - Service level received with/to be sent with
064:  * @path_bits - Local path bits received with/to be sent with
065:  * @grh_present - If set, GRH was received/should be sent
066:  * @gid_index - Local GID index to send with (unset on receive)
067:  * @hop_limit - Hop limit in GRH
068:  * @traffic_class - Traffic class in GRH
069:  * @gid - Remote GID in GRH
070:  * @flow_label - Flow label in GRH
071:  */
072: struct ib_user_mad_hdr_old {
073:         __u32   id;
074:         __u32   status;
075:         __u32   timeout_ms;
076:         __u32   retries;
077:         __u32   length;
078:         __be32  qpn;
079:         __be32  qkey;
080:         __be16  lid;
081:         __u8    sl;
082:         __u8    path_bits;
083:         __u8    grh_present;
084:         __u8    gid_index;
085:         __u8    hop_limit;
086:         __u8    traffic_class;
087:         __u8    gid[16];
088:         __be32  flow_label;
089: };
090: 
091: /**
092:  * ib_user_mad_hdr - MAD packet header
093:  *   This layout allows specifying/receiving the P_Key index.  To use
094:  *   this capability, an application must call the
095:  *   IB_USER_MAD_ENABLE_PKEY ioctl on the user MAD file handle before
096:  *   any other actions with the file handle.
097:  * @id - ID of agent MAD received with/to be sent with
098:  * @status - 0 on successful receive, ETIMEDOUT if no response
099:  *   received (transaction ID in data[] will be set to TID of original
100:  *   request) (ignored on send)
101:  * @timeout_ms - Milliseconds to wait for response (unset on receive)
102:  * @retries - Number of automatic retries to attempt
103:  * @qpn - Remote QP number received from/to be sent to
104:  * @qkey - Remote Q_Key to be sent with (unset on receive)
105:  * @lid - Remote lid received from/to be sent to
106:  * @sl - Service level received with/to be sent with
107:  * @path_bits - Local path bits received with/to be sent with
108:  * @grh_present - If set, GRH was received/should be sent
109:  * @gid_index - Local GID index to send with (unset on receive)
110:  * @hop_limit - Hop limit in GRH
111:  * @traffic_class - Traffic class in GRH
112:  * @gid - Remote GID in GRH
113:  * @flow_label - Flow label in GRH
114:  * @pkey_index - P_Key index
115:  */
116: struct ib_user_mad_hdr {
117:         __u32   id;
118:         __u32   status;
119:         __u32   timeout_ms;
120:         __u32   retries;
121:         __u32   length;
122:         __be32  qpn;
123:         __be32  qkey;
124:         __be16  lid;
125:         __u8    sl;
126:         __u8    path_bits;
127:         __u8    grh_present;
128:         __u8    gid_index;
129:         __u8    hop_limit;
130:         __u8    traffic_class;
131:         __u8    gid[16];
132:         __be32  flow_label;
133:         __u16   pkey_index;
134:         __u8    reserved[6];
135: };
136: 
137: /**
138:  * ib_user_mad - MAD packet
139:  * @hdr - MAD packet header
140:  * @data - Contents of MAD
141:  *
142:  */
143: struct ib_user_mad {
144:         struct ib_user_mad_hdr hdr;
145:         __u64   data[0];
146: };
147: 
148: /*
149:  * Earlier versions of this interface definition declared the
150:  * method_mask[] member as an array of __u32 but treated it as a
151:  * bitmap made up of longs in the kernel.  This ambiguity meant that
152:  * 32-bit big-endian applications that can run on both 32-bit and
153:  * 64-bit kernels had no consistent ABI to rely on, and 64-bit
154:  * big-endian applications that treated method_mask as being made up
155:  * of 32-bit words would have their bitmap misinterpreted.
156:  *
157:  * To clear up this confusion, we change the declaration of
158:  * method_mask[] to use unsigned long and handle the conversion from
159:  * 32-bit userspace to 64-bit kernel for big-endian systems in the
160:  * compat_ioctl method.  Unfortunately, to keep the structure layout
161:  * the same, we need the method_mask[] array to be aligned only to 4
162:  * bytes even when long is 64 bits, which forces us into this ugly
163:  * typedef.
164:  */
165: typedef unsigned long __attribute__((aligned(4))) packed_ulong;
166: #define IB_USER_MAD_LONGS_PER_METHOD_MASK (128 / (8 * sizeof (long)))
167: 
168: /**
169:  * ib_user_mad_reg_req - MAD registration request
170:  * @id - Set by the kernel; used to identify agent in future requests.
171:  * @qpn - Queue pair number; must be 0 or 1.
172:  * @method_mask - The caller will receive unsolicited MADs for any method
173:  *   where @method_mask = 1.
174:  * @mgmt_class - Indicates which management class of MADs should be receive
175:  *   by the caller.  This field is only required if the user wishes to
176:  *   receive unsolicited MADs, otherwise it should be 0.
177:  * @mgmt_class_version - Indicates which version of MADs for the given
178:  *   management class to receive.
179:  * @oui: Indicates IEEE OUI when mgmt_class is a vendor class
180:  *   in the range from 0x30 to 0x4f. Otherwise not used.
181:  * @rmpp_version: If set, indicates the RMPP version used.
182:  *
183:  */
184: struct ib_user_mad_reg_req {
185:         __u32   id;
186:         packed_ulong method_mask[IB_USER_MAD_LONGS_PER_METHOD_MASK];
187:         __u8    qpn;
188:         __u8    mgmt_class;
189:         __u8    mgmt_class_version;
190:         __u8    oui[3];
191:         __u8    rmpp_version;
192: };
193: 
194: #define IB_IOCTL_MAGIC          0x1b
195: 
196: #define IB_USER_MAD_REGISTER_AGENT      _IOWR(IB_IOCTL_MAGIC, 1, \
197:                                               struct ib_user_mad_reg_req)
198: 
199: #define IB_USER_MAD_UNREGISTER_AGENT    _IOW(IB_IOCTL_MAGIC, 2, __u32)
200: 
201: #define IB_USER_MAD_ENABLE_PKEY         _IO(IB_IOCTL_MAGIC, 3)
202: 
203: #endif /* IB_USER_MAD_H */
204: 

---

---

---