doc/guides/nics/txgbe.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright(c) 2015-2020.
   3
   4 TXGBE Poll Mode Driver
   5 ======================
   6
   7 The TXGBE PMD (librte_pmd_txgbe) provides poll mode driver support
   8 for Wangxun 10 Gigabit Ethernet NICs.
   9
  10 Features
  11 --------
  12
  13 - Multiple queues for TX and RX
  14 - MAC filtering
  15 - Link state information
  16
  17 Prerequisites
  18 -------------
  19
  20 - Learning about Wangxun 10 Gigabit Ethernet NICs using
  21   `<https://www.net-swift.com/a/383.html>`_.
  22
  23 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
  24
  25 Pre-Installation Configuration
  26 ------------------------------
  27
  28 Build Options
  29 ~~~~~~~~~~~~~
  30
  31 The following build-time options may be enabled on build time using.
  32
  33 ``-Dc_args=`` meson argument (e.g. ``-Dc_args=-DRTE_LIBRTE_TXGBE_DEBUG_RX``).
  34
  35 Please note that enabling debugging options may affect system performance.
  36
  37 - ``RTE_LIBRTE_TXGBE_DEBUG_RX`` (undefined by default)
  38
  39   Toggle display of receive fast path run-time messages.
  40
  41 - ``RTE_LIBRTE_TXGBE_DEBUG_TX`` (undefined by default)
  42
  43   Toggle display of transmit fast path run-time messages.
  44
  45 - ``RTE_LIBRTE_TXGBE_DEBUG_TX_FREE`` (undefined by default)
  46
  47   Toggle display of transmit descriptor clean messages.
  48
  49 Dynamic Logging Parameters
  50 ~~~~~~~~~~~~~~~~~~~~~~~~~~
  51
  52 One may leverage EAL option "--log-level" to change default levels
  53 for the log types supported by the driver. The option is used with
  54 an argument typically consisting of two parts separated by a colon.
  55
  56 TXGBE PMD provides the following log types available for control:
  57
  58 - ``pmd.net.txgbe.driver`` (default level is **notice**)
  59
  60   Affects driver-wide messages unrelated to any particular devices.
  61
  62 - ``pmd.net.txgbe.init`` (default level is **notice**)
  63
  64   Extra logging of the messages during PMD initialization.
  65
  66 Driver compilation and testing
  67 ------------------------------
  68
  69 Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
  70 for details.
  71
  72 Limitations or Known issues
  73 ---------------------------
  74
  75 Build with ICC is not supported yet.
  76 Power8, ARMv7 and BSD are not supported yet.