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