Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/60314/?format=api
{ "id": 60314, "url": "http://patches.dpdk.org/api/patches/60314/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/patch/20191001110209.6047-4-g.singh@nxp.com/", "project": { "id": 1, "url": "http://patches.dpdk.org/api/projects/1/?format=api", "name": "DPDK", "link_name": "dpdk", "list_id": "dev.dpdk.org", "list_email": "dev@dpdk.org", "web_url": "http://core.dpdk.org", "scm_url": "git://dpdk.org/dpdk", "webscm_url": "http://git.dpdk.org/dpdk", "list_archive_url": "https://inbox.dpdk.org/dev", "list_archive_url_format": "https://inbox.dpdk.org/dev/{}", "commit_url_format": "" }, "msgid": "<20191001110209.6047-4-g.singh@nxp.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20191001110209.6047-4-g.singh@nxp.com", "date": "2019-10-01T11:01:58", "name": "[v3,03/14] doc: add guide for ppfe net PMD", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": true, "hash": "f9e7fa97b1dd0bdf8c21025f152cbb5ce3c91730", "submitter": { "id": 1068, "url": "http://patches.dpdk.org/api/people/1068/?format=api", "name": "Gagandeep Singh", "email": "g.singh@nxp.com" }, "delegate": { "id": 319, "url": "http://patches.dpdk.org/api/users/319/?format=api", "username": "fyigit", "first_name": "Ferruh", "last_name": "Yigit", "email": "ferruh.yigit@amd.com" }, "mbox": "http://patches.dpdk.org/project/dpdk/patch/20191001110209.6047-4-g.singh@nxp.com/mbox/", "series": [ { "id": 6647, "url": "http://patches.dpdk.org/api/series/6647/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/list/?series=6647", "date": "2019-10-01T11:01:55", "name": "introduces ppfe network PMD", "version": 3, "mbox": "http://patches.dpdk.org/series/6647/mbox/" } ], "comments": "http://patches.dpdk.org/api/patches/60314/comments/", "check": "success", "checks": "http://patches.dpdk.org/api/patches/60314/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "X-Original-To": "patchwork@dpdk.org", "Delivered-To": "patchwork@dpdk.org", "Received": [ "from [92.243.14.124] (localhost [127.0.0.1])\n\tby dpdk.org (Postfix) with ESMTP id 622221BDFD;\n\tTue, 1 Oct 2019 13:17:33 +0200 (CEST)", "from inva020.nxp.com (inva020.nxp.com [92.121.34.13])\n\tby dpdk.org (Postfix) with ESMTP id 2DB584C93\n\tfor <dev@dpdk.org>; Tue, 1 Oct 2019 13:17:28 +0200 (CEST)", "from inva020.nxp.com (localhost [127.0.0.1])\n\tby inva020.eu-rdc02.nxp.com (Postfix) with ESMTP id 0FC301A055E;\n\tTue, 1 Oct 2019 13:17:28 +0200 (CEST)", "from invc005.ap-rdc01.nxp.com (invc005.ap-rdc01.nxp.com\n\t[165.114.16.14])\n\tby inva020.eu-rdc02.nxp.com (Postfix) with ESMTP id A7DDC1A053F;\n\tTue, 1 Oct 2019 13:17:25 +0200 (CEST)", "from GDB1.ap.freescale.net (GDB1.ap.freescale.net [10.232.132.179])\n\tby invc005.ap-rdc01.nxp.com (Postfix) with ESMTP id D7022402C1;\n\tTue, 1 Oct 2019 19:17:21 +0800 (SGT)" ], "From": "Gagandeep Singh <g.singh@nxp.com>", "To": "dev@dpdk.org,\n\tferruh.yigit@intel.com", "Cc": "thomas@monjalon.net,\n\tGagandeep Singh <g.singh@nxp.com>", "Date": "Tue, 1 Oct 2019 16:31:58 +0530", "Message-Id": "<20191001110209.6047-4-g.singh@nxp.com>", "X-Mailer": "git-send-email 2.17.1", "In-Reply-To": "<20191001110209.6047-1-g.singh@nxp.com>", "References": "<20190826130246.30485-1-g.singh@nxp.com>\n\t<20191001110209.6047-1-g.singh@nxp.com>", "MIME-Version": "1.0", "Content-Type": "text/plain; charset=UTF-8", "Content-Transfer-Encoding": "8bit", "X-Virus-Scanned": "ClamAV using ClamSMTP", "Subject": "[dpdk-dev] [PATCH v3 03/14] doc: add guide for ppfe net PMD", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.15", "Precedence": "list", "List-Id": "DPDK patches and discussions <dev.dpdk.org>", "List-Unsubscribe": "<https://mails.dpdk.org/options/dev>,\n\t<mailto:dev-request@dpdk.org?subject=unsubscribe>", "List-Archive": "<http://mails.dpdk.org/archives/dev/>", "List-Post": "<mailto:dev@dpdk.org>", "List-Help": "<mailto:dev-request@dpdk.org?subject=help>", "List-Subscribe": "<https://mails.dpdk.org/listinfo/dev>,\n\t<mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org", "Sender": "\"dev\" <dev-bounces@dpdk.org>" }, "content": "This patch add documentation for ppfe network\npoll mode driver.\n\nPPFE is a hardware programmable packet\nforwarding engine to provide high performance\nethernet interfaces.\n\nSigned-off-by: Gagandeep Singh <g.singh@nxp.com>\nAcked-by: Nipun Gupta <nipun.gupta@nxp.com>\nAcked-by: Akhil Goyal <akhil.goyal@nxp.com>\n---\n MAINTAINERS | 1 +\n doc/guides/nics/features/ppfe.ini | 1 +\n doc/guides/nics/index.rst | 1 +\n doc/guides/nics/ppfe.rst | 173 ++++++++++++++++++++++++++++++\n 4 files changed, 176 insertions(+)\n create mode 100644 doc/guides/nics/ppfe.rst", "diff": "diff --git a/MAINTAINERS b/MAINTAINERS\nindex 655ccae83..83af78144 100644\n--- a/MAINTAINERS\n+++ b/MAINTAINERS\n@@ -790,6 +790,7 @@ F: doc/guides/nics/features/enetc.ini\n NXP ppfe\n M: Gagandeep Singh <g.singh@nxp.com>\n M: Akhil Goyal <akhil.goyal@nxp.com>\n+F: doc/guides/nics/ppfe.rst\n F: drivers/net/ppfe/\n F: doc/guides/nics/features/ppfe.ini\n \ndiff --git a/doc/guides/nics/features/ppfe.ini b/doc/guides/nics/features/ppfe.ini\nindex 4bcac779c..cd5f836a3 100644\n--- a/doc/guides/nics/features/ppfe.ini\n+++ b/doc/guides/nics/features/ppfe.ini\n@@ -6,3 +6,4 @@\n [Features]\n Linux VFIO = Y\n ARMv8 = Y\n+Usage doc = Y\ndiff --git a/doc/guides/nics/index.rst b/doc/guides/nics/index.rst\nindex d477001d9..e0c931a3e 100644\n--- a/doc/guides/nics/index.rst\n+++ b/doc/guides/nics/index.rst\n@@ -48,6 +48,7 @@ Network Interface Controller Drivers\n nfp\n octeontx\n octeontx2\n+ ppfe\n qede\n sfc_efx\n softnic\ndiff --git a/doc/guides/nics/ppfe.rst b/doc/guides/nics/ppfe.rst\nnew file mode 100644\nindex 000000000..29b02957f\n--- /dev/null\n+++ b/doc/guides/nics/ppfe.rst\n@@ -0,0 +1,173 @@\n+.. SPDX-License-Identifier: BSD-3-Clause\n+ Copyright 2019 NXP\n+\n+PPFE Poll Mode Driver\n+======================\n+\n+The PPFE NIC PMD (**librte_pmd_ppfe**) provides poll mode driver\n+support for the inbuilt NIC found in the **NXP LS1012** SoC.\n+\n+More information can be found at `NXP Official Website\n+<https://nxp.com/ls1012a>`_.\n+\n+PPFE\n+-----\n+\n+This section provides an overview of the NXP PPFE\n+and how it is integrated into the DPDK.\n+\n+Contents summary\n+\n+- PPFE overview\n+- PPFE features\n+- Supported PPFE SoCs\n+- Prerequisites\n+- Driver compilation and testing\n+- Limitations\n+\n+PPFE Overview\n+~~~~~~~~~~~~~~\n+\n+PPFE is a hardware programmable packet forwarding engine to provide\n+high performance Ethernet interfaces. The diagram below shows a\n+system level overview of PPFE:\n+\n+.. code-block:: console\n+\n+ ====================================================+===============\n+ US +-----------------------------------------+ | Kernel Space\n+ | | |\n+ | PPFE Ethernet Driver | |\n+ +-----------------------------------------+ |\n+ ^ | ^ | |\n+ PPFE RXQ| |TXQ RXQ| |TXQ |\n+ PMD | | | | |\n+ | v | v | +----------+\n+ +---------+ +----------+ | | pfe.ko |\n+ | pfe_eth0| | pfe_eth1 | | +----------+\n+ +---------+ +----------+ |\n+ ^ | ^ | |\n+ TXQ| |RXQ TXQ| |RXQ |\n+ | | | | |\n+ | v | v |\n+ +------------------------+ |\n+ | | |\n+ | PPFE HIF driver | |\n+ +------------------------+ |\n+ ^ | |\n+ RX | TX | |\n+ RING| RING| |\n+ | v |\n+ +--------------+ |\n+ | | |\n+ ==================| HIF |==================+===============\n+ +-----------+ +--------------+\n+ | | | | HW\n+ | PPFE +--------------+ |\n+ | +-----+ +-----+ |\n+ | | MAC | | MAC | |\n+ | | | | | |\n+ +-------+-----+----------------+-----+----+\n+ | PHY | | PHY |\n+ +-----+ +-----+\n+\n+\n+The HIF, PPFE, MAC and PHY are the hardware blocks, the pfe.ko is a kernel\n+module, the PPFE HIF driver and the PPFE ethernet driver combined represent\n+as DPDK PPFE poll mode driver are running in the userspace.\n+\n+The PPFE hardware supports one HIF (host interface) RX ring and one TX ring\n+to send and receive packets through packet forwarding engine. Both network\n+interface traffic is multiplexed and send over HIF queue.\n+\n+pfe_eth0 and pfe_eth1 are logical ethernet interfaces, created by HIF client\n+driver. HIF driver is responsible for send and receive packets between\n+host interface and these logical interfaces. PPFE ethernet driver is a\n+hardware independent and register with the HIF client driver to transmit and\n+receive packets from HIF via logical interfaces.\n+\n+pfe.ko is required for PHY initialisation and also responsible for creating\n+the character device \"pfe_us_cdev\" which will be used for interacting with\n+the kernel layer for link status.\n+\n+PPFE Features\n+~~~~~~~~~~~~~~\n+\n+- ARMv8\n+\n+Supported PPFE SoCs\n+~~~~~~~~~~~~~~~~~~~~\n+\n+- LS1012\n+\n+Prerequisites\n+~~~~~~~~~~~~~\n+\n+Below are some pre-requisites for executing PPFE PMD on a PPFE\n+compatible board:\n+\n+1. **ARM 64 Tool Chain**\n+\n+ For example, the `*aarch64* Linaro Toolchain <https://releases.linaro.org/components/toolchain/binaries/7.3-2018.05/aarch64-linux-gnu/gcc-linaro-7.3.1-2018.05-i686_aarch64-linux-gnu.tar.xz>`_.\n+\n+2. **Linux Kernel**\n+\n+ It can be obtained from `NXP's Github hosting <https://source.codeaurora.org/external/qoriq/qoriq-components/linux>`_.\n+\n+3. **Rootfile system**\n+\n+ Any *aarch64* supporting filesystem can be used. For example,\n+ Ubuntu 16.04 LTS (Xenial) or 18.04 (Bionic) userland which can be obtained\n+ from `here <http://cdimage.ubuntu.com/ubuntu-base/releases/18.04/release/ubuntu-base-18.04.1-base-arm64.tar.gz>`_.\n+\n+4. The ethernet device will be registered as virtual device, so ppfe has dependency on\n+ **rte_bus_vdev** library and it is mandatory to use `--vdev` with value `eth_pfe` to\n+ run DPDK application.\n+\n+The following dependencies are not part of DPDK and must be installed\n+separately:\n+\n+- **NXP Linux LSDK**\n+\n+ NXP Layerscape software development kit (LSDK) includes support for family\n+ of QorIQ® ARM-Architecture-based system on chip (SoC) processors\n+ and corresponding boards.\n+\n+ It includes the Linux board support packages (BSPs) for NXP SoCs,\n+ a fully operational tool chain, kernel and board specific modules.\n+\n+ LSDK and related information can be obtained from: `LSDK <https://www.nxp.com/support/developer-resources/run-time-software/linux-software-and-development-tools/layerscape-software-development-kit:LAYERSCAPE-SDK>`_\n+\n+- **pfe kernel module**\n+\n+ pfe kernel module can be obtained from NXP Layerscape software development kit at\n+ location `/lib/modules/<kernel version>/kernel/drivers/staging/fsl_ppfe` in rootfs.\n+ Module should be loaded using below command:\n+\n+ .. code-block:: console\n+\n+ insmod pfe.ko us=1\n+\n+\n+Driver compilation and testing\n+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n+\n+Follow instructions available in the document\n+:ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`\n+to launch **testpmd**\n+\n+Additionally, PPFE driver needs `--vdev` as an input with value `eth_pfe`\n+to execute DPDK application. There is an optional parameter `intf` available\n+to specify port ID. PPFE driver supports only two interfaces, so valid values\n+for `intf` are 0 and 1.\n+see the command below:\n+\n+ .. code-block:: console\n+\n+ <dpdk app> <EAL args> --vdev=\"eth_pfe0,intf=0\" --vdev=\"eth_pfe1,intf=1\" -- ...\n+\n+\n+Limitations\n+~~~~~~~~~~~\n+\n+- Multi buffer pool cannot be supported.\n", "prefixes": [ "v3", "03/14" ] }