drivers/net/e1000/e1000.h

   1 /*******************************************************************************
   2
   3
   4   Copyright(c) 1999 - 2005 Intel Corporation. All rights reserved.
   5
   6   This program is free software; you can redistribute it and/or modify it
   7   under the terms of the GNU General Public License as published by the Free
   8   Software Foundation; either version 2 of the License, or (at your option)
   9   any later version.
  10
  11   This program is distributed in the hope that it will be useful, but WITHOUT
  12   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  14   more details.
  15
  16   You should have received a copy of the GNU General Public License along with
  17   this program; if not, write to the Free Software Foundation, Inc., 59
  18   Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  19
  20   The full GNU General Public License is included in this distribution in the
  21   file called LICENSE.
  22
  23   Contact Information:
  24   Linux NICS <linux.nics@intel.com>
  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/config.h>
  37 #include <linux/module.h>
  38 #include <linux/types.h>
  39 #include <asm/byteorder.h>
  40 #include <linux/init.h>
  41 #include <linux/mm.h>
  42 #include <linux/errno.h>
  43 #include <linux/ioport.h>
  44 #include <linux/pci.h>
  45 #include <linux/kernel.h>
  46 #include <linux/netdevice.h>
  47 #include <linux/etherdevice.h>
  48 #include <linux/skbuff.h>
  49 #include <linux/delay.h>
  50 #include <linux/timer.h>
  51 #include <linux/slab.h>
  52 #include <linux/vmalloc.h>
  53 #include <linux/interrupt.h>
  54 #include <linux/string.h>
  55 #include <linux/pagemap.h>
  56 #include <linux/dma-mapping.h>
  57 #include <linux/bitops.h>
  58 #include <asm/io.h>
  59 #include <asm/irq.h>
  60 #include <linux/capability.h>
  61 #include <linux/in.h>
  62 #include <linux/ip.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 #ifdef NETIF_F_TSO
  69 #include <net/checksum.h>
  70 #endif
  71 #include <linux/workqueue.h>
  72 #include <linux/mii.h>
  73 #include <linux/ethtool.h>
  74 #include <linux/if_vlan.h>
  75 #ifdef CONFIG_E1000_MQ
  76 #include <linux/cpu.h>
  77 #include <linux/smp.h>
  78 #endif
  79
  80 #define BAR_0           0
  81 #define BAR_1           1
  82 #define BAR_5           5
  83
  84 #define INTEL_E1000_ETHERNET_DEVICE(device_id) {\
  85         PCI_DEVICE(PCI_VENDOR_ID_INTEL, device_id)}
  86
  87 struct e1000_adapter;
  88
  89 #include "e1000_hw.h"
  90
  91 #ifdef DBG
  92 #define E1000_DBG(args...) printk(KERN_DEBUG "e1000: " args)
  93 #else
  94 #define E1000_DBG(args...)
  95 #endif
  96
  97 #define E1000_ERR(args...) printk(KERN_ERR "e1000: " args)
  98
  99 #define PFX "e1000: "
 100 #define DPRINTK(nlevel, klevel, fmt, args...) \
 101         (void)((NETIF_MSG_##nlevel & adapter->msg_enable) && \
 102         printk(KERN_##klevel PFX "%s: %s: " fmt, adapter->netdev->name, \
 103                 __FUNCTION__ , ## args))
 104
 105 #define E1000_MAX_INTR 10
 106
 107 /* TX/RX descriptor defines */
 108 #define E1000_DEFAULT_TXD                  256
 109 #define E1000_MAX_TXD                      256
 110 #define E1000_MIN_TXD                       80
 111 #define E1000_MAX_82544_TXD               4096
 112
 113 #define E1000_DEFAULT_RXD                  256
 114 #define E1000_MAX_RXD                      256
 115 #define E1000_MIN_RXD                       80
 116 #define E1000_MAX_82544_RXD               4096
 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_2048  2048
 122 #define E1000_RXBUFFER_4096  4096
 123 #define E1000_RXBUFFER_8192  8192
 124 #define E1000_RXBUFFER_16384 16384
 125
 126 /* SmartSpeed delimiters */
 127 #define E1000_SMARTSPEED_DOWNSHIFT 3
 128 #define E1000_SMARTSPEED_MAX       15
 129
 130 /* Packet Buffer allocations */
 131 #define E1000_PBA_BYTES_SHIFT 0xA
 132 #define E1000_TX_HEAD_ADDR_SHIFT 7
 133 #define E1000_PBA_TX_MASK 0xFFFF0000
 134
 135 /* Flow Control Watermarks */
 136 #define E1000_FC_HIGH_DIFF 0x1638  /* High: 5688 bytes below Rx FIFO size */
 137 #define E1000_FC_LOW_DIFF 0x1640   /* Low:  5696 bytes below Rx FIFO size */
 138
 139 #define E1000_FC_PAUSE_TIME 0x0680 /* 858 usec */
 140
 141 /* How many Tx Descriptors do we need to call netif_wake_queue ? */
 142 #define E1000_TX_QUEUE_WAKE     16
 143 /* How many Rx Buffers do we bundle into one write to the hardware ? */
 144 #define E1000_RX_BUFFER_WRITE   16      /* Must be power of 2 */
 145
 146 #define AUTO_ALL_MODES            0
 147 #define E1000_EEPROM_82544_APM    0x0004
 148 #define E1000_EEPROM_APME         0x0400
 149
 150 #ifndef E1000_MASTER_SLAVE
 151 /* Switch to override PHY master/slave setting */
 152 #define E1000_MASTER_SLAVE      e1000_ms_hw_default
 153 #endif
 154
 155 #define E1000_MNG_VLAN_NONE -1
 156 /* Number of packet split data buffers (not including the header buffer) */
 157 #define PS_PAGE_BUFFERS MAX_PS_BUFFERS-1
 158
 159 /* only works for sizes that are powers of 2 */
 160 #define E1000_ROUNDUP(i, size) ((i) = (((i) + (size) - 1) & ~((size) - 1)))
 161
 162 /* wrapper around a pointer to a socket buffer,
 163  * so a DMA handle can be stored along with the buffer */
 164 struct e1000_buffer {
 165         struct sk_buff *skb;
 166         dma_addr_t dma;
 167         unsigned long time_stamp;
 168         uint16_t length;
 169         uint16_t next_to_watch;
 170 };
 171
 172 struct e1000_ps_page { struct page *ps_page[PS_PAGE_BUFFERS]; };
 173 struct e1000_ps_page_dma { uint64_t ps_page_dma[PS_PAGE_BUFFERS]; };
 174
 175 struct e1000_tx_ring {
 176         /* pointer to the descriptor ring memory */
 177         void *desc;
 178         /* physical address of the descriptor ring */
 179         dma_addr_t dma;
 180         /* length of descriptor ring in bytes */
 181         unsigned int size;
 182         /* number of descriptors in the ring */
 183         unsigned int count;
 184         /* next descriptor to associate a buffer with */
 185         unsigned int next_to_use;
 186         /* next descriptor to check for DD status bit */
 187         unsigned int next_to_clean;
 188         /* array of buffer information structs */
 189         struct e1000_buffer *buffer_info;
 190
 191         spinlock_t tx_lock;
 192         uint16_t tdh;
 193         uint16_t tdt;
 194
 195         boolean_t last_tx_tso;
 196
 197 };
 198
 199 struct e1000_rx_ring {
 200         /* pointer to the descriptor ring memory */
 201         void *desc;
 202         /* physical address of the descriptor ring */
 203         dma_addr_t dma;
 204         /* length of descriptor ring in bytes */
 205         unsigned int size;
 206         /* number of descriptors in the ring */
 207         unsigned int count;
 208         /* next descriptor to associate a buffer with */
 209         unsigned int next_to_use;
 210         /* next descriptor to check for DD status bit */
 211         unsigned int next_to_clean;
 212         /* array of buffer information structs */
 213         struct e1000_buffer *buffer_info;
 214         /* arrays of page information for packet split */
 215         struct e1000_ps_page *ps_page;
 216         struct e1000_ps_page_dma *ps_page_dma;
 217
 218         struct sk_buff *rx_skb_top;
 219         struct sk_buff *rx_skb_prev;
 220
 221         /* cpu for rx queue */
 222         int cpu;
 223
 224         uint16_t rdh;
 225         uint16_t rdt;
 226 };
 227
 228 #define E1000_DESC_UNUSED(R) \
 229         ((((R)->next_to_clean > (R)->next_to_use) ? 0 : (R)->count) + \
 230         (R)->next_to_clean - (R)->next_to_use - 1)
 231
 232 #define E1000_RX_DESC_PS(R, i)      \
 233         (&(((union e1000_rx_desc_packet_split *)((R).desc))[i]))
 234 #define E1000_RX_DESC_EXT(R, i)     \
 235         (&(((union e1000_rx_desc_extended *)((R).desc))[i]))
 236 #define E1000_GET_DESC(R, i, type)      (&(((struct type *)((R).desc))[i]))
 237 #define E1000_RX_DESC(R, i)             E1000_GET_DESC(R, i, e1000_rx_desc)
 238 #define E1000_TX_DESC(R, i)             E1000_GET_DESC(R, i, e1000_tx_desc)
 239 #define E1000_CONTEXT_DESC(R, i)        E1000_GET_DESC(R, i, e1000_context_desc)
 240
 241 /* board specific private data structure */
 242
 243 struct e1000_adapter {
 244         struct timer_list tx_fifo_stall_timer;
 245         struct timer_list watchdog_timer;
 246         struct timer_list phy_info_timer;
 247         struct vlan_group *vlgrp;
 248         uint16_t mng_vlan_id;
 249         uint32_t bd_number;
 250         uint32_t rx_buffer_len;
 251         uint32_t part_num;
 252         uint32_t wol;
 253         uint32_t smartspeed;
 254         uint32_t en_mng_pt;
 255         uint16_t link_speed;
 256         uint16_t link_duplex;
 257         spinlock_t stats_lock;
 258         atomic_t irq_sem;
 259         struct work_struct tx_timeout_task;
 260         struct work_struct watchdog_task;
 261         uint8_t fc_autoneg;
 262
 263         struct timer_list blink_timer;
 264         unsigned long led_status;
 265
 266         /* TX */
 267         struct e1000_tx_ring *tx_ring;      /* One per active queue */
 268 #ifdef CONFIG_E1000_MQ
 269         struct e1000_tx_ring **cpu_tx_ring; /* per-cpu */
 270 #endif
 271         uint32_t txd_cmd;
 272         uint32_t tx_int_delay;
 273         uint32_t tx_abs_int_delay;
 274         uint32_t gotcl;
 275         uint64_t gotcl_old;
 276         uint64_t tpt_old;
 277         uint64_t colc_old;
 278         uint32_t tx_timeout_count;
 279         uint32_t tx_fifo_head;
 280         uint32_t tx_head_addr;
 281         uint32_t tx_fifo_size;
 282         atomic_t tx_fifo_stall;
 283         boolean_t pcix_82544;
 284         boolean_t detect_tx_hung;
 285
 286         /* RX */
 287 #ifdef CONFIG_E1000_NAPI
 288         boolean_t (*clean_rx) (struct e1000_adapter *adapter,
 289                                struct e1000_rx_ring *rx_ring,
 290                                int *work_done, int work_to_do);
 291 #else
 292         boolean_t (*clean_rx) (struct e1000_adapter *adapter,
 293                                struct e1000_rx_ring *rx_ring);
 294 #endif
 295         void (*alloc_rx_buf) (struct e1000_adapter *adapter,
 296                               struct e1000_rx_ring *rx_ring);
 297         struct e1000_rx_ring *rx_ring;      /* One per active queue */
 298 #ifdef CONFIG_E1000_NAPI
 299         struct net_device *polling_netdev;  /* One per active queue */
 300 #endif
 301 #ifdef CONFIG_E1000_MQ
 302         struct net_device **cpu_netdev;     /* per-cpu */
 303         struct call_async_data_struct rx_sched_call_data;
 304         int cpu_for_queue[4];
 305 #endif
 306         int num_queues;
 307
 308         uint64_t hw_csum_err;
 309         uint64_t hw_csum_good;
 310         uint64_t rx_hdr_split;
 311         uint32_t alloc_rx_buff_failed;
 312         uint32_t rx_int_delay;
 313         uint32_t rx_abs_int_delay;
 314         boolean_t rx_csum;
 315         unsigned int rx_ps_pages;
 316         uint32_t gorcl;
 317         uint64_t gorcl_old;
 318         uint16_t rx_ps_bsize0;
 319
 320         /* Interrupt Throttle Rate */
 321         uint32_t itr;
 322
 323         /* OS defined structs */
 324         struct net_device *netdev;
 325         struct pci_dev *pdev;
 326         struct net_device_stats net_stats;
 327
 328         /* structs defined in e1000_hw.h */
 329         struct e1000_hw hw;
 330         struct e1000_hw_stats stats;
 331         struct e1000_phy_info phy_info;
 332         struct e1000_phy_stats phy_stats;
 333
 334         uint32_t test_icr;
 335         struct e1000_tx_ring test_tx_ring;
 336         struct e1000_rx_ring test_rx_ring;
 337
 338
 339         int msg_enable;
 340 #ifdef CONFIG_PCI_MSI
 341         boolean_t have_msi;
 342 #endif
 343 };
 344 #endif /* _E1000_H_ */