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