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 5023C43BDF; Mon, 26 Feb 2024 06:18:17 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id CECA8402B2; Mon, 26 Feb 2024 06:18:16 +0100 (CET) Received: from mx0b-0016f401.pphosted.com (mx0a-0016f401.pphosted.com [67.231.148.174]) by mails.dpdk.org (Postfix) with ESMTP id 13DC340271 for ; Mon, 26 Feb 2024 06:18:14 +0100 (CET) Received: from pps.filterd (m0045849.ppops.net [127.0.0.1]) by mx0a-0016f401.pphosted.com (8.17.1.24/8.17.1.24) with ESMTP id 41PNvxlp023372; Sun, 25 Feb 2024 21:18:14 -0800 Received: from nam10-dm6-obe.outbound.protection.outlook.com (mail-dm6nam10lp2100.outbound.protection.outlook.com [104.47.58.100]) by mx0a-0016f401.pphosted.com (PPS) with ESMTPS id 3wfepr43ec-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Sun, 25 Feb 2024 21:18:13 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=LEItXEnPFHCNQfTchYqjs26F3NWzwTK9QQus0MvhDdfh3iPI+fhDypHUXNyxzNEqg40XuY4twK/L0MEf+2B7JaAUgMZZYJRzJ0puHN/iqM5m65bgqBUc2u+VBYvQjYGg8m1VLR+TnpwQPwNlwuLI5KebPdvUMWNvhjCI8Xe1u3zfXyZoVkrzuhvCRCCl0tV/QFZCU6+4LJGZ+/o/wae+H0Cu4CTdwIRSGduRQhwmNqrQwPe0bvFz8BmLO8AjNnMa9QFVtkASyiJTWKsWlIW6uZEA4gkf+SwQCad8YtJzk7E7yliMwDQk1rCu/k9b7OoR3oV+Us01uREsSzXLfhQj4g== 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=dCxCbjBprSDZ23lmUjh8fj19aidj/rFPigXLVI19+YM=; b=JaeOxzdQXfjCoeLturhw5Hpf7hbjvykhxcCRVn4UHbYSZUxCA5anlSQ+P/eIP8wv3XH++BU03X3nrz2BvHvDMRgtpYkekJPqYakObUW7nYgJrvcDAj4L5fTep7gg4L3mqqkasQfJG6sUfPvLzyAWpfiAQ2C/GqB7Fz2Osdnle53CkKyQnrjX7wovzHDfgLWbY+XAbTHmClTTEJkgWBW4l2bBLtL76+n45KLjTV/fQE24VE9TrAztqUWWG+rTwrtcerVsr5G3nanwoCZD1fRpq22cNjsPdNTMdCMuKLo1boggsQpRf4+okgEEHfD6Tg97ACpi7aW2XjRZW2LZZWMlDA== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=marvell.com; dmarc=pass action=none header.from=marvell.com; dkim=pass header.d=marvell.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=marvell.onmicrosoft.com; s=selector1-marvell-onmicrosoft-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=dCxCbjBprSDZ23lmUjh8fj19aidj/rFPigXLVI19+YM=; b=Tf4rowkKzL0ImIdFRaJCn0OIaJVImLlwXO+E8newYK0sdYfaYZZdQID8LS++PII8kQBzvVG13z/qoO+SEtiEoPIUib4gYILQIGJpd6MIHORSnxYNbbvzko7QIJYg4ePVS78VKipKrUEZfxE/0xVMQNg9YDf33VuWUhlWmb0sgso= Received: from PH0PR18MB4086.namprd18.prod.outlook.com (2603:10b6:510:3::9) by MN0PR18MB5871.namprd18.prod.outlook.com (2603:10b6:208:4c4::15) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7316.33; Mon, 26 Feb 2024 05:18:11 +0000 Received: from PH0PR18MB4086.namprd18.prod.outlook.com ([fe80::baf5:a4b6:7776:10f4]) by PH0PR18MB4086.namprd18.prod.outlook.com ([fe80::baf5:a4b6:7776:10f4%6]) with mapi id 15.20.7316.034; Mon, 26 Feb 2024 05:18:11 +0000 From: Pavan Nikhilesh Bhagavatula To: Bruce Richardson , "dev@dpdk.org" , Jerin Jacob , "mattias.ronnblom@ericsson.com" Subject: RE: [EXT] [PATCH v4 04/12] eventdev: cleanup doxygen comments on info structure Thread-Topic: [EXT] [PATCH v4 04/12] eventdev: cleanup doxygen comments on info structure Thread-Index: AQHaZLFZvWGXm1jKKk6aluNIt9J54rEcHPXA Date: Mon, 26 Feb 2024 05:18:11 +0000 Message-ID: References: <20240119174346.108905-1-bruce.richardson@intel.com> <20240221103221.933238-1-bruce.richardson@intel.com> <20240221103221.933238-5-bruce.richardson@intel.com> In-Reply-To: <20240221103221.933238-5-bruce.richardson@intel.com> Accept-Language: en-US, en-IN Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-ms-publictraffictype: Email x-ms-traffictypediagnostic: PH0PR18MB4086:EE_|MN0PR18MB5871:EE_ x-ms-office365-filtering-correlation-id: bbd954c6-224b-4b25-29ff-08dc368a53b0 x-ms-exchange-senderadcheck: 1 x-ms-exchange-antispam-relay: 0 x-microsoft-antispam: BCL:0; x-microsoft-antispam-message-info: TB+Rg/eDJ7vjMOVi+1CVUZq4pt6HFdbI7qIbyX6wwL9kMWvwgIieZAXuX2HNduFC5Y7vh05dpFGwzPRmkinkyxg3Cd26WsAt17l+u9gAzsGS7vNHGedazw6E3zhsik9zk4yZ+zVxkmanQIgeMr6BzpyImFiYTdV0ls8FEoGSX2L3j1nlf9pNQnjosm6EAkuj4rc16S++rk3YKRpp7y4j8FZGWERA7AxQPhNp7ZrZNvQuaSji/T3+n62b1GUwYo88EasQyIn/x9kHtM0lok690rIT42qsngu6DxZMtUhhmSu1bvlYJ2SSonvF+xvEfN9P/vtm2DxFKGnlWCqrI/aCDL7lnzw9rK+bpaR7mL3U/1NPSEQfJFE5EdzdOXIr99dV1v3oNoRvDI3ycYXVyju7X8SMKGXbF/e0YYzvkb0A4IR6ISFcfVou2S2DLRjso01jW6vPXmQkX8ypdhvrVcwW13O8xe9ey/RvuQQ5/c80lQ5hOdwow9yavQCnQVBZKXCw6O46QaEgpMTKmoqKCMiaR3s4p7FNshTT4XpxuaGlPjF18cX9wE3dE6pAuKFAEuGiUTVkaVY5K5kx+cPT9ybM1DRhYI1AhGTUhS2jgpzZQcaXTYXWrvAiEnQ1dRIon8mMwDv3sRHth5eoLAhOALk8ZAXmugqlcrKod2r+hCrNzkBTeh1SG2qG5VMjeIs0T7oZtpKUBBQV/kOeAwCqT7rQ3w== x-forefront-antispam-report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:PH0PR18MB4086.namprd18.prod.outlook.com; PTR:; CAT:NONE; SFS:(13230031)(38070700009); DIR:OUT; SFP:1102; x-ms-exchange-antispam-messagedata-chunkcount: 1 x-ms-exchange-antispam-messagedata-0: =?us-ascii?Q?b6xG5qCTx4+1gmk/UPO0ZR0WETHUdAtw6G5R5Npck+FmHEjSc/d11leKBAqv?= =?us-ascii?Q?hIFOdOaQxYss7ismHO2nTiuoLnnm0kD6DvwVALcUbedxq9yai6CrlyLhCaDT?= =?us-ascii?Q?eEL8TdkrnR1pydoTbHXae+ceX9f0ccLVvTXYtzp3oYpy4NyW+Red41k5o849?= =?us-ascii?Q?KhIiMmfpNYM0YxrhH0LW+oHChb/6CCD/82dv8wtIVGTLCpjfVL9rqlJUs3OD?= =?us-ascii?Q?qT3NrVqx9F/1R1kfP1c4wRuCKkq2jznU6/ETddQja9QX3R6NdVbz8KjH9zGR?= =?us-ascii?Q?KiIgkOA5/HfVvsYx463RsVH6v7tERxMp8dsLFhN7StQTmAUgzpAryNnBxkF6?= =?us-ascii?Q?m7HIYa6q5WCzyyxjkTRb4idPcNeTKP9Q1y/IPp/WhssgcJaBE5CqmVc0yfdl?= =?us-ascii?Q?OyWU7LkYNg8gzqdNjQmmXt29zOQeFtHp1RRniqc35eKrtfIzcHwca2nLu2vP?= =?us-ascii?Q?SE/qI/dK6xAmFnk5osn/cQ92iy9iDJAiGasHm6OIHTPd1dT/rmW4c4iGfd6g?= =?us-ascii?Q?ysQ1X1z5OLG873SeAEmD6U8o45fH8AFDLCjgkP00rhEYrWCDm9gWRZ0a/hLd?= =?us-ascii?Q?rJNMFUVRl82sa77lLVY+NqZwI1qSOwV2YcBbfAffG86XuLI12GBpTNJuifdU?= =?us-ascii?Q?DCW0QUWPEoBzMuT2lnmv2xG/MwVpH6OIy3jY55fCTz4zM5RN1l8u/hAun/Iy?= =?us-ascii?Q?7OyEcY2R6czWksfiaPWt7IS+omHO18Ly2vWYuobGiQqSFlIwNklg6qfVdSzU?= =?us-ascii?Q?IpqqooQLTeTr6eGG7aOYCNu/+QU9ntVnmjSJso8KEyhDrWpML63th3AOP2Nz?= =?us-ascii?Q?X6CDmFdz6RyKV/0sPFYQCVKsWOHyV5EKoSoExGxl/IMIArY9OpgXjMJS94wO?= =?us-ascii?Q?/UA3D56QdEyBKTaHCmN2tAjaNR15PU38inP8sLcxhn1nupilDV34tMx1tAwn?= =?us-ascii?Q?xJKuh8PLFfFj2JqVlcgiq3qAnXQ/IG6oOF046N/hPwmgsgWGYBCiwibIsWPg?= =?us-ascii?Q?i6rJv9l5ccsCkVZa9lqXdKi/zuoyD61oRVo8lPIu2qCbLM23RxOto9bSeQq9?= =?us-ascii?Q?nHnBVcj8jSWziaMC0CgLnpKn+XuhHU5I3xkaqx25MvWQLMXyzfikT7QeoDMG?= =?us-ascii?Q?JuRMd0cGOS9kA3LdDXtcbcgpbIOVAh6jQ0nL9pI7YM5MO7iH2Q5xxCrkD2E5?= =?us-ascii?Q?RO138VdwnbfH6YfZeIzOp6dhsxd7bFNeCyRGAWmqMA1KufyNUzh+ZBYWdebp?= =?us-ascii?Q?avsqnsllgGVFLtabErsn0J+ivEiLaeMk3rl3Anc/K84drD8YzQU8N1of2gYo?= =?us-ascii?Q?KdDfemGGdRNITZ62Xt/vwojRO3GuFPpVEdIMJjwtxbiBxn3o+47htw+8/lGp?= =?us-ascii?Q?Zl54EeFmM9edkjB6ot0Mju8czcnngad5TO00BBl5IbIaXo7cqosWRTUbhi6y?= =?us-ascii?Q?NlF8II9AZOHKuJH/0A/ONHsGnFdktBWyKhDiQDTScF3MTGyuKQIokqqh/6YG?= =?us-ascii?Q?5JaEs7J2t4F/E9XNyOKJk0baYgTklzMcvfyYRZKtqeznNS04H0h/fN+QxgoY?= =?us-ascii?Q?duYbNtif/Tn2soZymjjiQrrzj/mnOVbjUybUTQmI?= Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 X-OriginatorOrg: marvell.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-AuthSource: PH0PR18MB4086.namprd18.prod.outlook.com X-MS-Exchange-CrossTenant-Network-Message-Id: bbd954c6-224b-4b25-29ff-08dc368a53b0 X-MS-Exchange-CrossTenant-originalarrivaltime: 26 Feb 2024 05:18:11.6812 (UTC) X-MS-Exchange-CrossTenant-fromentityheader: Hosted X-MS-Exchange-CrossTenant-id: 70e1fb47-1155-421d-87fc-2e58f638b6e0 X-MS-Exchange-CrossTenant-mailboxtype: HOSTED X-MS-Exchange-CrossTenant-userprincipalname: 4At4Kr1GrfrsCzpppGvh9+Yd6sSwSjSJaGyfK5z6g1nSs9kIdgYmqOt/eu+vgYQ5qrnpGEsU4eb1Yd15lZNyNDR8MMH+JNCEXr3fSK7U/Xk= X-MS-Exchange-Transport-CrossTenantHeadersStamped: MN0PR18MB5871 X-Proofpoint-ORIG-GUID: 6J6Bt0K5UQUWjdPuUpfFnvJ9qmL3oE2X X-Proofpoint-GUID: 6J6Bt0K5UQUWjdPuUpfFnvJ9qmL3oE2X X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.272,Aquarius:18.0.1011,Hydra:6.0.619,FMLib:17.11.176.26 definitions=2024-02-26_02,2024-02-23_01,2023-05-22_02 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 > Some small rewording changes to the doxygen comments on struct > rte_event_dev_info. >=20 > Signed-off-by: Bruce Richardson Acked-by: Pavan Nikhilesh >=20 > --- > V3: reworked following feedback > - added closing "." on comments > - added more cross-reference links > - reworded priority level comments > --- > lib/eventdev/rte_eventdev.h | 85 +++++++++++++++++++++++++------------ > 1 file changed, 58 insertions(+), 27 deletions(-) >=20 > diff --git a/lib/eventdev/rte_eventdev.h b/lib/eventdev/rte_eventdev.h > index f7b98a6cfa..b9ec3fc45e 100644 > --- a/lib/eventdev/rte_eventdev.h > +++ b/lib/eventdev/rte_eventdev.h > @@ -537,57 +537,88 @@ rte_event_dev_socket_id(uint8_t dev_id); > * Event device information > */ > struct rte_event_dev_info { > - const char *driver_name; /**< Event driver name */ > - struct rte_device *dev; /**< Device information */ > + const char *driver_name; /**< Event driver name. */ > + struct rte_device *dev; /**< Device information. */ > uint32_t min_dequeue_timeout_ns; > - /**< Minimum supported global dequeue timeout(ns) by this device > */ > + /**< Minimum global dequeue timeout(ns) supported by this device. > */ > uint32_t max_dequeue_timeout_ns; > - /**< Maximum supported global dequeue timeout(ns) by this device > */ > + /**< Maximum global dequeue timeout(ns) supported by this device. > */ > uint32_t dequeue_timeout_ns; > - /**< Configured global dequeue timeout(ns) for this device */ > + /**< Configured global dequeue timeout(ns) for this device. */ > uint8_t max_event_queues; > - /**< Maximum event_queues supported by this device */ > + /**< Maximum event queues supported by this device. > + * > + * This count excludes any queues covered by @ref > max_single_link_event_port_queue_pairs. > + */ > uint32_t max_event_queue_flows; > - /**< Maximum supported flows in an event queue by this device*/ > + /**< Maximum number of flows within an event queue supported by > this device. */ > uint8_t max_event_queue_priority_levels; > - /**< Maximum number of event queue priority levels by this device. > - * Valid when the device has RTE_EVENT_DEV_CAP_QUEUE_QOS > capability > + /**< Maximum number of event queue priority levels supported by > this device. > + * > + * Valid when the device has @ref RTE_EVENT_DEV_CAP_QUEUE_QOS > capability. > + * > + * The implementation shall normalize priority values specified > between > + * @ref RTE_EVENT_DEV_PRIORITY_HIGHEST and @ref > RTE_EVENT_DEV_PRIORITY_LOWEST > + * to map them internally to this range of priorities. > + * [For devices supporting a power-of-2 number of priority levels, this > + * normalization will be done via a right-shift operation, so only the = top > + * log2(max_levels) bits will be used by the event device.] > + * > + * @see rte_event_queue_conf.priority > */ > uint8_t max_event_priority_levels; > /**< Maximum number of event priority levels by this device. > - * Valid when the device has RTE_EVENT_DEV_CAP_EVENT_QOS > capability > + * > + * Valid when the device has @ref RTE_EVENT_DEV_CAP_EVENT_QOS > capability. > + * > + * The implementation shall normalize priority values specified > between > + * @ref RTE_EVENT_DEV_PRIORITY_HIGHEST and @ref > RTE_EVENT_DEV_PRIORITY_LOWEST > + * to map them internally to this range of priorities. > + * [For devices supporting a power-of-2 number of priority levels, this > + * normalization will be done via a right-shift operation, so only the = top > + * log2(max_levels) bits will be used by the event device.] > + * > + * @see rte_event.priority > */ > uint8_t max_event_ports; > - /**< Maximum number of event ports supported by this device */ > + /**< Maximum number of event ports supported by this device. > + * > + * This count excludes any ports covered by @ref > max_single_link_event_port_queue_pairs. > + */ > uint8_t max_event_port_dequeue_depth; > - /**< Maximum number of events can be dequeued at a time from an > - * event port by this device. > - * A device that does not support bulk dequeue will set this as 1. > + /**< Maximum number of events that can be dequeued at a time > from an event port > + * on this device. > + * > + * A device that does not support burst dequeue > + * (@ref RTE_EVENT_DEV_CAP_BURST_MODE) will set this to 1. > */ > uint32_t max_event_port_enqueue_depth; > - /**< Maximum number of events can be enqueued at a time from an > - * event port by this device. > - * A device that does not support bulk enqueue will set this as 1. > + /**< Maximum number of events that can be enqueued at a time to > an event port > + * on this device. > + * > + * A device that does not support burst enqueue > + * (@ref RTE_EVENT_DEV_CAP_BURST_MODE) will set this to 1. > */ > uint8_t max_event_port_links; > - /**< Maximum number of queues that can be linked to a single event > - * port by this device. > + /**< Maximum number of queues that can be linked to a single event > port on this device. > */ > int32_t max_num_events; > /**< A *closed system* event dev has a limit on the number of events > it > - * can manage at a time. An *open system* event dev does not have a > - * limit and will specify this as -1. > + * can manage at a time. > + * Once the number of events tracked by an eventdev exceeds this > number, > + * any enqueues of NEW events will fail. > + * An *open system* event dev does not have a limit and will specify > this as -1. > */ > uint32_t event_dev_cap; > - /**< Event device capabilities(RTE_EVENT_DEV_CAP_)*/ > + /**< Event device capabilities flags (RTE_EVENT_DEV_CAP_*). */ > uint8_t max_single_link_event_port_queue_pairs; > - /**< Maximum number of event ports and queues that are optimized > for > - * (and only capable of) single-link configurations supported by this > - * device. These ports and queues are not accounted for in > - * max_event_ports or max_event_queues. > + /**< Maximum number of event ports and queues, supported by this > device, > + * that are optimized for (and only capable of) single-link > configurations. > + * These ports and queues are not accounted for in @ref > max_event_ports > + * or @ref max_event_queues. > */ > uint8_t max_profiles_per_port; > - /**< Maximum number of event queue profiles per event port. > + /**< Maximum number of event queue link profiles per event port. > * A device that doesn't support multiple profiles will set this as 1. > */ > }; > -- > 2.40.1