drivers/net/ixgbe/ixgbe.h

   1 /*******************************************************************************
   2
   3   Intel 10 Gigabit PCI Express Linux driver
   4   Copyright(c) 1999 - 2009 Intel Corporation.
   5
   6   This program is free software; you can redistribute it and/or modify it
   7   under the terms and conditions of the GNU General Public License,
   8   version 2, as published by the Free Software Foundation.
   9
  10   This program is distributed in the hope it will be useful, but WITHOUT
  11   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  13   more details.
  14
  15   You should have received a copy of the GNU General Public License along with
  16   this program; if not, write to the Free Software Foundation, Inc.,
  17   51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
  18
  19   The full GNU General Public License is included in this distribution in
  20   the file called "COPYING".
  21
  22   Contact Information:
  23   e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
  24   Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  25
  26 *******************************************************************************/
  27
  28 #ifndef _IXGBE_H_
  29 #define _IXGBE_H_
  30
  31 #include <linux/types.h>
  32 #include <linux/pci.h>
  33 #include <linux/netdevice.h>
  34 #include <linux/aer.h>
  35
  36 #include "ixgbe_type.h"
  37 #include "ixgbe_common.h"
  38 #include "ixgbe_dcb.h"
  39 #ifdef CONFIG_IXGBE_DCA
  40 #include <linux/dca.h>
  41 #endif
  42
  43 #define PFX "ixgbe: "
  44 #define DPRINTK(nlevel, klevel, fmt, args...) \
  45         ((void)((NETIF_MSG_##nlevel & adapter->msg_enable) && \
  46         printk(KERN_##klevel PFX "%s: %s: " fmt, adapter->netdev->name, \
  47                 __func__ , ## args)))
  48
  49 /* TX/RX descriptor defines */
  50 #define IXGBE_DEFAULT_TXD                  1024
  51 #define IXGBE_MAX_TXD                      4096
  52 #define IXGBE_MIN_TXD                        64
  53
  54 #define IXGBE_DEFAULT_RXD                  1024
  55 #define IXGBE_MAX_RXD                      4096
  56 #define IXGBE_MIN_RXD                        64
  57
  58 /* flow control */
  59 #define IXGBE_DEFAULT_FCRTL             0x10000
  60 #define IXGBE_MIN_FCRTL                    0x40
  61 #define IXGBE_MAX_FCRTL                 0x7FF80
  62 #define IXGBE_DEFAULT_FCRTH             0x20000
  63 #define IXGBE_MIN_FCRTH                   0x600
  64 #define IXGBE_MAX_FCRTH                 0x7FFF0
  65 #define IXGBE_DEFAULT_FCPAUSE            0xFFFF
  66 #define IXGBE_MIN_FCPAUSE                     0
  67 #define IXGBE_MAX_FCPAUSE                0xFFFF
  68
  69 /* Supported Rx Buffer Sizes */
  70 #define IXGBE_RXBUFFER_64    64     /* Used for packet split */
  71 #define IXGBE_RXBUFFER_128   128    /* Used for packet split */
  72 #define IXGBE_RXBUFFER_256   256    /* Used for packet split */
  73 #define IXGBE_RXBUFFER_2048  2048
  74 #define IXGBE_MAX_RXBUFFER   16384  /* largest size for a single descriptor */
  75
  76 #define IXGBE_RX_HDR_SIZE IXGBE_RXBUFFER_256
  77
  78 #define MAXIMUM_ETHERNET_VLAN_SIZE (ETH_FRAME_LEN + ETH_FCS_LEN + VLAN_HLEN)
  79
  80 /* How many Rx Buffers do we bundle into one write to the hardware ? */
  81 #define IXGBE_RX_BUFFER_WRITE   16      /* Must be power of 2 */
  82
  83 #define IXGBE_TX_FLAGS_CSUM             (u32)(1)
  84 #define IXGBE_TX_FLAGS_VLAN             (u32)(1 << 1)
  85 #define IXGBE_TX_FLAGS_TSO              (u32)(1 << 2)
  86 #define IXGBE_TX_FLAGS_IPV4             (u32)(1 << 3)
  87 #define IXGBE_TX_FLAGS_VLAN_MASK        0xffff0000
  88 #define IXGBE_TX_FLAGS_VLAN_PRIO_MASK   0x0000e000
  89 #define IXGBE_TX_FLAGS_VLAN_SHIFT       16
  90
  91 /* wrapper around a pointer to a socket buffer,
  92  * so a DMA handle can be stored along with the buffer */
  93 struct ixgbe_tx_buffer {
  94         struct sk_buff *skb;
  95         dma_addr_t dma;
  96         unsigned long time_stamp;
  97         u16 length;
  98         u16 next_to_watch;
  99 };
 100
 101 struct ixgbe_rx_buffer {
 102         struct sk_buff *skb;
 103         dma_addr_t dma;
 104         struct page *page;
 105         dma_addr_t page_dma;
 106         unsigned int page_offset;
 107 };
 108
 109 struct ixgbe_queue_stats {
 110         u64 packets;
 111         u64 bytes;
 112 };
 113
 114 struct ixgbe_ring {
 115         void *desc;                     /* descriptor ring memory */
 116         dma_addr_t dma;                 /* phys. address of descriptor ring */
 117         unsigned int size;              /* length in bytes */
 118         unsigned int count;             /* amount of descriptors */
 119         unsigned int next_to_use;
 120         unsigned int next_to_clean;
 121
 122         int queue_index; /* needed for multiqueue queue management */
 123         union {
 124                 struct ixgbe_tx_buffer *tx_buffer_info;
 125                 struct ixgbe_rx_buffer *rx_buffer_info;
 126         };
 127
 128         u16 head;
 129         u16 tail;
 130
 131         unsigned int total_bytes;
 132         unsigned int total_packets;
 133
 134         u16 reg_idx; /* holds the special value that gets the hardware register
 135                       * offset associated with this ring, which is different
 136                       * for DCB and RSS modes */
 137
 138 #ifdef CONFIG_IXGBE_DCA
 139         /* cpu for tx queue */
 140         int cpu;
 141 #endif
 142         struct ixgbe_queue_stats stats;
 143         u64 v_idx; /* maps directly to the index for this ring in the hardware
 144                     * vector array, can also be used for finding the bit in EICR
 145                     * and friends that represents the vector for this ring */
 146
 147
 148         u16 work_limit;                /* max work per interrupt */
 149         u16 rx_buf_len;
 150 };
 151
 152 enum ixgbe_ring_f_enum {
 153         RING_F_NONE = 0,
 154         RING_F_DCB,
 155         RING_F_VMDQ,
 156         RING_F_RSS,
 157
 158         RING_F_ARRAY_SIZE      /* must be last in enum set */
 159 };
 160
 161 #define IXGBE_MAX_DCB_INDICES   8
 162 #define IXGBE_MAX_RSS_INDICES  16
 163 #define IXGBE_MAX_VMDQ_INDICES 16
 164 struct ixgbe_ring_feature {
 165         int indices;
 166         int mask;
 167 };
 168
 169 #define MAX_RX_QUEUES 128
 170 #define MAX_TX_QUEUES 128
 171
 172 #define MAX_RX_PACKET_BUFFERS ((adapter->flags & IXGBE_FLAG_DCB_ENABLED) \
 173                               ? 8 : 1)
 174 #define MAX_TX_PACKET_BUFFERS MAX_RX_PACKET_BUFFERS
 175
 176 /* MAX_MSIX_Q_VECTORS of these are allocated,
 177  * but we only use one per queue-specific vector.
 178  */
 179 struct ixgbe_q_vector {
 180         struct ixgbe_adapter *adapter;
 181         struct napi_struct napi;
 182         DECLARE_BITMAP(rxr_idx, MAX_RX_QUEUES); /* Rx ring indices */
 183         DECLARE_BITMAP(txr_idx, MAX_TX_QUEUES); /* Tx ring indices */
 184         u8 rxr_count;     /* Rx ring count assigned to this vector */
 185         u8 txr_count;     /* Tx ring count assigned to this vector */
 186         u8 tx_itr;
 187         u8 rx_itr;
 188         u32 eitr;
 189 };
 190
 191 /* Helper macros to switch between ints/sec and what the register uses.
 192  * And yes, it's the same math going both ways.  The lowest value
 193  * supported by all of the ixgbe hardware is 8.
 194  */
 195 #define EITR_INTS_PER_SEC_TO_REG(_eitr) \
 196         ((_eitr) ? (1000000000 / ((_eitr) * 256)) : 8)
 197 #define EITR_REG_TO_INTS_PER_SEC EITR_INTS_PER_SEC_TO_REG
 198
 199 #define IXGBE_DESC_UNUSED(R) \
 200         ((((R)->next_to_clean > (R)->next_to_use) ? 0 : (R)->count) + \
 201         (R)->next_to_clean - (R)->next_to_use - 1)
 202
 203 #define IXGBE_RX_DESC_ADV(R, i)     \
 204         (&(((union ixgbe_adv_rx_desc *)((R).desc))[i]))
 205 #define IXGBE_TX_DESC_ADV(R, i)     \
 206         (&(((union ixgbe_adv_tx_desc *)((R).desc))[i]))
 207 #define IXGBE_TX_CTXTDESC_ADV(R, i)         \
 208         (&(((struct ixgbe_adv_tx_context_desc *)((R).desc))[i]))
 209
 210 #define IXGBE_MAX_JUMBO_FRAME_SIZE        16128
 211
 212 #define OTHER_VECTOR 1
 213 #define NON_Q_VECTORS (OTHER_VECTOR)
 214
 215 #define MAX_MSIX_VECTORS_82599 64
 216 #define MAX_MSIX_Q_VECTORS_82599 64
 217 #define MAX_MSIX_VECTORS_82598 18
 218 #define MAX_MSIX_Q_VECTORS_82598 16
 219
 220 #define MAX_MSIX_Q_VECTORS MAX_MSIX_Q_VECTORS_82599
 221 #define MAX_MSIX_COUNT MAX_MSIX_VECTORS_82599
 222
 223 #define MIN_MSIX_Q_VECTORS 2
 224 #define MIN_MSIX_COUNT (MIN_MSIX_Q_VECTORS + NON_Q_VECTORS)
 225
 226 /* board specific private data structure */
 227 struct ixgbe_adapter {
 228         struct timer_list watchdog_timer;
 229         struct vlan_group *vlgrp;
 230         u16 bd_number;
 231         struct work_struct reset_task;
 232         struct ixgbe_q_vector q_vector[MAX_MSIX_Q_VECTORS];
 233         char name[MAX_MSIX_COUNT][IFNAMSIZ + 9];
 234         struct ixgbe_dcb_config dcb_cfg;
 235         struct ixgbe_dcb_config temp_dcb_cfg;
 236         u8 dcb_set_bitmap;
 237
 238         /* Interrupt Throttle Rate */
 239         u32 itr_setting;
 240         u16 eitr_low;
 241         u16 eitr_high;
 242
 243         /* TX */
 244         struct ixgbe_ring *tx_ring;     /* One per active queue */
 245         int num_tx_queues;
 246         u64 restart_queue;
 247         u64 hw_csum_tx_good;
 248         u64 lsc_int;
 249         u64 hw_tso_ctxt;
 250         u64 hw_tso6_ctxt;
 251         u32 tx_timeout_count;
 252         bool detect_tx_hung;
 253
 254         /* RX */
 255         struct ixgbe_ring *rx_ring;     /* One per active queue */
 256         int num_rx_queues;
 257         u64 hw_csum_rx_error;
 258         u64 hw_rx_no_dma_resources;
 259         u64 hw_csum_rx_good;
 260         u64 non_eop_descs;
 261         int num_msix_vectors;
 262         int max_msix_q_vectors;         /* true count of q_vectors for device */
 263         struct ixgbe_ring_feature ring_feature[RING_F_ARRAY_SIZE];
 264         struct msix_entry *msix_entries;
 265
 266         u64 rx_hdr_split;
 267         u32 alloc_rx_page_failed;
 268         u32 alloc_rx_buff_failed;
 269
 270         /* Some features need tri-state capability,
 271          * thus the additional *_CAPABLE flags.
 272          */
 273         u32 flags;
 274 #define IXGBE_FLAG_RX_CSUM_ENABLED              (u32)(1)
 275 #define IXGBE_FLAG_MSI_CAPABLE                  (u32)(1 << 1)
 276 #define IXGBE_FLAG_MSI_ENABLED                  (u32)(1 << 2)
 277 #define IXGBE_FLAG_MSIX_CAPABLE                 (u32)(1 << 3)
 278 #define IXGBE_FLAG_MSIX_ENABLED                 (u32)(1 << 4)
 279 #define IXGBE_FLAG_RX_1BUF_CAPABLE              (u32)(1 << 6)
 280 #define IXGBE_FLAG_RX_PS_CAPABLE                (u32)(1 << 7)
 281 #define IXGBE_FLAG_RX_PS_ENABLED                (u32)(1 << 8)
 282 #define IXGBE_FLAG_IN_NETPOLL                   (u32)(1 << 9)
 283 #define IXGBE_FLAG_DCA_ENABLED                  (u32)(1 << 10)
 284 #define IXGBE_FLAG_DCA_CAPABLE                  (u32)(1 << 11)
 285 #define IXGBE_FLAG_IMIR_ENABLED                 (u32)(1 << 12)
 286 #define IXGBE_FLAG_MQ_CAPABLE                   (u32)(1 << 13)
 287 #define IXGBE_FLAG_DCB_ENABLED                  (u32)(1 << 14)
 288 #define IXGBE_FLAG_RSS_ENABLED                  (u32)(1 << 16)
 289 #define IXGBE_FLAG_RSS_CAPABLE                  (u32)(1 << 17)
 290 #define IXGBE_FLAG_VMDQ_CAPABLE                 (u32)(1 << 18)
 291 #define IXGBE_FLAG_VMDQ_ENABLED                 (u32)(1 << 19)
 292 #define IXGBE_FLAG_FAN_FAIL_CAPABLE             (u32)(1 << 20)
 293 #define IXGBE_FLAG_NEED_LINK_UPDATE             (u32)(1 << 22)
 294 #define IXGBE_FLAG_IN_WATCHDOG_TASK             (u32)(1 << 23)
 295 #define IXGBE_FLAG_IN_SFP_LINK_TASK             (u32)(1 << 24)
 296 #define IXGBE_FLAG_IN_SFP_MOD_TASK              (u32)(1 << 25)
 297
 298 /* default to trying for four seconds */
 299 #define IXGBE_TRY_LINK_TIMEOUT (4 * HZ)
 300
 301         /* OS defined structs */
 302         struct net_device *netdev;
 303         struct pci_dev *pdev;
 304         struct net_device_stats net_stats;
 305
 306         /* structs defined in ixgbe_hw.h */
 307         struct ixgbe_hw hw;
 308         u16 msg_enable;
 309         struct ixgbe_hw_stats stats;
 310
 311         /* Interrupt Throttle Rate */
 312         u32 eitr_param;
 313
 314         unsigned long state;
 315         u64 tx_busy;
 316         unsigned int tx_ring_count;
 317         unsigned int rx_ring_count;
 318
 319         u32 link_speed;
 320         bool link_up;
 321         unsigned long link_check_timeout;
 322
 323         struct work_struct watchdog_task;
 324         struct work_struct sfp_task;
 325         struct timer_list sfp_timer;
 326         struct work_struct multispeed_fiber_task;
 327         struct work_struct sfp_config_module_task;
 328         u32 wol;
 329         u16 eeprom_version;
 330 };
 331
 332 enum ixbge_state_t {
 333         __IXGBE_TESTING,
 334         __IXGBE_RESETTING,
 335         __IXGBE_DOWN,
 336         __IXGBE_SFP_MODULE_NOT_FOUND
 337 };
 338
 339 enum ixgbe_boards {
 340         board_82598,
 341         board_82599,
 342 };
 343
 344 extern struct ixgbe_info ixgbe_82598_info;
 345 extern struct ixgbe_info ixgbe_82599_info;
 346 #ifdef CONFIG_IXGBE_DCB
 347 extern struct dcbnl_rtnl_ops dcbnl_ops;
 348 extern int ixgbe_copy_dcb_cfg(struct ixgbe_dcb_config *src_dcb_cfg,
 349                               struct ixgbe_dcb_config *dst_dcb_cfg,
 350                               int tc_max);
 351 #endif
 352
 353 extern char ixgbe_driver_name[];
 354 extern const char ixgbe_driver_version[];
 355
 356 extern int ixgbe_up(struct ixgbe_adapter *adapter);
 357 extern void ixgbe_down(struct ixgbe_adapter *adapter);
 358 extern void ixgbe_reinit_locked(struct ixgbe_adapter *adapter);
 359 extern void ixgbe_reset(struct ixgbe_adapter *adapter);
 360 extern void ixgbe_set_ethtool_ops(struct net_device *netdev);
 361 extern int ixgbe_setup_rx_resources(struct ixgbe_adapter *, struct ixgbe_ring *);
 362 extern int ixgbe_setup_tx_resources(struct ixgbe_adapter *, struct ixgbe_ring *);
 363 extern void ixgbe_free_rx_resources(struct ixgbe_adapter *, struct ixgbe_ring *);
 364 extern void ixgbe_free_tx_resources(struct ixgbe_adapter *, struct ixgbe_ring *);
 365 extern void ixgbe_update_stats(struct ixgbe_adapter *adapter);
 366 extern void ixgbe_reset_interrupt_capability(struct ixgbe_adapter *adapter);
 367 extern int ixgbe_init_interrupt_scheme(struct ixgbe_adapter *adapter);
 368 void ixgbe_napi_add_all(struct ixgbe_adapter *adapter);
 369 void ixgbe_napi_del_all(struct ixgbe_adapter *adapter);
 370 extern void ixgbe_write_eitr(struct ixgbe_adapter *, int, u32);
 371
 372 #endif /* _IXGBE_H_ */