[v3,1/2] ethdev: clarify something about the new event

Message ID 20250117091210.12419-2-lihuisong@huawei.com (mailing list archive)
State Accepted
Delegated to: Stephen Hemminger
Headers
Series ethdev: clarify something about new event |

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Huisong Li Jan. 17, 2025, 9:12 a.m. UTC
If application verify the validity of the port id or configure this port in
the new event callback, application may happen to the port id is invalid.

In case of similar confusion, this patch have to clarify something about
RTE_ETH_EVENT_NEW in code.

Signed-off-by: Huisong Li <lihuisong@huawei.com>
Acked-by: Thomas Monjalon <thomas@monjalon.net>
---
 lib/ethdev/rte_ethdev.h | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)
  

Patch

diff --git a/lib/ethdev/rte_ethdev.h b/lib/ethdev/rte_ethdev.h
index 1f71cad244..ee7197aa97 100644
--- a/lib/ethdev/rte_ethdev.h
+++ b/lib/ethdev/rte_ethdev.h
@@ -4128,7 +4128,11 @@  enum rte_eth_event_type {
 	RTE_ETH_EVENT_VF_MBOX,  /**< message from the VF received by PF */
 	RTE_ETH_EVENT_MACSEC,   /**< MACsec offload related event */
 	RTE_ETH_EVENT_INTR_RMV, /**< device removal event */
-	RTE_ETH_EVENT_NEW,      /**< port is probed */
+	/** The port is being probed, i.e. allocated and not yet available.
+	 * It is too early to check validity, query infos, and configure
+	 * the port.
+	 */
+	RTE_ETH_EVENT_NEW,
 	RTE_ETH_EVENT_DESTROY,  /**< port is released */
 	RTE_ETH_EVENT_IPSEC,    /**< IPsec offload related event */
 	RTE_ETH_EVENT_FLOW_AGED,/**< New aged-out flows is detected */