drivers/net/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 #ifdef NETIF_F_TSO6
  63 #include <linux/ipv6.h>
  64 #endif
  65 #include <linux/tcp.h>
  66 #include <linux/udp.h>
  67 #include <net/pkt_sched.h>
  68 #include <linux/list.h>
  69 #include <linux/reboot.h>
  70 #ifdef NETIF_F_TSO
  71 #include <net/checksum.h>
  72 #endif
  73 #include <linux/mii.h>
  74 #include <linux/ethtool.h>
  75 #include <linux/if_vlan.h>
  76
  77 #define BAR_0           0
  78 #define BAR_1           1
  79 #define BAR_5           5
  80
  81 #define INTEL_E1000_ETHERNET_DEVICE(device_id) {\
  82         PCI_DEVICE(PCI_VENDOR_ID_INTEL, device_id)}
  83
  84 struct e1000_adapter;
  85
  86 #include "e1000_hw.h"
  87
  88 #ifdef DBG
  89 #define E1000_DBG(args...) printk(KERN_DEBUG "e1000: " args)
  90 #else
  91 #define E1000_DBG(args...)
  92 #endif
  93
  94 #define E1000_ERR(args...) printk(KERN_ERR "e1000: " args)
  95
  96 #define PFX "e1000: "
  97 #define DPRINTK(nlevel, klevel, fmt, args...) \
  98         (void)((NETIF_MSG_##nlevel & adapter->msg_enable) && \
  99         printk(KERN_##klevel PFX "%s: %s: " fmt, adapter->netdev->name, \
 100                 __FUNCTION__ , ## args))
 101
 102 #define E1000_MAX_INTR 10
 103
 104 /* TX/RX descriptor defines */
 105 #define E1000_DEFAULT_TXD                  256
 106 #define E1000_MAX_TXD                      256
 107 #define E1000_MIN_TXD                       80
 108 #define E1000_MAX_82544_TXD               4096
 109
 110 #define E1000_DEFAULT_RXD                  256
 111 #define E1000_MAX_RXD                      256
 112 #define E1000_MIN_RXD                       80
 113 #define E1000_MAX_82544_RXD               4096
 114
 115 /* this is the size past which hardware will drop packets when setting LPE=0 */
 116 #define MAXIMUM_ETHERNET_VLAN_SIZE 1522
 117
 118 /* Supported Rx Buffer Sizes */
 119 #define E1000_RXBUFFER_128   128    /* Used for packet split */
 120 #define E1000_RXBUFFER_256   256    /* Used for packet split */
 121 #define E1000_RXBUFFER_512   512
 122 #define E1000_RXBUFFER_1024  1024
 123 #define E1000_RXBUFFER_2048  2048
 124 #define E1000_RXBUFFER_4096  4096
 125 #define E1000_RXBUFFER_8192  8192
 126 #define E1000_RXBUFFER_16384 16384
 127
 128 /* SmartSpeed delimiters */
 129 #define E1000_SMARTSPEED_DOWNSHIFT 3
 130 #define E1000_SMARTSPEED_MAX       15
 131
 132 /* Packet Buffer allocations */
 133 #define E1000_PBA_BYTES_SHIFT 0xA
 134 #define E1000_TX_HEAD_ADDR_SHIFT 7
 135 #define E1000_PBA_TX_MASK 0xFFFF0000
 136
 137 /* Flow Control Watermarks */
 138 #define E1000_FC_HIGH_DIFF 0x1638  /* High: 5688 bytes below Rx FIFO size */
 139 #define E1000_FC_LOW_DIFF 0x1640   /* Low:  5696 bytes below Rx FIFO size */
 140
 141 #define E1000_FC_PAUSE_TIME 0x0680 /* 858 usec */
 142
 143 /* How many Tx Descriptors do we need to call netif_wake_queue ? */
 144 #define E1000_TX_QUEUE_WAKE     16
 145 /* How many Rx Buffers do we bundle into one write to the hardware ? */
 146 #define E1000_RX_BUFFER_WRITE   16      /* Must be power of 2 */
 147
 148 #define AUTO_ALL_MODES            0
 149 #define E1000_EEPROM_82544_APM    0x0004
 150 #define E1000_EEPROM_ICH8_APME    0x0004
 151 #define E1000_EEPROM_APME         0x0400
 152
 153 #ifndef E1000_MASTER_SLAVE
 154 /* Switch to override PHY master/slave setting */
 155 #define E1000_MASTER_SLAVE      e1000_ms_hw_default
 156 #endif
 157
 158 #define E1000_MNG_VLAN_NONE -1
 159 /* Number of packet split data buffers (not including the header buffer) */
 160 #define PS_PAGE_BUFFERS MAX_PS_BUFFERS-1
 161
 162 /* only works for sizes that are powers of 2 */
 163 #define E1000_ROUNDUP(i, size) ((i) = (((i) + (size) - 1) & ~((size) - 1)))
 164
 165 /* wrapper around a pointer to a socket buffer,
 166  * so a DMA handle can be stored along with the buffer */
 167 struct e1000_buffer {
 168         struct sk_buff *skb;
 169         dma_addr_t dma;
 170         unsigned long time_stamp;
 171         uint16_t length;
 172         uint16_t next_to_watch;
 173 };
 174
 175
 176 struct e1000_ps_page { struct page *ps_page[PS_PAGE_BUFFERS]; };
 177 struct e1000_ps_page_dma { uint64_t ps_page_dma[PS_PAGE_BUFFERS]; };
 178
 179 struct e1000_tx_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
 195         spinlock_t tx_lock;
 196         uint16_t tdh;
 197         uint16_t tdt;
 198         boolean_t last_tx_tso;
 199 };
 200
 201 struct e1000_rx_ring {
 202         /* pointer to the descriptor ring memory */
 203         void *desc;
 204         /* physical address of the descriptor ring */
 205         dma_addr_t dma;
 206         /* length of descriptor ring in bytes */
 207         unsigned int size;
 208         /* number of descriptors in the ring */
 209         unsigned int count;
 210         /* next descriptor to associate a buffer with */
 211         unsigned int next_to_use;
 212         /* next descriptor to check for DD status bit */
 213         unsigned int next_to_clean;
 214         /* array of buffer information structs */
 215         struct e1000_buffer *buffer_info;
 216         /* arrays of page information for packet split */
 217         struct e1000_ps_page *ps_page;
 218         struct e1000_ps_page_dma *ps_page_dma;
 219
 220         /* cpu for rx queue */
 221         int cpu;
 222
 223         uint16_t rdh;
 224         uint16_t rdt;
 225 };
 226
 227 #define E1000_DESC_UNUSED(R) \
 228         ((((R)->next_to_clean > (R)->next_to_use) ? 0 : (R)->count) + \
 229         (R)->next_to_clean - (R)->next_to_use - 1)
 230
 231 #define E1000_RX_DESC_PS(R, i)      \
 232         (&(((union e1000_rx_desc_packet_split *)((R).desc))[i]))
 233 #define E1000_RX_DESC_EXT(R, i)     \
 234         (&(((union e1000_rx_desc_extended *)((R).desc))[i]))
 235 #define E1000_GET_DESC(R, i, type)      (&(((struct type *)((R).desc))[i]))
 236 #define E1000_RX_DESC(R, i)             E1000_GET_DESC(R, i, e1000_rx_desc)
 237 #define E1000_TX_DESC(R, i)             E1000_GET_DESC(R, i, e1000_tx_desc)
 238 #define E1000_CONTEXT_DESC(R, i)        E1000_GET_DESC(R, i, e1000_context_desc)
 239
 240 /* board specific private data structure */
 241
 242 struct e1000_adapter {
 243         struct timer_list tx_fifo_stall_timer;
 244         struct timer_list watchdog_timer;
 245         struct timer_list phy_info_timer;
 246         struct vlan_group *vlgrp;
 247         uint16_t mng_vlan_id;
 248         uint32_t bd_number;
 249         uint32_t rx_buffer_len;
 250         uint32_t wol;
 251         uint32_t smartspeed;
 252         uint32_t en_mng_pt;
 253         uint16_t link_speed;
 254         uint16_t link_duplex;
 255         spinlock_t stats_lock;
 256 #ifdef CONFIG_E1000_NAPI
 257         spinlock_t tx_queue_lock;
 258 #endif
 259         atomic_t irq_sem;
 260         unsigned int detect_link;
 261         unsigned int total_tx_bytes;
 262         unsigned int total_tx_packets;
 263         unsigned int total_rx_bytes;
 264         unsigned int total_rx_packets;
 265         /* Interrupt Throttle Rate */
 266         uint32_t itr;
 267         uint32_t itr_setting;
 268         uint16_t tx_itr;
 269         uint16_t rx_itr;
 270
 271         struct work_struct reset_task;
 272         uint8_t fc_autoneg;
 273
 274         struct timer_list blink_timer;
 275         unsigned long led_status;
 276
 277         /* TX */
 278         struct e1000_tx_ring *tx_ring;      /* One per active queue */
 279         unsigned int restart_queue;
 280         unsigned long tx_queue_len;
 281         uint32_t txd_cmd;
 282         uint32_t tx_int_delay;
 283         uint32_t tx_abs_int_delay;
 284         uint32_t gotcl;
 285         uint64_t gotcl_old;
 286         uint64_t tpt_old;
 287         uint64_t colc_old;
 288         uint32_t tx_timeout_count;
 289         uint32_t tx_fifo_head;
 290         uint32_t tx_head_addr;
 291         uint32_t tx_fifo_size;
 292         uint8_t  tx_timeout_factor;
 293         atomic_t tx_fifo_stall;
 294         boolean_t pcix_82544;
 295         boolean_t detect_tx_hung;
 296
 297         /* RX */
 298 #ifdef CONFIG_E1000_NAPI
 299         boolean_t (*clean_rx) (struct e1000_adapter *adapter,
 300                                struct e1000_rx_ring *rx_ring,
 301                                int *work_done, int work_to_do);
 302 #else
 303         boolean_t (*clean_rx) (struct e1000_adapter *adapter,
 304                                struct e1000_rx_ring *rx_ring);
 305 #endif
 306         void (*alloc_rx_buf) (struct e1000_adapter *adapter,
 307                               struct e1000_rx_ring *rx_ring,
 308                                 int cleaned_count);
 309         struct e1000_rx_ring *rx_ring;      /* One per active queue */
 310 #ifdef CONFIG_E1000_NAPI
 311         struct net_device *polling_netdev;  /* One per active queue */
 312 #endif
 313         int num_tx_queues;
 314         int num_rx_queues;
 315
 316         uint64_t hw_csum_err;
 317         uint64_t hw_csum_good;
 318         uint64_t rx_hdr_split;
 319         uint32_t alloc_rx_buff_failed;
 320         uint32_t rx_int_delay;
 321         uint32_t rx_abs_int_delay;
 322         boolean_t rx_csum;
 323         unsigned int rx_ps_pages;
 324         uint32_t gorcl;
 325         uint64_t gorcl_old;
 326         uint16_t rx_ps_bsize0;
 327
 328
 329         /* OS defined structs */
 330         struct net_device *netdev;
 331         struct pci_dev *pdev;
 332         struct net_device_stats net_stats;
 333
 334         /* structs defined in e1000_hw.h */
 335         struct e1000_hw hw;
 336         struct e1000_hw_stats stats;
 337         struct e1000_phy_info phy_info;
 338         struct e1000_phy_stats phy_stats;
 339
 340         uint32_t test_icr;
 341         struct e1000_tx_ring test_tx_ring;
 342         struct e1000_rx_ring test_rx_ring;
 343
 344
 345         uint32_t *config_space;
 346         int msg_enable;
 347 #ifdef CONFIG_PCI_MSI
 348         boolean_t have_msi;
 349 #endif
 350         /* to not mess up cache alignment, always add to the bottom */
 351 #ifdef NETIF_F_TSO
 352         boolean_t tso_force;
 353 #endif
 354         boolean_t smart_power_down;     /* phy smart power down */
 355         boolean_t quad_port_a;
 356         unsigned long flags;
 357         uint32_t eeprom_wol;
 358 };
 359
 360 enum e1000_state_t {
 361         __E1000_TESTING,
 362         __E1000_RESETTING,
 363         __E1000_DOWN
 364 };
 365
 366 #endif /* _E1000_H_ */