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