qat: add AES-CTR capability
[dpdk.git] / doc / guides / rel_notes / release_16_07.rst
1 DPDK Release 16.07
2 ==================
3
4 .. **Read this first.**
5
6    The text below explains how to update the release notes.
7
8    Use proper spelling, capitalization and punctuation in all sections.
9
10    Variable and config names should be quoted as fixed width text: ``LIKE_THIS``.
11
12    Build the docs and view the output file to ensure the changes are correct::
13
14       make doc-guides-html
15
16       firefox build/doc/html/guides/rel_notes/release_16_07.html
17
18
19 New Features
20 ------------
21
22 .. This section should contain new features added in this release. Sample format:
23
24    * **Add a title in the past tense with a full stop.**
25
26      Add a short 1-2 sentence description in the past tense. The description
27      should be enough to allow someone scanning the release notes to understand
28      the new feature.
29
30      If the feature adds a lot of sub-features you can use a bullet list like this.
31
32      * Added feature foo to do something.
33      * Enhanced feature bar to do something else.
34
35      Refer to the previous release notes for examples.
36
37 * **Removed mempool cache if not needed.**
38
39   The size of the mempool structure is reduced if the per-lcore cache is disabled.
40
41 * **Changed the memory allocation in mempool library.**
42
43   * Added ability to allocate a large mempool in virtually fragmented memory.
44   * Added new APIs to populate a mempool with memory.
45   * Added an API to free a mempool.
46   * Modified the API of rte_mempool_obj_iter() function.
47   * Dropped specific Xen Dom0 code.
48   * Dropped specific anonymous mempool code in testpmd.
49
50 * **Added support of AES counter mode for Intel QuickAssist devices.**
51
52   Enabled support for the AES CTR algorithm for Intel QuickAssist devices.
53   Provided support for algorithm-chaining operations.
54
55
56 Resolved Issues
57 ---------------
58
59 .. This section should contain bug fixes added to the relevant sections. Sample format:
60
61    * **code/section Fixed issue in the past tense with a full stop.**
62
63      Add a short 1-2 sentence description of the resolved issue in the past tense.
64      The title should contain the code/lib section like a commit message.
65      Add the entries in alphabetic order in the relevant sections below.
66
67
68 EAL
69 ~~~
70
71
72 Drivers
73 ~~~~~~~
74
75 * **i40e: Fixed vlan stripping from inner header.**
76
77   Previously, for tunnel packets, such as VXLAN/NVGRE, the vlan
78   tags of the inner header will be stripped without putting vlan
79   info to descriptor.
80   Now this issue is fixed by disabling vlan stripping from inner header.
81
82
83 Libraries
84 ~~~~~~~~~
85
86 * **mbuf: Fixed refcnt update when detaching.**
87
88   Fix the ``rte_pktmbuf_detach()`` function to decrement the direct
89   mbuf's reference counter. The previous behavior was not to affect
90   the reference counter. It lead a memory leak of the direct mbuf.
91
92
93 Examples
94 ~~~~~~~~
95
96
97 Other
98 ~~~~~
99
100
101 Known Issues
102 ------------
103
104 .. This section should contain new known issues in this release. Sample format:
105
106    * **Add title in present tense with full stop.**
107
108      Add a short 1-2 sentence description of the known issue in the present
109      tense. Add information on any known workarounds.
110
111
112 API Changes
113 -----------
114
115 .. This section should contain API changes. Sample format:
116
117    * Add a short 1-2 sentence description of the API change. Use fixed width
118      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
119
120 * The following counters are removed from ``rte_eth_stats`` structure:
121   ibadcrc, ibadlen, imcasts, fdirmatch, fdirmiss,
122   tx_pause_xon, rx_pause_xon, tx_pause_xoff, rx_pause_xoff.
123
124
125 ABI Changes
126 -----------
127
128 .. * Add a short 1-2 sentence description of the ABI change that was announced in
129      the previous releases and made in this release. Use fixed width quotes for
130      ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
131
132 * The ``rte_port_source_params`` structure has new fields to support PCAP file.
133   It was already in release 16.04 with ``RTE_NEXT_ABI`` flag.
134
135
136 Shared Library Versions
137 -----------------------
138
139 .. Update any library version updated in this release and prepend with a ``+`` sign.
140
141 The libraries prepended with a plus sign were incremented in this version.
142
143 .. code-block:: diff
144
145    + libethdev.so.4
146      librte_acl.so.2
147      librte_cfgfile.so.2
148      librte_cmdline.so.2
149      librte_distributor.so.1
150      librte_eal.so.2
151      librte_hash.so.2
152      librte_ip_frag.so.1
153      librte_ivshmem.so.1
154      librte_jobstats.so.1
155      librte_kni.so.2
156      librte_kvargs.so.1
157      librte_lpm.so.2
158      librte_mbuf.so.2
159    + librte_mempool.so.2
160      librte_meter.so.1
161      librte_pipeline.so.3
162      librte_pmd_bond.so.1
163      librte_pmd_ring.so.2
164    + librte_port.so.3
165      librte_power.so.1
166      librte_reorder.so.1
167      librte_ring.so.1
168      librte_sched.so.1
169      librte_table.so.2
170      librte_timer.so.1
171      librte_vhost.so.2
172
173
174 Tested Platforms
175 ----------------
176
177 .. This section should contain a list of platforms that were tested with this
178    release.
179
180    The format is:
181
182    #. Platform name.
183
184       - Platform details.
185       - Platform details.
186
187
188 Tested NICs
189 -----------
190
191 .. This section should contain a list of NICs that were tested with this release.
192
193    The format is:
194
195    #. NIC name.
196
197       - NIC details.
198       - NIC details.