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