drivers/infiniband/ulp/ipoib/ipoib.h

   1 /*
   2  * Copyright (c) 2004, 2005 Topspin Communications.  All rights reserved.
   3  * Copyright (c) 2005 Sun Microsystems, Inc. All rights reserved.
   4  * Copyright (c) 2004 Voltaire, Inc. 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: ipoib.h 1358 2004-12-17 22:00:11Z roland $
  35  */
  36
  37 #ifndef _IPOIB_H
  38 #define _IPOIB_H
  39
  40 #include <linux/list.h>
  41 #include <linux/skbuff.h>
  42 #include <linux/netdevice.h>
  43 #include <linux/workqueue.h>
  44 #include <linux/pci.h>
  45 #include <linux/config.h>
  46 #include <linux/kref.h>
  47 #include <linux/if_infiniband.h>
  48 #include <linux/mutex.h>
  49
  50 #include <net/neighbour.h>
  51
  52 #include <asm/atomic.h>
  53
  54 #include <rdma/ib_verbs.h>
  55 #include <rdma/ib_pack.h>
  56 #include <rdma/ib_sa.h>
  57
  58 /* constants */
  59
  60 enum {
  61         IPOIB_PACKET_SIZE         = 2048,
  62         IPOIB_BUF_SIZE            = IPOIB_PACKET_SIZE + IB_GRH_BYTES,
  63
  64         IPOIB_ENCAP_LEN           = 4,
  65
  66         IPOIB_RX_RING_SIZE        = 128,
  67         IPOIB_TX_RING_SIZE        = 64,
  68
  69         IPOIB_NUM_WC              = 4,
  70
  71         IPOIB_MAX_PATH_REC_QUEUE  = 3,
  72         IPOIB_MAX_MCAST_QUEUE     = 3,
  73
  74         IPOIB_FLAG_OPER_UP        = 0,
  75         IPOIB_FLAG_ADMIN_UP       = 1,
  76         IPOIB_PKEY_ASSIGNED       = 2,
  77         IPOIB_PKEY_STOP           = 3,
  78         IPOIB_FLAG_SUBINTERFACE   = 4,
  79         IPOIB_MCAST_RUN           = 5,
  80         IPOIB_STOP_REAPER         = 6,
  81         IPOIB_MCAST_STARTED       = 7,
  82
  83         IPOIB_MAX_BACKOFF_SECONDS = 16,
  84
  85         IPOIB_MCAST_FLAG_FOUND    = 0,  /* used in set_multicast_list */
  86         IPOIB_MCAST_FLAG_SENDONLY = 1,
  87         IPOIB_MCAST_FLAG_BUSY     = 2,  /* joining or already joined */
  88         IPOIB_MCAST_FLAG_ATTACHED = 3,
  89 };
  90
  91 /* structs */
  92
  93 struct ipoib_header {
  94         __be16  proto;
  95         u16     reserved;
  96 };
  97
  98 struct ipoib_pseudoheader {
  99         u8  hwaddr[INFINIBAND_ALEN];
 100 };
 101
 102 struct ipoib_mcast;
 103
 104 struct ipoib_rx_buf {
 105         struct sk_buff *skb;
 106         dma_addr_t      mapping;
 107 };
 108
 109 struct ipoib_tx_buf {
 110         struct sk_buff *skb;
 111         DECLARE_PCI_UNMAP_ADDR(mapping)
 112 };
 113
 114 /*
 115  * Device private locking: tx_lock protects members used in TX fast
 116  * path (and we use LLTX so upper layers don't do extra locking).
 117  * lock protects everything else.  lock nests inside of tx_lock (ie
 118  * tx_lock must be acquired first if needed).
 119  */
 120 struct ipoib_dev_priv {
 121         spinlock_t lock;
 122
 123         struct net_device *dev;
 124
 125         unsigned long flags;
 126
 127         struct mutex mcast_mutex;
 128         struct mutex vlan_mutex;
 129
 130         struct rb_root  path_tree;
 131         struct list_head path_list;
 132
 133         struct ipoib_mcast *broadcast;
 134         struct list_head multicast_list;
 135         struct rb_root multicast_tree;
 136
 137         struct work_struct pkey_task;
 138         struct work_struct mcast_task;
 139         struct work_struct flush_task;
 140         struct work_struct restart_task;
 141         struct work_struct ah_reap_task;
 142
 143         struct ib_device *ca;
 144         u8                port;
 145         u16               pkey;
 146         struct ib_pd     *pd;
 147         struct ib_mr     *mr;
 148         struct ib_cq     *cq;
 149         struct ib_qp     *qp;
 150         u32               qkey;
 151
 152         union ib_gid local_gid;
 153         u16          local_lid;
 154         u8           local_rate;
 155
 156         unsigned int admin_mtu;
 157         unsigned int mcast_mtu;
 158
 159         struct ipoib_rx_buf *rx_ring;
 160
 161         spinlock_t           tx_lock;
 162         struct ipoib_tx_buf *tx_ring;
 163         unsigned             tx_head;
 164         unsigned             tx_tail;
 165         struct ib_sge        tx_sge;
 166         struct ib_send_wr    tx_wr;
 167
 168         struct ib_wc ibwc[IPOIB_NUM_WC];
 169
 170         struct list_head dead_ahs;
 171
 172         struct ib_event_handler event_handler;
 173
 174         struct net_device_stats stats;
 175
 176         struct net_device *parent;
 177         struct list_head child_intfs;
 178         struct list_head list;
 179
 180 #ifdef CONFIG_INFINIBAND_IPOIB_DEBUG
 181         struct list_head fs_list;
 182         struct dentry *mcg_dentry;
 183         struct dentry *path_dentry;
 184 #endif
 185 };
 186
 187 struct ipoib_ah {
 188         struct net_device *dev;
 189         struct ib_ah      *ah;
 190         struct list_head   list;
 191         struct kref        ref;
 192         unsigned           last_send;
 193 };
 194
 195 struct ipoib_path {
 196         struct net_device    *dev;
 197         struct ib_sa_path_rec pathrec;
 198         struct ipoib_ah      *ah;
 199         struct sk_buff_head   queue;
 200
 201         struct list_head      neigh_list;
 202
 203         int                   query_id;
 204         struct ib_sa_query   *query;
 205         struct completion     done;
 206
 207         struct rb_node        rb_node;
 208         struct list_head      list;
 209 };
 210
 211 struct ipoib_neigh {
 212         struct ipoib_ah    *ah;
 213         struct sk_buff_head queue;
 214
 215         struct neighbour   *neighbour;
 216
 217         struct list_head    list;
 218 };
 219
 220 /*
 221  * We stash a pointer to our private neighbour information after our
 222  * hardware address in neigh->ha.  The ALIGN() expression here makes
 223  * sure that this pointer is stored aligned so that an unaligned
 224  * load is not needed to dereference it.
 225  */
 226 static inline struct ipoib_neigh **to_ipoib_neigh(struct neighbour *neigh)
 227 {
 228         return (void*) neigh + ALIGN(offsetof(struct neighbour, ha) +
 229                                      INFINIBAND_ALEN, sizeof(void *));
 230 }
 231
 232 extern struct workqueue_struct *ipoib_workqueue;
 233
 234 /* functions */
 235
 236 void ipoib_ib_completion(struct ib_cq *cq, void *dev_ptr);
 237
 238 struct ipoib_ah *ipoib_create_ah(struct net_device *dev,
 239                                  struct ib_pd *pd, struct ib_ah_attr *attr);
 240 void ipoib_free_ah(struct kref *kref);
 241 static inline void ipoib_put_ah(struct ipoib_ah *ah)
 242 {
 243         kref_put(&ah->ref, ipoib_free_ah);
 244 }
 245
 246 int ipoib_open(struct net_device *dev);
 247 int ipoib_add_pkey_attr(struct net_device *dev);
 248
 249 void ipoib_send(struct net_device *dev, struct sk_buff *skb,
 250                 struct ipoib_ah *address, u32 qpn);
 251 void ipoib_reap_ah(void *dev_ptr);
 252
 253 void ipoib_flush_paths(struct net_device *dev);
 254 struct ipoib_dev_priv *ipoib_intf_alloc(const char *format);
 255
 256 int ipoib_ib_dev_init(struct net_device *dev, struct ib_device *ca, int port);
 257 void ipoib_ib_dev_flush(void *dev);
 258 void ipoib_ib_dev_cleanup(struct net_device *dev);
 259
 260 int ipoib_ib_dev_open(struct net_device *dev);
 261 int ipoib_ib_dev_up(struct net_device *dev);
 262 int ipoib_ib_dev_down(struct net_device *dev, int flush);
 263 int ipoib_ib_dev_stop(struct net_device *dev);
 264
 265 int ipoib_dev_init(struct net_device *dev, struct ib_device *ca, int port);
 266 void ipoib_dev_cleanup(struct net_device *dev);
 267
 268 void ipoib_mcast_join_task(void *dev_ptr);
 269 void ipoib_mcast_send(struct net_device *dev, union ib_gid *mgid,
 270                       struct sk_buff *skb);
 271
 272 void ipoib_mcast_restart_task(void *dev_ptr);
 273 int ipoib_mcast_start_thread(struct net_device *dev);
 274 int ipoib_mcast_stop_thread(struct net_device *dev, int flush);
 275
 276 void ipoib_mcast_dev_down(struct net_device *dev);
 277 void ipoib_mcast_dev_flush(struct net_device *dev);
 278
 279 #ifdef CONFIG_INFINIBAND_IPOIB_DEBUG
 280 struct ipoib_mcast_iter *ipoib_mcast_iter_init(struct net_device *dev);
 281 int ipoib_mcast_iter_next(struct ipoib_mcast_iter *iter);
 282 void ipoib_mcast_iter_read(struct ipoib_mcast_iter *iter,
 283                                   union ib_gid *gid,
 284                                   unsigned long *created,
 285                                   unsigned int *queuelen,
 286                                   unsigned int *complete,
 287                                   unsigned int *send_only);
 288
 289 struct ipoib_path_iter *ipoib_path_iter_init(struct net_device *dev);
 290 int ipoib_path_iter_next(struct ipoib_path_iter *iter);
 291 void ipoib_path_iter_read(struct ipoib_path_iter *iter,
 292                           struct ipoib_path *path);
 293 #endif
 294
 295 int ipoib_mcast_attach(struct net_device *dev, u16 mlid,
 296                        union ib_gid *mgid);
 297 int ipoib_mcast_detach(struct net_device *dev, u16 mlid,
 298                        union ib_gid *mgid);
 299
 300 int ipoib_init_qp(struct net_device *dev);
 301 int ipoib_transport_dev_init(struct net_device *dev, struct ib_device *ca);
 302 void ipoib_transport_dev_cleanup(struct net_device *dev);
 303
 304 void ipoib_event(struct ib_event_handler *handler,
 305                  struct ib_event *record);
 306
 307 int ipoib_vlan_add(struct net_device *pdev, unsigned short pkey);
 308 int ipoib_vlan_delete(struct net_device *pdev, unsigned short pkey);
 309
 310 void ipoib_pkey_poll(void *dev);
 311 int ipoib_pkey_dev_delay_open(struct net_device *dev);
 312
 313 #ifdef CONFIG_INFINIBAND_IPOIB_DEBUG
 314 void ipoib_create_debug_files(struct net_device *dev);
 315 void ipoib_delete_debug_files(struct net_device *dev);
 316 int ipoib_register_debugfs(void);
 317 void ipoib_unregister_debugfs(void);
 318 #else
 319 static inline void ipoib_create_debug_files(struct net_device *dev) { }
 320 static inline void ipoib_delete_debug_files(struct net_device *dev) { }
 321 static inline int ipoib_register_debugfs(void) { return 0; }
 322 static inline void ipoib_unregister_debugfs(void) { }
 323 #endif
 324
 325
 326 #define ipoib_printk(level, priv, format, arg...)       \
 327         printk(level "%s: " format, ((struct ipoib_dev_priv *) priv)->dev->name , ## arg)
 328 #define ipoib_warn(priv, format, arg...)                \
 329         ipoib_printk(KERN_WARNING, priv, format , ## arg)
 330
 331
 332 #ifdef CONFIG_INFINIBAND_IPOIB_DEBUG
 333 extern int ipoib_debug_level;
 334
 335 #define ipoib_dbg(priv, format, arg...)                 \
 336         do {                                            \
 337                 if (ipoib_debug_level > 0)                      \
 338                         ipoib_printk(KERN_DEBUG, priv, format , ## arg); \
 339         } while (0)
 340 #define ipoib_dbg_mcast(priv, format, arg...)           \
 341         do {                                            \
 342                 if (mcast_debug_level > 0)              \
 343                         ipoib_printk(KERN_DEBUG, priv, format , ## arg); \
 344         } while (0)
 345 #else /* CONFIG_INFINIBAND_IPOIB_DEBUG */
 346 #define ipoib_dbg(priv, format, arg...)                 \
 347         do { (void) (priv); } while (0)
 348 #define ipoib_dbg_mcast(priv, format, arg...)           \
 349         do { (void) (priv); } while (0)
 350 #endif /* CONFIG_INFINIBAND_IPOIB_DEBUG */
 351
 352 #ifdef CONFIG_INFINIBAND_IPOIB_DEBUG_DATA
 353 #define ipoib_dbg_data(priv, format, arg...)            \
 354         do {                                            \
 355                 if (data_debug_level > 0)               \
 356                         ipoib_printk(KERN_DEBUG, priv, format , ## arg); \
 357         } while (0)
 358 #else /* CONFIG_INFINIBAND_IPOIB_DEBUG_DATA */
 359 #define ipoib_dbg_data(priv, format, arg...)            \
 360         do { (void) (priv); } while (0)
 361 #endif /* CONFIG_INFINIBAND_IPOIB_DEBUG_DATA */
 362
 363
 364 #define IPOIB_GID_FMT           "%x:%x:%x:%x:%x:%x:%x:%x"
 365
 366 #define IPOIB_GID_ARG(gid)      be16_to_cpup((__be16 *) ((gid).raw +  0)), \
 367                                 be16_to_cpup((__be16 *) ((gid).raw +  2)), \
 368                                 be16_to_cpup((__be16 *) ((gid).raw +  4)), \
 369                                 be16_to_cpup((__be16 *) ((gid).raw +  6)), \
 370                                 be16_to_cpup((__be16 *) ((gid).raw +  8)), \
 371                                 be16_to_cpup((__be16 *) ((gid).raw + 10)), \
 372                                 be16_to_cpup((__be16 *) ((gid).raw + 12)), \
 373                                 be16_to_cpup((__be16 *) ((gid).raw + 14))
 374
 375 #endif /* _IPOIB_H */