From mboxrd@z Thu Jan 1 00:00:00 1970 From: Thomas Monjalon Subject: [PATCH v2 03/11] ethdev: add doxygen comments for each state Date: Thu, 10 May 2018 00:43:05 +0200 Message-ID: <20180509224313.27289-4-thomas@monjalon.net> References: <20180509094337.26112-1-thomas@monjalon.net> <20180509224313.27289-1-thomas@monjalon.net> To: dev@dpdk.org Return-path: Received: from out1-smtp.messagingengine.com (out1-smtp.messagingengine.com [66.111.4.25]) by dpdk.org (Postfix) with ESMTP id DF3F91B795 for ; Thu, 10 May 2018 00:43:24 +0200 (CEST) Received: from xps.monjalon.net (184.203.134.77.rev.sfr.net [77.134.203.184]) by mail.messagingengine.com (Postfix) with ESMTPA id AA83EE46C1 for ; Wed, 9 May 2018 18:43:23 -0400 (EDT) In-Reply-To: <20180509224313.27289-1-thomas@monjalon.net> List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" The enum rte_eth_dev_state was not properly documented. Its values did not appear in the doxygen output, and may be misunderstood. The state RTE_ETH_DEV_DEFERRED has no interest anymore since the ownership mechanism brings a more flexible categorization. This state could be removed later. Fixes: d52268a8b24b ("ethdev: expose device states") Fixes: cb894d99eceb ("ethdev: add deferred intermediate device state") Fixes: 5b7ba31148a8 ("ethdev: add port ownership") Fixes: 7106edc12380 ("ethdev: add devop to check removal status") Signed-off-by: Thomas Monjalon Acked-by: Matan Azrad Reviewed-by: Ferruh Yigit --- lib/librte_ethdev/rte_ethdev.h | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/lib/librte_ethdev/rte_ethdev.h b/lib/librte_ethdev/rte_ethdev.h index 7ccf4bae6..2271337dc 100644 --- a/lib/librte_ethdev/rte_ethdev.h +++ b/lib/librte_ethdev/rte_ethdev.h @@ -1269,12 +1269,16 @@ typedef uint16_t (*rte_tx_callback_fn)(uint16_t port_id, uint16_t queue, struct rte_mbuf *pkts[], uint16_t nb_pkts, void *user_param); /** - * A set of values to describe the possible states of an eth device. + * Possible states of an ethdev port. */ enum rte_eth_dev_state { + /** Device is unused before being probed. */ RTE_ETH_DEV_UNUSED = 0, + /** Device is attached when allocated in probing. */ RTE_ETH_DEV_ATTACHED, + /** The deferred state is useless and replaced by ownership. */ RTE_ETH_DEV_DEFERRED, + /** Device is in removed state when plug-out is detected. */ RTE_ETH_DEV_REMOVED, }; -- 2.16.2