torvalds/linux
torvalds/linux
2
0
Fork 0
mirror of git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git synced 2025-09-04 20:19:47 +08:00
Code

Documentation: e100: Update the Intel 10/100 driver doc

Browse Source 
Over the years, several of the links have changed or are no longer valid
so update them.  In addition, the default values were incorrect for a
couple of parameters.

Converted the text file to the reStructuredText (RST) format, since the
Linux kernel documentation now uses this format for documentation.

Signed-off-by: Jeff Kirsher <jeffrey.t.kirsher@intel.com>
Tested-by: Aaron Brown <aaron.f.brown@intel.com>
This commit is contained in:
Jeff Kirsher 2018-05-10 12:20:13 -07:00
parent fff200caf6
commit 85d63445f4
3 changed files with 29 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
Documentation/networking/e100.txt → Documentation/networking/e100.rst
View File

@ -1,7 +1,7 @@
Linux* Base Driver for the Intel(R) PRO/100 Family of Adapters Linux* Base Driver for the Intel(R) PRO/100 Family of Adapters
============================================================== ==============================================================
March 15, 2011 June 1, 2018
Contents Contents
======== ========
@ -36,16 +36,9 @@ Channel Bonding documentation can be found in the Linux kernel source:
Identifying Your Adapter Identifying Your Adapter
======================== ========================
For more information on how to identify your adapter, go to the Adapter & For information on how to identify your adapter, and for the latest Intel
Driver ID Guide at: network drivers, refer to the Intel Support website:
http://www.intel.com/support
http://support.intel.com/support/network/adapter/pro100/21397.htm
For the latest Intel network drivers for Linux, refer to the following
website. In the search field, enter your adapter name or type, or use the
networking link on the left to search for your adapter:
http://downloadfinder.intel.com/scripts-df/support_intel.asp
Driver Configuration Parameters Driver Configuration Parameters
=============================== ===============================
@ -57,22 +50,26 @@ Rx Descriptors: Number of receive descriptors. A receive descriptor is a data
structure that describes a receive buffer and its attributes to the network structure that describes a receive buffer and its attributes to the network
controller. The data in the descriptor is used by the controller to write controller. The data in the descriptor is used by the controller to write
data from the controller to host memory. In the 3.x.x driver the valid range data from the controller to host memory. In the 3.x.x driver the valid range
for this parameter is 64-256. The default value is 64. This parameter can be for this parameter is 64-256. The default value is 256. This parameter can be
changed using the command: changed using the command::
ethtool -G eth? rx n, where n is the number of desired rx descriptors. ethtool -G eth? rx n
Where n is the number of desired Rx descriptors.
Tx Descriptors: Number of transmit descriptors. A transmit descriptor is a data Tx Descriptors: Number of transmit descriptors. A transmit descriptor is a data
structure that describes a transmit buffer and its attributes to the network structure that describes a transmit buffer and its attributes to the network
controller. The data in the descriptor is used by the controller to read controller. The data in the descriptor is used by the controller to read
data from the host memory to the controller. In the 3.x.x driver the valid data from the host memory to the controller. In the 3.x.x driver the valid
range for this parameter is 64-256. The default value is 64. This parameter range for this parameter is 64-256. The default value is 128. This parameter
can be changed using the command: can be changed using the command::
ethtool -G eth? tx n, where n is the number of desired tx descriptors. ethtool -G eth? tx n
Where n is the number of desired Tx descriptors.
Speed/Duplex: The driver auto-negotiates the link speed and duplex settings by Speed/Duplex: The driver auto-negotiates the link speed and duplex settings by
default. The ethtool utility can be used as follows to force speed/duplex. default. The ethtool utility can be used as follows to force speed/duplex.::
ethtool -s eth? autoneg off speed {10|100} duplex {full|half} ethtool -s eth? autoneg off speed {10|100} duplex {full|half}
@ -81,7 +78,7 @@ Speed/Duplex: The driver auto-negotiates the link speed and duplex settings by
Event Log Message Level: The driver uses the message level flag to log events Event Log Message Level: The driver uses the message level flag to log events
to syslog. The message level can be set at driver load time. It can also be to syslog. The message level can be set at driver load time. It can also be
set using the command: set using the command::
ethtool -s eth? msglvl n ethtool -s eth? msglvl n
@ -112,9 +109,9 @@ Additional Configurations
--------------------- ---------------------
In order to see link messages and other Intel driver information on your In order to see link messages and other Intel driver information on your
console, you must set the dmesg level up to six. This can be done by console, you must set the dmesg level up to six. This can be done by
entering the following on the command line before loading the e100 driver: entering the following on the command line before loading the e100 driver::
dmesg -n 8 dmesg -n 6
If you wish to see all messages issued by the driver, including debug If you wish to see all messages issued by the driver, including debug
messages, set the dmesg level to eight. messages, set the dmesg level to eight.
@ -146,7 +143,8 @@ Additional Configurations
NAPI (Rx polling mode) is supported in the e100 driver. NAPI (Rx polling mode) is supported in the e100 driver.
See www.cyberus.ca/~hadi/usenix-paper.tgz for more information on NAPI. See https://wiki.linuxfoundation.org/networking/napi for more information
on NAPI.
Multiple Interfaces on Same Ethernet Broadcast Network Multiple Interfaces on Same Ethernet Broadcast Network
------------------------------------------------------ ------------------------------------------------------
@ -160,7 +158,7 @@ Additional Configurations
If you have multiple interfaces in a server, either turn on ARP If you have multiple interfaces in a server, either turn on ARP
filtering by filtering by
(1) entering: echo 1 > /proc/sys/net/ipv4/conf/all/arp_filter (1) entering:: echo 1 > /proc/sys/net/ipv4/conf/all/arp_filter
(this only works if your kernel's version is higher than 2.4.5), or (this only works if your kernel's version is higher than 2.4.5), or
(2) installing the interfaces in separate broadcast domains (either (2) installing the interfaces in separate broadcast domains (either
@ -169,15 +167,11 @@ Additional Configurations
Support Support
======= =======
For general information, go to the Intel support website at: For general information, go to the Intel support website at:
http://www.intel.com/support/
http://support.intel.com or the Intel Wired Networking project hosted by Sourceforge at:
http://sourceforge.net/projects/e1000
or the Intel Wired Networking project hosted by Sourceforge at: If an issue is identified with the released source code on a supported kernel
with a supported adapter, email the specific information related to the issue
http://sourceforge.net/projects/e1000 to e1000-devel@lists.sf.net.
If an issue is identified with the released source code on the supported
kernel with a supported adapter, email the specific information related to the
issue to e1000-devel@lists.sourceforge.net.

1
Documentation/networking/index.rst
View File

@ -10,6 +10,7 @@ Contents:
batman-adv batman-adv
can can
dpaa2/index dpaa2/index
e100
kapi kapi
z8530book z8530book
msg_zerocopy msg_zerocopy

2
MAINTAINERS
View File

@ -7089,7 +7089,7 @@ Q: http://patchwork.ozlabs.org/project/intel-wired-lan/list/
T: git git://git.kernel.org/pub/scm/linux/kernel/git/jkirsher/net-queue.git T: git git://git.kernel.org/pub/scm/linux/kernel/git/jkirsher/net-queue.git
T: git git://git.kernel.org/pub/scm/linux/kernel/git/jkirsher/next-queue.git T: git git://git.kernel.org/pub/scm/linux/kernel/git/jkirsher/next-queue.git
S: Supported S: Supported
F: Documentation/networking/e100.txt F: Documentation/networking/e100.rst
F: Documentation/networking/e1000.txt F: Documentation/networking/e1000.txt
F: Documentation/networking/e1000e.txt F: Documentation/networking/e1000e.txt
F: Documentation/networking/igb.txt F: Documentation/networking/igb.txt