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