From patchwork Fri Sep 28 07:46:01 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Gagandeep Singh X-Patchwork-Id: 45568 X-Patchwork-Delegate: ferruh.yigit@amd.com Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 2CD811B1D9; Fri, 28 Sep 2018 09:46:50 +0200 (CEST) Received: from EUR01-HE1-obe.outbound.protection.outlook.com (mail-he1eur01on0056.outbound.protection.outlook.com [104.47.0.56]) by dpdk.org (Postfix) with ESMTP id 67DC51B13B for ; Fri, 28 Sep 2018 09:46:41 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=nxp.com; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=x7utFb7l76VbXN+kc1+KYEAHAQ6lfPNUqxTiQRlfPDc=; b=P6cll69OFiup62m+HI2/7krs9zhU8SLjFaeRZWpF5c/nUO3HfT75wYRKxXYasw5x6U5204/vUOxDspqD2dHqS3J8Htb+zvbXgBNMgQ3w/R4miI9FNfTSaBMUE3CzkaleI2tq6bkJ004pK+4DT/aLtx+eT0jKXEdAPT4UZphzKLs= Authentication-Results: spf=none (sender IP is ) smtp.mailfrom=G.Singh@nxp.com; Received: from Tophie.ap.freescale.net (14.142.187.166) by DB5PR04MB1528.eurprd04.prod.outlook.com (2a01:111:e400:5993::22) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.1185.20; Fri, 28 Sep 2018 07:46:38 +0000 From: Gagandeep Singh To: dev@dpdk.org, ferruh.yigit@intel.com Cc: pankaj.chauhan@nxp.com, Gagandeep Singh Date: Fri, 28 Sep 2018 13:16:01 +0530 Message-Id: <20180928074601.4287-5-g.singh@nxp.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20180928074601.4287-1-g.singh@nxp.com> References: <20180928051647.32341-1-g.singh@nxp.com> <20180928074601.4287-1-g.singh@nxp.com> MIME-Version: 1.0 X-Originating-IP: [14.142.187.166] X-ClientProxiedBy: BM1PR0101CA0037.INDPRD01.PROD.OUTLOOK.COM (2603:1096:b00:1a::23) To DB5PR04MB1528.eurprd04.prod.outlook.com (2a01:111:e400:5993::22) X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: eaa4c525-32f0-43a1-4635-08d62516869f X-MS-Office365-Filtering-HT: Tenant X-Microsoft-Antispam: BCL:0; PCL:0; RULEID:(7020095)(4652040)(8989299)(4534165)(7168020)(4627221)(201703031133081)(201702281549075)(8990200)(5600074)(711020)(4618075)(2017052603328)(7153060)(7193020); SRVR:DB5PR04MB1528; X-Microsoft-Exchange-Diagnostics: 1; DB5PR04MB1528; 3:E24VDPB4ljsNdDW5/uUM3EMUf32CEKV2EnJ75vqDRTSGgehHIvqM6hrdrut714neGzibnIXxrJAbVDTriuSOZ4yyGMp18Tt4CQdSimNn4O/Wq18AOBY9hzWU8lfiUzpE0s7eMuS4PwQnCS6NkQgZ3BLPYW1Hs9HQq2DbHpLBydDwzJUKKW3ZMRy9olEqX15V6y68EcWx4nT3MDC9RVW4FdLkWE6EsWlsglmw27acwbj2vR6h+wZIZRWqV6lrE4Sf; 25:rViKgkLrzDU8NRMZ4selXDd80XEfbgbAnm2890DqAseJiELUr6zwiXwU5d5GD+TYsxbVmNB5VhgccZTvQxd7ddNOuluwEJoMIGt/kFFT3ci0af2ugl6nLf6/i7FKH+36Ksrd7/Hx6ZaY2W/IJS9VrphrS3ChAyB+7qCHzz459Y6pBQ7cLMCQ6Hn4KqDc4QN7XSju03VbjgGFLklWBSyqjY0gzafDlAdH2wn/Mp/YeOHViaFo33qlQF2t7xLRC1fVvOOeyxlWz9rYPxHIr2RV6P+JDtd/ofVPVjZvqgWbaEPN2F44pPh+atOuMhwMuaeaUgeq9grVmnQyBBFM8tx9Fw==; 31:GAPxYg4FYvc/TtBZGuzZVjtq0vQhWvSKifZtlbC08O6+zlR8DGcgVpakz0wYrNO+vQQAbWDWi+Eq9471BlDjoqMkbg3u4CsBOf/JCqycOUD84yixRno7Km9rutiZzyWBfAtCy5hQ/hjCvaRoAkjSx619WaWQsVgx86vbUc3qA77WKydurte/IP+p4OILkCQWveyO34+/MpQOX5Wlf8vIFgtczAZNY8G/nS27IzMSwtk= X-MS-TrafficTypeDiagnostic: DB5PR04MB1528: X-Microsoft-Exchange-Diagnostics: 1; DB5PR04MB1528; 20:okkZosXUbj2/VFpYYT3QGlz/O3jyrvx+f403GSeHYlwkb2Dr0y8AiO2YGYzWUFxT7B64ZeAo25USquf3SvqvGZxl6zxHHX5UruJ6fUGPQwpHE3PZLGUoLRwcePci7o2shjHCau1MKjSvq2yNTcaQWwHN4y4lUFbvk4kO0IK/7mrQwkFgMhcgnyjsgJsgwoKG4trLNDBRXQAnA7FW/hDNWag8fwijGSFnko0j3w53kImoVNJ09G0cUtlb4g20zQ/GgMJvATVZSp/jXXFIsvL6hTgwZzEsGQFZ+wqRAaT5FyR8gnbp37wYqVwixNowxRgIzzOqL9uH8VVwHc4eUUtcl2W56nZk7CLaHjqw0VEaS0jm2sU1rV1k40qw5QCF6mSl228HrEfieIpSFKzPwW6TDMkmITyLD5MTaRGX1DY7XkGWI2K9GZpBkciq7fcpH1fZ7qjNpZl8xnpsAYK7XG+WwkQ+STDcVAY+in2cn6Lm9sT71Cf/RyBARCj6WZRtglOu; 4:Ws8UdtU0LLMWYKmedyJy5Hwxk5+/xFamoUGEneDMtKVX9mk1fDoh08tJw7Db0UWuqmjWt8s0ZOks7witNtfplKdh6CYkgRTBSQAZpYTNXApekl0wW3hQRhagBxs6txukyzCRGHG3MrZxbLctu4V2J9SpH/rii4GpKLn17UMQOtp0ggT4aD9nIo3VahWvYFf1N4aNe+6s7HOVEExJDHLaEgk86QA9iLGaziCD7uyU1y/Ku55ChDNnzA/0qKw5zjjhLekOV23yYrtPJrEk/I4uJfVdCvo/VWDuZIsjS/52OL40RDrdyGP78w5+LYyKnYSu+BFTPQTaEq2YvB6nIq0a7ua9pxNjyFR9/GzzZVVeyjGt4kWpKhh/EpfpT/c9d4pG X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-Test: UriScan:(185117386973197)(264314650089876)(211171220733660); X-MS-Exchange-SenderADCheck: 1 X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0; RULEID:(8211001083)(6040522)(2401047)(5005006)(8121501046)(3231355)(944501410)(52105095)(3002001)(10201501046)(93006095)(93001095)(6055026)(149066)(150057)(6041310)(20161123560045)(20161123564045)(20161123562045)(20161123558120)(201703131423095)(201702281528075)(20161123555045)(201703061421075)(201703061406153)(201708071742011)(7699051); SRVR:DB5PR04MB1528; BCL:0; PCL:0; RULEID:; SRVR:DB5PR04MB1528; X-Forefront-PRVS: 0809C12563 X-Forefront-Antispam-Report: SFV:NSPM; SFS:(10009020)(979002)(136003)(376002)(39860400002)(346002)(396003)(366004)(189003)(199004)(386003)(6506007)(7736002)(186003)(6512007)(305945005)(36756003)(11346002)(6306002)(97736004)(6486002)(956004)(52116002)(76176011)(5660300001)(34290500001)(68736007)(50466002)(23676004)(81166006)(81156014)(446003)(8676002)(50226002)(8936002)(47776003)(105586002)(6116002)(3846002)(26005)(16526019)(106356001)(53936002)(66066001)(316002)(55236004)(1076002)(4326008)(2616005)(72206003)(478600001)(25786009)(476003)(86362001)(5009440100003)(2870700001)(6666003)(486006)(2906002)(110426005)(969003)(989001)(999001)(1009001)(1019001); DIR:OUT; SFP:1101; SCL:1; SRVR:DB5PR04MB1528; H:Tophie.ap.freescale.net; FPR:; SPF:None; LANG:en; PTR:InfoNoRecords; MX:1; A:1; Received-SPF: None (protection.outlook.com: nxp.com does not designate permitted sender hosts) X-Microsoft-Exchange-Diagnostics: =?utf-8?q?1=3BDB5PR04MB1528=3B23=3AaJAC?= =?utf-8?q?IqGQbeWYWj+MHKPF6ZXen0d4PDJSsrUov8EHZcotQbHhl9ORrAUF5Tex?= =?utf-8?q?WsbJkyPHdfQpxWt9SZf6PeaIzKxqe39QOFDYLSk9HvKC1HQwr65t7MQg?= =?utf-8?q?4VnhMl9UpHRm6JPwiu0/x7Q1GPkReRgLR7j5nNI48aATcdjGI4GK7+ql?= =?utf-8?q?KB+ua6R7geq1aJuZs21VRJLP3M/OpwWziKI6A35B5ZxWFBla04rsnzCj?= =?utf-8?q?1VGJftoXcF0Ly7aQw9Po1r8jTpYCWK2a/peTdCs+Ecz1o/vZ2l5zGYCw?= =?utf-8?q?8+bBJaBMzA1MoKFukh0xvw4DqLdP9x0A/81fBTIT4mPe+7w3ZiNGSzzc?= =?utf-8?q?pb8nQ/E26Yvq+5KYEw6+ncw1QCghGITwcCwMkelkHAdS4gkf1p4oqmR1?= =?utf-8?q?o5uOWOV4ds+MteIAUX14On0m5+CpGzJmQnb6WtPvOV0G1gk9IIaPQnce?= =?utf-8?q?VujjMLSTit6J1ghQgykNVOp7Qj6sPwjPj7inf3vuSXrqLCkPM9fjp6i/?= =?utf-8?q?bNYdTlxUH2lUOk0h7VfGt4EjiPB2ana4xZGTmSvGUhc24HYSSmWotGZG?= =?utf-8?q?E5+uQEbGVexMRQqupLOkx8SK965/hbA4e8L7339UuL4Jw3amUiWcgye+?= =?utf-8?q?veqtfE9pQ6ugKV0zzx++EVprL4gE4Qzp4meYbsRMfcj/HV3UkUcXy6qK?= =?utf-8?q?/vpUYRESNCoSFYxez50RXQvJztX7ekR+F0fmrSFaRqg0GrME1XZo2hRm?= =?utf-8?q?VBliBZQWrfjbjofAFpGEdjUlIBcSQS4Q1cM9OfmL21cLb/Af2NzQ7g/C?= =?utf-8?q?9oweIX490RkTcfvYz1VckRMycir/3Zh2JjcYxpa9J4Ny3XMDcrj5khyI?= =?utf-8?q?2iksrFo8TllVudpv6u2eU8+EyGeUB3G+O07oHE8JoY7mmzyTVt+IMsYo?= =?utf-8?q?FkE5Kus3zqzB15lGdrJ3OkQKdeLXjz3/mvlP9pICX1XfhtFiDbrBlESS?= =?utf-8?q?uQSpcSqSVQZzEyBvzLm9VXHnpbBZFRrXbyVezRkRXi1FVE+AVrtTWPqM?= =?utf-8?q?2iflN/VWGGz6a8/ZuLxMabAlw503nkBCjYBAYzuTZq9taWa6puCErrJm?= =?utf-8?q?y2uXVGJILz9ExeZHi3oG5Vmhd5vlM5RtWyCqtBV0XEf0cJ1V6duaV57L?= =?utf-8?q?EubP1fUcknzqkJyAIoX+P851Oz30QmgJdPEVTzjp81kArLF4QTeKHyDk?= =?utf-8?q?JIkS3tlXAlGvr+DNk5er/9L5WqiGXg4B6WW48/QwTljZt0Z8dSN0MFCQ?= =?utf-8?q?FrWmJoiPj4JM4X5I3Uob1M/MlccO/NilZ02sszAttrbCXMQuGN3ZCFs7?= =?utf-8?q?Rbil2Nlg0vr5S1vEupdxd0k1MfiirzBz3hBaeSkayYw5oBgPDXGNeW5t?= =?utf-8?q?ks7flvVAv0o3FTzB+46X+1Nq+1P9HsWp8tDhUBm52AL5Cu8an0zMYUfH?= =?utf-8?q?Dzl4?= X-Microsoft-Antispam-Message-Info: zhi+94+smYNWnOONZYZ9cmPwGhsgZcaOnNPDMg+xcQIjNC9xcgCiU+4ePhUHH/oKxFbjYiSyNvg0GT6hC5P/CLjTUddsp6kW7+2P+AXycDRiZ0HNUOZ3+hx6NqouVQlQ/n+nDQQmeurzrqeh8qjaqH+9HXxF6Mq//ui6tPE4R0b0hW9qkl28/HfF/XwMqXpGj05UzbZWlHJMcE4Z2KawlsccZYB5gI7l709wqUMLAik58hEcBwxsWsr1q3K6Gi5EPEmQxd8aliriFZvAmb2jkkHsyYnmZyPXdUsA0+cUrSiHUgXUv6arqc7Ek3yRrHiIXSkFEohnHy6rcFEme/NrFV+68T6GGbKeIS31Tb9ZU/g= X-Microsoft-Exchange-Diagnostics: 1; DB5PR04MB1528; 6:ScXjGXezM6nbl2x4W12JrmuX/MVSfCwm121Vrre7qaEi8iZd1RYvhmDoceeme++X7r+o0ezoaomyf6KDXfTDkD40dz1a/TKdtXvJWFOAwEI2UW4DEbVv/dql2pPxsmMtTFVyskoWpQAB7z4K/a295txFMeniachek13p0TYk4BAVgFcSBX+/WHDZED2UlszZegQNcfRQ53remRe3J6m3TG8E5TPBD18aH6PiUXl4gVYS8Edh1dp8IXE0mLBUpB+Ire1/g7HkhDxvjTyFiySkFM1UHM1dETyYXsYIQIudEPbCRFjQVOJT5ce/gJ9T8kQf4W8VDLduQTqvS3yoCa7DHZz4FMrPI4b7zU/O5GbNoZPHUXCuo7Zlb+YldlYKkXI3UEMwoOpk89VSJbyxpEedCKus0aOykQ7GeTAKRSKl4nKjeHuF68kuivlLOqVIzeFfEO8JqNmm4tZ+dZtjlqnmGQ==; 5:B24PhoNdNoAS3o5JY4Gibp3ys/9cKnc/iNGNE2nyXJFHFuwyTdNNsqXol+rHm21rl3Tho9foAIhThPrGqednyxoCZI1zuwumBcN/oN+V9tN10wxws915csLgJxa+SW0A44kCceI57PGXlVdO9ENovs2SqgDKnmlWH5JivVVXCuY=; 7:2MxxzMkKLujEPp/vadQjCEXlanyOART4wRwb6a7r0hVEETUeOf3cK9smV4KdYZPzLzmAUNZCZTEQRNSL++tFwvgjgICnNdl81IVmI3nZbhul/RWfKhyKzCXyKwGECs4vWHyYf58Gd/HfEx1fRvRzFabPnMl4AVyrEB/CelG8IGi7fpuWfk2qEHCVs49z8JAUn6QEHvUNu39nYSqfX3GCLh3XBLJEDXzVEvEqwniIvAvuJgINPC2TndXQkT5M6jRJ SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-OriginatorOrg: nxp.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 28 Sep 2018 07:46:38.6017 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: eaa4c525-32f0-43a1-4635-08d62516869f X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 686ea1d3-bc2b-4c6f-a92c-d99c5c301635 X-MS-Exchange-Transport-CrossTenantHeadersStamped: DB5PR04MB1528 Subject: [dpdk-dev] [PATCH v4 4/4] doc: add usage doc for ENETC PMD 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: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Add enetc usage document to compile and run the DPDK application on enetc supported platform. This document introduces the enetc driver, supported platforms and supported features. Signed-off-by: Gagandeep Singh --- MAINTAINERS | 7 ++ doc/guides/nics/enetc.rst | 110 +++++++++++++++++++++++++ doc/guides/nics/features/enetc.ini | 11 +++ doc/guides/nics/index.rst | 1 + doc/guides/rel_notes/release_18_11.rst | 6 ++ 5 files changed, 135 insertions(+) create mode 100644 doc/guides/nics/enetc.rst create mode 100644 doc/guides/nics/features/enetc.ini diff --git a/MAINTAINERS b/MAINTAINERS index 9fd258fad..b67f2afa4 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -643,6 +643,13 @@ F: drivers/net/dpaa2/ F: doc/guides/nics/dpaa2.rst F: doc/guides/nics/features/dpaa2.ini +NXP enetc +M: Gagandeep Singh +M: Pankaj Chauhan +F: drivers/net/enetc/ +F: doc/guides/nics/enetc.rst +F: doc/guides/nics/features/enetc.ini + QLogic bnx2x M: Harish Patil M: Rasesh Mody diff --git a/doc/guides/nics/enetc.rst b/doc/guides/nics/enetc.rst new file mode 100644 index 000000000..8038bf205 --- /dev/null +++ b/doc/guides/nics/enetc.rst @@ -0,0 +1,110 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright 2018 NXP + +ENETC Poll Mode Driver +====================== + +The ENETC NIC PMD (**librte_pmd_enetc**) provides poll mode driver +support for the inbuilt NIC found in the **NXP LS1028** SoC. + +More information can be found at `NXP Official Website +`_. + +ENETC +----- + +This section provides an overview of the NXP ENETC +and how it is integrated into the DPDK. + +Contents summary + +- ENETC overview +- ENETC features +- PCI bus driver +- NIC driver +- Supported ENETC SoCs +- Prerequisites +- Driver compilation and testing + +ENETC Overview +~~~~~~~~~~~~~~ + +ENETC is a PCI Integrated End Point(IEP). IEP implements +peripheral devices in an SoC such that software sees them as PCIe device. +ENETC is an evolution of BDR(Buffer Descriptor Ring) based networking +IPs. + +This infrastructure simplifies adding support for IEP and facilitates in following: + +- Device discovery and location +- Resource requirement discovery and allocation (e.g. interrupt assignment, + device register address) +- Event reporting + +ENETC Features +~~~~~~~~~~~~~~ + +- Link Status +- Packet type information + +NIC Driver (PMD) +~~~~~~~~~~~~~~~~ + +ENETC PMD is traditional DPDK PMD which provides necessary interface between +RTE framework and ENETC internal drivers. + +- Driver registers the device vendor table in PCI subsystem. +- RTE framework scans the PCI bus for connected devices. +- This scanning will invoke the probe function of ENETC driver. +- The probe function will set the basic device registers and also setups BD rings. +- On packet Rx the respective BD Ring status bit is set which is then used for + packet processing. +- Then Tx is done first followed by Rx. + +Supported ENETC SoCs +~~~~~~~~~~~~~~~~~~~~ + +- LS1028 + +Prerequisites +~~~~~~~~~~~~~ + +There are three main pre-requisities for executing ENETC PMD on a ENETC +compatible board: + +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 16.04 LTS (Xenial) or 18.04 (Bionic) userland which can be obtained + from `here `_. + +The following dependencies are not part of DPDK and must be installed +separately: + +- **NXP Linux LSDK** + + NXP Layerscape software development kit (LSDK) 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. + + LSDK and related information can be obtained from: `LSDK `_ + +Driver compilation and testing +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Follow instructions available in the document +:ref:`compiling and testing a PMD for a NIC ` +to launch **testpmd** + +To compile in performance mode, please set ``CONFIG_RTE_CACHE_LINE_SIZE=64`` diff --git a/doc/guides/nics/features/enetc.ini b/doc/guides/nics/features/enetc.ini new file mode 100644 index 000000000..69476a2a1 --- /dev/null +++ b/doc/guides/nics/features/enetc.ini @@ -0,0 +1,11 @@ +; +; Supported features of the 'enetc' network poll mode driver. +; +; Refer to default.ini for the full list of available PMD features. +; +[Features] +Packet type parsing = Y +Link status = Y +Linux VFIO = Y +ARMv8 = Y +Usage doc = Y diff --git a/doc/guides/nics/index.rst b/doc/guides/nics/index.rst index 59f6063dc..0323035d3 100644 --- a/doc/guides/nics/index.rst +++ b/doc/guides/nics/index.rst @@ -21,6 +21,7 @@ Network Interface Controller Drivers dpaa2 e1000em ena + enetc enic fm10k i40e diff --git a/doc/guides/rel_notes/release_18_11.rst b/doc/guides/rel_notes/release_18_11.rst index 3ae6b3f58..f4a2535f4 100644 --- a/doc/guides/rel_notes/release_18_11.rst +++ b/doc/guides/rel_notes/release_18_11.rst @@ -50,6 +50,11 @@ New Features * Other libs * Apps, Examples, Tools (if significative) + * **Added NXP ENETC PMD.** + + Added the new enetc driver for NXP enetc platform. See the + "ENETC Poll Mode Driver" document for more details on this new driver. + This section is a comment. Do not overwrite or remove it. Also, make sure to start the actual text at the margin. ========================================================= @@ -156,6 +161,7 @@ The libraries prepended with a plus sign were incremented in this version. librte_pmd_ixgbe.so.2 librte_pmd_dpaa2_cmdif.so.1 librte_pmd_dpaa2_qdma.so.1 + + librte_pmd_enetc.so.1 librte_pmd_ring.so.2 librte_pmd_softnic.so.1 librte_pmd_vhost.so.2