include/rdma/ib_sa.h

   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
  47 enum {
  48         IB_SA_CLASS_VERSION             = 2,    /* IB spec version 1.1/1.2 */
  49
  50         IB_SA_METHOD_GET_TABLE          = 0x12,
  51         IB_SA_METHOD_GET_TABLE_RESP     = 0x92,
  52         IB_SA_METHOD_DELETE             = 0x15,
  53         IB_SA_METHOD_DELETE_RESP        = 0x95,
  54         IB_SA_METHOD_GET_MULTI          = 0x14,
  55         IB_SA_METHOD_GET_MULTI_RESP     = 0x94,
  56         IB_SA_METHOD_GET_TRACE_TBL      = 0x13
  57 };
  58
  59 #define OPA_SA_CLASS_VERSION    0x80
  60 enum {
  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
  85 enum 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  * There are 4 types of join states:
 100  * FullMember, NonMember, SendOnlyNonMember, SendOnlyFullMember.
 101  * The order corresponds to JoinState bits in MCMemberRecord.
 102  */
 103 enum ib_sa_mc_join_states {
 104         FULLMEMBER_JOIN,
 105         NONMEMBER_JOIN,
 106         SENDONLY_NONMEBER_JOIN,
 107         SENDONLY_FULLMEMBER_JOIN,
 108         NUM_JOIN_MEMBERSHIP_TYPES,
 109 };
 110
 111 #define IB_SA_CAP_MASK2_SENDONLY_FULL_MEM_SUPPORT       BIT(12)
 112
 113 /*
 114  * Structures for SA records are named "struct ib_sa_xxx_rec."  No
 115  * attempt is made to pack structures to match the physical layout of
 116  * SA records in SA MADs; all packing and unpacking is handled by the
 117  * SA query code.
 118  *
 119  * For a record with structure ib_sa_xxx_rec, the naming convention
 120  * for the component mask value for field yyy is IB_SA_XXX_REC_YYY (we
 121  * never use different abbreviations or otherwise change the spelling
 122  * of xxx/yyy between ib_sa_xxx_rec.yyy and IB_SA_XXX_REC_YYY).
 123  *
 124  * Reserved rows are indicated with comments to help maintainability.
 125  */
 126
 127 #define IB_SA_PATH_REC_SERVICE_ID                      (IB_SA_COMP_MASK( 0) |\
 128                                                         IB_SA_COMP_MASK( 1))
 129 #define IB_SA_PATH_REC_DGID                             IB_SA_COMP_MASK( 2)
 130 #define IB_SA_PATH_REC_SGID                             IB_SA_COMP_MASK( 3)
 131 #define IB_SA_PATH_REC_DLID                             IB_SA_COMP_MASK( 4)
 132 #define IB_SA_PATH_REC_SLID                             IB_SA_COMP_MASK( 5)
 133 #define IB_SA_PATH_REC_RAW_TRAFFIC                      IB_SA_COMP_MASK( 6)
 134 /* reserved:                                                             7 */
 135 #define IB_SA_PATH_REC_FLOW_LABEL                       IB_SA_COMP_MASK( 8)
 136 #define IB_SA_PATH_REC_HOP_LIMIT                        IB_SA_COMP_MASK( 9)
 137 #define IB_SA_PATH_REC_TRAFFIC_CLASS                    IB_SA_COMP_MASK(10)
 138 #define IB_SA_PATH_REC_REVERSIBLE                       IB_SA_COMP_MASK(11)
 139 #define IB_SA_PATH_REC_NUMB_PATH                        IB_SA_COMP_MASK(12)
 140 #define IB_SA_PATH_REC_PKEY                             IB_SA_COMP_MASK(13)
 141 #define IB_SA_PATH_REC_QOS_CLASS                        IB_SA_COMP_MASK(14)
 142 #define IB_SA_PATH_REC_SL                               IB_SA_COMP_MASK(15)
 143 #define IB_SA_PATH_REC_MTU_SELECTOR                     IB_SA_COMP_MASK(16)
 144 #define IB_SA_PATH_REC_MTU                              IB_SA_COMP_MASK(17)
 145 #define IB_SA_PATH_REC_RATE_SELECTOR                    IB_SA_COMP_MASK(18)
 146 #define IB_SA_PATH_REC_RATE                             IB_SA_COMP_MASK(19)
 147 #define IB_SA_PATH_REC_PACKET_LIFE_TIME_SELECTOR        IB_SA_COMP_MASK(20)
 148 #define IB_SA_PATH_REC_PACKET_LIFE_TIME                 IB_SA_COMP_MASK(21)
 149 #define IB_SA_PATH_REC_PREFERENCE                       IB_SA_COMP_MASK(22)
 150 enum sa_path_rec_type {
 151         SA_PATH_REC_TYPE_IB,
 152         SA_PATH_REC_TYPE_ROCE_V1,
 153         SA_PATH_REC_TYPE_ROCE_V2
 154 };
 155
 156 struct sa_path_rec {
 157         __be64       service_id;
 158         union ib_gid dgid;
 159         union ib_gid sgid;
 160         __be16       dlid;
 161         __be16       slid;
 162         u8           raw_traffic;
 163         /* reserved */
 164         __be32       flow_label;
 165         u8           hop_limit;
 166         u8           traffic_class;
 167         u8           reversible;
 168         u8           numb_path;
 169         __be16       pkey;
 170         __be16       qos_class;
 171         u8           sl;
 172         u8           mtu_selector;
 173         u8           mtu;
 174         u8           rate_selector;
 175         u8           rate;
 176         u8           packet_life_time_selector;
 177         u8           packet_life_time;
 178         u8           preference;
 179         u8           dmac[ETH_ALEN];
 180         /* ignored in IB */
 181         int          ifindex;
 182         /* ignored in IB */
 183         struct net  *net;
 184         enum sa_path_rec_type rec_type;
 185 };
 186
 187 static inline struct net_device *ib_get_ndev_from_path(struct sa_path_rec *rec)
 188 {
 189         return rec->net ? dev_get_by_index(rec->net, rec->ifindex) : NULL;
 190 }
 191
 192 static inline enum ib_gid_type
 193                 sa_conv_pathrec_to_gid_type(struct sa_path_rec *rec)
 194 {
 195         switch (rec->rec_type) {
 196         case SA_PATH_REC_TYPE_ROCE_V1:
 197                 return IB_GID_TYPE_ROCE;
 198         case SA_PATH_REC_TYPE_ROCE_V2:
 199                 return IB_GID_TYPE_ROCE_UDP_ENCAP;
 200         default:
 201                 return IB_GID_TYPE_IB;
 202         }
 203 }
 204
 205 static inline enum sa_path_rec_type
 206                 sa_conv_gid_to_pathrec_type(enum ib_gid_type type)
 207 {
 208         switch (type) {
 209         case IB_GID_TYPE_ROCE:
 210                 return SA_PATH_REC_TYPE_ROCE_V1;
 211         case IB_GID_TYPE_ROCE_UDP_ENCAP:
 212                 return SA_PATH_REC_TYPE_ROCE_V2;
 213         default:
 214                 return SA_PATH_REC_TYPE_IB;
 215         }
 216 }
 217
 218 #define IB_SA_MCMEMBER_REC_MGID                         IB_SA_COMP_MASK( 0)
 219 #define IB_SA_MCMEMBER_REC_PORT_GID                     IB_SA_COMP_MASK( 1)
 220 #define IB_SA_MCMEMBER_REC_QKEY                         IB_SA_COMP_MASK( 2)
 221 #define IB_SA_MCMEMBER_REC_MLID                         IB_SA_COMP_MASK( 3)
 222 #define IB_SA_MCMEMBER_REC_MTU_SELECTOR                 IB_SA_COMP_MASK( 4)
 223 #define IB_SA_MCMEMBER_REC_MTU                          IB_SA_COMP_MASK( 5)
 224 #define IB_SA_MCMEMBER_REC_TRAFFIC_CLASS                IB_SA_COMP_MASK( 6)
 225 #define IB_SA_MCMEMBER_REC_PKEY                         IB_SA_COMP_MASK( 7)
 226 #define IB_SA_MCMEMBER_REC_RATE_SELECTOR                IB_SA_COMP_MASK( 8)
 227 #define IB_SA_MCMEMBER_REC_RATE                         IB_SA_COMP_MASK( 9)
 228 #define IB_SA_MCMEMBER_REC_PACKET_LIFE_TIME_SELECTOR    IB_SA_COMP_MASK(10)
 229 #define IB_SA_MCMEMBER_REC_PACKET_LIFE_TIME             IB_SA_COMP_MASK(11)
 230 #define IB_SA_MCMEMBER_REC_SL                           IB_SA_COMP_MASK(12)
 231 #define IB_SA_MCMEMBER_REC_FLOW_LABEL                   IB_SA_COMP_MASK(13)
 232 #define IB_SA_MCMEMBER_REC_HOP_LIMIT                    IB_SA_COMP_MASK(14)
 233 #define IB_SA_MCMEMBER_REC_SCOPE                        IB_SA_COMP_MASK(15)
 234 #define IB_SA_MCMEMBER_REC_JOIN_STATE                   IB_SA_COMP_MASK(16)
 235 #define IB_SA_MCMEMBER_REC_PROXY_JOIN                   IB_SA_COMP_MASK(17)
 236
 237 struct ib_sa_mcmember_rec {
 238         union ib_gid mgid;
 239         union ib_gid port_gid;
 240         __be32       qkey;
 241         __be16       mlid;
 242         u8           mtu_selector;
 243         u8           mtu;
 244         u8           traffic_class;
 245         __be16       pkey;
 246         u8           rate_selector;
 247         u8           rate;
 248         u8           packet_life_time_selector;
 249         u8           packet_life_time;
 250         u8           sl;
 251         __be32       flow_label;
 252         u8           hop_limit;
 253         u8           scope;
 254         u8           join_state;
 255         u8           proxy_join;
 256 };
 257
 258 /* Service Record Component Mask Sec 15.2.5.14 Ver 1.1  */
 259 #define IB_SA_SERVICE_REC_SERVICE_ID                    IB_SA_COMP_MASK( 0)
 260 #define IB_SA_SERVICE_REC_SERVICE_GID                   IB_SA_COMP_MASK( 1)
 261 #define IB_SA_SERVICE_REC_SERVICE_PKEY                  IB_SA_COMP_MASK( 2)
 262 /* reserved:                                                             3 */
 263 #define IB_SA_SERVICE_REC_SERVICE_LEASE                 IB_SA_COMP_MASK( 4)
 264 #define IB_SA_SERVICE_REC_SERVICE_KEY                   IB_SA_COMP_MASK( 5)
 265 #define IB_SA_SERVICE_REC_SERVICE_NAME                  IB_SA_COMP_MASK( 6)
 266 #define IB_SA_SERVICE_REC_SERVICE_DATA8_0               IB_SA_COMP_MASK( 7)
 267 #define IB_SA_SERVICE_REC_SERVICE_DATA8_1               IB_SA_COMP_MASK( 8)
 268 #define IB_SA_SERVICE_REC_SERVICE_DATA8_2               IB_SA_COMP_MASK( 9)
 269 #define IB_SA_SERVICE_REC_SERVICE_DATA8_3               IB_SA_COMP_MASK(10)
 270 #define IB_SA_SERVICE_REC_SERVICE_DATA8_4               IB_SA_COMP_MASK(11)
 271 #define IB_SA_SERVICE_REC_SERVICE_DATA8_5               IB_SA_COMP_MASK(12)
 272 #define IB_SA_SERVICE_REC_SERVICE_DATA8_6               IB_SA_COMP_MASK(13)
 273 #define IB_SA_SERVICE_REC_SERVICE_DATA8_7               IB_SA_COMP_MASK(14)
 274 #define IB_SA_SERVICE_REC_SERVICE_DATA8_8               IB_SA_COMP_MASK(15)
 275 #define IB_SA_SERVICE_REC_SERVICE_DATA8_9               IB_SA_COMP_MASK(16)
 276 #define IB_SA_SERVICE_REC_SERVICE_DATA8_10              IB_SA_COMP_MASK(17)
 277 #define IB_SA_SERVICE_REC_SERVICE_DATA8_11              IB_SA_COMP_MASK(18)
 278 #define IB_SA_SERVICE_REC_SERVICE_DATA8_12              IB_SA_COMP_MASK(19)
 279 #define IB_SA_SERVICE_REC_SERVICE_DATA8_13              IB_SA_COMP_MASK(20)
 280 #define IB_SA_SERVICE_REC_SERVICE_DATA8_14              IB_SA_COMP_MASK(21)
 281 #define IB_SA_SERVICE_REC_SERVICE_DATA8_15              IB_SA_COMP_MASK(22)
 282 #define IB_SA_SERVICE_REC_SERVICE_DATA16_0              IB_SA_COMP_MASK(23)
 283 #define IB_SA_SERVICE_REC_SERVICE_DATA16_1              IB_SA_COMP_MASK(24)
 284 #define IB_SA_SERVICE_REC_SERVICE_DATA16_2              IB_SA_COMP_MASK(25)
 285 #define IB_SA_SERVICE_REC_SERVICE_DATA16_3              IB_SA_COMP_MASK(26)
 286 #define IB_SA_SERVICE_REC_SERVICE_DATA16_4              IB_SA_COMP_MASK(27)
 287 #define IB_SA_SERVICE_REC_SERVICE_DATA16_5              IB_SA_COMP_MASK(28)
 288 #define IB_SA_SERVICE_REC_SERVICE_DATA16_6              IB_SA_COMP_MASK(29)
 289 #define IB_SA_SERVICE_REC_SERVICE_DATA16_7              IB_SA_COMP_MASK(30)
 290 #define IB_SA_SERVICE_REC_SERVICE_DATA32_0              IB_SA_COMP_MASK(31)
 291 #define IB_SA_SERVICE_REC_SERVICE_DATA32_1              IB_SA_COMP_MASK(32)
 292 #define IB_SA_SERVICE_REC_SERVICE_DATA32_2              IB_SA_COMP_MASK(33)
 293 #define IB_SA_SERVICE_REC_SERVICE_DATA32_3              IB_SA_COMP_MASK(34)
 294 #define IB_SA_SERVICE_REC_SERVICE_DATA64_0              IB_SA_COMP_MASK(35)
 295 #define IB_SA_SERVICE_REC_SERVICE_DATA64_1              IB_SA_COMP_MASK(36)
 296
 297 #define IB_DEFAULT_SERVICE_LEASE        0xFFFFFFFF
 298
 299 struct ib_sa_service_rec {
 300         u64             id;
 301         union ib_gid    gid;
 302         __be16          pkey;
 303         /* reserved */
 304         u32             lease;
 305         u8              key[16];
 306         u8              name[64];
 307         u8              data8[16];
 308         u16             data16[8];
 309         u32             data32[4];
 310         u64             data64[2];
 311 };
 312
 313 #define IB_SA_GUIDINFO_REC_LID          IB_SA_COMP_MASK(0)
 314 #define IB_SA_GUIDINFO_REC_BLOCK_NUM    IB_SA_COMP_MASK(1)
 315 #define IB_SA_GUIDINFO_REC_RES1         IB_SA_COMP_MASK(2)
 316 #define IB_SA_GUIDINFO_REC_RES2         IB_SA_COMP_MASK(3)
 317 #define IB_SA_GUIDINFO_REC_GID0         IB_SA_COMP_MASK(4)
 318 #define IB_SA_GUIDINFO_REC_GID1         IB_SA_COMP_MASK(5)
 319 #define IB_SA_GUIDINFO_REC_GID2         IB_SA_COMP_MASK(6)
 320 #define IB_SA_GUIDINFO_REC_GID3         IB_SA_COMP_MASK(7)
 321 #define IB_SA_GUIDINFO_REC_GID4         IB_SA_COMP_MASK(8)
 322 #define IB_SA_GUIDINFO_REC_GID5         IB_SA_COMP_MASK(9)
 323 #define IB_SA_GUIDINFO_REC_GID6         IB_SA_COMP_MASK(10)
 324 #define IB_SA_GUIDINFO_REC_GID7         IB_SA_COMP_MASK(11)
 325
 326 struct ib_sa_guidinfo_rec {
 327         __be16  lid;
 328         u8      block_num;
 329         /* reserved */
 330         u8      res1;
 331         __be32  res2;
 332         u8      guid_info_list[64];
 333 };
 334
 335 struct ib_sa_client {
 336         atomic_t users;
 337         struct completion comp;
 338 };
 339
 340 /**
 341  * ib_sa_register_client - Register an SA client.
 342  */
 343 void ib_sa_register_client(struct ib_sa_client *client);
 344
 345 /**
 346  * ib_sa_unregister_client - Deregister an SA client.
 347  * @client: Client object to deregister.
 348  */
 349 void ib_sa_unregister_client(struct ib_sa_client *client);
 350
 351 struct ib_sa_query;
 352
 353 void ib_sa_cancel_query(int id, struct ib_sa_query *query);
 354
 355 int ib_sa_path_rec_get(struct ib_sa_client *client,
 356                        struct ib_device *device, u8 port_num,
 357                        struct sa_path_rec *rec,
 358                        ib_sa_comp_mask comp_mask,
 359                        int timeout_ms, gfp_t gfp_mask,
 360                        void (*callback)(int status,
 361                                         struct sa_path_rec *resp,
 362                                         void *context),
 363                        void *context,
 364                        struct ib_sa_query **query);
 365
 366 int ib_sa_service_rec_query(struct ib_sa_client *client,
 367                          struct ib_device *device, u8 port_num,
 368                          u8 method,
 369                          struct ib_sa_service_rec *rec,
 370                          ib_sa_comp_mask comp_mask,
 371                          int timeout_ms, gfp_t gfp_mask,
 372                          void (*callback)(int status,
 373                                           struct ib_sa_service_rec *resp,
 374                                           void *context),
 375                          void *context,
 376                          struct ib_sa_query **sa_query);
 377
 378 struct ib_sa_multicast {
 379         struct ib_sa_mcmember_rec rec;
 380         ib_sa_comp_mask         comp_mask;
 381         int                     (*callback)(int status,
 382                                             struct ib_sa_multicast *multicast);
 383         void                    *context;
 384 };
 385
 386 /**
 387  * ib_sa_join_multicast - Initiates a join request to the specified multicast
 388  *   group.
 389  * @client: SA client
 390  * @device: Device associated with the multicast group.
 391  * @port_num: Port on the specified device to associate with the multicast
 392  *   group.
 393  * @rec: SA multicast member record specifying group attributes.
 394  * @comp_mask: Component mask indicating which group attributes of %rec are
 395  *   valid.
 396  * @gfp_mask: GFP mask for memory allocations.
 397  * @callback: User callback invoked once the join operation completes.
 398  * @context: User specified context stored with the ib_sa_multicast structure.
 399  *
 400  * This call initiates a multicast join request with the SA for the specified
 401  * multicast group.  If the join operation is started successfully, it returns
 402  * an ib_sa_multicast structure that is used to track the multicast operation.
 403  * Users must free this structure by calling ib_free_multicast, even if the
 404  * join operation later fails.  (The callback status is non-zero.)
 405  *
 406  * If the join operation fails; status will be non-zero, with the following
 407  * failures possible:
 408  * -ETIMEDOUT: The request timed out.
 409  * -EIO: An error occurred sending the query.
 410  * -EINVAL: The MCMemberRecord values differed from the existing group's.
 411  * -ENETRESET: Indicates that an fatal error has occurred on the multicast
 412  *   group, and the user must rejoin the group to continue using it.
 413  */
 414 struct ib_sa_multicast *ib_sa_join_multicast(struct ib_sa_client *client,
 415                                              struct ib_device *device, u8 port_num,
 416                                              struct ib_sa_mcmember_rec *rec,
 417                                              ib_sa_comp_mask comp_mask, gfp_t gfp_mask,
 418                                              int (*callback)(int status,
 419                                                              struct ib_sa_multicast
 420                                                                     *multicast),
 421                                              void *context);
 422
 423 /**
 424  * ib_free_multicast - Frees the multicast tracking structure, and releases
 425  *    any reference on the multicast group.
 426  * @multicast: Multicast tracking structure allocated by ib_join_multicast.
 427  *
 428  * This call blocks until the multicast identifier is destroyed.  It may
 429  * not be called from within the multicast callback; however, returning a non-
 430  * zero value from the callback will result in destroying the multicast
 431  * tracking structure.
 432  */
 433 void ib_sa_free_multicast(struct ib_sa_multicast *multicast);
 434
 435 /**
 436  * ib_get_mcmember_rec - Looks up a multicast member record by its MGID and
 437  *   returns it if found.
 438  * @device: Device associated with the multicast group.
 439  * @port_num: Port on the specified device to associate with the multicast
 440  *   group.
 441  * @mgid: MGID of multicast group.
 442  * @rec: Location to copy SA multicast member record.
 443  */
 444 int ib_sa_get_mcmember_rec(struct ib_device *device, u8 port_num,
 445                            union ib_gid *mgid, struct ib_sa_mcmember_rec *rec);
 446
 447 /**
 448  * ib_init_ah_from_mcmember - Initialize address handle attributes based on
 449  * an SA multicast member record.
 450  */
 451 int ib_init_ah_from_mcmember(struct ib_device *device, u8 port_num,
 452                              struct ib_sa_mcmember_rec *rec,
 453                              struct net_device *ndev,
 454                              enum ib_gid_type gid_type,
 455                              struct rdma_ah_attr *ah_attr);
 456
 457 /**
 458  * ib_init_ah_from_path - Initialize address handle attributes based on an SA
 459  *   path record.
 460  */
 461 int ib_init_ah_from_path(struct ib_device *device, u8 port_num,
 462                          struct sa_path_rec *rec,
 463                          struct rdma_ah_attr *ah_attr);
 464
 465 /**
 466  * ib_sa_pack_path - Conert a path record from struct ib_sa_path_rec
 467  * to IB MAD wire format.
 468  */
 469 void ib_sa_pack_path(struct sa_path_rec *rec, void *attribute);
 470
 471 /**
 472  * ib_sa_unpack_path - Convert a path record from MAD format to struct
 473  * ib_sa_path_rec.
 474  */
 475 void ib_sa_unpack_path(void *attribute, struct sa_path_rec *rec);
 476
 477 /* Support GuidInfoRecord */
 478 int ib_sa_guid_info_rec_query(struct ib_sa_client *client,
 479                               struct ib_device *device, u8 port_num,
 480                               struct ib_sa_guidinfo_rec *rec,
 481                               ib_sa_comp_mask comp_mask, u8 method,
 482                               int timeout_ms, gfp_t gfp_mask,
 483                               void (*callback)(int status,
 484                                                struct ib_sa_guidinfo_rec *resp,
 485                                                void *context),
 486                               void *context,
 487                               struct ib_sa_query **sa_query);
 488
 489 bool ib_sa_sendonly_fullmem_support(struct ib_sa_client *client,
 490                                     struct ib_device *device,
 491                                     u8 port_num);
 492
 493 #endif /* IB_SA_H */