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

#include "e1000-3.12-ethercat.h"

    30

    31

/* This is the only thing that needs to be changed to adjust the

    32

 * maximum number of ports that the driver can manage.

    33

 */

    34

    35

#define E1000_MAX_NIC 32

    36

    37

#define OPTION_UNSET   -1

    38

#define OPTION_DISABLED 0

    39

#define OPTION_ENABLED  1

    40

    41

/* All parameters are treated the same, as an integer array of values.

    42

 * This macro just reduces the need to repeat the same declaration code

    43

 * over and over (plus this helps to avoid typo bugs).

    44

 */

    45

    46

#define E1000_PARAM_INIT { [0 ... E1000_MAX_NIC] = OPTION_UNSET }

    47

#define E1000_PARAM(X, desc) \

    48

	static int X[E1000_MAX_NIC+1] = E1000_PARAM_INIT; \

    49

	static unsigned int num_##X; \

    50

	module_param_array_named(X, X, int, &num_##X, 0); \

    51

	MODULE_PARM_DESC(X, desc);

    52

    53

/* Transmit Descriptor Count

    54

 *

    55

 * Valid Range: 80-256 for 82542 and 82543 gigabit ethernet controllers

    56

 * Valid Range: 80-4096 for 82544 and newer

    57

 *

    58

 * Default Value: 256

    59

 */

    60

E1000_PARAM(TxDescriptors, "Number of transmit descriptors");

    61

    62

/* Receive Descriptor Count

    63

 *

    64

 * Valid Range: 80-256 for 82542 and 82543 gigabit ethernet controllers

    65

 * Valid Range: 80-4096 for 82544 and newer

    66

 *

    67

 * Default Value: 256

    68

 */

    69

E1000_PARAM(RxDescriptors, "Number of receive descriptors");

    70

    71

/* User Specified Speed Override

    72

 *

    73

 * Valid Range: 0, 10, 100, 1000

    74

 *  - 0    - auto-negotiate at all supported speeds

    75

 *  - 10   - only link at 10 Mbps

    76

 *  - 100  - only link at 100 Mbps

    77

 *  - 1000 - only link at 1000 Mbps

    78

 *

    79

 * Default Value: 0

    80

 */

    81

E1000_PARAM(Speed, "Speed setting");

    82

    83

/* User Specified Duplex Override

    84

 *

    85

 * Valid Range: 0-2

    86

 *  - 0 - auto-negotiate for duplex

    87

 *  - 1 - only link at half duplex

    88

 *  - 2 - only link at full duplex

    89

 *

    90

 * Default Value: 0

    91

 */

    92

E1000_PARAM(Duplex, "Duplex setting");

    93

    94

/* Auto-negotiation Advertisement Override

    95

 *

    96

 * Valid Range: 0x01-0x0F, 0x20-0x2F (copper); 0x20 (fiber)

    97

 *

    98

 * The AutoNeg value is a bit mask describing which speed and duplex

    99

 * combinations should be advertised during auto-negotiation.

   100

 * The supported speed and duplex modes are listed below

   101

 *

   102

 * Bit           7     6     5      4      3     2     1      0

   103

 * Speed (Mbps)  N/A   N/A   1000   N/A    100   100   10     10

   104

 * Duplex                    Full          Full  Half  Full   Half

   105

 *

   106

 * Default Value: 0x2F (copper); 0x20 (fiber)

   107

 */

   108

E1000_PARAM(AutoNeg, "Advertised auto-negotiation setting");

   109

#define AUTONEG_ADV_DEFAULT  0x2F

   110

#define AUTONEG_ADV_MASK     0x2F

   111

   112

/* User Specified Flow Control Override

   113

 *

   114

 * Valid Range: 0-3

   115

 *  - 0 - No Flow Control

   116

 *  - 1 - Rx only, respond to PAUSE frames but do not generate them

   117

 *  - 2 - Tx only, generate PAUSE frames but ignore them on receive

   118

 *  - 3 - Full Flow Control Support

   119

 *

   120

 * Default Value: Read flow control settings from the EEPROM

   121

 */

   122

E1000_PARAM(FlowControl, "Flow Control setting");

   123

#define FLOW_CONTROL_DEFAULT FLOW_CONTROL_FULL

   124

   125

/* XsumRX - Receive Checksum Offload Enable/Disable

   126

 *

   127

 * Valid Range: 0, 1

   128

 *  - 0 - disables all checksum offload

   129

 *  - 1 - enables receive IP/TCP/UDP checksum offload

   130

 *        on 82543 and newer -based NICs

   131

 *

   132

 * Default Value: 1

   133

 */

   134

E1000_PARAM(XsumRX, "Disable or enable Receive Checksum offload");

   135

   136

/* Transmit Interrupt Delay in units of 1.024 microseconds

   137

 *  Tx interrupt delay needs to typically be set to something non zero

   138

 *

   139

 * Valid Range: 0-65535

   140

 */

   141

E1000_PARAM(TxIntDelay, "Transmit Interrupt Delay");

   142

#define DEFAULT_TIDV                   8

   143

#define MAX_TXDELAY               0xFFFF

   144

#define MIN_TXDELAY                    0

   145

   146

/* Transmit Absolute Interrupt Delay in units of 1.024 microseconds

   147

 *

   148

 * Valid Range: 0-65535

   149

 */

   150

E1000_PARAM(TxAbsIntDelay, "Transmit Absolute Interrupt Delay");

   151

#define DEFAULT_TADV                  32

   152

#define MAX_TXABSDELAY            0xFFFF

   153

#define MIN_TXABSDELAY                 0

   154

   155

/* Receive Interrupt Delay in units of 1.024 microseconds

   156

 *   hardware will likely hang if you set this to anything but zero.

   157

 *

   158

 * Valid Range: 0-65535

   159

 */

   160

E1000_PARAM(RxIntDelay, "Receive Interrupt Delay");

   161

#define DEFAULT_RDTR                   0

   162

#define MAX_RXDELAY               0xFFFF

   163

#define MIN_RXDELAY                    0

   164

   165

/* Receive Absolute Interrupt Delay in units of 1.024 microseconds

   166

 *

   167

 * Valid Range: 0-65535

   168

 */

   169

E1000_PARAM(RxAbsIntDelay, "Receive Absolute Interrupt Delay");

   170

#define DEFAULT_RADV                   8

   171

#define MAX_RXABSDELAY            0xFFFF

   172

#define MIN_RXABSDELAY                 0

   173

   174

/* Interrupt Throttle Rate (interrupts/sec)

   175

 *

   176

 * Valid Range: 100-100000 (0=off, 1=dynamic, 3=dynamic conservative)

   177

 */

   178

E1000_PARAM(InterruptThrottleRate, "Interrupt Throttling Rate");

   179

#define DEFAULT_ITR                    3

   180

#define MAX_ITR                   100000

   181

#define MIN_ITR                      100

   182

   183

/* Enable Smart Power Down of the PHY

   184

 *

   185

 * Valid Range: 0, 1

   186

 *

   187

 * Default Value: 0 (disabled)

   188

 */

   189

E1000_PARAM(SmartPowerDownEnable, "Enable PHY smart power down");

   190

   191

struct e1000_option {

   192

	enum { enable_option, range_option, list_option } type;

   193

	const char *name;

   194

	const char *err;

   195

	int def;

   196

	union {

   197

		struct { /* range_option info */

   198

			int min;

   199

			int max;

   200

		} r;

   201

		struct { /* list_option info */

   202

			int nr;

   203

			const struct e1000_opt_list { int i; char *str; } *p;

   204

		} l;

   205

	} arg;

   206

};

   207

   208

static int e1000_validate_option(unsigned int *value,

   209

				 const struct e1000_option *opt,

   210

				 struct e1000_adapter *adapter)

   211

{

   212

	if (*value == OPTION_UNSET) {

   213

		*value = opt->def;

   214

		return 0;

   215

	}

   216

   217

	switch (opt->type) {

   218

	case enable_option:

   219

		switch (*value) {

   220

		case OPTION_ENABLED:

   221

			e_dev_info("%s Enabled\n", opt->name);

   222

			return 0;

   223

		case OPTION_DISABLED:

   224

			e_dev_info("%s Disabled\n", opt->name);

   225

			return 0;

   226

		}

   227

		break;

   228

	case range_option:

   229

		if (*value >= opt->arg.r.min && *value <= opt->arg.r.max) {

   230

			e_dev_info("%s set to %i\n", opt->name, *value);

   231

			return 0;

   232

		}

   233

		break;

   234

	case list_option: {

   235

		int i;

   236

		const struct e1000_opt_list *ent;

   237

   238

		for (i = 0; i < opt->arg.l.nr; i++) {

   239

			ent = &opt->arg.l.p[i];

   240

			if (*value == ent->i) {

   241

				if (ent->str[0] != '\0')

   242

					e_dev_info("%s\n", ent->str);

   243

				return 0;

   244

			}

   245

		}

   246

	}

   247

		break;

   248

	default:

   249

		BUG();

   250

	}

   251

   252

	e_dev_info("Invalid %s value specified (%i) %s\n",

   253

	       opt->name, *value, opt->err);

   254

	*value = opt->def;

   255

	return -1;

   256

}

   257

   258

static void e1000_check_fiber_options(struct e1000_adapter *adapter);

   259

static void e1000_check_copper_options(struct e1000_adapter *adapter);

   260

   261

/**

   262

 * e1000_check_options - Range Checking for Command Line Parameters

   263

 * @adapter: board private structure

   264

 *

   265

 * This routine checks all command line parameters for valid user

   266

 * input.  If an invalid value is given, or if no user specified

   267

 * value exists, a default value is used.  The final value is stored

   268

 * in a variable in the adapter structure.

   269

 **/

   270

void e1000_check_options(struct e1000_adapter *adapter)

   271

{

   272

	struct e1000_option opt;

   273

	int bd = adapter->bd_number;

   274

   275

	if (bd >= E1000_MAX_NIC) {

   276

		e_dev_warn("Warning: no configuration for board #%i "

   277

			   "using defaults for all values\n", bd);

   278

	}

   279

   280

	{ /* Transmit Descriptor Count */

   281

		struct e1000_tx_ring *tx_ring = adapter->tx_ring;

   282

		int i;

   283

		e1000_mac_type mac_type = adapter->hw.mac_type;

   284

   285

		opt = (struct e1000_option) {

   286

			.type = range_option,

   287

			.name = "Transmit Descriptors",

   288

			.err  = "using default of "

   289

				__MODULE_STRING(E1000_DEFAULT_TXD),

   290

			.def  = E1000_DEFAULT_TXD,

   291

			.arg  = { .r = {

   292

				.min = E1000_MIN_TXD,

   293

				.max = mac_type < e1000_82544 ? E1000_MAX_TXD : E1000_MAX_82544_TXD

   294

				}}

   295

		};

   296

   297

		if (num_TxDescriptors > bd) {

   298

			tx_ring->count = TxDescriptors[bd];

   299

			e1000_validate_option(&tx_ring->count, &opt, adapter);

   300

			tx_ring->count = ALIGN(tx_ring->count,

   301

						REQ_TX_DESCRIPTOR_MULTIPLE);

   302

		} else {

   303

			tx_ring->count = opt.def;

   304

		}

   305

		for (i = 0; i < adapter->num_tx_queues; i++)

   306

			tx_ring[i].count = tx_ring->count;

   307

	}

   308

	{ /* Receive Descriptor Count */

   309

		struct e1000_rx_ring *rx_ring = adapter->rx_ring;

   310

		int i;

   311

		e1000_mac_type mac_type = adapter->hw.mac_type;

   312

   313

		opt = (struct e1000_option) {

   314

			.type = range_option,

   315

			.name = "Receive Descriptors",

   316

			.err  = "using default of "

   317

				__MODULE_STRING(E1000_DEFAULT_RXD),

   318

			.def  = E1000_DEFAULT_RXD,

   319

			.arg  = { .r = {

   320

				.min = E1000_MIN_RXD,

   321

				.max = mac_type < e1000_82544 ? E1000_MAX_RXD :

   322

				       E1000_MAX_82544_RXD

   323

			}}

   324

		};

   325

   326

		if (num_RxDescriptors > bd) {

   327

			rx_ring->count = RxDescriptors[bd];

   328

			e1000_validate_option(&rx_ring->count, &opt, adapter);

   329

			rx_ring->count = ALIGN(rx_ring->count,

   330

						REQ_RX_DESCRIPTOR_MULTIPLE);

   331

		} else {

   332

			rx_ring->count = opt.def;

   333

		}

   334

		for (i = 0; i < adapter->num_rx_queues; i++)

   335

			rx_ring[i].count = rx_ring->count;

   336

	}

   337

	{ /* Checksum Offload Enable/Disable */

   338

		opt = (struct e1000_option) {

   339

			.type = enable_option,

   340

			.name = "Checksum Offload",

   341

			.err  = "defaulting to Enabled",

   342

			.def  = OPTION_ENABLED

   343

		};

   344

   345

		if (num_XsumRX > bd) {

   346

			unsigned int rx_csum = XsumRX[bd];

   347

			e1000_validate_option(&rx_csum, &opt, adapter);

   348

			adapter->rx_csum = rx_csum;

   349

		} else {

   350

			adapter->rx_csum = opt.def;

   351

		}

   352

	}

   353

	{ /* Flow Control */

   354

   355

		static const struct e1000_opt_list fc_list[] = {

   356

		       { E1000_FC_NONE, "Flow Control Disabled" },

   357

		       { E1000_FC_RX_PAUSE, "Flow Control Receive Only" },

   358

		       { E1000_FC_TX_PAUSE, "Flow Control Transmit Only" },

   359

		       { E1000_FC_FULL, "Flow Control Enabled" },

   360

		       { E1000_FC_DEFAULT, "Flow Control Hardware Default" }

   361

		};

   362

   363

		opt = (struct e1000_option) {

   364

			.type = list_option,

   365

			.name = "Flow Control",

   366

			.err  = "reading default settings from EEPROM",

   367

			.def  = E1000_FC_DEFAULT,

   368

			.arg  = { .l = { .nr = ARRAY_SIZE(fc_list),

   369

					 .p = fc_list }}

   370

		};

   371

   372

		if (num_FlowControl > bd) {

   373

			unsigned int fc = FlowControl[bd];

   374

			e1000_validate_option(&fc, &opt, adapter);

   375

			adapter->hw.fc = adapter->hw.original_fc = fc;

   376

		} else {

   377

			adapter->hw.fc = adapter->hw.original_fc = opt.def;

   378

		}

   379

	}

   380

	{ /* Transmit Interrupt Delay */

   381

		opt = (struct e1000_option) {

   382

			.type = range_option,

   383

			.name = "Transmit Interrupt Delay",

   384

			.err  = "using default of " __MODULE_STRING(DEFAULT_TIDV),

   385

			.def  = DEFAULT_TIDV,

   386

			.arg  = { .r = { .min = MIN_TXDELAY,

   387

					 .max = MAX_TXDELAY }}

   388

		};

   389

   390

		if (num_TxIntDelay > bd) {

   391

			adapter->tx_int_delay = TxIntDelay[bd];

   392

			e1000_validate_option(&adapter->tx_int_delay, &opt,

   393

			                      adapter);

   394

		} else {

   395

			adapter->tx_int_delay = opt.def;

   396

		}

   397

	}

   398

	{ /* Transmit Absolute Interrupt Delay */

   399

		opt = (struct e1000_option) {

   400

			.type = range_option,

   401

			.name = "Transmit Absolute Interrupt Delay",

   402

			.err  = "using default of " __MODULE_STRING(DEFAULT_TADV),

   403

			.def  = DEFAULT_TADV,

   404

			.arg  = { .r = { .min = MIN_TXABSDELAY,

   405

					 .max = MAX_TXABSDELAY }}

   406

		};

   407

   408

		if (num_TxAbsIntDelay > bd) {

   409

			adapter->tx_abs_int_delay = TxAbsIntDelay[bd];

   410

			e1000_validate_option(&adapter->tx_abs_int_delay, &opt,

   411

					      adapter);

   412

		} else {

   413

			adapter->tx_abs_int_delay = opt.def;

   414

		}

   415

	}

   416

	{ /* Receive Interrupt Delay */

   417

		opt = (struct e1000_option) {

   418

			.type = range_option,

   419

			.name = "Receive Interrupt Delay",

   420

			.err  = "using default of " __MODULE_STRING(DEFAULT_RDTR),

   421

			.def  = DEFAULT_RDTR,

   422

			.arg  = { .r = { .min = MIN_RXDELAY,

   423

					 .max = MAX_RXDELAY }}

   424

		};

   425

   426

		if (num_RxIntDelay > bd) {

   427

			adapter->rx_int_delay = RxIntDelay[bd];

   428

			e1000_validate_option(&adapter->rx_int_delay, &opt,

   429

					      adapter);

   430

		} else {

   431

			adapter->rx_int_delay = opt.def;

   432

		}

   433

	}

   434

	{ /* Receive Absolute Interrupt Delay */

   435

		opt = (struct e1000_option) {

   436

			.type = range_option,

   437

			.name = "Receive Absolute Interrupt Delay",

   438

			.err  = "using default of " __MODULE_STRING(DEFAULT_RADV),

   439

			.def  = DEFAULT_RADV,

   440

			.arg  = { .r = { .min = MIN_RXABSDELAY,

   441

					 .max = MAX_RXABSDELAY }}

   442

		};

   443

   444

		if (num_RxAbsIntDelay > bd) {

   445

			adapter->rx_abs_int_delay = RxAbsIntDelay[bd];

   446

			e1000_validate_option(&adapter->rx_abs_int_delay, &opt,

   447

					      adapter);

   448

		} else {

   449

			adapter->rx_abs_int_delay = opt.def;

   450

		}

   451

	}

   452

	{ /* Interrupt Throttling Rate */

   453

		opt = (struct e1000_option) {

   454

			.type = range_option,

   455

			.name = "Interrupt Throttling Rate (ints/sec)",

   456

			.err  = "using default of " __MODULE_STRING(DEFAULT_ITR),

   457

			.def  = DEFAULT_ITR,

   458

			.arg  = { .r = { .min = MIN_ITR,

   459

					 .max = MAX_ITR }}

   460

		};

   461

   462

		if (num_InterruptThrottleRate > bd) {

   463

			adapter->itr = InterruptThrottleRate[bd];

   464

			switch (adapter->itr) {

   465

			case 0:

   466

				e_dev_info("%s turned off\n", opt.name);

   467

				break;

   468

			case 1:

   469

				e_dev_info("%s set to dynamic mode\n",

   470

					   opt.name);

   471

				adapter->itr_setting = adapter->itr;

   472

				adapter->itr = 20000;

   473

				break;

   474

			case 3:

   475

				e_dev_info("%s set to dynamic conservative "

   476

					   "mode\n", opt.name);

   477

				adapter->itr_setting = adapter->itr;

   478

				adapter->itr = 20000;

   479

				break;

   480

			case 4:

   481

				e_dev_info("%s set to simplified "

   482

					   "(2000-8000) ints mode\n", opt.name);

   483

				adapter->itr_setting = adapter->itr;

   484

				break;

   485

			default:

   486

				e1000_validate_option(&adapter->itr, &opt,

   487

						      adapter);

   488

				/* save the setting, because the dynamic bits

   489

				 * change itr.

   490

				 * clear the lower two bits because they are

   491

				 * used as control

   492

				 */

   493

				adapter->itr_setting = adapter->itr & ~3;

   494

				break;

   495

			}

   496

		} else {

   497

			adapter->itr_setting = opt.def;

   498

			adapter->itr = 20000;

   499

		}

   500

	}

   501

	{ /* Smart Power Down */

   502

		opt = (struct e1000_option) {

   503

			.type = enable_option,

   504

			.name = "PHY Smart Power Down",

   505

			.err  = "defaulting to Disabled",

   506

			.def  = OPTION_DISABLED

   507

		};

   508

   509

		if (num_SmartPowerDownEnable > bd) {

   510

			unsigned int spd = SmartPowerDownEnable[bd];

   511

			e1000_validate_option(&spd, &opt, adapter);

   512

			adapter->smart_power_down = spd;

   513

		} else {

   514

			adapter->smart_power_down = opt.def;

   515

		}

   516

	}

   517

   518

	switch (adapter->hw.media_type) {

   519

	case e1000_media_type_fiber:

   520

	case e1000_media_type_internal_serdes:

   521

		e1000_check_fiber_options(adapter);

   522

		break;

   523

	case e1000_media_type_copper:

   524

		e1000_check_copper_options(adapter);

   525

		break;

   526

	default:

   527

		BUG();

   528

	}

   529

}

   530