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