1.. SPDX-License-Identifier: BSD-3-Clause 2 Copyright(c) 2018-2019 Hisilicon Limited. 3 4HNS3 Poll Mode Driver 5=============================== 6 7The hns3 PMD (**librte_net_hns3**) provides poll mode driver support 8for the inbuilt Hisilicon Network Subsystem(HNS) network engine 9found in the Hisilicon Kunpeng 920 SoC. 10 11Features 12-------- 13 14Features of the HNS3 PMD are: 15 16- Multiple queues for TX and RX 17- Receive Side Scaling (RSS) 18- Packet type information 19- Checksum offload 20- TSO offload 21- LRO offload 22- Promiscuous mode 23- Multicast mode 24- Port hardware statistics 25- Jumbo frames 26- Link state information 27- Interrupt mode for RX 28- VLAN stripping and inserting 29- QinQ inserting 30- DCB 31- Scattered and gather for TX and RX 32- Vector Poll mode driver 33- Dump register 34- SR-IOV VF 35- Multi-process 36- MAC/VLAN filter 37- MTU update 38- NUMA support 39- Generic flow API 40 41Prerequisites 42------------- 43- Get the information about Kunpeng920 chip using 44 `<http://www.hisilicon.com/en/Products/ProductList/Kunpeng>`_. 45 46- Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment. 47 48 49Driver compilation and testing 50------------------------------ 51 52Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>` 53for details. 54 55Limitations or Known issues 56--------------------------- 57Currently, we only support VF device is bound to vfio_pci or 58igb_uio and then driven by DPDK driver when PF is driven by 59kernel mode hns3 ethdev driver, VF is not supported when PF 60is driven by DPDK driver. 61 62Build with ICC is not supported yet. 63X86-32, Power8, ARMv7 and BSD are not supported yet. 64