devtools: add cocci script to rename mbuf offload flags
[dpdk.git] / doc / guides / nics / ngbe.rst
1 ..  SPDX-License-Identifier: BSD-3-Clause
2     Copyright(c) 2018-2021 Beijing WangXun Technology Co., Ltd.
3
4 NGBE Poll Mode Driver
5 =====================
6
7 The NGBE PMD (librte_pmd_ngbe) provides poll mode driver support
8 for Wangxun 1 Gigabit Ethernet NICs.
9
10
11 Features
12 --------
13
14 - Link state information
15
16
17 Prerequisites
18 -------------
19
20 - Learning about Wangxun 1 Gigabit Ethernet NICs using
21   `<https://www.net-swift.com/a/386.html>`_.
22
23 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
24
25
26 Pre-Installation Configuration
27 ------------------------------
28
29 Dynamic Logging Parameters
30 ~~~~~~~~~~~~~~~~~~~~~~~~~~
31
32 One may leverage EAL option "--log-level" to change default levels
33 for the log types supported by the driver. The option is used with
34 an argument typically consisting of two parts separated by a colon.
35
36 NGBE PMD provides the following log types available for control:
37
38 - ``pmd.net.ngbe.driver`` (default level is **notice**)
39
40   Affects driver-wide messages unrelated to any particular devices.
41
42 - ``pmd.net.ngbe.init`` (default level is **notice**)
43
44   Extra logging of the messages during PMD initialization.
45
46
47 Driver compilation and testing
48 ------------------------------
49
50 Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
51 for details.
52
53
54 Limitations or Known issues
55 ---------------------------
56
57 Build with ICC is not supported yet.
58 Power8, ARMv7 and BSD are not supported yet.