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 - 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
  29 - NUMA support
  30
  31 Prerequisites
  32 -------------
  33 - Get the information about Kunpeng920 chip using
  34   `<http://www.hisilicon.com/en/Products/ProductList/Kunpeng>`_.
  35
  36 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
  37
  38 Pre-Installation Configuration
  39 ------------------------------
  40
  41 Config File Options
  42 ~~~~~~~~~~~~~~~~~~~
  43
  44 The following options can be modified in the ``config`` file.
  45 Please note that enabling debugging options may affect system performance.
  46
  47 - ``CONFIG_RTE_LIBRTE_HNS3_PMD`` (default ``y``)
  48
  49 Driver compilation and testing
  50 ------------------------------
  51
  52 Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
  53 for details.
  54
  55 Limitations or Known issues
  56 ---------------------------
  57 Currently, we only support VF device is bound to vfio_pci or
  58 igb_uio and then driven by DPDK driver when PF is driven by
  59 kernel mode hns3 ethdev driver, VF is not supported when PF
  60 is driven by DPDK driver.
  61
  62 Build with ICC is not supported yet.
  63 X86-32, Power8, ARMv7 and BSD are not supported yet.