From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 7065443E57 for ; Sat, 13 Apr 2024 14:50:58 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 6A83F402D4; Sat, 13 Apr 2024 14:50:58 +0200 (CEST) Received: from NAM12-MW2-obe.outbound.protection.outlook.com (mail-mw2nam12on2058.outbound.protection.outlook.com [40.107.244.58]) by mails.dpdk.org (Postfix) with ESMTP id A2CE240294 for ; Sat, 13 Apr 2024 14:50:55 +0200 (CEST) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=HpKgg3kQB8x3/i2wbaAwrqzs2nNCwyhdlfOQlRkK7ei61XpBfK2izrfcpSJI9SicrwWnxINtQbHsr9H+ruXlAwHkbQuAOtiWTnsZ2jFIskPZyqUGEmLKtE8s0dmnJrfo0016MzinGZNjqMLvDL3CG66A5FOHtXMPCH5rhcDOmOS3rGtZyqBGwbWeDeKvMZI/vTex+UVjBeE5PIWXWbHMdr7PaEHSj9yDG7o+rHuOeVGrmuu3tHIDUQ7lK7TliDiQXWKmOzpyYse6/L/80uCFk74gaOIb2F/nTz/eoymhWmu9aTPuX97XZSYeYJTWUnt5IAlYiZDT4Gsrb0UqIYGfEQ== 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-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=N+UuZJfFquPTYJOxkSMFTakrlXb1RxydkcRsAHrMlkI=; b=KqWRjMfwosCqYRgHxWvLy9/v5kbqcMxEajju03rbRUb+QnX5EqYUIK4RKvbl7BDMbyPnKOWQUG408EYIY89zBhaycKC4vS2IGakvzDEYCmb9/S4wBljBbQT8OfV2iC3vwYN+sp0fqhPm2/BkSEzW4H30qHAOU6kS/wuyrwZNGeDrz59JKQQPvSDem6bACZCNAgh7K3KePvORrvqx7Nt2rUZvv3hmgN9zHepBYQl/O3jL5F1TmiqWgW9JgwFdYtV63qWSPEwFMMPHWAV20YsiRiUJ7tke9MDVC8WP08Gry0OLUfHi9bKJ2iHZq3FmtO5DeuaCEMfWd5h4Bm2EwdO/1Q== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass (sender ip is 216.228.117.161) smtp.rcpttodomain=intel.com smtp.mailfrom=nvidia.com; dmarc=pass (p=reject sp=reject pct=100) action=none header.from=nvidia.com; dkim=none (message not signed); arc=none (0) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=Nvidia.com; s=selector2; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=N+UuZJfFquPTYJOxkSMFTakrlXb1RxydkcRsAHrMlkI=; b=BOr7e3j/zm4xUc27ydayE3B2CrGnp7xxo4WB8FJl7mOTaePAg4AgtZq1oA3CkoMkT+7udq3t9qvMPQmMzM3Tw3tuk1LUGOfcv+Fn7JGJvG7KrshbEi1dCJN4bdLszmXa73vEl/wWCLrfktSYGU/r5JGF9KwwoWTyH3p4og9BQGjbScP+MFUEMQMJCsf3YI8zHf7px5Jo1b0duKThWJAY6Jbhm9Lctn+bLXyuU1lGurA4FpeAnLE1GCmOhZZsGCkut9zhDaQcuWPBE5JvM3Br5feHiKPfk0fxN1GqRy+eTDjgq5hWp0i5NoPgy18YQfNnD6PwBRiEALXKWoFnFsLmCg== Received: from MN2PR05CA0020.namprd05.prod.outlook.com (2603:10b6:208:c0::33) by SN7PR12MB8004.namprd12.prod.outlook.com (2603:10b6:806:341::7) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7409.46; Sat, 13 Apr 2024 12:50:51 +0000 Received: from BL02EPF00021F6A.namprd02.prod.outlook.com (2603:10b6:208:c0:cafe::f0) by MN2PR05CA0020.outlook.office365.com (2603:10b6:208:c0::33) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7495.16 via Frontend Transport; Sat, 13 Apr 2024 12:50:51 +0000 X-MS-Exchange-Authentication-Results: spf=pass (sender IP is 216.228.117.161) smtp.mailfrom=nvidia.com; dkim=none (message not signed) header.d=none;dmarc=pass action=none header.from=nvidia.com; Received-SPF: Pass (protection.outlook.com: domain of nvidia.com designates 216.228.117.161 as permitted sender) receiver=protection.outlook.com; client-ip=216.228.117.161; helo=mail.nvidia.com; pr=C Received: from mail.nvidia.com (216.228.117.161) by BL02EPF00021F6A.mail.protection.outlook.com (10.167.249.6) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7452.22 via Frontend Transport; Sat, 13 Apr 2024 12:50:51 +0000 Received: from rnnvmail201.nvidia.com (10.129.68.8) by mail.nvidia.com (10.129.200.67) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.986.41; Sat, 13 Apr 2024 05:50:36 -0700 Received: from nvidia.com (10.126.230.35) by rnnvmail201.nvidia.com (10.129.68.8) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.1258.12; Sat, 13 Apr 2024 05:50:34 -0700 From: Xueming Li To: Bruce Richardson CC: Pavan Nikhilesh , Jerin Jacob , dpdk stable Subject: patch 'eventdev: improve Doxygen comments on configure struct' has been queued to stable release 23.11.1 Date: Sat, 13 Apr 2024 20:48:05 +0800 Message-ID: <20240413125005.725659-5-xuemingl@nvidia.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240413125005.725659-1-xuemingl@nvidia.com> References: <20240305094757.439387-1-xuemingl@nvidia.com> <20240413125005.725659-1-xuemingl@nvidia.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Type: text/plain X-Originating-IP: [10.126.230.35] X-ClientProxiedBy: rnnvmail201.nvidia.com (10.129.68.8) To rnnvmail201.nvidia.com (10.129.68.8) X-EOPAttributedMessage: 0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: BL02EPF00021F6A:EE_|SN7PR12MB8004:EE_ X-MS-Office365-Filtering-Correlation-Id: a0518eeb-8cab-4791-b738-08dc5bb85989 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: QoHk7coxdJSBo+f3cPOqhfMyhUa/I0u0L+zqG4z5m46IulciNKJTSY2IFDAEhKYerrUxhQYh0/BUgvxd1gsi9wPVMph8qQA1g+tNWoXZzHa5i9VaziFNsDEEY46Gf6UtrwWW0n6PEmhNDGlX+PbcGivn0ARarOVLfbg8qJcpD339WpIrSpEKIrb84+JQw6OC9PYxCV8teBAC14ixGQDAS3U1egM76H9c89rWFEXNAz+BV6SMj8ybT27nzyKX6LM4kvkcL3AITdjLTBQWoIC/UfibXrnmXsXn1r0WlrbDgaKEGwnA6V7S2GgjpkXmcnolmcRZ5qTnk2mfhjX46TqZlKTIuRtZz1Bky1Rw8Vz97yGvfjwEJxRnxSSx45/MZ98KK0ot8kHPrPHxPOrIUC/W4RPZlEMFwmmimAglcuLEQfoNZklxG9KOL4m++erKzLV8aemCl6Cpb1aJF2O4IvR4D3cXdLIN4zSG0xCAF2yQVLoQvx0cSrmhLJohy2LKjLOrVFQ/lyBixkizTCSPvGURZ/RU3orPr+fRJSIKqo/bNQQEsXZHRYKlYT1mlnSYkVqIKDrKMGXfmgXF8eORe0IyNLvB7kR44SVGft8NbKbuOsB3AiBDzyL1TV+GTmqBZ1PNPrD/ZQJMJ4SiXOt2YrhdcJ4sECMrQ1XD+nTkj4pH02kLPHyf7yntAxSp/nLpkfgJk05J1LpNtFzLhuKwbjEPDQ5EhO6LwjjrqHnATrqvxIOlvnfteM3DoBuVgJXc7rrd X-Forefront-Antispam-Report: CIP:216.228.117.161; CTRY:US; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:mail.nvidia.com; PTR:dc6edge2.nvidia.com; CAT:NONE; SFS:(13230031)(36860700004)(376005)(1800799015)(82310400014); DIR:OUT; SFP:1101; X-OriginatorOrg: Nvidia.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 13 Apr 2024 12:50:51.1887 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: a0518eeb-8cab-4791-b738-08dc5bb85989 X-MS-Exchange-CrossTenant-Id: 43083d15-7273-40c1-b7db-39efd9ccc17a X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=43083d15-7273-40c1-b7db-39efd9ccc17a; Ip=[216.228.117.161]; Helo=[mail.nvidia.com] X-MS-Exchange-CrossTenant-AuthSource: BL02EPF00021F6A.namprd02.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: SN7PR12MB8004 X-BeenThere: stable@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: patches for DPDK stable branches List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: stable-bounces@dpdk.org Hi, FYI, your patch has been queued to stable release 23.11.1 Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet. It will be pushed if I get no objections before 04/15/24. So please shout if anyone has objections. Also note that after the patch there's a diff of the upstream commit vs the patch applied to the branch. This will indicate if there was any rebasing needed to apply to the stable branch. If there were code changes for rebasing (ie: not only metadata diffs), please double check that the rebase was correctly done. Queued patches are on a temporary branch at: https://git.dpdk.org/dpdk-stable/log/?h=23.11-staging This queued commit can be viewed at: https://git.dpdk.org/dpdk-stable/commit/?h=23.11-staging&id=2faf71417f2c08153a844df70beae6ff68a20e5b Thanks. Xueming Li --- >From 2faf71417f2c08153a844df70beae6ff68a20e5b Mon Sep 17 00:00:00 2001 From: Bruce Richardson Date: Wed, 21 Feb 2024 10:32:15 +0000 Subject: [PATCH] eventdev: improve Doxygen comments on configure struct Cc: Xueming Li [ upstream commit 1203462c5ada21bdace88e009db5a8f17f88528a ] General rewording and cleanup on the rte_event_dev_config structure. Improved the wording of some sentences and created linked cross-references out of the existing references to the dev_info structure. As part of the rework, fix issue with how single-link port-queue pairs were counted in the rte_event_dev_config structure. This did not match the actual implementation and, if following the documentation, certain valid port/queue configurations would have been impossible to configure. Fix this by changing the documentation to match the implementation Bugzilla ID: 1368 Fixes: 75d113136f38 ("eventdev: express DLB/DLB2 PMD constraints") Signed-off-by: Bruce Richardson Acked-by: Pavan Nikhilesh Acked-by: Jerin Jacob --- lib/eventdev/rte_eventdev.h | 61 ++++++++++++++++++++++--------------- 1 file changed, 37 insertions(+), 24 deletions(-) diff --git a/lib/eventdev/rte_eventdev.h b/lib/eventdev/rte_eventdev.h index ec9b02455d..a3e2f9f862 100644 --- a/lib/eventdev/rte_eventdev.h +++ b/lib/eventdev/rte_eventdev.h @@ -515,9 +515,9 @@ rte_event_dev_attr_get(uint8_t dev_id, uint32_t attr_id, struct rte_event_dev_config { uint32_t dequeue_timeout_ns; /**< rte_event_dequeue_burst() timeout on this device. - * This value should be in the range of *min_dequeue_timeout_ns* and - * *max_dequeue_timeout_ns* which previously provided in - * rte_event_dev_info_get() + * This value should be in the range of @ref rte_event_dev_info.min_dequeue_timeout_ns and + * @ref rte_event_dev_info.max_dequeue_timeout_ns returned by + * @ref rte_event_dev_info_get() * The value 0 is allowed, in which case, default dequeue timeout used. * @see RTE_EVENT_DEV_CFG_PER_DEQUEUE_TIMEOUT */ @@ -525,40 +525,53 @@ struct rte_event_dev_config { /**< In a *closed system* this field is the limit on maximum number of * events that can be inflight in the eventdev at a given time. The * limit is required to ensure that the finite space in a closed system - * is not overwhelmed. The value cannot exceed the *max_num_events* - * as provided by rte_event_dev_info_get(). - * This value should be set to -1 for *open system*. + * is not exhausted. + * The value cannot exceed @ref rte_event_dev_info.max_num_events + * returned by rte_event_dev_info_get(). + * + * This value should be set to -1 for *open systems*, that is, + * those systems returning -1 in @ref rte_event_dev_info.max_num_events. + * + * @see rte_event_port_conf.new_event_threshold */ uint8_t nb_event_queues; /**< Number of event queues to configure on this device. - * This value cannot exceed the *max_event_queues* which previously - * provided in rte_event_dev_info_get() + * This value *includes* any single-link queue-port pairs to be used. + * This value cannot exceed @ref rte_event_dev_info.max_event_queues + + * @ref rte_event_dev_info.max_single_link_event_port_queue_pairs + * returned by rte_event_dev_info_get(). + * The number of non-single-link queues i.e. this value less + * *nb_single_link_event_port_queues* in this struct, cannot exceed + * @ref rte_event_dev_info.max_event_queues */ uint8_t nb_event_ports; /**< Number of event ports to configure on this device. - * This value cannot exceed the *max_event_ports* which previously - * provided in rte_event_dev_info_get() + * This value *includes* any single-link queue-port pairs to be used. + * This value cannot exceed @ref rte_event_dev_info.max_event_ports + + * @ref rte_event_dev_info.max_single_link_event_port_queue_pairs + * returned by rte_event_dev_info_get(). + * The number of non-single-link ports i.e. this value less + * *nb_single_link_event_port_queues* in this struct, cannot exceed + * @ref rte_event_dev_info.max_event_ports */ uint32_t nb_event_queue_flows; - /**< Number of flows for any event queue on this device. - * This value cannot exceed the *max_event_queue_flows* which previously - * provided in rte_event_dev_info_get() + /**< Max number of flows needed for a single event queue on this device. + * This value cannot exceed @ref rte_event_dev_info.max_event_queue_flows + * returned by rte_event_dev_info_get() */ uint32_t nb_event_port_dequeue_depth; - /**< Maximum number of events can be dequeued at a time from an - * event port by this device. - * This value cannot exceed the *max_event_port_dequeue_depth* - * which previously provided in rte_event_dev_info_get(). + /**< Max number of events that can be dequeued at a time from an event port on this device. + * This value cannot exceed @ref rte_event_dev_info.max_event_port_dequeue_depth + * returned by rte_event_dev_info_get(). * Ignored when device is not RTE_EVENT_DEV_CAP_BURST_MODE capable. - * @see rte_event_port_setup() + * @see rte_event_port_setup() rte_event_dequeue_burst() */ uint32_t nb_event_port_enqueue_depth; - /**< Maximum number of events can be enqueued at a time from an - * event port by this device. - * This value cannot exceed the *max_event_port_enqueue_depth* - * which previously provided in rte_event_dev_info_get(). + /**< Maximum number of events can be enqueued at a time to an event port on this device. + * This value cannot exceed @ref rte_event_dev_info.max_event_port_enqueue_depth + * returned by rte_event_dev_info_get(). * Ignored when device is not RTE_EVENT_DEV_CAP_BURST_MODE capable. - * @see rte_event_port_setup() + * @see rte_event_port_setup() rte_event_enqueue_burst() */ uint32_t event_dev_cfg; /**< Event device config flags(RTE_EVENT_DEV_CFG_)*/ @@ -568,7 +581,7 @@ struct rte_event_dev_config { * queues; this value cannot exceed *nb_event_ports* or * *nb_event_queues*. If the device has ports and queues that are * optimized for single-link usage, this field is a hint for how many - * to allocate; otherwise, regular event ports and queues can be used. + * to allocate; otherwise, regular event ports and queues will be used. */ }; -- 2.34.1 --- Diff of the applied patch vs upstream commit (please double-check if non-empty: --- --- - 2024-04-13 20:43:05.350252471 +0800 +++ 0005-eventdev-improve-Doxygen-comments-on-configure-struc.patch 2024-04-13 20:43:04.897754062 +0800 @@ -1 +1 @@ -From 1203462c5ada21bdace88e009db5a8f17f88528a Mon Sep 17 00:00:00 2001 +From 2faf71417f2c08153a844df70beae6ff68a20e5b Mon Sep 17 00:00:00 2001 @@ -4,0 +5,3 @@ +Cc: Xueming Li + +[ upstream commit 1203462c5ada21bdace88e009db5a8f17f88528a ] @@ -19 +21,0 @@ -Cc: stable@dpdk.org @@ -29 +31 @@ -index 9808889625..fb1c4429f0 100644 +index ec9b02455d..a3e2f9f862 100644 @@ -32 +34 @@ -@@ -684,9 +684,9 @@ rte_event_dev_attr_get(uint8_t dev_id, uint32_t attr_id, +@@ -515,9 +515,9 @@ rte_event_dev_attr_get(uint8_t dev_id, uint32_t attr_id, @@ -45 +47 @@ -@@ -694,40 +694,53 @@ struct rte_event_dev_config { +@@ -525,40 +525,53 @@ struct rte_event_dev_config { @@ -119 +121 @@ -@@ -737,7 +750,7 @@ struct rte_event_dev_config { +@@ -568,7 +581,7 @@ struct rte_event_dev_config {