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 - VLAN filtering
  15 - Packet type information
  16 - Checksum offload
  17 - VLAN/QinQ stripping and inserting
  18 - TSO offload
  19 - Port hardware statistics
  20 - Jumbo frames
  21 - Link state information
  22 - Scattered and gather for TX and RX
  23
  24
  25 Prerequisites
  26 -------------
  27
  28 - Learning about Wangxun 1 Gigabit Ethernet NICs using
  29   `<https://www.net-swift.com/a/386.html>`_.
  30
  31 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
  32
  33
  34 Pre-Installation Configuration
  35 ------------------------------
  36
  37 Dynamic Logging Parameters
  38 ~~~~~~~~~~~~~~~~~~~~~~~~~~
  39
  40 One may leverage EAL option "--log-level" to change default levels
  41 for the log types supported by the driver. The option is used with
  42 an argument typically consisting of two parts separated by a colon.
  43
  44 NGBE PMD provides the following log types available for control:
  45
  46 - ``pmd.net.ngbe.driver`` (default level is **notice**)
  47
  48   Affects driver-wide messages unrelated to any particular devices.
  49
  50 - ``pmd.net.ngbe.init`` (default level is **notice**)
  51
  52   Extra logging of the messages during PMD initialization.
  53
  54
  55 Driver compilation and testing
  56 ------------------------------
  57
  58 Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
  59 for details.
  60
  61
  62 Limitations or Known issues
  63 ---------------------------
  64
  65 Build with ICC is not supported yet.
  66 Power8, ARMv7 and BSD are not supported yet.