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)
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_desc_ring *tx_ring = &adapter->tx_ring;
310 e1000_mac_type mac_type = adapter->hw.mac_type;
311 opt.arg.r.max = mac_type < e1000_82544 ?
312 E1000_MAX_TXD : E1000_MAX_82544_TXD;
314 if (num_TxDescriptors > bd) {
315 tx_ring->count = TxDescriptors[bd];
316 e1000_validate_option(&tx_ring->count, &opt, adapter);
317 E1000_ROUNDUP(tx_ring->count,
318 REQ_TX_DESCRIPTOR_MULTIPLE);
320 tx_ring->count = opt.def;
323 { /* Receive Descriptor Count */
324 struct e1000_option opt = {
325 .type = range_option,
326 .name = "Receive Descriptors",
327 .err = "using default of "
328 __MODULE_STRING(E1000_DEFAULT_RXD),
329 .def = E1000_DEFAULT_RXD,
330 .arg = { .r = { .min = E1000_MIN_RXD }}
332 struct e1000_desc_ring *rx_ring = &adapter->rx_ring;
333 e1000_mac_type mac_type = adapter->hw.mac_type;
334 opt.arg.r.max = mac_type < e1000_82544 ? E1000_MAX_RXD :
337 if (num_RxDescriptors > bd) {
338 rx_ring->count = RxDescriptors[bd];
339 e1000_validate_option(&rx_ring->count, &opt, adapter);
340 E1000_ROUNDUP(rx_ring->count,
341 REQ_RX_DESCRIPTOR_MULTIPLE);
343 rx_ring->count = opt.def;
346 { /* Checksum Offload Enable/Disable */
347 struct e1000_option opt = {
348 .type = enable_option,
349 .name = "Checksum Offload",
350 .err = "defaulting to Enabled",
351 .def = OPTION_ENABLED
354 if (num_XsumRX > bd) {
355 int rx_csum = XsumRX[bd];
356 e1000_validate_option(&rx_csum, &opt, adapter);
357 adapter->rx_csum = rx_csum;
359 adapter->rx_csum = opt.def;
364 struct e1000_opt_list fc_list[] =
365 {{ e1000_fc_none, "Flow Control Disabled" },
366 { e1000_fc_rx_pause,"Flow Control Receive Only" },
367 { e1000_fc_tx_pause,"Flow Control Transmit Only" },
368 { e1000_fc_full, "Flow Control Enabled" },
369 { e1000_fc_default, "Flow Control Hardware Default" }};
371 struct e1000_option opt = {
373 .name = "Flow Control",
374 .err = "reading default settings from EEPROM",
375 .def = e1000_fc_default,
376 .arg = { .l = { .nr = ARRAY_SIZE(fc_list),
380 if (num_FlowControl > bd) {
381 int fc = FlowControl[bd];
382 e1000_validate_option(&fc, &opt, adapter);
383 adapter->hw.fc = adapter->hw.original_fc = fc;
385 adapter->hw.fc = opt.def;
388 { /* Transmit Interrupt Delay */
389 struct e1000_option opt = {
390 .type = range_option,
391 .name = "Transmit Interrupt Delay",
392 .err = "using default of " __MODULE_STRING(DEFAULT_TIDV),
394 .arg = { .r = { .min = MIN_TXDELAY,
395 .max = MAX_TXDELAY }}
398 if (num_TxIntDelay > bd) {
399 adapter->tx_int_delay = TxIntDelay[bd];
400 e1000_validate_option(&adapter->tx_int_delay, &opt,
403 adapter->tx_int_delay = opt.def;
406 { /* Transmit Absolute Interrupt Delay */
407 struct e1000_option opt = {
408 .type = range_option,
409 .name = "Transmit Absolute Interrupt Delay",
410 .err = "using default of " __MODULE_STRING(DEFAULT_TADV),
412 .arg = { .r = { .min = MIN_TXABSDELAY,
413 .max = MAX_TXABSDELAY }}
416 if (num_TxAbsIntDelay > bd) {
417 adapter->tx_abs_int_delay = TxAbsIntDelay[bd];
418 e1000_validate_option(&adapter->tx_abs_int_delay, &opt,
421 adapter->tx_abs_int_delay = opt.def;
424 { /* Receive Interrupt Delay */
425 struct e1000_option opt = {
426 .type = range_option,
427 .name = "Receive Interrupt Delay",
428 .err = "using default of " __MODULE_STRING(DEFAULT_RDTR),
430 .arg = { .r = { .min = MIN_RXDELAY,
431 .max = MAX_RXDELAY }}
434 if (num_RxIntDelay > bd) {
435 adapter->rx_int_delay = RxIntDelay[bd];
436 e1000_validate_option(&adapter->rx_int_delay, &opt,
439 adapter->rx_int_delay = opt.def;
442 { /* Receive Absolute Interrupt Delay */
443 struct e1000_option opt = {
444 .type = range_option,
445 .name = "Receive Absolute Interrupt Delay",
446 .err = "using default of " __MODULE_STRING(DEFAULT_RADV),
448 .arg = { .r = { .min = MIN_RXABSDELAY,
449 .max = MAX_RXABSDELAY }}
452 if (num_RxAbsIntDelay > bd) {
453 adapter->rx_abs_int_delay = RxAbsIntDelay[bd];
454 e1000_validate_option(&adapter->rx_abs_int_delay, &opt,
457 adapter->rx_abs_int_delay = opt.def;
460 { /* Interrupt Throttling Rate */
461 struct e1000_option opt = {
462 .type = range_option,
463 .name = "Interrupt Throttling Rate (ints/sec)",
464 .err = "using default of " __MODULE_STRING(DEFAULT_ITR),
466 .arg = { .r = { .min = MIN_ITR,
470 if (num_InterruptThrottleRate > bd) {
471 adapter->itr = InterruptThrottleRate[bd];
472 switch(adapter->itr) {
474 DPRINTK(PROBE, INFO, "%s turned off\n",
478 DPRINTK(PROBE, INFO, "%s set to dynamic mode\n",
482 e1000_validate_option(&adapter->itr, &opt,
487 adapter->itr = opt.def;
491 switch(adapter->hw.media_type) {
492 case e1000_media_type_fiber:
493 case e1000_media_type_internal_serdes:
494 e1000_check_fiber_options(adapter);
496 case e1000_media_type_copper:
497 e1000_check_copper_options(adapter);
505 * e1000_check_fiber_options - Range Checking for Link Options, Fiber Version
506 * @adapter: board private structure
508 * Handles speed and duplex options on fiber adapters
511 static void __devinit
512 e1000_check_fiber_options(struct e1000_adapter *adapter)
514 int bd = adapter->bd_number;
516 DPRINTK(PROBE, INFO, "Speed not valid for fiber adapters, "
517 "parameter ignored\n");
520 if(num_Duplex > bd) {
521 DPRINTK(PROBE, INFO, "Duplex not valid for fiber adapters, "
522 "parameter ignored\n");
525 if((num_AutoNeg > bd) && (AutoNeg[bd] != 0x20)) {
526 DPRINTK(PROBE, INFO, "AutoNeg other than 1000/Full is "
527 "not valid for fiber adapters, "
528 "parameter ignored\n");
533 * e1000_check_copper_options - Range Checking for Link Options, Copper Version
534 * @adapter: board private structure
536 * Handles speed and duplex options on copper adapters
539 static void __devinit
540 e1000_check_copper_options(struct e1000_adapter *adapter)
543 int bd = adapter->bd_number;
546 struct e1000_opt_list speed_list[] = {{ 0, "" },
551 struct e1000_option opt = {
554 .err = "parameter ignored",
556 .arg = { .l = { .nr = ARRAY_SIZE(speed_list),
560 if (num_Speed > bd) {
562 e1000_validate_option(&speed, &opt, adapter);
568 struct e1000_opt_list dplx_list[] = {{ 0, "" },
570 { FULL_DUPLEX, "" }};
572 struct e1000_option opt = {
575 .err = "parameter ignored",
577 .arg = { .l = { .nr = ARRAY_SIZE(dplx_list),
581 if (num_Duplex > bd) {
583 e1000_validate_option(&dplx, &opt, adapter);
589 if((num_AutoNeg > bd) && (speed != 0 || dplx != 0)) {
591 "AutoNeg specified along with Speed or Duplex, "
592 "parameter ignored\n");
593 adapter->hw.autoneg_advertised = AUTONEG_ADV_DEFAULT;
594 } else { /* Autoneg */
595 struct e1000_opt_list an_list[] =
596 #define AA "AutoNeg advertising "
597 {{ 0x01, AA "10/HD" },
598 { 0x02, AA "10/FD" },
599 { 0x03, AA "10/FD, 10/HD" },
600 { 0x04, AA "100/HD" },
601 { 0x05, AA "100/HD, 10/HD" },
602 { 0x06, AA "100/HD, 10/FD" },
603 { 0x07, AA "100/HD, 10/FD, 10/HD" },
604 { 0x08, AA "100/FD" },
605 { 0x09, AA "100/FD, 10/HD" },
606 { 0x0a, AA "100/FD, 10/FD" },
607 { 0x0b, AA "100/FD, 10/FD, 10/HD" },
608 { 0x0c, AA "100/FD, 100/HD" },
609 { 0x0d, AA "100/FD, 100/HD, 10/HD" },
610 { 0x0e, AA "100/FD, 100/HD, 10/FD" },
611 { 0x0f, AA "100/FD, 100/HD, 10/FD, 10/HD" },
612 { 0x20, AA "1000/FD" },
613 { 0x21, AA "1000/FD, 10/HD" },
614 { 0x22, AA "1000/FD, 10/FD" },
615 { 0x23, AA "1000/FD, 10/FD, 10/HD" },
616 { 0x24, AA "1000/FD, 100/HD" },
617 { 0x25, AA "1000/FD, 100/HD, 10/HD" },
618 { 0x26, AA "1000/FD, 100/HD, 10/FD" },
619 { 0x27, AA "1000/FD, 100/HD, 10/FD, 10/HD" },
620 { 0x28, AA "1000/FD, 100/FD" },
621 { 0x29, AA "1000/FD, 100/FD, 10/HD" },
622 { 0x2a, AA "1000/FD, 100/FD, 10/FD" },
623 { 0x2b, AA "1000/FD, 100/FD, 10/FD, 10/HD" },
624 { 0x2c, AA "1000/FD, 100/FD, 100/HD" },
625 { 0x2d, AA "1000/FD, 100/FD, 100/HD, 10/HD" },
626 { 0x2e, AA "1000/FD, 100/FD, 100/HD, 10/FD" },
627 { 0x2f, AA "1000/FD, 100/FD, 100/HD, 10/FD, 10/HD" }};
629 struct e1000_option opt = {
632 .err = "parameter ignored",
633 .def = AUTONEG_ADV_DEFAULT,
634 .arg = { .l = { .nr = ARRAY_SIZE(an_list),
638 int an = AutoNeg[bd];
639 e1000_validate_option(&an, &opt, adapter);
640 adapter->hw.autoneg_advertised = an;
643 switch (speed + dplx) {
645 adapter->hw.autoneg = adapter->fc_autoneg = 1;
646 if((num_Speed > bd) && (speed != 0 || dplx != 0))
648 "Speed and duplex autonegotiation enabled\n");
651 DPRINTK(PROBE, INFO, "Half Duplex specified without Speed\n");
652 DPRINTK(PROBE, INFO, "Using Autonegotiation at "
653 "Half Duplex only\n");
654 adapter->hw.autoneg = adapter->fc_autoneg = 1;
655 adapter->hw.autoneg_advertised = ADVERTISE_10_HALF |
659 DPRINTK(PROBE, INFO, "Full Duplex specified without Speed\n");
660 DPRINTK(PROBE, INFO, "Using Autonegotiation at "
661 "Full Duplex only\n");
662 adapter->hw.autoneg = adapter->fc_autoneg = 1;
663 adapter->hw.autoneg_advertised = ADVERTISE_10_FULL |
668 DPRINTK(PROBE, INFO, "10 Mbps Speed specified "
670 DPRINTK(PROBE, INFO, "Using Autonegotiation at 10 Mbps only\n");
671 adapter->hw.autoneg = adapter->fc_autoneg = 1;
672 adapter->hw.autoneg_advertised = ADVERTISE_10_HALF |
675 case SPEED_10 + HALF_DUPLEX:
676 DPRINTK(PROBE, INFO, "Forcing to 10 Mbps Half Duplex\n");
677 adapter->hw.autoneg = adapter->fc_autoneg = 0;
678 adapter->hw.forced_speed_duplex = e1000_10_half;
679 adapter->hw.autoneg_advertised = 0;
681 case SPEED_10 + FULL_DUPLEX:
682 DPRINTK(PROBE, INFO, "Forcing to 10 Mbps Full Duplex\n");
683 adapter->hw.autoneg = adapter->fc_autoneg = 0;
684 adapter->hw.forced_speed_duplex = e1000_10_full;
685 adapter->hw.autoneg_advertised = 0;
688 DPRINTK(PROBE, INFO, "100 Mbps Speed specified "
690 DPRINTK(PROBE, INFO, "Using Autonegotiation at "
692 adapter->hw.autoneg = adapter->fc_autoneg = 1;
693 adapter->hw.autoneg_advertised = ADVERTISE_100_HALF |
696 case SPEED_100 + HALF_DUPLEX:
697 DPRINTK(PROBE, INFO, "Forcing to 100 Mbps Half Duplex\n");
698 adapter->hw.autoneg = adapter->fc_autoneg = 0;
699 adapter->hw.forced_speed_duplex = e1000_100_half;
700 adapter->hw.autoneg_advertised = 0;
702 case SPEED_100 + FULL_DUPLEX:
703 DPRINTK(PROBE, INFO, "Forcing to 100 Mbps Full Duplex\n");
704 adapter->hw.autoneg = adapter->fc_autoneg = 0;
705 adapter->hw.forced_speed_duplex = e1000_100_full;
706 adapter->hw.autoneg_advertised = 0;
709 DPRINTK(PROBE, INFO, "1000 Mbps Speed specified without "
712 "Using Autonegotiation at 1000 Mbps "
713 "Full Duplex only\n");
714 adapter->hw.autoneg = adapter->fc_autoneg = 1;
715 adapter->hw.autoneg_advertised = ADVERTISE_1000_FULL;
717 case SPEED_1000 + HALF_DUPLEX:
719 "Half Duplex is not supported at 1000 Mbps\n");
721 "Using Autonegotiation at 1000 Mbps "
722 "Full Duplex only\n");
723 adapter->hw.autoneg = adapter->fc_autoneg = 1;
724 adapter->hw.autoneg_advertised = ADVERTISE_1000_FULL;
726 case SPEED_1000 + FULL_DUPLEX:
728 "Using Autonegotiation at 1000 Mbps Full Duplex only\n");
729 adapter->hw.autoneg = adapter->fc_autoneg = 1;
730 adapter->hw.autoneg_advertised = ADVERTISE_1000_FULL;
736 /* Speed, AutoNeg and MDI/MDI-X must all play nice */
737 if (e1000_validate_mdi_setting(&(adapter->hw)) < 0) {
739 "Speed, AutoNeg and MDI-X specifications are "
740 "incompatible. Setting MDI-X to a compatible value.\n");