1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright(c) 2015-2020.
7 The TXGBE PMD (librte_pmd_txgbe) provides poll mode driver support
8 for Wangxun 10 Gigabit Ethernet NICs.
13 - Multiple queues for TX and RX
14 - Receiver Side Scaling (RSS)
16 - Packet type information
18 - VLAN/QinQ stripping and inserting
22 - Port hardware statistics
24 - Link state information
26 - Interrupt mode for RX
27 - Scattered and gather for TX and RX
36 - Learning about Wangxun 10 Gigabit Ethernet NICs using
37 `<https://www.net-swift.com/a/383.html>`_.
39 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
41 Pre-Installation Configuration
42 ------------------------------
47 The following build-time options may be enabled on build time using.
49 ``-Dc_args=`` meson argument (e.g. ``-Dc_args=-DRTE_LIBRTE_TXGBE_DEBUG_RX``).
51 Please note that enabling debugging options may affect system performance.
53 - ``RTE_LIBRTE_TXGBE_DEBUG_RX`` (undefined by default)
55 Toggle display of receive fast path run-time messages.
57 - ``RTE_LIBRTE_TXGBE_DEBUG_TX`` (undefined by default)
59 Toggle display of transmit fast path run-time messages.
61 - ``RTE_LIBRTE_TXGBE_DEBUG_TX_FREE`` (undefined by default)
63 Toggle display of transmit descriptor clean messages.
65 Dynamic Logging Parameters
66 ~~~~~~~~~~~~~~~~~~~~~~~~~~
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.
72 TXGBE PMD provides the following log types available for control:
74 - ``pmd.net.txgbe.driver`` (default level is **notice**)
76 Affects driver-wide messages unrelated to any particular devices.
78 - ``pmd.net.txgbe.init`` (default level is **notice**)
80 Extra logging of the messages during PMD initialization.
82 Driver compilation and testing
83 ------------------------------
85 Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
88 Limitations or Known issues
89 ---------------------------
91 Build with ICC is not supported yet.
92 Power8, ARMv7 and BSD are not supported yet.