From: Harry van Haaren <harry.van.haaren@intel.com>
Date: Thu, 30 Mar 2017 19:30:29 +0000 (+0100)
Subject: eventdev: improve docs of start function
X-Git-Tag: spdx-start~3851
X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=d924782d84d45717fec6cada688f9439df766a95;p=dpdk.git

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 <jerin.jacob@caviumnetworks.com>
Signed-off-by: Harry van Haaren <harry.van.haaren@intel.com>
---

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