devices/e1000/e1000-2.6.31-orig.h
changeset 2066 b544025bd696
parent 1996 852668fdae6a
equal deleted inserted replaced
2065:4d8c9a441ef6 2066:b544025bd696
       
     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 #include <linux/ipv6.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 #include <net/checksum.h>
       
    69 #include <linux/mii.h>
       
    70 #include <linux/ethtool.h>
       
    71 #include <linux/if_vlan.h>
       
    72 
       
    73 #define BAR_0		0
       
    74 #define BAR_1		1
       
    75 #define BAR_5		5
       
    76 
       
    77 #define INTEL_E1000_ETHERNET_DEVICE(device_id) {\
       
    78 	PCI_DEVICE(PCI_VENDOR_ID_INTEL, device_id)}
       
    79 
       
    80 struct e1000_adapter;
       
    81 
       
    82 #include "e1000_hw.h"
       
    83 
       
    84 #ifdef DBG
       
    85 #define E1000_DBG(args...) printk(KERN_DEBUG "e1000: " args)
       
    86 #else
       
    87 #define E1000_DBG(args...)
       
    88 #endif
       
    89 
       
    90 #define E1000_ERR(args...) printk(KERN_ERR "e1000: " args)
       
    91 
       
    92 #define PFX "e1000: "
       
    93 
       
    94 #define DPRINTK(nlevel, klevel, fmt, args...)				\
       
    95 do {									\
       
    96 	if (NETIF_MSG_##nlevel & adapter->msg_enable)			\
       
    97 		printk(KERN_##klevel PFX "%s: %s: " fmt,		\
       
    98 		       adapter->netdev->name, __func__, ##args);	\
       
    99 } while (0)
       
   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 /* this is the size past which hardware will drop packets when setting LPE=0 */
       
   115 #define MAXIMUM_ETHERNET_VLAN_SIZE 1522
       
   116 
       
   117 /* Supported Rx Buffer Sizes */
       
   118 #define E1000_RXBUFFER_128   128    /* Used for packet split */
       
   119 #define E1000_RXBUFFER_256   256    /* Used for packet split */
       
   120 #define E1000_RXBUFFER_512   512
       
   121 #define E1000_RXBUFFER_1024  1024
       
   122 #define E1000_RXBUFFER_2048  2048
       
   123 #define E1000_RXBUFFER_4096  4096
       
   124 #define E1000_RXBUFFER_8192  8192
       
   125 #define E1000_RXBUFFER_16384 16384
       
   126 
       
   127 /* SmartSpeed delimiters */
       
   128 #define E1000_SMARTSPEED_DOWNSHIFT 3
       
   129 #define E1000_SMARTSPEED_MAX       15
       
   130 
       
   131 /* Packet Buffer allocations */
       
   132 #define E1000_PBA_BYTES_SHIFT 0xA
       
   133 #define E1000_TX_HEAD_ADDR_SHIFT 7
       
   134 #define E1000_PBA_TX_MASK 0xFFFF0000
       
   135 
       
   136 /* Flow Control Watermarks */
       
   137 #define E1000_FC_HIGH_DIFF 0x1638  /* High: 5688 bytes below Rx FIFO size */
       
   138 #define E1000_FC_LOW_DIFF 0x1640   /* Low:  5696 bytes below Rx FIFO size */
       
   139 
       
   140 #define E1000_FC_PAUSE_TIME 0x0680 /* 858 usec */
       
   141 
       
   142 /* How many Tx Descriptors do we need to call netif_wake_queue ? */
       
   143 #define E1000_TX_QUEUE_WAKE	16
       
   144 /* How many Rx Buffers do we bundle into one write to the hardware ? */
       
   145 #define E1000_RX_BUFFER_WRITE	16	/* Must be power of 2 */
       
   146 
       
   147 #define AUTO_ALL_MODES            0
       
   148 #define E1000_EEPROM_82544_APM    0x0004
       
   149 #define E1000_EEPROM_ICH8_APME    0x0004
       
   150 #define E1000_EEPROM_APME         0x0400
       
   151 
       
   152 #ifndef E1000_MASTER_SLAVE
       
   153 /* Switch to override PHY master/slave setting */
       
   154 #define E1000_MASTER_SLAVE	e1000_ms_hw_default
       
   155 #endif
       
   156 
       
   157 #define E1000_MNG_VLAN_NONE (-1)
       
   158 
       
   159 /* wrapper around a pointer to a socket buffer,
       
   160  * so a DMA handle can be stored along with the buffer */
       
   161 struct e1000_buffer {
       
   162 	struct sk_buff *skb;
       
   163 	dma_addr_t dma;
       
   164 	unsigned long time_stamp;
       
   165 	u16 length;
       
   166 	u16 next_to_watch;
       
   167 };
       
   168 
       
   169 struct e1000_tx_ring {
       
   170 	/* pointer to the descriptor ring memory */
       
   171 	void *desc;
       
   172 	/* physical address of the descriptor ring */
       
   173 	dma_addr_t dma;
       
   174 	/* length of descriptor ring in bytes */
       
   175 	unsigned int size;
       
   176 	/* number of descriptors in the ring */
       
   177 	unsigned int count;
       
   178 	/* next descriptor to associate a buffer with */
       
   179 	unsigned int next_to_use;
       
   180 	/* next descriptor to check for DD status bit */
       
   181 	unsigned int next_to_clean;
       
   182 	/* array of buffer information structs */
       
   183 	struct e1000_buffer *buffer_info;
       
   184 
       
   185 	u16 tdh;
       
   186 	u16 tdt;
       
   187 	bool last_tx_tso;
       
   188 };
       
   189 
       
   190 struct e1000_rx_ring {
       
   191 	/* pointer to the descriptor ring memory */
       
   192 	void *desc;
       
   193 	/* physical address of the descriptor ring */
       
   194 	dma_addr_t dma;
       
   195 	/* length of descriptor ring in bytes */
       
   196 	unsigned int size;
       
   197 	/* number of descriptors in the ring */
       
   198 	unsigned int count;
       
   199 	/* next descriptor to associate a buffer with */
       
   200 	unsigned int next_to_use;
       
   201 	/* next descriptor to check for DD status bit */
       
   202 	unsigned int next_to_clean;
       
   203 	/* array of buffer information structs */
       
   204 	struct e1000_buffer *buffer_info;
       
   205 
       
   206 	/* cpu for rx queue */
       
   207 	int cpu;
       
   208 
       
   209 	u16 rdh;
       
   210 	u16 rdt;
       
   211 };
       
   212 
       
   213 #define E1000_DESC_UNUSED(R)						\
       
   214 	((((R)->next_to_clean > (R)->next_to_use)			\
       
   215 	  ? 0 : (R)->count) + (R)->next_to_clean - (R)->next_to_use - 1)
       
   216 
       
   217 #define E1000_RX_DESC_EXT(R, i)						\
       
   218 	(&(((union e1000_rx_desc_extended *)((R).desc))[i]))
       
   219 #define E1000_GET_DESC(R, i, type)	(&(((struct type *)((R).desc))[i]))
       
   220 #define E1000_RX_DESC(R, i)		E1000_GET_DESC(R, i, e1000_rx_desc)
       
   221 #define E1000_TX_DESC(R, i)		E1000_GET_DESC(R, i, e1000_tx_desc)
       
   222 #define E1000_CONTEXT_DESC(R, i)	E1000_GET_DESC(R, i, e1000_context_desc)
       
   223 
       
   224 /* board specific private data structure */
       
   225 
       
   226 struct e1000_adapter {
       
   227 	struct timer_list tx_fifo_stall_timer;
       
   228 	struct timer_list watchdog_timer;
       
   229 	struct timer_list phy_info_timer;
       
   230 	struct vlan_group *vlgrp;
       
   231 	u16 mng_vlan_id;
       
   232 	u32 bd_number;
       
   233 	u32 rx_buffer_len;
       
   234 	u32 wol;
       
   235 	u32 smartspeed;
       
   236 	u32 en_mng_pt;
       
   237 	u16 link_speed;
       
   238 	u16 link_duplex;
       
   239 	spinlock_t stats_lock;
       
   240 	unsigned int total_tx_bytes;
       
   241 	unsigned int total_tx_packets;
       
   242 	unsigned int total_rx_bytes;
       
   243 	unsigned int total_rx_packets;
       
   244 	/* Interrupt Throttle Rate */
       
   245 	u32 itr;
       
   246 	u32 itr_setting;
       
   247 	u16 tx_itr;
       
   248 	u16 rx_itr;
       
   249 
       
   250 	struct work_struct reset_task;
       
   251 	u8 fc_autoneg;
       
   252 
       
   253 	struct timer_list blink_timer;
       
   254 	unsigned long led_status;
       
   255 
       
   256 	/* TX */
       
   257 	struct e1000_tx_ring *tx_ring;      /* One per active queue */
       
   258 	unsigned int restart_queue;
       
   259 	unsigned long tx_queue_len;
       
   260 	u32 txd_cmd;
       
   261 	u32 tx_int_delay;
       
   262 	u32 tx_abs_int_delay;
       
   263 	u32 gotcl;
       
   264 	u64 gotcl_old;
       
   265 	u64 tpt_old;
       
   266 	u64 colc_old;
       
   267 	u32 tx_timeout_count;
       
   268 	u32 tx_fifo_head;
       
   269 	u32 tx_head_addr;
       
   270 	u32 tx_fifo_size;
       
   271 	u8  tx_timeout_factor;
       
   272 	atomic_t tx_fifo_stall;
       
   273 	bool pcix_82544;
       
   274 	bool detect_tx_hung;
       
   275 
       
   276 	/* RX */
       
   277 	bool (*clean_rx)(struct e1000_adapter *adapter,
       
   278 			 struct e1000_rx_ring *rx_ring,
       
   279 			 int *work_done, int work_to_do);
       
   280 	void (*alloc_rx_buf)(struct e1000_adapter *adapter,
       
   281 			     struct e1000_rx_ring *rx_ring,
       
   282 			     int cleaned_count);
       
   283 	struct e1000_rx_ring *rx_ring;      /* One per active queue */
       
   284 	struct napi_struct napi;
       
   285 
       
   286 	int num_tx_queues;
       
   287 	int num_rx_queues;
       
   288 
       
   289 	u64 hw_csum_err;
       
   290 	u64 hw_csum_good;
       
   291 	u64 rx_hdr_split;
       
   292 	u32 alloc_rx_buff_failed;
       
   293 	u32 rx_int_delay;
       
   294 	u32 rx_abs_int_delay;
       
   295 	bool rx_csum;
       
   296 	u32 gorcl;
       
   297 	u64 gorcl_old;
       
   298 
       
   299 	/* OS defined structs */
       
   300 	struct net_device *netdev;
       
   301 	struct pci_dev *pdev;
       
   302 	struct net_device_stats net_stats;
       
   303 
       
   304 	/* structs defined in e1000_hw.h */
       
   305 	struct e1000_hw hw;
       
   306 	struct e1000_hw_stats stats;
       
   307 	struct e1000_phy_info phy_info;
       
   308 	struct e1000_phy_stats phy_stats;
       
   309 
       
   310 	u32 test_icr;
       
   311 	struct e1000_tx_ring test_tx_ring;
       
   312 	struct e1000_rx_ring test_rx_ring;
       
   313 
       
   314 	int msg_enable;
       
   315 	bool have_msi;
       
   316 
       
   317 	/* to not mess up cache alignment, always add to the bottom */
       
   318 	bool tso_force;
       
   319 	bool smart_power_down;	/* phy smart power down */
       
   320 	bool quad_port_a;
       
   321 	unsigned long flags;
       
   322 	u32 eeprom_wol;
       
   323 
       
   324 	/* for ioport free */
       
   325 	int bars;
       
   326 	int need_ioport;
       
   327 };
       
   328 
       
   329 enum e1000_state_t {
       
   330 	__E1000_TESTING,
       
   331 	__E1000_RESETTING,
       
   332 	__E1000_DOWN
       
   333 };
       
   334 
       
   335 extern char e1000_driver_name[];
       
   336 extern const char e1000_driver_version[];
       
   337 
       
   338 extern int e1000_up(struct e1000_adapter *adapter);
       
   339 extern void e1000_down(struct e1000_adapter *adapter);
       
   340 extern void e1000_reinit_locked(struct e1000_adapter *adapter);
       
   341 extern void e1000_reset(struct e1000_adapter *adapter);
       
   342 extern int e1000_set_spd_dplx(struct e1000_adapter *adapter, u16 spddplx);
       
   343 extern int e1000_setup_all_rx_resources(struct e1000_adapter *adapter);
       
   344 extern int e1000_setup_all_tx_resources(struct e1000_adapter *adapter);
       
   345 extern void e1000_free_all_rx_resources(struct e1000_adapter *adapter);
       
   346 extern void e1000_free_all_tx_resources(struct e1000_adapter *adapter);
       
   347 extern void e1000_update_stats(struct e1000_adapter *adapter);
       
   348 extern void e1000_power_up_phy(struct e1000_adapter *);
       
   349 extern void e1000_set_ethtool_ops(struct net_device *netdev);
       
   350 extern void e1000_check_options(struct e1000_adapter *adapter);
       
   351 
       
   352 #endif /* _E1000_H_ */