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