1 /*-
2 * SPDX-License-Identifier: BSD-2-Clause OR GPL-2.0
3 *
4 * Copyright (c) 2004 Topspin Communications. All rights reserved.
5 * Copyright (c) 2005 Voltaire, Inc. All rights reserved.
6 * Copyright (c) 2006 Intel Corporation. All rights reserved.
7 *
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:
13 *
14 * Redistribution and use in source and binary forms, with or
15 * without modification, are permitted provided that the following
16 * conditions are met:
17 *
18 * - Redistributions of source code must retain the above
19 * copyright notice, this list of conditions and the following
20 * disclaimer.
21 *
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.
26 *
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
34 * SOFTWARE.
35 */
36
37 #ifndef IB_SA_H
38 #define IB_SA_H
39
40 #include <linux/completion.h>
41 #include <linux/compiler.h>
42 #include <linux/netdevice.h>
43 #include <linux/etherdevice.h>
44
45 #include <rdma/ib_verbs.h>
46 #include <rdma/ib_mad.h>
47 #include <rdma/ib_addr.h>
48 #include <rdma/opa_addr.h>
49
50 enum {
51 IB_SA_CLASS_VERSION = 2, /* IB spec version 1.1/1.2 */
52
53 IB_SA_METHOD_GET_TABLE = 0x12,
54 IB_SA_METHOD_GET_TABLE_RESP = 0x92,
55 IB_SA_METHOD_DELETE = 0x15,
56 IB_SA_METHOD_DELETE_RESP = 0x95,
57 IB_SA_METHOD_GET_MULTI = 0x14,
58 IB_SA_METHOD_GET_MULTI_RESP = 0x94,
59 IB_SA_METHOD_GET_TRACE_TBL = 0x13
60 };
61
62 #define OPA_SA_CLASS_VERSION 0x80
63 enum {
64 IB_SA_ATTR_CLASS_PORTINFO = 0x01,
65 IB_SA_ATTR_NOTICE = 0x02,
66 IB_SA_ATTR_INFORM_INFO = 0x03,
67 IB_SA_ATTR_NODE_REC = 0x11,
68 IB_SA_ATTR_PORT_INFO_REC = 0x12,
69 IB_SA_ATTR_SL2VL_REC = 0x13,
70 IB_SA_ATTR_SWITCH_REC = 0x14,
71 IB_SA_ATTR_LINEAR_FDB_REC = 0x15,
72 IB_SA_ATTR_RANDOM_FDB_REC = 0x16,
73 IB_SA_ATTR_MCAST_FDB_REC = 0x17,
74 IB_SA_ATTR_SM_INFO_REC = 0x18,
75 IB_SA_ATTR_LINK_REC = 0x20,
76 IB_SA_ATTR_GUID_INFO_REC = 0x30,
77 IB_SA_ATTR_SERVICE_REC = 0x31,
78 IB_SA_ATTR_PARTITION_REC = 0x33,
79 IB_SA_ATTR_PATH_REC = 0x35,
80 IB_SA_ATTR_VL_ARB_REC = 0x36,
81 IB_SA_ATTR_MC_MEMBER_REC = 0x38,
82 IB_SA_ATTR_TRACE_REC = 0x39,
83 IB_SA_ATTR_MULTI_PATH_REC = 0x3a,
84 IB_SA_ATTR_SERVICE_ASSOC_REC = 0x3b,
85 IB_SA_ATTR_INFORM_INFO_REC = 0xf3
86 };
87
88 enum ib_sa_selector {
89 IB_SA_GT = 0,
90 IB_SA_LT = 1,
91 IB_SA_EQ = 2,
92 /*
93 * The meaning of "best" depends on the attribute: for
94 * example, for MTU best will return the largest available
95 * MTU, while for packet life time, best will return the
96 * smallest available life time.
97 */
98 IB_SA_BEST = 3
99 };
100
101 /*
102 * There are 4 types of join states:
103 * FullMember, NonMember, SendOnlyNonMember, SendOnlyFullMember.
104 * The order corresponds to JoinState bits in MCMemberRecord.
105 */
106 enum ib_sa_mc_join_states {
107 FULLMEMBER_JOIN,
108 NONMEMBER_JOIN,
109 SENDONLY_NONMEBER_JOIN,
110 SENDONLY_FULLMEMBER_JOIN,
111 NUM_JOIN_MEMBERSHIP_TYPES,
112 };
113
114 #define IB_SA_CAP_MASK2_SENDONLY_FULL_MEM_SUPPORT BIT(12)
115
116 /*
117 * Structures for SA records are named "struct ib_sa_xxx_rec." No
118 * attempt is made to pack structures to match the physical layout of
119 * SA records in SA MADs; all packing and unpacking is handled by the
120 * SA query code.
121 *
122 * For a record with structure ib_sa_xxx_rec, the naming convention
123 * for the component mask value for field yyy is IB_SA_XXX_REC_YYY (we
124 * never use different abbreviations or otherwise change the spelling
125 * of xxx/yyy between ib_sa_xxx_rec.yyy and IB_SA_XXX_REC_YYY).
126 *
127 * Reserved rows are indicated with comments to help maintainability.
128 */
129
130 #define IB_SA_PATH_REC_SERVICE_ID (IB_SA_COMP_MASK( 0) |\
131 IB_SA_COMP_MASK( 1))
132 #define IB_SA_PATH_REC_DGID IB_SA_COMP_MASK( 2)
133 #define IB_SA_PATH_REC_SGID IB_SA_COMP_MASK( 3)
134 #define IB_SA_PATH_REC_DLID IB_SA_COMP_MASK( 4)
135 #define IB_SA_PATH_REC_SLID IB_SA_COMP_MASK( 5)
136 #define IB_SA_PATH_REC_RAW_TRAFFIC IB_SA_COMP_MASK( 6)
137 /* reserved: 7 */
138 #define IB_SA_PATH_REC_FLOW_LABEL IB_SA_COMP_MASK( 8)
139 #define IB_SA_PATH_REC_HOP_LIMIT IB_SA_COMP_MASK( 9)
140 #define IB_SA_PATH_REC_TRAFFIC_CLASS IB_SA_COMP_MASK(10)
141 #define IB_SA_PATH_REC_REVERSIBLE IB_SA_COMP_MASK(11)
142 #define IB_SA_PATH_REC_NUMB_PATH IB_SA_COMP_MASK(12)
143 #define IB_SA_PATH_REC_PKEY IB_SA_COMP_MASK(13)
144 #define IB_SA_PATH_REC_QOS_CLASS IB_SA_COMP_MASK(14)
145 #define IB_SA_PATH_REC_SL IB_SA_COMP_MASK(15)
146 #define IB_SA_PATH_REC_MTU_SELECTOR IB_SA_COMP_MASK(16)
147 #define IB_SA_PATH_REC_MTU IB_SA_COMP_MASK(17)
148 #define IB_SA_PATH_REC_RATE_SELECTOR IB_SA_COMP_MASK(18)
149 #define IB_SA_PATH_REC_RATE IB_SA_COMP_MASK(19)
150 #define IB_SA_PATH_REC_PACKET_LIFE_TIME_SELECTOR IB_SA_COMP_MASK(20)
151 #define IB_SA_PATH_REC_PACKET_LIFE_TIME IB_SA_COMP_MASK(21)
152 #define IB_SA_PATH_REC_PREFERENCE IB_SA_COMP_MASK(22)
153
154 enum sa_path_rec_type {
155 SA_PATH_REC_TYPE_IB,
156 SA_PATH_REC_TYPE_ROCE_V1,
157 SA_PATH_REC_TYPE_ROCE_V2,
158 SA_PATH_REC_TYPE_OPA
159 };
160
161 struct sa_path_rec_ib {
162 __be16 dlid;
163 __be16 slid;
164 u8 raw_traffic;
165 };
166
167 /**
168 * struct sa_path_rec_roce - RoCE specific portion of the path record entry
169 * @route_resolved: When set, it indicates that this route is already
170 * resolved for this path record entry.
171 * @dmac: Destination mac address for the given DGID entry
172 * of the path record entry.
173 */
174 struct sa_path_rec_roce {
175 bool route_resolved;
176 u8 dmac[ETH_ALEN];
177 };
178
179 struct sa_path_rec_opa {
180 __be32 dlid;
181 __be32 slid;
182 u8 raw_traffic;
183 u8 l2_8B;
184 u8 l2_10B;
185 u8 l2_9B;
186 u8 l2_16B;
187 u8 qos_type;
188 u8 qos_priority;
189 };
190
191 struct sa_path_rec {
192 union ib_gid dgid;
193 union ib_gid sgid;
194 __be64 service_id;
195 /* reserved */
196 __be32 flow_label;
197 u8 hop_limit;
198 u8 traffic_class;
199 u8 reversible;
200 u8 numb_path;
201 __be16 pkey;
202 __be16 qos_class;
203 u8 sl;
204 u8 mtu_selector;
205 u8 mtu;
206 u8 rate_selector;
207 u8 rate;
208 u8 packet_life_time_selector;
209 u8 packet_life_time;
210 u8 preference;
211 union {
212 struct sa_path_rec_ib ib;
213 struct sa_path_rec_roce roce;
214 struct sa_path_rec_opa opa;
215 };
216 enum sa_path_rec_type rec_type;
217 };
218
219 static inline enum ib_gid_type
sa_conv_pathrec_to_gid_type(struct sa_path_rec * rec)220 sa_conv_pathrec_to_gid_type(struct sa_path_rec *rec)
221 {
222 switch (rec->rec_type) {
223 case SA_PATH_REC_TYPE_ROCE_V1:
224 return IB_GID_TYPE_ROCE;
225 case SA_PATH_REC_TYPE_ROCE_V2:
226 return IB_GID_TYPE_ROCE_UDP_ENCAP;
227 default:
228 return IB_GID_TYPE_IB;
229 }
230 }
231
232 static inline enum sa_path_rec_type
sa_conv_gid_to_pathrec_type(enum ib_gid_type type)233 sa_conv_gid_to_pathrec_type(enum ib_gid_type type)
234 {
235 switch (type) {
236 case IB_GID_TYPE_ROCE:
237 return SA_PATH_REC_TYPE_ROCE_V1;
238 case IB_GID_TYPE_ROCE_UDP_ENCAP:
239 return SA_PATH_REC_TYPE_ROCE_V2;
240 default:
241 return SA_PATH_REC_TYPE_IB;
242 }
243 }
244
path_conv_opa_to_ib(struct sa_path_rec * ib,struct sa_path_rec * opa)245 static inline void path_conv_opa_to_ib(struct sa_path_rec *ib,
246 struct sa_path_rec *opa)
247 {
248 if ((be32_to_cpu(opa->opa.dlid) >=
249 be16_to_cpu(IB_MULTICAST_LID_BASE)) ||
250 (be32_to_cpu(opa->opa.slid) >=
251 be16_to_cpu(IB_MULTICAST_LID_BASE))) {
252 /* Create OPA GID and zero out the LID */
253 ib->dgid.global.interface_id
254 = OPA_MAKE_ID(be32_to_cpu(opa->opa.dlid));
255 ib->dgid.global.subnet_prefix
256 = opa->dgid.global.subnet_prefix;
257 ib->sgid.global.interface_id
258 = OPA_MAKE_ID(be32_to_cpu(opa->opa.slid));
259 ib->dgid.global.subnet_prefix
260 = opa->dgid.global.subnet_prefix;
261 ib->ib.dlid = 0;
262
263 ib->ib.slid = 0;
264 } else {
265 ib->ib.dlid = htons(ntohl(opa->opa.dlid));
266 ib->ib.slid = htons(ntohl(opa->opa.slid));
267 }
268 ib->service_id = opa->service_id;
269 ib->ib.raw_traffic = opa->opa.raw_traffic;
270 }
271
path_conv_ib_to_opa(struct sa_path_rec * opa,struct sa_path_rec * ib)272 static inline void path_conv_ib_to_opa(struct sa_path_rec *opa,
273 struct sa_path_rec *ib)
274 {
275 __be32 slid, dlid;
276
277 if ((ib_is_opa_gid(&ib->sgid)) ||
278 (ib_is_opa_gid(&ib->dgid))) {
279 slid = htonl(opa_get_lid_from_gid(&ib->sgid));
280 dlid = htonl(opa_get_lid_from_gid(&ib->dgid));
281 } else {
282 slid = htonl(ntohs(ib->ib.slid));
283 dlid = htonl(ntohs(ib->ib.dlid));
284 }
285 opa->opa.slid = slid;
286 opa->opa.dlid = dlid;
287 opa->service_id = ib->service_id;
288 opa->opa.raw_traffic = ib->ib.raw_traffic;
289 }
290
291 /* Convert from OPA to IB path record */
sa_convert_path_opa_to_ib(struct sa_path_rec * dest,struct sa_path_rec * src)292 static inline void sa_convert_path_opa_to_ib(struct sa_path_rec *dest,
293 struct sa_path_rec *src)
294 {
295 if (src->rec_type != SA_PATH_REC_TYPE_OPA)
296 return;
297
298 *dest = *src;
299 dest->rec_type = SA_PATH_REC_TYPE_IB;
300 path_conv_opa_to_ib(dest, src);
301 }
302
303 /* Convert from IB to OPA path record */
sa_convert_path_ib_to_opa(struct sa_path_rec * dest,struct sa_path_rec * src)304 static inline void sa_convert_path_ib_to_opa(struct sa_path_rec *dest,
305 struct sa_path_rec *src)
306 {
307 if (src->rec_type != SA_PATH_REC_TYPE_IB)
308 return;
309
310 /* Do a structure copy and overwrite the relevant fields */
311 *dest = *src;
312 dest->rec_type = SA_PATH_REC_TYPE_OPA;
313 path_conv_ib_to_opa(dest, src);
314 }
315
316 #define IB_SA_MCMEMBER_REC_MGID IB_SA_COMP_MASK( 0)
317 #define IB_SA_MCMEMBER_REC_PORT_GID IB_SA_COMP_MASK( 1)
318 #define IB_SA_MCMEMBER_REC_QKEY IB_SA_COMP_MASK( 2)
319 #define IB_SA_MCMEMBER_REC_MLID IB_SA_COMP_MASK( 3)
320 #define IB_SA_MCMEMBER_REC_MTU_SELECTOR IB_SA_COMP_MASK( 4)
321 #define IB_SA_MCMEMBER_REC_MTU IB_SA_COMP_MASK( 5)
322 #define IB_SA_MCMEMBER_REC_TRAFFIC_CLASS IB_SA_COMP_MASK( 6)
323 #define IB_SA_MCMEMBER_REC_PKEY IB_SA_COMP_MASK( 7)
324 #define IB_SA_MCMEMBER_REC_RATE_SELECTOR IB_SA_COMP_MASK( 8)
325 #define IB_SA_MCMEMBER_REC_RATE IB_SA_COMP_MASK( 9)
326 #define IB_SA_MCMEMBER_REC_PACKET_LIFE_TIME_SELECTOR IB_SA_COMP_MASK(10)
327 #define IB_SA_MCMEMBER_REC_PACKET_LIFE_TIME IB_SA_COMP_MASK(11)
328 #define IB_SA_MCMEMBER_REC_SL IB_SA_COMP_MASK(12)
329 #define IB_SA_MCMEMBER_REC_FLOW_LABEL IB_SA_COMP_MASK(13)
330 #define IB_SA_MCMEMBER_REC_HOP_LIMIT IB_SA_COMP_MASK(14)
331 #define IB_SA_MCMEMBER_REC_SCOPE IB_SA_COMP_MASK(15)
332 #define IB_SA_MCMEMBER_REC_JOIN_STATE IB_SA_COMP_MASK(16)
333 #define IB_SA_MCMEMBER_REC_PROXY_JOIN IB_SA_COMP_MASK(17)
334
335 struct ib_sa_mcmember_rec {
336 union ib_gid mgid;
337 union ib_gid port_gid;
338 __be32 qkey;
339 __be16 mlid;
340 u8 mtu_selector;
341 u8 mtu;
342 u8 traffic_class;
343 __be16 pkey;
344 u8 rate_selector;
345 u8 rate;
346 u8 packet_life_time_selector;
347 u8 packet_life_time;
348 u8 sl;
349 __be32 flow_label;
350 u8 hop_limit;
351 u8 scope;
352 u8 join_state;
353 u8 proxy_join;
354 };
355
356 /* Service Record Component Mask Sec 15.2.5.14 Ver 1.1 */
357 #define IB_SA_SERVICE_REC_SERVICE_ID IB_SA_COMP_MASK( 0)
358 #define IB_SA_SERVICE_REC_SERVICE_GID IB_SA_COMP_MASK( 1)
359 #define IB_SA_SERVICE_REC_SERVICE_PKEY IB_SA_COMP_MASK( 2)
360 /* reserved: 3 */
361 #define IB_SA_SERVICE_REC_SERVICE_LEASE IB_SA_COMP_MASK( 4)
362 #define IB_SA_SERVICE_REC_SERVICE_KEY IB_SA_COMP_MASK( 5)
363 #define IB_SA_SERVICE_REC_SERVICE_NAME IB_SA_COMP_MASK( 6)
364 #define IB_SA_SERVICE_REC_SERVICE_DATA8_0 IB_SA_COMP_MASK( 7)
365 #define IB_SA_SERVICE_REC_SERVICE_DATA8_1 IB_SA_COMP_MASK( 8)
366 #define IB_SA_SERVICE_REC_SERVICE_DATA8_2 IB_SA_COMP_MASK( 9)
367 #define IB_SA_SERVICE_REC_SERVICE_DATA8_3 IB_SA_COMP_MASK(10)
368 #define IB_SA_SERVICE_REC_SERVICE_DATA8_4 IB_SA_COMP_MASK(11)
369 #define IB_SA_SERVICE_REC_SERVICE_DATA8_5 IB_SA_COMP_MASK(12)
370 #define IB_SA_SERVICE_REC_SERVICE_DATA8_6 IB_SA_COMP_MASK(13)
371 #define IB_SA_SERVICE_REC_SERVICE_DATA8_7 IB_SA_COMP_MASK(14)
372 #define IB_SA_SERVICE_REC_SERVICE_DATA8_8 IB_SA_COMP_MASK(15)
373 #define IB_SA_SERVICE_REC_SERVICE_DATA8_9 IB_SA_COMP_MASK(16)
374 #define IB_SA_SERVICE_REC_SERVICE_DATA8_10 IB_SA_COMP_MASK(17)
375 #define IB_SA_SERVICE_REC_SERVICE_DATA8_11 IB_SA_COMP_MASK(18)
376 #define IB_SA_SERVICE_REC_SERVICE_DATA8_12 IB_SA_COMP_MASK(19)
377 #define IB_SA_SERVICE_REC_SERVICE_DATA8_13 IB_SA_COMP_MASK(20)
378 #define IB_SA_SERVICE_REC_SERVICE_DATA8_14 IB_SA_COMP_MASK(21)
379 #define IB_SA_SERVICE_REC_SERVICE_DATA8_15 IB_SA_COMP_MASK(22)
380 #define IB_SA_SERVICE_REC_SERVICE_DATA16_0 IB_SA_COMP_MASK(23)
381 #define IB_SA_SERVICE_REC_SERVICE_DATA16_1 IB_SA_COMP_MASK(24)
382 #define IB_SA_SERVICE_REC_SERVICE_DATA16_2 IB_SA_COMP_MASK(25)
383 #define IB_SA_SERVICE_REC_SERVICE_DATA16_3 IB_SA_COMP_MASK(26)
384 #define IB_SA_SERVICE_REC_SERVICE_DATA16_4 IB_SA_COMP_MASK(27)
385 #define IB_SA_SERVICE_REC_SERVICE_DATA16_5 IB_SA_COMP_MASK(28)
386 #define IB_SA_SERVICE_REC_SERVICE_DATA16_6 IB_SA_COMP_MASK(29)
387 #define IB_SA_SERVICE_REC_SERVICE_DATA16_7 IB_SA_COMP_MASK(30)
388 #define IB_SA_SERVICE_REC_SERVICE_DATA32_0 IB_SA_COMP_MASK(31)
389 #define IB_SA_SERVICE_REC_SERVICE_DATA32_1 IB_SA_COMP_MASK(32)
390 #define IB_SA_SERVICE_REC_SERVICE_DATA32_2 IB_SA_COMP_MASK(33)
391 #define IB_SA_SERVICE_REC_SERVICE_DATA32_3 IB_SA_COMP_MASK(34)
392 #define IB_SA_SERVICE_REC_SERVICE_DATA64_0 IB_SA_COMP_MASK(35)
393 #define IB_SA_SERVICE_REC_SERVICE_DATA64_1 IB_SA_COMP_MASK(36)
394
395 #define IB_DEFAULT_SERVICE_LEASE 0xFFFFFFFF
396
397 struct ib_sa_service_rec {
398 u64 id;
399 union ib_gid gid;
400 __be16 pkey;
401 /* reserved */
402 u32 lease;
403 u8 key[16];
404 u8 name[64];
405 u8 data8[16];
406 u16 data16[8];
407 u32 data32[4];
408 u64 data64[2];
409 };
410
411 #define IB_SA_GUIDINFO_REC_LID IB_SA_COMP_MASK(0)
412 #define IB_SA_GUIDINFO_REC_BLOCK_NUM IB_SA_COMP_MASK(1)
413 #define IB_SA_GUIDINFO_REC_RES1 IB_SA_COMP_MASK(2)
414 #define IB_SA_GUIDINFO_REC_RES2 IB_SA_COMP_MASK(3)
415 #define IB_SA_GUIDINFO_REC_GID0 IB_SA_COMP_MASK(4)
416 #define IB_SA_GUIDINFO_REC_GID1 IB_SA_COMP_MASK(5)
417 #define IB_SA_GUIDINFO_REC_GID2 IB_SA_COMP_MASK(6)
418 #define IB_SA_GUIDINFO_REC_GID3 IB_SA_COMP_MASK(7)
419 #define IB_SA_GUIDINFO_REC_GID4 IB_SA_COMP_MASK(8)
420 #define IB_SA_GUIDINFO_REC_GID5 IB_SA_COMP_MASK(9)
421 #define IB_SA_GUIDINFO_REC_GID6 IB_SA_COMP_MASK(10)
422 #define IB_SA_GUIDINFO_REC_GID7 IB_SA_COMP_MASK(11)
423
424 struct ib_sa_guidinfo_rec {
425 __be16 lid;
426 u8 block_num;
427 /* reserved */
428 u8 res1;
429 __be32 res2;
430 u8 guid_info_list[64];
431 };
432
433 struct ib_sa_client {
434 atomic_t users;
435 struct completion comp;
436 };
437
438 /**
439 * ib_sa_register_client - Register an SA client.
440 */
441 void ib_sa_register_client(struct ib_sa_client *client);
442
443 /**
444 * ib_sa_unregister_client - Deregister an SA client.
445 * @client: Client object to deregister.
446 */
447 void ib_sa_unregister_client(struct ib_sa_client *client);
448
449 struct ib_sa_query;
450
451 void ib_sa_cancel_query(int id, struct ib_sa_query *query);
452
453 int ib_sa_path_rec_get(struct ib_sa_client *client,
454 struct ib_device *device, u8 port_num,
455 struct sa_path_rec *rec,
456 ib_sa_comp_mask comp_mask,
457 int timeout_ms, gfp_t gfp_mask,
458 void (*callback)(int status,
459 struct sa_path_rec *resp,
460 void *context),
461 void *context,
462 struct ib_sa_query **query);
463
464 int ib_sa_service_rec_query(struct ib_sa_client *client,
465 struct ib_device *device, u8 port_num,
466 u8 method,
467 struct ib_sa_service_rec *rec,
468 ib_sa_comp_mask comp_mask,
469 int timeout_ms, gfp_t gfp_mask,
470 void (*callback)(int status,
471 struct ib_sa_service_rec *resp,
472 void *context),
473 void *context,
474 struct ib_sa_query **sa_query);
475
476 struct ib_sa_multicast {
477 struct ib_sa_mcmember_rec rec;
478 ib_sa_comp_mask comp_mask;
479 int (*callback)(int status,
480 struct ib_sa_multicast *multicast);
481 void *context;
482 };
483
484 /**
485 * ib_sa_join_multicast - Initiates a join request to the specified multicast
486 * group.
487 * @client: SA client
488 * @device: Device associated with the multicast group.
489 * @port_num: Port on the specified device to associate with the multicast
490 * group.
491 * @rec: SA multicast member record specifying group attributes.
492 * @comp_mask: Component mask indicating which group attributes of %rec are
493 * valid.
494 * @gfp_mask: GFP mask for memory allocations.
495 * @callback: User callback invoked once the join operation completes.
496 * @context: User specified context stored with the ib_sa_multicast structure.
497 *
498 * This call initiates a multicast join request with the SA for the specified
499 * multicast group. If the join operation is started successfully, it returns
500 * an ib_sa_multicast structure that is used to track the multicast operation.
501 * Users must free this structure by calling ib_free_multicast, even if the
502 * join operation later fails. (The callback status is non-zero.)
503 *
504 * If the join operation fails; status will be non-zero, with the following
505 * failures possible:
506 * -ETIMEDOUT: The request timed out.
507 * -EIO: An error occurred sending the query.
508 * -EINVAL: The MCMemberRecord values differed from the existing group's.
509 * -ENETRESET: Indicates that an fatal error has occurred on the multicast
510 * group, and the user must rejoin the group to continue using it.
511 */
512 struct ib_sa_multicast *ib_sa_join_multicast(struct ib_sa_client *client,
513 struct ib_device *device, u8 port_num,
514 struct ib_sa_mcmember_rec *rec,
515 ib_sa_comp_mask comp_mask, gfp_t gfp_mask,
516 int (*callback)(int status,
517 struct ib_sa_multicast
518 *multicast),
519 void *context);
520
521 /**
522 * ib_free_multicast - Frees the multicast tracking structure, and releases
523 * any reference on the multicast group.
524 * @multicast: Multicast tracking structure allocated by ib_join_multicast.
525 *
526 * This call blocks until the multicast identifier is destroyed. It may
527 * not be called from within the multicast callback; however, returning a non-
528 * zero value from the callback will result in destroying the multicast
529 * tracking structure.
530 */
531 void ib_sa_free_multicast(struct ib_sa_multicast *multicast);
532
533 /**
534 * ib_get_mcmember_rec - Looks up a multicast member record by its MGID and
535 * returns it if found.
536 * @device: Device associated with the multicast group.
537 * @port_num: Port on the specified device to associate with the multicast
538 * group.
539 * @mgid: MGID of multicast group.
540 * @rec: Location to copy SA multicast member record.
541 */
542 int ib_sa_get_mcmember_rec(struct ib_device *device, u8 port_num,
543 union ib_gid *mgid, struct ib_sa_mcmember_rec *rec);
544
545 /**
546 * ib_init_ah_from_mcmember - Initialize address handle attributes based on
547 * an SA multicast member record.
548 */
549 int ib_init_ah_from_mcmember(struct ib_device *device, u8 port_num,
550 struct ib_sa_mcmember_rec *rec,
551 if_t ndev,
552 enum ib_gid_type gid_type,
553 struct rdma_ah_attr *ah_attr);
554
555 int ib_init_ah_attr_from_path(struct ib_device *device, u8 port_num,
556 struct sa_path_rec *rec,
557 struct rdma_ah_attr *ah_attr,
558 const struct ib_gid_attr *sgid_attr);
559
560 /**
561 * ib_sa_pack_path - Conert a path record from struct ib_sa_path_rec
562 * to IB MAD wire format.
563 */
564 void ib_sa_pack_path(struct sa_path_rec *rec, void *attribute);
565
566 /**
567 * ib_sa_unpack_path - Convert a path record from MAD format to struct
568 * ib_sa_path_rec.
569 */
570 void ib_sa_unpack_path(void *attribute, struct sa_path_rec *rec);
571
572 /* Support GuidInfoRecord */
573 int ib_sa_guid_info_rec_query(struct ib_sa_client *client,
574 struct ib_device *device, u8 port_num,
575 struct ib_sa_guidinfo_rec *rec,
576 ib_sa_comp_mask comp_mask, u8 method,
577 int timeout_ms, gfp_t gfp_mask,
578 void (*callback)(int status,
579 struct ib_sa_guidinfo_rec *resp,
580 void *context),
581 void *context,
582 struct ib_sa_query **sa_query);
583
584 bool ib_sa_sendonly_fullmem_support(struct ib_sa_client *client,
585 struct ib_device *device,
586 u8 port_num);
587
sa_path_is_roce(struct sa_path_rec * rec)588 static inline bool sa_path_is_roce(struct sa_path_rec *rec)
589 {
590 return ((rec->rec_type == SA_PATH_REC_TYPE_ROCE_V1) ||
591 (rec->rec_type == SA_PATH_REC_TYPE_ROCE_V2));
592 }
593
sa_path_is_opa(struct sa_path_rec * rec)594 static inline bool sa_path_is_opa(struct sa_path_rec *rec)
595 {
596 return (rec->rec_type == SA_PATH_REC_TYPE_OPA);
597 }
598
sa_path_set_slid(struct sa_path_rec * rec,__be32 slid)599 static inline void sa_path_set_slid(struct sa_path_rec *rec, __be32 slid)
600 {
601 if (rec->rec_type == SA_PATH_REC_TYPE_IB)
602 rec->ib.slid = htons(ntohl(slid));
603 else if (rec->rec_type == SA_PATH_REC_TYPE_OPA)
604 rec->opa.slid = slid;
605 }
606
sa_path_set_dlid(struct sa_path_rec * rec,__be32 dlid)607 static inline void sa_path_set_dlid(struct sa_path_rec *rec, __be32 dlid)
608 {
609 if (rec->rec_type == SA_PATH_REC_TYPE_IB)
610 rec->ib.dlid = htons(ntohl(dlid));
611 else if (rec->rec_type == SA_PATH_REC_TYPE_OPA)
612 rec->opa.dlid = dlid;
613 }
614
sa_path_set_raw_traffic(struct sa_path_rec * rec,u8 raw_traffic)615 static inline void sa_path_set_raw_traffic(struct sa_path_rec *rec,
616 u8 raw_traffic)
617 {
618 if (rec->rec_type == SA_PATH_REC_TYPE_IB)
619 rec->ib.raw_traffic = raw_traffic;
620 else if (rec->rec_type == SA_PATH_REC_TYPE_OPA)
621 rec->opa.raw_traffic = raw_traffic;
622 }
623
sa_path_get_slid(struct sa_path_rec * rec)624 static inline __be32 sa_path_get_slid(struct sa_path_rec *rec)
625 {
626 if (rec->rec_type == SA_PATH_REC_TYPE_IB)
627 return htonl(ntohs(rec->ib.slid));
628 else if (rec->rec_type == SA_PATH_REC_TYPE_OPA)
629 return rec->opa.slid;
630 return 0;
631 }
632
sa_path_get_dlid(struct sa_path_rec * rec)633 static inline __be32 sa_path_get_dlid(struct sa_path_rec *rec)
634 {
635 if (rec->rec_type == SA_PATH_REC_TYPE_IB)
636 return htonl(ntohs(rec->ib.dlid));
637 else if (rec->rec_type == SA_PATH_REC_TYPE_OPA)
638 return rec->opa.dlid;
639 return 0;
640 }
641
sa_path_get_raw_traffic(struct sa_path_rec * rec)642 static inline u8 sa_path_get_raw_traffic(struct sa_path_rec *rec)
643 {
644 if (rec->rec_type == SA_PATH_REC_TYPE_IB)
645 return rec->ib.raw_traffic;
646 else if (rec->rec_type == SA_PATH_REC_TYPE_OPA)
647 return rec->opa.raw_traffic;
648 return 0;
649 }
650
sa_path_set_dmac(struct sa_path_rec * rec,u8 * dmac)651 static inline void sa_path_set_dmac(struct sa_path_rec *rec, u8 *dmac)
652 {
653 if (sa_path_is_roce(rec))
654 memcpy(rec->roce.dmac, dmac, ETH_ALEN);
655 }
656
sa_path_set_dmac_zero(struct sa_path_rec * rec)657 static inline void sa_path_set_dmac_zero(struct sa_path_rec *rec)
658 {
659 if (sa_path_is_roce(rec))
660 eth_zero_addr(rec->roce.dmac);
661 }
662
sa_path_get_dmac(struct sa_path_rec * rec)663 static inline u8 *sa_path_get_dmac(struct sa_path_rec *rec)
664 {
665 if (sa_path_is_roce(rec))
666 return rec->roce.dmac;
667 return NULL;
668 }
669 #endif /* IB_SA_H */
670