drivers/net/ethernet/intel/igb/igb.h

   1 /*******************************************************************************
   2
   3   Intel(R) Gigabit Ethernet Linux driver
   4   Copyright(c) 2007-2011 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
  29 /* Linux PRO/1000 Ethernet Driver main header file */
  30
  31 #ifndef _IGB_H_
  32 #define _IGB_H_
  33
  34 #include "e1000_mac.h"
  35 #include "e1000_82575.h"
  36
  37 #include <linux/clocksource.h>
  38 #include <linux/timecompare.h>
  39 #include <linux/net_tstamp.h>
  40 #include <linux/bitops.h>
  41 #include <linux/if_vlan.h>
  42
  43 struct igb_adapter;
  44
  45 /* ((1000000000ns / (6000ints/s * 1024ns)) << 2 = 648 */
  46 #define IGB_START_ITR 648
  47
  48 /* TX/RX descriptor defines */
  49 #define IGB_DEFAULT_TXD                  256
  50 #define IGB_MIN_TXD                       80
  51 #define IGB_MAX_TXD                     4096
  52
  53 #define IGB_DEFAULT_RXD                  256
  54 #define IGB_MIN_RXD                       80
  55 #define IGB_MAX_RXD                     4096
  56
  57 #define IGB_DEFAULT_ITR                    3 /* dynamic */
  58 #define IGB_MAX_ITR_USECS              10000
  59 #define IGB_MIN_ITR_USECS                 10
  60 #define NON_Q_VECTORS                      1
  61 #define MAX_Q_VECTORS                      8
  62
  63 /* Transmit and receive queues */
  64 #define IGB_MAX_RX_QUEUES                  (adapter->vfs_allocated_count ? 2 : \
  65                                            (hw->mac.type > e1000_82575 ? 8 : 4))
  66 #define IGB_ABS_MAX_TX_QUEUES              8
  67 #define IGB_MAX_TX_QUEUES                  IGB_MAX_RX_QUEUES
  68
  69 #define IGB_MAX_VF_MC_ENTRIES              30
  70 #define IGB_MAX_VF_FUNCTIONS               8
  71 #define IGB_MAX_VFTA_ENTRIES               128
  72
  73 struct vf_data_storage {
  74         unsigned char vf_mac_addresses[ETH_ALEN];
  75         u16 vf_mc_hashes[IGB_MAX_VF_MC_ENTRIES];
  76         u16 num_vf_mc_hashes;
  77         u16 vlans_enabled;
  78         u32 flags;
  79         unsigned long last_nack;
  80         u16 pf_vlan; /* When set, guest VLAN config not allowed. */
  81         u16 pf_qos;
  82         u16 tx_rate;
  83 };
  84
  85 #define IGB_VF_FLAG_CTS            0x00000001 /* VF is clear to send data */
  86 #define IGB_VF_FLAG_UNI_PROMISC    0x00000002 /* VF has unicast promisc */
  87 #define IGB_VF_FLAG_MULTI_PROMISC  0x00000004 /* VF has multicast promisc */
  88 #define IGB_VF_FLAG_PF_SET_MAC     0x00000008 /* PF has set MAC address */
  89
  90 /* RX descriptor control thresholds.
  91  * PTHRESH - MAC will consider prefetch if it has fewer than this number of
  92  *           descriptors available in its onboard memory.
  93  *           Setting this to 0 disables RX descriptor prefetch.
  94  * HTHRESH - MAC will only prefetch if there are at least this many descriptors
  95  *           available in host memory.
  96  *           If PTHRESH is 0, this should also be 0.
  97  * WTHRESH - RX descriptor writeback threshold - MAC will delay writing back
  98  *           descriptors until either it has this many to write back, or the
  99  *           ITR timer expires.
 100  */
 101 #define IGB_RX_PTHRESH                     8
 102 #define IGB_RX_HTHRESH                     8
 103 #define IGB_TX_PTHRESH                     8
 104 #define IGB_TX_HTHRESH                     1
 105 #define IGB_RX_WTHRESH                     ((hw->mac.type == e1000_82576 && \
 106                                              adapter->msix_entries) ? 1 : 4)
 107 #define IGB_TX_WTHRESH                     ((hw->mac.type == e1000_82576 && \
 108                                              adapter->msix_entries) ? 1 : 16)
 109
 110 /* this is the size past which hardware will drop packets when setting LPE=0 */
 111 #define MAXIMUM_ETHERNET_VLAN_SIZE 1522
 112
 113 /* Supported Rx Buffer Sizes */
 114 #define IGB_RXBUFFER_64    64     /* Used for packet split */
 115 #define IGB_RXBUFFER_128   128    /* Used for packet split */
 116 #define IGB_RXBUFFER_1024  1024
 117 #define IGB_RXBUFFER_2048  2048
 118 #define IGB_RXBUFFER_16384 16384
 119
 120 /* How many Tx Descriptors do we need to call netif_wake_queue ? */
 121 #define IGB_TX_QUEUE_WAKE       16
 122 /* How many Rx Buffers do we bundle into one write to the hardware ? */
 123 #define IGB_RX_BUFFER_WRITE     16      /* Must be power of 2 */
 124
 125 #define AUTO_ALL_MODES            0
 126 #define IGB_EEPROM_APME         0x0400
 127
 128 #ifndef IGB_MASTER_SLAVE
 129 /* Switch to override PHY master/slave setting */
 130 #define IGB_MASTER_SLAVE        e1000_ms_hw_default
 131 #endif
 132
 133 #define IGB_MNG_VLAN_NONE -1
 134
 135 /* wrapper around a pointer to a socket buffer,
 136  * so a DMA handle can be stored along with the buffer */
 137 struct igb_buffer {
 138         struct sk_buff *skb;
 139         dma_addr_t dma;
 140         union {
 141                 /* TX */
 142                 struct {
 143                         unsigned long time_stamp;
 144                         u16 length;
 145                         u16 next_to_watch;
 146                         unsigned int bytecount;
 147                         u16 gso_segs;
 148                         u8 tx_flags;
 149                         u8 mapped_as_page;
 150                 };
 151                 /* RX */
 152                 struct {
 153                         struct page *page;
 154                         dma_addr_t page_dma;
 155                         u16 page_offset;
 156                 };
 157         };
 158 };
 159
 160 struct igb_tx_queue_stats {
 161         u64 packets;
 162         u64 bytes;
 163         u64 restart_queue;
 164         u64 restart_queue2;
 165 };
 166
 167 struct igb_rx_queue_stats {
 168         u64 packets;
 169         u64 bytes;
 170         u64 drops;
 171         u64 csum_err;
 172         u64 alloc_failed;
 173 };
 174
 175 struct igb_q_vector {
 176         struct igb_adapter *adapter; /* backlink */
 177         struct igb_ring *rx_ring;
 178         struct igb_ring *tx_ring;
 179         struct napi_struct napi;
 180
 181         u32 eims_value;
 182         u16 cpu;
 183
 184         u16 itr_val;
 185         u8 set_itr;
 186         void __iomem *itr_register;
 187
 188         char name[IFNAMSIZ + 9];
 189 };
 190
 191 struct igb_ring {
 192         struct igb_q_vector *q_vector; /* backlink to q_vector */
 193         struct net_device *netdev;     /* back pointer to net_device */
 194         struct device *dev;            /* device pointer for dma mapping */
 195         dma_addr_t dma;                /* phys address of the ring */
 196         void *desc;                    /* descriptor ring memory */
 197         unsigned int size;             /* length of desc. ring in bytes */
 198         u16 count;                     /* number of desc. in the ring */
 199         u16 next_to_use;
 200         u16 next_to_clean;
 201         u8 queue_index;
 202         u8 reg_idx;
 203         void __iomem *head;
 204         void __iomem *tail;
 205         struct igb_buffer *buffer_info; /* array of buffer info structs */
 206
 207         unsigned int total_bytes;
 208         unsigned int total_packets;
 209
 210         u32 flags;
 211
 212         union {
 213                 /* TX */
 214                 struct {
 215                         struct igb_tx_queue_stats tx_stats;
 216                         struct u64_stats_sync tx_syncp;
 217                         struct u64_stats_sync tx_syncp2;
 218                         bool detect_tx_hung;
 219                 };
 220                 /* RX */
 221                 struct {
 222                         struct igb_rx_queue_stats rx_stats;
 223                         struct u64_stats_sync rx_syncp;
 224                         u32 rx_buffer_len;
 225                 };
 226         };
 227 };
 228
 229 #define IGB_RING_FLAG_RX_CSUM        0x00000001 /* RX CSUM enabled */
 230 #define IGB_RING_FLAG_RX_SCTP_CSUM   0x00000002 /* SCTP CSUM offload enabled */
 231
 232 #define IGB_RING_FLAG_TX_CTX_IDX     0x00000001 /* HW requires context index */
 233
 234 #define IGB_ADVTXD_DCMD (E1000_TXD_CMD_EOP | E1000_TXD_CMD_RS)
 235
 236 #define E1000_RX_DESC_ADV(R, i)     \
 237         (&(((union e1000_adv_rx_desc *)((R).desc))[i]))
 238 #define E1000_TX_DESC_ADV(R, i)     \
 239         (&(((union e1000_adv_tx_desc *)((R).desc))[i]))
 240 #define E1000_TX_CTXTDESC_ADV(R, i)         \
 241         (&(((struct e1000_adv_tx_context_desc *)((R).desc))[i]))
 242
 243 /* igb_desc_unused - calculate if we have unused descriptors */
 244 static inline int igb_desc_unused(struct igb_ring *ring)
 245 {
 246         if (ring->next_to_clean > ring->next_to_use)
 247                 return ring->next_to_clean - ring->next_to_use - 1;
 248
 249         return ring->count + ring->next_to_clean - ring->next_to_use - 1;
 250 }
 251
 252 /* board specific private data structure */
 253 struct igb_adapter {
 254         struct timer_list watchdog_timer;
 255         struct timer_list phy_info_timer;
 256         unsigned long active_vlans[BITS_TO_LONGS(VLAN_N_VID)];
 257         u16 mng_vlan_id;
 258         u32 bd_number;
 259         u32 wol;
 260         u32 en_mng_pt;
 261         u16 link_speed;
 262         u16 link_duplex;
 263
 264         /* Interrupt Throttle Rate */
 265         u32 rx_itr_setting;
 266         u32 tx_itr_setting;
 267         u16 tx_itr;
 268         u16 rx_itr;
 269
 270         struct work_struct reset_task;
 271         struct work_struct watchdog_task;
 272         bool fc_autoneg;
 273         u8  tx_timeout_factor;
 274         struct timer_list blink_timer;
 275         unsigned long led_status;
 276
 277         /* TX */
 278         struct igb_ring *tx_ring[16];
 279         u32 tx_timeout_count;
 280
 281         /* RX */
 282         struct igb_ring *rx_ring[16];
 283         int num_tx_queues;
 284         int num_rx_queues;
 285
 286         u32 max_frame_size;
 287         u32 min_frame_size;
 288
 289         /* OS defined structs */
 290         struct net_device *netdev;
 291         struct pci_dev *pdev;
 292         struct cyclecounter cycles;
 293         struct timecounter clock;
 294         struct timecompare compare;
 295         struct hwtstamp_config hwtstamp_config;
 296
 297         spinlock_t stats64_lock;
 298         struct rtnl_link_stats64 stats64;
 299
 300         /* structs defined in e1000_hw.h */
 301         struct e1000_hw hw;
 302         struct e1000_hw_stats stats;
 303         struct e1000_phy_info phy_info;
 304         struct e1000_phy_stats phy_stats;
 305
 306         u32 test_icr;
 307         struct igb_ring test_tx_ring;
 308         struct igb_ring test_rx_ring;
 309
 310         int msg_enable;
 311
 312         unsigned int num_q_vectors;
 313         struct igb_q_vector *q_vector[MAX_Q_VECTORS];
 314         struct msix_entry *msix_entries;
 315         u32 eims_enable_mask;
 316         u32 eims_other;
 317
 318         /* to not mess up cache alignment, always add to the bottom */
 319         unsigned long state;
 320         unsigned int flags;
 321         u32 eeprom_wol;
 322
 323         struct igb_ring *multi_tx_table[IGB_ABS_MAX_TX_QUEUES];
 324         u16 tx_ring_count;
 325         u16 rx_ring_count;
 326         unsigned int vfs_allocated_count;
 327         struct vf_data_storage *vf_data;
 328         int vf_rate_link_speed;
 329         u32 rss_queues;
 330         u32 wvbr;
 331 };
 332
 333 #define IGB_FLAG_HAS_MSI           (1 << 0)
 334 #define IGB_FLAG_DCA_ENABLED       (1 << 1)
 335 #define IGB_FLAG_QUAD_PORT_A       (1 << 2)
 336 #define IGB_FLAG_QUEUE_PAIRS       (1 << 3)
 337 #define IGB_FLAG_DMAC              (1 << 4)
 338
 339 /* DMA Coalescing defines */
 340 #define IGB_MIN_TXPBSIZE           20408
 341 #define IGB_TX_BUF_4096            4096
 342 #define IGB_DMCTLX_DCFLUSH_DIS     0x80000000  /* Disable DMA Coal Flush */
 343
 344 #define IGB_82576_TSYNC_SHIFT 19
 345 #define IGB_82580_TSYNC_SHIFT 24
 346 #define IGB_TS_HDR_LEN        16
 347 enum e1000_state_t {
 348         __IGB_TESTING,
 349         __IGB_RESETTING,
 350         __IGB_DOWN
 351 };
 352
 353 enum igb_boards {
 354         board_82575,
 355 };
 356
 357 extern char igb_driver_name[];
 358 extern char igb_driver_version[];
 359
 360 extern int igb_up(struct igb_adapter *);
 361 extern void igb_down(struct igb_adapter *);
 362 extern void igb_reinit_locked(struct igb_adapter *);
 363 extern void igb_reset(struct igb_adapter *);
 364 extern int igb_set_spd_dplx(struct igb_adapter *, u32, u8);
 365 extern int igb_setup_tx_resources(struct igb_ring *);
 366 extern int igb_setup_rx_resources(struct igb_ring *);
 367 extern void igb_free_tx_resources(struct igb_ring *);
 368 extern void igb_free_rx_resources(struct igb_ring *);
 369 extern void igb_configure_tx_ring(struct igb_adapter *, struct igb_ring *);
 370 extern void igb_configure_rx_ring(struct igb_adapter *, struct igb_ring *);
 371 extern void igb_setup_tctl(struct igb_adapter *);
 372 extern void igb_setup_rctl(struct igb_adapter *);
 373 extern netdev_tx_t igb_xmit_frame_ring_adv(struct sk_buff *, struct igb_ring *);
 374 extern void igb_unmap_and_free_tx_resource(struct igb_ring *,
 375                                            struct igb_buffer *);
 376 extern void igb_alloc_rx_buffers_adv(struct igb_ring *, int);
 377 extern void igb_update_stats(struct igb_adapter *, struct rtnl_link_stats64 *);
 378 extern bool igb_has_link(struct igb_adapter *adapter);
 379 extern void igb_set_ethtool_ops(struct net_device *);
 380 extern void igb_power_up_link(struct igb_adapter *);
 381
 382 static inline s32 igb_reset_phy(struct e1000_hw *hw)
 383 {
 384         if (hw->phy.ops.reset)
 385                 return hw->phy.ops.reset(hw);
 386
 387         return 0;
 388 }
 389
 390 static inline s32 igb_read_phy_reg(struct e1000_hw *hw, u32 offset, u16 *data)
 391 {
 392         if (hw->phy.ops.read_reg)
 393                 return hw->phy.ops.read_reg(hw, offset, data);
 394
 395         return 0;
 396 }
 397
 398 static inline s32 igb_write_phy_reg(struct e1000_hw *hw, u32 offset, u16 data)
 399 {
 400         if (hw->phy.ops.write_reg)
 401                 return hw->phy.ops.write_reg(hw, offset, data);
 402
 403         return 0;
 404 }
 405
 406 static inline s32 igb_get_phy_info(struct e1000_hw *hw)
 407 {
 408         if (hw->phy.ops.get_phy_info)
 409                 return hw->phy.ops.get_phy_info(hw);
 410
 411         return 0;
 412 }
 413
 414 #endif /* _IGB_H_ */