Commit f10727d3 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by David S. Miller

docs: networking: device drivers: convert neterion/vxge.txt to ReST

- add SPDX header;
- adjust titles and chapters, adding proper markups;
- comment out text-only TOC from html/pdf output;
- mark code blocks and literals as such;
- adjust identation, whitespaces and blank lines where needed;
- add to networking/index.rst.
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent 7762f5c5
...@@ -43,6 +43,7 @@ Contents: ...@@ -43,6 +43,7 @@ Contents:
intel/ipw2200 intel/ipw2200
microsoft/netvsc microsoft/netvsc
neterion/s2io neterion/s2io
neterion/vxge
.. only:: subproject and html .. only:: subproject and html
......
.. SPDX-License-Identifier: GPL-2.0
==============================================================================
Neterion's (Formerly S2io) X3100 Series 10GbE PCIe Server Adapter Linux driver Neterion's (Formerly S2io) X3100 Series 10GbE PCIe Server Adapter Linux driver
============================================================================== ==============================================================================
Contents .. Contents
--------
1) Introduction
2) Features supported
3) Configurable driver parameters
4) Troubleshooting
1) Introduction 1. Introduction
2) Features supported ===============
3) Configurable driver parameters
4) Troubleshooting
1) Introduction:
----------------
This Linux driver supports all Neterion's X3100 series 10 GbE PCIe I/O This Linux driver supports all Neterion's X3100 series 10 GbE PCIe I/O
Virtualized Server adapters. Virtualized Server adapters.
The X3100 series supports four modes of operation, configurable via The X3100 series supports four modes of operation, configurable via
firmware - firmware:
Single function mode
Multi function mode - Single function mode
SRIOV mode - Multi function mode
MRIOV mode - SRIOV mode
- MRIOV mode
The functions share a 10GbE link and the pci-e bus, but hardly anything else The functions share a 10GbE link and the pci-e bus, but hardly anything else
inside the ASIC. Features like independent hw reset, statistics, bandwidth/ inside the ASIC. Features like independent hw reset, statistics, bandwidth/
priority allocation and guarantees, GRO, TSO, interrupt moderation etc are priority allocation and guarantees, GRO, TSO, interrupt moderation etc are
...@@ -26,41 +32,49 @@ supported independently on each function. ...@@ -26,41 +32,49 @@ supported independently on each function.
(See below for a complete list of features supported for both IPv4 and IPv6) (See below for a complete list of features supported for both IPv4 and IPv6)
2) Features supported: 2. Features supported
---------------------- =====================
i) Single function mode (up to 17 queues) i) Single function mode (up to 17 queues)
ii) Multi function mode (up to 17 functions) ii) Multi function mode (up to 17 functions)
iii) PCI-SIG's I/O Virtualization iii) PCI-SIG's I/O Virtualization
- Single Root mode: v1.0 (up to 17 functions) - Single Root mode: v1.0 (up to 17 functions)
- Multi-Root mode: v1.0 (up to 17 functions) - Multi-Root mode: v1.0 (up to 17 functions)
iv) Jumbo frames iv) Jumbo frames
X3100 Series supports MTU up to 9600 bytes, modifiable using X3100 Series supports MTU up to 9600 bytes, modifiable using
ip command. ip command.
v) Offloads supported: (Enabled by default) v) Offloads supported: (Enabled by default)
Checksum offload (TCP/UDP/IP) on transmit and receive paths
TCP Segmentation Offload (TSO) on transmit path - Checksum offload (TCP/UDP/IP) on transmit and receive paths
Generic Receive Offload (GRO) on receive path - TCP Segmentation Offload (TSO) on transmit path
- Generic Receive Offload (GRO) on receive path
vi) MSI-X: (Enabled by default) vi) MSI-X: (Enabled by default)
Resulting in noticeable performance improvement (up to 7% on certain Resulting in noticeable performance improvement (up to 7% on certain
platforms). platforms).
vii) NAPI: (Enabled by default) vii) NAPI: (Enabled by default)
For better Rx interrupt moderation. For better Rx interrupt moderation.
viii)RTH (Receive Traffic Hash): (Enabled by default) viii)RTH (Receive Traffic Hash): (Enabled by default)
Receive side steering for better scaling. Receive side steering for better scaling.
ix) Statistics ix) Statistics
Comprehensive MAC-level and software statistics displayed using Comprehensive MAC-level and software statistics displayed using
"ethtool -S" option. "ethtool -S" option.
x) Multiple hardware queues: (Enabled by default) x) Multiple hardware queues: (Enabled by default)
Up to 17 hardware based transmit and receive data channels, with Up to 17 hardware based transmit and receive data channels, with
multiple steering options (transmit multiqueue enabled by default). multiple steering options (transmit multiqueue enabled by default).
...@@ -69,25 +83,33 @@ x) Multiple hardware queues: (Enabled by default) ...@@ -69,25 +83,33 @@ x) Multiple hardware queues: (Enabled by default)
i) max_config_dev i) max_config_dev
Specifies maximum device functions to be enabled. Specifies maximum device functions to be enabled.
Valid range: 1-8 Valid range: 1-8
ii) max_config_port ii) max_config_port
Specifies number of ports to be enabled. Specifies number of ports to be enabled.
Valid range: 1,2 Valid range: 1,2
Default: 1 Default: 1
iii)max_config_vpath iii) max_config_vpath
Specifies maximum VPATH(s) configured for each device function. Specifies maximum VPATH(s) configured for each device function.
Valid range: 1-17 Valid range: 1-17
iv) vlan_tag_strip iv) vlan_tag_strip
Enables/disables vlan tag stripping from all received tagged frames that Enables/disables vlan tag stripping from all received tagged frames that
are not replicated at the internal L2 switch. are not replicated at the internal L2 switch.
Valid range: 0,1 (disabled, enabled respectively) Valid range: 0,1 (disabled, enabled respectively)
Default: 1 Default: 1
v) addr_learn_en v) addr_learn_en
Enable learning the mac address of the guest OS interface in Enable learning the mac address of the guest OS interface in
virtualization environment. virtualization environment.
Valid range: 0,1 (disabled, enabled respectively) Valid range: 0,1 (disabled, enabled respectively)
Default: 0 Default: 0
...@@ -11657,7 +11657,7 @@ M: Jon Mason <jdmason@kudzu.us> ...@@ -11657,7 +11657,7 @@ M: Jon Mason <jdmason@kudzu.us>
L: netdev@vger.kernel.org L: netdev@vger.kernel.org
S: Supported S: Supported
F: Documentation/networking/device_drivers/neterion/s2io.rst F: Documentation/networking/device_drivers/neterion/s2io.rst
F: Documentation/networking/device_drivers/neterion/vxge.txt F: Documentation/networking/device_drivers/neterion/vxge.rst
F: drivers/net/ethernet/neterion/ F: drivers/net/ethernet/neterion/
NETFILTER NETFILTER
......
...@@ -42,7 +42,7 @@ config VXGE ...@@ -42,7 +42,7 @@ config VXGE
labeled as either one, depending on its age. labeled as either one, depending on its age.
More specific information on configuring the driver is in More specific information on configuring the driver is in
<file:Documentation/networking/device_drivers/neterion/vxge.txt>. <file:Documentation/networking/device_drivers/neterion/vxge.rst>.
To compile this driver as a module, choose M here. The module To compile this driver as a module, choose M here. The module
will be called vxge. will be called vxge.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment