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