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