[dpdk-dev,v2,12/12] doc: add DPAA eventdev guide
Checks
Commit Message
Signed-off-by: Sunil Kumar Kori <sunil.kori@nxp.com>
---
MAINTAINERS | 1 +
doc/guides/eventdevs/dpaa.rst | 144 +++++++++++++++++++++++++++++++++++++++++
doc/guides/eventdevs/index.rst | 1 +
3 files changed, 146 insertions(+)
create mode 100644 doc/guides/eventdevs/dpaa.rst
Comments
-----Original Message-----
> Date: Fri, 22 Dec 2017 20:47:25 +0530
> From: Sunil Kumar Kori <sunil.kori@nxp.com>
> To: jerin.jacob@caviumnetworks.com
> CC: dev@dpdk.org, hemant.agrawal@nxp.com
> Subject: [PATCH v2 12/12] doc: add DPAA eventdev guide
> X-Mailer: git-send-email 2.9.3
>
> Signed-off-by: Sunil Kumar Kori <sunil.kori@nxp.com>
> +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_DPAA_EVENTDEV`` (default ``y``)
> +
> + Toggle compilation of the ``librte_pmd_dpaa_event`` driver.
> +
> +- ``CONFIG_RTE_LIBRTE_PMD_DPAA_EVENTDEV_DEBUG`` (default ``n``)
Looks like CONFIG_RTE_LIBRTE_PMD_DPAA_EVENTDEV_DEBUG option is removed in the series.
In general this series looks good to me. It would be good if someone from NXP ACK the
driver code so that I can pull the to next-event tree.
/Jerin
> Looks like CONFIG_RTE_LIBRTE_PMD_DPAA_EVENTDEV_DEBUG option is
> removed in the series.
>
> In general this series looks good to me. It would be good if someone from
> NXP ACK the driver code so that I can pull the to next-event tree.
>
[Hemant] I am reviewing and will complete the review by tomorrow.
> /Jerin
On 1/8/2018 7:43 PM, Hemant Agrawal wrote:
>
>> Looks like CONFIG_RTE_LIBRTE_PMD_DPAA_EVENTDEV_DEBUG option is
>> removed in the series.
>>
>> In general this series looks good to me. It would be good if someone from
>> NXP ACK the driver code so that I can pull the to next-event tree.
>>
>
> [Hemant] I am reviewing and will complete the review by tomorrow.
>
>> /Jerin
>
Hi Sunil,
Please update the cover letter with dependency on the DPAA PMD
improvements (v3) patches. Also you may have to do minor tweak to
cleanly apply the patches on v3.
Once you fix Jerin's comment, you can add my ack to your patches.
regards,
Acked-by: Hemant Agrawal <hemant.agrawal@nxp.com>
-----Original Message-----
> Date: Wed, 10 Jan 2018 17:40:41 +0530
> From: Hemant Agrawal <hemant.agrawal@nxp.com>
> To: Jerin Jacob <jerin.jacob@caviumnetworks.com>, Sunil Kumar Kori
> <sunil.kori@nxp.com>
> CC: "dev@dpdk.org" <dev@dpdk.org>
> Subject: Re: [PATCH v2 12/12] doc: add DPAA eventdev guide
> User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64; rv:45.0) Gecko/20100101
> Thunderbird/45.8.0
>
> On 1/8/2018 7:43 PM, Hemant Agrawal wrote:
> >
> > > Looks like CONFIG_RTE_LIBRTE_PMD_DPAA_EVENTDEV_DEBUG option is
> > > removed in the series.
> > >
> > > In general this series looks good to me. It would be good if someone from
> > > NXP ACK the driver code so that I can pull the to next-event tree.
> > >
> >
> > [Hemant] I am reviewing and will complete the review by tomorrow.
> >
> > > /Jerin
> >
> Hi Sunil,
> Please update the cover letter with dependency on the DPAA PMD
> improvements (v3) patches. Also you may have to do minor tweak to cleanly
> apply the patches on v3.
>
> Once you fix Jerin's comment, you can add my ack to your patches.
> regards,
>
> Acked-by: Hemant Agrawal <hemant.agrawal@nxp.com>
Sunil,
In v3, Please rebase to latest next-eventdev tree to add new capabilities for this PMD.
reference change for dpaa2:
http://dpdk.org/browse/next/dpdk-next-eventdev/commit/?id=0011b9c531e6ed83069e357ccdc89f956a6d37db
>
-----Original Message-----
> Date: Wed, 10 Jan 2018 23:53:53 +0530
> From: Jerin Jacob <jerin.jacob@caviumnetworks.com>
> To: Hemant Agrawal <hemant.agrawal@nxp.com>
> CC: Sunil Kumar Kori <sunil.kori@nxp.com>, "dev@dpdk.org" <dev@dpdk.org>
> Subject: Re: [dpdk-dev] [PATCH v2 12/12] doc: add DPAA eventdev guide
> User-Agent: Mutt/1.9.2 (2017-12-15)
>
> -----Original Message-----
> > Date: Wed, 10 Jan 2018 17:40:41 +0530
> > From: Hemant Agrawal <hemant.agrawal@nxp.com>
> > To: Jerin Jacob <jerin.jacob@caviumnetworks.com>, Sunil Kumar Kori
> > <sunil.kori@nxp.com>
> > CC: "dev@dpdk.org" <dev@dpdk.org>
> > Subject: Re: [PATCH v2 12/12] doc: add DPAA eventdev guide
> > User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64; rv:45.0) Gecko/20100101
> > Thunderbird/45.8.0
> >
> > On 1/8/2018 7:43 PM, Hemant Agrawal wrote:
> > >
> > > > Looks like CONFIG_RTE_LIBRTE_PMD_DPAA_EVENTDEV_DEBUG option is
> > > > removed in the series.
> > > >
> > > > In general this series looks good to me. It would be good if someone from
> > > > NXP ACK the driver code so that I can pull the to next-event tree.
> > > >
> > >
> > > [Hemant] I am reviewing and will complete the review by tomorrow.
> > >
> > > > /Jerin
> > >
> > Hi Sunil,
> > Please update the cover letter with dependency on the DPAA PMD
> > improvements (v3) patches. Also you may have to do minor tweak to cleanly
> > apply the patches on v3.
> >
> > Once you fix Jerin's comment, you can add my ack to your patches.
> > regards,
> >
> > Acked-by: Hemant Agrawal <hemant.agrawal@nxp.com>
>
> Sunil,
>
> In v3, Please rebase to latest next-eventdev tree to add new capabilities for this PMD.
> reference change for dpaa2:
> http://dpdk.org/browse/next/dpdk-next-eventdev/commit/?id=0011b9c531e6ed83069e357ccdc89f956a6d37db
I would like to include your driver for next-event-rc1 pull request. Could you please send the v3?
>
> >
@@ -696,6 +696,7 @@ NXP DPAA eventdev
M: Hemant Agrawal <hemant.agrawal@nxp.com>
M: Sunil Kumar Kori <sunil.kori@nxp.com>
F: drivers/event/dpaa/
+F: doc/guides/eventdevs/dpaa.rst
Software Eventdev PMD
M: Harry van Haaren <harry.van.haaren@intel.com>
new file mode 100644
@@ -0,0 +1,144 @@
+.. SPDX-License-Identifier: BSD-3-Clause
+ Copyright 2017 NXP
+
+NXP DPAA Eventdev Driver
+=========================
+
+The dpaa eventdev is an implementation of the eventdev API, that provides a
+wide range of the eventdev features. The eventdev relies on a dpaa based
+platform 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 DPAA EVENTDEV implements many features in the eventdev API;
+
+- Hardware based event scheduler
+- 4 event ports
+- 4 event queues
+- Parallel flows
+- Atomic flows
+
+Supported DPAA SoCs
+--------------------
+
+- LS1046A
+- LS1043A
+
+Prerequisites
+-------------
+
+There are following pre-requisites for executing EVENTDEV on a DPAA compatible
+platform:
+
+1. **ARM 64 Tool Chain**
+
+ For example, the `*aarch64* Linaro Toolchain <https://releases.linaro.org/components/toolchain/binaries/6.4-2017.08/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, DPAA 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 DPAA 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 Extra Scripts**
+
+ DPAA based resources can be configured easily with the help of ready to use
+ xml files as provided in the DPDK Extra repository.
+
+ `DPDK Extras Scripts <https://github.com/qoriq-open-source/dpdk-extras>`_.
+
+Currently supported by DPDK:
+
+- NXP SDK **2.0+** or LSDK **17.09+**
+- Supported architectures: **arm64 LE**.
+
+- Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
+
+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_DPAA_EVENTDEV`` (default ``y``)
+
+ Toggle compilation of the ``librte_pmd_dpaa_event`` driver.
+
+- ``CONFIG_RTE_LIBRTE_PMD_DPAA_EVENTDEV_DEBUG`` (default ``n``)
+
+ Toggle display of generic debugging messages
+
+Driver Compilation
+~~~~~~~~~~~~~~~~~~
+
+To compile the DPAA EVENTDEV PMD for Linux arm64 gcc target, run the
+following ``make`` command:
+
+.. code-block:: console
+
+ cd <DPDK-source-directory>
+ make config T=arm64-dpaa-linuxapp-gcc install
+
+Initialization
+--------------
+
+The dpaa eventdev is exposed as a vdev device which consists of a set of channels
+and queues. On EAL initialization, dpaa components will be
+probed and then vdev device can be created from the application code by
+
+* Invoking ``rte_vdev_init("event_dpaa")`` from the application
+
+* Using ``--vdev="event_dpaa"`` in the EAL options, which will call
+ rte_vdev_init() internally
+
+Example:
+
+.. code-block:: console
+
+ ./your_eventdev_application --vdev="event_dpaa"
+
+Limitations
+-----------
+
+1. DPAA eventdev can not work with DPAA PUSH mode queues configured for ethdev.
+ Please configure export DPAA_NUM_PUSH_QUEUES=0
+
+Platform Requirement
+~~~~~~~~~~~~~~~~~~~~
+
+DPAA drivers for DPDK can only work on NXP SoCs as listed in the
+``Supported DPAA SoCs``.
+
+Port-core Binding
+~~~~~~~~~~~~~~~~~
+
+DPAA EVENTDEV driver requires event port 'x' to be used on core 'x'.
@@ -38,5 +38,6 @@ application trough the eventdev API.
:numbered:
dpaa2
+ dpaa
sw
octeontx