doc: announce ABI change for tunnel filtering
[dpdk.git] / doc / guides / rel_notes / deprecation.rst
1 ABI and API Deprecation
2 =======================
3
4 See the :doc:`guidelines document for details of the ABI policy </contributing/versioning>`.
5 API and ABI deprecation notices are to be posted here.
6
7
8 Deprecation Notices
9 -------------------
10
11 * The following fields have been deprecated in rte_eth_stats:
12   ibadcrc, ibadlen, imcasts, fdirmatch, fdirmiss,
13   tx_pause_xon, rx_pause_xon, tx_pause_xoff, rx_pause_xoff
14
15 * ABI changes is planned for the reta field in struct rte_eth_rss_reta_entry64
16   which handles at most 256 entries (8 bits) while newer NICs support larger
17   tables (512 entries).
18   It should be integrated in release 2.3.
19
20 * ABI changes are planned for struct rte_eth_fdir_flow in order to support
21   extend flow director's input set. The release 2.2 does not contain these ABI
22   changes, but release 2.3 will, and no backwards compatibility is planned.
23
24 * ABI changes are planned for rte_eth_tunnel_filter_conf. Change the fields
25   of outer_mac and inner_mac from pointer to struct in order to keep the
26   code's readability. The release 2.2 does not contain these ABI changes, but
27   release 2.3 will, and no backwards compatibility is planned.
28
29 * The scheduler statistics structure will change to allow keeping track of
30   RED actions.
31
32 * librte_pipeline: The prototype for the pipeline input port, output port
33   and table action handlers will be updated:
34   the pipeline parameter will be added, the packets mask parameter will be
35   either removed (for input port action handler) or made input-only.
36
37 * ABI changes are planned in cmdline buffer size to allow the use of long
38   commands (such as RETA update in testpmd).  This should impact
39   CMDLINE_PARSE_RESULT_BUFSIZE, STR_TOKEN_SIZE and RDLINE_BUF_SIZE.
40   It should be integrated in release 2.3.