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