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

#include "../ecdev.h"

    73

    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-3.4-ethercat.h"

    85

    86

#define E1000_MAX_INTR 10

    87

    88

/* TX/RX descriptor defines */

    89

#define E1000_DEFAULT_TXD                  256

    90

#define E1000_MAX_TXD                      256

    91

#define E1000_MIN_TXD                       48

    92

#define E1000_MAX_82544_TXD               4096

    93

    94

#define E1000_DEFAULT_RXD                  256

    95

#define E1000_MAX_RXD                      256

    96

#define E1000_MIN_RXD                       48

    97

#define E1000_MAX_82544_RXD               4096

    98

    99

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

   100

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

   101

   102

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

   103

#define MAXIMUM_ETHERNET_VLAN_SIZE 1522

   104

   105

/* Supported Rx Buffer Sizes */

   106

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

   107

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

   108

#define E1000_RXBUFFER_512   512

   109

#define E1000_RXBUFFER_1024  1024

   110

#define E1000_RXBUFFER_2048  2048

   111

#define E1000_RXBUFFER_4096  4096

   112

#define E1000_RXBUFFER_8192  8192

   113

#define E1000_RXBUFFER_16384 16384

   114

   115

/* SmartSpeed delimiters */

   116

#define E1000_SMARTSPEED_DOWNSHIFT 3

   117

#define E1000_SMARTSPEED_MAX       15

   118

   119

/* Packet Buffer allocations */

   120

#define E1000_PBA_BYTES_SHIFT 0xA

   121

#define E1000_TX_HEAD_ADDR_SHIFT 7

   122

#define E1000_PBA_TX_MASK 0xFFFF0000

   123

   124

/* Flow Control Watermarks */

   125

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

   126

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

   127

   128

#define E1000_FC_PAUSE_TIME 0xFFFF /* pause for the max or until send xon */

   129

   130

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

   131

#define E1000_TX_QUEUE_WAKE	16

   132

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

   133

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

   134

   135

#define AUTO_ALL_MODES            0

   136

#define E1000_EEPROM_82544_APM    0x0004

   137

#define E1000_EEPROM_APME         0x0400

   138

   139

#ifndef E1000_MASTER_SLAVE

   140

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

   141

#define E1000_MASTER_SLAVE	e1000_ms_hw_default

   142

#endif

   143

   144

#define E1000_MNG_VLAN_NONE (-1)

   145

   146

/* wrapper around a pointer to a socket buffer,

   147

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

   148

struct e1000_buffer {

   149

	struct sk_buff *skb;

   150

	dma_addr_t dma;

   151

	struct page *page;

   152

	unsigned long time_stamp;

   153

	u16 length;

   154

	u16 next_to_watch;

   155

	unsigned int segs;

   156

	unsigned int bytecount;

   157

	u16 mapped_as_page;

   158

};

   159

   160

struct e1000_tx_ring {

   161

	/* pointer to the descriptor ring memory */

   162

	void *desc;

   163

	/* physical address of the descriptor ring */

   164

	dma_addr_t dma;

   165

	/* length of descriptor ring in bytes */

   166

	unsigned int size;

   167

	/* number of descriptors in the ring */

   168

	unsigned int count;

   169

	/* next descriptor to associate a buffer with */

   170

	unsigned int next_to_use;

   171

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

   172

	unsigned int next_to_clean;

   173

	/* array of buffer information structs */

   174

	struct e1000_buffer *buffer_info;

   175

   176

	u16 tdh;

   177

	u16 tdt;

   178

	bool last_tx_tso;

   179

};

   180

   181

struct e1000_rx_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

	struct sk_buff *rx_skb_top;

   197

   198

	/* cpu for rx queue */

   199

	int cpu;

   200

   201

	u16 rdh;

   202

	u16 rdt;

   203

};

   204

   205

#define E1000_DESC_UNUSED(R)						\

   206

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

   207

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

   208

   209

#define E1000_RX_DESC_EXT(R, i)						\

   210

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

   211

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

   212

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

   213

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

   214

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

   215

   216

/* board specific private data structure */

   217

   218

struct e1000_adapter {

   219

	unsigned long active_vlans[BITS_TO_LONGS(VLAN_N_VID)];

   220

	u16 mng_vlan_id;

   221

	u32 bd_number;

   222

	u32 rx_buffer_len;

   223

	u32 wol;

   224

	u32 smartspeed;

   225

	u32 en_mng_pt;

   226

	u16 link_speed;

   227

	u16 link_duplex;

   228

	spinlock_t stats_lock;

   229

	unsigned int total_tx_bytes;

   230

	unsigned int total_tx_packets;

   231

	unsigned int total_rx_bytes;

   232

	unsigned int total_rx_packets;

   233

	/* Interrupt Throttle Rate */

   234

	u32 itr;

   235

	u32 itr_setting;

   236

	u16 tx_itr;

   237

	u16 rx_itr;

   238

   239

	u8 fc_autoneg;

   240

   241

	/* TX */

   242

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

   243

	unsigned int restart_queue;

   244

	u32 txd_cmd;

   245

	u32 tx_int_delay;

   246

	u32 tx_abs_int_delay;

   247

	u32 gotcl;

   248

	u64 gotcl_old;

   249

	u64 tpt_old;

   250

	u64 colc_old;

   251

	u32 tx_timeout_count;

   252

	u32 tx_fifo_head;

   253

	u32 tx_head_addr;

   254

	u32 tx_fifo_size;

   255

	u8  tx_timeout_factor;

   256

	atomic_t tx_fifo_stall;

   257

	bool pcix_82544;

   258

	bool detect_tx_hung;

   259

	bool dump_buffers;

   260

   261

	/* RX */

   262

	bool (*clean_rx)(struct e1000_adapter *adapter,

   263

			 struct e1000_rx_ring *rx_ring,

   264

			 int *work_done, int work_to_do);

   265

	void (*alloc_rx_buf)(struct e1000_adapter *adapter,

   266

			     struct e1000_rx_ring *rx_ring,

   267

			     int cleaned_count);

   268

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

   269

	struct napi_struct napi;

   270

   271

	int num_tx_queues;

   272

	int num_rx_queues;

   273

   274

	u64 hw_csum_err;

   275

	u64 hw_csum_good;

   276

	u32 alloc_rx_buff_failed;

   277

	u32 rx_int_delay;

   278

	u32 rx_abs_int_delay;

   279

	bool rx_csum;

   280

	u32 gorcl;

   281

	u64 gorcl_old;

   282

   283

	/* OS defined structs */

   284

	struct net_device *netdev;

   285

	struct pci_dev *pdev;

   286

   287

	/* structs defined in e1000_hw.h */

   288

	struct e1000_hw hw;

   289

	struct e1000_hw_stats stats;

   290

	struct e1000_phy_info phy_info;

   291

	struct e1000_phy_stats phy_stats;

   292

   293

	u32 test_icr;

   294

	struct e1000_tx_ring test_tx_ring;

   295

	struct e1000_rx_ring test_rx_ring;

   296

   297

	int msg_enable;

   298

   299

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

   300

	bool tso_force;

   301

	bool smart_power_down;	/* phy smart power down */

   302

	bool quad_port_a;

   303

	unsigned long flags;

   304

	u32 eeprom_wol;

   305

   306

	/* for ioport free */

   307

	int bars;

   308

	int need_ioport;

   309

   310

	bool discarding;

   311

   312

	struct work_struct reset_task;

   313

	struct delayed_work watchdog_task;

   314

	struct delayed_work fifo_stall_task;

   315

	struct delayed_work phy_info_task;

   316

   317

	struct mutex mutex;

   318

   319

	ec_device_t *ecdev;

   320

	unsigned long ec_watchdog_jiffies;

   321

};

   322

   323

enum e1000_state_t {

   324

	__E1000_TESTING,

   325

	__E1000_RESETTING,

   326

	__E1000_DOWN

   327

};

   328

   329

#undef pr_fmt

   330

#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

   331

   332

extern struct net_device *e1000_get_hw_dev(struct e1000_hw *hw);

   333

#define e_dbg(format, arg...) \

   334

	netdev_dbg(e1000_get_hw_dev(hw), format, ## arg)

   335

#define e_err(msglvl, format, arg...) \

   336

	netif_err(adapter, msglvl, adapter->netdev, format, ## arg)

   337

#define e_info(msglvl, format, arg...) \

   338

	netif_info(adapter, msglvl, adapter->netdev, format, ## arg)

   339

#define e_warn(msglvl, format, arg...) \

   340

	netif_warn(adapter, msglvl, adapter->netdev, format, ## arg)

   341

#define e_notice(msglvl, format, arg...) \

   342

	netif_notice(adapter, msglvl, adapter->netdev, format, ## arg)

   343

#define e_dev_info(format, arg...) \

   344

	dev_info(&adapter->pdev->dev, format, ## arg)

   345

#define e_dev_warn(format, arg...) \

   346

	dev_warn(&adapter->pdev->dev, format, ## arg)

   347

#define e_dev_err(format, arg...) \

   348

	dev_err(&adapter->pdev->dev, format, ## arg)

   349

   350

extern char e1000_driver_name[];

   351

extern const char e1000_driver_version[];

   352

   353

extern int e1000_up(struct e1000_adapter *adapter);

   354

extern void e1000_down(struct e1000_adapter *adapter);

   355

extern void e1000_reinit_locked(struct e1000_adapter *adapter);

   356

extern void e1000_reset(struct e1000_adapter *adapter);

   357

extern int e1000_set_spd_dplx(struct e1000_adapter *adapter, u32 spd, u8 dplx);

   358

extern int e1000_setup_all_rx_resources(struct e1000_adapter *adapter);

   359

extern int e1000_setup_all_tx_resources(struct e1000_adapter *adapter);

   360

extern void e1000_free_all_rx_resources(struct e1000_adapter *adapter);

   361

extern void e1000_free_all_tx_resources(struct e1000_adapter *adapter);

   362

extern void e1000_update_stats(struct e1000_adapter *adapter);

   363

extern bool e1000_has_link(struct e1000_adapter *adapter);

   364

extern void e1000_power_up_phy(struct e1000_adapter *);

   365

extern void e1000_set_ethtool_ops(struct net_device *netdev);

   366

extern void e1000_check_options(struct e1000_adapter *adapter);

   367

extern char *e1000_get_hw_dev_name(struct e1000_hw *hw);

   368

   369

#endif /* _E1000_H_ */