From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from NAM03-BY2-obe.outbound.protection.outlook.com (mail-by2nam03on0073.outbound.protection.outlook.com [104.47.42.73]) by dpdk.org (Postfix) with ESMTP id 6DE911B015 for ; Tue, 16 Jan 2018 15:30:21 +0100 (CET) Received: from MWHPR03CA0036.namprd03.prod.outlook.com (10.174.173.153) by DM5PR03MB2699.namprd03.prod.outlook.com (10.168.197.137) 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 14:30:19 +0000 Received: from BN1BFFO11FD032.protection.gbl (2a01:111:f400:7c10::1:151) by MWHPR03CA0036.outlook.office365.com (2603:10b6:301:3b::25) 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 14:30:19 +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 BN1BFFO11FD032.mail.protection.outlook.com (10.58.144.95) 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 14:30:18 +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 w0GESqAL024963; Tue, 16 Jan 2018 07:30:16 -0700 From: Nipun Gupta To: CC: , , Date: Wed, 17 Jan 2018 02:14:03 +0530 Message-ID: <1516135443-10509-11-git-send-email-nipun.gupta@nxp.com> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1516135443-10509-1-git-send-email-nipun.gupta@nxp.com> References: <20171215130828.14218-1-sunil.kori@nxp.com> <1516135443-10509-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: 131605866189622661; (91ab9b29-cfa4-454e-5278-08d120cd25b8); () X-Forefront-Antispam-Report: CIP:192.88.168.50; IPV:NLI; CTRY:US; EFV:NLI; SFV:NSPM; SFS:(10009020)(376002)(396003)(346002)(39380400002)(39860400002)(2980300002)(1110001)(1109001)(339900001)(199004)(189003)(2351001)(6306002)(53936002)(4326008)(50226002)(77096006)(8656006)(8936002)(97736004)(6666003)(305945005)(26005)(6916009)(2950100002)(36756003)(5660300001)(2906002)(105606002)(54906003)(106466001)(356003)(296002)(316002)(68736007)(8676002)(81166006)(2870700001)(81156014)(104016004)(50466002)(86362001)(498600001)(76176011)(47776003)(85426001); DIR:OUT; SFP:1101; SCL:1; SRVR:DM5PR03MB2699; H:tx30smr01.am.freescale.net; FPR:; SPF:Fail; PTR:InfoDomainNonexistent; A:1; MX:1; LANG:en; X-Microsoft-Exchange-Diagnostics: 1; BN1BFFO11FD032; 1:0eJ2chr3GUwD4Cthtbh2muVwkUKvUPbfEF/wNYZoQqbnSzexJwSUWnvVvjxYJzRYxd9oDa4lwwnnGLgvXfcv82oyfluDfme42+AhdDoLYMYjLbaJ3eiuneKMvXTCf8sH X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: 4213ffa2-c7e8-4047-0d85-08d55cedab0e X-Microsoft-Antispam: UriScan:; BCL:0; PCL:0; RULEID:(7020095)(5600026)(4604075)(2017052603307); SRVR:DM5PR03MB2699; X-Microsoft-Exchange-Diagnostics: 1; DM5PR03MB2699; 3:yW/MKyp+PuJoCcKH3d1ujdeO/jFdDmKthUXsK23RCUBiBWYmfBtzwZJw1aZI0QMj5kqJRh/QyxfJ9P0xe2BPOWovgF4MFTWMtd7Vcs4dvWjN22miSH98YtQXuQfnVXjpv41LIpWleeGHas1Wy+1MZpb24o1ILFXIWI4cnwd68qLCh7xI8T1O3IgqigjdHMYoA7OaoTXYi74yXfh2EJ3984pDMQicIJRwGOBgGYNb5K8LTlCMq1XscJxlJaCqxp+aj1opu8vAOzQQwxTvJxRp5SeoUrKzyL58y3heZNMCZxkqekwvz4Z+KrUHS3JpZEu7p5KePtlqb1Bujscl3hgU83s56TWGCw/41zr1QBXpqsQ=; 25:XxFeQa8+coEB33M+PnELHAUrdSL8mxIHQOTrZI/hiASRj5MxezP/V9JrEvOKbw9VoSPk4oD3vHFpXdWdTfdO/BZzfPoZwPdgKX0rgFpRCgG3N5PR+qtnTbjIpdwakDQ7hFZPAmTPye7HQzfkeCExdwivU8w/rQMJZ8XqNKYsUtlJXa/OcTNOkxH4HOtS2EAWC4Iks2hbT0bfF7xwq9TR86fT+yqRImyXuBfPWy7WePuhc+48yitQgfr8bj+AMyP4DR4GVXoIjY3C8d2NgSVs6ao8dt7DvPMLbxalcv9f0dHgJOy/+RORyikQZd8ELLgkISP2OLCcTDDf7RxqKNkFYA== X-MS-TrafficTypeDiagnostic: DM5PR03MB2699: X-Microsoft-Exchange-Diagnostics: 1; DM5PR03MB2699; 31:mGQELXkBa7AjZga3rpJPCn0O5S7OfgBT05WKzfo3aRwq6FjR8kg3qlXDBF63iBg4YGB++ApdkIeZNFfv4CZYPXjhlTgVj0Di02jPD2PY1gIU6BDHSnSQ3uCznscSHaktuR5MvbsJ40gAJFMkYBv1VuNkRexl6K7ZBRMLkxPz5UjWDm6fqoIHeiLSRYUkp1j2tuKUp/aTC07Ej+c2JXdYe0Njame3tcwv91YJqb7yXcI=; 4:MvwrmvW0tydXMpRfiH6Trph4Unq2f3cT0Bj2ZvCj0UPVCfJlIWv25Wf8PUtw9CER8sXSoO1xThPMKEPFaUpQIe3ryf4xi5NKAuZSC00AYAR7Y5ijI59LLUKFke7UAOEXAFqF13g9O1qwICHJN0vmi4sk/WKFEnuiVOhZobcZiSPFy+PY/vdxmrgiqthnZdHw0/QZwFyrBjHrxlE7vmlFhGb76HUdeWFhugd9ckTj22qeP78fuvJIp4S2aWqaMbtkZhZKjpiujY4BWCrlD6YUj5mCFSTYheM/P0xPzctoMrVqcHu4HqTpOes9RPtRfNVgrspGkMybdiuhux8GpI9MddMSH1iWULExRMQyXz7C24QFdiisWLwIoEc+Gv3dArZ5r4ScD2sq8DQW0ZjcI97rmV/5YkThOZz85xzMOGK6BCs= 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)(5005006)(8121501046)(10201501046)(3231023)(944501161)(3002001)(93006095)(93001095)(6055026)(6096035)(20161123563025)(20161123561025)(20161123565025)(201703131430075)(201703131520075)(201703131433075)(201703131448075)(201703151042153)(20161123559100)(20161123556025)(201708071742011); SRVR:DM5PR03MB2699; BCL:0; PCL:0; RULEID:(100000803101)(100110400095)(400006); SRVR:DM5PR03MB2699; X-Forefront-PRVS: 0554B1F54F X-Microsoft-Exchange-Diagnostics: =?us-ascii?Q?1; DM5PR03MB2699; 23:FP33JVQsF7re/DqeCzi2ss5LSXGYZiQi/bu8RI4dw?= =?us-ascii?Q?bGQnpS2Ksu+wGUbANLMIowlOyUg8AHeMXCSEQNjMHr04JaA2gHBTDeX3x6f/?= =?us-ascii?Q?eMHUHdEZsctQMe390zMpV/UHymJqtUdwQXuYX5sQmu5kihhpMj+LsN6tj7Dn?= =?us-ascii?Q?IkjykquS3bKTxmsUGAwmduY8GNCqErBPUXChAT9Ll7dTcjXfWwGdPlyJMZO9?= =?us-ascii?Q?CCPt9hu9AQH+BcqWxxvEoMyvHHNOXkrsPeYmem1eml4Meedee023kQ/dl5gO?= =?us-ascii?Q?89TEDGxHD82bfDVWw593Ivf47rciDuEIn1W+IQJm1XlOqDv4YapaF75O6V2k?= =?us-ascii?Q?JHyO5n4tUKj/6gf2wvpquH2gTfiGLWOY0zcZU95YbXBepzC9Z3IGfm8xLCut?= =?us-ascii?Q?TlTbhAaCHIkKUzpGPQSW/P+bW8ANYTFE9Qa1lZKuCw1iuIvjgVOQmnCtZaRF?= =?us-ascii?Q?mHm5Xy7dtkali+VuOJzrSkwCO5gMW7WkAy29QSNJy0orKsuxxBO0BF8QJ7iy?= =?us-ascii?Q?K1wLCi43tMrTRrzijkCo2ctKWAoYp1DvYky2MsphlEIoFaq3OIk0DBcgSJkK?= =?us-ascii?Q?o/wv/4xbNKYMx6lYBuNhHBLb0Gwy/l1leX9UR+NDBBbPCZwp5oBSkE+dgy7B?= =?us-ascii?Q?SBKOiMeO2wBkCvmrq4NCIut6n4NBo71gSAD5qHjrL+IXXtzmmD3XW+vmCUoo?= =?us-ascii?Q?fxD81DWPjmZ0ubKaV/ud+svY8ZTExApwL1jtVVzHHMxgkerOQDnpSBtosfJ2?= =?us-ascii?Q?nz7/sIAuJ9MHF2CIVCJxlOY3kdPRoYxdwwl3CldmTDd9BdEKJ+i0PTDXQktp?= =?us-ascii?Q?OD4vp34Ig7Egv2DSKECmDuZyt9SFsEQ1ckkIj1eXwAiMgN4fyjcQNoKfrQrc?= =?us-ascii?Q?nseirb/rBAb/NBBx+eVdn5g6fsJcqlNtHjSFfEDAiv2x012DFophibO0LLHD?= =?us-ascii?Q?MbpmqweR5lgekEZBHHenA6pbGNHZKLqEYSU8YChthb6WzRMJqE5NvqvTaJrX?= =?us-ascii?Q?8UeHgOxAXCiFLP3DFNNfgNKCxWPEn1FPmDScaUnR6d2pehonf+NPJCO01AmZ?= =?us-ascii?Q?NLlJzBlCVbMr4Hi6pmVOwo7/Bpv?= X-Microsoft-Exchange-Diagnostics: 1; DM5PR03MB2699; 6:9Fq+P9Tkf9O5BfyupD6TB+Guug8MdjE8ImdWJf48GA2uUHHPwHnTTjf8MZ0Aw88JA+a5NOKcW2cTzB2Y+AFsr993H3/s83X0GNuLRFaPuWUTS+MckgQ49lctsh/RXHCP1OdrJp3m47e0Pn8MF9/oD5WSiELWVoFxREMnjLdNaQ1AYe25IgeXfKN5cMAZQnUXqQJ0a3yRP2DNb0/D2U3F3FaHNeJ4CqqDvi+8aEICfakm7rGKeFpMHz+Wue9hc5Sq1k9tHemWLRbhyGhVrPScTUQMTLtQpHK4DeIfoPayHaCWVHFwLjf2ZSlzxDfm6m30xT3SL2x2UCF1Pxtzpy0BG42dUuSFa2SfQzP/CcBmb0k=; 5:dlL+jVCcwOIosI+liCXKehcrITNOQgSHSbCUS9ZXNzR5CLoWG276Wiiu06GU3/Y51ksn4ZzH9mhQ6NLqX1JT2sGcTxHtrAr6c88bLhjs96cFa3A357TLWu/gbmhvQWwp9qq6Nw+YmNZ6nbzomFOoUa0z+y60/wDts1/Y2BkI7zM=; 24:o8amIwqHSKQgOxZ4v40HZNDzDuodOdLs+F7nO8zq26mxDdLP/k0OwVwnrQyI/bP39eCnVDHhYr/2PCKDXwa6Z250rECik6LzL9hwZQkcdaM=; 7:saNc2o2Ks4IJSLiAkO3uzoo6EQ2twqAUL/T9IYZVEwN68Hxd3IgDK/rcv1FqAkLcBPt+FY8BILnTsN/h8lz9MAFbVKixouGYG//4tQi/Y1Ls2wOZLC5VHW3zbGkLoCjS/DWO4Kzib6WBSgxZp3blxvrRfGM10x08w+aG8aPNCoQtJABOw8RXFGZndtBXt04aiuCHtWCShRXK1sNEYNvjCE9wJCcJnhxk8Mi0DGFUDc8MVBiSVizC8Gcd3DgKD58t SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-MS-Exchange-CrossTenant-OriginalArrivalTime: 16 Jan 2018 14:30:18.7906 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 4213ffa2-c7e8-4047-0d85-08d55cedab0e 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: DM5PR03MB2699 Subject: [dpdk-dev] [PATCH 10/10 v4] 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 14:30:22 -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