[v4,01/32] net/sssnic: add build and doc infrastructure
Checks
Commit Message
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>
---
v2:
* Fixed 'Title underline too short' in doc/guides/nics/sssnic.rst.
* Removed error.h from including files.
---
.mailmap | 5 +-
MAINTAINERS | 8 ++++
doc/guides/nics/features/sssnic.ini | 9 ++++
doc/guides/nics/index.rst | 1 +
doc/guides/nics/sssnic.rst | 73 +++++++++++++++++++++++++++++
drivers/net/meson.build | 1 +
drivers/net/sssnic/meson.build | 18 +++++++
drivers/net/sssnic/sssnic_ethdev.c | 28 +++++++++++
8 files changed, 140 insertions(+), 3 deletions(-)
create mode 100644 doc/guides/nics/features/sssnic.ini
create mode 100644 doc/guides/nics/sssnic.rst
create mode 100644 drivers/net/sssnic/meson.build
create mode 100644 drivers/net/sssnic/sssnic_ethdev.c
Comments
On Fri, Sep 1, 2023 at 11:35 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>
> ---
> v2:
> * Fixed 'Title underline too short' in doc/guides/nics/sssnic.rst.
> * Removed error.h from including files.
> ---
> .mailmap | 5 +-
> MAINTAINERS | 8 ++++
> doc/guides/nics/features/sssnic.ini | 9 ++++
> doc/guides/nics/index.rst | 1 +
> doc/guides/nics/sssnic.rst | 73 +++++++++++++++++++++++++++++
> drivers/net/meson.build | 1 +
> drivers/net/sssnic/meson.build | 18 +++++++
> drivers/net/sssnic/sssnic_ethdev.c | 28 +++++++++++
> 8 files changed, 140 insertions(+), 3 deletions(-)
> create mode 100644 doc/guides/nics/features/sssnic.ini
> create mode 100644 doc/guides/nics/sssnic.rst
> create mode 100644 drivers/net/sssnic/meson.build
> create mode 100644 drivers/net/sssnic/sssnic_ethdev.c
>
> diff --git a/.mailmap b/.mailmap
> index 864d33ee46..6fa73d3b79 100644
> --- a/.mailmap
> +++ b/.mailmap
> @@ -151,7 +151,6 @@ Bao-Long Tran <longtb5@viettel.com.vn>
> Bar Neuman <bneuman@nvidia.com>
> Barak Enat <barak@saguna.net>
> Barry Cao <barry.cao@nxp.com>
> -Bartosz Staszewski <bartoszx.staszewski@intel.com>
> Baruch Siach <baruch@tkos.co.il>
> Bassam Zaid AlKilani <bzalkilani@nvidia.com>
> Beilei Xing <beilei.xing@intel.com>
This looks like some rebase damage, or at least unwanted changes.
Please fix.
> @@ -496,7 +495,6 @@ Helin Zhang <helin.zhang@intel.com>
> Hemant Agrawal <hemant.agrawal@nxp.com> <hemant@freescale.com>
> Heng Ding <hengx.ding@intel.com>
> Hengjian Zhang <hengjianx.zhang@intel.com>
> -Heng Jiang <jiangheng14@huawei.com>
> Heng Wang <heng.wang@ericsson.com>
> Henning Schild <henning.schild@siemens.com>
> Henry Cai <caihe@huawei.com>
> @@ -630,7 +628,6 @@ Jie Liu <jie2.liu@hxt-semitech.com>
> Jie Pan <panjie5@jd.com>
> Jie Wang <jie1x.wang@intel.com>
> Jie Zhou <jizh@linux.microsoft.com> <jizh@microsoft.com>
> -Jieqiang Wang <jieqiang.wang@arm.com>
> Jijiang Liu <jijiang.liu@intel.com>
> Jilei Chen <chenjilei@cmss.chinamobile.com>
> Jim Harris <james.r.harris@intel.com>
> @@ -1156,6 +1153,7 @@ Rebecca Troy <rebecca.troy@intel.com>
> Remi Pommarel <repk@triplefau.lt>
> Remy Horton <remy.horton@intel.com>
> Renata Saiakhova <renata.saiakhova@ekinops.com>
> +Renyong Wan <wanry@3snic.com>
> Reshma Pattan <reshma.pattan@intel.com> <reshma.pattan@gmail.com>
> Ricardo Roldan <rroldan@bequant.com>
> Ricardo Salveti <ricardo.salveti@linaro.org>
> @@ -1329,6 +1327,7 @@ Stephen Hurd <stephen.hurd@broadcom.com> <shurd@broadcom.com>
> Steve Capper <steve.capper@arm.com>
> Steven Lariau <steven.lariau@arm.com>
> Steven Luong <sluong@cisco.com>
> +Steven Song <steven.song@3snic.com>
> Steven Webster <steven.webster@windriver.com>
> Steven Zou <steven.zou@intel.com>
> Steve Rempe <steve.rempe@broadcom.com>
> diff --git a/MAINTAINERS b/MAINTAINERS
> index a926155f26..1e57d29aa3 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -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: driver/net/sssnic/
This path is incorrect.
*drivers*
> +F: doc/guides/nics/sssnic.rst
> +F: doc/guides/nics/features/sssnic.ini
> +
> Amazon ENA
> M: Michal Krawczyk <mk@semihalf.com>
> M: Shai Brandes <shaibran@amazon.com>
> @@ -1793,6 +1800,7 @@ F: doc/guides/tools/img/eventdev_*
> F: app/test/test_event_ring.c
>
> Procinfo tool
> +M: Maryam Tahhan <maryam.tahhan@intel.com>
> M: Reshma Pattan <reshma.pattan@intel.com>
> F: app/proc-info/
> F: doc/guides/tools/proc_info.rst
Thanks for your reply, I'll fix them next version.
On 2023/9/1 19:54, David Marchand wrote:
> On Fri, Sep 1, 2023 at 11:35 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>
>> ---
>> v2:
>> * Fixed 'Title underline too short' in doc/guides/nics/sssnic.rst.
>> * Removed error.h from including files.
>> ---
>> .mailmap | 5 +-
>> MAINTAINERS | 8 ++++
>> doc/guides/nics/features/sssnic.ini | 9 ++++
>> doc/guides/nics/index.rst | 1 +
>> doc/guides/nics/sssnic.rst | 73 +++++++++++++++++++++++++++++
>> drivers/net/meson.build | 1 +
>> drivers/net/sssnic/meson.build | 18 +++++++
>> drivers/net/sssnic/sssnic_ethdev.c | 28 +++++++++++
>> 8 files changed, 140 insertions(+), 3 deletions(-)
>> create mode 100644 doc/guides/nics/features/sssnic.ini
>> create mode 100644 doc/guides/nics/sssnic.rst
>> create mode 100644 drivers/net/sssnic/meson.build
>> create mode 100644 drivers/net/sssnic/sssnic_ethdev.c
>>
>> diff --git a/.mailmap b/.mailmap
>> index 864d33ee46..6fa73d3b79 100644
>> --- a/.mailmap
>> +++ b/.mailmap
>> @@ -151,7 +151,6 @@ Bao-Long Tran <longtb5@viettel.com.vn>
>> Bar Neuman <bneuman@nvidia.com>
>> Barak Enat <barak@saguna.net>
>> Barry Cao <barry.cao@nxp.com>
>> -Bartosz Staszewski <bartoszx.staszewski@intel.com>
>> Baruch Siach <baruch@tkos.co.il>
>> Bassam Zaid AlKilani <bzalkilani@nvidia.com>
>> Beilei Xing <beilei.xing@intel.com>
> This looks like some rebase damage, or at least unwanted changes.
> Please fix.
>
>> @@ -496,7 +495,6 @@ Helin Zhang <helin.zhang@intel.com>
>> Hemant Agrawal <hemant.agrawal@nxp.com> <hemant@freescale.com>
>> Heng Ding <hengx.ding@intel.com>
>> Hengjian Zhang <hengjianx.zhang@intel.com>
>> -Heng Jiang <jiangheng14@huawei.com>
>> Heng Wang <heng.wang@ericsson.com>
>> Henning Schild <henning.schild@siemens.com>
>> Henry Cai <caihe@huawei.com>
>> @@ -630,7 +628,6 @@ Jie Liu <jie2.liu@hxt-semitech.com>
>> Jie Pan <panjie5@jd.com>
>> Jie Wang <jie1x.wang@intel.com>
>> Jie Zhou <jizh@linux.microsoft.com> <jizh@microsoft.com>
>> -Jieqiang Wang <jieqiang.wang@arm.com>
>> Jijiang Liu <jijiang.liu@intel.com>
>> Jilei Chen <chenjilei@cmss.chinamobile.com>
>> Jim Harris <james.r.harris@intel.com>
>> @@ -1156,6 +1153,7 @@ Rebecca Troy <rebecca.troy@intel.com>
>> Remi Pommarel <repk@triplefau.lt>
>> Remy Horton <remy.horton@intel.com>
>> Renata Saiakhova <renata.saiakhova@ekinops.com>
>> +Renyong Wan <wanry@3snic.com>
>> Reshma Pattan <reshma.pattan@intel.com> <reshma.pattan@gmail.com>
>> Ricardo Roldan <rroldan@bequant.com>
>> Ricardo Salveti <ricardo.salveti@linaro.org>
>> @@ -1329,6 +1327,7 @@ Stephen Hurd <stephen.hurd@broadcom.com> <shurd@broadcom.com>
>> Steve Capper <steve.capper@arm.com>
>> Steven Lariau <steven.lariau@arm.com>
>> Steven Luong <sluong@cisco.com>
>> +Steven Song <steven.song@3snic.com>
>> Steven Webster <steven.webster@windriver.com>
>> Steven Zou <steven.zou@intel.com>
>> Steve Rempe <steve.rempe@broadcom.com>
>> diff --git a/MAINTAINERS b/MAINTAINERS
>> index a926155f26..1e57d29aa3 100644
>> --- a/MAINTAINERS
>> +++ b/MAINTAINERS
>> @@ -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: driver/net/sssnic/
> This path is incorrect.
> *drivers*
>
>> +F: doc/guides/nics/sssnic.rst
>> +F: doc/guides/nics/features/sssnic.ini
>> +
>> Amazon ENA
>> M: Michal Krawczyk <mk@semihalf.com>
>> M: Shai Brandes <shaibran@amazon.com>
>> @@ -1793,6 +1800,7 @@ F: doc/guides/tools/img/eventdev_*
>> F: app/test/test_event_ring.c
>>
>> Procinfo tool
>> +M: Maryam Tahhan <maryam.tahhan@intel.com>
>> M: Reshma Pattan <reshma.pattan@intel.com>
>> F: app/proc-info/
>> F: doc/guides/tools/proc_info.rst
>
@@ -151,7 +151,6 @@ Bao-Long Tran <longtb5@viettel.com.vn>
Bar Neuman <bneuman@nvidia.com>
Barak Enat <barak@saguna.net>
Barry Cao <barry.cao@nxp.com>
-Bartosz Staszewski <bartoszx.staszewski@intel.com>
Baruch Siach <baruch@tkos.co.il>
Bassam Zaid AlKilani <bzalkilani@nvidia.com>
Beilei Xing <beilei.xing@intel.com>
@@ -496,7 +495,6 @@ Helin Zhang <helin.zhang@intel.com>
Hemant Agrawal <hemant.agrawal@nxp.com> <hemant@freescale.com>
Heng Ding <hengx.ding@intel.com>
Hengjian Zhang <hengjianx.zhang@intel.com>
-Heng Jiang <jiangheng14@huawei.com>
Heng Wang <heng.wang@ericsson.com>
Henning Schild <henning.schild@siemens.com>
Henry Cai <caihe@huawei.com>
@@ -630,7 +628,6 @@ Jie Liu <jie2.liu@hxt-semitech.com>
Jie Pan <panjie5@jd.com>
Jie Wang <jie1x.wang@intel.com>
Jie Zhou <jizh@linux.microsoft.com> <jizh@microsoft.com>
-Jieqiang Wang <jieqiang.wang@arm.com>
Jijiang Liu <jijiang.liu@intel.com>
Jilei Chen <chenjilei@cmss.chinamobile.com>
Jim Harris <james.r.harris@intel.com>
@@ -1156,6 +1153,7 @@ Rebecca Troy <rebecca.troy@intel.com>
Remi Pommarel <repk@triplefau.lt>
Remy Horton <remy.horton@intel.com>
Renata Saiakhova <renata.saiakhova@ekinops.com>
+Renyong Wan <wanry@3snic.com>
Reshma Pattan <reshma.pattan@intel.com> <reshma.pattan@gmail.com>
Ricardo Roldan <rroldan@bequant.com>
Ricardo Salveti <ricardo.salveti@linaro.org>
@@ -1329,6 +1327,7 @@ Stephen Hurd <stephen.hurd@broadcom.com> <shurd@broadcom.com>
Steve Capper <steve.capper@arm.com>
Steven Lariau <steven.lariau@arm.com>
Steven Luong <sluong@cisco.com>
+Steven Song <steven.song@3snic.com>
Steven Webster <steven.webster@windriver.com>
Steven Zou <steven.zou@intel.com>
Steve Rempe <steve.rempe@broadcom.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: driver/net/sssnic/
+F: doc/guides/nics/sssnic.rst
+F: doc/guides/nics/features/sssnic.ini
+
Amazon ENA
M: Michal Krawczyk <mk@semihalf.com>
M: Shai Brandes <shaibran@amazon.com>
@@ -1793,6 +1800,7 @@ F: doc/guides/tools/img/eventdev_*
F: app/test/test_event_ring.c
Procinfo tool
+M: Maryam Tahhan <maryam.tahhan@intel.com>
M: Reshma Pattan <reshma.pattan@intel.com>
F: app/proc-info/
F: doc/guides/tools/proc_info.rst
new file mode 100644
@@ -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
@@ -61,6 +61,7 @@ Network Interface Controller Drivers
qede
sfc_efx
softnic
+ sssnic
tap
thunderx
txgbe
new file mode 100644
@@ -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
+
+
+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
+
+
+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.
+Power8, ARMv7 and BSD are not supported yet.
@@ -54,6 +54,7 @@ drivers = [
'ring',
'sfc',
'softnic',
+ 'sssnic',
'tap',
'thunderx',
'txgbe',
new file mode 100644
@@ -0,0 +1,18 @@
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright(c) 2018-2022 Shenzhen 3SNIC Information Technology Co., Ltd.
+
+if not is_linux
+ build = false
+ reason = 'only supported on Linux'
+ subdir_done()
+endif
+
+if (arch_subdir != 'x86' and arch_subdir != 'arm') or (not dpdk_conf.get('RTE_ARCH_64'))
+ build = false
+ reason = 'only supported on x86_64 and aarch64'
+ subdir_done()
+endif
+
+sources = files(
+ 'sssnic_ethdev.c',
+)
new file mode 100644
@@ -0,0 +1,28 @@
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(c) 2018-2022 Shenzhen 3SNIC Information Technology Co., Ltd.
+ */
+
+#include <rte_common.h>
+#include <ethdev_pci.h>
+
+static int
+sssnic_pci_probe(struct rte_pci_driver *pci_drv, struct rte_pci_device *pci_dev)
+{
+ RTE_SET_USED(pci_drv);
+ RTE_SET_USED(pci_dev);
+ return -EINVAL;
+}
+
+static int
+sssnic_pci_remove(struct rte_pci_device *pci_dev)
+{
+ RTE_SET_USED(pci_dev);
+ return -EINVAL;
+}
+
+static struct rte_pci_driver sssnic_pmd = {
+ .probe = sssnic_pci_probe,
+ .remove = sssnic_pci_remove,
+};
+
+RTE_PMD_REGISTER_PCI(net_sssnic, sssnic_pmd);