summaryrefslogtreecommitdiff
path: root/doc/guides/nics
diff options
context:
space:
mode:
authorHaiyue Wang <haiyue.wang@intel.com>2019-10-15 15:51:30 +0800
committerFerruh Yigit <ferruh.yigit@intel.com>2019-10-23 16:43:09 +0200
commiteb5902504a1349f40530117b9c33dc352835ea20 (patch)
tree661f28e20a46b3fe332ceeb6f1c04007f1ee0d0e /doc/guides/nics
parent9bc556e3ecec6c1127c6d6c99660742315c59282 (diff)
downloaddpdk-eb5902504a1349f40530117b9c33dc352835ea20.zip
dpdk-eb5902504a1349f40530117b9c33dc352835ea20.tar.gz
dpdk-eb5902504a1349f40530117b9c33dc352835ea20.tar.xz
ethdev: add API for getting burst mode information
Some PMDs have more than one Rx/Tx burst paths, add the ethdev API that allows an application to retrieve the mode information about Rx/Tx packet burst such as Scalar or Vector, and Vector technology like AVX2. Signed-off-by: Haiyue Wang <haiyue.wang@intel.com> Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>
Diffstat (limited to 'doc/guides/nics')
-rw-r--r--doc/guides/nics/features.rst11
-rw-r--r--doc/guides/nics/features/default.ini1
2 files changed, 12 insertions, 0 deletions
diff --git a/doc/guides/nics/features.rst b/doc/guides/nics/features.rst
index c4e128d..d966968 100644
--- a/doc/guides/nics/features.rst
+++ b/doc/guides/nics/features.rst
@@ -871,6 +871,17 @@ Supports Tx queue setup after device started.
* **[provides] rte_eth_dev_info**: ``dev_capa:RTE_ETH_DEV_CAPA_RUNTIME_TX_QUEUE_SETUP``.
* **[related] API**: ``rte_eth_dev_info_get()``.
+.. _nic_features_burst_mode_info:
+
+Burst mode info
+---------------
+
+Supports to get Rx/Tx packet burst mode information.
+
+* **[implements] eth_dev_ops**: ``rx_burst_mode_get``, ``tx_burst_mode_get``.
+* **[related] API**: ``rte_eth_rx_burst_mode_get()``, ``rte_eth_tx_burst_mode_get()``,
+ ``rte_eth_burst_mode_option_name()``.
+
.. _nic_features_other:
Other dev ops not represented by a Feature
diff --git a/doc/guides/nics/features/default.ini b/doc/guides/nics/features/default.ini
index dfbdf08..91ec619 100644
--- a/doc/guides/nics/features/default.ini
+++ b/doc/guides/nics/features/default.ini
@@ -19,6 +19,7 @@ Free Tx mbuf on demand =
Queue start/stop =
Runtime Rx queue setup =
Runtime Tx queue setup =
+Burst mode info =
MTU update =
Jumbo frame =
Scattered Rx =