X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Fnics%2Fhns3.rst;h=3366562968f504156e9475adec62d82658992063;hb=50c383793b7b377ed9f733a779976447dbfd8bda;hp=505488b6cab0c82a8ffebfa9566b0fe5a79aa1d8;hpb=565829db8b8fa70605cc3a00e19c37c561c9dc18;p=dpdk.git diff --git a/doc/guides/nics/hns3.rst b/doc/guides/nics/hns3.rst index 505488b6ca..3366562968 100644 --- a/doc/guides/nics/hns3.rst +++ b/doc/guides/nics/hns3.rst @@ -4,7 +4,7 @@ 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. @@ -17,31 +17,72 @@ Features of the HNS3 PMD are: - 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 -- 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 +- Generic flow API +- IEEE1588/802.1AS timestamping Prerequisites ------------- - Get the information about Kunpeng920 chip using - ``_. + ``_. - Follow the DPDK :ref:`Getting Started Guide for Linux ` 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 ------------------------------