net/sxe: add base driver directory and rough doc documentation
Subsystems (2)
PATCH 1/1 net/sxe: add base driver directory and rough doc documentation
Adding a minimum maintainable directory structure for the network driver and request maintenance of the sxe driver.
Signed-off-by Jie Liu <[email protected]>
--- MAINTAINERS | 6 ++++ doc/guides/nics/features/sxe.ini | 10 +++++++ doc/guides/nics/features/sxe_vf.ini | 10 +++++++ doc/guides/nics/sxe.rst | 40 +++++++++++++++++++++++++ drivers/net/sxe/meson.build | 9 ++++++ drivers/net/sxe/pf/sxe_ethdev.c | 3 ++ drivers/net/sxe/pf/sxe_ethdev.h | 3 ++ drivers/net/sxe/rte_pmd_sxe_version.map | 3 ++ drivers/net/sxe/version.map | 3 ++ 9 files changed, 87 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 create mode 100644 drivers/net/sxe/rte_pmd_sxe_version.map create mode 100644 drivers/net/sxe/version.map
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
doc/guides/nics/features/sxe.ini new file +10 -0
@@ -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
@@ -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/sxe.rst new file +40 -0
@@ -0,0 +1,40 @@ +.. 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. + + +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. + +SXE PMD provides the following log types available for control: + +- ``pmd.net.sxe.drv`` (default level is **DEBUG**) + + 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**) + + Affects tx-wide messages. +------------------------------ + +Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>` +for details.
drivers/net/sxe/meson.build new file +9 -0
@@ -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
@@ -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
@@ -0,0 +1,3 @@ +/* SPDX-License-Identifier: BSD-3-Clause +* Copyright(c) 2015-2024 +*/
drivers/net/sxe/rte_pmd_sxe_version.map new file +3 -0
@@ -0,0 +1,3 @@ +DPDK_24.0 { + local: *; +};
drivers/net/sxe/version.map new file +3 -0
@@ -0,0 +1,3 @@ +DPDK_25 { + local: *; +};
Signature · 1 line
2.27.0