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 64E9143BE1; Mon, 26 Feb 2024 07:36:40 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 32A6D402BA; Mon, 26 Feb 2024 07:36:40 +0100 (CET) Received: from mx0b-0016f401.pphosted.com (mx0a-0016f401.pphosted.com [67.231.148.174]) by mails.dpdk.org (Postfix) with ESMTP id 28AE840144 for ; Mon, 26 Feb 2024 07:36:39 +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 41PNgDj5027414; Sun, 25 Feb 2024 22:36:38 -0800 Received: from nam12-mw2-obe.outbound.protection.outlook.com (mail-mw2nam12lp2040.outbound.protection.outlook.com [104.47.66.40]) by mx0a-0016f401.pphosted.com (PPS) with ESMTPS id 3wfepr493y-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Sun, 25 Feb 2024 22:36:38 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=aSaj5ViMrRovgvoA54ImH479anz6QdqC8BTUu7AFwQYHv9r2nSKDukW7Dqm1apKBPu+WQr819c2fCAK7O1uHeyTlt3ITe6T8mTxk+pnRg72aDN5sHXFUcomncP9j+fciAz8ELPBl+caMDbCGGTf716G/wZQKY+T0JQ6/Cr5VKKVhiY08vsuh6mcMnudAYyV9t8iAHnoUBIelifjpyMX0G1jxSB9n3ygW2Fumo4lMd1xOPYkOeT4Tnfz2sLJCWDVdDDM9QGXHc+YDoPaF11/pO0XbkRfwkDwQAC5lxRrXrygZsuTYQCIyfbFXzWTuppq4FIs11yyvyG2JoujZOvVAIA== 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=nFw0ZHJ5A5H1KLOPrPo2pfUReo7ABtqCGgwfKj1tPYg=; b=GCC2xs2Lw7evoJDWEVuStWADujNyYhzN3XQQ+ghe3bv+06TYG3TkRSsD2ESoF68zIs1N+cVDY+qwsdNlf9Ht5OTPOjvG0JR2BTO4amdCDtaVeKiwuO4xsPA0uyBcRdkptqWJyXCZ2PGh4SllvCQe1tTPQ66ef3Mg967LB7cD72TxHMEvN8EAqJgbIG53cAjRJKF6nq68LjKRM8wv4dtouBxXFe1N/W2J72aqgAY4k5Hoz0gIJaD9hfiYW38YR86yNtlaqx6pq/TCVXawYtHU29B3hkG5tDJiWT+JuLFN3kGgC1zZjkECsbIZBzRUdFFcKF756CYg3aztNkH5xOSc6Q== 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=nFw0ZHJ5A5H1KLOPrPo2pfUReo7ABtqCGgwfKj1tPYg=; b=u1s0rV75P1pGkKjlHYPFf/V6+vojp1urRv4AH6r0JVJPT2UMD6dggTyoQ9bgx3NYW1ijxTUaRyo6IqD4ir7PIsQRizbg3MdGeGZClqbBp/ieIhgxP3Ws5bfJq2UcF5ePGCr0d55X7Eu25KSjmZo3e+2KC58ne6oBkS5e9u85r30= Received: from PH0PR18MB4086.namprd18.prod.outlook.com (2603:10b6:510:3::9) by PH0PR18MB3831.namprd18.prod.outlook.com (2603:10b6:510:22::16) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7316.34; Mon, 26 Feb 2024 06:36:34 +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 06:36:33 +0000 From: Pavan Nikhilesh Bhagavatula To: Bruce Richardson , "dev@dpdk.org" , Jerin Jacob , "mattias.ronnblom@ericsson.com" Subject: RE: [EXT] [PATCH v4 06/12] eventdev: improve doxygen comments on configure struct Thread-Topic: [EXT] [PATCH v4 06/12] eventdev: improve doxygen comments on configure struct Thread-Index: AQHaZLFg4LvNcGB3mUeW+wKjwNUL2bEcMruQ Date: Mon, 26 Feb 2024 06:36:33 +0000 Message-ID: References: <20240119174346.108905-1-bruce.richardson@intel.com> <20240221103221.933238-1-bruce.richardson@intel.com> <20240221103221.933238-7-bruce.richardson@intel.com> In-Reply-To: <20240221103221.933238-7-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_|PH0PR18MB3831:EE_ x-ms-office365-filtering-correlation-id: e2b147d5-9a3f-4289-d22c-08dc369545ee x-ms-exchange-senderadcheck: 1 x-ms-exchange-antispam-relay: 0 x-microsoft-antispam: BCL:0; x-microsoft-antispam-message-info: mZ8VFJ7u4EQJ0LgbndNUWBwItrSLJnozT9XADWNIU39DRkd718d38bXr86U/PMz5XmslNm78JNIJLDnNUHwLk2XJKpN6xiNr7ciivJmgzwRk2RbfJkm/d1a80sn5ZMVXjGsKXAEcm4Q0DTqDpzWvMmu/EI10CGtW5cAny8DJ/RvmObgiREdLD2eb9854rGheWCC9ggHIrCmnsw22ujNDP0ADm85esEQ9Fx0OBX0BuhszXArBwP621nqfNTLXe+2m9dH4VsGzHvKBx+8m1DddACI/EqVwvVWQB56/BPLaEZqywVRjAbWr7kdvotrzSxqUif+KWmnishKG0HcGMrM2A/eYyuZanuXfhB8pDT0x9xYHJq66lpoJcm0ZbsLDeTUxg3Regs52kGb2WWwyZeNnhJDtY1imrbBDvAVaOt5xexQlVlmelIvn1IH6XCvYqo6cHhtDSBLQnWJCwpG6wtj6l/qcsTXRl/Yer3iUQlbfVwjUuD273FO4t180sNvvG6Gd6d4G7nUP4o/fnC6lzPeI7Wgy3g7X4OOpH1AjGm/O9oxBG0DoMoG8YZQxlX2FbXkiuXqYmek0leUnmuI3wsDtxgACsrfxckSTOAqgFHm1unWy4fMtWqFnQxKIcRfbELp1mTyy5KnClFPYjZYnmImpXyl5gIKqjUTp3vxFCu5Gq+GjvnZrSY017GIQ96fKWLooeawYnykwopFpv3PZMagwa345oyMz3BbVrUDPZDwGvw4= 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?mcpJqIkA+GRUa8l0C/Bi5nPXlxPhO4L6tM7jNWQaC4nXyj3a3q9k9lpSX3F5?= =?us-ascii?Q?m64f9OeoBZRNDHqFWy9fwBW6T62J2vHAoZNr4JN3uE0AHSl9U4Mui0oZ+u+J?= =?us-ascii?Q?BHmcmITqHUO2s/0Q4dlhJ5zyokMiN44UMyasw+rHLP2lFY9ZF5wSdDhWwSBz?= =?us-ascii?Q?8WmTttWHRYdBtE7C8r10htyC9wcdwqw4YDUSPaIn0c06XbrgLFccn4npijpC?= =?us-ascii?Q?am/V8dt/5BObn/8neZhwqK8cqs+TaWUoLunYhVfIdxTxUE5GcUHDYH19J/nf?= =?us-ascii?Q?kRQSssAE/bSPN7qKgfwNQ5BUy9uIuhcfPT71P+PFgDj3+0DdJXZX6OezAwZ3?= =?us-ascii?Q?l77aJ7s4Bd8rtZCPdtaKdeoLhBEex9NgAKbFoNEEish0VbO8NHIZ9WCGQULK?= =?us-ascii?Q?YW7d6Wz1L2gehdkiCIRoCI8QdDdP4AoGTrvlKp8rw1DwuK+9spgjH98qZJM5?= =?us-ascii?Q?4v9f9iviKZykKglP+ZsRAzh1e096g1nMagL3Jp9eBGRh5dEO3/bkexBwoLrs?= =?us-ascii?Q?eOqt8Qc1QrQiAyKqOWhfrQEKO3fIOs5unPf7lrhq4kD/uYWKgO/3EaAMUZo9?= =?us-ascii?Q?569NG/BslokmOOFFve5LOgsfJjcow1JDModz8NZiRGug6gzqw1WYDA8Jlwrv?= =?us-ascii?Q?f9VlWc/hbalUtdyp7dUAvF7VrdJt7gVV15GifVW4vkHx3mx3lhgL/ktxQ2Ex?= =?us-ascii?Q?e9VWjuSQloCha/1TbZ+/50XV3YoXTqB8WpFU3Xw0VMg2REtiYNedVFjUpMaJ?= =?us-ascii?Q?zhTW5DzeZPxftfVLkwYzJzpSCNY9CwTzEmURPojzphvoMmchvSdC2agZ1BUc?= =?us-ascii?Q?FqVU0/mn369GTGfVxftYPc24Uil1HOffYW3Qju6on8/1IwAxaXqgMl9fmmS3?= =?us-ascii?Q?ZXBm0qZ0t4vBInnV7ULHu/1nAZ9tGFEY3ZplvJaMmmUqtOrzn/76UmVotOfQ?= =?us-ascii?Q?LEB+zo08RQND+SaYTBkAwBA1nY5Ma1myuodC8bPlf36ymERrnrge6NV2LdCy?= =?us-ascii?Q?hMATXIbATddoNobqjlaVpvSiYkMbkpLsVi2HxNQM/9RAHwLDFyQkhh3Q/3qv?= =?us-ascii?Q?u9B9DAKpgolbTVihi2HBVtJyY3OZNYCTvi8LCyBjliKY2HcRjjW9PDmMLRPh?= =?us-ascii?Q?jO1gBOeDIHajGIfHltIM8xgQJgvNoRFK0tk7JxBxxXS5/ykrtDPxI9ZUI6zK?= =?us-ascii?Q?AwGmA32rnXl7VFV2/ag78Vix4yJfHvuncp9rzbaGEJFGbIMDQNvtZY42cHSj?= =?us-ascii?Q?vpidKQ/YKKBMl/CMb7artN8YUeXR2rcVS8ksI8hyXuMyKbVlxJQLrUgKLCUL?= =?us-ascii?Q?klhT2RVjAXDf5NkoZIg4h+yeyb8jQfdLpRjSOssnSCUNaFazJ9HUWMwoZYCp?= =?us-ascii?Q?clyxzIgZBUYnCy0GlRGrdLS7L3OYEonBR4kJFebKIGKRLWtKthUvRGCEmYTp?= =?us-ascii?Q?xP7lJvSMt0386uwTXDSgPcrk/UBVXeDdurIU/MGppCzAPbUz7DsNVRx30A6E?= =?us-ascii?Q?3p7ezYFwEWYsXT21vPtvCDEowfte5dvoFguEu+ighdZxas8tqXoFHza3XHDW?= =?us-ascii?Q?kXZqibUoCY9NQh50GatFrTU+U0N4cAVyeJuatzbz?= 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: e2b147d5-9a3f-4289-d22c-08dc369545ee X-MS-Exchange-CrossTenant-originalarrivaltime: 26 Feb 2024 06:36:33.0594 (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: n1NnNwIlhqOdzaGB0qEjFsfCOEFe0yruuM38BA49grK7CA8dYJfLeyaZfnZcD5Kq5ziDHaqUokfSiSqYo+efVHrjyYyRwfIN8SIB0LyC6fk= X-MS-Exchange-Transport-CrossTenantHeadersStamped: PH0PR18MB3831 X-Proofpoint-ORIG-GUID: -BiQPN_uonowJ4l3nYljGDBaVkP-gWMF X-Proofpoint-GUID: -BiQPN_uonowJ4l3nYljGDBaVkP-gWMF 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_03,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 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. >=20 > 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 >=20 > Bugzilla ID: 1368 > Fixes: 75d113136f38 ("eventdev: express DLB/DLB2 PMD constraints") >=20 > Signed-off-by: Bruce Richardson Acked-by: Pavan Nikhilesh >=20 > --- > V3: > - minor tweaks following review > - merged in doc fix for bugzilla 1368 into this patch, since it fit with > other clarifications to the config struct. > --- > lib/eventdev/rte_eventdev.h | 61 ++++++++++++++++++++++--------------- > 1 file changed, 37 insertions(+), 24 deletions(-) >=20 > diff --git a/lib/eventdev/rte_eventdev.h b/lib/eventdev/rte_eventdev.h > index 9d286168b1..73cc6b6688 100644 > --- a/lib/eventdev/rte_eventdev.h > +++ b/lib/eventdev/rte_eventdev.h > @@ -684,9 +684,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 > */ > @@ -694,40 +694,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_)*/ > @@ -737,7 +750,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. > */ > }; >=20 > -- > 2.40.1