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