From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from EUR04-HE1-obe.outbound.protection.outlook.com (mail-eopbgr70085.outbound.protection.outlook.com [40.107.7.85]) by dpdk.org (Postfix) with ESMTP id 87F511B2AD for ; Wed, 3 Oct 2018 15:37:20 +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=RyOKIzQii5702r1/HY90ysHd0yDJ0gsRtfO8CsKk6x4=; b=CzoLu8Qc60ytoZArUu3XeVL6KmBl/Jr/S0ca7Qqav1VAgqR/hWt2ZYznCkSi8qpEABQs6nHnrAslj0gqX/l0u/RPioXMABGlQmRE/WaWYO3owTz7ZQTjTzeICbx9L1PNXeN+nuNV187A3ER0w0ToBkSWnbashs77LiS9mulKOzw= Authentication-Results: spf=none (sender IP is ) smtp.mailfrom=G.Singh@nxp.com; Received: from Tophie.ap.freescale.net (14.142.187.166) by AM4PR04MB1521.eurprd04.prod.outlook.com (2a01:111:e400:59e4::19) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.1185.25; Wed, 3 Oct 2018 13:37:17 +0000 From: Gagandeep Singh To: dev@dpdk.org, ferruh.yigit@intel.com Cc: pankaj.chauhan@nxp.com, Gagandeep Singh Date: Wed, 3 Oct 2018 19:06:08 +0530 Message-Id: <20181003133608.3605-5-g.singh@nxp.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20181003133608.3605-1-g.singh@nxp.com> References: <20180928074601.4287-1-g.singh@nxp.com> <20181003133608.3605-1-g.singh@nxp.com> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-Originating-IP: [14.142.187.166] X-ClientProxiedBy: MA1PR01CA0095.INDPRD01.PROD.OUTLOOK.COM (2603:1096:a00:1::11) To AM4PR04MB1521.eurprd04.prod.outlook.com (2a01:111:e400:59e4::19) X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: b72bf684-4f21-46e9-047d-08d6293556c9 X-MS-Office365-Filtering-HT: Tenant X-Microsoft-Antispam: BCL:0; PCL:0; RULEID:(7020095)(4652040)(8989299)(4534185)(7168020)(4627221)(201703031133081)(201702281549075)(8990200)(5600074)(711020)(4618075)(2017052603328)(7153060)(7193020); SRVR:AM4PR04MB1521; X-Microsoft-Exchange-Diagnostics: 1; AM4PR04MB1521; 3:vrKsqfEz2ha1bJjSkmfpzmWMyaazkuK7b2IFj5eF2ITseawUfHJSIippBeWl2HyQUT7vSufCSGePB8WEYwEu4hSx8JL4MFORqfebYjRmYQ6hqliB9+R7jgbFWz2HyiWYXHSSloSakKHwrcBGboH7OcIROud7F42Er5SSZL6qNkEKRZw14fUcAaSsq5dcsciLFnWzEJ2HSx9F6qSuHSUQcPUP7gDxnXPNfWA4v806w6vujZ59UJEx5Q9c4PA5DJ53; 25:q5mZlhEFxeGHyiEffWLfiOWgWRi/8x5P7dsSnrKDTsNfAyESDmBmF/AK8B+zyO0kkjuUiJx30FoxErJcYggetboLq8bFPayIBL6ob2XiO80GtYouvfmyzMZbfOOq9e5uGwUsZ2Nz1WFSR0uW/lGGx37maTzFw9ZnOgqBf6HKQQLuA2/p3E2wj1gEY7T7ayblLKFEk1h6TIUoGDek2wZ7XkHtY67TJWmlikydBoP43VRPohRKLSvmaOaEdPD19hj6C/o/3HJQ5MiXat2Dd3FGjCTtr105+6a1GFBGGkCW5SdFpWKP1fRt3/0UyHkIDDHOvsGS9fnIz1NRbgKLPh0kiQ==; 31:1Of/NXbr+ZKBvIDaEOR/jaiyAMKvBJwfkWQJjWakdmmEZx6/N8oXTSEY11rA2TzrQtuFl8tMZ6Ergqa/7ihGoxmZFe77FOrsZhcUOJkHYszTH/MV7vt9G5OT4lTbLgo5hGS6grgnqhSBc+A+x/yVuE3545DTUDH7tCLnZZbAqJMn2rlCSvXVrsF0WX8Ud6KGnM62tRiIIX1HInN6Zit5yQcNa7iDgX6yw7Bl19CgZZ4= X-MS-TrafficTypeDiagnostic: AM4PR04MB1521: X-Microsoft-Exchange-Diagnostics: 1; AM4PR04MB1521; 20:EcpQKB/VFy/FouZYmAB9XRQMfRYmFlrlsiCbwg0Mg8czCu80rH74qvSfx4hB2/BWvhHhXnM7MbdKdIiEV2RBmf8tM9uIePrJvrIo/PDLZRRNWrV91v+xXh5kbl0XrH/+29Of3XDtQDz18EENyy2r7+5DNt53MOU819h83rGSX9DZA0Ck3U078dmk8WcQpazwlWyqP6ASZBVW9izIpVk3+c/jT1LJqm49uHREW4ZUaHq1iLtuHRxYbK7CA0mKxn1cthu399shwr3XaR28h7hELuwRedNSqP7wAUJDC8OoiXSsbJskOsGQBU7EKZ7XLM9riMvtf8vzXDk/566TmYMi+C9i42ExCpMLrUuCPue/aqWCWV9ZE0f8JZsuq7IJX8bw34tCL11N6w4Fq6LEAdrxYQ5q3ZIWWU4WadBGy+j4EefUoqHk7iF3sarPgn+koKAxq6A0/vKBeUSG5m1zlndrcpOXxQel3ntxvVaIoRNmZ+0hT8w7OB6iPTyiUGC7s0sT; 4:AKB3BLWxd60btGAaI+P60SVhdnfOxvHoAw/G0kAC7x93uIsL8uW7tbSvkLnvJyjjjE5udZFDLs1FcCi9BZC/puW+z7CuU1V2wML1AgDYvhHNlMZ8t6nbnIChtN+2+Rg5bAz7T4Zdwt0nrLjxD1UuFbeTQN1lqpKJtOpxvwqQC62/tpDPqNtWvBdoM/76+sRgfCEaL+TvLe54WlZ4RP8+hCzVUGMvxfF5PSfOB1+Qzpbsvc0pbgkverNDC+uV+1QRmPYlc4wAeDSHn3g6HyT45WzrkCCE+GId1Le0kcMGB8YmBV3wteHgqDVDaPo2jSOesPELUnKzbP2z48+sW0yR+thF39Bdy5cCL0DtXN8RUWnuEBhb4Hdz1iVsEtIwp7JL 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)(93006095)(93001095)(3231355)(944501410)(4982022)(52105095)(10201501046)(3002001)(6055026)(149066)(150057)(6041310)(20161123560045)(20161123558120)(20161123564045)(201703131423095)(201702281528075)(20161123555045)(201703061421075)(201703061406153)(20161123562045)(201708071742011)(7699051); SRVR:AM4PR04MB1521; BCL:0; PCL:0; RULEID:; SRVR:AM4PR04MB1521; X-Forefront-PRVS: 0814A2C7A3 X-Forefront-Antispam-Report: SFV:NSPM; SFS:(10009020)(39860400002)(376002)(346002)(136003)(396003)(366004)(199004)(189003)(6486002)(97736004)(2870700001)(6116002)(3846002)(86362001)(575784001)(106356001)(1076002)(55236004)(53936002)(6512007)(4326008)(2906002)(52116002)(476003)(6506007)(105586002)(386003)(25786009)(6306002)(956004)(81166006)(2616005)(81156014)(47776003)(8936002)(11346002)(446003)(8676002)(66066001)(305945005)(5009440100003)(68736007)(72206003)(26005)(5660300001)(7736002)(76176011)(50226002)(36756003)(486006)(316002)(16526019)(186003)(50466002)(6666003)(478600001)(23676004)(110426005); DIR:OUT; SFP:1101; SCL:1; SRVR:AM4PR04MB1521; H:Tophie.ap.freescale.net; FPR:; SPF:None; LANG:en; PTR:InfoNoRecords; A:1; MX:1; Received-SPF: None (protection.outlook.com: nxp.com does not designate permitted sender hosts) X-Microsoft-Exchange-Diagnostics: =?utf-8?B?MTtBTTRQUjA0TUIxNTIxOzIzOjBnd3NFUERrSm9PQlJ1Vk5nb2hVdEpHbWhk?= =?utf-8?B?NkRqN3Nzbm4zOFpUa0oxTy9acExrYSsxbWtEaXZHTVhhUkRyc04rTXhCVGxC?= =?utf-8?B?K0M4eW5zelByQWVXRmxWTUx2cmxiYTJkM1h3OTl5UVZ0dUR2RnQ1UGhMdm0r?= =?utf-8?B?bWsxM0R1b05LTUloNjh2bEJ6SHFDVkFJZWdTRDJRSG1Ba2tMNnBMK2NiMFBS?= =?utf-8?B?bFNlVUVWdkZzV3FNYkdRRU04a0dSRGUyczFCQ2laM0pobks5ZDFjczF4QWVu?= =?utf-8?B?c1ZtV2ZLV1VJSWRjbGxPNm9mU3hxRFhSK3NRZGIyRTdvdmFrT3Y4b25ReERK?= =?utf-8?B?QS9UNDUzK09lU2tSci9XcEsvR3RSdlFsSUpmbWgyb1ZKREliTUhSZUhwdk95?= =?utf-8?B?akN0TmR0aGZObUNqWFEvWGxzWnFRRUxrMVp4TUhyK2ZJdmpJdFRlNTk2OHc4?= =?utf-8?B?bmtLQ0xjdjBUK0FTQ3lYU25jVXFsOVNHeWhIcGNOUGxxS2xneWp1eDA4aE92?= =?utf-8?B?emNPOCsxVXJMZkRpdEs2Q1NiYzVBTVhOWENjQ1ljWjR3bUtwZ1BEUS9RNlhN?= =?utf-8?B?MzQzWllnekhyTWN2T3F0OVQrd3pvZ0JOMWk0VjM3aW90K1BvdUliTFNXL0dR?= =?utf-8?B?TUIvR1ZTM2kra2ZSVjk0emxTYkJRVlB4dytxR0VmdDFnUFJ0WXZGSjBhTDBH?= =?utf-8?B?b2JmRitaTjVBelBBblVBVzNWeXA3LzZBNjRTTm56OEtFam1wdXdpc0doT2J4?= =?utf-8?B?c3IveGt6cXB2NTRvOUN1WncyekZEWHJKUnpIcGRRdkJrVHU1QlZjM012RHlk?= =?utf-8?B?Y2xnWEo3TUtNZjdxRjBxWFRlWEVQcjRFaVYwRVg3SHRQdU81UUpVT1lRbjdi?= =?utf-8?B?anR3b2Q3Sjhocm0xZE5sQk9rR3EvWUE0OHpCbVBtNEhYblFlbzZHcWlRRFRp?= =?utf-8?B?YUtvdk9rcjArQUlkY0sxNmllRmE3VDhwNXhQZWV1cWVWVkhBTjFUVUdYd1RV?= =?utf-8?B?SERDMGtGVS82ZHBwVXVUbmxLUVZlL014bEQrVG8zRVphajZCYjNUQWhLY2FB?= =?utf-8?B?bnFCdi9mV3hzYlE2TVk4R2FwRWMvcHNzczZrNnlGVFhiL1JYWTU0ckl6MGQv?= =?utf-8?B?T2pFNGsxUzdtZ1dEc3FocitWT1N6MEx1Sm41b3ZTNHlxVFpxRFBGRjNXYTNS?= =?utf-8?B?eDBxTDJCS0RYbUpoSU1PUE1rUnJVVjhOb09JUXVNRVIwSWM1ellQcEZXaVd4?= =?utf-8?B?ajV0bzg3U29BaVhGaVQ4NFUyYm8xME1PK0FZdHhVaWdCZ2V6cUo2MGx4Uzk3?= =?utf-8?B?QmlNV2N6WFZvSUF5M3Y2c0N4R0doZEhabmFUVXRnL3JGUFVhRXNRV1V5Q2w5?= =?utf-8?B?dm45K1d2cVFYWlNQM1NHS3hqRU9WdGhIN29QV2cvVE1rQ2oxbENtRnZzdko4?= =?utf-8?B?YUJzOVAzTjJNSGJCQkg4WlVTa2MyUjlWeWxIVkxFZDkwWEZWT0IwZVRTeUxY?= =?utf-8?B?NW94K2ptdWxBR3pXQ0p2cEZ4aGd3SnR4cW1FdUZJbWx1emN5bm93R01TSTkz?= =?utf-8?B?Mk16d0dsREdQaGEvSGJ0U3R6SGllK2liUVdLenErUWFhMDdPVHdhWUdjQk10?= =?utf-8?B?a0NseldVYSszNWFsYzJEbnpqenV3Z3BwNE5SejE0dnRzcElZZkE0ZFd4MGp1?= =?utf-8?B?WlZocUlOK054dzNaOUgrTFRXeCt2TGZMMEptbkNIaVFsd3R2MVB4VjhsMzhV?= =?utf-8?B?aXViZTRWb3luS1J4K1dQUT09?= X-Microsoft-Antispam-Message-Info: XyC79zBezvsFgxsJ+Om5HiFVJUEDmQ1rmpz9Q/Qz+03oQ+llf5avLKd7sCulsQet8lsliyDT8KuOycA4Hi+DDvcTMnmYT2m6tIr95SuueDqKAEcn6KpzLmB6GdSlViV6XZyLoAlVbd6Fkt0yY7cuBo0hChDSTtLfQqjJ4PGnuXyfRksWtUZO8sc1UDDXJkzV7TB7ixr9kv59/ImYsRfp/bpEuAvsL3OrJgqnRuYH2nXreobnPMnYW0PMmj7qQNdPLXor6FV6vrkvMQlZls9Q4JrMa/HCZCD/y0reU9sOrEcCkCtd7N6QVKc2vXSaPHkhrViTbSdjiYQNffXaFoMwTyd7wQjJt7G3DqagBr2RizM= X-Microsoft-Exchange-Diagnostics: 1; AM4PR04MB1521; 6:jwmnAfcdln+aJOrSkeyvIfiZP83tm7SGN4Icj1GpRvWIcr+qQy1PqfNS5ktbpN+gie35L+DSEv68nh/+xhGR7QEUpgSEZDj0sEcGLzg8rq4a6Zy7VqY/BYtBOKVSHbpCmDasCuT0/zpLEL6v4dMBaH/XVpht3t8N4yRR0r9uNSHyNyuhDatP5HfEMis38dmtrbQXTsf3D+sREW/9E75e6O7wnt0pwLmNnxYsARlIbZ0bZWc344HC8Rbf7f9vXfrfAUg9Bl5A5PMhTGc/ozwZDrA9816rzhM2zdkRqFgvT+0vPQLc04YlvHQub25r1nAJoq7Q5wHTxRPKBzX7UnmzUzeDZiqkgWxpo7NH1t3bqI2rqavVX1sqAgIgxFJpBebLoFaPKuQiAC9sjaV4Za3gEZzdnX3uAc5/ppRhgQOZz9GjEq8HR9WLz/669v/TBrS/2SF4wms3hiR3b67NJVv1xQ==; 5:HNaVFZryPX9vUIGxlUs015oqkBmKKloXSYyZkwF4bXC+LzZ9kE2YW483lycmQdKAjWBcQNkR23P8ptgvchkpb8Y6zu2ogp4OgS+ZhYZkAQs8i+VLy7PF/nZCEE7GNz2B6iSPOmE+0rSc/nj8hhHTtxLLmZKE4GjXkgiH/v2417Y=; 7:RtYFtTmRMxDwMKrqdI1tfxhTfnmNvzu5caaWlYCIUzX70+NClmktcfB8K9Skt/SMeCtzde9san78VsIfNYz+Es7p2o6Mt/fkmzcz69LIwKWS0n+tCBmZRf8KnHsj0A6q1axIg2/mjO0XnCBQRIKlN53aKgpBv3LhVUaHzjj3MpEiV4F6eA94wZAUzhnYgRHAmdL7AEr5wjAL6+Y2tKkTpuFYCybXNAU0CS8kWMzVsLyCx5xRmlfHrciF0rE2ae/I SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-OriginatorOrg: nxp.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 03 Oct 2018 13:37:17.1441 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: b72bf684-4f21-46e9-047d-08d6293556c9 X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 686ea1d3-bc2b-4c6f-a92c-d99c5c301635 X-MS-Exchange-Transport-CrossTenantHeadersStamped: AM4PR04MB1521 Subject: [dpdk-dev] [PATCH v5 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: , X-List-Received-Date: Wed, 03 Oct 2018 13:37:21 -0000 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 | 1 + doc/guides/nics/enetc.rst | 110 +++++++++++++++++++++++++ doc/guides/nics/features/enetc.ini | 1 + doc/guides/nics/index.rst | 1 + doc/guides/rel_notes/release_18_11.rst | 5 ++ 5 files changed, 118 insertions(+) create mode 100644 doc/guides/nics/enetc.rst diff --git a/MAINTAINERS b/MAINTAINERS index 0443addc0..b67f2afa4 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -647,6 +647,7 @@ 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 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 index bd9cb0bc0..69476a2a1 100644 --- a/doc/guides/nics/features/enetc.ini +++ b/doc/guides/nics/features/enetc.ini @@ -8,3 +8,4 @@ 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..1fa7152d2 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. ========================================================= -- 2.17.1