ethdev: document new error code for reset
authorLuca Boccassi <bluca@debian.org>
Tue, 24 Oct 2017 13:19:05 +0000 (14:19 +0100)
committerFerruh Yigit <ferruh.yigit@intel.com>
Thu, 26 Oct 2017 00:33:01 +0000 (02:33 +0200)
commit79e4ee566891c8e2e8b3657fa64d5d896190737e
tree3bfd615b9eb536023e3e6256c4e46262c14e181e
parentd5c7a09edbe709b50ecde4269b80b9a07627c876
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 <bluca@debian.org>
Acked-by: Thomas Monjalon <thomas@monjalon.net>
lib/librte_ether/rte_ethdev.h