1 /*******************************************************************************
4 Copyright(c) 1999 - 2005 Intel Corporation. All rights reserved.
6 This program is free software; you can redistribute it and/or modify it
7 under the terms of the GNU General Public License as published by the Free
8 Software Foundation; either version 2 of the License, or (at your option)
11 This program is distributed in the hope that it will be useful, but WITHOUT
12 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
16 You should have received a copy of the GNU General Public License along with
17 this program; if not, write to the Free Software Foundation, Inc., 59
18 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
20 The full GNU General Public License is included in this distribution in the
24 Linux NICS <linux.nics@intel.com>
25 Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
27 *******************************************************************************/
31 /* This is the only thing that needs to be changed to adjust the
32 * maximum number of ports that the driver can manage.
35 #define E1000_MAX_NIC 32
37 #define OPTION_UNSET -1
38 #define OPTION_DISABLED 0
39 #define OPTION_ENABLED 1
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).
46 #define E1000_PARAM_INIT { [0 ... E1000_MAX_NIC] = OPTION_UNSET }
47 #define E1000_PARAM(X, desc) \
48 static int __devinitdata X[E1000_MAX_NIC+1] = E1000_PARAM_INIT; \
49 static int num_##X = 0; \
50 module_param_array_named(X, X, int, &num_##X, 0); \
51 MODULE_PARM_DESC(X, desc);
53 /* Transmit Descriptor Count
55 * Valid Range: 80-256 for 82542 and 82543 gigabit ethernet controllers
56 * Valid Range: 80-4096 for 82544 and newer
61 E1000_PARAM(TxDescriptors, "Number of transmit descriptors");
63 /* Receive Descriptor Count
65 * Valid Range: 80-256 for 82542 and 82543 gigabit ethernet controllers
66 * Valid Range: 80-4096 for 82544 and newer
71 E1000_PARAM(RxDescriptors, "Number of receive descriptors");
73 /* User Specified Speed Override
75 * Valid Range: 0, 10, 100, 1000
76 * - 0 - auto-negotiate at all supported speeds
77 * - 10 - only link at 10 Mbps
78 * - 100 - only link at 100 Mbps
79 * - 1000 - only link at 1000 Mbps
84 E1000_PARAM(Speed, "Speed setting");
86 /* User Specified Duplex Override
89 * - 0 - auto-negotiate for duplex
90 * - 1 - only link at half duplex
91 * - 2 - only link at full duplex
96 E1000_PARAM(Duplex, "Duplex setting");
98 /* Auto-negotiation Advertisement Override
100 * Valid Range: 0x01-0x0F, 0x20-0x2F (copper); 0x20 (fiber)
102 * The AutoNeg value is a bit mask describing which speed and duplex
103 * combinations should be advertised during auto-negotiation.
104 * The supported speed and duplex modes are listed below
106 * Bit 7 6 5 4 3 2 1 0
107 * Speed (Mbps) N/A N/A 1000 N/A 100 100 10 10
108 * Duplex Full Full Half Full Half
110 * Default Value: 0x2F (copper); 0x20 (fiber)
113 E1000_PARAM(AutoNeg, "Advertised auto-negotiation setting");
115 /* User Specified Flow Control Override
118 * - 0 - No Flow Control
119 * - 1 - Rx only, respond to PAUSE frames but do not generate them
120 * - 2 - Tx only, generate PAUSE frames but ignore them on receive
121 * - 3 - Full Flow Control Support
123 * Default Value: Read flow control settings from the EEPROM
126 E1000_PARAM(FlowControl, "Flow Control setting");
128 /* XsumRX - Receive Checksum Offload Enable/Disable
131 * - 0 - disables all checksum offload
132 * - 1 - enables receive IP/TCP/UDP checksum offload
133 * on 82543 and newer -based NICs
138 E1000_PARAM(XsumRX, "Disable or enable Receive Checksum offload");
140 /* Transmit Interrupt Delay in units of 1.024 microseconds
142 * Valid Range: 0-65535
147 E1000_PARAM(TxIntDelay, "Transmit Interrupt Delay");
149 /* Transmit Absolute Interrupt Delay in units of 1.024 microseconds
151 * Valid Range: 0-65535
156 E1000_PARAM(TxAbsIntDelay, "Transmit Absolute Interrupt Delay");
158 /* Receive Interrupt Delay in units of 1.024 microseconds
160 * Valid Range: 0-65535
165 E1000_PARAM(RxIntDelay, "Receive Interrupt Delay");
167 /* Receive Absolute Interrupt Delay in units of 1.024 microseconds
169 * Valid Range: 0-65535
174 E1000_PARAM(RxAbsIntDelay, "Receive Absolute Interrupt Delay");
176 /* Interrupt Throttle Rate (interrupts/sec)
178 * Valid Range: 100-100000 (0=off, 1=dynamic)
180 * Default Value: 8000
183 E1000_PARAM(InterruptThrottleRate, "Interrupt Throttling Rate");
185 #define AUTONEG_ADV_DEFAULT 0x2F
186 #define AUTONEG_ADV_MASK 0x2F
187 #define FLOW_CONTROL_DEFAULT FLOW_CONTROL_FULL
189 #define DEFAULT_RDTR 0
190 #define MAX_RXDELAY 0xFFFF
191 #define MIN_RXDELAY 0
193 #define DEFAULT_RADV 128
194 #define MAX_RXABSDELAY 0xFFFF
195 #define MIN_RXABSDELAY 0
197 #define DEFAULT_TIDV 64
198 #define MAX_TXDELAY 0xFFFF
199 #define MIN_TXDELAY 0
201 #define DEFAULT_TADV 64
202 #define MAX_TXABSDELAY 0xFFFF
203 #define MIN_TXABSDELAY 0
205 #define DEFAULT_ITR 8000
206 #define MAX_ITR 100000
209 struct e1000_option {
210 enum { enable_option, range_option, list_option } type;
215 struct { /* range_option info */
219 struct { /* list_option info */
221 struct e1000_opt_list { int i; char *str; } *p;
227 e1000_validate_option(int *value, struct e1000_option *opt,
228 struct e1000_adapter *adapter)
230 if(*value == OPTION_UNSET) {
239 DPRINTK(PROBE, INFO, "%s Enabled\n", opt->name);
241 case OPTION_DISABLED:
242 DPRINTK(PROBE, INFO, "%s Disabled\n", opt->name);
247 if(*value >= opt->arg.r.min && *value <= opt->arg.r.max) {
249 "%s set to %i\n", opt->name, *value);
255 struct e1000_opt_list *ent;
257 for(i = 0; i < opt->arg.l.nr; i++) {
258 ent = &opt->arg.l.p[i];
259 if(*value == ent->i) {
260 if(ent->str[0] != '\0')
261 DPRINTK(PROBE, INFO, "%s\n", ent->str);
271 DPRINTK(PROBE, INFO, "Invalid %s specified (%i) %s\n",
272 opt->name, *value, opt->err);
277 static void e1000_check_fiber_options(struct e1000_adapter *adapter);
278 static void e1000_check_copper_options(struct e1000_adapter *adapter);
281 * e1000_check_options - Range Checking for Command Line Parameters
282 * @adapter: board private structure
284 * This routine checks all command line parameters for valid user
285 * input. If an invalid value is given, or if no user specified
286 * value exists, a default value is used. The final value is stored
287 * in a variable in the adapter structure.
291 e1000_check_options(struct e1000_adapter *adapter)
293 int bd = adapter->bd_number;
294 if(bd >= E1000_MAX_NIC) {
295 DPRINTK(PROBE, NOTICE,
296 "Warning: no configuration for board #%i\n", bd);
297 DPRINTK(PROBE, NOTICE, "Using defaults for all values\n");
300 { /* Transmit Descriptor Count */
301 struct e1000_option opt = {
302 .type = range_option,
303 .name = "Transmit Descriptors",
304 .err = "using default of "
305 __MODULE_STRING(E1000_DEFAULT_TXD),
306 .def = E1000_DEFAULT_TXD,
307 .arg = { .r = { .min = E1000_MIN_TXD }}
309 struct e1000_tx_ring *tx_ring = adapter->tx_ring;
311 e1000_mac_type mac_type = adapter->hw.mac_type;
312 opt.arg.r.max = mac_type < e1000_82544 ?
313 E1000_MAX_TXD : E1000_MAX_82544_TXD;
315 if (num_TxDescriptors > bd) {
316 tx_ring->count = TxDescriptors[bd];
317 e1000_validate_option(&tx_ring->count, &opt, adapter);
318 E1000_ROUNDUP(tx_ring->count,
319 REQ_TX_DESCRIPTOR_MULTIPLE);
321 tx_ring->count = opt.def;
323 for (i = 0; i < adapter->num_tx_queues; i++)
324 tx_ring[i].count = tx_ring->count;
326 { /* Receive Descriptor Count */
327 struct e1000_option opt = {
328 .type = range_option,
329 .name = "Receive Descriptors",
330 .err = "using default of "
331 __MODULE_STRING(E1000_DEFAULT_RXD),
332 .def = E1000_DEFAULT_RXD,
333 .arg = { .r = { .min = E1000_MIN_RXD }}
335 struct e1000_rx_ring *rx_ring = adapter->rx_ring;
337 e1000_mac_type mac_type = adapter->hw.mac_type;
338 opt.arg.r.max = mac_type < e1000_82544 ? E1000_MAX_RXD :
341 if (num_RxDescriptors > bd) {
342 rx_ring->count = RxDescriptors[bd];
343 e1000_validate_option(&rx_ring->count, &opt, adapter);
344 E1000_ROUNDUP(rx_ring->count,
345 REQ_RX_DESCRIPTOR_MULTIPLE);
347 rx_ring->count = opt.def;
349 for (i = 0; i < adapter->num_rx_queues; i++)
350 rx_ring[i].count = rx_ring->count;
352 { /* Checksum Offload Enable/Disable */
353 struct e1000_option opt = {
354 .type = enable_option,
355 .name = "Checksum Offload",
356 .err = "defaulting to Enabled",
357 .def = OPTION_ENABLED
360 if (num_XsumRX > bd) {
361 int rx_csum = XsumRX[bd];
362 e1000_validate_option(&rx_csum, &opt, adapter);
363 adapter->rx_csum = rx_csum;
365 adapter->rx_csum = opt.def;
370 struct e1000_opt_list fc_list[] =
371 {{ e1000_fc_none, "Flow Control Disabled" },
372 { e1000_fc_rx_pause,"Flow Control Receive Only" },
373 { e1000_fc_tx_pause,"Flow Control Transmit Only" },
374 { e1000_fc_full, "Flow Control Enabled" },
375 { e1000_fc_default, "Flow Control Hardware Default" }};
377 struct e1000_option opt = {
379 .name = "Flow Control",
380 .err = "reading default settings from EEPROM",
381 .def = e1000_fc_default,
382 .arg = { .l = { .nr = ARRAY_SIZE(fc_list),
386 if (num_FlowControl > bd) {
387 int fc = FlowControl[bd];
388 e1000_validate_option(&fc, &opt, adapter);
389 adapter->hw.fc = adapter->hw.original_fc = fc;
391 adapter->hw.fc = adapter->hw.original_fc = opt.def;
394 { /* Transmit Interrupt Delay */
395 struct e1000_option opt = {
396 .type = range_option,
397 .name = "Transmit Interrupt Delay",
398 .err = "using default of " __MODULE_STRING(DEFAULT_TIDV),
400 .arg = { .r = { .min = MIN_TXDELAY,
401 .max = MAX_TXDELAY }}
404 if (num_TxIntDelay > bd) {
405 adapter->tx_int_delay = TxIntDelay[bd];
406 e1000_validate_option(&adapter->tx_int_delay, &opt,
409 adapter->tx_int_delay = opt.def;
412 { /* Transmit Absolute Interrupt Delay */
413 struct e1000_option opt = {
414 .type = range_option,
415 .name = "Transmit Absolute Interrupt Delay",
416 .err = "using default of " __MODULE_STRING(DEFAULT_TADV),
418 .arg = { .r = { .min = MIN_TXABSDELAY,
419 .max = MAX_TXABSDELAY }}
422 if (num_TxAbsIntDelay > bd) {
423 adapter->tx_abs_int_delay = TxAbsIntDelay[bd];
424 e1000_validate_option(&adapter->tx_abs_int_delay, &opt,
427 adapter->tx_abs_int_delay = opt.def;
430 { /* Receive Interrupt Delay */
431 struct e1000_option opt = {
432 .type = range_option,
433 .name = "Receive Interrupt Delay",
434 .err = "using default of " __MODULE_STRING(DEFAULT_RDTR),
436 .arg = { .r = { .min = MIN_RXDELAY,
437 .max = MAX_RXDELAY }}
440 if (num_RxIntDelay > bd) {
441 adapter->rx_int_delay = RxIntDelay[bd];
442 e1000_validate_option(&adapter->rx_int_delay, &opt,
445 adapter->rx_int_delay = opt.def;
448 { /* Receive Absolute Interrupt Delay */
449 struct e1000_option opt = {
450 .type = range_option,
451 .name = "Receive Absolute Interrupt Delay",
452 .err = "using default of " __MODULE_STRING(DEFAULT_RADV),
454 .arg = { .r = { .min = MIN_RXABSDELAY,
455 .max = MAX_RXABSDELAY }}
458 if (num_RxAbsIntDelay > bd) {
459 adapter->rx_abs_int_delay = RxAbsIntDelay[bd];
460 e1000_validate_option(&adapter->rx_abs_int_delay, &opt,
463 adapter->rx_abs_int_delay = opt.def;
466 { /* Interrupt Throttling Rate */
467 struct e1000_option opt = {
468 .type = range_option,
469 .name = "Interrupt Throttling Rate (ints/sec)",
470 .err = "using default of " __MODULE_STRING(DEFAULT_ITR),
472 .arg = { .r = { .min = MIN_ITR,
476 if (num_InterruptThrottleRate > bd) {
477 adapter->itr = InterruptThrottleRate[bd];
478 switch(adapter->itr) {
480 DPRINTK(PROBE, INFO, "%s turned off\n",
484 DPRINTK(PROBE, INFO, "%s set to dynamic mode\n",
488 e1000_validate_option(&adapter->itr, &opt,
493 adapter->itr = opt.def;
497 switch(adapter->hw.media_type) {
498 case e1000_media_type_fiber:
499 case e1000_media_type_internal_serdes:
500 e1000_check_fiber_options(adapter);
502 case e1000_media_type_copper:
503 e1000_check_copper_options(adapter);
511 * e1000_check_fiber_options - Range Checking for Link Options, Fiber Version
512 * @adapter: board private structure
514 * Handles speed and duplex options on fiber adapters
517 static void __devinit
518 e1000_check_fiber_options(struct e1000_adapter *adapter)
520 int bd = adapter->bd_number;
522 DPRINTK(PROBE, INFO, "Speed not valid for fiber adapters, "
523 "parameter ignored\n");
526 if(num_Duplex > bd) {
527 DPRINTK(PROBE, INFO, "Duplex not valid for fiber adapters, "
528 "parameter ignored\n");
531 if((num_AutoNeg > bd) && (AutoNeg[bd] != 0x20)) {
532 DPRINTK(PROBE, INFO, "AutoNeg other than 1000/Full is "
533 "not valid for fiber adapters, "
534 "parameter ignored\n");
539 * e1000_check_copper_options - Range Checking for Link Options, Copper Version
540 * @adapter: board private structure
542 * Handles speed and duplex options on copper adapters
545 static void __devinit
546 e1000_check_copper_options(struct e1000_adapter *adapter)
549 int bd = adapter->bd_number;
552 struct e1000_opt_list speed_list[] = {{ 0, "" },
557 struct e1000_option opt = {
560 .err = "parameter ignored",
562 .arg = { .l = { .nr = ARRAY_SIZE(speed_list),
566 if (num_Speed > bd) {
568 e1000_validate_option(&speed, &opt, adapter);
574 struct e1000_opt_list dplx_list[] = {{ 0, "" },
576 { FULL_DUPLEX, "" }};
578 struct e1000_option opt = {
581 .err = "parameter ignored",
583 .arg = { .l = { .nr = ARRAY_SIZE(dplx_list),
587 if (e1000_check_phy_reset_block(&adapter->hw)) {
589 "Link active due to SoL/IDER Session. "
590 "Speed/Duplex/AutoNeg parameter ignored.\n");
593 if (num_Duplex > bd) {
595 e1000_validate_option(&dplx, &opt, adapter);
601 if((num_AutoNeg > bd) && (speed != 0 || dplx != 0)) {
603 "AutoNeg specified along with Speed or Duplex, "
604 "parameter ignored\n");
605 adapter->hw.autoneg_advertised = AUTONEG_ADV_DEFAULT;
606 } else { /* Autoneg */
607 struct e1000_opt_list an_list[] =
608 #define AA "AutoNeg advertising "
609 {{ 0x01, AA "10/HD" },
610 { 0x02, AA "10/FD" },
611 { 0x03, AA "10/FD, 10/HD" },
612 { 0x04, AA "100/HD" },
613 { 0x05, AA "100/HD, 10/HD" },
614 { 0x06, AA "100/HD, 10/FD" },
615 { 0x07, AA "100/HD, 10/FD, 10/HD" },
616 { 0x08, AA "100/FD" },
617 { 0x09, AA "100/FD, 10/HD" },
618 { 0x0a, AA "100/FD, 10/FD" },
619 { 0x0b, AA "100/FD, 10/FD, 10/HD" },
620 { 0x0c, AA "100/FD, 100/HD" },
621 { 0x0d, AA "100/FD, 100/HD, 10/HD" },
622 { 0x0e, AA "100/FD, 100/HD, 10/FD" },
623 { 0x0f, AA "100/FD, 100/HD, 10/FD, 10/HD" },
624 { 0x20, AA "1000/FD" },
625 { 0x21, AA "1000/FD, 10/HD" },
626 { 0x22, AA "1000/FD, 10/FD" },
627 { 0x23, AA "1000/FD, 10/FD, 10/HD" },
628 { 0x24, AA "1000/FD, 100/HD" },
629 { 0x25, AA "1000/FD, 100/HD, 10/HD" },
630 { 0x26, AA "1000/FD, 100/HD, 10/FD" },
631 { 0x27, AA "1000/FD, 100/HD, 10/FD, 10/HD" },
632 { 0x28, AA "1000/FD, 100/FD" },
633 { 0x29, AA "1000/FD, 100/FD, 10/HD" },
634 { 0x2a, AA "1000/FD, 100/FD, 10/FD" },
635 { 0x2b, AA "1000/FD, 100/FD, 10/FD, 10/HD" },
636 { 0x2c, AA "1000/FD, 100/FD, 100/HD" },
637 { 0x2d, AA "1000/FD, 100/FD, 100/HD, 10/HD" },
638 { 0x2e, AA "1000/FD, 100/FD, 100/HD, 10/FD" },
639 { 0x2f, AA "1000/FD, 100/FD, 100/HD, 10/FD, 10/HD" }};
641 struct e1000_option opt = {
644 .err = "parameter ignored",
645 .def = AUTONEG_ADV_DEFAULT,
646 .arg = { .l = { .nr = ARRAY_SIZE(an_list),
650 if (num_AutoNeg > bd) {
652 e1000_validate_option(&an, &opt, adapter);
656 adapter->hw.autoneg_advertised = an;
659 switch (speed + dplx) {
661 adapter->hw.autoneg = adapter->fc_autoneg = 1;
662 if((num_Speed > bd) && (speed != 0 || dplx != 0))
664 "Speed and duplex autonegotiation enabled\n");
667 DPRINTK(PROBE, INFO, "Half Duplex specified without Speed\n");
668 DPRINTK(PROBE, INFO, "Using Autonegotiation at "
669 "Half Duplex only\n");
670 adapter->hw.autoneg = adapter->fc_autoneg = 1;
671 adapter->hw.autoneg_advertised = ADVERTISE_10_HALF |
675 DPRINTK(PROBE, INFO, "Full Duplex specified without Speed\n");
676 DPRINTK(PROBE, INFO, "Using Autonegotiation at "
677 "Full Duplex only\n");
678 adapter->hw.autoneg = adapter->fc_autoneg = 1;
679 adapter->hw.autoneg_advertised = ADVERTISE_10_FULL |
684 DPRINTK(PROBE, INFO, "10 Mbps Speed specified "
686 DPRINTK(PROBE, INFO, "Using Autonegotiation at 10 Mbps only\n");
687 adapter->hw.autoneg = adapter->fc_autoneg = 1;
688 adapter->hw.autoneg_advertised = ADVERTISE_10_HALF |
691 case SPEED_10 + HALF_DUPLEX:
692 DPRINTK(PROBE, INFO, "Forcing to 10 Mbps Half Duplex\n");
693 adapter->hw.autoneg = adapter->fc_autoneg = 0;
694 adapter->hw.forced_speed_duplex = e1000_10_half;
695 adapter->hw.autoneg_advertised = 0;
697 case SPEED_10 + FULL_DUPLEX:
698 DPRINTK(PROBE, INFO, "Forcing to 10 Mbps Full Duplex\n");
699 adapter->hw.autoneg = adapter->fc_autoneg = 0;
700 adapter->hw.forced_speed_duplex = e1000_10_full;
701 adapter->hw.autoneg_advertised = 0;
704 DPRINTK(PROBE, INFO, "100 Mbps Speed specified "
706 DPRINTK(PROBE, INFO, "Using Autonegotiation at "
708 adapter->hw.autoneg = adapter->fc_autoneg = 1;
709 adapter->hw.autoneg_advertised = ADVERTISE_100_HALF |
712 case SPEED_100 + HALF_DUPLEX:
713 DPRINTK(PROBE, INFO, "Forcing to 100 Mbps Half Duplex\n");
714 adapter->hw.autoneg = adapter->fc_autoneg = 0;
715 adapter->hw.forced_speed_duplex = e1000_100_half;
716 adapter->hw.autoneg_advertised = 0;
718 case SPEED_100 + FULL_DUPLEX:
719 DPRINTK(PROBE, INFO, "Forcing to 100 Mbps Full Duplex\n");
720 adapter->hw.autoneg = adapter->fc_autoneg = 0;
721 adapter->hw.forced_speed_duplex = e1000_100_full;
722 adapter->hw.autoneg_advertised = 0;
725 DPRINTK(PROBE, INFO, "1000 Mbps Speed specified without "
728 "Using Autonegotiation at 1000 Mbps "
729 "Full Duplex only\n");
730 adapter->hw.autoneg = adapter->fc_autoneg = 1;
731 adapter->hw.autoneg_advertised = ADVERTISE_1000_FULL;
733 case SPEED_1000 + HALF_DUPLEX:
735 "Half Duplex is not supported at 1000 Mbps\n");
737 "Using Autonegotiation at 1000 Mbps "
738 "Full Duplex only\n");
739 adapter->hw.autoneg = adapter->fc_autoneg = 1;
740 adapter->hw.autoneg_advertised = ADVERTISE_1000_FULL;
742 case SPEED_1000 + FULL_DUPLEX:
744 "Using Autonegotiation at 1000 Mbps Full Duplex only\n");
745 adapter->hw.autoneg = adapter->fc_autoneg = 1;
746 adapter->hw.autoneg_advertised = ADVERTISE_1000_FULL;
752 /* Speed, AutoNeg and MDI/MDI-X must all play nice */
753 if (e1000_validate_mdi_setting(&(adapter->hw)) < 0) {
755 "Speed, AutoNeg and MDI-X specifications are "
756 "incompatible. Setting MDI-X to a compatible value.\n");