Merge master.kernel.org:/pub/scm/linux/kernel/git/lethal/sh-2.6
[sfrench/cifs-2.6.git] / 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/kref.h>
45 #include <linux/if_infiniband.h>
46 #include <linux/mutex.h>
47
48 #include <net/neighbour.h>
49
50 #include <asm/atomic.h>
51
52 #include <rdma/ib_verbs.h>
53 #include <rdma/ib_pack.h>
54 #include <rdma/ib_sa.h>
55
56 /* constants */
57
58 enum {
59         IPOIB_PACKET_SIZE         = 2048,
60         IPOIB_BUF_SIZE            = IPOIB_PACKET_SIZE + IB_GRH_BYTES,
61
62         IPOIB_ENCAP_LEN           = 4,
63
64         IPOIB_CM_MTU              = 0x10000 - 0x10, /* padding to align header to 16 */
65         IPOIB_CM_BUF_SIZE         = IPOIB_CM_MTU  + IPOIB_ENCAP_LEN,
66         IPOIB_CM_HEAD_SIZE        = IPOIB_CM_BUF_SIZE % PAGE_SIZE,
67         IPOIB_CM_RX_SG            = ALIGN(IPOIB_CM_BUF_SIZE, PAGE_SIZE) / PAGE_SIZE,
68         IPOIB_RX_RING_SIZE        = 128,
69         IPOIB_TX_RING_SIZE        = 64,
70         IPOIB_MAX_QUEUE_SIZE      = 8192,
71         IPOIB_MIN_QUEUE_SIZE      = 2,
72
73         IPOIB_NUM_WC              = 4,
74
75         IPOIB_MAX_PATH_REC_QUEUE  = 3,
76         IPOIB_MAX_MCAST_QUEUE     = 3,
77
78         IPOIB_FLAG_OPER_UP        = 0,
79         IPOIB_FLAG_INITIALIZED    = 1,
80         IPOIB_FLAG_ADMIN_UP       = 2,
81         IPOIB_PKEY_ASSIGNED       = 3,
82         IPOIB_PKEY_STOP           = 4,
83         IPOIB_FLAG_SUBINTERFACE   = 5,
84         IPOIB_MCAST_RUN           = 6,
85         IPOIB_STOP_REAPER         = 7,
86         IPOIB_MCAST_STARTED       = 8,
87         IPOIB_FLAG_NETIF_STOPPED  = 9,
88         IPOIB_FLAG_ADMIN_CM       = 10,
89
90         IPOIB_MAX_BACKOFF_SECONDS = 16,
91
92         IPOIB_MCAST_FLAG_FOUND    = 0,  /* used in set_multicast_list */
93         IPOIB_MCAST_FLAG_SENDONLY = 1,
94         IPOIB_MCAST_FLAG_BUSY     = 2,  /* joining or already joined */
95         IPOIB_MCAST_FLAG_ATTACHED = 3,
96 };
97
98 #define IPOIB_OP_RECV   (1ul << 31)
99 #ifdef CONFIG_INFINIBAND_IPOIB_CM
100 #define IPOIB_CM_OP_SRQ (1ul << 30)
101 #else
102 #define IPOIB_CM_OP_SRQ (0)
103 #endif
104
105 /* structs */
106
107 struct ipoib_header {
108         __be16  proto;
109         u16     reserved;
110 };
111
112 struct ipoib_pseudoheader {
113         u8  hwaddr[INFINIBAND_ALEN];
114 };
115
116 struct ipoib_mcast;
117
118 struct ipoib_rx_buf {
119         struct sk_buff *skb;
120         u64             mapping;
121 };
122
123 struct ipoib_tx_buf {
124         struct sk_buff *skb;
125         u64             mapping;
126 };
127
128 struct ib_cm_id;
129
130 struct ipoib_cm_data {
131         __be32 qpn; /* High byte MUST be ignored on receive */
132         __be32 mtu;
133 };
134
135 struct ipoib_cm_rx {
136         struct ib_cm_id     *id;
137         struct ib_qp        *qp;
138         struct list_head     list;
139         struct net_device   *dev;
140         unsigned long        jiffies;
141 };
142
143 struct ipoib_cm_tx {
144         struct ib_cm_id     *id;
145         struct ib_cq        *cq;
146         struct ib_qp        *qp;
147         struct list_head     list;
148         struct net_device   *dev;
149         struct ipoib_neigh  *neigh;
150         struct ipoib_path   *path;
151         struct ipoib_tx_buf *tx_ring;
152         unsigned             tx_head;
153         unsigned             tx_tail;
154         unsigned long        flags;
155         u32                  mtu;
156         struct ib_wc         ibwc[IPOIB_NUM_WC];
157 };
158
159 struct ipoib_cm_rx_buf {
160         struct sk_buff *skb;
161         u64 mapping[IPOIB_CM_RX_SG];
162 };
163
164 struct ipoib_cm_dev_priv {
165         struct ib_srq          *srq;
166         struct ipoib_cm_rx_buf *srq_ring;
167         struct ib_cm_id        *id;
168         struct list_head        passive_ids;
169         struct work_struct      start_task;
170         struct work_struct      reap_task;
171         struct work_struct      skb_task;
172         struct delayed_work     stale_task;
173         struct sk_buff_head     skb_queue;
174         struct list_head        start_list;
175         struct list_head        reap_list;
176         struct ib_wc            ibwc[IPOIB_NUM_WC];
177         struct ib_sge           rx_sge[IPOIB_CM_RX_SG];
178         struct ib_recv_wr       rx_wr;
179 };
180
181 /*
182  * Device private locking: tx_lock protects members used in TX fast
183  * path (and we use LLTX so upper layers don't do extra locking).
184  * lock protects everything else.  lock nests inside of tx_lock (ie
185  * tx_lock must be acquired first if needed).
186  */
187 struct ipoib_dev_priv {
188         spinlock_t lock;
189
190         struct net_device *dev;
191
192         unsigned long flags;
193
194         struct mutex mcast_mutex;
195         struct mutex vlan_mutex;
196
197         struct rb_root  path_tree;
198         struct list_head path_list;
199
200         struct ipoib_mcast *broadcast;
201         struct list_head multicast_list;
202         struct rb_root multicast_tree;
203
204         struct delayed_work pkey_task;
205         struct delayed_work mcast_task;
206         struct work_struct flush_task;
207         struct work_struct restart_task;
208         struct delayed_work ah_reap_task;
209
210         struct ib_device *ca;
211         u8                port;
212         u16               pkey;
213         struct ib_pd     *pd;
214         struct ib_mr     *mr;
215         struct ib_cq     *cq;
216         struct ib_qp     *qp;
217         u32               qkey;
218
219         union ib_gid local_gid;
220         u16          local_lid;
221
222         unsigned int admin_mtu;
223         unsigned int mcast_mtu;
224
225         struct ipoib_rx_buf *rx_ring;
226
227         spinlock_t           tx_lock;
228         struct ipoib_tx_buf *tx_ring;
229         unsigned             tx_head;
230         unsigned             tx_tail;
231         struct ib_sge        tx_sge;
232         struct ib_send_wr    tx_wr;
233
234         struct ib_wc ibwc[IPOIB_NUM_WC];
235
236         struct list_head dead_ahs;
237
238         struct ib_event_handler event_handler;
239
240         struct net_device_stats stats;
241
242         struct net_device *parent;
243         struct list_head child_intfs;
244         struct list_head list;
245
246 #ifdef CONFIG_INFINIBAND_IPOIB_CM
247         struct ipoib_cm_dev_priv cm;
248 #endif
249
250 #ifdef CONFIG_INFINIBAND_IPOIB_DEBUG
251         struct list_head fs_list;
252         struct dentry *mcg_dentry;
253         struct dentry *path_dentry;
254 #endif
255 };
256
257 struct ipoib_ah {
258         struct net_device *dev;
259         struct ib_ah      *ah;
260         struct list_head   list;
261         struct kref        ref;
262         unsigned           last_send;
263 };
264
265 struct ipoib_path {
266         struct net_device    *dev;
267         struct ib_sa_path_rec pathrec;
268         struct ipoib_ah      *ah;
269         struct sk_buff_head   queue;
270
271         struct list_head      neigh_list;
272
273         int                   query_id;
274         struct ib_sa_query   *query;
275         struct completion     done;
276
277         struct rb_node        rb_node;
278         struct list_head      list;
279 };
280
281 struct ipoib_neigh {
282         struct ipoib_ah    *ah;
283 #ifdef CONFIG_INFINIBAND_IPOIB_CM
284         struct ipoib_cm_tx *cm;
285 #endif
286         union ib_gid        dgid;
287         struct sk_buff_head queue;
288
289         struct neighbour   *neighbour;
290
291         struct list_head    list;
292 };
293
294 /*
295  * We stash a pointer to our private neighbour information after our
296  * hardware address in neigh->ha.  The ALIGN() expression here makes
297  * sure that this pointer is stored aligned so that an unaligned
298  * load is not needed to dereference it.
299  */
300 static inline struct ipoib_neigh **to_ipoib_neigh(struct neighbour *neigh)
301 {
302         return (void*) neigh + ALIGN(offsetof(struct neighbour, ha) +
303                                      INFINIBAND_ALEN, sizeof(void *));
304 }
305
306 struct ipoib_neigh *ipoib_neigh_alloc(struct neighbour *neigh);
307 void ipoib_neigh_free(struct net_device *dev, struct ipoib_neigh *neigh);
308
309 extern struct workqueue_struct *ipoib_workqueue;
310
311 /* functions */
312
313 void ipoib_ib_completion(struct ib_cq *cq, void *dev_ptr);
314
315 struct ipoib_ah *ipoib_create_ah(struct net_device *dev,
316                                  struct ib_pd *pd, struct ib_ah_attr *attr);
317 void ipoib_free_ah(struct kref *kref);
318 static inline void ipoib_put_ah(struct ipoib_ah *ah)
319 {
320         kref_put(&ah->ref, ipoib_free_ah);
321 }
322
323 int ipoib_open(struct net_device *dev);
324 int ipoib_add_pkey_attr(struct net_device *dev);
325
326 void ipoib_send(struct net_device *dev, struct sk_buff *skb,
327                 struct ipoib_ah *address, u32 qpn);
328 void ipoib_reap_ah(struct work_struct *work);
329
330 void ipoib_flush_paths(struct net_device *dev);
331 struct ipoib_dev_priv *ipoib_intf_alloc(const char *format);
332
333 int ipoib_ib_dev_init(struct net_device *dev, struct ib_device *ca, int port);
334 void ipoib_ib_dev_flush(struct work_struct *work);
335 void ipoib_ib_dev_cleanup(struct net_device *dev);
336
337 int ipoib_ib_dev_open(struct net_device *dev);
338 int ipoib_ib_dev_up(struct net_device *dev);
339 int ipoib_ib_dev_down(struct net_device *dev, int flush);
340 int ipoib_ib_dev_stop(struct net_device *dev);
341
342 int ipoib_dev_init(struct net_device *dev, struct ib_device *ca, int port);
343 void ipoib_dev_cleanup(struct net_device *dev);
344
345 void ipoib_mcast_join_task(struct work_struct *work);
346 void ipoib_mcast_send(struct net_device *dev, void *mgid, struct sk_buff *skb);
347
348 void ipoib_mcast_restart_task(struct work_struct *work);
349 int ipoib_mcast_start_thread(struct net_device *dev);
350 int ipoib_mcast_stop_thread(struct net_device *dev, int flush);
351
352 void ipoib_mcast_dev_down(struct net_device *dev);
353 void ipoib_mcast_dev_flush(struct net_device *dev);
354
355 #ifdef CONFIG_INFINIBAND_IPOIB_DEBUG
356 struct ipoib_mcast_iter *ipoib_mcast_iter_init(struct net_device *dev);
357 int ipoib_mcast_iter_next(struct ipoib_mcast_iter *iter);
358 void ipoib_mcast_iter_read(struct ipoib_mcast_iter *iter,
359                                   union ib_gid *gid,
360                                   unsigned long *created,
361                                   unsigned int *queuelen,
362                                   unsigned int *complete,
363                                   unsigned int *send_only);
364
365 struct ipoib_path_iter *ipoib_path_iter_init(struct net_device *dev);
366 int ipoib_path_iter_next(struct ipoib_path_iter *iter);
367 void ipoib_path_iter_read(struct ipoib_path_iter *iter,
368                           struct ipoib_path *path);
369 #endif
370
371 int ipoib_mcast_attach(struct net_device *dev, u16 mlid,
372                        union ib_gid *mgid);
373 int ipoib_mcast_detach(struct net_device *dev, u16 mlid,
374                        union ib_gid *mgid);
375
376 int ipoib_init_qp(struct net_device *dev);
377 int ipoib_transport_dev_init(struct net_device *dev, struct ib_device *ca);
378 void ipoib_transport_dev_cleanup(struct net_device *dev);
379
380 void ipoib_event(struct ib_event_handler *handler,
381                  struct ib_event *record);
382
383 int ipoib_vlan_add(struct net_device *pdev, unsigned short pkey);
384 int ipoib_vlan_delete(struct net_device *pdev, unsigned short pkey);
385
386 void ipoib_pkey_poll(struct work_struct *work);
387 int ipoib_pkey_dev_delay_open(struct net_device *dev);
388
389 #ifdef CONFIG_INFINIBAND_IPOIB_CM
390
391 #define IPOIB_FLAGS_RC          0x80
392 #define IPOIB_FLAGS_UC          0x40
393
394 /* We don't support UC connections at the moment */
395 #define IPOIB_CM_SUPPORTED(ha)   (ha[0] & (IPOIB_FLAGS_RC))
396
397 static inline int ipoib_cm_admin_enabled(struct net_device *dev)
398 {
399         struct ipoib_dev_priv *priv = netdev_priv(dev);
400         return IPOIB_CM_SUPPORTED(dev->dev_addr) &&
401                 test_bit(IPOIB_FLAG_ADMIN_CM, &priv->flags);
402 }
403
404 static inline int ipoib_cm_enabled(struct net_device *dev, struct neighbour *n)
405 {
406         struct ipoib_dev_priv *priv = netdev_priv(dev);
407         return IPOIB_CM_SUPPORTED(n->ha) &&
408                 test_bit(IPOIB_FLAG_ADMIN_CM, &priv->flags);
409 }
410
411 static inline int ipoib_cm_up(struct ipoib_neigh *neigh)
412
413 {
414         return test_bit(IPOIB_FLAG_OPER_UP, &neigh->cm->flags);
415 }
416
417 static inline struct ipoib_cm_tx *ipoib_cm_get(struct ipoib_neigh *neigh)
418 {
419         return neigh->cm;
420 }
421
422 static inline void ipoib_cm_set(struct ipoib_neigh *neigh, struct ipoib_cm_tx *tx)
423 {
424         neigh->cm = tx;
425 }
426
427 void ipoib_cm_send(struct net_device *dev, struct sk_buff *skb, struct ipoib_cm_tx *tx);
428 int ipoib_cm_dev_open(struct net_device *dev);
429 void ipoib_cm_dev_stop(struct net_device *dev);
430 int ipoib_cm_dev_init(struct net_device *dev);
431 int ipoib_cm_add_mode_attr(struct net_device *dev);
432 void ipoib_cm_dev_cleanup(struct net_device *dev);
433 struct ipoib_cm_tx *ipoib_cm_create_tx(struct net_device *dev, struct ipoib_path *path,
434                                     struct ipoib_neigh *neigh);
435 void ipoib_cm_destroy_tx(struct ipoib_cm_tx *tx);
436 void ipoib_cm_skb_too_long(struct net_device* dev, struct sk_buff *skb,
437                            unsigned int mtu);
438 void ipoib_cm_handle_rx_wc(struct net_device *dev, struct ib_wc *wc);
439 #else
440
441 struct ipoib_cm_tx;
442
443 static inline int ipoib_cm_admin_enabled(struct net_device *dev)
444 {
445         return 0;
446 }
447 static inline int ipoib_cm_enabled(struct net_device *dev, struct neighbour *n)
448
449 {
450         return 0;
451 }
452
453 static inline int ipoib_cm_up(struct ipoib_neigh *neigh)
454
455 {
456         return 0;
457 }
458
459 static inline struct ipoib_cm_tx *ipoib_cm_get(struct ipoib_neigh *neigh)
460 {
461         return NULL;
462 }
463
464 static inline void ipoib_cm_set(struct ipoib_neigh *neigh, struct ipoib_cm_tx *tx)
465 {
466 }
467
468 static inline
469 void ipoib_cm_send(struct net_device *dev, struct sk_buff *skb, struct ipoib_cm_tx *tx)
470 {
471         return;
472 }
473
474 static inline
475 int ipoib_cm_dev_open(struct net_device *dev)
476 {
477         return 0;
478 }
479
480 static inline
481 void ipoib_cm_dev_stop(struct net_device *dev)
482 {
483         return;
484 }
485
486 static inline
487 int ipoib_cm_dev_init(struct net_device *dev)
488 {
489         return -ENOSYS;
490 }
491
492 static inline
493 void ipoib_cm_dev_cleanup(struct net_device *dev)
494 {
495         return;
496 }
497
498 static inline
499 struct ipoib_cm_tx *ipoib_cm_create_tx(struct net_device *dev, struct ipoib_path *path,
500                                     struct ipoib_neigh *neigh)
501 {
502         return NULL;
503 }
504
505 static inline
506 void ipoib_cm_destroy_tx(struct ipoib_cm_tx *tx)
507 {
508         return;
509 }
510
511 static inline
512 int ipoib_cm_add_mode_attr(struct net_device *dev)
513 {
514         return 0;
515 }
516
517 static inline void ipoib_cm_skb_too_long(struct net_device* dev, struct sk_buff *skb,
518                                          unsigned int mtu)
519 {
520         dev_kfree_skb_any(skb);
521 }
522
523 static inline void ipoib_cm_handle_rx_wc(struct net_device *dev, struct ib_wc *wc)
524 {
525 }
526
527 #endif
528
529 #ifdef CONFIG_INFINIBAND_IPOIB_DEBUG
530 void ipoib_create_debug_files(struct net_device *dev);
531 void ipoib_delete_debug_files(struct net_device *dev);
532 int ipoib_register_debugfs(void);
533 void ipoib_unregister_debugfs(void);
534 #else
535 static inline void ipoib_create_debug_files(struct net_device *dev) { }
536 static inline void ipoib_delete_debug_files(struct net_device *dev) { }
537 static inline int ipoib_register_debugfs(void) { return 0; }
538 static inline void ipoib_unregister_debugfs(void) { }
539 #endif
540
541
542 #define ipoib_printk(level, priv, format, arg...)       \
543         printk(level "%s: " format, ((struct ipoib_dev_priv *) priv)->dev->name , ## arg)
544 #define ipoib_warn(priv, format, arg...)                \
545         ipoib_printk(KERN_WARNING, priv, format , ## arg)
546
547 extern int ipoib_sendq_size;
548 extern int ipoib_recvq_size;
549
550 extern struct ib_sa_client ipoib_sa_client;
551
552 #ifdef CONFIG_INFINIBAND_IPOIB_DEBUG
553 extern int ipoib_debug_level;
554
555 #define ipoib_dbg(priv, format, arg...)                 \
556         do {                                            \
557                 if (ipoib_debug_level > 0)                      \
558                         ipoib_printk(KERN_DEBUG, priv, format , ## arg); \
559         } while (0)
560 #define ipoib_dbg_mcast(priv, format, arg...)           \
561         do {                                            \
562                 if (mcast_debug_level > 0)              \
563                         ipoib_printk(KERN_DEBUG, priv, format , ## arg); \
564         } while (0)
565 #else /* CONFIG_INFINIBAND_IPOIB_DEBUG */
566 #define ipoib_dbg(priv, format, arg...)                 \
567         do { (void) (priv); } while (0)
568 #define ipoib_dbg_mcast(priv, format, arg...)           \
569         do { (void) (priv); } while (0)
570 #endif /* CONFIG_INFINIBAND_IPOIB_DEBUG */
571
572 #ifdef CONFIG_INFINIBAND_IPOIB_DEBUG_DATA
573 #define ipoib_dbg_data(priv, format, arg...)            \
574         do {                                            \
575                 if (data_debug_level > 0)               \
576                         ipoib_printk(KERN_DEBUG, priv, format , ## arg); \
577         } while (0)
578 #else /* CONFIG_INFINIBAND_IPOIB_DEBUG_DATA */
579 #define ipoib_dbg_data(priv, format, arg...)            \
580         do { (void) (priv); } while (0)
581 #endif /* CONFIG_INFINIBAND_IPOIB_DEBUG_DATA */
582
583
584 #define IPOIB_GID_FMT           "%2.2x%2.2x:%2.2x%2.2x:%2.2x%2.2x:%2.2x%2.2x:" \
585                                 "%2.2x%2.2x:%2.2x%2.2x:%2.2x%2.2x:%2.2x%2.2x"
586
587 #define IPOIB_GID_RAW_ARG(gid)  ((u8 *)(gid))[0], \
588                                 ((u8 *)(gid))[1], \
589                                 ((u8 *)(gid))[2], \
590                                 ((u8 *)(gid))[3], \
591                                 ((u8 *)(gid))[4], \
592                                 ((u8 *)(gid))[5], \
593                                 ((u8 *)(gid))[6], \
594                                 ((u8 *)(gid))[7], \
595                                 ((u8 *)(gid))[8], \
596                                 ((u8 *)(gid))[9], \
597                                 ((u8 *)(gid))[10],\
598                                 ((u8 *)(gid))[11],\
599                                 ((u8 *)(gid))[12],\
600                                 ((u8 *)(gid))[13],\
601                                 ((u8 *)(gid))[14],\
602                                 ((u8 *)(gid))[15]
603
604 #define IPOIB_GID_ARG(gid)      IPOIB_GID_RAW_ARG((gid).raw)
605
606 #define IPOIB_QPN(ha) (be32_to_cpup((__be32 *) ha) & 0xffffff)
607
608 #endif /* _IPOIB_H */