From: Luca Boccassi <bluca@debian.org>
Date: Tue, 24 Oct 2017 13:19:04 +0000 (+0100)
Subject: ethdev: document error codes of reset
X-Git-Tag: spdx-start~1113
X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=d5c7a09edbe709b50ecde4269b80b9a07627c876;p=dpdk.git

ethdev: document error codes of reset

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>
Acked-by: Thomas Monjalon <thomas@monjalon.net>
---

diff --git a/lib/librte_ether/rte_ethdev.h b/lib/librte_ether/rte_ethdev.h
index 028bf111a9..60a8bae605 100644
--- a/lib/librte_ether/rte_ethdev.h
+++ b/lib/librte_ether/rte_ethdev.h
@@ -2278,6 +2278,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);