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