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