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