sk98lin.4

   1 .\" (C)Copyright 1999-2005 Marvell(R). -- linux@syskonnect.de
   2 .\" sk98lin.4 1.1 2005/04/25 15:13:26
   3 .\" This manpage can be viewed using `groff -Tascii -man sk98lin.4 | less`
   4 .\"
   5 .TH SK98LIN 4 "2005/04/25 15:13:26" "sk98lin 8.18.2.2 (beta)"
   6 .SH NAME
   7 sk98lin \- Marvell/SysKonnect Gigabit Ethernet driver v8.18.2.2 (beta)
   8 .SH SYNOPSIS
   9 .B insmod sk98lin.o
  10 .RB [ Speed_A=\c
  11 .IR i,j,... ]
  12 .RB [ Speed_B=\c
  13 .IR i,j,... ]
  14 .RB [ AutoNeg_A=\c
  15 .IR i,j,... ]
  16 .RB [ AutoNeg_B=\c
  17 .IR i,j,... ]
  18 .RB [ DupCap_A=\c
  19 .IR i,j,... ]
  20 .RB [ DupCap_B=\c
  21 .IR i,j,... ]
  22 .RB [ FlowCtrl_A=\c
  23 .IR i,j,... ]
  24 .RB [ FlowCtrl_B=\c
  25 .IR i,j,... ]
  26 .RB [ Role_A=\c
  27 .IR i,j,... ]
  28 .RB [ Role_B=\c
  29 .IR i,j,... ]
  30 .RB [ ConType=\c
  31 .IR i,j,... ]
  32 .RB [ Moderation=\c
  33 .IR i,j,... ]
  34 .RB [ IntsPerSec=\c
  35 .IR i,j,... ]
  36 .RB [ PrefPort=\c
  37 .IR i,j,... ]
  38 .RB [ RlmtMode=\c
  39 .IR i,j,... ]
  40 .RB [ LowLatency=\c
  41 .IR i,j,... ]
  42 .SH DESCRIPTION
  43 .B sk98lin
  44 is the Gigabit Ethernet driver for Marvell and SysKonnect network adapter cards.
  45 It supports SysKonnect SK-98xx/SK-95xx compliant Gigabit Ethernet Adapter and any Yukon compliant chipset.
  46
  47 When loading the driver using
  48 .BR insmod (8)
  49 , parameters for the network adapter cards might be stated as a sequence of comma separated commands. If for instance two network adapters are installed and AutoNegotiation on Port A of the first adapter should be ON, but on the Port A of the second adapter switched OFF, one must enter:
  50
  51    insmod sk98lin.o AutoNeg_A=On,Off
  52
  53 After
  54 .B sk98lin
  55 is bound to one or more adapter cards and the
  56 .IR /proc
  57 filesystem is mounted on your system, a dedicated statistics file will be created in folder
  58 .IR /proc/net/sk98lin
  59 for all ports of the installed network adapter cards. Those files are named
  60 .IR eth[x]
  61 whereby
  62 .IR x
  63 is the number of the interface that has been assigned to a dedicated port by the system.
  64
  65 If loading is finished, any desired IP address can be assigned to the respective
  66 .IR eth[x]
  67 interface using the
  68 .BR ifconfig (8)
  69 command. This causes the adapter to connect to the Ethernet and to display a status message on the console saying "ethx: network connection up using port y" followed by the configured or detected connection parameters.
  70
  71 The
  72 .B sk98lin
  73 also supports large frames (also called jumbo frames). Using jumbo frames can improve throughput tremendously when transferring large amounts of data. To enable large frames, the MTU (maximum transfer unit) size for an interface is to be set to a high value. The default MTU size is 1500 and can be changed up to 9000 (bytes). Setting the MTU size can be done when assigning the IP address to the interface or later by using the
  74 .BR ifconfig (8)
  75 command with the mtu parameter. If for instance eth0 needs an IP address and a large frame MTU size, the following two commands might be used:
  76
  77     ifconfig eth0 10.1.1.1
  78     ifconfig eth0 mtu 9000
  79
  80 Those two commands might even be combined into one:
  81
  82     ifconfig eth0 10.1.1.1 mtu 9000
  83
  84 Note that large frames can only be used if your network infrastructure allows to do so. This means, that any switch being used in your Ethernet must also support large frames. Quite some switches support large frames, but need to be configured to do so. Most of the times, their default setting is to support only standard frames with an MTU size of 1500 (bytes). In addition to the switches inside the network, all network adapters that are to be used must also be enabled regarding jumbo frames. If an adapter is not set to receive large frames it will simply drop them.
  85
  86 Switching back to the standard Ethernet frame size can be done by using the
  87 .BR ifconfig (8)
  88 command again:
  89
  90     ifconfig eth0 mtu 1500
  91
  92 The Marvell/SysKonnect Gigabit Ethernet driver for Linux is able to support VLAN and Link Aggregation according to IEEE standards 802.1, 802.1q, and 802.3ad. Those features are only available after installation of open source modules which can be found on the Internet:
  93
  94 .IR VLAN \c
  95 : http://www.candelatech.com/~greear/vlan.html
  96 .br
  97 .IR Link
  98 .IR Aggregation \c
  99 : http://www.st.rim.or.jp/~yumo
 100
 101 .br
 102 Note that Marvell/SysKonnect does not offer any support for these open source modules and does not take the responsibility for any kind of failures or problems arising when using these modules.
 103 .SH PARAMETERS
 104 .TP
 105 .BI Speed_A= i,j,...
 106 This parameter is used to set the speed capabilities of port A of an adapter card. It is only valid for Yukon copper adapters. Possible values are:
 107 .IR 10
 108 ,
 109 .IR 100
 110 ,
 111 .IR 1000
 112 or
 113 .IR Auto
 114 whereby
 115 .IR Auto
 116 is the default. Usually, the speed is negotiated between the two ports during link establishment. If this fails, a port can be forced to a specific setting with this parameter.
 117 .TP
 118 .BI Speed_B= i,j,...
 119 This parameter is used to set the speed capabilities of port B of an adapter card. It is only valid for Yukon copper adapters. Possible values are:
 120 .IR 10
 121 ,
 122 .IR 100
 123 ,
 124 .IR 1000
 125 or
 126 .IR Auto
 127 whereby
 128 .IR Auto
 129 is the default. Usually, the speed is negotiated between the two ports during link establishment. If this fails, a port can be forced to a specific setting with this parameter.
 130 .TP
 131 .BI AutoNeg_A= i,j,...
 132 Enables or disables the use of autonegotiation of port A of an adapter card. Possible values are:
 133 .IR On
 134 ,
 135 .IR Off
 136 or
 137 .IR Sense
 138 whereby
 139 .IR On
 140 is the default. The
 141 .IR Sense
 142 mode automatically detects whether the link partner supports auto-negotiation or not.
 143 .TP
 144 .BI AutoNeg_B= i,j,...
 145 Enables or disables the use of autonegotiation of port B of an adapter card. Possible values are:
 146 .IR On
 147 ,
 148 .IR Off
 149 or
 150 .IR Sense
 151 whereby
 152 .IR On
 153 is the default. The
 154 .IR Sense
 155 mode automatically detects whether the link partner supports auto-negotiation or not.
 156 .TP
 157 .BI DupCap_A= i,j,...
 158 This parameter indicates the duplex mode to be used for port A of an adapter card. Possible values are:
 159 .IR Half
 160 ,
 161 .IR Full
 162 or
 163 .IR Both
 164 whereby
 165 .IR Both
 166 is the default. This parameter is only relevant if AutoNeg_A of port A is not set to
 167 .IR Sense.
 168 If AutoNeg_A is set to
 169 .IR On
 170 , all three values of DupCap_A (
 171 .IR Half
 172 ,
 173 .IR Full
 174 or
 175 .IR Both
 176 ) might be stated. If AutoNeg_A is set to
 177 .IR Off
 178 , only DupCap_A values
 179 .IR Full
 180 and
 181 .IR Half
 182 are allowed. This DupCap_A parameter is useful if your link partner does not support all possible duplex combinations.
 183 .TP
 184 .BI DupCap_B= i,j,...
 185 This parameter indicates the duplex mode to be used for port B of an adapter card. Possible values are:
 186 .IR Half
 187 ,
 188 .IR Full
 189 or
 190 .IR Both
 191 whereby
 192 .IR Both
 193 is the default. This parameter is only relevant if AutoNeg_B of port B is not set to
 194 .IR Sense.
 195 If AutoNeg_B is set to
 196 .IR On
 197 , all three values of DupCap_B (
 198 .IR Half
 199 ,
 200 .IR Full
 201 or
 202 .IR Both
 203 ) might be stated. If AutoNeg_B is set to
 204 .IR Off
 205 , only DupCap_B values
 206 .IR Full
 207 and
 208 .IR Half
 209 are allowed. This DupCap_B parameter is useful if your link partner does not support all possible duplex combinations.
 210 .TP
 211 .BI FlowCtrl_A= i,j,...
 212 This parameter can be used to set the flow control capabilities the port reports during auto-negotiation. Possible values are:
 213 .IR Sym
 214 ,
 215 .IR SymOrRem
 216 ,
 217 .IR LocSend
 218 or
 219 .IR None
 220 whereby
 221 .IR SymOrRem
 222 is the default.  The different modes have the following meaning:
 223
 224 .br
 225 .IR Sym
 226 = Symmetric
 227  both link partners are allowed to send PAUSE frames
 228 .br
 229 .IR SymOrRem
 230 = SymmetricOrRemote
 231  both or only remote partner are allowed to send PAUSE frames
 232 .br
 233 .IR LocSend
 234 = LocalSend
 235  only local link partner is allowed to send PAUSE frames
 236 .br
 237 .IR None
 238 = None
 239  no link partner is allowed to send PAUSE frames
 240
 241 Note that this parameter is ignored if AutoNeg_A is set to
 242 .IR Off .
 243 .TP
 244 .BI FlowCtrl_B= i,j,...
 245 This parameter can be used to set the flow control capabilities the port reports during auto-negotiation. Possible values are:
 246 .IR Sym
 247 ,
 248 .IR SymOrRem
 249 ,
 250 .IR LocSend
 251 or
 252 .IR None
 253 whereby
 254 .IR SymOrRem
 255 is the default.  The different modes have the following meaning:
 256
 257 .IR Sym
 258 = Symmetric
 259  both link partners are allowed to send PAUSE frames
 260 .br
 261 .IR SymOrRem
 262 = SymmetricOrRemote
 263  both or only remote partner are allowed to send PAUSE frames
 264 .br
 265 .IR LocSend
 266 = LocalSend
 267  only local link partner is allowed to send PAUSE frames
 268 .br
 269 .IR None
 270 = None
 271  no link partner is allowed to send PAUSE frames
 272 .br
 273
 274 Note that this parameter is ignored if AutoNeg_B is set to
 275 .IR Off .
 276 .TP
 277 .BI Role_A= i,j,...
 278 This parameter is only valid for 1000Base-T adapter cards. For two 1000Base-T ports to communicate, one must take the role of the master (providing timing information), while the other must be the slave. Possible values are:
 279 .IR Auto
 280 ,
 281 .IR Master
 282 or
 283 .IR Slave
 284 whereby
 285 .IR Auto
 286 is the default. Usually, the role of a port is negotiated between two ports during link establishment, but if that fails the port A of an adapter card can be forced to a specific setting with this parameter.
 287 .TP
 288 .BI Role_B= i,j,...
 289 This parameter is only valid for 1000Base-T adapter cards. For two 1000Base-T ports to communicate, one must take the role of the master (providing timing information), while the other must be the slave. Possible values are:
 290 .IR Auto
 291 ,
 292 .IR Master
 293 or
 294 .IR Slave
 295 whereby
 296 .IR Auto
 297 is the default. Usually, the role of a port is negotiated between two ports during link establishment, but if that fails the port B of an adapter card can be forced to a specific setting with this parameter.
 298 .TP
 299 .BI ConType= i,j,...
 300 This parameter is a combination of all five per-port parameters within one single parameter. This simplifies the configuration of both ports of an adapter card. The different values of this variable reflect the most meaningful combinations of port parameters. Possible values and their corresponding combination of per-port parameters:
 301
 302 .br
 303 .ad l
 304 ConType | DupCap   AutoNeg   FlowCtrl   Role   Speed
 305 --------+-------------------------------------------
 306 .br
 307 .IR Auto \c
 308     |  Both      On      SymOrRem   Auto   Auto
 309 .br
 310 .IR 100FD \c
 311    |  Full      Off       None     Auto   100
 312 .br
 313 .IR 100HD \c
 314    |  Half      Off       None     Auto   100
 315 .br
 316 .IR 10FD \c
 317     |  Full      Off       None     Auto   10
 318 .br
 319 .IR 10HD \c
 320     |  Half      Off       None     Auto   10
 321
 322 .ad b
 323 Stating any other port parameter together with this
 324 .IR ConType
 325 parameter will result in a merged configuration of those settings. This is due to
 326 the fact, that the per-port parameters (e.g.
 327 .IR Speed_A
 328 ) have a higher priority than the combined variable
 329 .IR ConType
 330 .
 331 .TP
 332 .BI Moderation= i,j,...
 333 Interrupt moderation is employed to limit the maximum number of interrupts the driver has to serve. That is, one or more interrupts (which indicate any transmit or receive packet to be processed) are queued until the driver processes them. When queued interrupts are to be served, is determined by the
 334 .IR IntsPerSec
 335 parameter, which is explained later below. Possible moderation modes are:
 336 .IR None
 337 ,
 338 .IR Static
 339 or
 340 .IR Dynamic
 341 whereby
 342 .IR None
 343 is the default. The different modes have the following meaning:
 344
 345 .IR None
 346 No interrupt moderation is applied on the adapter card. Therefore, each transmit or receive interrupt is served immediately as soon as it appears on the interrupt line of the adapter card.
 347
 348 .br
 349 .IR Static
 350 Interrupt moderation is applied on the adapter card. All transmit and receive interrupts are queued until a complete moderation interval ends. If such a moderation interval ends, all queued interrupts are processed in one big bunch without any delay. The term
 351 .IR Static
 352 reflects the fact, that interrupt moderation is always enabled, regardless how much network load is currently passing via a particular interface. In addition, the duration of the moderation interval has a fixed length that never changes while the driver is operational.
 353
 354 .br
 355 .IR Dynamic
 356 Interrupt moderation might be applied on the adapter card, depending on the load of the system. If the driver detects that the system load is too high, the driver tries to shield the system against too much network load by enabling interrupt moderation. If - at a later time - the CPU utilization decreases again (or if the network load is negligible) the interrupt moderation will automatically be disabled.
 357
 358 Interrupt moderation should be used when the driver has to handle one or more interfaces with a high network load, which - as a consequence - leads also to a high CPU utilization. When moderation is applied in such high network load situations, CPU load might be reduced by 20-30% on slow computers.
 359
 360 Note that the drawback of using interrupt moderation is an increase of the round-trip-time (RTT), due to the queuing and serving of interrupts at dedicated
 361 moderation times.
 362 .TP
 363 .BI IntsPerSec= i,j,...
 364 This parameter determines the length of any interrupt moderation interval.
 365 Assuming that static interrupt moderation is to be used, an
 366 .IR IntsPerSec
 367 parameter value of 2000 will lead to an interrupt moderation interval of
 368 500 microseconds. Possible values for this parameter are in the range of 30...40000 (interrupts per second). The default value is 2000.
 369
 370 This parameter is only used, if either static or dynamic interrupt moderation
 371 is enabled on a network adapter card. This parameter is ignored if no moderation is
 372 applied.
 373
 374 Note that the duration of the moderation interval is to be chosen with care.
 375 At first glance, selecting a very long duration (e.g. only 100 interrupts per
 376 second) seems to be meaningful, but the increase of packet-processing delay
 377 is tremendous. On the other hand, selecting a very short moderation time might
 378 compensate the use of any moderation being applied.
 379 .TP
 380 .BI PrefPort= i,j,...
 381 This parameter is used to force the preferred port to A or B (on dual-port network adapters). The preferred port is the one that is used if both ports A and B are detected as fully functional.  Possible values are:
 382 .IR A
 383 or
 384 .IR B
 385 whereby
 386 .IR A
 387 is the default.
 388 .TP
 389 .BI RlmtMode= i,j,...
 390 RLMT monitors the status of the port. If the link of the active port fails, RLMT switches immediately to the standby link. The virtual link is maintained as long as at least one 'physical' link is up.  This parameters states how RLMT should monitor both ports. Possible values are:
 391 .IR CheckLinkState
 392 ,
 393 .IR CheckLocalPort
 394 ,
 395 .IR CheckSeg
 396 or
 397 .IR DualNet
 398 whereby
 399 .IR CheckLinkState
 400 is the default. The different modes have the following meaning:
 401
 402 .IR CheckLinkState
 403 Check link state only: RLMT uses the link state reported by the adapter hardware for each individual port to determine whether a port can be used for all network traffic or not.
 404
 405 .br
 406 .IR CheckLocalPort
 407 In this mode, RLMT monitors the network path between the two ports of an adapter by regularly exchanging packets between them. This mode requires a network configuration in which the two ports are able to "see" each other (i.e. there must not be any router between the ports).
 408
 409 .br
 410 .IR CheckSeg
 411 Check local port and segmentation: This mode supports the same functions as the CheckLocalPort mode and additionally checks network segmentation between the ports. Therefore, this mode is only to be used if Gigabit Ethernet switches are installed on the network that have been configured to use the Spanning Tree protocol.
 412
 413 .br
 414 .IR DualNet
 415 In this mode, ports A and B are used as separate devices. If you have a dual port adapter, port A will be configured as
 416 .IR eth[x]
 417 and port B as
 418 .IR eth[x+1]
 419 Both ports can be used independently with distinct IP addresses. The preferred port setting is not used. RLMT is turned off.
 420
 421 Note that RLMT modes
 422 .IR CheckLocalPort
 423 and
 424 .IR CheckLinkState
 425 are designed to operate in configurations where a network path between the ports on one adapter exists. Moreover, they are not designed to work where adapters are connected back-to-back.
 426 .TP
 427 .BI LowLatency= i,j,...
 428 This parameter is used to reduce the packet latency time of the adapter. Setting
 429 .IR LowLatency
 430 to
 431 .IR On
 432 forces the adapter to pass any received packet immediately to upper network layers and to send out any transmit packet as fast as possible. Possible values are
 433 .IR On
 434 or
 435 .IR Off
 436 whereby
 437 .IR Off
 438 is the default.
 439
 440 Be aware of the fact that the system load increases if
 441 .IR LowLatency
 442 is set to
 443 .IR On
 444 and a lot of data packets are transmitted and received.
 445
 446 Note that this parameter is only used on adapters which are based on PCI Express compatible chipsets.
 447 .SH FILES
 448 .TP
 449 .B /proc/net/sk98lin/eth[x]
 450 .br
 451 The statistics file of a particular interface of an adapter card. It contains generic information about the adapter card plus a detailed summary of all transmit and receive counters.
 452 .TP
 453 .B /usr/src/linux/Documentation/networking/sk98lin.txt
 454 .br
 455 This is the
 456 .IR README
 457 file of the
 458 .IR sk98lin
 459 driver. It contains a detailed installation HOWTO and describes all parameters of the driver. It denotes also common problems and provides the solution to them.
 460 .SH BUGS
 461 Report any bugs to linux@syskonnect.de
 462 .SH AUTHOR
 463 (C)Copyright 1999-2005 Marvell(R).
 464 .br
 465
 466 Ralph Roesler \- rroesler@syskonnect.de
 467 .br
 468 Mirko Lindner \- mlindner@syskonnect.de
 469 .SH "SEE ALSO"
 470 modprobe(8), insmod(8), ifconfig(8).