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