diff mbox series

[08/33] doc: update enic guide

Message ID 20230321235941.2169068-9-ferruh.yigit@amd.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series Update net driver documentation |

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Ferruh Yigit March 21, 2023, 11:59 p.m. UTC 
  - Move "Supported Cisco VIC adapters" section up
- Move "Supported features" section up
- Remove "Contact Information" as this is duplication of Maintainers
  file

Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
---
 doc/guides/nics/enic.rst | 79 ++++++++++++++++++----------------------
 1 file changed, 35 insertions(+), 44 deletions(-)

Comments

Hyong Youb Kim (hyonkim) March 22, 2023, 2:32 a.m. UTC | #1 
> -----Original Message-----
> From: Ferruh Yigit <ferruh.yigit@amd.com>
> Sent: Wednesday, March 22, 2023 8:59 AM
> To: John McNamara <john.mcnamara@intel.com>; John Daley (johndale)
> <johndale@cisco.com>; Hyong Youb Kim (hyonkim) <hyonkim@cisco.com>
> Cc: Thomas Monjalon <thomas@monjalon.net>; Andrew Rybchenko
> <andrew.rybchenko@oktetlabs.ru>; dev@dpdk.org
> Subject: [PATCH 08/33] doc: update enic guide
> 
> - Move "Supported Cisco VIC adapters" section up
> - Move "Supported features" section up
> - Remove "Contact Information" as this is duplication of Maintainers
>   file
> 
> Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
> ---

Acked-by: Hyong Youb Kim <hyonkim@cisco.com>

Thanks.
-Hyong

>  doc/guides/nics/enic.rst | 79 ++++++++++++++++++----------------------
>  1 file changed, 35 insertions(+), 44 deletions(-)
> 
> diff --git a/doc/guides/nics/enic.rst b/doc/guides/nics/enic.rst index
> 5e2054fc8a9d..5bf5cc9ab98f 100644
> --- a/doc/guides/nics/enic.rst
> +++ b/doc/guides/nics/enic.rst
> @@ -10,6 +10,41 @@ NICs. These adapters are also referred to as vNICs
> below. If you are running  or would like to run DPDK software applications on
> Cisco UCS servers using  Cisco VIC adapters the following documentation is
> relevant.
> 
> +Supported Cisco VIC adapters
> +----------------------------
> +
> +ENIC PMD supports all recent generations of Cisco VIC adapters including:
> +
> +- VIC 1200 series
> +- VIC 1300 series
> +- VIC 1400 series
> +
> +Supported features
> +------------------
> +
> +- Unicast, multicast and broadcast transmission and reception
> +- Receive queue polling
> +- Port Hardware Statistics
> +- Hardware VLAN acceleration
> +- IP checksum offload
> +- Receive side VLAN stripping
> +- Multiple receive and transmit queues
> +- Promiscuous mode
> +- Setting RX VLAN (supported via UCSM/CIMC only)
> +- VLAN filtering (supported via UCSM/CIMC only)
> +- Execution of application by unprivileged system users
> +- IPV4, IPV6 and TCP RSS hashing
> +- UDP RSS hashing (1400 series and later adapters)
> +- Scattered Rx
> +- MTU update
> +- SR-IOV on UCS managed servers connected to Fabric Interconnects
> +- Flow API
> +- Overlay offload
> +
> +  - Rx/Tx checksum offloads for VXLAN, NVGRE, GENEVE
> +  - TSO for VXLAN and GENEVE packets
> +  - Inner RSS
> +
>  How to obtain ENIC PMD integrated DPDK
>  --------------------------------------
> 
> @@ -510,47 +545,12 @@ Refer to the document :ref:`compiling and testing a
> PMD for a NIC  For configuring and using UIO and VFIO frameworks, please
> refer to the  documentation that comes with DPDK suite.
> 
> -Supported Cisco VIC adapters
> -----------------------------
> -
> -ENIC PMD supports all recent generations of Cisco VIC adapters including:
> -
> -- VIC 1200 series
> -- VIC 1300 series
> -- VIC 1400 series
> -
>  Supported Operating Systems
>  ---------------------------
> 
>  Any Linux distribution fulfilling the conditions described in Dependencies
> section of DPDK documentation.
> 
> -Supported features
> -------------------
> -
> -- Unicast, multicast and broadcast transmission and reception
> -- Receive queue polling
> -- Port Hardware Statistics
> -- Hardware VLAN acceleration
> -- IP checksum offload
> -- Receive side VLAN stripping
> -- Multiple receive and transmit queues
> -- Promiscuous mode
> -- Setting RX VLAN (supported via UCSM/CIMC only)
> -- VLAN filtering (supported via UCSM/CIMC only)
> -- Execution of application by unprivileged system users
> -- IPV4, IPV6 and TCP RSS hashing
> -- UDP RSS hashing (1400 series and later adapters)
> -- Scattered Rx
> -- MTU update
> -- SR-IOV on UCS managed servers connected to Fabric Interconnects
> -- Flow API
> -- Overlay offload
> -
> -  - Rx/Tx checksum offloads for VXLAN, NVGRE, GENEVE
> -  - TSO for VXLAN and GENEVE packets
> -  - Inner RSS
> -
>  Known bugs and unsupported features in this release
>  ---------------------------------------------------
> 
> @@ -604,12 +604,3 @@ Additional Reference
> 
>  - https://www.cisco.com/c/en/us/products/servers-unified-
> computing/index.html
>  - https://www.cisco.com/c/en/us/products/interfaces-modules/unified-
> computing-system-adapters/index.html
> -
> -Contact Information
> --------------------
> -
> -Any questions or bugs should be reported to DPDK community and to the
> ENIC PMD
> -maintainers:
> -
> -- John Daley <johndale@cisco.com>
> -- Hyong Youb Kim <hyonkim@cisco.com>
> --
> 2.34.1
diff mbox series

Patch

diff --git a/doc/guides/nics/enic.rst b/doc/guides/nics/enic.rst
index 5e2054fc8a9d..5bf5cc9ab98f 100644
--- a/doc/guides/nics/enic.rst
+++ b/doc/guides/nics/enic.rst
@@ -10,6 +10,41 @@  NICs. These adapters are also referred to as vNICs below. If you are running
 or would like to run DPDK software applications on Cisco UCS servers using
 Cisco VIC adapters the following documentation is relevant.
 
+Supported Cisco VIC adapters
+----------------------------
+
+ENIC PMD supports all recent generations of Cisco VIC adapters including:
+
+- VIC 1200 series
+- VIC 1300 series
+- VIC 1400 series
+
+Supported features
+------------------
+
+- Unicast, multicast and broadcast transmission and reception
+- Receive queue polling
+- Port Hardware Statistics
+- Hardware VLAN acceleration
+- IP checksum offload
+- Receive side VLAN stripping
+- Multiple receive and transmit queues
+- Promiscuous mode
+- Setting RX VLAN (supported via UCSM/CIMC only)
+- VLAN filtering (supported via UCSM/CIMC only)
+- Execution of application by unprivileged system users
+- IPV4, IPV6 and TCP RSS hashing
+- UDP RSS hashing (1400 series and later adapters)
+- Scattered Rx
+- MTU update
+- SR-IOV on UCS managed servers connected to Fabric Interconnects
+- Flow API
+- Overlay offload
+
+  - Rx/Tx checksum offloads for VXLAN, NVGRE, GENEVE
+  - TSO for VXLAN and GENEVE packets
+  - Inner RSS
+
 How to obtain ENIC PMD integrated DPDK
 --------------------------------------
 
@@ -510,47 +545,12 @@  Refer to the document :ref:`compiling and testing a PMD for a NIC
 For configuring and using UIO and VFIO frameworks, please refer to the
 documentation that comes with DPDK suite.
 
-Supported Cisco VIC adapters
-----------------------------
-
-ENIC PMD supports all recent generations of Cisco VIC adapters including:
-
-- VIC 1200 series
-- VIC 1300 series
-- VIC 1400 series
-
 Supported Operating Systems
 ---------------------------
 
 Any Linux distribution fulfilling the conditions described in Dependencies
 section of DPDK documentation.
 
-Supported features
-------------------
-
-- Unicast, multicast and broadcast transmission and reception
-- Receive queue polling
-- Port Hardware Statistics
-- Hardware VLAN acceleration
-- IP checksum offload
-- Receive side VLAN stripping
-- Multiple receive and transmit queues
-- Promiscuous mode
-- Setting RX VLAN (supported via UCSM/CIMC only)
-- VLAN filtering (supported via UCSM/CIMC only)
-- Execution of application by unprivileged system users
-- IPV4, IPV6 and TCP RSS hashing
-- UDP RSS hashing (1400 series and later adapters)
-- Scattered Rx
-- MTU update
-- SR-IOV on UCS managed servers connected to Fabric Interconnects
-- Flow API
-- Overlay offload
-
-  - Rx/Tx checksum offloads for VXLAN, NVGRE, GENEVE
-  - TSO for VXLAN and GENEVE packets
-  - Inner RSS
-
 Known bugs and unsupported features in this release
 ---------------------------------------------------
 
@@ -604,12 +604,3 @@  Additional Reference
 
 - https://www.cisco.com/c/en/us/products/servers-unified-computing/index.html
 - https://www.cisco.com/c/en/us/products/interfaces-modules/unified-computing-system-adapters/index.html
-
-Contact Information
--------------------
-
-Any questions or bugs should be reported to DPDK community and to the ENIC PMD
-maintainers:
-
-- John Daley <johndale@cisco.com>
-- Hyong Youb Kim <hyonkim@cisco.com>