[V4,1/3] ethdev: introduce FEC API
Checks
Commit Message
This patch adds Forward error correction(FEC) support for ethdev.
Introduce APIs which support query and config FEC information in
hardware.
Signed-off-by: Min Hu (Connor) <humin29@huawei.com>
Reviewed-by: Wei Hu (Xavier) <xavier.huwei@huawei.com>
Reviewed-by: Chengwen Feng <fengchengwen@huawei.com>
Reviewed-by: Chengchang Tang <tangchengchang@huawei.com>
---
v2->v3:
add function return value "-ENOTSUP" for API
---
lib/librte_ethdev/rte_ethdev.c | 50 +++++++++++++++++++++
lib/librte_ethdev/rte_ethdev.h | 75 +++++++++++++++++++++++++++++++
lib/librte_ethdev/rte_ethdev_core.h | 77 ++++++++++++++++++++++++++++++++
lib/librte_ethdev/rte_ethdev_version.map | 5 +++
4 files changed, 207 insertions(+)
Comments
On Thu, Sep 10, 2020 at 12:26 AM Min Hu (Connor) <humin29@huawei.com> wrote:
> This patch adds Forward error correction(FEC) support for ethdev.
> Introduce APIs which support query and config FEC information in
> hardware.
>
> Signed-off-by: Min Hu (Connor) <humin29@huawei.com>
> Reviewed-by: Wei Hu (Xavier) <xavier.huwei@huawei.com>
> Reviewed-by: Chengwen Feng <fengchengwen@huawei.com>
> Reviewed-by: Chengchang Tang <tangchengchang@huawei.com>
>
Reviewed-by: Ajit Khaparde <ajit.khaparde@broadcom.com>
>
> ---
> v2->v3:
> add function return value "-ENOTSUP" for API
> ---
> lib/librte_ethdev/rte_ethdev.c | 50 +++++++++++++++++++++
> lib/librte_ethdev/rte_ethdev.h | 75
> +++++++++++++++++++++++++++++++
> lib/librte_ethdev/rte_ethdev_core.h | 77
> ++++++++++++++++++++++++++++++++
> lib/librte_ethdev/rte_ethdev_version.map | 5 +++
> 4 files changed, 207 insertions(+)
>
> diff --git a/lib/librte_ethdev/rte_ethdev.c
> b/lib/librte_ethdev/rte_ethdev.c
> index 7858ad5..b7ac791 100644
> --- a/lib/librte_ethdev/rte_ethdev.c
> +++ b/lib/librte_ethdev/rte_ethdev.c
> @@ -3642,6 +3642,56 @@ rte_eth_led_off(uint16_t port_id)
> return eth_err(port_id, (*dev->dev_ops->dev_led_off)(dev));
> }
>
> +int
> +rte_eth_fec_get_capability(uint16_t port_id, uint8_t *fec_cap)
> +{
> + struct rte_eth_dev *dev;
> +
> + RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
> + dev = &rte_eth_devices[port_id];
> + RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->fec_get_capability,
> -ENOTSUP);
> + return eth_err(port_id, (*dev->dev_ops->fec_get_capability)(dev,
> + fec_cap));
> +}
> +
> +int
> +rte_eth_fec_get(uint16_t port_id, enum rte_fec_mode *mode)
> +{
> + struct rte_eth_dev *dev;
> +
> + RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
> + dev = &rte_eth_devices[port_id];
> + RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->fec_get, -ENOTSUP);
> + return eth_err(port_id, (*dev->dev_ops->fec_get)(dev, mode));
> +}
> +
> +int
> +rte_eth_fec_set(uint16_t port_id, enum rte_fec_mode mode)
> +{
> + struct rte_eth_dev *dev;
> + uint8_t fec_mode_mask;
> + int ret;
> +
> + RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
> +
> + ret = rte_eth_fec_get_capability(port_id, &fec_mode_mask);
> + if (ret)
> + return ret;
> +
> + /*
> + * Check whether the configured mode is within the FEC capability.
> + * If not, the configured mode will not be supported.
> + */
> + if (!(fec_mode_mask & (1U << (uint8_t)mode))) {
> + RTE_ETHDEV_LOG(ERR, "unsupported fec mode=%d\n", mode);
> + return -EINVAL;
> + }
> +
> + dev = &rte_eth_devices[port_id];
> + RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->fec_set, -ENOTSUP);
> + return eth_err(port_id, (*dev->dev_ops->fec_set)(dev, mode));
> +}
> +
> /*
> * Returns index into MAC address array of addr. Use 00:00:00:00:00:00 to
> find
> * an empty spot.
> diff --git a/lib/librte_ethdev/rte_ethdev.h
> b/lib/librte_ethdev/rte_ethdev.h
> index 70295d7..c353480 100644
> --- a/lib/librte_ethdev/rte_ethdev.h
> +++ b/lib/librte_ethdev/rte_ethdev.h
> @@ -1511,6 +1511,17 @@ struct rte_eth_dcb_info {
> struct rte_eth_dcb_tc_queue_mapping tc_queue;
> };
>
> +/**
> + * This enum indicates the possible (forward error correction)FEC modes
> + * of an ethdev port.
> + */
> +enum rte_fec_mode {
> + ETH_FEC_NOFEC = 0, /**< FEC is off */
> + ETH_FEC_BASER, /**< FEC using common algorithm */
> + ETH_FEC_RS, /**< FEC using RS algorithm */
> + ETH_FEC_AUTO /**< FEC autonegotiation modes */
> +};
> +
> #define RTE_ETH_ALL RTE_MAX_ETHPORTS
>
> /* Macros to check for valid port */
> @@ -3328,6 +3339,70 @@ int rte_eth_led_on(uint16_t port_id);
> int rte_eth_led_off(uint16_t port_id);
>
> /**
> + * @warning
> + * @b EXPERIMENTAL: this API may change, or be removed, without prior
> notice
> + *
> + * Get Forward Error Correction(FEC) capability.
> + *
> + * @param port_id
> + * The port identifier of the Ethernet device.
> + * @param fec_cap
> + * returns the FEC capability from the device, as follows:
> + * bit0: nofec
> + * bit1: baser
> + * bit2: rs
> + * bit3: auto
> + * @return
> + * - (0) if successful.
> + * - (-ENOTSUP) if underlying hardware OR driver doesn't support.
> + * that operation.
> + * - (-EIO) if device is removed.
> + * - (-ENODEV) if *port_id* invalid.
> + */
> +__rte_experimental
> +int rte_eth_fec_get_capability(uint16_t port_id, uint8_t *fec_cap);
> +
> +/**
> + * @warning
> + * @b EXPERIMENTAL: this API may change, or be removed, without prior
> notice
> + *
> + * Get current Forward Error Correction(FEC) mode.
> + *
> + * @param port_id
> + * The port identifier of the Ethernet device.
> + * @param mode
> + * returns the FEC mode from the device.
> + * @return
> + * - (0) if successful.
> + * - (-ENOTSUP) if underlying hardware OR driver doesn't support.
> + * that operation.
> + * - (-EIO) if device is removed.
> + * - (-ENODEV) if *port_id* invalid.
> + */
> +__rte_experimental
> +int rte_eth_fec_get(uint16_t port_id, enum rte_fec_mode *mode);
> +
> +/**
> + * @warning
> + * @b EXPERIMENTAL: this API may change, or be removed, without prior
> notice
> + *
> + * Set Forward Error Correction(FEC) mode.
> + *
> + * @param port_id
> + * The port identifier of the Ethernet device.
> + * @param mode
> + * the FEC mode.
> + * @return
> + * - (0) if successful.
> + * - (-EINVAL) if the FEC mode is not valid.
> + * - (-ENOTSUP) if underlying hardware OR driver doesn't support.
> + * - (-EIO) if device is removed.
> + * - (-ENODEV) if *port_id* invalid.
> + */
> +__rte_experimental
> +int rte_eth_fec_set(uint16_t port_id, enum rte_fec_mode mode);
> +
> +/**
> * Get current status of the Ethernet link flow control for Ethernet
> device
> *
> * @param port_id
> diff --git a/lib/librte_ethdev/rte_ethdev_core.h
> b/lib/librte_ethdev/rte_ethdev_core.h
> index 32407dd..df9e18a 100644
> --- a/lib/librte_ethdev/rte_ethdev_core.h
> +++ b/lib/librte_ethdev/rte_ethdev_core.h
> @@ -604,6 +604,76 @@ typedef int (*eth_tx_hairpin_queue_setup_t)
> const struct rte_eth_hairpin_conf *hairpin_conf);
>
> /**
> + * @internal
> + * Get Forward Error Correction(FEC) capability.
> + *
> + * @param dev
> + * ethdev handle of port.
> + * @param fec_cap
> + * returns the FEC capability from the device.
> + *
> + * @return
> + * Negative errno value on error, 0 on success.
> + *
> + * @retval 0
> + * Success, get FEC success.
> + * @retval -ENOTSUP
> + * operation is not supported.
> + * @retval -EIO
> + * device is removed.
> + * @retval -ENODEV
> + * Device is gone.
> + */
> +typedef int (*eth_fec_get_capability_t)(struct rte_eth_dev *dev,
> + uint8_t *fec_cap);
> +
> +/**
> + * @internal
> + * Get Forward Error Correction(FEC) mode.
> + *
> + * @param dev
> + * ethdev handle of port.
> + * @param mode
> + * returns the FEC mode from the device.
> + *
> + * @return
> + * Negative errno value on error, 0 on success.
> + *
> + * @retval 0
> + * Success, get FEC success.
> + * @retval -ENOTSUP
> + * operation is not supported.
> + * @retval -EIO
> + * device is removed.
> + * @retval -ENODEV
> + * Device is gone.
> + */
> +typedef int (*eth_fec_get_t)(struct rte_eth_dev *dev, enum rte_fec_mode
> *mode);
> +
> +/**
> + * @internal
> + * Set Forward Error Correction(FEC) mode.
> + *
> + * @param dev
> + * ethdev handle of port.
> + * @param mode
> + * the FEC mode.
> + *
> + * @return
> + * Negative errno value on error, 0 on success.
> + *
> + * @retval 0
> + * Success, set FEC success.
> + * @retval -ENOTSUP
> + * operation is not supported.
> + * @retval -EIO
> + * device is removed.
> + * @retval -ENODEV
> + * Device is gone.
> + */
> +typedef int (*eth_fec_set_t)(struct rte_eth_dev *dev, enum rte_fec_mode
> mode);
> +
> +/**
> * @internal A structure containing the functions exported by an Ethernet
> driver.
> */
> struct eth_dev_ops {
> @@ -752,6 +822,13 @@ struct eth_dev_ops {
> /**< Set up device RX hairpin queue. */
> eth_tx_hairpin_queue_setup_t tx_hairpin_queue_setup;
> /**< Set up device TX hairpin queue. */
> +
> + eth_fec_get_capability_t fec_get_capability;
> + /**< Get Forward Error Correction(FEC) capability; */
> + eth_fec_get_t fec_get;
> + /**< Get Forward Error Correction(FEC) mode; */
> + eth_fec_set_t fec_set;
> + /**< Set Forward Error Correction(FEC) mode; */
> };
>
> /**
> diff --git a/lib/librte_ethdev/rte_ethdev_version.map
> b/lib/librte_ethdev/rte_ethdev_version.map
> index 1212a17..33cf5e4 100644
> --- a/lib/librte_ethdev/rte_ethdev_version.map
> +++ b/lib/librte_ethdev/rte_ethdev_version.map
> @@ -241,6 +241,11 @@ EXPERIMENTAL {
> __rte_ethdev_trace_rx_burst;
> __rte_ethdev_trace_tx_burst;
> rte_flow_get_aged_flows;
> +
> + # added in 20.11
> + rte_eth_fec_get_capability;
> + rte_eth_fec_get;
> + rte_eth_fec_set;
> };
>
> INTERNAL {
> --
> 2.7.4
>
>
Seems ok in general, few nits below.
> This patch adds Forward error correction(FEC) support for ethdev.
> Introduce APIs which support query and config FEC information in
> hardware.
>
> Signed-off-by: Min Hu (Connor) <humin29@huawei.com>
> Reviewed-by: Wei Hu (Xavier) <xavier.huwei@huawei.com>
> Reviewed-by: Chengwen Feng <fengchengwen@huawei.com>
> Reviewed-by: Chengchang Tang <tangchengchang@huawei.com>
>
> ---
> v2->v3:
> add function return value "-ENOTSUP" for API
> ---
> lib/librte_ethdev/rte_ethdev.c | 50 +++++++++++++++++++++
> lib/librte_ethdev/rte_ethdev.h | 75 +++++++++++++++++++++++++++++++
> lib/librte_ethdev/rte_ethdev_core.h | 77 ++++++++++++++++++++++++++++++++
> lib/librte_ethdev/rte_ethdev_version.map | 5 +++
This is a wew feature, probably worth to update release notes.
> 4 files changed, 207 insertions(+)
>
> diff --git a/lib/librte_ethdev/rte_ethdev.c b/lib/librte_ethdev/rte_ethdev.c
> index 7858ad5..b7ac791 100644
> --- a/lib/librte_ethdev/rte_ethdev.c
> +++ b/lib/librte_ethdev/rte_ethdev.c
> @@ -3642,6 +3642,56 @@ rte_eth_led_off(uint16_t port_id)
> return eth_err(port_id, (*dev->dev_ops->dev_led_off)(dev));
> }
>
> +int
> +rte_eth_fec_get_capability(uint16_t port_id, uint8_t *fec_cap)
> +{
> + struct rte_eth_dev *dev;
> +
> + RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
> + dev = &rte_eth_devices[port_id];
> + RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->fec_get_capability, -ENOTSUP);
> + return eth_err(port_id, (*dev->dev_ops->fec_get_capability)(dev,
> + fec_cap));
> +}
> +
> +int
> +rte_eth_fec_get(uint16_t port_id, enum rte_fec_mode *mode)
> +{
> + struct rte_eth_dev *dev;
> +
> + RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
> + dev = &rte_eth_devices[port_id];
> + RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->fec_get, -ENOTSUP);
> + return eth_err(port_id, (*dev->dev_ops->fec_get)(dev, mode));
> +}
> +
> +int
> +rte_eth_fec_set(uint16_t port_id, enum rte_fec_mode mode)
> +{
> + struct rte_eth_dev *dev;
> + uint8_t fec_mode_mask;
> + int ret;
> +
> + RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
> +
> + ret = rte_eth_fec_get_capability(port_id, &fec_mode_mask);
> + if (ret)
> + return ret;
> +
> + /*
> + * Check whether the configured mode is within the FEC capability.
> + * If not, the configured mode will not be supported.
> + */
> + if (!(fec_mode_mask & (1U << (uint8_t)mode))) {
> + RTE_ETHDEV_LOG(ERR, "unsupported fec mode=%d\n", mode);
> + return -EINVAL;
> + }
> +
> + dev = &rte_eth_devices[port_id];
> + RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->fec_set, -ENOTSUP);
> + return eth_err(port_id, (*dev->dev_ops->fec_set)(dev, mode));
> +}
> +
> /*
> * Returns index into MAC address array of addr. Use 00:00:00:00:00:00 to find
> * an empty spot.
> diff --git a/lib/librte_ethdev/rte_ethdev.h b/lib/librte_ethdev/rte_ethdev.h
> index 70295d7..c353480 100644
> --- a/lib/librte_ethdev/rte_ethdev.h
> +++ b/lib/librte_ethdev/rte_ethdev.h
> @@ -1511,6 +1511,17 @@ struct rte_eth_dcb_info {
> struct rte_eth_dcb_tc_queue_mapping tc_queue;
> };
>
> +/**
> + * This enum indicates the possible (forward error correction)FEC modes
> + * of an ethdev port.
> + */
> +enum rte_fec_mode {
> + ETH_FEC_NOFEC = 0, /**< FEC is off */
As it is a public enum, RTE_ prefix is needed for each value.
> + ETH_FEC_BASER, /**< FEC using common algorithm */
> + ETH_FEC_RS, /**< FEC using RS algorithm */
> + ETH_FEC_AUTO /**< FEC autonegotiation modes */
> +};
> +
> #define RTE_ETH_ALL RTE_MAX_ETHPORTS
>
> /* Macros to check for valid port */
> @@ -3328,6 +3339,70 @@ int rte_eth_led_on(uint16_t port_id);
> int rte_eth_led_off(uint16_t port_id);
>
> /**
> + * @warning
> + * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
> + *
> + * Get Forward Error Correction(FEC) capability.
> + *
> + * @param port_id
> + * The port identifier of the Ethernet device.
> + * @param fec_cap
> + * returns the FEC capability from the device, as follows:
> + * bit0: nofec
> + * bit1: baser
> + * bit2: rs
> + * bit3: auto
Instead of putting bit description into the comment, I think it is better to define
them explicitly. Something like:
#define RTE_ETH_FEC_CAPA_XXX (1 << RTE_ETH_FEC_XXX)
> + * @return
> + * - (0) if successful.
> + * - (-ENOTSUP) if underlying hardware OR driver doesn't support.
> + * that operation.
> + * - (-EIO) if device is removed.
> + * - (-ENODEV) if *port_id* invalid.
> + */
> +__rte_experimental
> +int rte_eth_fec_get_capability(uint16_t port_id, uint8_t *fec_cap);
Probably make sense to have uint32_t bit value for fec_cap (for possible future expansion)?
> +
> +/**
> + * @warning
> + * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
> + *
> + * Get current Forward Error Correction(FEC) mode.
> + *
> + * @param port_id
> + * The port identifier of the Ethernet device.
> + * @param mode
> + * returns the FEC mode from the device.
> + * @return
> + * - (0) if successful.
> + * - (-ENOTSUP) if underlying hardware OR driver doesn't support.
> + * that operation.
> + * - (-EIO) if device is removed.
> + * - (-ENODEV) if *port_id* invalid.
> + */
> +__rte_experimental
> +int rte_eth_fec_get(uint16_t port_id, enum rte_fec_mode *mode);
> +
> +/**
> + * @warning
> + * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
> + *
> + * Set Forward Error Correction(FEC) mode.
> + *
> + * @param port_id
> + * The port identifier of the Ethernet device.
> + * @param mode
> + * the FEC mode.
> + * @return
> + * - (0) if successful.
> + * - (-EINVAL) if the FEC mode is not valid.
> + * - (-ENOTSUP) if underlying hardware OR driver doesn't support.
> + * - (-EIO) if device is removed.
> + * - (-ENODEV) if *port_id* invalid.
> + */
> +__rte_experimental
> +int rte_eth_fec_set(uint16_t port_id, enum rte_fec_mode mode);
> +
> +/**
> * Get current status of the Ethernet link flow control for Ethernet device
> *
> * @param port_id
> diff --git a/lib/librte_ethdev/rte_ethdev_core.h b/lib/librte_ethdev/rte_ethdev_core.h
> index 32407dd..df9e18a 100644
> --- a/lib/librte_ethdev/rte_ethdev_core.h
> +++ b/lib/librte_ethdev/rte_ethdev_core.h
> @@ -604,6 +604,76 @@ typedef int (*eth_tx_hairpin_queue_setup_t)
> const struct rte_eth_hairpin_conf *hairpin_conf);
>
> /**
> + * @internal
> + * Get Forward Error Correction(FEC) capability.
> + *
> + * @param dev
> + * ethdev handle of port.
> + * @param fec_cap
> + * returns the FEC capability from the device.
> + *
> + * @return
> + * Negative errno value on error, 0 on success.
> + *
> + * @retval 0
> + * Success, get FEC success.
> + * @retval -ENOTSUP
> + * operation is not supported.
> + * @retval -EIO
> + * device is removed.
> + * @retval -ENODEV
> + * Device is gone.
> + */
> +typedef int (*eth_fec_get_capability_t)(struct rte_eth_dev *dev,
> + uint8_t *fec_cap);
> +
> +/**
> + * @internal
> + * Get Forward Error Correction(FEC) mode.
> + *
> + * @param dev
> + * ethdev handle of port.
> + * @param mode
> + * returns the FEC mode from the device.
> + *
> + * @return
> + * Negative errno value on error, 0 on success.
> + *
> + * @retval 0
> + * Success, get FEC success.
> + * @retval -ENOTSUP
> + * operation is not supported.
> + * @retval -EIO
> + * device is removed.
> + * @retval -ENODEV
> + * Device is gone.
> + */
> +typedef int (*eth_fec_get_t)(struct rte_eth_dev *dev, enum rte_fec_mode *mode);
> +
> +/**
> + * @internal
> + * Set Forward Error Correction(FEC) mode.
> + *
> + * @param dev
> + * ethdev handle of port.
> + * @param mode
> + * the FEC mode.
> + *
> + * @return
> + * Negative errno value on error, 0 on success.
> + *
> + * @retval 0
> + * Success, set FEC success.
> + * @retval -ENOTSUP
> + * operation is not supported.
> + * @retval -EIO
> + * device is removed.
> + * @retval -ENODEV
> + * Device is gone.
> + */
> +typedef int (*eth_fec_set_t)(struct rte_eth_dev *dev, enum rte_fec_mode mode);
> +
> +/**
> * @internal A structure containing the functions exported by an Ethernet driver.
> */
> struct eth_dev_ops {
> @@ -752,6 +822,13 @@ struct eth_dev_ops {
> /**< Set up device RX hairpin queue. */
> eth_tx_hairpin_queue_setup_t tx_hairpin_queue_setup;
> /**< Set up device TX hairpin queue. */
> +
> + eth_fec_get_capability_t fec_get_capability;
> + /**< Get Forward Error Correction(FEC) capability; */
> + eth_fec_get_t fec_get;
> + /**< Get Forward Error Correction(FEC) mode; */
> + eth_fec_set_t fec_set;
> + /**< Set Forward Error Correction(FEC) mode; */
> };
>
> /**
> diff --git a/lib/librte_ethdev/rte_ethdev_version.map b/lib/librte_ethdev/rte_ethdev_version.map
> index 1212a17..33cf5e4 100644
> --- a/lib/librte_ethdev/rte_ethdev_version.map
> +++ b/lib/librte_ethdev/rte_ethdev_version.map
> @@ -241,6 +241,11 @@ EXPERIMENTAL {
> __rte_ethdev_trace_rx_burst;
> __rte_ethdev_trace_tx_burst;
> rte_flow_get_aged_flows;
> +
> + # added in 20.11
> + rte_eth_fec_get_capability;
> + rte_eth_fec_get;
> + rte_eth_fec_set;
> };
>
> INTERNAL {
> --
> 2.7.4
@@ -3642,6 +3642,56 @@ rte_eth_led_off(uint16_t port_id)
return eth_err(port_id, (*dev->dev_ops->dev_led_off)(dev));
}
+int
+rte_eth_fec_get_capability(uint16_t port_id, uint8_t *fec_cap)
+{
+ struct rte_eth_dev *dev;
+
+ RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
+ dev = &rte_eth_devices[port_id];
+ RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->fec_get_capability, -ENOTSUP);
+ return eth_err(port_id, (*dev->dev_ops->fec_get_capability)(dev,
+ fec_cap));
+}
+
+int
+rte_eth_fec_get(uint16_t port_id, enum rte_fec_mode *mode)
+{
+ struct rte_eth_dev *dev;
+
+ RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
+ dev = &rte_eth_devices[port_id];
+ RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->fec_get, -ENOTSUP);
+ return eth_err(port_id, (*dev->dev_ops->fec_get)(dev, mode));
+}
+
+int
+rte_eth_fec_set(uint16_t port_id, enum rte_fec_mode mode)
+{
+ struct rte_eth_dev *dev;
+ uint8_t fec_mode_mask;
+ int ret;
+
+ RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
+
+ ret = rte_eth_fec_get_capability(port_id, &fec_mode_mask);
+ if (ret)
+ return ret;
+
+ /*
+ * Check whether the configured mode is within the FEC capability.
+ * If not, the configured mode will not be supported.
+ */
+ if (!(fec_mode_mask & (1U << (uint8_t)mode))) {
+ RTE_ETHDEV_LOG(ERR, "unsupported fec mode=%d\n", mode);
+ return -EINVAL;
+ }
+
+ dev = &rte_eth_devices[port_id];
+ RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->fec_set, -ENOTSUP);
+ return eth_err(port_id, (*dev->dev_ops->fec_set)(dev, mode));
+}
+
/*
* Returns index into MAC address array of addr. Use 00:00:00:00:00:00 to find
* an empty spot.
@@ -1511,6 +1511,17 @@ struct rte_eth_dcb_info {
struct rte_eth_dcb_tc_queue_mapping tc_queue;
};
+/**
+ * This enum indicates the possible (forward error correction)FEC modes
+ * of an ethdev port.
+ */
+enum rte_fec_mode {
+ ETH_FEC_NOFEC = 0, /**< FEC is off */
+ ETH_FEC_BASER, /**< FEC using common algorithm */
+ ETH_FEC_RS, /**< FEC using RS algorithm */
+ ETH_FEC_AUTO /**< FEC autonegotiation modes */
+};
+
#define RTE_ETH_ALL RTE_MAX_ETHPORTS
/* Macros to check for valid port */
@@ -3328,6 +3339,70 @@ int rte_eth_led_on(uint16_t port_id);
int rte_eth_led_off(uint16_t port_id);
/**
+ * @warning
+ * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
+ *
+ * Get Forward Error Correction(FEC) capability.
+ *
+ * @param port_id
+ * The port identifier of the Ethernet device.
+ * @param fec_cap
+ * returns the FEC capability from the device, as follows:
+ * bit0: nofec
+ * bit1: baser
+ * bit2: rs
+ * bit3: auto
+ * @return
+ * - (0) if successful.
+ * - (-ENOTSUP) if underlying hardware OR driver doesn't support.
+ * that operation.
+ * - (-EIO) if device is removed.
+ * - (-ENODEV) if *port_id* invalid.
+ */
+__rte_experimental
+int rte_eth_fec_get_capability(uint16_t port_id, uint8_t *fec_cap);
+
+/**
+ * @warning
+ * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
+ *
+ * Get current Forward Error Correction(FEC) mode.
+ *
+ * @param port_id
+ * The port identifier of the Ethernet device.
+ * @param mode
+ * returns the FEC mode from the device.
+ * @return
+ * - (0) if successful.
+ * - (-ENOTSUP) if underlying hardware OR driver doesn't support.
+ * that operation.
+ * - (-EIO) if device is removed.
+ * - (-ENODEV) if *port_id* invalid.
+ */
+__rte_experimental
+int rte_eth_fec_get(uint16_t port_id, enum rte_fec_mode *mode);
+
+/**
+ * @warning
+ * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
+ *
+ * Set Forward Error Correction(FEC) mode.
+ *
+ * @param port_id
+ * The port identifier of the Ethernet device.
+ * @param mode
+ * the FEC mode.
+ * @return
+ * - (0) if successful.
+ * - (-EINVAL) if the FEC mode is not valid.
+ * - (-ENOTSUP) if underlying hardware OR driver doesn't support.
+ * - (-EIO) if device is removed.
+ * - (-ENODEV) if *port_id* invalid.
+ */
+__rte_experimental
+int rte_eth_fec_set(uint16_t port_id, enum rte_fec_mode mode);
+
+/**
* Get current status of the Ethernet link flow control for Ethernet device
*
* @param port_id
@@ -604,6 +604,76 @@ typedef int (*eth_tx_hairpin_queue_setup_t)
const struct rte_eth_hairpin_conf *hairpin_conf);
/**
+ * @internal
+ * Get Forward Error Correction(FEC) capability.
+ *
+ * @param dev
+ * ethdev handle of port.
+ * @param fec_cap
+ * returns the FEC capability from the device.
+ *
+ * @return
+ * Negative errno value on error, 0 on success.
+ *
+ * @retval 0
+ * Success, get FEC success.
+ * @retval -ENOTSUP
+ * operation is not supported.
+ * @retval -EIO
+ * device is removed.
+ * @retval -ENODEV
+ * Device is gone.
+ */
+typedef int (*eth_fec_get_capability_t)(struct rte_eth_dev *dev,
+ uint8_t *fec_cap);
+
+/**
+ * @internal
+ * Get Forward Error Correction(FEC) mode.
+ *
+ * @param dev
+ * ethdev handle of port.
+ * @param mode
+ * returns the FEC mode from the device.
+ *
+ * @return
+ * Negative errno value on error, 0 on success.
+ *
+ * @retval 0
+ * Success, get FEC success.
+ * @retval -ENOTSUP
+ * operation is not supported.
+ * @retval -EIO
+ * device is removed.
+ * @retval -ENODEV
+ * Device is gone.
+ */
+typedef int (*eth_fec_get_t)(struct rte_eth_dev *dev, enum rte_fec_mode *mode);
+
+/**
+ * @internal
+ * Set Forward Error Correction(FEC) mode.
+ *
+ * @param dev
+ * ethdev handle of port.
+ * @param mode
+ * the FEC mode.
+ *
+ * @return
+ * Negative errno value on error, 0 on success.
+ *
+ * @retval 0
+ * Success, set FEC success.
+ * @retval -ENOTSUP
+ * operation is not supported.
+ * @retval -EIO
+ * device is removed.
+ * @retval -ENODEV
+ * Device is gone.
+ */
+typedef int (*eth_fec_set_t)(struct rte_eth_dev *dev, enum rte_fec_mode mode);
+
+/**
* @internal A structure containing the functions exported by an Ethernet driver.
*/
struct eth_dev_ops {
@@ -752,6 +822,13 @@ struct eth_dev_ops {
/**< Set up device RX hairpin queue. */
eth_tx_hairpin_queue_setup_t tx_hairpin_queue_setup;
/**< Set up device TX hairpin queue. */
+
+ eth_fec_get_capability_t fec_get_capability;
+ /**< Get Forward Error Correction(FEC) capability; */
+ eth_fec_get_t fec_get;
+ /**< Get Forward Error Correction(FEC) mode; */
+ eth_fec_set_t fec_set;
+ /**< Set Forward Error Correction(FEC) mode; */
};
/**
@@ -241,6 +241,11 @@ EXPERIMENTAL {
__rte_ethdev_trace_rx_burst;
__rte_ethdev_trace_tx_burst;
rte_flow_get_aged_flows;
+
+ # added in 20.11
+ rte_eth_fec_get_capability;
+ rte_eth_fec_get;
+ rte_eth_fec_set;
};
INTERNAL {