From mboxrd@z Thu Jan 1 00:00:00 1970 From: luca.boccassi@gmail.com Subject: [PATCH 1/2] ethdev: document rte_eth_dev_reset return codes Date: Thu, 19 Oct 2017 14:48:26 +0100 Message-ID: <20171019134827.22740-1-luca.boccassi@gmail.com> Cc: wenzhuo.lu@intel.com, wei.dai@intel.com, remy.horton@intel.com, Luca Boccassi To: dev@dpdk.org Return-path: Received: from mail-wm0-f68.google.com (mail-wm0-f68.google.com [74.125.82.68]) by dpdk.org (Postfix) with ESMTP id 75AA09B6B for ; Thu, 19 Oct 2017 15:48:49 +0200 (CEST) Received: by mail-wm0-f68.google.com with SMTP id u138so16163901wmu.5 for ; Thu, 19 Oct 2017 06:48:49 -0700 (PDT) List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" From: Luca Boccassi This new function returns 0 on success and various error codes on different failures. Attempt to document them. Signed-off-by: Luca Boccassi --- lib/librte_ether/rte_ethdev.h | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/lib/librte_ether/rte_ethdev.h b/lib/librte_ether/rte_ethdev.h index aaf02b33d..9cdb9724a 100644 --- a/lib/librte_ether/rte_ethdev.h +++ b/lib/librte_ether/rte_ethdev.h @@ -2262,6 +2262,14 @@ void rte_eth_dev_close(uint16_t port_id); * * @param port_id * The port identifier of the Ethernet device. + * + * @return + * - (0) if successful. + * - (-EINVAL) if port identifier is invalid. + * - (-ENOTSUP) if hardware doesn't support this function. + * - (-EPERM) if not ran from the primary process. + * - (-EIO) if re-initialisation failed. + * - (-ENOMEM) if the reset failed due to OOM. */ int rte_eth_dev_reset(uint16_t port_id); -- 2.11.0