doc: fix ABI change announce for RETA configuration
[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 * The ethdev structures rte_eth_link, rte_eth_dev_info and rte_eth_conf
16   must be updated to support 100G link and to have a cleaner link speed API.
17
18 * ABI changes is planned for the reta field in struct rte_eth_rss_reta_entry64
19   which handles at most 256 queues (8 bits) while newer NICs support larger
20   tables (512 queues).
21   It should be integrated in release 2.3.
22
23 * ABI changes are planned for struct rte_eth_fdir_flow in order to support
24   extend flow director's input set. The release 2.2 does not contain these ABI
25   changes, but release 2.3 will, and no backwards compatibility is planned.
26
27 * ABI changes are planned for rte_eth_ipv4_flow and rte_eth_ipv6_flow to
28   include more fields to be matched against. The release 2.2 does not
29   contain these ABI changes, but release 2.3 will.
30
31 * ABI changes are planned for adding four new flow types. This impacts
32   RTE_ETH_FLOW_MAX. The release 2.2 does not contain these ABI changes,
33   but release 2.3 will.
34
35 * ABI changes are planned for rte_eth_tunnel_filter_conf. Change the fields
36   of outer_mac and inner_mac from pointer to struct in order to keep the
37   code's readability. The release 2.2 does not contain these ABI changes, but
38   release 2.3 will, and no backwards compatibility is planned.
39
40 * The scheduler statistics structure will change to allow keeping track of
41   RED actions.
42
43 * librte_pipeline: The prototype for the pipeline input port, output port
44   and table action handlers will be updated:
45   the pipeline parameter will be added, the packets mask parameter will be
46   either removed (for input port action handler) or made input-only.
47
48 * ABI changes are planned in cmdline buffer size to allow the use of long
49   commands (such as RETA update in testpmd).  This should impact
50   CMDLINE_PARSE_RESULT_BUFSIZE, STR_TOKEN_SIZE and RDLINE_BUF_SIZE.
51   It should be integrated in release 2.3.