Re: [PATCH] net/sxe: add base driver directory and doc

[Stephen Hemminger <stephen@networkplumber.org>]

On Fri,  3 Jan 2025 00:29:09 -0800
Jie Liu <liujie5@linkdatatechnology.com> wrote:

> Adding a minimum maintainable directory structure for the
> network driver and request maintenance of the sxe driver.
> 
> Signed-off-by: Jie Liu <liujie5@linkdatatechnology.com>
> ---
>  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.

> 
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 60bdcce543..0af5b437db 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -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 <lijie@linkdatatechnology.com>
> +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'


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


> +
> +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**)

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


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