31d4210971
Document all supported NICs. Add Intel I219 NICs support in release note. Signed-off-by: Wenzhuo Lu <wenzhuo.lu@intel.com>
295 lines
8.4 KiB
ReStructuredText
295 lines
8.4 KiB
ReStructuredText
DPDK Release 17.02
|
|
==================
|
|
|
|
.. **Read this first.**
|
|
|
|
The text 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
|
|
|
|
firefox build/doc/html/guides/rel_notes/release_17_02.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 generic flow API (rte_flow).**
|
|
|
|
This API provides a generic means to configure hardware to match specific
|
|
ingress or egress traffic, alter its fate and query related counters
|
|
according to any number of user-defined rules.
|
|
|
|
It is slightly higher-level than the legacy filtering framework which it
|
|
encompasses and supersedes (including all functions and filter types) in
|
|
order to expose a single interface with an unambiguous behavior that is
|
|
common to all poll-mode drivers (PMDs).
|
|
|
|
See the :ref:`Generic flow API <Generic_flow_API>` documentation for more
|
|
information.
|
|
|
|
* **Added firmware version get API.**
|
|
|
|
Added a new function ``rte_eth_dev_fw_version_get()`` to fetch firmware
|
|
version by a given device.
|
|
|
|
* **Added APIs for MACsec offload support to the ixgbe PMD.**
|
|
|
|
Six new APIs have been added to the ixgbe PMD for MACsec offload support.
|
|
The declarations for the APIs can be found in ``rte_pmd_ixgbe.h``.
|
|
|
|
* **Added I219 NICs support.**
|
|
|
|
Added support for I219 Intel 1GbE NICs.
|
|
|
|
* **virtio-user with vhost-kernel as another exceptional path.**
|
|
|
|
Previously, we upstreamed a virtual device, virtio-user with vhost-user
|
|
as the backend, as a way for IPC (Inter-Process Communication) and user
|
|
space container networking.
|
|
|
|
Virtio-user with vhost-kernel as the backend is a solution for exceptional
|
|
path, such as KNI, which exchanges packets with kernel networking stack.
|
|
This solution is very promising in:
|
|
|
|
* maintenance: vhost and vhost-net (kernel) is upstreamed and extensively
|
|
used kernel module.
|
|
* features: vhost-net is born to be a networking solution, which has
|
|
lots of networking related features, like multi-queue, TSO, multi-seg
|
|
mbuf, etc.
|
|
* performance: similar to KNI, this solution would use one or more
|
|
kthreads to send/receive packets from user space DPDK applications,
|
|
which has little impact on user space polling thread (except that
|
|
it might enter into kernel space to wake up those kthreads if
|
|
necessary).
|
|
|
|
* **Added virtio Rx interrupt suppprt.**
|
|
|
|
This feature enables Rx interrupt mode for virtio pci net devices as
|
|
binded to VFIO (noiommu mode) and drived by virtio PMD.
|
|
|
|
With this feature, virtio PMD can switch between polling mode and
|
|
interrupt mode, to achieve best performance, and at the same time save
|
|
power. It can work on both legacy and modern virtio devices. At this mode,
|
|
each rxq is mapped with an exluded MSIx interrupt.
|
|
|
|
See the :ref:`Virtio Interrupt Mode <virtio_interrupt_mode>` documentation
|
|
for more information.
|
|
|
|
|
|
Resolved Issues
|
|
---------------
|
|
|
|
.. This section should contain bug fixes added to the relevant sections. Sample format:
|
|
|
|
* **code/section Fixed issue in the past tense with a full stop.**
|
|
|
|
Add a short 1-2 sentence description of the resolved issue in the past tense.
|
|
The title should contain the code/lib section like a commit message.
|
|
Add the entries in alphabetic order in the relevant sections below.
|
|
|
|
This section is a comment. do not overwrite or remove it.
|
|
Also, make sure to start the actual text at the margin.
|
|
=========================================================
|
|
|
|
|
|
EAL
|
|
~~~
|
|
|
|
|
|
Drivers
|
|
~~~~~~~
|
|
|
|
* **net/virtio: Fixed multiple process support.**
|
|
|
|
Fixed few regressions introduced in recent releases that break the virtio
|
|
multiple process support.
|
|
|
|
|
|
Libraries
|
|
~~~~~~~~~
|
|
|
|
|
|
Examples
|
|
~~~~~~~~
|
|
|
|
* **examples/ethtool: Fixed crash with non-PCI devices.**
|
|
|
|
Querying a non-PCI device was dereferencing non-existent PCI data
|
|
resulting in a segmentation fault.
|
|
|
|
|
|
Other
|
|
~~~~~
|
|
|
|
|
|
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.
|
|
=========================================================
|
|
|
|
|
|
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 ``rte_function_names`` or ``rte_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.
|
|
=========================================================
|
|
|
|
|
|
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
|
|
``rte_function_names`` or ``rte_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.
|
|
=========================================================
|
|
|
|
|
|
|
|
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
|
|
|
|
librte_acl.so.2
|
|
librte_cfgfile.so.2
|
|
librte_cmdline.so.2
|
|
librte_cryptodev.so.2
|
|
librte_distributor.so.1
|
|
librte_eal.so.3
|
|
librte_ethdev.so.5
|
|
librte_hash.so.2
|
|
librte_ip_frag.so.1
|
|
librte_jobstats.so.1
|
|
librte_kni.so.2
|
|
librte_kvargs.so.1
|
|
librte_lpm.so.2
|
|
librte_mbuf.so.2
|
|
librte_mempool.so.2
|
|
librte_meter.so.1
|
|
librte_net.so.1
|
|
librte_pdump.so.1
|
|
librte_pipeline.so.3
|
|
librte_pmd_bond.so.1
|
|
librte_pmd_ring.so.2
|
|
librte_port.so.3
|
|
librte_power.so.1
|
|
librte_reorder.so.1
|
|
librte_ring.so.1
|
|
librte_sched.so.1
|
|
librte_table.so.2
|
|
librte_timer.so.1
|
|
librte_vhost.so.3
|
|
|
|
|
|
Tested Platforms
|
|
----------------
|
|
|
|
.. This section should contain a list of platforms that were tested with this release.
|
|
|
|
The format is:
|
|
|
|
#. Platform name.
|
|
|
|
* Platform details.
|
|
* Platform details.
|
|
|
|
This section is a comment. do not overwrite or remove it.
|
|
Also, make sure to start the actual text at the margin.
|
|
=========================================================
|
|
|
|
|
|
Tested NICs
|
|
-----------
|
|
|
|
.. This section should contain a list of NICs that were tested with this release.
|
|
|
|
The format is:
|
|
|
|
#. NIC name.
|
|
|
|
* NIC details.
|
|
* NIC details.
|
|
|
|
This section is a comment. do not overwrite or remove it.
|
|
Also, make sure to start the actual text at the margin.
|
|
=========================================================
|
|
|
|
|
|
Tested OSes
|
|
-----------
|
|
|
|
.. This section should contain a list of OSes that were tested with this release.
|
|
The format is as follows, in alphabetical order:
|
|
|
|
* CentOS 7.0
|
|
* Fedora 23
|
|
* Fedora 24
|
|
* FreeBSD 10.3
|
|
* Red Hat Enterprise Linux 7.2
|
|
* SUSE Enterprise Linux 12
|
|
* Ubuntu 15.10
|
|
* Ubuntu 16.04 LTS
|
|
* Wind River Linux 8
|
|
|
|
This section is a comment. do not overwrite or remove it.
|
|
Also, make sure to start the actual text at the margin.
|
|
=========================================================
|