From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from NAM01-BY2-obe.outbound.protection.outlook.com (mail-by2nam01on0049.outbound.protection.outlook.com [104.47.34.49]) by dpdk.org (Postfix) with ESMTP id 851BD1B3E2 for ; Fri, 22 Dec 2017 16:17:56 +0100 (CET) Received: from BN3PR03CA0107.namprd03.prod.outlook.com (10.174.66.25) by MWHPR03MB2702.namprd03.prod.outlook.com (10.168.207.136) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P256) id 15.20.323.15; Fri, 22 Dec 2017 15:17:55 +0000 Received: from BL2FFO11FD033.protection.gbl (2a01:111:f400:7c09::138) by BN3PR03CA0107.outlook.office365.com (2603:10b6:400:4::25) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384) id 15.20.345.14 via Frontend Transport; Fri, 22 Dec 2017 15:17:54 +0000 Authentication-Results: spf=fail (sender IP is 192.88.168.50) smtp.mailfrom=nxp.com; nxp.com; dkim=none (message not signed) header.d=none;nxp.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 BL2FFO11FD033.mail.protection.outlook.com (10.173.161.129) with Microsoft SMTP Server (version=TLS1_0, cipher=TLS_RSA_WITH_AES_256_CBC_SHA) id 15.20.302.6 via Frontend Transport; Fri, 22 Dec 2017 15:17:39 +0000 Received: from sunil-OptiPlex-790.ap.freescale.net (sunil-OptiPlex-790.ap.freescale.net [10.232.132.53]) by tx30smr01.am.freescale.net (8.14.3/8.14.0) with ESMTP id vBMFHVf5024113; Fri, 22 Dec 2017 08:17:52 -0700 From: Sunil Kumar Kori To: CC: , Date: Fri, 22 Dec 2017 20:47:25 +0530 Message-ID: <20171222151725.11273-12-sunil.kori@nxp.com> X-Mailer: git-send-email 2.9.3 In-Reply-To: <20171222151725.11273-1-sunil.kori@nxp.com> References: <20171215130828.14218-7-sunil.kori@nxp.com> <20171222151725.11273-1-sunil.kori@nxp.com> MIME-Version: 1.0 Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: 8bit X-EOPAttributedMessage: 0 X-Matching-Connectors: 131584294597797627; (91ab9b29-cfa4-454e-5278-08d120cd25b8); () X-Forefront-Antispam-Report: CIP:192.88.168.50; IPV:NLI; CTRY:US; EFV:NLI; SFV:NSPM; SFS:(10009020)(336005)(396003)(39380400002)(376002)(346002)(39860400002)(2980300002)(1109001)(1110001)(339900001)(199004)(189003)(5660300001)(8676002)(50466002)(305945005)(76176011)(50226002)(2906002)(81156014)(23676004)(2870700001)(6916009)(8936002)(2950100002)(77096006)(498600001)(85426001)(36756003)(104016004)(68736007)(6666003)(6306002)(97736004)(81166006)(4326008)(47776003)(86362001)(575784001)(5820100001)(1076002)(316002)(54906003)(53936002)(356003)(106466001)(105606002)(8656006)(2351001); DIR:OUT; SFP:1101; SCL:1; SRVR:MWHPR03MB2702; H:tx30smr01.am.freescale.net; FPR:; SPF:Fail; PTR:InfoDomainNonexistent; A:1; MX:1; LANG:en; X-Microsoft-Exchange-Diagnostics: 1; BL2FFO11FD033; 1:R2xtYO/xqIl0NaGhfy0jgSTtTMi9zbHtAM7oQjq5WVgo9gae9zRwHGFNVOoPh36G1FGxWqdU06M0JykEutEBOaSDw3fCMkPelChIudnCqIlSxPVWHJS4qZO+XG8lkMUq X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: 8c2f0d78-3e86-46b1-a6fb-08d5494f23fc X-Microsoft-Antispam: UriScan:; BCL:0; PCL:0; RULEID:(5600026)(4604075)(4534020)(4628075)(201703131517081)(2017052603307); SRVR:MWHPR03MB2702; X-Microsoft-Exchange-Diagnostics: 1; MWHPR03MB2702; 3:wqG1kNE3cWBF59PZz24HZwAujhEzTouxrk+XfMZVJt+4FYtod4F/VeEhOcmvhBQeda76p0tCYZTJ0hrQ6LhBmuCtY5ik7JJy5GnPkVQk0B1pTAPLhCNl7Jy90DFr92djuVbQ9H+oEiY694tUc5waaHs73iTCsQ+ePh6ZsL2HuJZj4WezFuBFyzEaMjc/1TQMPXyZhTWsP5oDfiEmLRrHg/mpmgd579AAmm2qjvWLgkQrj7eZiDPfKQ6wK1QBO3qahaeDR95YfBbSu0mTRKhm9M2u+VSUd9izKBvfAUapxmCV+EvjIp55Yo5jP3SNpqh45xCEoeDkwbDwl0blS7KOUXmXKOYUJDPzm9i6exQrRUM=; 25:ZDZV4BlVZhMrIUHZLKiDkzYmnlvfwlZM+kMxfw0rbUxJt2XvMg/2o/nm9B243UI78EHb5cU1TY3U6KnvFlYOwkCdPrkQDBPYafMnzLYtkLbOvrqMqbzQjjOXRXEbX+pPvhfUucr9LGAX2lD4+QFgce7IZh7jpENU45tzCrtJOItl7I3Tu+vWShF1YFNVMPz7uYM0l3p61x2E0DS1ZKTLATKDTjO/LGV9E6K3KuEgY+E9h4gN0nLpojMsRcLnpM5XlPfTuI8wPCo0NFOrKmNoQ96lgxjR6nc89X47dI+1RTLskn224FxTNs5J5sIYx4IOb40JfaU7p8/uEf5AW5M2Kg== X-MS-TrafficTypeDiagnostic: MWHPR03MB2702: X-Microsoft-Exchange-Diagnostics: 1; MWHPR03MB2702; 31:evnSv0ZO5s8Atd5RaiUvLqa4Cm1PsNS8WRfIHOtteZXkIpl7i/LDsTYeqIIpZjQuZ5U1HKvZMSkV73S5vbB0GXaoCpIrCNiZeMGIqBz4peUI3Cy4cOicp3PabMcyuSK3HyPZWQaCA1UO7Z3w0+AByHwxJ2MsVhqKniIbHYK9sJr/iObT3jKnkkq0Aour0/3SSFrg7C/rtrODdHr+o//rpaqw8J4HLKm/7dfEO2kFSLs=; 4:g6Dck9fDHAx1Z3pamqyrCN1OUJW0gZ0NNxgPpwVZTk+doIZnZt5+tLWz/zfmwCZUZqRTCUcRpucynWAiJ8qKVipqmp7yQ7kKtbcrJSLXyb821Y+QRY7IT+PrJFuzMEdz25yQMywYD4PUsJi6cldXE+EwGzFq6EANlrFmVE9NmPVoSbBq7BlH4y/ZqCAVFpmC8LcTpHBtzsKxcmBNGSBeEj5bqOUU9A+qnDyjJYAM/J1UKjVZ+pYUdWLXjDLQCxcP9paGq6PDsBjNCVD5nGv41Gu/7/Xdh24SOR5QOwP8zB9ZAmwS42R3Aqo32ArqW+Ihb4VIaI2SuKv2OnPWSTrPv3J1+GUs48KfQDQwH+oQ2CkLFmepuI83NAWr8oz8/pjqEea3T7YB21KmTRr1yepfCEpAPJFxnoCwuEyrReZ0Hjg= 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)(93006095)(93001095)(10201501046)(3231023)(944510044)(944921044)(946801044)(946901044)(3002001)(6055026)(6096035)(20161123565025)(201703131430075)(201703131433075)(201703131448075)(201703161259150)(201703151042153)(20161123559100)(20161123561025)(20161123563025)(20161123556025)(201708071742011); SRVR:MWHPR03MB2702; BCL:0; PCL:0; RULEID:(100000803101)(100110400095)(400006); SRVR:MWHPR03MB2702; X-Forefront-PRVS: 05299D545B X-Microsoft-Exchange-Diagnostics: =?utf-8?B?MTtNV0hQUjAzTUIyNzAyOzIzOmNMNHBRM3lEOHVrNmVjNVh2ak9NbElyMnBX?= =?utf-8?B?TlZTYXIyYjlyMkw3NVJmeHk0Z1AxVnQyZHRrbUlWWU5SUXpla0ZzalR0akh6?= =?utf-8?B?dHR4cTg0ZlRWczlXcnhOYm5DelpteVU0Q2xsNmJaMWZUeU52MmdTbEYrbDJx?= =?utf-8?B?QjZlRVlzZXpWMkVSWUhmL2R1NGNyeXZqc09DOHRvYjVMTW5vanVNY3lpMlI2?= =?utf-8?B?dmJjVE5NL3RCM2ZubitPUkVRdVlhUlVNOTUyQmdVblh4TTFET3BmMnp3aE53?= =?utf-8?B?TzRxb2kwSFBJUmtyc3VtZWVhdHhoVm0vdzN3U0dWVDVTUzdYbm5PN1R0Rmo3?= =?utf-8?B?VXluYThZajhnTjdXblhYWmUxaUJsdENZOFdBSFZjYURCTGpMM244b2Rkdkx0?= =?utf-8?B?d2ZFY0ZQVmpjbHgxYlN2U2dkOUt5Y2hBNGFMZkRQaVVhVGV1b0VkNEptdkJs?= =?utf-8?B?KzFSMEdUQzM4Z3J3ei9UeFg5Tzh3dnRLeXY3L1Z3QWN1bVVQYnFpU25rSHVX?= =?utf-8?B?QkNNMDZobEQwdkJRS3U1M2xjaGRGdjRFSmtKb2VFWkNMa2pTaXd0MTArN0JD?= =?utf-8?B?YlBHcVFNRnIrbFV1YXh3UjZDNHZ3ak1LSHBJL0VFRlltbWM4aDJnVjRpTWoz?= =?utf-8?B?aURPeDZaWmw1R3BtQ2h5MWxuTngwRm1LZE85dEpUanN2WmVaZEQrZ0s0aGRH?= =?utf-8?B?emFpcit6SEZXcm9hYkwzYmxnQUp4SHZVUzRGc0RONXkzc3BpZ2hLSzVtNmRX?= =?utf-8?B?SWlUb2Q4d2pZUjF6MFA1YnhGZmFkMWFvQmhJNFVhdFRtMnMzd2hwL3ZLazZZ?= =?utf-8?B?NmFqaHl6UWxkNU5yNk1nSml6TlBnbXpZTCtJRkdNMFdTdGxTcmR6eHA1Qmpq?= =?utf-8?B?VGllZTNKeDlZcGlWL2pTUEpOZU1yZC9kV3dSUDMxTkY2ZVRVczIrMjVqbEV6?= =?utf-8?B?NWpTYWdMV0xHYVRodnI0eGE4bEpEd05lWGlzRXliZWVRR3poeHBhcWhjb0dJ?= =?utf-8?B?ZVBJTEUrMm15NXc1OTNtMXNQMkVJdHprclJ4NndyVTNQNFVUZjIya0FFMXpV?= =?utf-8?B?SGEyY0RENVNEaG91N2tyTFl4NFgxWFMvUG81QVFRaVpzdStwVHh5MWVOUFdG?= =?utf-8?B?RFY0eTc2WFk5UndWVUhXUk1RUkc5cURPTCszR01BZncrYnVNUVFpTXBnbWh6?= =?utf-8?B?U0pBcDlTVitOZUJ0MGFiRjdTd05waDVUbTEzcGFUTVBWNk9xK1M2YzFNZWdT?= =?utf-8?B?SlBPMnRIa3U2bDFlUlZtVm9IMG82N2R5dWtUK1VlbzUrVnlQNjhDRm5NMmdn?= =?utf-8?B?ZDljQ0U4NnZHNHd4a1RtdXkwWkJYRlhSZitaZ254RW93akk3QmJ2MU5SZk9V?= =?utf-8?B?VTBOWGVGNWwvbi8rM1J6Vld3UG85SktpM01yQ3RCbk54WHllUUN1ZWhYMitx?= =?utf-8?B?VHdheDhhRUtLbzlkcUM5dEZLSmozZmlFZFliZnJ5LzJ4ekRiNVFHRFIrdXA3?= =?utf-8?B?WFVUT2FOYm1DSjdWa2hlNVlZT2gzMFdHcHp3cWd2YXFxb1Z5OGpuSWNQQzc3?= =?utf-8?B?MUtpZ0I3NVpWNHNqbjloRmFyak1zSmc9PQ==?= X-Microsoft-Exchange-Diagnostics: 1; MWHPR03MB2702; 6:GEPytmT+L6ShVU+yfnrzjn916HFNCINMJjtjTb6tYhZz+xZpF5se1v1m5SzqVlM6MrhFna25L158bTz3v6Z7q7eAw4R5VNxaHYNrqyPNdJ1OD5NhjAbFB2ph0sTFdcMLxUuSxM1EHNmExSDKl6/tJv/GNvm8UF/B/3sO/lplXHkxKCCTDV9zUBjRULcO9pweLyEGmcrk/g/6is3rmMEN3+ZQQz9nlCUpjqHnzuOhbhLgqTTaL2LASzI6N9kQmQBaSkJnSZmhqGYWUOJM4VaFwU0KPZXSVXSm1eA4Djan9zKQoDdjHPobMLSZ3Us+PsFjpnFTAn4asTAEmK7QvczIP8B/1HROtxxkLBPE39hh6fI=; 5:EMRxZm0zGXpM8aGM9sxGX9xQ6aRNz3FZ0SydBOfzPLXis5NmpVzn24IM/EOG8E3SPBz9IOCFND9mH4FbLLnR9NIHtrx+Tau9lJ+voAMXx0C2iNysXhy/pkne9HVqHNreE20eL/7rbKU2754OuWHa1/qDZkzyEFQtI+YGBlpPJYA=; 24:OoqTrdoWehAFNToz537JCxvePxeY/ElyMIs3bkNbMLBr3Ehyy5KNbh+TLd3ozojOC6ertDxGrknXUGKKX1PKDaDDTO34Xd8x5kpXfCKNuok=; 7:ASUxT/tEpdZdpQ8aOS4z2fqCeLNE5Zu2OZ6k4TKE7yb3xuvSg0tiJfI4dimN+42dFR5I4XJtzj+jZV25MKL5h8Dz/LZ3XrZ+gLCNsHeRJrKLNarGQLUBoxUci65dT7SuteC0jlly4trNoYtLbP89srC/WfQPxBj7EECwpnkdQNA14OyJ8J4FO5TTzKT3NBWKkCNmFLcpmSKgCVqbE4M9TlvVQ6ADQcfLS4wsprRM6OLqmnmM2B4bXczASiUnB2Bm SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-MS-Exchange-CrossTenant-OriginalArrivalTime: 22 Dec 2017 15:17:39.6237 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 8c2f0d78-3e86-46b1-a6fb-08d5494f23fc 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: MWHPR03MB2702 Subject: [dpdk-dev] [PATCH v2 12/12] 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: Fri, 22 Dec 2017 15:17:57 -0000 Signed-off-by: Sunil Kumar Kori --- 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 diff --git a/MAINTAINERS b/MAINTAINERS index bf4d0da..ced725a 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -696,6 +696,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..35e5211 --- /dev/null +++ b/doc/guides/eventdevs/dpaa.rst @@ -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 +`_. + +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. + +- ``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 + 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 ba2048c..22f6480 100644 --- a/doc/guides/eventdevs/index.rst +++ b/doc/guides/eventdevs/index.rst @@ -38,5 +38,6 @@ application trough the eventdev API. :numbered: dpaa2 + dpaa sw octeontx -- 2.9.3