Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /******************************************************************************* |
| 2 | |
| 3 | |
Malli Chilakala | 2648345 | 2005-04-28 19:44:46 -0700 | [diff] [blame] | 4 | Copyright(c) 1999 - 2005 Intel Corporation. All rights reserved. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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> |
Mallikarjuna R Chilakala | 581d708 | 2005-10-04 07:01:55 -0400 | [diff] [blame] | 75 | #ifdef CONFIG_E1000_MQ |
| 76 | #include <linux/cpu.h> |
| 77 | #include <linux/smp.h> |
| 78 | #endif |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 */ |
Malli Chilakala | 2d7edb9 | 2005-04-28 19:43:52 -0700 | [diff] [blame] | 119 | #define E1000_RXBUFFER_128 128 /* Used for packet split */ |
| 120 | #define E1000_RXBUFFER_256 256 /* Used for packet split */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 | |
Malli Chilakala | 2648345 | 2005-04-28 19:44:46 -0700 | [diff] [blame] | 146 | #define AUTO_ALL_MODES 0 |
Malli Chilakala | 70cf362 | 2005-06-17 17:40:41 -0700 | [diff] [blame] | 147 | #define E1000_EEPROM_82544_APM 0x0004 |
Malli Chilakala | 2648345 | 2005-04-28 19:44:46 -0700 | [diff] [blame] | 148 | #define E1000_EEPROM_APME 0x0400 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 | |
Malli Chilakala | 2d7edb9 | 2005-04-28 19:43:52 -0700 | [diff] [blame] | 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 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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; |
Malli Chilakala | c6963ef | 2005-06-17 17:42:07 -0700 | [diff] [blame] | 166 | dma_addr_t dma; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 167 | unsigned long time_stamp; |
| 168 | uint16_t length; |
| 169 | uint16_t next_to_watch; |
| 170 | }; |
| 171 | |
Mallikarjuna R Chilakala | e4c811c | 2005-10-04 07:05:44 -0400 | [diff] [blame] | 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]; }; |
Malli Chilakala | 2d7edb9 | 2005-04-28 19:43:52 -0700 | [diff] [blame] | 174 | |
Mallikarjuna R Chilakala | 581d708 | 2005-10-04 07:01:55 -0400 | [diff] [blame] | 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 | |
Mallikarjuna R Chilakala | 581d708 | 2005-10-04 07:01:55 -0400 | [diff] [blame] | 191 | spinlock_t tx_lock; |
| 192 | uint16_t tdh; |
| 193 | uint16_t tdt; |
| 194 | uint64_t pkt; |
Jeff Kirsher | fd80324 | 2005-12-13 00:06:22 -0500 | [diff] [blame] | 195 | |
| 196 | boolean_t last_tx_tso; |
| 197 | |
Mallikarjuna R Chilakala | 581d708 | 2005-10-04 07:01:55 -0400 | [diff] [blame] | 198 | }; |
| 199 | |
| 200 | struct e1000_rx_ring { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 201 | /* pointer to the descriptor ring memory */ |
| 202 | void *desc; |
| 203 | /* physical address of the descriptor ring */ |
| 204 | dma_addr_t dma; |
| 205 | /* length of descriptor ring in bytes */ |
| 206 | unsigned int size; |
| 207 | /* number of descriptors in the ring */ |
| 208 | unsigned int count; |
| 209 | /* next descriptor to associate a buffer with */ |
| 210 | unsigned int next_to_use; |
| 211 | /* next descriptor to check for DD status bit */ |
| 212 | unsigned int next_to_clean; |
| 213 | /* array of buffer information structs */ |
| 214 | struct e1000_buffer *buffer_info; |
Malli Chilakala | 2d7edb9 | 2005-04-28 19:43:52 -0700 | [diff] [blame] | 215 | /* arrays of page information for packet split */ |
| 216 | struct e1000_ps_page *ps_page; |
| 217 | struct e1000_ps_page_dma *ps_page_dma; |
Mallikarjuna R Chilakala | 581d708 | 2005-10-04 07:01:55 -0400 | [diff] [blame] | 218 | |
| 219 | uint16_t rdh; |
| 220 | uint16_t rdt; |
| 221 | uint64_t pkt; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 222 | }; |
| 223 | |
| 224 | #define E1000_DESC_UNUSED(R) \ |
| 225 | ((((R)->next_to_clean > (R)->next_to_use) ? 0 : (R)->count) + \ |
| 226 | (R)->next_to_clean - (R)->next_to_use - 1) |
| 227 | |
Malli Chilakala | 2d7edb9 | 2005-04-28 19:43:52 -0700 | [diff] [blame] | 228 | #define E1000_RX_DESC_PS(R, i) \ |
| 229 | (&(((union e1000_rx_desc_packet_split *)((R).desc))[i])) |
| 230 | #define E1000_RX_DESC_EXT(R, i) \ |
| 231 | (&(((union e1000_rx_desc_extended *)((R).desc))[i])) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 232 | #define E1000_GET_DESC(R, i, type) (&(((struct type *)((R).desc))[i])) |
| 233 | #define E1000_RX_DESC(R, i) E1000_GET_DESC(R, i, e1000_rx_desc) |
| 234 | #define E1000_TX_DESC(R, i) E1000_GET_DESC(R, i, e1000_tx_desc) |
| 235 | #define E1000_CONTEXT_DESC(R, i) E1000_GET_DESC(R, i, e1000_context_desc) |
| 236 | |
| 237 | /* board specific private data structure */ |
| 238 | |
| 239 | struct e1000_adapter { |
| 240 | struct timer_list tx_fifo_stall_timer; |
| 241 | struct timer_list watchdog_timer; |
| 242 | struct timer_list phy_info_timer; |
| 243 | struct vlan_group *vlgrp; |
Malli Chilakala | 2d7edb9 | 2005-04-28 19:43:52 -0700 | [diff] [blame] | 244 | uint16_t mng_vlan_id; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 245 | uint32_t bd_number; |
| 246 | uint32_t rx_buffer_len; |
| 247 | uint32_t part_num; |
| 248 | uint32_t wol; |
| 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 | atomic_t irq_sem; |
| 255 | struct work_struct tx_timeout_task; |
| 256 | struct work_struct watchdog_task; |
| 257 | uint8_t fc_autoneg; |
| 258 | |
| 259 | struct timer_list blink_timer; |
| 260 | unsigned long led_status; |
| 261 | |
| 262 | /* TX */ |
Mallikarjuna R Chilakala | 581d708 | 2005-10-04 07:01:55 -0400 | [diff] [blame] | 263 | struct e1000_tx_ring *tx_ring; /* One per active queue */ |
| 264 | #ifdef CONFIG_E1000_MQ |
| 265 | struct e1000_tx_ring **cpu_tx_ring; /* per-cpu */ |
| 266 | #endif |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 267 | uint32_t txd_cmd; |
| 268 | uint32_t tx_int_delay; |
| 269 | uint32_t tx_abs_int_delay; |
| 270 | uint32_t gotcl; |
| 271 | uint64_t gotcl_old; |
| 272 | uint64_t tpt_old; |
| 273 | uint64_t colc_old; |
| 274 | uint32_t tx_fifo_head; |
| 275 | uint32_t tx_head_addr; |
| 276 | uint32_t tx_fifo_size; |
| 277 | atomic_t tx_fifo_stall; |
| 278 | boolean_t pcix_82544; |
| 279 | boolean_t detect_tx_hung; |
| 280 | |
| 281 | /* RX */ |
Malli Chilakala | 2d7edb9 | 2005-04-28 19:43:52 -0700 | [diff] [blame] | 282 | #ifdef CONFIG_E1000_NAPI |
Mallikarjuna R Chilakala | 581d708 | 2005-10-04 07:01:55 -0400 | [diff] [blame] | 283 | boolean_t (*clean_rx) (struct e1000_adapter *adapter, |
| 284 | struct e1000_rx_ring *rx_ring, |
| 285 | int *work_done, int work_to_do); |
Malli Chilakala | 2d7edb9 | 2005-04-28 19:43:52 -0700 | [diff] [blame] | 286 | #else |
Mallikarjuna R Chilakala | 581d708 | 2005-10-04 07:01:55 -0400 | [diff] [blame] | 287 | boolean_t (*clean_rx) (struct e1000_adapter *adapter, |
| 288 | struct e1000_rx_ring *rx_ring); |
Malli Chilakala | 2d7edb9 | 2005-04-28 19:43:52 -0700 | [diff] [blame] | 289 | #endif |
Mallikarjuna R Chilakala | 581d708 | 2005-10-04 07:01:55 -0400 | [diff] [blame] | 290 | void (*alloc_rx_buf) (struct e1000_adapter *adapter, |
| 291 | struct e1000_rx_ring *rx_ring); |
| 292 | struct e1000_rx_ring *rx_ring; /* One per active queue */ |
| 293 | #ifdef CONFIG_E1000_NAPI |
| 294 | struct net_device *polling_netdev; /* One per active queue */ |
| 295 | #endif |
| 296 | #ifdef CONFIG_E1000_MQ |
| 297 | struct net_device **cpu_netdev; /* per-cpu */ |
| 298 | struct call_async_data_struct rx_sched_call_data; |
| 299 | int cpu_for_queue[4]; |
| 300 | #endif |
| 301 | int num_queues; |
| 302 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 303 | uint64_t hw_csum_err; |
| 304 | uint64_t hw_csum_good; |
Mallikarjuna R Chilakala | e4c811c | 2005-10-04 07:05:44 -0400 | [diff] [blame] | 305 | uint64_t rx_hdr_split; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 306 | uint32_t rx_int_delay; |
| 307 | uint32_t rx_abs_int_delay; |
| 308 | boolean_t rx_csum; |
Mallikarjuna R Chilakala | e4c811c | 2005-10-04 07:05:44 -0400 | [diff] [blame] | 309 | unsigned int rx_ps_pages; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 310 | uint32_t gorcl; |
| 311 | uint64_t gorcl_old; |
Malli Chilakala | 2d7edb9 | 2005-04-28 19:43:52 -0700 | [diff] [blame] | 312 | uint16_t rx_ps_bsize0; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 313 | |
| 314 | /* Interrupt Throttle Rate */ |
| 315 | uint32_t itr; |
| 316 | |
| 317 | /* OS defined structs */ |
| 318 | struct net_device *netdev; |
| 319 | struct pci_dev *pdev; |
| 320 | struct net_device_stats net_stats; |
| 321 | |
| 322 | /* structs defined in e1000_hw.h */ |
| 323 | struct e1000_hw hw; |
| 324 | struct e1000_hw_stats stats; |
| 325 | struct e1000_phy_info phy_info; |
| 326 | struct e1000_phy_stats phy_stats; |
| 327 | |
| 328 | uint32_t test_icr; |
Mallikarjuna R Chilakala | 581d708 | 2005-10-04 07:01:55 -0400 | [diff] [blame] | 329 | struct e1000_tx_ring test_tx_ring; |
| 330 | struct e1000_rx_ring test_rx_ring; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 331 | |
| 332 | |
| 333 | int msg_enable; |
Malli Chilakala | fa4f7ef | 2005-04-28 19:39:13 -0700 | [diff] [blame] | 334 | #ifdef CONFIG_PCI_MSI |
| 335 | boolean_t have_msi; |
| 336 | #endif |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 337 | }; |
| 338 | #endif /* _E1000_H_ */ |