1.. SPDX-License-Identifier: BSD-3-Clause 2 Copyright(c) 2018-2021 Beijing WangXun Technology Co., Ltd. 3 4NGBE Poll Mode Driver 5===================== 6 7The NGBE PMD (librte_pmd_ngbe) provides poll mode driver support 8for Wangxun 1 Gigabit Ethernet NICs. 9 10 11Features 12-------- 13 14- Multiple queues for Tx and Rx 15- Receiver Side Scaling (RSS) 16- MAC/VLAN filtering 17- Packet type information 18- Checksum offload 19- VLAN/QinQ stripping and inserting 20- TSO offload 21- Promiscuous mode 22- Multicast mode 23- Port hardware statistics 24- Jumbo frames 25- Link state information 26- Link flow control 27- Scattered and gather for TX and RX 28- IEEE 1588 29- FW version 30- Interrupt mode for RX 31 32 33Prerequisites 34------------- 35 36- Learning about Wangxun 1 Gigabit Ethernet NICs using 37 `<https://www.net-swift.com/a/386.html>`_. 38 39- Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment. 40 41 42Configuration 43------------- 44 45Compilation Options 46~~~~~~~~~~~~~~~~~~~ 47 48The following build-time options may be enabled on build time using. 49 50``-Dc_args=`` meson argument (e.g. ``-Dc_args=-DRTE_LIBRTE_NGBE_PF_DISABLE_STRIP_CRC``). 51 52- ``RTE_LIBRTE_NGBE_PF_DISABLE_STRIP_CRC`` (undefined by default) 53 54 Decide to enable or disable HW CRC in VF PMD. 55 56Dynamic Logging Parameters 57~~~~~~~~~~~~~~~~~~~~~~~~~~ 58 59One may leverage EAL option "--log-level" to change default levels 60for the log types supported by the driver. The option is used with 61an argument typically consisting of two parts separated by a colon. 62 63NGBE PMD provides the following log types available for control: 64 65- ``pmd.net.ngbe.driver`` (default level is **notice**) 66 67 Affects driver-wide messages unrelated to any particular devices. 68 69- ``pmd.net.ngbe.init`` (default level is **notice**) 70 71 Extra logging of the messages during PMD initialization. 72 73 74Driver compilation and testing 75------------------------------ 76 77Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>` 78for details. 79 80 81Limitations or Known issues 82--------------------------- 83 84Build with ICC is not supported yet. 85Power8, ARMv7 and BSD are not supported yet. 86