7 The text below explains how to update the release notes.
9 Use proper spelling, capitalization and punctuation in all sections.
11 Variable and config names should be quoted as fixed width text: ``LIKE_THIS``.
13 Build the docs and view the output file to ensure the changes are correct::
17 firefox build/doc/html/guides/rel_notes/release_16_04.html
23 This section should contain new features added in this release. Sample format:
25 * **Add a title in the past tense with a full stop.**
27 Add a short 1-2 sentence description in the past tense. The description
28 should be enough to allow someone scanning the release notes to understand
31 If the feature adds a lot of sub-features you can use a bullet list like this.
33 * Added feature foo to do something.
34 * Enhanced feature bar to do something else.
36 Refer to the previous release notes for examples.
38 * **Added function to check primary process state.**
40 A new function ``rte_eal_primary_proc_alive()`` has been added
41 to allow the user to detect if a primary process is running.
42 Use cases for this feature include fault detection, and monitoring
43 using secondary processes.
45 * **Enabled bulk allocation of mbufs.**
47 A new function ``rte_pktmbuf_alloc_bulk()`` has been added to allow the user
48 to allocate a bulk of mbufs.
52 Enabled virtio 1.0 support for virtio pmd driver.
54 * **Supported virtio for ARM.**
56 Enabled virtio support for armv7/v8. Tested for arm64.
57 Virtio for arm support VFIO-noiommu mode only.
58 Virtio can work with other non-x86 arch too like powerpc.
60 * **Supported virtio offload in vhost-user.**
62 Add the offload and negotiation of checksum and TSO between vhost-user and
63 vanilla Linux virtio guest.
65 * **Added vhost-user live migration support.**
67 * **Added multicast promiscuous mode support on VF for ixgbe.**
69 Added multicast promiscuous mode support on ixgbe VF driver. So all the VFs
70 can receive the multicast packets.
72 Please note if we want to use this promiscuous mode, we need both PF and VF
73 driver to support it. The reason is this VF feature is configured on PF.
74 If use kernel PF driver + dpdk VF driver, make sure kernel PF driver support
75 VF multicast promiscuous mode. If use dpdk PF + dpdk VF, better make sure PF
76 driver is the same version as VF.
78 * **Added support for E-tag on X550.**
80 E-tag is defined in 802.1br. Please reference
81 http://www.ieee802.org/1/pages/802.1br.html.
83 This feature is for VF, but the settings are on PF. It means
84 the CLIs should be used on PF, but some of their effects will be shown on VF.
85 The forwarding of E-tag packets based on GRP and E-CID_base will have effect
86 on PF. Theoretically the E-tag packets can be forwarded to any pool/queue.
87 But normally we'd like to forward the packets to the pools/queues belonging
88 to the VFs. And E-tag insertion and stripping will have effect on VFs. When
89 VF receives E-tag packets, it should strip the E-tag. When VF transmits
90 packets, it should insert the E-tag. Both can be offloaded.
92 When we want to use this E-tag support feature, the forwarding should be
93 enabled to forward the packets received by PF to indicated VFs. And insertion
94 and stripping should be enabled for VFs to offload the effort to HW.
96 * Support E-tag offloading of insertion and stripping.
97 * Support Forwarding E-tag packets to pools based on
100 * **Added support for VxLAN & NVGRE checksum off-load on X550.**
102 * Added support for VxLAN & NVGRE RX/TX checksum off-load on
103 X550. RX/TX checksum off-load is provided on both inner and
104 outer IP header and TCP header.
105 * Added functions to support VxLAN port configuration. The
106 default VxLAN port number is 4789 but this can be updated
109 * **Added new X550EM_a devices.**
111 Added new X550EM_a devices and their mac types, X550EM_a and X550EM_a_vf.
112 Updated the code to use the new devices and mac types.
114 * **Added x550em_x V2 device support.**
116 Only x550em_x V1 was supported before. Now V2 is supported.
117 A mask for V1 and V2 is defined and used to support both.
119 * **Supported link speed auto-negotiation on X550EM_X**
121 Normally the auto-negotiation is supported by FW. SW need not care about
122 that. But on x550em_x, FW doesn't support auto-neg. As the ports of x550em_x
123 are 10G, if we connect the port with a peer which is 1G, the link will always
125 We added the support of auto-neg by SW to avoid this link down issue.
127 * **Added sw-firmware sync on X550EM_a.**
129 Added support for sw-firmware sync for resource sharing.
130 Use the PHY token, shared between sw-fw for PHY access on X550EM_a.
132 * **Enabled PCI extended tag for i40e.**
134 It enabled extended tag by checking and writing corresponding PCI config
135 space bytes, to boost the performance. In the meanwhile, it deprecated the
136 legacy way via reading/writing sysfile supported by kernel module igb_uio.
138 * **Supported ether type setting of single and double VLAN for i40e**
140 * **Increased number of next hops for LPM IPv4 to 2^24.**
142 The next_hop field is extended from 8 bits to 24 bits for IPv4.
144 * **Added support of SNOW 3G (UEA2 and UIA2) for Intel Quick Assist devices.**
146 Enabled support for SNOW 3G wireless algorithm for Intel Quick Assist devices.
147 Support for cipher only, hash only is also provided
148 along with alg-chaining operations.
150 * **Added SNOW3G SW PMD.**
152 A new Crypto PMD has been added, which provides SNOW 3G UEA2 ciphering
153 and SNOW3G UIA2 hashing.
155 * **Added AES GCM PMD.**
157 Added new Crypto PMD to support AES-GCM authenticated encryption and
158 authenticated decryption in SW.
160 * **Added NULL Crypto PMD**
162 Added new Crypto PMD to support null crypto operations in SW.
164 * **Added IPsec security gateway example.**
166 New application implementing an IPsec Security Gateway.
172 This section should contain bug fixes added to the relevant sections. Sample format:
174 * **code/section: Fixed issue in the past tense with a full stop.**
176 Add a short 1-2 sentence description of the resolved issue in the past tense.
177 The title should contain the code/lib section like a commit message.
178 Add the entries in alphabetic order in the relevant sections below.
188 * **ethdev: Fixed byte order consistency between fdir flow and mask.**
190 Fixed issue in ethdev library that the structure for setting
191 fdir's mask and flow entry was not consistent in byte ordering.
193 * **cxgbe: Fixed crash due to incorrect size allocated for RSS table.**
195 Fixed a segfault that occurs when accessing part of port 0's RSS
196 table that gets overwritten by subsequent port 1's part of the RSS
197 table due to incorrect size allocated for each entry in the table.
199 * **cxgbe: Fixed setting wrong device MTU.**
201 Fixed an incorrect device MTU being set due to ethernet header and
202 CRC lengths being added twice.
204 * **ixgbe: Fixed zeroed VF mac address.**
206 Resolved an issue where VF mac address is zeroed out in cases where the VF
207 driver is loaded while the PF interface is down.
208 The solution is to only set it when we get an ACK from the PF.
210 * **ixgbe: Fixed setting flow director flag twice.**
212 Resolved an issue where packets were being dropped when switching to perfect
215 * **ixgbe: Set MDIO speed after MAC reset.**
217 The MDIO clock speed must be reconfigured after the MAC reset. The MDIO clock
218 speed becomes invalid, therefore the driver reads invalid PHY register values.
219 The driver now set the MDIO clock speed prior to initializing PHY ops and
220 again after the MAC reset.
222 * **i40e: Generated MAC address for each VFs.**
224 It generates a MAC address for each VFs during PF host initialization,
225 and keeps the VF MAC address the same among different VF launch.
227 * **aesni_mb: Fixed wrong return value when creating a device.**
229 cryptodev_aesni_mb_init() was returning the device id of the device created,
230 instead of 0 (when success), that rte_eal_vdev_init() expects.
231 This made impossible the creation of more than one aesni_mb device
234 * **qat: Fixed AES GCM decryption.**
236 Allowed AES GCM on the cryptodev API, but in some cases gave invalid results
237 due to incorrect IV setting.
243 * **hash: Fixed CRC32c hash computation for non multiple of 4 bytes sizes.**
245 Fix crc32c hash functions to return a valid crc32c value for data lengths
246 not multiple of 4 bytes.
252 * **examples/vhost: Fixed frequent mbuf allocation failure.**
254 vhost-switch often fails to allocate mbuf when dequeue from vring because it
255 wrongly calculates the number of mbufs needed.
265 This section should contain new known issues in this release. Sample format:
267 * **Add title in present tense with full stop.**
269 Add a short 1-2 sentence description of the known issue in the present
270 tense. Add information on any known workarounds.
276 This section should contain API changes. Sample format:
278 * Add a short 1-2 sentence description of the API change. Use fixed width
279 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
281 * The functions ``rte_eth_dev_udp_tunnel_add`` and ``rte_eth_dev_udp_tunnel_delete``
282 have been renamed into ``rte_eth_dev_udp_tunnel_port_add`` and
283 ``rte_eth_dev_udp_tunnel_port_delete``.
285 * The ``outer_mac`` and ``inner_mac`` fields in structure
286 ``rte_eth_tunnel_filter_conf`` are changed from pointer to struct in order
287 to keep code's readability.
289 * The fields in ethdev structure ``rte_eth_fdir_masks`` were changed
292 * A parameter ``vlan_type`` has been added to the function
293 ``rte_eth_dev_set_vlan_ether_type``.
295 * The LPM ``next_hop`` field is extended from 8 bits to 24 bits for IPv4
296 while keeping ABI compatibility.
298 * A new ``rte_lpm_config`` structure is used so LPM library will allocate
299 exactly the amount of memory which is necessary to hold application’s rules.
300 The previous ABI is kept for compatibility.
302 * The prototype for the pipeline input port, output port and table action
303 handlers are updated: the pipeline parameter is added,
304 the packets mask parameter has been either removed or made input-only.
310 * Add a short 1-2 sentence description of the ABI change that was announced in
311 the previous releases and made in this release. Use fixed width quotes for
312 ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
314 * The RETA entry size in ``rte_eth_rss_reta_entry64`` has been increased
315 from 8-bit to 16-bit.
317 * The cmdline buffer size has been increase from 256 to 512.
320 Shared Library Versions
321 -----------------------
323 Update any library version updated in this release and prepend with a ``+`` sign.
325 The libraries prepended with a plus sign were incremented in this version.
332 + librte_cmdline.so.2
333 librte_distributor.so.1
345 + librte_pipeline.so.3