1/* SPDX-License-Identifier: GPL-2.0 */
  2/* Copyright(c) 1999 - 2008 Intel Corporation. */
  3
  4#ifndef _IXGB_H_
  5#define _IXGB_H_
  6
  7#include <linux/stddef.h>
  8#include <linux/module.h>
  9#include <linux/types.h>
 10#include <asm/byteorder.h>
 11#include <linux/mm.h>
 12#include <linux/errno.h>
 13#include <linux/ioport.h>
 14#include <linux/pci.h>
 15#include <linux/kernel.h>
 16#include <linux/netdevice.h>
 17#include <linux/etherdevice.h>
 18#include <linux/skbuff.h>
 19#include <linux/delay.h>
 20#include <linux/timer.h>
 21#include <linux/slab.h>
 22#include <linux/vmalloc.h>
 23#include <linux/interrupt.h>
 24#include <linux/string.h>
 25#include <linux/pagemap.h>
 26#include <linux/dma-mapping.h>
 27#include <linux/bitops.h>
 28#include <asm/io.h>
 29#include <asm/irq.h>
 30#include <linux/capability.h>
 31#include <linux/in.h>
 32#include <linux/ip.h>
 33#include <linux/tcp.h>
 34#include <linux/udp.h>
 35#include <net/pkt_sched.h>
 36#include <linux/list.h>
 37#include <linux/reboot.h>
 38#include <net/checksum.h>
 39
 40#include <linux/ethtool.h>
 41#include <linux/if_vlan.h>
 42
 43#define BAR_0		0
 44#define BAR_1		1
 45#define BAR_5		5
 46
 47struct ixgb_adapter;
 48#include "ixgb_hw.h"
 49#include "ixgb_ee.h"
 50#include "ixgb_ids.h"
 51
 52/* TX/RX descriptor defines */
 53#define DEFAULT_TXD      256
 54#define MAX_TXD         4096
 55#define MIN_TXD           64
 56
 57/* hardware cannot reliably support more than 512 descriptors owned by
 58 * hardware descriptor cache otherwise an unreliable ring under heavy
 59 * receive load may result */
 60#define DEFAULT_RXD      512
 61#define MAX_RXD          512
 62#define MIN_RXD           64
 63
 64/* Supported Rx Buffer Sizes */
 65#define IXGB_RXBUFFER_2048  2048
 66#define IXGB_RXBUFFER_4096  4096
 67#define IXGB_RXBUFFER_8192  8192
 68#define IXGB_RXBUFFER_16384 16384
 69
 70/* How many Rx Buffers do we bundle into one write to the hardware ? */
 71#define IXGB_RX_BUFFER_WRITE	8	/* Must be power of 2 */
 72
 73/* wrapper around a pointer to a socket buffer,
 74 * so a DMA handle can be stored along with the buffer */
 75struct ixgb_buffer {
 76	struct sk_buff *skb;
 77	dma_addr_t dma;
 78	unsigned long time_stamp;
 79	u16 length;
 80	u16 next_to_watch;
 81	u16 mapped_as_page;
 82};
 83
 84struct ixgb_desc_ring {
 85	/* pointer to the descriptor ring memory */
 86	void *desc;
 87	/* physical address of the descriptor ring */
 88	dma_addr_t dma;
 89	/* length of descriptor ring in bytes */
 90	unsigned int size;
 91	/* number of descriptors in the ring */
 92	unsigned int count;
 93	/* next descriptor to associate a buffer with */
 94	unsigned int next_to_use;
 95	/* next descriptor to check for DD status bit */
 96	unsigned int next_to_clean;
 97	/* array of buffer information structs */
 98	struct ixgb_buffer *buffer_info;
 99};
100
101#define IXGB_DESC_UNUSED(R) \
102	((((R)->next_to_clean > (R)->next_to_use) ? 0 : (R)->count) + \
103	(R)->next_to_clean - (R)->next_to_use - 1)
104
105#define IXGB_GET_DESC(R, i, type)	(&(((struct type *)((R).desc))[i]))
106#define IXGB_RX_DESC(R, i)		IXGB_GET_DESC(R, i, ixgb_rx_desc)
107#define IXGB_TX_DESC(R, i)		IXGB_GET_DESC(R, i, ixgb_tx_desc)
108#define IXGB_CONTEXT_DESC(R, i)	IXGB_GET_DESC(R, i, ixgb_context_desc)
109
110/* board specific private data structure */
111
112struct ixgb_adapter {
113	struct timer_list watchdog_timer;
114	unsigned long active_vlans[BITS_TO_LONGS(VLAN_N_VID)];
115	u32 bd_number;
116	u32 rx_buffer_len;
117	u32 part_num;
118	u16 link_speed;
119	u16 link_duplex;
120	struct work_struct tx_timeout_task;
121
122	/* TX */
123	struct ixgb_desc_ring tx_ring ____cacheline_aligned_in_smp;
124	unsigned int restart_queue;
125	unsigned long timeo_start;
126	u32 tx_cmd_type;
127	u64 hw_csum_tx_good;
128	u64 hw_csum_tx_error;
129	u32 tx_int_delay;
130	u32 tx_timeout_count;
131	bool tx_int_delay_enable;
132	bool detect_tx_hung;
133
134	/* RX */
135	struct ixgb_desc_ring rx_ring;
136	u64 hw_csum_rx_error;
137	u64 hw_csum_rx_good;
138	u32 rx_int_delay;
139	bool rx_csum;
140
141	/* OS defined structs */
142	struct napi_struct napi;
143	struct net_device *netdev;
144	struct pci_dev *pdev;
145
146	/* structs defined in ixgb_hw.h */
147	struct ixgb_hw hw;
148	u16 msg_enable;
149	struct ixgb_hw_stats stats;
150	u32 alloc_rx_buff_failed;
151	bool have_msi;
152	unsigned long flags;
153};
154
155enum ixgb_state_t {
156	/* TBD
157	__IXGB_TESTING,
158	__IXGB_RESETTING,
159	*/
160	__IXGB_DOWN
161};
162
163/* Exported from other modules */
164void ixgb_check_options(struct ixgb_adapter *adapter);
165void ixgb_set_ethtool_ops(struct net_device *netdev);
166extern char ixgb_driver_name[];
167extern const char ixgb_driver_version[];
168
169void ixgb_set_speed_duplex(struct net_device *netdev);
170
171int ixgb_up(struct ixgb_adapter *adapter);
172void ixgb_down(struct ixgb_adapter *adapter, bool kill_watchdog);
173void ixgb_reset(struct ixgb_adapter *adapter);
174int ixgb_setup_rx_resources(struct ixgb_adapter *adapter);
175int ixgb_setup_tx_resources(struct ixgb_adapter *adapter);
176void ixgb_free_rx_resources(struct ixgb_adapter *adapter);
177void ixgb_free_tx_resources(struct ixgb_adapter *adapter);
178void ixgb_update_stats(struct ixgb_adapter *adapter);
179
180
181#endif /* _IXGB_H_ */