OSDN Git Service

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