1 .\" (C)Copyright 1999-2005 Marvell(R). -- linux@syskonnect.de
2 .\" sk98lin.4 1.1 2005/06/14 08:53:57
3 .\" This manpage can be viewed using `groff -Tascii -man sk98lin.4 | less`
5 .TH SK98LIN 4 "2005/06/14 08:53:57" "sk98lin 8.23.1.3"
7 sk98lin \- Marvell/SysKonnect Gigabit Ethernet driver v8.23.1.3
44 is the Gigabit Ethernet driver for Marvell and SysKonnect network adapter cards.
45 It supports SysKonnect SK-98xx/SK-95xx compliant Gigabit Ethernet Adapter and any Yukon compliant chipset.
47 When loading the driver using
49 , parameters for the network adapter cards might be stated as a sequence of comma separated commands. If for instance two network adapters are installed and AutoNegotiation on Port A of the first adapter should be ON, but on the Port A of the second adapter switched OFF, one must enter:
51 insmod sk98lin.o AutoNeg_A=On,Off
55 is bound to one or more adapter cards and the
57 filesystem is mounted on your system, a dedicated statistics file will be created in folder
59 for all ports of the installed network adapter cards. Those files are named
63 is the number of the interface that has been assigned to a dedicated port by the system.
65 If loading is finished, any desired IP address can be assigned to the respective
69 command. This causes the adapter to connect to the Ethernet and to display a status message on the console saying "ethx: network connection up using port y" followed by the configured or detected connection parameters.
73 also supports large frames (also called jumbo frames). Using jumbo frames can improve throughput tremendously when transferring large amounts of data. To enable large frames, the MTU (maximum transfer unit) size for an interface is to be set to a high value. The default MTU size is 1500 and can be changed up to 9000 (bytes). Setting the MTU size can be done when assigning the IP address to the interface or later by using the
75 command with the mtu parameter. If for instance eth0 needs an IP address and a large frame MTU size, the following two commands might be used:
77 ifconfig eth0 10.1.1.1
78 ifconfig eth0 mtu 9000
80 Those two commands might even be combined into one:
82 ifconfig eth0 10.1.1.1 mtu 9000
84 Note that large frames can only be used if your network infrastructure allows to do so. This means, that any switch being used in your Ethernet must also support large frames. Quite some switches support large frames, but need to be configured to do so. Most of the times, their default setting is to support only standard frames with an MTU size of 1500 (bytes). In addition to the switches inside the network, all network adapters that are to be used must also be enabled regarding jumbo frames. If an adapter is not set to receive large frames it will simply drop them.
86 Switching back to the standard Ethernet frame size can be done by using the
90 ifconfig eth0 mtu 1500
92 The Marvell/SysKonnect Gigabit Ethernet driver for Linux is able to support VLAN and Link Aggregation according to IEEE standards 802.1, 802.1q, and 802.3ad. Those features are only available after installation of open source modules which can be found on the Internet:
95 : http://www.candelatech.com/~greear/vlan.html
99 : http://www.st.rim.or.jp/~yumo
102 Note that Marvell/SysKonnect does not offer any support for these open source modules and does not take the responsibility for any kind of failures or problems arising when using these modules.
106 This parameter is used to set the speed capabilities of port A of an adapter card. It is only valid for Yukon copper adapters. Possible values are:
116 is the default. Usually, the speed is negotiated between the two ports during link establishment. If this fails, a port can be forced to a specific setting with this parameter.
119 This parameter is used to set the speed capabilities of port B of an adapter card. It is only valid for Yukon copper adapters. Possible values are:
129 is the default. Usually, the speed is negotiated between the two ports during link establishment. If this fails, a port can be forced to a specific setting with this parameter.
131 .BI AutoNeg_A= i,j,...
132 Enables or disables the use of autonegotiation of port A of an adapter card. Possible values are:
142 mode automatically detects whether the link partner supports auto-negotiation or not.
144 .BI AutoNeg_B= i,j,...
145 Enables or disables the use of autonegotiation of port B of an adapter card. Possible values are:
155 mode automatically detects whether the link partner supports auto-negotiation or not.
157 .BI DupCap_A= i,j,...
158 This parameter indicates the duplex mode to be used for port A of an adapter card. Possible values are:
166 is the default. This parameter is only relevant if AutoNeg_A of port A is not set to
168 If AutoNeg_A is set to
170 , all three values of DupCap_A (
176 ) might be stated. If AutoNeg_A is set to
178 , only DupCap_A values
182 are allowed. This DupCap_A parameter is useful if your link partner does not support all possible duplex combinations.
184 .BI DupCap_B= i,j,...
185 This parameter indicates the duplex mode to be used for port B of an adapter card. Possible values are:
193 is the default. This parameter is only relevant if AutoNeg_B of port B is not set to
195 If AutoNeg_B is set to
197 , all three values of DupCap_B (
203 ) might be stated. If AutoNeg_B is set to
205 , only DupCap_B values
209 are allowed. This DupCap_B parameter is useful if your link partner does not support all possible duplex combinations.
211 .BI FlowCtrl_A= i,j,...
212 This parameter can be used to set the flow control capabilities the port reports during auto-negotiation. Possible values are:
222 is the default. The different modes have the following meaning:
227 both link partners are allowed to send PAUSE frames
231 both or only remote partner are allowed to send PAUSE frames
235 only local link partner is allowed to send PAUSE frames
239 no link partner is allowed to send PAUSE frames
241 Note that this parameter is ignored if AutoNeg_A is set to
244 .BI FlowCtrl_B= i,j,...
245 This parameter can be used to set the flow control capabilities the port reports during auto-negotiation. Possible values are:
255 is the default. The different modes have the following meaning:
259 both link partners are allowed to send PAUSE frames
263 both or only remote partner are allowed to send PAUSE frames
267 only local link partner is allowed to send PAUSE frames
271 no link partner is allowed to send PAUSE frames
274 Note that this parameter is ignored if AutoNeg_B is set to
278 This parameter is only valid for 1000Base-T adapter cards. For two 1000Base-T ports to communicate, one must take the role of the master (providing timing information), while the other must be the slave. Possible values are:
286 is the default. Usually, the role of a port is negotiated between two ports during link establishment, but if that fails the port A of an adapter card can be forced to a specific setting with this parameter.
289 This parameter is only valid for 1000Base-T adapter cards. For two 1000Base-T ports to communicate, one must take the role of the master (providing timing information), while the other must be the slave. Possible values are:
297 is the default. Usually, the role of a port is negotiated between two ports during link establishment, but if that fails the port B of an adapter card can be forced to a specific setting with this parameter.
300 This parameter is a combination of all five per-port parameters within one single parameter. This simplifies the configuration of both ports of an adapter card. The different values of this variable reflect the most meaningful combinations of port parameters. Possible values and their corresponding combination of per-port parameters:
304 ConType | DupCap AutoNeg FlowCtrl Role Speed
305 --------+-------------------------------------------
308 | Both On SymOrRem Auto Auto
311 | Full Off None Auto 100
314 | Half Off None Auto 100
317 | Full Off None Auto 10
320 | Half Off None Auto 10
323 Stating any other port parameter together with this
325 parameter will result in a merged configuration of those settings. This is due to
326 the fact, that the per-port parameters (e.g.
328 ) have a higher priority than the combined variable
332 .BI Moderation= i,j,...
333 Interrupt moderation is employed to limit the maximum number of interrupts the driver has to serve. That is, one or more interrupts (which indicate any transmit or receive packet to be processed) are queued until the driver processes them. When queued interrupts are to be served, is determined by the
335 parameter, which is explained later below. Possible moderation modes are:
343 is the default. The different modes have the following meaning:
346 No interrupt moderation is applied on the adapter card. Therefore, each transmit or receive interrupt is served immediately as soon as it appears on the interrupt line of the adapter card.
350 Interrupt moderation is applied on the adapter card. All transmit and receive interrupts are queued until a complete moderation interval ends. If such a moderation interval ends, all queued interrupts are processed in one big bunch without any delay. The term
352 reflects the fact, that interrupt moderation is always enabled, regardless how much network load is currently passing via a particular interface. In addition, the duration of the moderation interval has a fixed length that never changes while the driver is operational.
356 Interrupt moderation might be applied on the adapter card, depending on the load of the system. If the driver detects that the system load is too high, the driver tries to shield the system against too much network load by enabling interrupt moderation. If - at a later time - the CPU utilization decreases again (or if the network load is negligible) the interrupt moderation will automatically be disabled.
358 Interrupt moderation should be used when the driver has to handle one or more interfaces with a high network load, which - as a consequence - leads also to a high CPU utilization. When moderation is applied in such high network load situations, CPU load might be reduced by 20-30% on slow computers.
360 Note that the drawback of using interrupt moderation is an increase of the round-trip-time (RTT), due to the queuing and serving of interrupts at dedicated
363 .BI IntsPerSec= i,j,...
364 This parameter determines the length of any interrupt moderation interval.
365 Assuming that static interrupt moderation is to be used, an
367 parameter value of 2000 will lead to an interrupt moderation interval of
368 500 microseconds. Possible values for this parameter are in the range of 30...40000 (interrupts per second). The default value is 2000.
370 This parameter is only used, if either static or dynamic interrupt moderation
371 is enabled on a network adapter card. This parameter is ignored if no moderation is
374 Note that the duration of the moderation interval is to be chosen with care.
375 At first glance, selecting a very long duration (e.g. only 100 interrupts per
376 second) seems to be meaningful, but the increase of packet-processing delay
377 is tremendous. On the other hand, selecting a very short moderation time might
378 compensate the use of any moderation being applied.
380 .BI PrefPort= i,j,...
381 This parameter is used to force the preferred port to A or B (on dual-port network adapters). The preferred port is the one that is used if both ports A and B are detected as fully functional. Possible values are:
389 .BI RlmtMode= i,j,...
390 RLMT monitors the status of the port. If the link of the active port fails, RLMT switches immediately to the standby link. The virtual link is maintained as long as at least one 'physical' link is up. This parameters states how RLMT should monitor both ports. Possible values are:
400 is the default. The different modes have the following meaning:
403 Check link state only: RLMT uses the link state reported by the adapter hardware for each individual port to determine whether a port can be used for all network traffic or not.
407 In this mode, RLMT monitors the network path between the two ports of an adapter by regularly exchanging packets between them. This mode requires a network configuration in which the two ports are able to "see" each other (i.e. there must not be any router between the ports).
411 Check local port and segmentation: This mode supports the same functions as the CheckLocalPort mode and additionally checks network segmentation between the ports. Therefore, this mode is only to be used if Gigabit Ethernet switches are installed on the network that have been configured to use the Spanning Tree protocol.
415 In this mode, ports A and B are used as separate devices. If you have a dual port adapter, port A will be configured as
419 Both ports can be used independently with distinct IP addresses. The preferred port setting is not used. RLMT is turned off.
425 are designed to operate in configurations where a network path between the ports on one adapter exists. Moreover, they are not designed to work where adapters are connected back-to-back.
427 .BI LowLatency= i,j,...
428 This parameter is used to reduce the packet latency time of the adapter. Setting
432 forces the adapter to pass any received packet immediately to upper network layers and to send out any transmit packet as fast as possible. Possible values are
440 Be aware of the fact that the system load increases if
444 and a lot of data packets are transmitted and received.
446 Note that this parameter is only used on adapters which are based on PCI Express compatible chipsets.
449 .B /proc/net/sk98lin/eth[x]
451 The statistics file of a particular interface of an adapter card. It contains generic information about the adapter card plus a detailed summary of all transmit and receive counters.
453 .B /usr/src/linux/Documentation/networking/sk98lin.txt
459 driver. It contains a detailed installation HOWTO and describes all parameters of the driver. It denotes also common problems and provides the solution to them.
461 Report any bugs to linux@syskonnect.de
463 (C)Copyright 1999-2005 Marvell(R).
466 Ralph Roesler \- rroesler@syskonnect.de
468 Mirko Lindner \- mlindner@syskonnect.de
470 modprobe(8), insmod(8), ifconfig(8).