diff mbox

[dpdk-dev,20/20] doc: add NXP DPAA2 EVENTDEV details

Message ID 1495735671-4917-21-git-send-email-nipun.gupta@nxp.com (mailing list archive)
State Superseded, archived
Delegated to: Jerin Jacob
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Nipun Gupta May 25, 2017, 6:07 p.m. UTC 
  Signed-off-by: Nipun Gupta <nipun.gupta@nxp.com>
---
 MAINTAINERS                    |   1 +
 doc/guides/eventdevs/dpaa2.rst | 157 +++++++++++++++++++++++++++++++++++++++++
 2 files changed, 158 insertions(+)
 create mode 100644 doc/guides/eventdevs/dpaa2.rst

Comments

Jerin Jacob May 31, 2017, 3:58 p.m. UTC | #1 
-----Original Message-----
> Date: Thu, 25 May 2017 23:37:51 +0530
> From: Nipun Gupta <nipun.gupta@nxp.com>
> To: dev@dpdk.org
> CC: hemant.agrawal@nxp.com, jerin.jacob@caviumnetworks.com,
>  harry.van.haaren@intel.com, bruce.richardson@intel.com,
>  gage.eads@intel.com, shreyansh.jain@nxp.com, Nipun Gupta
>  <nipun.gupta@nxp.com>
> Subject: [PATCH 20/20] doc: add NXP DPAA2 EVENTDEV details
> X-Mailer: git-send-email 1.9.1
> 
> Signed-off-by: Nipun Gupta <nipun.gupta@nxp.com>
> ---
>  MAINTAINERS                    |   1 +
>  doc/guides/eventdevs/dpaa2.rst | 157 +++++++++++++++++++++++++++++++++++++++++
>  2 files changed, 158 insertions(+)
>  create mode 100644 doc/guides/eventdevs/dpaa2.rst
> 
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 45e284e..9c9095b 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -584,6 +584,7 @@ NXP DPAA2 Eventdev PMD
>  M: Hemant Agrawal <hemant.agrawal@nxp.com>
>  M: Nipun Gupta <nipun.gupta@nxp.com>
>  F: drivers/event/dpaa2/
> +F: doc/guides/eventdevs/dpaa2.rst
>  
>  Packet processing
>  -----------------
> +
> +To compile the DPAA2 EVENTDEV PMD for Linux arm64 gcc target, run the
> +following ``make`` command:
> +
> +.. code-block:: console
> +
> +   cd <DPDK-source-directory>
> +   make config T=arm64-dpaa2-linuxapp-gcc install

It nice to mention your PMD driver vdev name in the document.

> +
> +Limitations
> +-----------
> +
> +Platform Requirement
> +~~~~~~~~~~~~~~~~~~~~
> +
> +DPAA2 drivers for DPDK can only work on NXP SoCs as listed in the
> +``Supported DPAA2 SoCs``.
> +
> +Port-core binding
> +~~~~~~~~~~~~~~~~~
> +
> +DPAA2 EVENTDEV driver requires event port 'x' to be used on core 'x'.

Is it a HW limitation? or Is it like, only one port can connect to one
lcore. If it latter, then I think, you can have physical port to virtual
port translation in slow path as ports are enumerated as 0 to N. lcore
id can be anything.


> -- 
> 1.9.1
>
Nipun Gupta June 1, 2017, 12:07 p.m. UTC | #2 
> -----Original Message-----
> From: Jerin Jacob [mailto:jerin.jacob@caviumnetworks.com]
> Sent: Wednesday, May 31, 2017 21:28
> To: Nipun Gupta <nipun.gupta@nxp.com>
> Cc: dev@dpdk.org; Hemant Agrawal <hemant.agrawal@nxp.com>;
> harry.van.haaren@intel.com; bruce.richardson@intel.com;
> gage.eads@intel.com; Shreyansh Jain <shreyansh.jain@nxp.com>
> Subject: Re: [PATCH 20/20] doc: add NXP DPAA2 EVENTDEV details
> 
> -----Original Message-----
> > Date: Thu, 25 May 2017 23:37:51 +0530
> > From: Nipun Gupta <nipun.gupta@nxp.com>
> > To: dev@dpdk.org
> > CC: hemant.agrawal@nxp.com, jerin.jacob@caviumnetworks.com,
> >  harry.van.haaren@intel.com, bruce.richardson@intel.com,
> >  gage.eads@intel.com, shreyansh.jain@nxp.com, Nipun Gupta
> >  <nipun.gupta@nxp.com>
> > Subject: [PATCH 20/20] doc: add NXP DPAA2 EVENTDEV details
> > X-Mailer: git-send-email 1.9.1
> >
> > Signed-off-by: Nipun Gupta <nipun.gupta@nxp.com>
> > ---
> >  MAINTAINERS                    |   1 +
> >  doc/guides/eventdevs/dpaa2.rst | 157
> +++++++++++++++++++++++++++++++++++++++++
> >  2 files changed, 158 insertions(+)
> >  create mode 100644 doc/guides/eventdevs/dpaa2.rst
> >
> > diff --git a/MAINTAINERS b/MAINTAINERS
> > index 45e284e..9c9095b 100644
> > --- a/MAINTAINERS
> > +++ b/MAINTAINERS
> > @@ -584,6 +584,7 @@ NXP DPAA2 Eventdev PMD
> >  M: Hemant Agrawal <hemant.agrawal@nxp.com>
> >  M: Nipun Gupta <nipun.gupta@nxp.com>
> >  F: drivers/event/dpaa2/
> > +F: doc/guides/eventdevs/dpaa2.rst
> >
> >  Packet processing
> >  -----------------
> > +
> > +To compile the DPAA2 EVENTDEV PMD for Linux arm64 gcc target, run the
> > +following ``make`` command:
> > +
> > +.. code-block:: console
> > +
> > +   cd <DPDK-source-directory>
> > +   make config T=arm64-dpaa2-linuxapp-gcc install
> 
> It nice to mention your PMD driver vdev name in the document.
> 
> > +
> > +Limitations
> > +-----------
> > +
> > +Platform Requirement
> > +~~~~~~~~~~~~~~~~~~~~
> > +
> > +DPAA2 drivers for DPDK can only work on NXP SoCs as listed in the
> > +``Supported DPAA2 SoCs``.
> > +
> > +Port-core binding
> > +~~~~~~~~~~~~~~~~~
> > +
> > +DPAA2 EVENTDEV driver requires event port 'x' to be used on core 'x'.
> 
> Is it a HW limitation? or Is it like, only one port can connect to one
> lcore. If it latter, then I think, you can have physical port to virtual
> port translation in slow path as ports are enumerated as 0 to N. lcore
> id can be anything.

Appreciate your suggestion, but right now our event driver limits this.
This is because core needs to be known at event port setup.
As event port setup is done at initialization time, we need to have this limitation.
We are having discussions to somehow do away with this.

Thanks,
Nipun

> 
> 
> > --
> > 1.9.1
> >
diff mbox

Patch

diff --git a/MAINTAINERS b/MAINTAINERS
index 45e284e..9c9095b 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -584,6 +584,7 @@  NXP DPAA2 Eventdev PMD
 M: Hemant Agrawal <hemant.agrawal@nxp.com>
 M: Nipun Gupta <nipun.gupta@nxp.com>
 F: drivers/event/dpaa2/
+F: doc/guides/eventdevs/dpaa2.rst
 
 Packet processing
 -----------------
diff --git a/doc/guides/eventdevs/dpaa2.rst b/doc/guides/eventdevs/dpaa2.rst
new file mode 100644
index 0000000..42453b2
--- /dev/null
+++ b/doc/guides/eventdevs/dpaa2.rst
@@ -0,0 +1,157 @@ 
+..  BSD LICENSE
+    Copyright 2017 NXP.
+
+    Redistribution and use in source and binary forms, with or without
+    modification, are permitted provided that the following conditions
+    are met:
+
+    * Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in
+    the documentation and/or other materials provided with the
+    distribution.
+    * Neither the name of NXP nor the names of its
+    contributors may be used to endorse or promote products derived
+    from this software without specific prior written permission.
+
+    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+    OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+    LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+NXP DPAA2 Eventdev Driver
+==================================
+
+The dpaa2 eventdev is an implementation of the eventdev API, that provides a
+wide range of the eventdev features. The eventdev relies on a dpaa2 hw to
+perform event scheduling.
+
+More information can be found at `NXP Official Website
+<http://www.nxp.com/products/microcontrollers-and-processors/arm-processors/qoriq-arm-processors:QORIQ-ARM>`_.
+
+Features
+--------
+
+The DPAA2 EVENTDEV implements many features in the eventdev API;
+
+- Hardware based event scheduler
+- 8 event ports
+- 8 event queues
+- Parallel flows
+- Atomic flows
+
+Supported DPAA2 SoCs
+--------------------
+
+- LS2080A/LS2040A
+- LS2084A/LS2044A
+- LS2088A/LS2048A
+- LS1088A/LS1048A
+
+Prerequisites
+-------------
+
+There are three main pre-requisities for executing DPAA2 EVENTDEV on a DPAA2
+compatible board:
+
+1. **ARM 64 Tool Chain**
+
+   For example, the `*aarch64* Linaro Toolchain <https://releases.linaro.org/components/toolchain/binaries/4.9-2017.01/aarch64-linux-gnu>`_.
+
+2. **Linux Kernel**
+
+   It can be obtained from `NXP's Github hosting <https://github.com/qoriq-open-source/linux>`_.
+
+3. **Rootfile system**
+
+   Any *aarch64* supporting filesystem can be used. For example,
+   Ubuntu 15.10 (Wily) or 16.04 LTS (Xenial) userland which can be obtained
+   from `here <http://cdimage.ubuntu.com/ubuntu-base/releases/16.04/release/ubuntu-base-16.04.1-base-arm64.tar.gz>`_.
+
+As an alternative method, DPAA2 EVENTDEV can also be executed using images provided
+as part of SDK from NXP. The SDK includes all the above prerequisites necessary
+to bring up a DPAA2 board.
+
+The following dependencies are not part of DPDK and must be installed
+separately:
+
+- **NXP Linux SDK**
+
+  NXP Linux software development kit (SDK) includes support for family
+  of QorIQ® ARM-Architecture-based system on chip (SoC) processors
+  and corresponding boards.
+
+  It includes the Linux board support packages (BSPs) for NXP SoCs,
+  a fully operational tool chain, kernel and board specific modules.
+
+  SDK and related information can be obtained from:  `NXP QorIQ SDK  <http://www.nxp.com/products/software-and-tools/run-time-software/linux-sdk/linux-sdk-for-qoriq-processors:SDKLINUX>`_.
+
+- **DPDK Helper Scripts**
+
+  DPAA2 based resources can be configured easily with the help of ready scripts
+  as provided in the DPDK helper repository.
+
+  `DPDK Helper Scripts <https://github.com/qoriq-open-source/dpdk-helper>`_.
+
+Currently supported by DPDK:
+
+- NXP SDK **2.0+**.
+- MC Firmware version **10.0.0** and higher.
+- Supported architectures:  **arm64 LE**.
+
+- Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
+
+.. note::
+
+   Some part of fslmc bus code (mc flib - object library) routines are
+   dual licensed (BSD & GPLv2).
+
+Pre-Installation Configuration
+------------------------------
+
+Config File Options
+~~~~~~~~~~~~~~~~~~~
+
+The following options can be modified in the ``config`` file.
+Please note that enabling debugging options may affect system performance.
+
+- ``CONFIG_RTE_LIBRTE_PMD_DPAA2_EVENTDEV`` (default ``y``)
+
+  Toggle compilation of the ``lrte_pmd_dpaa2_event`` driver.
+
+- ``CONFIG_RTE_LIBRTE_PMD_DPAA2_EVENTDEV_DEBUG`` (default ``n``)
+
+  Toggle display of generic debugging messages
+
+Driver Compilation
+~~~~~~~~~~~~~~~~~~
+
+To compile the DPAA2 EVENTDEV PMD for Linux arm64 gcc target, run the
+following ``make`` command:
+
+.. code-block:: console
+
+   cd <DPDK-source-directory>
+   make config T=arm64-dpaa2-linuxapp-gcc install
+
+Limitations
+-----------
+
+Platform Requirement
+~~~~~~~~~~~~~~~~~~~~
+
+DPAA2 drivers for DPDK can only work on NXP SoCs as listed in the
+``Supported DPAA2 SoCs``.
+
+Port-core binding
+~~~~~~~~~~~~~~~~~
+
+DPAA2 EVENTDEV driver requires event port 'x' to be used on core 'x'.