Skip to contentSkip to conversation

net/sxe: add base driver directory and doc

PATCH Superseded Jie Liu 2 participants 2 messages Jan 3, 2025 – Feb 7, 2025

Subsystems (2)

v1 of 19 Superseded Latest is v19 →

lore
Share & tools
lore

Jie Liu

author
#0 lore raw

PATCH 1/1 net/sxe: add base driver directory and doc

Adding a minimum maintainable directory structure for the network driver and request maintenance of the sxe driver.

---
 MAINTAINERS                         |  6 +++++
 doc/guides/nics/features/sxe.ini    | 10 +++++++
 doc/guides/nics/features/sxe_vf.ini | 10 +++++++
 doc/guides/nics/index.rst           |  1 +
 doc/guides/nics/sxe.rst             | 41 +++++++++++++++++++++++++++++
 drivers/net/sxe/meson.build         |  9 +++++++
 drivers/net/sxe/pf/sxe_ethdev.c     |  3 +++
 drivers/net/sxe/pf/sxe_ethdev.h     |  3 +++
 8 files changed, 83 insertions(+)
 create mode 100644 doc/guides/nics/features/sxe.ini
 create mode 100644 doc/guides/nics/features/sxe_vf.ini
 create mode 100644 doc/guides/nics/sxe.rst
 create mode 100644 drivers/net/sxe/meson.build
 create mode 100644 drivers/net/sxe/pf/sxe_ethdev.c
 create mode 100644 drivers/net/sxe/pf/sxe_ethdev.h
MAINTAINERS +6 -0
index 60bdcce543..0af5b437db 100644
@@ -2039,3 +2039,9 @@ F: examples/vmdq/
 F: doc/guides/sample_app_ug/vmdq_forwarding.rst
 F: examples/vmdq_dcb/
 F: doc/guides/sample_app_ug/vmdq_dcb_forwarding.rst
+
+Linkdata sxe
+M: Jie Li <[email protected]>
+F: drivers/net/sxe/
+F: doc/guides/nics/sxe.rst
+F: doc/guides/nics/features/sxe*.ini
doc/guides/nics/features/sxe.ini new file +10 -0
new file mode 100644
index 0000000000..173ab48889
@@ -0,0 +1,10 @@
+;
+; Supported features of the 'sxe' network poll mode driver.
+;
+; Refer to default.ini for the full list of available PMD features.
+;
+[Features]
+Linux                = Y
+ARMv8                = Y
+x86-32               = Y
+x86-64               = Y
doc/guides/nics/features/sxe_vf.ini new file +10 -0
new file mode 100644
index 0000000000..76376dd4c3
@@ -0,0 +1,10 @@
+;
+; Supported features of the 'sxe_vf' network poll mode driver.
+;
+; Refer to default.ini for the full list of available PMD features.
+;
+[Features]
+Linux                = Y
+ARMv8                = Y
+x86-32               = Y
+x86-64               = Y
doc/guides/nics/index.rst +1 -0
index 50688d9f64..4d38b22321 100644
@@ -71,3 +71,4 @@ Network Interface Controller Drivers
     virtio
     vmxnet3
     zxdh
+    sxe
doc/guides/nics/sxe.rst new file +41 -0

41 lines not on this page · raw message

drivers/net/sxe/meson.build new file +9 -0
new file mode 100644
index 0000000000..dad9ee44a0
@@ -0,0 +1,9 @@
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright (C), 2020, Wuxi Stars Micro System Technologies Co., Ltd.
+
+deps += ['hash']
+sources = files(
+        'pf/sxe_ethdev.c',
+)
+
+includes += include_directories('pf')
drivers/net/sxe/pf/sxe_ethdev.c new file +3 -0
new file mode 100644
index 0000000000..e31a23deeb
@@ -0,0 +1,3 @@
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(c) 2015-2024
+ */
drivers/net/sxe/pf/sxe_ethdev.h new file +3 -0
new file mode 100644
index 0000000000..e31a23deeb
@@ -0,0 +1,3 @@
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(c) 2015-2024
+ */
Signature · 1 line
2.27.0
#1 lore raw
Quoted 4 lines · On Fri, 3 Jan 2025 00:29:09 -0800 Jie Liu <[email protected]>…

Adding a minimum maintainable directory structure for the network driver and request maintenance of the sxe driver.

Quoted 16 lines
---
 MAINTAINERS                         |  6 +++++
 doc/guides/nics/features/sxe.ini    | 10 +++++++
 doc/guides/nics/features/sxe_vf.ini | 10 +++++++
 doc/guides/nics/index.rst           |  1 +
 doc/guides/nics/sxe.rst             | 41 +++++++++++++++++++++++++++++
 drivers/net/sxe/meson.build         |  9 +++++++
 drivers/net/sxe/pf/sxe_ethdev.c     |  3 +++
 drivers/net/sxe/pf/sxe_ethdev.h     |  3 +++
 8 files changed, 83 insertions(+)
 create mode 100644 doc/guides/nics/features/sxe.ini
 create mode 100644 doc/guides/nics/features/sxe_vf.ini
 create mode 100644 doc/guides/nics/sxe.rst
 create mode 100644 drivers/net/sxe/meson.build
 create mode 100644 drivers/net/sxe/pf/sxe_ethdev.c
 create mode 100644 drivers/net/sxe/pf/sxe_ethdev.h

Thank you for starting work on a new driver.
We only accept drivers that have enough implemented to be useful. No templates or base only code.

Quoted 6 lines
MAINTAINERS +0 -0
index 60bdcce543..0af5b437db 100644

MAINTAINERS F: examples/vmdq/ · line 2047

Quoted 9 lines
MAINTAINERS +6 -0
@@ -2039,3 +2039,9 @@ F: examples/vmdq/
 F: doc/guides/sample_app_ug/vmdq_forwarding.rst
 F: examples/vmdq_dcb/
 F: doc/guides/sample_app_ug/vmdq_dcb_forwarding.rst
+
+Linkdata sxe
+M: Jie Li <[email protected]>
+F: drivers/net/sxe/
+F: doc/guides/nics/sxe.rst
+F: doc/guides/nics/features/sxe*.ini

The maintainers file has sections. There is one for Ethernet drivers. You should add your new entry there and in alphabetical order. That would put 'Linkdata sxe' after the last Intel driver 'Intel ip3nke'

Quoted 15 lines
doc/guides/nics/sxe.rst new file +9 -0
new file mode 100644
index 0000000000..0efb220595
@@ -0,0 +1,41 @@
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright (C), 2022, Linkdata Technology Co., Ltd.
+
+SXE Poll Mode Driver
+======================
+
+The SXE PMD (librte_pmd_sxe) provides poll mode driver support
+for Linkdata 1160-2X 10GE Ethernet Adapter.
+

doc/guides/nics/sxe.rst line 19

Quoted 10 lines
doc/guides/nics/sxe.rst new file +10 -0
+
+Configuration
+-------------
+
+Dynamic Logging Parameters
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+One may leverage EAL option "--log-level" to change default levels
+for the log types supported by the driver. The option is used with
+an argument typically consisting of two parts separated by a colon.

This is awkward sentence don't use passive voice. Look at the recent NTNIC PMD (ntnic.rst) for better wording.

Quoted 5 lines
doc/guides/nics/sxe.rst new file +5 -0
+
+SXE PMD provides the following log types available for control:
+
+- ``pmd.net.sxe.drv`` (default level is **DEBUG**)
+

doc/guides/nics/sxe.rst line 34

Quoted 10 lines
doc/guides/nics/sxe.rst new file +10 -0
+  Affects driver-wide messages unrelated to any particular devices.
+
+- ``pmd.net.sxe.init`` (default level is **DEBUG**)
+
+  Extra logging of the messages during PMD initialization.
+
+- ``pmd.net.sxe.rx`` (default level is **DEBUG**)
+
+  Affects rx-wide messages.
+- ``pmd.net.sxe.tx`` (default level is **DEBUG**)

The default in the release should not be DEBUG. That implies to me the driver is not tested and ready.

doc/guides/nics/sxe.rst line 41

Quoted 2 lines
doc/guides/nics/sxe.rst new file +2 -0
+Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
+for details.

That part is not necessary.

Please resubmit when more is ready.
See https://doc.dpdk.org/guides/contributing/new_driver.html