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