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 #if defined(CONFIG_FCOE) || defined(CONFIG_FCOE_MODULE)
  40 #define IXGBE_FCOE
  41 #include "ixgbe_fcoe.h"
  42 #endif /* CONFIG_FCOE or CONFIG_FCOE_MODULE */
  43 #ifdef CONFIG_IXGBE_DCA
  44 #include <linux/dca.h>
  45 #endif
  46
  47 #define PFX "ixgbe: "
  48 #define DPRINTK(nlevel, klevel, fmt, args...) \
  49         ((void)((NETIF_MSG_##nlevel & adapter->msg_enable) && \
  50         printk(KERN_##klevel PFX "%s: %s: " fmt, adapter->netdev->name, \
  51                 __func__ , ## args)))
  52
  53 /* TX/RX descriptor defines */
  54 #define IXGBE_DEFAULT_TXD                  1024
  55 #define IXGBE_MAX_TXD                      4096
  56 #define IXGBE_MIN_TXD                        64
  57
  58 #define IXGBE_DEFAULT_RXD                  1024
  59 #define IXGBE_MAX_RXD                      4096
  60 #define IXGBE_MIN_RXD                        64
  61
  62 /* flow control */
  63 #define IXGBE_DEFAULT_FCRTL             0x10000
  64 #define IXGBE_MIN_FCRTL                    0x40
  65 #define IXGBE_MAX_FCRTL                 0x7FF80
  66 #define IXGBE_DEFAULT_FCRTH             0x20000
  67 #define IXGBE_MIN_FCRTH                   0x600
  68 #define IXGBE_MAX_FCRTH                 0x7FFF0
  69 #define IXGBE_DEFAULT_FCPAUSE            0xFFFF
  70 #define IXGBE_MIN_FCPAUSE                     0
  71 #define IXGBE_MAX_FCPAUSE                0xFFFF
  72
  73 /* Supported Rx Buffer Sizes */
  74 #define IXGBE_RXBUFFER_64    64     /* Used for packet split */
  75 #define IXGBE_RXBUFFER_128   128    /* Used for packet split */
  76 #define IXGBE_RXBUFFER_256   256    /* Used for packet split */
  77 #define IXGBE_RXBUFFER_2048  2048
  78 #define IXGBE_RXBUFFER_4096  4096
  79 #define IXGBE_RXBUFFER_8192  8192
  80 #define IXGBE_MAX_RXBUFFER   16384  /* largest size for a single descriptor */
  81
  82 #define IXGBE_RX_HDR_SIZE IXGBE_RXBUFFER_256
  83
  84 #define MAXIMUM_ETHERNET_VLAN_SIZE (ETH_FRAME_LEN + ETH_FCS_LEN + VLAN_HLEN)
  85
  86 /* How many Rx Buffers do we bundle into one write to the hardware ? */
  87 #define IXGBE_RX_BUFFER_WRITE   16      /* Must be power of 2 */
  88
  89 #define IXGBE_TX_FLAGS_CSUM             (u32)(1)
  90 #define IXGBE_TX_FLAGS_VLAN             (u32)(1 << 1)
  91 #define IXGBE_TX_FLAGS_TSO              (u32)(1 << 2)
  92 #define IXGBE_TX_FLAGS_IPV4             (u32)(1 << 3)
  93 #define IXGBE_TX_FLAGS_FCOE             (u32)(1 << 4)
  94 #define IXGBE_TX_FLAGS_FSO              (u32)(1 << 5)
  95 #define IXGBE_TX_FLAGS_VLAN_MASK        0xffff0000
  96 #define IXGBE_TX_FLAGS_VLAN_PRIO_MASK   0x0000e000
  97 #define IXGBE_TX_FLAGS_VLAN_SHIFT       16
  98
  99 /* wrapper around a pointer to a socket buffer,
 100  * so a DMA handle can be stored along with the buffer */
 101 struct ixgbe_tx_buffer {
 102         struct sk_buff *skb;
 103         dma_addr_t dma;
 104         unsigned long time_stamp;
 105         u16 length;
 106         u16 next_to_watch;
 107 };
 108
 109 struct ixgbe_rx_buffer {
 110         struct sk_buff *skb;
 111         dma_addr_t dma;
 112         struct page *page;
 113         dma_addr_t page_dma;
 114         unsigned int page_offset;
 115 };
 116
 117 struct ixgbe_queue_stats {
 118         u64 packets;
 119         u64 bytes;
 120 };
 121
 122 struct ixgbe_ring {
 123         void *desc;                     /* descriptor ring memory */
 124         dma_addr_t dma;                 /* phys. address of descriptor ring */
 125         unsigned int size;              /* length in bytes */
 126         unsigned int count;             /* amount of descriptors */
 127         unsigned int next_to_use;
 128         unsigned int next_to_clean;
 129
 130         int queue_index; /* needed for multiqueue queue management */
 131         union {
 132                 struct ixgbe_tx_buffer *tx_buffer_info;
 133                 struct ixgbe_rx_buffer *rx_buffer_info;
 134         };
 135
 136         u16 head;
 137         u16 tail;
 138
 139         unsigned int total_bytes;
 140         unsigned int total_packets;
 141
 142         u16 reg_idx; /* holds the special value that gets the hardware register
 143                       * offset associated with this ring, which is different
 144                       * for DCB and RSS modes */
 145
 146 #ifdef CONFIG_IXGBE_DCA
 147         /* cpu for tx queue */
 148         int cpu;
 149 #endif
 150         struct ixgbe_queue_stats stats;
 151
 152         u16 work_limit;                /* max work per interrupt */
 153         u16 rx_buf_len;
 154         u64 rsc_count;                 /* stat for coalesced packets */
 155 };
 156
 157 enum ixgbe_ring_f_enum {
 158         RING_F_NONE = 0,
 159         RING_F_DCB,
 160         RING_F_VMDQ,
 161         RING_F_RSS,
 162 #ifdef IXGBE_FCOE
 163         RING_F_FCOE,
 164 #endif /* IXGBE_FCOE */
 165
 166         RING_F_ARRAY_SIZE      /* must be last in enum set */
 167 };
 168
 169 #define IXGBE_MAX_DCB_INDICES   8
 170 #define IXGBE_MAX_RSS_INDICES  16
 171 #define IXGBE_MAX_VMDQ_INDICES 16
 172 #ifdef IXGBE_FCOE
 173 #define IXGBE_MAX_FCOE_INDICES  8
 174 #endif /* IXGBE_FCOE */
 175 struct ixgbe_ring_feature {
 176         int indices;
 177         int mask;
 178 };
 179
 180 #define MAX_RX_QUEUES 128
 181 #define MAX_TX_QUEUES 128
 182
 183 #define MAX_RX_PACKET_BUFFERS ((adapter->flags & IXGBE_FLAG_DCB_ENABLED) \
 184                               ? 8 : 1)
 185 #define MAX_TX_PACKET_BUFFERS MAX_RX_PACKET_BUFFERS
 186
 187 /* MAX_MSIX_Q_VECTORS of these are allocated,
 188  * but we only use one per queue-specific vector.
 189  */
 190 struct ixgbe_q_vector {
 191         struct ixgbe_adapter *adapter;
 192         unsigned int v_idx; /* index of q_vector within array, also used for
 193                              * finding the bit in EICR and friends that
 194                              * represents the vector for this ring */
 195         struct napi_struct napi;
 196         DECLARE_BITMAP(rxr_idx, MAX_RX_QUEUES); /* Rx ring indices */
 197         DECLARE_BITMAP(txr_idx, MAX_TX_QUEUES); /* Tx ring indices */
 198         u8 rxr_count;     /* Rx ring count assigned to this vector */
 199         u8 txr_count;     /* Tx ring count assigned to this vector */
 200         u8 tx_itr;
 201         u8 rx_itr;
 202         u32 eitr;
 203 };
 204
 205 /* Helper macros to switch between ints/sec and what the register uses.
 206  * And yes, it's the same math going both ways.  The lowest value
 207  * supported by all of the ixgbe hardware is 8.
 208  */
 209 #define EITR_INTS_PER_SEC_TO_REG(_eitr) \
 210         ((_eitr) ? (1000000000 / ((_eitr) * 256)) : 8)
 211 #define EITR_REG_TO_INTS_PER_SEC EITR_INTS_PER_SEC_TO_REG
 212
 213 #define IXGBE_DESC_UNUSED(R) \
 214         ((((R)->next_to_clean > (R)->next_to_use) ? 0 : (R)->count) + \
 215         (R)->next_to_clean - (R)->next_to_use - 1)
 216
 217 #define IXGBE_RX_DESC_ADV(R, i)     \
 218         (&(((union ixgbe_adv_rx_desc *)((R).desc))[i]))
 219 #define IXGBE_TX_DESC_ADV(R, i)     \
 220         (&(((union ixgbe_adv_tx_desc *)((R).desc))[i]))
 221 #define IXGBE_TX_CTXTDESC_ADV(R, i)         \
 222         (&(((struct ixgbe_adv_tx_context_desc *)((R).desc))[i]))
 223
 224 #define IXGBE_GET_DESC(R, i, type)      (&(((struct type *)((R).desc))[i]))
 225 #define IXGBE_TX_DESC(R, i)     IXGBE_GET_DESC(R, i, ixgbe_legacy_tx_desc)
 226 #define IXGBE_RX_DESC(R, i)     IXGBE_GET_DESC(R, i, ixgbe_legacy_rx_desc)
 227
 228 #define IXGBE_MAX_JUMBO_FRAME_SIZE        16128
 229 #ifdef IXGBE_FCOE
 230 /* Use 3K as the baby jumbo frame size for FCoE */
 231 #define IXGBE_FCOE_JUMBO_FRAME_SIZE       3072
 232 #endif /* IXGBE_FCOE */
 233
 234 #define OTHER_VECTOR 1
 235 #define NON_Q_VECTORS (OTHER_VECTOR)
 236
 237 #define MAX_MSIX_VECTORS_82599 64
 238 #define MAX_MSIX_Q_VECTORS_82599 64
 239 #define MAX_MSIX_VECTORS_82598 18
 240 #define MAX_MSIX_Q_VECTORS_82598 16
 241
 242 #define MAX_MSIX_Q_VECTORS MAX_MSIX_Q_VECTORS_82599
 243 #define MAX_MSIX_COUNT MAX_MSIX_VECTORS_82599
 244
 245 #define MIN_MSIX_Q_VECTORS 2
 246 #define MIN_MSIX_COUNT (MIN_MSIX_Q_VECTORS + NON_Q_VECTORS)
 247
 248 /* board specific private data structure */
 249 struct ixgbe_adapter {
 250         struct timer_list watchdog_timer;
 251         struct vlan_group *vlgrp;
 252         u16 bd_number;
 253         struct work_struct reset_task;
 254         struct ixgbe_q_vector *q_vector[MAX_MSIX_Q_VECTORS];
 255         char name[MAX_MSIX_COUNT][IFNAMSIZ + 9];
 256         struct ixgbe_dcb_config dcb_cfg;
 257         struct ixgbe_dcb_config temp_dcb_cfg;
 258         u8 dcb_set_bitmap;
 259         enum ixgbe_fc_mode last_lfc_mode;
 260
 261         /* Interrupt Throttle Rate */
 262         u32 itr_setting;
 263         u16 eitr_low;
 264         u16 eitr_high;
 265
 266         /* TX */
 267         struct ixgbe_ring *tx_ring;     /* One per active queue */
 268         int num_tx_queues;
 269         u64 restart_queue;
 270         u64 hw_csum_tx_good;
 271         u64 lsc_int;
 272         u64 hw_tso_ctxt;
 273         u64 hw_tso6_ctxt;
 274         u32 tx_timeout_count;
 275         bool detect_tx_hung;
 276
 277         /* RX */
 278         struct ixgbe_ring *rx_ring;     /* One per active queue */
 279         int num_rx_queues;
 280         u64 hw_csum_rx_error;
 281         u64 hw_rx_no_dma_resources;
 282         u64 hw_csum_rx_good;
 283         u64 non_eop_descs;
 284         int num_msix_vectors;
 285         int max_msix_q_vectors;         /* true count of q_vectors for device */
 286         struct ixgbe_ring_feature ring_feature[RING_F_ARRAY_SIZE];
 287         struct msix_entry *msix_entries;
 288
 289         u64 rx_hdr_split;
 290         u32 alloc_rx_page_failed;
 291         u32 alloc_rx_buff_failed;
 292
 293         /* Some features need tri-state capability,
 294          * thus the additional *_CAPABLE flags.
 295          */
 296         u32 flags;
 297 #define IXGBE_FLAG_RX_CSUM_ENABLED              (u32)(1)
 298 #define IXGBE_FLAG_MSI_CAPABLE                  (u32)(1 << 1)
 299 #define IXGBE_FLAG_MSI_ENABLED                  (u32)(1 << 2)
 300 #define IXGBE_FLAG_MSIX_CAPABLE                 (u32)(1 << 3)
 301 #define IXGBE_FLAG_MSIX_ENABLED                 (u32)(1 << 4)
 302 #define IXGBE_FLAG_RX_1BUF_CAPABLE              (u32)(1 << 6)
 303 #define IXGBE_FLAG_RX_PS_CAPABLE                (u32)(1 << 7)
 304 #define IXGBE_FLAG_RX_PS_ENABLED                (u32)(1 << 8)
 305 #define IXGBE_FLAG_IN_NETPOLL                   (u32)(1 << 9)
 306 #define IXGBE_FLAG_DCA_ENABLED                  (u32)(1 << 10)
 307 #define IXGBE_FLAG_DCA_CAPABLE                  (u32)(1 << 11)
 308 #define IXGBE_FLAG_IMIR_ENABLED                 (u32)(1 << 12)
 309 #define IXGBE_FLAG_MQ_CAPABLE                   (u32)(1 << 13)
 310 #define IXGBE_FLAG_DCB_ENABLED                  (u32)(1 << 14)
 311 #define IXGBE_FLAG_RSS_ENABLED                  (u32)(1 << 16)
 312 #define IXGBE_FLAG_RSS_CAPABLE                  (u32)(1 << 17)
 313 #define IXGBE_FLAG_VMDQ_CAPABLE                 (u32)(1 << 18)
 314 #define IXGBE_FLAG_VMDQ_ENABLED                 (u32)(1 << 19)
 315 #define IXGBE_FLAG_FAN_FAIL_CAPABLE             (u32)(1 << 20)
 316 #define IXGBE_FLAG_NEED_LINK_UPDATE             (u32)(1 << 22)
 317 #define IXGBE_FLAG_IN_WATCHDOG_TASK             (u32)(1 << 23)
 318 #define IXGBE_FLAG_IN_SFP_LINK_TASK             (u32)(1 << 24)
 319 #define IXGBE_FLAG_IN_SFP_MOD_TASK              (u32)(1 << 25)
 320 #define IXGBE_FLAG_FCOE_ENABLED                 (u32)(1 << 29)
 321
 322         u32 flags2;
 323 #define IXGBE_FLAG2_RSC_CAPABLE                 (u32)(1)
 324 #define IXGBE_FLAG2_RSC_ENABLED                 (u32)(1 << 1)
 325 /* default to trying for four seconds */
 326 #define IXGBE_TRY_LINK_TIMEOUT (4 * HZ)
 327
 328         /* OS defined structs */
 329         struct net_device *netdev;
 330         struct pci_dev *pdev;
 331         struct net_device_stats net_stats;
 332
 333         u32 test_icr;
 334         struct ixgbe_ring test_tx_ring;
 335         struct ixgbe_ring test_rx_ring;
 336
 337         /* structs defined in ixgbe_hw.h */
 338         struct ixgbe_hw hw;
 339         u16 msg_enable;
 340         struct ixgbe_hw_stats stats;
 341
 342         /* Interrupt Throttle Rate */
 343         u32 eitr_param;
 344
 345         unsigned long state;
 346         u64 tx_busy;
 347         unsigned int tx_ring_count;
 348         unsigned int rx_ring_count;
 349
 350         u32 link_speed;
 351         bool link_up;
 352         unsigned long link_check_timeout;
 353
 354         struct work_struct watchdog_task;
 355         struct work_struct sfp_task;
 356         struct timer_list sfp_timer;
 357         struct work_struct multispeed_fiber_task;
 358         struct work_struct sfp_config_module_task;
 359 #ifdef IXGBE_FCOE
 360         struct ixgbe_fcoe fcoe;
 361 #endif /* IXGBE_FCOE */
 362         u64 rsc_count;
 363         u32 wol;
 364         u16 eeprom_version;
 365 };
 366
 367 enum ixbge_state_t {
 368         __IXGBE_TESTING,
 369         __IXGBE_RESETTING,
 370         __IXGBE_DOWN,
 371         __IXGBE_SFP_MODULE_NOT_FOUND
 372 };
 373
 374 enum ixgbe_boards {
 375         board_82598,
 376         board_82599,
 377 };
 378
 379 extern struct ixgbe_info ixgbe_82598_info;
 380 extern struct ixgbe_info ixgbe_82599_info;
 381 #ifdef CONFIG_IXGBE_DCB
 382 extern struct dcbnl_rtnl_ops dcbnl_ops;
 383 extern int ixgbe_copy_dcb_cfg(struct ixgbe_dcb_config *src_dcb_cfg,
 384                               struct ixgbe_dcb_config *dst_dcb_cfg,
 385                               int tc_max);
 386 #endif
 387
 388 extern char ixgbe_driver_name[];
 389 extern const char ixgbe_driver_version[];
 390
 391 extern int ixgbe_up(struct ixgbe_adapter *adapter);
 392 extern void ixgbe_down(struct ixgbe_adapter *adapter);
 393 extern void ixgbe_reinit_locked(struct ixgbe_adapter *adapter);
 394 extern void ixgbe_reset(struct ixgbe_adapter *adapter);
 395 extern void ixgbe_set_ethtool_ops(struct net_device *netdev);
 396 extern int ixgbe_setup_rx_resources(struct ixgbe_adapter *, struct ixgbe_ring *);
 397 extern int ixgbe_setup_tx_resources(struct ixgbe_adapter *, struct ixgbe_ring *);
 398 extern void ixgbe_free_rx_resources(struct ixgbe_adapter *, struct ixgbe_ring *);
 399 extern void ixgbe_free_tx_resources(struct ixgbe_adapter *, struct ixgbe_ring *);
 400 extern void ixgbe_update_stats(struct ixgbe_adapter *adapter);
 401 extern int ixgbe_init_interrupt_scheme(struct ixgbe_adapter *adapter);
 402 extern void ixgbe_clear_interrupt_scheme(struct ixgbe_adapter *adapter);
 403 extern void ixgbe_write_eitr(struct ixgbe_q_vector *);
 404 extern int ethtool_ioctl(struct ifreq *ifr);
 405 #ifdef IXGBE_FCOE
 406 extern void ixgbe_configure_fcoe(struct ixgbe_adapter *adapter);
 407 extern int ixgbe_fso(struct ixgbe_adapter *adapter,
 408                      struct ixgbe_ring *tx_ring, struct sk_buff *skb,
 409                      u32 tx_flags, u8 *hdr_len);
 410 extern void ixgbe_cleanup_fcoe(struct ixgbe_adapter *adapter);
 411 extern int ixgbe_fcoe_ddp(struct ixgbe_adapter *adapter,
 412                           union ixgbe_adv_rx_desc *rx_desc,
 413                           struct sk_buff *skb);
 414 extern int ixgbe_fcoe_ddp_get(struct net_device *netdev, u16 xid,
 415                               struct scatterlist *sgl, unsigned int sgc);
 416 extern int ixgbe_fcoe_ddp_put(struct net_device *netdev, u16 xid);
 417 #endif /* IXGBE_FCOE */
 418
 419 #endif /* _IXGBE_H_ */