1 /*******************************************************************************
3 Intel PRO/10GbE Linux driver
4 Copyright(c) 1999 - 2008 Intel Corporation.
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.
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
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.
19 The full GNU General Public License is included in this distribution in
20 the file called "COPYING".
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
27 *******************************************************************************/
29 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
33 /* This is the only thing that needs to be changed to adjust the
34 * maximum number of ports that the driver can manage.
37 #define IXGB_MAX_NIC 8
39 #define OPTION_UNSET -1
40 #define OPTION_DISABLED 0
41 #define OPTION_ENABLED 1
43 /* All parameters are treated the same, as an integer array of values.
44 * This macro just reduces the need to repeat the same declaration code
45 * over and over (plus this helps to avoid typo bugs).
48 #define IXGB_PARAM_INIT { [0 ... IXGB_MAX_NIC] = OPTION_UNSET }
49 #define IXGB_PARAM(X, desc) \
50 static int __devinitdata X[IXGB_MAX_NIC+1] \
52 static unsigned int num_##X = 0; \
53 module_param_array_named(X, X, int, &num_##X, 0); \
54 MODULE_PARM_DESC(X, desc);
56 /* Transmit Descriptor Count
58 * Valid Range: 64-4096
63 IXGB_PARAM(TxDescriptors, "Number of transmit descriptors");
65 /* Receive Descriptor Count
67 * Valid Range: 64-4096
72 IXGB_PARAM(RxDescriptors, "Number of receive descriptors");
74 /* User Specified Flow Control Override
77 * - 0 - No Flow Control
78 * - 1 - Rx only, respond to PAUSE frames but do not generate them
79 * - 2 - Tx only, generate PAUSE frames but ignore them on receive
80 * - 3 - Full Flow Control Support
82 * Default Value: 2 - Tx only (silicon bug avoidance)
85 IXGB_PARAM(FlowControl, "Flow Control setting");
87 /* XsumRX - Receive Checksum Offload Enable/Disable
90 * - 0 - disables all checksum offload
91 * - 1 - enables receive IP/TCP/UDP checksum offload
97 IXGB_PARAM(XsumRX, "Disable or enable Receive Checksum offload");
99 /* Transmit Interrupt Delay in units of 0.8192 microseconds
101 * Valid Range: 0-65535
106 IXGB_PARAM(TxIntDelay, "Transmit Interrupt Delay");
108 /* Receive Interrupt Delay in units of 0.8192 microseconds
110 * Valid Range: 0-65535
115 IXGB_PARAM(RxIntDelay, "Receive Interrupt Delay");
117 /* Receive Flow control high threshold (when we send a pause frame)
120 * Valid Range: 1,536 - 262,136 (0x600 - 0x3FFF8, 8 byte granularity)
122 * Default Value: 196,608 (0x30000)
125 IXGB_PARAM(RxFCHighThresh, "Receive Flow Control High Threshold");
127 /* Receive Flow control low threshold (when we send a resume frame)
130 * Valid Range: 64 - 262,136 (0x40 - 0x3FFF8, 8 byte granularity)
131 * must be less than high threshold by at least 8 bytes
133 * Default Value: 163,840 (0x28000)
136 IXGB_PARAM(RxFCLowThresh, "Receive Flow Control Low Threshold");
138 /* Flow control request timeout (how long to pause the link partner's tx)
141 * Valid Range: 1 - 65535
143 * Default Value: 65535 (0xffff) (we'll send an xon if we recover)
146 IXGB_PARAM(FCReqTimeout, "Flow Control Request Timeout");
148 /* Interrupt Delay Enable
152 * - 0 - disables transmit interrupt delay
153 * - 1 - enables transmmit interrupt delay
158 IXGB_PARAM(IntDelayEnable, "Transmit Interrupt Delay Enable");
161 #define DEFAULT_TIDV 32
162 #define MAX_TIDV 0xFFFF
165 #define DEFAULT_RDTR 72
166 #define MAX_RDTR 0xFFFF
169 #define XSUMRX_DEFAULT OPTION_ENABLED
171 #define DEFAULT_FCRTL 0x28000
172 #define DEFAULT_FCRTH 0x30000
174 #define MAX_FCRTL 0x3FFE8
176 #define MAX_FCRTH 0x3FFF0
178 #define MIN_FCPAUSE 1
179 #define MAX_FCPAUSE 0xffff
180 #define DEFAULT_FCPAUSE 0xFFFF /* this may be too long */
183 enum { enable_option, range_option, list_option } type;
188 struct { /* range_option info */
192 struct { /* list_option info */
194 struct ixgb_opt_list {
203 ixgb_validate_option(unsigned int *value, const struct ixgb_option *opt)
205 if (*value == OPTION_UNSET) {
214 pr_info("%s Enabled\n", opt->name);
216 case OPTION_DISABLED:
217 pr_info("%s Disabled\n", opt->name);
222 if (*value >= opt->arg.r.min && *value <= opt->arg.r.max) {
223 pr_info("%s set to %i\n", opt->name, *value);
229 struct ixgb_opt_list *ent;
231 for (i = 0; i < opt->arg.l.nr; i++) {
232 ent = &opt->arg.l.p[i];
233 if (*value == ent->i) {
234 if (ent->str[0] != '\0')
235 pr_info("%s\n", ent->str);
245 pr_info("Invalid %s specified (%i) %s\n", opt->name, *value, opt->err);
251 * ixgb_check_options - Range Checking for Command Line Parameters
252 * @adapter: board private structure
254 * This routine checks all command line parameters for valid user
255 * input. If an invalid value is given, or if no user specified
256 * value exists, a default value is used. The final value is stored
257 * in a variable in the adapter structure.
261 ixgb_check_options(struct ixgb_adapter *adapter)
263 int bd = adapter->bd_number;
264 if (bd >= IXGB_MAX_NIC) {
265 pr_notice("Warning: no configuration for board #%i\n", bd);
266 pr_notice("Using defaults for all values\n");
269 { /* Transmit Descriptor Count */
270 const struct ixgb_option opt = {
271 .type = range_option,
272 .name = "Transmit Descriptors",
273 .err = "using default of " __MODULE_STRING(DEFAULT_TXD),
275 .arg = { .r = { .min = MIN_TXD,
278 struct ixgb_desc_ring *tx_ring = &adapter->tx_ring;
280 if (num_TxDescriptors > bd) {
281 tx_ring->count = TxDescriptors[bd];
282 ixgb_validate_option(&tx_ring->count, &opt);
284 tx_ring->count = opt.def;
286 tx_ring->count = ALIGN(tx_ring->count, IXGB_REQ_TX_DESCRIPTOR_MULTIPLE);
288 { /* Receive Descriptor Count */
289 const struct ixgb_option opt = {
290 .type = range_option,
291 .name = "Receive Descriptors",
292 .err = "using default of " __MODULE_STRING(DEFAULT_RXD),
294 .arg = { .r = { .min = MIN_RXD,
297 struct ixgb_desc_ring *rx_ring = &adapter->rx_ring;
299 if (num_RxDescriptors > bd) {
300 rx_ring->count = RxDescriptors[bd];
301 ixgb_validate_option(&rx_ring->count, &opt);
303 rx_ring->count = opt.def;
305 rx_ring->count = ALIGN(rx_ring->count, IXGB_REQ_RX_DESCRIPTOR_MULTIPLE);
307 { /* Receive Checksum Offload Enable */
308 const struct ixgb_option opt = {
309 .type = enable_option,
310 .name = "Receive Checksum Offload",
311 .err = "defaulting to Enabled",
312 .def = OPTION_ENABLED
315 if (num_XsumRX > bd) {
316 unsigned int rx_csum = XsumRX[bd];
317 ixgb_validate_option(&rx_csum, &opt);
318 adapter->rx_csum = rx_csum;
320 adapter->rx_csum = opt.def;
325 struct ixgb_opt_list fc_list[] =
326 {{ ixgb_fc_none, "Flow Control Disabled" },
327 { ixgb_fc_rx_pause,"Flow Control Receive Only" },
328 { ixgb_fc_tx_pause,"Flow Control Transmit Only" },
329 { ixgb_fc_full, "Flow Control Enabled" },
330 { ixgb_fc_default, "Flow Control Hardware Default" }};
332 const struct ixgb_option opt = {
334 .name = "Flow Control",
335 .err = "reading default settings from EEPROM",
336 .def = ixgb_fc_tx_pause,
337 .arg = { .l = { .nr = ARRAY_SIZE(fc_list),
341 if (num_FlowControl > bd) {
342 unsigned int fc = FlowControl[bd];
343 ixgb_validate_option(&fc, &opt);
344 adapter->hw.fc.type = fc;
346 adapter->hw.fc.type = opt.def;
349 { /* Receive Flow Control High Threshold */
350 const struct ixgb_option opt = {
351 .type = range_option,
352 .name = "Rx Flow Control High Threshold",
353 .err = "using default of " __MODULE_STRING(DEFAULT_FCRTH),
354 .def = DEFAULT_FCRTH,
355 .arg = { .r = { .min = MIN_FCRTH,
359 if (num_RxFCHighThresh > bd) {
360 adapter->hw.fc.high_water = RxFCHighThresh[bd];
361 ixgb_validate_option(&adapter->hw.fc.high_water, &opt);
363 adapter->hw.fc.high_water = opt.def;
365 if (!(adapter->hw.fc.type & ixgb_fc_tx_pause) )
366 pr_info("Ignoring RxFCHighThresh when no RxFC\n");
368 { /* Receive Flow Control Low Threshold */
369 const struct ixgb_option opt = {
370 .type = range_option,
371 .name = "Rx Flow Control Low Threshold",
372 .err = "using default of " __MODULE_STRING(DEFAULT_FCRTL),
373 .def = DEFAULT_FCRTL,
374 .arg = { .r = { .min = MIN_FCRTL,
378 if (num_RxFCLowThresh > bd) {
379 adapter->hw.fc.low_water = RxFCLowThresh[bd];
380 ixgb_validate_option(&adapter->hw.fc.low_water, &opt);
382 adapter->hw.fc.low_water = opt.def;
384 if (!(adapter->hw.fc.type & ixgb_fc_tx_pause) )
385 pr_info("Ignoring RxFCLowThresh when no RxFC\n");
387 { /* Flow Control Pause Time Request*/
388 const struct ixgb_option opt = {
389 .type = range_option,
390 .name = "Flow Control Pause Time Request",
391 .err = "using default of "__MODULE_STRING(DEFAULT_FCPAUSE),
392 .def = DEFAULT_FCPAUSE,
393 .arg = { .r = { .min = MIN_FCPAUSE,
397 if (num_FCReqTimeout > bd) {
398 unsigned int pause_time = FCReqTimeout[bd];
399 ixgb_validate_option(&pause_time, &opt);
400 adapter->hw.fc.pause_time = pause_time;
402 adapter->hw.fc.pause_time = opt.def;
404 if (!(adapter->hw.fc.type & ixgb_fc_tx_pause) )
405 pr_info("Ignoring FCReqTimeout when no RxFC\n");
407 /* high low and spacing check for rx flow control thresholds */
408 if (adapter->hw.fc.type & ixgb_fc_tx_pause) {
409 /* high must be greater than low */
410 if (adapter->hw.fc.high_water < (adapter->hw.fc.low_water + 8)) {
412 pr_info("RxFCHighThresh must be >= (RxFCLowThresh + 8), Using Defaults\n");
413 adapter->hw.fc.high_water = DEFAULT_FCRTH;
414 adapter->hw.fc.low_water = DEFAULT_FCRTL;
417 { /* Receive Interrupt Delay */
418 const struct ixgb_option opt = {
419 .type = range_option,
420 .name = "Receive Interrupt Delay",
421 .err = "using default of " __MODULE_STRING(DEFAULT_RDTR),
423 .arg = { .r = { .min = MIN_RDTR,
427 if (num_RxIntDelay > bd) {
428 adapter->rx_int_delay = RxIntDelay[bd];
429 ixgb_validate_option(&adapter->rx_int_delay, &opt);
431 adapter->rx_int_delay = opt.def;
434 { /* Transmit Interrupt Delay */
435 const struct ixgb_option opt = {
436 .type = range_option,
437 .name = "Transmit Interrupt Delay",
438 .err = "using default of " __MODULE_STRING(DEFAULT_TIDV),
440 .arg = { .r = { .min = MIN_TIDV,
444 if (num_TxIntDelay > bd) {
445 adapter->tx_int_delay = TxIntDelay[bd];
446 ixgb_validate_option(&adapter->tx_int_delay, &opt);
448 adapter->tx_int_delay = opt.def;
452 { /* Transmit Interrupt Delay Enable */
453 const struct ixgb_option opt = {
454 .type = enable_option,
455 .name = "Tx Interrupt Delay Enable",
456 .err = "defaulting to Enabled",
457 .def = OPTION_ENABLED
460 if (num_IntDelayEnable > bd) {
461 unsigned int ide = IntDelayEnable[bd];
462 ixgb_validate_option(&ide, &opt);
463 adapter->tx_int_delay_enable = ide;
465 adapter->tx_int_delay_enable = opt.def;