drivers/net/e1000/e1000.h

   1 /*******************************************************************************
   2
   3
   4   Copyright(c) 1999 - 2004 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/interrupt.h>
  53 #include <linux/string.h>
  54 #include <linux/pagemap.h>
  55 #include <linux/dma-mapping.h>
  56 #include <asm/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/tcp.h>
  63 #include <linux/udp.h>
  64 #include <net/pkt_sched.h>
  65 #include <linux/list.h>
  66 #include <linux/reboot.h>
  67 #ifdef NETIF_F_TSO
  68 #include <net/checksum.h>
  69 #endif
  70 #include <linux/workqueue.h>
  71 #include <linux/mii.h>
  72 #include <linux/ethtool.h>
  73 #include <linux/if_vlan.h>
  74 #include <linux/moduleparam.h>
  75
  76 #define BAR_0           0
  77 #define BAR_1           1
  78 #define BAR_5           5
  79
  80
  81 struct e1000_adapter;
  82
  83 #include "e1000_hw.h"
  84
  85 #if DBG
  86 #define E1000_DBG(args...) printk(KERN_DEBUG "e1000: " args)
  87 #else
  88 #define E1000_DBG(args...)
  89 #endif
  90
  91 #define E1000_ERR(args...) printk(KERN_ERR "e1000: " args)
  92
  93 #define PFX "e1000: "
  94 #define DPRINTK(nlevel, klevel, fmt, args...) \
  95         (void)((NETIF_MSG_##nlevel & adapter->msg_enable) && \
  96         printk(KERN_##klevel PFX "%s: %s: " fmt, adapter->netdev->name, \
  97                 __FUNCTION__ , ## args))
  98
  99 #define E1000_MAX_INTR 10
 100
 101 /* How many descriptors for TX and RX ? */
 102 #define E1000_DEFAULT_TXD                  256
 103 #define E1000_MAX_TXD                      256
 104 #define E1000_MIN_TXD                       80
 105 #define E1000_MAX_82544_TXD               4096
 106 #define E1000_DEFAULT_RXD                  256
 107 #define E1000_MAX_RXD                      256
 108 #define E1000_MIN_RXD                       80
 109 #define E1000_MAX_82544_RXD               4096
 110
 111 /* Supported Rx Buffer Sizes */
 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 High-Watermark: 5688 bytes below Rx FIFO size */
 127 #define E1000_FC_HIGH_DIFF 0x1638
 128
 129 /* Flow Control Low-Watermark: 5696 bytes below Rx FIFO size */
 130 #define E1000_FC_LOW_DIFF 0x1640
 131
 132 /* Flow Control Pause Time: 858 usec */
 133 #define E1000_FC_PAUSE_TIME 0x0680
 134
 135 /* How many Tx Descriptors do we need to call netif_wake_queue ? */
 136 #define E1000_TX_QUEUE_WAKE     16
 137 /* How many Rx Buffers do we bundle into one write to the hardware ? */
 138 #define E1000_RX_BUFFER_WRITE   16      /* Must be power of 2 */
 139
 140 #define AUTO_ALL_MODES       0
 141 #define E1000_EEPROM_APME    0x0400
 142
 143 #ifndef E1000_MASTER_SLAVE
 144 /* Switch to override PHY master/slave setting */
 145 #define E1000_MASTER_SLAVE      e1000_ms_hw_default
 146 #endif
 147
 148 /* only works for sizes that are powers of 2 */
 149 #define E1000_ROUNDUP(i, size) ((i) = (((i) + (size) - 1) & ~((size) - 1)))
 150
 151 /* wrapper around a pointer to a socket buffer,
 152  * so a DMA handle can be stored along with the buffer */
 153 struct e1000_buffer {
 154         struct sk_buff *skb;
 155         uint64_t dma;
 156         unsigned long length;
 157         unsigned long time_stamp;
 158         unsigned int next_to_watch;
 159 };
 160
 161 struct e1000_desc_ring {
 162         /* pointer to the descriptor ring memory */
 163         void *desc;
 164         /* physical address of the descriptor ring */
 165         dma_addr_t dma;
 166         /* length of descriptor ring in bytes */
 167         unsigned int size;
 168         /* number of descriptors in the ring */
 169         unsigned int count;
 170         /* next descriptor to associate a buffer with */
 171         unsigned int next_to_use;
 172         /* next descriptor to check for DD status bit */
 173         unsigned int next_to_clean;
 174         /* array of buffer information structs */
 175         struct e1000_buffer *buffer_info;
 176 };
 177
 178 #define E1000_DESC_UNUSED(R) \
 179         ((((R)->next_to_clean > (R)->next_to_use) ? 0 : (R)->count) + \
 180         (R)->next_to_clean - (R)->next_to_use - 1)
 181
 182 #define E1000_GET_DESC(R, i, type)      (&(((struct type *)((R).desc))[i]))
 183 #define E1000_RX_DESC(R, i)             E1000_GET_DESC(R, i, e1000_rx_desc)
 184 #define E1000_TX_DESC(R, i)             E1000_GET_DESC(R, i, e1000_tx_desc)
 185 #define E1000_CONTEXT_DESC(R, i)        E1000_GET_DESC(R, i, e1000_context_desc)
 186
 187 /* board specific private data structure */
 188
 189 struct e1000_adapter {
 190         struct timer_list tx_fifo_stall_timer;
 191         struct timer_list watchdog_timer;
 192         struct timer_list phy_info_timer;
 193         struct vlan_group *vlgrp;
 194         uint32_t bd_number;
 195         uint32_t rx_buffer_len;
 196         uint32_t part_num;
 197         uint32_t wol;
 198         uint32_t smartspeed;
 199         uint16_t link_speed;
 200         uint16_t link_duplex;
 201         spinlock_t stats_lock;
 202         atomic_t irq_sem;
 203         struct work_struct tx_timeout_task;
 204         uint8_t fc_autoneg;
 205
 206         struct timer_list blink_timer;
 207         unsigned long led_status;
 208
 209         /* TX */
 210         struct e1000_desc_ring tx_ring;
 211         spinlock_t tx_lock;
 212         uint32_t txd_cmd;
 213         uint32_t tx_int_delay;
 214         uint32_t tx_abs_int_delay;
 215         uint32_t gotcl;
 216         uint64_t gotcl_old;
 217         uint64_t tpt_old;
 218         uint64_t colc_old;
 219         uint32_t tx_fifo_head;
 220         uint32_t tx_head_addr;
 221         uint32_t tx_fifo_size;
 222         atomic_t tx_fifo_stall;
 223         boolean_t pcix_82544;
 224
 225         /* RX */
 226         struct e1000_desc_ring rx_ring;
 227         uint64_t hw_csum_err;
 228         uint64_t hw_csum_good;
 229         uint32_t rx_int_delay;
 230         uint32_t rx_abs_int_delay;
 231         boolean_t rx_csum;
 232         uint32_t gorcl;
 233         uint64_t gorcl_old;
 234
 235         /* Interrupt Throttle Rate */
 236         uint32_t itr;
 237
 238         /* OS defined structs */
 239         struct net_device *netdev;
 240         struct pci_dev *pdev;
 241         struct net_device_stats net_stats;
 242
 243         /* structs defined in e1000_hw.h */
 244         struct e1000_hw hw;
 245         struct e1000_hw_stats stats;
 246         struct e1000_phy_info phy_info;
 247         struct e1000_phy_stats phy_stats;
 248
 249         uint32_t test_icr;
 250         struct e1000_desc_ring test_tx_ring;
 251         struct e1000_desc_ring test_rx_ring;
 252
 253
 254         uint32_t pci_state[16];
 255         int msg_enable;
 256 };
 257 #endif /* _E1000_H_ */