| Message ID | 20230508114707.89629-1-denis.pryazhennikov@arknetworks.am (mailing list archive) |
|---|---|
| Headers |
Return-Path: <dev-bounces@dpdk.org> 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 239D042A94; Mon, 8 May 2023 13:47:13 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id ADD9F410ED; Mon, 8 May 2023 13:47:12 +0200 (CEST) Received: from agw.arknetworks.am (agw.arknetworks.am [79.141.165.80]) by mails.dpdk.org (Postfix) with ESMTP id 2397540685 for <dev@dpdk.org>; Mon, 8 May 2023 13:47:11 +0200 (CEST) Received: from localhost.localdomain (unknown [37.252.88.48]) (using TLSv1.3 with cipher TLS_CHACHA20_POLY1305_SHA256 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA512) (No client certificate requested) by agw.arknetworks.am (Postfix) with ESMTPSA id 394ECE1218; Mon, 8 May 2023 15:47:10 +0400 (+04) From: Denis Pryazhennikov <denis.pryazhennikov@arknetworks.am> To: dev@dpdk.org Cc: Ivan Malov <ivan.malov@arknetworks.am>, Viacheslav Galaktionov <viacheslav.galaktionov@arknetworks.am>, Thomas Monjalon <thomas@monjalon.net>, Ferruh Yigit <ferruh.yigit@amd.com>, Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru> Subject: [RFC PATCH v2 0/3] improve FEC API usage Date: Mon, 8 May 2023 15:47:04 +0400 Message-Id: <20230508114707.89629-1-denis.pryazhennikov@arknetworks.am> X-Mailer: git-send-email 2.37.0 (Apple Git-136) In-Reply-To: <20230428102728.51956-1-denis.pryazhennikov@arknetworks.am> References: <20230428102728.51956-1-denis.pryazhennikov@arknetworks.am> 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 <dev.dpdk.org> List-Unsubscribe: <https://mails.dpdk.org/options/dev>, <mailto:dev-request@dpdk.org?subject=unsubscribe> List-Archive: <http://mails.dpdk.org/archives/dev/> List-Post: <mailto:dev@dpdk.org> List-Help: <mailto:dev-request@dpdk.org?subject=help> List-Subscribe: <https://mails.dpdk.org/listinfo/dev>, <mailto:dev-request@dpdk.org?subject=subscribe> Errors-To: dev-bounces@dpdk.org |
| Series | improve FEC API usage | |
Message
Denis Pryazhennikov
May 8, 2023, 11:47 a.m. UTC
The documentation for the FEC API is currently incomplete and contains inaccuracies in its descriptions of function parameters. Specifically, the semantics of the fec_capa parameter in rte_eth_fec_set() is not well-defined. It does not provide information on what should be done if only AUTO bit is set or one of the specified FEC modes is not supported. Additionally, the fec_capa parameter in rte_eth_fec_get() implies that more than one FEC mode can be obtained, but it is wrong. Furthermore, the behaviour is undefined in rte_eth_fec_set() when the fec_capa parameter is zero. To address these issues, a patch series has been created that updates the FEC API documentation, renames one of the parameters to improve its clarity and adds a check for zero fec_capability. v2: * Update documentation for rte_eth_fec_set() to fix review comments. * Don't rename the fec_capa parameter of rte_eth_fec_get() but add a proper description instead. Denis Pryazhennikov (3): ethdev: update documentation for API to set FEC ethdev: check that at least one FEC mode is specified ethdev: update documentation for API to get FEC lib/ethdev/rte_ethdev.c | 5 +++++ lib/ethdev/rte_ethdev.h | 16 ++++++++-------- 2 files changed, 13 insertions(+), 8 deletions(-)
Comments
On 5/8/2023 12:47 PM, Denis Pryazhennikov wrote: > The documentation for the FEC API is currently incomplete and contains > inaccuracies in its descriptions of function parameters. > Specifically, the semantics of the fec_capa parameter in rte_eth_fec_set() > is not well-defined. It does not provide information on what should > be done if only AUTO bit is set or one of the specified FEC modes is > not supported. Additionally, the fec_capa parameter in rte_eth_fec_get() > implies that more than one FEC mode can be obtained, but it is > wrong. Furthermore, the behaviour is undefined in > rte_eth_fec_set() when the fec_capa parameter is zero. > > To address these issues, a patch series has been created that updates > the FEC API documentation, renames one of the parameters to improve > its clarity and adds a check for zero fec_capability. > > v2: > * Update documentation for rte_eth_fec_set() to fix review comments. > * Don't rename the fec_capa parameter of rte_eth_fec_get() but > add a proper description instead. > > Denis Pryazhennikov (3): > ethdev: update documentation for API to set FEC > ethdev: check that at least one FEC mode is specified > ethdev: update documentation for API to get FEC > For series, Acked-by: Ferruh Yigit <ferruh.yigit@amd.com> +cc Author and reviewer of original patch, if there is no objection I can proceed with the set. @Denis, can you please provide Fixes tags too? If you prefer you can send a new version with ack and fixes tags.
On 5/12/2023 12:57 PM, Ferruh Yigit wrote: > On 5/8/2023 12:47 PM, Denis Pryazhennikov wrote: >> The documentation for the FEC API is currently incomplete and contains >> inaccuracies in its descriptions of function parameters. >> Specifically, the semantics of the fec_capa parameter in rte_eth_fec_set() >> is not well-defined. It does not provide information on what should >> be done if only AUTO bit is set or one of the specified FEC modes is >> not supported. Additionally, the fec_capa parameter in rte_eth_fec_get() >> implies that more than one FEC mode can be obtained, but it is >> wrong. Furthermore, the behaviour is undefined in >> rte_eth_fec_set() when the fec_capa parameter is zero. >> >> To address these issues, a patch series has been created that updates >> the FEC API documentation, renames one of the parameters to improve >> its clarity and adds a check for zero fec_capability. >> >> v2: >> * Update documentation for rte_eth_fec_set() to fix review comments. >> * Don't rename the fec_capa parameter of rte_eth_fec_get() but >> add a proper description instead. >> >> Denis Pryazhennikov (3): >> ethdev: update documentation for API to set FEC >> ethdev: check that at least one FEC mode is specified >> ethdev: update documentation for API to get FEC >> > > For series, > Acked-by: Ferruh Yigit <ferruh.yigit@amd.com> > > > +cc Author and reviewer of original patch, if there is no objection I > can proceed with the set. > > > @Denis, can you please provide Fixes tags too? If you prefer you can > send a new version with ack and fixes tags. > @Denis, just a reminder that this patch is waiting for a new version.
On 5/12/2023 12:57 PM, Ferruh Yigit wrote: > On 5/8/2023 12:47 PM, Denis Pryazhennikov wrote: >> The documentation for the FEC API is currently incomplete and contains >> inaccuracies in its descriptions of function parameters. >> Specifically, the semantics of the fec_capa parameter in rte_eth_fec_set() >> is not well-defined. It does not provide information on what should >> be done if only AUTO bit is set or one of the specified FEC modes is >> not supported. Additionally, the fec_capa parameter in rte_eth_fec_get() >> implies that more than one FEC mode can be obtained, but it is >> wrong. Furthermore, the behaviour is undefined in >> rte_eth_fec_set() when the fec_capa parameter is zero. >> >> To address these issues, a patch series has been created that updates >> the FEC API documentation, renames one of the parameters to improve >> its clarity and adds a check for zero fec_capability. >> >> v2: >> * Update documentation for rte_eth_fec_set() to fix review comments. >> * Don't rename the fec_capa parameter of rte_eth_fec_get() but >> add a proper description instead. >> >> Denis Pryazhennikov (3): >> ethdev: update documentation for API to set FEC >> ethdev: check that at least one FEC mode is specified >> ethdev: update documentation for API to get FEC >> > > For series, > Acked-by: Ferruh Yigit <ferruh.yigit@amd.com> > > Series applied to dpdk-next-net/main, thanks. > +cc Author and reviewer of original patch, if there is no objection I > can proceed with the set. > > > @Denis, can you please provide Fixes tags too? If you prefer you can > send a new version with ack and fixes tags. > Fixes: b7ccfb09da95 ("ethdev: introduce FEC API") Cc: stable@dpdk.org