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