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