X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Frel_notes%2Frelease_18_08.rst;h=314723f1e0834fb94387c5d7fbe369c09e78f55a;hb=60229dcfc4301ce6051b0b1691743e1eff2a0fb1;hp=cbdf2d94a8ef7f3108ab0090e9f297c595a5b78c;hpb=83a8a143bba5e05bd9cb9b44f949611df60dfa3c;p=dpdk.git diff --git a/doc/guides/rel_notes/release_18_08.rst b/doc/guides/rel_notes/release_18_08.rst index cbdf2d94a8..314723f1e0 100644 --- a/doc/guides/rel_notes/release_18_08.rst +++ b/doc/guides/rel_notes/release_18_08.rst @@ -1,46 +1,12 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright 2018 The DPDK contributors + DPDK Release 18.08 ================== -.. **Read this first.** - - The text in the sections below explains how to update the release notes. - - Use proper spelling, capitalization and punctuation in all sections. - - Variable and config names should be quoted as fixed width text: - ``LIKE_THIS``. - - Build the docs and view the output file to ensure the changes are correct:: - - make doc-guides-html - - xdg-open build/doc/html/guides/rel_notes/release_18_08.html - - New Features ------------ -.. This section should contain new features added in this release. - Sample format: - - * **Add a title in the past tense with a full stop.** - - Add a short 1-2 sentence description in the past tense. - The description should be enough to allow someone scanning - the release notes to understand the new feature. - - If the feature adds a lot of sub-features you can use a bullet list - like this: - - * Added feature foo to do something. - * Enhanced feature bar to do something else. - - Refer to the previous release notes for examples. - - This section is a comment. Do not overwrite or remove it. - Also, make sure to start the actual text at the margin. - ========================================================= - * **Added support for Hyper-V netvsc PMD.** The new ``netvsc`` poll mode driver provides native support for @@ -51,6 +17,7 @@ New Features Flow API support has been added to CXGBE Poll Mode Driver to offload flows to Chelsio T5/T6 NICs. Support added for: + * Wildcard (LE-TCAM) and Exact (HASH) match filters. * Match items: physical ingress port, IPv4, IPv6, TCP and UDP. * Action items: queue, drop, count, and physical egress port redirect. @@ -65,8 +32,8 @@ New Features * **Added descriptor status check support for fm10k.** - ``rte_eth_rx_descritpr_status`` and ``rte_eth_tx_descriptor_status`` - are supported by fm10K. + The ``rte_eth_rx_descriptor_status`` and ``rte_eth_tx_descriptor_status`` + APIs are now supported by fm10K. * **Updated the enic driver.** @@ -82,20 +49,20 @@ New Features * Added port representors support. * Added Flow API support for e-switch rules. - Supported ACTION_PORT_ID, ACTION_DROP, ACTION_OF_POP_VLAN, + Added support for ACTION_PORT_ID, ACTION_DROP, ACTION_OF_POP_VLAN, ACTION_OF_PUSH_VLAN, ACTION_OF_SET_VLAN_VID, ACTION_OF_SET_VLAN_PCP and ITEM_PORT_ID. - * Supported 32-bit compilation. + * Added support for 32-bit compilation. -* **Added TSO support for mlx4 driver.** +* **Added TSO support for the mlx4 driver.** - The support is from MLNX_OFED_4.4 and above. + Added TSO support for the mlx4 drivers from MLNX_OFED_4.4 and above. * **SoftNIC PMD rework.** - The SoftNIC PMD infrastructure is restructured to use the Packet Framework, - which makes it more flexible, modular and easier to add new functionality - in future. + The SoftNIC PMD infrastructure has been restructured to use the Packet + Framework, which makes it more flexible, modular and easier to add new + functionality in the future. * **Updated the AESNI MB PMD.** @@ -117,18 +84,8 @@ New Features API Changes ----------- -.. This section should contain API changes. Sample format: - - * Add a short 1-2 sentence description of the API change. - Use fixed width quotes for ``function_names`` or ``struct_names``. - Use the past tense. - - This section is a comment. Do not overwrite or remove it. - Also, make sure to start the actual text at the margin. - ========================================================= - -* Path to runtime config file has changed. The new path is determined as - follows: +* The path to the runtime config file has changed. The new path is determined + as follows: - If DPDK is running as root, ``/var/run/dpdk//config`` - If DPDK is not running as root: @@ -161,24 +118,26 @@ API Changes - ``rte_eth_conf.rxmode.ignore_offload_bitfield`` - ``ETH_TXQ_FLAGS_IGNORE`` -* cryptodev: In struct ``struct rte_cryptodev_info``, field ``rte_pci_device *pci_dev`` - has been replaced with field ``struct rte_device *device``. - Value 0 is accepted in ``sym.max_nb_sessions``, meaning that a device - supports an unlimited number of sessions. - Two new fields of type ``uint16_t`` have been added: - ``min_mbuf_headroom_req`` and ``min_mbuf_tailroom_req``. - These parameters specify the recommended headroom and tailroom for mbufs - to be processed by the PMD. +* cryptodev: The following API changes have been made in 18.08: + + - In struct ``struct rte_cryptodev_info``, field ``rte_pci_device *pci_dev`` + has been replaced with field ``struct rte_device *device``. + - Value 0 is accepted in ``sym.max_nb_sessions``, meaning that a device + supports an unlimited number of sessions. + - Two new fields of type ``uint16_t`` have been added: + ``min_mbuf_headroom_req`` and ``min_mbuf_tailroom_req``. These parameters + specify the recommended headroom and tailroom for mbufs to be processed by + the PMD. -* cryptodev: Following functions were deprecated and are removed in 18.08: +* cryptodev: The following functions were deprecated and are removed in 18.08: - ``rte_cryptodev_queue_pair_start`` - ``rte_cryptodev_queue_pair_stop`` - ``rte_cryptodev_queue_pair_attach_sym_session`` - ``rte_cryptodev_queue_pair_detach_sym_session`` -* cryptodev: Following functions were deprecated and are replaced by - other functions in 18.08: +* cryptodev: The following functions were deprecated and are replaced by other + functions in 18.08: - ``rte_cryptodev_get_header_session_size`` is replaced with ``rte_cryptodev_sym_get_header_session_size`` @@ -212,47 +171,9 @@ API Changes - ``RTE_COMP_FF_OOP_LB_IN_SGL_OUT`` -ABI Changes ------------ - -.. This section should contain ABI changes. Sample format: - - * Add a short 1-2 sentence description of the ABI change - that was announced in the previous releases and made in this release. - Use fixed width quotes for ``function_names`` or ``struct_names``. - Use the past tense. - - This section is a comment. Do not overwrite or remove it. - Also, make sure to start the actual text at the margin. - ========================================================= - - -Removed Items -------------- - -.. This section should contain removed items in this release. Sample format: - - * Add a short 1-2 sentence description of the removed item - in the past tense. - - This section is a comment. Do not overwrite or remove it. - Also, make sure to start the actual text at the margin. - ========================================================= - - Shared Library Versions ----------------------- -.. Update any library version updated in this release - and prepend with a ``+`` sign, like this: - - librte_acl.so.2 - + librte_cfgfile.so.2 - librte_cmdline.so.2 - - This section is a comment. Do not overwrite or remove it. - ========================================================= - The libraries prepended with a plus sign were incremented in this version. .. code-block:: diff @@ -274,7 +195,7 @@ The libraries prepended with a plus sign were incremented in this version. librte_distributor.so.1 + librte_eal.so.8 + librte_ethdev.so.10 - librte_eventdev.so.4 + + librte_eventdev.so.5 librte_flow_classify.so.1 librte_gro.so.1 librte_gso.so.1 @@ -314,40 +235,9 @@ The libraries prepended with a plus sign were incremented in this version. librte_vhost.so.3 -Known Issues ------------- - -.. This section should contain new known issues in this release. Sample format: - - * **Add title in present tense with full stop.** - - Add a short 1-2 sentence description of the known issue - in the present tense. Add information on any known workarounds. - - This section is a comment. Do not overwrite or remove it. - Also, make sure to start the actual text at the margin. - ========================================================= - - Tested Platforms ---------------- -.. This section should contain a list of platforms that were tested - with this release. - - The format is: - - * platform with combinations - - * List of CPU - * List of OS - * List of devices - * Other relevant details... - - This section is a comment. Do not overwrite or remove it. - Also, make sure to start the actual text at the margin. - ========================================================= - * Intel(R) platforms with Intel(R) NICs combinations * CPU @@ -583,4 +473,4 @@ Tested Platforms * Mellanox MLNX_OFED 4.2-1.4.21.0 * DPDK application running on ARM cores inside SmartNIC - * Bluefield representors support planned for next release. + * BlueField representors support planned for next release.