numam-dpdk/doc/guides/rel_notes/release_16_04.rst

144 lines
3.3 KiB
ReStructuredText
Raw Normal View History

DPDK Release 16.04
==================
**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_16_04.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.
virtio: support specification 1.0 Modern (v1.0) virtio pci device defines several pci capabilities. Each cap has a configure structure corresponding to it, and the cap.bar and cap.offset fields tell us where to find it. Firstly, we map the pci resources by rte_eal_pci_map_device(). We then could easily locate a cfg structure by: cfg_addr = dev->mem_resources[cap.bar].addr + cap.offset; Therefore, the entrance of enabling modern (v1.0) pci device support is to iterate the pci capability lists, and to locate some configs we care; and they are: - common cfg For generic virtio and virtqueue configuration, such as setting/getting features, enabling a specific queue, and so on. - nofity cfg Combining with `queue_notify_off' from common cfg, we could use it to notify a specific virt queue. - device cfg Where virtio_net_config structure is located. - isr cfg Where to read isr (interrupt status). If any of above cap is not found, we fallback to the legacy virtio handling. If succeed, hw->vtpci_ops is assigned to modern_ops, where all operations are implemented by reading/writing a (or few) specific configuration space from above 4 cfg structures. And that's basically how this patch works. Besides those changes, virtio 1.0 introduces a new status field: FEATURES_OK, which is set after features negotiation is done. Last, set the VIRTIO_F_VERSION_1 feature flag. Signed-off-by: Yuanhan Liu <yuanhan.liu@linux.intel.com> Tested-by: Qian Xu <qian.q.xu@intel.com> Reviewed-by: Tetsuya Mukawa <mukawa@igel.co.jp> Tested-by: Tetsuya Mukawa <mukawa@igel.co.jp> Acked-by: Huawei Xie <huawei.xie@intel.com>
2016-02-02 13:48:19 +00:00
* **Virtio 1.0.**
Enabled virtio 1.0 support for virtio pmd driver.
* **Supported virtio offload in vhost-user.**
Add the offload of checksum and TSO between vhost-user and
vanilla Linux virtio guest.
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.
EAL
~~~
Drivers
~~~~~~~
Libraries
~~~~~~~~~
Examples
~~~~~~~~
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.
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.
ABI Changes
-----------
* 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.
Shared Library Versions
-----------------------
Update any library version updated in this release and prepend with a ``+`` sign.
The libraries prepended with a plus sign were incremented in this version.
.. code-block:: diff
libethdev.so.2
librte_acl.so.2
librte_cfgfile.so.2
librte_cmdline.so.1
librte_distributor.so.1
librte_eal.so.2
librte_hash.so.2
librte_ip_frag.so.1
librte_ivshmem.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.1
librte_meter.so.1
librte_pipeline.so.2
librte_pmd_bond.so.1
librte_pmd_ring.so.2
librte_port.so.2
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.2