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