[dpdk-dev,v2,1/2] ethdev: document rte_eth_dev_reset return codes
Checks
Commit Message
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
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>
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.
@@ -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);