drivers/net/ethernet/intel/e1000/e1000.h

   1 /*******************************************************************************
   2
   3   Intel PRO/1000 Linux driver
   4   Copyright(c) 1999 - 2006 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   Linux NICS <linux.nics@intel.com>
  24   e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
  25   Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  26
  27 *******************************************************************************/
  28
  29
  30 /* Linux PRO/1000 Ethernet Driver main header file */
  31
  32 #ifndef _E1000_H_
  33 #define _E1000_H_
  34
  35 #include <linux/stddef.h>
  36 #include <linux/module.h>
  37 #include <linux/types.h>
  38 #include <asm/byteorder.h>
  39 #include <linux/init.h>
  40 #include <linux/mm.h>
  41 #include <linux/errno.h>
  42 #include <linux/ioport.h>
  43 #include <linux/pci.h>
  44 #include <linux/kernel.h>
  45 #include <linux/netdevice.h>
  46 #include <linux/etherdevice.h>
  47 #include <linux/skbuff.h>
  48 #include <linux/delay.h>
  49 #include <linux/timer.h>
  50 #include <linux/slab.h>
  51 #include <linux/vmalloc.h>
  52 #include <linux/interrupt.h>
  53 #include <linux/string.h>
  54 #include <linux/pagemap.h>
  55 #include <linux/dma-mapping.h>
  56 #include <linux/bitops.h>
  57 #include <asm/io.h>
  58 #include <asm/irq.h>
  59 #include <linux/capability.h>
  60 #include <linux/in.h>
  61 #include <linux/ip.h>
  62 #include <linux/ipv6.h>
  63 #include <linux/tcp.h>
  64 #include <linux/udp.h>
  65 #include <net/pkt_sched.h>
  66 #include <linux/list.h>
  67 #include <linux/reboot.h>
  68 #include <net/checksum.h>
  69 #include <linux/mii.h>
  70 #include <linux/ethtool.h>
  71 #include <linux/if_vlan.h>
  72
  73 #define BAR_0           0
  74 #define BAR_1           1
  75 #define BAR_5           5
  76
  77 #define INTEL_E1000_ETHERNET_DEVICE(device_id) {\
  78         PCI_DEVICE(PCI_VENDOR_ID_INTEL, device_id)}
  79
  80 struct e1000_adapter;
  81
  82 #include "e1000_hw.h"
  83
  84 #define E1000_MAX_INTR                  10
  85
  86 /*
  87  * Count for polling __E1000_RESET condition every 10-20msec.
  88  */
  89 #define E1000_CHECK_RESET_COUNT 50
  90
  91 /* TX/RX descriptor defines */
  92 #define E1000_DEFAULT_TXD               256
  93 #define E1000_MAX_TXD                   256
  94 #define E1000_MIN_TXD                   48
  95 #define E1000_MAX_82544_TXD             4096
  96
  97 #define E1000_DEFAULT_RXD               256
  98 #define E1000_MAX_RXD                   256
  99 #define E1000_MIN_RXD                   48
 100 #define E1000_MAX_82544_RXD             4096
 101
 102 #define E1000_MIN_ITR_USECS             10 /* 100000 irq/sec */
 103 #define E1000_MAX_ITR_USECS             10000 /* 100    irq/sec */
 104
 105 /* this is the size past which hardware will drop packets when setting LPE=0 */
 106 #define MAXIMUM_ETHERNET_VLAN_SIZE      1522
 107
 108 /* Supported Rx Buffer Sizes */
 109 #define E1000_RXBUFFER_128              128    /* Used for packet split */
 110 #define E1000_RXBUFFER_256              256    /* Used for packet split */
 111 #define E1000_RXBUFFER_512              512
 112 #define E1000_RXBUFFER_1024             1024
 113 #define E1000_RXBUFFER_2048             2048
 114 #define E1000_RXBUFFER_4096             4096
 115 #define E1000_RXBUFFER_8192             8192
 116 #define E1000_RXBUFFER_16384            16384
 117
 118 /* SmartSpeed delimiters */
 119 #define E1000_SMARTSPEED_DOWNSHIFT      3
 120 #define E1000_SMARTSPEED_MAX            15
 121
 122 /* Packet Buffer allocations */
 123 #define E1000_PBA_BYTES_SHIFT           0xA
 124 #define E1000_TX_HEAD_ADDR_SHIFT        7
 125 #define E1000_PBA_TX_MASK               0xFFFF0000
 126
 127 /* Flow Control Watermarks */
 128 #define E1000_FC_HIGH_DIFF      0x1638 /* High: 5688 bytes below Rx FIFO size */
 129 #define E1000_FC_LOW_DIFF       0x1640 /* Low:  5696 bytes below Rx FIFO size */
 130
 131 #define E1000_FC_PAUSE_TIME     0xFFFF /* pause for the max or until send xon */
 132
 133 /* How many Tx Descriptors do we need to call netif_wake_queue ? */
 134 #define E1000_TX_QUEUE_WAKE     16
 135 /* How many Rx Buffers do we bundle into one write to the hardware ? */
 136 #define E1000_RX_BUFFER_WRITE   16 /* Must be power of 2 */
 137
 138 #define AUTO_ALL_MODES          0
 139 #define E1000_EEPROM_82544_APM  0x0004
 140 #define E1000_EEPROM_APME       0x0400
 141
 142 #ifndef E1000_MASTER_SLAVE
 143 /* Switch to override PHY master/slave setting */
 144 #define E1000_MASTER_SLAVE      e1000_ms_hw_default
 145 #endif
 146
 147 #define E1000_MNG_VLAN_NONE     (-1)
 148
 149 /* wrapper around a pointer to a socket buffer,
 150  * so a DMA handle can be stored along with the buffer
 151  */
 152 struct e1000_buffer {
 153         struct sk_buff *skb;
 154         dma_addr_t dma;
 155         struct page *page;
 156         unsigned long time_stamp;
 157         u16 length;
 158         u16 next_to_watch;
 159         unsigned int segs;
 160         unsigned int bytecount;
 161         u16 mapped_as_page;
 162 };
 163
 164 struct e1000_tx_ring {
 165         /* pointer to the descriptor ring memory */
 166         void *desc;
 167         /* physical address of the descriptor ring */
 168         dma_addr_t dma;
 169         /* length of descriptor ring in bytes */
 170         unsigned int size;
 171         /* number of descriptors in the ring */
 172         unsigned int count;
 173         /* next descriptor to associate a buffer with */
 174         unsigned int next_to_use;
 175         /* next descriptor to check for DD status bit */
 176         unsigned int next_to_clean;
 177         /* array of buffer information structs */
 178         struct e1000_buffer *buffer_info;
 179
 180         u16 tdh;
 181         u16 tdt;
 182         bool last_tx_tso;
 183 };
 184
 185 struct e1000_rx_ring {
 186         /* pointer to the descriptor ring memory */
 187         void *desc;
 188         /* physical address of the descriptor ring */
 189         dma_addr_t dma;
 190         /* length of descriptor ring in bytes */
 191         unsigned int size;
 192         /* number of descriptors in the ring */
 193         unsigned int count;
 194         /* next descriptor to associate a buffer with */
 195         unsigned int next_to_use;
 196         /* next descriptor to check for DD status bit */
 197         unsigned int next_to_clean;
 198         /* array of buffer information structs */
 199         struct e1000_buffer *buffer_info;
 200         struct sk_buff *rx_skb_top;
 201
 202         /* cpu for rx queue */
 203         int cpu;
 204
 205         u16 rdh;
 206         u16 rdt;
 207 };
 208
 209 #define E1000_DESC_UNUSED(R)                                            \
 210         ((((R)->next_to_clean > (R)->next_to_use)                       \
 211           ? 0 : (R)->count) + (R)->next_to_clean - (R)->next_to_use - 1)
 212
 213 #define E1000_RX_DESC_EXT(R, i)                                         \
 214         (&(((union e1000_rx_desc_extended *)((R).desc))[i]))
 215 #define E1000_GET_DESC(R, i, type)      (&(((struct type *)((R).desc))[i]))
 216 #define E1000_RX_DESC(R, i)             E1000_GET_DESC(R, i, e1000_rx_desc)
 217 #define E1000_TX_DESC(R, i)             E1000_GET_DESC(R, i, e1000_tx_desc)
 218 #define E1000_CONTEXT_DESC(R, i)        E1000_GET_DESC(R, i, e1000_context_desc)
 219
 220 /* board specific private data structure */
 221
 222 struct e1000_adapter {
 223         unsigned long active_vlans[BITS_TO_LONGS(VLAN_N_VID)];
 224         u16 mng_vlan_id;
 225         u32 bd_number;
 226         u32 rx_buffer_len;
 227         u32 wol;
 228         u32 smartspeed;
 229         u32 en_mng_pt;
 230         u16 link_speed;
 231         u16 link_duplex;
 232         spinlock_t stats_lock;
 233         unsigned int total_tx_bytes;
 234         unsigned int total_tx_packets;
 235         unsigned int total_rx_bytes;
 236         unsigned int total_rx_packets;
 237         /* Interrupt Throttle Rate */
 238         u32 itr;
 239         u32 itr_setting;
 240         u16 tx_itr;
 241         u16 rx_itr;
 242
 243         u8 fc_autoneg;
 244
 245         /* TX */
 246         struct e1000_tx_ring *tx_ring;      /* One per active queue */
 247         unsigned int restart_queue;
 248         u32 txd_cmd;
 249         u32 tx_int_delay;
 250         u32 tx_abs_int_delay;
 251         u32 gotcl;
 252         u64 gotcl_old;
 253         u64 tpt_old;
 254         u64 colc_old;
 255         u32 tx_timeout_count;
 256         u32 tx_fifo_head;
 257         u32 tx_head_addr;
 258         u32 tx_fifo_size;
 259         u8  tx_timeout_factor;
 260         atomic_t tx_fifo_stall;
 261         bool pcix_82544;
 262         bool detect_tx_hung;
 263         bool dump_buffers;
 264
 265         /* RX */
 266         bool (*clean_rx)(struct e1000_adapter *adapter,
 267                          struct e1000_rx_ring *rx_ring,
 268                          int *work_done, int work_to_do);
 269         void (*alloc_rx_buf)(struct e1000_adapter *adapter,
 270                              struct e1000_rx_ring *rx_ring,
 271                              int cleaned_count);
 272         struct e1000_rx_ring *rx_ring;      /* One per active queue */
 273         struct napi_struct napi;
 274
 275         int num_tx_queues;
 276         int num_rx_queues;
 277
 278         u64 hw_csum_err;
 279         u64 hw_csum_good;
 280         u32 alloc_rx_buff_failed;
 281         u32 rx_int_delay;
 282         u32 rx_abs_int_delay;
 283         bool rx_csum;
 284         u32 gorcl;
 285         u64 gorcl_old;
 286
 287         /* OS defined structs */
 288         struct net_device *netdev;
 289         struct pci_dev *pdev;
 290
 291         /* structs defined in e1000_hw.h */
 292         struct e1000_hw hw;
 293         struct e1000_hw_stats stats;
 294         struct e1000_phy_info phy_info;
 295         struct e1000_phy_stats phy_stats;
 296
 297         u32 test_icr;
 298         struct e1000_tx_ring test_tx_ring;
 299         struct e1000_rx_ring test_rx_ring;
 300
 301         int msg_enable;
 302
 303         /* to not mess up cache alignment, always add to the bottom */
 304         bool tso_force;
 305         bool smart_power_down;  /* phy smart power down */
 306         bool quad_port_a;
 307         unsigned long flags;
 308         u32 eeprom_wol;
 309
 310         /* for ioport free */
 311         int bars;
 312         int need_ioport;
 313
 314         bool discarding;
 315
 316         struct work_struct reset_task;
 317         struct delayed_work watchdog_task;
 318         struct delayed_work fifo_stall_task;
 319         struct delayed_work phy_info_task;
 320 };
 321
 322 enum e1000_state_t {
 323         __E1000_TESTING,
 324         __E1000_RESETTING,
 325         __E1000_DOWN
 326 };
 327
 328 #undef pr_fmt
 329 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
 330
 331 struct net_device *e1000_get_hw_dev(struct e1000_hw *hw);
 332 #define e_dbg(format, arg...) \
 333         netdev_dbg(e1000_get_hw_dev(hw), format, ## arg)
 334 #define e_err(msglvl, format, arg...) \
 335         netif_err(adapter, msglvl, adapter->netdev, format, ## arg)
 336 #define e_info(msglvl, format, arg...) \
 337         netif_info(adapter, msglvl, adapter->netdev, format, ## arg)
 338 #define e_warn(msglvl, format, arg...) \
 339         netif_warn(adapter, msglvl, adapter->netdev, format, ## arg)
 340 #define e_notice(msglvl, format, arg...) \
 341         netif_notice(adapter, msglvl, adapter->netdev, format, ## arg)
 342 #define e_dev_info(format, arg...) \
 343         dev_info(&adapter->pdev->dev, format, ## arg)
 344 #define e_dev_warn(format, arg...) \
 345         dev_warn(&adapter->pdev->dev, format, ## arg)
 346 #define e_dev_err(format, arg...) \
 347         dev_err(&adapter->pdev->dev, format, ## arg)
 348
 349 extern char e1000_driver_name[];
 350 extern const char e1000_driver_version[];
 351
 352 int e1000_up(struct e1000_adapter *adapter);
 353 void e1000_down(struct e1000_adapter *adapter);
 354 void e1000_reinit_locked(struct e1000_adapter *adapter);
 355 void e1000_reset(struct e1000_adapter *adapter);
 356 int e1000_set_spd_dplx(struct e1000_adapter *adapter, u32 spd, u8 dplx);
 357 int e1000_setup_all_rx_resources(struct e1000_adapter *adapter);
 358 int e1000_setup_all_tx_resources(struct e1000_adapter *adapter);
 359 void e1000_free_all_rx_resources(struct e1000_adapter *adapter);
 360 void e1000_free_all_tx_resources(struct e1000_adapter *adapter);
 361 void e1000_update_stats(struct e1000_adapter *adapter);
 362 bool e1000_has_link(struct e1000_adapter *adapter);
 363 void e1000_power_up_phy(struct e1000_adapter *);
 364 void e1000_set_ethtool_ops(struct net_device *netdev);
 365 void e1000_check_options(struct e1000_adapter *adapter);
 366 char *e1000_get_hw_dev_name(struct e1000_hw *hw);
 367
 368 #endif /* _E1000_H_ */