From mboxrd@z Thu Jan 1 00:00:00 1970 From: Harry van Haaren Subject: [PATCH v6 01/21] eventdev: improve API docs for start function Date: Thu, 30 Mar 2017 00:25:43 +0100 Message-ID: <1490829963-106807-2-git-send-email-harry.van.haaren@intel.com> References: <1490374395-149320-1-git-send-email-harry.van.haaren@intel.com> <1490829963-106807-1-git-send-email-harry.van.haaren@intel.com> Cc: jerin.jacob@caviumnetworks.com, Harry van Haaren To: dev@dpdk.org Return-path: Received: from mga11.intel.com (mga11.intel.com [192.55.52.93]) by dpdk.org (Postfix) with ESMTP id 571179E3 for ; Thu, 30 Mar 2017 01:26:18 +0200 (CEST) In-Reply-To: <1490829963-106807-1-git-send-email-harry.van.haaren@intel.com> List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" This commit documents two error return values for the rte_event_dev_start() function. -EINVAL indicates not all ports are configured -EDEADLK indicates that not all queues are linked to ports. If an application enqueues to such a queue it can lead to deadlock 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 9971937..dc8dacb 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. + * - -EINVAL : Not all ports of the device are configured + * - -EDEADLK: Not all queues are linked, which could lead to deadlock. */ int rte_event_dev_start(uint8_t dev_id); -- 2.7.4