man4/sk98lin.4

   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 .\"
  25 .TH SK98LIN 4 2007-11-25 "Linux" "Linux Programmer's Manual"
  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
  61 .ad l
  62 .hy 0
  63 .BR Note :
  64 This obsolete driver was removed from the kernel in version 2.6.26.
  65
  66 .B sk98lin
  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
  71 any Yukon compliant chipset.
  72
  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,
  78 but on the Port A of the second adapter switched OFF, one must enter:
  79
  80    insmod sk98lin.o AutoNeg_A=On,Off
  81
  82 After
  83 .B sk98lin
  84 is bound to one or more adapter cards and the
  85 .I /proc
  86 file system is mounted on your system, a dedicated statistics file
  87 will be created in folder
  88 .I /proc/net/sk98lin
  89 for all ports of the installed network adapter cards.
  90 Those files are named
  91 .I eth[x]
  92 whereas
  93 .I x
  94 is the number of the interface that has been assigned to a
  95 dedicated port by the system.
  96
  97 If loading is finished, any desired IP address can be
  98 assigned to the respective
  99 .I eth[x]
 100 interface using the
 101 .BR ifconfig (8)
 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"
 105 followed by the configured or detected connection parameters.
 106
 107 The
 108 .B sk98lin
 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
 116 to the interface or later by using the
 117 .BR ifconfig (8)
 118 command with the mtu parameter.
 119 If for instance eth0 needs an IP
 120 address and a large frame MTU size,
 121 the following two commands might be used:
 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
 130 Note that large frames can only be used if permitted by
 131 your network infrastructure.
 132 This means, that any switch being used in your Ethernet must
 133 also support large frames.
 134 Quite some switches support large frames,
 135 but need to be configured to do so.
 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.
 141 If an adapter is not set to receive large frames it will simply drop them.
 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
 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.
 152 Those features are only available after installation of open source modules
 153 which can be found on the Internet:
 154
 155 .IR VLAN \c
 156 : http://www.candelatech.com/~greear/vlan.html
 157 .br
 158 .I Link
 159 .IR Aggregation \c
 160 : http://www.st.rim.or.jp/~yumo
 161
 162 .br
 163 Note that Marvell/SysKonnect does not offer any support for these
 164 open source modules and does not take the responsibility for any
 165 kind of failures or problems arising when using these modules.
 166 .SS Parameters
 167 .TP
 168 .BI Speed_A= i,j,...
 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.
 172 Possible values are:
 173 .IR 10 ,
 174 .IR 100 ,
 175 .I 1000
 176 or
 177 .I Auto
 178 whereas
 179 .I Auto
 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.
 185 .TP
 186 .BI Speed_B= i,j,...
 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.
 190 Possible values are:
 191 .IR 10 ,
 192 .IR 100 ,
 193 .I 1000
 194 or
 195 .I Auto
 196 whereas
 197 .I Auto
 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.
 203 .TP
 204 .BI AutoNeg_A= i,j,...
 205 Enables or disables the use of autonegotiation of port A of an adapter card.
 206 Possible values are:
 207 .IR On ,
 208 .I Off
 209 or
 210 .I Sense
 211 whereas
 212 .I On
 213 is the default.
 214 The
 215 .I Sense
 216 mode automatically detects whether the link partner supports
 217 auto-negotiation or not.
 218 .TP
 219 .BI AutoNeg_B= i,j,...
 220 Enables or disables the use of autonegotiation of port B of an adapter card.
 221 Possible values are:
 222 .IR On ,
 223 .I Off
 224 or
 225 .I Sense
 226 whereas
 227 .I On
 228 is the default.
 229 The
 230 .I Sense
 231 mode automatically detects whether the link partner supports
 232 auto-negotiation or not.
 233 .TP
 234 .BI DupCap_A= i,j,...
 235 This parameter indicates the duplex mode to be used for port A
 236 of an adapter card.
 237 Possible values are:
 238 .IR Half ,
 239 .I Full
 240 or
 241 .I Both
 242 whereas
 243 .I Both
 244 is the default.
 245 This parameter is only relevant if AutoNeg_A of port A is not set to
 246 .IR Sense .
 247 If AutoNeg_A is set to
 248 .IR On ,
 249 all three values of DupCap_A (
 250 .IR Half ,
 251 .I Full
 252 or
 253 .IR Both )
 254 might be stated.
 255 If AutoNeg_A is set to
 256 .IR Off ,
 257 only DupCap_A values
 258 .I Full
 259 and
 260 .I Half
 261 are allowed.
 262 This DupCap_A parameter is useful if your link partner does not
 263 support all possible duplex combinations.
 264 .TP
 265 .BI DupCap_B= i,j,...
 266 This parameter indicates the duplex mode to be used for port B
 267 of an adapter card.
 268 Possible values are:
 269 .IR Half ,
 270 .I Full
 271 or
 272 .I Both
 273 whereas
 274 .I Both
 275 is the default.
 276 This parameter is only relevant if AutoNeg_B of port B is not set to
 277 .IR Sense .
 278 If AutoNeg_B is set to
 279 .IR On ,
 280 all three values of DupCap_B (
 281 .IR Half ,
 282 .I Full
 283 or
 284 .IR Both )
 285 might be stated.
 286 If AutoNeg_B is set to
 287 .IR Off ,
 288 only DupCap_B values
 289 .I Full
 290 and
 291 .I Half
 292 are allowed.
 293 This DupCap_B parameter is useful if your link partner does not
 294 support all possible duplex combinations.
 295 .TP
 296 .BI FlowCtrl_A= i,j,...
 297 This parameter can be used to set the flow control capabilities the
 298 port reports during auto-negotiation.
 299 Possible values are:
 300 .IR Sym ,
 301 .IR SymOrRem ,
 302 .I LocSend
 303 or
 304 .I None
 305 whereas
 306 .I SymOrRem
 307 is the default.
 308 The different modes have the following meaning:
 309
 310 .br
 311 .I Sym
 312 = Symmetric
 313  both link partners are allowed to send PAUSE frames
 314 .br
 315 .I SymOrRem
 316 = SymmetricOrRemote
 317  both or only remote partner are allowed to send PAUSE frames
 318 .br
 319 .I LocSend
 320 = LocalSend
 321  only local link partner is allowed to send PAUSE frames
 322 .br
 323 .I None
 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,...
 331 This parameter can be used to set the flow control capabilities the
 332 port reports during auto-negotiation.
 333 Possible values are:
 334 .IR Sym ,
 335 .IR SymOrRem ,
 336 .I LocSend
 337 or
 338 .I None
 339 whereas
 340 .I SymOrRem
 341 is the default.
 342 The different modes have the following meaning:
 343
 344 .I Sym
 345 = Symmetric
 346  both link partners are allowed to send PAUSE frames
 347 .br
 348 .I SymOrRem
 349 = SymmetricOrRemote
 350  both or only remote partner are allowed to send PAUSE frames
 351 .br
 352 .I LocSend
 353 = LocalSend
 354  only local link partner is allowed to send PAUSE frames
 355 .br
 356 .I None
 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,...
 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.
 369 Possible values are:
 370 .IR Auto ,
 371 .I Master
 372 or
 373 .I Slave
 374 whereas
 375 .I Auto
 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
 379 can be forced to a specific setting with this parameter.
 380 .TP
 381 .BI Role_B= i,j,...
 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.
 386 Possible values are:
 387 .IR Auto ,
 388 .I Master
 389 or
 390 .I Slave
 391 whereas
 392 .I Auto
 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
 397 specific setting with this parameter.
 398 .TP
 399 .BI ConType= i,j,...
 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.
 405 Possible values and their corresponding combination of per-port parameters:
 406
 407 .nf
 408 ConType | DupCap   AutoNeg   FlowCtrl   Role   Speed
 409 --------+-------------------------------------------
 410 \fIAuto\fP    |  Both      On      SymOrRem   Auto   Auto
 411 .br
 412 \fI100FD\fP   |  Full      Off       None     Auto   100
 413 .br
 414 \fI100HD\fP   |  Half      Off       None     Auto   100
 415 .br
 416 \fI10FD\fP    |  Full      Off       None     Auto   10
 417 .br
 418 \fI10HD\fP    |  Half      Off       None     Auto   10
 419
 420 .fi
 421 Stating any other port parameter together with this
 422 .I ConType
 423 parameter will result in a merged configuration of those settings.
 424 This is due to
 425 the fact, that the per-port parameters (e.g.
 426 .IR Speed_A )
 427 have a higher priority than the combined variable
 428 .IR ConType .
 429 .TP
 430 .BI Moderation= i,j,...
 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.
 435 When queued interrupts are to be served, is determined by the
 436 .I IntsPerSec
 437 parameter, which is explained later below.
 438 Possible moderation modes are:
 439 .IR None ,
 440 .I Static
 441 or
 442 .I Dynamic
 443 whereas
 444 .I None
 445 is the default.
 446 The different modes have the following meaning:
 447
 448 .I None
 449 No interrupt moderation is applied on the adapter card.
 450 Therefore, each transmit or receive interrupt is served immediately
 451 as soon as it appears on the interrupt line of the adapter card.
 452
 453 .br
 454 .I Static
 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.
 460 The term
 461 .I Static
 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
 466 length that never changes while the driver is operational.
 467
 468 .br
 469 .I Dynamic
 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.
 475 If\(emat a later time\(emthe CPU utilization decreases
 476 again (or if the network load is negligible) the interrupt
 477 moderation will automatically be disabled.
 478
 479 Interrupt moderation should be used when the driver has to
 480 handle one or more interfaces with a high network load,
 481 which\(emas a consequence\(emleads also to a high CPU utilization.
 482 When moderation is applied in such high network load situations,
 483 CPU load might be reduced by 20-30% on slow computers.
 484
 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
 487 interrupts at dedicated moderation times.
 488 .TP
 489 .BI IntsPerSec= i,j,...
 490 This parameter determines the length of any interrupt moderation interval.
 491 Assuming that static interrupt moderation is to be used, an
 492 .I IntsPerSec
 493 parameter value of 2000 will lead to an interrupt moderation interval of
 494 500 microseconds.
 495 Possible values for this parameter are in the range of
 496 30...40000 (interrupts per second).
 497 The default value is 2000.
 498
 499 This parameter is only used, if either static or dynamic interrupt moderation
 500 is enabled on a network adapter card.
 501 This parameter is ignored if no moderation is applied.
 502
 503 Note that the duration of the moderation interval is to be chosen with care.
 504 At first glance, selecting a very long duration (e.g., only 100 interrupts per
 505 second) seems to be meaningful, but the increase of packet-processing delay
 506 is tremendous.
 507 On the other hand, selecting a very short moderation time might
 508 compensate the use of any moderation being applied.
 509 .TP
 510 .BI PrefPort= i,j,...
 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.
 515 Possible values are:
 516 .I A
 517 or
 518 .I B
 519 whereas
 520 .I A
 521 is the default.
 522 .TP
 523 .BI RlmtMode= i,j,...
 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.
 527 The virtual link is maintained as long as at least one "physical" link is up.
 528 This parameters states how RLMT should monitor both ports.
 529 Possible values are:
 530 .IR CheckLinkState ,
 531 .IR CheckLocalPort ,
 532 .I CheckSeg
 533 or
 534 .I DualNet
 535 whereas
 536 .I CheckLinkState
 537 is the default.
 538 The different modes have the following meaning:
 539
 540 .I CheckLinkState
 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
 543 for all network traffic or not.
 544
 545 .br
 546 .I CheckLocalPort
 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
 550 two ports are able to "see" each other (i.e., there
 551 must not be any router between the ports).
 552
 553 .br
 554 .I CheckSeg
 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
 560 configured to use the Spanning Tree protocol.
 561
 562 .br
 563 .I DualNet
 564 In this mode, ports A and B are used as separate devices.
 565 If you have a dual port adapter, port A will be configured as
 566 .IR eth[x]
 567 and port B as
 568 .IR eth[x+1] .
 569 Both ports can be used independently with distinct IP addresses.
 570 The preferred port setting is not used.
 571 RLMT is turned off.
 572
 573 Note that RLMT modes
 574 .I CheckLocalPort
 575 and
 576 .I CheckLinkState
 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
 580 connected back-to-back.
 581 .SH FILES
 582 .TP
 583 .I /proc/net/sk98lin/eth[x]
 584 .br
 585 The statistics file of a particular interface of an adapter card.
 586 It contains generic information about the adapter card plus a detailed
 587 summary of all transmit and receive counters.
 588 .TP
 589 .I /usr/src/linux/Documentation/networking/sk98lin.txt
 590 .br
 591 This is the
 592 .I README
 593 file of the
 594 .I sk98lin
 595 driver.
 596 It contains a detailed installation HOWTO and describes all parameters
 597 of the driver.
 598 It denotes also common problems and provides the solution to them.
 599 .SH BUGS
 600 Report any bugs to linux@syskonnect.de
 601 .\" .SH AUTHORS
 602 .\" Ralph Roesler \(em rroesler@syskonnect.de
 603 .\" .br
 604 .\" Mirko Lindner \(em mlindner@syskonnect.de
 605 .SH "SEE ALSO"
 606 .BR ifconfig (8),
 607 .BR insmod (8),
 608 .BR modprobe (8)