352 lines · c
1/* SPDX-License-Identifier: GPL-2.0 */2/* Copyright(c) 1999 - 2006 Intel Corporation. */3 4/* Linux PRO/1000 Ethernet Driver main header file */5 6#ifndef _E1000_H_7#define _E1000_H_8 9#include <linux/stddef.h>10#include <linux/module.h>11#include <linux/types.h>12#include <asm/byteorder.h>13#include <linux/mm.h>14#include <linux/errno.h>15#include <linux/ioport.h>16#include <linux/pci.h>17#include <linux/kernel.h>18#include <linux/netdevice.h>19#include <linux/etherdevice.h>20#include <linux/skbuff.h>21#include <linux/delay.h>22#include <linux/timer.h>23#include <linux/slab.h>24#include <linux/vmalloc.h>25#include <linux/interrupt.h>26#include <linux/string.h>27#include <linux/pagemap.h>28#include <linux/dma-mapping.h>29#include <linux/bitops.h>30#include <asm/io.h>31#include <asm/irq.h>32#include <linux/capability.h>33#include <linux/in.h>34#include <linux/ip.h>35#include <linux/ipv6.h>36#include <linux/tcp.h>37#include <linux/udp.h>38#include <net/pkt_sched.h>39#include <linux/list.h>40#include <linux/reboot.h>41#include <net/checksum.h>42#include <linux/mii.h>43#include <linux/ethtool.h>44#include <linux/if_vlan.h>45 46#define BAR_0 047#define BAR_1 148 49#define INTEL_E1000_ETHERNET_DEVICE(device_id) {\50 PCI_DEVICE(PCI_VENDOR_ID_INTEL, device_id)}51 52struct e1000_adapter;53 54#include "e1000_hw.h"55 56#define E1000_MAX_INTR 1057 58/*59 * Count for polling __E1000_RESET condition every 10-20msec.60 */61#define E1000_CHECK_RESET_COUNT 5062 63/* TX/RX descriptor defines */64#define E1000_DEFAULT_TXD 25665#define E1000_MAX_TXD 25666#define E1000_MIN_TXD 4867#define E1000_MAX_82544_TXD 409668 69#define E1000_DEFAULT_RXD 25670#define E1000_MAX_RXD 25671#define E1000_MIN_RXD 4872#define E1000_MAX_82544_RXD 409673 74#define E1000_MIN_ITR_USECS 10 /* 100000 irq/sec */75#define E1000_MAX_ITR_USECS 10000 /* 100 irq/sec */76 77/* this is the size past which hardware will drop packets when setting LPE=0 */78#define MAXIMUM_ETHERNET_VLAN_SIZE 152279 80/* Supported Rx Buffer Sizes */81#define E1000_RXBUFFER_128 128 /* Used for packet split */82#define E1000_RXBUFFER_256 256 /* Used for packet split */83#define E1000_RXBUFFER_512 51284#define E1000_RXBUFFER_1024 102485#define E1000_RXBUFFER_2048 204886#define E1000_RXBUFFER_4096 409687#define E1000_RXBUFFER_8192 819288#define E1000_RXBUFFER_16384 1638489 90/* SmartSpeed delimiters */91#define E1000_SMARTSPEED_DOWNSHIFT 392#define E1000_SMARTSPEED_MAX 1593 94/* Packet Buffer allocations */95#define E1000_PBA_BYTES_SHIFT 0xA96#define E1000_TX_HEAD_ADDR_SHIFT 797#define E1000_PBA_TX_MASK 0xFFFF000098 99/* Flow Control Watermarks */100#define E1000_FC_HIGH_DIFF 0x1638 /* High: 5688 bytes below Rx FIFO size */101#define E1000_FC_LOW_DIFF 0x1640 /* Low: 5696 bytes below Rx FIFO size */102 103#define E1000_FC_PAUSE_TIME 0xFFFF /* pause for the max or until send xon */104 105/* How many Tx Descriptors do we need to call netif_wake_queue ? */106#define E1000_TX_QUEUE_WAKE 16107/* How many Rx Buffers do we bundle into one write to the hardware ? */108#define E1000_RX_BUFFER_WRITE 16 /* Must be power of 2 */109 110#define AUTO_ALL_MODES 0111#define E1000_EEPROM_82544_APM 0x0004112#define E1000_EEPROM_APME 0x0400113 114#ifndef E1000_MASTER_SLAVE115/* Switch to override PHY master/slave setting */116#define E1000_MASTER_SLAVE e1000_ms_hw_default117#endif118 119#define E1000_MNG_VLAN_NONE (-1)120 121/* wrapper around a pointer to a socket buffer,122 * so a DMA handle can be stored along with the buffer123 */124struct e1000_tx_buffer {125 struct sk_buff *skb;126 dma_addr_t dma;127 unsigned long time_stamp;128 u16 length;129 u16 next_to_watch;130 bool mapped_as_page;131 unsigned short segs;132 unsigned int bytecount;133};134 135struct e1000_rx_buffer {136 union {137 struct page *page; /* jumbo: alloc_page */138 u8 *data; /* else, netdev_alloc_frag */139 } rxbuf;140 dma_addr_t dma;141};142 143struct e1000_tx_ring {144 /* pointer to the descriptor ring memory */145 void *desc;146 /* physical address of the descriptor ring */147 dma_addr_t dma;148 /* length of descriptor ring in bytes */149 unsigned int size;150 /* number of descriptors in the ring */151 unsigned int count;152 /* next descriptor to associate a buffer with */153 unsigned int next_to_use;154 /* next descriptor to check for DD status bit */155 unsigned int next_to_clean;156 /* array of buffer information structs */157 struct e1000_tx_buffer *buffer_info;158 159 u16 tdh;160 u16 tdt;161 bool last_tx_tso;162};163 164struct e1000_rx_ring {165 /* pointer to the descriptor ring memory */166 void *desc;167 /* physical address of the descriptor ring */168 dma_addr_t dma;169 /* length of descriptor ring in bytes */170 unsigned int size;171 /* number of descriptors in the ring */172 unsigned int count;173 /* next descriptor to associate a buffer with */174 unsigned int next_to_use;175 /* next descriptor to check for DD status bit */176 unsigned int next_to_clean;177 /* array of buffer information structs */178 struct e1000_rx_buffer *buffer_info;179 struct sk_buff *rx_skb_top;180 181 /* cpu for rx queue */182 int cpu;183 184 u16 rdh;185 u16 rdt;186};187 188#define E1000_DESC_UNUSED(R) \189({ \190 unsigned int clean = smp_load_acquire(&(R)->next_to_clean); \191 unsigned int use = READ_ONCE((R)->next_to_use); \192 (clean > use ? 0 : (R)->count) + clean - use - 1; \193})194 195#define E1000_RX_DESC_EXT(R, i) \196 (&(((union e1000_rx_desc_extended *)((R).desc))[i]))197#define E1000_GET_DESC(R, i, type) (&(((struct type *)((R).desc))[i]))198#define E1000_RX_DESC(R, i) E1000_GET_DESC(R, i, e1000_rx_desc)199#define E1000_TX_DESC(R, i) E1000_GET_DESC(R, i, e1000_tx_desc)200#define E1000_CONTEXT_DESC(R, i) E1000_GET_DESC(R, i, e1000_context_desc)201 202/* board specific private data structure */203 204struct e1000_adapter {205 unsigned long active_vlans[BITS_TO_LONGS(VLAN_N_VID)];206 u16 mng_vlan_id;207 u32 bd_number;208 u32 rx_buffer_len;209 u32 wol;210 u32 smartspeed;211 u32 en_mng_pt;212 u16 link_speed;213 u16 link_duplex;214 spinlock_t stats_lock;215 unsigned int total_tx_bytes;216 unsigned int total_tx_packets;217 unsigned int total_rx_bytes;218 unsigned int total_rx_packets;219 /* Interrupt Throttle Rate */220 u32 itr;221 u32 itr_setting;222 u16 tx_itr;223 u16 rx_itr;224 225 u8 fc_autoneg;226 227 /* TX */228 struct e1000_tx_ring *tx_ring; /* One per active queue */229 unsigned int restart_queue;230 u32 txd_cmd;231 u32 tx_int_delay;232 u32 tx_abs_int_delay;233 u32 gotcl;234 u64 gotcl_old;235 u64 tpt_old;236 u64 colc_old;237 u32 tx_timeout_count;238 u32 tx_fifo_head;239 u32 tx_head_addr;240 u32 tx_fifo_size;241 u8 tx_timeout_factor;242 atomic_t tx_fifo_stall;243 bool pcix_82544;244 bool detect_tx_hung;245 bool dump_buffers;246 247 /* RX */248 bool (*clean_rx)(struct e1000_adapter *adapter,249 struct e1000_rx_ring *rx_ring,250 int *work_done, int work_to_do);251 void (*alloc_rx_buf)(struct e1000_adapter *adapter,252 struct e1000_rx_ring *rx_ring,253 int cleaned_count);254 struct e1000_rx_ring *rx_ring; /* One per active queue */255 struct napi_struct napi;256 257 int num_tx_queues;258 int num_rx_queues;259 260 u64 hw_csum_err;261 u64 hw_csum_good;262 u32 alloc_rx_buff_failed;263 u32 rx_int_delay;264 u32 rx_abs_int_delay;265 bool rx_csum;266 u32 gorcl;267 u64 gorcl_old;268 269 /* OS defined structs */270 struct net_device *netdev;271 struct pci_dev *pdev;272 273 /* structs defined in e1000_hw.h */274 struct e1000_hw hw;275 struct e1000_hw_stats stats;276 struct e1000_phy_info phy_info;277 struct e1000_phy_stats phy_stats;278 279 u32 test_icr;280 struct e1000_tx_ring test_tx_ring;281 struct e1000_rx_ring test_rx_ring;282 283 int msg_enable;284 285 /* to not mess up cache alignment, always add to the bottom */286 bool tso_force;287 bool smart_power_down; /* phy smart power down */288 bool quad_port_a;289 unsigned long flags;290 u32 eeprom_wol;291 292 /* for ioport free */293 int bars;294 int need_ioport;295 296 bool discarding;297 298 struct work_struct reset_task;299 struct delayed_work watchdog_task;300 struct delayed_work fifo_stall_task;301 struct delayed_work phy_info_task;302};303 304enum e1000_state_t {305 __E1000_TESTING,306 __E1000_RESETTING,307 __E1000_DOWN,308 __E1000_DISABLED309};310 311#undef pr_fmt312#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt313 314struct net_device *e1000_get_hw_dev(struct e1000_hw *hw);315#define e_dbg(format, arg...) \316 netdev_dbg(e1000_get_hw_dev(hw), format, ## arg)317#define e_err(msglvl, format, arg...) \318 netif_err(adapter, msglvl, adapter->netdev, format, ## arg)319#define e_info(msglvl, format, arg...) \320 netif_info(adapter, msglvl, adapter->netdev, format, ## arg)321#define e_warn(msglvl, format, arg...) \322 netif_warn(adapter, msglvl, adapter->netdev, format, ## arg)323#define e_notice(msglvl, format, arg...) \324 netif_notice(adapter, msglvl, adapter->netdev, format, ## arg)325#define e_dev_info(format, arg...) \326 dev_info(&adapter->pdev->dev, format, ## arg)327#define e_dev_warn(format, arg...) \328 dev_warn(&adapter->pdev->dev, format, ## arg)329#define e_dev_err(format, arg...) \330 dev_err(&adapter->pdev->dev, format, ## arg)331 332extern char e1000_driver_name[];333 334int e1000_open(struct net_device *netdev);335int e1000_close(struct net_device *netdev);336int e1000_up(struct e1000_adapter *adapter);337void e1000_down(struct e1000_adapter *adapter);338void e1000_reinit_locked(struct e1000_adapter *adapter);339void e1000_reset(struct e1000_adapter *adapter);340int e1000_set_spd_dplx(struct e1000_adapter *adapter, u32 spd, u8 dplx);341int e1000_setup_all_rx_resources(struct e1000_adapter *adapter);342int e1000_setup_all_tx_resources(struct e1000_adapter *adapter);343void e1000_free_all_rx_resources(struct e1000_adapter *adapter);344void e1000_free_all_tx_resources(struct e1000_adapter *adapter);345void e1000_update_stats(struct e1000_adapter *adapter);346bool e1000_has_link(struct e1000_adapter *adapter);347void e1000_power_up_phy(struct e1000_adapter *);348void e1000_set_ethtool_ops(struct net_device *netdev);349void e1000_check_options(struct e1000_adapter *adapter);350 351#endif /* _E1000_H_ */352