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