net/ngbe: add log and error types
[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 Prerequisites
12 -------------
13
14 - Learning about Wangxun 1 Gigabit Ethernet NICs using
15   `<https://www.net-swift.com/a/386.html>`_.
16
17 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
18
19
20 Pre-Installation Configuration
21 ------------------------------
22
23 Dynamic Logging Parameters
24 ~~~~~~~~~~~~~~~~~~~~~~~~~~
25
26 One may leverage EAL option "--log-level" to change default levels
27 for the log types supported by the driver. The option is used with
28 an argument typically consisting of two parts separated by a colon.
29
30 NGBE PMD provides the following log types available for control:
31
32 - ``pmd.net.ngbe.driver`` (default level is **notice**)
33
34   Affects driver-wide messages unrelated to any particular devices.
35
36 - ``pmd.net.ngbe.init`` (default level is **notice**)
37
38   Extra logging of the messages during PMD initialization.
39
40
41 Driver compilation and testing
42 ------------------------------
43
44 Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
45 for details.
46
47
48 Limitations or Known issues
49 ---------------------------
50
51 Build with ICC is not supported yet.
52 Power8, ARMv7 and BSD are not supported yet.