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: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: David S. Miller <davem@davemloft.net>

diff --git a/Documentation/networking/device_drivers/index.rst b/Documentation/networking/device_drivers/index.rst
index da1f8438d4ea4052c1b79bff6e26f0805eeb208c..55837244eaada3a1bdd604f213356a8e506d2c73 100644 (file)
--- a/Documentation/networking/device_drivers/index.rst
+++ b/Documentation/networking/device_drivers/index.rst
@@ -43,6 +43,7 @@ Contents:
    intel/ipw2200
    microsoft/netvsc
    neterion/s2io
    intel/ipw2200
    microsoft/netvsc
    neterion/s2io

+   neterion/vxge

 
 .. only::  subproject and html
 
 
 .. only::  subproject and html
 

diff --git a/Documentation/networking/device_drivers/neterion/vxge.txt b/Documentation/networking/device_drivers/neterion/vxge.rst
similarity index 80%
rename from Documentation/networking/device_drivers/neterion/vxge.txt
rename to Documentation/networking/device_drivers/neterion/vxge.rst
index abfec245f97c6aa9cc6e4bc40dcf8c2324f496ec..589c6b15c63d7e1d93c3cf33f90d561b49f90cc4 100644 (file)
--- a/Documentation/networking/device_drivers/neterion/vxge.txt
+++ b/Documentation/networking/device_drivers/neterion/vxge.rst
@@ -1,24 +1,30 @@
+.. 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
-2) Features supported
-3) Configurable driver parameters
-4) Troubleshooting
+1. Introduction
+===============

 
 

-1) Introduction:
-----------------

 This Linux driver supports all Neterion's X3100 series 10 GbE PCIe I/O
 Virtualized Server adapters.
 This Linux driver supports all Neterion's X3100 series 10 GbE PCIe I/O
 Virtualized Server adapters.

+

 The X3100 series supports four modes of operation, configurable via
 The X3100 series supports four modes of operation, configurable via

-firmware -
-       Single function mode
-       Multi function mode
-       SRIOV mode
-       MRIOV mode
+firmware:
+
+       - Single function mode
+       - Multi function mode
+       - SRIOV mode
+       - MRIOV mode
+

 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/
 priority allocation and guarantees, GRO, TSO, interrupt moderation etc are
 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/
 priority allocation and guarantees, GRO, TSO, interrupt moderation etc are


@@ -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)
 
 ii)  Multi function mode (up to 17 functions)
 
 iii) PCI-SIG's I/O Virtualization
 
 i)   Single function mode (up to 17 queues)
 
 ii)  Multi function mode (up to 17 functions)
 
 iii) PCI-SIG's I/O Virtualization

+

        - Single Root mode: v1.0 (up to 17 functions)
        - Multi-Root mode: v1.0 (up to 17 functions)
 
 iv)  Jumbo frames
        - Single Root mode: v1.0 (up to 17 functions)
        - Multi-Root mode: v1.0 (up to 17 functions)
 
 iv)  Jumbo frames

+

        X3100 Series supports MTU up to 9600 bytes, modifiable using
        ip command.
 
 v)   Offloads supported: (Enabled by default)
        X3100 Series supports MTU up to 9600 bytes, modifiable using
        ip command.
 
 v)   Offloads supported: (Enabled by default)

-       Checksum offload (TCP/UDP/IP) on transmit and receive paths
-       TCP Segmentation Offload (TSO) on transmit path
-       Generic Receive Offload (GRO) on receive path
+
+       - Checksum offload (TCP/UDP/IP) on transmit and receive paths
+       - 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
        platforms).
 
 vii) NAPI: (Enabled by default)
        Resulting in noticeable performance improvement (up to 7% on certain
        platforms).
 
 vii) NAPI: (Enabled by default)

+

        For better Rx interrupt moderation.
 
 viii)RTH (Receive Traffic Hash): (Enabled by default)
        For better Rx interrupt moderation.
 
 viii)RTH (Receive Traffic Hash): (Enabled by default)

+

        Receive side steering for better scaling.
 
 ix)  Statistics
        Receive side steering for better scaling.
 
 ix)  Statistics

+

        Comprehensive MAC-level and software statistics displayed using
        "ethtool -S" option.
 
 x)   Multiple hardware queues: (Enabled by default)
        Comprehensive MAC-level and software statistics displayed using
        "ethtool -S" option.
 
 x)   Multiple hardware queues: (Enabled by default)

+

        Up to 17 hardware based transmit and receive data channels, with
        multiple steering options (transmit multiqueue enabled by default).
 
        Up to 17 hardware based transmit and receive data channels, with
        multiple steering options (transmit multiqueue enabled by default).
 


@@ -69,25 +83,33 @@ x)   Multiple hardware queues: (Enabled by default)
 
 i)  max_config_dev
        Specifies maximum device functions to be enabled.
 
 i)  max_config_dev
        Specifies maximum device functions to be enabled.

+

        Valid range: 1-8
 
 ii) max_config_port
        Specifies number of ports to be enabled.
        Valid range: 1-8
 
 ii) max_config_port
        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
 
 iv) vlan_tag_strip
        Enables/disables vlan tag stripping from all received tagged frames that
        are not replicated at the internal L2 switch.
        Valid range: 1-17
 
 iv) vlan_tag_strip
        Enables/disables vlan tag stripping from all received tagged frames that
        are not replicated at the internal L2 switch.

+

        Valid range: 0,1 (disabled, enabled respectively)
        Valid range: 0,1 (disabled, enabled respectively)

+

        Default: 1
 
 v)  addr_learn_en
        Enable learning the mac address of the guest OS interface in
        virtualization environment.
        Default: 1
 
 v)  addr_learn_en
        Enable learning the mac address of the guest OS interface in
        virtualization environment.

+

        Valid range: 0,1 (disabled, enabled respectively)
        Valid range: 0,1 (disabled, enabled respectively)

+

        Default: 0
        Default: 0

diff --git a/MAINTAINERS b/MAINTAINERS
index 4e3f96ee0d982538fda6312eee9305de19154c9c..88e9e84305818393297c8b9a35b185e86abda25d 100644 (file)
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -11657,7 +11657,7 @@ M:      Jon Mason <jdmason@kudzu.us>
 L:     netdev@vger.kernel.org
 S:     Supported
 F:     Documentation/networking/device_drivers/neterion/s2io.rst
 L:     netdev@vger.kernel.org
 S:     Supported
 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/
 
 NETFILTER
 F:     drivers/net/ethernet/neterion/
 
 NETFILTER

diff --git a/drivers/net/ethernet/neterion/Kconfig b/drivers/net/ethernet/neterion/Kconfig
index c375ee08f6eab70850602c2bc62460c1632a206a..a82a370945792ef644ad690a55fbd8bab010c4d8 100644 (file)
--- a/drivers/net/ethernet/neterion/Kconfig
+++ b/drivers/net/ethernet/neterion/Kconfig
@@ -42,7 +42,7 @@ config VXGE
          labeled as either one, depending on its age.
 
          More specific information on configuring the driver is in
          labeled as either one, depending on its age.
 
          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
          will be called vxge.
 
          To compile this driver as a module, choose M here. The module
          will be called vxge.