Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/132612/?format=api
{ "id": 132612, "url": "http://patchwork.dpdk.org/api/patches/132612/?format=api", "web_url": "http://patchwork.dpdk.org/project/dpdk/patch/20231013214238.902741-3-nicolas.chautru@intel.com/", "project": { "id": 1, "url": "http://patchwork.dpdk.org/api/projects/1/?format=api", "name": "DPDK", "link_name": "dpdk", "list_id": "dev.dpdk.org", "list_email": "dev@dpdk.org", "web_url": "http://core.dpdk.org", "scm_url": "git://dpdk.org/dpdk", "webscm_url": "http://git.dpdk.org/dpdk", "list_archive_url": "https://inbox.dpdk.org/dev", "list_archive_url_format": "https://inbox.dpdk.org/dev/{}", "commit_url_format": "" }, "msgid": "<20231013214238.902741-3-nicolas.chautru@intel.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20231013214238.902741-3-nicolas.chautru@intel.com", "date": "2023-10-13T21:42:38", "name": "[v2,2/2] doc/guides: refer to generic bbdev test section", "commit_ref": null, "pull_url": null, "state": "accepted", "archived": true, "hash": "d86e31e008325712b4f60a83cdef5a14cdfb85dc", "submitter": { "id": 1314, "url": "http://patchwork.dpdk.org/api/people/1314/?format=api", "name": "Chautru, Nicolas", "email": "nicolas.chautru@intel.com" }, "delegate": { "id": 2642, "url": "http://patchwork.dpdk.org/api/users/2642/?format=api", "username": "mcoquelin", "first_name": "Maxime", "last_name": "Coquelin", "email": "maxime.coquelin@redhat.com" }, "mbox": "http://patchwork.dpdk.org/project/dpdk/patch/20231013214238.902741-3-nicolas.chautru@intel.com/mbox/", "series": [ { "id": 29840, "url": "http://patchwork.dpdk.org/api/series/29840/?format=api", "web_url": "http://patchwork.dpdk.org/project/dpdk/list/?series=29840", "date": "2023-10-13T21:42:37", "name": "doc/guides: bbdev clean up", "version": 2, "mbox": "http://patchwork.dpdk.org/series/29840/mbox/" } ], "comments": "http://patchwork.dpdk.org/api/patches/132612/comments/", "check": "warning", "checks": "http://patchwork.dpdk.org/api/patches/132612/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "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])\n\tby inbox.dpdk.org (Postfix) with ESMTP id C310C426DB;\n\tFri, 13 Oct 2023 23:42:51 +0200 (CEST)", "from mails.dpdk.org (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id 31005402E6;\n\tFri, 13 Oct 2023 23:42:47 +0200 (CEST)", "from mgamail.intel.com (mgamail.intel.com [134.134.136.31])\n by mails.dpdk.org (Postfix) with ESMTP id 154794027D\n for <dev@dpdk.org>; Fri, 13 Oct 2023 23:42:44 +0200 (CEST)", "from orsmga007.jf.intel.com ([10.7.209.58])\n by orsmga104.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384;\n 13 Oct 2023 14:42:30 -0700", "from spr-npg-bds1-eec2.sn.intel.com (HELO spr-npg-bds1-eec2..)\n ([10.233.181.123])\n by orsmga007.jf.intel.com with ESMTP; 13 Oct 2023 14:42:30 -0700" ], "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/simple;\n d=intel.com; i=@intel.com; q=dns/txt; s=Intel;\n t=1697233365; x=1728769365;\n h=from:to:cc:subject:date:message-id:in-reply-to:\n references:mime-version:content-transfer-encoding;\n bh=UwOXE4MQQBas29vaMcH63QGm5Bkk0FfT5TagCFqDvWg=;\n b=Xq8wBXtPJDb83o/bnaNIANNbaNh04WCK32PY4I/nt4bqyfbgd3AaX1NK\n 1HplcJAuy0YSuHn7l4yONWaVwddMy2zBuAb0+QWIwuEYvrHRU463UApdO\n NNgqmR5GULSwoBnhM7Wt2tHfsYvWoXidpuj0B6dd3XJa3SvXU7MXmmhPL\n BubMeZhPaS7aLYdisZsgnLnQ1lf8fQIgpER0GRmZlXd3pTBreCeCrTPLy\n zQtuTMdzys73K7yMeBaXfA/ZVVDWR/rhARTv8xdec1HLLHyGR7bJsmE0O\n eAzLBUf79NNTZxfGUJx0RtZu0rFGy2lXPUOq1oCdS6sbypfAJO6vxC/S7 g==;", "X-IronPort-AV": [ "E=McAfee;i=\"6600,9927,10862\"; a=\"449461881\"", "E=Sophos;i=\"6.03,223,1694761200\"; d=\"scan'208\";a=\"449461881\"", "E=McAfee;i=\"6600,9927,10862\"; a=\"748500854\"", "E=Sophos;i=\"6.03,223,1694761200\"; d=\"scan'208\";a=\"748500854\"" ], "X-ExtLoop1": "1", "From": "Nicolas Chautru <nicolas.chautru@intel.com>", "To": "dev@dpdk.org,\n\tmaxime.coquelin@redhat.com", "Cc": "hemant.agrawal@nxp.com, david.marchand@redhat.com,\n hernan.vargas@intel.com,\n Nicolas Chautru <nicolas.chautru@intel.com>", "Subject": "[PATCH v2 2/2] doc/guides: refer to generic bbdev test section", "Date": "Fri, 13 Oct 2023 21:42:38 +0000", "Message-Id": "<20231013214238.902741-3-nicolas.chautru@intel.com>", "X-Mailer": "git-send-email 2.34.1", "In-Reply-To": "<20231013214238.902741-1-nicolas.chautru@intel.com>", "References": "<20231013214238.902741-1-nicolas.chautru@intel.com>", "MIME-Version": "1.0", "Content-Transfer-Encoding": "8bit", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.29", "Precedence": "list", "List-Id": "DPDK patches and discussions <dev.dpdk.org>", "List-Unsubscribe": "<https://mails.dpdk.org/options/dev>,\n <mailto:dev-request@dpdk.org?subject=unsubscribe>", "List-Archive": "<http://mails.dpdk.org/archives/dev/>", "List-Post": "<mailto:dev@dpdk.org>", "List-Help": "<mailto:dev-request@dpdk.org?subject=help>", "List-Subscribe": "<https://mails.dpdk.org/listinfo/dev>,\n <mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org" }, "content": "Avoiding duplication among each PMD doc, now referring directly to the\nrelevant details section.\n\nSigned-off-by: Nicolas Chautru <nicolas.chautru@intel.com>\n---\n doc/guides/bbdevs/acc100.rst | 33 +++---------------------\n doc/guides/bbdevs/fpga_5gnr_fec.rst | 39 +++-------------------------\n doc/guides/bbdevs/fpga_lte_fec.rst | 40 +++--------------------------\n doc/guides/bbdevs/la12xx.rst | 32 +++--------------------\n doc/guides/bbdevs/vrb1.rst | 36 +++-----------------------\n doc/guides/bbdevs/vrb2.rst | 36 +++-----------------------\n doc/guides/tools/testbbdev.rst | 2 ++\n 7 files changed, 22 insertions(+), 196 deletions(-)", "diff": "diff --git a/doc/guides/bbdevs/acc100.rst b/doc/guides/bbdevs/acc100.rst\nindex 8a275dcdd4..b9443adf4e 100644\n--- a/doc/guides/bbdevs/acc100.rst\n+++ b/doc/guides/bbdevs/acc100.rst\n@@ -190,37 +190,10 @@ Test Application\n ----------------\n \n BBDEV provides a test application, ``test-bbdev.py`` and range of test data for testing\n-the functionality of the device 5G/4G FEC encode and decode, depending on the device's\n-capabilities. The test application is located under app->test-bbdev folder and has the\n-following options:\n+the functionality of the device, depending on the device's capabilities.\n \n-.. code-block:: console\n-\n- \"-p\", \"--testapp-path\": specifies path to the bbdev test app.\n- \"-e\", \"--eal-params\"\t: EAL arguments which are passed to the test app.\n- \"-t\", \"--timeout\"\t: Timeout in seconds (default=300).\n- \"-c\", \"--test-cases\"\t: Defines test cases to run. Run all if not specified.\n- \"-v\", \"--test-vector\"\t: Test vector path (default=dpdk_path+/app/test-bbdev/test_vectors/bbdev_null.data).\n- \"-n\", \"--num-ops\"\t: Number of operations to process on device (default=32).\n- \"-b\", \"--burst-size\"\t: Operations enqueue/dequeue burst size (default=32).\n- \"-s\", \"--snr\"\t\t: SNR in dB used when generating LLRs for bler tests.\n- \"-s\", \"--iter_max\"\t: Number of iterations for LDPC decoder.\n- \"-l\", \"--num-lcores\"\t: Number of lcores to run (default=16).\n- \"-i\", \"--init-device\" : Initialise PF device with default values.\n-\n-\n-To execute the test application tool using simple decode or encode data,\n-type one of the following:\n-\n-.. code-block:: console\n-\n- ./test-bbdev.py -c validation -n 64 -b 1 -v ./ldpc_dec_default.data\n- ./test-bbdev.py -c validation -n 64 -b 1 -v ./ldpc_enc_default.data\n-\n-\n-The test application ``test-bbdev.py``, supports the ability to configure the PF device with\n-a default set of values, if the \"-i\" or \"- -init-device\" option is included. The default values\n-are defined in test_bbdev_perf.c.\n+For more details on how to use the test application,\n+see :ref:`test_bbdev_application`.\n \n \n Test Vectors\ndiff --git a/doc/guides/bbdevs/fpga_5gnr_fec.rst b/doc/guides/bbdevs/fpga_5gnr_fec.rst\nindex 9d71585e9e..84340b18f0 100644\n--- a/doc/guides/bbdevs/fpga_5gnr_fec.rst\n+++ b/doc/guides/bbdevs/fpga_5gnr_fec.rst\n@@ -227,43 +227,10 @@ Test Application\n ----------------\n \n BBDEV provides a test application, ``test-bbdev.py`` and range of test data for testing\n-the functionality of FPGA 5GNR FEC encode and decode, depending on the device's\n-capabilities. The test application is located under app->test-bbdev folder and has the\n-following options:\n+the functionality of the device, depending on the device's capabilities.\n \n-.. code-block:: console\n-\n- \"-p\", \"--testapp-path\": specifies path to the bbdev test app.\n- \"-e\", \"--eal-params\"\t: EAL arguments which are passed to the test app.\n- \"-t\", \"--timeout\"\t: Timeout in seconds (default=300).\n- \"-c\", \"--test-cases\"\t: Defines test cases to run. Run all if not specified.\n- \"-v\", \"--test-vector\"\t: Test vector path (default=dpdk_path+/app/test-bbdev/test_vectors/bbdev_null.data).\n- \"-n\", \"--num-ops\"\t: Number of operations to process on device (default=32).\n- \"-b\", \"--burst-size\"\t: Operations enqueue/dequeue burst size (default=32).\n- \"-l\", \"--num-lcores\"\t: Number of lcores to run (default=16).\n- \"-i\", \"--init-device\" : Initialise PF device with default values.\n-\n-\n-To execute the test application tool using simple decode or encode data,\n-type one of the following:\n-\n-.. code-block:: console\n-\n- ./test-bbdev.py -c validation -n 64 -b 1 -v ./ldpc_dec_default.data\n- ./test-bbdev.py -c validation -n 64 -b 1 -v ./ldpc_enc_default.data\n-\n-\n-The test application ``test-bbdev.py``, supports the ability to configure the PF device with\n-a default set of values, if the \"-i\" or \"- -init-device\" option is included. The default values\n-are defined in test_bbdev_perf.c as:\n-\n-- VF_UL_QUEUE_VALUE 4\n-- VF_DL_QUEUE_VALUE 4\n-- UL_BANDWIDTH 3\n-- DL_BANDWIDTH 3\n-- UL_LOAD_BALANCE 128\n-- DL_LOAD_BALANCE 128\n-- FLR_TIMEOUT 610\n+For more details on how to use the test application,\n+see :ref:`test_bbdev_application`.\n \n \n Test Vectors\ndiff --git a/doc/guides/bbdevs/fpga_lte_fec.rst b/doc/guides/bbdevs/fpga_lte_fec.rst\nindex c3379c24e3..5b2029c864 100644\n--- a/doc/guides/bbdevs/fpga_lte_fec.rst\n+++ b/doc/guides/bbdevs/fpga_lte_fec.rst\n@@ -226,44 +226,10 @@ Test Application\n ----------------\n \n BBDEV provides a test application, ``test-bbdev.py`` and range of test data for testing\n-the functionality of FPGA LTE FEC turbo encode and turbo decode, depending on the device's\n-capabilities. The test application is located under app->test-bbdev folder and has the\n-following options:\n-\n-.. code-block:: console\n-\n- \"-p\", \"--testapp-path\": specifies path to the bbdev test app.\n- \"-e\", \"--eal-params\"\t: EAL arguments which are passed to the test app.\n- \"-t\", \"--timeout\"\t: Timeout in seconds (default=300).\n- \"-c\", \"--test-cases\"\t: Defines test cases to run. Run all if not specified.\n- \"-v\", \"--test-vector\"\t: Test vector path (default=dpdk_path+/app/test-bbdev/test_vectors/bbdev_null.data).\n- \"-n\", \"--num-ops\"\t: Number of operations to process on device (default=32).\n- \"-b\", \"--burst-size\"\t: Operations enqueue/dequeue burst size (default=32).\n- \"-l\", \"--num-lcores\"\t: Number of lcores to run (default=16).\n- \"-i\", \"--init-device\" : Initialise PF device with default values.\n-\n-\n-To execute the test application tool using simple turbo decode or turbo encode data,\n-type one of the following:\n-\n-.. code-block:: console\n-\n- ./test-bbdev.py -c validation -n 64 -b 8 -v ./turbo_dec_default.data\n- ./test-bbdev.py -c validation -n 64 -b 8 -v ./turbo_enc_default.data\n-\n-\n-The test application ``test-bbdev.py``, supports the ability to configure the PF device with\n-a default set of values, if the \"-i\" or \"- -init-device\" option is included. The default values\n-are defined in test_bbdev_perf.c as:\n-\n-- VF_UL_QUEUE_VALUE 4\n-- VF_DL_QUEUE_VALUE 4\n-- UL_BANDWIDTH 3\n-- DL_BANDWIDTH 3\n-- UL_LOAD_BALANCE 128\n-- DL_LOAD_BALANCE 128\n-- FLR_TIMEOUT 610\n+the functionality of the device, depending on the device's capabilities.\n \n+For more details on how to use the test application,\n+see :ref:`test_bbdev_application`.\n \n Test Vectors\n ~~~~~~~~~~~~\ndiff --git a/doc/guides/bbdevs/la12xx.rst b/doc/guides/bbdevs/la12xx.rst\nindex 5cc5d46921..9df4a39725 100644\n--- a/doc/guides/bbdevs/la12xx.rst\n+++ b/doc/guides/bbdevs/la12xx.rst\n@@ -83,36 +83,10 @@ Test Application\n ----------------\n \n BBDEV provides a test application, ``test-bbdev.py`` and range of test data for testing\n-the functionality of LA12xx for FEC encode and decode, depending on the device\n-capabilities. The test application is located under app->test-bbdev folder and has the\n-following options:\n+the functionality of the device, depending on the device's capabilities.\n \n-.. code-block:: console\n-\n- \"-p\", \"--testapp-path\": specifies path to the bbdev test app.\n- \"-e\", \"--eal-params\"\t: EAL arguments which are passed to the test app.\n- \"-t\", \"--timeout\"\t: Timeout in seconds (default=300).\n- \"-c\", \"--test-cases\"\t: Defines test cases to run. Run all if not specified.\n- \"-v\", \"--test-vector\"\t: Test vector path (default=dpdk_path+/app/test-bbdev/test_vectors/bbdev_null.data).\n- \"-n\", \"--num-ops\"\t: Number of operations to process on device (default=32).\n- \"-b\", \"--burst-size\"\t: Operations enqueue/dequeue burst size (default=32).\n- \"-s\", \"--snr\"\t\t: SNR in dB used when generating LLRs for bler tests.\n- \"-s\", \"--iter_max\"\t: Number of iterations for LDPC decoder.\n- \"-l\", \"--num-lcores\"\t: Number of lcores to run (default=16).\n- \"-i\", \"--init-device\" : Initialise PF device with default values.\n-\n-\n-To execute the test application tool using simple decode or encode data,\n-type one of the following:\n-\n-.. code-block:: console\n-\n- ./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\n- ./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\n-\n-The test application ``test-bbdev.py``, supports the ability to configure the PF device with\n-a default set of values, if the \"-i\" or \"- -init-device\" option is included. The default values\n-are defined in test_bbdev_perf.c.\n+For more details on how to use the test application,\n+see :ref:`test_bbdev_application`.\n \n \n Test Vectors\ndiff --git a/doc/guides/bbdevs/vrb1.rst b/doc/guides/bbdevs/vrb1.rst\nindex fdefb20651..776b9e69ac 100644\n--- a/doc/guides/bbdevs/vrb1.rst\n+++ b/doc/guides/bbdevs/vrb1.rst\n@@ -192,39 +192,11 @@ which sets up the parameters defined in the compatible ``acc200_conf`` structure\n Test Application\n ----------------\n \n-The bbdev class is provided with a test application, ``test-bbdev.py``\n-and range of test data for testing the functionality of the device,\n-depending on the device's capabilities.\n-The test application is located under app/test-bbdev folder\n-and has the following options:\n+BBDEV provides a test application, ``test-bbdev.py`` and range of test data for testing\n+the functionality of the device, depending on the device's capabilities.\n \n-.. code-block:: console\n-\n- \"-p\", \"--testapp-path\": specifies path to the bbdev test app.\n- \"-e\", \"--eal-params\": EAL arguments which are passed to the test app.\n- \"-t\", \"--timeout\": Timeout in seconds (default=300).\n- \"-c\", \"--test-cases\": Defines test cases to run. Run all if not specified.\n- \"-v\", \"--test-vector\": Test vector path.\n- \"-n\", \"--num-ops\": Number of operations to process on device (default=32).\n- \"-b\", \"--burst-size\": Operations enqueue/dequeue burst size (default=32).\n- \"-s\", \"--snr\": SNR in dB used when generating LLRs for bler tests.\n- \"-s\", \"--iter_max\": Number of iterations for LDPC decoder.\n- \"-l\", \"--num-lcores\": Number of lcores to run (default=16).\n- \"-i\", \"--init-device\": Initialise PF device with default values.\n-\n-\n-To execute the test application tool using simple decode or encode data,\n-type one of the following:\n-\n-.. code-block:: console\n-\n- ./test-bbdev.py -c validation -n 64 -b 1 -v ./ldpc_dec_default.data\n- ./test-bbdev.py -c validation -n 64 -b 1 -v ./ldpc_enc_default.data\n-\n-\n-The test application ``test-bbdev.py``, supports the ability to configure the\n-PF device with a default set of values, if the \"-i\" or \"- -init-device\" option\n-is included. The default values are defined in test_bbdev_perf.c.\n+For more details on how to use the test application,\n+see :ref:`test_bbdev_application`.\n \n \n Test Vectors\ndiff --git a/doc/guides/bbdevs/vrb2.rst b/doc/guides/bbdevs/vrb2.rst\nindex 2a30002e05..12b7bf6e64 100644\n--- a/doc/guides/bbdevs/vrb2.rst\n+++ b/doc/guides/bbdevs/vrb2.rst\n@@ -141,39 +141,11 @@ which sets up the parameters defined in the compatible ``rte_acc_conf`` structur\n Test Application\n ----------------\n \n-The bbdev class is provided with a test application, ``test-bbdev.py``\n-and range of test data for testing the functionality of the device,\n-depending on the device's capabilities.\n-The test application is located under app/test-bbdev folder\n-and has the following options:\n+BBDEV provides a test application, ``test-bbdev.py`` and range of test data for testing\n+the functionality of the device, depending on the device's capabilities.\n \n-.. code-block:: console\n-\n- \"-p\", \"--testapp-path\": specifies path to the bbdev test app.\n- \"-e\", \"--eal-params\": EAL arguments which are passed to the test app.\n- \"-t\", \"--timeout\": Timeout in seconds (default=300).\n- \"-c\", \"--test-cases\": Defines test cases to run. Run all if not specified.\n- \"-v\", \"--test-vector\": Test vector path.\n- \"-n\", \"--num-ops\": Number of operations to process on device (default=32).\n- \"-b\", \"--burst-size\": Operations enqueue/dequeue burst size (default=32).\n- \"-s\", \"--snr\": SNR in dB used when generating LLRs for bler tests.\n- \"-s\", \"--iter_max\": Number of iterations for LDPC decoder.\n- \"-l\", \"--num-lcores\": Number of lcores to run (default=16).\n- \"-i\", \"--init-device\": Initialise PF device with default values.\n-\n-\n-To execute the test application tool using simple decode or encode data,\n-type one of the following:\n-\n-.. code-block:: console\n-\n- ./test-bbdev.py -c validation -n 64 -b 1 -v ./ldpc_dec_default.data\n- ./test-bbdev.py -c validation -n 64 -b 1 -v ./ldpc_enc_default.data\n-\n-\n-The test application ``test-bbdev.py``, supports the ability to configure the\n-PF device with a default set of values, if the \"-i\" or \"- -init-device\" option\n-is included. The default values are defined in test_bbdev_perf.c.\n+For more details on how to use the test application,\n+see :ref:`test_bbdev_application`.\n \n \n Test Vectors\ndiff --git a/doc/guides/tools/testbbdev.rst b/doc/guides/tools/testbbdev.rst\nindex 54a9c44dc3..ddb8d787be 100644\n--- a/doc/guides/tools/testbbdev.rst\n+++ b/doc/guides/tools/testbbdev.rst\n@@ -1,6 +1,8 @@\n .. SPDX-License-Identifier: BSD-3-Clause\n Copyright(c) 2017 Intel Corporation\n \n+.. _test_bbdev_application:\n+\n dpdk-test-bbdev Application\n ===========================\n \n", "prefixes": [ "v2", "2/2" ] }