[dpdk-dev] [PATCH v2] ethdev: enhance the API for getting burst mode information

[Wang, Haiyue]

> -----Original Message-----
> From: Wang, Haiyue
> Sent: Wednesday, November 6, 2019 09:22
> To: Thomas Monjalon <thomas at monjalon.net>
> Cc: dev at dpdk.org; jerinjacobk at gmail.com; Yigit, Ferruh <ferruh.yigit at intel.com>;
> arybchenko at solarflare.com; viacheslavo at mellanox.com; damarion at cisco.com; Ye, Xiaolong
> <xiaolong.ye at intel.com>; Sun, Chenmin <chenmin.sun at intel.com>; Kinsella, Ray <ray.kinsella at intel.com>;
> Liu, Yu Y <yu.y.liu at intel.com>
> Subject: RE: [dpdk-dev] [PATCH v2] ethdev: enhance the API for getting burst mode information
> 
> Hi Thomas,
> 
> > -----Original Message-----
> > From: Thomas Monjalon <thomas at monjalon.net>
> > Sent: Wednesday, November 6, 2019 08:34
> > To: Wang, Haiyue <haiyue.wang at intel.com>
> > Cc: dev at dpdk.org; jerinjacobk at gmail.com; Yigit, Ferruh <ferruh.yigit at intel.com>;
> > arybchenko at solarflare.com; viacheslavo at mellanox.com; damarion at cisco.com; Ye, Xiaolong
> > <xiaolong.ye at intel.com>; Sun, Chenmin <chenmin.sun at intel.com>; Kinsella, Ray
> <ray.kinsella at intel.com>;
> > Liu, Yu Y <yu.y.liu at intel.com>
> > Subject: Re: [dpdk-dev] [PATCH v2] ethdev: enhance the API for getting burst mode information
> >
> > 04/11/2019 11:39, Haiyue Wang:
> > > Change the type of burst mode information from bit field to free string
> > > data, so that each PMD can describe the Rx/Tx busrt functions flexibly.
> > >
> > > Signed-off-by: Haiyue Wang <haiyue.wang at intel.com>
> > > ---
> > >
> > > v2: - Drop the bit field for burst mode information handling.
> >
> 
> > > --- a/lib/librte_ethdev/rte_ethdev.h
> > > +++ b/lib/librte_ethdev/rte_ethdev.h
> > >  /**
> > > - * Burst mode types, values can be ORed to define the burst mode of a driver.
> > > + * Generic Burst mode flag definition, values can be ORed.
> > > + */
> > > +#define RTE_ETH_BURST_FLAG_PER_QUEUE     (1ULL << 0)
> > > +/**< If the queues have different burst mode description, this bit will be set
> > > + * by PMD, then the application can iterate to retrieve burst description for
> > > + * all other queues.
> > >   */
> >
> > I am not sure you can have a doxygen comment before and after the same item.
> >
> 
> The first is for all flags, but only one now, so looks like for the same item.
> The second is just for RTE_ETH_BURST_FLAG_PER_QUEUE flag.
> 

Yes, you are right. I misunderstand the doxygen's grammar. Its output is two comments
together.

RTE_ETH_BURST_FLAG_PER_QUEUE
#define RTE_ETH_BURST_FLAG_PER_QUEUE   (1ULL << 0)
Generic Burst mode flag definition, values can be ORed. If the queues have different burst mode description, this bit will be set by PMD, then the application can iterate to retrieve burst description for all other queues.

Definition at line 1253 of file rte_ethdev.h.

I submit a new patch, change the first line to C comment. Now the output is:

RTE_ETH_BURST_FLAG_PER_QUEUE
#define RTE_ETH_BURST_FLAG_PER_QUEUE   (1ULL << 0)
If the queues have different burst mode description, this bit will be set by PMD, then the application can iterate to retrieve burst description for all other queues.

Definition at line 1257 of file rte_ethdev.h.


> 
> >