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