Commit Graph

1855 Commits

Author SHA1 Message Date
Thomas Monjalon
48595b8d55 doc: adapt features tables header height
The length of the longest header name is used to adjust the padding
of the header row automatically, instead of fixed length.
The previous length (10) was too short for vdev_netvsc.

Fixes: 6086ab3bb3 ("net/vdev_netvsc: introduce Hyper-V platform driver")
Cc: stable@dpdk.org

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
2018-03-21 23:04:21 +01:00
Thomas Monjalon
18b884e9a9 doc: reduce features tables column width
The font size of the header row is reduced in order to shrink
the column size of the tables.
It is required for the NICs features table which is too large to fit
in the page width.

Cc: stable@dpdk.org

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
2018-03-21 23:04:21 +01:00
Cristian Dumitrescu
c06ddf9698 meter: add configuration profile
This patch adds support for meter configuration profiles.
Benefits: simplified configuration procedure, improved performance.

Q1: What is the configuration profile and why does it make sense?
A1: The configuration profile represents the set of configuration
    parameters for a given meter object, such as the rates and sizes for
    the token buckets. The configuration profile concept makes sense when
    many meter objects share the same configuration, which is the typical
    usage model: thousands of traffic flows are each individually metered
    according to just a few service levels (i.e. profiles).

Q2: How is the configuration profile improving the performance?
A2: The performance improvement is achieved by reducing the memory
    footprint of a meter object, which results in better cache utilization
    for the typical case when large arrays of meter objects are used. The
    internal data structures stored for each meter object contain:
       a) Constant fields: Low level translation of the configuration
          parameters that does not change post-configuration. This is
          really duplicated for all meters that use the same
          configuration. This is the configuration profile data that is
          moved away from the meter object. Current size (implementation
          dependent): srTCM = 32 bytes, trTCM = 32 bytes.
       b) Variable fields: Time stamps and running counters that change
          during the on-going traffic metering process. Current size
          (implementation dependent): srTCM = 24 bytes, trTCM = 32 bytes.
          Therefore, by moving the constant fields to a separate profile
          data structure shared by all the meters with the same
          configuration, the size of the meter object is reduced by ~50%.

Signed-off-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com>
Signed-off-by: Jasvinder Singh <jasvinder.singh@intel.com>
2018-02-19 22:28:05 +01:00
John McNamara
8249acf424 doc: add template release notes for 18.05
Add template release notes for DPDK 18.05 with inline
comments and explanations of the various sections.

Signed-off-by: John McNamara <john.mcnamara@intel.com>
Acked-by: Erik Gabriel Carrillo <erik.g.carrillo@intel.com>
2018-02-19 21:54:14 +01:00
John McNamara
acf5c976bb doc: update release notes for 18.02
Fix grammar, spelling and formatting of DPDK 18.02 release notes.

Signed-off-by: John McNamara <john.mcnamara@intel.com>
2018-02-14 19:01:26 +01:00
Xiao Wang
7f012f707f doc: add virtio guest announce support to release notes
Signed-off-by: Xiao Wang <xiao.w.wang@intel.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
2018-02-14 18:58:47 +01:00
Raslan Darawsheh
d0d7ad6119 doc: add tested platforms with Mellanox NICs
Signed-off-by: Raslan Darawsheh <rasland@mellanox.com>
2018-02-14 18:52:31 +01:00
Pablo de Lara
d429cc0b53 doc: fix outdated link to IPsec white paper
Fixes: 924e84f873 ("aesni_mb: add driver for multi buffer based crypto")
Cc: stable@dpdk.org

Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
2018-02-14 18:43:12 +01:00
Harry van Haaren
e4f113761d doc: remove reference to old distro in Linux guide
Remove reference to Fedora 18 which is EOL-ed, reword
surrounding sentences to read correctly.

Signed-off-by: Harry van Haaren <harry.van.haaren@intel.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
2018-02-14 18:35:18 +01:00
Ferruh Yigit
1d81d4f2a6 doc: announce ethdev API fix for port id size
Fix rte_eth_dev_get_sec_ctx() parameter port_id storage size,
from uint8_t to uint16_t.

Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
Acked-by: Radu Nicolau <radu.nicolau@intel.com>
Acked-by: Hemant Agrawal <hemant.agrawal@nxp.com>
Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
2018-02-14 18:31:14 +01:00
Kirill Rybalchenko
bdc9bb9b62 doc: announce ethdev ABI change for filter structs
Signed-off-by: Kirill Rybalchenko <kirill.rybalchenko@intel.com>
Acked-by: Marko Kovacevic <marko.kovacevic@intel.com>
Acked-by: Neil Horman <nhorman@tuxdriver.com>
Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
Acked-by: Olivier Matz <olivier.matz@6wind.com>
Acked-by: Thomas Monjalon <thomas@monjalon.net>
2018-02-14 18:30:22 +01:00
Ferruh Yigit
768ac8d452 doc: announce ethdev API changes for callbacks
Ethdev APIs to add callback return the callback object as "void *",
update return type to actual object type
"struct rte_eth_rxtx_callback *"

Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
Acked-by: Hemant Agrawal <hemant.agrawal@nxp.com>
2018-02-14 18:29:04 +01:00
Olivier Matz
16a7009aee doc: announce ethdev API change for default MAC
Announce internal PMD API change in the function to set the default MAC
address. The objective is to be able to notify errors occurring in the
PMD.

Link: https://dpdk.org/dev/patchwork/patch/32284/

Signed-off-by: Olivier Matz <olivier.matz@6wind.com>
Acked-by: Andrew Rybchenko <arybchenko@solarflare.com>
Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
Acked-by: Shahaf Shuler <shahafs@mellanox.com>
Acked-by: Thomas Monjalon <thomas@monjalon.net>
2018-02-14 18:27:41 +01:00
Shahaf Shuler
6790f48e66 doc: announce ethdev API change for VF representors
This is following the RFC being discussed and targets 18.05

http://dpdk.org/ml/archives/dev/2018-January/085716.html

Signed-off-by: Shahaf Shuler <shahafs@mellanox.com>
Acked-by: Thomas Monjalon <thomas@monjalon.net>
Acked-by: Declan Doherty <declan.doherty@intel.com>
Acked-by: Remy Horton <remy.horton@intel.com>
Acked-by: Luca Boccassi <luca.boccassi@intl.att.com>
Acked-by: Alex Zelezniak <alexz@att.com>
Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
2018-02-14 18:27:41 +01:00
Shreyansh Jain
0ab44211c7 doc: announce ethdev API change for preferred burst size
rte_eth_rx_burst(..,nb_pkts) function has semantic that if return value
is smaller than requested, application can consider it end of packet
stream. Some hardware can only support smaller burst sizes which need
to be advertised. Similar is the case for Tx burst.

This patch adds deprecation notice for rte_eth_dev_info structure as
new members, for preferred Rx and Tx burst and ring size would be
added - impacting the size of the structure.

Signed-off-by: Shreyansh Jain <shreyansh.jain@nxp.com>
Acked-by: Hemant Agrawal <hemant.agrawal@nxp.com>
Acked-by: Andrew Rybchenko <arybchenko@solarflare.com>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
Acked-by: Zhiyong Yang <zhiyong.yang@intel.com>
Acked-by: Thomas Monjalon <thomas@monjalon.net>
2018-02-14 18:27:41 +01:00
Xueming Li
676b605182 doc: announce ethdev API change for RSS configuration
Update deprecation notice for the new rss_level field of
rte_eth_rss_conf.

Link: http://www.dpdk.org/dev/patchwork/patch/31891

Signed-off-by: Xueming Li <xuemingl@mellanox.com>
Acked-by: Shahaf Shuler <shahafs@mellanox.com>
Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
2018-02-14 18:27:41 +01:00
Cristian Dumitrescu
a098c4702c doc: announce mbuf sched field change
Signed-off-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com>
Acked-by: Jasvinder Singh <jasvinder.singh@intel.com>
Acked-by: Fan Zhang <roy.fan.zhang@intel.com>
Acked-by: Kevin Laatz <kevin.laatz@intel.com>
Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
Acked-by: Hemant Agrawal <hemant.agrawal@nxp.com>
Acked-by: Olivier Matz <olivier.matz@6wind.com>
2018-02-14 18:27:36 +01:00
Olivier Matz
d555d46d0a doc: announce control mbuf removal
Link: http://dpdk.org/ml/archives/dev/2017-July/069813.html
Link: http://dpdk.org/dev/patchwork/patch/32041/

Signed-off-by: Olivier Matz <olivier.matz@6wind.com>
Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
Acked-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
Acked-by: Hemant Agrawal <hemant.agrawal@nxp.com>
Acked-by: Thomas Monjalon <thomas@monjalon.net>
2018-02-14 16:36:44 +01:00
Andrew Rybchenko
c96caf64c2 doc: announce mempool API changes
An API/ABI changes are planned for 18.05 [1]:

 * Allow to customize how mempool objects are stored in memory.
 * Deprecate mempool XMEM API.
 * Add mempool driver ops to get information from mempool driver and
   dequeue contiguous blocks of objects if driver supports it.

[1] http://dpdk.org/ml/archives/dev/2018-January/088698.html

Signed-off-by: Andrew Rybchenko <arybchenko@solarflare.com>
Acked-by: Olivier Matz <olivier.matz@6wind.com>
Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
Acked-by: Hemant Agrawal <hemant.agrawal@nxp.com>
2018-02-14 16:32:00 +01:00
Hemant Agrawal
74915174b4 doc: announce EAL function removal for default mempool
Signed-off-by: Hemant Agrawal <hemant.agrawal@nxp.com>
Acked-by: Olivier Matz <olivier.matz@6wind.com>
Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
2018-02-14 16:32:00 +01:00
Anatoly Burakov
01dad51115 doc: announce memory hotplug changes
Due to coming changes outlined in memory hotplug RFC, there will
be several API/ABI changes.

Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
Acked-by: Jonas Pfefferle <pepperjo@japf.ch>
Acked-by: Yongseok Koh <yskoh@mellanox.com>
2018-02-14 16:32:00 +01:00
Anatoly Burakov
12639dcc05 doc: announce EAL ABI change for NUMA node count
There will be a new function added in v18.05 that will return
number of detected sockets, which will change the ABI.

Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
Acked-by: Jonas Pfefferle <pepperjo@japf.ch>
Acked-by: Thomas Monjalon <thomas@monjalon.net>
2018-02-14 16:32:00 +01:00
Erik Gabriel Carrillo
064518f68d doc: announce EAL API change to lcore role function
This an API/ABI change notice for DPDK 18.05 announcing a change in
the meaning of the return values of the rte_lcore_has_role() function.

Signed-off-by: Erik Gabriel Carrillo <erik.g.carrillo@intel.com>
Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
Acked-by: Harry van Haaren <harry.van.haaren@intel.com>
Acked-by: Pavan Nikhilesh <pbhagavatula@caviumnetworks.com>
Acked-by: Thomas Monjalon <thomas@monjalon.net>
2018-02-14 16:32:00 +01:00
Gaetan Rivet
66226f28e1 doc: update deprecation notice for devargs
The declaration and identification of devices will change in v18.05.

Remove the precedent deprecation notice.

Add new one reflecting the planned changes more accurately,
updated for v18.05.

Signed-off-by: Gaetan Rivet <gaetan.rivet@6wind.com>
Acked-by: Shreyansh Jain <shreyansh.jain@nxp.com>
Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
Acked-by: Thomas Monjalon <thomas@monjalon.net>
2018-02-14 16:32:00 +01:00
Ciara Power
3a99ac9d62 doc: add maintainers section to the contributors guide
Add a maintainers section to the contributors guide to have a low tech
location to check/link to the current maintainers. This file is included
dynamically from the MAINTAINERS file in the root directory of the DPDK
source when the docs are built. This also allows us to link to the file
from other sections of the docs.

Signed-off-by: Ciara Power <ciara.power@intel.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
2018-02-14 00:23:25 +01:00
Thomas Monjalon
f41989c8c0 doc: improve HTML spacing in release notes
Vertical spacing is lower before an item title than after.
So the items with paragraphs are not well separated.

A custom CSS is added to override the rtd theme.

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
Acked-by: John McNamara <john.mcnamara@intel.com>
2018-02-14 00:23:25 +01:00
Jiayu Hu
b18ec9a03a doc: add vhost live migration features to release notes
Signed-off-by: Jiayu Hu <jiayu.hu@intel.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
2018-02-14 00:10:58 +01:00
Jiayu Hu
cef5d0a474 doc: add VxLAN GRO to release notes
Signed-off-by: Jiayu Hu <jiayu.hu@intel.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
2018-02-14 00:08:31 +01:00
Vipin Varghese
16126326b3 doc: add note for shared library in NICs guide
Add note information to intimate about use of option '-d' for shared
library in DPDK application.

Signed-off-by: Vipin Varghese <vipin.varghese@intel.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
2018-02-13 23:59:00 +01:00
Matan Azrad
4521540c38 doc: remove jumbo frames entry from tap features
The current implementation of the Tap PMD doesn't support packet size
grater than 1522B, so no need to set jumbo frames in the Tap features.

Fixes: 04b2c3c943 ("doc: add tap features")
Cc: stable@dpdk.org

Signed-off-by: Matan Azrad <matan@mellanox.com>
Acked-by: Pascal Mazon <pascal.mazon@6wind.com>
2018-02-13 18:17:30 +01:00
Andrew Rybchenko
3a05ad785c doc: add missing SFN8xxx adapters in sfc guide
Signed-off-by: Andrew Rybchenko <arybchenko@solarflare.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
2018-02-13 18:17:30 +01:00
Jingjing Wu
c721648d95 doc: update Intel VF guide
update for intel VF usage:
 - Add note for AVF device ID generation.
 - Add steps for vfio-pci pass through.

Signed-off-by: Jingjing Wu <jingjing.wu@intel.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
2018-02-13 18:17:30 +01:00
Alejandro Lucero
311d70dc5b doc: rename nfp PF features file
Other NICs with VF support do not use the _pf suffix for these files
but just for the VF description.

This change makes NFP files consistent in this regard and helps with
how the DPDK web nics features matrix shows NFP devices.

Signed-off-by: Alejandro Lucero <alejandro.lucero@netronome.com>
2018-02-13 18:17:30 +01:00
Yulong Pei
b8f0742394 doc: add tested Intel platforms with Intel NICs
Add tested Intel platforms with Intel NICs to the release note.

Signed-off-by: Yulong Pei <yulong.pei@intel.com>
2018-02-08 23:18:13 +01:00
John McNamara
5ae9d5299a doc: add increased default ring size to release notes
Added note on the increased ring size in testpmd and the sample
applications to the release note.

Fixes: bd8f10f6d6 ("app/testpmd: increase default ring sizes to 1024")
Fixes: 867a6c66ec ("examples: increase default ring sizes to 1024")

Signed-off-by: John McNamara <john.mcnamara@intel.com>
Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
2018-02-08 23:11:28 +01:00
Marko Kovacevic
bacf34762a doc: update limitations in procinfo guide
Updated the limitations for dpdk-procinfo
to inform user of the proper use. To avoid
failures and build issues

Signed-off-by: Marko Kovacevic <marko.kovacevic@intel.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
2018-02-08 23:06:37 +01:00
Bao-Long Tran
acd10628a6 doc: update callback functions in pipeline sample guide
Update f_post_init for pipeline frontend.
Move f_track from pipeline backend to pipeline frontend.

Signed-off-by: Bao-Long Tran <longtb5@viettel.com.vn>
Acked-by: Marko Kovacevic <marko.kovacevic@intel.com>
2018-02-08 22:54:09 +01:00
Anoob Joseph
fa9088849e examples/ipsec-secgw: support AES 256
Adding support for AES 256 algorithm in ipsec-secgw application

Signed-off-by: Anoob Joseph <anoob.joseph@caviumnetworks.com>
Acked-by: Radu Nicolau <radu.nicolau@intel.com>
2018-02-08 22:31:17 +01:00
Ophir Munk
6a2a61d95f doc: add systems support in tap guide
Signed-off-by: Ophir Munk <ophirmu@mellanox.com>
Acked-by: Pascal Mazon <pascal.mazon@6wind.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
2018-02-08 19:02:14 +01:00
Shahaf Shuler
282da936f9 net/mlx5: revert support of IPv4 time-to-live filter
Neither upstream kernel nor MLNX_OFED support such filter.
There is no point announcing this feature.

Reverts commit 0fb2c9842b ("net/mlx5: support IPv4 time-to-live filter")

Fixes: 0fb2c9842b ("net/mlx5: support IPv4 time-to-live filter")

Signed-off-by: Shahaf Shuler <shahafs@mellanox.com>
Acked-by: Nelio Laranjeiro <nelio.laranjeiro@6wind.com>
2018-02-08 18:42:14 +01:00
Wei Zhao
d2bc8f4d45 doc: add igb guide
This patch adds user guide specifically for igb NIC, like ixgbe,
to list all the supported features and known issues.

Signed-off-by: Wei Zhao <wei.zhao1@intel.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
2018-02-08 18:42:14 +01:00
Ajit Khaparde
a0f5e47267 doc: update bnxt feature list
Updating bnxt.ini file.

Signed-off-by: Ajit Khaparde <ajit.khaparde@broadcom.com>
2018-02-08 14:13:18 +01:00
Beilei Xing
68d35933a9 doc: add multi-driver option in i40e guide
This patch updates the i40e guide with new device parameter of
'support-multi-driver'.

Signed-off-by: Beilei Xing <beilei.xing@intel.com>
Acked-by: Marko Kovacevic <marko.kovacevic@intel.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
2018-02-08 12:39:58 +01:00
Ferruh Yigit
5be776dfa9 doc: convert Intel sharing license header to SPDX tag
Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
Acked-by: Marko Kovacevic <marko.kovacevic@intel.com>
Acked-by: Thomas Monjalon <thomas@monjalon.net>
2018-02-06 23:36:35 +01:00
Ferruh Yigit
5630257fcc doc: convert Intel license headers to SPDX tags
Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
2018-02-06 23:27:08 +01:00
Anatoly Burakov
0572343172 doc: remove UTF-8 BOM from membership guide
Fixes: 55694b2a9f ("doc: add membership documentation")
Cc: stable@dpdk.org

Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
Acked-by: Marko Kovacevic <marko.kovacevic@intel.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
2018-02-06 22:29:26 +01:00
David Hunt
d9e71f5227 doc: add hyperthreading note to power library guide
Signed-off-by: David Hunt <david.hunt@intel.com>
Acked-by: Marko Kovacevic <marko.kovacevic@intel.com>
2018-02-06 22:29:26 +01:00
Vipin Varghese
c149818b0e doc: add note on multiple crypto vdevs
Add information to explain applications using multiple instances of sw
crypto with example.

Signed-off-by: Vipin Varghese <vipin.varghese@intel.com>
Acked-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
2018-02-06 22:29:26 +01:00
Vipin Varghese
10b9d471a6 doc: update minimum requirement of l2fwd-crypto
Added note section to update information for use cases working with
multiple crypto devices.

Signed-off-by: Vipin Varghese <vipin.varghese@intel.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
Acked-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
2018-02-06 22:29:26 +01:00
Shreyansh Jain
4ce5b14ac9 doc: fix release note for rawdev library
'+' sign was missing from librawdev library which is added
in this release.

Fixes: a9bb0c44c7 ("doc: add rawdev library guide and doxygen page")

Signed-off-by: Shreyansh Jain <shreyansh.jain@nxp.com>
Acked-by: Marko Kovacevic <marko.kovacevic@intel.com>
2018-02-06 17:35:53 +01:00