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