blob: c72c9494961762572163d7f87003840058b3b355 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * Copyright (c) 2004 Topspin Communications. All rights reserved.
Hal Rosenstockcbae32c2005-07-27 11:45:38 -07003 * Copyright (c) 2005 Voltaire, Inc. All rights reserved.
Michael S. Tsirkinc1a0b232006-08-21 16:40:12 -07004 * Copyright (c) 2006 Intel Corporation. All rights reserved.
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 *
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.
Linus Torvalds1da177e2005-04-16 15:20:36 -070033 */
34
35#ifndef IB_SA_H
36#define IB_SA_H
37
Michael S. Tsirkinc1a0b232006-08-21 16:40:12 -070038#include <linux/completion.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070039#include <linux/compiler.h>
40
Arun Sharma600634972011-07-26 16:09:06 -070041#include <linux/atomic.h>
Matan Barakba36e372015-10-15 18:38:47 +030042#include <linux/netdevice.h>
Michael S. Tsirkinc1a0b232006-08-21 16:40:12 -070043
Roland Dreiera4d61e82005-08-25 13:40:04 -070044#include <rdma/ib_verbs.h>
45#include <rdma/ib_mad.h>
Dasaratharaman Chandramouli9fdca4d2017-04-27 19:06:00 -040046#include <rdma/ib_addr.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070047
48enum {
Hal Rosenstockcbae32c2005-07-27 11:45:38 -070049 IB_SA_CLASS_VERSION = 2, /* IB spec version 1.1/1.2 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070050
Hal Rosenstockcbae32c2005-07-27 11:45:38 -070051 IB_SA_METHOD_GET_TABLE = 0x12,
52 IB_SA_METHOD_GET_TABLE_RESP = 0x92,
Hal Rosenstock1325cc72005-09-09 13:45:51 -070053 IB_SA_METHOD_DELETE = 0x15,
54 IB_SA_METHOD_DELETE_RESP = 0x95,
55 IB_SA_METHOD_GET_MULTI = 0x14,
56 IB_SA_METHOD_GET_MULTI_RESP = 0x94,
57 IB_SA_METHOD_GET_TRACE_TBL = 0x13
Linus Torvalds1da177e2005-04-16 15:20:36 -070058};
59
Dasaratharaman Chandramouli2196f272017-04-28 19:20:26 -040060#define OPA_SA_CLASS_VERSION 0x80
Hal Rosenstockfbed8ee2005-09-09 15:24:04 -070061enum {
62 IB_SA_ATTR_CLASS_PORTINFO = 0x01,
63 IB_SA_ATTR_NOTICE = 0x02,
64 IB_SA_ATTR_INFORM_INFO = 0x03,
65 IB_SA_ATTR_NODE_REC = 0x11,
66 IB_SA_ATTR_PORT_INFO_REC = 0x12,
67 IB_SA_ATTR_SL2VL_REC = 0x13,
68 IB_SA_ATTR_SWITCH_REC = 0x14,
69 IB_SA_ATTR_LINEAR_FDB_REC = 0x15,
70 IB_SA_ATTR_RANDOM_FDB_REC = 0x16,
71 IB_SA_ATTR_MCAST_FDB_REC = 0x17,
72 IB_SA_ATTR_SM_INFO_REC = 0x18,
73 IB_SA_ATTR_LINK_REC = 0x20,
74 IB_SA_ATTR_GUID_INFO_REC = 0x30,
75 IB_SA_ATTR_SERVICE_REC = 0x31,
76 IB_SA_ATTR_PARTITION_REC = 0x33,
77 IB_SA_ATTR_PATH_REC = 0x35,
78 IB_SA_ATTR_VL_ARB_REC = 0x36,
79 IB_SA_ATTR_MC_MEMBER_REC = 0x38,
80 IB_SA_ATTR_TRACE_REC = 0x39,
81 IB_SA_ATTR_MULTI_PATH_REC = 0x3a,
82 IB_SA_ATTR_SERVICE_ASSOC_REC = 0x3b,
83 IB_SA_ATTR_INFORM_INFO_REC = 0xf3
84};
85
Linus Torvalds1da177e2005-04-16 15:20:36 -070086enum ib_sa_selector {
Michael S. Tsirkinaec79fc2006-09-18 22:17:08 +030087 IB_SA_GT = 0,
88 IB_SA_LT = 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -070089 IB_SA_EQ = 2,
90 /*
91 * The meaning of "best" depends on the attribute: for
92 * example, for MTU best will return the largest available
93 * MTU, while for packet life time, best will return the
94 * smallest available life time.
95 */
96 IB_SA_BEST = 3
97};
98
Alex Veskerab15c952016-07-06 16:36:35 +030099/*
100 * There are 4 types of join states:
101 * FullMember, NonMember, SendOnlyNonMember, SendOnlyFullMember.
102 * The order corresponds to JoinState bits in MCMemberRecord.
103 */
104enum ib_sa_mc_join_states {
105 FULLMEMBER_JOIN,
106 NONMEMBER_JOIN,
107 SENDONLY_NONMEBER_JOIN,
108 SENDONLY_FULLMEMBER_JOIN,
109 NUM_JOIN_MEMBERSHIP_TYPES,
110};
111
Erez Shitrit628e6f72016-05-25 22:02:05 +0300112#define IB_SA_CAP_MASK2_SENDONLY_FULL_MEM_SUPPORT BIT(12)
113
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114/*
115 * Structures for SA records are named "struct ib_sa_xxx_rec." No
116 * attempt is made to pack structures to match the physical layout of
117 * SA records in SA MADs; all packing and unpacking is handled by the
118 * SA query code.
119 *
120 * For a record with structure ib_sa_xxx_rec, the naming convention
121 * for the component mask value for field yyy is IB_SA_XXX_REC_YYY (we
122 * never use different abbreviations or otherwise change the spelling
123 * of xxx/yyy between ib_sa_xxx_rec.yyy and IB_SA_XXX_REC_YYY).
124 *
125 * Reserved rows are indicated with comments to help maintainability.
126 */
127
Sean Hefty733d65f2007-08-08 15:41:28 -0700128#define IB_SA_PATH_REC_SERVICE_ID (IB_SA_COMP_MASK( 0) |\
129 IB_SA_COMP_MASK( 1))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130#define IB_SA_PATH_REC_DGID IB_SA_COMP_MASK( 2)
131#define IB_SA_PATH_REC_SGID IB_SA_COMP_MASK( 3)
132#define IB_SA_PATH_REC_DLID IB_SA_COMP_MASK( 4)
133#define IB_SA_PATH_REC_SLID IB_SA_COMP_MASK( 5)
134#define IB_SA_PATH_REC_RAW_TRAFFIC IB_SA_COMP_MASK( 6)
135/* reserved: 7 */
136#define IB_SA_PATH_REC_FLOW_LABEL IB_SA_COMP_MASK( 8)
137#define IB_SA_PATH_REC_HOP_LIMIT IB_SA_COMP_MASK( 9)
138#define IB_SA_PATH_REC_TRAFFIC_CLASS IB_SA_COMP_MASK(10)
139#define IB_SA_PATH_REC_REVERSIBLE IB_SA_COMP_MASK(11)
140#define IB_SA_PATH_REC_NUMB_PATH IB_SA_COMP_MASK(12)
141#define IB_SA_PATH_REC_PKEY IB_SA_COMP_MASK(13)
Sean Hefty733d65f2007-08-08 15:41:28 -0700142#define IB_SA_PATH_REC_QOS_CLASS IB_SA_COMP_MASK(14)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143#define IB_SA_PATH_REC_SL IB_SA_COMP_MASK(15)
144#define IB_SA_PATH_REC_MTU_SELECTOR IB_SA_COMP_MASK(16)
145#define IB_SA_PATH_REC_MTU IB_SA_COMP_MASK(17)
146#define IB_SA_PATH_REC_RATE_SELECTOR IB_SA_COMP_MASK(18)
147#define IB_SA_PATH_REC_RATE IB_SA_COMP_MASK(19)
148#define IB_SA_PATH_REC_PACKET_LIFE_TIME_SELECTOR IB_SA_COMP_MASK(20)
149#define IB_SA_PATH_REC_PACKET_LIFE_TIME IB_SA_COMP_MASK(21)
150#define IB_SA_PATH_REC_PREFERENCE IB_SA_COMP_MASK(22)
Dasaratharaman Chandramouli9fdca4d2017-04-27 19:06:00 -0400151
Dasaratharaman Chandramoulidfa834e12017-04-27 19:05:59 -0400152enum sa_path_rec_type {
153 SA_PATH_REC_TYPE_IB,
154 SA_PATH_REC_TYPE_ROCE_V1,
155 SA_PATH_REC_TYPE_ROCE_V2
156};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157
Dasaratharaman Chandramouli9fdca4d2017-04-27 19:06:00 -0400158struct sa_path_rec_ib {
Sean Hefty733d65f2007-08-08 15:41:28 -0700159 __be64 service_id;
Sean Hefty97f52eb2005-08-13 21:05:57 -0700160 __be16 dlid;
161 __be16 slid;
Jason Gunthorpe55efcfc2016-12-22 18:07:52 -0700162 u8 raw_traffic;
Dasaratharaman Chandramouli9fdca4d2017-04-27 19:06:00 -0400163};
164
165struct sa_path_rec_roce {
166 u8 dmac[ETH_ALEN];
167 /* ignored in IB */
168 int ifindex;
169 /* ignored in IB */
170 struct net *net;
171
172};
173
174struct sa_path_rec {
175 union ib_gid dgid;
176 union ib_gid sgid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177 /* reserved */
Sean Hefty97f52eb2005-08-13 21:05:57 -0700178 __be32 flow_label;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179 u8 hop_limit;
180 u8 traffic_class;
Jason Gunthorpe55efcfc2016-12-22 18:07:52 -0700181 u8 reversible;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182 u8 numb_path;
Sean Hefty97f52eb2005-08-13 21:05:57 -0700183 __be16 pkey;
Sean Hefty733d65f2007-08-08 15:41:28 -0700184 __be16 qos_class;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185 u8 sl;
186 u8 mtu_selector;
Roland Dreier3bf4fb82005-05-25 12:31:31 -0700187 u8 mtu;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188 u8 rate_selector;
189 u8 rate;
190 u8 packet_life_time_selector;
191 u8 packet_life_time;
192 u8 preference;
Dasaratharaman Chandramouli9fdca4d2017-04-27 19:06:00 -0400193 union {
194 struct sa_path_rec_ib ib;
195 struct sa_path_rec_roce roce;
196 };
Dasaratharaman Chandramoulidfa834e12017-04-27 19:05:59 -0400197 enum sa_path_rec_type rec_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198};
199
Dasaratharaman Chandramoulidfa834e12017-04-27 19:05:59 -0400200static inline enum ib_gid_type
201 sa_conv_pathrec_to_gid_type(struct sa_path_rec *rec)
202{
203 switch (rec->rec_type) {
204 case SA_PATH_REC_TYPE_ROCE_V1:
205 return IB_GID_TYPE_ROCE;
206 case SA_PATH_REC_TYPE_ROCE_V2:
207 return IB_GID_TYPE_ROCE_UDP_ENCAP;
208 default:
209 return IB_GID_TYPE_IB;
210 }
211}
212
213static inline enum sa_path_rec_type
214 sa_conv_gid_to_pathrec_type(enum ib_gid_type type)
215{
216 switch (type) {
217 case IB_GID_TYPE_ROCE:
218 return SA_PATH_REC_TYPE_ROCE_V1;
219 case IB_GID_TYPE_ROCE_UDP_ENCAP:
220 return SA_PATH_REC_TYPE_ROCE_V2;
221 default:
222 return SA_PATH_REC_TYPE_IB;
223 }
224}
225
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226#define IB_SA_MCMEMBER_REC_MGID IB_SA_COMP_MASK( 0)
227#define IB_SA_MCMEMBER_REC_PORT_GID IB_SA_COMP_MASK( 1)
228#define IB_SA_MCMEMBER_REC_QKEY IB_SA_COMP_MASK( 2)
229#define IB_SA_MCMEMBER_REC_MLID IB_SA_COMP_MASK( 3)
230#define IB_SA_MCMEMBER_REC_MTU_SELECTOR IB_SA_COMP_MASK( 4)
231#define IB_SA_MCMEMBER_REC_MTU IB_SA_COMP_MASK( 5)
232#define IB_SA_MCMEMBER_REC_TRAFFIC_CLASS IB_SA_COMP_MASK( 6)
233#define IB_SA_MCMEMBER_REC_PKEY IB_SA_COMP_MASK( 7)
234#define IB_SA_MCMEMBER_REC_RATE_SELECTOR IB_SA_COMP_MASK( 8)
235#define IB_SA_MCMEMBER_REC_RATE IB_SA_COMP_MASK( 9)
236#define IB_SA_MCMEMBER_REC_PACKET_LIFE_TIME_SELECTOR IB_SA_COMP_MASK(10)
237#define IB_SA_MCMEMBER_REC_PACKET_LIFE_TIME IB_SA_COMP_MASK(11)
238#define IB_SA_MCMEMBER_REC_SL IB_SA_COMP_MASK(12)
239#define IB_SA_MCMEMBER_REC_FLOW_LABEL IB_SA_COMP_MASK(13)
240#define IB_SA_MCMEMBER_REC_HOP_LIMIT IB_SA_COMP_MASK(14)
241#define IB_SA_MCMEMBER_REC_SCOPE IB_SA_COMP_MASK(15)
242#define IB_SA_MCMEMBER_REC_JOIN_STATE IB_SA_COMP_MASK(16)
243#define IB_SA_MCMEMBER_REC_PROXY_JOIN IB_SA_COMP_MASK(17)
244
245struct ib_sa_mcmember_rec {
246 union ib_gid mgid;
247 union ib_gid port_gid;
Sean Hefty97f52eb2005-08-13 21:05:57 -0700248 __be32 qkey;
249 __be16 mlid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250 u8 mtu_selector;
Roland Dreier3bf4fb82005-05-25 12:31:31 -0700251 u8 mtu;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 u8 traffic_class;
Sean Hefty97f52eb2005-08-13 21:05:57 -0700253 __be16 pkey;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254 u8 rate_selector;
255 u8 rate;
256 u8 packet_life_time_selector;
257 u8 packet_life_time;
258 u8 sl;
Sean Hefty97f52eb2005-08-13 21:05:57 -0700259 __be32 flow_label;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260 u8 hop_limit;
261 u8 scope;
262 u8 join_state;
Jason Gunthorpe55efcfc2016-12-22 18:07:52 -0700263 u8 proxy_join;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264};
265
Hal Rosenstockcbae32c2005-07-27 11:45:38 -0700266/* Service Record Component Mask Sec 15.2.5.14 Ver 1.1 */
267#define IB_SA_SERVICE_REC_SERVICE_ID IB_SA_COMP_MASK( 0)
268#define IB_SA_SERVICE_REC_SERVICE_GID IB_SA_COMP_MASK( 1)
269#define IB_SA_SERVICE_REC_SERVICE_PKEY IB_SA_COMP_MASK( 2)
270/* reserved: 3 */
271#define IB_SA_SERVICE_REC_SERVICE_LEASE IB_SA_COMP_MASK( 4)
272#define IB_SA_SERVICE_REC_SERVICE_KEY IB_SA_COMP_MASK( 5)
273#define IB_SA_SERVICE_REC_SERVICE_NAME IB_SA_COMP_MASK( 6)
274#define IB_SA_SERVICE_REC_SERVICE_DATA8_0 IB_SA_COMP_MASK( 7)
275#define IB_SA_SERVICE_REC_SERVICE_DATA8_1 IB_SA_COMP_MASK( 8)
276#define IB_SA_SERVICE_REC_SERVICE_DATA8_2 IB_SA_COMP_MASK( 9)
277#define IB_SA_SERVICE_REC_SERVICE_DATA8_3 IB_SA_COMP_MASK(10)
278#define IB_SA_SERVICE_REC_SERVICE_DATA8_4 IB_SA_COMP_MASK(11)
279#define IB_SA_SERVICE_REC_SERVICE_DATA8_5 IB_SA_COMP_MASK(12)
280#define IB_SA_SERVICE_REC_SERVICE_DATA8_6 IB_SA_COMP_MASK(13)
281#define IB_SA_SERVICE_REC_SERVICE_DATA8_7 IB_SA_COMP_MASK(14)
282#define IB_SA_SERVICE_REC_SERVICE_DATA8_8 IB_SA_COMP_MASK(15)
283#define IB_SA_SERVICE_REC_SERVICE_DATA8_9 IB_SA_COMP_MASK(16)
284#define IB_SA_SERVICE_REC_SERVICE_DATA8_10 IB_SA_COMP_MASK(17)
285#define IB_SA_SERVICE_REC_SERVICE_DATA8_11 IB_SA_COMP_MASK(18)
286#define IB_SA_SERVICE_REC_SERVICE_DATA8_12 IB_SA_COMP_MASK(19)
287#define IB_SA_SERVICE_REC_SERVICE_DATA8_13 IB_SA_COMP_MASK(20)
288#define IB_SA_SERVICE_REC_SERVICE_DATA8_14 IB_SA_COMP_MASK(21)
289#define IB_SA_SERVICE_REC_SERVICE_DATA8_15 IB_SA_COMP_MASK(22)
290#define IB_SA_SERVICE_REC_SERVICE_DATA16_0 IB_SA_COMP_MASK(23)
291#define IB_SA_SERVICE_REC_SERVICE_DATA16_1 IB_SA_COMP_MASK(24)
292#define IB_SA_SERVICE_REC_SERVICE_DATA16_2 IB_SA_COMP_MASK(25)
293#define IB_SA_SERVICE_REC_SERVICE_DATA16_3 IB_SA_COMP_MASK(26)
294#define IB_SA_SERVICE_REC_SERVICE_DATA16_4 IB_SA_COMP_MASK(27)
295#define IB_SA_SERVICE_REC_SERVICE_DATA16_5 IB_SA_COMP_MASK(28)
296#define IB_SA_SERVICE_REC_SERVICE_DATA16_6 IB_SA_COMP_MASK(29)
297#define IB_SA_SERVICE_REC_SERVICE_DATA16_7 IB_SA_COMP_MASK(30)
298#define IB_SA_SERVICE_REC_SERVICE_DATA32_0 IB_SA_COMP_MASK(31)
299#define IB_SA_SERVICE_REC_SERVICE_DATA32_1 IB_SA_COMP_MASK(32)
300#define IB_SA_SERVICE_REC_SERVICE_DATA32_2 IB_SA_COMP_MASK(33)
301#define IB_SA_SERVICE_REC_SERVICE_DATA32_3 IB_SA_COMP_MASK(34)
302#define IB_SA_SERVICE_REC_SERVICE_DATA64_0 IB_SA_COMP_MASK(35)
303#define IB_SA_SERVICE_REC_SERVICE_DATA64_1 IB_SA_COMP_MASK(36)
304
305#define IB_DEFAULT_SERVICE_LEASE 0xFFFFFFFF
306
307struct ib_sa_service_rec {
308 u64 id;
309 union ib_gid gid;
Sean Hefty97f52eb2005-08-13 21:05:57 -0700310 __be16 pkey;
Hal Rosenstockcbae32c2005-07-27 11:45:38 -0700311 /* reserved */
312 u32 lease;
313 u8 key[16];
314 u8 name[64];
315 u8 data8[16];
316 u16 data16[8];
317 u32 data32[4];
318 u64 data64[2];
319};
320
Erez Shitritaeab97e2012-06-19 11:21:38 +0300321#define IB_SA_GUIDINFO_REC_LID IB_SA_COMP_MASK(0)
322#define IB_SA_GUIDINFO_REC_BLOCK_NUM IB_SA_COMP_MASK(1)
323#define IB_SA_GUIDINFO_REC_RES1 IB_SA_COMP_MASK(2)
324#define IB_SA_GUIDINFO_REC_RES2 IB_SA_COMP_MASK(3)
325#define IB_SA_GUIDINFO_REC_GID0 IB_SA_COMP_MASK(4)
326#define IB_SA_GUIDINFO_REC_GID1 IB_SA_COMP_MASK(5)
327#define IB_SA_GUIDINFO_REC_GID2 IB_SA_COMP_MASK(6)
328#define IB_SA_GUIDINFO_REC_GID3 IB_SA_COMP_MASK(7)
329#define IB_SA_GUIDINFO_REC_GID4 IB_SA_COMP_MASK(8)
330#define IB_SA_GUIDINFO_REC_GID5 IB_SA_COMP_MASK(9)
331#define IB_SA_GUIDINFO_REC_GID6 IB_SA_COMP_MASK(10)
332#define IB_SA_GUIDINFO_REC_GID7 IB_SA_COMP_MASK(11)
333
334struct ib_sa_guidinfo_rec {
335 __be16 lid;
336 u8 block_num;
337 /* reserved */
338 u8 res1;
339 __be32 res2;
340 u8 guid_info_list[64];
341};
342
Michael S. Tsirkinc1a0b232006-08-21 16:40:12 -0700343struct ib_sa_client {
344 atomic_t users;
345 struct completion comp;
346};
347
348/**
349 * ib_sa_register_client - Register an SA client.
350 */
351void ib_sa_register_client(struct ib_sa_client *client);
352
353/**
354 * ib_sa_unregister_client - Deregister an SA client.
355 * @client: Client object to deregister.
356 */
357void ib_sa_unregister_client(struct ib_sa_client *client);
358
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359struct ib_sa_query;
360
361void ib_sa_cancel_query(int id, struct ib_sa_query *query);
362
Michael S. Tsirkinc1a0b232006-08-21 16:40:12 -0700363int ib_sa_path_rec_get(struct ib_sa_client *client,
364 struct ib_device *device, u8 port_num,
Dasaratharaman Chandramoulic2f8fc42017-04-27 19:05:58 -0400365 struct sa_path_rec *rec,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366 ib_sa_comp_mask comp_mask,
Al Virodd0fc662005-10-07 07:46:04 +0100367 int timeout_ms, gfp_t gfp_mask,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368 void (*callback)(int status,
Dasaratharaman Chandramoulic2f8fc42017-04-27 19:05:58 -0400369 struct sa_path_rec *resp,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370 void *context),
371 void *context,
372 struct ib_sa_query **query);
373
Michael S. Tsirkinc1a0b232006-08-21 16:40:12 -0700374int ib_sa_service_rec_query(struct ib_sa_client *client,
375 struct ib_device *device, u8 port_num,
Hal Rosenstockcbae32c2005-07-27 11:45:38 -0700376 u8 method,
377 struct ib_sa_service_rec *rec,
378 ib_sa_comp_mask comp_mask,
Al Virodd0fc662005-10-07 07:46:04 +0100379 int timeout_ms, gfp_t gfp_mask,
Hal Rosenstockcbae32c2005-07-27 11:45:38 -0700380 void (*callback)(int status,
381 struct ib_sa_service_rec *resp,
382 void *context),
383 void *context,
384 struct ib_sa_query **sa_query);
385
Sean Heftyfaec2f72007-02-15 17:00:17 -0800386struct ib_sa_multicast {
387 struct ib_sa_mcmember_rec rec;
388 ib_sa_comp_mask comp_mask;
389 int (*callback)(int status,
390 struct ib_sa_multicast *multicast);
391 void *context;
392};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393
394/**
Sean Heftyfaec2f72007-02-15 17:00:17 -0800395 * ib_sa_join_multicast - Initiates a join request to the specified multicast
396 * group.
397 * @client: SA client
398 * @device: Device associated with the multicast group.
399 * @port_num: Port on the specified device to associate with the multicast
400 * group.
401 * @rec: SA multicast member record specifying group attributes.
402 * @comp_mask: Component mask indicating which group attributes of %rec are
403 * valid.
404 * @gfp_mask: GFP mask for memory allocations.
405 * @callback: User callback invoked once the join operation completes.
406 * @context: User specified context stored with the ib_sa_multicast structure.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407 *
Sean Heftyfaec2f72007-02-15 17:00:17 -0800408 * This call initiates a multicast join request with the SA for the specified
409 * multicast group. If the join operation is started successfully, it returns
410 * an ib_sa_multicast structure that is used to track the multicast operation.
411 * Users must free this structure by calling ib_free_multicast, even if the
412 * join operation later fails. (The callback status is non-zero.)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413 *
Sean Heftyfaec2f72007-02-15 17:00:17 -0800414 * If the join operation fails; status will be non-zero, with the following
415 * failures possible:
416 * -ETIMEDOUT: The request timed out.
417 * -EIO: An error occurred sending the query.
418 * -EINVAL: The MCMemberRecord values differed from the existing group's.
419 * -ENETRESET: Indicates that an fatal error has occurred on the multicast
420 * group, and the user must rejoin the group to continue using it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421 */
Sean Heftyfaec2f72007-02-15 17:00:17 -0800422struct ib_sa_multicast *ib_sa_join_multicast(struct ib_sa_client *client,
423 struct ib_device *device, u8 port_num,
424 struct ib_sa_mcmember_rec *rec,
425 ib_sa_comp_mask comp_mask, gfp_t gfp_mask,
426 int (*callback)(int status,
427 struct ib_sa_multicast
428 *multicast),
429 void *context);
430
431/**
432 * ib_free_multicast - Frees the multicast tracking structure, and releases
433 * any reference on the multicast group.
434 * @multicast: Multicast tracking structure allocated by ib_join_multicast.
435 *
436 * This call blocks until the multicast identifier is destroyed. It may
437 * not be called from within the multicast callback; however, returning a non-
438 * zero value from the callback will result in destroying the multicast
439 * tracking structure.
440 */
441void ib_sa_free_multicast(struct ib_sa_multicast *multicast);
442
443/**
444 * ib_get_mcmember_rec - Looks up a multicast member record by its MGID and
445 * returns it if found.
446 * @device: Device associated with the multicast group.
447 * @port_num: Port on the specified device to associate with the multicast
448 * group.
449 * @mgid: MGID of multicast group.
450 * @rec: Location to copy SA multicast member record.
451 */
452int ib_sa_get_mcmember_rec(struct ib_device *device, u8 port_num,
453 union ib_gid *mgid, struct ib_sa_mcmember_rec *rec);
454
455/**
456 * ib_init_ah_from_mcmember - Initialize address handle attributes based on
457 * an SA multicast member record.
458 */
459int ib_init_ah_from_mcmember(struct ib_device *device, u8 port_num,
460 struct ib_sa_mcmember_rec *rec,
Moni Shouabee3c3c2015-12-23 14:56:57 +0200461 struct net_device *ndev,
462 enum ib_gid_type gid_type,
Dasaratharaman Chandramouli90898852017-04-29 14:41:18 -0400463 struct rdma_ah_attr *ah_attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464
Sean Hefty6d969a42006-06-17 20:37:39 -0700465/**
466 * ib_init_ah_from_path - Initialize address handle attributes based on an SA
467 * path record.
468 */
469int ib_init_ah_from_path(struct ib_device *device, u8 port_num,
Dasaratharaman Chandramoulic2f8fc42017-04-27 19:05:58 -0400470 struct sa_path_rec *rec,
Dasaratharaman Chandramouli90898852017-04-29 14:41:18 -0400471 struct rdma_ah_attr *ah_attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472
Sean Heftya7ca1f02009-11-16 09:30:33 -0800473/**
Sean Hefty2e08b582013-05-29 10:09:26 -0700474 * ib_sa_pack_path - Conert a path record from struct ib_sa_path_rec
475 * to IB MAD wire format.
476 */
Dasaratharaman Chandramoulic2f8fc42017-04-27 19:05:58 -0400477void ib_sa_pack_path(struct sa_path_rec *rec, void *attribute);
Sean Hefty2e08b582013-05-29 10:09:26 -0700478
479/**
Sean Heftya7ca1f02009-11-16 09:30:33 -0800480 * ib_sa_unpack_path - Convert a path record from MAD format to struct
481 * ib_sa_path_rec.
482 */
Dasaratharaman Chandramoulic2f8fc42017-04-27 19:05:58 -0400483void ib_sa_unpack_path(void *attribute, struct sa_path_rec *rec);
Sean Heftya7ca1f02009-11-16 09:30:33 -0800484
Erez Shitritaeab97e2012-06-19 11:21:38 +0300485/* Support GuidInfoRecord */
486int ib_sa_guid_info_rec_query(struct ib_sa_client *client,
487 struct ib_device *device, u8 port_num,
488 struct ib_sa_guidinfo_rec *rec,
489 ib_sa_comp_mask comp_mask, u8 method,
490 int timeout_ms, gfp_t gfp_mask,
491 void (*callback)(int status,
492 struct ib_sa_guidinfo_rec *resp,
493 void *context),
494 void *context,
495 struct ib_sa_query **sa_query);
Sean Hefty2e08b582013-05-29 10:09:26 -0700496
Dasaratharaman Chandramouliee1c60b2017-03-20 19:38:08 -0400497bool ib_sa_sendonly_fullmem_support(struct ib_sa_client *client,
498 struct ib_device *device,
499 u8 port_num);
Erez Shitrit628e6f72016-05-25 22:02:05 +0300500
Dasaratharaman Chandramouli9fdca4d2017-04-27 19:06:00 -0400501static inline bool sa_path_is_roce(struct sa_path_rec *rec)
502{
503 return ((rec->rec_type == SA_PATH_REC_TYPE_ROCE_V1) ||
504 (rec->rec_type == SA_PATH_REC_TYPE_ROCE_V2));
505}
506
507static inline void sa_path_set_service_id(struct sa_path_rec *rec,
508 __be64 service_id)
509{
510 if (rec->rec_type == SA_PATH_REC_TYPE_IB)
511 rec->ib.service_id = service_id;
512}
513
514static inline void sa_path_set_slid(struct sa_path_rec *rec, __be16 slid)
515{
516 if (rec->rec_type == SA_PATH_REC_TYPE_IB)
517 rec->ib.slid = slid;
518}
519
520static inline void sa_path_set_dlid(struct sa_path_rec *rec, __be16 dlid)
521{
522 if (rec->rec_type == SA_PATH_REC_TYPE_IB)
523 rec->ib.dlid = dlid;
524}
525
526static inline void sa_path_set_raw_traffic(struct sa_path_rec *rec,
527 u8 raw_traffic)
528{
529 if (rec->rec_type == SA_PATH_REC_TYPE_IB)
530 rec->ib.raw_traffic = raw_traffic;
531}
532
533static inline __be64 sa_path_get_service_id(struct sa_path_rec *rec)
534{
535 if (rec->rec_type == SA_PATH_REC_TYPE_IB)
536 return rec->ib.service_id;
537 return 0;
538}
539
540static inline __be16 sa_path_get_slid(struct sa_path_rec *rec)
541{
542 if (rec->rec_type == SA_PATH_REC_TYPE_IB)
543 return rec->ib.slid;
544 return 0;
545}
546
547static inline __be16 sa_path_get_dlid(struct sa_path_rec *rec)
548{
549 if (rec->rec_type == SA_PATH_REC_TYPE_IB)
550 return rec->ib.dlid;
551 return 0;
552}
553
554static inline u8 sa_path_get_raw_traffic(struct sa_path_rec *rec)
555{
556 if (rec->rec_type == SA_PATH_REC_TYPE_IB)
557 return rec->ib.raw_traffic;
558 return 0;
559}
560
561static inline void sa_path_set_dmac(struct sa_path_rec *rec, u8 *dmac)
562{
563 if (sa_path_is_roce(rec))
564 memcpy(rec->roce.dmac, dmac, ETH_ALEN);
565}
566
567static inline void sa_path_set_dmac_zero(struct sa_path_rec *rec)
568{
569 if (sa_path_is_roce(rec))
570 eth_zero_addr(rec->roce.dmac);
571}
572
573static inline void sa_path_set_ifindex(struct sa_path_rec *rec, int ifindex)
574{
575 if (sa_path_is_roce(rec))
576 rec->roce.ifindex = ifindex;
577}
578
579static inline void sa_path_set_ndev(struct sa_path_rec *rec, struct net *net)
580{
581 if (sa_path_is_roce(rec))
582 rec->roce.net = net;
583}
584
585static inline u8 *sa_path_get_dmac(struct sa_path_rec *rec)
586{
587 if (sa_path_is_roce(rec))
588 return rec->roce.dmac;
589 return NULL;
590}
591
592static inline int sa_path_get_ifindex(struct sa_path_rec *rec)
593{
594 if (sa_path_is_roce(rec))
595 return rec->roce.ifindex;
596 return 0;
597}
598
599static inline struct net *sa_path_get_ndev(struct sa_path_rec *rec)
600{
601 if (sa_path_is_roce(rec))
602 return rec->roce.net;
603 return NULL;
604}
605
606static inline struct net_device *ib_get_ndev_from_path(struct sa_path_rec *rec)
607{
608 return sa_path_get_ndev(rec) ?
609 dev_get_by_index(sa_path_get_ndev(rec),
610 sa_path_get_ifindex(rec))
611 : NULL;
612}
613
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614#endif /* IB_SA_H */