> -----Original Message-----
> From: Yigit, Ferruh
> Sent: Tuesday, October 15, 2019 18:45
> To: Wang, Haiyue <haiyue.w...@intel.com>; dev@dpdk.org; Ye, Xiaolong
> <xiaolong...@intel.com>
> Cc: Kinsella, Ray <ray.kinse...@intel.com>; Iremonger, Bernard
> <bernard.iremon...@intel.com>; Sun,
> Chenmin <chenmin....@intel.com>
> Subject: Re: [PATCH v4 1/4] ethdev: add the API for getting burst mode
> information
>
> On 10/15/2019 8:51 AM, Haiyue Wang wrote:
> > Some PMDs have more than one RX/TX burst paths, add the ethdev API
> > that allows an application to retrieve the mode information about
> > Rx/Tx packet burst such as Scalar or Vector, and Vector technology
> > like AVX2.
> >
> > Signed-off-by: Haiyue Wang <haiyue.w...@intel.com>
>
> <...>
>
> > +/**
> > + * Retrieve name about burst mode option.
> > + *
> > + * @param mode
> > + * The burst mode option of type *rte_eth_burst_mode_option*.
> > + *
> > + * @return
> > + * - "": Not found
> > + * - "xxx": name of the mode option.
> > + */
> > +__rte_experimental
> > +const char *
> > +rte_eth_burst_mode_option_name(uint64_t option);
>
> Doxygen giving warnings [1], can be fixed [2] while merging.
>
Learned, thanks, will notice to check it next time. ;-)
>
> [1]
> .../lib/librte_ethdev/rte_ethdev.h:1217:
> warning: Member rte_eth_burst_mode_option (enumeration) of file rte_ethdev.h
> is
> not documented.
>
> .../lib/librte_ethdev/rte_ethdev.h:3673:
> warning: argument 'mode' of command @param is not found in the argument list
> of
> rte_eth_burst_mode_option_name(uint64_t option)
>
> .../lib/librte_ethdev/rte_ethdev.h:3685:
> warning: The following parameters of rte_eth_burst_mode_option_name(uint64_t
> option) are not documented:
>
>
> [2]
> diff --git a/lib/librte_ethdev/rte_ethdev.h b/lib/librte_ethdev/rte_ethdev.h
> index 83b08ee4df..ec95f9b194 100644
> --- a/lib/librte_ethdev/rte_ethdev.h
> +++ b/lib/librte_ethdev/rte_ethdev.h
> @@ -1214,6 +1214,9 @@ struct rte_eth_txq_info {
> uint16_t nb_desc; /**< configured number of TXDs. */
> } __rte_cache_min_aligned;
>
> +/**
> + * Burst mode types, values can be ORed to define the burst mode of a
> driver.
> + */
> enum rte_eth_burst_mode_option {
> RTE_ETH_BURST_SCALAR = (1 << 0),
> RTE_ETH_BURST_VECTOR = (1 << 1),
> @@ -3673,7 +3676,7 @@ int rte_eth_tx_burst_mode_get(uint16_t port_id,
> uint16_t
> queue_id,
> /**
> * Retrieve name about burst mode option.
> *
> - * @param mode
> + * @param option
> * The burst mode option of type *rte_eth_burst_mode_option*.
> *
> * @return
