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

Message ID 20171024110312.24029-1-luca.boccassi@gmail.com
State Superseded, archived
Headers show

Checks

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

Commit Message

Luca Boccassi Oct. 24, 2017, 11:03 a.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

Thomas Monjalon Oct. 24, 2017, 12:27 p.m. UTC | #1
24/10/2017 13:03, luca.boccassi@gmail.com:
> 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>

Suggested title: "ethdev: document error codes of reset"

Acked-by: Thomas Monjalon <thomas@monjalon.net>
Luca Boccassi Oct. 24, 2017, 1:19 p.m. UTC | #2
On Tue, 2017-10-24 at 14:27 +0200, Thomas Monjalon wrote:
> 24/10/2017 13:03, luca.boccassi@gmail.com:
> > 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>
> 
> Suggested title: "ethdev: document error codes of reset"
> 
> Acked-by: Thomas Monjalon <thomas@monjalon.net>

Ok, see v3.

Patch
diff mbox

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