Techwizz/kernel-fxtec-pro1x
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

networking: e1000.rst: Get rid of Sphinx warnings

Browse source 
Documentation/networking/e1000.rst:83: ERROR: Unexpected indentation.
    Documentation/networking/e1000.rst:84: WARNING: Block quote ends without a blank line; unexpected unindent.
    Documentation/networking/e1000.rst:173: WARNING: Definition list ends without a blank line; unexpected unindent.
    Documentation/networking/e1000.rst:236: WARNING: Definition list ends without a blank line; unexpected unindent.

While here, fix highlights and mark a table as such.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: Jeff Kirsher <jeffrey.t.kirsher@intel.com>
This commit is contained in:
Mauro Carvalho Chehab 2018-06-26 06:49:10 -03:00 committed by Jeff Kirsher
parent b203cc7a4f
commit 8dc4b1a799
1 changed files with 112 additions and 75 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

187
Documentation/networking/e1000.rst
View file

@ -34,7 +34,8 @@ Command Line Parameters
The default value for each parameter is generally the recommended setting, The default value for each parameter is generally the recommended setting,
unless otherwise noted. unless otherwise noted.
NOTES: For more information about the AutoNeg, Duplex, and Speed NOTES:
For more information about the AutoNeg, Duplex, and Speed
parameters, see the "Speed and Duplex Configuration" section in parameters, see the "Speed and Duplex Configuration" section in
this document. this document.
@ -45,22 +46,27 @@ NOTES: For more information about the AutoNeg, Duplex, and Speed
AutoNeg AutoNeg
------- -------
(Supported only on adapters with copper connections) (Supported only on adapters with copper connections)
Valid Range: 0x01-0x0F, 0x20-0x2F
Default Value: 0x2F :Valid Range: 0x01-0x0F, 0x20-0x2F
:Default Value: 0x2F
This parameter is a bit-mask that specifies the speed and duplex settings This parameter is a bit-mask that specifies the speed and duplex settings
advertised by the adapter. When this parameter is used, the Speed and advertised by the adapter. When this parameter is used, the Speed and
Duplex parameters must not be specified. Duplex parameters must not be specified.
NOTE: Refer to the Speed and Duplex section of this readme for more NOTE:
Refer to the Speed and Duplex section of this readme for more
information on the AutoNeg parameter. information on the AutoNeg parameter.
Duplex Duplex
------ ------
(Supported only on adapters with copper connections) (Supported only on adapters with copper connections)
Valid Range: 0-2 (0=auto-negotiate, 1=half, 2=full)
Default Value: 0 :Valid Range: 0-2 (0=auto-negotiate, 1=half, 2=full)
:Default Value: 0
This defines the direction in which data is allowed to flow. Can be This defines the direction in which data is allowed to flow. Can be
either one or two-directional. If both Duplex and the link partner are either one or two-directional. If both Duplex and the link partner are
@ -70,18 +76,22 @@ duplex.
FlowControl FlowControl
----------- -----------
Valid Range: 0-3 (0=none, 1=Rx only, 2=Tx only, 3=Rx&Tx)
Default Value: Reads flow control settings from the EEPROM :Valid Range: 0-3 (0=none, 1=Rx only, 2=Tx only, 3=Rx&Tx)
:Default Value: Reads flow control settings from the EEPROM
This parameter controls the automatic generation(Tx) and response(Rx) This parameter controls the automatic generation(Tx) and response(Rx)
to Ethernet PAUSE frames. to Ethernet PAUSE frames.
InterruptThrottleRate InterruptThrottleRate
--------------------- ---------------------
(not supported on Intel(R) 82542, 82543 or 82544-based adapters) (not supported on Intel(R) 82542, 82543 or 82544-based adapters)
Valid Range: 0,1,3,4,100-100000 (0=off, 1=dynamic, 3=dynamic conservative,
4=simplified balancing) :Valid Range:
Default Value: 3 0,1,3,4,100-100000 (0=off, 1=dynamic, 3=dynamic conservative,
4=simplified balancing)
:Default Value: 3
The driver can limit the amount of interrupts per second that the adapter The driver can limit the amount of interrupts per second that the adapter
will generate for incoming packets. It does this by writing a value to the will generate for incoming packets. It does this by writing a value to the
@ -135,13 +145,15 @@ Setting InterruptThrottleRate to 0 turns off any interrupt moderation
and may improve small packet latency, but is generally not suitable and may improve small packet latency, but is generally not suitable
for bulk throughput traffic. for bulk throughput traffic.
NOTE: InterruptThrottleRate takes precedence over the TxAbsIntDelay and NOTE:
InterruptThrottleRate takes precedence over the TxAbsIntDelay and
RxAbsIntDelay parameters. In other words, minimizing the receive RxAbsIntDelay parameters. In other words, minimizing the receive
and/or transmit absolute delays does not force the controller to and/or transmit absolute delays does not force the controller to
generate more interrupts than what the Interrupt Throttle Rate generate more interrupts than what the Interrupt Throttle Rate
allows. allows.
CAUTION: If you are using the Intel(R) PRO/1000 CT Network Connection CAUTION:
If you are using the Intel(R) PRO/1000 CT Network Connection
(controller 82547), setting InterruptThrottleRate to a value (controller 82547), setting InterruptThrottleRate to a value
greater than 75,000, may hang (stop transmitting) adapters greater than 75,000, may hang (stop transmitting) adapters
under certain network conditions. If this occurs a NETDEV under certain network conditions. If this occurs a NETDEV
@ -151,7 +163,8 @@ CAUTION: If you are using the Intel(R) PRO/1000 CT Network Connection
hang, ensure that InterruptThrottleRate is set no greater hang, ensure that InterruptThrottleRate is set no greater
than 75,000 and is not set to 0. than 75,000 and is not set to 0.
NOTE: When e1000 is loaded with default settings and multiple adapters NOTE:
When e1000 is loaded with default settings and multiple adapters
are in use simultaneously, the CPU utilization may increase non- are in use simultaneously, the CPU utilization may increase non-
linearly. In order to limit the CPU utilization without impacting linearly. In order to limit the CPU utilization without impacting
the overall throughput, we recommend that you load the driver as the overall throughput, we recommend that you load the driver as
@ -168,9 +181,11 @@ NOTE: When e1000 is loaded with default settings and multiple adapters
RxDescriptors RxDescriptors
------------- -------------
Valid Range: 48-256 for 82542 and 82543-based adapters
48-4096 for all other supported adapters :Valid Range:
Default Value: 256 - 48-256 for 82542 and 82543-based adapters
- 48-4096 for all other supported adapters
:Default Value: 256
This value specifies the number of receive buffer descriptors allocated This value specifies the number of receive buffer descriptors allocated
by the driver. Increasing this value allows the driver to buffer more by the driver. Increasing this value allows the driver to buffer more
@ -180,15 +195,17 @@ Each descriptor is 16 bytes. A receive buffer is also allocated for each
descriptor and can be either 2048, 4096, 8192, or 16384 bytes, depending descriptor and can be either 2048, 4096, 8192, or 16384 bytes, depending
on the MTU setting. The maximum MTU size is 16110. on the MTU setting. The maximum MTU size is 16110.
NOTE: MTU designates the frame size. It only needs to be set for Jumbo NOTE:
MTU designates the frame size. It only needs to be set for Jumbo
Frames. Depending on the available system resources, the request Frames. Depending on the available system resources, the request
for a higher number of receive descriptors may be denied. In this for a higher number of receive descriptors may be denied. In this
case, use a lower number. case, use a lower number.
RxIntDelay RxIntDelay
---------- ----------
Valid Range: 0-65535 (0=off)
Default Value: 0 :Valid Range: 0-65535 (0=off)
:Default Value: 0
This value delays the generation of receive interrupts in units of 1.024 This value delays the generation of receive interrupts in units of 1.024
microseconds. Receive interrupt reduction can improve CPU efficiency if microseconds. Receive interrupt reduction can improve CPU efficiency if
@ -198,7 +215,8 @@ of TCP traffic. If the system is reporting dropped receives, this value
may be set too high, causing the driver to run out of available receive may be set too high, causing the driver to run out of available receive
descriptors. descriptors.
CAUTION: When setting RxIntDelay to a value other than 0, adapters may CAUTION:
When setting RxIntDelay to a value other than 0, adapters may
hang (stop transmitting) under certain network conditions. If hang (stop transmitting) under certain network conditions. If
this occurs a NETDEV WATCHDOG message is logged in the system this occurs a NETDEV WATCHDOG message is logged in the system
event log. In addition, the controller is automatically reset, event log. In addition, the controller is automatically reset,
@ -207,9 +225,11 @@ CAUTION: When setting RxIntDelay to a value other than 0, adapters may
RxAbsIntDelay RxAbsIntDelay
------------- -------------
(This parameter is supported only on 82540, 82545 and later adapters.) (This parameter is supported only on 82540, 82545 and later adapters.)
Valid Range: 0-65535 (0=off)
Default Value: 128 :Valid Range: 0-65535 (0=off)
:Default Value: 128
This value, in units of 1.024 microseconds, limits the delay in which a This value, in units of 1.024 microseconds, limits the delay in which a
receive interrupt is generated. Useful only if RxIntDelay is non-zero, receive interrupt is generated. Useful only if RxIntDelay is non-zero,
@ -220,9 +240,11 @@ conditions.
Speed Speed
----- -----
(This parameter is supported only on adapters with copper connections.) (This parameter is supported only on adapters with copper connections.)
Valid Settings: 0, 10, 100, 1000
Default Value: 0 (auto-negotiate at all supported speeds) :Valid Settings: 0, 10, 100, 1000
:Default Value: 0 (auto-negotiate at all supported speeds)
Speed forces the line speed to the specified value in megabits per second Speed forces the line speed to the specified value in megabits per second
(Mbps). If this parameter is not specified or is set to 0 and the link (Mbps). If this parameter is not specified or is set to 0 and the link
@ -231,22 +253,26 @@ speed. Duplex should also be set when Speed is set to either 10 or 100.
TxDescriptors TxDescriptors
------------- -------------
Valid Range: 48-256 for 82542 and 82543-based adapters
48-4096 for all other supported adapters :Valid Range:
Default Value: 256 - 48-256 for 82542 and 82543-based adapters
- 48-4096 for all other supported adapters
:Default Value: 256
This value is the number of transmit descriptors allocated by the driver. This value is the number of transmit descriptors allocated by the driver.
Increasing this value allows the driver to queue more transmits. Each Increasing this value allows the driver to queue more transmits. Each
descriptor is 16 bytes. descriptor is 16 bytes.
NOTE: Depending on the available system resources, the request for a NOTE:
Depending on the available system resources, the request for a
higher number of transmit descriptors may be denied. In this case, higher number of transmit descriptors may be denied. In this case,
use a lower number. use a lower number.
TxIntDelay TxIntDelay
---------- ----------
Valid Range: 0-65535 (0=off)
Default Value: 8 :Valid Range: 0-65535 (0=off)
:Default Value: 8
This value delays the generation of transmit interrupts in units of This value delays the generation of transmit interrupts in units of
1.024 microseconds. Transmit interrupt reduction can improve CPU 1.024 microseconds. Transmit interrupt reduction can improve CPU
@ -256,9 +282,11 @@ causing the driver to run out of available transmit descriptors.
TxAbsIntDelay TxAbsIntDelay
------------- -------------
(This parameter is supported only on 82540, 82545 and later adapters.) (This parameter is supported only on 82540, 82545 and later adapters.)
Valid Range: 0-65535 (0=off)
Default Value: 32 :Valid Range: 0-65535 (0=off)
:Default Value: 32
This value, in units of 1.024 microseconds, limits the delay in which a This value, in units of 1.024 microseconds, limits the delay in which a
transmit interrupt is generated. Useful only if TxIntDelay is non-zero, transmit interrupt is generated. Useful only if TxIntDelay is non-zero,
@ -269,18 +297,21 @@ network conditions.
XsumRX XsumRX
------ ------
(This parameter is NOT supported on the 82542-based adapter.) (This parameter is NOT supported on the 82542-based adapter.)
Valid Range: 0-1
Default Value: 1 :Valid Range: 0-1
:Default Value: 1
A value of '1' indicates that the driver should enable IP checksum A value of '1' indicates that the driver should enable IP checksum
offload for received packets (both UDP and TCP) to the adapter hardware. offload for received packets (both UDP and TCP) to the adapter hardware.
Copybreak Copybreak
--------- ---------
Valid Range: 0-xxxxxxx (0=off)
Default Value: 256 :Valid Range: 0-xxxxxxx (0=off)
Usage: modprobe e1000.ko copybreak=128 :Default Value: 256
:Usage: modprobe e1000.ko copybreak=128
Driver copies all packets below or equaling this size to a fresh RX Driver copies all packets below or equaling this size to a fresh RX
buffer before handing it up the stack. buffer before handing it up the stack.
@ -292,8 +323,9 @@ it is also available during runtime at
SmartPowerDownEnable SmartPowerDownEnable
-------------------- --------------------
Valid Range: 0-1
Default Value: 0 (disabled) :Valid Range: 0-1
:Default Value: 0 (disabled)
Allows PHY to turn off in lower power states. The user can turn off Allows PHY to turn off in lower power states. The user can turn off
this parameter in supported chipsets. this parameter in supported chipsets.
@ -309,14 +341,14 @@ fiber interface board only links at 1000 Mbps full-duplex.
For copper-based boards, the keywords interact as follows: For copper-based boards, the keywords interact as follows:
The default operation is auto-negotiate. The board advertises all - The default operation is auto-negotiate. The board advertises all
supported speed and duplex combinations, and it links at the highest supported speed and duplex combinations, and it links at the highest
common speed and duplex mode IF the link partner is set to auto-negotiate. common speed and duplex mode IF the link partner is set to auto-negotiate.
If Speed = 1000, limited auto-negotiation is enabled and only 1000 Mbps - If Speed = 1000, limited auto-negotiation is enabled and only 1000 Mbps
is advertised (The 1000BaseT spec requires auto-negotiation.) is advertised (The 1000BaseT spec requires auto-negotiation.)
If Speed = 10 or 100, then both Speed and Duplex should be set. Auto- - If Speed = 10 or 100, then both Speed and Duplex should be set. Auto-
negotiation is disabled, and the AutoNeg parameter is ignored. Partner negotiation is disabled, and the AutoNeg parameter is ignored. Partner
SHOULD also be forced. SHOULD also be forced.
@ -328,13 +360,15 @@ process.
The parameter may be specified as either a decimal or hexadecimal value as The parameter may be specified as either a decimal or hexadecimal value as
determined by the bitmap below. determined by the bitmap below.
============== ====== ====== ======= ======= ====== ====== ======= ======
Bit position 7 6 5 4 3 2 1 0 Bit position 7 6 5 4 3 2 1 0
Decimal Value 128 64 32 16 8 4 2 1 Decimal Value 128 64 32 16 8 4 2 1
Hex value 80 40 20 10 8 4 2 1 Hex value 80 40 20 10 8 4 2 1
Speed (Mbps) N/A N/A 1000 N/A 100 100 10 10 Speed (Mbps) N/A N/A 1000 N/A 100 100 10 10
Duplex Full Full Half Full Half Duplex Full Full Half Full Half
============== ====== ====== ======= ======= ====== ====== ======= ======
Some examples of using AutoNeg: Some examples of using AutoNeg::
modprobe e1000 AutoNeg=0x01 (Restricts autonegotiation to 10 Half) modprobe e1000 AutoNeg=0x01 (Restricts autonegotiation to 10 Half)
modprobe e1000 AutoNeg=1 (Same as above) modprobe e1000 AutoNeg=1 (Same as above)
@ -357,56 +391,59 @@ Additional Configurations
Jumbo Frames Jumbo Frames
------------ ------------
Jumbo Frames support is enabled by changing the MTU to a value larger
than the default of 1500. Use the ifconfig command to increase the MTU Jumbo Frames support is enabled by changing the MTU to a value larger than
size. For example:: the default of 1500. Use the ifconfig command to increase the MTU size.
For example::
ifconfig eth<x> mtu 9000 up ifconfig eth<x> mtu 9000 up
This setting is not saved across reboots. It can be made permanent if This setting is not saved across reboots. It can be made permanent if
you add:: you add::
MTU=9000 MTU=9000
to the file /etc/sysconfig/network-scripts/ifcfg-eth<x>. This example to the file /etc/sysconfig/network-scripts/ifcfg-eth<x>. This example
applies to the Red Hat distributions; other distributions may store this applies to the Red Hat distributions; other distributions may store this
setting in a different location. setting in a different location.
Notes: Degradation in throughput performance may be observed in some Notes:
Jumbo frames environments. If this is observed, increasing the Degradation in throughput performance may be observed in some Jumbo frames
application's socket buffer size and/or increasing the environments. If this is observed, increasing the application's socket buffer
/proc/sys/net/ipv4/tcp_*mem entry values may help. See the specific size and/or increasing the /proc/sys/net/ipv4/tcp_*mem entry values may help.
application manual and /usr/src/linux*/Documentation/ See the specific application manual and /usr/src/linux*/Documentation/
networking/ip-sysctl.txt for more details. networking/ip-sysctl.txt for more details.
- The maximum MTU setting for Jumbo Frames is 16110. This value - The maximum MTU setting for Jumbo Frames is 16110. This value coincides
coincides with the maximum Jumbo Frames size of 16128. with the maximum Jumbo Frames size of 16128.
- Using Jumbo frames at 10 or 100 Mbps is not supported and may result - Using Jumbo frames at 10 or 100 Mbps is not supported and may result in
in poor performance or loss of link. poor performance or loss of link.
- Adapters based on the Intel(R) 82542 and 82573V/E controller do not - Adapters based on the Intel(R) 82542 and 82573V/E controller do not
support Jumbo Frames. These correspond to the following product names: support Jumbo Frames. These correspond to the following product names::
Intel(R) PRO/1000 Gigabit Server Adapter Intel(R) PRO/1000 PM Network
Connection Intel(R) PRO/1000 Gigabit Server Adapter
Intel(R) PRO/1000 PM Network Connection
ethtool ethtool
------- -------
The driver utilizes the ethtool interface for driver configuration and
diagnostics, as well as displaying statistical information. The ethtool
version 1.6 or later is required for this functionality.
The latest release of ethtool can be found from The driver utilizes the ethtool interface for driver configuration and
https://www.kernel.org/pub/software/network/ethtool/ diagnostics, as well as displaying statistical information. The ethtool
version 1.6 or later is required for this functionality.
The latest release of ethtool can be found from
https://www.kernel.org/pub/software/network/ethtool/
Enabling Wake on LAN* (WoL) Enabling Wake on LAN* (WoL)
--------------------------- ---------------------------
WoL is configured through the ethtool* utility.
WoL will be enabled on the system during the next shut down or reboot. WoL is configured through the ethtool* utility.
For this driver version, in order to enable WoL, the e1000 driver must be
loaded when shutting down or rebooting the system.
WoL will be enabled on the system during the next shut down or reboot.
For this driver version, in order to enable WoL, the e1000 driver must be
loaded when shutting down or rebooting the system.
Support Support
======= =======