doc/guides/nics/hns3.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright(c) 2018-2019 Hisilicon Limited.
   3
   4 HNS3 Poll Mode Driver
   5 ===============================
   6
   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.
  10
  11 Features
  12 --------
  13
  14 Features 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 - Promiscuous mode
  21 - Multicast mode
  22 - Port hardware statistics
  23 - Jumbo frames
  24 - Link state information
  25 - Interrupt mode for RX
  26 - VLAN stripping
  27 - NUMA support
  28
  29 Prerequisites
  30 -------------
  31 - Get the information about Kunpeng920 chip using
  32   `<http://www.hisilicon.com/en/Products/ProductList/Kunpeng>`_.
  33
  34 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
  35
  36 Pre-Installation Configuration
  37 ------------------------------
  38
  39 Config File Options
  40 ~~~~~~~~~~~~~~~~~~~
  41
  42 The following options can be modified in the ``config`` file.
  43 Please note that enabling debugging options may affect system performance.
  44
  45 - ``CONFIG_RTE_LIBRTE_HNS3_PMD`` (default ``y``)
  46
  47 Driver compilation and testing
  48 ------------------------------
  49
  50 Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
  51 for details.
  52
  53 Limitations or Known issues
  54 ---------------------------
  55 Currently, we only support VF device is bound to vfio_pci or
  56 igb_uio and then driven by DPDK driver when PF is driven by
  57 kernel mode hns3 ethdev driver, VF is not supported when PF
  58 is driven by DPDK driver.
  59
  60 Build with ICC is not supported yet.
  61 X86-32, Power8, ARMv7 and BSD are not supported yet.