X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Fnics%2Fhns3.rst;h=d51d9b13998960f2f09a01113e5d9a86ff474c6e;hb=cdf6a5fbc540cdaac576a2be6c8dac25ce173c65;hp=84bd7a3c92e8ee4d812a0f83b619bbbb679477f7;hpb=a951fbbe91d6edd30ef01320b960162c33a2b46e;p=dpdk.git diff --git a/doc/guides/nics/hns3.rst b/doc/guides/nics/hns3.rst index 84bd7a3c92..d51d9b1399 100644 --- a/doc/guides/nics/hns3.rst +++ b/doc/guides/nics/hns3.rst @@ -1,12 +1,12 @@ .. SPDX-License-Identifier: BSD-3-Clause - Copyright(c) 2018-2019 Hisilicon Limited. + Copyright(c) 2018-2019 HiSilicon Limited. HNS3 Poll Mode Driver =============================== 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 and Kunpeng 930 SoC . Features -------- @@ -37,6 +37,7 @@ Features of the HNS3 PMD are: - MTU update - NUMA support - Generic flow API +- IEEE1588/802.1AS timestamping Prerequisites ------------- @@ -46,6 +47,61 @@ Prerequisites - Follow the DPDK :ref:`Getting Started Guide for Linux ` to setup the basic DPDK environment. +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 simple 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``. + + For example:: + -a 0000:7d:00.0,rx_func_hint=simple + +- ``tx_func_hint`` (default ``none``) + + 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. + + When provided parameter is not supported, ``vec`` usage condition will + be first checked, if meets, use the ``vec``. Then, ``simple``, at last + ``common``. + + For example:: + -a 0000:7d:00.0,tx_func_hint=common + +- ``dev_caps_mask`` (default ``0``) + + Used to mask the capability which queried from firmware. + This args take hexadecimal bitmask where each bit represents whether mask + corresponding capability. eg. If the capability is 0xFFFF queried from + firmware, and the args value is 0xF which means the bit0~bit3 should be + masked off, then the capability will be 0xFFF0. + Its main purpose is to debug and avoid problems. + + For example:: + -a 0000:7d:00.0,dev_caps_mask=0xF + Driver compilation and testing ------------------------------