doc: announce ABI change for config file library

[dpdk.git] / doc / guides / rel_notes / deprecation.rst

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 5e8beed..5cf01a4 100644 (file)
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -43,3 +43,34 @@ Deprecation Notices
   Functions: rte_eth_dev_fdir_*.
   Structures: rte_fdir_*, rte_eth_fdir.
   Enums: rte_l4type, rte_iptype.
+
+* ABI changes are planned for struct rte_eth_fdir_flow_ext in order to support
+  flow director filtering in VF. The release 2.1 does not contain these ABI
+  changes, but release 2.2 will, and no backwards compatibility is planned.
+
+* ABI change is planned to extend the SCTP flow's key input from release 2.1.
+  The change may be enabled in the release 2.1 with CONFIG_RTE_NEXT_ABI.
+
+* ABI changes are planned for struct rte_eth_fdir_filter and
+  rte_eth_fdir_masks in order to support new flow director modes,
+  MAC VLAN and Cloud, on x550. The MAC VLAN mode means the MAC and
+  VLAN are monitored. The Cloud mode is for VxLAN and NVGRE, and
+  the tunnel type, TNI/VNI, inner MAC and inner VLAN are monitored.
+  The release 2.2 will contain these changes without backwards compatibility.
+
+* ABI changes are planned for struct virtio_net in order to support vhost-user
+  multiple queues feature.
+  It should be integrated in release 2.2 without backward compatibility.
+
+* The scheduler hierarchy structure (rte_sched_port_hierarchy) will change to
+  allow for a larger number of subport entries.
+  The number of available traffic_classes and queues may also change.
+  The mbuf structure element for sched hierarchy will also change from a single
+  32 bit to a 64 bit structure.
+
+* The scheduler statistics structure will change to allow keeping track of
+  RED actions.
+
+* librte_cfgfile: In order to allow for longer names and values,
+  the value of macros CFG_NAME_LEN and CFG_NAME_VAL will be increased.
+  Most likely, the new values will be 64 and 256, respectively.