This patch adds doc infrastructure for spnic PMD driver. Signed-off-by: Yanling Song <son...@ramaxel.com> --- MAINTAINERS | 6 +++ doc/guides/nics/features/spnic.ini | 40 ++++++++++++++++++++ doc/guides/nics/spnic.rst | 61 ++++++++++++++++++++++++++++++ 3 files changed, 107 insertions(+) create mode 100644 doc/guides/nics/features/spnic.ini create mode 100644 doc/guides/nics/spnic.rst
diff --git a/MAINTAINERS b/MAINTAINERS index 18d9edaf88..12f6171aef 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -919,6 +919,12 @@ F: drivers/net/qede/ F: doc/guides/nics/qede.rst F: doc/guides/nics/features/qede*.ini +Ramaxel SPNIC +M: Yanling Song <son...@ramaxel.com> +F: drivers/net/spnic/ +F: doc/guides/nics/spnic.rst +F: doc/guides/nics/features/spnic.ini + Solarflare sfc_efx M: Andrew Rybchenko <andrew.rybche...@oktetlabs.ru> F: drivers/common/sfc_efx/ diff --git a/doc/guides/nics/features/spnic.ini b/doc/guides/nics/features/spnic.ini new file mode 100644 index 0000000000..bdefcb451b --- /dev/null +++ b/doc/guides/nics/features/spnic.ini @@ -0,0 +1,40 @@ +; +; Supported features of 'spnic' network poll mode driver. +; +; Refer to default.ini for the full list of available PMD features. +; +[Features] +Speed capabilities = Y +Link status = Y +Link status event = Y +Queue start/stop = Y +MTU update = Y +Jumbo frame = Y +Scattered Rx = Y +LRO = Y +TSO = Y +Promiscuous mode = Y +Allmulticast mode = Y +Unicast MAC filter = Y +Multicast MAC filter = Y +RSS hash = Y +RSS key update = Y +RSS reta update = Y +Inner RSS = Y +SR-IOV = Y +Flow control = Y +CRC offload = Y +VLAN filter = Y +VLAN offload = Y +L3 checksum offload = Y +L4 checksum offload = Y +Inner L3 checksum = Y +Inner L4 checksum = Y +Basic stats = Y +Extended stats = Y +Stats per queue = Y +FW version = Y +Multiprocess aware = Y +Linux = Y +x86-64 = Y +ARMv8 = Y \ No newline at end of file diff --git a/doc/guides/nics/spnic.rst b/doc/guides/nics/spnic.rst new file mode 100644 index 0000000000..9305ecbb84 --- /dev/null +++ b/doc/guides/nics/spnic.rst @@ -0,0 +1,61 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(c) 2021 Ramaxel Memory Technology, Ltd + + +SPNIC Poll Mode Driver +====================== + +The spnic PMD (**librte_net_spnic**) provides poll mode driver support +for 25Gbps/100Gbps SPNxxx Network Adapters. + + +Features +-------- + +- Multiple queues for TX and RX +- Receiver Side Scaling（RSS） +- RSS supports IPv4, IPv6, TCPv4, TCPv6, UDPv4 and UDPv6, use inner type for VXLAN as default +- MAC/VLAN filtering +- Checksum offload +- TSO offload +- LRO offload +- Promiscuous mode +- Port hardware statistics +- Link state information +- Link flow control(pause frame) +- Scattered and gather for TX and RX +- SR-IOV - Partially supported VFIO only +- VLAN filter and VLAN offload +- Allmulticast mode +- MTU update +- Unicast MAC filter +- Multicast MAC filter +- Set Link down or up +- FW version +- Multi arch support: x86_64, ARMv8. + +Prerequisites +------------- + +- Learning about SPNIC using + `<xx card introduce>`_. + +- Getting the latest product documents and software supports using + `<Website to support>`_. + +- Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment. + + +Driver compilation and testing +------------------------------ + +Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>` +for details. + +It is highly recommended to upgrade the spnic driver and firmware to avoid the compatibility issues, +and check the work mode with the latest product documents. + +Limitations or Known issues +--------------------------- +Build with ICC is not supported yet. +X86-32, Power8, ARMv7 and BSD are not supported yet. -- 2.27.0
