Debian Codegraph @

upstream/opensuse-tumbleweed/man4/sk98lin.4

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