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