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