[dpdk-dev] [PATCH 15/18] net/dpaa: add support for loopback API

[Ferruh Yigit]

On 12/13/2017 12:05 PM, Hemant Agrawal wrote:
> Signed-off-by: Hemant Agrawal <hemant.agrawal at nxp.com>

<...>

> @@ -0,0 +1,37 @@
> +/*-
> + *   Copyright 2017 NXP.
> + *
> + *   SPDX-License-Identifier:        BSD-3-Clause

I guess latest agreement was without break.

> + */
> +
> +#ifndef _PMD_DPAA_H_
> +#define _PMD_DPAA_H_
> +
> +/**
> + * @file rte_pmd_dpaa.h
> + *
> + * dpaa PMD specific functions.
> + *
> + * @b EXPERIMENTAL: this API may change, or be removed, without prior notice

What about adding a @warning for this note too, otherwise it is very easy to
miss note.

> + *
> + */
> +
> +#include <rte_ethdev.h>
> +
> +/**
> + * Enable/Disable TX loopback

I am for adding EXPERIMENTAL tag for API as well, otherwise it is easy to miss.
I suggest adding @warning as well to highlight is as done in rte_member.h

> + *
> + * @param port
> + *    The port identifier of the Ethernet device.
> + * @param on
> + *    1 - Enable TX loopback.
> + *    0 - Disable TX loopback.
> + * @return
> + *   - (0) if successful.
> + *   - (-ENODEV) if *port* invalid.
> + *   - (-EINVAL) if bad parameter.
> + */
> +int rte_pmd_dpaa_set_tx_loopback(uint8_t port,
> +				 uint8_t on);

PMD now has PMD specific API, this is public API, can you please update related
API documentations to document this API?

> +
> +#endif /* _PMD_DPAA_H_ */
> diff --git a/drivers/net/dpaa/rte_pmd_dpaa_version.map b/drivers/net/dpaa/rte_pmd_dpaa_version.map
> index a70bd19..d76acbd 100644
> --- a/drivers/net/dpaa/rte_pmd_dpaa_version.map
> +++ b/drivers/net/dpaa/rte_pmd_dpaa_version.map
> @@ -2,3 +2,11 @@ DPDK_17.11 {
>  
>  	local: *;
>  };
> +
> +DPDK_18.02 {

This API is EXPERIMENTAL (as far as I can see from above) so having an
experimental tag is better.

How to mark an API as experimental is not documented, we should indeed.

cc'ed Luca if I am missing steps related how to make an API experimental.

> +	global:
> +
> +	rte_pmd_dpaa_set_tx_loopback;
> +
> +	local: *;
> +} DPDK_17.11;
>