From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from NAM01-BN3-obe.outbound.protection.outlook.com (mail-bn3nam01on0060.outbound.protection.outlook.com [104.47.33.60]) by dpdk.org (Postfix) with ESMTP id 8D44A1B211 for ; Tue, 16 Jan 2018 12:43:39 +0100 (CET) Received: from BN6PR03CA0021.namprd03.prod.outlook.com (10.168.230.159) by MWHPR03MB2701.namprd03.prod.outlook.com (10.168.207.135) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P256) id 15.20.407.7; Tue, 16 Jan 2018 11:43:38 +0000 Received: from BN1BFFO11FD026.protection.gbl (2a01:111:f400:7c10::1:147) by BN6PR03CA0021.outlook.office365.com (2603:10b6:404:23::31) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384) id 15.20.407.7 via Frontend Transport; Tue, 16 Jan 2018 11:43:38 +0000 Authentication-Results: spf=fail (sender IP is 192.88.168.50) smtp.mailfrom=nxp.com; NXP1.onmicrosoft.com; dkim=none (message not signed) header.d=none;NXP1.onmicrosoft.com; dmarc=fail action=none header.from=nxp.com; Received-SPF: Fail (protection.outlook.com: domain of nxp.com does not designate 192.88.168.50 as permitted sender) receiver=protection.outlook.com; client-ip=192.88.168.50; helo=tx30smr01.am.freescale.net; Received: from tx30smr01.am.freescale.net (192.88.168.50) by BN1BFFO11FD026.mail.protection.outlook.com (10.58.144.89) with Microsoft SMTP Server (version=TLS1_0, cipher=TLS_RSA_WITH_AES_256_CBC_SHA) id 15.20.345.12 via Frontend Transport; Tue, 16 Jan 2018 11:43:38 +0000 Received: from b27504-OptiPlex-790.ap.freescale.net (b27504-OptiPlex-790.ap.freescale.net [10.232.132.60]) by tx30smr01.am.freescale.net (8.14.3/8.14.0) with ESMTP id w0GBgtjW014705; Tue, 16 Jan 2018 04:43:35 -0700 From: Nipun Gupta To: CC: , , Date: Tue, 16 Jan 2018 23:28:05 +0530 Message-ID: <1516125485-28919-13-git-send-email-nipun.gupta@nxp.com> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1516125485-28919-1-git-send-email-nipun.gupta@nxp.com> References: <20171215130828.14218-1-sunil.kori@nxp.com> <1516125485-28919-1-git-send-email-nipun.gupta@nxp.com> MIME-Version: 1.0 Content-Type: text/plain; charset="y" Content-Transfer-Encoding: 8bit X-EOPAttributedMessage: 0 X-Matching-Connectors: 131605766182601172; (91ab9b29-cfa4-454e-5278-08d120cd25b8); () X-Forefront-Antispam-Report: CIP:192.88.168.50; IPV:NLI; CTRY:US; EFV:NLI; SFV:NSPM; SFS:(10009020)(346002)(376002)(39860400002)(39380400002)(396003)(2980300002)(1109001)(1110001)(339900001)(189003)(199004)(106466001)(86362001)(105606002)(36756003)(85426001)(50466002)(47776003)(50226002)(68736007)(8936002)(104016004)(81156014)(81166006)(8676002)(97736004)(305945005)(356003)(296002)(316002)(54906003)(76176011)(77096006)(4326008)(5660300001)(2351001)(26005)(6666003)(2950100002)(6916009)(2906002)(2870700001)(498600001)(53936002)(6306002)(8656006); DIR:OUT; SFP:1101; SCL:1; SRVR:MWHPR03MB2701; H:tx30smr01.am.freescale.net; FPR:; SPF:Fail; PTR:InfoDomainNonexistent; MX:1; A:1; LANG:en; X-Microsoft-Exchange-Diagnostics: 1; BN1BFFO11FD026; 1:SB+xhhhNB+aocNjvbZhTRs2XqA9qWMXn4P0EsourhgxKDkWoQmneo+Z+4N5OuuX7JytIyIfRpjKZ3DaaV+akjMAv7r2CWrupTyXzanm2rC9pXRK8DZfiZJoyqGf5pFfY X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: 7aa8f42c-7877-43ee-01d4-08d55cd6622c X-Microsoft-Antispam: UriScan:; BCL:0; PCL:0; RULEID:(7020095)(5600026)(4604075)(2017052603307); SRVR:MWHPR03MB2701; X-Microsoft-Exchange-Diagnostics: 1; MWHPR03MB2701; 3:4ZeEHzpikB3bqKVaFFtRcKfmiU2HEEVoAczRZZDdtZS19jh8BjAJ87Rz7vkFg6JgL0+u3lWVyHzRa7o+RqciWwgFLlMGzlz/z0BDF42Ka34NEzAOzCh+8jvIFaoLmyYcm4wLjJm7o/SjGlfYKjac4T0HQe0AzWlK5VC3q4D0EW02BlXzZcdb36EpokeboQked9gjQWvQ7AhM1rz8y38UNUM2/OgvCv8bq/kDAMNneoDVO4QIhYBbpcXagngIBXfbzocA9x/XuepDOW6r5eO6iiiNvhfMXZJIeNIJvJ5TNMXfLYNbKWs6GESokHhcGEWI/lTZFIqWrdWDHU5jD0kdHdBKWtSDTm2ePhj6iqBOclo=; 25:IFI+Th7V19jvHcNCmn/E6OsSunV2KCYhLOWy8O1ALqyDUswcMBacpqIHC3f3y5/uN1dU3rHxUcoibex4xZVXTFx3LMSkHUSOb49/1P21XFiHHlyDtsqYMmdsLBp0tuSp3LJGB15l2qwj0ymQ2RBiBheDa0+7h5sIBPd/zQt1149VZUoYZwnsSVEwmWnVSloZYKU+zkjlGE8HWAppJo5xOyITMvumPBg2ngmRPT+JpuudDjmwN0n9du3r2C2RKPoxF24ZShDObxiym1ivxYLcOXZyIqHJbnflzTZXLLvSSM2Y9Y9P1cMZ0fcqGtZezc8QrZqoi+80t1TNNavHSX3pWQ== X-MS-TrafficTypeDiagnostic: MWHPR03MB2701: X-Microsoft-Exchange-Diagnostics: 1; MWHPR03MB2701; 31:AN3N73RujwDggqja7BDFrdCiUg9tlrXOGv0NBoFi/1sfk1gIimClCedyoyoOtUe3cMZejMdiTWcVnACWnquMc29nlix5MXhKIobrQU/QqGfHZ+M0sfozJRI6UZAPMqzOpHs1zF11pr4BHZjAh/9CgXD0VWrAjPjo5YqA/HnhphX/a6a2pSKDB+Wkwasnp6gzTFIaUMP8gsl3CoY79hDYm3CoEh2GTFVZdODOX+/LA+I=; 4:eTEpEjUyNhnmx0eIkUiLrtG8MkgxkIg6jS42iWVGZgbzAHm3GQT+jHIOMH5nc+t1m9TBjwPG61T7fEs68hK3neuCeYYVBxIWid19Sw+hw+YjRBodr1NTsHV0177rwScV2t6gFdn4rYBDqAKL0Az9qCcweAJH3p9VHPncXggInio9ngm9Gp5AUoYG0o8Envb+LBx2QJfbF5yLIl2p4DXAmoh74mzt8fKEPTWtCp03gQ45fUGjYe5ey+OWERQpWRkcbUafPCjHzQ2r4JDudy3RoURZEQcX2CO6//SNwv7ETzcAKgrctsIENRP5SHp8YB9w61fWpzF7gbB0l6vVnvSxBtZaD4eDnJ9nHp45fNF20D4Uqf53b6Fui9VMqnNAmJP3lehM2TLnrY589/xS/Tz3rMKZGmY5+dq2Lm0MJAfJvEw= X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-Test: UriScan:(166708455590820)(185117386973197)(264314650089876)(228905959029699); X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0; RULEID:(6095135)(2401047)(8121501046)(5005006)(3002001)(93006095)(93001095)(3231023)(944501161)(10201501046)(6055026)(6096035)(201703131430075)(201703131520075)(201703131448075)(201703131433075)(201703151042153)(20161123559100)(20161123561025)(20161123565025)(20161123556025)(20161123563025)(201708071742011); SRVR:MWHPR03MB2701; BCL:0; PCL:0; RULEID:(100000803101)(100110400095)(400006); SRVR:MWHPR03MB2701; X-Forefront-PRVS: 0554B1F54F X-Microsoft-Exchange-Diagnostics: =?us-ascii?Q?1; MWHPR03MB2701; 23:t8iFdulMCSdjrkGnYHerQ210u5PgOIqnsXT8krYuk?= =?us-ascii?Q?7L83mMW/JnCgmkXGpbVrLuAukcI5lqsWz+LGGSgOcBQKaO/cGeNyCSpqUwLE?= =?us-ascii?Q?2OCrulNJvDOvhcaS8t1UyEOMsFa7yS0KZCJYRhBz3efbSvYulsF+yAbLXQYV?= =?us-ascii?Q?zy2NrFoZZ948ZKd9JNVMgFoBL+dnvWcwL+SuNHMobgTzE84fz3qwUBmBv4AK?= =?us-ascii?Q?9D0e9JykwCl2gmY29Z6QNJP38mAead7e3fcbQ6wTbgB2p9qOvgEoeyha9Fo3?= =?us-ascii?Q?wOL5VSMsSY9kxFNwycxuWPvrfoyJsA3J2N07wmKKVMp036IIiJ8/qHqoC0JE?= =?us-ascii?Q?dDNNs2u2ocDrOgrLjOzkh8Qug5IZKQWbynyr6pmwG8paMHq16z/O4SW/xPfU?= =?us-ascii?Q?MZHIeQD14gMDH23pNqnFlPpdeGvr5/IYV4ucy+3Qnq5LKDT3CHXWBZqk+gK0?= =?us-ascii?Q?9P4i8gZzWpQTAAF8B0GC2Wqw1CQczX3qjkswQsxoe3G/mIknLoepmN7Anjr7?= =?us-ascii?Q?U8RJ8iLPeEUKv4vmcpu46PYzAU2PyKVAOyIbNpSFWJcB34nw1ndakKT8K+3w?= =?us-ascii?Q?V3kicLqk+cnuPGkUsMpY52MzX3fmDbGFO5ppvXeQUR+kVRVTWZPOmZUKyduc?= =?us-ascii?Q?oVAZ9biJ83+oWqTdjBVttgk3KJmAxoBW9Tgf3G/P3TXxRLNKBIHSByKX347q?= =?us-ascii?Q?+E5zhEhYQsPEn2g4/NBDE1SGNNdUYIPIQbHefOPErI3gkEWBkUT7V1WD+pkq?= =?us-ascii?Q?qciDv8/UjqWTlqA9YyDOtCozQMhftg/VZRXlNX6oxbXxEBI9xFnTNfG/hhiG?= =?us-ascii?Q?2/CWDcExMTDJjN4dlMAVE/pRCoTpolZdAQaz8ilA9zENFljhyFFWHDHq97ld?= =?us-ascii?Q?Wml87Z4OSopisGXyl95LQ/zTKoP/vYdwKHD/jE2WL6TQn1DfFQjogybNK0bR?= =?us-ascii?Q?eXhWsguajgEvzM22oCH7LLYUQr465DdiOkMjof1SejL9muIgJpLTbd9lU4E7?= =?us-ascii?Q?yCZryQfWDYlMc+AAwerLTiN5eZ5kW8QzlriJCQR5VVkmKciHgfP7mclIyIjZ?= =?us-ascii?Q?vEMZcbah+1nooE4Fko1DoJrHPnc?= X-Microsoft-Exchange-Diagnostics: 1; MWHPR03MB2701; 6:e1iMuiVvrE44K1K+F7H8Pf0kizhgMLcOtOTTfoFyHwWaQNh2yxNOeoDRK3TCkVFYMR/ycw1waubHQXt2R7G5pYq9yONrWzfxNNkBIbO/FrLInS0vUvnjP2a1lAzWYdQlqKed5dWR1caUYVQ9MpoC9cFPM4Za7XOp3Nfol4tw5aCFbSUjcIO87/HZioasBdglOr3BCTnfD1RSFTgoMoC17Nvq5R9OJxcbuL0Ky+ciTSMsE03pikN87nFfMMvE99MZygryljiKUr1yV6OCqVtqRTe/mstjjvOUNLZdPiY9kIeaeNqPV/RR7QhftvSARsuTXTzsCEoiH80IzyGTFt6eSAjq662SGRmRKYdTdyZU+v8=; 5:PjTXaK3e7tBnWTik3HQKkKWqBzRrA5LSuYjK5S0xxUYekH+gkxlDGy1Q8ImUPejjhnTj8rJYLZmixXaicSoLJQhFdOCy5zmx0nV82Brf3/YoMZDA5rvb7BJeJF/MGt5lt+4k9tsVIQmUTL3wXr0OAFEM+PHFSp5krk3iELoQlkU=; 24:Bw0t3Pa885Lex6jgkHK0ILDC/20HBbaFT8x/3NwI6URLVNusnWx7SBrjjfHEax6kQZOMSP5ma6qOB53xuVlrhv0gi3VLuFbGhZmRJ8ZJKx8=; 7:MoeolWi2mObOankQ4ufGQhN79Pl1tEvsSj7+py90Qa6YMnULCijTRydUTQA6kRMv8UZaTTFcB2X8VZ498jClhdeD8DtIOZl/MgfKjVm23TOAn57wtrR/0Sh2PgxK29JNPBX6F16rOiE9+X5qVCjpqfKUegfHHtZQac9Tb4Wo5A4p2JxqV6hiMaz5YTY1pW/xAsbXu3TaPqFG6fp26ByiUnkVZKVoBAIcktRC2TS+yC+eFTyhRbYaWVX/cvmwKXw/ SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-MS-Exchange-CrossTenant-OriginalArrivalTime: 16 Jan 2018 11:43:38.0885 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 7aa8f42c-7877-43ee-01d4-08d55cd6622c X-MS-Exchange-CrossTenant-Id: 5afe0b00-7697-4969-b663-5eab37d5f47e X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=5afe0b00-7697-4969-b663-5eab37d5f47e; Ip=[192.88.168.50]; Helo=[tx30smr01.am.freescale.net] X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: MWHPR03MB2701 Subject: [dpdk-dev] [PATCH 12/12 v3] doc: add DPAA eventdev guide X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 16 Jan 2018 11:43:40 -0000 From: Sunil Kumar Kori Signed-off-by: Sunil Kumar Kori Acked-by: Hemant Agrawal --- MAINTAINERS | 1 + doc/guides/eventdevs/dpaa.rst | 140 +++++++++++++++++++++++++++++++++++++++++ doc/guides/eventdevs/index.rst | 1 + 3 files changed, 142 insertions(+) create mode 100644 doc/guides/eventdevs/dpaa.rst diff --git a/MAINTAINERS b/MAINTAINERS index fff842e..66633e8 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -708,6 +708,7 @@ NXP DPAA eventdev M: Hemant Agrawal M: Sunil Kumar Kori F: drivers/event/dpaa/ +F: doc/guides/eventdevs/dpaa.rst Software Eventdev PMD M: Harry van Haaren diff --git a/doc/guides/eventdevs/dpaa.rst b/doc/guides/eventdevs/dpaa.rst new file mode 100644 index 0000000..44ed128 --- /dev/null +++ b/doc/guides/eventdevs/dpaa.rst @@ -0,0 +1,140 @@ +.. 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 +`_. + +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 `_. + +2. **Linux Kernel** + + It can be obtained from `NXP's Github hosting `_. + +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 `_. + +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 `_. + +- **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 `_. + +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 ` 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. + +Driver Compilation +~~~~~~~~~~~~~~~~~~ + +To compile the DPAA EVENTDEV PMD for Linux arm64 gcc target, run the +following ``make`` command: + +.. code-block:: console + + cd + 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'. diff --git a/doc/guides/eventdevs/index.rst b/doc/guides/eventdevs/index.rst index 07a41bc..6f58058 100644 --- a/doc/guides/eventdevs/index.rst +++ b/doc/guides/eventdevs/index.rst @@ -38,6 +38,7 @@ application trough the eventdev API. :numbered: dpaa2 + dpaa sw octeontx opdl -- 1.9.1