From: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru> To: dev@dpdk.org, Thomas Monjalon <thomas@monjalon.net>, Ferruh Yigit <ferruh.yigit@intel.com>, Kuba Kozak <kubax.kozak@intel.com> Cc: Ivan Ilchenko <ivan.ilchenko@oktetlabs.ru>, stable@dpdk.org, Andy Moreton <amoreton@xilinx.com> Subject: [dpdk-stable] [PATCH v4 2/2] ethdev: fix docs of drivers callbacks getting xstats by IDs Date: Sat, 24 Jul 2021 15:33:14 +0300 Message-ID: <20210724123314.2970537-2-andrew.rybchenko@oktetlabs.ru> (raw) In-Reply-To: <20210724123314.2970537-1-andrew.rybchenko@oktetlabs.ru> From: Ivan Ilchenko <ivan.ilchenko@oktetlabs.ru> Update xstats by IDs callbacks documentation in accordance with ethdev usage of these callbacks. Document valid combinations of input arguments to make driver implementation simpler. Fixes: 79c913a42f0 ("ethdev: retrieve xstats by ID") Cc: stable@dpdk.org Signed-off-by: Ivan Ilchenko <ivan.ilchenko@oktetlabs.ru> Signed-off-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru> Reviewed-by: Andy Moreton <amoreton@xilinx.com> --- lib/ethdev/ethdev_driver.h | 43 ++++++++++++++++++++++++++++++++++++-- 1 file changed, 41 insertions(+), 2 deletions(-) diff --git a/lib/ethdev/ethdev_driver.h b/lib/ethdev/ethdev_driver.h index 40e474aa7e..fd5b7ca550 100644 --- a/lib/ethdev/ethdev_driver.h +++ b/lib/ethdev/ethdev_driver.h @@ -187,11 +187,28 @@ typedef int (*eth_xstats_get_t)(struct rte_eth_dev *dev, struct rte_eth_xstat *stats, unsigned int n); /**< @internal Get extended stats of an Ethernet device. */ +/** + * @internal + * Get extended stats of an Ethernet device. + * + * @param dev + * ethdev handle of port. + * @param ids + * IDs array to retrieve specific statistics. Must not be NULL. + * @param values + * A pointer to a table to be filled with device statistics values. + * Must not be NULL. + * @param n + * Element count in @p ids and @p values + * + * @return + * - A number of filled in stats. + * - A negative value on error. + */ typedef int (*eth_xstats_get_by_id_t)(struct rte_eth_dev *dev, const uint64_t *ids, uint64_t *values, unsigned int n); -/**< @internal Get extended stats of an Ethernet device. */ /** * @internal @@ -218,10 +235,32 @@ typedef int (*eth_xstats_get_names_t)(struct rte_eth_dev *dev, struct rte_eth_xstat_name *xstats_names, unsigned int size); /**< @internal Get names of extended stats of an Ethernet device. */ +/** + * @internal + * Get names of extended stats of an Ethernet device. + * For name count, set @p xstats_names and @p ids to NULL. + * + * @param dev + * ethdev handle of port. + * @param xstats_names + * An rte_eth_xstat_name array of at least *size* elements to + * be filled. Can be NULL together with @p ids to retrieve number of + * available statistics. + * @param ids + * IDs array to retrieve specific statistics. Can be NULL together + * with @p xstats_names to retrieve number of available statistics. + * @param size + * Size of ids and xstats_names arrays. + * Element count in @p ids and @p xstats_names + * + * @return + * - A number of filled in stats if both xstats_names and ids are not NULL. + * - A number of available stats if both xstats_names and ids are NULL. + * - A negative value on error. + */ typedef int (*eth_xstats_get_names_by_id_t)(struct rte_eth_dev *dev, struct rte_eth_xstat_name *xstats_names, const uint64_t *ids, unsigned int size); -/**< @internal Get names of extended stats of an Ethernet device. */ typedef int (*eth_queue_stats_mapping_set_t)(struct rte_eth_dev *dev, uint16_t queue_id, -- 2.30.2
next prev parent reply other threads:[~2021-07-24 12:33 UTC|newest] Thread overview: 64+ messages / expand[flat|nested] mbox.gz Atom feed top [not found] <20210604144225.287678-1-andrew.rybchenko@oktetlabs.ru> 2021-06-04 14:42 ` [dpdk-stable] [PATCH 01/11] net/sfc: fix get xstats by ID callback to use MAC stats lock Andrew Rybchenko 2021-06-04 14:42 ` [dpdk-stable] [PATCH 02/11] net/sfc: fix reading adapter state without locking Andrew Rybchenko 2021-06-04 14:42 ` [dpdk-stable] [PATCH 03/11] ethdev: fix docs of functions getting xstats by IDs Andrew Rybchenko 2021-07-20 16:25 ` Ferruh Yigit 2021-07-22 9:12 ` Andrew Rybchenko 2021-07-23 14:19 ` Ferruh Yigit 2021-07-24 12:06 ` Andrew Rybchenko 2021-06-04 14:42 ` [dpdk-stable] [PATCH 04/11] ethdev: fix docs of drivers callbacks " Andrew Rybchenko 2021-07-20 16:51 ` Ferruh Yigit 2021-07-22 9:33 ` Andrew Rybchenko 2021-07-23 14:31 ` Ferruh Yigit 2021-07-23 18:47 ` Andrew Rybchenko 2021-06-04 14:42 ` [dpdk-stable] [PATCH 05/11] net/sfc: fix xstats by ID callbacks according to ethdev Andrew Rybchenko 2021-06-04 14:42 ` [dpdk-stable] [PATCH 06/11] net/sfc: fix accessing xstats by an unsorted list of IDs Andrew Rybchenko 2021-06-04 14:42 ` [dpdk-stable] [PATCH 07/11] net/sfc: fix MAC stats update to work for stopped device Andrew Rybchenko [not found] ` <20210722095433.1898589-1-andrew.rybchenko@oktetlabs.ru> 2021-07-22 9:54 ` [dpdk-stable] [PATCH v2 01/11] net/sfc: fix get xstats by ID callback to use MAC stats lock Andrew Rybchenko 2021-07-22 9:54 ` [dpdk-stable] [PATCH v2 02/11] net/sfc: fix reading adapter state without locking Andrew Rybchenko 2021-07-22 9:54 ` [dpdk-stable] [PATCH v2 03/11] ethdev: fix docs of functions getting xstats by IDs Andrew Rybchenko 2021-07-22 9:54 ` [dpdk-stable] [PATCH v2 04/11] ethdev: fix docs of drivers callbacks " Andrew Rybchenko 2021-07-22 9:54 ` [dpdk-stable] [PATCH v2 05/11] net/sfc: fix xstats by ID callbacks according to ethdev Andrew Rybchenko 2021-07-22 9:54 ` [dpdk-stable] [PATCH v2 06/11] net/sfc: fix accessing xstats by an unsorted list of IDs Andrew Rybchenko 2021-07-22 9:54 ` [dpdk-stable] [PATCH v2 07/11] net/sfc: fix MAC stats update to work for stopped device Andrew Rybchenko [not found] ` <20210723131515.2317168-1-andrew.rybchenko@oktetlabs.ru> 2021-07-23 13:15 ` [dpdk-stable] [PATCH v3 01/11] net/sfc: fix get xstats by ID callback to use MAC stats lock Andrew Rybchenko 2021-07-23 13:15 ` [dpdk-stable] [PATCH v3 02/11] net/sfc: fix reading adapter state without locking Andrew Rybchenko 2021-07-23 13:15 ` [dpdk-stable] [PATCH v3 03/11] ethdev: fix docs of functions getting xstats by IDs Andrew Rybchenko 2021-07-23 14:42 ` Ferruh Yigit 2021-07-24 12:07 ` Andrew Rybchenko 2021-07-23 13:15 ` [dpdk-stable] [PATCH v3 04/11] ethdev: fix docs of drivers callbacks " Andrew Rybchenko 2021-07-23 14:46 ` Ferruh Yigit 2021-07-23 13:15 ` [dpdk-stable] [PATCH v3 05/11] net/sfc: fix xstats by ID callbacks according to ethdev Andrew Rybchenko 2021-07-23 13:15 ` [dpdk-stable] [PATCH v3 06/11] net/sfc: fix accessing xstats by an unsorted list of IDs Andrew Rybchenko 2021-07-23 13:15 ` [dpdk-stable] [PATCH v3 07/11] net/sfc: fix MAC stats update to work for stopped device Andrew Rybchenko 2021-07-24 12:33 ` [dpdk-stable] [PATCH v4 1/2] ethdev: fix docs of functions getting xstats by IDs Andrew Rybchenko 2021-07-24 12:33 ` Andrew Rybchenko [this message] 2021-07-26 10:13 ` [dpdk-stable] [dpdk-dev] [PATCH v4 2/2] ethdev: fix docs of drivers callbacks " Olivier Matz 2021-09-28 12:04 ` Andrew Rybchenko 2021-07-26 10:13 ` [dpdk-stable] [dpdk-dev] [PATCH v4 1/2] ethdev: fix docs of functions " Olivier Matz 2021-09-28 12:01 ` Andrew Rybchenko 2021-09-28 12:05 ` [dpdk-stable] [PATCH v5 " Andrew Rybchenko 2021-09-28 12:05 ` [dpdk-stable] [PATCH v5 2/2] ethdev: fix docs of drivers callbacks " Andrew Rybchenko 2021-09-28 16:50 ` Ferruh Yigit 2021-09-28 16:53 ` Andrew Rybchenko 2021-09-29 8:44 ` Ferruh Yigit 2021-09-29 11:54 ` Andrew Rybchenko 2021-09-30 12:08 ` Ferruh Yigit 2021-09-30 14:01 ` Andrew Rybchenko 2021-09-30 15:30 ` Ferruh Yigit 2021-09-30 16:01 ` Andrew Rybchenko 2021-09-28 16:46 ` [dpdk-stable] [PATCH v5 1/2] ethdev: fix docs of functions " Ferruh Yigit 2021-09-30 14:04 ` [dpdk-stable] [PATCH v6 1/4] " Andrew Rybchenko 2021-09-30 14:04 ` [dpdk-stable] [PATCH v6 2/4] ethdev: fix docs of drivers callbacks " Andrew Rybchenko [not found] ` <20210930160156.961041-1-andrew.rybchenko@oktetlabs.ru> 2021-09-30 16:01 ` [dpdk-stable] [PATCH v7 1/5] ethdev: fix docs of functions " Andrew Rybchenko 2021-09-30 16:01 ` [dpdk-stable] [PATCH v7 2/4] ethdev: fix docs of drivers callbacks " Andrew Rybchenko 2021-09-30 16:01 ` [dpdk-stable] [PATCH v7 3/5] " Andrew Rybchenko 2021-09-30 16:05 ` [dpdk-stable] [PATCH v8 1/5] ethdev: fix docs of functions " Andrew Rybchenko 2021-09-30 16:05 ` [dpdk-stable] [PATCH v8 3/5] ethdev: fix docs of drivers callbacks " Andrew Rybchenko 2021-09-30 16:33 ` Ferruh Yigit 2021-10-01 9:07 ` Andrew Rybchenko 2021-10-01 9:07 ` [dpdk-stable] [PATCH v9 1/5] ethdev: fix docs of functions " Andrew Rybchenko 2021-10-01 9:07 ` [dpdk-stable] [PATCH v9 3/5] ethdev: fix docs of drivers callbacks " Andrew Rybchenko 2021-10-01 9:42 ` Ferruh Yigit 2021-10-01 10:22 ` Andrew Rybchenko 2021-10-06 10:37 ` Ferruh Yigit 2021-10-06 11:08 ` [dpdk-stable] [PATCH v9 1/5] ethdev: fix docs of functions " Ferruh Yigit
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=20210724123314.2970537-2-andrew.rybchenko@oktetlabs.ru \ --to=andrew.rybchenko@oktetlabs.ru \ --cc=amoreton@xilinx.com \ --cc=dev@dpdk.org \ --cc=ferruh.yigit@intel.com \ --cc=ivan.ilchenko@oktetlabs.ru \ --cc=kubax.kozak@intel.com \ --cc=stable@dpdk.org \ --cc=thomas@monjalon.net \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: link
patches for DPDK stable branches This inbox may be cloned and mirrored by anyone: git clone --mirror http://inbox.dpdk.org/stable/0 stable/git/0.git # If you have public-inbox 1.1+ installed, you may # initialize and index your mirror using the following commands: public-inbox-init -V2 stable stable/ http://inbox.dpdk.org/stable \ stable@dpdk.org public-inbox-index stable Example config snippet for mirrors. Newsgroup available over NNTP: nntp://inbox.dpdk.org/inbox.dpdk.stable AGPL code for this site: git clone https://public-inbox.org/public-inbox.git