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 7B29343B55; Tue, 20 Feb 2024 17:42:16 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 68F2C40648; Tue, 20 Feb 2024 17:42:16 +0100 (CET) Received: from mgamail.intel.com (mgamail.intel.com [192.198.163.17]) by mails.dpdk.org (Postfix) with ESMTP id A2BBC40289 for ; Tue, 20 Feb 2024 17:42:14 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1708447334; x=1739983334; h=date:from:to:cc:subject:message-id:references: content-transfer-encoding:in-reply-to:mime-version; bh=1tnlfpy8zEsKRZlefuF7Z509bNIPsFBhFU8kiLf2Qec=; b=Vpccgc9W+YLHmTuan8Hnmkv8h+c8b2qFtyY5g2gdEDWvnHTkKU+Ldbhj oPIZzSLKCp4coDCPGCX9FrsWj4xfI1r/fVPx/aENwh7yCxJxNGdR8R8EA iWPWA6DOgBMNODpb059SvwjjzWXY17Ik1QveY2ywOAjo+i68JyTMlSGjw ZEYjqEk/4pkkJzdAFYl+pkFtazdqLZzQJODDNihLAJHkGV+7FZQuu6UJj UW3VLIby8uFq4hY2EONgtb05Uq1wCMjtkDZv6X0zvmtdIw7BPksbS324n +21mnKUhbhB/v/H0JljWhyO/g2/aiin1xft4cztmpl2CBxqn9z+sShVzc g==; X-IronPort-AV: E=McAfee;i="6600,9927,10990"; a="2420927" X-IronPort-AV: E=Sophos;i="6.06,174,1705392000"; d="scan'208";a="2420927" Received: from orviesa004.jf.intel.com ([10.64.159.144]) by fmvoesa111.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 20 Feb 2024 08:42:12 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="6.06,174,1705392000"; d="scan'208";a="9491417" Received: from fmsmsx602.amr.corp.intel.com ([10.18.126.82]) by orviesa004.jf.intel.com with ESMTP/TLS/AES256-GCM-SHA384; 20 Feb 2024 08:42:12 -0800 Received: from fmsmsx611.amr.corp.intel.com (10.18.126.91) 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; Tue, 20 Feb 2024 08:42:11 -0800 Received: from fmsmsx603.amr.corp.intel.com (10.18.126.83) by fmsmsx611.amr.corp.intel.com (10.18.126.91) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.35; Tue, 20 Feb 2024 08:42:11 -0800 Received: from fmsedg602.ED.cps.intel.com (10.1.192.136) by fmsmsx603.amr.corp.intel.com (10.18.126.83) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.35 via Frontend Transport; Tue, 20 Feb 2024 08:42:11 -0800 Received: from NAM02-DM3-obe.outbound.protection.outlook.com (104.47.56.40) 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; Tue, 20 Feb 2024 08:42:10 -0800 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=i3R5mCnm3kbvW1XNgaCsFphN31sHsXArcKtPsKtF8gGux/KetetIGavD2b1fKtCNbxAparZsRujG0zF13DqCEI1DsU7saPluCTa0FKsk5NHHqAo2/WB/47fR5s6C39OjAkoWXDN6WjDba8MV7f8cZIBffCblfhAhGpTo3l8SjTzKJPCxTt6Be6eWxu2ZU9m2ESmCD8yDYlD2fvNYVJiby0hzwCe217gWSCJu//5ldiqsjCV0pNE82i/KSi089fWwMEVsbPSbEY1Zzt3ctR4FENH2OYwc9wdaqji1Uq84Wl/Gb28n95QXVzLqXDNad9nvaD696jjPYLO6JhsRb9brQQ== 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=+n8VMJ2SEwgrgHutmTrBoW7oKoE2TL7ATrQ5eLHlmYo=; b=GUQKuZUn+jXUv8Z5Wsz1a3A8csW59c2i1PHBVPY9jRB1LrPMZhPzU1hd1KBg/tMxfV5Jyl2LYrzhUj6CjD/nq9qRLqfrO0rShYssQub6mOkJ0BhoMVRCnwQtmKpPPL7M0n/8pTalhz+wC30dPBTmSfcaQT9PFKJLDAH8mby6EalcO3XGCCVVnVfFYkY5sQRq7EreYNIb3hRfzCDQWj06K7FqJDe0aLdyPSHozNp2ePkIr7LTRXBLKVwYyLknHfyLHszL9G2dQkdzEiCga38PxfOYSoNcvQ0pl+d+gAM73WycXqL6vMjRAwkrSl1EQksw3bBItJjpXDA4eiYnCSjuqw== 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 SJ0PR11MB7156.namprd11.prod.outlook.com (2603:10b6:a03:48d::7) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7292.39; Tue, 20 Feb 2024 16:42:09 +0000 Received: from DS0PR11MB7309.namprd11.prod.outlook.com ([fe80::d10:3009:a8d3:1d2e]) by DS0PR11MB7309.namprd11.prod.outlook.com ([fe80::d10:3009:a8d3:1d2e%7]) with mapi id 15.20.7292.036; Tue, 20 Feb 2024 16:42:09 +0000 Date: Tue, 20 Feb 2024 16:42:03 +0000 From: Bruce Richardson To: Jerin Jacob CC: , , , , , , , Subject: Re: [PATCH v3 03/11] eventdev: update documentation on device capability flags Message-ID: References: <20240119174346.108905-1-bruce.richardson@intel.com> <20240202123953.77166-1-bruce.richardson@intel.com> <20240202123953.77166-4-bruce.richardson@intel.com> Content-Type: text/plain; charset="utf-8" Content-Disposition: inline Content-Transfer-Encoding: 8bit In-Reply-To: X-ClientProxiedBy: DU2PR04CA0081.eurprd04.prod.outlook.com (2603:10a6:10:232::26) To DS0PR11MB7309.namprd11.prod.outlook.com (2603:10b6:8:13e::17) MIME-Version: 1.0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: DS0PR11MB7309:EE_|SJ0PR11MB7156:EE_ X-MS-Office365-Filtering-Correlation-Id: e1398afe-8b42-4cb1-c561-08dc3232e12e X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: e3jdmYN/Sr1kltcKZrj8LVrMeyHqtP+xg7OfkMQcbCaCsNCEVSl5qaYIIT89tfH73F8HIcP7xWByR6BdK6EXclf7kKPZPnWBjgHFH39cGnEvlDeYC8rcVpZxUuK52/By2kIsNIc8z7z3qOXpsDpLYrvTPYhDuvlhm9imGRXQyQvx+3PxCZX6DWqANq4iQVWzn+sKJgQjiJqexYUWEm5ePsXKop13bd+02CCRO3/Yc3dR1lk9BrT5yJsMggicwUNDmUX00tpRDOQe7dJidLkZkqy8eeF7Hm/x3Tmrx63XJHnKmMjQXpX7JUa/9VJ0LleQ005G2sYZIb2E5hnYzaBmlmgDikhcOVfnGXXVAsENK501oKkoGe7N4Wq0V2XUTxcpm+LGgpZX8+h1cgsYPWT3Wkgao6oZfLXDPFwL5Vx8JYE949zz+yQ14bO2yTkZzHJt5TkNNTmgkOYszFHO5ZfbDOVGliqrpUlgoNiG7guncR+U2eKNfRI/EuvQl7YSW7QRxcTlkRo3i52GrmrDOlkaxDs3HIN4V5QdemczD9ibxdc= 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); DIR:OUT; SFP:1101; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?OVlkZ0lmVHB3Z0Y2bUVvbURneTBKSUhKbnJuWnh4V2U5dnI2bUlJMS84RHBP?= =?utf-8?B?dTI3U0lrZll5d2xOQ3FoL3BPWDRYWXJ1M3l4UUZrRGhnZEZBKzc4K1V0eVJ6?= =?utf-8?B?L1FkYlEzc0JSTmFJeWxoOUJLNUR2cDRlRTVVZ3ErVWl4ODZwN2pxK3ZoYWcr?= =?utf-8?B?Tm9XdUQ5ZDBFcEpWSVAvcnIza3VIZjhtRlFwUitoNGdzRitxSjFEZ0pmMUdV?= =?utf-8?B?UEpKbElTK2JzMEE5QUEwRmJ3S2xacVMrczZJbFJtS28wbzdYckZQSVk5d0E4?= =?utf-8?B?SEZNdVhPWjh2WWwwZHNmNnRwWk5ieGM1TWNwMXVIYVRmcnBCemZqTFFrWmVu?= =?utf-8?B?QjliL00rcmFTcVJ6czh4OWVSYnI3VWhuYVAvV3pkWTBQS1JmWWh5c2V3L3pl?= =?utf-8?B?Nkl0eE5QYjZUOFM4ZnBaVkREL0ptNWVvQk9xYmlwczVGVGhwcVJnR0ZBNEFB?= =?utf-8?B?RHdMeGFtUm9RL3A2RzNkc1I2R0grSXdNOUgvVmxpWUh4UTV4b2MvYTE5SEFG?= =?utf-8?B?VGJTb1VhQWxUMXZ0TVBXNWxiUm5MUWdITmV4a2VLUzA4OHJndHBTZmsxSEpH?= =?utf-8?B?ZVFyZ0g4RGloaUtCNC9PNS9VVGJkQ1ZqVDc2cVdRMEdOR3JITzJvSHprOHd6?= =?utf-8?B?VHpwazVGUUlGZCs5RkZsVEgrd1loKzNOWEE1NU5nN0FUQnJvUkc4bUlZbU9k?= =?utf-8?B?OEVDWnVXZWNPOGhUQzU0S1JKU3IzSTZBdDRZSng4TXd1djlVdVlaNDl6bjky?= =?utf-8?B?SmNQQXhPcm8xbzRVRlB2Q1psZzN4QkpDV1lnamw1NDl0a0ZvZWc1dEh3aHJJ?= =?utf-8?B?Z2lvamNsTG8zeFI0aVhmR1daNjIyUFpVZDlmbTE3YmhHWDlxM09IRWdlS0N3?= =?utf-8?B?aU5CUlBNRHQ5YTRaN0FMRkhzdHo0b2R4SFhLeFdSRjQydHVFeG14Wm9BNG1p?= =?utf-8?B?MzFKeEZMMTlGa1cwVjZDb21ITTFOVURJYWkxTzQ3c3h4bURqcGxCR05tNnIy?= =?utf-8?B?ZGFya3NhZ2ZBVVhhMnJYeGJNRm1KYlRJYm1wN2JwSFZLZE1aUVZCSjQxSFRx?= =?utf-8?B?RzhBcVNRNDBmQ0dEVDBQT0FSTHR2cUhEZ1ZSWTRlT2kyUDdXam02akhnQnZ5?= =?utf-8?B?SVJHejNqUHFUWC9nd3ptc1lNK1VrYUJFcGNUbUtOeStZYUo5RS9wZGlHK1h4?= =?utf-8?B?dGtlZnpnZFlKTW1hRHZEb2E4WVd5Rmk2TE1zK2U0VWlKblNrR1lZVE9WbVFt?= =?utf-8?B?RHVvTVZMVHNYbXE2MVI5Q0lMSUtMWmMwZENCNEZmMmJueDFjb3NXZExOWG90?= =?utf-8?B?OUNNMkVJdGJuY0lDVUpmMzFoTkt1ZFZUZVgvN0NxbzRDMktRQ0k4K3FwemF3?= =?utf-8?B?aWM4UkE2R2tnMzk5Wm04NGNmamlacU1CK1pCVEs0bk9FTzd1QjZYbmx5TkI3?= =?utf-8?B?cTVJWkxyNnhId1lQYS9sd0FFWE1Xc1NpL3E4aW9vNk5uRmR3WXdrRmxkQk9p?= =?utf-8?B?bXVMRFEyaUx1OFFIa01FWVkwVVNBRCtPeWtUdFJhM1VITlRJcTk4dWk1Zkdy?= =?utf-8?B?V0xvNE1ZMElGUXNoUG9BcnM2NldMNHp5eXM2aGE2R3hrekVNb0JhTUJ4TUJO?= =?utf-8?B?S21SM0hmeEpvSTg1dnpNYXZTQWJPMnVjUUZWZzU1aHdOQUJKcXJ5NEp4WUJS?= =?utf-8?B?czk1anp3UjN3M0pZMVRWZUpSTlNhTTlacDI1SGx6RDhnVEI0aTdsRXFlMS9K?= =?utf-8?B?dGpodUt2QmZDUTZIMzlsM1M1NmJNYlhTVDNBTDBHOTdVamJ3RnJnZGNNQVRO?= =?utf-8?B?a2lRcm4wRU9KSTRMaHdvVlhidXZTZXM0NTdFakRoZkgzRnZKa0d2RWZoSlFP?= =?utf-8?B?VnU5UUgxRHN6NjVmU1ZxS2tUWWptTTNTRW5JQ3Q2SWtISVBVeVRmd3hSWWdo?= =?utf-8?B?bDNMZDN0TzJZWUg1dlNkVjBJTGE1OXhrQzZ4OVV4Z1YrdWQ5b0lMUjYwcTZD?= =?utf-8?B?TXBXeEV6S0puTW83OGN6b2RZbGJwRUdiQ3FJMHVmZjJJL1hGUHFrVFV4c3Fk?= =?utf-8?B?Zy9tSGxtMzRNZFlGdWJUMDY5NDhLVVgrQ3dVYmlHUWxCcUQ1Rll1SzNNR0V1?= =?utf-8?B?V0VzYm5XWWQ5QzVVZmZJOHJsSy9ZblZOck15WkFvT2hQT2dOaGdVV3o3NlJK?= =?utf-8?B?ckE9PQ==?= X-MS-Exchange-CrossTenant-Network-Message-Id: e1398afe-8b42-4cb1-c561-08dc3232e12e X-MS-Exchange-CrossTenant-AuthSource: DS0PR11MB7309.namprd11.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 20 Feb 2024 16:42:08.9871 (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: FYxPM0JgnrdmRoqHok1JLIQblJN0lmJNtc6qrQdWocWw0zJX6ZtkoYYJa5HfILgphHbZoi/rvkcVaEY0jYjxGkVT/eu1Vv3dcfVIl6m/DVU= X-MS-Exchange-Transport-CrossTenantHeadersStamped: SJ0PR11MB7156 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 Wed, Feb 07, 2024 at 04:00:04PM +0530, Jerin Jacob wrote: > On Sat, Feb 3, 2024 at 12:59 PM Bruce Richardson > wrote: > > > > Update the device capability docs, to: > > > > * include more cross-references > > * split longer text into paragraphs, in most cases with each flag having > > a single-line summary at the start of the doc block > > * general comment rewording and clarification as appropriate > > > > Signed-off-by: Bruce Richardson > > --- > > V3: Updated following feedback from Mattias > > --- > > lib/eventdev/rte_eventdev.h | 130 +++++++++++++++++++++++++----------- > > 1 file changed, 92 insertions(+), 38 deletions(-) > > > */ > > #define RTE_EVENT_DEV_CAP_DISTRIBUTED_SCHED (1ULL << 2) > > /**< Event device operates in distributed scheduling mode. > > + * > > * In distributed scheduling mode, event scheduling happens in HW or > > - * rte_event_dequeue_burst() or the combination of these two. > > + * rte_event_dequeue_burst() / rte_event_enqueue_burst() or the combination of these two. > > * If the flag is not set then eventdev is centralized and thus needs a > > * dedicated service core that acts as a scheduling thread . > > Please remove space between thread and . in the existing code. > ack > > * > > - * @see rte_event_dequeue_burst() > > + * @see rte_event_dev_service_id_get > > Could you add () around all the functions so that looks good across the series? > Yes. I'll also standardize them on one-per-line. Some had two per line but put the third on a separate line because of code wrapping. Better to just have everything on its own line for consistency. > > > */ > > #define RTE_EVENT_DEV_CAP_QUEUE_ALL_TYPES (1ULL << 3) > > /**< Event device is capable of enqueuing events of any type to any queue. > > - * If this capability is not set, the queue only supports events of the > > - * *RTE_SCHED_TYPE_* type that it was created with. > > * > > - * @see RTE_SCHED_TYPE_* values > > + * If this capability is not set, each queue only supports events of the > > + * *RTE_SCHED_TYPE_* type that it was created with. > > + * The behaviour when events of other scheduling types are sent to the queue is > > + * currently undefined. > > I think, in header file, we can remove "currently" > Ack. > > p > > */ > > > > #define RTE_EVENT_DEV_CAP_PROFILE_LINK (1ULL << 12) > > -/**< Event device is capable of supporting multiple link profiles per event port > > - * i.e., the value of `rte_event_dev_info::max_profiles_per_port` is greater > > - * than one. > > +/**< Event device is capable of supporting multiple link profiles per event port. > > + * > > + * > > The above line can be removed. Ack. > > > + * When set, the value of `rte_event_dev_info::max_profiles_per_port` is greater > > + * than one, and multiple profiles may be configured and then switched at runtime. > > + * If not set, only a single profile may be configured, which may itself be > > + * runtime adjustable (if @ref RTE_EVENT_DEV_CAP_RUNTIME_PORT_LINK is set). > > + * > > + * @see rte_event_port_profile_links_set rte_event_port_profile_links_get > > + * @see rte_event_port_profile_switch > > + * @see RTE_EVENT_DEV_CAP_RUNTIME_PORT_LINK > > */ > >