2 * SPDX-License-Identifier: BSD-2-Clause OR GPL-2.0
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.
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:
14 * Redistribution and use in source and binary forms, with or
15 * without modification, are permitted provided that the following
18 * - Redistributions of source code must retain the above
19 * copyright notice, this list of conditions and the following
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.
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
42 #include <linux/completion.h>
43 #include <linux/compiler.h>
44 #include <linux/netdevice.h>
46 #include <rdma/ib_verbs.h>
47 #include <rdma/ib_mad.h>
50 IB_SA_CLASS_VERSION = 2, /* IB spec version 1.1/1.2 */
52 IB_SA_METHOD_GET_TABLE = 0x12,
53 IB_SA_METHOD_GET_TABLE_RESP = 0x92,
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
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
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.
100 * There are 4 types of join states:
101 * FullMember, NonMember, SendOnlyNonMember, SendOnlyFullMember.
102 * The order corresponds to JoinState bits in MCMemberRecord.
104 enum ib_sa_mc_join_states {
107 SENDONLY_NONMEBER_JOIN,
108 SENDONLY_FULLMEMBER_JOIN,
109 NUM_JOIN_MEMBERSHIP_TYPES,
112 #define IB_SA_CAP_MASK2_SENDONLY_FULL_MEM_SUPPORT BIT(12)
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
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).
125 * Reserved rows are indicated with comments to help maintainability.
128 #define IB_SA_PATH_REC_SERVICE_ID (IB_SA_COMP_MASK( 0) |\
130 #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)
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)
142 #define IB_SA_PATH_REC_QOS_CLASS IB_SA_COMP_MASK(14)
143 #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)
152 struct ib_sa_path_rec {
172 u8 packet_life_time_selector;
180 enum ib_gid_type gid_type;
183 static inline struct net_device *ib_get_ndev_from_path(struct ib_sa_path_rec *rec)
186 if (rec->net == NULL)
189 return dev_get_by_index(rec->net, rec->ifindex);
192 #define IB_SA_MCMEMBER_REC_MGID IB_SA_COMP_MASK( 0)
193 #define IB_SA_MCMEMBER_REC_PORT_GID IB_SA_COMP_MASK( 1)
194 #define IB_SA_MCMEMBER_REC_QKEY IB_SA_COMP_MASK( 2)
195 #define IB_SA_MCMEMBER_REC_MLID IB_SA_COMP_MASK( 3)
196 #define IB_SA_MCMEMBER_REC_MTU_SELECTOR IB_SA_COMP_MASK( 4)
197 #define IB_SA_MCMEMBER_REC_MTU IB_SA_COMP_MASK( 5)
198 #define IB_SA_MCMEMBER_REC_TRAFFIC_CLASS IB_SA_COMP_MASK( 6)
199 #define IB_SA_MCMEMBER_REC_PKEY IB_SA_COMP_MASK( 7)
200 #define IB_SA_MCMEMBER_REC_RATE_SELECTOR IB_SA_COMP_MASK( 8)
201 #define IB_SA_MCMEMBER_REC_RATE IB_SA_COMP_MASK( 9)
202 #define IB_SA_MCMEMBER_REC_PACKET_LIFE_TIME_SELECTOR IB_SA_COMP_MASK(10)
203 #define IB_SA_MCMEMBER_REC_PACKET_LIFE_TIME IB_SA_COMP_MASK(11)
204 #define IB_SA_MCMEMBER_REC_SL IB_SA_COMP_MASK(12)
205 #define IB_SA_MCMEMBER_REC_FLOW_LABEL IB_SA_COMP_MASK(13)
206 #define IB_SA_MCMEMBER_REC_HOP_LIMIT IB_SA_COMP_MASK(14)
207 #define IB_SA_MCMEMBER_REC_SCOPE IB_SA_COMP_MASK(15)
208 #define IB_SA_MCMEMBER_REC_JOIN_STATE IB_SA_COMP_MASK(16)
209 #define IB_SA_MCMEMBER_REC_PROXY_JOIN IB_SA_COMP_MASK(17)
211 struct ib_sa_mcmember_rec {
213 union ib_gid port_gid;
222 u8 packet_life_time_selector;
232 /* Service Record Component Mask Sec 15.2.5.14 Ver 1.1 */
233 #define IB_SA_SERVICE_REC_SERVICE_ID IB_SA_COMP_MASK( 0)
234 #define IB_SA_SERVICE_REC_SERVICE_GID IB_SA_COMP_MASK( 1)
235 #define IB_SA_SERVICE_REC_SERVICE_PKEY IB_SA_COMP_MASK( 2)
237 #define IB_SA_SERVICE_REC_SERVICE_LEASE IB_SA_COMP_MASK( 4)
238 #define IB_SA_SERVICE_REC_SERVICE_KEY IB_SA_COMP_MASK( 5)
239 #define IB_SA_SERVICE_REC_SERVICE_NAME IB_SA_COMP_MASK( 6)
240 #define IB_SA_SERVICE_REC_SERVICE_DATA8_0 IB_SA_COMP_MASK( 7)
241 #define IB_SA_SERVICE_REC_SERVICE_DATA8_1 IB_SA_COMP_MASK( 8)
242 #define IB_SA_SERVICE_REC_SERVICE_DATA8_2 IB_SA_COMP_MASK( 9)
243 #define IB_SA_SERVICE_REC_SERVICE_DATA8_3 IB_SA_COMP_MASK(10)
244 #define IB_SA_SERVICE_REC_SERVICE_DATA8_4 IB_SA_COMP_MASK(11)
245 #define IB_SA_SERVICE_REC_SERVICE_DATA8_5 IB_SA_COMP_MASK(12)
246 #define IB_SA_SERVICE_REC_SERVICE_DATA8_6 IB_SA_COMP_MASK(13)
247 #define IB_SA_SERVICE_REC_SERVICE_DATA8_7 IB_SA_COMP_MASK(14)
248 #define IB_SA_SERVICE_REC_SERVICE_DATA8_8 IB_SA_COMP_MASK(15)
249 #define IB_SA_SERVICE_REC_SERVICE_DATA8_9 IB_SA_COMP_MASK(16)
250 #define IB_SA_SERVICE_REC_SERVICE_DATA8_10 IB_SA_COMP_MASK(17)
251 #define IB_SA_SERVICE_REC_SERVICE_DATA8_11 IB_SA_COMP_MASK(18)
252 #define IB_SA_SERVICE_REC_SERVICE_DATA8_12 IB_SA_COMP_MASK(19)
253 #define IB_SA_SERVICE_REC_SERVICE_DATA8_13 IB_SA_COMP_MASK(20)
254 #define IB_SA_SERVICE_REC_SERVICE_DATA8_14 IB_SA_COMP_MASK(21)
255 #define IB_SA_SERVICE_REC_SERVICE_DATA8_15 IB_SA_COMP_MASK(22)
256 #define IB_SA_SERVICE_REC_SERVICE_DATA16_0 IB_SA_COMP_MASK(23)
257 #define IB_SA_SERVICE_REC_SERVICE_DATA16_1 IB_SA_COMP_MASK(24)
258 #define IB_SA_SERVICE_REC_SERVICE_DATA16_2 IB_SA_COMP_MASK(25)
259 #define IB_SA_SERVICE_REC_SERVICE_DATA16_3 IB_SA_COMP_MASK(26)
260 #define IB_SA_SERVICE_REC_SERVICE_DATA16_4 IB_SA_COMP_MASK(27)
261 #define IB_SA_SERVICE_REC_SERVICE_DATA16_5 IB_SA_COMP_MASK(28)
262 #define IB_SA_SERVICE_REC_SERVICE_DATA16_6 IB_SA_COMP_MASK(29)
263 #define IB_SA_SERVICE_REC_SERVICE_DATA16_7 IB_SA_COMP_MASK(30)
264 #define IB_SA_SERVICE_REC_SERVICE_DATA32_0 IB_SA_COMP_MASK(31)
265 #define IB_SA_SERVICE_REC_SERVICE_DATA32_1 IB_SA_COMP_MASK(32)
266 #define IB_SA_SERVICE_REC_SERVICE_DATA32_2 IB_SA_COMP_MASK(33)
267 #define IB_SA_SERVICE_REC_SERVICE_DATA32_3 IB_SA_COMP_MASK(34)
268 #define IB_SA_SERVICE_REC_SERVICE_DATA64_0 IB_SA_COMP_MASK(35)
269 #define IB_SA_SERVICE_REC_SERVICE_DATA64_1 IB_SA_COMP_MASK(36)
271 #define IB_DEFAULT_SERVICE_LEASE 0xFFFFFFFF
273 struct ib_sa_service_rec {
287 #define IB_SA_GUIDINFO_REC_LID IB_SA_COMP_MASK(0)
288 #define IB_SA_GUIDINFO_REC_BLOCK_NUM IB_SA_COMP_MASK(1)
289 #define IB_SA_GUIDINFO_REC_RES1 IB_SA_COMP_MASK(2)
290 #define IB_SA_GUIDINFO_REC_RES2 IB_SA_COMP_MASK(3)
291 #define IB_SA_GUIDINFO_REC_GID0 IB_SA_COMP_MASK(4)
292 #define IB_SA_GUIDINFO_REC_GID1 IB_SA_COMP_MASK(5)
293 #define IB_SA_GUIDINFO_REC_GID2 IB_SA_COMP_MASK(6)
294 #define IB_SA_GUIDINFO_REC_GID3 IB_SA_COMP_MASK(7)
295 #define IB_SA_GUIDINFO_REC_GID4 IB_SA_COMP_MASK(8)
296 #define IB_SA_GUIDINFO_REC_GID5 IB_SA_COMP_MASK(9)
297 #define IB_SA_GUIDINFO_REC_GID6 IB_SA_COMP_MASK(10)
298 #define IB_SA_GUIDINFO_REC_GID7 IB_SA_COMP_MASK(11)
300 struct ib_sa_guidinfo_rec {
306 u8 guid_info_list[64];
309 struct ib_sa_client {
311 struct completion comp;
315 * ib_sa_register_client - Register an SA client.
317 void ib_sa_register_client(struct ib_sa_client *client);
320 * ib_sa_unregister_client - Deregister an SA client.
321 * @client: Client object to deregister.
323 void ib_sa_unregister_client(struct ib_sa_client *client);
327 void ib_sa_cancel_query(int id, struct ib_sa_query *query);
329 int ib_sa_path_rec_get(struct ib_sa_client *client,
330 struct ib_device *device, u8 port_num,
331 struct ib_sa_path_rec *rec,
332 ib_sa_comp_mask comp_mask,
333 int timeout_ms, gfp_t gfp_mask,
334 void (*callback)(int status,
335 struct ib_sa_path_rec *resp,
338 struct ib_sa_query **query);
340 int ib_sa_service_rec_query(struct ib_sa_client *client,
341 struct ib_device *device, u8 port_num,
343 struct ib_sa_service_rec *rec,
344 ib_sa_comp_mask comp_mask,
345 int timeout_ms, gfp_t gfp_mask,
346 void (*callback)(int status,
347 struct ib_sa_service_rec *resp,
350 struct ib_sa_query **sa_query);
352 struct ib_sa_multicast {
353 struct ib_sa_mcmember_rec rec;
354 ib_sa_comp_mask comp_mask;
355 int (*callback)(int status,
356 struct ib_sa_multicast *multicast);
361 * ib_sa_join_multicast - Initiates a join request to the specified multicast
364 * @device: Device associated with the multicast group.
365 * @port_num: Port on the specified device to associate with the multicast
367 * @rec: SA multicast member record specifying group attributes.
368 * @comp_mask: Component mask indicating which group attributes of %rec are
370 * @gfp_mask: GFP mask for memory allocations.
371 * @callback: User callback invoked once the join operation completes.
372 * @context: User specified context stored with the ib_sa_multicast structure.
374 * This call initiates a multicast join request with the SA for the specified
375 * multicast group. If the join operation is started successfully, it returns
376 * an ib_sa_multicast structure that is used to track the multicast operation.
377 * Users must free this structure by calling ib_free_multicast, even if the
378 * join operation later fails. (The callback status is non-zero.)
380 * If the join operation fails; status will be non-zero, with the following
382 * -ETIMEDOUT: The request timed out.
383 * -EIO: An error occurred sending the query.
384 * -EINVAL: The MCMemberRecord values differed from the existing group's.
385 * -ENETRESET: Indicates that an fatal error has occurred on the multicast
386 * group, and the user must rejoin the group to continue using it.
388 struct ib_sa_multicast *ib_sa_join_multicast(struct ib_sa_client *client,
389 struct ib_device *device, u8 port_num,
390 struct ib_sa_mcmember_rec *rec,
391 ib_sa_comp_mask comp_mask, gfp_t gfp_mask,
392 int (*callback)(int status,
393 struct ib_sa_multicast
398 * ib_free_multicast - Frees the multicast tracking structure, and releases
399 * any reference on the multicast group.
400 * @multicast: Multicast tracking structure allocated by ib_join_multicast.
402 * This call blocks until the multicast identifier is destroyed. It may
403 * not be called from within the multicast callback; however, returning a non-
404 * zero value from the callback will result in destroying the multicast
405 * tracking structure.
407 void ib_sa_free_multicast(struct ib_sa_multicast *multicast);
410 * ib_get_mcmember_rec - Looks up a multicast member record by its MGID and
411 * returns it if found.
412 * @device: Device associated with the multicast group.
413 * @port_num: Port on the specified device to associate with the multicast
415 * @mgid: MGID of multicast group.
416 * @rec: Location to copy SA multicast member record.
418 int ib_sa_get_mcmember_rec(struct ib_device *device, u8 port_num,
419 union ib_gid *mgid, struct ib_sa_mcmember_rec *rec);
422 * ib_init_ah_from_mcmember - Initialize address handle attributes based on
423 * an SA multicast member record.
425 int ib_init_ah_from_mcmember(struct ib_device *device, u8 port_num,
426 struct ib_sa_mcmember_rec *rec,
427 struct net_device *ndev,
428 enum ib_gid_type gid_type,
429 struct ib_ah_attr *ah_attr);
432 * ib_init_ah_from_path - Initialize address handle attributes based on an SA
435 int ib_init_ah_from_path(struct ib_device *device, u8 port_num,
436 struct ib_sa_path_rec *rec,
437 struct ib_ah_attr *ah_attr);
440 * ib_sa_pack_path - Conert a path record from struct ib_sa_path_rec
441 * to IB MAD wire format.
443 void ib_sa_pack_path(struct ib_sa_path_rec *rec, void *attribute);
446 * ib_sa_unpack_path - Convert a path record from MAD format to struct
449 void ib_sa_unpack_path(void *attribute, struct ib_sa_path_rec *rec);
451 /* Support GuidInfoRecord */
452 int ib_sa_guid_info_rec_query(struct ib_sa_client *client,
453 struct ib_device *device, u8 port_num,
454 struct ib_sa_guidinfo_rec *rec,
455 ib_sa_comp_mask comp_mask, u8 method,
456 int timeout_ms, gfp_t gfp_mask,
457 void (*callback)(int status,
458 struct ib_sa_guidinfo_rec *resp,
461 struct ib_sa_query **sa_query);
463 /* Support get SA ClassPortInfo */
464 int ib_sa_classport_info_rec_query(struct ib_sa_client *client,
465 struct ib_device *device, u8 port_num,
466 int timeout_ms, gfp_t gfp_mask,
467 void (*callback)(int status,
468 struct ib_class_port_info *resp,
471 struct ib_sa_query **sa_query);