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 Prerequisites
  11 -------------
  12
  13 - Learning about Wangxun 10 Gigabit Ethernet NICs using
  14   `<https://www.net-swift.com/a/383.html>`_.
  15
  16 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
  17
  18 Pre-Installation Configuration
  19 ------------------------------
  20
  21 Build Options
  22 ~~~~~~~~~~~~~
  23
  24 The following build-time options may be enabled on build time using.
  25
  26 ``-Dc_args=`` meson argument (e.g. ``-Dc_args=-DRTE_LIBRTE_TXGBE_DEBUG_RX``).
  27
  28 Please note that enabling debugging options may affect system performance.
  29
  30 - ``RTE_LIBRTE_TXGBE_DEBUG_RX`` (undefined by default)
  31
  32   Toggle display of receive fast path run-time messages.
  33
  34 - ``RTE_LIBRTE_TXGBE_DEBUG_TX`` (undefined by default)
  35
  36   Toggle display of transmit fast path run-time messages.
  37
  38 - ``RTE_LIBRTE_TXGBE_DEBUG_TX_FREE`` (undefined by default)
  39
  40   Toggle display of transmit descriptor clean messages.
  41
  42 Dynamic Logging Parameters
  43 ~~~~~~~~~~~~~~~~~~~~~~~~~~
  44
  45 One may leverage EAL option "--log-level" to change default levels
  46 for the log types supported by the driver. The option is used with
  47 an argument typically consisting of two parts separated by a colon.
  48
  49 TXGBE PMD provides the following log types available for control:
  50
  51 - ``pmd.net.txgbe.driver`` (default level is **notice**)
  52
  53   Affects driver-wide messages unrelated to any particular devices.
  54
  55 - ``pmd.net.txgbe.init`` (default level is **notice**)
  56
  57   Extra logging of the messages during PMD initialization.
  58
  59 Driver compilation and testing
  60 ------------------------------
  61
  62 Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
  63 for details.
  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.