2 * Copyright (c) 2004 Topspin Communications. All rights reserved.
3 * Copyright (c) 2005 Voltaire, Inc. All rights reserved.
4 * Copyright (c) 2006 Intel Corporation. All rights reserved.
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:
12 * Redistribution and use in source and binary forms, with or
13 * without modification, are permitted provided that the following
16 * - Redistributions of source code must retain the above
17 * copyright notice, this list of conditions and the following
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.
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
38 #include <linux/completion.h>
39 #include <linux/compiler.h>
41 #include <asm/atomic.h>
43 #include <rdma/ib_verbs.h>
44 #include <rdma/ib_mad.h>
47 IB_SA_CLASS_VERSION = 2, /* IB spec version 1.1/1.2 */
49 IB_SA_METHOD_GET_TABLE = 0x12,
50 IB_SA_METHOD_GET_TABLE_RESP = 0x92,
51 IB_SA_METHOD_DELETE = 0x15,
52 IB_SA_METHOD_DELETE_RESP = 0x95,
53 IB_SA_METHOD_GET_MULTI = 0x14,
54 IB_SA_METHOD_GET_MULTI_RESP = 0x94,
55 IB_SA_METHOD_GET_TRACE_TBL = 0x13
59 IB_SA_ATTR_CLASS_PORTINFO = 0x01,
60 IB_SA_ATTR_NOTICE = 0x02,
61 IB_SA_ATTR_INFORM_INFO = 0x03,
62 IB_SA_ATTR_NODE_REC = 0x11,
63 IB_SA_ATTR_PORT_INFO_REC = 0x12,
64 IB_SA_ATTR_SL2VL_REC = 0x13,
65 IB_SA_ATTR_SWITCH_REC = 0x14,
66 IB_SA_ATTR_LINEAR_FDB_REC = 0x15,
67 IB_SA_ATTR_RANDOM_FDB_REC = 0x16,
68 IB_SA_ATTR_MCAST_FDB_REC = 0x17,
69 IB_SA_ATTR_SM_INFO_REC = 0x18,
70 IB_SA_ATTR_LINK_REC = 0x20,
71 IB_SA_ATTR_GUID_INFO_REC = 0x30,
72 IB_SA_ATTR_SERVICE_REC = 0x31,
73 IB_SA_ATTR_PARTITION_REC = 0x33,
74 IB_SA_ATTR_PATH_REC = 0x35,
75 IB_SA_ATTR_VL_ARB_REC = 0x36,
76 IB_SA_ATTR_MC_MEMBER_REC = 0x38,
77 IB_SA_ATTR_TRACE_REC = 0x39,
78 IB_SA_ATTR_MULTI_PATH_REC = 0x3a,
79 IB_SA_ATTR_SERVICE_ASSOC_REC = 0x3b,
80 IB_SA_ATTR_INFORM_INFO_REC = 0xf3
88 * The meaning of "best" depends on the attribute: for
89 * example, for MTU best will return the largest available
90 * MTU, while for packet life time, best will return the
91 * smallest available life time.
97 * Structures for SA records are named "struct ib_sa_xxx_rec." No
98 * attempt is made to pack structures to match the physical layout of
99 * SA records in SA MADs; all packing and unpacking is handled by the
102 * For a record with structure ib_sa_xxx_rec, the naming convention
103 * for the component mask value for field yyy is IB_SA_XXX_REC_YYY (we
104 * never use different abbreviations or otherwise change the spelling
105 * of xxx/yyy between ib_sa_xxx_rec.yyy and IB_SA_XXX_REC_YYY).
107 * Reserved rows are indicated with comments to help maintainability.
110 #define IB_SA_PATH_REC_SERVICE_ID (IB_SA_COMP_MASK( 0) |\
112 #define IB_SA_PATH_REC_DGID IB_SA_COMP_MASK( 2)
113 #define IB_SA_PATH_REC_SGID IB_SA_COMP_MASK( 3)
114 #define IB_SA_PATH_REC_DLID IB_SA_COMP_MASK( 4)
115 #define IB_SA_PATH_REC_SLID IB_SA_COMP_MASK( 5)
116 #define IB_SA_PATH_REC_RAW_TRAFFIC IB_SA_COMP_MASK( 6)
118 #define IB_SA_PATH_REC_FLOW_LABEL IB_SA_COMP_MASK( 8)
119 #define IB_SA_PATH_REC_HOP_LIMIT IB_SA_COMP_MASK( 9)
120 #define IB_SA_PATH_REC_TRAFFIC_CLASS IB_SA_COMP_MASK(10)
121 #define IB_SA_PATH_REC_REVERSIBLE IB_SA_COMP_MASK(11)
122 #define IB_SA_PATH_REC_NUMB_PATH IB_SA_COMP_MASK(12)
123 #define IB_SA_PATH_REC_PKEY IB_SA_COMP_MASK(13)
124 #define IB_SA_PATH_REC_QOS_CLASS IB_SA_COMP_MASK(14)
125 #define IB_SA_PATH_REC_SL IB_SA_COMP_MASK(15)
126 #define IB_SA_PATH_REC_MTU_SELECTOR IB_SA_COMP_MASK(16)
127 #define IB_SA_PATH_REC_MTU IB_SA_COMP_MASK(17)
128 #define IB_SA_PATH_REC_RATE_SELECTOR IB_SA_COMP_MASK(18)
129 #define IB_SA_PATH_REC_RATE IB_SA_COMP_MASK(19)
130 #define IB_SA_PATH_REC_PACKET_LIFE_TIME_SELECTOR IB_SA_COMP_MASK(20)
131 #define IB_SA_PATH_REC_PACKET_LIFE_TIME IB_SA_COMP_MASK(21)
132 #define IB_SA_PATH_REC_PREFERENCE IB_SA_COMP_MASK(22)
134 struct ib_sa_path_rec {
154 u8 packet_life_time_selector;
159 #define IB_SA_MCMEMBER_REC_MGID IB_SA_COMP_MASK( 0)
160 #define IB_SA_MCMEMBER_REC_PORT_GID IB_SA_COMP_MASK( 1)
161 #define IB_SA_MCMEMBER_REC_QKEY IB_SA_COMP_MASK( 2)
162 #define IB_SA_MCMEMBER_REC_MLID IB_SA_COMP_MASK( 3)
163 #define IB_SA_MCMEMBER_REC_MTU_SELECTOR IB_SA_COMP_MASK( 4)
164 #define IB_SA_MCMEMBER_REC_MTU IB_SA_COMP_MASK( 5)
165 #define IB_SA_MCMEMBER_REC_TRAFFIC_CLASS IB_SA_COMP_MASK( 6)
166 #define IB_SA_MCMEMBER_REC_PKEY IB_SA_COMP_MASK( 7)
167 #define IB_SA_MCMEMBER_REC_RATE_SELECTOR IB_SA_COMP_MASK( 8)
168 #define IB_SA_MCMEMBER_REC_RATE IB_SA_COMP_MASK( 9)
169 #define IB_SA_MCMEMBER_REC_PACKET_LIFE_TIME_SELECTOR IB_SA_COMP_MASK(10)
170 #define IB_SA_MCMEMBER_REC_PACKET_LIFE_TIME IB_SA_COMP_MASK(11)
171 #define IB_SA_MCMEMBER_REC_SL IB_SA_COMP_MASK(12)
172 #define IB_SA_MCMEMBER_REC_FLOW_LABEL IB_SA_COMP_MASK(13)
173 #define IB_SA_MCMEMBER_REC_HOP_LIMIT IB_SA_COMP_MASK(14)
174 #define IB_SA_MCMEMBER_REC_SCOPE IB_SA_COMP_MASK(15)
175 #define IB_SA_MCMEMBER_REC_JOIN_STATE IB_SA_COMP_MASK(16)
176 #define IB_SA_MCMEMBER_REC_PROXY_JOIN IB_SA_COMP_MASK(17)
178 struct ib_sa_mcmember_rec {
180 union ib_gid port_gid;
189 u8 packet_life_time_selector;
199 /* Service Record Component Mask Sec 15.2.5.14 Ver 1.1 */
200 #define IB_SA_SERVICE_REC_SERVICE_ID IB_SA_COMP_MASK( 0)
201 #define IB_SA_SERVICE_REC_SERVICE_GID IB_SA_COMP_MASK( 1)
202 #define IB_SA_SERVICE_REC_SERVICE_PKEY IB_SA_COMP_MASK( 2)
204 #define IB_SA_SERVICE_REC_SERVICE_LEASE IB_SA_COMP_MASK( 4)
205 #define IB_SA_SERVICE_REC_SERVICE_KEY IB_SA_COMP_MASK( 5)
206 #define IB_SA_SERVICE_REC_SERVICE_NAME IB_SA_COMP_MASK( 6)
207 #define IB_SA_SERVICE_REC_SERVICE_DATA8_0 IB_SA_COMP_MASK( 7)
208 #define IB_SA_SERVICE_REC_SERVICE_DATA8_1 IB_SA_COMP_MASK( 8)
209 #define IB_SA_SERVICE_REC_SERVICE_DATA8_2 IB_SA_COMP_MASK( 9)
210 #define IB_SA_SERVICE_REC_SERVICE_DATA8_3 IB_SA_COMP_MASK(10)
211 #define IB_SA_SERVICE_REC_SERVICE_DATA8_4 IB_SA_COMP_MASK(11)
212 #define IB_SA_SERVICE_REC_SERVICE_DATA8_5 IB_SA_COMP_MASK(12)
213 #define IB_SA_SERVICE_REC_SERVICE_DATA8_6 IB_SA_COMP_MASK(13)
214 #define IB_SA_SERVICE_REC_SERVICE_DATA8_7 IB_SA_COMP_MASK(14)
215 #define IB_SA_SERVICE_REC_SERVICE_DATA8_8 IB_SA_COMP_MASK(15)
216 #define IB_SA_SERVICE_REC_SERVICE_DATA8_9 IB_SA_COMP_MASK(16)
217 #define IB_SA_SERVICE_REC_SERVICE_DATA8_10 IB_SA_COMP_MASK(17)
218 #define IB_SA_SERVICE_REC_SERVICE_DATA8_11 IB_SA_COMP_MASK(18)
219 #define IB_SA_SERVICE_REC_SERVICE_DATA8_12 IB_SA_COMP_MASK(19)
220 #define IB_SA_SERVICE_REC_SERVICE_DATA8_13 IB_SA_COMP_MASK(20)
221 #define IB_SA_SERVICE_REC_SERVICE_DATA8_14 IB_SA_COMP_MASK(21)
222 #define IB_SA_SERVICE_REC_SERVICE_DATA8_15 IB_SA_COMP_MASK(22)
223 #define IB_SA_SERVICE_REC_SERVICE_DATA16_0 IB_SA_COMP_MASK(23)
224 #define IB_SA_SERVICE_REC_SERVICE_DATA16_1 IB_SA_COMP_MASK(24)
225 #define IB_SA_SERVICE_REC_SERVICE_DATA16_2 IB_SA_COMP_MASK(25)
226 #define IB_SA_SERVICE_REC_SERVICE_DATA16_3 IB_SA_COMP_MASK(26)
227 #define IB_SA_SERVICE_REC_SERVICE_DATA16_4 IB_SA_COMP_MASK(27)
228 #define IB_SA_SERVICE_REC_SERVICE_DATA16_5 IB_SA_COMP_MASK(28)
229 #define IB_SA_SERVICE_REC_SERVICE_DATA16_6 IB_SA_COMP_MASK(29)
230 #define IB_SA_SERVICE_REC_SERVICE_DATA16_7 IB_SA_COMP_MASK(30)
231 #define IB_SA_SERVICE_REC_SERVICE_DATA32_0 IB_SA_COMP_MASK(31)
232 #define IB_SA_SERVICE_REC_SERVICE_DATA32_1 IB_SA_COMP_MASK(32)
233 #define IB_SA_SERVICE_REC_SERVICE_DATA32_2 IB_SA_COMP_MASK(33)
234 #define IB_SA_SERVICE_REC_SERVICE_DATA32_3 IB_SA_COMP_MASK(34)
235 #define IB_SA_SERVICE_REC_SERVICE_DATA64_0 IB_SA_COMP_MASK(35)
236 #define IB_SA_SERVICE_REC_SERVICE_DATA64_1 IB_SA_COMP_MASK(36)
238 #define IB_DEFAULT_SERVICE_LEASE 0xFFFFFFFF
240 struct ib_sa_service_rec {
255 IB_SA_EVENT_TYPE_FATAL = 0x0,
256 IB_SA_EVENT_TYPE_URGENT = 0x1,
257 IB_SA_EVENT_TYPE_SECURITY = 0x2,
258 IB_SA_EVENT_TYPE_SM = 0x3,
259 IB_SA_EVENT_TYPE_INFO = 0x4,
260 IB_SA_EVENT_TYPE_EMPTY = 0x7F,
261 IB_SA_EVENT_TYPE_ALL = 0xFFFF
265 IB_SA_EVENT_PRODUCER_TYPE_CA = 0x1,
266 IB_SA_EVENT_PRODUCER_TYPE_SWITCH = 0x2,
267 IB_SA_EVENT_PRODUCER_TYPE_ROUTER = 0x3,
268 IB_SA_EVENT_PRODUCER_TYPE_CLASS_MANAGER = 0x4,
269 IB_SA_EVENT_PRODUCER_TYPE_ALL = 0xFFFFFF
273 IB_SA_SM_TRAP_GID_IN_SERVICE = 64,
274 IB_SA_SM_TRAP_GID_OUT_OF_SERVICE = 65,
275 IB_SA_SM_TRAP_CREATE_MC_GROUP = 66,
276 IB_SA_SM_TRAP_DELETE_MC_GROUP = 67,
277 IB_SA_SM_TRAP_PORT_CHANGE_STATE = 128,
278 IB_SA_SM_TRAP_LINK_INTEGRITY = 129,
279 IB_SA_SM_TRAP_EXCESSIVE_BUFFER_OVERRUN = 130,
280 IB_SA_SM_TRAP_FLOW_CONTROL_UPDATE_EXPIRED = 131,
281 IB_SA_SM_TRAP_BAD_M_KEY = 256,
282 IB_SA_SM_TRAP_BAD_P_KEY = 257,
283 IB_SA_SM_TRAP_BAD_Q_KEY = 258,
284 IB_SA_SM_TRAP_SWITCH_BAD_P_KEY = 259,
285 IB_SA_SM_TRAP_ALL = 0xFFFF
288 struct ib_sa_inform {
290 __be16 lid_range_begin;
291 __be16 lid_range_end;
300 __be32 producer_type;
311 struct ib_sa_notice {
316 __be32 producer_type;
328 * Align data 16 bits off 64 bit field to match InformInfo definition.
329 * Data contained within this field will then align properly.
330 * See IB spec 1.2, sections 13.4.8.2 and 14.2.5.1.
334 union ib_gid issuer_gid;
338 * SM notice data details for:
340 * IB_SA_SM_TRAP_GID_IN_SERVICE = 64
341 * IB_SA_SM_TRAP_GID_OUT_OF_SERVICE = 65
342 * IB_SA_SM_TRAP_CREATE_MC_GROUP = 66
343 * IB_SA_SM_TRAP_DELETE_MC_GROUP = 67
345 struct ib_sa_notice_data_gid {
352 * SM notice data details for:
354 * IB_SA_SM_TRAP_PORT_CHANGE_STATE = 128
356 struct ib_sa_notice_data_port_change {
362 * SM notice data details for:
364 * IB_SA_SM_TRAP_LINK_INTEGRITY = 129
365 * IB_SA_SM_TRAP_EXCESSIVE_BUFFER_OVERRUN = 130
366 * IB_SA_SM_TRAP_FLOW_CONTROL_UPDATE_EXPIRED = 131
368 struct ib_sa_notice_data_port_error {
375 struct ib_sa_client {
377 struct completion comp;
381 * ib_sa_register_client - Register an SA client.
383 void ib_sa_register_client(struct ib_sa_client *client);
386 * ib_sa_unregister_client - Deregister an SA client.
387 * @client: Client object to deregister.
389 void ib_sa_unregister_client(struct ib_sa_client *client);
393 void ib_sa_cancel_query(int id, struct ib_sa_query *query);
395 int ib_sa_path_rec_get(struct ib_sa_client *client,
396 struct ib_device *device, u8 port_num,
397 struct ib_sa_path_rec *rec,
398 ib_sa_comp_mask comp_mask,
399 int timeout_ms, gfp_t gfp_mask,
400 void (*callback)(int status,
401 struct ib_sa_path_rec *resp,
404 struct ib_sa_query **query);
406 int ib_sa_service_rec_query(struct ib_sa_client *client,
407 struct ib_device *device, u8 port_num,
409 struct ib_sa_service_rec *rec,
410 ib_sa_comp_mask comp_mask,
411 int timeout_ms, gfp_t gfp_mask,
412 void (*callback)(int status,
413 struct ib_sa_service_rec *resp,
416 struct ib_sa_query **sa_query);
418 struct ib_sa_multicast {
419 struct ib_sa_mcmember_rec rec;
420 ib_sa_comp_mask comp_mask;
421 int (*callback)(int status,
422 struct ib_sa_multicast *multicast);
427 * ib_sa_join_multicast - Initiates a join request to the specified multicast
430 * @device: Device associated with the multicast group.
431 * @port_num: Port on the specified device to associate with the multicast
433 * @rec: SA multicast member record specifying group attributes.
434 * @comp_mask: Component mask indicating which group attributes of %rec are
436 * @gfp_mask: GFP mask for memory allocations.
437 * @callback: User callback invoked once the join operation completes.
438 * @context: User specified context stored with the ib_sa_multicast structure.
440 * This call initiates a multicast join request with the SA for the specified
441 * multicast group. If the join operation is started successfully, it returns
442 * an ib_sa_multicast structure that is used to track the multicast operation.
443 * Users must free this structure by calling ib_free_multicast, even if the
444 * join operation later fails. (The callback status is non-zero.)
446 * If the join operation fails; status will be non-zero, with the following
448 * -ETIMEDOUT: The request timed out.
449 * -EIO: An error occurred sending the query.
450 * -EINVAL: The MCMemberRecord values differed from the existing group's.
451 * -ENETRESET: Indicates that an fatal error has occurred on the multicast
452 * group, and the user must rejoin the group to continue using it.
454 struct ib_sa_multicast *ib_sa_join_multicast(struct ib_sa_client *client,
455 struct ib_device *device, u8 port_num,
456 struct ib_sa_mcmember_rec *rec,
457 ib_sa_comp_mask comp_mask, gfp_t gfp_mask,
458 int (*callback)(int status,
459 struct ib_sa_multicast
464 * ib_free_multicast - Frees the multicast tracking structure, and releases
465 * any reference on the multicast group.
466 * @multicast: Multicast tracking structure allocated by ib_join_multicast.
468 * This call blocks until the multicast identifier is destroyed. It may
469 * not be called from within the multicast callback; however, returning a non-
470 * zero value from the callback will result in destroying the multicast
471 * tracking structure.
473 void ib_sa_free_multicast(struct ib_sa_multicast *multicast);
476 * ib_get_mcmember_rec - Looks up a multicast member record by its MGID and
477 * returns it if found.
478 * @device: Device associated with the multicast group.
479 * @port_num: Port on the specified device to associate with the multicast
481 * @mgid: MGID of multicast group.
482 * @rec: Location to copy SA multicast member record.
484 int ib_sa_get_mcmember_rec(struct ib_device *device, u8 port_num,
485 union ib_gid *mgid, struct ib_sa_mcmember_rec *rec);
488 * ib_init_ah_from_mcmember - Initialize address handle attributes based on
489 * an SA multicast member record.
491 int ib_init_ah_from_mcmember(struct ib_device *device, u8 port_num,
492 struct ib_sa_mcmember_rec *rec,
493 struct ib_ah_attr *ah_attr);
496 * ib_init_ah_from_path - Initialize address handle attributes based on an SA
499 int ib_init_ah_from_path(struct ib_device *device, u8 port_num,
500 struct ib_sa_path_rec *rec,
501 struct ib_ah_attr *ah_attr);
504 * ib_sa_unpack_path - Convert a path record from MAD format to struct
507 void ib_sa_unpack_path(void *attribute, struct ib_sa_path_rec *rec);
509 struct ib_inform_info {
511 int (*callback)(int status,
512 struct ib_inform_info *info,
513 struct ib_sa_notice *notice);
518 * ib_sa_register_inform_info - Registers to receive notice events.
519 * @device: Device associated with the registration.
520 * @port_num: Port on the specified device to associate with the registration.
521 * @trap_number: InformInfo trap number to register for.
522 * @gfp_mask: GFP mask for memory allocations.
523 * @callback: User callback invoked once the registration completes and to
524 * report noticed events.
525 * @context: User specified context stored with the ib_inform_reg structure.
527 * This call initiates a registration request with the SA for the specified
528 * trap number. If the operation is started successfully, it returns
529 * an ib_inform_info structure that is used to track the registration operation.
530 * Users must free this structure by calling ib_unregister_inform_info,
531 * even if the operation later fails. (The callback status is non-zero.)
533 * If the registration fails; status will be non-zero. If the registration
534 * succeeds, the callback status will be zero, but the notice parameter will
535 * be NULL. If the notice parameter is not NULL, a trap or notice is being
536 * reported to the user.
538 * A status of -ENETRESET indicates that an error occurred which requires
541 struct ib_inform_info *
542 ib_sa_register_inform_info(struct ib_sa_client *client,
543 struct ib_device *device, u8 port_num,
544 u16 trap_number, gfp_t gfp_mask,
545 int (*callback)(int status,
546 struct ib_inform_info *info,
547 struct ib_sa_notice *notice),
551 * ib_sa_unregister_inform_info - Releases an InformInfo registration.
552 * @info: InformInfo registration tracking structure.
554 * This call blocks until the registration request is destroyed. It may
555 * not be called from within the registration callback.
557 void ib_sa_unregister_inform_info(struct ib_inform_info *info);