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 CB53343A21; Wed, 31 Jan 2024 17:16:08 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 76F1C4026B; Wed, 31 Jan 2024 17:16:08 +0100 (CET) Received: from mgamail.intel.com (mgamail.intel.com [192.55.52.120]) by mails.dpdk.org (Postfix) with ESMTP id ED5F440269 for ; Wed, 31 Jan 2024 17:16:06 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1706717766; x=1738253766; h=date:from:to:cc:subject:message-id:references: content-transfer-encoding:in-reply-to:mime-version; bh=7V25PV06xAX0ebF2fzaV36JGQfHNtCjxG4iwroRDKAQ=; b=bkrB8ZKZGF3EsNGJnDamr0QfpMuGJEKfUrLAmMkuRJf84RTZBNPwGZyy efnZpGD6wNHodTRpHldF0eNru/PeM76pIjQHAYd/REZa5X+xo3qzW8bbl flnczdUbbQIz7tgzxSfFaKemO+ManTbCPnVZhLevGGJJsho/G+hWss2d/ o94zmUf0wpxXSK5/EhqUIy+27kjAry6TjWhBGJKy+8ZY124iLk0H+jRcO IPqiKucRzfNt5NqRjHFkz9Dd2aFaY8/RaQyeFXZYSy8DhKCCQNIUTzxhZ 4j/1GusSXwVBt6CG7Kh2WI934lEG1L+yiqPSj7usRPX9B3p2ytPTXWWvs w==; X-IronPort-AV: E=McAfee;i="6600,9927,10969"; a="402493974" X-IronPort-AV: E=Sophos;i="6.05,231,1701158400"; d="scan'208";a="402493974" Received: from fmsmga003.fm.intel.com ([10.253.24.29]) by fmsmga104.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 31 Jan 2024 08:16:04 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=McAfee;i="6600,9927,10969"; a="878818495" X-IronPort-AV: E=Sophos;i="6.05,231,1701158400"; d="scan'208";a="878818495" Received: from fmsmsx602.amr.corp.intel.com ([10.18.126.82]) by FMSMGA003.fm.intel.com with ESMTP/TLS/AES256-GCM-SHA384; 31 Jan 2024 08:16:05 -0800 Received: from fmsmsx610.amr.corp.intel.com (10.18.126.90) by fmsmsx602.amr.corp.intel.com (10.18.126.82) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.35; Wed, 31 Jan 2024 08:16:03 -0800 Received: from fmsedg602.ED.cps.intel.com (10.1.192.136) by fmsmsx610.amr.corp.intel.com (10.18.126.90) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.35 via Frontend Transport; Wed, 31 Jan 2024 08:16:03 -0800 Received: from NAM10-DM6-obe.outbound.protection.outlook.com (104.47.58.101) by edgegateway.intel.com (192.55.55.71) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.1.2507.35; Wed, 31 Jan 2024 08:15:58 -0800 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=mXwBDnyyLJ/g4yIGeRUOhbz0nnIFgxuYi6lAolo0BLas+ZtZIWgDKhLx0GEXEGd0awVXau26I5jxhQibQXVzl3J+81goKUa1mnnX5dBDd2aue9e/kcU95um84TA+8iNfp5YXtL35zx0FqHeqTbg8UkOkFJxXlaxsEFXlQln9XMez0Bfck4Y8cVkd7BJ7462optyLqyO6itvZRxh0vxz7ggytB+8trptEEsg3kjZizSgYNSwwfE2OS9maL3Bb8IO+o+lyu92T2BZ4YF8zQxx1WW0TBFkRwbq6PSSMwrgaljnQP7FpsIZs49gQtCV2BFHkphoXFpotKIM9w34xyEvpMA== 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=uG/4poTMisfEcETIxjjeOB5C4YMgjhN3q2dn6fyl/Jo=; b=IBieGjJgZ2riQQvlT6hPlDfdNcvxmK38WQQUyJZgvajjFX1cnYNC+rb45KjOwFCJhZd7XqE0zoaXtI1mdYoDqGZ//Ookh3EYj3Ljl+MJ6qjwJ916/d4tVMI/RrGW+XeVgoj3XHShLA5CoOkHsGwP+Yx0vn8QJc13DRqKIwLR5qtE6AqMeYdXmvQMnwmuiygn7EIJsYvnbPWlCE2IPypkCnaNmxUU4im82yVXjzp8T8gQAkyRItSc1XOqEj5wX/TwMl4+mNInpPsaCXX12Dh7HJNVJXDEjhmr/AiXLI9tsNukAEe04BbOnh/JybivzhBe4U0YM8U8uFhP8ID/S1i9Jg== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=intel.com; dmarc=pass action=none header.from=intel.com; dkim=pass header.d=intel.com; arc=none Authentication-Results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=intel.com; Received: from DS0PR11MB7309.namprd11.prod.outlook.com (2603:10b6:8:13e::17) by SJ0PR11MB4943.namprd11.prod.outlook.com (2603:10b6:a03:2ad::17) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7249.23; Wed, 31 Jan 2024 16:15:56 +0000 Received: from DS0PR11MB7309.namprd11.prod.outlook.com ([fe80::df88:b743:97f8:516c]) by DS0PR11MB7309.namprd11.prod.outlook.com ([fe80::df88:b743:97f8:516c%5]) with mapi id 15.20.7249.017; Wed, 31 Jan 2024 16:15:56 +0000 Date: Wed, 31 Jan 2024 16:15:51 +0000 From: Bruce Richardson To: Mattias =?iso-8859-1?Q?R=F6nnblom?= CC: , , , , , , , Subject: Re: [PATCH v2 06/11] eventdev: improve doxygen comments on configure struct Message-ID: References: <20240118134557.73172-1-bruce.richardson@intel.com> <20240119174346.108905-1-bruce.richardson@intel.com> <20240119174346.108905-7-bruce.richardson@intel.com> Content-Type: text/plain; charset="iso-8859-1" Content-Disposition: inline Content-Transfer-Encoding: 8bit In-Reply-To: X-ClientProxiedBy: DU7PR01CA0014.eurprd01.prod.exchangelabs.com (2603:10a6:10:50f::21) To DS0PR11MB7309.namprd11.prod.outlook.com (2603:10b6:8:13e::17) MIME-Version: 1.0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: DS0PR11MB7309:EE_|SJ0PR11MB4943:EE_ X-MS-Office365-Filtering-Correlation-Id: c0c1d1a8-2e22-49f1-bd4d-08dc2277e7d0 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: kN9GeXCZW9kScK5xfQYsUT+jOGcaE506kHzTndnWweckobkcDyVlF00bf7jlwCVnlSj/ZoV1xbZeVPZ6WFlJsybwRCe7HpITMAO/BvYL1g+9Pas/BKY65Lb83DpfaJjn0c1Nb8XBXGR9QH/7SJI0jcRRvXWlsvz97ZKC0XJJ9TTQOz09Y9ymemBRrgI1C+Dr2x6oGq76R7l8N3CM4AHXmb01UiYx39xQeJE8fWb20VJ8xGKTyD4zqWWrlkpG8lQ7y0BxRTvJZpSi6s0dGkMmpAhqIz7siZlsgq6+CkSDUhVuEDuzC/if8bgM5Ea+ZWKJCh0KyOSPZcEUNkZvFExUHr4cJF0SDsmJe4zpXSaAcqHZgOWDbKBQYwhE9+1JBGAAPLAd1GnyUGlEK/d4W3QKLlGe70bo9BRg3Z+5EJEcSq6tr9BpT52xYNdT2zqqtv4BLiwPfbY1t+olpq12P2oofTDbyFQ9oE8tynMRw5qDzARy/dAKj0PmZiJyrpOF8FUEn14SaNlFTDMTqsWsXnoYwsjFZxiBNKHl6DqDnVE70A4od12LEziKOQeElk1QDHhZ X-Forefront-Antispam-Report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:DS0PR11MB7309.namprd11.prod.outlook.com; PTR:; CAT:NONE; SFS:(13230031)(396003)(346002)(136003)(39860400002)(376002)(366004)(230922051799003)(64100799003)(451199024)(1800799012)(186009)(82960400001)(44832011)(316002)(296002)(66946007)(6916009)(66556008)(66476007)(2906002)(8676002)(4326008)(8936002)(6512007)(86362001)(5660300002)(38100700002)(83380400001)(107886003)(66574015)(26005)(6666004)(6486002)(6506007)(41300700001)(478600001)(53546011); DIR:OUT; SFP:1101; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?iso-8859-1?Q?FuMfiDcLmoDTxgpovl9sd+bUm6a6+bDfURvNPII6QR4usBH3/zopuyyNw4?= =?iso-8859-1?Q?2wWmHpAD8K3PzpNk/YeaXmWLifzrSHqML6NUxe/1aMyP+8Ix+2TnHXjveR?= =?iso-8859-1?Q?whe1UNs6DT4YrviMBD/pYVSxLt0tAfuwp68r+PzM+djrmlQgIYqtlpPyjh?= =?iso-8859-1?Q?o00Xa8HTTfJIExObpZHGG/NY+QIp9cM+d65t0yc7BNlwosI4EGTPZIGhOJ?= =?iso-8859-1?Q?16R4K/groNzawZ4my+KynWZpIL8/khuU0OTy9NKQ5phiek4S24DmlWjVy0?= =?iso-8859-1?Q?su195Kz0OOG6ZeEdHx76V/8MiCPKh5TmmISQ8ODJ+4Kjzhs1qFAd07iC7w?= =?iso-8859-1?Q?8UQb1jVw+++pBS7BtoAUCCs0dk9Sddnu3oZAwAyN2/xcfX03Zl7uv6PwgE?= =?iso-8859-1?Q?o7P4ZKPeRpCbb5B3LmVTncHqDZH5nFFWsq6YVAMCCHEGSbbGGWYp3GfLD4?= =?iso-8859-1?Q?G3kl5RgTf2xJeEm0Raumw1xTw9d/eZqj/bYWq43qhsEN2PzWDcRkE1CwlY?= =?iso-8859-1?Q?2Gwh0dQRgye2Htqp1Y1446hajeviO1qa3i9rdsmzoNwE6TBDku1T8pM/Qk?= =?iso-8859-1?Q?yqqOIh1Y3GzYQGoyHO4d68T3hC910ZzmX3OAjWKp4z7Ew/9GkPv2+JW2g6?= =?iso-8859-1?Q?NTHNQICwNGBu0HmhEjp36v8sKApaTpLWld2tXnDnivRIii4TS3A0dsHMHC?= =?iso-8859-1?Q?tw9XIHm5eegUCVI2Ob+gCnoUDPy1iaxF66DVZfAiDX86jwJQ8nVTTXfR39?= =?iso-8859-1?Q?zYLPfD07RnyA5rnoFcfK0G3Olnhq1wz0vcOo39FCQ97TmKZ7tVs+/NR4Vg?= =?iso-8859-1?Q?qn+OUiNK51YzbbV23R7p7PvOd5WFCTkTLObL7bTuKdSku1OJHLgFJ4I4PD?= =?iso-8859-1?Q?0a8OmioatN+ncajhkGKgQr/JAD7zWARSQE1NHXrsxINRNtGpumsMpjF5dF?= =?iso-8859-1?Q?RI45PKLsx9Cvp3szdxS9qb2x+EMyZuOk1yM8hgGIdD+zV9VlVVBm3W6kOT?= =?iso-8859-1?Q?SoIDN7ik7D8PfbFELEcadVHg7DfOjugxKKiV46iiIYqvo4jW5GL4LNdSp3?= =?iso-8859-1?Q?cTGb8sr2u+mvb+d/GW0Ow+cGhL/kvvlX5nE5JoNprPYIY5Re2TMONxCr4q?= =?iso-8859-1?Q?JJ1fs/tljZ1/Up1kIkLpeTEGTQZXUa1trYiycwOWrlRdQUBwLPGZdhVUos?= =?iso-8859-1?Q?110ZKRteJGKXQkEwR2ETTazZpMmzzKPqf6SkEuC0PybqO40Vugt9zvoOFP?= =?iso-8859-1?Q?T+gzLXOU1+pfMNR1AmhlsEDbkeHtG6kqQipZMH+KgmuBCbPRkY5/SQFeB1?= =?iso-8859-1?Q?EwDHOLX5UZepP12YVmiBCqjphyNB3DpYoS4bEgSmzSSWS1c1ahWkX9/MWd?= =?iso-8859-1?Q?zATgDIclODTlzSOFdVqkU8cghWTzwvaEFwOxaJPJLKgzC8jmqenqVAbXTn?= =?iso-8859-1?Q?no6GJ6GUnvJQ9+ZsfqeSThiTvvtE2BIbG45NtBzEE4FNowyf519AqwZMAx?= =?iso-8859-1?Q?OyvQqy9usUWnzw3yezSW3MdCzEs86E93bgs0Nqurn6li0kqD90XgHtoBoM?= =?iso-8859-1?Q?zfdGJjdahPwG9vpkR4nWyNOjhA7+KmZYOnoq2NTUduqXGLu4q35JvhZDXB?= =?iso-8859-1?Q?hrQ9Aw9JjRxMjXQh14xaMayQSAa+MtI/zkFcfxM0nSCSn+Wxy1/NmZ1g?= =?iso-8859-1?Q?=3D=3D?= X-MS-Exchange-CrossTenant-Network-Message-Id: c0c1d1a8-2e22-49f1-bd4d-08dc2277e7d0 X-MS-Exchange-CrossTenant-AuthSource: DS0PR11MB7309.namprd11.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 31 Jan 2024 16:15:56.7176 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 46c98d88-e344-4ed4-8496-4ed7712e255d X-MS-Exchange-CrossTenant-MailboxType: HOSTED X-MS-Exchange-CrossTenant-UserPrincipalName: DUedemn9C4SLO7AIBs5+oC8Noi6B4wFz1z1C0Xd9jw9D08WYpm97r+IVZMNfIFeOPWQFYmCU0Ac/rf31Ttc+uRo0R4Ogj8XqEzmRaWoZnDk= X-MS-Exchange-Transport-CrossTenantHeadersStamped: SJ0PR11MB4943 X-OriginatorOrg: intel.com 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 On Tue, Jan 23, 2024 at 10:46:00AM +0100, Mattias Rönnblom wrote: > On 2024-01-19 18:43, Bruce Richardson wrote: > > 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. > > > > Signed-off-by: Bruce Richardson > > --- > > lib/eventdev/rte_eventdev.h | 47 +++++++++++++++++++------------------ > > 1 file changed, 24 insertions(+), 23 deletions(-) > > > > diff --git a/lib/eventdev/rte_eventdev.h b/lib/eventdev/rte_eventdev.h > > index c57c93a22e..4139ccb982 100644 > > --- a/lib/eventdev/rte_eventdev.h > > +++ b/lib/eventdev/rte_eventdev.h > > @@ -599,9 +599,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 > > */ > > @@ -609,40 +609,41 @@ 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(). > > + * is not overwhelmed. > > "overwhelmed" -> "exhausted" > > > + * Once the limit has been reached, any enqueues of NEW events to the > > + * system will fail. > > While this is true, it's also a bit misleading. RTE_EVENT_OP_NEW events > being backpressured is controlled by new_event_threshold on the level of the > port. > Right. Will remove this statement, and instead add a cross-reference to the new_event_threshold setting at the end of the comment. /Bruce