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