Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/132611/?format=api
{ "id": 132611, "url": "http://patchwork.dpdk.org/api/patches/132611/?format=api", "web_url": "http://patchwork.dpdk.org/project/dpdk/patch/20231013214238.902741-2-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-2-nicolas.chautru@intel.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20231013214238.902741-2-nicolas.chautru@intel.com", "date": "2023-10-13T21:42:37", "name": "[v2,1/2] doc: bbdev device discovery clarification", "commit_ref": null, "pull_url": null, "state": "accepted", "archived": true, "hash": "c246fac2aa457cc1bbc6760b7b175b6d02e87253", "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-2-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/132611/comments/", "check": "success", "checks": "http://patchwork.dpdk.org/api/patches/132611/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 8DD71426DB;\n\tFri, 13 Oct 2023 23:42:46 +0200 (CEST)", "from mails.dpdk.org (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id 1BA534028C;\n\tFri, 13 Oct 2023 23:42:46 +0200 (CEST)", "from mgamail.intel.com (mgamail.intel.com [134.134.136.31])\n by mails.dpdk.org (Postfix) with ESMTP id 651364027D\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:29 -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=1697233364; x=1728769364;\n h=from:to:cc:subject:date:message-id:in-reply-to:\n references:mime-version:content-transfer-encoding;\n bh=aq0DmXjB6iGxe0klfED19KMW51wIEv/MWOVBXHQtI5k=;\n b=RunlASsw8VSsokqEH1p7ovO/AMVTd8xIqXqLb5uTdqRj0HZ84OfuwJ/q\n RAcQK9eNaAhKF6+14+hI1+JHHv4YIGQ1kHptgGRUe3RhUbf4sZJ7Z0phv\n RyPywHss2kDmGGED6f+jmRD2lI6/Z5jOTv2b6njtlco2Y3UwTM43Lp37Q\n 371S+MtwpfiQ8EMSoDcx9pk8RF5SZbM3OxJLdgWnwL93iWv5Ya8KVdoXT\n kDt1bUMI61wWX41vF5J06KXMGpYW4scgmAdZ2+TiZAsFSsmBFasrt3NOT\n dzo7k4xZMECsmy/A6LWjYwjFkk5KHTmgFtDmnWYo9D84M6D/FVFZqSd2T A==;", "X-IronPort-AV": [ "E=McAfee;i=\"6600,9927,10862\"; a=\"449461878\"", "E=Sophos;i=\"6.03,223,1694761200\"; d=\"scan'208\";a=\"449461878\"", "E=McAfee;i=\"6600,9927,10862\"; a=\"748500851\"", "E=Sophos;i=\"6.03,223,1694761200\"; d=\"scan'208\";a=\"748500851\"" ], "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 1/2] doc: bbdev device discovery clarification", "Date": "Fri, 13 Oct 2023 21:42:37 +0000", "Message-Id": "<20231013214238.902741-2-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": "Adding more context and information related the data exposed\nthrough device discovery notably for FEC and FFT operations.\n\nSigned-off-by: Nicolas Chautru <nicolas.chautru@intel.com>\n---\n doc/guides/prog_guide/bbdev.rst | 60 ++++++++++++++++++++++++++++-----\n lib/bbdev/rte_bbdev.h | 6 ++++\n 2 files changed, 57 insertions(+), 9 deletions(-)", "diff": "diff --git a/doc/guides/prog_guide/bbdev.rst b/doc/guides/prog_guide/bbdev.rst\nindex c43e478eda..01a8a6d79b 100644\n--- a/doc/guides/prog_guide/bbdev.rst\n+++ b/doc/guides/prog_guide/bbdev.rst\n@@ -261,16 +261,58 @@ information:\n structure, this is where capabilities reside along with other specifics like:\n maximum queue sizes and priority level.\n \n-.. code-block:: c\n+.. literalinclude:: ../../../lib/bbdev/rte_bbdev.h\n+ :language: c\n+ :start-after: Structure rte_bbdev_driver_info 8<\n+ :end-before: >8 End of structure rte_bbdev_driver_info.\n \n- struct rte_bbdev_info {\n- int socket_id;\n- const char *dev_name;\n- const struct rte_device *device;\n- uint16_t num_queues;\n- bool started;\n- struct rte_bbdev_driver_info drv;\n- };\n+.. literalinclude:: ../../../lib/bbdev/rte_bbdev.h\n+ :language: c\n+ :start-after: Structure rte_bbdev_info 8<\n+ :end-before: >8 End of structure rte_bbdev_info.\n+\n+Capabilities details for LDPC Decoder\n+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n+\n+On top of the ``RTE_BBDEV_LDPC_<*>`` capabilities the device also exposes the LLR numerical\n+representation expected by the decoder as a fractional fixed-point representation.\n+For instance, when the representation (``llr_size``, ``llr_decimals``) = (8, 2) respectively,\n+this means that each input LLR in the data provided by the application must be computed as 8 total\n+bits (including sign bit) where 2 of these are fractions bits (also referred to as S8.2 format).\n+It is up to the user application during LLR generation to scale the LLR according to this\n+optimal numerical representation. Any mis-scaled LLR would cause wireless performance degradation.\n+\n+The ``harq_buffer_size`` exposes the amount of dedicated DDR made available for the device operation.\n+This is specific for accelerator non-integrated on the CPU (separate PCIe device) which may\n+include separate on-card memory.\n+\n+Capabilities details for FFT function\n+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n+\n+The total number of distinct time windows supported for the post-FFT point-wise multiplication is\n+exposed as ``fft_windows_num``. The ``window_index`` provided for each cyclic shift in each\n+``rte_bbdev_op_fft`` operation is expected to be limited to that size.\n+\n+The information related to the width of each of these pre-configured window is also exposed\n+using the ``fft_window_width`` array. This provides the number of non-null samples used for each\n+window index when scaling back the size to a reference of 1024 FFT. The actual shape size is\n+effectively scaled up or down based on the dynamic size of the FFT operation being used.\n+\n+This allows to distinguish different version of the flexible pointwise windowing applied to the\n+FFT and exposes this platform configuration to the application.\n+\n+Other optional capabilities exposed during device discovery\n+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n+\n+The device status can be used to expose additional information related to the state of the\n+platform notably based on its configuration state or related to error management\n+(correctable or non).\n+\n+The queue topology exposed to the device is provided on top of the capabilities. This provides\n+the number of queues available for the exposed bbdev device (the physical device may have more)\n+for each operation as well as the different level of priority available for arbitration.\n+These are based on the arrays and parameters ``num_queues``, ``queue_priority``,\n+``max_num_queues``, ``queue_size_lim``.\n \n \n Operation Processing\ndiff --git a/lib/bbdev/rte_bbdev.h b/lib/bbdev/rte_bbdev.h\nindex d12e2e7fbc..925c78cae1 100644\n--- a/lib/bbdev/rte_bbdev.h\n+++ b/lib/bbdev/rte_bbdev.h\n@@ -313,6 +313,8 @@ int\n rte_bbdev_stats_reset(uint16_t dev_id);\n \n /** Device information supplied by the device's driver */\n+\n+/* Structure rte_bbdev_driver_info 8< */\n struct rte_bbdev_driver_info {\n \t/** Driver name */\n \tconst char *driver_name;\n@@ -352,6 +354,7 @@ struct rte_bbdev_driver_info {\n \t/** FFT windowing width for 2048 FFT - size defined in capability. */\n \tuint16_t *fft_window_width;\n };\n+/* >8 End of structure rte_bbdev_driver_info. */\n \n /** Macro used at end of bbdev PMD list */\n #define RTE_BBDEV_END_OF_CAPABILITIES_LIST() \\\n@@ -361,6 +364,8 @@ struct rte_bbdev_driver_info {\n * Device information structure used by an application to discover a devices\n * capabilities and current configuration\n */\n+\n+/* Structure rte_bbdev_info 8< */\n struct rte_bbdev_info {\n \tint socket_id; /**< NUMA socket that device is on */\n \tconst char *dev_name; /**< Unique device name */\n@@ -369,6 +374,7 @@ struct rte_bbdev_info {\n \tbool started; /**< Set if device is currently started */\n \tstruct rte_bbdev_driver_info drv; /**< Info from device driver */\n };\n+/* >8 End of structure rte_bbdev_info. */\n \n /**\n * Retrieve information about a device.\n", "prefixes": [ "v2", "1/2" ] }