[dpdk-dev] [PATCH 1/2] compressdev: replace mbuf scatter gather flag

[Trahe, Fiona]

Hi Pablo,

> -----Original Message-----
> From: De Lara Guarch, Pablo
> Sent: Wednesday, June 27, 2018 6:51 AM
> To: Trahe, Fiona <fiona.trahe at intel.com>; ashish.gupta at caviumnetworks.com; Daly, Lee
> <lee.daly at intel.com>
> Cc: dev at dpdk.org; De Lara Guarch, Pablo <pablo.de.lara.guarch at intel.com>
> Subject: [PATCH 1/2] compressdev: replace mbuf scatter gather flag
> 
> The current mbuf scatter gatter feature flag is
[Fiona] typo - gather

> too ambiguous, as it is not clear if input and/or output
> buffers can be scatter gather mbufs or not.
> 
> Therefore, three new flags will replace this flag:
> - RTE_CRYPTODEV_FF_OUT_OF_PLACE_SGL_IN_SGL_OUT
> - RTE_CRYPTODEV_FF_OUT_OF_PLACE_SGL_IN_FB_OUT
> - RTE_CRYPTODEV_FF_OUT_OF_PLACE_FB_IN_SGL_OUT
[Fiona] oops! CRYPTODEV?? Here and below in docs

> 
> Note that out-of-place flat buffers is supported by default
> and in-place is not supported by the library.
> 
> Signed-off-by: Pablo de Lara <pablo.de.lara.guarch at intel.com>
> ---
>  doc/guides/rel_notes/release_18_08.rst |  6 ++++++
>  lib/librte_compressdev/rte_comp.c      |  8 ++++++--
>  lib/librte_compressdev/rte_comp.h      | 30 ++++++++++++++++++++----------
>  3 files changed, 32 insertions(+), 12 deletions(-)
> 
> diff --git a/doc/guides/rel_notes/release_18_08.rst b/doc/guides/rel_notes/release_18_08.rst
> index bc0124295..1fc38418a 100644
> --- a/doc/guides/rel_notes/release_18_08.rst
> +++ b/doc/guides/rel_notes/release_18_08.rst
> @@ -60,6 +60,12 @@ API Changes
>     Also, make sure to start the actual text at the margin.
>     =========================================================
> 
> +* compressdev: Feature flag ``RTE_COMP_FF_MBUF_SCATTER_GATHER`` is
> +  replaced with the following more explicit flags:
> +  - ``RTE_CRYPTODEV_FF_OUT_OF_PLACE_SGL_IN_SGL_OUT``
> +  - ``RTE_CRYPTODEV_FF_OUT_OF_PLACE_SGL_IN_FB_OUT``
> +  - ``RTE_CRYPTODEV_FF_OUT_OF_PLACE_FB_IN_SGL_OUT``
> +
> 

> +#define RTE_COMP_FF_OUT_OF_PLACE_SGL_IN_SGL_OUT	(1ULL << 2)
> +/**< Out-of-place Scatter-gather (SGL) mbufs are
> + * supported in input and output
> + */
> +#define RTE_COMP_FF_OUT_OF_PLACE_SGL_IN_FB_OUT	(1ULL << 3)
> +/**< Out-of-place Scatter-gather (SGL) mbufs are supported
> + * in input, but only flat buffers (FB) are supported in output
> + */
[Fiona] I'd replace "but only.." with "combined with FB in output" 
As a PMD can set more than one of these flags, so the but only is misleading in this case. 
Same with next flag.