man4/sk98lin.4

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