1

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

     2

     3

  Intel PRO/1000 Linux driver

     4

  Copyright(c) 1999 - 2006 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

    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/module.h>

    37

#include <linux/types.h>

    38

#include <asm/byteorder.h>

    39

#include <linux/init.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

#ifdef NETIF_F_TSO6

    63

#include <linux/ipv6.h>

    64

#endif

    65

#include <linux/tcp.h>

    66

#include <linux/udp.h>

    67

#include <net/pkt_sched.h>

    68

#include <linux/list.h>

    69

#include <linux/reboot.h>

    70

#ifdef NETIF_F_TSO

    71

#include <net/checksum.h>

    72

#endif

    73

#include <linux/mii.h>

    74

#include <linux/ethtool.h>

    75

#include <linux/if_vlan.h>

    76

#include "../ecdev.h"

    77

    78

    79

#define BAR_0		0

    80

#define BAR_1		1

    81

#define BAR_5		5

    82

    83

#define INTEL_E1000_ETHERNET_DEVICE(device_id) {\

    84

	PCI_DEVICE(PCI_VENDOR_ID_INTEL, device_id)}

    85

    86

struct e1000_adapter;

    87

    88

#include "e1000_hw-2.6.20-ethercat.h"

    89

    90

#ifdef DBG

    91

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

    92

#else

    93

#define E1000_DBG(args...)

    94

#endif

    95

    96

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

    97

    98

#define PFX "ec_e1000: "

    99

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

   100

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

   101

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

   102

		__FUNCTION__ , ## args))

   103

   104

#define E1000_MAX_INTR 10

   105

   106

/* TX/RX descriptor defines */

   107

#define E1000_DEFAULT_TXD                  256

   108

#define E1000_MAX_TXD                      256

   109

#define E1000_MIN_TXD                       80

   110

#define E1000_MAX_82544_TXD               4096

   111

   112

#define E1000_DEFAULT_RXD                  256

   113

#define E1000_MAX_RXD                      256

   114

#define E1000_MIN_RXD                       80

   115

#define E1000_MAX_82544_RXD               4096

   116

   117

/* this is the size past which hardware will drop packets when setting LPE=0 */

   118

#define MAXIMUM_ETHERNET_VLAN_SIZE 1522

   119

   120

/* Supported Rx Buffer Sizes */

   121

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

   122

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

   123

#define E1000_RXBUFFER_512   512

   124

#define E1000_RXBUFFER_1024  1024

   125

#define E1000_RXBUFFER_2048  2048

   126

#define E1000_RXBUFFER_4096  4096

   127

#define E1000_RXBUFFER_8192  8192

   128

#define E1000_RXBUFFER_16384 16384

   129

   130

/* SmartSpeed delimiters */

   131

#define E1000_SMARTSPEED_DOWNSHIFT 3

   132

#define E1000_SMARTSPEED_MAX       15

   133

   134

/* Packet Buffer allocations */

   135

#define E1000_PBA_BYTES_SHIFT 0xA

   136

#define E1000_TX_HEAD_ADDR_SHIFT 7

   137

#define E1000_PBA_TX_MASK 0xFFFF0000

   138

   139

/* Flow Control Watermarks */

   140

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

   141

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

   142

   143

#define E1000_FC_PAUSE_TIME 0x0680 /* 858 usec */

   144

   145

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

   146

#define E1000_TX_QUEUE_WAKE	16

   147

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

   148

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

   149

   150

#define AUTO_ALL_MODES            0

   151

#define E1000_EEPROM_82544_APM    0x0004

   152

#define E1000_EEPROM_ICH8_APME    0x0004

   153

#define E1000_EEPROM_APME         0x0400

   154

   155

#ifndef E1000_MASTER_SLAVE

   156

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

   157

#define E1000_MASTER_SLAVE	e1000_ms_hw_default

   158

#endif

   159

   160

#define E1000_MNG_VLAN_NONE -1

   161

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

   162

#define PS_PAGE_BUFFERS MAX_PS_BUFFERS-1

   163

   164

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

   165

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

   166

   167

/* wrapper around a pointer to a socket buffer,

   168

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

   169

struct e1000_buffer {

   170

	struct sk_buff *skb;

   171

	dma_addr_t dma;

   172

	unsigned long time_stamp;

   173

	uint16_t length;

   174

	uint16_t next_to_watch;

   175

};

   176

   177

   178

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

   179

struct e1000_ps_page_dma { uint64_t ps_page_dma[PS_PAGE_BUFFERS]; };

   180

   181

struct e1000_tx_ring {

   182

	/* pointer to the descriptor ring memory */

   183

	void *desc;

   184

	/* physical address of the descriptor ring */

   185

	dma_addr_t dma;

   186

	/* length of descriptor ring in bytes */

   187

	unsigned int size;

   188

	/* number of descriptors in the ring */

   189

	unsigned int count;

   190

	/* next descriptor to associate a buffer with */

   191

	unsigned int next_to_use;

   192

	/* next descriptor to check for DD status bit */

   193

	unsigned int next_to_clean;

   194

	/* array of buffer information structs */

   195

	struct e1000_buffer *buffer_info;

   196

   197

	spinlock_t tx_lock;

   198

	uint16_t tdh;

   199

	uint16_t tdt;

   200

	boolean_t last_tx_tso;

   201

};

   202

   203

struct e1000_rx_ring {

   204

	/* pointer to the descriptor ring memory */

   205

	void *desc;

   206

	/* physical address of the descriptor ring */

   207

	dma_addr_t dma;

   208

	/* length of descriptor ring in bytes */

   209

	unsigned int size;

   210

	/* number of descriptors in the ring */

   211

	unsigned int count;

   212

	/* next descriptor to associate a buffer with */

   213

	unsigned int next_to_use;

   214

	/* next descriptor to check for DD status bit */

   215

	unsigned int next_to_clean;

   216

	/* array of buffer information structs */

   217

	struct e1000_buffer *buffer_info;

   218

	/* arrays of page information for packet split */

   219

	struct e1000_ps_page *ps_page;

   220

	struct e1000_ps_page_dma *ps_page_dma;

   221

   222

	/* cpu for rx queue */

   223

	int cpu;

   224

   225

	uint16_t rdh;

   226

	uint16_t rdt;

   227

};

   228

   229

#define E1000_DESC_UNUSED(R) \

   230

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

   231

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

   232

   233

#define E1000_RX_DESC_PS(R, i)	    \

   234

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

   235

#define E1000_RX_DESC_EXT(R, i)	    \

   236

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

   237

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

   238

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

   239

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

   240

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

   241

   242

/* board specific private data structure */

   243

   244

struct e1000_adapter {

   245

	struct timer_list tx_fifo_stall_timer;

   246

	struct timer_list watchdog_timer;

   247

	struct timer_list phy_info_timer;

   248

	struct vlan_group *vlgrp;

   249

	uint16_t mng_vlan_id;

   250

	uint32_t bd_number;

   251

	uint32_t rx_buffer_len;

   252

	uint32_t wol;

   253

	uint32_t smartspeed;

   254

	uint32_t en_mng_pt;

   255

	uint16_t link_speed;

   256

	uint16_t link_duplex;

   257

	spinlock_t stats_lock;

   258

#ifdef CONFIG_E1000_NAPI

   259

	spinlock_t tx_queue_lock;

   260

#endif

   261

	atomic_t irq_sem;

   262

	unsigned int detect_link;

   263

	unsigned int total_tx_bytes;

   264

	unsigned int total_tx_packets;

   265

	unsigned int total_rx_bytes;

   266

	unsigned int total_rx_packets;

   267

	/* Interrupt Throttle Rate */

   268

	uint32_t itr;

   269

	uint32_t itr_setting;

   270

	uint16_t tx_itr;

   271

	uint16_t rx_itr;

   272

   273

	struct work_struct reset_task;

   274

	uint8_t fc_autoneg;

   275

   276

	struct timer_list blink_timer;

   277

	unsigned long led_status;

   278

   279

	/* TX */

   280

	struct e1000_tx_ring *tx_ring;      /* One per active queue */

   281

	unsigned int restart_queue;

   282

	unsigned long tx_queue_len;

   283

	uint32_t txd_cmd;

   284

	uint32_t tx_int_delay;

   285

	uint32_t tx_abs_int_delay;

   286

	uint32_t gotcl;

   287

	uint64_t gotcl_old;

   288

	uint64_t tpt_old;

   289

	uint64_t colc_old;

   290

	uint32_t tx_timeout_count;

   291

	uint32_t tx_fifo_head;

   292

	uint32_t tx_head_addr;

   293

	uint32_t tx_fifo_size;

   294

	uint8_t  tx_timeout_factor;

   295

	atomic_t tx_fifo_stall;

   296

	boolean_t pcix_82544;

   297

	boolean_t detect_tx_hung;

   298

   299

	/* RX */

   300

#ifdef CONFIG_E1000_NAPI

   301

	boolean_t (*clean_rx) (struct e1000_adapter *adapter,

   302

			       struct e1000_rx_ring *rx_ring,

   303

			       int *work_done, int work_to_do);

   304

#else

   305

	boolean_t (*clean_rx) (struct e1000_adapter *adapter,

   306

			       struct e1000_rx_ring *rx_ring);

   307

#endif

   308

	void (*alloc_rx_buf) (struct e1000_adapter *adapter,

   309

			      struct e1000_rx_ring *rx_ring,

   310

				int cleaned_count);

   311

	struct e1000_rx_ring *rx_ring;      /* One per active queue */

   312

#ifdef CONFIG_E1000_NAPI

   313

	struct net_device *polling_netdev;  /* One per active queue */

   314

#endif

   315

	int num_tx_queues;

   316

	int num_rx_queues;

   317

   318

	uint64_t hw_csum_err;

   319

	uint64_t hw_csum_good;

   320

	uint64_t rx_hdr_split;

   321

	uint32_t alloc_rx_buff_failed;

   322

	uint32_t rx_int_delay;

   323

	uint32_t rx_abs_int_delay;

   324

	boolean_t rx_csum;

   325

	unsigned int rx_ps_pages;

   326

	uint32_t gorcl;

   327

	uint64_t gorcl_old;

   328

	uint16_t rx_ps_bsize0;

   329

   330

   331

	/* OS defined structs */

   332

	struct net_device *netdev;

   333

	struct pci_dev *pdev;

   334

	struct net_device_stats net_stats;

   335

   336

	/* structs defined in e1000_hw.h */

   337

	struct e1000_hw hw;

   338

	struct e1000_hw_stats stats;

   339

	struct e1000_phy_info phy_info;

   340

	struct e1000_phy_stats phy_stats;

   341

   342

	uint32_t test_icr;

   343

	struct e1000_tx_ring test_tx_ring;

   344

	struct e1000_rx_ring test_rx_ring;

   345

   346

   347

	uint32_t *config_space;

   348

	int msg_enable;

   349

#ifdef CONFIG_PCI_MSI

   350

	boolean_t have_msi;

   351

#endif

   352

	/* to not mess up cache alignment, always add to the bottom */

   353

#ifdef NETIF_F_TSO

   354

	boolean_t tso_force;

   355

#endif

   356

	boolean_t smart_power_down;	/* phy smart power down */

   357

	boolean_t quad_port_a;

   358

	unsigned long flags;

   359

	uint32_t eeprom_wol;

   360

   361

	ec_device_t *ecdev;

   362

    unsigned long ec_watchdog_jiffies;

   363

};

   364

   365

enum e1000_state_t {

   366

	__E1000_TESTING,

   367

	__E1000_RESETTING,

   368

	__E1000_DOWN

   369

};

   370

   371

#endif /* _E1000_H_ */