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 * $Id: ib_sa.h,v 1.1.1.1 2007/08/03 18:53:46 Exp $ 35 */ 36 37#ifndef IB_SA_H 38#define IB_SA_H 39 40#include <linux/completion.h> 41#include <linux/compiler.h> 42 43#include <asm/atomic.h> 44 45#include <rdma/ib_verbs.h> 46#include <rdma/ib_mad.h> 47 48enum { 49 IB_SA_CLASS_VERSION = 2, /* IB spec version 1.1/1.2 */ 50 51 IB_SA_METHOD_GET_TABLE = 0x12, 52 IB_SA_METHOD_GET_TABLE_RESP = 0x92, 53 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 58}; 59 60enum { 61 IB_SA_ATTR_CLASS_PORTINFO = 0x01, 62 IB_SA_ATTR_NOTICE = 0x02, 63 IB_SA_ATTR_INFORM_INFO = 0x03, 64 IB_SA_ATTR_NODE_REC = 0x11, 65 IB_SA_ATTR_PORT_INFO_REC = 0x12, 66 IB_SA_ATTR_SL2VL_REC = 0x13, 67 IB_SA_ATTR_SWITCH_REC = 0x14, 68 IB_SA_ATTR_LINEAR_FDB_REC = 0x15, 69 IB_SA_ATTR_RANDOM_FDB_REC = 0x16, 70 IB_SA_ATTR_MCAST_FDB_REC = 0x17, 71 IB_SA_ATTR_SM_INFO_REC = 0x18, 72 IB_SA_ATTR_LINK_REC = 0x20, 73 IB_SA_ATTR_GUID_INFO_REC = 0x30, 74 IB_SA_ATTR_SERVICE_REC = 0x31, 75 IB_SA_ATTR_PARTITION_REC = 0x33, 76 IB_SA_ATTR_PATH_REC = 0x35, 77 IB_SA_ATTR_VL_ARB_REC = 0x36, 78 IB_SA_ATTR_MC_MEMBER_REC = 0x38, 79 IB_SA_ATTR_TRACE_REC = 0x39, 80 IB_SA_ATTR_MULTI_PATH_REC = 0x3a, 81 IB_SA_ATTR_SERVICE_ASSOC_REC = 0x3b, 82 IB_SA_ATTR_INFORM_INFO_REC = 0xf3 83}; 84 85enum ib_sa_selector { 86 IB_SA_GT = 0, 87 IB_SA_LT = 1, 88 IB_SA_EQ = 2, 89 /* 90 * The meaning of "best" depends on the attribute: for 91 * example, for MTU best will return the largest available 92 * MTU, while for packet life time, best will return the 93 * smallest available life time. 94 */ 95 IB_SA_BEST = 3 96}; 97 98 99/* reserved: 0 */ 100/* reserved: 1 */ 101#define IB_SA_PATH_REC_DGID IB_SA_COMP_MASK( 2) 102#define IB_SA_PATH_REC_SGID IB_SA_COMP_MASK( 3) 103#define IB_SA_PATH_REC_DLID IB_SA_COMP_MASK( 4) 104#define IB_SA_PATH_REC_SLID IB_SA_COMP_MASK( 5) 105#define IB_SA_PATH_REC_RAW_TRAFFIC IB_SA_COMP_MASK( 6) 106/* reserved: 7 */ 107#define IB_SA_PATH_REC_FLOW_LABEL IB_SA_COMP_MASK( 8) 108#define IB_SA_PATH_REC_HOP_LIMIT IB_SA_COMP_MASK( 9) 109#define IB_SA_PATH_REC_TRAFFIC_CLASS IB_SA_COMP_MASK(10) 110#define IB_SA_PATH_REC_REVERSIBLE IB_SA_COMP_MASK(11) 111#define IB_SA_PATH_REC_NUMB_PATH IB_SA_COMP_MASK(12) 112#define IB_SA_PATH_REC_PKEY IB_SA_COMP_MASK(13) 113/* reserved: 14 */ 114#define IB_SA_PATH_REC_SL IB_SA_COMP_MASK(15) 115#define IB_SA_PATH_REC_MTU_SELECTOR IB_SA_COMP_MASK(16) 116#define IB_SA_PATH_REC_MTU IB_SA_COMP_MASK(17) 117#define IB_SA_PATH_REC_RATE_SELECTOR IB_SA_COMP_MASK(18) 118#define IB_SA_PATH_REC_RATE IB_SA_COMP_MASK(19) 119#define IB_SA_PATH_REC_PACKET_LIFE_TIME_SELECTOR IB_SA_COMP_MASK(20) 120#define IB_SA_PATH_REC_PACKET_LIFE_TIME IB_SA_COMP_MASK(21) 121#define IB_SA_PATH_REC_PREFERENCE IB_SA_COMP_MASK(22) 122 123struct ib_sa_path_rec { 124 /* reserved */ 125 /* reserved */ 126 union ib_gid dgid; 127 union ib_gid sgid; 128 __be16 dlid; 129 __be16 slid; 130 int raw_traffic; 131 /* reserved */ 132 __be32 flow_label; 133 u8 hop_limit; 134 u8 traffic_class; 135 int reversible; 136 u8 numb_path; 137 __be16 pkey; 138 /* reserved */ 139 u8 sl; 140 u8 mtu_selector; 141 u8 mtu; 142 u8 rate_selector; 143 u8 rate; 144 u8 packet_life_time_selector; 145 u8 packet_life_time; 146 u8 preference; 147}; 148 149#define IB_SA_MCMEMBER_REC_MGID IB_SA_COMP_MASK( 0) 150#define IB_SA_MCMEMBER_REC_PORT_GID IB_SA_COMP_MASK( 1) 151#define IB_SA_MCMEMBER_REC_QKEY IB_SA_COMP_MASK( 2) 152#define IB_SA_MCMEMBER_REC_MLID IB_SA_COMP_MASK( 3) 153#define IB_SA_MCMEMBER_REC_MTU_SELECTOR IB_SA_COMP_MASK( 4) 154#define IB_SA_MCMEMBER_REC_MTU IB_SA_COMP_MASK( 5) 155#define IB_SA_MCMEMBER_REC_TRAFFIC_CLASS IB_SA_COMP_MASK( 6) 156#define IB_SA_MCMEMBER_REC_PKEY IB_SA_COMP_MASK( 7) 157#define IB_SA_MCMEMBER_REC_RATE_SELECTOR IB_SA_COMP_MASK( 8) 158#define IB_SA_MCMEMBER_REC_RATE IB_SA_COMP_MASK( 9) 159#define IB_SA_MCMEMBER_REC_PACKET_LIFE_TIME_SELECTOR IB_SA_COMP_MASK(10) 160#define IB_SA_MCMEMBER_REC_PACKET_LIFE_TIME IB_SA_COMP_MASK(11) 161#define IB_SA_MCMEMBER_REC_SL IB_SA_COMP_MASK(12) 162#define IB_SA_MCMEMBER_REC_FLOW_LABEL IB_SA_COMP_MASK(13) 163#define IB_SA_MCMEMBER_REC_HOP_LIMIT IB_SA_COMP_MASK(14) 164#define IB_SA_MCMEMBER_REC_SCOPE IB_SA_COMP_MASK(15) 165#define IB_SA_MCMEMBER_REC_JOIN_STATE IB_SA_COMP_MASK(16) 166#define IB_SA_MCMEMBER_REC_PROXY_JOIN IB_SA_COMP_MASK(17) 167 168struct ib_sa_mcmember_rec { 169 union ib_gid mgid; 170 union ib_gid port_gid; 171 __be32 qkey; 172 __be16 mlid; 173 u8 mtu_selector; 174 u8 mtu; 175 u8 traffic_class; 176 __be16 pkey; 177 u8 rate_selector; 178 u8 rate; 179 u8 packet_life_time_selector; 180 u8 packet_life_time; 181 u8 sl; 182 __be32 flow_label; 183 u8 hop_limit; 184 u8 scope; 185 u8 join_state; 186 int proxy_join; 187}; 188 189/* Service Record Component Mask Sec 15.2.5.14 Ver 1.1 */ 190#define IB_SA_SERVICE_REC_SERVICE_ID IB_SA_COMP_MASK( 0) 191#define IB_SA_SERVICE_REC_SERVICE_GID IB_SA_COMP_MASK( 1) 192#define IB_SA_SERVICE_REC_SERVICE_PKEY IB_SA_COMP_MASK( 2) 193/* reserved: 3 */ 194#define IB_SA_SERVICE_REC_SERVICE_LEASE IB_SA_COMP_MASK( 4) 195#define IB_SA_SERVICE_REC_SERVICE_KEY IB_SA_COMP_MASK( 5) 196#define IB_SA_SERVICE_REC_SERVICE_NAME IB_SA_COMP_MASK( 6) 197#define IB_SA_SERVICE_REC_SERVICE_DATA8_0 IB_SA_COMP_MASK( 7) 198#define IB_SA_SERVICE_REC_SERVICE_DATA8_1 IB_SA_COMP_MASK( 8) 199#define IB_SA_SERVICE_REC_SERVICE_DATA8_2 IB_SA_COMP_MASK( 9) 200#define IB_SA_SERVICE_REC_SERVICE_DATA8_3 IB_SA_COMP_MASK(10) 201#define IB_SA_SERVICE_REC_SERVICE_DATA8_4 IB_SA_COMP_MASK(11) 202#define IB_SA_SERVICE_REC_SERVICE_DATA8_5 IB_SA_COMP_MASK(12) 203#define IB_SA_SERVICE_REC_SERVICE_DATA8_6 IB_SA_COMP_MASK(13) 204#define IB_SA_SERVICE_REC_SERVICE_DATA8_7 IB_SA_COMP_MASK(14) 205#define IB_SA_SERVICE_REC_SERVICE_DATA8_8 IB_SA_COMP_MASK(15) 206#define IB_SA_SERVICE_REC_SERVICE_DATA8_9 IB_SA_COMP_MASK(16) 207#define IB_SA_SERVICE_REC_SERVICE_DATA8_10 IB_SA_COMP_MASK(17) 208#define IB_SA_SERVICE_REC_SERVICE_DATA8_11 IB_SA_COMP_MASK(18) 209#define IB_SA_SERVICE_REC_SERVICE_DATA8_12 IB_SA_COMP_MASK(19) 210#define IB_SA_SERVICE_REC_SERVICE_DATA8_13 IB_SA_COMP_MASK(20) 211#define IB_SA_SERVICE_REC_SERVICE_DATA8_14 IB_SA_COMP_MASK(21) 212#define IB_SA_SERVICE_REC_SERVICE_DATA8_15 IB_SA_COMP_MASK(22) 213#define IB_SA_SERVICE_REC_SERVICE_DATA16_0 IB_SA_COMP_MASK(23) 214#define IB_SA_SERVICE_REC_SERVICE_DATA16_1 IB_SA_COMP_MASK(24) 215#define IB_SA_SERVICE_REC_SERVICE_DATA16_2 IB_SA_COMP_MASK(25) 216#define IB_SA_SERVICE_REC_SERVICE_DATA16_3 IB_SA_COMP_MASK(26) 217#define IB_SA_SERVICE_REC_SERVICE_DATA16_4 IB_SA_COMP_MASK(27) 218#define IB_SA_SERVICE_REC_SERVICE_DATA16_5 IB_SA_COMP_MASK(28) 219#define IB_SA_SERVICE_REC_SERVICE_DATA16_6 IB_SA_COMP_MASK(29) 220#define IB_SA_SERVICE_REC_SERVICE_DATA16_7 IB_SA_COMP_MASK(30) 221#define IB_SA_SERVICE_REC_SERVICE_DATA32_0 IB_SA_COMP_MASK(31) 222#define IB_SA_SERVICE_REC_SERVICE_DATA32_1 IB_SA_COMP_MASK(32) 223#define IB_SA_SERVICE_REC_SERVICE_DATA32_2 IB_SA_COMP_MASK(33) 224#define IB_SA_SERVICE_REC_SERVICE_DATA32_3 IB_SA_COMP_MASK(34) 225#define IB_SA_SERVICE_REC_SERVICE_DATA64_0 IB_SA_COMP_MASK(35) 226#define IB_SA_SERVICE_REC_SERVICE_DATA64_1 IB_SA_COMP_MASK(36) 227 228#define IB_DEFAULT_SERVICE_LEASE 0xFFFFFFFF 229 230struct ib_sa_service_rec { 231 u64 id; 232 union ib_gid gid; 233 __be16 pkey; 234 /* reserved */ 235 u32 lease; 236 u8 key[16]; 237 u8 name[64]; 238 u8 data8[16]; 239 u16 data16[8]; 240 u32 data32[4]; 241 u64 data64[2]; 242}; 243 244struct ib_sa_client { 245 atomic_t users; 246 struct completion comp; 247}; 248 249/** 250 * ib_sa_register_client - Register an SA client. 251 */ 252void ib_sa_register_client(struct ib_sa_client *client); 253 254/** 255 * ib_sa_unregister_client - Deregister an SA client. 256 * @client: Client object to deregister. 257 */ 258void ib_sa_unregister_client(struct ib_sa_client *client); 259 260struct ib_sa_query; 261 262void ib_sa_cancel_query(int id, struct ib_sa_query *query); 263 264int ib_sa_path_rec_get(struct ib_sa_client *client, 265 struct ib_device *device, u8 port_num, 266 struct ib_sa_path_rec *rec, 267 ib_sa_comp_mask comp_mask, 268 int timeout_ms, gfp_t gfp_mask, 269 void (*callback)(int status, 270 struct ib_sa_path_rec *resp, 271 void *context), 272 void *context, 273 struct ib_sa_query **query); 274 275int ib_sa_service_rec_query(struct ib_sa_client *client, 276 struct ib_device *device, u8 port_num, 277 u8 method, 278 struct ib_sa_service_rec *rec, 279 ib_sa_comp_mask comp_mask, 280 int timeout_ms, gfp_t gfp_mask, 281 void (*callback)(int status, 282 struct ib_sa_service_rec *resp, 283 void *context), 284 void *context, 285 struct ib_sa_query **sa_query); 286 287struct ib_sa_multicast { 288 struct ib_sa_mcmember_rec rec; 289 ib_sa_comp_mask comp_mask; 290 int (*callback)(int status, 291 struct ib_sa_multicast *multicast); 292 void *context; 293}; 294 295/** 296 * ib_sa_join_multicast - Initiates a join request to the specified multicast 297 * group. 298 * @client: SA client 299 * @device: Device associated with the multicast group. 300 * @port_num: Port on the specified device to associate with the multicast 301 * group. 302 * @rec: SA multicast member record specifying group attributes. 303 * @comp_mask: Component mask indicating which group attributes of %rec are 304 * valid. 305 * @gfp_mask: GFP mask for memory allocations. 306 * @callback: User callback invoked once the join operation completes. 307 * @context: User specified context stored with the ib_sa_multicast structure. 308 * 309 * This call initiates a multicast join request with the SA for the specified 310 * multicast group. If the join operation is started successfully, it returns 311 * an ib_sa_multicast structure that is used to track the multicast operation. 312 * Users must free this structure by calling ib_free_multicast, even if the 313 * join operation later fails. (The callback status is non-zero.) 314 * 315 * If the join operation fails; status will be non-zero, with the following 316 * failures possible: 317 * -ETIMEDOUT: The request timed out. 318 * -EIO: An error occurred sending the query. 319 * -EINVAL: The MCMemberRecord values differed from the existing group's. 320 * -ENETRESET: Indicates that an fatal error has occurred on the multicast 321 * group, and the user must rejoin the group to continue using it. 322 */ 323struct ib_sa_multicast *ib_sa_join_multicast(struct ib_sa_client *client, 324 struct ib_device *device, u8 port_num, 325 struct ib_sa_mcmember_rec *rec, 326 ib_sa_comp_mask comp_mask, gfp_t gfp_mask, 327 int (*callback)(int status, 328 struct ib_sa_multicast 329 *multicast), 330 void *context); 331 332/** 333 * ib_free_multicast - Frees the multicast tracking structure, and releases 334 * any reference on the multicast group. 335 * @multicast: Multicast tracking structure allocated by ib_join_multicast. 336 * 337 * This call blocks until the multicast identifier is destroyed. It may 338 * not be called from within the multicast callback; however, returning a non- 339 * zero value from the callback will result in destroying the multicast 340 * tracking structure. 341 */ 342void ib_sa_free_multicast(struct ib_sa_multicast *multicast); 343 344/** 345 * ib_get_mcmember_rec - Looks up a multicast member record by its MGID and 346 * returns it if found. 347 * @device: Device associated with the multicast group. 348 * @port_num: Port on the specified device to associate with the multicast 349 * group. 350 * @mgid: MGID of multicast group. 351 * @rec: Location to copy SA multicast member record. 352 */ 353int ib_sa_get_mcmember_rec(struct ib_device *device, u8 port_num, 354 union ib_gid *mgid, struct ib_sa_mcmember_rec *rec); 355 356/** 357 * ib_init_ah_from_mcmember - Initialize address handle attributes based on 358 * an SA multicast member record. 359 */ 360int ib_init_ah_from_mcmember(struct ib_device *device, u8 port_num, 361 struct ib_sa_mcmember_rec *rec, 362 struct ib_ah_attr *ah_attr); 363 364/** 365 * ib_init_ah_from_path - Initialize address handle attributes based on an SA 366 * path record. 367 */ 368int ib_init_ah_from_path(struct ib_device *device, u8 port_num, 369 struct ib_sa_path_rec *rec, 370 struct ib_ah_attr *ah_attr); 371 372#endif /* IB_SA_H */ 373