DPDK patches and discussions
 help / color / mirror / Atom feed
From: Ferruh Yigit <ferruh.yigit@amd.com>
To: John McNamara <john.mcnamara@intel.com>,
	John Daley <johndale@cisco.com>,
	 Hyong Youb Kim <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
Date: Tue, 21 Mar 2023 23:59:16 +0000	[thread overview]
Message-ID: <20230321235941.2169068-9-ferruh.yigit@amd.com> (raw)
In-Reply-To: <20230321235941.2169068-1-ferruh.yigit@amd.com>

- 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(-)

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


  parent reply	other threads:[~2023-03-22  0:01 UTC|newest]

Thread overview: 54+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-03-21 23:59 [PATCH 00/33] Update net driver documentation Ferruh Yigit
2023-03-21 23:59 ` [PATCH 01/33] doc: update atlantic guide Ferruh Yigit
2023-03-22 10:21   ` [EXT] " Igor Russkikh
2023-03-21 23:59 ` [PATCH 02/33] doc: update cpfl guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 03/33] doc: update cxgbe guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 04/33] doc: update dpaa guide Ferruh Yigit
2023-03-22  9:01   ` Sachin Saxena (OSS)
2023-03-21 23:59 ` [PATCH 05/33] doc: update ena guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 06/33] doc: update enetc guide Ferruh Yigit
2023-03-22  9:07   ` Sachin Saxena (OSS)
2023-03-21 23:59 ` [PATCH 07/33] doc: update enetfec guide Ferruh Yigit
2023-03-22  9:08   ` Sachin Saxena (OSS)
2023-03-21 23:59 ` Ferruh Yigit [this message]
2023-03-22  2:32   ` [PATCH 08/33] doc: update enic guide Hyong Youb Kim (hyonkim)
2023-03-21 23:59 ` [PATCH 09/33] doc: update hns3 guide Ferruh Yigit
2023-03-22  0:33   ` fengchengwen
2023-03-22  7:54   ` Dongdong Liu
2023-03-21 23:59 ` [PATCH 10/33] doc: update i40e guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 11/33] doc: update ice guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 12/33] doc: update idpf guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 13/33] doc: update igb guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 14/33] doc: update igc guide Ferruh Yigit
2023-03-22  2:31   ` Su, Simei
2023-03-21 23:59 ` [PATCH 15/33] doc: update ipn3ke guide Ferruh Yigit
2023-03-22  1:41   ` Xu, Rosen
2023-03-21 23:59 ` [PATCH 16/33] doc: update ixgbe guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 17/33] doc: update kni guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 18/33] doc: update mana guide Ferruh Yigit
2023-03-22  0:09   ` Long Li
2023-03-21 23:59 ` [PATCH 19/33] doc: update mlx5 guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 20/33] doc: update mvneta guide Ferruh Yigit
2023-03-22 11:45   ` [EXT] " Liron Himi
2023-03-21 23:59 ` [PATCH 21/33] doc: update netvsc guide Ferruh Yigit
2023-03-22  0:09   ` Long Li
2023-03-21 23:59 ` [PATCH 22/33] doc: update ngbe guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 23/33] doc: update net null guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 24/33] doc: update octeontx guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 25/33] doc: update pfe guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 26/33] doc: update qede guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 27/33] doc: update sfc guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 28/33] doc: update softnic guide Ferruh Yigit
2023-03-22 12:43   ` Dumitrescu, Cristian
2023-03-21 23:59 ` [PATCH 29/33] doc: update thunderx guide Ferruh Yigit
2023-03-22 13:18   ` Jerin Jacob
2023-03-21 23:59 ` [PATCH 30/33] doc: update txgbe guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 31/33] doc: update vdev netvsc guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 32/33] doc: update vhost guide Ferruh Yigit
2023-03-22  2:17   ` Xia, Chenbo
2023-03-21 23:59 ` [PATCH 33/33] doc: update virtio guide Ferruh Yigit
2023-03-22  2:17   ` Xia, Chenbo
2023-03-22  0:48 ` [PATCH 00/33] Update net driver documentation fengchengwen
2023-03-22  8:43   ` Ferruh Yigit
2023-03-22  2:53 ` Zhang, Qi Z
2023-03-28 16:59 ` Thomas Monjalon

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230321235941.2169068-9-ferruh.yigit@amd.com \
    --to=ferruh.yigit@amd.com \
    --cc=andrew.rybchenko@oktetlabs.ru \
    --cc=dev@dpdk.org \
    --cc=hyonkim@cisco.com \
    --cc=john.mcnamara@intel.com \
    --cc=johndale@cisco.com \
    --cc=thomas@monjalon.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).