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 7810DA0C50; Sat, 24 Jul 2021 14:33:35 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id A29B9410D7; Sat, 24 Jul 2021 14:33:34 +0200 (CEST) Received: from shelob.oktetlabs.ru (shelob.oktetlabs.ru [91.220.146.113]) by mails.dpdk.org (Postfix) with ESMTP id B2C774067A; Sat, 24 Jul 2021 14:33:33 +0200 (CEST) Received: by shelob.oktetlabs.ru (Postfix, from userid 122) id 5160F7F6C6; Sat, 24 Jul 2021 15:33:33 +0300 (MSK) X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on shelob.oktetlabs.ru X-Spam-Level: X-Spam-Status: No, score=0.8 required=5.0 tests=ALL_TRUSTED, DKIM_ADSP_DISCARD, URIBL_BLOCKED autolearn=no autolearn_force=no version=3.4.2 Received: from aros.oktetlabs.ru (aros.oktetlabs.ru [192.168.38.17]) by shelob.oktetlabs.ru (Postfix) with ESMTP id 6DC4F7F51B; Sat, 24 Jul 2021 15:33:29 +0300 (MSK) DKIM-Filter: OpenDKIM Filter v2.11.0 shelob.oktetlabs.ru 6DC4F7F51B Authentication-Results: shelob.oktetlabs.ru/6DC4F7F51B; dkim=none; dkim-atps=neutral From: Andrew Rybchenko To: dev@dpdk.org, Thomas Monjalon , Ferruh Yigit , Kuba Kozak Cc: Ivan Ilchenko , stable@dpdk.org, Andy Moreton Date: Sat, 24 Jul 2021 15:33:13 +0300 Message-Id: <20210724123314.2970537-1-andrew.rybchenko@oktetlabs.ru> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20210604144225.287678-1-andrew.rybchenko@oktetlabs.ru> References: <20210604144225.287678-1-andrew.rybchenko@oktetlabs.ru> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: [dpdk-dev] [PATCH v4 1/2] ethdev: fix docs of functions getting xstats by IDs 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 Sender: "dev" From: Ivan Ilchenko Document valid combinations of input arguments in accordance with current implementation in ethdev. Fixes: 79c913a42f0 ("ethdev: retrieve xstats by ID") Cc: stable@dpdk.org Signed-off-by: Ivan Ilchenko Signed-off-by: Andrew Rybchenko Reviewed-by: Andy Moreton --- lib/ethdev/rte_ethdev.h | 32 +++++++++++++++++++------------- 1 file changed, 19 insertions(+), 13 deletions(-) diff --git a/lib/ethdev/rte_ethdev.h b/lib/ethdev/rte_ethdev.h index d2b27c351f..b14067fe7e 100644 --- a/lib/ethdev/rte_ethdev.h +++ b/lib/ethdev/rte_ethdev.h @@ -2872,13 +2872,17 @@ int rte_eth_xstats_get(uint16_t port_id, struct rte_eth_xstat *xstats, * @param port_id * The port identifier of the Ethernet device. * @param xstats_names - * An rte_eth_xstat_name array of at least *size* elements to - * be filled. If set to NULL, the function returns the required number - * of elements. + * Array to be filled in with names of requested device statistics. + * Must not be NULL if @p ids are specified (not NULL). * @param ids - * IDs array given by app to retrieve specific statistics + * IDs array given by app to retrieve specific statistics. May be NULL to + * retrieve names of all available statistics or, if @p xstats_names is + * NULL as well, just a number of available statistics. * @param size - * The size of the xstats_names array (number of elements). + * If @p ids is not NULL, number of elements in the array with requested IDs + * and number of elements in @p xstats_names to put names in. If @p ids is + * NULL, number of elements in @p xstats_names to put all available statistics + * names in. * @return * - A positive value lower or equal to size: success. The return value * is the number of entries filled in the stats table. @@ -2886,7 +2890,7 @@ int rte_eth_xstats_get(uint16_t port_id, struct rte_eth_xstat *xstats, * is too small. The return value corresponds to the size that should * be given to succeed. The entries in the table are not valid and * shall not be used by the caller. - * - A negative value on error (invalid port id). + * - A negative value on error. */ int rte_eth_xstats_get_names_by_id(uint16_t port_id, @@ -2899,14 +2903,16 @@ rte_eth_xstats_get_names_by_id(uint16_t port_id, * @param port_id * The port identifier of the Ethernet device. * @param ids - * A pointer to an ids array passed by application. This tells which - * statistics values function should retrieve. This parameter - * can be set to NULL if size is 0. In this case function will retrieve - * all available statistics. + * IDs array given by app to retrieve specific statistics. May be NULL to + * retrieve all available statistics or, if @p values is NULL as well, + * just a number of available statistics. * @param values - * A pointer to a table to be filled with device statistics values. + * Array to be filled in with requested device statistics. + * Must not be NULL if ids are specified (not NULL). * @param size - * The size of the ids array (number of elements). + * If @p ids is not NULL, number of elements in the array with requested IDs + * and number of elements in @p values to put statistics in. If @p ids is NULL, + * number of elements in @p values to put all available statistics in. * @return * - A positive value lower or equal to size: success. The return value * is the number of entries filled in the stats table. @@ -2914,7 +2920,7 @@ rte_eth_xstats_get_names_by_id(uint16_t port_id, * is too small. The return value corresponds to the size that should * be given to succeed. The entries in the table are not valid and * shall not be used by the caller. - * - A negative value on error (invalid port id). + * - A negative value on error. */ int rte_eth_xstats_get_by_id(uint16_t port_id, const uint64_t *ids, uint64_t *values, unsigned int size); -- 2.30.2