From patchwork Wed Feb 21 10:32:14 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bruce Richardson X-Patchwork-Id: 136961 X-Patchwork-Delegate: jerinj@marvell.com Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id AC56243B61; Wed, 21 Feb 2024 11:33:02 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 7BA8640E09; Wed, 21 Feb 2024 11:32:39 +0100 (CET) Received: from mgamail.intel.com (mgamail.intel.com [192.198.163.15]) by mails.dpdk.org (Postfix) with ESMTP id 7891640DCB for ; Wed, 21 Feb 2024 11:32:36 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1708511557; x=1740047557; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=8ODRsJgg3p8zuDDukFfrcJG/OQ+7gPhkfTrFTgqw7HY=; b=cOm4TzDS37pknMw4+ZxrJr+eQvoOu1i6QnQ45sZLhE8/7wiCdqLXKvcr SlR8Ju8BGdOFQtD7iVcFXtZw8nTYPSLOL27KkLjEAxdrQhy0gEnSOaJ+M b34XY+nn0Lf2hYAst3FmzjV5xQrhmvUQUYPZzZEScPqwIE4/sY2Qt2B+p 60wT/rkFgfVh59dKWEYp0iK7LElow56tXC1AkueMsDYxGl5wZ3KaCJJ7m 6P3/uxTA7lB8bhMG+luaMYprkL+VBoZ4Z7IAZoy7eyroZe7viSFJVZU4x WA9esC6CQldo5AsdzNomkwH/iaR9CJO2fHRxaMhdPFoxVvfelBHiHib8I w==; X-IronPort-AV: E=McAfee;i="6600,9927,10990"; a="2800719" X-IronPort-AV: E=Sophos;i="6.06,175,1705392000"; d="scan'208";a="2800719" Received: from orviesa007.jf.intel.com ([10.64.159.147]) by fmvoesa109.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 21 Feb 2024 02:32:36 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="6.06,175,1705392000"; d="scan'208";a="5393009" Received: from silpixa00401385.ir.intel.com ([10.237.214.38]) by orviesa007.jf.intel.com with ESMTP; 21 Feb 2024 02:32:35 -0800 From: Bruce Richardson To: dev@dpdk.org, jerinj@marvell.com, mattias.ronnblom@ericsson.com Cc: Bruce Richardson Subject: [PATCH v4 05/12] eventdev: improve function documentation for query fns Date: Wed, 21 Feb 2024 10:32:14 +0000 Message-Id: <20240221103221.933238-6-bruce.richardson@intel.com> X-Mailer: git-send-email 2.40.1 In-Reply-To: <20240221103221.933238-1-bruce.richardson@intel.com> References: <20240119174346.108905-1-bruce.richardson@intel.com> <20240221103221.933238-1-bruce.richardson@intel.com> MIME-Version: 1.0 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 Acked-by: Pavan Nikhilesh --- V3: minor changes following review --- 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 b9ec3fc45e..9d286168b1 100644 --- a/lib/eventdev/rte_eventdev.h +++ b/lib/eventdev/rte_eventdev.h @@ -498,8 +498,7 @@ struct rte_event; */ /** - * Get the total number of event devices that have been successfully - * initialised. + * Get the total number of event devices. * * @return * The total number of usable event devices. @@ -514,8 +513,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); @@ -528,7 +529,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); @@ -624,18 +626,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);