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_sa.h 2811 2005-07-06 18:11:43Z halr $
39 #include <linux/compiler.h>
41 #include <rdma/ib_verbs.h>
42 #include <rdma/ib_mad.h>
45 IB_SA_CLASS_VERSION
= 2, /* IB spec version 1.1/1.2 */
47 IB_SA_METHOD_GET_TABLE
= 0x12,
48 IB_SA_METHOD_GET_TABLE_RESP
= 0x92,
49 IB_SA_METHOD_DELETE
= 0x15,
50 IB_SA_METHOD_DELETE_RESP
= 0x95,
51 IB_SA_METHOD_GET_MULTI
= 0x14,
52 IB_SA_METHOD_GET_MULTI_RESP
= 0x94,
53 IB_SA_METHOD_GET_TRACE_TBL
= 0x13
57 IB_SA_ATTR_CLASS_PORTINFO
= 0x01,
58 IB_SA_ATTR_NOTICE
= 0x02,
59 IB_SA_ATTR_INFORM_INFO
= 0x03,
60 IB_SA_ATTR_NODE_REC
= 0x11,
61 IB_SA_ATTR_PORT_INFO_REC
= 0x12,
62 IB_SA_ATTR_SL2VL_REC
= 0x13,
63 IB_SA_ATTR_SWITCH_REC
= 0x14,
64 IB_SA_ATTR_LINEAR_FDB_REC
= 0x15,
65 IB_SA_ATTR_RANDOM_FDB_REC
= 0x16,
66 IB_SA_ATTR_MCAST_FDB_REC
= 0x17,
67 IB_SA_ATTR_SM_INFO_REC
= 0x18,
68 IB_SA_ATTR_LINK_REC
= 0x20,
69 IB_SA_ATTR_GUID_INFO_REC
= 0x30,
70 IB_SA_ATTR_SERVICE_REC
= 0x31,
71 IB_SA_ATTR_PARTITION_REC
= 0x33,
72 IB_SA_ATTR_PATH_REC
= 0x35,
73 IB_SA_ATTR_VL_ARB_REC
= 0x36,
74 IB_SA_ATTR_MC_MEMBER_REC
= 0x38,
75 IB_SA_ATTR_TRACE_REC
= 0x39,
76 IB_SA_ATTR_MULTI_PATH_REC
= 0x3a,
77 IB_SA_ATTR_SERVICE_ASSOC_REC
= 0x3b,
78 IB_SA_ATTR_INFORM_INFO_REC
= 0xf3
86 * The meaning of "best" depends on the attribute: for
87 * example, for MTU best will return the largest available
88 * MTU, while for packet life time, best will return the
89 * smallest available life time.
95 IB_SA_RATE_2_5_GBPS
= 2,
96 IB_SA_RATE_5_GBPS
= 5,
97 IB_SA_RATE_10_GBPS
= 3,
98 IB_SA_RATE_20_GBPS
= 6,
99 IB_SA_RATE_30_GBPS
= 4,
100 IB_SA_RATE_40_GBPS
= 7,
101 IB_SA_RATE_60_GBPS
= 8,
102 IB_SA_RATE_80_GBPS
= 9,
103 IB_SA_RATE_120_GBPS
= 10
106 static inline int ib_sa_rate_enum_to_int(enum ib_sa_rate rate
)
109 case IB_SA_RATE_2_5_GBPS
: return 1;
110 case IB_SA_RATE_5_GBPS
: return 2;
111 case IB_SA_RATE_10_GBPS
: return 4;
112 case IB_SA_RATE_20_GBPS
: return 8;
113 case IB_SA_RATE_30_GBPS
: return 12;
114 case IB_SA_RATE_40_GBPS
: return 16;
115 case IB_SA_RATE_60_GBPS
: return 24;
116 case IB_SA_RATE_80_GBPS
: return 32;
117 case IB_SA_RATE_120_GBPS
: return 48;
123 * Structures for SA records are named "struct ib_sa_xxx_rec." No
124 * attempt is made to pack structures to match the physical layout of
125 * SA records in SA MADs; all packing and unpacking is handled by the
128 * For a record with structure ib_sa_xxx_rec, the naming convention
129 * for the component mask value for field yyy is IB_SA_XXX_REC_YYY (we
130 * never use different abbreviations or otherwise change the spelling
131 * of xxx/yyy between ib_sa_xxx_rec.yyy and IB_SA_XXX_REC_YYY).
133 * Reserved rows are indicated with comments to help maintainability.
138 #define IB_SA_PATH_REC_DGID IB_SA_COMP_MASK( 2)
139 #define IB_SA_PATH_REC_SGID IB_SA_COMP_MASK( 3)
140 #define IB_SA_PATH_REC_DLID IB_SA_COMP_MASK( 4)
141 #define IB_SA_PATH_REC_SLID IB_SA_COMP_MASK( 5)
142 #define IB_SA_PATH_REC_RAW_TRAFFIC IB_SA_COMP_MASK( 6)
144 #define IB_SA_PATH_REC_FLOW_LABEL IB_SA_COMP_MASK( 8)
145 #define IB_SA_PATH_REC_HOP_LIMIT IB_SA_COMP_MASK( 9)
146 #define IB_SA_PATH_REC_TRAFFIC_CLASS IB_SA_COMP_MASK(10)
147 #define IB_SA_PATH_REC_REVERSIBLE IB_SA_COMP_MASK(11)
148 #define IB_SA_PATH_REC_NUMB_PATH IB_SA_COMP_MASK(12)
149 #define IB_SA_PATH_REC_PKEY IB_SA_COMP_MASK(13)
151 #define IB_SA_PATH_REC_SL IB_SA_COMP_MASK(15)
152 #define IB_SA_PATH_REC_MTU_SELECTOR IB_SA_COMP_MASK(16)
153 #define IB_SA_PATH_REC_MTU IB_SA_COMP_MASK(17)
154 #define IB_SA_PATH_REC_RATE_SELECTOR IB_SA_COMP_MASK(18)
155 #define IB_SA_PATH_REC_RATE IB_SA_COMP_MASK(19)
156 #define IB_SA_PATH_REC_PACKET_LIFE_TIME_SELECTOR IB_SA_COMP_MASK(20)
157 #define IB_SA_PATH_REC_PACKET_LIFE_TIME IB_SA_COMP_MASK(21)
158 #define IB_SA_PATH_REC_PREFERENCE IB_SA_COMP_MASK(22)
160 struct ib_sa_path_rec
{
181 u8 packet_life_time_selector
;
186 #define IB_SA_MCMEMBER_REC_MGID IB_SA_COMP_MASK( 0)
187 #define IB_SA_MCMEMBER_REC_PORT_GID IB_SA_COMP_MASK( 1)
188 #define IB_SA_MCMEMBER_REC_QKEY IB_SA_COMP_MASK( 2)
189 #define IB_SA_MCMEMBER_REC_MLID IB_SA_COMP_MASK( 3)
190 #define IB_SA_MCMEMBER_REC_MTU_SELECTOR IB_SA_COMP_MASK( 4)
191 #define IB_SA_MCMEMBER_REC_MTU IB_SA_COMP_MASK( 5)
192 #define IB_SA_MCMEMBER_REC_TRAFFIC_CLASS IB_SA_COMP_MASK( 6)
193 #define IB_SA_MCMEMBER_REC_PKEY IB_SA_COMP_MASK( 7)
194 #define IB_SA_MCMEMBER_REC_RATE_SELECTOR IB_SA_COMP_MASK( 8)
195 #define IB_SA_MCMEMBER_REC_RATE IB_SA_COMP_MASK( 9)
196 #define IB_SA_MCMEMBER_REC_PACKET_LIFE_TIME_SELECTOR IB_SA_COMP_MASK(10)
197 #define IB_SA_MCMEMBER_REC_PACKET_LIFE_TIME IB_SA_COMP_MASK(11)
198 #define IB_SA_MCMEMBER_REC_SL IB_SA_COMP_MASK(12)
199 #define IB_SA_MCMEMBER_REC_FLOW_LABEL IB_SA_COMP_MASK(13)
200 #define IB_SA_MCMEMBER_REC_HOP_LIMIT IB_SA_COMP_MASK(14)
201 #define IB_SA_MCMEMBER_REC_SCOPE IB_SA_COMP_MASK(15)
202 #define IB_SA_MCMEMBER_REC_JOIN_STATE IB_SA_COMP_MASK(16)
203 #define IB_SA_MCMEMBER_REC_PROXY_JOIN IB_SA_COMP_MASK(17)
205 struct ib_sa_mcmember_rec
{
207 union ib_gid port_gid
;
216 u8 packet_life_time_selector
;
226 /* Service Record Component Mask Sec 15.2.5.14 Ver 1.1 */
227 #define IB_SA_SERVICE_REC_SERVICE_ID IB_SA_COMP_MASK( 0)
228 #define IB_SA_SERVICE_REC_SERVICE_GID IB_SA_COMP_MASK( 1)
229 #define IB_SA_SERVICE_REC_SERVICE_PKEY IB_SA_COMP_MASK( 2)
231 #define IB_SA_SERVICE_REC_SERVICE_LEASE IB_SA_COMP_MASK( 4)
232 #define IB_SA_SERVICE_REC_SERVICE_KEY IB_SA_COMP_MASK( 5)
233 #define IB_SA_SERVICE_REC_SERVICE_NAME IB_SA_COMP_MASK( 6)
234 #define IB_SA_SERVICE_REC_SERVICE_DATA8_0 IB_SA_COMP_MASK( 7)
235 #define IB_SA_SERVICE_REC_SERVICE_DATA8_1 IB_SA_COMP_MASK( 8)
236 #define IB_SA_SERVICE_REC_SERVICE_DATA8_2 IB_SA_COMP_MASK( 9)
237 #define IB_SA_SERVICE_REC_SERVICE_DATA8_3 IB_SA_COMP_MASK(10)
238 #define IB_SA_SERVICE_REC_SERVICE_DATA8_4 IB_SA_COMP_MASK(11)
239 #define IB_SA_SERVICE_REC_SERVICE_DATA8_5 IB_SA_COMP_MASK(12)
240 #define IB_SA_SERVICE_REC_SERVICE_DATA8_6 IB_SA_COMP_MASK(13)
241 #define IB_SA_SERVICE_REC_SERVICE_DATA8_7 IB_SA_COMP_MASK(14)
242 #define IB_SA_SERVICE_REC_SERVICE_DATA8_8 IB_SA_COMP_MASK(15)
243 #define IB_SA_SERVICE_REC_SERVICE_DATA8_9 IB_SA_COMP_MASK(16)
244 #define IB_SA_SERVICE_REC_SERVICE_DATA8_10 IB_SA_COMP_MASK(17)
245 #define IB_SA_SERVICE_REC_SERVICE_DATA8_11 IB_SA_COMP_MASK(18)
246 #define IB_SA_SERVICE_REC_SERVICE_DATA8_12 IB_SA_COMP_MASK(19)
247 #define IB_SA_SERVICE_REC_SERVICE_DATA8_13 IB_SA_COMP_MASK(20)
248 #define IB_SA_SERVICE_REC_SERVICE_DATA8_14 IB_SA_COMP_MASK(21)
249 #define IB_SA_SERVICE_REC_SERVICE_DATA8_15 IB_SA_COMP_MASK(22)
250 #define IB_SA_SERVICE_REC_SERVICE_DATA16_0 IB_SA_COMP_MASK(23)
251 #define IB_SA_SERVICE_REC_SERVICE_DATA16_1 IB_SA_COMP_MASK(24)
252 #define IB_SA_SERVICE_REC_SERVICE_DATA16_2 IB_SA_COMP_MASK(25)
253 #define IB_SA_SERVICE_REC_SERVICE_DATA16_3 IB_SA_COMP_MASK(26)
254 #define IB_SA_SERVICE_REC_SERVICE_DATA16_4 IB_SA_COMP_MASK(27)
255 #define IB_SA_SERVICE_REC_SERVICE_DATA16_5 IB_SA_COMP_MASK(28)
256 #define IB_SA_SERVICE_REC_SERVICE_DATA16_6 IB_SA_COMP_MASK(29)
257 #define IB_SA_SERVICE_REC_SERVICE_DATA16_7 IB_SA_COMP_MASK(30)
258 #define IB_SA_SERVICE_REC_SERVICE_DATA32_0 IB_SA_COMP_MASK(31)
259 #define IB_SA_SERVICE_REC_SERVICE_DATA32_1 IB_SA_COMP_MASK(32)
260 #define IB_SA_SERVICE_REC_SERVICE_DATA32_2 IB_SA_COMP_MASK(33)
261 #define IB_SA_SERVICE_REC_SERVICE_DATA32_3 IB_SA_COMP_MASK(34)
262 #define IB_SA_SERVICE_REC_SERVICE_DATA64_0 IB_SA_COMP_MASK(35)
263 #define IB_SA_SERVICE_REC_SERVICE_DATA64_1 IB_SA_COMP_MASK(36)
265 #define IB_DEFAULT_SERVICE_LEASE 0xFFFFFFFF
267 struct ib_sa_service_rec
{
283 void ib_sa_cancel_query(int id
, struct ib_sa_query
*query
);
285 int ib_sa_path_rec_get(struct ib_device
*device
, u8 port_num
,
286 struct ib_sa_path_rec
*rec
,
287 ib_sa_comp_mask comp_mask
,
288 int timeout_ms
, gfp_t gfp_mask
,
289 void (*callback
)(int status
,
290 struct ib_sa_path_rec
*resp
,
293 struct ib_sa_query
**query
);
295 int ib_sa_mcmember_rec_query(struct ib_device
*device
, u8 port_num
,
297 struct ib_sa_mcmember_rec
*rec
,
298 ib_sa_comp_mask comp_mask
,
299 int timeout_ms
, gfp_t gfp_mask
,
300 void (*callback
)(int status
,
301 struct ib_sa_mcmember_rec
*resp
,
304 struct ib_sa_query
**query
);
306 int ib_sa_service_rec_query(struct ib_device
*device
, u8 port_num
,
308 struct ib_sa_service_rec
*rec
,
309 ib_sa_comp_mask comp_mask
,
310 int timeout_ms
, gfp_t gfp_mask
,
311 void (*callback
)(int status
,
312 struct ib_sa_service_rec
*resp
,
315 struct ib_sa_query
**sa_query
);
318 * ib_sa_mcmember_rec_set - Start an MCMember set query
319 * @device:device to send query on
320 * @port_num: port number to send query on
321 * @rec:MCMember Record to send in query
322 * @comp_mask:component mask to send in query
323 * @timeout_ms:time to wait for response
324 * @gfp_mask:GFP mask to use for internal allocations
325 * @callback:function called when query completes, times out or is
327 * @context:opaque user context passed to callback
328 * @sa_query:query context, used to cancel query
330 * Send an MCMember Set query to the SA (eg to join a multicast
331 * group). The callback function will be called when the query
332 * completes (or fails); status is 0 for a successful response, -EINTR
333 * if the query is canceled, -ETIMEDOUT is the query timed out, or
334 * -EIO if an error occurred sending the query. The resp parameter of
335 * the callback is only valid if status is 0.
337 * If the return value of ib_sa_mcmember_rec_set() is negative, it is
338 * an error code. Otherwise it is a query ID that can be used to
342 ib_sa_mcmember_rec_set(struct ib_device
*device
, u8 port_num
,
343 struct ib_sa_mcmember_rec
*rec
,
344 ib_sa_comp_mask comp_mask
,
345 int timeout_ms
, gfp_t gfp_mask
,
346 void (*callback
)(int status
,
347 struct ib_sa_mcmember_rec
*resp
,
350 struct ib_sa_query
**query
)
352 return ib_sa_mcmember_rec_query(device
, port_num
,
355 timeout_ms
, gfp_mask
, callback
,
360 * ib_sa_mcmember_rec_delete - Start an MCMember delete query
361 * @device:device to send query on
362 * @port_num: port number to send query on
363 * @rec:MCMember Record to send in query
364 * @comp_mask:component mask to send in query
365 * @timeout_ms:time to wait for response
366 * @gfp_mask:GFP mask to use for internal allocations
367 * @callback:function called when query completes, times out or is
369 * @context:opaque user context passed to callback
370 * @sa_query:query context, used to cancel query
372 * Send an MCMember Delete query to the SA (eg to leave a multicast
373 * group). The callback function will be called when the query
374 * completes (or fails); status is 0 for a successful response, -EINTR
375 * if the query is canceled, -ETIMEDOUT is the query timed out, or
376 * -EIO if an error occurred sending the query. The resp parameter of
377 * the callback is only valid if status is 0.
379 * If the return value of ib_sa_mcmember_rec_delete() is negative, it
380 * is an error code. Otherwise it is a query ID that can be used to
384 ib_sa_mcmember_rec_delete(struct ib_device
*device
, u8 port_num
,
385 struct ib_sa_mcmember_rec
*rec
,
386 ib_sa_comp_mask comp_mask
,
387 int timeout_ms
, gfp_t gfp_mask
,
388 void (*callback
)(int status
,
389 struct ib_sa_mcmember_rec
*resp
,
392 struct ib_sa_query
**query
)
394 return ib_sa_mcmember_rec_query(device
, port_num
,
397 timeout_ms
, gfp_mask
, callback
,