1

/* Intel PRO/1000 Linux driver

     2

 * Copyright(c) 1999 - 2014 Intel Corporation.

     3

 *

     4

 * This program is free software; you can redistribute it and/or modify it

     5

 * under the terms and conditions of the GNU General Public License,

     6

 * version 2, as published by the Free Software Foundation.

     7

 *

     8

 * This program is distributed in the hope it will be useful, but WITHOUT

     9

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    10

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for

    11

 * more details.

    12

 *

    13

 * The full GNU General Public License is included in this distribution in

    14

 * the file called "COPYING".

    15

 *

    16

 * Contact Information:

    17

 * Linux NICS <linux.nics@intel.com>

    18

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

    19

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

    20

 */

    21

    22

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

    23

    24

#ifndef _E1000_H_

    25

#define _E1000_H_

    26

    27

#include <linux/bitops.h>

    28

#include <linux/types.h>

    29

#include <linux/timer.h>

    30

#include <linux/workqueue.h>

    31

#include <linux/io.h>

    32

#include <linux/netdevice.h>

    33

#include <linux/pci.h>

    34

#include <linux/pci-aspm.h>

    35

#include <linux/crc32.h>

    36

#include <linux/if_vlan.h>

    37

#include <linux/clocksource.h>

    38

#include <linux/net_tstamp.h>

    39

#include <linux/ptp_clock_kernel.h>

    40

#include <linux/ptp_classify.h>

    41

#include <linux/mii.h>

    42

#include <linux/mdio.h>

    43

#include "hw-3.16-ethercat.h"

    44

    45

/* EtherCAT header file */

    46

#include "../ecdev.h"

    47

    48

struct e1000_info;

    49

    50

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

    51

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

    52

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

    53

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

    54

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

    55

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

    56

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

    57

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

    58

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

    59

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

    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

#define E1000_FC_PAUSE_TIME		0x0680 /* 858 usec */

    79

    80

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

    81

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

    82

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

    83

    84

#define AUTO_ALL_MODES			0

    85

#define E1000_EEPROM_APME		0x0400

    86

    87

#define E1000_MNG_VLAN_NONE		(-1)

    88

    89

#define DEFAULT_JUMBO			9234

    90

    91

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

    92

#define LINK_TIMEOUT		100

    93

    94

/* Count for polling __E1000_RESET condition every 10-20msec.

    95

 * Experimentation has shown the reset can take approximately 210msec.

    96

 */

    97

#define E1000_CHECK_RESET_COUNT		25

    98

    99

#define DEFAULT_RDTR			0

   100

#define DEFAULT_RADV			8

   101

#define BURST_RDTR			0x20

   102

#define BURST_RADV			0x20

   103

   104

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

   105

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

   106

 * WTHRESH=4, so a setting of 5 gives the most efficient bus

   107

 * utilization but to avoid possible Tx stalls, set it to 1

   108

 */

   109

#define E1000_TXDCTL_DMA_BURST_ENABLE                          \

   110

	(E1000_TXDCTL_GRAN | /* set descriptor granularity */  \

   111

	 E1000_TXDCTL_COUNT_DESC |                             \

   112

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

   113

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

   114

	 0x1f)       /* pthresh */

   115

   116

#define E1000_RXDCTL_DMA_BURST_ENABLE                          \

   117

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

   118

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

   119

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

   120

	 0x20)        /* set hthresh                */

   121

   122

#define E1000_TIDV_FPD (1 << 31)

   123

#define E1000_RDTR_FPD (1 << 31)

   124

   125

enum e1000_boards {

   126

	board_82571,

   127

	board_82572,

   128

	board_82573,

   129

	board_82574,

   130

	board_82583,

   131

	board_80003es2lan,

   132

	board_ich8lan,

   133

	board_ich9lan,

   134

	board_ich10lan,

   135

	board_pchlan,

   136

	board_pch2lan,

   137

	board_pch_lpt,

   138

};

   139

   140

struct e1000_ps_page {

   141

	struct page *page;

   142

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

   143

};

   144

   145

/* wrappers around a pointer to a socket buffer,

   146

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

   147

 */

   148

struct e1000_buffer {

   149

	dma_addr_t dma;

   150

	struct sk_buff *skb;

   151

	union {

   152

		/* Tx */

   153

		struct {

   154

			unsigned long time_stamp;

   155

			u16 length;

   156

			u16 next_to_watch;

   157

			unsigned int segs;

   158

			unsigned int bytecount;

   159

			u16 mapped_as_page;

   160

		};

   161

		/* Rx */

   162

		struct {

   163

			/* arrays of page information for packet split */

   164

			struct e1000_ps_page *ps_pages;

   165

			struct page *page;

   166

		};

   167

	};

   168

};

   169

   170

struct e1000_ring {

   171

	struct e1000_adapter *adapter;	/* back pointer to adapter */

   172

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

   173

	dma_addr_t dma;			/* phys address of ring    */

   174

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

   175

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

   176

   177

	u16 next_to_use;

   178

	u16 next_to_clean;

   179

   180

	void __iomem *head;

   181

	void __iomem *tail;

   182

   183

	/* array of buffer information structs */

   184

	struct e1000_buffer *buffer_info;

   185

   186

	char name[IFNAMSIZ + 5];

   187

	u32 ims_val;

   188

	u32 itr_val;

   189

	void __iomem *itr_register;

   190

	int set_itr;

   191

   192

	struct sk_buff *rx_skb_top;

   193

};

   194

   195

/* PHY register snapshot values */

   196

struct e1000_phy_regs {

   197

	u16 bmcr;		/* basic mode control register    */

   198

	u16 bmsr;		/* basic mode status register     */

   199

	u16 advertise;		/* auto-negotiation advertisement */

   200

	u16 lpa;		/* link partner ability register  */

   201

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

   202

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

   203

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

   204

	u16 estatus;		/* extended status register       */

   205

};

   206

   207

/* board specific private data structure */

   208

struct e1000_adapter {

   209

	struct timer_list watchdog_timer;

   210

	struct timer_list phy_info_timer;

   211

	struct timer_list blink_timer;

   212

   213

	struct work_struct reset_task;

   214

	struct work_struct watchdog_task;

   215

   216

	const struct e1000_info *ei;

   217

   218

	unsigned long active_vlans[BITS_TO_LONGS(VLAN_N_VID)];

   219

	u32 bd_number;

   220

	u32 rx_buffer_len;

   221

	u16 mng_vlan_id;

   222

	u16 link_speed;

   223

	u16 link_duplex;

   224

	u16 eeprom_vers;

   225

   226

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

   227

	unsigned long state;

   228

   229

	/* Interrupt Throttle Rate */

   230

	u32 itr;

   231

	u32 itr_setting;

   232

	u16 tx_itr;

   233

	u16 rx_itr;

   234

   235

	/* Tx - one ring per active queue */

   236

	struct e1000_ring *tx_ring ____cacheline_aligned_in_smp;

   237

	u32 tx_fifo_limit;

   238

   239

	struct napi_struct napi;

   240

   241

	unsigned int uncorr_errors;	/* uncorrectable ECC errors */

   242

	unsigned int corr_errors;	/* correctable ECC errors */

   243

	unsigned int restart_queue;

   244

	u32 txd_cmd;

   245

   246

	bool detect_tx_hung;

   247

	bool tx_hang_recheck;

   248

	u8 tx_timeout_factor;

   249

   250

	u32 tx_int_delay;

   251

	u32 tx_abs_int_delay;

   252

   253

	unsigned int total_tx_bytes;

   254

	unsigned int total_tx_packets;

   255

	unsigned int total_rx_bytes;

   256

	unsigned int total_rx_packets;

   257

   258

	/* Tx stats */

   259

	u64 tpt_old;

   260

	u64 colc_old;

   261

	u32 gotc;

   262

	u64 gotc_old;

   263

	u32 tx_timeout_count;

   264

	u32 tx_fifo_head;

   265

	u32 tx_head_addr;

   266

	u32 tx_fifo_size;

   267

	u32 tx_dma_failed;

   268

	u32 tx_hwtstamp_timeouts;

   269

   270

	/* Rx */

   271

	bool (*clean_rx)(struct e1000_ring *ring, int *work_done,

   272

			 int work_to_do) ____cacheline_aligned_in_smp;

   273

	void (*alloc_rx_buf)(struct e1000_ring *ring, int cleaned_count,

   274

			     gfp_t gfp);

   275

	struct e1000_ring *rx_ring;

   276

   277

	u32 rx_int_delay;

   278

	u32 rx_abs_int_delay;

   279

   280

	/* Rx stats */

   281

	u64 hw_csum_err;

   282

	u64 hw_csum_good;

   283

	u64 rx_hdr_split;

   284

	u32 gorc;

   285

	u64 gorc_old;

   286

	u32 alloc_rx_buff_failed;

   287

	u32 rx_dma_failed;

   288

	u32 rx_hwtstamp_cleared;

   289

   290

	unsigned int rx_ps_pages;

   291

	u16 rx_ps_bsize0;

   292

	u32 max_frame_size;

   293

	u32 min_frame_size;

   294

   295

	/* OS defined structs */

   296

	struct net_device *netdev;

   297

	struct pci_dev *pdev;

   298

   299

	/* structs defined in e1000_hw.h */

   300

	struct e1000_hw hw;

   301

   302

	spinlock_t stats64_lock;	/* protects statistics counters */

   303

	struct e1000_hw_stats stats;

   304

	struct e1000_phy_info phy_info;

   305

	struct e1000_phy_stats phy_stats;

   306

   307

	/* Snapshot of PHY registers */

   308

	struct e1000_phy_regs phy_regs;

   309

   310

	struct e1000_ring test_tx_ring;

   311

	struct e1000_ring test_rx_ring;

   312

	u32 test_icr;

   313

   314

	u32 msg_enable;

   315

	unsigned int num_vectors;

   316

	struct msix_entry *msix_entries;

   317

	int int_mode;

   318

	u32 eiac_mask;

   319

   320

	u32 eeprom_wol;

   321

	u32 wol;

   322

	u32 pba;

   323

	u32 max_hw_frame_size;

   324

   325

	bool fc_autoneg;

   326

   327

	unsigned int flags;

   328

	unsigned int flags2;

   329

	struct work_struct downshift_task;

   330

	struct work_struct update_phy_task;

   331

	struct work_struct print_hang_task;

   332

   333

	int phy_hang_count;

   334

   335

	u16 tx_ring_count;

   336

	u16 rx_ring_count;

   337

   338

	struct hwtstamp_config hwtstamp_config;

   339

	struct delayed_work systim_overflow_work;

   340

	struct sk_buff *tx_hwtstamp_skb;

   341

	unsigned long tx_hwtstamp_start;

   342

	struct work_struct tx_hwtstamp_work;

   343

	spinlock_t systim_lock;	/* protects SYSTIML/H regsters */

   344

	struct cyclecounter cc;

   345

	struct timecounter tc;

   346

	struct ptp_clock *ptp_clock;

   347

	struct ptp_clock_info ptp_clock_info;

   348

   349

	u16 eee_advert;

   350

   351

	/* EtherCAT device variables */

   352

	ec_device_t *ecdev;

   353

	unsigned long ec_watchdog_jiffies;

   354

};

   355

   356

struct e1000_info {

   357

	enum e1000_mac_type	mac;

   358

	unsigned int		flags;

   359

	unsigned int		flags2;

   360

	u32			pba;

   361

	u32			max_hw_frame_size;

   362

	s32			(*get_variants)(struct e1000_adapter *);

   363

	const struct e1000_mac_operations *mac_ops;

   364

	const struct e1000_phy_operations *phy_ops;

   365

	const struct e1000_nvm_operations *nvm_ops;

   366

};

   367

   368

s32 e1000e_get_base_timinca(struct e1000_adapter *adapter, u32 *timinca);

   369

   370

/* The system time is maintained by a 64-bit counter comprised of the 32-bit

   371

 * SYSTIMH and SYSTIML registers.  How the counter increments (and therefore

   372

 * its resolution) is based on the contents of the TIMINCA register - it

   373

 * increments every incperiod (bits 31:24) clock ticks by incvalue (bits 23:0).

   374

 * For the best accuracy, the incperiod should be as small as possible.  The

   375

 * incvalue is scaled by a factor as large as possible (while still fitting

   376

 * in bits 23:0) so that relatively small clock corrections can be made.

   377

 *

   378

 * As a result, a shift of INCVALUE_SHIFT_n is used to fit a value of

   379

 * INCVALUE_n into the TIMINCA register allowing 32+8+(24-INCVALUE_SHIFT_n)

   380

 * bits to count nanoseconds leaving the rest for fractional nonseconds.

   381

 */

   382

#define INCVALUE_96MHz		125

   383

#define INCVALUE_SHIFT_96MHz	17

   384

#define INCPERIOD_SHIFT_96MHz	2

   385

#define INCPERIOD_96MHz		(12 >> INCPERIOD_SHIFT_96MHz)

   386

   387

#define INCVALUE_25MHz		40

   388

#define INCVALUE_SHIFT_25MHz	18

   389

#define INCPERIOD_25MHz		1

   390

   391

/* Another drawback of scaling the incvalue by a large factor is the

   392

 * 64-bit SYSTIM register overflows more quickly.  This is dealt with

   393

 * by simply reading the clock before it overflows.

   394

 *

   395

 * Clock	ns bits	Overflows after

   396

 * ~~~~~~	~~~~~~~	~~~~~~~~~~~~~~~

   397

 * 96MHz	47-bit	2^(47-INCPERIOD_SHIFT_96MHz) / 10^9 / 3600 = 9.77 hrs

   398

 * 25MHz	46-bit	2^46 / 10^9 / 3600 = 19.55 hours

   399

 */

   400

#define E1000_SYSTIM_OVERFLOW_PERIOD	(HZ * 60 * 60 * 4)

   401

#define E1000_MAX_82574_SYSTIM_REREADS	50

   402

#define E1000_82574_SYSTIM_EPSILON	(1ULL << 35ULL)

   403

   404

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

   405

#define FLAG_HAS_AMT                      (1 << 0)

   406

#define FLAG_HAS_FLASH                    (1 << 1)

   407

#define FLAG_HAS_HW_VLAN_FILTER           (1 << 2)

   408

#define FLAG_HAS_WOL                      (1 << 3)

   409

/* reserved bit4 */

   410

#define FLAG_HAS_CTRLEXT_ON_LOAD          (1 << 5)

   411

#define FLAG_HAS_SWSM_ON_LOAD             (1 << 6)

   412

#define FLAG_HAS_JUMBO_FRAMES             (1 << 7)

   413

#define FLAG_READ_ONLY_NVM                (1 << 8)

   414

#define FLAG_IS_ICH                       (1 << 9)

   415

#define FLAG_HAS_MSIX                     (1 << 10)

   416

#define FLAG_HAS_SMART_POWER_DOWN         (1 << 11)

   417

#define FLAG_IS_QUAD_PORT_A               (1 << 12)

   418

#define FLAG_IS_QUAD_PORT                 (1 << 13)

   419

#define FLAG_HAS_HW_TIMESTAMP             (1 << 14)

   420

#define FLAG_APME_IN_WUC                  (1 << 15)

   421

#define FLAG_APME_IN_CTRL3                (1 << 16)

   422

#define FLAG_APME_CHECK_PORT_B            (1 << 17)

   423

#define FLAG_DISABLE_FC_PAUSE_TIME        (1 << 18)

   424

#define FLAG_NO_WAKE_UCAST                (1 << 19)

   425

#define FLAG_MNG_PT_ENABLED               (1 << 20)

   426

#define FLAG_RESET_OVERWRITES_LAA         (1 << 21)

   427

#define FLAG_TARC_SPEED_MODE_BIT          (1 << 22)

   428

#define FLAG_TARC_SET_BIT_ZERO            (1 << 23)

   429

#define FLAG_RX_NEEDS_RESTART             (1 << 24)

   430

#define FLAG_LSC_GIG_SPEED_DROP           (1 << 25)

   431

#define FLAG_SMART_POWER_DOWN             (1 << 26)

   432

#define FLAG_MSI_ENABLED                  (1 << 27)

   433

/* reserved (1 << 28) */

   434

#define FLAG_TSO_FORCE                    (1 << 29)

   435

#define FLAG_RESTART_NOW                  (1 << 30)

   436

#define FLAG_MSI_TEST_FAILED              (1 << 31)

   437

   438

#define FLAG2_CRC_STRIPPING               (1 << 0)

   439

#define FLAG2_HAS_PHY_WAKEUP              (1 << 1)

   440

#define FLAG2_IS_DISCARDING               (1 << 2)

   441

#define FLAG2_DISABLE_ASPM_L1             (1 << 3)

   442

#define FLAG2_HAS_PHY_STATS               (1 << 4)

   443

#define FLAG2_HAS_EEE                     (1 << 5)

   444

#define FLAG2_DMA_BURST                   (1 << 6)

   445

#define FLAG2_DISABLE_ASPM_L0S            (1 << 7)

   446

#define FLAG2_DISABLE_AIM                 (1 << 8)

   447

#define FLAG2_CHECK_PHY_HANG              (1 << 9)

   448

#define FLAG2_NO_DISABLE_RX               (1 << 10)

   449

#define FLAG2_PCIM2PCI_ARBITER_WA         (1 << 11)

   450

#define FLAG2_DFLT_CRC_STRIPPING          (1 << 12)

   451

#define FLAG2_CHECK_RX_HWTSTAMP           (1 << 13)

   452

   453

#define E1000_RX_DESC_PS(R, i)	    \

   454

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

   455

#define E1000_RX_DESC_EXT(R, i)	    \

   456

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

   457

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

   458

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

   459

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

   460

   461

enum e1000_state_t {

   462

	__E1000_TESTING,

   463

	__E1000_RESETTING,

   464

	__E1000_ACCESS_SHARED_RESOURCE,

   465

	__E1000_DOWN

   466

};

   467

   468

enum latency_range {

   469

	lowest_latency = 0,

   470

	low_latency = 1,

   471

	bulk_latency = 2,

   472

	latency_invalid = 255

   473

};

   474

   475

extern char e1000e_driver_name[];

   476

extern const char e1000e_driver_version[];

   477

   478

void e1000e_check_options(struct e1000_adapter *adapter);

   479

void e1000e_set_ethtool_ops(struct net_device *netdev);

   480

   481

int e1000e_up(struct e1000_adapter *adapter);

   482

void e1000e_down(struct e1000_adapter *adapter, bool reset);

   483

void e1000e_reinit_locked(struct e1000_adapter *adapter);

   484

void e1000e_reset(struct e1000_adapter *adapter);

   485

void e1000e_power_up_phy(struct e1000_adapter *adapter);

   486

int e1000e_setup_rx_resources(struct e1000_ring *ring);

   487

int e1000e_setup_tx_resources(struct e1000_ring *ring);

   488

void e1000e_free_rx_resources(struct e1000_ring *ring);

   489

void e1000e_free_tx_resources(struct e1000_ring *ring);

   490

struct rtnl_link_stats64 *e1000e_get_stats64(struct net_device *netdev,

   491

					     struct rtnl_link_stats64 *stats);

   492

void e1000e_set_interrupt_capability(struct e1000_adapter *adapter);

   493

void e1000e_reset_interrupt_capability(struct e1000_adapter *adapter);

   494

void e1000e_get_hw_control(struct e1000_adapter *adapter);

   495

void e1000e_release_hw_control(struct e1000_adapter *adapter);

   496

void e1000e_write_itr(struct e1000_adapter *adapter, u32 itr);

   497

   498

extern unsigned int copybreak;

   499

   500

extern const struct e1000_info e1000_82571_info;

   501

extern const struct e1000_info e1000_82572_info;

   502

extern const struct e1000_info e1000_82573_info;

   503

extern const struct e1000_info e1000_82574_info;

   504

extern const struct e1000_info e1000_82583_info;

   505

extern const struct e1000_info e1000_ich8_info;

   506

extern const struct e1000_info e1000_ich9_info;

   507

extern const struct e1000_info e1000_ich10_info;

   508

extern const struct e1000_info e1000_pch_info;

   509

extern const struct e1000_info e1000_pch2_info;

   510

extern const struct e1000_info e1000_pch_lpt_info;

   511

extern const struct e1000_info e1000_es2_info;

   512

   513

void e1000e_ptp_init(struct e1000_adapter *adapter);

   514

void e1000e_ptp_remove(struct e1000_adapter *adapter);

   515

   516

static inline s32 e1000_phy_hw_reset(struct e1000_hw *hw)

   517

{

   518

	return hw->phy.ops.reset(hw);

   519

}

   520

   521

static inline s32 e1e_rphy(struct e1000_hw *hw, u32 offset, u16 *data)

   522

{

   523

	return hw->phy.ops.read_reg(hw, offset, data);

   524

}

   525

   526

static inline s32 e1e_rphy_locked(struct e1000_hw *hw, u32 offset, u16 *data)

   527

{

   528

	return hw->phy.ops.read_reg_locked(hw, offset, data);

   529

}