From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-wm0-f66.google.com (mail-wm0-f66.google.com [74.125.82.66]) by dpdk.org (Postfix) with ESMTP id B5AE21B7B1 for ; Tue, 24 Oct 2017 13:03:20 +0200 (CEST) Received: by mail-wm0-f66.google.com with SMTP id p75so14902851wmg.3 for ; Tue, 24 Oct 2017 04:03:20 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=TlIwxcw+PJT4TJSsFCp6TJ/qb2/yoNWSinIKtEUegfs=; b=Ll83DYYDzIL4tuo8lI8ZbI0frRq6Ksaji61GQV9jqGY53OSb1LMZbeZ6Iuvobk5REo utbZxEx9mlALUVBYyzM2/ktvUec39TqPtbYQBx26uttlmQvSoFdd+T7HMFKMsQCCX6n+ atJChZ3fLfJn60G9/yKN2rzSATNHuSj0jfp4w5HtymPE2o5fPuOA7FkCcj+zj0PNqSf/ v/GplQdBW21t8ekyUKmynLSr6wwQ35pLiWIIhk7dP3Tmr0oh0avCaVVxZd3jqRTo04pz l9tAg+MBHLbP5sIYY/kZdwmIqR0BYVVEImQnHU0SfCVW0ktQ4Udi/fq40uPU4GeAgSus cRuw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=TlIwxcw+PJT4TJSsFCp6TJ/qb2/yoNWSinIKtEUegfs=; b=AOY+aiii7RSOe105aTXo4eoMThlDGhlGfqLWd24NCCOKU8IJpmBmU+N/qmXXrWzz43 WTUtsYZZ5xCPRcvVizE/PoIayPiCWqDCZ27iWgN6cnEr/NF8/FeY5i7uCONyXrcUd+90 ZtOsSXLWavJKbCAxQfhyMTnmxHayWovDOqiN/zL5aoQ9sK/6Nz3ymu7x7p2x7Fm7LUyd tkJ7lsSxkP4UIFXp+5ZIMggDB9/ZCzv7/A1JdjOFDd0hMb0qaWzYljfv2nzY9twpR1p5 E/sV26hSYkQYtP637EBtci1qialKTQuUOMqUBdxXHgfo4bGEYWRLMkbN3lJfKKgG8miO sllg== X-Gm-Message-State: AMCzsaUjHnIGPQyZ7eJtSqfZF9QtxSd710bmL7DqxcsiM1duGYerfJN4 9Wv6wtW1iijrhM0NcR5Xp4c2KtH85zs= X-Google-Smtp-Source: ABhQp+SnchjmJfuhNJJEOutVzxEzlrEt6FJsdCw/m7SCIj1Unyh0asv9nxk+mQPJ521nL0UiaNz+GQ== X-Received: by 10.80.165.204 with SMTP id b12mr20626210edc.289.1508843000221; Tue, 24 Oct 2017 04:03:20 -0700 (PDT) Received: from localhost ([213.251.34.151]) by smtp.gmail.com with ESMTPSA id k42sm5993edb.88.2017.10.24.04.03.19 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Tue, 24 Oct 2017 04:03:19 -0700 (PDT) From: luca.boccassi@gmail.com To: dev@dpdk.org Cc: wenzhuo.lu@intel.com, wei.dai@intel.com, remy.horton@intel.com, thomas@monjalon.net, Luca Boccassi Date: Tue, 24 Oct 2017 12:03:11 +0100 Message-Id: <20171024110312.24029-1-luca.boccassi@gmail.com> X-Mailer: git-send-email 2.11.0 In-Reply-To: <20171019134827.22740-1-luca.boccassi@gmail.com> References: <20171019134827.22740-1-luca.boccassi@gmail.com> Subject: [dpdk-dev] [PATCH v2 1/2] ethdev: document rte_eth_dev_reset return codes X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 24 Oct 2017 11:03:20 -0000 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 b773589d6..697f6b2e0 100644 --- a/lib/librte_ether/rte_ethdev.h +++ b/lib/librte_ether/rte_ethdev.h @@ -2269,6 +2269,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