mirror of https://github.com/mkerrisk/man-pages
Formatting fixes
This commit is contained in:
Michael Kerrisk
parent
c6f82ebc77
commit
62f38a5fa6
134
man4/sk98lin.4
134
man4/sk98lin.4
|
|
@ -66,26 +66,26 @@ When loading the driver using insmod, parameters for the network adapter cards m
|
|||
|
||||
insmod sk98lin.o AutoNeg_A=On,Off
|
||||
|
||||
After
|
||||
.B sk98lin
|
||||
is bound to one or more adapter cards and the
|
||||
.IR /proc
|
||||
filesystem is mounted on your system, a dedicated statistics file will be created in folder
|
||||
.IR /proc/net/sk98lin
|
||||
for all ports of the installed network adapter cards. Those files are named
|
||||
After
|
||||
.B sk98lin
|
||||
is bound to one or more adapter cards and the
|
||||
.IR /proc
|
||||
filesystem is mounted on your system, a dedicated statistics file will be created in folder
|
||||
.IR /proc/net/sk98lin
|
||||
for all ports of the installed network adapter cards. Those files are named
|
||||
.IR eth[x]
|
||||
whereas
|
||||
.IR x
|
||||
whereas
|
||||
.IR x
|
||||
is the number of the interface that has been assigned to a dedicated port by the system.
|
||||
|
||||
If loading is finished, any desired IP address can be assigned to the respective
|
||||
If loading is finished, any desired IP address can be assigned to the respective
|
||||
.IR eth[x]
|
||||
interface using the
|
||||
interface using the
|
||||
.BR ifconfig (8)
|
||||
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.
|
||||
|
||||
The
|
||||
.B sk98lin
|
||||
The
|
||||
.B sk98lin
|
||||
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
|
||||
.BR ifconfig (8)
|
||||
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:
|
||||
|
|
@ -97,7 +97,7 @@ Those two commands might even be combined into one:
|
|||
|
||||
ifconfig eth0 10.1.1.1 mtu 9000
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
Switching back to the standard Ethernet frame size can be done by using the
|
||||
.BR ifconfig (8)
|
||||
|
|
@ -110,7 +110,7 @@ The Marvell/SysKonnect Gigabit Ethernet driver for Linux is able to support VLAN
|
|||
.IR VLAN \c
|
||||
: http://www.candelatech.com/~greear/vlan.html
|
||||
.br
|
||||
.IR Link
|
||||
.IR Link
|
||||
.IR Aggregation \c
|
||||
: http://www.st.rim.or.jp/~yumo
|
||||
|
||||
|
|
@ -124,9 +124,9 @@ This parameter is used to set the speed capabilities of port A of an adapter car
|
|||
.IR 100 ,
|
||||
.IR 1000
|
||||
or
|
||||
.IR Auto
|
||||
whereas
|
||||
.IR Auto
|
||||
.IR Auto
|
||||
whereas
|
||||
.IR Auto
|
||||
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.
|
||||
.TP
|
||||
.BI Speed_B= i,j,...
|
||||
|
|
@ -135,9 +135,9 @@ This parameter is used to set the speed capabilities of port B of an adapter car
|
|||
.IR 100 ,
|
||||
.IR 1000
|
||||
or
|
||||
.IR Auto
|
||||
whereas
|
||||
.IR Auto
|
||||
.IR Auto
|
||||
whereas
|
||||
.IR Auto
|
||||
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.
|
||||
.TP
|
||||
.BI AutoNeg_A= i,j,...
|
||||
|
|
@ -148,8 +148,8 @@ or
|
|||
.IR Sense
|
||||
whereas
|
||||
.IR On
|
||||
is the default. The
|
||||
.IR Sense
|
||||
is the default. The
|
||||
.IR Sense
|
||||
mode automatically detects whether the link partner supports auto-negotiation or not.
|
||||
.TP
|
||||
.BI AutoNeg_B= i,j,...
|
||||
|
|
@ -160,8 +160,8 @@ or
|
|||
.IR Sense
|
||||
whereas
|
||||
.IR On
|
||||
is the default. The
|
||||
.IR Sense
|
||||
is the default. The
|
||||
.IR Sense
|
||||
mode automatically detects whether the link partner supports auto-negotiation or not.
|
||||
.TP
|
||||
.BI DupCap_A= i,j,...
|
||||
|
|
@ -172,21 +172,21 @@ or
|
|||
.IR Both
|
||||
whereas
|
||||
.IR Both
|
||||
is the default.
|
||||
This parameter is only relevant if AutoNeg_A of port A is not set to
|
||||
is the default.
|
||||
This parameter is only relevant if AutoNeg_A of port A is not set to
|
||||
.IR Sense .
|
||||
If AutoNeg_A is set to
|
||||
.IR On ,
|
||||
If AutoNeg_A is set to
|
||||
.IR On ,
|
||||
all three values of DupCap_A (
|
||||
.IR Half ,
|
||||
.IR Half ,
|
||||
.IR Full
|
||||
or
|
||||
.IR Both )
|
||||
might be stated. If AutoNeg_A is set to
|
||||
.IR Off ,
|
||||
only DupCap_A values
|
||||
or
|
||||
.IR Both )
|
||||
might be stated. If AutoNeg_A is set to
|
||||
.IR Off ,
|
||||
only DupCap_A values
|
||||
.IR Full
|
||||
and
|
||||
and
|
||||
.IR Half
|
||||
are allowed. This DupCap_A parameter is useful if your link partner does not support all possible duplex combinations.
|
||||
.TP
|
||||
|
|
@ -201,14 +201,14 @@ whereas
|
|||
is the default. This parameter is only relevant if AutoNeg_B of port B is not set to
|
||||
.IR Sense .
|
||||
If AutoNeg_B is set to
|
||||
.IR On ,
|
||||
.IR On ,
|
||||
all three values of DupCap_B (
|
||||
.IR Half ,
|
||||
.IR Full
|
||||
or
|
||||
.IR Both)
|
||||
.IR Both)
|
||||
might be stated. If AutoNeg_B is set to
|
||||
.IR Off ,
|
||||
.IR Off ,
|
||||
only DupCap_B values
|
||||
.IR Full
|
||||
and
|
||||
|
|
@ -224,15 +224,15 @@ or
|
|||
.IR None
|
||||
whereas
|
||||
.IR SymOrRem
|
||||
is the default. The different modes have the following meaning:
|
||||
is the default. The different modes have the following meaning:
|
||||
|
||||
.br
|
||||
.IR Sym
|
||||
= Symmetric
|
||||
= Symmetric
|
||||
both link partners are allowed to send PAUSE frames
|
||||
.br
|
||||
.IR SymOrRem
|
||||
= SymmetricOrRemote
|
||||
= SymmetricOrRemote
|
||||
both or only remote partner are allowed to send PAUSE frames
|
||||
.br
|
||||
.IR LocSend
|
||||
|
|
@ -285,7 +285,7 @@ or
|
|||
.IR Slave
|
||||
whereas
|
||||
.IR Auto
|
||||
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.
|
||||
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.
|
||||
.TP
|
||||
.BI Role_B= i,j,...
|
||||
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:
|
||||
|
|
@ -295,7 +295,7 @@ or
|
|||
.IR Slave
|
||||
whereas
|
||||
.IR Auto
|
||||
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.
|
||||
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.
|
||||
.TP
|
||||
.BI ConType= i,j,...
|
||||
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:
|
||||
|
|
@ -320,18 +320,18 @@ ConType | DupCap AutoNeg FlowCtrl Role Speed
|
|||
.IR 10HD \c
|
||||
| Half Off None Auto 10
|
||||
|
||||
.ad b
|
||||
Stating any other port parameter together with this
|
||||
.ad b
|
||||
Stating any other port parameter together with this
|
||||
.IR ConType
|
||||
parameter will result in a merged configuration of those settings. This is due to
|
||||
the fact, that the per-port parameters (e.g.
|
||||
.IR Speed_A )
|
||||
have a higher priority than the combined variable
|
||||
the fact, that the per-port parameters (e.g.
|
||||
.IR Speed_A )
|
||||
have a higher priority than the combined variable
|
||||
.IR ConType
|
||||
.
|
||||
.TP
|
||||
.BI Moderation= i,j,...
|
||||
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
|
||||
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
|
||||
.IR IntsPerSec
|
||||
parameter, which is explained later below. Possible moderation modes are:
|
||||
.IR None ,
|
||||
|
|
@ -347,7 +347,7 @@ No interrupt moderation is applied on the adapter card. Therefore, each transmit
|
|||
|
||||
.br
|
||||
.IR Static
|
||||
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
|
||||
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
|
||||
.IR Static
|
||||
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.
|
||||
|
||||
|
|
@ -362,7 +362,7 @@ moderation times.
|
|||
.TP
|
||||
.BI IntsPerSec= i,j,...
|
||||
This parameter determines the length of any interrupt moderation interval.
|
||||
Assuming that static interrupt moderation is to be used, an
|
||||
Assuming that static interrupt moderation is to be used, an
|
||||
.IR IntsPerSec
|
||||
parameter value of 2000 will lead to an interrupt moderation interval of
|
||||
500 microseconds. Possible values for this parameter are in the range of 30...40000 (interrupts per second). The default value is 2000.
|
||||
|
|
@ -406,32 +406,32 @@ In this mode, RLMT monitors the network path between the two ports of an adapter
|
|||
|
||||
.br
|
||||
.IR CheckSeg
|
||||
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.
|
||||
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.
|
||||
|
||||
.br
|
||||
.IR DualNet
|
||||
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
|
||||
.IR eth[x] and port B as
|
||||
.IR eth[x+1] .
|
||||
Both ports can be used independently with distinct IP addresses.
|
||||
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
|
||||
.IR eth[x] and port B as
|
||||
.IR eth[x+1] .
|
||||
Both ports can be used independently with distinct IP addresses.
|
||||
The preferred port setting is not used. RLMT is turned off.
|
||||
|
||||
Note that RLMT modes
|
||||
.IR CheckLocalPort
|
||||
and
|
||||
.IR CheckLinkState
|
||||
Note that RLMT modes
|
||||
.IR CheckLocalPort
|
||||
and
|
||||
.IR CheckLinkState
|
||||
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.
|
||||
.SH FILES
|
||||
.TP
|
||||
.B /proc/net/sk98lin/eth[x]
|
||||
.br
|
||||
.br
|
||||
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.
|
||||
.TP
|
||||
.B /usr/src/linux/Documentation/network/sk98lin.txt
|
||||
.br
|
||||
This is the
|
||||
.br
|
||||
This is the
|
||||
.IR README
|
||||
file of the
|
||||
file of the
|
||||
.IR sk98lin
|
||||
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.
|
||||
.SH BUGS
|
||||
|
|
@ -441,6 +441,6 @@ Ralph Roesler \(em rroesler@syskonnect.de
|
|||
.br
|
||||
Mirko Lindner \(em mlindner@syskonnect.de
|
||||
.SH "SEE ALSO"
|
||||
.BR modprobe (8),
|
||||
.BR insmod (8),
|
||||
.BR modprobe (8),
|
||||
.BR insmod (8),
|
||||
.BR ifconfig (8).
|
||||
|
|
|
|||
Loading…
Reference in New Issue