fp@2219: /*******************************************************************************
fp@2219: 
fp@2219:   Intel PRO/1000 Linux driver
fp@2219:   Copyright(c) 1999 - 2010 Intel Corporation.
fp@2219: 
fp@2219:   This program is free software; you can redistribute it and/or modify it
fp@2219:   under the terms and conditions of the GNU General Public License,
fp@2219:   version 2, as published by the Free Software Foundation.
fp@2219: 
fp@2219:   This program is distributed in the hope it will be useful, but WITHOUT
fp@2219:   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
fp@2219:   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
fp@2219:   more details.
fp@2219: 
fp@2219:   You should have received a copy of the GNU General Public License along with
fp@2219:   this program; if not, write to the Free Software Foundation, Inc.,
fp@2219:   51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
fp@2219: 
fp@2219:   The full GNU General Public License is included in this distribution in
fp@2219:   the file called "COPYING".
fp@2219: 
fp@2219:   Contact Information:
fp@2219:   Linux NICS <linux.nics@intel.com>
fp@2219:   e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
fp@2219:   Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
fp@2219: 
fp@2219: *******************************************************************************/
fp@2219: 
fp@2219: #include <linux/netdevice.h>
fp@2219: #include <linux/pci.h>
fp@2219: 
fp@2219: #include "e1000-2.6.37-ethercat.h"
fp@2219: 
fp@2219: int entropy = 0;
fp@2219: module_param(entropy, int, 0);
fp@2219: MODULE_PARM_DESC(entropy, "Allow e1000e to populate the /dev/random entropy pool");
fp@2219: 
fp@2219: /*
fp@2219:  * This is the only thing that needs to be changed to adjust the
fp@2219:  * maximum number of ports that the driver can manage.
fp@2219:  */
fp@2219: 
fp@2219: #define E1000_MAX_NIC 32
fp@2219: 
fp@2219: #define OPTION_UNSET   -1
fp@2219: #define OPTION_DISABLED 0
fp@2219: #define OPTION_ENABLED  1
fp@2219: 
fp@2219: #define COPYBREAK_DEFAULT 256
fp@2219: unsigned int copybreak = COPYBREAK_DEFAULT;
fp@2219: module_param(copybreak, uint, 0644);
fp@2219: MODULE_PARM_DESC(copybreak,
fp@2219: 	"Maximum size of packet that is copied to a new buffer on receive");
fp@2219: 
fp@2219: /*
fp@2219:  * All parameters are treated the same, as an integer array of values.
fp@2219:  * This macro just reduces the need to repeat the same declaration code
fp@2219:  * over and over (plus this helps to avoid typo bugs).
fp@2219:  */
fp@2219: 
fp@2219: #define E1000_PARAM_INIT { [0 ... E1000_MAX_NIC] = OPTION_UNSET }
fp@2219: #define E1000_PARAM(X, desc)					\
fp@2219: 	static int __devinitdata X[E1000_MAX_NIC+1]		\
fp@2219: 		= E1000_PARAM_INIT;				\
fp@2219: 	static unsigned int num_##X;				\
fp@2219: 	module_param_array_named(X, X, int, &num_##X, 0);	\
fp@2219: 	MODULE_PARM_DESC(X, desc);
fp@2219: 
fp@2219: 
fp@2219: /*
fp@2219:  * Transmit Interrupt Delay in units of 1.024 microseconds
fp@2219:  * Tx interrupt delay needs to typically be set to something non zero
fp@2219:  *
fp@2219:  * Valid Range: 0-65535
fp@2219:  */
fp@2219: E1000_PARAM(TxIntDelay, "Transmit Interrupt Delay");
fp@2219: #define DEFAULT_TIDV 8
fp@2219: #define MAX_TXDELAY 0xFFFF
fp@2219: #define MIN_TXDELAY 0
fp@2219: 
fp@2219: /*
fp@2219:  * Transmit Absolute Interrupt Delay in units of 1.024 microseconds
fp@2219:  *
fp@2219:  * Valid Range: 0-65535
fp@2219:  */
fp@2219: E1000_PARAM(TxAbsIntDelay, "Transmit Absolute Interrupt Delay");
fp@2219: #define DEFAULT_TADV 32
fp@2219: #define MAX_TXABSDELAY 0xFFFF
fp@2219: #define MIN_TXABSDELAY 0
fp@2219: 
fp@2219: /*
fp@2219:  * Receive Interrupt Delay in units of 1.024 microseconds
fp@2219:  * hardware will likely hang if you set this to anything but zero.
fp@2219:  *
fp@2219:  * Valid Range: 0-65535
fp@2219:  */
fp@2219: E1000_PARAM(RxIntDelay, "Receive Interrupt Delay");
fp@2219: #define MAX_RXDELAY 0xFFFF
fp@2219: #define MIN_RXDELAY 0
fp@2219: 
fp@2219: /*
fp@2219:  * Receive Absolute Interrupt Delay in units of 1.024 microseconds
fp@2219:  *
fp@2219:  * Valid Range: 0-65535
fp@2219:  */
fp@2219: E1000_PARAM(RxAbsIntDelay, "Receive Absolute Interrupt Delay");
fp@2219: #define MAX_RXABSDELAY 0xFFFF
fp@2219: #define MIN_RXABSDELAY 0
fp@2219: 
fp@2219: /*
fp@2219:  * Interrupt Throttle Rate (interrupts/sec)
fp@2219:  *
fp@2219:  * Valid Range: 100-100000 (0=off, 1=dynamic, 3=dynamic conservative)
fp@2219:  */
fp@2219: E1000_PARAM(InterruptThrottleRate, "Interrupt Throttling Rate");
fp@2219: #define DEFAULT_ITR 3
fp@2219: #define MAX_ITR 100000
fp@2219: #define MIN_ITR 100
fp@2219: /* IntMode (Interrupt Mode)
fp@2219:  *
fp@2219:  * Valid Range: 0 - 2
fp@2219:  *
fp@2219:  * Default Value: 2 (MSI-X)
fp@2219:  */
fp@2219: E1000_PARAM(IntMode, "Interrupt Mode");
fp@2219: #define MAX_INTMODE	2
fp@2219: #define MIN_INTMODE	0
fp@2219: 
fp@2219: /*
fp@2219:  * Enable Smart Power Down of the PHY
fp@2219:  *
fp@2219:  * Valid Range: 0, 1
fp@2219:  *
fp@2219:  * Default Value: 0 (disabled)
fp@2219:  */
fp@2219: E1000_PARAM(SmartPowerDownEnable, "Enable PHY smart power down");
fp@2219: 
fp@2219: /*
fp@2219:  * Enable Kumeran Lock Loss workaround
fp@2219:  *
fp@2219:  * Valid Range: 0, 1
fp@2219:  *
fp@2219:  * Default Value: 1 (enabled)
fp@2219:  */
fp@2219: E1000_PARAM(KumeranLockLoss, "Enable Kumeran lock loss workaround");
fp@2219: 
fp@2219: /*
fp@2219:  * Write Protect NVM
fp@2219:  *
fp@2219:  * Valid Range: 0, 1
fp@2219:  *
fp@2219:  * Default Value: 1 (enabled)
fp@2219:  */
fp@2219: E1000_PARAM(WriteProtectNVM, "Write-protect NVM [WARNING: disabling this can lead to corrupted NVM]");
fp@2219: 
fp@2219: /*
fp@2219:  * Enable CRC Stripping
fp@2219:  *
fp@2219:  * Valid Range: 0, 1
fp@2219:  *
fp@2219:  * Default Value: 1 (enabled)
fp@2219:  */
fp@2219: E1000_PARAM(CrcStripping, "Enable CRC Stripping, disable if your BMC needs " \
fp@2219:                           "the CRC");
fp@2219: 
fp@2219: struct e1000_option {
fp@2219: 	enum { enable_option, range_option, list_option } type;
fp@2219: 	const char *name;
fp@2219: 	const char *err;
fp@2219: 	int def;
fp@2219: 	union {
fp@2219: 		struct { /* range_option info */
fp@2219: 			int min;
fp@2219: 			int max;
fp@2219: 		} r;
fp@2219: 		struct { /* list_option info */
fp@2219: 			int nr;
fp@2219: 			struct e1000_opt_list { int i; char *str; } *p;
fp@2219: 		} l;
fp@2219: 	} arg;
fp@2219: };
fp@2219: 
fp@2219: static int __devinit e1000_validate_option(unsigned int *value,
fp@2219: 					   const struct e1000_option *opt,
fp@2219: 					   struct e1000_adapter *adapter)
fp@2219: {
fp@2219: 	if (*value == OPTION_UNSET) {
fp@2219: 		*value = opt->def;
fp@2219: 		return 0;
fp@2219: 	}
fp@2219: 
fp@2219: 	switch (opt->type) {
fp@2219: 	case enable_option:
fp@2219: 		switch (*value) {
fp@2219: 		case OPTION_ENABLED:
fp@2219: 			e_info("%s Enabled\n", opt->name);
fp@2219: 			return 0;
fp@2219: 		case OPTION_DISABLED:
fp@2219: 			e_info("%s Disabled\n", opt->name);
fp@2219: 			return 0;
fp@2219: 		}
fp@2219: 		break;
fp@2219: 	case range_option:
fp@2219: 		if (*value >= opt->arg.r.min && *value <= opt->arg.r.max) {
fp@2219: 			e_info("%s set to %i\n", opt->name, *value);
fp@2219: 			return 0;
fp@2219: 		}
fp@2219: 		break;
fp@2219: 	case list_option: {
fp@2219: 		int i;
fp@2219: 		struct e1000_opt_list *ent;
fp@2219: 
fp@2219: 		for (i = 0; i < opt->arg.l.nr; i++) {
fp@2219: 			ent = &opt->arg.l.p[i];
fp@2219: 			if (*value == ent->i) {
fp@2219: 				if (ent->str[0] != '\0')
fp@2219: 					e_info("%s\n", ent->str);
fp@2219: 				return 0;
fp@2219: 			}
fp@2219: 		}
fp@2219: 	}
fp@2219: 		break;
fp@2219: 	default:
fp@2219: 		BUG();
fp@2219: 	}
fp@2219: 
fp@2219: 	e_info("Invalid %s value specified (%i) %s\n", opt->name, *value,
fp@2219: 	       opt->err);
fp@2219: 	*value = opt->def;
fp@2219: 	return -1;
fp@2219: }
fp@2219: 
fp@2219: /**
fp@2219:  * e1000e_check_options - Range Checking for Command Line Parameters
fp@2219:  * @adapter: board private structure
fp@2219:  *
fp@2219:  * This routine checks all command line parameters for valid user
fp@2219:  * input.  If an invalid value is given, or if no user specified
fp@2219:  * value exists, a default value is used.  The final value is stored
fp@2219:  * in a variable in the adapter structure.
fp@2219:  **/
fp@2219: void __devinit e1000e_check_options(struct e1000_adapter *adapter)
fp@2219: {
fp@2219: 	struct e1000_hw *hw = &adapter->hw;
fp@2219: 	int bd = adapter->bd_number;
fp@2219: 
fp@2219: 	if (bd >= E1000_MAX_NIC) {
fp@2219: 		e_notice("Warning: no configuration for board #%i\n", bd);
fp@2219: 		e_notice("Using defaults for all values\n");
fp@2219: 	}
fp@2219: 
fp@2219: 	{ /* Transmit Interrupt Delay */
fp@2219: 		static const struct e1000_option opt = {
fp@2219: 			.type = range_option,
fp@2219: 			.name = "Transmit Interrupt Delay",
fp@2219: 			.err  = "using default of "
fp@2219: 				__MODULE_STRING(DEFAULT_TIDV),
fp@2219: 			.def  = DEFAULT_TIDV,
fp@2219: 			.arg  = { .r = { .min = MIN_TXDELAY,
fp@2219: 					 .max = MAX_TXDELAY } }
fp@2219: 		};
fp@2219: 
fp@2219: 		if (num_TxIntDelay > bd) {
fp@2219: 			adapter->tx_int_delay = TxIntDelay[bd];
fp@2219: 			e1000_validate_option(&adapter->tx_int_delay, &opt,
fp@2219: 					      adapter);
fp@2219: 		} else {
fp@2219: 			adapter->tx_int_delay = opt.def;
fp@2219: 		}
fp@2219: 	}
fp@2219: 	{ /* Transmit Absolute Interrupt Delay */
fp@2219: 		static const struct e1000_option opt = {
fp@2219: 			.type = range_option,
fp@2219: 			.name = "Transmit Absolute Interrupt Delay",
fp@2219: 			.err  = "using default of "
fp@2219: 				__MODULE_STRING(DEFAULT_TADV),
fp@2219: 			.def  = DEFAULT_TADV,
fp@2219: 			.arg  = { .r = { .min = MIN_TXABSDELAY,
fp@2219: 					 .max = MAX_TXABSDELAY } }
fp@2219: 		};
fp@2219: 
fp@2219: 		if (num_TxAbsIntDelay > bd) {
fp@2219: 			adapter->tx_abs_int_delay = TxAbsIntDelay[bd];
fp@2219: 			e1000_validate_option(&adapter->tx_abs_int_delay, &opt,
fp@2219: 					      adapter);
fp@2219: 		} else {
fp@2219: 			adapter->tx_abs_int_delay = opt.def;
fp@2219: 		}
fp@2219: 	}
fp@2219: 	{ /* Receive Interrupt Delay */
fp@2219: 		static struct e1000_option opt = {
fp@2219: 			.type = range_option,
fp@2219: 			.name = "Receive Interrupt Delay",
fp@2219: 			.err  = "using default of "
fp@2219: 				__MODULE_STRING(DEFAULT_RDTR),
fp@2219: 			.def  = DEFAULT_RDTR,
fp@2219: 			.arg  = { .r = { .min = MIN_RXDELAY,
fp@2219: 					 .max = MAX_RXDELAY } }
fp@2219: 		};
fp@2219: 
fp@2219: 		if (num_RxIntDelay > bd) {
fp@2219: 			adapter->rx_int_delay = RxIntDelay[bd];
fp@2219: 			e1000_validate_option(&adapter->rx_int_delay, &opt,
fp@2219: 					      adapter);
fp@2219: 		} else {
fp@2219: 			adapter->rx_int_delay = opt.def;
fp@2219: 		}
fp@2219: 	}
fp@2219: 	{ /* Receive Absolute Interrupt Delay */
fp@2219: 		static const struct e1000_option opt = {
fp@2219: 			.type = range_option,
fp@2219: 			.name = "Receive Absolute Interrupt Delay",
fp@2219: 			.err  = "using default of "
fp@2219: 				__MODULE_STRING(DEFAULT_RADV),
fp@2219: 			.def  = DEFAULT_RADV,
fp@2219: 			.arg  = { .r = { .min = MIN_RXABSDELAY,
fp@2219: 					 .max = MAX_RXABSDELAY } }
fp@2219: 		};
fp@2219: 
fp@2219: 		if (num_RxAbsIntDelay > bd) {
fp@2219: 			adapter->rx_abs_int_delay = RxAbsIntDelay[bd];
fp@2219: 			e1000_validate_option(&adapter->rx_abs_int_delay, &opt,
fp@2219: 					      adapter);
fp@2219: 		} else {
fp@2219: 			adapter->rx_abs_int_delay = opt.def;
fp@2219: 		}
fp@2219: 	}
fp@2219: 	{ /* Interrupt Throttling Rate */
fp@2219: 		static const struct e1000_option opt = {
fp@2219: 			.type = range_option,
fp@2219: 			.name = "Interrupt Throttling Rate (ints/sec)",
fp@2219: 			.err  = "using default of "
fp@2219: 				__MODULE_STRING(DEFAULT_ITR),
fp@2219: 			.def  = DEFAULT_ITR,
fp@2219: 			.arg  = { .r = { .min = MIN_ITR,
fp@2219: 					 .max = MAX_ITR } }
fp@2219: 		};
fp@2219: 
fp@2219: 		if (num_InterruptThrottleRate > bd) {
fp@2219: 			adapter->itr = InterruptThrottleRate[bd];
fp@2219: 			switch (adapter->itr) {
fp@2219: 			case 0:
fp@2219: 				e_info("%s turned off\n", opt.name);
fp@2219: 				break;
fp@2219: 			case 1:
fp@2219: 				e_info("%s set to dynamic mode\n", opt.name);
fp@2219: 				adapter->itr_setting = adapter->itr;
fp@2219: 				adapter->itr = 20000;
fp@2219: 				break;
fp@2219: 			case 3:
fp@2219: 				e_info("%s set to dynamic conservative mode\n",
fp@2219: 					opt.name);
fp@2219: 				adapter->itr_setting = adapter->itr;
fp@2219: 				adapter->itr = 20000;
fp@2219: 				break;
fp@2219: 			case 4:
fp@2219: 				e_info("%s set to simplified (2000-8000 ints) "
fp@2219: 				       "mode\n", opt.name);
fp@2219: 				adapter->itr_setting = 4;
fp@2219: 				break;
fp@2219: 			default:
fp@2219: 				/*
fp@2219: 				 * Save the setting, because the dynamic bits
fp@2219: 				 * change itr.
fp@2219: 				 */
fp@2219: 				if (e1000_validate_option(&adapter->itr, &opt,
fp@2219: 							  adapter) &&
fp@2219: 				    (adapter->itr == 3)) {
fp@2219: 					/*
fp@2219: 					 * In case of invalid user value,
fp@2219: 					 * default to conservative mode.
fp@2219: 					 */
fp@2219: 					adapter->itr_setting = adapter->itr;
fp@2219: 					adapter->itr = 20000;
fp@2219: 				} else {
fp@2219: 					/*
fp@2219: 					 * Clear the lower two bits because
fp@2219: 					 * they are used as control.
fp@2219: 					 */
fp@2219: 					adapter->itr_setting =
fp@2219: 						adapter->itr & ~3;
fp@2219: 				}
fp@2219: 				break;
fp@2219: 			}
fp@2219: 		} else {
fp@2219: 			adapter->itr_setting = opt.def;
fp@2219: 			adapter->itr = 20000;
fp@2219: 		}
fp@2219: 	}
fp@2219: 	{ /* Interrupt Mode */
fp@2219: 		static struct e1000_option opt = {
fp@2219: 			.type = range_option,
fp@2219: 			.name = "Interrupt Mode",
fp@2219: 			.err  = "defaulting to 2 (MSI-X)",
fp@2219: 			.def  = E1000E_INT_MODE_MSIX,
fp@2219: 			.arg  = { .r = { .min = MIN_INTMODE,
fp@2219: 					 .max = MAX_INTMODE } }
fp@2219: 		};
fp@2219: 
fp@2219: 		if (num_IntMode > bd) {
fp@2219: 			unsigned int int_mode = IntMode[bd];
fp@2219: 			e1000_validate_option(&int_mode, &opt, adapter);
fp@2219: 			adapter->int_mode = int_mode;
fp@2219: 		} else {
fp@2219: 			adapter->int_mode = opt.def;
fp@2219: 		}
fp@2219: 	}
fp@2219: 	{ /* Smart Power Down */
fp@2219: 		static const struct e1000_option opt = {
fp@2219: 			.type = enable_option,
fp@2219: 			.name = "PHY Smart Power Down",
fp@2219: 			.err  = "defaulting to Disabled",
fp@2219: 			.def  = OPTION_DISABLED
fp@2219: 		};
fp@2219: 
fp@2219: 		if (num_SmartPowerDownEnable > bd) {
fp@2219: 			unsigned int spd = SmartPowerDownEnable[bd];
fp@2219: 			e1000_validate_option(&spd, &opt, adapter);
fp@2219: 			if ((adapter->flags & FLAG_HAS_SMART_POWER_DOWN)
fp@2219: 			    && spd)
fp@2219: 				adapter->flags |= FLAG_SMART_POWER_DOWN;
fp@2219: 		}
fp@2219: 	}
fp@2219: 	{ /* CRC Stripping */
fp@2219: 		static const struct e1000_option opt = {
fp@2219: 			.type = enable_option,
fp@2219: 			.name = "CRC Stripping",
fp@2219: 			.err  = "defaulting to enabled",
fp@2219: 			.def  = OPTION_ENABLED
fp@2219: 		};
fp@2219: 
fp@2219: 		if (num_CrcStripping > bd) {
fp@2219: 			unsigned int crc_stripping = CrcStripping[bd];
fp@2219: 			e1000_validate_option(&crc_stripping, &opt, adapter);
fp@2219: 			if (crc_stripping == OPTION_ENABLED)
fp@2219: 				adapter->flags2 |= FLAG2_CRC_STRIPPING;
fp@2219: 		} else {
fp@2219: 			adapter->flags2 |= FLAG2_CRC_STRIPPING;
fp@2219: 		}
fp@2219: 	}
fp@2219: 	{ /* Kumeran Lock Loss Workaround */
fp@2219: 		static const struct e1000_option opt = {
fp@2219: 			.type = enable_option,
fp@2219: 			.name = "Kumeran Lock Loss Workaround",
fp@2219: 			.err  = "defaulting to Enabled",
fp@2219: 			.def  = OPTION_ENABLED
fp@2219: 		};
fp@2219: 
fp@2219: 		if (num_KumeranLockLoss > bd) {
fp@2219: 			unsigned int kmrn_lock_loss = KumeranLockLoss[bd];
fp@2219: 			e1000_validate_option(&kmrn_lock_loss, &opt, adapter);
fp@2219: 			if (hw->mac.type == e1000_ich8lan)
fp@2219: 				e1000e_set_kmrn_lock_loss_workaround_ich8lan(hw,
fp@2219: 								kmrn_lock_loss);
fp@2219: 		} else {
fp@2219: 			if (hw->mac.type == e1000_ich8lan)
fp@2219: 				e1000e_set_kmrn_lock_loss_workaround_ich8lan(hw,
fp@2219: 								       opt.def);
fp@2219: 		}
fp@2219: 	}
fp@2219: 	{ /* Write-protect NVM */
fp@2219: 		static const struct e1000_option opt = {
fp@2219: 			.type = enable_option,
fp@2219: 			.name = "Write-protect NVM",
fp@2219: 			.err  = "defaulting to Enabled",
fp@2219: 			.def  = OPTION_ENABLED
fp@2219: 		};
fp@2219: 
fp@2219: 		if (adapter->flags & FLAG_IS_ICH) {
fp@2219: 			if (num_WriteProtectNVM > bd) {
fp@2219: 				unsigned int write_protect_nvm = WriteProtectNVM[bd];
fp@2219: 				e1000_validate_option(&write_protect_nvm, &opt,
fp@2219: 						      adapter);
fp@2219: 				if (write_protect_nvm)
fp@2219: 					adapter->flags |= FLAG_READ_ONLY_NVM;
fp@2219: 			} else {
fp@2219: 				if (opt.def)
fp@2219: 					adapter->flags |= FLAG_READ_ONLY_NVM;
fp@2219: 			}
fp@2219: 		}
fp@2219: 	}
fp@2219: }