From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 7E9B6438F3; Thu, 18 Jan 2024 14:46:52 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id F1D0242DA3; Thu, 18 Jan 2024 14:46:23 +0100 (CET) Received: from mgamail.intel.com (mgamail.intel.com [198.175.65.13]) by mails.dpdk.org (Postfix) with ESMTP id 877EE42DAC for ; Thu, 18 Jan 2024 14:46:20 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1705585581; x=1737121581; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=L5m5miMiYE21agROvRXl0A3v7/+usNFxKwe9mRepIpA=; b=RuJz57X1IiEHTxfAXLV2jG8OHQYROuYJC4OUlp432/pk9BFDAkSqWboC pAbuwAR/n29rSDTzhoM12WRx/x2fnlrvUlezblYcvO/bVJ53V6zL0JP3A kFeWwQLeWHxNJkLBzOOzn+tFq2InYmCtc0/Jm8W2Mm1sN6ltxtY7P3s3i qZEGJEZ8bDhAva83ss1VKntBmUXssvCZ4zhYnim62hUt5oZDuz+5seB9g qRBp7jog+M2mlbqcfiwZSB+qx/iINpAq6SBHGZxkUhhIeW5Y1YqK8lvKB 2lpuEXHwWnGvHy1Ud+rLUEtYs2CrBZzpF5D2R0Zsu46OZCWgFR0VLXF8l A==; X-IronPort-AV: E=McAfee;i="6600,9927,10956"; a="7542795" X-IronPort-AV: E=Sophos;i="6.05,201,1701158400"; d="scan'208";a="7542795" Received: from orsmga003.jf.intel.com ([10.7.209.27]) by orvoesa105.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 18 Jan 2024 05:46:20 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=McAfee;i="6600,9927,10956"; a="734274148" X-IronPort-AV: E=Sophos;i="6.05,201,1701158400"; d="scan'208";a="734274148" Received: from silpixa00400957.ir.intel.com (HELO silpixa00401385.ir.intel.com) ([10.237.214.26]) by orsmga003.jf.intel.com with ESMTP; 18 Jan 2024 05:46:18 -0800 From: Bruce Richardson To: dev@dpdk.org Cc: Bruce Richardson , Jerin Jacob Subject: [PATCH v1 5/7] eventdev: improve function documentation for query fns Date: Thu, 18 Jan 2024 13:45:55 +0000 Message-Id: <20240118134557.73172-6-bruce.richardson@intel.com> X-Mailer: git-send-email 2.40.1 In-Reply-To: <20240118134557.73172-1-bruce.richardson@intel.com> References: <20240118134557.73172-1-bruce.richardson@intel.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org General improvements to the doxygen docs for eventdev functions for querying basic information: * number of devices * id for a particular device * socket id of device * capability information for a device Signed-off-by: Bruce Richardson --- lib/eventdev/rte_eventdev.h | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/lib/eventdev/rte_eventdev.h b/lib/eventdev/rte_eventdev.h index 872f241df2..c57c93a22e 100644 --- a/lib/eventdev/rte_eventdev.h +++ b/lib/eventdev/rte_eventdev.h @@ -440,8 +440,7 @@ struct rte_event; */ /** - * Get the total number of event devices that have been successfully - * initialised. + * Get the total number of event devices available for application use. * * @return * The total number of usable event devices. @@ -456,8 +455,10 @@ rte_event_dev_count(void); * Event device name to select the event device identifier. * * @return - * Returns event device identifier on success. - * - <0: Failure to find named event device. + * Event device identifier (dev_id >= 0) on success. + * Negative error code on failure: + * - -EINVAL - input name parameter is invalid + * - -ENODEV - no event device found with that name */ int rte_event_dev_get_dev_id(const char *name); @@ -470,7 +471,8 @@ rte_event_dev_get_dev_id(const char *name); * @return * The NUMA socket id to which the device is connected or * a default of zero if the socket could not be determined. - * -(-EINVAL) dev_id value is out of range. + * -EINVAL on error, where the given dev_id value does not + * correspond to any event device. */ int rte_event_dev_socket_id(uint8_t dev_id); @@ -539,18 +541,20 @@ struct rte_event_dev_info { }; /** - * Retrieve the contextual information of an event device. + * Retrieve details of an event device's capabilities and configuration limits. * * @param dev_id * The identifier of the device. * * @param[out] dev_info * A pointer to a structure of type *rte_event_dev_info* to be filled with the - * contextual information of the device. + * information about the device's capabilities. * * @return - * - 0: Success, driver updates the contextual information of the event device - * - <0: Error code returned by the driver info get function. + * - 0: Success, information about the event device is present in dev_info. + * - <0: Failure, error code returned by the function. + * - -EINVAL - invalid input parameters, e.g. incorrect device id + * - -ENOTSUP - device does not support returning capabilities information */ int rte_event_dev_info_get(uint8_t dev_id, struct rte_event_dev_info *dev_info); -- 2.40.1