1 /* 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. 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. 33 */ 34 35 #ifndef IB_SA_H 36 #define IB_SA_H 37 38 #include <linux/completion.h> 39 #include <linux/compiler.h> 40 41 #include <linux/atomic.h> 42 #include <linux/netdevice.h> 43 44 #include <rdma/ib_verbs.h> 45 #include <rdma/ib_mad.h> 46 #include <rdma/ib_addr.h> 47 #include <rdma/opa_addr.h> 48 49 enum { 50 IB_SA_CLASS_VERSION = 2, /* IB spec version 1.1/1.2 */ 51 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 59 }; 60 61 #define OPA_SA_CLASS_VERSION 0x80 62 enum { 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 87 enum ib_sa_selector { 88 IB_SA_GT = 0, 89 IB_SA_LT = 1, 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 100 /* 101 * There are 4 types of join states: 102 * FullMember, NonMember, SendOnlyNonMember, SendOnlyFullMember. 103 * The order corresponds to JoinState bits in MCMemberRecord. 104 */ 105 enum 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 113 #define IB_SA_CAP_MASK2_SENDONLY_FULL_MEM_SUPPORT BIT(12) 114 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 129 #define IB_SA_PATH_REC_SERVICE_ID (IB_SA_COMP_MASK( 0) |\ 130 IB_SA_COMP_MASK( 1)) 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) 143 #define IB_SA_PATH_REC_QOS_CLASS IB_SA_COMP_MASK(14) 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) 152 153 enum sa_path_rec_type { 154 SA_PATH_REC_TYPE_IB, 155 SA_PATH_REC_TYPE_ROCE_V1, 156 SA_PATH_REC_TYPE_ROCE_V2, 157 SA_PATH_REC_TYPE_OPA 158 }; 159 160 struct sa_path_rec_ib { 161 __be64 service_id; 162 __be16 dlid; 163 __be16 slid; 164 u8 raw_traffic; 165 }; 166 167 struct sa_path_rec_roce { 168 u8 dmac[ETH_ALEN]; 169 /* ignored in IB */ 170 int ifindex; 171 /* ignored in IB */ 172 struct net *net; 173 174 }; 175 176 struct sa_path_rec_opa { 177 __be64 service_id; 178 __be32 dlid; 179 __be32 slid; 180 u8 raw_traffic; 181 u8 l2_8B; 182 u8 l2_10B; 183 u8 l2_9B; 184 u8 l2_16B; 185 u8 qos_type; 186 u8 qos_priority; 187 }; 188 189 struct sa_path_rec { 190 union ib_gid dgid; 191 union ib_gid sgid; 192 /* reserved */ 193 __be32 flow_label; 194 u8 hop_limit; 195 u8 traffic_class; 196 u8 reversible; 197 u8 numb_path; 198 __be16 pkey; 199 __be16 qos_class; 200 u8 sl; 201 u8 mtu_selector; 202 u8 mtu; 203 u8 rate_selector; 204 u8 rate; 205 u8 packet_life_time_selector; 206 u8 packet_life_time; 207 u8 preference; 208 union { 209 struct sa_path_rec_ib ib; 210 struct sa_path_rec_roce roce; 211 struct sa_path_rec_opa opa; 212 }; 213 enum sa_path_rec_type rec_type; 214 }; 215 216 static inline enum ib_gid_type 217 sa_conv_pathrec_to_gid_type(struct sa_path_rec *rec) 218 { 219 switch (rec->rec_type) { 220 case SA_PATH_REC_TYPE_ROCE_V1: 221 return IB_GID_TYPE_ROCE; 222 case SA_PATH_REC_TYPE_ROCE_V2: 223 return IB_GID_TYPE_ROCE_UDP_ENCAP; 224 default: 225 return IB_GID_TYPE_IB; 226 } 227 } 228 229 static inline enum sa_path_rec_type 230 sa_conv_gid_to_pathrec_type(enum ib_gid_type type) 231 { 232 switch (type) { 233 case IB_GID_TYPE_ROCE: 234 return SA_PATH_REC_TYPE_ROCE_V1; 235 case IB_GID_TYPE_ROCE_UDP_ENCAP: 236 return SA_PATH_REC_TYPE_ROCE_V2; 237 default: 238 return SA_PATH_REC_TYPE_IB; 239 } 240 } 241 242 static inline void path_conv_opa_to_ib(struct sa_path_rec *ib, 243 struct sa_path_rec *opa) 244 { 245 if ((be32_to_cpu(opa->opa.dlid) >= 246 be16_to_cpu(IB_MULTICAST_LID_BASE)) || 247 (be32_to_cpu(opa->opa.slid) >= 248 be16_to_cpu(IB_MULTICAST_LID_BASE))) { 249 /* Create OPA GID and zero out the LID */ 250 ib->dgid.global.interface_id 251 = OPA_MAKE_ID(be32_to_cpu(opa->opa.dlid)); 252 ib->dgid.global.subnet_prefix 253 = opa->dgid.global.subnet_prefix; 254 ib->sgid.global.interface_id 255 = OPA_MAKE_ID(be32_to_cpu(opa->opa.slid)); 256 ib->dgid.global.subnet_prefix 257 = opa->dgid.global.subnet_prefix; 258 ib->ib.dlid = 0; 259 260 ib->ib.slid = 0; 261 } else { 262 ib->ib.dlid = htons(ntohl(opa->opa.dlid)); 263 ib->ib.slid = htons(ntohl(opa->opa.slid)); 264 } 265 ib->ib.service_id = opa->opa.service_id; 266 ib->ib.raw_traffic = opa->opa.raw_traffic; 267 } 268 269 static inline void path_conv_ib_to_opa(struct sa_path_rec *opa, 270 struct sa_path_rec *ib) 271 { 272 __be32 slid, dlid; 273 274 if ((ib_is_opa_gid(&ib->sgid)) || 275 (ib_is_opa_gid(&ib->dgid))) { 276 slid = htonl(opa_get_lid_from_gid(&ib->sgid)); 277 dlid = htonl(opa_get_lid_from_gid(&ib->dgid)); 278 } else { 279 slid = htonl(ntohs(ib->ib.slid)); 280 dlid = htonl(ntohs(ib->ib.dlid)); 281 } 282 opa->opa.slid = slid; 283 opa->opa.dlid = dlid; 284 opa->opa.service_id = ib->ib.service_id; 285 opa->opa.raw_traffic = ib->ib.raw_traffic; 286 } 287 288 /* Convert from OPA to IB path record */ 289 static inline void sa_convert_path_opa_to_ib(struct sa_path_rec *dest, 290 struct sa_path_rec *src) 291 { 292 if (src->rec_type != SA_PATH_REC_TYPE_OPA) 293 return; 294 295 *dest = *src; 296 dest->rec_type = SA_PATH_REC_TYPE_IB; 297 path_conv_opa_to_ib(dest, src); 298 } 299 300 /* Convert from IB to OPA path record */ 301 static inline void sa_convert_path_ib_to_opa(struct sa_path_rec *dest, 302 struct sa_path_rec *src) 303 { 304 if (src->rec_type != SA_PATH_REC_TYPE_IB) 305 return; 306 307 /* Do a structure copy and overwrite the relevant fields */ 308 *dest = *src; 309 dest->rec_type = SA_PATH_REC_TYPE_OPA; 310 path_conv_ib_to_opa(dest, src); 311 } 312 313 #define IB_SA_MCMEMBER_REC_MGID IB_SA_COMP_MASK( 0) 314 #define IB_SA_MCMEMBER_REC_PORT_GID IB_SA_COMP_MASK( 1) 315 #define IB_SA_MCMEMBER_REC_QKEY IB_SA_COMP_MASK( 2) 316 #define IB_SA_MCMEMBER_REC_MLID IB_SA_COMP_MASK( 3) 317 #define IB_SA_MCMEMBER_REC_MTU_SELECTOR IB_SA_COMP_MASK( 4) 318 #define IB_SA_MCMEMBER_REC_MTU IB_SA_COMP_MASK( 5) 319 #define IB_SA_MCMEMBER_REC_TRAFFIC_CLASS IB_SA_COMP_MASK( 6) 320 #define IB_SA_MCMEMBER_REC_PKEY IB_SA_COMP_MASK( 7) 321 #define IB_SA_MCMEMBER_REC_RATE_SELECTOR IB_SA_COMP_MASK( 8) 322 #define IB_SA_MCMEMBER_REC_RATE IB_SA_COMP_MASK( 9) 323 #define IB_SA_MCMEMBER_REC_PACKET_LIFE_TIME_SELECTOR IB_SA_COMP_MASK(10) 324 #define IB_SA_MCMEMBER_REC_PACKET_LIFE_TIME IB_SA_COMP_MASK(11) 325 #define IB_SA_MCMEMBER_REC_SL IB_SA_COMP_MASK(12) 326 #define IB_SA_MCMEMBER_REC_FLOW_LABEL IB_SA_COMP_MASK(13) 327 #define IB_SA_MCMEMBER_REC_HOP_LIMIT IB_SA_COMP_MASK(14) 328 #define IB_SA_MCMEMBER_REC_SCOPE IB_SA_COMP_MASK(15) 329 #define IB_SA_MCMEMBER_REC_JOIN_STATE IB_SA_COMP_MASK(16) 330 #define IB_SA_MCMEMBER_REC_PROXY_JOIN IB_SA_COMP_MASK(17) 331 332 struct ib_sa_mcmember_rec { 333 union ib_gid mgid; 334 union ib_gid port_gid; 335 __be32 qkey; 336 __be16 mlid; 337 u8 mtu_selector; 338 u8 mtu; 339 u8 traffic_class; 340 __be16 pkey; 341 u8 rate_selector; 342 u8 rate; 343 u8 packet_life_time_selector; 344 u8 packet_life_time; 345 u8 sl; 346 __be32 flow_label; 347 u8 hop_limit; 348 u8 scope; 349 u8 join_state; 350 u8 proxy_join; 351 }; 352 353 /* Service Record Component Mask Sec 15.2.5.14 Ver 1.1 */ 354 #define IB_SA_SERVICE_REC_SERVICE_ID IB_SA_COMP_MASK( 0) 355 #define IB_SA_SERVICE_REC_SERVICE_GID IB_SA_COMP_MASK( 1) 356 #define IB_SA_SERVICE_REC_SERVICE_PKEY IB_SA_COMP_MASK( 2) 357 /* reserved: 3 */ 358 #define IB_SA_SERVICE_REC_SERVICE_LEASE IB_SA_COMP_MASK( 4) 359 #define IB_SA_SERVICE_REC_SERVICE_KEY IB_SA_COMP_MASK( 5) 360 #define IB_SA_SERVICE_REC_SERVICE_NAME IB_SA_COMP_MASK( 6) 361 #define IB_SA_SERVICE_REC_SERVICE_DATA8_0 IB_SA_COMP_MASK( 7) 362 #define IB_SA_SERVICE_REC_SERVICE_DATA8_1 IB_SA_COMP_MASK( 8) 363 #define IB_SA_SERVICE_REC_SERVICE_DATA8_2 IB_SA_COMP_MASK( 9) 364 #define IB_SA_SERVICE_REC_SERVICE_DATA8_3 IB_SA_COMP_MASK(10) 365 #define IB_SA_SERVICE_REC_SERVICE_DATA8_4 IB_SA_COMP_MASK(11) 366 #define IB_SA_SERVICE_REC_SERVICE_DATA8_5 IB_SA_COMP_MASK(12) 367 #define IB_SA_SERVICE_REC_SERVICE_DATA8_6 IB_SA_COMP_MASK(13) 368 #define IB_SA_SERVICE_REC_SERVICE_DATA8_7 IB_SA_COMP_MASK(14) 369 #define IB_SA_SERVICE_REC_SERVICE_DATA8_8 IB_SA_COMP_MASK(15) 370 #define IB_SA_SERVICE_REC_SERVICE_DATA8_9 IB_SA_COMP_MASK(16) 371 #define IB_SA_SERVICE_REC_SERVICE_DATA8_10 IB_SA_COMP_MASK(17) 372 #define IB_SA_SERVICE_REC_SERVICE_DATA8_11 IB_SA_COMP_MASK(18) 373 #define IB_SA_SERVICE_REC_SERVICE_DATA8_12 IB_SA_COMP_MASK(19) 374 #define IB_SA_SERVICE_REC_SERVICE_DATA8_13 IB_SA_COMP_MASK(20) 375 #define IB_SA_SERVICE_REC_SERVICE_DATA8_14 IB_SA_COMP_MASK(21) 376 #define IB_SA_SERVICE_REC_SERVICE_DATA8_15 IB_SA_COMP_MASK(22) 377 #define IB_SA_SERVICE_REC_SERVICE_DATA16_0 IB_SA_COMP_MASK(23) 378 #define IB_SA_SERVICE_REC_SERVICE_DATA16_1 IB_SA_COMP_MASK(24) 379 #define IB_SA_SERVICE_REC_SERVICE_DATA16_2 IB_SA_COMP_MASK(25) 380 #define IB_SA_SERVICE_REC_SERVICE_DATA16_3 IB_SA_COMP_MASK(26) 381 #define IB_SA_SERVICE_REC_SERVICE_DATA16_4 IB_SA_COMP_MASK(27) 382 #define IB_SA_SERVICE_REC_SERVICE_DATA16_5 IB_SA_COMP_MASK(28) 383 #define IB_SA_SERVICE_REC_SERVICE_DATA16_6 IB_SA_COMP_MASK(29) 384 #define IB_SA_SERVICE_REC_SERVICE_DATA16_7 IB_SA_COMP_MASK(30) 385 #define IB_SA_SERVICE_REC_SERVICE_DATA32_0 IB_SA_COMP_MASK(31) 386 #define IB_SA_SERVICE_REC_SERVICE_DATA32_1 IB_SA_COMP_MASK(32) 387 #define IB_SA_SERVICE_REC_SERVICE_DATA32_2 IB_SA_COMP_MASK(33) 388 #define IB_SA_SERVICE_REC_SERVICE_DATA32_3 IB_SA_COMP_MASK(34) 389 #define IB_SA_SERVICE_REC_SERVICE_DATA64_0 IB_SA_COMP_MASK(35) 390 #define IB_SA_SERVICE_REC_SERVICE_DATA64_1 IB_SA_COMP_MASK(36) 391 392 #define IB_DEFAULT_SERVICE_LEASE 0xFFFFFFFF 393 394 struct ib_sa_service_rec { 395 u64 id; 396 union ib_gid gid; 397 __be16 pkey; 398 /* reserved */ 399 u32 lease; 400 u8 key[16]; 401 u8 name[64]; 402 u8 data8[16]; 403 u16 data16[8]; 404 u32 data32[4]; 405 u64 data64[2]; 406 }; 407 408 #define IB_SA_GUIDINFO_REC_LID IB_SA_COMP_MASK(0) 409 #define IB_SA_GUIDINFO_REC_BLOCK_NUM IB_SA_COMP_MASK(1) 410 #define IB_SA_GUIDINFO_REC_RES1 IB_SA_COMP_MASK(2) 411 #define IB_SA_GUIDINFO_REC_RES2 IB_SA_COMP_MASK(3) 412 #define IB_SA_GUIDINFO_REC_GID0 IB_SA_COMP_MASK(4) 413 #define IB_SA_GUIDINFO_REC_GID1 IB_SA_COMP_MASK(5) 414 #define IB_SA_GUIDINFO_REC_GID2 IB_SA_COMP_MASK(6) 415 #define IB_SA_GUIDINFO_REC_GID3 IB_SA_COMP_MASK(7) 416 #define IB_SA_GUIDINFO_REC_GID4 IB_SA_COMP_MASK(8) 417 #define IB_SA_GUIDINFO_REC_GID5 IB_SA_COMP_MASK(9) 418 #define IB_SA_GUIDINFO_REC_GID6 IB_SA_COMP_MASK(10) 419 #define IB_SA_GUIDINFO_REC_GID7 IB_SA_COMP_MASK(11) 420 421 struct ib_sa_guidinfo_rec { 422 __be16 lid; 423 u8 block_num; 424 /* reserved */ 425 u8 res1; 426 __be32 res2; 427 u8 guid_info_list[64]; 428 }; 429 430 struct ib_sa_client { 431 atomic_t users; 432 struct completion comp; 433 }; 434 435 /** 436 * ib_sa_register_client - Register an SA client. 437 */ 438 void ib_sa_register_client(struct ib_sa_client *client); 439 440 /** 441 * ib_sa_unregister_client - Deregister an SA client. 442 * @client: Client object to deregister. 443 */ 444 void ib_sa_unregister_client(struct ib_sa_client *client); 445 446 struct ib_sa_query; 447 448 void ib_sa_cancel_query(int id, struct ib_sa_query *query); 449 450 int ib_sa_path_rec_get(struct ib_sa_client *client, 451 struct ib_device *device, u8 port_num, 452 struct sa_path_rec *rec, 453 ib_sa_comp_mask comp_mask, 454 int timeout_ms, gfp_t gfp_mask, 455 void (*callback)(int status, 456 struct sa_path_rec *resp, 457 void *context), 458 void *context, 459 struct ib_sa_query **query); 460 461 int ib_sa_service_rec_query(struct ib_sa_client *client, 462 struct ib_device *device, u8 port_num, 463 u8 method, 464 struct ib_sa_service_rec *rec, 465 ib_sa_comp_mask comp_mask, 466 int timeout_ms, gfp_t gfp_mask, 467 void (*callback)(int status, 468 struct ib_sa_service_rec *resp, 469 void *context), 470 void *context, 471 struct ib_sa_query **sa_query); 472 473 struct ib_sa_multicast { 474 struct ib_sa_mcmember_rec rec; 475 ib_sa_comp_mask comp_mask; 476 int (*callback)(int status, 477 struct ib_sa_multicast *multicast); 478 void *context; 479 }; 480 481 /** 482 * ib_sa_join_multicast - Initiates a join request to the specified multicast 483 * group. 484 * @client: SA client 485 * @device: Device associated with the multicast group. 486 * @port_num: Port on the specified device to associate with the multicast 487 * group. 488 * @rec: SA multicast member record specifying group attributes. 489 * @comp_mask: Component mask indicating which group attributes of %rec are 490 * valid. 491 * @gfp_mask: GFP mask for memory allocations. 492 * @callback: User callback invoked once the join operation completes. 493 * @context: User specified context stored with the ib_sa_multicast structure. 494 * 495 * This call initiates a multicast join request with the SA for the specified 496 * multicast group. If the join operation is started successfully, it returns 497 * an ib_sa_multicast structure that is used to track the multicast operation. 498 * Users must free this structure by calling ib_free_multicast, even if the 499 * join operation later fails. (The callback status is non-zero.) 500 * 501 * If the join operation fails; status will be non-zero, with the following 502 * failures possible: 503 * -ETIMEDOUT: The request timed out. 504 * -EIO: An error occurred sending the query. 505 * -EINVAL: The MCMemberRecord values differed from the existing group's. 506 * -ENETRESET: Indicates that an fatal error has occurred on the multicast 507 * group, and the user must rejoin the group to continue using it. 508 */ 509 struct ib_sa_multicast *ib_sa_join_multicast(struct ib_sa_client *client, 510 struct ib_device *device, u8 port_num, 511 struct ib_sa_mcmember_rec *rec, 512 ib_sa_comp_mask comp_mask, gfp_t gfp_mask, 513 int (*callback)(int status, 514 struct ib_sa_multicast 515 *multicast), 516 void *context); 517 518 /** 519 * ib_free_multicast - Frees the multicast tracking structure, and releases 520 * any reference on the multicast group. 521 * @multicast: Multicast tracking structure allocated by ib_join_multicast. 522 * 523 * This call blocks until the multicast identifier is destroyed. It may 524 * not be called from within the multicast callback; however, returning a non- 525 * zero value from the callback will result in destroying the multicast 526 * tracking structure. 527 */ 528 void ib_sa_free_multicast(struct ib_sa_multicast *multicast); 529 530 /** 531 * ib_get_mcmember_rec - Looks up a multicast member record by its MGID and 532 * returns it if found. 533 * @device: Device associated with the multicast group. 534 * @port_num: Port on the specified device to associate with the multicast 535 * group. 536 * @mgid: MGID of multicast group. 537 * @rec: Location to copy SA multicast member record. 538 */ 539 int ib_sa_get_mcmember_rec(struct ib_device *device, u8 port_num, 540 union ib_gid *mgid, struct ib_sa_mcmember_rec *rec); 541 542 /** 543 * ib_init_ah_from_mcmember - Initialize address handle attributes based on 544 * an SA multicast member record. 545 */ 546 int ib_init_ah_from_mcmember(struct ib_device *device, u8 port_num, 547 struct ib_sa_mcmember_rec *rec, 548 struct net_device *ndev, 549 enum ib_gid_type gid_type, 550 struct rdma_ah_attr *ah_attr); 551 552 /** 553 * ib_init_ah_from_path - Initialize address handle attributes based on an SA 554 * path record. 555 */ 556 int ib_init_ah_from_path(struct ib_device *device, u8 port_num, 557 struct sa_path_rec *rec, 558 struct rdma_ah_attr *ah_attr); 559 560 /** 561 * ib_sa_pack_path - Conert a path record from struct ib_sa_path_rec 562 * to IB MAD wire format. 563 */ 564 void ib_sa_pack_path(struct sa_path_rec *rec, void *attribute); 565 566 /** 567 * ib_sa_unpack_path - Convert a path record from MAD format to struct 568 * ib_sa_path_rec. 569 */ 570 void ib_sa_unpack_path(void *attribute, struct sa_path_rec *rec); 571 572 /* Support GuidInfoRecord */ 573 int ib_sa_guid_info_rec_query(struct ib_sa_client *client, 574 struct ib_device *device, u8 port_num, 575 struct ib_sa_guidinfo_rec *rec, 576 ib_sa_comp_mask comp_mask, u8 method, 577 int timeout_ms, gfp_t gfp_mask, 578 void (*callback)(int status, 579 struct ib_sa_guidinfo_rec *resp, 580 void *context), 581 void *context, 582 struct ib_sa_query **sa_query); 583 584 bool ib_sa_sendonly_fullmem_support(struct ib_sa_client *client, 585 struct ib_device *device, 586 u8 port_num); 587 588 static inline bool sa_path_is_roce(struct sa_path_rec *rec) 589 { 590 return ((rec->rec_type == SA_PATH_REC_TYPE_ROCE_V1) || 591 (rec->rec_type == SA_PATH_REC_TYPE_ROCE_V2)); 592 } 593 594 static inline void sa_path_set_service_id(struct sa_path_rec *rec, 595 __be64 service_id) 596 { 597 if (rec->rec_type == SA_PATH_REC_TYPE_IB) 598 rec->ib.service_id = service_id; 599 else if (rec->rec_type == SA_PATH_REC_TYPE_OPA) 600 rec->opa.service_id = service_id; 601 } 602 603 static inline void sa_path_set_slid(struct sa_path_rec *rec, __be32 slid) 604 { 605 if (rec->rec_type == SA_PATH_REC_TYPE_IB) 606 rec->ib.slid = htons(ntohl(slid)); 607 else if (rec->rec_type == SA_PATH_REC_TYPE_OPA) 608 rec->opa.slid = slid; 609 } 610 611 static inline void sa_path_set_dlid(struct sa_path_rec *rec, __be32 dlid) 612 { 613 if (rec->rec_type == SA_PATH_REC_TYPE_IB) 614 rec->ib.dlid = htons(ntohl(dlid)); 615 else if (rec->rec_type == SA_PATH_REC_TYPE_OPA) 616 rec->opa.dlid = dlid; 617 } 618 619 static inline void sa_path_set_raw_traffic(struct sa_path_rec *rec, 620 u8 raw_traffic) 621 { 622 if (rec->rec_type == SA_PATH_REC_TYPE_IB) 623 rec->ib.raw_traffic = raw_traffic; 624 else if (rec->rec_type == SA_PATH_REC_TYPE_OPA) 625 rec->opa.raw_traffic = raw_traffic; 626 } 627 628 static inline __be64 sa_path_get_service_id(struct sa_path_rec *rec) 629 { 630 if (rec->rec_type == SA_PATH_REC_TYPE_IB) 631 return rec->ib.service_id; 632 else if (rec->rec_type == SA_PATH_REC_TYPE_OPA) 633 return rec->opa.service_id; 634 return 0; 635 } 636 637 static inline __be32 sa_path_get_slid(struct sa_path_rec *rec) 638 { 639 if (rec->rec_type == SA_PATH_REC_TYPE_IB) 640 return htonl(ntohs(rec->ib.slid)); 641 else if (rec->rec_type == SA_PATH_REC_TYPE_OPA) 642 return rec->opa.slid; 643 return 0; 644 } 645 646 static inline __be32 sa_path_get_dlid(struct sa_path_rec *rec) 647 { 648 if (rec->rec_type == SA_PATH_REC_TYPE_IB) 649 return htonl(ntohs(rec->ib.dlid)); 650 else if (rec->rec_type == SA_PATH_REC_TYPE_OPA) 651 return rec->opa.dlid; 652 return 0; 653 } 654 655 static inline u8 sa_path_get_raw_traffic(struct sa_path_rec *rec) 656 { 657 if (rec->rec_type == SA_PATH_REC_TYPE_IB) 658 return rec->ib.raw_traffic; 659 else if (rec->rec_type == SA_PATH_REC_TYPE_OPA) 660 return rec->opa.raw_traffic; 661 return 0; 662 } 663 664 static inline void sa_path_set_dmac(struct sa_path_rec *rec, u8 *dmac) 665 { 666 if (sa_path_is_roce(rec)) 667 memcpy(rec->roce.dmac, dmac, ETH_ALEN); 668 } 669 670 static inline void sa_path_set_dmac_zero(struct sa_path_rec *rec) 671 { 672 if (sa_path_is_roce(rec)) 673 eth_zero_addr(rec->roce.dmac); 674 } 675 676 static inline void sa_path_set_ifindex(struct sa_path_rec *rec, int ifindex) 677 { 678 if (sa_path_is_roce(rec)) 679 rec->roce.ifindex = ifindex; 680 } 681 682 static inline void sa_path_set_ndev(struct sa_path_rec *rec, struct net *net) 683 { 684 if (sa_path_is_roce(rec)) 685 rec->roce.net = net; 686 } 687 688 static inline u8 *sa_path_get_dmac(struct sa_path_rec *rec) 689 { 690 if (sa_path_is_roce(rec)) 691 return rec->roce.dmac; 692 return NULL; 693 } 694 695 static inline int sa_path_get_ifindex(struct sa_path_rec *rec) 696 { 697 if (sa_path_is_roce(rec)) 698 return rec->roce.ifindex; 699 return 0; 700 } 701 702 static inline struct net *sa_path_get_ndev(struct sa_path_rec *rec) 703 { 704 if (sa_path_is_roce(rec)) 705 return rec->roce.net; 706 return NULL; 707 } 708 709 static inline struct net_device *ib_get_ndev_from_path(struct sa_path_rec *rec) 710 { 711 return sa_path_get_ndev(rec) ? 712 dev_get_by_index(sa_path_get_ndev(rec), 713 sa_path_get_ifindex(rec)) 714 : NULL; 715 } 716 717 #endif /* IB_SA_H */ 718