1

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

     2

     3

  Intel PRO/1000 Linux driver

     4

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

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

    30

    31

#ifndef _E1000_H_

    32

#define _E1000_H_

    33

    34

#include <linux/types.h>

    35

#include <linux/timer.h>

    36

#include <linux/workqueue.h>

    37

#include <linux/io.h>

    38

#include <linux/netdevice.h>

    39

#include <linux/pci.h>

    40

#include <linux/pci-aspm.h>

    41

    42

#include "hw-2.6.37-ethercat.h"

    43

    44

/* EtherCAT header file */

    45

#include "../ecdev.h"

    46

    47

struct e1000_info;

    48

    49

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

    50

	netdev_dbg(hw->adapter->netdev, format, ## arg)

    51

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

    52

	netdev_err(adapter->netdev, format, ## arg)

    53

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

    54

	netdev_info(adapter->netdev, format, ## arg)

    55

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

    56

	netdev_warn(adapter->netdev, format, ## arg)

    57

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

    58

	netdev_notice(adapter->netdev, format, ## arg)

    59

    60

    61

/* Interrupt modes, as used by the IntMode parameter */

    62

#define E1000E_INT_MODE_LEGACY		0

    63

#define E1000E_INT_MODE_MSI		1

    64

#define E1000E_INT_MODE_MSIX		2

    65

    66

/* Tx/Rx descriptor defines */

    67

#define E1000_DEFAULT_TXD		256

    68

#define E1000_MAX_TXD			4096

    69

#define E1000_MIN_TXD			64

    70

    71

#define E1000_DEFAULT_RXD		256

    72

#define E1000_MAX_RXD			4096

    73

#define E1000_MIN_RXD			64

    74

    75

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

    76

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

    77

    78

/* Early Receive defines */

    79

#define E1000_ERT_2048			0x100

    80

    81

#define E1000_FC_PAUSE_TIME		0x0680 /* 858 usec */

    82

    83

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

    84

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

    85

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

    86

    87

#define AUTO_ALL_MODES			0

    88

#define E1000_EEPROM_APME		0x0400

    89

    90

#define E1000_MNG_VLAN_NONE		(-1)

    91

    92

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

    93

#define PS_PAGE_BUFFERS			(MAX_PS_BUFFERS - 1)

    94

    95

#define DEFAULT_JUMBO			9234

    96

    97

/* BM/HV Specific Registers */

    98

#define BM_PORT_CTRL_PAGE                 769

    99

   100

#define PHY_UPPER_SHIFT                   21

   101

#define BM_PHY_REG(page, reg) \

   102

	(((reg) & MAX_PHY_REG_ADDRESS) |\

   103

	 (((page) & 0xFFFF) << PHY_PAGE_SHIFT) |\

   104

	 (((reg) & ~MAX_PHY_REG_ADDRESS) << (PHY_UPPER_SHIFT - PHY_PAGE_SHIFT)))

   105

   106

/* PHY Wakeup Registers and defines */

   107

#define BM_RCTL         PHY_REG(BM_WUC_PAGE, 0)

   108

#define BM_WUC          PHY_REG(BM_WUC_PAGE, 1)

   109

#define BM_WUFC         PHY_REG(BM_WUC_PAGE, 2)

   110

#define BM_WUS          PHY_REG(BM_WUC_PAGE, 3)

   111

#define BM_RAR_L(_i)    (BM_PHY_REG(BM_WUC_PAGE, 16 + ((_i) << 2)))

   112

#define BM_RAR_M(_i)    (BM_PHY_REG(BM_WUC_PAGE, 17 + ((_i) << 2)))

   113

#define BM_RAR_H(_i)    (BM_PHY_REG(BM_WUC_PAGE, 18 + ((_i) << 2)))

   114

#define BM_RAR_CTRL(_i) (BM_PHY_REG(BM_WUC_PAGE, 19 + ((_i) << 2)))

   115

#define BM_MTA(_i)      (BM_PHY_REG(BM_WUC_PAGE, 128 + ((_i) << 1)))

   116

   117

#define BM_RCTL_UPE           0x0001          /* Unicast Promiscuous Mode */

   118

#define BM_RCTL_MPE           0x0002          /* Multicast Promiscuous Mode */

   119

#define BM_RCTL_MO_SHIFT      3               /* Multicast Offset Shift */

   120

#define BM_RCTL_MO_MASK       (3 << 3)        /* Multicast Offset Mask */

   121

#define BM_RCTL_BAM           0x0020          /* Broadcast Accept Mode */

   122

#define BM_RCTL_PMCF          0x0040          /* Pass MAC Control Frames */

   123

#define BM_RCTL_RFCE          0x0080          /* Rx Flow Control Enable */

   124

   125

#define HV_SCC_UPPER		PHY_REG(778, 16) /* Single Collision Count */

   126

#define HV_SCC_LOWER		PHY_REG(778, 17)

   127

#define HV_ECOL_UPPER		PHY_REG(778, 18) /* Excessive Collision Count */

   128

#define HV_ECOL_LOWER		PHY_REG(778, 19)

   129

#define HV_MCC_UPPER		PHY_REG(778, 20) /* Multiple Collision Count */

   130

#define HV_MCC_LOWER		PHY_REG(778, 21)

   131

#define HV_LATECOL_UPPER	PHY_REG(778, 23) /* Late Collision Count */

   132

#define HV_LATECOL_LOWER	PHY_REG(778, 24)

   133

#define HV_COLC_UPPER		PHY_REG(778, 25) /* Collision Count */

   134

#define HV_COLC_LOWER		PHY_REG(778, 26)

   135

#define HV_DC_UPPER		PHY_REG(778, 27) /* Defer Count */

   136

#define HV_DC_LOWER		PHY_REG(778, 28)

   137

#define HV_TNCRS_UPPER		PHY_REG(778, 29) /* Transmit with no CRS */

   138

#define HV_TNCRS_LOWER		PHY_REG(778, 30)

   139

   140

#define E1000_FCRTV_PCH     0x05F40 /* PCH Flow Control Refresh Timer Value */

   141

   142

/* BM PHY Copper Specific Status */

   143

#define BM_CS_STATUS                      17

   144

#define BM_CS_STATUS_LINK_UP              0x0400

   145

#define BM_CS_STATUS_RESOLVED             0x0800

   146

#define BM_CS_STATUS_SPEED_MASK           0xC000

   147

#define BM_CS_STATUS_SPEED_1000           0x8000

   148

   149

/* 82577 Mobile Phy Status Register */

   150

#define HV_M_STATUS                       26

   151

#define HV_M_STATUS_AUTONEG_COMPLETE      0x1000

   152

#define HV_M_STATUS_SPEED_MASK            0x0300

   153

#define HV_M_STATUS_SPEED_1000            0x0200

   154

#define HV_M_STATUS_LINK_UP               0x0040

   155

   156

/* Time to wait before putting the device into D3 if there's no link (in ms). */

   157

#define LINK_TIMEOUT		100

   158

   159

#define DEFAULT_RDTR			0

   160

#define DEFAULT_RADV			8

   161

#define BURST_RDTR			0x20

   162

#define BURST_RADV			0x20

   163

   164

/*

   165

 * in the case of WTHRESH, it appears at least the 82571/2 hardware

   166

 * writes back 4 descriptors when WTHRESH=5, and 3 descriptors when

   167

 * WTHRESH=4, and since we want 64 bytes at a time written back, set

   168

 * it to 5

   169

 */

   170

#define E1000_TXDCTL_DMA_BURST_ENABLE                          \

   171

	(E1000_TXDCTL_GRAN | /* set descriptor granularity */  \

   172

	 E1000_TXDCTL_COUNT_DESC |                             \

   173

	 (5 << 16) | /* wthresh must be +1 more than desired */\

   174

	 (1 << 8)  | /* hthresh */                             \

   175

	 0x1f)       /* pthresh */

   176

   177

#define E1000_RXDCTL_DMA_BURST_ENABLE                          \

   178

	(0x01000000 | /* set descriptor granularity */         \

   179

	 (4 << 16)  | /* set writeback threshold    */         \

   180

	 (4 << 8)   | /* set prefetch threshold     */         \

   181

	 0x20)        /* set hthresh                */

   182

   183

#define E1000_TIDV_FPD (1 << 31)

   184

#define E1000_RDTR_FPD (1 << 31)

   185

   186

enum e1000_boards {

   187

	board_82571,

   188

	board_82572,

   189

	board_82573,

   190

	board_82574,

   191

	board_82583,

   192

	board_80003es2lan,

   193

	board_ich8lan,

   194

	board_ich9lan,

   195

	board_ich10lan,

   196

	board_pchlan,

   197

	board_pch2lan,

   198

};

   199

   200

struct e1000_queue_stats {

   201

	u64 packets;

   202

	u64 bytes;

   203

};

   204

   205

struct e1000_ps_page {

   206

	struct page *page;

   207

	u64 dma; /* must be u64 - written to hw */

   208

};

   209

   210

/*

   211

 * wrappers around a pointer to a socket buffer,

   212

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

   213

 */

   214

struct e1000_buffer {

   215

	dma_addr_t dma;

   216

	struct sk_buff *skb;

   217

	union {

   218

		/* Tx */

   219

		struct {

   220

			unsigned long time_stamp;

   221

			u16 length;

   222

			u16 next_to_watch;

   223

			unsigned int segs;

   224

			unsigned int bytecount;

   225

			u16 mapped_as_page;

   226

		};

   227

		/* Rx */

   228

		struct {

   229

			/* arrays of page information for packet split */

   230

			struct e1000_ps_page *ps_pages;

   231

			struct page *page;

   232

		};

   233

	};

   234

};

   235

   236

struct e1000_ring {

   237

	void *desc;			/* pointer to ring memory  */

   238

	dma_addr_t dma;			/* phys address of ring    */

   239

	unsigned int size;		/* length of ring in bytes */

   240

	unsigned int count;		/* number of desc. in ring */

   241

   242

	u16 next_to_use;

   243

	u16 next_to_clean;

   244

   245

	u16 head;

   246

	u16 tail;

   247

   248

	/* array of buffer information structs */

   249

	struct e1000_buffer *buffer_info;

   250

   251

	char name[IFNAMSIZ + 5];

   252

	u32 ims_val;

   253

	u32 itr_val;

   254

	u16 itr_register;

   255

	int set_itr;

   256

   257

	struct sk_buff *rx_skb_top;

   258

   259

	struct e1000_queue_stats stats;

   260

};

   261

   262

/* PHY register snapshot values */

   263

struct e1000_phy_regs {

   264

	u16 bmcr;		/* basic mode control register    */

   265

	u16 bmsr;		/* basic mode status register     */

   266

	u16 advertise;		/* auto-negotiation advertisement */

   267

	u16 lpa;		/* link partner ability register  */

   268

	u16 expansion;		/* auto-negotiation expansion reg */

   269

	u16 ctrl1000;		/* 1000BASE-T control register    */

   270

	u16 stat1000;		/* 1000BASE-T status register     */

   271

	u16 estatus;		/* extended status register       */

   272

};

   273

   274

/* board specific private data structure */

   275

struct e1000_adapter {

   276

	struct timer_list watchdog_timer;

   277

	struct timer_list phy_info_timer;

   278

	struct timer_list blink_timer;

   279

   280

	struct work_struct reset_task;

   281

	struct work_struct watchdog_task;

   282

   283

	const struct e1000_info *ei;

   284

   285

	struct vlan_group *vlgrp;

   286

	u32 bd_number;

   287

	u32 rx_buffer_len;

   288

	u16 mng_vlan_id;

   289

	u16 link_speed;

   290

	u16 link_duplex;

   291

	u16 eeprom_vers;

   292

   293

	/* track device up/down/testing state */

   294

	unsigned long state;

   295

   296

	/* Interrupt Throttle Rate */

   297

	u32 itr;

   298

	u32 itr_setting;

   299

	u16 tx_itr;

   300

	u16 rx_itr;

   301

   302

	/*

   303

	 * Tx

   304

	 */

   305

	struct e1000_ring *tx_ring /* One per active queue */

   306

						____cacheline_aligned_in_smp;

   307

   308

	struct napi_struct napi;

   309

   310

	unsigned int restart_queue;

   311

	u32 txd_cmd;

   312

   313

	bool detect_tx_hung;

   314

	u8 tx_timeout_factor;

   315

   316

	u32 tx_int_delay;

   317

	u32 tx_abs_int_delay;

   318

   319

	unsigned int total_tx_bytes;

   320

	unsigned int total_tx_packets;

   321

	unsigned int total_rx_bytes;

   322

	unsigned int total_rx_packets;

   323

   324

	/* Tx stats */

   325

	u64 tpt_old;

   326

	u64 colc_old;

   327

	u32 gotc;

   328

	u64 gotc_old;

   329

	u32 tx_timeout_count;

   330

	u32 tx_fifo_head;

   331

	u32 tx_head_addr;

   332

	u32 tx_fifo_size;

   333

	u32 tx_dma_failed;

   334

   335

	/*

   336

	 * Rx

   337

	 */

   338

	bool (*clean_rx) (struct e1000_adapter *adapter,

   339

			  int *work_done, int work_to_do)

   340

						____cacheline_aligned_in_smp;

   341

	void (*alloc_rx_buf) (struct e1000_adapter *adapter,

   342

			      int cleaned_count);

   343

	struct e1000_ring *rx_ring;

   344

   345

	u32 rx_int_delay;

   346

	u32 rx_abs_int_delay;

   347

   348

	/* Rx stats */

   349

	u64 hw_csum_err;

   350

	u64 hw_csum_good;

   351

	u64 rx_hdr_split;

   352

	u32 gorc;

   353

	u64 gorc_old;

   354

	u32 alloc_rx_buff_failed;

   355

	u32 rx_dma_failed;

   356

   357

	unsigned int rx_ps_pages;

   358

	u16 rx_ps_bsize0;

   359

	u32 max_frame_size;

   360

	u32 min_frame_size;

   361

   362

	/* OS defined structs */

   363

	struct net_device *netdev;

   364

	struct pci_dev *pdev;

   365

   366

	/* structs defined in e1000_hw.h */

   367

	struct e1000_hw hw;

   368

   369

	struct e1000_hw_stats stats;

   370

	struct e1000_phy_info phy_info;

   371

	struct e1000_phy_stats phy_stats;

   372

   373

	/* Snapshot of PHY registers */

   374

	struct e1000_phy_regs phy_regs;

   375

   376

	struct e1000_ring test_tx_ring;

   377

	struct e1000_ring test_rx_ring;

   378

	u32 test_icr;

   379

   380

	u32 msg_enable;

   381

	unsigned int num_vectors;

   382

	struct msix_entry *msix_entries;

   383

	int int_mode;

   384

	u32 eiac_mask;

   385

   386

	u32 eeprom_wol;

   387

	u32 wol;

   388

	u32 pba;

   389

	u32 max_hw_frame_size;

   390

   391

	bool fc_autoneg;

   392

   393

	unsigned long led_status;

   394

   395

	unsigned int flags;

   396

	unsigned int flags2;

   397

	struct work_struct downshift_task;

   398

	struct work_struct update_phy_task;

   399

	struct work_struct led_blink_task;

   400

	struct work_struct print_hang_task;

   401

   402

	bool idle_check;

   403

	int phy_hang_count;

   404

   405

	/* EtherCAT device variables */

   406

	ec_device_t *ecdev;

   407

	unsigned long ec_watchdog_jiffies;

   408

};

   409

   410

struct e1000_info {

   411

	enum e1000_mac_type	mac;

   412

	unsigned int		flags;

   413

	unsigned int		flags2;

   414

	u32			pba;

   415

	u32			max_hw_frame_size;

   416

	s32			(*get_variants)(struct e1000_adapter *);

   417

	struct e1000_mac_operations *mac_ops;

   418

	struct e1000_phy_operations *phy_ops;

   419

	struct e1000_nvm_operations *nvm_ops;

   420

};

   421

   422

/* hardware capability, feature, and workaround flags */

   423

#define FLAG_HAS_AMT                      (1 << 0)

   424

#define FLAG_HAS_FLASH                    (1 << 1)

   425

#define FLAG_HAS_HW_VLAN_FILTER           (1 << 2)

   426

#define FLAG_HAS_WOL                      (1 << 3)

   427

#define FLAG_HAS_ERT                      (1 << 4)

   428

#define FLAG_HAS_CTRLEXT_ON_LOAD          (1 << 5)

   429

#define FLAG_HAS_SWSM_ON_LOAD             (1 << 6)

   430

#define FLAG_HAS_JUMBO_FRAMES             (1 << 7)

   431

#define FLAG_READ_ONLY_NVM                (1 << 8)

   432

#define FLAG_IS_ICH                       (1 << 9)

   433

#define FLAG_HAS_MSIX                     (1 << 10)

   434

#define FLAG_HAS_SMART_POWER_DOWN         (1 << 11)

   435

#define FLAG_IS_QUAD_PORT_A               (1 << 12)

   436

#define FLAG_IS_QUAD_PORT                 (1 << 13)

   437

#define FLAG_TIPG_MEDIUM_FOR_80003ESLAN   (1 << 14)

   438

#define FLAG_APME_IN_WUC                  (1 << 15)

   439

#define FLAG_APME_IN_CTRL3                (1 << 16)

   440

#define FLAG_APME_CHECK_PORT_B            (1 << 17)

   441

#define FLAG_DISABLE_FC_PAUSE_TIME        (1 << 18)

   442

#define FLAG_NO_WAKE_UCAST                (1 << 19)

   443

#define FLAG_MNG_PT_ENABLED               (1 << 20)

   444

#define FLAG_RESET_OVERWRITES_LAA         (1 << 21)

   445

#define FLAG_TARC_SPEED_MODE_BIT          (1 << 22)

   446

#define FLAG_TARC_SET_BIT_ZERO            (1 << 23)

   447

#define FLAG_RX_NEEDS_RESTART             (1 << 24)

   448

#define FLAG_LSC_GIG_SPEED_DROP           (1 << 25)

   449

#define FLAG_SMART_POWER_DOWN             (1 << 26)

   450

#define FLAG_MSI_ENABLED                  (1 << 27)

   451

#define FLAG_RX_CSUM_ENABLED              (1 << 28)

   452

#define FLAG_TSO_FORCE                    (1 << 29)

   453

#define FLAG_RX_RESTART_NOW               (1 << 30)

   454

#define FLAG_MSI_TEST_FAILED              (1 << 31)

   455

   456

/* CRC Stripping defines */

   457

#define FLAG2_CRC_STRIPPING               (1 << 0)

   458

#define FLAG2_HAS_PHY_WAKEUP              (1 << 1)

   459

#define FLAG2_IS_DISCARDING               (1 << 2)

   460

#define FLAG2_DISABLE_ASPM_L1             (1 << 3)

   461

#define FLAG2_HAS_PHY_STATS               (1 << 4)

   462

#define FLAG2_HAS_EEE                     (1 << 5)

   463

#define FLAG2_DMA_BURST                   (1 << 6)

   464

#define FLAG2_DISABLE_AIM                 (1 << 8)

   465

#define FLAG2_CHECK_PHY_HANG              (1 << 9)

   466

   467

#define E1000_RX_DESC_PS(R, i)	    \

   468

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

   469

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

   470

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

   471

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

   472

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

   473

   474

enum e1000_state_t {

   475

	__E1000_TESTING,

   476

	__E1000_RESETTING,

   477

	__E1000_DOWN

   478

};

   479

   480

enum latency_range {

   481

	lowest_latency = 0,

   482

	low_latency = 1,

   483

	bulk_latency = 2,

   484

	latency_invalid = 255

   485

};

   486

   487

extern char e1000e_driver_name[];

   488

extern const char e1000e_driver_version[];

   489

   490

extern void e1000e_check_options(struct e1000_adapter *adapter);

   491

extern void e1000e_set_ethtool_ops(struct net_device *netdev);

   492

   493

extern int e1000e_up(struct e1000_adapter *adapter);

   494

extern void e1000e_down(struct e1000_adapter *adapter);

   495

extern void e1000e_reinit_locked(struct e1000_adapter *adapter);

   496

extern void e1000e_reset(struct e1000_adapter *adapter);

   497

extern void e1000e_power_up_phy(struct e1000_adapter *adapter);

   498

extern int e1000e_setup_rx_resources(struct e1000_adapter *adapter);

   499

extern int e1000e_setup_tx_resources(struct e1000_adapter *adapter);

   500

extern void e1000e_free_rx_resources(struct e1000_adapter *adapter);

   501

extern void e1000e_free_tx_resources(struct e1000_adapter *adapter);

   502

extern void e1000e_update_stats(struct e1000_adapter *adapter);

   503

extern void e1000e_set_interrupt_capability(struct e1000_adapter *adapter);

   504

extern void e1000e_reset_interrupt_capability(struct e1000_adapter *adapter);

   505

extern void e1000e_disable_aspm(struct pci_dev *pdev, u16 state);

   506

   507

extern unsigned int copybreak;

   508

extern int entropy;

   509

   510

extern char *e1000e_get_hw_dev_name(struct e1000_hw *hw);

   511

   512

extern struct e1000_info e1000_82571_info;

   513

extern struct e1000_info e1000_82572_info;

   514

extern struct e1000_info e1000_82573_info;

   515

extern struct e1000_info e1000_82574_info;

   516

extern struct e1000_info e1000_82583_info;

   517

extern struct e1000_info e1000_ich8_info;

   518

extern struct e1000_info e1000_ich9_info;

   519

extern struct e1000_info e1000_ich10_info;

   520

extern struct e1000_info e1000_pch_info;

   521

extern struct e1000_info e1000_pch2_info;

   522

extern struct e1000_info e1000_es2_info;

   523

   524

extern s32 e1000e_read_pba_num(struct e1000_hw *hw, u32 *pba_num);

   525

   526

extern s32  e1000e_commit_phy(struct e1000_hw *hw);

   527

   528

extern bool e1000e_enable_mng_pass_thru(struct e1000_hw *hw);

   529

   530

extern bool e1000e_get_laa_state_82571(struct e1000_hw *hw);