[dpdk-dev,1/2] ethdev: document rte_eth_dev_reset return codes
diff mbox

Message ID 20171019134827.22740-1-luca.boccassi@gmail.com
State Superseded, archived
Delegated to: Ferruh Yigit
Headers show

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Luca Boccassi Oct. 19, 2017, 1:48 p.m. UTC
From: Luca Boccassi <bluca@debian.org>

This new function returns 0 on success and various error codes on
different failures. Attempt to document them.

Signed-off-by: Luca Boccassi <bluca@debian.org>
---
 lib/librte_ether/rte_ethdev.h | 8 ++++++++
 1 file changed, 8 insertions(+)

Comments

Remy Horton Oct. 19, 2017, 2:52 p.m. UTC | #1
On 19/10/2017 14:48, luca.boccassi@gmail.com wrote:
> From: Luca Boccassi <bluca@debian.org>
>
> This new function returns 0 on success and various error codes on
> different failures. Attempt to document them.
>
> Signed-off-by: Luca Boccassi <bluca@debian.org>
> ---
>  lib/librte_ether/rte_ethdev.h | 8 ++++++++
>  1 file changed, 8 insertions(+)

Acked-by: Remy Horton <remy.horton@intel.com>

Patch
diff mbox

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);