ethdev: dump single flow rule

[dpdk.git] / doc / guides / nics / hns3.rst

diff --git a/doc/guides/nics/hns3.rst b/doc/guides/nics/hns3.rst
index 505488b..3366562 100644 (file)
--- a/doc/guides/nics/hns3.rst
+++ b/doc/guides/nics/hns3.rst
@@ -4,7 +4,7 @@
 HNS3 Poll Mode Driver
 ===============================
 
 HNS3 Poll Mode Driver
 ===============================
 

-The hns3 PMD (librte_pmd_hns3) provides poll mode driver support
+The hns3 PMD (**librte_net_hns3**) provides poll mode driver support

 for the inbuilt Hisilicon Network Subsystem(HNS) network engine
 found in the Hisilicon Kunpeng 920 SoC.
 
 for the inbuilt Hisilicon Network Subsystem(HNS) network engine
 found in the Hisilicon Kunpeng 920 SoC.
 


@@ -17,31 +17,72 @@ Features of the HNS3 PMD are:
 - Receive Side Scaling (RSS)
 - Packet type information
 - Checksum offload
 - Receive Side Scaling (RSS)
 - Packet type information
 - Checksum offload

+- TSO offload
+- LRO offload

 - Promiscuous mode
 - Multicast mode
 - Port hardware statistics
 - Jumbo frames
 - Link state information
 - Promiscuous mode
 - Multicast mode
 - Port hardware statistics
 - Jumbo frames
 - Link state information

-- VLAN stripping
+- Interrupt mode for RX
+- VLAN stripping and inserting
+- QinQ inserting
+- DCB
+- Scattered and gather for TX and RX
+- Vector Poll mode driver
+- Dump register
+- SR-IOV VF
+- Multi-process
+- MAC/VLAN filter
+- MTU update

 - NUMA support
 - NUMA support

+- Generic flow API
+- IEEE1588/802.1AS timestamping

 
 Prerequisites
 -------------
 - Get the information about Kunpeng920 chip using
 
 Prerequisites
 -------------
 - Get the information about Kunpeng920 chip using

-  `<http://www.hisilicon.com/en/Products/ProductList/Kunpeng>`_.
+  `<https://www.hisilicon.com/en/products/Kunpeng>`_.

 
 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
 
 
 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
 

-Pre-Installation Configuration
-------------------------------

 
 

-Config File Options
-~~~~~~~~~~~~~~~~~~~
+Runtime Config Options
+----------------------
+
+- ``rx_func_hint`` (default ``none``)
+
+  Used to select Rx burst function, supported value are ``vec``, ``sve``,
+  ``simple``, ``common``.
+  ``vec``, if supported use the ``vec`` Rx function which indicates the
+  default vector algorithm, neon for Kunpeng Arm platform.
+  ``sve``, if supported use the ``sve`` Rx function which indicates the
+  sve algorithm.
+  ``simple``, if supported use the ``simple`` Rx function which indicates
+  the scalar algorithm.
+  ``common``, if supported use the ``common`` Rx function which indicates
+  the scalar scattered algorithm.
+
+  When provided parameter is not supported, ``vec`` usage condition will
+  be first checked, if meets, use the ``vec``. Then, ``simple``, at last
+  ``common``.
+
+- ``tx_func_hint`` (default ``none``)

 
 

-The following options can be modified in the ``config`` file.
-Please note that enabling debugging options may affect system performance.
+  Used to select Tx burst function, supported value are ``vec``, ``sve``,
+  ``simple``, ``common``.
+  ``vec``, if supported use the ``vec`` Tx function which indicates the
+  default vector algorithm, neon for Kunpeng Arm platform.
+  ``sve``, if supported use the ``sve`` Tx function which indicates the
+  sve algorithm.
+  ``simple``, if supported use the ``simple`` Tx function which indicates
+  the scalar simple algorithm.
+  ``common``, if supported use the ``common`` Tx function which indicates
+  the scalar algorithm.

 
 

-- ``CONFIG_RTE_LIBRTE_HNS3_PMD`` (default ``y``)
+  When provided parameter is not supported, ``vec`` usage condition will
+  be first checked, if meets, use the ``vec``. Then, ``simple``, at last
+  ``common``.

 
 Driver compilation and testing
 ------------------------------
 
 Driver compilation and testing
 ------------------------------