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