1

/*******************************************************************************

     2

     3

     4

  Copyright(c) 1999 - 2005 Intel Corporation. All rights reserved.

     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>

    75

    76

#define BAR_0		0

    77

#define BAR_1		1

    78

#define BAR_5		5

    79

    80

#define INTEL_E1000_ETHERNET_DEVICE(device_id) {\

    81

	PCI_DEVICE(PCI_VENDOR_ID_INTEL, device_id)}

    82

    83

struct e1000_adapter;

    84

    85

#include "e1000_hw.h"

    86

    87

#ifdef DBG

    88

#define E1000_DBG(args...) printk(KERN_DEBUG "e1000: " args)

    89

#else

    90

#define E1000_DBG(args...)

    91

#endif

    92

    93

#define E1000_ERR(args...) printk(KERN_ERR "e1000: " args)

    94

    95

#define PFX "e1000: "

    96

#define DPRINTK(nlevel, klevel, fmt, args...) \

    97

	(void)((NETIF_MSG_##nlevel & adapter->msg_enable) && \

    98

	printk(KERN_##klevel PFX "%s: %s: " fmt, adapter->netdev->name, \

    99

		__FUNCTION__ , ## args))

   100

   101

#define E1000_MAX_INTR 10

   102

   103

/* TX/RX descriptor defines */

   104

#define E1000_DEFAULT_TXD                  256

   105

#define E1000_MAX_TXD                      256

   106

#define E1000_MIN_TXD                       80

   107

#define E1000_MAX_82544_TXD               4096

   108

   109

#define E1000_DEFAULT_RXD                  256

   110

#define E1000_MAX_RXD                      256

   111

#define E1000_MIN_RXD                       80

   112

#define E1000_MAX_82544_RXD               4096

   113

   114

/* Supported Rx Buffer Sizes */

   115

#define E1000_RXBUFFER_128   128    /* Used for packet split */

   116

#define E1000_RXBUFFER_256   256    /* Used for packet split */

   117

#define E1000_RXBUFFER_2048  2048

   118

#define E1000_RXBUFFER_4096  4096

   119

#define E1000_RXBUFFER_8192  8192

   120

#define E1000_RXBUFFER_16384 16384

   121

   122

/* SmartSpeed delimiters */

   123

#define E1000_SMARTSPEED_DOWNSHIFT 3

   124

#define E1000_SMARTSPEED_MAX       15

   125

   126

/* Packet Buffer allocations */

   127

#define E1000_PBA_BYTES_SHIFT 0xA

   128

#define E1000_TX_HEAD_ADDR_SHIFT 7

   129

#define E1000_PBA_TX_MASK 0xFFFF0000

   130

   131

/* Flow Control Watermarks */

   132

#define E1000_FC_HIGH_DIFF 0x1638  /* High: 5688 bytes below Rx FIFO size */

   133

#define E1000_FC_LOW_DIFF 0x1640   /* Low:  5696 bytes below Rx FIFO size */

   134

   135

#define E1000_FC_PAUSE_TIME 0x0680 /* 858 usec */

   136

   137

/* How many Tx Descriptors do we need to call netif_wake_queue ? */

   138

#define E1000_TX_QUEUE_WAKE	16

   139

/* How many Rx Buffers do we bundle into one write to the hardware ? */

   140

#define E1000_RX_BUFFER_WRITE	16	/* Must be power of 2 */

   141

   142

#define AUTO_ALL_MODES            0

   143

#define E1000_EEPROM_82544_APM    0x0004

   144

#define E1000_EEPROM_APME         0x0400

   145

   146

#ifndef E1000_MASTER_SLAVE

   147

/* Switch to override PHY master/slave setting */

   148

#define E1000_MASTER_SLAVE	e1000_ms_hw_default

   149

#endif

   150

   151

#define E1000_MNG_VLAN_NONE -1

   152

/* Number of packet split data buffers (not including the header buffer) */

   153

#define PS_PAGE_BUFFERS MAX_PS_BUFFERS-1

   154

   155

/* only works for sizes that are powers of 2 */

   156

#define E1000_ROUNDUP(i, size) ((i) = (((i) + (size) - 1) & ~((size) - 1)))

   157

   158

/* wrapper around a pointer to a socket buffer,

   159

 * so a DMA handle can be stored along with the buffer */

   160

struct e1000_buffer {

   161

	struct sk_buff *skb;

   162

	dma_addr_t dma;

   163

	unsigned long time_stamp;

   164

	uint16_t length;

   165

	uint16_t next_to_watch;

   166

};

   167

   168

struct e1000_ps_page { struct page *ps_page[MAX_PS_BUFFERS]; };

   169

struct e1000_ps_page_dma { uint64_t ps_page_dma[MAX_PS_BUFFERS]; };

   170

   171

struct e1000_desc_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_buffer *buffer_info;

   186

	/* arrays of page information for packet split */

   187

	struct e1000_ps_page *ps_page;

   188

	struct e1000_ps_page_dma *ps_page_dma;

   189

};

   190

   191

#define E1000_DESC_UNUSED(R) \

   192

	((((R)->next_to_clean > (R)->next_to_use) ? 0 : (R)->count) + \

   193

	(R)->next_to_clean - (R)->next_to_use - 1)

   194

   195

#define E1000_RX_DESC_PS(R, i)	    \

   196

	(&(((union e1000_rx_desc_packet_split *)((R).desc))[i]))

   197

#define E1000_RX_DESC_EXT(R, i)	    \

   198

	(&(((union e1000_rx_desc_extended *)((R).desc))[i]))

   199

#define E1000_GET_DESC(R, i, type)	(&(((struct type *)((R).desc))[i]))

   200

#define E1000_RX_DESC(R, i)		E1000_GET_DESC(R, i, e1000_rx_desc)

   201

#define E1000_TX_DESC(R, i)		E1000_GET_DESC(R, i, e1000_tx_desc)

   202

#define E1000_CONTEXT_DESC(R, i)	E1000_GET_DESC(R, i, e1000_context_desc)

   203

   204

/* board specific private data structure */

   205

   206

struct e1000_adapter {

   207

	struct timer_list tx_fifo_stall_timer;

   208

	struct timer_list watchdog_timer;

   209

	struct timer_list phy_info_timer;

   210

	struct vlan_group *vlgrp;

   211

    	uint16_t mng_vlan_id;

   212

	uint32_t bd_number;

   213

	uint32_t rx_buffer_len;

   214

	uint32_t part_num;

   215

	uint32_t wol;

   216

	uint32_t smartspeed;

   217

	uint32_t en_mng_pt;

   218

	uint16_t link_speed;

   219

	uint16_t link_duplex;

   220

	spinlock_t stats_lock;

   221

	atomic_t irq_sem;

   222

	struct work_struct tx_timeout_task;

   223

	struct work_struct watchdog_task;

   224

	uint8_t fc_autoneg;

   225

   226

	struct timer_list blink_timer;

   227

	unsigned long led_status;

   228

   229

	/* TX */

   230

	struct e1000_desc_ring tx_ring;

   231

	struct e1000_buffer previous_buffer_info;

   232

	spinlock_t tx_lock;

   233

	uint32_t txd_cmd;

   234

	uint32_t tx_int_delay;

   235

	uint32_t tx_abs_int_delay;

   236

	uint32_t gotcl;

   237

	uint64_t gotcl_old;

   238

	uint64_t tpt_old;

   239

	uint64_t colc_old;

   240

	uint32_t tx_fifo_head;

   241

	uint32_t tx_head_addr;

   242

	uint32_t tx_fifo_size;

   243

	atomic_t tx_fifo_stall;

   244

	boolean_t pcix_82544;

   245

	boolean_t detect_tx_hung;

   246

   247

	/* RX */

   248

#ifdef CONFIG_E1000_NAPI

   249

	boolean_t (*clean_rx) (struct e1000_adapter *adapter, int *work_done,

   250

			  int work_to_do);

   251

#else

   252

	boolean_t (*clean_rx) (struct e1000_adapter *adapter);

   253

#endif

   254

	void (*alloc_rx_buf) (struct e1000_adapter *adapter);

   255

	struct e1000_desc_ring rx_ring;

   256

	uint64_t hw_csum_err;

   257

	uint64_t hw_csum_good;

   258

	uint32_t rx_int_delay;

   259

	uint32_t rx_abs_int_delay;

   260

	boolean_t rx_csum;

   261

	boolean_t rx_ps;

   262

	uint32_t gorcl;

   263

	uint64_t gorcl_old;

   264

	uint16_t rx_ps_bsize0;

   265

   266

	/* Interrupt Throttle Rate */

   267

	uint32_t itr;

   268

   269

	/* OS defined structs */

   270

	struct net_device *netdev;

   271

	struct pci_dev *pdev;

   272

	struct net_device_stats net_stats;

   273

   274

	/* structs defined in e1000_hw.h */

   275

	struct e1000_hw hw;

   276

	struct e1000_hw_stats stats;

   277

	struct e1000_phy_info phy_info;

   278

	struct e1000_phy_stats phy_stats;

   279

   280

	uint32_t test_icr;

   281

	struct e1000_desc_ring test_tx_ring;

   282

	struct e1000_desc_ring test_rx_ring;

   283

   284

   285

	int msg_enable;

   286

#ifdef CONFIG_PCI_MSI

   287

	boolean_t have_msi;

   288

#endif

   289

};

   290

#endif /* _E1000_H_ */