diff mbox series

[v6,25/26] net/spnic: add doc infrastructure

Message ID 3cb3441af22c2483cfbe1908ff8c26c721d7644a.1640838702.git.songyl@ramaxel.com (mailing list archive)
State Changes Requested, archived
Delegated to: Ferruh Yigit
Headers
Series Net/SPNIC: support SPNIC into DPDK 22.03 |

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Yanling Song Dec. 30, 2021, 6:09 a.m. UTC 
  This patch adds doc infrastructure for spnic PMD driver.

Signed-off-by: Yanling Song <songyl@ramaxel.com>
---
 MAINTAINERS                        |  6 ++++
 doc/guides/nics/features/spnic.ini | 39 +++++++++++++++++++++
 doc/guides/nics/index.rst          |  1 +
 doc/guides/nics/spnic.rst          | 55 ++++++++++++++++++++++++++++++
 4 files changed, 101 insertions(+)
 create mode 100644 doc/guides/nics/features/spnic.ini
 create mode 100644 doc/guides/nics/spnic.rst

Comments

Ferruh Yigit Jan. 19, 2022, 5:27 p.m. UTC | #1 
On 12/30/2021 6:09 AM, Yanling Song wrote:
> This patch adds doc infrastructure for spnic PMD driver.
> 
> Signed-off-by: Yanling Song <songyl@ramaxel.com>

<...>

> diff --git a/doc/guides/nics/spnic.rst b/doc/guides/nics/spnic.rst
> new file mode 100644
> index 0000000000..fd04178f8a
> --- /dev/null
> +++ b/doc/guides/nics/spnic.rst
> @@ -0,0 +1,55 @@
> +..  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.
> +

Can you please provide more information to the device, and add a link to the
product page?

> +
> +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.


Please build this list in each patch as these features are added.
So have the base documentation in first patch, later as above features added
update this file in that patch.

Same for above .ini file.

> +
> +Prerequisites
> +-------------
> +
> +- 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.
Yanling Song Jan. 21, 2022, 9:39 a.m. UTC | #2 
On Wed, 19 Jan 2022 17:27:56 +0000
Ferruh Yigit <ferruh.yigit@intel.com> wrote:

> On 12/30/2021 6:09 AM, Yanling Song wrote:
> > This patch adds doc infrastructure for spnic PMD driver.
> > 
> > Signed-off-by: Yanling Song <songyl@ramaxel.com>  
> 
> <...>
> 
> > diff --git a/doc/guides/nics/spnic.rst b/doc/guides/nics/spnic.rst
> > new file mode 100644
> > index 0000000000..fd04178f8a
> > --- /dev/null
> > +++ b/doc/guides/nics/spnic.rst
> > @@ -0,0 +1,55 @@
> > +..  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.
> > +  
> 
> Can you please provide more information to the device, and add a link
> to the product page?
> 
More information will be supplied in the next version. But the web page
is still under construction.

> > +
> > +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.  
> 
> 
> Please build this list in each patch as these features are added.
> So have the base documentation in first patch, later as above
> features added update this file in that patch.
> 
> Same for above .ini file.
> 
Ok. Will do it this way in the next version.

> > +
> > +Prerequisites
> > +-------------
> > +
> > +- 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.  
>
diff mbox series

Patch

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 <songyl@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.rybchenko@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..1cec6a59fa
--- /dev/null
+++ b/doc/guides/nics/features/spnic.ini
@@ -0,0 +1,39 @@ 
+;
+; 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
+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
diff --git a/doc/guides/nics/index.rst b/doc/guides/nics/index.rst
index 1c94caccea..6d47fa64a1 100644
--- a/doc/guides/nics/index.rst
+++ b/doc/guides/nics/index.rst
@@ -57,6 +57,7 @@  Network Interface Controller Drivers
     pfe
     qede
     sfc_efx
+    spnic
     softnic
     tap
     thunderx
diff --git a/doc/guides/nics/spnic.rst b/doc/guides/nics/spnic.rst
new file mode 100644
index 0000000000..fd04178f8a
--- /dev/null
+++ b/doc/guides/nics/spnic.rst
@@ -0,0 +1,55 @@ 
+..  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
+-------------
+
+- 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.