doc/guides/nics/ngbe.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright(c) 2018-2021 Beijing WangXun Technology Co., Ltd.
   3
   4 NGBE Poll Mode Driver
   5 =====================
   6
   7 The NGBE PMD (librte_pmd_ngbe) provides poll mode driver support
   8 for Wangxun 1 Gigabit Ethernet NICs.
   9
  10
  11 Features
  12 --------
  13
  14 - Multiple queues for Tx and Rx
  15 - Receiver Side Scaling (RSS)
  16 - MAC/VLAN filtering
  17 - Packet type information
  18 - Checksum offload
  19 - VLAN/QinQ stripping and inserting
  20 - TSO offload
  21 - Promiscuous mode
  22 - Multicast mode
  23 - Port hardware statistics
  24 - Jumbo frames
  25 - Link state information
  26 - Scattered and gather for TX and RX
  27 - FW version
  28
  29
  30 Prerequisites
  31 -------------
  32
  33 - Learning about Wangxun 1 Gigabit Ethernet NICs using
  34   `<https://www.net-swift.com/a/386.html>`_.
  35
  36 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
  37
  38
  39 Pre-Installation Configuration
  40 ------------------------------
  41
  42 Dynamic Logging Parameters
  43 ~~~~~~~~~~~~~~~~~~~~~~~~~~
  44
  45 One may leverage EAL option "--log-level" to change default levels
  46 for the log types supported by the driver. The option is used with
  47 an argument typically consisting of two parts separated by a colon.
  48
  49 NGBE PMD provides the following log types available for control:
  50
  51 - ``pmd.net.ngbe.driver`` (default level is **notice**)
  52
  53   Affects driver-wide messages unrelated to any particular devices.
  54
  55 - ``pmd.net.ngbe.init`` (default level is **notice**)
  56
  57   Extra logging of the messages during PMD initialization.
  58
  59
  60 Driver compilation and testing
  61 ------------------------------
  62
  63 Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
  64 for details.
  65
  66
  67 Limitations or Known issues
  68 ---------------------------
  69
  70 Build with ICC is not supported yet.
  71 Power8, ARMv7 and BSD are not supported yet.