Re: [PATCH v5 01/32] net/sssnic: add build and doc infrastructure

[Ferruh Yigit <ferruh.yigit@amd.com>]

On 9/4/2023 5:56 AM, wanry@3snic.com wrote:
> From: Renyong Wan <wanry@3snic.com>
> 
> Adding minimum PMD code, doc and build infrastructure for sssnic.
> 
> Signed-off-by: Steven Song <steven.song@3snic.com>
> Signed-off-by: Renyong Wan <wanry@3snic.com>
> 

<...>

> @@ -633,6 +633,13 @@ F: drivers/net/af_xdp/
>  F: doc/guides/nics/af_xdp.rst
>  F: doc/guides/nics/features/af_xdp.ini
>  
> +3SNIC sssnic
> +M: Renyong Wan <wanry@3snic.com>
> +M: Steven Song <steven.song@3snic.com>
> +F: drivers/net/sssnic/
> +F: doc/guides/nics/sssnic.rst
> +F: doc/guides/nics/features/sssnic.ini
> +
>

The list is sorted by the company name, I am aware above virtual devices
(af_xdp, af_packet & bondign) are causing the confusion, they are not
sorted clearly, please move the driver as first net driver, we can fix
the virtual ones later.


>  Amazon ENA
>  M: Michal Krawczyk <mk@semihalf.com>
>  M: Shai Brandes <shaibran@amazon.com>
> diff --git a/doc/guides/nics/features/sssnic.ini b/doc/guides/nics/features/sssnic.ini
> new file mode 100644
> index 0000000000..6d9786db7e
> --- /dev/null
> +++ b/doc/guides/nics/features/sssnic.ini
> @@ -0,0 +1,9 @@
> +;
> +; Supported features of the 'sssnic' network poll mode driver.
> +;
> +; Refer to default.ini for the full list of available PMD features.
> +;
> +[Features]
> +Linux                = Y
> +ARMv8                = Y
> +x86-64               = Y
> diff --git a/doc/guides/nics/index.rst b/doc/guides/nics/index.rst
> index 7bfcac880f..9d2b29383b 100644
> --- a/doc/guides/nics/index.rst
> +++ b/doc/guides/nics/index.rst
> @@ -61,6 +61,7 @@ Network Interface Controller Drivers
>      qede
>      sfc_efx
>      softnic
> +    sssnic
>      tap
>      thunderx
>      txgbe
> diff --git a/doc/guides/nics/sssnic.rst b/doc/guides/nics/sssnic.rst
> new file mode 100644
> index 0000000000..fe0180c2e6
> --- /dev/null
> +++ b/doc/guides/nics/sssnic.rst
> @@ -0,0 +1,73 @@
> +..  SPDX-License-Identifier: BSD-3-Clause
> +    Copyright(c) 2022 Shenzhen 3SNIC Information Technology Co., Ltd.
> +
> +SSSNIC Poll Mode Driver
> +=======================
> +
> +The sssnic PMD (**librte_pmd_sssnic**) provides poll mode driver support
> +for 3SNIC 9x0 serials family of Ethernet adapters.
> +
> +
> +Supported NICs
> +--------------
> +
> +- 3S910 Dual Port SFP28 10/25GbE Ethernet adapter
> +- 3S920 Quad Port SFP28 10/25GbE Ethernet adapter
> +- 3S920 Quad Port QSFP28 100GbE Ethernet adapter
>

3S930 ?
I can see from your website, that is the one with 100GbE interface.

It can be nice to have a link to each device page, if possible.


> +
> +
> +Features
> +--------
> +
> +Features of sssnic PMD are:
> +
> +- Link status
> +- Link status event
> +- Queue start/stop
> +- Rx interrupt
> +- Scattered Rx
> +- TSO
> +- LRO
> +- Promiscuous mode
> +- Allmulticast mode
> +- Unicast MAC filter
> +- Multicast MAC filte
> +- RSS hash
> +- RSS key update
> +- RSS reta update
> +- Inner RSS
> +- VLAN filter
> +- VLAN offload
> +- L3 checksum offload
> +- L4 checksum offload
> +- Inner L3 checksum
> +- Inner L4 checksum
> +- Basic stats
> +- Extended stats
> +- Stats per queue
> +- Flow control
> +- FW version
> +- Generic flow API
> +
>

Can you please update this list as features added to the code? Similar
to what you are already doing with sssnic.ini.

This helps whoever checking the git history can find the relevant code
from documentation git blame.


> +
> +Prerequisites
> +-------------
> +
> +- Learning about 3SNIC Ethernet NICs using
> +  `<https://www.3snic.com/products/SSSNIC>`_.
> +
> +- 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.
> +
> +
> +Limitations or Known issues
> +---------------------------
> +
> +Build with ICC is not supported yet.
>

I don't know listing ICC as relevant anymore, I am not aware of anyone
testing it. So can drop this limitation.