From: Luca Boccassi Date: Tue, 24 Oct 2017 13:19:05 +0000 (+0100) Subject: ethdev: document new error code for reset X-Git-Tag: spdx-start~1112 X-Git-Url: http://git.droids-corp.org/?p=dpdk.git;a=commitdiff_plain;h=79e4ee566891c8e2e8b3657fa64d5d896190737e ethdev: document new error code for reset When VF reset will be supported by drivers, the API will most likely have to return -EAGAIN to avoid blocking when the VF cannot be reset because the PF is down. Document it immediately even if it's not yet supported, so that users and developers can already take into account about this use case, and thus avoid an API-incompatible change later on. This is based on real-world production usage and customer escalations, using earlier patches from Intel [1]. [1] http://dpdk.org/ml/archives/dev/2017-October/079692.html Signed-off-by: Luca Boccassi Acked-by: Thomas Monjalon --- diff --git a/lib/librte_ether/rte_ethdev.h b/lib/librte_ether/rte_ethdev.h index 60a8bae605..67ecc6a336 100644 --- a/lib/librte_ether/rte_ethdev.h +++ b/lib/librte_ether/rte_ethdev.h @@ -2286,6 +2286,7 @@ void rte_eth_dev_close(uint16_t port_id); * - (-EPERM) if not ran from the primary process. * - (-EIO) if re-initialisation failed. * - (-ENOMEM) if the reset failed due to OOM. + * - (-EAGAIN) if the reset temporarily failed and should be retried later. */ int rte_eth_dev_reset(uint16_t port_id);