[dpdk-dev] [PATCH v3] doc: update hairpin data buffer size config

[Bing Zhao]

> -----Original Message-----
> From: Thomas Monjalon <thomas at monjalon.net>
> Sent: Wednesday, April 22, 2020 10:13 AM
> To: Bing Zhao <bingz at mellanox.com>
> Cc: john.mcnamara at intel.com; marko.kovacevic at intel.com; Slava
> Ovsiienko <viacheslavo at mellanox.com>; Ori Kam
> <orika at mellanox.com>; Matan Azrad <matan at mellanox.com>;
> Shahaf Shuler <shahafs at mellanox.com>; Raslan Darawsheh
> <rasland at mellanox.com>; dev at dpdk.org
> Subject: Re: [PATCH v3] doc: update hairpin data buffer size config
> 
> 21/04/2020 09:29, Bing Zhao:
> > This patch updates the MLX5 PMD and release notes
> documentations.
> > Adding the guideline for hairpin data buffer size configuration.
> >
> > Signed-off-by: Bing Zhao <bingz at mellanox.com>
> > Acked-by: Ori Kam <orika at mellanox.com>
> > ---
> > --- a/doc/guides/nics/mlx5.rst
> > +++ b/doc/guides/nics/mlx5.rst
> > +- ``hp_buf_log_sz`` parameter [int]
> > +
> > +  The total data buffer size of a hairpin queue (logarithmic form), in
> bytes.
> > +  PMD will set the data buffer size to 2 ** ``hp_buf_log_sz``, both
> for RX & TX.
> > +  The capacity of the value is sepcified by the Firmware, and the
> > + initialization
> 
> sepcified -> specified
> Firmware -> firmware
> 
> > +  will get a failure if it is out of scope.
> > +  The range of the value is from 11 to 19 right now, and the
> > + supported frame  size of a single packet for hairpin is from 512B to
> > + 128KB. It might change if  different Firmware release is being used.
> > + By using a small value, it could
> 
> Firmware -> firmware
> 
> > +  reduce the memory consumption but not work with large frame. If
> the
> > + value is  too large, the memory consumption will be high and some
> > + potential performance  degradation will be introduced.
> > +  By default PMD will set this value to 16, which mean that 9KB
> jumbo
> > + frames
> 
> By default, the PMD
> 
> > +  will be supported.
> > +
> 
> > --- a/doc/guides/rel_notes/release_20_05.rst
> > +++ b/doc/guides/rel_notes/release_20_05.rst
> > @@ -62,6 +62,7 @@ New Features
> >
> >    * Added support for matching on IPv4 Time To Live and IPv6 Hop
> Limit.
> >    * Added support for creating Relaxed Ordering Memory Regions.
> > +  * Added support for configuring Haripin queue data buffer size.
> 
> Haripin -> Hairpin
> 
> 

Many thanks, Thomas. I corrected them and sent the v4.