[dpdk-dev,v3] doc: announce ethdev CRC strip flag deprecation

Message ID 20180417131221.181117-1-ferruh.yigit@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Ferruh Yigit April 17, 2018, 1:12 p.m. UTC
  Make CRC stripping default behavior, deprecate flag
DEV_RX_OFFLOAD_CRC_STRIP.

Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>

---
v2:
* Make CRC behavior active in this release

v3:
* Distribute switch into next two releases for more smooth transition
  v18.08: add new flag to keep crc, and implement this in PMDs
  v18.11: remove crc strip flag and make default behavior to strip crc
---
 doc/guides/rel_notes/deprecation.rst | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
  

Comments

Andrew Rybchenko April 17, 2018, 1:31 p.m. UTC | #1
On 04/17/2018 04:12 PM, Ferruh Yigit wrote:
> Make CRC stripping default behavior, deprecate flag
> DEV_RX_OFFLOAD_CRC_STRIP.
>
> Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
Acked-by: Andrew Rybchenko <arybchenko@solarflare.com>
  
Ferruh Yigit April 17, 2018, 1:36 p.m. UTC | #2
On 4/17/2018 2:12 PM, Ferruh Yigit wrote:
> Make CRC stripping default behavior, deprecate flag
> DEV_RX_OFFLOAD_CRC_STRIP.
> 
> Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
> 
> ---
> v2:
> * Make CRC behavior active in this release
> 
> v3:
> * Distribute switch into next two releases for more smooth transition
>   v18.08: add new flag to keep crc, and implement this in PMDs
>   v18.11: remove crc strip flag and make default behavior to strip crc
> ---
>  doc/guides/rel_notes/deprecation.rst | 20 ++++++++++++++++++++
>  1 file changed, 20 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index fd9def20c..3ee1bd05e 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -100,6 +100,26 @@ Deprecation Notices
>    between the VF representor and the VF or the parent PF. Those new fields
>    are to be included in ``rte_eth_dev_info`` struct.
>  
> +* ethdev: A new offloading flag ``DEV_RX_OFFLOAD_KEEP_CRC`` will be added in v18.08,
> +  This will replace the usage of not setting ``DEV_RX_OFFLOAD_CRC_STRIP`` flag
> +  and will be implemented in PMDs accordingly.
> +  In v18.08 both ``DEV_RX_OFFLOAD_KEEP_CRC`` and ``DEV_RX_OFFLOAD_CRC_STRIP`` flags
> +  will be available, usage will be:
> +  ``CRC_STRIP``: Strip CRC from packet
> +  ``KEEP_CRC``: Keep CRC in packet
> +  Both ``CRC_STRIP`` & ``KEEP_CRC``: Invalid
> +  No flag: Keep CRC in packet
> +
> +* ethdev: In v18.11 ``DEV_RX_OFFLOAD_CRC_STRIP`` offload flag will be removed, default
> +  behavior without any flag will be changed to CRC strip.
> +  To keep CRC ``DEV_RX_OFFLOAD_KEEP_CRC`` flag is required.
> +  ``KEEP_CRC``: Keep CRC in packet
> +  No flag: Strip CRC from packet
> +
> +* ethdev: Make CRC stripping default behavior in v18.05 without any flag
> +  and remove flag completely in v18.08
> +  ``DEV_RX_OFFLOAD_CRC_STRIP`` flag will be removed.
> +

This last part is git artifact, I will send a new version to fix it.

>  * i40e: The default flexible payload configuration which extracts the first 16
>    bytes of the payload for RSS will be deprecated starting from 18.02. If
>    required the previous behavior can be configured using existing flow
>
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index fd9def20c..3ee1bd05e 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -100,6 +100,26 @@  Deprecation Notices
   between the VF representor and the VF or the parent PF. Those new fields
   are to be included in ``rte_eth_dev_info`` struct.
 
+* ethdev: A new offloading flag ``DEV_RX_OFFLOAD_KEEP_CRC`` will be added in v18.08,
+  This will replace the usage of not setting ``DEV_RX_OFFLOAD_CRC_STRIP`` flag
+  and will be implemented in PMDs accordingly.
+  In v18.08 both ``DEV_RX_OFFLOAD_KEEP_CRC`` and ``DEV_RX_OFFLOAD_CRC_STRIP`` flags
+  will be available, usage will be:
+  ``CRC_STRIP``: Strip CRC from packet
+  ``KEEP_CRC``: Keep CRC in packet
+  Both ``CRC_STRIP`` & ``KEEP_CRC``: Invalid
+  No flag: Keep CRC in packet
+
+* ethdev: In v18.11 ``DEV_RX_OFFLOAD_CRC_STRIP`` offload flag will be removed, default
+  behavior without any flag will be changed to CRC strip.
+  To keep CRC ``DEV_RX_OFFLOAD_KEEP_CRC`` flag is required.
+  ``KEEP_CRC``: Keep CRC in packet
+  No flag: Strip CRC from packet
+
+* ethdev: Make CRC stripping default behavior in v18.05 without any flag
+  and remove flag completely in v18.08
+  ``DEV_RX_OFFLOAD_CRC_STRIP`` flag will be removed.
+
 * i40e: The default flexible payload configuration which extracts the first 16
   bytes of the payload for RSS will be deprecated starting from 18.02. If
   required the previous behavior can be configured using existing flow