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