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 - Generic flow API
  33
  34 Prerequisites
  35 -------------
  36
  37 - Learning about Wangxun 10 Gigabit Ethernet NICs using
  38   `<https://www.net-swift.com/a/383.html>`_.
  39
  40 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
  41
  42 Pre-Installation Configuration
  43 ------------------------------
  44
  45 Build Options
  46 ~~~~~~~~~~~~~
  47
  48 The following build-time options may be enabled on build time using.
  49
  50 ``-Dc_args=`` meson argument (e.g. ``-Dc_args=-DRTE_LIBRTE_TXGBE_DEBUG_RX``).
  51
  52 Please note that enabling debugging options may affect system performance.
  53
  54 - ``RTE_LIBRTE_TXGBE_DEBUG_RX`` (undefined by default)
  55
  56   Toggle display of receive fast path run-time messages.
  57
  58 - ``RTE_LIBRTE_TXGBE_DEBUG_TX`` (undefined by default)
  59
  60   Toggle display of transmit fast path run-time messages.
  61
  62 - ``RTE_LIBRTE_TXGBE_DEBUG_TX_FREE`` (undefined by default)
  63
  64   Toggle display of transmit descriptor clean messages.
  65
  66 Dynamic Logging Parameters
  67 ~~~~~~~~~~~~~~~~~~~~~~~~~~
  68
  69 One may leverage EAL option "--log-level" to change default levels
  70 for the log types supported by the driver. The option is used with
  71 an argument typically consisting of two parts separated by a colon.
  72
  73 TXGBE PMD provides the following log types available for control:
  74
  75 - ``pmd.net.txgbe.driver`` (default level is **notice**)
  76
  77   Affects driver-wide messages unrelated to any particular devices.
  78
  79 - ``pmd.net.txgbe.init`` (default level is **notice**)
  80
  81   Extra logging of the messages during PMD initialization.
  82
  83 Driver compilation and testing
  84 ------------------------------
  85
  86 Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
  87 for details.
  88
  89 Sample Application Notes
  90 ------------------------
  91
  92 Generic flow API
  93 ~~~~~~~~~~~~~~~~
  94
  95 TXGBE PMD supports generic flow API which configures hardware to match specific
  96 ingress or egress traffic, alter its fate and query related counters according
  97 to any number of user-defined rules.
  98
  99 A flow rule is the combination of attributes with a matching pattern and a list of
 100 actions. Theorically one rule can match more than one filters, which named for
 101 different patterns and actions. Like ethertype filter defines a rule in pattern:
 102 the first not void item can be ETH, and the next not void item must be END.
 103
 104 For example, create a flow rule:
 105
 106 .. code-block:: console
 107
 108         testpmd> flow create 0 ingress pattern eth type is 0x0806 / end actions queue index 2 / end
 109
 110 For a detailed usage description please refer to "Flow rules management" section in DPDK :doc:`Testpmd Runtime Functions <../testpmd_app_ug/testpmd_funcs>`.
 111
 112 Traffic Management API
 113 ~~~~~~~~~~~~~~~~~~~~~~
 114
 115 TXGBE PMD supports generic DPDK Traffic Management API which allows to
 116 configure the following features: hierarchical scheduling, traffic shaping,
 117 congestion management, packet marking.
 118
 119 For example, add shaper profile
 120
 121 .. code-block:: console
 122
 123         testpmd> add port tm node shaper profile 0 0 0 0 25000000 0 0
 124
 125 For a detailed usage description please refer to "Traffic Management" section in DPDK :doc:`Testpmd Runtime Functions <../testpmd_app_ug/testpmd_funcs>`.
 126
 127 Limitations or Known issues
 128 ---------------------------
 129
 130 Build with ICC is not supported yet.
 131 Power8, ARMv7 and BSD are not supported yet.