Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * Copyright (c) 2004 Topspin Communications. All rights reserved. | |
cbae32c5 | 3 | * Copyright (c) 2005 Voltaire, Inc. All rights reserved. |
1da177e4 LT |
4 | * |
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: | |
10 | * | |
11 | * Redistribution and use in source and binary forms, with or | |
12 | * without modification, are permitted provided that the following | |
13 | * conditions are met: | |
14 | * | |
15 | * - Redistributions of source code must retain the above | |
16 | * copyright notice, this list of conditions and the following | |
17 | * disclaimer. | |
18 | * | |
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. | |
23 | * | |
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 | |
31 | * SOFTWARE. | |
32 | * | |
cbae32c5 | 33 | * $Id: ib_sa.h 2811 2005-07-06 18:11:43Z halr $ |
1da177e4 LT |
34 | */ |
35 | ||
36 | #ifndef IB_SA_H | |
37 | #define IB_SA_H | |
38 | ||
39 | #include <linux/compiler.h> | |
40 | ||
a4d61e84 RD |
41 | #include <rdma/ib_verbs.h> |
42 | #include <rdma/ib_mad.h> | |
1da177e4 LT |
43 | |
44 | enum { | |
cbae32c5 | 45 | IB_SA_CLASS_VERSION = 2, /* IB spec version 1.1/1.2 */ |
1da177e4 | 46 | |
cbae32c5 HR |
47 | IB_SA_METHOD_GET_TABLE = 0x12, |
48 | IB_SA_METHOD_GET_TABLE_RESP = 0x92, | |
1325cc79 HR |
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 | |
1da177e4 LT |
54 | }; |
55 | ||
56 | enum ib_sa_selector { | |
57 | IB_SA_GTE = 0, | |
58 | IB_SA_LTE = 1, | |
59 | IB_SA_EQ = 2, | |
60 | /* | |
61 | * The meaning of "best" depends on the attribute: for | |
62 | * example, for MTU best will return the largest available | |
63 | * MTU, while for packet life time, best will return the | |
64 | * smallest available life time. | |
65 | */ | |
66 | IB_SA_BEST = 3 | |
67 | }; | |
68 | ||
69 | enum ib_sa_rate { | |
70 | IB_SA_RATE_2_5_GBPS = 2, | |
71 | IB_SA_RATE_5_GBPS = 5, | |
72 | IB_SA_RATE_10_GBPS = 3, | |
73 | IB_SA_RATE_20_GBPS = 6, | |
74 | IB_SA_RATE_30_GBPS = 4, | |
75 | IB_SA_RATE_40_GBPS = 7, | |
76 | IB_SA_RATE_60_GBPS = 8, | |
77 | IB_SA_RATE_80_GBPS = 9, | |
78 | IB_SA_RATE_120_GBPS = 10 | |
79 | }; | |
80 | ||
81 | static inline int ib_sa_rate_enum_to_int(enum ib_sa_rate rate) | |
82 | { | |
83 | switch (rate) { | |
84 | case IB_SA_RATE_2_5_GBPS: return 1; | |
85 | case IB_SA_RATE_5_GBPS: return 2; | |
86 | case IB_SA_RATE_10_GBPS: return 4; | |
87 | case IB_SA_RATE_20_GBPS: return 8; | |
88 | case IB_SA_RATE_30_GBPS: return 12; | |
89 | case IB_SA_RATE_40_GBPS: return 16; | |
90 | case IB_SA_RATE_60_GBPS: return 24; | |
91 | case IB_SA_RATE_80_GBPS: return 32; | |
92 | case IB_SA_RATE_120_GBPS: return 48; | |
93 | default: return -1; | |
94 | } | |
95 | } | |
96 | ||
1da177e4 LT |
97 | /* |
98 | * Structures for SA records are named "struct ib_sa_xxx_rec." No | |
99 | * attempt is made to pack structures to match the physical layout of | |
100 | * SA records in SA MADs; all packing and unpacking is handled by the | |
101 | * SA query code. | |
102 | * | |
103 | * For a record with structure ib_sa_xxx_rec, the naming convention | |
104 | * for the component mask value for field yyy is IB_SA_XXX_REC_YYY (we | |
105 | * never use different abbreviations or otherwise change the spelling | |
106 | * of xxx/yyy between ib_sa_xxx_rec.yyy and IB_SA_XXX_REC_YYY). | |
107 | * | |
108 | * Reserved rows are indicated with comments to help maintainability. | |
109 | */ | |
110 | ||
111 | /* reserved: 0 */ | |
112 | /* reserved: 1 */ | |
113 | #define IB_SA_PATH_REC_DGID IB_SA_COMP_MASK( 2) | |
114 | #define IB_SA_PATH_REC_SGID IB_SA_COMP_MASK( 3) | |
115 | #define IB_SA_PATH_REC_DLID IB_SA_COMP_MASK( 4) | |
116 | #define IB_SA_PATH_REC_SLID IB_SA_COMP_MASK( 5) | |
117 | #define IB_SA_PATH_REC_RAW_TRAFFIC IB_SA_COMP_MASK( 6) | |
118 | /* reserved: 7 */ | |
119 | #define IB_SA_PATH_REC_FLOW_LABEL IB_SA_COMP_MASK( 8) | |
120 | #define IB_SA_PATH_REC_HOP_LIMIT IB_SA_COMP_MASK( 9) | |
121 | #define IB_SA_PATH_REC_TRAFFIC_CLASS IB_SA_COMP_MASK(10) | |
122 | #define IB_SA_PATH_REC_REVERSIBLE IB_SA_COMP_MASK(11) | |
123 | #define IB_SA_PATH_REC_NUMB_PATH IB_SA_COMP_MASK(12) | |
124 | #define IB_SA_PATH_REC_PKEY IB_SA_COMP_MASK(13) | |
125 | /* reserved: 14 */ | |
126 | #define IB_SA_PATH_REC_SL IB_SA_COMP_MASK(15) | |
127 | #define IB_SA_PATH_REC_MTU_SELECTOR IB_SA_COMP_MASK(16) | |
128 | #define IB_SA_PATH_REC_MTU IB_SA_COMP_MASK(17) | |
129 | #define IB_SA_PATH_REC_RATE_SELECTOR IB_SA_COMP_MASK(18) | |
130 | #define IB_SA_PATH_REC_RATE IB_SA_COMP_MASK(19) | |
131 | #define IB_SA_PATH_REC_PACKET_LIFE_TIME_SELECTOR IB_SA_COMP_MASK(20) | |
132 | #define IB_SA_PATH_REC_PACKET_LIFE_TIME IB_SA_COMP_MASK(21) | |
133 | #define IB_SA_PATH_REC_PREFERENCE IB_SA_COMP_MASK(22) | |
134 | ||
135 | struct ib_sa_path_rec { | |
136 | /* reserved */ | |
137 | /* reserved */ | |
138 | union ib_gid dgid; | |
139 | union ib_gid sgid; | |
97f52eb4 SH |
140 | __be16 dlid; |
141 | __be16 slid; | |
1da177e4 LT |
142 | int raw_traffic; |
143 | /* reserved */ | |
97f52eb4 | 144 | __be32 flow_label; |
1da177e4 LT |
145 | u8 hop_limit; |
146 | u8 traffic_class; | |
147 | int reversible; | |
148 | u8 numb_path; | |
97f52eb4 | 149 | __be16 pkey; |
1da177e4 LT |
150 | /* reserved */ |
151 | u8 sl; | |
152 | u8 mtu_selector; | |
3bf4fb82 | 153 | u8 mtu; |
1da177e4 LT |
154 | u8 rate_selector; |
155 | u8 rate; | |
156 | u8 packet_life_time_selector; | |
157 | u8 packet_life_time; | |
158 | u8 preference; | |
159 | }; | |
160 | ||
161 | #define IB_SA_MCMEMBER_REC_MGID IB_SA_COMP_MASK( 0) | |
162 | #define IB_SA_MCMEMBER_REC_PORT_GID IB_SA_COMP_MASK( 1) | |
163 | #define IB_SA_MCMEMBER_REC_QKEY IB_SA_COMP_MASK( 2) | |
164 | #define IB_SA_MCMEMBER_REC_MLID IB_SA_COMP_MASK( 3) | |
165 | #define IB_SA_MCMEMBER_REC_MTU_SELECTOR IB_SA_COMP_MASK( 4) | |
166 | #define IB_SA_MCMEMBER_REC_MTU IB_SA_COMP_MASK( 5) | |
167 | #define IB_SA_MCMEMBER_REC_TRAFFIC_CLASS IB_SA_COMP_MASK( 6) | |
168 | #define IB_SA_MCMEMBER_REC_PKEY IB_SA_COMP_MASK( 7) | |
169 | #define IB_SA_MCMEMBER_REC_RATE_SELECTOR IB_SA_COMP_MASK( 8) | |
170 | #define IB_SA_MCMEMBER_REC_RATE IB_SA_COMP_MASK( 9) | |
171 | #define IB_SA_MCMEMBER_REC_PACKET_LIFE_TIME_SELECTOR IB_SA_COMP_MASK(10) | |
172 | #define IB_SA_MCMEMBER_REC_PACKET_LIFE_TIME IB_SA_COMP_MASK(11) | |
173 | #define IB_SA_MCMEMBER_REC_SL IB_SA_COMP_MASK(12) | |
174 | #define IB_SA_MCMEMBER_REC_FLOW_LABEL IB_SA_COMP_MASK(13) | |
175 | #define IB_SA_MCMEMBER_REC_HOP_LIMIT IB_SA_COMP_MASK(14) | |
176 | #define IB_SA_MCMEMBER_REC_SCOPE IB_SA_COMP_MASK(15) | |
177 | #define IB_SA_MCMEMBER_REC_JOIN_STATE IB_SA_COMP_MASK(16) | |
178 | #define IB_SA_MCMEMBER_REC_PROXY_JOIN IB_SA_COMP_MASK(17) | |
179 | ||
180 | struct ib_sa_mcmember_rec { | |
181 | union ib_gid mgid; | |
182 | union ib_gid port_gid; | |
97f52eb4 SH |
183 | __be32 qkey; |
184 | __be16 mlid; | |
1da177e4 | 185 | u8 mtu_selector; |
3bf4fb82 | 186 | u8 mtu; |
1da177e4 | 187 | u8 traffic_class; |
97f52eb4 | 188 | __be16 pkey; |
1da177e4 LT |
189 | u8 rate_selector; |
190 | u8 rate; | |
191 | u8 packet_life_time_selector; | |
192 | u8 packet_life_time; | |
193 | u8 sl; | |
97f52eb4 | 194 | __be32 flow_label; |
1da177e4 LT |
195 | u8 hop_limit; |
196 | u8 scope; | |
197 | u8 join_state; | |
198 | int proxy_join; | |
199 | }; | |
200 | ||
cbae32c5 HR |
201 | /* Service Record Component Mask Sec 15.2.5.14 Ver 1.1 */ |
202 | #define IB_SA_SERVICE_REC_SERVICE_ID IB_SA_COMP_MASK( 0) | |
203 | #define IB_SA_SERVICE_REC_SERVICE_GID IB_SA_COMP_MASK( 1) | |
204 | #define IB_SA_SERVICE_REC_SERVICE_PKEY IB_SA_COMP_MASK( 2) | |
205 | /* reserved: 3 */ | |
206 | #define IB_SA_SERVICE_REC_SERVICE_LEASE IB_SA_COMP_MASK( 4) | |
207 | #define IB_SA_SERVICE_REC_SERVICE_KEY IB_SA_COMP_MASK( 5) | |
208 | #define IB_SA_SERVICE_REC_SERVICE_NAME IB_SA_COMP_MASK( 6) | |
209 | #define IB_SA_SERVICE_REC_SERVICE_DATA8_0 IB_SA_COMP_MASK( 7) | |
210 | #define IB_SA_SERVICE_REC_SERVICE_DATA8_1 IB_SA_COMP_MASK( 8) | |
211 | #define IB_SA_SERVICE_REC_SERVICE_DATA8_2 IB_SA_COMP_MASK( 9) | |
212 | #define IB_SA_SERVICE_REC_SERVICE_DATA8_3 IB_SA_COMP_MASK(10) | |
213 | #define IB_SA_SERVICE_REC_SERVICE_DATA8_4 IB_SA_COMP_MASK(11) | |
214 | #define IB_SA_SERVICE_REC_SERVICE_DATA8_5 IB_SA_COMP_MASK(12) | |
215 | #define IB_SA_SERVICE_REC_SERVICE_DATA8_6 IB_SA_COMP_MASK(13) | |
216 | #define IB_SA_SERVICE_REC_SERVICE_DATA8_7 IB_SA_COMP_MASK(14) | |
217 | #define IB_SA_SERVICE_REC_SERVICE_DATA8_8 IB_SA_COMP_MASK(15) | |
218 | #define IB_SA_SERVICE_REC_SERVICE_DATA8_9 IB_SA_COMP_MASK(16) | |
219 | #define IB_SA_SERVICE_REC_SERVICE_DATA8_10 IB_SA_COMP_MASK(17) | |
220 | #define IB_SA_SERVICE_REC_SERVICE_DATA8_11 IB_SA_COMP_MASK(18) | |
221 | #define IB_SA_SERVICE_REC_SERVICE_DATA8_12 IB_SA_COMP_MASK(19) | |
222 | #define IB_SA_SERVICE_REC_SERVICE_DATA8_13 IB_SA_COMP_MASK(20) | |
223 | #define IB_SA_SERVICE_REC_SERVICE_DATA8_14 IB_SA_COMP_MASK(21) | |
224 | #define IB_SA_SERVICE_REC_SERVICE_DATA8_15 IB_SA_COMP_MASK(22) | |
225 | #define IB_SA_SERVICE_REC_SERVICE_DATA16_0 IB_SA_COMP_MASK(23) | |
226 | #define IB_SA_SERVICE_REC_SERVICE_DATA16_1 IB_SA_COMP_MASK(24) | |
227 | #define IB_SA_SERVICE_REC_SERVICE_DATA16_2 IB_SA_COMP_MASK(25) | |
228 | #define IB_SA_SERVICE_REC_SERVICE_DATA16_3 IB_SA_COMP_MASK(26) | |
229 | #define IB_SA_SERVICE_REC_SERVICE_DATA16_4 IB_SA_COMP_MASK(27) | |
230 | #define IB_SA_SERVICE_REC_SERVICE_DATA16_5 IB_SA_COMP_MASK(28) | |
231 | #define IB_SA_SERVICE_REC_SERVICE_DATA16_6 IB_SA_COMP_MASK(29) | |
232 | #define IB_SA_SERVICE_REC_SERVICE_DATA16_7 IB_SA_COMP_MASK(30) | |
233 | #define IB_SA_SERVICE_REC_SERVICE_DATA32_0 IB_SA_COMP_MASK(31) | |
234 | #define IB_SA_SERVICE_REC_SERVICE_DATA32_1 IB_SA_COMP_MASK(32) | |
235 | #define IB_SA_SERVICE_REC_SERVICE_DATA32_2 IB_SA_COMP_MASK(33) | |
236 | #define IB_SA_SERVICE_REC_SERVICE_DATA32_3 IB_SA_COMP_MASK(34) | |
237 | #define IB_SA_SERVICE_REC_SERVICE_DATA64_0 IB_SA_COMP_MASK(35) | |
238 | #define IB_SA_SERVICE_REC_SERVICE_DATA64_1 IB_SA_COMP_MASK(36) | |
239 | ||
240 | #define IB_DEFAULT_SERVICE_LEASE 0xFFFFFFFF | |
241 | ||
242 | struct ib_sa_service_rec { | |
243 | u64 id; | |
244 | union ib_gid gid; | |
97f52eb4 | 245 | __be16 pkey; |
cbae32c5 HR |
246 | /* reserved */ |
247 | u32 lease; | |
248 | u8 key[16]; | |
249 | u8 name[64]; | |
250 | u8 data8[16]; | |
251 | u16 data16[8]; | |
252 | u32 data32[4]; | |
253 | u64 data64[2]; | |
254 | }; | |
255 | ||
1da177e4 LT |
256 | struct ib_sa_query; |
257 | ||
258 | void ib_sa_cancel_query(int id, struct ib_sa_query *query); | |
259 | ||
260 | int ib_sa_path_rec_get(struct ib_device *device, u8 port_num, | |
261 | struct ib_sa_path_rec *rec, | |
262 | ib_sa_comp_mask comp_mask, | |
f13f9f50 | 263 | int timeout_ms, unsigned int __nocast gfp_mask, |
1da177e4 LT |
264 | void (*callback)(int status, |
265 | struct ib_sa_path_rec *resp, | |
266 | void *context), | |
267 | void *context, | |
268 | struct ib_sa_query **query); | |
269 | ||
270 | int ib_sa_mcmember_rec_query(struct ib_device *device, u8 port_num, | |
271 | u8 method, | |
272 | struct ib_sa_mcmember_rec *rec, | |
273 | ib_sa_comp_mask comp_mask, | |
f13f9f50 | 274 | int timeout_ms, unsigned int __nocast gfp_mask, |
1da177e4 LT |
275 | void (*callback)(int status, |
276 | struct ib_sa_mcmember_rec *resp, | |
277 | void *context), | |
278 | void *context, | |
279 | struct ib_sa_query **query); | |
280 | ||
cbae32c5 HR |
281 | int ib_sa_service_rec_query(struct ib_device *device, u8 port_num, |
282 | u8 method, | |
283 | struct ib_sa_service_rec *rec, | |
284 | ib_sa_comp_mask comp_mask, | |
f13f9f50 | 285 | int timeout_ms, unsigned int __nocast gfp_mask, |
cbae32c5 HR |
286 | void (*callback)(int status, |
287 | struct ib_sa_service_rec *resp, | |
288 | void *context), | |
289 | void *context, | |
290 | struct ib_sa_query **sa_query); | |
291 | ||
1da177e4 LT |
292 | /** |
293 | * ib_sa_mcmember_rec_set - Start an MCMember set query | |
294 | * @device:device to send query on | |
295 | * @port_num: port number to send query on | |
296 | * @rec:MCMember Record to send in query | |
297 | * @comp_mask:component mask to send in query | |
298 | * @timeout_ms:time to wait for response | |
299 | * @gfp_mask:GFP mask to use for internal allocations | |
300 | * @callback:function called when query completes, times out or is | |
301 | * canceled | |
302 | * @context:opaque user context passed to callback | |
303 | * @sa_query:query context, used to cancel query | |
304 | * | |
305 | * Send an MCMember Set query to the SA (eg to join a multicast | |
306 | * group). The callback function will be called when the query | |
307 | * completes (or fails); status is 0 for a successful response, -EINTR | |
308 | * if the query is canceled, -ETIMEDOUT is the query timed out, or | |
309 | * -EIO if an error occurred sending the query. The resp parameter of | |
310 | * the callback is only valid if status is 0. | |
311 | * | |
312 | * If the return value of ib_sa_mcmember_rec_set() is negative, it is | |
313 | * an error code. Otherwise it is a query ID that can be used to | |
314 | * cancel the query. | |
315 | */ | |
316 | static inline int | |
317 | ib_sa_mcmember_rec_set(struct ib_device *device, u8 port_num, | |
318 | struct ib_sa_mcmember_rec *rec, | |
319 | ib_sa_comp_mask comp_mask, | |
f13f9f50 | 320 | int timeout_ms, unsigned int __nocast gfp_mask, |
1da177e4 LT |
321 | void (*callback)(int status, |
322 | struct ib_sa_mcmember_rec *resp, | |
323 | void *context), | |
324 | void *context, | |
325 | struct ib_sa_query **query) | |
326 | { | |
327 | return ib_sa_mcmember_rec_query(device, port_num, | |
328 | IB_MGMT_METHOD_SET, | |
329 | rec, comp_mask, | |
330 | timeout_ms, gfp_mask, callback, | |
331 | context, query); | |
332 | } | |
333 | ||
334 | /** | |
335 | * ib_sa_mcmember_rec_delete - Start an MCMember delete query | |
336 | * @device:device to send query on | |
337 | * @port_num: port number to send query on | |
338 | * @rec:MCMember Record to send in query | |
339 | * @comp_mask:component mask to send in query | |
340 | * @timeout_ms:time to wait for response | |
341 | * @gfp_mask:GFP mask to use for internal allocations | |
342 | * @callback:function called when query completes, times out or is | |
343 | * canceled | |
344 | * @context:opaque user context passed to callback | |
345 | * @sa_query:query context, used to cancel query | |
346 | * | |
347 | * Send an MCMember Delete query to the SA (eg to leave a multicast | |
348 | * group). The callback function will be called when the query | |
349 | * completes (or fails); status is 0 for a successful response, -EINTR | |
350 | * if the query is canceled, -ETIMEDOUT is the query timed out, or | |
351 | * -EIO if an error occurred sending the query. The resp parameter of | |
352 | * the callback is only valid if status is 0. | |
353 | * | |
354 | * If the return value of ib_sa_mcmember_rec_delete() is negative, it | |
355 | * is an error code. Otherwise it is a query ID that can be used to | |
356 | * cancel the query. | |
357 | */ | |
358 | static inline int | |
359 | ib_sa_mcmember_rec_delete(struct ib_device *device, u8 port_num, | |
360 | struct ib_sa_mcmember_rec *rec, | |
361 | ib_sa_comp_mask comp_mask, | |
f13f9f50 | 362 | int timeout_ms, unsigned int __nocast gfp_mask, |
1da177e4 LT |
363 | void (*callback)(int status, |
364 | struct ib_sa_mcmember_rec *resp, | |
365 | void *context), | |
366 | void *context, | |
367 | struct ib_sa_query **query) | |
368 | { | |
369 | return ib_sa_mcmember_rec_query(device, port_num, | |
370 | IB_SA_METHOD_DELETE, | |
371 | rec, comp_mask, | |
372 | timeout_ms, gfp_mask, callback, | |
373 | context, query); | |
374 | } | |
375 | ||
376 | ||
377 | #endif /* IB_SA_H */ |