4 .. **Read this first.**
6 The text in the sections below explains how to update the release notes.
8 Use proper spelling, capitalization and punctuation in all sections.
10 Variable and config names should be quoted as fixed width text:
13 Build the docs and view the output file to ensure the changes are correct::
17 xdg-open build/doc/html/guides/rel_notes/release_18_08.html
23 .. This section should contain new features added in this release.
26 * **Add a title in the past tense with a full stop.**
28 Add a short 1-2 sentence description in the past tense.
29 The description should be enough to allow someone scanning
30 the release notes to understand the new feature.
32 If the feature adds a lot of sub-features you can use a bullet list
35 * Added feature foo to do something.
36 * Enhanced feature bar to do something else.
38 Refer to the previous release notes for examples.
40 This section is a comment. Do not overwrite or remove it.
41 Also, make sure to start the actual text at the margin.
42 =========================================================
44 * **Added support for Hyper-V netvsc PMD.**
46 The new ``netvsc`` poll mode driver provides native support for
47 networking on Hyper-V. See the :doc:`../nics/netvsc` NIC driver guide
48 for more details on this new driver.
50 * **Added Flow API support for CXGBE PMD.**
52 Flow API support has been added to CXGBE Poll Mode Driver to offload
53 flows to Chelsio T5/T6 NICs. Support added for:
54 * Wildcard (LE-TCAM) and Exact (HASH) match filters.
55 * Match items: physical ingress port, IPv4, IPv6, TCP and UDP.
56 * Action items: queue, drop, count, and physical egress port redirect.
58 * **Added ixgbe preferred Rx/Tx parameters.**
60 Rather than applications providing explicit Rx and Tx parameters such as
61 queue and burst sizes, they can request that the EAL instead uses preferred
62 values provided by the PMD, falling back to defaults within the EAL if the
63 PMD does not provide any. The provision of such tuned values now includes
66 * **Added descriptor status check support for fm10k.**
68 ``rte_eth_rx_descritpr_status`` and ``rte_eth_tx_descriptor_status``
69 are supported by fm10K.
71 * **Updated the enic driver.**
73 * Add low cycle count Tx handler for no-offload Tx.
74 * Add low cycle count Rx handler for non-scattered Rx.
75 * Minor performance improvements to scattered Rx handler.
76 * Add handlers to add/delete VxLAN port number.
77 * Add devarg to specify ingress VLAN rewrite mode.
79 * **Updated mlx5 driver.**
81 Updated the mlx5 driver including the following changes:
83 * Added port representors support.
84 * Added Flow API support for e-switch rules.
85 Supported ACTION_PORT_ID, ACTION_DROP, ACTION_OF_POP_VLAN,
86 ACTION_OF_PUSH_VLAN, ACTION_OF_SET_VLAN_VID, ACTION_OF_SET_VLAN_PCP
88 * Supported 32-bit compilation.
90 * **Added TSO support for mlx4 driver.**
92 The support is from MLNX_OFED_4.4 and above.
94 * **SoftNIC PMD rework.**
96 The SoftNIC PMD infrastructure is restructured to use the Packet Framework,
97 which makes it more flexible, modular and easier to add new functionality
100 * **Updated the AESNI MB PMD.**
102 The AESNI MB PMD has been updated with additional support for:
104 * 3DES for 8, 16 and 24 byte keys.
106 * **Added a new compression PMD using Intel's QuickAssist (QAT) device family.**
108 Added the new ``QAT`` compression driver, for compression and decompression
109 operations in software. See the :doc:`../compressdevs/qat_comp` compression
110 driver guide for details on this new driver.
112 * **Updated the ISA-L PMD.**
114 Added support for chained mbufs (input and output).
120 .. This section should contain API changes. Sample format:
122 * Add a short 1-2 sentence description of the API change.
123 Use fixed width quotes for ``function_names`` or ``struct_names``.
126 This section is a comment. Do not overwrite or remove it.
127 Also, make sure to start the actual text at the margin.
128 =========================================================
130 * Path to runtime config file has changed. The new path is determined as
133 - If DPDK is running as root, ``/var/run/dpdk/<prefix>/config``
134 - If DPDK is not running as root:
136 * If ``$XDG_RUNTIME_DIR`` is set, ``${XDG_RUNTIME_DIR}/dpdk/<prefix>/config``
137 * Otherwise, ``/tmp/dpdk/<prefix>/config``
139 * eal: The function ``rte_eal_mbuf_default_mempool_ops`` was deprecated
140 and is removed in 18.08. It shall be replaced by
141 ``rte_mbuf_best_mempool_ops``.
143 * mempool: Following functions were deprecated and are removed in 18.08:
145 - ``rte_mempool_populate_iova_tab``
146 - ``rte_mempool_populate_phys_tab``
147 - ``rte_mempool_populate_phys`` (``rte_mempool_populate_iova`` should be used)
148 - ``rte_mempool_virt2phy`` (``rte_mempool_virt2iova`` should be used)
149 - ``rte_mempool_xmem_create``
150 - ``rte_mempool_xmem_size``
151 - ``rte_mempool_xmem_usage``
153 * ethdev: The old offload API is removed:
155 - Rx per-port ``rte_eth_conf.rxmode.[bit-fields]``
156 - Tx per-queue ``rte_eth_txconf.txq_flags``
157 - ``ETH_TXQ_FLAGS_NO*``
159 The transition bits are removed:
161 - ``rte_eth_conf.rxmode.ignore_offload_bitfield``
162 - ``ETH_TXQ_FLAGS_IGNORE``
164 * cryptodev: In struct ``struct rte_cryptodev_info``, field ``rte_pci_device *pci_dev``
165 has been replaced with field ``struct rte_device *device``.
166 Value 0 is accepted in ``sym.max_nb_sessions``, meaning that a device
167 supports an unlimited number of sessions.
168 Two new fields of type ``uint16_t`` have been added:
169 ``min_mbuf_headroom_req`` and ``min_mbuf_tailroom_req``.
170 These parameters specify the recommended headroom and tailroom for mbufs
171 to be processed by the PMD.
173 * cryptodev: Following functions were deprecated and are removed in 18.08:
175 - ``rte_cryptodev_queue_pair_start``
176 - ``rte_cryptodev_queue_pair_stop``
177 - ``rte_cryptodev_queue_pair_attach_sym_session``
178 - ``rte_cryptodev_queue_pair_detach_sym_session``
180 * cryptodev: Following functions were deprecated and are replaced by
181 other functions in 18.08:
183 - ``rte_cryptodev_get_header_session_size`` is replaced with
184 ``rte_cryptodev_sym_get_header_session_size``
185 - ``rte_cryptodev_get_private_session_size`` is replaced with
186 ``rte_cryptodev_sym_get_private_session_size``
188 * cryptodev: Feature flag ``RTE_CRYPTODEV_FF_MBUF_SCATTER_GATHER`` is
189 replaced with the following more explicit flags:
191 - ``RTE_CRYPTODEV_FF_IN_PLACE_SGL``
192 - ``RTE_CRYPTODEV_FF_OOP_SGL_IN_SGL_OUT``
193 - ``RTE_CRYPTODEV_FF_OOP_SGL_IN_LB_OUT``
194 - ``RTE_CRYPTODEV_FF_OOP_LB_IN_SGL_OUT``
195 - ``RTE_CRYPTODEV_FF_OOP_LB_IN_LB_OUT``
197 * cryptodev: Renamed cryptodev experimental APIs:
199 Used user_data instead of private_data in following APIs to avoid confusion
200 with the existing session parameter ``sess_private_data[]`` and related APIs.
202 - ``rte_cryptodev_sym_session_set_private_data()`` changed to
203 ``rte_cryptodev_sym_session_set_user_data()``
204 - ``rte_cryptodev_sym_session_get_private_data()`` changed to
205 ``rte_cryptodev_sym_session_get_user_data()``
207 * compressdev: Feature flag ``RTE_COMP_FF_MBUF_SCATTER_GATHER`` is
208 replaced with the following more explicit flags:
210 - ``RTE_COMP_FF_OOP_SGL_IN_SGL_OUT``
211 - ``RTE_COMP_FF_OOP_SGL_IN_LB_OUT``
212 - ``RTE_COMP_FF_OOP_LB_IN_SGL_OUT``
218 .. This section should contain ABI changes. Sample format:
220 * Add a short 1-2 sentence description of the ABI change
221 that was announced in the previous releases and made in this release.
222 Use fixed width quotes for ``function_names`` or ``struct_names``.
225 This section is a comment. Do not overwrite or remove it.
226 Also, make sure to start the actual text at the margin.
227 =========================================================
233 .. This section should contain removed items in this release. Sample format:
235 * Add a short 1-2 sentence description of the removed item
238 This section is a comment. Do not overwrite or remove it.
239 Also, make sure to start the actual text at the margin.
240 =========================================================
243 Shared Library Versions
244 -----------------------
246 .. Update any library version updated in this release
247 and prepend with a ``+`` sign, like this:
250 + librte_cfgfile.so.2
253 This section is a comment. Do not overwrite or remove it.
254 =========================================================
256 The libraries prepended with a plus sign were incremented in this version.
262 librte_bitratestats.so.2
265 librte_bus_fslmc.so.1
268 + librte_bus_vmbus.so.1
271 librte_common_octeontx.so.1
272 librte_compressdev.so.1
273 + librte_cryptodev.so.5
274 librte_distributor.so.1
276 + librte_ethdev.so.10
278 librte_flow_classify.so.1
286 librte_latencystats.so.1
289 + librte_mempool.so.5
299 librte_pmd_ixgbe.so.2
300 librte_pmd_dpaa2_cmdif.so.1
301 librte_pmd_dpaa2_qdma.so.1
303 librte_pmd_softnic.so.1
304 librte_pmd_vhost.so.2
320 .. This section should contain new known issues in this release. Sample format:
322 * **Add title in present tense with full stop.**
324 Add a short 1-2 sentence description of the known issue
325 in the present tense. Add information on any known workarounds.
327 This section is a comment. Do not overwrite or remove it.
328 Also, make sure to start the actual text at the margin.
329 =========================================================
335 .. This section should contain a list of platforms that were tested
340 * <vendor> platform with <vendor> <type of devices> combinations
345 * Other relevant details...
347 This section is a comment. Do not overwrite or remove it.
348 Also, make sure to start the actual text at the margin.
349 =========================================================
351 * Intel(R) platforms with Intel(R) NICs combinations
355 * Intel(R) Atom(TM) CPU C3858 @ 2.00GHz
356 * Intel(R) Xeon(R) CPU D-1541 @ 2.10GHz
357 * Intel(R) Xeon(R) CPU E5-4667 v3 @ 2.00GHz
358 * Intel(R) Xeon(R) CPU E5-2680 v2 @ 2.80GHz
359 * Intel(R) Xeon(R) CPU E5-2699 v4 @ 2.20GHz
360 * Intel(R) Xeon(R) CPU E5-2695 v4 @ 2.10GHz
361 * Intel(R) Xeon(R) CPU E5-2658 v2 @ 2.40GHz
362 * Intel(R) Xeon(R) CPU E5-2658 v3 @ 2.20GHz
363 * Intel(R) Xeon(R) Platinum 8180 CPU @ 2.50GHz
372 * Red Hat Enterprise Linux Server release 7.5
373 * SUSE Enterprise Linux 12
383 * Intel(R) 82599ES 10 Gigabit Ethernet Controller
385 * Firmware version: 0x61bf0001
386 * Device id (pf/vf): 8086:10fb / 8086:10ed
387 * Driver version: 5.2.3 (ixgbe)
389 * Intel(R) Corporation Ethernet Connection X552/X557-AT 10GBASE-T
391 * Firmware version: 0x800003e7
392 * Device id (pf/vf): 8086:15ad / 8086:15a8
393 * Driver version: 4.4.6 (ixgbe)
395 * Intel(R) Ethernet Converged Network Adapter X710-DA4 (4x10G)
397 * Firmware version: 6.01 0x80003221
398 * Device id (pf/vf): 8086:1572 / 8086:154c
399 * Driver version: 2.4.6 (i40e)
401 * Intel Corporation Ethernet Connection X722 for 10GbE SFP+ (4x10G)
403 * Firmware version: 3.33 0x80000fd5 0.0.0
404 * Device id (pf/vf): 8086:37d0 / 8086:37cd
405 * Driver version: 2.4.3 (i40e)
407 * Intel(R) Ethernet Converged Network Adapter XXV710-DA2 (2x25G)
409 * Firmware version: 6.01 0x80003221
410 * Device id (pf/vf): 8086:158b / 8086:154c
411 * Driver version: 2.4.6 (i40e)
413 * Intel(R) Ethernet Converged Network Adapter XL710-QDA2 (2X40G)
415 * Firmware version: 6.01 0x8000321c
416 * Device id (pf/vf): 8086:1583 / 8086:154c
417 * Driver version: 2.4.6 (i40e)
419 * Intel(R) Corporation I350 Gigabit Network Connection
421 * Firmware version: 1.63, 0x80000dda
422 * Device id (pf/vf): 8086:1521 / 8086:1520
423 * Driver version: 5.4.0-k (igb)
425 * Intel(R) platforms with Mellanox(R) NICs combinations
429 * Intel(R) Xeon(R) Gold 6154 CPU @ 3.00GHz
430 * Intel(R) Xeon(R) CPU E5-2697A v4 @ 2.60GHz
431 * Intel(R) Xeon(R) CPU E5-2697 v3 @ 2.60GHz
432 * Intel(R) Xeon(R) CPU E5-2680 v2 @ 2.80GHz
433 * Intel(R) Xeon(R) CPU E5-2650 v4 @ 2.20GHz
434 * Intel(R) Xeon(R) CPU E5-2640 @ 2.50GHz
435 * Intel(R) Xeon(R) CPU E5-2620 v4 @ 2.10GHz
439 * Red Hat Enterprise Linux Server release 7.5 (Maipo)
440 * Red Hat Enterprise Linux Server release 7.4 (Maipo)
441 * Red Hat Enterprise Linux Server release 7.3 (Maipo)
442 * Red Hat Enterprise Linux Server release 7.2 (Maipo)
446 * SUSE Linux Enterprise Server 15
448 * MLNX_OFED: 4.3-2.0.2.0
449 * MLNX_OFED: 4.4-2.0.1.0
453 * Mellanox(R) ConnectX(R)-3 Pro 40G MCX354A-FCC_Ax (2x40G)
455 * Host interface: PCI Express 3.0 x8
456 * Device ID: 15b3:1007
457 * Firmware version: 2.42.5000
459 * Mellanox(R) ConnectX(R)-4 10G MCX4111A-XCAT (1x10G)
461 * Host interface: PCI Express 3.0 x8
462 * Device ID: 15b3:1013
463 * Firmware version: 12.21.1000 and above
465 * Mellanox(R) ConnectX(R)-4 10G MCX4121A-XCAT (2x10G)
467 * Host interface: PCI Express 3.0 x8
468 * Device ID: 15b3:1013
469 * Firmware version: 12.21.1000 and above
471 * Mellanox(R) ConnectX(R)-4 25G MCX4111A-ACAT (1x25G)
473 * Host interface: PCI Express 3.0 x8
474 * Device ID: 15b3:1013
475 * Firmware version: 12.21.1000 and above
477 * Mellanox(R) ConnectX(R)-4 25G MCX4121A-ACAT (2x25G)
479 * Host interface: PCI Express 3.0 x8
480 * Device ID: 15b3:1013
481 * Firmware version: 12.21.1000 and above
483 * Mellanox(R) ConnectX(R)-4 40G MCX4131A-BCAT/MCX413A-BCAT (1x40G)
485 * Host interface: PCI Express 3.0 x8
486 * Device ID: 15b3:1013
487 * Firmware version: 12.21.1000 and above
489 * Mellanox(R) ConnectX(R)-4 40G MCX415A-BCAT (1x40G)
491 * Host interface: PCI Express 3.0 x16
492 * Device ID: 15b3:1013
493 * Firmware version: 12.21.1000 and above
495 * Mellanox(R) ConnectX(R)-4 50G MCX4131A-GCAT/MCX413A-GCAT (1x50G)
497 * Host interface: PCI Express 3.0 x8
498 * Device ID: 15b3:1013
499 * Firmware version: 12.21.1000 and above
501 * Mellanox(R) ConnectX(R)-4 50G MCX414A-BCAT (2x50G)
503 * Host interface: PCI Express 3.0 x8
504 * Device ID: 15b3:1013
505 * Firmware version: 12.21.1000 and above
507 * Mellanox(R) ConnectX(R)-4 50G MCX415A-GCAT/MCX416A-BCAT/MCX416A-GCAT (2x50G)
509 * Host interface: PCI Express 3.0 x16
510 * Device ID: 15b3:1013
511 * Firmware version: 12.21.1000 and above
512 * Firmware version: 12.21.1000 and above
514 * Mellanox(R) ConnectX(R)-4 50G MCX415A-CCAT (1x100G)
516 * Host interface: PCI Express 3.0 x16
517 * Device ID: 15b3:1013
518 * Firmware version: 12.21.1000 and above
520 * Mellanox(R) ConnectX(R)-4 100G MCX416A-CCAT (2x100G)
522 * Host interface: PCI Express 3.0 x16
523 * Device ID: 15b3:1013
524 * Firmware version: 12.21.1000 and above
526 * Mellanox(R) ConnectX(R)-4 Lx 10G MCX4121A-XCAT (2x10G)
528 * Host interface: PCI Express 3.0 x8
529 * Device ID: 15b3:1015
530 * Firmware version: 14.21.1000 and above
532 * Mellanox(R) ConnectX(R)-4 Lx 25G MCX4121A-ACAT (2x25G)
534 * Host interface: PCI Express 3.0 x8
535 * Device ID: 15b3:1015
536 * Firmware version: 14.21.1000 and above
538 * Mellanox(R) ConnectX(R)-5 100G MCX556A-ECAT (2x100G)
540 * Host interface: PCI Express 3.0 x16
541 * Device ID: 15b3:1017
542 * Firmware version: 16.21.1000 and above
544 * Mellanox(R) ConnectX-5 Ex EN 100G MCX516A-CDAT (2x100G)
546 * Host interface: PCI Express 4.0 x16
547 * Device ID: 15b3:1019
548 * Firmware version: 16.21.1000 and above
550 * ARM platforms with Mellanox(R) NICs combinations
554 * Qualcomm ARM 1.1 2500MHz
558 * Red Hat Enterprise Linux Server release 7.5 (Maipo)
562 * Mellanox(R) ConnectX(R)-4 Lx 25G MCX4121A-ACAT (2x25G)
564 * Host interface: PCI Express 3.0 x8
565 * Device ID: 15b3:1015
566 * Firmware version: 14.23.1000
568 * Mellanox(R) ConnectX(R)-5 100G MCX556A-ECAT (2x100G)
570 * Host interface: PCI Express 3.0 x16
571 * Device ID: 15b3:1017
572 * Firmware version: 16.23.1000
574 * Mellanox BlueField SmartNIC
576 * Mellanox(R) BlueField SmartNIC MT416842 (2x25G)
577 * Host interface: PCI Express 3.0 x16
578 * Device ID: 15b3:a2d2
579 * Firmware version: 18.99.3950
581 * SoC ARM cores running OS:
582 * CentOS Linux release 7.4.1708 (AltArch)
583 * Mellanox MLNX_OFED 4.2-1.4.21.0
585 * DPDK application running on ARM cores inside SmartNIC
586 * Bluefield representors support planned for next release.