1 .\" (C)Copyright 1999-2003 Marvell(R) -- linux@syskonnect.de
2 .\" sk98lin.4 1.1 2003/12/17 10:03:18
4 .\" %%%LICENSE_START(GPLv2+_DOC_FULL)
5 .\" This is free documentation; you can redistribute it and/or
6 .\" modify it under the terms of the GNU General Public License as
7 .\" published by the Free Software Foundation; either version 2 of
8 .\" the License, or (at your option) any later version.
10 .\" The GNU General Public License's references to "object code"
11 .\" and "executables" are to be interpreted as the output of any
12 .\" document formatting or typesetting system, including
13 .\" intermediate and printed output.
15 .\" This manual is distributed in the hope that it will be useful,
16 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
17 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 .\" GNU General Public License for more details.
20 .\" You should have received a copy of the GNU General Public
21 .\" License along with this manual; if not, see
22 .\" <http://www.gnu.org/licenses/>.
25 .\" This manpage can be viewed using `groff -Tascii -man sk98lin.4 | less`
27 .TH SK98LIN 4 2012-08-05 "Linux" "Linux Programmer's Manual"
29 sk98lin \- Marvell/SysKonnect Gigabit Ethernet driver v6.21
66 This obsolete driver was removed from the kernel in version 2.6.26.
69 is the Gigabit Ethernet driver for
70 Marvell and SysKonnect network adapter cards.
71 It supports SysKonnect SK-98xx/SK-95xx
72 compliant Gigabit Ethernet Adapter and
73 any Yukon compliant chipset.
75 When loading the driver using insmod,
76 parameters for the network adapter cards
77 might be stated as a sequence of comma separated commands.
78 If for instance two network adapters are installed and AutoNegotiation on
79 Port A of the first adapter should be ON,
80 but on the Port A of the second adapter switched OFF, one must enter:
82 insmod sk98lin.o AutoNeg_A=On,Off
86 is bound to one or more adapter cards and the
88 file system is mounted on your system, a dedicated statistics file
89 will be created in folder
91 for all ports of the installed network adapter cards.
96 is the number of the interface that has been assigned to a
97 dedicated port by the system.
99 If loading is finished, any desired IP address can be
100 assigned to the respective
105 This causes the adapter to connect to the Ethernet and to display a status
106 message on the console saying "ethx: network connection up using port y"
107 followed by the configured or detected connection parameters.
111 also supports large frames (also called jumbo frames).
112 Using jumbo frames can improve throughput tremendously when
113 transferring large amounts of data.
114 To enable large frames, the MTU (maximum transfer unit) size
115 for an interface is to be set to a high value.
116 The default MTU size is 1500 and can be changed up to 9000 (bytes).
117 Setting the MTU size can be done when assigning the IP address
118 to the interface or later by using the
120 command with the mtu parameter.
121 If for instance eth0 needs an IP
122 address and a large frame MTU size,
123 the following two commands might be used:
125 ifconfig eth0 10.1.1.1
126 ifconfig eth0 mtu 9000
128 Those two commands might even be combined into one:
130 ifconfig eth0 10.1.1.1 mtu 9000
132 Note that large frames can only be used if permitted by
133 your network infrastructure.
134 This means, that any switch being used in your Ethernet must
135 also support large frames.
136 Quite some switches support large frames,
137 but need to be configured to do so.
138 Most of the times, their default setting is to support only
139 standard frames with an MTU size of 1500 (bytes).
140 In addition to the switches inside the network,
141 all network adapters that are to be used must also be
142 enabled regarding jumbo frames.
143 If an adapter is not set to receive large frames it will simply drop them.
145 Switching back to the standard Ethernet frame size can be done by using the
149 ifconfig eth0 mtu 1500
151 The Marvell/SysKonnect Gigabit Ethernet driver for Linux is able to
152 support VLAN and Link Aggregation according to
153 IEEE standards 802.1, 802.1q, and 802.3ad.
154 Those features are only available after installation of open source modules
155 which can be found on the Internet:
159 .UR http://www.candelatech.com\:/~greear\:/vlan.html
165 .UR http://www.st.rim.or.jp\:/~yumo
169 Note that Marvell/SysKonnect does not offer any support for these
170 open source modules and does not take the responsibility for any
171 kind of failures or problems arising when using these modules.
175 This parameter is used to set the speed capabilities of port A of an
177 It is only valid for Yukon copper adapters.
187 Usually, the speed is negotiated between the two ports
188 during link establishment.
190 a port can be forced to a specific setting with this parameter.
193 This parameter is used to set the speed capabilities of port B of
195 It is only valid for Yukon copper adapters.
205 Usually, the speed is negotiated between the two ports during link
208 a port can be forced to a specific setting with this parameter.
210 .BI AutoNeg_A= i,j,...
211 Enables or disables the use of autonegotiation of port A of an adapter card.
222 mode automatically detects whether the link partner supports
223 auto-negotiation or not.
225 .BI AutoNeg_B= i,j,...
226 Enables or disables the use of autonegotiation of port B of an adapter card.
237 mode automatically detects whether the link partner supports
238 auto-negotiation or not.
240 .BI DupCap_A= i,j,...
241 This parameter indicates the duplex mode to be used for port A
251 This parameter is only relevant if AutoNeg_A of port A is not set to
253 If AutoNeg_A is set to
255 all three values of DupCap_A (
261 If AutoNeg_A is set to
268 This DupCap_A parameter is useful if your link partner does not
269 support all possible duplex combinations.
271 .BI DupCap_B= i,j,...
272 This parameter indicates the duplex mode to be used for port B
282 This parameter is only relevant if AutoNeg_B of port B is not set to
284 If AutoNeg_B is set to
286 all three values of DupCap_B (
292 If AutoNeg_B is set to
299 This DupCap_B parameter is useful if your link partner does not
300 support all possible duplex combinations.
302 .BI FlowCtrl_A= i,j,...
303 This parameter can be used to set the flow control capabilities the
304 port reports during auto-negotiation.
314 The different modes have the following meaning:
319 both link partners are allowed to send PAUSE frames
323 both or only remote partner are allowed to send PAUSE frames
327 only local link partner is allowed to send PAUSE frames
331 no link partner is allowed to send PAUSE frames
333 Note that this parameter is ignored if AutoNeg_A is set to
336 .BI FlowCtrl_B= i,j,...
337 This parameter can be used to set the flow control capabilities the
338 port reports during auto-negotiation.
348 The different modes have the following meaning:
352 both link partners are allowed to send PAUSE frames
356 both or only remote partner are allowed to send PAUSE frames
360 only local link partner is allowed to send PAUSE frames
364 no link partner is allowed to send PAUSE frames
367 Note that this parameter is ignored if AutoNeg_B is set to
371 This parameter is only valid for 1000Base-T adapter cards.
372 For two 1000Base-T ports to communicate,
373 one must take the role of the master (providing timing information),
374 while the other must be the slave.
383 Usually, the role of a port is negotiated between two ports during
384 link establishment, but if that fails the port A of an adapter card
385 can be forced to a specific setting with this parameter.
388 This parameter is only valid for 1000Base-T adapter cards.
389 For two 1000Base-T ports to communicate, one must take
390 the role of the master (providing timing information),
391 while the other must be the slave.
400 Usually, the role of a port is negotiated between
401 two ports during link establishment, but if that fails
402 the port B of an adapter card can be forced to a
403 specific setting with this parameter.
406 This parameter is a combination of all five per-port parameters
407 within one single parameter.
408 This simplifies the configuration of both ports of an adapter card.
409 The different values of this variable reflect the
410 most meaningful combinations of port parameters.
411 Possible values and their corresponding combination of per-port parameters:
414 ConType | DupCap AutoNeg FlowCtrl Role Speed
415 --------+-------------------------------------------
416 \fIAuto\fP | Both On SymOrRem Auto Auto
418 \fI100FD\fP | Full Off None Auto 100
420 \fI100HD\fP | Half Off None Auto 100
422 \fI10FD\fP | Full Off None Auto 10
424 \fI10HD\fP | Half Off None Auto 10
427 Stating any other port parameter together with this
429 parameter will result in a merged configuration of those settings.
431 the fact, that the per-port parameters (e.g.,
433 have a higher priority than the combined variable
436 .BI Moderation= i,j,...
437 Interrupt moderation is employed to limit the maximum number of interrupts
438 the driver has to serve.
439 That is, one or more interrupts (which indicate any transmit or
440 receive packet to be processed) are queued until the driver processes them.
441 When queued interrupts are to be served, is determined by the
443 parameter, which is explained later below.
444 Possible moderation modes are:
452 The different modes have the following meaning:
455 No interrupt moderation is applied on the adapter card.
456 Therefore, each transmit or receive interrupt is served immediately
457 as soon as it appears on the interrupt line of the adapter card.
461 Interrupt moderation is applied on the adapter card.
462 All transmit and receive interrupts are queued until
463 a complete moderation interval ends.
464 If such a moderation interval ends, all queued interrupts
465 are processed in one big bunch without any delay.
468 reflects the fact, that interrupt moderation is always enabled,
469 regardless how much network load is currently passing via a
470 particular interface.
471 In addition, the duration of the moderation interval has a fixed
472 length that never changes while the driver is operational.
476 Interrupt moderation might be applied on the adapter card,
477 depending on the load of the system.
478 If the driver detects that the system load is too high,
479 the driver tries to shield the system against too much network
480 load by enabling interrupt moderation.
481 If\(emat a later time\(emthe CPU utilization decreases
482 again (or if the network load is negligible) the interrupt
483 moderation will automatically be disabled.
485 Interrupt moderation should be used when the driver has to
486 handle one or more interfaces with a high network load,
487 which\(emas a consequence\(emleads also to a high CPU utilization.
488 When moderation is applied in such high network load situations,
489 CPU load might be reduced by 20-30% on slow computers.
491 Note that the drawback of using interrupt moderation is an increase of
492 the round-trip-time (RTT), due to the queuing and serving of
493 interrupts at dedicated moderation times.
495 .BI IntsPerSec= i,j,...
496 This parameter determines the length of any interrupt moderation interval.
497 Assuming that static interrupt moderation is to be used, an
499 parameter value of 2000 will lead to an interrupt moderation interval of
501 Possible values for this parameter are in the range of
502 30...40000 (interrupts per second).
503 The default value is 2000.
505 This parameter is only used, if either static or dynamic interrupt moderation
506 is enabled on a network adapter card.
507 This parameter is ignored if no moderation is applied.
509 Note that the duration of the moderation interval is to be chosen with care.
510 At first glance, selecting a very long duration (e.g., only 100 interrupts per
511 second) seems to be meaningful, but the increase of packet-processing delay
513 On the other hand, selecting a very short moderation time might
514 compensate the use of any moderation being applied.
516 .BI PrefPort= i,j,...
517 This parameter is used to force the preferred port to
518 A or B (on dual-port network adapters).
519 The preferred port is the one that is used if both ports A and B are
520 detected as fully functional.
529 .BI RlmtMode= i,j,...
530 RLMT monitors the status of the port.
531 If the link of the active port fails,
532 RLMT switches immediately to the standby link.
533 The virtual link is maintained as long as at least one "physical" link is up.
534 This parameters states how RLMT should monitor both ports.
544 The different modes have the following meaning:
547 Check link state only: RLMT uses the link state reported by the adapter
548 hardware for each individual port to determine whether a port can be used
549 for all network traffic or not.
553 In this mode, RLMT monitors the network path between the two
554 ports of an adapter by regularly exchanging packets between them.
555 This mode requires a network configuration in which the
556 two ports are able to "see" each other (i.e., there
557 must not be any router between the ports).
561 Check local port and segmentation:
562 This mode supports the same functions as the CheckLocalPort
563 mode and additionally checks network segmentation between the ports.
564 Therefore, this mode is only to be used if Gigabit Ethernet
565 switches are installed on the network that have been
566 configured to use the Spanning Tree protocol.
570 In this mode, ports A and B are used as separate devices.
571 If you have a dual port adapter, port A will be configured as
575 Both ports can be used independently with distinct IP addresses.
576 The preferred port setting is not used.
583 are designed to operate in configurations where a
584 network path between the ports on one adapter exists.
585 Moreover, they are not designed to work where adapters are
586 connected back-to-back.
589 .I /proc/net/sk98lin/eth[x]
591 The statistics file of a particular interface of an adapter card.
592 It contains generic information about the adapter card plus a detailed
593 summary of all transmit and receive counters.
595 .I /usr/src/linux/Documentation/networking/sk98lin.txt
602 It contains a detailed installation HOWTO and describes all parameters
604 It denotes also common problems and provides the solution to them.
606 Report any bugs to linux@syskonnect.de
608 .\" Ralph Roesler \(em rroesler@syskonnect.de
610 .\" Mirko Lindner \(em mlindner@syskonnect.de
OSDN Git Service
