1

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

     2

     3

     4

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

  e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>

    26

  Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497

    27

    28

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

    29

    30

    31

/* Linux PRO/1000 Ethernet Driver main header file */

    32

    33

#ifndef _E1000_H_

    34

#define _E1000_H_

    35

    36

#include <linux/stddef.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/mii.h>

    72

#include <linux/ethtool.h>

    73

#include <linux/if_vlan.h>

    74

    75

#define BAR_0		0

    76

#define BAR_1		1

    77

#define BAR_5		5

    78

    79

#define INTEL_E1000_ETHERNET_DEVICE(device_id) {\

    80

	PCI_DEVICE(PCI_VENDOR_ID_INTEL, device_id)}

    81

    82

struct e1000_adapter;

    83

    84

#include "e1000_hw.h"

    85

    86

#ifdef DBG

    87

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

    88

#else

    89

#define E1000_DBG(args...)

    90

#endif

    91

    92

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

    93

    94

#define PFX "e1000: "

    95

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

    96

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

    97

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

    98

		__FUNCTION__ , ## args))

    99

   100

#define E1000_MAX_INTR 10

   101

   102

/* TX/RX descriptor defines */

   103

#define E1000_DEFAULT_TXD                  256

   104

#define E1000_MAX_TXD                      256

   105

#define E1000_MIN_TXD                       80

   106

#define E1000_MAX_82544_TXD               4096

   107

   108

#define E1000_DEFAULT_RXD                  256

   109

#define E1000_MAX_RXD                      256

   110

#define E1000_MIN_RXD                       80

   111

#define E1000_MAX_82544_RXD               4096

   112

   113

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

   114

#define MAXIMUM_ETHERNET_VLAN_SIZE 1522

   115

   116

/* Supported Rx Buffer Sizes */

   117

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

   118

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

   119

#define E1000_RXBUFFER_512   512

   120

#define E1000_RXBUFFER_1024  1024

   121

#define E1000_RXBUFFER_2048  2048

   122

#define E1000_RXBUFFER_4096  4096

   123

#define E1000_RXBUFFER_8192  8192

   124

#define E1000_RXBUFFER_16384 16384

   125

   126

/* SmartSpeed delimiters */

   127

#define E1000_SMARTSPEED_DOWNSHIFT 3

   128

#define E1000_SMARTSPEED_MAX       15

   129

   130

/* Packet Buffer allocations */

   131

#define E1000_PBA_BYTES_SHIFT 0xA

   132

#define E1000_TX_HEAD_ADDR_SHIFT 7

   133

#define E1000_PBA_TX_MASK 0xFFFF0000

   134

   135

/* Flow Control Watermarks */

   136

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

   137

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

   138

   139

#define E1000_FC_PAUSE_TIME 0x0680 /* 858 usec */

   140

   141

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

   142

#define E1000_TX_QUEUE_WAKE	16

   143

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

   144

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

   145

   146

#define AUTO_ALL_MODES            0

   147

#define E1000_EEPROM_82544_APM    0x0004

   148

#define E1000_EEPROM_ICH8_APME    0x0004

   149

#define E1000_EEPROM_APME         0x0400

   150

   151

#ifndef E1000_MASTER_SLAVE

   152

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

   153

#define E1000_MASTER_SLAVE	e1000_ms_hw_default

   154

#endif

   155

   156

#define E1000_MNG_VLAN_NONE -1

   157

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

   158

#define PS_PAGE_BUFFERS MAX_PS_BUFFERS-1

   159

   160

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

   161

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

   162

   163

/* wrapper around a pointer to a socket buffer,

   164

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

   165

struct e1000_buffer {

   166

	struct sk_buff *skb;

   167

	dma_addr_t dma;

   168

	unsigned long time_stamp;

   169

	uint16_t length;

   170

	uint16_t next_to_watch;

   171

};

   172

   173

   174

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

   175

struct e1000_ps_page_dma { uint64_t ps_page_dma[PS_PAGE_BUFFERS]; };

   176

   177

struct e1000_tx_ring {

   178

	/* pointer to the descriptor ring memory */

   179

	void *desc;

   180

	/* physical address of the descriptor ring */

   181

	dma_addr_t dma;

   182

	/* length of descriptor ring in bytes */

   183

	unsigned int size;

   184

	/* number of descriptors in the ring */

   185

	unsigned int count;

   186

	/* next descriptor to associate a buffer with */

   187

	unsigned int next_to_use;

   188

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

   189

	unsigned int next_to_clean;

   190

	/* array of buffer information structs */

   191

	struct e1000_buffer *buffer_info;

   192

   193

	spinlock_t tx_lock;

   194

	uint16_t tdh;

   195

	uint16_t tdt;

   196

	boolean_t last_tx_tso;

   197

};

   198

   199

struct e1000_rx_ring {

   200

	/* pointer to the descriptor ring memory */

   201

	void *desc;

   202

	/* physical address of the descriptor ring */

   203

	dma_addr_t dma;

   204

	/* length of descriptor ring in bytes */

   205

	unsigned int size;

   206

	/* number of descriptors in the ring */

   207

	unsigned int count;

   208

	/* next descriptor to associate a buffer with */

   209

	unsigned int next_to_use;

   210

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

   211

	unsigned int next_to_clean;

   212

	/* array of buffer information structs */

   213

	struct e1000_buffer *buffer_info;

   214

	/* arrays of page information for packet split */

   215

	struct e1000_ps_page *ps_page;

   216

	struct e1000_ps_page_dma *ps_page_dma;

   217

   218

	/* cpu for rx queue */

   219

	int cpu;

   220

   221

	uint16_t rdh;

   222

	uint16_t rdt;

   223

};

   224

   225

#define E1000_DESC_UNUSED(R) \

   226

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

   227

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

   228

   229

#define E1000_RX_DESC_PS(R, i)	    \

   230

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

   231

#define E1000_RX_DESC_EXT(R, i)	    \

   232

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

   233

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

   234

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

   235

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

   236

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

   237

   238

/* board specific private data structure */

   239

   240

struct e1000_adapter {

   241

	struct timer_list tx_fifo_stall_timer;

   242

	struct timer_list watchdog_timer;

   243

	struct timer_list phy_info_timer;

   244

	struct vlan_group *vlgrp;

   245

    	uint16_t mng_vlan_id;

   246

	uint32_t bd_number;

   247

	uint32_t rx_buffer_len;

   248

	uint32_t part_num;

   249

	uint32_t wol;

   250

	uint32_t ksp3_port_a;

   251

	uint32_t smartspeed;

   252

	uint32_t en_mng_pt;

   253

	uint16_t link_speed;

   254

	uint16_t link_duplex;

   255

	spinlock_t stats_lock;

   256

#ifdef CONFIG_E1000_NAPI

   257

	spinlock_t tx_queue_lock;

   258

#endif

   259

	atomic_t irq_sem;

   260

	struct work_struct reset_task;

   261

	uint8_t fc_autoneg;

   262

   263

	struct timer_list blink_timer;

   264

	unsigned long led_status;

   265

   266

	/* TX */

   267

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

   268

	unsigned long tx_queue_len;

   269

	uint32_t txd_cmd;

   270

	uint32_t tx_int_delay;

   271

	uint32_t tx_abs_int_delay;

   272

	uint32_t gotcl;

   273

	uint64_t gotcl_old;

   274

	uint64_t tpt_old;

   275

	uint64_t colc_old;

   276

	uint32_t tx_timeout_count;

   277

	uint32_t tx_fifo_head;

   278

	uint32_t tx_head_addr;

   279

	uint32_t tx_fifo_size;

   280

	uint8_t  tx_timeout_factor;

   281

	atomic_t tx_fifo_stall;

   282

	boolean_t pcix_82544;

   283

	boolean_t detect_tx_hung;

   284

   285

	/* RX */

   286

#ifdef CONFIG_E1000_NAPI

   287

	boolean_t (*clean_rx) (struct e1000_adapter *adapter,

   288

			       struct e1000_rx_ring *rx_ring,

   289

			       int *work_done, int work_to_do);

   290

#else

   291

	boolean_t (*clean_rx) (struct e1000_adapter *adapter,

   292

			       struct e1000_rx_ring *rx_ring);

   293

#endif

   294

	void (*alloc_rx_buf) (struct e1000_adapter *adapter,

   295

			      struct e1000_rx_ring *rx_ring,

   296

				int cleaned_count);

   297

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

   298

#ifdef CONFIG_E1000_NAPI

   299

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

   300

#endif

   301

	int num_tx_queues;

   302

	int num_rx_queues;

   303

   304

	uint64_t hw_csum_err;

   305

	uint64_t hw_csum_good;

   306

	uint64_t rx_hdr_split;

   307

	uint32_t alloc_rx_buff_failed;

   308

	uint32_t rx_int_delay;

   309

	uint32_t rx_abs_int_delay;

   310

	boolean_t rx_csum;

   311

	unsigned int rx_ps_pages;

   312

	uint32_t gorcl;

   313

	uint64_t gorcl_old;

   314

	uint16_t rx_ps_bsize0;

   315

   316

	/* Interrupt Throttle Rate */

   317

	uint32_t itr;

   318

   319

	/* OS defined structs */

   320

	struct net_device *netdev;

   321

	struct pci_dev *pdev;

   322

	struct net_device_stats net_stats;

   323

   324

	/* structs defined in e1000_hw.h */

   325

	struct e1000_hw hw;

   326

	struct e1000_hw_stats stats;

   327

	struct e1000_phy_info phy_info;

   328

	struct e1000_phy_stats phy_stats;

   329

   330

	uint32_t test_icr;

   331

	struct e1000_tx_ring test_tx_ring;

   332

	struct e1000_rx_ring test_rx_ring;

   333

   334

   335

	uint32_t *config_space;

   336

	int msg_enable;

   337

#ifdef CONFIG_PCI_MSI

   338

	boolean_t have_msi;

   339

#endif

   340

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

   341

#ifdef NETIF_F_TSO

   342

	boolean_t tso_force;

   343

#endif

   344

	boolean_t smart_power_down;	/* phy smart power down */

   345

	unsigned long flags;

   346

};

   347

   348

enum e1000_state_t {

   349

	__E1000_DRIVER_TESTING,

   350

	__E1000_RESETTING,

   351

};

   352

   353

/*  e1000_main.c  */

   354

extern char e1000_driver_name[];

   355

extern char e1000_driver_version[];

   356

int e1000_up(struct e1000_adapter *adapter);

   357

void e1000_down(struct e1000_adapter *adapter);

   358

void e1000_reset(struct e1000_adapter *adapter);

   359

void e1000_reinit_locked(struct e1000_adapter *adapter);

   360

int e1000_setup_all_tx_resources(struct e1000_adapter *adapter);

   361

void e1000_free_all_tx_resources(struct e1000_adapter *adapter);

   362

int e1000_setup_all_rx_resources(struct e1000_adapter *adapter);

   363

void e1000_free_all_rx_resources(struct e1000_adapter *adapter);

   364

void e1000_update_stats(struct e1000_adapter *adapter);

   365

int e1000_set_spd_dplx(struct e1000_adapter *adapter, uint16_t spddplx);

   366

   367

/*  e1000_ethtool.c  */

   368

void e1000_set_ethtool_ops(struct net_device *netdev);

   369

   370

/*  e1000_param.c  */

   371

void e1000_check_options(struct e1000_adapter *adapter);

   372

   373

   374

#endif /* _E1000_H_ */