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