net/txgbe: add build and doc infrastructure
[dpdk.git] / 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 Prerequisites
11 -------------
12
13 - Learning about Wangxun 10 Gigabit Ethernet NICs using
14   `<https://www.net-swift.com/a/383.html>`_.
15
16 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
17
18 Driver compilation and testing
19 ------------------------------
20
21 Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
22 for details.
23
24 Limitations or Known issues
25 ---------------------------
26
27 Build with ICC is not supported yet.
28 Power8, ARMv7 and BSD are not supported yet.