1 .\" (C)Copyright 1999-2003 Marvell(R) -- linux@syskonnect.de
2 .\" sk98lin.4 1.1 2003/12/17 10:03:18
3 .\" This manpage can be viewed using `groff -Tascii -man sk98lin.4 | less`
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, write to the Free
22 .\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111,
25 .TH SK98LIN 4 2007-11-25 "Linux" "Linux Programmer's Manual"
27 sk98lin \- Marvell/SysKonnect Gigabit Ethernet driver v6.21
64 is the Gigabit Ethernet driver for
65 Marvell and SysKonnect network adapter cards.
66 It supports SysKonnect SK-98xx/SK-95xx
67 compliant Gigabit Ethernet Adapter and
68 any Yukon compliant chipset.
70 When loading the driver using insmod,
71 parameters for the network adapter cards
72 might be stated as a sequence of comma separated commands.
73 If for instance two network adapters are installed and AutoNegotiation on
74 Port A of the first adapter should be ON,
75 but on the Port A of the second adapter switched OFF, one must enter:
77 insmod sk98lin.o AutoNeg_A=On,Off
81 is bound to one or more adapter cards and the
83 file system is mounted on your system, a dedicated statistics file
84 will be created in folder
86 for all ports of the installed network adapter cards.
91 is the number of the interface that has been assigned to a
92 dedicated port by the system.
94 If loading is finished, any desired IP address can be
95 assigned to the respective
100 This causes the adapter to connect to the Ethernet and to display a status
101 message on the console saying "ethx: network connection up using port y"
102 followed by the configured or detected connection parameters.
106 also supports large frames (also called jumbo frames).
107 Using jumbo frames can improve throughput tremendously when
108 transferring large amounts of data.
109 To enable large frames, the MTU (maximum transfer unit) size
110 for an interface is to be set to a high value.
111 The default MTU size is 1500 and can be changed up to 9000 (bytes).
112 Setting the MTU size can be done when assigning the IP address
113 to the interface or later by using the
115 command with the mtu parameter.
116 If for instance eth0 needs an IP
117 address and a large frame MTU size,
118 the following two commands might be used:
120 ifconfig eth0 10.1.1.1
121 ifconfig eth0 mtu 9000
123 Those two commands might even be combined into one:
125 ifconfig eth0 10.1.1.1 mtu 9000
127 Note that large frames can only be used if permitted by
128 your network infrastructure.
129 This means, that any switch being used in your Ethernet must
130 also support large frames.
131 Quite some switches support large frames,
132 but need to be configured to do so.
133 Most of the times, their default setting is to support only
134 standard frames with an MTU size of 1500 (bytes).
135 In addition to the switches inside the network,
136 all network adapters that are to be used must also be
137 enabled regarding jumbo frames.
138 If an adapter is not set to receive large frames it will simply drop them.
140 Switching back to the standard Ethernet frame size can be done by using the
144 ifconfig eth0 mtu 1500
146 The Marvell/SysKonnect Gigabit Ethernet driver for Linux is able to
147 support VLAN and Link Aggregation according to
148 IEEE standards 802.1, 802.1q, and 802.3ad.
149 Those features are only available after installation of open source modules
150 which can be found on the Internet:
153 : http://www.candelatech.com/~greear/vlan.html
157 : http://www.st.rim.or.jp/~yumo
160 Note that Marvell/SysKonnect does not offer any support for these
161 open source modules and does not take the responsibility for any
162 kind of failures or problems arising when using these modules.
166 This parameter is used to set the speed capabilities of port A of an
168 It is only valid for Yukon copper adapters.
178 Usually, the speed is negotiated between the two ports
179 during link establishment.
181 a port can be forced to a specific setting with this parameter.
184 This parameter is used to set the speed capabilities of port B of
186 It is only valid for Yukon copper adapters.
196 Usually, the speed is negotiated between the two ports during link
199 a port can be forced to a specific setting with this parameter.
201 .BI AutoNeg_A= i,j,...
202 Enables or disables the use of autonegotiation of port A of an adapter card.
213 mode automatically detects whether the link partner supports
214 auto-negotiation or not.
216 .BI AutoNeg_B= i,j,...
217 Enables or disables the use of autonegotiation of port B of an adapter card.
228 mode automatically detects whether the link partner supports
229 auto-negotiation or not.
231 .BI DupCap_A= i,j,...
232 This parameter indicates the duplex mode to be used for port A
242 This parameter is only relevant if AutoNeg_A of port A is not set to
244 If AutoNeg_A is set to
246 all three values of DupCap_A (
252 If AutoNeg_A is set to
259 This DupCap_A parameter is useful if your link partner does not
260 support all possible duplex combinations.
262 .BI DupCap_B= i,j,...
263 This parameter indicates the duplex mode to be used for port B
273 This parameter is only relevant if AutoNeg_B of port B is not set to
275 If AutoNeg_B is set to
277 all three values of DupCap_B (
283 If AutoNeg_B is set to
290 This DupCap_B parameter is useful if your link partner does not
291 support all possible duplex combinations.
293 .BI FlowCtrl_A= i,j,...
294 This parameter can be used to set the flow control capabilities the
295 port reports during auto-negotiation.
305 The different modes have the following meaning:
310 both link partners are allowed to send PAUSE frames
314 both or only remote partner are allowed to send PAUSE frames
318 only local link partner is allowed to send PAUSE frames
322 no link partner is allowed to send PAUSE frames
324 Note that this parameter is ignored if AutoNeg_A is set to
327 .BI FlowCtrl_B= i,j,...
328 This parameter can be used to set the flow control capabilities the
329 port reports during auto-negotiation.
339 The different modes have the following meaning:
343 both link partners are allowed to send PAUSE frames
347 both or only remote partner are allowed to send PAUSE frames
351 only local link partner is allowed to send PAUSE frames
355 no link partner is allowed to send PAUSE frames
358 Note that this parameter is ignored if AutoNeg_B is set to
362 This parameter is only valid for 1000Base-T adapter cards.
363 For two 1000Base-T ports to communicate,
364 one must take the role of the master (providing timing information),
365 while the other must be the slave.
374 Usually, the role of a port is negotiated between two ports during
375 link establishment, but if that fails the port A of an adapter card
376 can be forced to a specific setting with this parameter.
379 This parameter is only valid for 1000Base-T adapter cards.
380 For two 1000Base-T ports to communicate, one must take
381 the role of the master (providing timing information),
382 while the other must be the slave.
391 Usually, the role of a port is negotiated between
392 two ports during link establishment, but if that fails
393 the port B of an adapter card can be forced to a
394 specific setting with this parameter.
397 This parameter is a combination of all five per-port parameters
398 within one single parameter.
399 This simplifies the configuration of both ports of an adapter card.
400 The different values of this variable reflect the
401 most meaningful combinations of port parameters.
402 Possible values and their corresponding combination of per-port parameters:
405 ConType | DupCap AutoNeg FlowCtrl Role Speed
406 --------+-------------------------------------------
407 \fIAuto\fP | Both On SymOrRem Auto Auto
409 \fI100FD\fP | Full Off None Auto 100
411 \fI100HD\fP | Half Off None Auto 100
413 \fI10FD\fP | Full Off None Auto 10
415 \fI10HD\fP | Half Off None Auto 10
418 Stating any other port parameter together with this
420 parameter will result in a merged configuration of those settings.
422 the fact, that the per-port parameters (e.g.
424 have a higher priority than the combined variable
427 .BI Moderation= i,j,...
428 Interrupt moderation is employed to limit the maximum number of interrupts
429 the driver has to serve.
430 That is, one or more interrupts (which indicate any transmit or
431 receive packet to be processed) are queued until the driver processes them.
432 When queued interrupts are to be served, is determined by the
434 parameter, which is explained later below.
435 Possible moderation modes are:
443 The different modes have the following meaning:
446 No interrupt moderation is applied on the adapter card.
447 Therefore, each transmit or receive interrupt is served immediately
448 as soon as it appears on the interrupt line of the adapter card.
452 Interrupt moderation is applied on the adapter card.
453 All transmit and receive interrupts are queued until
454 a complete moderation interval ends.
455 If such a moderation interval ends, all queued interrupts
456 are processed in one big bunch without any delay.
459 reflects the fact, that interrupt moderation is always enabled,
460 regardless how much network load is currently passing via a
461 particular interface.
462 In addition, the duration of the moderation interval has a fixed
463 length that never changes while the driver is operational.
467 Interrupt moderation might be applied on the adapter card,
468 depending on the load of the system.
469 If the driver detects that the system load is too high,
470 the driver tries to shield the system against too much network
471 load by enabling interrupt moderation.
472 If \(em at a later time \(em the CPU utilization decreases
473 again (or if the network load is negligible) the interrupt
474 moderation will automatically be disabled.
476 Interrupt moderation should be used when the driver has to
477 handle one or more interfaces with a high network load,
478 which \(em as a consequence \(em leads also to a high CPU utilization.
479 When moderation is applied in such high network load situations,
480 CPU load might be reduced by 20-30% on slow computers.
482 Note that the drawback of using interrupt moderation is an increase of
483 the round-trip-time (RTT), due to the queuing and serving of
484 interrupts at dedicated moderation times.
486 .BI IntsPerSec= i,j,...
487 This parameter determines the length of any interrupt moderation interval.
488 Assuming that static interrupt moderation is to be used, an
490 parameter value of 2000 will lead to an interrupt moderation interval of
492 Possible values for this parameter are in the range of
493 30...40000 (interrupts per second).
494 The default value is 2000.
496 This parameter is only used, if either static or dynamic interrupt moderation
497 is enabled on a network adapter card.
498 This parameter is ignored if no moderation is applied.
500 Note that the duration of the moderation interval is to be chosen with care.
501 At first glance, selecting a very long duration (e.g., only 100 interrupts per
502 second) seems to be meaningful, but the increase of packet-processing delay
504 On the other hand, selecting a very short moderation time might
505 compensate the use of any moderation being applied.
507 .BI PrefPort= i,j,...
508 This parameter is used to force the preferred port to
509 A or B (on dual-port network adapters).
510 The preferred port is the one that is used if both ports A and B are
511 detected as fully functional.
520 .BI RlmtMode= i,j,...
521 RLMT monitors the status of the port.
522 If the link of the active port fails,
523 RLMT switches immediately to the standby link.
524 The virtual link is maintained as long as at least one "physical" link is up.
525 This parameters states how RLMT should monitor both ports.
535 The different modes have the following meaning:
538 Check link state only: RLMT uses the link state reported by the adapter
539 hardware for each individual port to determine whether a port can be used
540 for all network traffic or not.
544 In this mode, RLMT monitors the network path between the two
545 ports of an adapter by regularly exchanging packets between them.
546 This mode requires a network configuration in which the
547 two ports are able to "see" each other (i.e., there
548 must not be any router between the ports).
552 Check local port and segmentation:
553 This mode supports the same functions as the CheckLocalPort
554 mode and additionally checks network segmentation between the ports.
555 Therefore, this mode is only to be used if Gigabit Ethernet
556 switches are installed on the network that have been
557 configured to use the Spanning Tree protocol.
561 In this mode, ports A and B are used as separate devices.
562 If you have a dual port adapter, port A will be configured as
566 Both ports can be used independently with distinct IP addresses.
567 The preferred port setting is not used.
574 are designed to operate in configurations where a
575 network path between the ports on one adapter exists.
576 Moreover, they are not designed to work where adapters are
577 connected back-to-back.
580 .I /proc/net/sk98lin/eth[x]
582 The statistics file of a particular interface of an adapter card.
583 It contains generic information about the adapter card plus a detailed
584 summary of all transmit and receive counters.
586 .I /usr/src/linux/Documentation/networking/sk98lin.txt
593 It contains a detailed installation HOWTO and describes all parameters
595 It denotes also common problems and provides the solution to them.
597 Report any bugs to linux@syskonnect.de
599 .\" Ralph Roesler \(em rroesler@syskonnect.de
601 .\" Mirko Lindner \(em mlindner@syskonnect.de
projects / thirdparty / man-pages.git / blob