From d924782d84d45717fec6cada688f9439df766a95 Mon Sep 17 00:00:00 2001 From: Harry van Haaren Date: Thu, 30 Mar 2017 20:30:29 +0100 Subject: [PATCH] eventdev: improve docs of start function This commit documents two error return values for the rte_event_dev_start() function. -ESTALE indicates not all ports are configured -ENOLINK indicates that not all queues are linked to ports. If an application enqueues to such a queue it can lead to deadlock Suggested-by: Jerin Jacob Signed-off-by: Harry van Haaren --- lib/librte_eventdev/rte_eventdev.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/lib/librte_eventdev/rte_eventdev.h b/lib/librte_eventdev/rte_eventdev.h index 99719378ac..b8ed6ef085 100644 --- a/lib/librte_eventdev/rte_eventdev.h +++ b/lib/librte_eventdev/rte_eventdev.h @@ -757,7 +757,8 @@ rte_event_port_count(uint8_t dev_id); * Event device identifier * @return * - 0: Success, device started. - * - <0: Error code of the driver device start function. + * - -ESTALE : Not all ports of the device are configured + * - -ENOLINK: Not all queues are linked, which could lead to deadlock. */ int rte_event_dev_start(uint8_t dev_id); -- 2.20.1