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 AA96043BDF; Mon, 26 Feb 2024 06:19:01 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 8C3A7402B2; Mon, 26 Feb 2024 06:19:01 +0100 (CET) Received: from mx0b-0016f401.pphosted.com (mx0a-0016f401.pphosted.com [67.231.148.174]) by mails.dpdk.org (Postfix) with ESMTP id B550440271 for ; Mon, 26 Feb 2024 06:18:58 +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 41PNvxlu023372; Sun, 25 Feb 2024 21:18:58 -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 3wfepr43he-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Sun, 25 Feb 2024 21:18:57 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=HmSb8/ThbMePGHDQQhRNIHyHDrEZk9HSExt1p5fnwtiNwEHQCkxDbu8fxsw5TAC5NbMieIU5cz4+y9tWv4kkOqlMgSLDq9mUwnI6UPlSDdvNXle9zhNiBMxSXdInirmkV4gDiMIrDmpDTlSPWLDlhFBKPVgJj4age4Umff1z8BnHL3gcLiLMZaZ77mnz3zVbrrdKJrvYerMis8Z4+IFzwWozuWfAl3UbaYdB5m3fifvJfKjOI4KjhEd/KL8G3GIO2DX+466DzX0DQEOIvJ1v5EmzvxVUY1dRllU9gO+m4BqPgst2ErZRm8C3X9cul6WuzBvVxkn6CVH4/sa0FOzYww== 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=fHrg47Qxj0TceIlF6/hmgo1aBG2KZsX2ayB+kZLuaBQ=; b=SJNx99OUFuBae0U6DUKIjDhLfrerkfZV5jUX9dgqzh44pUz2DMwLYsAcXldzbBK3DHR3rd4A4xXvHj42p3AqE5BYm0xzUj+239yMBLuUniVX/VBUQunO0hP9irdPDPaAKu9QbCE5aC34AK2wF74QpSrSDk7SrHBUMVlm+Tifvf0AQ6sFymF9z+v90ZjMikHzG7pXPZdQRTu2HNK5sI2og24FJyRTZuil2+8/bqVnncQqw5GJXbu2ARfJoIFYdHYUIVu9BBtasCm5xB5ui+p07iUkHkggNnwzuyqO67DyKzFZ6bXw1HAKXjUHvZmM+R4XBVUXxZB4v3ZWrqQpVESUzg== 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=fHrg47Qxj0TceIlF6/hmgo1aBG2KZsX2ayB+kZLuaBQ=; b=ZZalEGAhwEbZSIN+pRDW+PvoBZqXz4JTvB+i2uzVihK5W2BgqDh7T0gohyK7HoVwcLA6Hn/m6n9u6YcaokCAOfhAoliKo23kEhftHDXKD6f6kTcSm3LchnJkcEhASaIUwv3Buxs+T+0tfMpA75ReD5RrWjYeMZqu09deTZJeys8= 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:55 +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:55 +0000 From: Pavan Nikhilesh Bhagavatula To: Bruce Richardson , "dev@dpdk.org" , Jerin Jacob , "mattias.ronnblom@ericsson.com" Subject: RE: [EXT] [PATCH v4 05/12] eventdev: improve function documentation for query fns Thread-Topic: [EXT] [PATCH v4 05/12] eventdev: improve function documentation for query fns Thread-Index: AQHaZLFcgtdq5WVzjEeExMF1bmkW0LEcHSbg Date: Mon, 26 Feb 2024 05:18:55 +0000 Message-ID: References: <20240119174346.108905-1-bruce.richardson@intel.com> <20240221103221.933238-1-bruce.richardson@intel.com> <20240221103221.933238-6-bruce.richardson@intel.com> In-Reply-To: <20240221103221.933238-6-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: 3355cfda-8942-4d1d-166e-08dc368a6de1 x-ms-exchange-senderadcheck: 1 x-ms-exchange-antispam-relay: 0 x-microsoft-antispam: BCL:0; x-microsoft-antispam-message-info: XuFR0ilvIKiLra4TZeZwUZAPVPRVXCToyqZWG1nDd7ScVyM59qTKsRHmkDWiP1XxDz1kA5p+xtU6vhY8FUEx07u+PMrc+aqoq38MR4r2ca6Ncmzodu/AaIq0YgzWyKvqMmED4VxuvWfWkdCrFYPYKZkfNcbA79Rv9Ws/xxA6OJbWL80fS6GVNRBMJ8qRaCdq7XsmanxAlIfHAmOwC4kp73M7kmd/i1KEYRBv/bjtPKUrwKEDg2N3+Quw7869GEpKU0C3loWS3nwGew1XhwvMUc9H9ojN+Io+9w3qoVpDpC3SaFxqUuHZgBT8H4t2zzNolrKb0eS6OLJ4Ic8Zv+vZmqqVEp5SKXiT4rGlYv2gr+snv8YSUBAERGn1FKMZcgog/YLiWxyFmhOOUGluK63AtAuNpzehTbZ7XpyhF1aP46v/OnPrhmY8XPIORHHE2/1p2+4ghnLnwHum+qVessYM2N+cdD24Ne7Ep24ZI4pVhzllVQAVIyF+yTLRMotRn6ekxvFalwOyU7sO6gKQ2Bxy+SPF+ziYW2hrOI6OiOFhU5PxUISn0BkATml2LTRZReMbSMoi18aLRKp8LoM0PTgjC+NiD9ucn7T5BUkHNFHegWSryE5BmOLeJNXQEC4p3APvua8mUmKIQjOdxgn4FYzmO75Z2i2jt48sRtVnGbfwosxCNeCkYVP3198sCJcUOz9Yu/33kDndTV/0gJP8e7Ml0LbeRPEf+ogwnRSVNhXZLO0= 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?Rx8NJwBNGIOaeVL12m1/OnAyaRTkHjTNKSfjRr/r4lcg3NElW/L+qZsJN0Js?= =?us-ascii?Q?4/+vgDMz5ySrF6sWET06NytDmdK1y0CSNUxOqy1PLo/+i++csk0cG0IW+N4J?= =?us-ascii?Q?rcXh0zrd+rDv8Yc48i+TAkzqQEDHC+d5RXB9ueNRvUCQm7LemBe6NdYS6Qmn?= =?us-ascii?Q?ioC0CuHt7mjaPRBrIjz1C4KWTc9WYcnCKBtL1UlxKnsAWKBVrKBOlbFIxhdw?= =?us-ascii?Q?8byaCZ3RzCrDAMf1stYSMjYFHVkFxu1L+b1PB8mV7iCoNlWseyxRjplnm8xv?= =?us-ascii?Q?Uy5ZGeYSRL9FMRmRX1T0SCqKifeqUZJ4MaQdejo3biexW2Ep6GQubFdzV3kg?= =?us-ascii?Q?7EOlUQH+rab+Rp/TxMbkDs/fG2wVepoFyMYJ4e2fpjNmj7UPysH/+YPVWvph?= =?us-ascii?Q?oCNPmduFlbH0yagBhjA54OBAiZXCVHIS/hkh0eRPNiJl4ofOr4DpGYZ9zG4e?= =?us-ascii?Q?98UWLsvWUIXubs80RzvlUeUtjQ3x9FtMOl6o3Lp7rzs44HMX9EIsE03q7bq2?= =?us-ascii?Q?slFAEQ9Cbirbll6fU8F0NuzzeCZAg/S8/DzvGBY0A9cbGIbJKKYSX1JA+bCG?= =?us-ascii?Q?ld81T1Vi88qOG/85Kj5vtJXFrlMqPXt+lV8g2XMtZP0VU3/2HGZGAQVhZeCn?= =?us-ascii?Q?h9myqe0rK4a8wvHWahq5cLfxDxCbGyMsnv/9Qgju0ELJFAH5rQRI47FFjLTu?= =?us-ascii?Q?4Z2c8jgFa/LYf3jIPd7KF7EI7Qi/ytznpN3x0Kz5GZyTkcTGsjblSxvRpJI1?= =?us-ascii?Q?nJY5T2LsJFfEXpJ+EG6UyN+c5ySIdtP9Kv+kStKA27gfu9Wu+ZSP69TI2VBS?= =?us-ascii?Q?qAJZB0hB/Y5Uvg4/5/S0sXwyWRB/PgRNC/p+z0mEU7bb3t0bo4hVw6qtgDLH?= =?us-ascii?Q?poWfTfR8Y7uHTq3cbLLibSTNbiwpwYDbU/VpqtHAaghZx1COwzNvDeUl0v2A?= =?us-ascii?Q?JNib1uy9iAZKMZ5QIdTsCDjmBDudZHELkF8SiCwjNHvon+SuZRrTxAhoInEF?= =?us-ascii?Q?iqKGARuKylVuSTSRNvFXGxiuZPfEZDgcMxs6crHnz2tzwcrSZu4CPCpBY6P2?= =?us-ascii?Q?YireFLGV1hGBdelhMplJqi0QF2r1tg5DT5jgU2si65jGRMLMSAj6OzEvDYg8?= =?us-ascii?Q?hsoJJps/2jgo9fr+QcI0m1wXUeg93pMdtHid29G8KY+sLQ+gSl5rlmL7olj1?= =?us-ascii?Q?Q7Cr4TMHtjiqu1C//lTUBEWTMi1IzPyr/Cli8W/0OCk4ewvydea5LxXO7Hre?= =?us-ascii?Q?wGrKs/7H49guyzBHLTrwdOts/BE+rn6YdkkrSZFmp24/f7dBrVWf6FVVtQFU?= =?us-ascii?Q?VhCoe0iuXQwJHsVgK626yePLNkFp7QzxBeM830WvX422EQ9HikIzPKMeq3bl?= =?us-ascii?Q?zm1yRq+p9lYVpdZWBoVnw6w8bAT6GlssbTtZnHAulUMAv8Oyg5Bvy+5AnYIN?= =?us-ascii?Q?hBqOJzNBfFTQG6YKiuOQuMqLGMXA3b+/ji4H9KSRa1K3fptc/HUdT5A808/6?= =?us-ascii?Q?lR+PdXxYK2a7HHb/6op2KhUdTXAf3bN1PnJTZc3z3YUICac5r+sumTuw8Pba?= =?us-ascii?Q?9nn7jtkeljW3l1RJGc2vP3aLpOx9nByoZDVYo4Pl?= 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: 3355cfda-8942-4d1d-166e-08dc368a6de1 X-MS-Exchange-CrossTenant-originalarrivaltime: 26 Feb 2024 05:18:55.6412 (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: ya7B89pYewFFP/yvLzye91WTvC6HMJ8r21Q5CZmTLWWlE5Kpv/k9MvdcfGa7RRyWq/xva7KRH7MUxKF6Tz2HTg1Iwl8Y2zAWxn5ErThI4AA= X-MS-Exchange-Transport-CrossTenantHeadersStamped: MN0PR18MB5871 X-Proofpoint-ORIG-GUID: RvvGGNAyg2KdixlNMISdXiSXRXCd695K X-Proofpoint-GUID: RvvGGNAyg2KdixlNMISdXiSXRXCd695K 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 > General improvements to the doxygen docs for eventdev functions for > querying basic information: > * number of devices > * id for a particular device > * socket id of device > * capability information for a device >=20 > Signed-off-by: Bruce Richardson > Acked-by: Pavan Nikhilesh =20 > --- > V3: minor changes following review > --- > lib/eventdev/rte_eventdev.h | 22 +++++++++++++--------- > 1 file changed, 13 insertions(+), 9 deletions(-) >=20 > diff --git a/lib/eventdev/rte_eventdev.h b/lib/eventdev/rte_eventdev.h > index b9ec3fc45e..9d286168b1 100644 > --- a/lib/eventdev/rte_eventdev.h > +++ b/lib/eventdev/rte_eventdev.h > @@ -498,8 +498,7 @@ struct rte_event; > */ >=20 > /** > - * Get the total number of event devices that have been successfully > - * initialised. > + * Get the total number of event devices. > * > * @return > * The total number of usable event devices. > @@ -514,8 +513,10 @@ rte_event_dev_count(void); > * Event device name to select the event device identifier. > * > * @return > - * Returns event device identifier on success. > - * - <0: Failure to find named event device. > + * Event device identifier (dev_id >=3D 0) on success. > + * Negative error code on failure: > + * - -EINVAL - input name parameter is invalid. > + * - -ENODEV - no event device found with that name. > */ > int > rte_event_dev_get_dev_id(const char *name); > @@ -528,7 +529,8 @@ rte_event_dev_get_dev_id(const char *name); > * @return > * The NUMA socket id to which the device is connected or > * a default of zero if the socket could not be determined. > - * -(-EINVAL) dev_id value is out of range. > + * -EINVAL on error, where the given dev_id value does not > + * correspond to any event device. > */ > int > rte_event_dev_socket_id(uint8_t dev_id); > @@ -624,18 +626,20 @@ struct rte_event_dev_info { > }; >=20 > /** > - * Retrieve the contextual information of an event device. > + * Retrieve details of an event device's capabilities and configuration = limits. > * > * @param dev_id > * The identifier of the device. > * > * @param[out] dev_info > * A pointer to a structure of type *rte_event_dev_info* to be filled = with the > - * contextual information of the device. > + * information about the device's capabilities. > * > * @return > - * - 0: Success, driver updates the contextual information of the even= t device > - * - <0: Error code returned by the driver info get function. > + * - 0: Success, information about the event device is present in dev_= info. > + * - <0: Failure, error code returned by the function. > + * - -EINVAL - invalid input parameters, e.g. incorrect device id. > + * - -ENOTSUP - device does not support returning capabilities infor= mation. > */ > int > rte_event_dev_info_get(uint8_t dev_id, struct rte_event_dev_info > *dev_info); > -- > 2.40.1