drivers/net/e1000/e1000.h

   1 /*******************************************************************************
   2
   3
   4   Copyright(c) 1999 - 2006 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   e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
  26   Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  27
  28 *******************************************************************************/
  29
  30
  31 /* Linux PRO/1000 Ethernet Driver main header file */
  32
  33 #ifndef _E1000_H_
  34 #define _E1000_H_
  35
  36 #include <linux/stddef.h>
  37 #include <linux/config.h>
  38 #include <linux/module.h>
  39 #include <linux/types.h>
  40 #include <asm/byteorder.h>
  41 #include <linux/init.h>
  42 #include <linux/mm.h>
  43 #include <linux/errno.h>
  44 #include <linux/ioport.h>
  45 #include <linux/pci.h>
  46 #include <linux/kernel.h>
  47 #include <linux/netdevice.h>
  48 #include <linux/etherdevice.h>
  49 #include <linux/skbuff.h>
  50 #include <linux/delay.h>
  51 #include <linux/timer.h>
  52 #include <linux/slab.h>
  53 #include <linux/vmalloc.h>
  54 #include <linux/interrupt.h>
  55 #include <linux/string.h>
  56 #include <linux/pagemap.h>
  57 #include <linux/dma-mapping.h>
  58 #include <linux/bitops.h>
  59 #include <asm/io.h>
  60 #include <asm/irq.h>
  61 #include <linux/capability.h>
  62 #include <linux/in.h>
  63 #include <linux/ip.h>
  64 #include <linux/tcp.h>
  65 #include <linux/udp.h>
  66 #include <net/pkt_sched.h>
  67 #include <linux/list.h>
  68 #include <linux/reboot.h>
  69 #ifdef NETIF_F_TSO
  70 #include <net/checksum.h>
  71 #endif
  72 #include <linux/workqueue.h>
  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 /* Supported Rx Buffer Sizes */
 116 #define E1000_RXBUFFER_128   128    /* Used for packet split */
 117 #define E1000_RXBUFFER_256   256    /* Used for packet split */
 118 #define E1000_RXBUFFER_512   512
 119 #define E1000_RXBUFFER_1024  1024
 120 #define E1000_RXBUFFER_2048  2048
 121 #define E1000_RXBUFFER_4096  4096
 122 #define E1000_RXBUFFER_8192  8192
 123 #define E1000_RXBUFFER_16384 16384
 124
 125 /* SmartSpeed delimiters */
 126 #define E1000_SMARTSPEED_DOWNSHIFT 3
 127 #define E1000_SMARTSPEED_MAX       15
 128
 129 /* Packet Buffer allocations */
 130 #define E1000_PBA_BYTES_SHIFT 0xA
 131 #define E1000_TX_HEAD_ADDR_SHIFT 7
 132 #define E1000_PBA_TX_MASK 0xFFFF0000
 133
 134 /* Flow Control Watermarks */
 135 #define E1000_FC_HIGH_DIFF 0x1638  /* High: 5688 bytes below Rx FIFO size */
 136 #define E1000_FC_LOW_DIFF 0x1640   /* Low:  5696 bytes below Rx FIFO size */
 137
 138 #define E1000_FC_PAUSE_TIME 0x0680 /* 858 usec */
 139
 140 /* How many Tx Descriptors do we need to call netif_wake_queue ? */
 141 #define E1000_TX_QUEUE_WAKE     16
 142 /* How many Rx Buffers do we bundle into one write to the hardware ? */
 143 #define E1000_RX_BUFFER_WRITE   16      /* Must be power of 2 */
 144
 145 #define AUTO_ALL_MODES            0
 146 #define E1000_EEPROM_82544_APM    0x0004
 147 #define E1000_EEPROM_APME         0x0400
 148
 149 #ifndef E1000_MASTER_SLAVE
 150 /* Switch to override PHY master/slave setting */
 151 #define E1000_MASTER_SLAVE      e1000_ms_hw_default
 152 #endif
 153
 154 #define E1000_MNG_VLAN_NONE -1
 155 /* Number of packet split data buffers (not including the header buffer) */
 156 #define PS_PAGE_BUFFERS MAX_PS_BUFFERS-1
 157
 158 /* only works for sizes that are powers of 2 */
 159 #define E1000_ROUNDUP(i, size) ((i) = (((i) + (size) - 1) & ~((size) - 1)))
 160
 161 /* wrapper around a pointer to a socket buffer,
 162  * so a DMA handle can be stored along with the buffer */
 163 struct e1000_buffer {
 164         struct sk_buff *skb;
 165         dma_addr_t dma;
 166         unsigned long time_stamp;
 167         uint16_t length;
 168         uint16_t next_to_watch;
 169 };
 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         boolean_t last_tx_tso;
 195 };
 196
 197 struct e1000_rx_ring {
 198         /* pointer to the descriptor ring memory */
 199         void *desc;
 200         /* physical address of the descriptor ring */
 201         dma_addr_t dma;
 202         /* length of descriptor ring in bytes */
 203         unsigned int size;
 204         /* number of descriptors in the ring */
 205         unsigned int count;
 206         /* next descriptor to associate a buffer with */
 207         unsigned int next_to_use;
 208         /* next descriptor to check for DD status bit */
 209         unsigned int next_to_clean;
 210         /* array of buffer information structs */
 211         struct e1000_buffer *buffer_info;
 212         /* arrays of page information for packet split */
 213         struct e1000_ps_page *ps_page;
 214         struct e1000_ps_page_dma *ps_page_dma;
 215
 216         /* cpu for rx queue */
 217         int cpu;
 218
 219         uint16_t rdh;
 220         uint16_t rdt;
 221 };
 222
 223 #define E1000_DESC_UNUSED(R) \
 224         ((((R)->next_to_clean > (R)->next_to_use) ? 0 : (R)->count) + \
 225         (R)->next_to_clean - (R)->next_to_use - 1)
 226
 227 #define E1000_RX_DESC_PS(R, i)      \
 228         (&(((union e1000_rx_desc_packet_split *)((R).desc))[i]))
 229 #define E1000_RX_DESC_EXT(R, i)     \
 230         (&(((union e1000_rx_desc_extended *)((R).desc))[i]))
 231 #define E1000_GET_DESC(R, i, type)      (&(((struct type *)((R).desc))[i]))
 232 #define E1000_RX_DESC(R, i)             E1000_GET_DESC(R, i, e1000_rx_desc)
 233 #define E1000_TX_DESC(R, i)             E1000_GET_DESC(R, i, e1000_tx_desc)
 234 #define E1000_CONTEXT_DESC(R, i)        E1000_GET_DESC(R, i, e1000_context_desc)
 235
 236 /* board specific private data structure */
 237
 238 struct e1000_adapter {
 239         struct timer_list tx_fifo_stall_timer;
 240         struct timer_list watchdog_timer;
 241         struct timer_list phy_info_timer;
 242         struct vlan_group *vlgrp;
 243         uint16_t mng_vlan_id;
 244         uint32_t bd_number;
 245         uint32_t rx_buffer_len;
 246         uint32_t part_num;
 247         uint32_t wol;
 248         uint32_t ksp3_port_a;
 249         uint32_t smartspeed;
 250         uint32_t en_mng_pt;
 251         uint16_t link_speed;
 252         uint16_t link_duplex;
 253         spinlock_t stats_lock;
 254 #ifdef CONFIG_E1000_NAPI
 255         spinlock_t tx_queue_lock;
 256 #endif
 257         atomic_t irq_sem;
 258         struct work_struct watchdog_task;
 259         struct work_struct reset_task;
 260         uint8_t fc_autoneg;
 261
 262         struct timer_list blink_timer;
 263         unsigned long led_status;
 264
 265         /* TX */
 266         struct e1000_tx_ring *tx_ring;      /* One per active queue */
 267         unsigned long tx_queue_len;
 268         uint32_t txd_cmd;
 269         uint32_t tx_int_delay;
 270         uint32_t tx_abs_int_delay;
 271         uint32_t gotcl;
 272         uint64_t gotcl_old;
 273         uint64_t tpt_old;
 274         uint64_t colc_old;
 275         uint32_t tx_timeout_count;
 276         uint32_t tx_fifo_head;
 277         uint32_t tx_head_addr;
 278         uint32_t tx_fifo_size;
 279         uint8_t  tx_timeout_factor;
 280         atomic_t tx_fifo_stall;
 281         boolean_t pcix_82544;
 282         boolean_t detect_tx_hung;
 283
 284         /* RX */
 285 #ifdef CONFIG_E1000_NAPI
 286         boolean_t (*clean_rx) (struct e1000_adapter *adapter,
 287                                struct e1000_rx_ring *rx_ring,
 288                                int *work_done, int work_to_do);
 289 #else
 290         boolean_t (*clean_rx) (struct e1000_adapter *adapter,
 291                                struct e1000_rx_ring *rx_ring);
 292 #endif
 293         void (*alloc_rx_buf) (struct e1000_adapter *adapter,
 294                               struct e1000_rx_ring *rx_ring,
 295                                 int cleaned_count);
 296         struct e1000_rx_ring *rx_ring;      /* One per active queue */
 297 #ifdef CONFIG_E1000_NAPI
 298         struct net_device *polling_netdev;  /* One per active queue */
 299 #endif
 300         int num_tx_queues;
 301         int num_rx_queues;
 302
 303         uint64_t hw_csum_err;
 304         uint64_t hw_csum_good;
 305         uint64_t rx_hdr_split;
 306         uint32_t alloc_rx_buff_failed;
 307         uint32_t rx_int_delay;
 308         uint32_t rx_abs_int_delay;
 309         boolean_t rx_csum;
 310         unsigned int rx_ps_pages;
 311         uint32_t gorcl;
 312         uint64_t gorcl_old;
 313         uint16_t rx_ps_bsize0;
 314
 315         /* Interrupt Throttle Rate */
 316         uint32_t itr;
 317
 318         /* OS defined structs */
 319         struct net_device *netdev;
 320         struct pci_dev *pdev;
 321         struct net_device_stats net_stats;
 322
 323         /* structs defined in e1000_hw.h */
 324         struct e1000_hw hw;
 325         struct e1000_hw_stats stats;
 326         struct e1000_phy_info phy_info;
 327         struct e1000_phy_stats phy_stats;
 328
 329         uint32_t test_icr;
 330         struct e1000_tx_ring test_tx_ring;
 331         struct e1000_rx_ring test_rx_ring;
 332
 333
 334         uint32_t *config_space;
 335         int msg_enable;
 336 #ifdef CONFIG_PCI_MSI
 337         boolean_t have_msi;
 338 #endif
 339         /* to not mess up cache alignment, always add to the bottom */
 340 #ifdef NETIF_F_TSO
 341         boolean_t tso_force;
 342 #endif
 343 };
 344
 345
 346 /*  e1000_main.c  */
 347 extern char e1000_driver_name[];
 348 extern char e1000_driver_version[];
 349 int e1000_up(struct e1000_adapter *adapter);
 350 void e1000_down(struct e1000_adapter *adapter);
 351 void e1000_reset(struct e1000_adapter *adapter);
 352 int e1000_setup_all_tx_resources(struct e1000_adapter *adapter);
 353 void e1000_free_all_tx_resources(struct e1000_adapter *adapter);
 354 int e1000_setup_all_rx_resources(struct e1000_adapter *adapter);
 355 void e1000_free_all_rx_resources(struct e1000_adapter *adapter);
 356 void e1000_update_stats(struct e1000_adapter *adapter);
 357 int e1000_set_spd_dplx(struct e1000_adapter *adapter, uint16_t spddplx);
 358
 359 /*  e1000_ethtool.c  */
 360 void e1000_set_ethtool_ops(struct net_device *netdev);
 361
 362 /*  e1000_param.c  */
 363 void e1000_check_options(struct e1000_adapter *adapter);
 364
 365
 366 #endif /* _E1000_H_ */