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>
This commit is contained in:
Luca Boccassi 2017-10-24 14:19:04 +01:00 committed by Ferruh Yigit
parent 9eff0d0f97
commit d5c7a09edb

View File

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