Linux Audio

Check our new training course

Loading...
v6.13.7
  1// SPDX-License-Identifier: GPL-2.0
  2/* Copyright(c) 1999 - 2018 Intel Corporation. */
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
  3
  4#include <linux/netdevice.h>
  5#include <linux/module.h>
  6#include <linux/pci.h>
  7
  8#include "e1000.h"
  9
 10/* This is the only thing that needs to be changed to adjust the
 
 11 * maximum number of ports that the driver can manage.
 12 */
 
 13#define E1000_MAX_NIC 32
 14
 15#define OPTION_UNSET   -1
 16#define OPTION_DISABLED 0
 17#define OPTION_ENABLED  1
 18
 19#define COPYBREAK_DEFAULT 256
 20unsigned int copybreak = COPYBREAK_DEFAULT;
 21module_param(copybreak, uint, 0644);
 22MODULE_PARM_DESC(copybreak,
 23		 "Maximum size of packet that is copied to a new buffer on receive");
 24
 25/* All parameters are treated the same, as an integer array of values.
 
 26 * This macro just reduces the need to repeat the same declaration code
 27 * over and over (plus this helps to avoid typo bugs).
 28 */
 
 29#define E1000_PARAM_INIT { [0 ... E1000_MAX_NIC] = OPTION_UNSET }
 30#define E1000_PARAM(X, desc)					\
 31	static int X[E1000_MAX_NIC+1] = E1000_PARAM_INIT;	\
 
 32	static unsigned int num_##X;				\
 33	module_param_array_named(X, X, int, &num_##X, 0);	\
 34	MODULE_PARM_DESC(X, desc);
 35
 36/* Transmit Interrupt Delay in units of 1.024 microseconds
 
 37 * Tx interrupt delay needs to typically be set to something non-zero
 38 *
 39 * Valid Range: 0-65535
 40 */
 41E1000_PARAM(TxIntDelay, "Transmit Interrupt Delay");
 42#define DEFAULT_TIDV 8
 43#define MAX_TXDELAY 0xFFFF
 44#define MIN_TXDELAY 0
 45
 46/* Transmit Absolute Interrupt Delay in units of 1.024 microseconds
 
 47 *
 48 * Valid Range: 0-65535
 49 */
 50E1000_PARAM(TxAbsIntDelay, "Transmit Absolute Interrupt Delay");
 51#define DEFAULT_TADV 32
 52#define MAX_TXABSDELAY 0xFFFF
 53#define MIN_TXABSDELAY 0
 54
 55/* Receive Interrupt Delay in units of 1.024 microseconds
 
 56 * hardware will likely hang if you set this to anything but zero.
 57 *
 58 * Burst variant is used as default if device has FLAG2_DMA_BURST.
 59 *
 60 * Valid Range: 0-65535
 61 */
 62E1000_PARAM(RxIntDelay, "Receive Interrupt Delay");
 63#define DEFAULT_RDTR	0
 64#define BURST_RDTR	0x20
 65#define MAX_RXDELAY 0xFFFF
 66#define MIN_RXDELAY 0
 67
 68/* Receive Absolute Interrupt Delay in units of 1.024 microseconds
 69 *
 70 * Burst variant is used as default if device has FLAG2_DMA_BURST.
 71 *
 72 * Valid Range: 0-65535
 73 */
 74E1000_PARAM(RxAbsIntDelay, "Receive Absolute Interrupt Delay");
 75#define DEFAULT_RADV	8
 76#define BURST_RADV	0x20
 77#define MAX_RXABSDELAY 0xFFFF
 78#define MIN_RXABSDELAY 0
 79
 80/* Interrupt Throttle Rate (interrupts/sec)
 
 81 *
 82 * Valid Range: 100-100000 or one of: 0=off, 1=dynamic, 3=dynamic conservative
 83 */
 84E1000_PARAM(InterruptThrottleRate, "Interrupt Throttling Rate");
 85#define DEFAULT_ITR 3
 86#define MAX_ITR 100000
 87#define MIN_ITR 100
 88
 89/* IntMode (Interrupt Mode)
 
 90 *
 91 * Valid Range: varies depending on kernel configuration & hardware support
 92 *
 93 * legacy=0, MSI=1, MSI-X=2
 94 *
 95 * When MSI/MSI-X support is enabled in kernel-
 96 *   Default Value: 2 (MSI-X) when supported by hardware, 1 (MSI) otherwise
 97 * When MSI/MSI-X support is not enabled in kernel-
 98 *   Default Value: 0 (legacy)
 99 *
100 * When a mode is specified that is not allowed/supported, it will be
101 * demoted to the most advanced interrupt mode available.
102 */
103E1000_PARAM(IntMode, "Interrupt Mode");
 
 
104
105/* Enable Smart Power Down of the PHY
 
106 *
107 * Valid Range: 0, 1
108 *
109 * Default Value: 0 (disabled)
110 */
111E1000_PARAM(SmartPowerDownEnable, "Enable PHY smart power down");
112
113/* Enable Kumeran Lock Loss workaround
 
114 *
115 * Valid Range: 0, 1
116 *
117 * Default Value: 1 (enabled)
118 */
119E1000_PARAM(KumeranLockLoss, "Enable Kumeran lock loss workaround");
120
121/* Write Protect NVM
 
122 *
123 * Valid Range: 0, 1
124 *
125 * Default Value: 1 (enabled)
126 */
127E1000_PARAM(WriteProtectNVM,
128	    "Write-protect NVM [WARNING: disabling this can lead to corrupted NVM]");
129
130/* Enable CRC Stripping
 
131 *
132 * Valid Range: 0, 1
133 *
134 * Default Value: 1 (enabled)
135 */
136E1000_PARAM(CrcStripping,
137	    "Enable CRC Stripping, disable if your BMC needs the CRC");
138
139struct e1000_option {
140	enum { enable_option, range_option, list_option } type;
141	const char *name;
142	const char *err;
143	int def;
144	union {
145		/* range_option info */
146		struct {
147			int min;
148			int max;
149		} r;
150		/* list_option info */
151		struct {
152			int nr;
153			struct e1000_opt_list {
154				int i;
155				char *str;
156			} *p;
157		} l;
158	} arg;
159};
160
161static int e1000_validate_option(unsigned int *value,
162				 const struct e1000_option *opt,
163				 struct e1000_adapter *adapter)
164{
165	if (*value == OPTION_UNSET) {
166		*value = opt->def;
167		return 0;
168	}
169
170	switch (opt->type) {
171	case enable_option:
172		switch (*value) {
173		case OPTION_ENABLED:
174			dev_info(&adapter->pdev->dev, "%s Enabled\n",
175				 opt->name);
176			return 0;
177		case OPTION_DISABLED:
178			dev_info(&adapter->pdev->dev, "%s Disabled\n",
179				 opt->name);
180			return 0;
181		}
182		break;
183	case range_option:
184		if (*value >= opt->arg.r.min && *value <= opt->arg.r.max) {
185			dev_info(&adapter->pdev->dev, "%s set to %i\n",
186				 opt->name, *value);
187			return 0;
188		}
189		break;
190	case list_option: {
191		int i;
192		struct e1000_opt_list *ent;
193
194		for (i = 0; i < opt->arg.l.nr; i++) {
195			ent = &opt->arg.l.p[i];
196			if (*value == ent->i) {
197				if (ent->str[0] != '\0')
198					dev_info(&adapter->pdev->dev, "%s\n",
199						 ent->str);
200				return 0;
201			}
202		}
203	}
204		break;
205	default:
206		BUG();
207	}
208
209	dev_info(&adapter->pdev->dev, "Invalid %s value specified (%i) %s\n",
210		 opt->name, *value, opt->err);
211	*value = opt->def;
212	return -1;
213}
214
215/**
216 * e1000e_check_options - Range Checking for Command Line Parameters
217 * @adapter: board private structure
218 *
219 * This routine checks all command line parameters for valid user
220 * input.  If an invalid value is given, or if no user specified
221 * value exists, a default value is used.  The final value is stored
222 * in a variable in the adapter structure.
223 **/
224void e1000e_check_options(struct e1000_adapter *adapter)
225{
226	struct e1000_hw *hw = &adapter->hw;
227	int bd = adapter->bd_number;
228
229	if (bd >= E1000_MAX_NIC) {
230		dev_notice(&adapter->pdev->dev,
231			   "Warning: no configuration for board #%i\n", bd);
232		dev_notice(&adapter->pdev->dev,
233			   "Using defaults for all values\n");
234	}
235
236	/* Transmit Interrupt Delay */
237	{
238		static const struct e1000_option opt = {
239			.type = range_option,
240			.name = "Transmit Interrupt Delay",
241			.err  = "using default of "
242				__MODULE_STRING(DEFAULT_TIDV),
243			.def  = DEFAULT_TIDV,
244			.arg  = { .r = { .min = MIN_TXDELAY,
245					 .max = MAX_TXDELAY } }
246		};
247
248		if (num_TxIntDelay > bd) {
249			adapter->tx_int_delay = TxIntDelay[bd];
250			e1000_validate_option(&adapter->tx_int_delay, &opt,
251					      adapter);
252		} else {
253			adapter->tx_int_delay = opt.def;
254		}
255	}
256	/* Transmit Absolute Interrupt Delay */
257	{
258		static const struct e1000_option opt = {
259			.type = range_option,
260			.name = "Transmit Absolute Interrupt Delay",
261			.err  = "using default of "
262				__MODULE_STRING(DEFAULT_TADV),
263			.def  = DEFAULT_TADV,
264			.arg  = { .r = { .min = MIN_TXABSDELAY,
265					 .max = MAX_TXABSDELAY } }
266		};
267
268		if (num_TxAbsIntDelay > bd) {
269			adapter->tx_abs_int_delay = TxAbsIntDelay[bd];
270			e1000_validate_option(&adapter->tx_abs_int_delay, &opt,
271					      adapter);
272		} else {
273			adapter->tx_abs_int_delay = opt.def;
274		}
275	}
276	/* Receive Interrupt Delay */
277	{
278		static struct e1000_option opt = {
279			.type = range_option,
280			.name = "Receive Interrupt Delay",
281			.err  = "using default of "
282				__MODULE_STRING(DEFAULT_RDTR),
283			.def  = DEFAULT_RDTR,
284			.arg  = { .r = { .min = MIN_RXDELAY,
285					 .max = MAX_RXDELAY } }
286		};
287
288		if (adapter->flags2 & FLAG2_DMA_BURST)
289			opt.def = BURST_RDTR;
290
291		if (num_RxIntDelay > bd) {
292			adapter->rx_int_delay = RxIntDelay[bd];
293			e1000_validate_option(&adapter->rx_int_delay, &opt,
294					      adapter);
295		} else {
296			adapter->rx_int_delay = opt.def;
297		}
298	}
299	/* Receive Absolute Interrupt Delay */
300	{
301		static struct e1000_option opt = {
302			.type = range_option,
303			.name = "Receive Absolute Interrupt Delay",
304			.err  = "using default of "
305				__MODULE_STRING(DEFAULT_RADV),
306			.def  = DEFAULT_RADV,
307			.arg  = { .r = { .min = MIN_RXABSDELAY,
308					 .max = MAX_RXABSDELAY } }
309		};
310
311		if (adapter->flags2 & FLAG2_DMA_BURST)
312			opt.def = BURST_RADV;
313
314		if (num_RxAbsIntDelay > bd) {
315			adapter->rx_abs_int_delay = RxAbsIntDelay[bd];
316			e1000_validate_option(&adapter->rx_abs_int_delay, &opt,
317					      adapter);
318		} else {
319			adapter->rx_abs_int_delay = opt.def;
320		}
321	}
322	/* Interrupt Throttling Rate */
323	{
324		static const struct e1000_option opt = {
325			.type = range_option,
326			.name = "Interrupt Throttling Rate (ints/sec)",
327			.err  = "using default of "
328				__MODULE_STRING(DEFAULT_ITR),
329			.def  = DEFAULT_ITR,
330			.arg  = { .r = { .min = MIN_ITR,
331					 .max = MAX_ITR } }
332		};
333
334		if (num_InterruptThrottleRate > bd) {
335			adapter->itr = InterruptThrottleRate[bd];
336
337			/* Make sure a message is printed for non-special
 
338			 * values. And in case of an invalid option, display
339			 * warning, use default and go through itr/itr_setting
340			 * adjustment logic below
341			 */
342			if ((adapter->itr > 4) &&
343			    e1000_validate_option(&adapter->itr, &opt, adapter))
344				adapter->itr = opt.def;
345		} else {
346			/* If no option specified, use default value and go
 
347			 * through the logic below to adjust itr/itr_setting
348			 */
349			adapter->itr = opt.def;
350
351			/* Make sure a message is printed for non-special
 
352			 * default values
353			 */
354			if (adapter->itr > 4)
355				dev_info(&adapter->pdev->dev,
356					 "%s set to default %d\n", opt.name,
357					 adapter->itr);
358		}
359
360		adapter->itr_setting = adapter->itr;
361		switch (adapter->itr) {
362		case 0:
363			dev_info(&adapter->pdev->dev, "%s turned off\n",
364				 opt.name);
365			break;
366		case 1:
367			dev_info(&adapter->pdev->dev,
368				 "%s set to dynamic mode\n", opt.name);
369			adapter->itr = 20000;
370			break;
371		case 2:
372			dev_info(&adapter->pdev->dev,
373				 "%s Invalid mode - setting default\n",
374				 opt.name);
375			adapter->itr_setting = opt.def;
376			fallthrough;
377		case 3:
378			dev_info(&adapter->pdev->dev,
379				 "%s set to dynamic conservative mode\n",
380				 opt.name);
381			adapter->itr = 20000;
382			break;
383		case 4:
384			dev_info(&adapter->pdev->dev,
385				 "%s set to simplified (2000-8000 ints) mode\n",
386				 opt.name);
387			break;
388		default:
389			/* Save the setting, because the dynamic bits
 
390			 * change itr.
391			 *
392			 * Clear the lower two bits because
393			 * they are used as control.
394			 */
395			adapter->itr_setting &= ~3;
396			break;
397		}
398	}
399	/* Interrupt Mode */
400	{
401		static struct e1000_option opt = {
402			.type = range_option,
403			.name = "Interrupt Mode",
404#ifndef CONFIG_PCI_MSI
405			.err  = "defaulting to 0 (legacy)",
406			.def  = E1000E_INT_MODE_LEGACY,
407			.arg  = { .r = { .min = 0,
408					 .max = 0 } }
409#endif
410		};
411
412#ifdef CONFIG_PCI_MSI
413		if (adapter->flags & FLAG_HAS_MSIX) {
414			opt.err = kstrdup("defaulting to 2 (MSI-X)",
415					  GFP_KERNEL);
416			opt.def = E1000E_INT_MODE_MSIX;
417			opt.arg.r.max = E1000E_INT_MODE_MSIX;
418		} else {
419			opt.err = kstrdup("defaulting to 1 (MSI)", GFP_KERNEL);
420			opt.def = E1000E_INT_MODE_MSI;
421			opt.arg.r.max = E1000E_INT_MODE_MSI;
422		}
423
424		if (!opt.err) {
425			dev_err(&adapter->pdev->dev,
426				"Failed to allocate memory\n");
427			return;
428		}
429#endif
430
431		if (num_IntMode > bd) {
432			unsigned int int_mode = IntMode[bd];
433
434			e1000_validate_option(&int_mode, &opt, adapter);
435			adapter->int_mode = int_mode;
436		} else {
437			adapter->int_mode = opt.def;
438		}
439
440#ifdef CONFIG_PCI_MSI
441		kfree(opt.err);
442#endif
443	}
444	/* Smart Power Down */
445	{
446		static const struct e1000_option opt = {
447			.type = enable_option,
448			.name = "PHY Smart Power Down",
449			.err  = "defaulting to Disabled",
450			.def  = OPTION_DISABLED
451		};
452
453		if (num_SmartPowerDownEnable > bd) {
454			unsigned int spd = SmartPowerDownEnable[bd];
455
456			e1000_validate_option(&spd, &opt, adapter);
457			if ((adapter->flags & FLAG_HAS_SMART_POWER_DOWN) && spd)
 
458				adapter->flags |= FLAG_SMART_POWER_DOWN;
459		}
460	}
461	/* CRC Stripping */
462	{
463		static const struct e1000_option opt = {
464			.type = enable_option,
465			.name = "CRC Stripping",
466			.err  = "defaulting to Enabled",
467			.def  = OPTION_ENABLED
468		};
469
470		if (num_CrcStripping > bd) {
471			unsigned int crc_stripping = CrcStripping[bd];
472
473			e1000_validate_option(&crc_stripping, &opt, adapter);
474			if (crc_stripping == OPTION_ENABLED) {
475				adapter->flags2 |= FLAG2_CRC_STRIPPING;
476				adapter->flags2 |= FLAG2_DFLT_CRC_STRIPPING;
477			}
478		} else {
479			adapter->flags2 |= FLAG2_CRC_STRIPPING;
480			adapter->flags2 |= FLAG2_DFLT_CRC_STRIPPING;
481		}
482	}
483	/* Kumeran Lock Loss Workaround */
484	{
485		static const struct e1000_option opt = {
486			.type = enable_option,
487			.name = "Kumeran Lock Loss Workaround",
488			.err  = "defaulting to Enabled",
489			.def  = OPTION_ENABLED
490		};
491		bool enabled = opt.def;
492
493		if (num_KumeranLockLoss > bd) {
494			unsigned int kmrn_lock_loss = KumeranLockLoss[bd];
495
496			e1000_validate_option(&kmrn_lock_loss, &opt, adapter);
497			enabled = kmrn_lock_loss;
 
 
 
 
 
 
498		}
499
500		if (hw->mac.type == e1000_ich8lan)
501			e1000e_set_kmrn_lock_loss_workaround_ich8lan(hw,
502								     enabled);
503	}
504	/* Write-protect NVM */
505	{
506		static const struct e1000_option opt = {
507			.type = enable_option,
508			.name = "Write-protect NVM",
509			.err  = "defaulting to Enabled",
510			.def  = OPTION_ENABLED
511		};
512
513		if (adapter->flags & FLAG_IS_ICH) {
514			if (num_WriteProtectNVM > bd) {
515				unsigned int write_protect_nvm =
516				    WriteProtectNVM[bd];
517				e1000_validate_option(&write_protect_nvm, &opt,
518						      adapter);
519				if (write_protect_nvm)
520					adapter->flags |= FLAG_READ_ONLY_NVM;
521			} else {
522				if (opt.def)
523					adapter->flags |= FLAG_READ_ONLY_NVM;
524			}
525		}
526	}
527}
v3.5.6
  1/*******************************************************************************
  2
  3  Intel PRO/1000 Linux driver
  4  Copyright(c) 1999 - 2012 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 <linux/netdevice.h>
 30#include <linux/module.h>
 31#include <linux/pci.h>
 32
 33#include "e1000.h"
 34
 35/*
 36 * This is the only thing that needs to be changed to adjust the
 37 * maximum number of ports that the driver can manage.
 38 */
 39
 40#define E1000_MAX_NIC 32
 41
 42#define OPTION_UNSET   -1
 43#define OPTION_DISABLED 0
 44#define OPTION_ENABLED  1
 45
 46#define COPYBREAK_DEFAULT 256
 47unsigned int copybreak = COPYBREAK_DEFAULT;
 48module_param(copybreak, uint, 0644);
 49MODULE_PARM_DESC(copybreak,
 50	"Maximum size of packet that is copied to a new buffer on receive");
 51
 52/*
 53 * All parameters are treated the same, as an integer array of values.
 54 * This macro just reduces the need to repeat the same declaration code
 55 * over and over (plus this helps to avoid typo bugs).
 56 */
 57
 58#define E1000_PARAM_INIT { [0 ... E1000_MAX_NIC] = OPTION_UNSET }
 59#define E1000_PARAM(X, desc)					\
 60	static int __devinitdata X[E1000_MAX_NIC+1]		\
 61		= E1000_PARAM_INIT;				\
 62	static unsigned int num_##X;				\
 63	module_param_array_named(X, X, int, &num_##X, 0);	\
 64	MODULE_PARM_DESC(X, desc);
 65
 66/*
 67 * Transmit Interrupt Delay in units of 1.024 microseconds
 68 * Tx interrupt delay needs to typically be set to something non-zero
 69 *
 70 * Valid Range: 0-65535
 71 */
 72E1000_PARAM(TxIntDelay, "Transmit Interrupt Delay");
 73#define DEFAULT_TIDV 8
 74#define MAX_TXDELAY 0xFFFF
 75#define MIN_TXDELAY 0
 76
 77/*
 78 * Transmit Absolute Interrupt Delay in units of 1.024 microseconds
 79 *
 80 * Valid Range: 0-65535
 81 */
 82E1000_PARAM(TxAbsIntDelay, "Transmit Absolute Interrupt Delay");
 83#define DEFAULT_TADV 32
 84#define MAX_TXABSDELAY 0xFFFF
 85#define MIN_TXABSDELAY 0
 86
 87/*
 88 * Receive Interrupt Delay in units of 1.024 microseconds
 89 * hardware will likely hang if you set this to anything but zero.
 90 *
 
 
 91 * Valid Range: 0-65535
 92 */
 93E1000_PARAM(RxIntDelay, "Receive Interrupt Delay");
 
 
 94#define MAX_RXDELAY 0xFFFF
 95#define MIN_RXDELAY 0
 96
 97/*
 98 * Receive Absolute Interrupt Delay in units of 1.024 microseconds
 
 99 *
100 * Valid Range: 0-65535
101 */
102E1000_PARAM(RxAbsIntDelay, "Receive Absolute Interrupt Delay");
 
 
103#define MAX_RXABSDELAY 0xFFFF
104#define MIN_RXABSDELAY 0
105
106/*
107 * Interrupt Throttle Rate (interrupts/sec)
108 *
109 * Valid Range: 100-100000 or one of: 0=off, 1=dynamic, 3=dynamic conservative
110 */
111E1000_PARAM(InterruptThrottleRate, "Interrupt Throttling Rate");
112#define DEFAULT_ITR 3
113#define MAX_ITR 100000
114#define MIN_ITR 100
115
116/*
117 * IntMode (Interrupt Mode)
118 *
119 * Valid Range: varies depending on kernel configuration & hardware support
120 *
121 * legacy=0, MSI=1, MSI-X=2
122 *
123 * When MSI/MSI-X support is enabled in kernel-
124 *   Default Value: 2 (MSI-X) when supported by hardware, 1 (MSI) otherwise
125 * When MSI/MSI-X support is not enabled in kernel-
126 *   Default Value: 0 (legacy)
127 *
128 * When a mode is specified that is not allowed/supported, it will be
129 * demoted to the most advanced interrupt mode available.
130 */
131E1000_PARAM(IntMode, "Interrupt Mode");
132#define MAX_INTMODE	2
133#define MIN_INTMODE	0
134
135/*
136 * Enable Smart Power Down of the PHY
137 *
138 * Valid Range: 0, 1
139 *
140 * Default Value: 0 (disabled)
141 */
142E1000_PARAM(SmartPowerDownEnable, "Enable PHY smart power down");
143
144/*
145 * Enable Kumeran Lock Loss workaround
146 *
147 * Valid Range: 0, 1
148 *
149 * Default Value: 1 (enabled)
150 */
151E1000_PARAM(KumeranLockLoss, "Enable Kumeran lock loss workaround");
152
153/*
154 * Write Protect NVM
155 *
156 * Valid Range: 0, 1
157 *
158 * Default Value: 1 (enabled)
159 */
160E1000_PARAM(WriteProtectNVM, "Write-protect NVM [WARNING: disabling this can lead to corrupted NVM]");
 
161
162/*
163 * Enable CRC Stripping
164 *
165 * Valid Range: 0, 1
166 *
167 * Default Value: 1 (enabled)
168 */
169E1000_PARAM(CrcStripping,
170	    "Enable CRC Stripping, disable if your BMC needs the CRC");
171
172struct e1000_option {
173	enum { enable_option, range_option, list_option } type;
174	const char *name;
175	const char *err;
176	int def;
177	union {
178		struct { /* range_option info */
 
179			int min;
180			int max;
181		} r;
182		struct { /* list_option info */
 
183			int nr;
184			struct e1000_opt_list { int i; char *str; } *p;
 
 
 
185		} l;
186	} arg;
187};
188
189static int __devinit e1000_validate_option(unsigned int *value,
190					   const struct e1000_option *opt,
191					   struct e1000_adapter *adapter)
192{
193	if (*value == OPTION_UNSET) {
194		*value = opt->def;
195		return 0;
196	}
197
198	switch (opt->type) {
199	case enable_option:
200		switch (*value) {
201		case OPTION_ENABLED:
202			e_info("%s Enabled\n", opt->name);
 
203			return 0;
204		case OPTION_DISABLED:
205			e_info("%s Disabled\n", opt->name);
 
206			return 0;
207		}
208		break;
209	case range_option:
210		if (*value >= opt->arg.r.min && *value <= opt->arg.r.max) {
211			e_info("%s set to %i\n", opt->name, *value);
 
212			return 0;
213		}
214		break;
215	case list_option: {
216		int i;
217		struct e1000_opt_list *ent;
218
219		for (i = 0; i < opt->arg.l.nr; i++) {
220			ent = &opt->arg.l.p[i];
221			if (*value == ent->i) {
222				if (ent->str[0] != '\0')
223					e_info("%s\n", ent->str);
 
224				return 0;
225			}
226		}
227	}
228		break;
229	default:
230		BUG();
231	}
232
233	e_info("Invalid %s value specified (%i) %s\n", opt->name, *value,
234	       opt->err);
235	*value = opt->def;
236	return -1;
237}
238
239/**
240 * e1000e_check_options - Range Checking for Command Line Parameters
241 * @adapter: board private structure
242 *
243 * This routine checks all command line parameters for valid user
244 * input.  If an invalid value is given, or if no user specified
245 * value exists, a default value is used.  The final value is stored
246 * in a variable in the adapter structure.
247 **/
248void __devinit e1000e_check_options(struct e1000_adapter *adapter)
249{
250	struct e1000_hw *hw = &adapter->hw;
251	int bd = adapter->bd_number;
252
253	if (bd >= E1000_MAX_NIC) {
254		e_notice("Warning: no configuration for board #%i\n", bd);
255		e_notice("Using defaults for all values\n");
 
 
256	}
257
258	{ /* Transmit Interrupt Delay */
 
259		static const struct e1000_option opt = {
260			.type = range_option,
261			.name = "Transmit Interrupt Delay",
262			.err  = "using default of "
263				__MODULE_STRING(DEFAULT_TIDV),
264			.def  = DEFAULT_TIDV,
265			.arg  = { .r = { .min = MIN_TXDELAY,
266					 .max = MAX_TXDELAY } }
267		};
268
269		if (num_TxIntDelay > bd) {
270			adapter->tx_int_delay = TxIntDelay[bd];
271			e1000_validate_option(&adapter->tx_int_delay, &opt,
272					      adapter);
273		} else {
274			adapter->tx_int_delay = opt.def;
275		}
276	}
277	{ /* Transmit Absolute Interrupt Delay */
 
278		static const struct e1000_option opt = {
279			.type = range_option,
280			.name = "Transmit Absolute Interrupt Delay",
281			.err  = "using default of "
282				__MODULE_STRING(DEFAULT_TADV),
283			.def  = DEFAULT_TADV,
284			.arg  = { .r = { .min = MIN_TXABSDELAY,
285					 .max = MAX_TXABSDELAY } }
286		};
287
288		if (num_TxAbsIntDelay > bd) {
289			adapter->tx_abs_int_delay = TxAbsIntDelay[bd];
290			e1000_validate_option(&adapter->tx_abs_int_delay, &opt,
291					      adapter);
292		} else {
293			adapter->tx_abs_int_delay = opt.def;
294		}
295	}
296	{ /* Receive Interrupt Delay */
 
297		static struct e1000_option opt = {
298			.type = range_option,
299			.name = "Receive Interrupt Delay",
300			.err  = "using default of "
301				__MODULE_STRING(DEFAULT_RDTR),
302			.def  = DEFAULT_RDTR,
303			.arg  = { .r = { .min = MIN_RXDELAY,
304					 .max = MAX_RXDELAY } }
305		};
306
 
 
 
307		if (num_RxIntDelay > bd) {
308			adapter->rx_int_delay = RxIntDelay[bd];
309			e1000_validate_option(&adapter->rx_int_delay, &opt,
310					      adapter);
311		} else {
312			adapter->rx_int_delay = opt.def;
313		}
314	}
315	{ /* Receive Absolute Interrupt Delay */
316		static const struct e1000_option opt = {
 
317			.type = range_option,
318			.name = "Receive Absolute Interrupt Delay",
319			.err  = "using default of "
320				__MODULE_STRING(DEFAULT_RADV),
321			.def  = DEFAULT_RADV,
322			.arg  = { .r = { .min = MIN_RXABSDELAY,
323					 .max = MAX_RXABSDELAY } }
324		};
325
 
 
 
326		if (num_RxAbsIntDelay > bd) {
327			adapter->rx_abs_int_delay = RxAbsIntDelay[bd];
328			e1000_validate_option(&adapter->rx_abs_int_delay, &opt,
329					      adapter);
330		} else {
331			adapter->rx_abs_int_delay = opt.def;
332		}
333	}
334	{ /* Interrupt Throttling Rate */
 
335		static const struct e1000_option opt = {
336			.type = range_option,
337			.name = "Interrupt Throttling Rate (ints/sec)",
338			.err  = "using default of "
339				__MODULE_STRING(DEFAULT_ITR),
340			.def  = DEFAULT_ITR,
341			.arg  = { .r = { .min = MIN_ITR,
342					 .max = MAX_ITR } }
343		};
344
345		if (num_InterruptThrottleRate > bd) {
346			adapter->itr = InterruptThrottleRate[bd];
347
348			/*
349			 * Make sure a message is printed for non-special
350			 * values. And in case of an invalid option, display
351			 * warning, use default and go through itr/itr_setting
352			 * adjustment logic below
353			 */
354			if ((adapter->itr > 4) &&
355			    e1000_validate_option(&adapter->itr, &opt, adapter))
356				adapter->itr = opt.def;
357		} else {
358			/*
359			 * If no option specified, use default value and go
360			 * through the logic below to adjust itr/itr_setting
361			 */
362			adapter->itr = opt.def;
363
364			/*
365			 * Make sure a message is printed for non-special
366			 * default values
367			 */
368			if (adapter->itr > 4)
369				e_info("%s set to default %d\n", opt.name,
370				       adapter->itr);
 
371		}
372
373		adapter->itr_setting = adapter->itr;
374		switch (adapter->itr) {
375		case 0:
376			e_info("%s turned off\n", opt.name);
 
377			break;
378		case 1:
379			e_info("%s set to dynamic mode\n", opt.name);
 
380			adapter->itr = 20000;
381			break;
 
 
 
 
 
 
382		case 3:
383			e_info("%s set to dynamic conservative mode\n",
384			       opt.name);
 
385			adapter->itr = 20000;
386			break;
387		case 4:
388			e_info("%s set to simplified (2000-8000 ints) mode\n",
389			       opt.name);
 
390			break;
391		default:
392			/*
393			 * Save the setting, because the dynamic bits
394			 * change itr.
395			 *
396			 * Clear the lower two bits because
397			 * they are used as control.
398			 */
399			adapter->itr_setting &= ~3;
400			break;
401		}
402	}
403	{ /* Interrupt Mode */
 
404		static struct e1000_option opt = {
405			.type = range_option,
406			.name = "Interrupt Mode",
407#ifndef CONFIG_PCI_MSI
408			.err  = "defaulting to 0 (legacy)",
409			.def  = E1000E_INT_MODE_LEGACY,
410			.arg  = { .r = { .min = 0,
411					 .max = 0 } }
412#endif
413		};
414
415#ifdef CONFIG_PCI_MSI
416		if (adapter->flags & FLAG_HAS_MSIX) {
417			opt.err = kstrdup("defaulting to 2 (MSI-X)",
418					  GFP_KERNEL);
419			opt.def = E1000E_INT_MODE_MSIX;
420			opt.arg.r.max = E1000E_INT_MODE_MSIX;
421		} else {
422			opt.err = kstrdup("defaulting to 1 (MSI)", GFP_KERNEL);
423			opt.def = E1000E_INT_MODE_MSI;
424			opt.arg.r.max = E1000E_INT_MODE_MSI;
425		}
426
427		if (!opt.err) {
428			dev_err(&adapter->pdev->dev,
429				"Failed to allocate memory\n");
430			return;
431		}
432#endif
433
434		if (num_IntMode > bd) {
435			unsigned int int_mode = IntMode[bd];
 
436			e1000_validate_option(&int_mode, &opt, adapter);
437			adapter->int_mode = int_mode;
438		} else {
439			adapter->int_mode = opt.def;
440		}
441
442#ifdef CONFIG_PCI_MSI
443		kfree(opt.err);
444#endif
445	}
446	{ /* Smart Power Down */
 
447		static const struct e1000_option opt = {
448			.type = enable_option,
449			.name = "PHY Smart Power Down",
450			.err  = "defaulting to Disabled",
451			.def  = OPTION_DISABLED
452		};
453
454		if (num_SmartPowerDownEnable > bd) {
455			unsigned int spd = SmartPowerDownEnable[bd];
 
456			e1000_validate_option(&spd, &opt, adapter);
457			if ((adapter->flags & FLAG_HAS_SMART_POWER_DOWN)
458			    && spd)
459				adapter->flags |= FLAG_SMART_POWER_DOWN;
460		}
461	}
462	{ /* CRC Stripping */
 
463		static const struct e1000_option opt = {
464			.type = enable_option,
465			.name = "CRC Stripping",
466			.err  = "defaulting to Enabled",
467			.def  = OPTION_ENABLED
468		};
469
470		if (num_CrcStripping > bd) {
471			unsigned int crc_stripping = CrcStripping[bd];
 
472			e1000_validate_option(&crc_stripping, &opt, adapter);
473			if (crc_stripping == OPTION_ENABLED) {
474				adapter->flags2 |= FLAG2_CRC_STRIPPING;
475				adapter->flags2 |= FLAG2_DFLT_CRC_STRIPPING;
476			}
477		} else {
478			adapter->flags2 |= FLAG2_CRC_STRIPPING;
479			adapter->flags2 |= FLAG2_DFLT_CRC_STRIPPING;
480		}
481	}
482	{ /* Kumeran Lock Loss Workaround */
 
483		static const struct e1000_option opt = {
484			.type = enable_option,
485			.name = "Kumeran Lock Loss Workaround",
486			.err  = "defaulting to Enabled",
487			.def  = OPTION_ENABLED
488		};
 
489
490		if (num_KumeranLockLoss > bd) {
491			unsigned int kmrn_lock_loss = KumeranLockLoss[bd];
 
492			e1000_validate_option(&kmrn_lock_loss, &opt, adapter);
493			if (hw->mac.type == e1000_ich8lan)
494				e1000e_set_kmrn_lock_loss_workaround_ich8lan(hw,
495								kmrn_lock_loss);
496		} else {
497			if (hw->mac.type == e1000_ich8lan)
498				e1000e_set_kmrn_lock_loss_workaround_ich8lan(hw,
499								       opt.def);
500		}
 
 
 
 
501	}
502	{ /* Write-protect NVM */
 
503		static const struct e1000_option opt = {
504			.type = enable_option,
505			.name = "Write-protect NVM",
506			.err  = "defaulting to Enabled",
507			.def  = OPTION_ENABLED
508		};
509
510		if (adapter->flags & FLAG_IS_ICH) {
511			if (num_WriteProtectNVM > bd) {
512				unsigned int write_protect_nvm = WriteProtectNVM[bd];
 
513				e1000_validate_option(&write_protect_nvm, &opt,
514						      adapter);
515				if (write_protect_nvm)
516					adapter->flags |= FLAG_READ_ONLY_NVM;
517			} else {
518				if (opt.def)
519					adapter->flags |= FLAG_READ_ONLY_NVM;
520			}
521		}
522	}
523}