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

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

#include <net/checksum.h>

    69

#include <linux/mii.h>

    70

#include <linux/ethtool.h>

    71

#include <linux/if_vlan.h>

    72

    73

#define BAR_0		0

    74

#define BAR_1		1

    75

#define BAR_5		5

    76

    77

#define INTEL_E1000_ETHERNET_DEVICE(device_id) {\

    78

	PCI_DEVICE(PCI_VENDOR_ID_INTEL, device_id)}

    79

    80

struct e1000_adapter;

    81

    82

#include "e1000_hw.h"

    83

    84

#ifdef DBG

    85

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

    86

#else

    87

#define E1000_DBG(args...)

    88

#endif

    89

    90

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

    91

    92

#define PFX "e1000: "

    93

    94

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

    95

do {									\

    96

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

    97

		printk(KERN_##klevel PFX "%s: %s: " fmt,		\

    98

		       adapter->netdev->name, __func__, ##args);	\

    99

} while (0)

   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

#define E1000_MIN_ITR_USECS		10 /* 100000 irq/sec */

   115

#define E1000_MAX_ITR_USECS		10000 /* 100    irq/sec */

   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 0xFFFF /* pause for the max or until send xon */

   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_APME         0x0400

   153

   154

#ifndef E1000_MASTER_SLAVE

   155

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

   156

#define E1000_MASTER_SLAVE	e1000_ms_hw_default

   157

#endif

   158

   159

#define E1000_MNG_VLAN_NONE (-1)

   160

   161

/* wrapper around a pointer to a socket buffer,

   162

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

   163

struct e1000_buffer {

   164

	struct sk_buff *skb;

   165

	dma_addr_t dma;

   166

	struct page *page;

   167

	unsigned long time_stamp;

   168

	u16 length;

   169

	u16 next_to_watch;

   170

	u16 mapped_as_page;

   171

};

   172

   173

struct e1000_tx_ring {

   174

	/* pointer to the descriptor ring memory */

   175

	void *desc;

   176

	/* physical address of the descriptor ring */

   177

	dma_addr_t dma;

   178

	/* length of descriptor ring in bytes */

   179

	unsigned int size;

   180

	/* number of descriptors in the ring */

   181

	unsigned int count;

   182

	/* next descriptor to associate a buffer with */

   183

	unsigned int next_to_use;

   184

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

   185

	unsigned int next_to_clean;

   186

	/* array of buffer information structs */

   187

	struct e1000_buffer *buffer_info;

   188

   189

	u16 tdh;

   190

	u16 tdt;

   191

	bool last_tx_tso;

   192

};

   193

   194

struct e1000_rx_ring {

   195

	/* pointer to the descriptor ring memory */

   196

	void *desc;

   197

	/* physical address of the descriptor ring */

   198

	dma_addr_t dma;

   199

	/* length of descriptor ring in bytes */

   200

	unsigned int size;

   201

	/* number of descriptors in the ring */

   202

	unsigned int count;

   203

	/* next descriptor to associate a buffer with */

   204

	unsigned int next_to_use;

   205

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

   206

	unsigned int next_to_clean;

   207

	/* array of buffer information structs */

   208

	struct e1000_buffer *buffer_info;

   209

	struct sk_buff *rx_skb_top;

   210

   211

	/* cpu for rx queue */

   212

	int cpu;

   213

   214

	u16 rdh;

   215

	u16 rdt;

   216

};

   217

   218

#define E1000_DESC_UNUSED(R)						\

   219

	((((R)->next_to_clean > (R)->next_to_use)			\

   220

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

   221

   222

#define E1000_RX_DESC_EXT(R, i)						\

   223

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

   224

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

   225

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

   226

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

   227

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

   228

   229

/* board specific private data structure */

   230

   231

struct e1000_adapter {

   232

	struct timer_list tx_fifo_stall_timer;

   233

	struct timer_list watchdog_timer;

   234

	struct timer_list phy_info_timer;

   235

	struct vlan_group *vlgrp;

   236

	u16 mng_vlan_id;

   237

	u32 bd_number;

   238

	u32 rx_buffer_len;

   239

	u32 wol;

   240

	u32 smartspeed;

   241

	u32 en_mng_pt;

   242

	u16 link_speed;

   243

	u16 link_duplex;

   244

	spinlock_t stats_lock;

   245

	unsigned int total_tx_bytes;

   246

	unsigned int total_tx_packets;

   247

	unsigned int total_rx_bytes;

   248

	unsigned int total_rx_packets;

   249

	/* Interrupt Throttle Rate */

   250

	u32 itr;

   251

	u32 itr_setting;

   252

	u16 tx_itr;

   253

	u16 rx_itr;

   254

   255

	struct work_struct reset_task;

   256

	u8 fc_autoneg;

   257

   258

	struct timer_list blink_timer;

   259

	unsigned long led_status;

   260

   261

	/* TX */

   262

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

   263

	unsigned int restart_queue;

   264

	unsigned long tx_queue_len;

   265

	u32 txd_cmd;

   266

	u32 tx_int_delay;

   267

	u32 tx_abs_int_delay;

   268

	u32 gotcl;

   269

	u64 gotcl_old;

   270

	u64 tpt_old;

   271

	u64 colc_old;

   272

	u32 tx_timeout_count;

   273

	u32 tx_fifo_head;

   274

	u32 tx_head_addr;

   275

	u32 tx_fifo_size;

   276

	u8  tx_timeout_factor;

   277

	atomic_t tx_fifo_stall;

   278

	bool pcix_82544;

   279

	bool detect_tx_hung;

   280

   281

	/* RX */

   282

	bool (*clean_rx)(struct e1000_adapter *adapter,

   283

			 struct e1000_rx_ring *rx_ring,

   284

			 int *work_done, int work_to_do);

   285

	void (*alloc_rx_buf)(struct e1000_adapter *adapter,

   286

			     struct e1000_rx_ring *rx_ring,

   287

			     int cleaned_count);

   288

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

   289

	struct napi_struct napi;

   290

   291

	int num_tx_queues;

   292

	int num_rx_queues;

   293

   294

	u64 hw_csum_err;

   295

	u64 hw_csum_good;

   296

	u32 alloc_rx_buff_failed;

   297

	u32 rx_int_delay;

   298

	u32 rx_abs_int_delay;

   299

	bool rx_csum;

   300

	u32 gorcl;

   301

	u64 gorcl_old;

   302

   303

	/* OS defined structs */

   304

	struct net_device *netdev;

   305

	struct pci_dev *pdev;

   306

   307

	/* structs defined in e1000_hw.h */

   308

	struct e1000_hw hw;

   309

	struct e1000_hw_stats stats;

   310

	struct e1000_phy_info phy_info;

   311

	struct e1000_phy_stats phy_stats;

   312

   313

	u32 test_icr;

   314

	struct e1000_tx_ring test_tx_ring;

   315

	struct e1000_rx_ring test_rx_ring;

   316

   317

	int msg_enable;

   318

   319

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

   320

	bool tso_force;

   321

	bool smart_power_down;	/* phy smart power down */

   322

	bool quad_port_a;

   323

	unsigned long flags;

   324

	u32 eeprom_wol;

   325

   326

	/* for ioport free */

   327

	int bars;

   328

	int need_ioport;

   329

   330

	bool discarding;

   331

};

   332

   333

enum e1000_state_t {

   334

	__E1000_TESTING,

   335

	__E1000_RESETTING,

   336

	__E1000_DOWN

   337

};

   338

   339

extern char e1000_driver_name[];

   340

extern const char e1000_driver_version[];

   341

   342

extern int e1000_up(struct e1000_adapter *adapter);

   343

extern void e1000_down(struct e1000_adapter *adapter);

   344

extern void e1000_reinit_locked(struct e1000_adapter *adapter);

   345

extern void e1000_reset(struct e1000_adapter *adapter);

   346

extern int e1000_set_spd_dplx(struct e1000_adapter *adapter, u16 spddplx);

   347

extern int e1000_setup_all_rx_resources(struct e1000_adapter *adapter);

   348

extern int e1000_setup_all_tx_resources(struct e1000_adapter *adapter);

   349

extern void e1000_free_all_rx_resources(struct e1000_adapter *adapter);

   350

extern void e1000_free_all_tx_resources(struct e1000_adapter *adapter);

   351

extern void e1000_update_stats(struct e1000_adapter *adapter);

   352

extern void e1000_power_up_phy(struct e1000_adapter *);

   353

extern void e1000_set_ethtool_ops(struct net_device *netdev);

   354

extern void e1000_check_options(struct e1000_adapter *adapter);

   355

   356

#endif /* _E1000_H_ */