drivers/net/igb/igb.h

   1 /*******************************************************************************
   2
   3   Intel(R) Gigabit Ethernet Linux driver
   4   Copyright(c) 2007-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
  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
  41 struct igb_adapter;
  42
  43 /* ((1000000000ns / (6000ints/s * 1024ns)) << 2 = 648 */
  44 #define IGB_START_ITR 648
  45
  46 /* TX/RX descriptor defines */
  47 #define IGB_DEFAULT_TXD                  256
  48 #define IGB_MIN_TXD                       80
  49 #define IGB_MAX_TXD                     4096
  50
  51 #define IGB_DEFAULT_RXD                  256
  52 #define IGB_MIN_RXD                       80
  53 #define IGB_MAX_RXD                     4096
  54
  55 #define IGB_DEFAULT_ITR                    3 /* dynamic */
  56 #define IGB_MAX_ITR_USECS              10000
  57 #define IGB_MIN_ITR_USECS                 10
  58
  59 /* Transmit and receive queues */
  60 #define IGB_MAX_RX_QUEUES     (adapter->vfs_allocated_count ? \
  61                                (adapter->vfs_allocated_count > 6 ? 1 : 2) : 4)
  62 #define IGB_MAX_TX_QUEUES     IGB_MAX_RX_QUEUES
  63 #define IGB_ABS_MAX_TX_QUEUES     4
  64
  65 #define IGB_MAX_VF_MC_ENTRIES              30
  66 #define IGB_MAX_VF_FUNCTIONS               8
  67 #define IGB_MAX_VFTA_ENTRIES               128
  68
  69 struct vf_data_storage {
  70         unsigned char vf_mac_addresses[ETH_ALEN];
  71         u16 vf_mc_hashes[IGB_MAX_VF_MC_ENTRIES];
  72         u16 num_vf_mc_hashes;
  73         bool clear_to_send;
  74 };
  75
  76 /* RX descriptor control thresholds.
  77  * PTHRESH - MAC will consider prefetch if it has fewer than this number of
  78  *           descriptors available in its onboard memory.
  79  *           Setting this to 0 disables RX descriptor prefetch.
  80  * HTHRESH - MAC will only prefetch if there are at least this many descriptors
  81  *           available in host memory.
  82  *           If PTHRESH is 0, this should also be 0.
  83  * WTHRESH - RX descriptor writeback threshold - MAC will delay writing back
  84  *           descriptors until either it has this many to write back, or the
  85  *           ITR timer expires.
  86  */
  87 #define IGB_RX_PTHRESH                    16
  88 #define IGB_RX_HTHRESH                     8
  89 #define IGB_RX_WTHRESH                     1
  90
  91 /* this is the size past which hardware will drop packets when setting LPE=0 */
  92 #define MAXIMUM_ETHERNET_VLAN_SIZE 1522
  93
  94 /* Supported Rx Buffer Sizes */
  95 #define IGB_RXBUFFER_128   128    /* Used for packet split */
  96 #define IGB_RXBUFFER_256   256    /* Used for packet split */
  97 #define IGB_RXBUFFER_512   512
  98 #define IGB_RXBUFFER_1024  1024
  99 #define IGB_RXBUFFER_2048  2048
 100 #define IGB_RXBUFFER_16384 16384
 101
 102 #define MAX_STD_JUMBO_FRAME_SIZE 9234
 103
 104 /* How many Tx Descriptors do we need to call netif_wake_queue ? */
 105 #define IGB_TX_QUEUE_WAKE       16
 106 /* How many Rx Buffers do we bundle into one write to the hardware ? */
 107 #define IGB_RX_BUFFER_WRITE     16      /* Must be power of 2 */
 108
 109 #define AUTO_ALL_MODES            0
 110 #define IGB_EEPROM_APME         0x0400
 111
 112 #ifndef IGB_MASTER_SLAVE
 113 /* Switch to override PHY master/slave setting */
 114 #define IGB_MASTER_SLAVE        e1000_ms_hw_default
 115 #endif
 116
 117 #define IGB_MNG_VLAN_NONE -1
 118
 119 /* wrapper around a pointer to a socket buffer,
 120  * so a DMA handle can be stored along with the buffer */
 121 struct igb_buffer {
 122         struct sk_buff *skb;
 123         dma_addr_t dma;
 124         union {
 125                 /* TX */
 126                 struct {
 127                         unsigned long time_stamp;
 128                         u16 length;
 129                         u16 next_to_watch;
 130                 };
 131                 /* RX */
 132                 struct {
 133                         struct page *page;
 134                         u64 page_dma;
 135                         unsigned int page_offset;
 136                 };
 137         };
 138 };
 139
 140 struct igb_queue_stats {
 141         u64 packets;
 142         u64 bytes;
 143 };
 144
 145 struct igb_ring {
 146         struct igb_adapter *adapter; /* backlink */
 147         void *desc;                  /* descriptor ring memory */
 148         dma_addr_t dma;              /* phys address of the ring */
 149         unsigned int size;           /* length of desc. ring in bytes */
 150         unsigned int count;          /* number of desc. in the ring */
 151         u16 next_to_use;
 152         u16 next_to_clean;
 153         u16 head;
 154         u16 tail;
 155         struct igb_buffer *buffer_info; /* array of buffer info structs */
 156
 157         u32 eims_value;
 158         u32 itr_val;
 159         u16 itr_register;
 160         u16 cpu;
 161
 162         u16 queue_index;
 163         u16 reg_idx;
 164         unsigned int total_bytes;
 165         unsigned int total_packets;
 166
 167         union {
 168                 /* TX */
 169                 struct {
 170                         struct igb_queue_stats tx_stats;
 171                         bool detect_tx_hung;
 172                 };
 173                 /* RX */
 174                 struct {
 175                         struct igb_queue_stats rx_stats;
 176                         struct napi_struct napi;
 177                         int set_itr;
 178                         struct igb_ring *buddy;
 179                 };
 180         };
 181
 182         char name[IFNAMSIZ + 5];
 183 };
 184
 185 #define E1000_RX_DESC_ADV(R, i)     \
 186         (&(((union e1000_adv_rx_desc *)((R).desc))[i]))
 187 #define E1000_TX_DESC_ADV(R, i)     \
 188         (&(((union e1000_adv_tx_desc *)((R).desc))[i]))
 189 #define E1000_TX_CTXTDESC_ADV(R, i)         \
 190         (&(((struct e1000_adv_tx_context_desc *)((R).desc))[i]))
 191
 192 /* board specific private data structure */
 193
 194 struct igb_adapter {
 195         struct timer_list watchdog_timer;
 196         struct timer_list phy_info_timer;
 197         struct vlan_group *vlgrp;
 198         u16 mng_vlan_id;
 199         u32 bd_number;
 200         u32 rx_buffer_len;
 201         u32 wol;
 202         u32 en_mng_pt;
 203         u16 link_speed;
 204         u16 link_duplex;
 205         unsigned int total_tx_bytes;
 206         unsigned int total_tx_packets;
 207         unsigned int total_rx_bytes;
 208         unsigned int total_rx_packets;
 209         /* Interrupt Throttle Rate */
 210         u32 itr;
 211         u32 itr_setting;
 212         u16 tx_itr;
 213         u16 rx_itr;
 214
 215         struct work_struct reset_task;
 216         struct work_struct watchdog_task;
 217         bool fc_autoneg;
 218         u8  tx_timeout_factor;
 219         struct timer_list blink_timer;
 220         unsigned long led_status;
 221
 222         /* TX */
 223         struct igb_ring *tx_ring;      /* One per active queue */
 224         unsigned int restart_queue;
 225         unsigned long tx_queue_len;
 226         u32 txd_cmd;
 227         u32 gotc;
 228         u64 gotc_old;
 229         u64 tpt_old;
 230         u64 colc_old;
 231         u32 tx_timeout_count;
 232
 233         /* RX */
 234         struct igb_ring *rx_ring;      /* One per active queue */
 235         int num_tx_queues;
 236         int num_rx_queues;
 237
 238         u64 hw_csum_err;
 239         u64 hw_csum_good;
 240         u32 alloc_rx_buff_failed;
 241         bool rx_csum;
 242         u32 gorc;
 243         u64 gorc_old;
 244         u16 rx_ps_hdr_size;
 245         u32 max_frame_size;
 246         u32 min_frame_size;
 247
 248         /* OS defined structs */
 249         struct net_device *netdev;
 250         struct napi_struct napi;
 251         struct pci_dev *pdev;
 252         struct net_device_stats net_stats;
 253         struct cyclecounter cycles;
 254         struct timecounter clock;
 255         struct timecompare compare;
 256         struct hwtstamp_config hwtstamp_config;
 257
 258         /* structs defined in e1000_hw.h */
 259         struct e1000_hw hw;
 260         struct e1000_hw_stats stats;
 261         struct e1000_phy_info phy_info;
 262         struct e1000_phy_stats phy_stats;
 263
 264         u32 test_icr;
 265         struct igb_ring test_tx_ring;
 266         struct igb_ring test_rx_ring;
 267
 268         int msg_enable;
 269         struct msix_entry *msix_entries;
 270         u32 eims_enable_mask;
 271         u32 eims_other;
 272
 273         /* to not mess up cache alignment, always add to the bottom */
 274         unsigned long state;
 275         unsigned int flags;
 276         u32 eeprom_wol;
 277
 278         struct igb_ring *multi_tx_table[IGB_ABS_MAX_TX_QUEUES];
 279         unsigned int tx_ring_count;
 280         unsigned int rx_ring_count;
 281         unsigned int vfs_allocated_count;
 282         struct vf_data_storage *vf_data;
 283 };
 284
 285 #define IGB_FLAG_HAS_MSI           (1 << 0)
 286 #define IGB_FLAG_DCA_ENABLED       (1 << 1)
 287 #define IGB_FLAG_QUAD_PORT_A       (1 << 2)
 288 #define IGB_FLAG_NEED_CTX_IDX      (1 << 3)
 289
 290 enum e1000_state_t {
 291         __IGB_TESTING,
 292         __IGB_RESETTING,
 293         __IGB_DOWN
 294 };
 295
 296 enum igb_boards {
 297         board_82575,
 298 };
 299
 300 extern char igb_driver_name[];
 301 extern char igb_driver_version[];
 302
 303 extern char *igb_get_hw_dev_name(struct e1000_hw *hw);
 304 extern int igb_up(struct igb_adapter *);
 305 extern void igb_down(struct igb_adapter *);
 306 extern void igb_reinit_locked(struct igb_adapter *);
 307 extern void igb_reset(struct igb_adapter *);
 308 extern int igb_set_spd_dplx(struct igb_adapter *, u16);
 309 extern int igb_setup_tx_resources(struct igb_adapter *, struct igb_ring *);
 310 extern int igb_setup_rx_resources(struct igb_adapter *, struct igb_ring *);
 311 extern void igb_free_tx_resources(struct igb_ring *);
 312 extern void igb_free_rx_resources(struct igb_ring *);
 313 extern void igb_update_stats(struct igb_adapter *);
 314 extern void igb_set_ethtool_ops(struct net_device *);
 315
 316 static inline s32 igb_reset_phy(struct e1000_hw *hw)
 317 {
 318         if (hw->phy.ops.reset)
 319                 return hw->phy.ops.reset(hw);
 320
 321         return 0;
 322 }
 323
 324 static inline s32 igb_read_phy_reg(struct e1000_hw *hw, u32 offset, u16 *data)
 325 {
 326         if (hw->phy.ops.read_reg)
 327                 return hw->phy.ops.read_reg(hw, offset, data);
 328
 329         return 0;
 330 }
 331
 332 static inline s32 igb_write_phy_reg(struct e1000_hw *hw, u32 offset, u16 data)
 333 {
 334         if (hw->phy.ops.write_reg)
 335                 return hw->phy.ops.write_reg(hw, offset, data);
 336
 337         return 0;
 338 }
 339
 340 static inline s32 igb_get_phy_info(struct e1000_hw *hw)
 341 {
 342         if (hw->phy.ops.get_phy_info)
 343                 return hw->phy.ops.get_phy_info(hw);
 344
 345         return 0;
 346 }
 347
 348 #endif /* _IGB_H_ */