From patchwork Tue Apr 13 05:17:13 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Hemant Agrawal X-Patchwork-Id: 91196 X-Patchwork-Delegate: gakhil@marvell.com Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 7329CA0524; Tue, 13 Apr 2021 07:19:13 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 084BA160B39; Tue, 13 Apr 2021 07:18:50 +0200 (CEST) Received: from EUR01-HE1-obe.outbound.protection.outlook.com (mail-eopbgr130055.outbound.protection.outlook.com [40.107.13.55]) by mails.dpdk.org (Postfix) with ESMTP id BE4A4160B2F for ; Tue, 13 Apr 2021 07:18:48 +0200 (CEST) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=Qaz0XR5jW66O3cN6JfqLHrYZdZi7iO2rjTjla2U2dmZ2n5aiCuI4jiiavMoZ50eQtIMve15P6enFyzSfZ6q4mKFsBHMdozwFNyuqXlull13CYY0EcP8/36CukdZx2cXmBDmdG79ReqxWmljfQhNLoMjSz2G7AhZPq5HWcFm//DVyFynRSJrXy9FsAGRltw/klDNXIfX5JOtA+arMlmpLqOb3A1J42yQsgeP6LowscVVIPMtSiQFT3wuDA7mj1pq+kFWRcDYqSgLtXmJKXLQSyS411rOMF3qLk6P0V7tjAYdS5qE1pqqjDC5FoX0w3JbdNvuXfTKcNTid5v0FOKdalQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=e2NdDSfc2Eo8QRAMh0pJKTz1RyqHaOJHv5XZoHnf/P8=; b=eTM4UtFu1/fvvvhV6Krgiv7dwT0erNkCY5jGGInKoOm9XMrlx4bhWgqNoBAsldfh9IrUs8ustnyvAUpCY7SV4SYpf0oM6mr1iQfQ7Ne8F8hnTa/iTh/wJ0F2Z7aNnZQseHKdnNuhu/j/nJr9Ejel/4L7eHUtQE53krlXuu3TzNdsyVmVR2KP7YHim35TITdA8xSGAJlcBusGMLqXcas0OsIzPz7yXHCpXDJe8z1vliRh6yBWj1bqyfNFhFcesL7zqGlcTRDrYSZIb6EdfvRcUwnrBJ57jAqZ3CM7EYDZjMxRnkbALDDiXzcCMRcFy5TF6HoMCkvgxtwgtuOEWRBSug== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=nxp.com; dmarc=pass action=none header.from=nxp.com; dkim=pass header.d=nxp.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=nxp.com; s=selector2; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=e2NdDSfc2Eo8QRAMh0pJKTz1RyqHaOJHv5XZoHnf/P8=; b=nPJtXAmOv2sMrHJVr8VhJxaZOwpDZ6NEAk2xy8KB1LNrg4/PYdA1UtXM5Y+RocR2kqVWZLk45CE72SjK7cdImoeNYv5kU7lhnK1UDkiB+kXpi6/aN59IoENWtWIS56ZkU8q4ek8CICvyi0o9sbvx4GIR9qk8/3AUwpZI2TuZw6s= Authentication-Results: dpdk.org; dkim=none (message not signed) header.d=none;dpdk.org; dmarc=none action=none header.from=nxp.com; Received: from AM6PR04MB4456.eurprd04.prod.outlook.com (2603:10a6:20b:22::25) by AM5PR04MB3250.eurprd04.prod.outlook.com (2603:10a6:206:b::23) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4020.22; Tue, 13 Apr 2021 05:18:47 +0000 Received: from AM6PR04MB4456.eurprd04.prod.outlook.com ([fe80::ad9e:a38e:e84e:bf55]) by AM6PR04MB4456.eurprd04.prod.outlook.com ([fe80::ad9e:a38e:e84e:bf55%7]) with mapi id 15.20.4020.022; Tue, 13 Apr 2021 05:18:47 +0000 From: Hemant Agrawal To: dev@dpdk.org, gakhil@marvell.com, nicolas.chautru@intel.com Cc: david.marchand@redhat.com, Hemant Agrawal , Nipun Gupta Date: Tue, 13 Apr 2021 10:47:13 +0530 Message-Id: <20210413051715.26430-7-hemant.agrawal@nxp.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20210413051715.26430-1-hemant.agrawal@nxp.com> References: <20210410170252.4587-1-hemant.agrawal@nxp.com> <20210413051715.26430-1-hemant.agrawal@nxp.com> X-Originating-IP: [92.120.0.67] X-ClientProxiedBy: HK2PR03CA0059.apcprd03.prod.outlook.com (2603:1096:202:17::29) To AM6PR04MB4456.eurprd04.prod.outlook.com (2603:10a6:20b:22::25) MIME-Version: 1.0 X-MS-Exchange-MessageSentRepresentingType: 1 Received: from dpdk-xeon.ap.freescale.net (92.120.0.67) by HK2PR03CA0059.apcprd03.prod.outlook.com (2603:1096:202:17::29) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4042.6 via Frontend Transport; Tue, 13 Apr 2021 05:18:45 +0000 X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: e5f44b02-dcc7-424d-a3da-08d8fe3b9da1 X-MS-TrafficTypeDiagnostic: AM5PR04MB3250: X-MS-Exchange-Transport-Forked: True X-Microsoft-Antispam-PRVS: X-MS-Oob-TLC-OOBClassifiers: OLM:4125; X-MS-Exchange-SenderADCheck: 1 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: kZGZRtDwe9RLcq78UeLROd2JWH/iRPKH1jxBotk3iNFMzPiA4ogwEi2Asb7gfTlvwIA0xL9eQYF/YYtvXC8E+/3J8NFRUxubo1VxLxZph0ocZhooXp3/FUaYvnOJluZHf/eln1gnmAue75VH813T5eP+KvhOZ9G3UEiajym5n/Dj60s1M1tx0ErPZTTiQiKnhS9hF+qlIKaSbmKTN99JG090+EIszHCuRT8PPHX7LZuIrzBaEv+wd37RsKOY6QsQZcEaiduXx1sX4qVTPtkUbMoQdv7c+9pLA9C9CeOQi65x4vIXameBfdG0EoCsQPLoMlaBOOd2f3v3aT8Mmt/YfaLgaz76vq3zHz50NzEcvBSTehgRoluwnMfVHgZIHvvZyw0mLaS6IjAhZZWlz04v5SmgCMYkIy+b9kqtcD9jZPylgibDqZSqb/kWLtYxbOLzNRx9nwjX9AecLNtx8CDS/HdfIXqm76Wt5XWWcMXPGRFhLkMKAW7Apy32ucuaKZw9aX13bzTOnzqWYBkGsCZ16V4DwGraQizqt2dT6PxLG5lR0G4xlWxseXRn+aHXMoFVgUElVOYDmuAtjOMnjcEEegFbfOH3H9/ORbOQ+xS7+jgK4qNNYp+lGvT2XTWtRZcAaLlmkEcYAKE/7HnksHR8NTtENIClvYY4jYV60QFZ+RkeVrH70kncHVFzn9gO0IE5aaUE3+eNPvZJ0HpbrYtENrzIvlrRiY2pVqYtkfL0u8W4tMPhTdtnq+GunYA6Nl5L X-Forefront-Antispam-Report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:AM6PR04MB4456.eurprd04.prod.outlook.com; PTR:; CAT:NONE; SFS:(4636009)(346002)(396003)(39860400002)(366004)(136003)(376002)(83380400001)(16526019)(186003)(26005)(54906003)(38350700002)(38100700002)(316002)(66556008)(66946007)(66476007)(6512007)(2616005)(956004)(478600001)(4326008)(44832011)(36756003)(6486002)(6506007)(5660300002)(2906002)(52116002)(1076003)(86362001)(8936002)(6666004)(8676002); DIR:OUT; SFP:1101; X-MS-Exchange-AntiSpam-MessageData: YQ4hBq8JUWSVSY8rnq110zZkqzibpmFOpyGg+G4gIRJwN0BZMW46SP4lfUmG8FTIWtjJS2xJh9/31ZP2vxAcgej84kTAwcBjDu4PAuolePxl6ckHZ2TNdD+/bXEsXHZCSfBThZMvL95XDa8U8hk1gviXxPTd5ZDpS+pPVHCwAeM+sGUA4jRWpfYxxZ3Xfw3pWa6YfG2Fk8tVenFhp6UXMThat6ocPPQkQcf0qpbU/zFlUljcbzFkNdPfO+fVKSQgAMcDdbV8NZmK22ylbE+5JhDOm7vKdQkAzTnffc0kiVJRvutd+tbFIzlMsGVtgWqg08OKyazJNJ5izeIibhL7H5t07GtrUDqQO5m+c9ajUyZN2cC3Xl/RqE2OJGrTlqxNCBb0v0BQLERzP4vuos025cvC1LyiwUwCPckyTdynbb8pN3oSigBBTmnoFPVJHT0lfbo+W3DQHcTiKhSG2/f2zblanaPq3tYPTktCbwaWaInn2K1OWr+m9ww6BBAu37Jl9E7tDkXecE0x/b2MVjb/KqiN1wzZoJnm2ebUhMmMp4SqfzOC/93LcSv0xCmE15BuFUUzFgEBN5oVO5Ie0Rl5PkSthbyq0/iVpTauRGiGlJqMy56OI0NWRmM1Lo5zGG392LSNB6ZeLbRruHjcjUxpLKtCMI0+TrxjnqjEolIB1kfYkgT2TwIIe0ECF1o/+J9ohKJZBfKdM3Afvr2gtUM0+cZp1X8X5kbjIBatEYeZz2VVYblbdmvgdjMco/kYagNjy/KMtmuuhuQ2Ul9S5ZLNhfW2TMF/mH492oPMLmfeR0PZ5NlJ0oa7tCKnxoZr8YXeOE0pGiQtORRYCtzRQg0JXsQWk155CzZa5GgmH53iv3d7uVuQ7Q2Cb2JpDVifJ+IactTf3wDkNz08y5DJ32Ta6qeu/QLGKJdeBH17BHzuFuZAhZq31VDfOovQlCjQnmCSsUFef3YpTLR+cCmBTwC913X8jgv8SdMHsMe8t+zpHrdlnR2qLtGrxMdjxEunNAv5ZNV1pBs9bs4B5QDshjSyLOWcvaNdp03sMDsfhoe0azg/woFITETd6/8P3oyvYmHQsaMdKdP4mQi59VZ2SHPOdcGzfIdhvTB25TPlz3CB+VWBLqSuYlp8Kf1RSmEl5Tg/fMpWb+sKGWjrkELhSosGCooB9EliJlnbJQWQLxPtw8l8LQodP5dI4d7Z1rb42V+jIk16YxRZy8osqD5VSI8qpiF27MgWwZ425wfN9NWtuoi947fDeqbJbGBtWDkiGGpvyFphTQgin7KsXxUeDHiVPlbHJdWbm3U29wLZ0JVWj+Km+KCn/RsGMHZjGNQ7uHbI X-OriginatorOrg: nxp.com X-MS-Exchange-CrossTenant-Network-Message-Id: e5f44b02-dcc7-424d-a3da-08d8fe3b9da1 X-MS-Exchange-CrossTenant-AuthSource: AM6PR04MB4456.eurprd04.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 13 Apr 2021 05:18:47.6525 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 686ea1d3-bc2b-4c6f-a92c-d99c5c301635 X-MS-Exchange-CrossTenant-MailboxType: HOSTED X-MS-Exchange-CrossTenant-UserPrincipalName: H5vsnQYEmWfxU0Zu/zNHFn8FirjwMUqLzW5hrNG1MSiI41nA6B1Z0KK5wKpLEsNXvo6KtbEjEwnvY5eM7bpwXA== X-MS-Exchange-Transport-CrossTenantHeadersStamped: AM5PR04MB3250 Subject: [dpdk-dev] [PATCH v3 6/8] baseband/la12xx: add documentation support X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 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" This patch add documentation for LA12xx PMD. Signed-off-by: Nipun Gupta Signed-off-by: Hemant Agrawal --- MAINTAINERS | 9 ++ doc/guides/bbdevs/features/la12xx.ini | 14 +++ doc/guides/bbdevs/index.rst | 1 + doc/guides/bbdevs/la12xx.rst | 139 +++++++++++++++++++++++++ doc/guides/rel_notes/release_21_05.rst | 5 + 5 files changed, 168 insertions(+) create mode 100644 doc/guides/bbdevs/features/la12xx.ini create mode 100644 doc/guides/bbdevs/la12xx.rst diff --git a/MAINTAINERS b/MAINTAINERS index e746ef1d32..24081fceb3 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -1289,6 +1289,15 @@ F: doc/guides/rawdevs/ntb.rst F: examples/ntb/ F: doc/guides/sample_app_ug/ntb.rst +Baseband Drivers +------------------- + +NXP LA12xx +M: Hemant Agrawal +M: Nipun Gupta +F: drivers/baseband/la12xx/ +F: doc/guides/bbdevs/la12xx.rst +F: doc/guides/bbdevs/features/la12xx.ini Packet processing ----------------- diff --git a/doc/guides/bbdevs/features/la12xx.ini b/doc/guides/bbdevs/features/la12xx.ini new file mode 100644 index 0000000000..979d9dd224 --- /dev/null +++ b/doc/guides/bbdevs/features/la12xx.ini @@ -0,0 +1,14 @@ +; +; Supported features of the 'la12xx' bbdev driver. +; +; Refer to default.ini for the full list of available PMD features. +; +[Features] +Turbo Decoder (4G) = N +Turbo Encoder (4G) = N +LDPC Decoder (5G) = Y +LDPC Encoder (5G) = Y +LLR/HARQ Compression = N +External DDR Access = Y +HW Accelerated = Y +BBDEV API = Y diff --git a/doc/guides/bbdevs/index.rst b/doc/guides/bbdevs/index.rst index 4445cbd1b0..cedd706fa6 100644 --- a/doc/guides/bbdevs/index.rst +++ b/doc/guides/bbdevs/index.rst @@ -14,3 +14,4 @@ Baseband Device Drivers fpga_lte_fec fpga_5gnr_fec acc100 + la12xx diff --git a/doc/guides/bbdevs/la12xx.rst b/doc/guides/bbdevs/la12xx.rst new file mode 100644 index 0000000000..1cadd6f337 --- /dev/null +++ b/doc/guides/bbdevs/la12xx.rst @@ -0,0 +1,139 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright 2021 NXP + +NXP LA12xx Poll Mode Driver +======================================= + +The BBDEV LA12xx poll mode driver (PMD) supports an implementation for +offloading High Phy processing functions like LDPC Encode / Decode 5GNR wireless +acceleration function, using PCI based LA12xx Software defined radio. + +More information can be found at `NXP Official Website +`_. + +Features +-------- + +LA12xx PMD supports the following features: + +- LDPC Encode in the DL +- LDPC Decode in the UL +- Maximum of 8 UL queues +- Maximum of 8 DL queues +- PCIe Gen-3 x8 Interface +- MSI-X + +LA12xx PMD supports the following BBDEV capabilities: + +* For the LDPC encode operation: + - ``RTE_BBDEV_LDPC_CRC_24B_ATTACH`` : set to attach CRC24B to CB(s) + - ``RTE_BBDEV_LDPC_RATE_MATCH`` : if set then do not do Rate Match bypass + +* For the LDPC decode operation: + - ``RTE_BBDEV_LDPC_CRC_TYPE_24B_CHECK`` : check CRC24B from CB(s) + - ``RTE_BBDEV_LDPC_CRC_TYPE_24B_DROP`` : drops CRC24B bits appended while decoding + - ``RTE_BBDEV_LDPC_DEC_SCATTER_GATHER`` : supports scatter-gather for input/output data + +Installation +------------ + +Section 3 of the DPDK manual provides instructions on installing and compiling DPDK. + +DPDK requires hugepages to be configured as detailed in section 2 of the DPDK manual. + +Initialization +-------------- + +The device can be listed on the host console with: + + +Use the following lspci command to get the multiple LA12xx processor ids. The +device ID of the LA12xx baseband processor is "1c30". + +.. code-block:: console + + sudo lspci -nn + +... +0001:01:00.0 Power PC [0b20]: Freescale Semiconductor Inc Device [1957:1c30] ( +rev 10) +... +0002:01:00.0 Power PC [0b20]: Freescale Semiconductor Inc Device [1957:1c30] ( +rev 10) + + +Prerequisites +------------- + +Currently supported by DPDK: + +- NXP LA1224 BSP **1.0+**. +- NXP LA1224 PCIe Modem card connected to ARM host. + +- Follow the DPDK :ref:`Getting Started Guide for Linux ` to setup the basic DPDK environment. + +* Use dev arg option ``modem=0`` to identify the modem instance for a given + device. This is required only if more than 1 modem cards are attached to host. + this is optional and the default value is 0. + e.g. ``--vdev=baseband_la12xx,modem=0`` + +* Use dev arg option ``max_nb_queues=x`` to specify the maximum number of queues + to be used for communication with offload device i.e. modem. default is 16. + e.g. ``--vdev=baseband_la12xx,max_nb_queues=4`` + +Enabling logs +------------- + +For enabling logs, use the following EAL parameter: + +.. code-block:: console + + ./your_bbdev_application --log-level=la12xx: + +Using ``bb.la12xx`` as log matching criteria, all Baseband PMD logs can be +enabled which are lower than logging ``level``. + + +Test Application +---------------- + +BBDEV provides a test application, ``test-bbdev.py`` and range of test data for testing +the functionality of LA12xx for FEC encode and decode, depending on the device +capabilities. The test application is located under app->test-bbdev folder and has the +following options: + +.. code-block:: console + + "-p", "--testapp-path": specifies path to the bbdev test app. + "-e", "--eal-params" : EAL arguments which are passed to the test app. + "-t", "--timeout" : Timeout in seconds (default=300). + "-c", "--test-cases" : Defines test cases to run. Run all if not specified. + "-v", "--test-vector" : Test vector path (default=dpdk_path+/app/test-bbdev/test_vectors/bbdev_null.data). + "-n", "--num-ops" : Number of operations to process on device (default=32). + "-b", "--burst-size" : Operations enqueue/dequeue burst size (default=32). + "-s", "--snr" : SNR in dB used when generating LLRs for bler tests. + "-s", "--iter_max" : Number of iterations for LDPC decoder. + "-l", "--num-lcores" : Number of lcores to run (default=16). + "-i", "--init-device" : Initialise PF device with default values. + + +To execute the test application tool using simple decode or encode data, +type one of the following: + +.. code-block:: console + + ./test-bbdev.py -e="--vdev=baseband_la12xx,socket_id=0,max_nb_queues=8" -c validation -n 64 -b 1 -v ./ldpc_dec_default.data + ./test-bbdev.py -e="--vdev=baseband_la12xx,socket_id=0,max_nb_queues=8" -c validation -n 64 -b 1 -v ./ldpc_enc_default.data + +The test application ``test-bbdev.py``, supports the ability to configure the PF device with +a default set of values, if the "-i" or "- -init-device" option is included. The default values +are defined in test_bbdev_perf.c. + + +Test Vectors +~~~~~~~~~~~~ + +In addition to the simple LDPC decoder and LDPC encoder tests, bbdev also provides +a range of additional tests under the test_vectors folder, which may be useful. The results +of these tests will depend on the LA12xx FEC capabilities which may cause some +testcases to be skipped, but no failure should be reported. diff --git a/doc/guides/rel_notes/release_21_05.rst b/doc/guides/rel_notes/release_21_05.rst index 6f5858c8f6..61797e2a43 100644 --- a/doc/guides/rel_notes/release_21_05.rst +++ b/doc/guides/rel_notes/release_21_05.rst @@ -130,6 +130,11 @@ New Features * Added command to display Rx queue used descriptor count. ``show port (port_id) rxq (queue_id) desc used count`` +* **Added NXP LA12xx baseband PMD.** + + Added a new baseband PMD driver for NXP LA12xx Software defined radio. + + See the :doc:`../bbdevs/la12xx` for more details. Removed Items -------------