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 7A25642A13; Fri, 28 Apr 2023 12:27:37 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 5E5AA42DB3; Fri, 28 Apr 2023 12:27:34 +0200 (CEST) Received: from agw.arknetworks.am (agw.arknetworks.am [79.141.165.80]) by mails.dpdk.org (Postfix) with ESMTP id 85EED4021D for ; Fri, 28 Apr 2023 12:27:31 +0200 (CEST) Received: from localhost.localdomain (unknown [37.252.90.108]) (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 D4F26E0EC6; Fri, 28 Apr 2023 14:27:30 +0400 (+04) From: Denis Pryazhennikov To: dev@dpdk.org Cc: Ivan Malov , Viacheslav Galaktionov , Thomas Monjalon , Ferruh Yigit , Andrew Rybchenko Subject: [RFC PATCH 1/3] ethdev: update documentation for API to set FEC Date: Fri, 28 Apr 2023 14:27:26 +0400 Message-Id: <20230428102728.51956-2-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 List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org The documentation for the rte_eth_fec_set() is updated to provide more detailed information about how FEC modes are handled. It also includes a description of the case when only the AUTO bit is set. Signed-off-by: Denis Pryazhennikov Acked-by: Ivan Malov Acked-by: Viacheslav Galaktionov --- lib/ethdev/rte_ethdev.h | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/lib/ethdev/rte_ethdev.h b/lib/ethdev/rte_ethdev.h index 99fe9e238b20..0f10ac944061 100644 --- a/lib/ethdev/rte_ethdev.h +++ b/lib/ethdev/rte_ethdev.h @@ -4227,13 +4227,19 @@ int rte_eth_fec_get(uint16_t port_id, uint32_t *fec_capa); * @param port_id * The port identifier of the Ethernet device. * @param fec_capa - * A bitmask of allowed FEC modes. If AUTO bit is set, other - * bits specify FEC modes which may be negotiated. If AUTO - * bit is clear, specify FEC modes to be used (only one valid - * mode per speed may be set). + * A bitmask of allowed FEC modes. + * If only the AUTO bit is set, the decision on which FEC + * mode to use will be made by HW/FW or driver. + * If the AUTO bit is set, other bits specify FEC modes + * which may be negotiated. It means that only specified + * FEC modes can be set. + * If AUTO bit is clear, specify FEC mode to be used + * (only one valid mode per speed may be set). + * NOFEC will be used if specified FEC modes are not + * supported. * @return * - (0) if successful. - * - (-EINVAL) if the FEC mode is not valid. + * - (-EINVAL) if *fec_capa* is not valid. * - (-ENOTSUP) if underlying hardware OR driver doesn't support. * - (-EIO) if device is removed. * - (-ENODEV) if *port_id* invalid. -- 2.37.0 (Apple Git-136)