1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright(c) 2018-2019 Hisilicon Limited.
5 ===============================
7 The hns3 PMD (librte_pmd_hns3) provides poll mode driver support
8 for the inbuilt Hisilicon Network Subsystem(HNS) network engine
9 found in the Hisilicon Kunpeng 920 SoC.
14 Features of the HNS3 PMD are:
16 - Multiple queues for TX and RX
17 - Receive Side Scaling (RSS)
18 - Packet type information
22 - Port hardware statistics
24 - Link state information
30 - Get the information about Kunpeng920 chip using
31 `<http://www.hisilicon.com/en/Products/ProductList/Kunpeng>`_.
33 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
35 Pre-Installation Configuration
36 ------------------------------
41 The following options can be modified in the ``config`` file.
42 Please note that enabling debugging options may affect system performance.
44 - ``CONFIG_RTE_LIBRTE_HNS3_PMD`` (default ``y``)
46 Driver compilation and testing
47 ------------------------------
49 Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
52 Limitations or Known issues
53 ---------------------------
54 Currently, we only support VF device is bound to vfio_pci or
55 igb_uio and then driven by DPDK driver when PF is driven by
56 kernel mode hns3 ethdev driver, VF is not supported when PF
57 is driven by DPDK driver.
59 Build with ICC is not supported yet.
60 X86-32, Power8, ARMv7 and BSD are not supported yet.