1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /******************************************************************************* 3 4 Intel PRO/1000 Linux driver 5 Copyright(c) 1999 - 2006 Intel Corporation. 6 7 This program is free software; you can redistribute it and/or modify it 8 under the terms and conditions of the GNU General Public License, 9 version 2, as published by the Free Software Foundation. 10 11 This program is distributed in the hope 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., 18 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA. 19 20 The full GNU General Public License is included in this distribution in 21 the file called "COPYING". 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/module.h> 38 #include <linux/types.h> 39 #include <asm/byteorder.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 #define E1000_MAX_INTR 10 85 86 /* 87 * Count for polling __E1000_RESET condition every 10-20msec. 88 */ 89 #define E1000_CHECK_RESET_COUNT 50 90 91 /* TX/RX descriptor defines */ 92 #define E1000_DEFAULT_TXD 256 93 #define E1000_MAX_TXD 256 94 #define E1000_MIN_TXD 48 95 #define E1000_MAX_82544_TXD 4096 96 97 #define E1000_DEFAULT_RXD 256 98 #define E1000_MAX_RXD 256 99 #define E1000_MIN_RXD 48 100 #define E1000_MAX_82544_RXD 4096 101 102 #define E1000_MIN_ITR_USECS 10 /* 100000 irq/sec */ 103 #define E1000_MAX_ITR_USECS 10000 /* 100 irq/sec */ 104 105 /* this is the size past which hardware will drop packets when setting LPE=0 */ 106 #define MAXIMUM_ETHERNET_VLAN_SIZE 1522 107 108 /* Supported Rx Buffer Sizes */ 109 #define E1000_RXBUFFER_128 128 /* Used for packet split */ 110 #define E1000_RXBUFFER_256 256 /* Used for packet split */ 111 #define E1000_RXBUFFER_512 512 112 #define E1000_RXBUFFER_1024 1024 113 #define E1000_RXBUFFER_2048 2048 114 #define E1000_RXBUFFER_4096 4096 115 #define E1000_RXBUFFER_8192 8192 116 #define E1000_RXBUFFER_16384 16384 117 118 /* SmartSpeed delimiters */ 119 #define E1000_SMARTSPEED_DOWNSHIFT 3 120 #define E1000_SMARTSPEED_MAX 15 121 122 /* Packet Buffer allocations */ 123 #define E1000_PBA_BYTES_SHIFT 0xA 124 #define E1000_TX_HEAD_ADDR_SHIFT 7 125 #define E1000_PBA_TX_MASK 0xFFFF0000 126 127 /* Flow Control Watermarks */ 128 #define E1000_FC_HIGH_DIFF 0x1638 /* High: 5688 bytes below Rx FIFO size */ 129 #define E1000_FC_LOW_DIFF 0x1640 /* Low: 5696 bytes below Rx FIFO size */ 130 131 #define E1000_FC_PAUSE_TIME 0xFFFF /* pause for the max or until send xon */ 132 133 /* How many Tx Descriptors do we need to call netif_wake_queue ? */ 134 #define E1000_TX_QUEUE_WAKE 16 135 /* How many Rx Buffers do we bundle into one write to the hardware ? */ 136 #define E1000_RX_BUFFER_WRITE 16 /* Must be power of 2 */ 137 138 #define AUTO_ALL_MODES 0 139 #define E1000_EEPROM_82544_APM 0x0004 140 #define E1000_EEPROM_APME 0x0400 141 142 #ifndef E1000_MASTER_SLAVE 143 /* Switch to override PHY master/slave setting */ 144 #define E1000_MASTER_SLAVE e1000_ms_hw_default 145 #endif 146 147 #define E1000_MNG_VLAN_NONE (-1) 148 149 /* wrapper around a pointer to a socket buffer, 150 * so a DMA handle can be stored along with the buffer 151 */ 152 struct e1000_tx_buffer { 153 struct sk_buff *skb; 154 dma_addr_t dma; 155 unsigned long time_stamp; 156 u16 length; 157 u16 next_to_watch; 158 bool mapped_as_page; 159 unsigned short segs; 160 unsigned int bytecount; 161 }; 162 163 struct e1000_rx_buffer { 164 union { 165 struct page *page; /* jumbo: alloc_page */ 166 u8 *data; /* else, netdev_alloc_frag */ 167 } rxbuf; 168 dma_addr_t dma; 169 }; 170 171 struct e1000_tx_ring { 172 /* pointer to the descriptor ring memory */ 173 void *desc; 174 /* physical address of the descriptor ring */ 175 dma_addr_t dma; 176 /* length of descriptor ring in bytes */ 177 unsigned int size; 178 /* number of descriptors in the ring */ 179 unsigned int count; 180 /* next descriptor to associate a buffer with */ 181 unsigned int next_to_use; 182 /* next descriptor to check for DD status bit */ 183 unsigned int next_to_clean; 184 /* array of buffer information structs */ 185 struct e1000_tx_buffer *buffer_info; 186 187 u16 tdh; 188 u16 tdt; 189 bool last_tx_tso; 190 }; 191 192 struct e1000_rx_ring { 193 /* pointer to the descriptor ring memory */ 194 void *desc; 195 /* physical address of the descriptor ring */ 196 dma_addr_t dma; 197 /* length of descriptor ring in bytes */ 198 unsigned int size; 199 /* number of descriptors in the ring */ 200 unsigned int count; 201 /* next descriptor to associate a buffer with */ 202 unsigned int next_to_use; 203 /* next descriptor to check for DD status bit */ 204 unsigned int next_to_clean; 205 /* array of buffer information structs */ 206 struct e1000_rx_buffer *buffer_info; 207 struct sk_buff *rx_skb_top; 208 209 /* cpu for rx queue */ 210 int cpu; 211 212 u16 rdh; 213 u16 rdt; 214 }; 215 216 #define E1000_DESC_UNUSED(R) \ 217 ({ \ 218 unsigned int clean = smp_load_acquire(&(R)->next_to_clean); \ 219 unsigned int use = READ_ONCE((R)->next_to_use); \ 220 (clean > use ? 0 : (R)->count) + clean - use - 1; \ 221 }) 222 223 #define E1000_RX_DESC_EXT(R, i) \ 224 (&(((union e1000_rx_desc_extended *)((R).desc))[i])) 225 #define E1000_GET_DESC(R, i, type) (&(((struct type *)((R).desc))[i])) 226 #define E1000_RX_DESC(R, i) E1000_GET_DESC(R, i, e1000_rx_desc) 227 #define E1000_TX_DESC(R, i) E1000_GET_DESC(R, i, e1000_tx_desc) 228 #define E1000_CONTEXT_DESC(R, i) E1000_GET_DESC(R, i, e1000_context_desc) 229 230 /* board specific private data structure */ 231 232 struct e1000_adapter { 233 unsigned long active_vlans[BITS_TO_LONGS(VLAN_N_VID)]; 234 u16 mng_vlan_id; 235 u32 bd_number; 236 u32 rx_buffer_len; 237 u32 wol; 238 u32 smartspeed; 239 u32 en_mng_pt; 240 u16 link_speed; 241 u16 link_duplex; 242 spinlock_t stats_lock; 243 unsigned int total_tx_bytes; 244 unsigned int total_tx_packets; 245 unsigned int total_rx_bytes; 246 unsigned int total_rx_packets; 247 /* Interrupt Throttle Rate */ 248 u32 itr; 249 u32 itr_setting; 250 u16 tx_itr; 251 u16 rx_itr; 252 253 u8 fc_autoneg; 254 255 /* TX */ 256 struct e1000_tx_ring *tx_ring; /* One per active queue */ 257 unsigned int restart_queue; 258 u32 txd_cmd; 259 u32 tx_int_delay; 260 u32 tx_abs_int_delay; 261 u32 gotcl; 262 u64 gotcl_old; 263 u64 tpt_old; 264 u64 colc_old; 265 u32 tx_timeout_count; 266 u32 tx_fifo_head; 267 u32 tx_head_addr; 268 u32 tx_fifo_size; 269 u8 tx_timeout_factor; 270 atomic_t tx_fifo_stall; 271 bool pcix_82544; 272 bool detect_tx_hung; 273 bool dump_buffers; 274 275 /* RX */ 276 bool (*clean_rx)(struct e1000_adapter *adapter, 277 struct e1000_rx_ring *rx_ring, 278 int *work_done, int work_to_do); 279 void (*alloc_rx_buf)(struct e1000_adapter *adapter, 280 struct e1000_rx_ring *rx_ring, 281 int cleaned_count); 282 struct e1000_rx_ring *rx_ring; /* One per active queue */ 283 struct napi_struct napi; 284 285 int num_tx_queues; 286 int num_rx_queues; 287 288 u64 hw_csum_err; 289 u64 hw_csum_good; 290 u32 alloc_rx_buff_failed; 291 u32 rx_int_delay; 292 u32 rx_abs_int_delay; 293 bool rx_csum; 294 u32 gorcl; 295 u64 gorcl_old; 296 297 /* OS defined structs */ 298 struct net_device *netdev; 299 struct pci_dev *pdev; 300 301 /* structs defined in e1000_hw.h */ 302 struct e1000_hw hw; 303 struct e1000_hw_stats stats; 304 struct e1000_phy_info phy_info; 305 struct e1000_phy_stats phy_stats; 306 307 u32 test_icr; 308 struct e1000_tx_ring test_tx_ring; 309 struct e1000_rx_ring test_rx_ring; 310 311 int msg_enable; 312 313 /* to not mess up cache alignment, always add to the bottom */ 314 bool tso_force; 315 bool smart_power_down; /* phy smart power down */ 316 bool quad_port_a; 317 unsigned long flags; 318 u32 eeprom_wol; 319 320 /* for ioport free */ 321 int bars; 322 int need_ioport; 323 324 bool discarding; 325 326 struct work_struct reset_task; 327 struct delayed_work watchdog_task; 328 struct delayed_work fifo_stall_task; 329 struct delayed_work phy_info_task; 330 }; 331 332 enum e1000_state_t { 333 __E1000_TESTING, 334 __E1000_RESETTING, 335 __E1000_DOWN, 336 __E1000_DISABLED 337 }; 338 339 #undef pr_fmt 340 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt 341 342 struct net_device *e1000_get_hw_dev(struct e1000_hw *hw); 343 #define e_dbg(format, arg...) \ 344 netdev_dbg(e1000_get_hw_dev(hw), format, ## arg) 345 #define e_err(msglvl, format, arg...) \ 346 netif_err(adapter, msglvl, adapter->netdev, format, ## arg) 347 #define e_info(msglvl, format, arg...) \ 348 netif_info(adapter, msglvl, adapter->netdev, format, ## arg) 349 #define e_warn(msglvl, format, arg...) \ 350 netif_warn(adapter, msglvl, adapter->netdev, format, ## arg) 351 #define e_notice(msglvl, format, arg...) \ 352 netif_notice(adapter, msglvl, adapter->netdev, format, ## arg) 353 #define e_dev_info(format, arg...) \ 354 dev_info(&adapter->pdev->dev, format, ## arg) 355 #define e_dev_warn(format, arg...) \ 356 dev_warn(&adapter->pdev->dev, format, ## arg) 357 #define e_dev_err(format, arg...) \ 358 dev_err(&adapter->pdev->dev, format, ## arg) 359 360 extern char e1000_driver_name[]; 361 extern const char e1000_driver_version[]; 362 363 int e1000_open(struct net_device *netdev); 364 int e1000_close(struct net_device *netdev); 365 int e1000_up(struct e1000_adapter *adapter); 366 void e1000_down(struct e1000_adapter *adapter); 367 void e1000_reinit_locked(struct e1000_adapter *adapter); 368 void e1000_reset(struct e1000_adapter *adapter); 369 int e1000_set_spd_dplx(struct e1000_adapter *adapter, u32 spd, u8 dplx); 370 int e1000_setup_all_rx_resources(struct e1000_adapter *adapter); 371 int e1000_setup_all_tx_resources(struct e1000_adapter *adapter); 372 void e1000_free_all_rx_resources(struct e1000_adapter *adapter); 373 void e1000_free_all_tx_resources(struct e1000_adapter *adapter); 374 void e1000_update_stats(struct e1000_adapter *adapter); 375 bool e1000_has_link(struct e1000_adapter *adapter); 376 void e1000_power_up_phy(struct e1000_adapter *); 377 void e1000_set_ethtool_ops(struct net_device *netdev); 378 void e1000_check_options(struct e1000_adapter *adapter); 379 char *e1000_get_hw_dev_name(struct e1000_hw *hw); 380 381 #endif /* _E1000_H_ */ 382