vxge: Remove queue_state references
[linux-2.6.git] / drivers / net / vxge / vxge-main.h
1 /******************************************************************************
2  * This software may be used and distributed according to the terms of
3  * the GNU General Public License (GPL), incorporated herein by reference.
4  * Drivers based on or derived from this code fall under the GPL and must
5  * retain the authorship, copyright and license notice.  This file is not
6  * a complete program and may only be used when the entire operating
7  * system is licensed under the GPL.
8  * See the file COPYING in this distribution for more information.
9  *
10  * vxge-main.h: Driver for Neterion Inc's X3100 Series 10GbE PCIe I/O
11  *              Virtualized Server Adapter.
12  * Copyright(c) 2002-2009 Neterion Inc.
13  ******************************************************************************/
14 #ifndef VXGE_MAIN_H
15 #define VXGE_MAIN_H
16
17 #include "vxge-traffic.h"
18 #include "vxge-config.h"
19 #include "vxge-version.h"
20 #include <linux/list.h>
21
22 #define VXGE_DRIVER_NAME                "vxge"
23 #define VXGE_DRIVER_VENDOR              "Neterion, Inc"
24 #define VXGE_DRIVER_FW_VERSION_MAJOR    1
25
26 #define DRV_VERSION     VXGE_VERSION_MAJOR"."VXGE_VERSION_MINOR"."\
27         VXGE_VERSION_FIX"."VXGE_VERSION_BUILD"-"\
28         VXGE_VERSION_FOR
29
30 #define PCI_DEVICE_ID_TITAN_WIN         0x5733
31 #define PCI_DEVICE_ID_TITAN_UNI         0x5833
32 #define VXGE_USE_DEFAULT                0xffffffff
33 #define VXGE_HW_VPATH_MSIX_ACTIVE       4
34 #define VXGE_ALARM_MSIX_ID              2
35 #define VXGE_HW_RXSYNC_FREQ_CNT         4
36 #define VXGE_LL_WATCH_DOG_TIMEOUT       (15 * HZ)
37 #define VXGE_LL_RX_COPY_THRESHOLD       256
38 #define VXGE_DEF_FIFO_LENGTH            84
39
40 #define NO_STEERING             0
41 #define PORT_STEERING           0x1
42 #define RTH_STEERING            0x2
43 #define RX_TOS_STEERING         0x3
44 #define RX_VLAN_STEERING        0x4
45 #define RTH_BUCKET_SIZE         4
46
47 #define TX_PRIORITY_STEERING    1
48 #define TX_VLAN_STEERING        2
49 #define TX_PORT_STEERING        3
50 #define TX_MULTIQ_STEERING      4
51
52 #define VXGE_HW_MAC_ADDR_LEARN_DEFAULT VXGE_HW_RTS_MAC_DISABLE
53
54 #define VXGE_TTI_BTIMER_VAL 250000
55
56 #define VXGE_TTI_LTIMER_VAL 1000
57 #define VXGE_TTI_RTIMER_VAL 0
58 #define VXGE_RTI_BTIMER_VAL 250
59 #define VXGE_RTI_LTIMER_VAL 100
60 #define VXGE_RTI_RTIMER_VAL 0
61 #define VXGE_FIFO_INDICATE_MAX_PKTS VXGE_DEF_FIFO_LENGTH
62 #define VXGE_ISR_POLLING_CNT    8
63 #define VXGE_MAX_CONFIG_DEV     0xFF
64 #define VXGE_EXEC_MODE_DISABLE  0
65 #define VXGE_EXEC_MODE_ENABLE   1
66 #define VXGE_MAX_CONFIG_PORT    1
67 #define VXGE_ALL_VID_DISABLE    0
68 #define VXGE_ALL_VID_ENABLE     1
69 #define VXGE_PAUSE_CTRL_DISABLE 0
70 #define VXGE_PAUSE_CTRL_ENABLE  1
71
72 #define TTI_TX_URANGE_A 5
73 #define TTI_TX_URANGE_B 15
74 #define TTI_TX_URANGE_C 40
75 #define TTI_TX_UFC_A    5
76 #define TTI_TX_UFC_B    40
77 #define TTI_TX_UFC_C    60
78 #define TTI_TX_UFC_D    100
79
80 #define RTI_RX_URANGE_A 5
81 #define RTI_RX_URANGE_B 15
82 #define RTI_RX_URANGE_C 40
83 #define RTI_RX_UFC_A    1
84 #define RTI_RX_UFC_B    5
85 #define RTI_RX_UFC_C    10
86 #define RTI_RX_UFC_D    15
87
88 /* Milli secs timer period */
89 #define VXGE_TIMER_DELAY                10000
90
91 #define VXGE_LL_MAX_FRAME_SIZE(dev) ((dev)->mtu + VXGE_HW_MAC_HEADER_MAX_SIZE)
92
93 #define is_sriov(function_mode) \
94         ((function_mode == VXGE_HW_FUNCTION_MODE_SRIOV) || \
95         (function_mode == VXGE_HW_FUNCTION_MODE_SRIOV_8) || \
96         (function_mode == VXGE_HW_FUNCTION_MODE_SRIOV_4))
97
98 enum vxge_reset_event {
99         /* reset events */
100         VXGE_LL_VPATH_RESET     = 0,
101         VXGE_LL_DEVICE_RESET    = 1,
102         VXGE_LL_FULL_RESET      = 2,
103         VXGE_LL_START_RESET     = 3,
104         VXGE_LL_COMPL_RESET     = 4
105 };
106 /* These flags represent the devices temporary state */
107 enum vxge_device_state_t {
108 __VXGE_STATE_RESET_CARD = 0,
109 __VXGE_STATE_CARD_UP
110 };
111
112 enum vxge_mac_addr_state {
113         /* mac address states */
114         VXGE_LL_MAC_ADDR_IN_LIST        = 0,
115         VXGE_LL_MAC_ADDR_IN_DA_TABLE    = 1
116 };
117
118 struct vxge_drv_config {
119         int config_dev_cnt;
120         int total_dev_cnt;
121         int g_no_cpus;
122         unsigned int vpath_per_dev;
123 };
124
125 struct macInfo {
126         unsigned char macaddr[ETH_ALEN];
127         unsigned char macmask[ETH_ALEN];
128         unsigned int vpath_no;
129         enum vxge_mac_addr_state state;
130 };
131
132 struct vxge_config {
133         int             tx_pause_enable;
134         int             rx_pause_enable;
135
136 #define NEW_NAPI_WEIGHT 64
137         int             napi_weight;
138 #define VXGE_GRO_DONOT_AGGREGATE                0
139 #define VXGE_GRO_ALWAYS_AGGREGATE               1
140         int             gro_enable;
141         int             intr_type;
142 #define INTA    0
143 #define MSI     1
144 #define MSI_X   2
145
146         int             addr_learn_en;
147
148         int             rth_steering;
149         int             rth_algorithm;
150         int             rth_hash_type_tcpipv4;
151         int             rth_hash_type_ipv4;
152         int             rth_hash_type_tcpipv6;
153         int             rth_hash_type_ipv6;
154         int             rth_hash_type_tcpipv6ex;
155         int             rth_hash_type_ipv6ex;
156         int             rth_bkt_sz;
157         int             rth_jhash_golden_ratio;
158         int             tx_steering_type;
159         int     fifo_indicate_max_pkts;
160         struct vxge_hw_device_hw_info device_hw_info;
161 };
162
163 struct vxge_msix_entry {
164         /* Mimicing the msix_entry struct of Kernel. */
165         u16 vector;
166         u16 entry;
167         u16 in_use;
168         void *arg;
169 };
170
171 /* Software Statistics */
172
173 struct vxge_sw_stats {
174         /* Network Stats (interface stats) */
175         struct net_device_stats net_stats;
176
177         /* Tx */
178         u64 tx_frms;
179         u64 tx_errors;
180         u64 tx_bytes;
181         u64 txd_not_free;
182         u64 txd_out_of_desc;
183
184         /* Virtual Path */
185         u64 vpaths_open;
186         u64 vpath_open_fail;
187
188         /* Rx */
189         u64 rx_frms;
190         u64 rx_errors;
191         u64 rx_bytes;
192         u64 rx_mcast;
193
194         /* Misc. */
195         u64 link_up;
196         u64 link_down;
197         u64 pci_map_fail;
198         u64 skb_alloc_fail;
199 };
200
201 struct vxge_mac_addrs {
202         struct list_head item;
203         u64 macaddr;
204         u64 macmask;
205         enum vxge_mac_addr_state state;
206 };
207
208 struct vxgedev;
209
210 struct vxge_fifo_stats {
211         u64 tx_frms;
212         u64 tx_errors;
213         u64 tx_bytes;
214         u64 txd_not_free;
215         u64 txd_out_of_desc;
216         u64 pci_map_fail;
217 };
218
219 struct vxge_fifo {
220         struct net_device       *ndev;
221         struct pci_dev          *pdev;
222         struct __vxge_hw_fifo *handle;
223
224         /* The vpath id maintained in the driver -
225          * 0 to 'maximum_vpaths_in_function - 1'
226          */
227         int driver_id;
228         int tx_steering_type;
229         int indicate_max_pkts;
230         spinlock_t tx_lock;
231
232         /* Tx stats */
233         struct vxge_fifo_stats stats;
234 } ____cacheline_aligned;
235
236 struct vxge_ring_stats {
237         u64 prev_rx_frms;
238         u64 rx_frms;
239         u64 rx_errors;
240         u64 rx_dropped;
241         u64 rx_bytes;
242         u64 rx_mcast;
243         u64 pci_map_fail;
244         u64 skb_alloc_fail;
245 };
246
247 struct vxge_ring {
248         struct net_device       *ndev;
249         struct pci_dev          *pdev;
250         struct __vxge_hw_ring   *handle;
251         /* The vpath id maintained in the driver -
252          * 0 to 'maximum_vpaths_in_function - 1'
253          */
254         int driver_id;
255
256          /* copy of the flag indicating whether rx_csum is to be used */
257         u32 rx_csum;
258
259         int pkts_processed;
260         int budget;
261         int gro_enable;
262
263         struct napi_struct napi;
264         struct napi_struct *napi_p;
265
266 #define VXGE_MAX_MAC_ADDR_COUNT         30
267
268         int vlan_tag_strip;
269         struct vlan_group *vlgrp;
270         int rx_vector_no;
271         enum vxge_hw_status last_status;
272
273         /* Rx stats */
274         struct vxge_ring_stats stats;
275 } ____cacheline_aligned;
276
277 struct vxge_vpath {
278
279         struct vxge_fifo fifo;
280         struct vxge_ring ring;
281
282         struct __vxge_hw_vpath_handle *handle;
283
284         /* Actual vpath id for this vpath in the device - 0 to 16 */
285         int device_id;
286         int max_mac_addr_cnt;
287         int is_configured;
288         int is_open;
289         struct vxgedev *vdev;
290         u8 (macaddr)[ETH_ALEN];
291         u8 (macmask)[ETH_ALEN];
292
293 #define VXGE_MAX_LEARN_MAC_ADDR_CNT     2048
294         /* mac addresses currently programmed into NIC */
295         u16 mac_addr_cnt;
296         u16 mcast_addr_cnt;
297         struct list_head mac_addr_list;
298
299         u32 level_err;
300         u32 level_trace;
301 };
302 #define VXGE_COPY_DEBUG_INFO_TO_LL(vdev, err, trace) {  \
303         for (i = 0; i < vdev->no_of_vpath; i++) {               \
304                 vdev->vpaths[i].level_err = err;                \
305                 vdev->vpaths[i].level_trace = trace;            \
306         }                                                       \
307         vdev->level_err = err;                                  \
308         vdev->level_trace = trace;                              \
309 }
310
311 struct vxgedev {
312         struct net_device       *ndev;
313         struct pci_dev          *pdev;
314         struct __vxge_hw_device *devh;
315         struct vlan_group       *vlgrp;
316         int vlan_tag_strip;
317         struct vxge_config      config;
318         unsigned long   state;
319
320         /* Indicates which vpath to reset */
321         unsigned long  vp_reset;
322
323         /* Timer used for polling vpath resets */
324         struct timer_list vp_reset_timer;
325
326         /* Timer used for polling vpath lockup */
327         struct timer_list vp_lockup_timer;
328
329         /*
330          * Flags to track whether device is in All Multicast
331          * or in promiscuous mode.
332          */
333         u16             all_multi_flg;
334
335          /* A flag indicating whether rx_csum is to be used or not. */
336         u32     rx_csum;
337
338         struct vxge_msix_entry *vxge_entries;
339         struct msix_entry *entries;
340         /*
341          * 4 for each vpath * 17;
342          * total is 68
343          */
344 #define VXGE_MAX_REQUESTED_MSIX 68
345 #define VXGE_INTR_STRLEN 80
346         char desc[VXGE_MAX_REQUESTED_MSIX][VXGE_INTR_STRLEN];
347
348         enum vxge_hw_event cric_err_event;
349
350         int max_vpath_supported;
351         int no_of_vpath;
352
353         struct napi_struct napi;
354         /* A debug option, when enabled and if error condition occurs,
355          * the driver will do following steps:
356          * - mask all interrupts
357          * - Not clear the source of the alarm
358          * - gracefully stop all I/O
359          * A diagnostic dump of register and stats at this point
360          * reveals very useful information.
361          */
362         int exec_mode;
363         int max_config_port;
364         struct vxge_vpath       *vpaths;
365
366         struct __vxge_hw_vpath_handle *vp_handles[VXGE_HW_MAX_VIRTUAL_PATHS];
367         void __iomem *bar0;
368         struct vxge_sw_stats    stats;
369         int             mtu;
370         /* Below variables are used for vpath selection to transmit a packet */
371         u8              vpath_selector[VXGE_HW_MAX_VIRTUAL_PATHS];
372         u64             vpaths_deployed;
373
374         u32             intr_cnt;
375         u32             level_err;
376         u32             level_trace;
377         char            fw_version[VXGE_HW_FW_STRLEN];
378 };
379
380 struct vxge_rx_priv {
381         struct sk_buff          *skb;
382         unsigned char           *skb_data;
383         dma_addr_t              data_dma;
384         dma_addr_t              data_size;
385 };
386
387 struct vxge_tx_priv {
388         struct sk_buff          *skb;
389         dma_addr_t              dma_buffers[MAX_SKB_FRAGS+1];
390 };
391
392 #define VXGE_MODULE_PARAM_INT(p, val) \
393         static int p = val; \
394         module_param(p, int, 0)
395
396 #define vxge_os_bug(fmt...)             { printk(fmt); BUG(); }
397
398 #define vxge_os_timer(timer, handle, arg, exp) do { \
399                 init_timer(&timer); \
400                 timer.function = handle; \
401                 timer.data = (unsigned long) arg; \
402                 mod_timer(&timer, (jiffies + exp)); \
403         } while (0);
404
405 int __devinit vxge_device_register(struct __vxge_hw_device *devh,
406                                     struct vxge_config *config,
407                                     int high_dma, int no_of_vpath,
408                                     struct vxgedev **vdev);
409
410 void vxge_device_unregister(struct __vxge_hw_device *devh);
411
412 void vxge_vpath_intr_enable(struct vxgedev *vdev, int vp_id);
413
414 void vxge_vpath_intr_disable(struct vxgedev *vdev, int vp_id);
415
416 void vxge_callback_link_up(struct __vxge_hw_device *devh);
417
418 void vxge_callback_link_down(struct __vxge_hw_device *devh);
419
420 enum vxge_hw_status vxge_add_mac_addr(struct vxgedev *vdev,
421         struct macInfo *mac);
422
423 int vxge_mac_list_del(struct vxge_vpath *vpath, struct macInfo *mac);
424
425 int vxge_reset(struct vxgedev *vdev);
426
427 enum vxge_hw_status
428 vxge_rx_1b_compl(struct __vxge_hw_ring *ringh, void *dtr,
429         u8 t_code, void *userdata);
430
431 enum vxge_hw_status
432 vxge_xmit_compl(struct __vxge_hw_fifo *fifo_hw, void *dtr,
433         enum vxge_hw_fifo_tcode t_code, void *userdata,
434         struct sk_buff ***skb_ptr, int nr_skbs, int *more);
435
436 int vxge_close(struct net_device *dev);
437
438 int vxge_open(struct net_device *dev);
439
440 void vxge_close_vpaths(struct vxgedev *vdev, int index);
441
442 int vxge_open_vpaths(struct vxgedev *vdev);
443
444 enum vxge_hw_status vxge_reset_all_vpaths(struct vxgedev *vdev);
445
446 void vxge_stop_tx_queue(struct vxge_fifo *fifo);
447
448 void vxge_wake_tx_queue(struct vxge_fifo *fifo);
449
450 enum vxge_hw_status vxge_add_mac_addr(struct vxgedev *vdev,
451         struct macInfo *mac);
452
453 enum vxge_hw_status vxge_del_mac_addr(struct vxgedev *vdev,
454         struct macInfo *mac);
455
456 int vxge_mac_list_add(struct vxge_vpath *vpath,
457         struct macInfo *mac);
458
459 void vxge_free_mac_add_list(struct vxge_vpath *vpath);
460
461 enum vxge_hw_status vxge_restore_vpath_mac_addr(struct vxge_vpath *vpath);
462
463 enum vxge_hw_status vxge_restore_vpath_vid_table(struct vxge_vpath *vpath);
464
465 int do_vxge_close(struct net_device *dev, int do_io);
466 extern void initialize_ethtool_ops(struct net_device *ndev);
467 /**
468  * #define VXGE_DEBUG_INIT: debug for initialization functions
469  * #define VXGE_DEBUG_TX         : debug transmit related functions
470  * #define VXGE_DEBUG_RX  : debug recevice related functions
471  * #define VXGE_DEBUG_MEM : debug memory module
472  * #define VXGE_DEBUG_LOCK: debug locks
473  * #define VXGE_DEBUG_SEM : debug semaphore
474  * #define VXGE_DEBUG_ENTRYEXIT: debug functions by adding entry exit statements
475 */
476 #define VXGE_DEBUG_INIT         0x00000001
477 #define VXGE_DEBUG_TX           0x00000002
478 #define VXGE_DEBUG_RX           0x00000004
479 #define VXGE_DEBUG_MEM          0x00000008
480 #define VXGE_DEBUG_LOCK         0x00000010
481 #define VXGE_DEBUG_SEM          0x00000020
482 #define VXGE_DEBUG_ENTRYEXIT    0x00000040
483 #define VXGE_DEBUG_INTR         0x00000080
484 #define VXGE_DEBUG_LL_CONFIG    0x00000100
485
486 /* Debug tracing for VXGE driver */
487 #ifndef VXGE_DEBUG_MASK
488 #define VXGE_DEBUG_MASK 0x0
489 #endif
490
491 #if (VXGE_DEBUG_LL_CONFIG & VXGE_DEBUG_MASK)
492 #define vxge_debug_ll_config(level, fmt, ...) \
493         vxge_debug_ll(level, VXGE_DEBUG_LL_CONFIG, fmt, __VA_ARGS__)
494 #else
495 #define vxge_debug_ll_config(level, fmt, ...)
496 #endif
497
498 #if (VXGE_DEBUG_INIT & VXGE_DEBUG_MASK)
499 #define vxge_debug_init(level, fmt, ...) \
500         vxge_debug_ll(level, VXGE_DEBUG_INIT, fmt, __VA_ARGS__)
501 #else
502 #define vxge_debug_init(level, fmt, ...)
503 #endif
504
505 #if (VXGE_DEBUG_TX & VXGE_DEBUG_MASK)
506 #define vxge_debug_tx(level, fmt, ...) \
507         vxge_debug_ll(level, VXGE_DEBUG_TX, fmt, __VA_ARGS__)
508 #else
509 #define vxge_debug_tx(level, fmt, ...)
510 #endif
511
512 #if (VXGE_DEBUG_RX & VXGE_DEBUG_MASK)
513 #define vxge_debug_rx(level, fmt, ...) \
514         vxge_debug_ll(level, VXGE_DEBUG_RX, fmt, __VA_ARGS__)
515 #else
516 #define vxge_debug_rx(level, fmt, ...)
517 #endif
518
519 #if (VXGE_DEBUG_MEM & VXGE_DEBUG_MASK)
520 #define vxge_debug_mem(level, fmt, ...) \
521         vxge_debug_ll(level, VXGE_DEBUG_MEM, fmt, __VA_ARGS__)
522 #else
523 #define vxge_debug_mem(level, fmt, ...)
524 #endif
525
526 #if (VXGE_DEBUG_ENTRYEXIT & VXGE_DEBUG_MASK)
527 #define vxge_debug_entryexit(level, fmt, ...) \
528         vxge_debug_ll(level, VXGE_DEBUG_ENTRYEXIT, fmt, __VA_ARGS__)
529 #else
530 #define vxge_debug_entryexit(level, fmt, ...)
531 #endif
532
533 #if (VXGE_DEBUG_INTR & VXGE_DEBUG_MASK)
534 #define vxge_debug_intr(level, fmt, ...) \
535         vxge_debug_ll(level, VXGE_DEBUG_INTR, fmt, __VA_ARGS__)
536 #else
537 #define vxge_debug_intr(level, fmt, ...)
538 #endif
539
540 #define VXGE_DEVICE_DEBUG_LEVEL_SET(level, mask, vdev) {\
541         vxge_hw_device_debug_set((struct __vxge_hw_device  *)vdev->devh, \
542                 level, mask);\
543         VXGE_COPY_DEBUG_INFO_TO_LL(vdev, \
544                 vxge_hw_device_error_level_get((struct __vxge_hw_device  *) \
545                         vdev->devh), \
546                 vxge_hw_device_trace_level_get((struct __vxge_hw_device  *) \
547                         vdev->devh));\
548 }
549
550 #ifdef NETIF_F_GSO
551 #define vxge_tcp_mss(skb) (skb_shinfo(skb)->gso_size)
552 #define vxge_udp_mss(skb) (skb_shinfo(skb)->gso_size)
553 #define vxge_offload_type(skb) (skb_shinfo(skb)->gso_type)
554 #endif
555
556 #endif