| blob | 3bbbd69f099d1cb3e762a8bd6c01bc96332af8a1 |
1 '\" t
2 .\" (C)Copyright 1999-2003 Marvell(R) -- linux@syskonnect.de
3 .\" sk98lin.4 1.1 2003/12/17 10:03:18
4 .\"
5 .\" SPDX-License-Identifier: GPL-2.0-or-later
6 .\"
7 .\" This manpage can be viewed using `groff -Tascii -man sk98lin.4 | less`
8 .\"
9 .TH sk98lin 4 (date) "Linux man-pages (unreleased)"
10 .SH NAME
11 sk98lin \- Marvell/SysKonnect Gigabit Ethernet driver v6.21
12 .SH SYNOPSIS
13 .B insmod sk98lin.o
14 .RB [ Speed_A=\c
15 .IR i,j,... ]
16 .RB [ Speed_B=\c
17 .IR i,j,... ]
18 .RB [ AutoNeg_A=\c
19 .IR i,j,... ]
20 .RB [ AutoNeg_B=\c
21 .IR i,j,... ]
22 .RB [ DupCap_A=\c
23 .IR i,j,... ]
24 .RB [ DupCap_B=\c
25 .IR i,j,... ]
26 .RB [ FlowCtrl_A=\c
27 .IR i,j,... ]
28 .RB [ FlowCtrl_B=\c
29 .IR i,j,... ]
30 .RB [ Role_A=\c
31 .IR i,j,... ]
32 .RB [ Role_B=\c
33 .IR i,j,... ]
34 .RB [ ConType=\c
35 .IR i,j,... ]
36 .RB [ Moderation=\c
37 .IR i,j,... ]
38 .RB [ IntsPerSec=\c
39 .IR i,j,... ]
40 .RB [ PrefPort=\c
41 .IR i,j,... ]
42 .RB [ RlmtMode=\c
43 .IR i,j,... ]
44 .SH DESCRIPTION
45 .ad l
46 .hy 0
47 .BR Note :
48 This obsolete driver was removed in Linux 2.6.26.
49 .P
50 .B sk98lin
51 is the Gigabit Ethernet driver for
52 Marvell and SysKonnect network adapter cards.
53 It supports SysKonnect SK-98xx/SK-95xx
54 compliant Gigabit Ethernet Adapter and
55 any Yukon compliant chipset.
56 .P
57 When loading the driver using insmod,
58 parameters for the network adapter cards
59 might be stated as a sequence of comma separated commands.
60 If for instance two network adapters are installed and AutoNegotiation on
61 Port A of the first adapter should be ON,
62 but on the Port A of the second adapter switched OFF, one must enter:
63 .P
64 .in +4n
65 .EX
66 insmod sk98lin.o AutoNeg_A=On,Off
67 .EE
68 .in
69 .P
70 After
71 .B sk98lin
72 is bound to one or more adapter cards and the
73 .I /proc
74 filesystem is mounted on your system, a dedicated statistics file
75 will be created in the folder
76 .I /proc/net/sk98lin
77 for all ports of the installed network adapter cards.
78 Those files are named
79 .IR eth[x] ,
80 where
81 .I x
82 is the number of the interface that has been assigned to a
83 dedicated port by the system.
84 .P
85 If loading is finished, any desired IP address can be
86 assigned to the respective
87 .I eth[x]
88 interface using the
89 .BR ifconfig (8)
90 command.
91 This causes the adapter to connect to the Ethernet and to display a status
92 message on the console saying "ethx: network connection up using port y"
93 followed by the configured or detected connection parameters.
94 .P
95 The
96 .B sk98lin
97 also supports large frames (also called jumbo frames).
98 Using jumbo frames can improve throughput tremendously when
99 transferring large amounts of data.
100 To enable large frames, the MTU (maximum transfer unit) size
101 for an interface is to be set to a high value.
102 The default MTU size is 1500 and can be changed up to 9000 (bytes).
103 Setting the MTU size can be done when assigning the IP address
104 to the interface or later by using the
105 .BR ifconfig (8)
106 command with the mtu parameter.
107 If for instance eth0 needs an IP
108 address and a large frame MTU size,
109 the following two commands might be used:
110 .P
111 .in +4n
112 .EX
113 ifconfig eth0 10.1.1.1
114 ifconfig eth0 mtu 9000
115 .EE
116 .in
117 .P
118 Those two commands might even be combined into one:
119 .P
120 .in +4n
121 .EX
122 ifconfig eth0 10.1.1.1 mtu 9000
123 .EE
124 .in
125 .P
126 Note that large frames can be used only if permitted by
127 your network infrastructure.
128 This means, that any switch being used in your Ethernet must
129 also support large frames.
130 Quite some switches support large frames,
131 but need to be configured to do so.
132 Most of the times, their default setting is to support only
133 standard frames with an MTU size of 1500 (bytes).
134 In addition to the switches inside the network,
135 all network adapters that are to be used must also be
136 enabled regarding jumbo frames.
137 If an adapter is not set to receive large frames, it will simply drop them.
138 .P
139 Switching back to the standard Ethernet frame size can be done by using the
140 .BR ifconfig (8)
141 command again:
142 .P
143 .in +4n
144 .EX
145 ifconfig eth0 mtu 1500
146 .EE
147 .in
148 .P
149 The Marvell/SysKonnect Gigabit Ethernet driver for Linux is able to
150 support VLAN and Link Aggregation according to
151 IEEE standards 802.1, 802.1q, and 802.3ad.
152 Those features are available only after installation of open source modules
153 which can be found on the Internet:
154 .P
155 .IR VLAN :
156 .UR http://www.candelatech.com\:/\[ti]greear\:/vlan.html
157 .UE
158 .br
159 .I Link
160 .IR Aggregation :
161 .UR http://www.st.rim.or.jp\:/\[ti]yumo
162 .UE
163 .P
164 Note that Marvell/SysKonnect does not offer any support for these
165 open source modules and does not take the responsibility for any
166 kind of failures or problems arising when using these modules.
167 .SS Parameters
168 .TP
169 .BI Speed_A= i,j,...
170 This parameter is used to set the speed capabilities of port A of an
171 adapter card.
172 It is valid only for Yukon copper adapters.
173 Possible values are:
174 .IR 10 ,
175 .IR 100 ,
176 .IR 1000 ,
177 or
178 .IR Auto ;
179 .I Auto
180 is the default.
181 Usually, the speed is negotiated between the two ports
182 during link establishment.
183 If this fails,
184 a port can be forced to a specific setting with this parameter.
185 .TP
186 .BI Speed_B= i,j,...
187 This parameter is used to set the speed capabilities of port B of
188 an adapter card.
189 It is valid only for Yukon copper adapters.
190 Possible values are:
191 .IR 10 ,
192 .IR 100 ,
193 .IR 1000 ,
194 or
195 .IR Auto ;
196 .I Auto
197 is the default.
198 Usually, the speed is negotiated between the two ports during link
199 establishment.
200 If this fails,
201 a port can be forced to a specific setting with this parameter.
202 .TP
203 .BI AutoNeg_A= i,j,...
204 Enables or disables the use of autonegotiation of port A of an adapter card.
205 Possible values are:
206 .IR On ,
207 .IR Off ,
208 or
209 .IR Sense ;
210 .I On
211 is the default.
212 The
213 .I Sense
214 mode automatically detects whether the link partner supports
215 auto-negotiation or not.
216 .TP
217 .BI AutoNeg_B= i,j,...
218 Enables or disables the use of autonegotiation of port B of an adapter card.
219 Possible values are:
220 .IR On ,
221 .IR Off ,
222 or
223 .IR Sense ;
224 .I On
225 is the default.
226 The
227 .I Sense
228 mode automatically detects whether the link partner supports
229 auto-negotiation or not.
230 .TP
231 .BI DupCap_A= i,j,...
232 This parameter indicates the duplex mode to be used for port A
233 of an adapter card.
234 Possible values are:
235 .IR Half ,
236 .IR Full ,
237 or
238 .IR Both ;
239 .I Both
240 is the default.
241 This parameter is relevant only if AutoNeg_A of port A is not set to
242 .IR Sense .
243 If AutoNeg_A is set to
244 .IR On ,
245 all three values of DupCap_A (
246 .IR Half ,
247 .IR Full ,
248 or
249 .IR Both )
250 might be stated.
251 If AutoNeg_A is set to
252 .IR Off ,
253 only DupCap_A values
254 .I Full
255 and
256 .I Half
257 are allowed.
258 This DupCap_A parameter is useful if your link partner does not
259 support all possible duplex combinations.
260 .TP
261 .BI DupCap_B= i,j,...
262 This parameter indicates the duplex mode to be used for port B
263 of an adapter card.
264 Possible values are:
265 .IR Half ,
266 .IR Full ,
267 or
268 .IR Both ;
269 .I Both
270 is the default.
271 This parameter is relevant only if AutoNeg_B of port B is not set to
272 .IR Sense .
273 If AutoNeg_B is set to
274 .IR On ,
275 all three values of DupCap_B (
276 .IR Half ,
277 .IR Full ,
278 or
279 .IR Both )
280 might be stated.
281 If AutoNeg_B is set to
282 .IR Off ,
283 only DupCap_B values
284 .I Full
285 and
286 .I Half
287 are allowed.
288 This DupCap_B parameter is useful if your link partner does not
289 support all possible duplex combinations.
290 .TP
291 .BI FlowCtrl_A= i,j,...
292 This parameter can be used to set the flow control capabilities the
293 port reports during auto-negotiation.
294 Possible values are:
295 .IR Sym ,
296 .IR SymOrRem ,
297 .IR LocSend ,
298 or
299 .IR None ;
300 .I SymOrRem
301 is the default.
302 The different modes have the following meaning:
303 .RS
304 .TP
305 .IR Sym " = Symmetric"
306 Both link partners are allowed to send PAUSE frames.
307 .TP
308 .IR SymOrRem " = SymmetricOrRemote"
309 Both or only remote partner are allowed to send PAUSE frames.
310 .TP
311 .IR LocSend " = LocalSend"
312 Only local link partner is allowed to send PAUSE frames.
313 .TP
314 .IR None " = None"
315 No link partner is allowed to send PAUSE frames.
316 .RE
317 .IP
318 Note that this parameter is ignored if AutoNeg_A is set to
319 .IR Off .
320 .TP
321 .BI FlowCtrl_B= i,j,...
322 This parameter can be used to set the flow control capabilities the
323 port reports during auto-negotiation.
324 Possible values are:
325 .IR Sym ,
326 .IR SymOrRem ,
327 .IR LocSend ,
328 or
329 .IR None ;
330 .I SymOrRem
331 is the default.
332 The different modes have the following meaning:
333 .RS
334 .TP
335 .IR Sym " = Symmetric"
336 Both link partners are allowed to send PAUSE frames.
337 .TP
338 .IR SymOrRem " = SymmetricOrRemote"
339 Both or only remote partner are allowed to send PAUSE frames.
340 .TP
341 .IR LocSend " = LocalSend"
342 Only local link partner is allowed to send PAUSE frames.
343 .TP
344 .IR None " = None"
345 No link partner is allowed to send PAUSE frames.
346 .RE
347 .IP
348 Note that this parameter is ignored if AutoNeg_B is set to
349 .IR Off .
350 .TP
351 .BI Role_A= i,j,...
352 This parameter is valid only for 1000Base-T adapter cards.
353 For two 1000Base-T ports to communicate,
354 one must take the role of the master (providing timing information),
355 while the other must be the slave.
356 Possible values are:
357 .IR Auto ,
358 .IR Master ,
359 or
360 .IR Slave ;
361 .I Auto
362 is the default.
363 Usually, the role of a port is negotiated between two ports during
364 link establishment, but if that fails the port A of an adapter card
365 can be forced to a specific setting with this parameter.
366 .TP
367 .BI Role_B= i,j,...
368 This parameter is valid only for 1000Base-T adapter cards.
369 For two 1000Base-T ports to communicate, one must take
370 the role of the master (providing timing information),
371 while the other must be the slave.
372 Possible values are:
373 .IR Auto ,
374 .IR Master ,
375 or
376 .IR Slave ;
377 .I Auto
378 is the default.
379 Usually, the role of a port is negotiated between
380 two ports during link establishment, but if that fails
381 the port B of an adapter card can be forced to a
382 specific setting with this parameter.
383 .TP
384 .BI ConType= i,j,...
385 This parameter is a combination of all five per-port parameters
386 within one single parameter.
387 This simplifies the configuration of both ports of an adapter card.
388 The different values of this variable reflect the
389 most meaningful combinations of port parameters.
390 Possible values and their corresponding combination of per-port parameters:
391 .IP
392 .TS
393 lb lb lb lb lb lb
394 l l l l l l.
395 ConType DupCap AutoNeg FlowCtrl Role Speed
396 \fIAuto\fP Both On SymOrRem Auto Auto
397 \fI100FD\fP Full Off None Auto 100
398 \fI100HD\fP Half Off None Auto 100
399 \fI10FD\fP Full Off None Auto 10
400 \fI10HD\fP Half Off None Auto 10
401 .TE
402 .IP
403 Stating any other port parameter together with this
404 .I ConType
405 parameter will result in a merged configuration of those settings.
406 This is due to
407 the fact, that the per-port parameters (e.g.,
408 .IR Speed_A )
409 have a higher priority than the combined variable
410 .IR ConType .
411 .TP
412 .BI Moderation= i,j,...
413 Interrupt moderation is employed to limit the maximum number of interrupts
414 the driver has to serve.
415 That is, one or more interrupts (which indicate any transmit or
416 receive packet to be processed) are queued until the driver processes them.
417 When queued interrupts are to be served, is determined by the
418 .I IntsPerSec
419 parameter, which is explained later below.
420 Possible moderation modes are:
421 .IR None ,
422 .IR Static ,
423 or
424 .IR Dynamic ;
425 .I None
426 is the default.
427 The different modes have the following meaning:
428 .IP
429 .I None
430 No interrupt moderation is applied on the adapter card.
431 Therefore, each transmit or receive interrupt is served immediately
432 as soon as it appears on the interrupt line of the adapter card.
433 .IP
434 .I Static
435 Interrupt moderation is applied on the adapter card.
436 All transmit and receive interrupts are queued until
437 a complete moderation interval ends.
438 If such a moderation interval ends, all queued interrupts
439 are processed in one big bunch without any delay.
440 The term
441 .I Static
442 reflects the fact, that interrupt moderation is always enabled,
443 regardless how much network load is currently passing via a
444 particular interface.
445 In addition, the duration of the moderation interval has a fixed
446 length that never changes while the driver is operational.
447 .IP
448 .I Dynamic
449 Interrupt moderation might be applied on the adapter card,
450 depending on the load of the system.
451 If the driver detects that the system load is too high,
452 the driver tries to shield the system against too much network
453 load by enabling interrupt moderation.
454 If\[em]at a later time\[em]the CPU utilization decreases
455 again (or if the network load is negligible), the interrupt
456 moderation will automatically be disabled.
457 .IP
458 Interrupt moderation should be used when the driver has to
459 handle one or more interfaces with a high network load,
460 which\[em]as a consequence\[em]leads also to a high CPU utilization.
461 When moderation is applied in such high network load situations,
462 CPU load might be reduced by 20\[en]30% on slow computers.
463 .IP
464 Note that the drawback of using interrupt moderation is an increase of
465 the round-trip-time (RTT), due to the queuing and serving of
466 interrupts at dedicated moderation times.
467 .TP
468 .BI IntsPerSec= i,j,...
469 This parameter determines the length of any interrupt moderation interval.
470 Assuming that static interrupt moderation is to be used, an
471 .I IntsPerSec
472 parameter value of 2000 will lead to an interrupt moderation interval of
473 500 microseconds.
474 Possible values for this parameter are in the range of
475 30...40000 (interrupts per second).
476 The default value is 2000.
477 .IP
478 This parameter is used only if either static or dynamic interrupt moderation
479 is enabled on a network adapter card.
480 This parameter is ignored if no moderation is applied.
481 .IP
482 Note that the duration of the moderation interval is to be chosen with care.
483 At first glance, selecting a very long duration (e.g., only 100 interrupts per
484 second) seems to be meaningful, but the increase of packet-processing delay
485 is tremendous.
486 On the other hand, selecting a very short moderation time might
487 compensate the use of any moderation being applied.
488 .TP
489 .BI PrefPort= i,j,...
490 This parameter is used to force the preferred port to
491 A or B (on dual-port network adapters).
492 The preferred port is the one that is used if both ports A and B are
493 detected as fully functional.
494 Possible values are:
495 .I A
496 or
497 .IR B ;
498 .I A
499 is the default.
500 .TP
501 .BI RlmtMode= i,j,...
502 RLMT monitors the status of the port.
503 If the link of the active port fails,
504 RLMT switches immediately to the standby link.
505 The virtual link is maintained as long as at least one "physical" link is up.
506 This parameters states how RLMT should monitor both ports.
507 Possible values are:
508 .IR CheckLinkState ,
509 .IR CheckLocalPort ,
510 .IR CheckSeg ,
511 or
512 .IR DualNet ;
513 .I CheckLinkState
514 is the default.
515 The different modes have the following meaning:
516 .IP
517 .I CheckLinkState
518 Check link state only: RLMT uses the link state reported by the adapter
519 hardware for each individual port to determine whether a port can be used
520 for all network traffic or not.
521 .IP
522 .I CheckLocalPort
523 In this mode, RLMT monitors the network path between the two
524 ports of an adapter by regularly exchanging packets between them.
525 This mode requires a network configuration in which the
526 two ports are able to "see" each other (i.e., there
527 must not be any router between the ports).
528 .IP
529 .I CheckSeg
530 Check local port and segmentation:
531 This mode supports the same functions as the CheckLocalPort
532 mode and additionally checks network segmentation between the ports.
533 Therefore, this mode is to be used only if Gigabit Ethernet
534 switches are installed on the network that have been
535 configured to use the Spanning Tree protocol.
536 .IP
537 .I DualNet
538 In this mode, ports A and B are used as separate devices.
539 If you have a dual port adapter, port A will be configured as
540 .I eth[x]
541 and port B as
542 .IR eth[x+1] .
543 Both ports can be used independently with distinct IP addresses.
544 The preferred port setting is not used.
545 RLMT is turned off.
546 .IP
547 Note that RLMT modes
548 .I CheckLocalPort
549 and
550 .I CheckLinkState
551 are designed to operate in configurations where a
552 network path between the ports on one adapter exists.
553 Moreover, they are not designed to work where adapters are
554 connected back-to-back.
555 .SH FILES
556 .TP
557 .I /proc/net/sk98lin/eth[x]
558 The statistics file of a particular interface of an adapter card.
559 It contains generic information about the adapter card plus a detailed
560 summary of all transmit and receive counters.
561 .TP
562 .I /usr/src/linux/Documentation/networking/sk98lin.txt
563 This is the
564 .I README
565 file of the
566 .I sk98lin
567 driver.
568 It contains a detailed installation HOWTO and describes all parameters
569 of the driver.
570 It denotes also common problems and provides the solution to them.
571 .SH BUGS
572 Report any bugs to linux@syskonnect.de
573 .\" .SH AUTHORS
574 .\" Ralph Roesler \[em] rroesler@syskonnect.de
575 .\" .br
576 .\" Mirko Lindner \[em] mlindner@syskonnect.de
577 .SH SEE ALSO
578 .BR ifconfig (8),
579 .BR insmod (8),
580 .BR modprobe (8)