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