[dpdk-dev] [patch v2] doc: announce API change in ethdev offload flags

[Jerin Jacob Kollanukkaran]

> -----Original Message-----
> From: pbhagavatula at marvell.com <pbhagavatula at marvell.com>
> Sent: Thursday, August 8, 2019 1:48 PM
> To: Jerin Jacob Kollanukkaran <jerinj at marvell.com>;
> stephen at networkplumber.org; arybchenko at solarflare.com;
> hemant.agrawal at nxp.com; thomas at monjalon.net; ferruh.yigit at intel.com;
> bruce.richardson at intel.com; Neil Horman <nhorman at tuxdriver.com>; John
> McNamara <john.mcnamara at intel.com>; Marko Kovacevic
> <marko.kovacevic at intel.com>
> Cc: dev at dpdk.org; Pavan Nikhilesh Bhagavatula <pbhagavatula at marvell.com>
> Subject: [dpdk-dev] [patch v2] doc: announce API change in ethdev offload flags
> 
> From: Pavan Nikhilesh <pbhagavatula at marvell.com>
> 
> Add new offload flags ``DEV_RX_OFFLOAD_PTYPE``, ``DEV_RX_OFFLOAD_RSS``
> and ``DEV_RX_OFFLOAD_FLOW_MARK``.
> 
> Signed-off-by: Pavan Nikhilesh <pbhagavatula at marvell.com>
> Acked-by: Andrew Rybchenko <arybchenko at solarflare.com>

With DEV_RX_OFFLOAD_RSS to DEV_RX_OFFLOAD_RSS_HASH name change as Andrew suggested.

Acked-by: Jerin Jacob <jerinj at marvell.com>


> ---
>  v2: Reword for clarity.
> 
>  doc/guides/rel_notes/deprecation.rst | 13 +++++++++++++
>  1 file changed, 13 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst
> b/doc/guides/rel_notes/deprecation.rst
> index 37b8592b6..79e50a272 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -78,3 +78,16 @@ Deprecation Notices
>    to set new power environment if power environment was already initialized.
>    In this case the function will return -1 unless the environment is unset first
>    (using ``rte_power_unset_env``). Other function usage scenarios will not
> change.
> +
> +* ethdev: New offload flags ``DEV_RX_OFFLOAD_PTYPE``,
> +``DEV_RX_OFFLOAD_RSS``
> +  and ``DEV_RX_OFFLOAD_FLOW_MARK`` will be added in 19.11.
> +  This will allow application to enable or disable PMDs from updating
> +  ``rte_mbuf`` fields ``rte_mbuf::packet_type``,
> +``rte_mbuf::hash::rss`` and
> +  ``rte_mbuf::hash::fdir`` respectively.
> +  This scheme will allow PMDs to avoid writes to ``rte_mbuf`` fields on
> +Rx and
> +  thereby improve Rx performance if application wishes do so.
> +  In 19.11 PMDs will still update the fields even when the offloads are
> +not
> +  enabled.
> +  The exact semantics of the flags will be worked out later either by
> +making
> +  them negative offloads to avoid application change or positive
> +offload to
> +  align with existing offload flag semantics.
> --
> 2.17.1