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