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