From: Ferruh Yigit <ferruh.yigit@amd.com>
To: John McNamara <john.mcnamara@intel.com>,
Gagandeep Singh <g.singh@nxp.com>
Cc: Thomas Monjalon <thomas@monjalon.net>,
Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>, <dev@dpdk.org>
Subject: [PATCH 25/33] doc: update pfe guide
Date: Tue, 21 Mar 2023 23:59:33 +0000 [thread overview]
Message-ID: <20230321235941.2169068-26-ferruh.yigit@amd.com> (raw)
In-Reply-To: <20230321235941.2169068-1-ferruh.yigit@amd.com>
- Reduce section indentation, 'PFE' was single top level section
- Move "Supported PFE SoCs" section up
Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
---
doc/guides/nics/pfe.rst | 25 +++++++++++--------------
1 file changed, 11 insertions(+), 14 deletions(-)
diff --git a/doc/guides/nics/pfe.rst b/doc/guides/nics/pfe.rst
index 5261984884af..748c382573e8 100644
--- a/doc/guides/nics/pfe.rst
+++ b/doc/guides/nics/pfe.rst
@@ -10,23 +10,20 @@ support for the inbuilt NIC found in the **NXP LS1012** SoC.
More information can be found at `NXP Official Website
<https://nxp.com/ls1012a>`_.
-PFE
----
-
This section provides an overview of the NXP PFE
and how it is integrated into the DPDK.
Contents summary
- PFE overview
-- PFE features
- Supported PFE SoCs
+- PFE features
- Prerequisites
- Driver compilation and testing
- Limitations
PFE Overview
-~~~~~~~~~~~~
+------------
PFE is a hardware programmable packet forwarding engine to provide
high performance Ethernet interfaces. The diagram below shows a
@@ -90,8 +87,13 @@ pfe.ko is required for PHY initialisation and also responsible for creating
the character device "pfe_us_cdev" which will be used for interacting with
the kernel layer for link status.
+Supported PFE SoCs
+------------------
+
+- LS1012
+
PFE Features
-~~~~~~~~~~~~
+------------
- L3/L4 checksum offload
- Packet type parsing
@@ -102,13 +104,8 @@ PFE Features
- Link status
- ARMv8
-Supported PFE SoCs
-~~~~~~~~~~~~~~~~~~
-
-- LS1012
-
Prerequisites
-~~~~~~~~~~~~~
+-------------
Below are some pre-requisites for executing PFE PMD on a PFE
compatible board:
@@ -157,7 +154,7 @@ separately:
Driver compilation and testing
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+------------------------------
Follow instructions available in the document
:ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
@@ -175,6 +172,6 @@ see the command below:
Limitations
-~~~~~~~~~~~
+-----------
- Multi buffer pool cannot be supported.
--
2.34.1
next prev parent reply other threads:[~2023-03-22 0:03 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 ` [PATCH 08/33] doc: update enic guide Ferruh Yigit
2023-03-22 2:32 ` 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 ` Ferruh Yigit [this message]
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-26-ferruh.yigit@amd.com \
--to=ferruh.yigit@amd.com \
--cc=andrew.rybchenko@oktetlabs.ru \
--cc=dev@dpdk.org \
--cc=g.singh@nxp.com \
--cc=john.mcnamara@intel.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).