Re: [PATCH v9 net-next 14/14] pds_core: Kconfig and pds_core.rst

[Leon Romanovsky <leon@kernel.org>]

On Thu, Apr 06, 2023 at 04:41:43PM -0700, Shannon Nelson wrote:
> Documentation and Kconfig hook for building the driver.
> 
> Signed-off-by: Shannon Nelson <shannon.nelson@amd.com>
> ---
>  .../device_drivers/ethernet/amd/pds_core.rst     | 16 ++++++++++++++++
>  MAINTAINERS                                      |  9 +++++++++
>  drivers/net/ethernet/amd/Kconfig                 | 12 ++++++++++++
>  drivers/net/ethernet/amd/Makefile                |  1 +
>  4 files changed, 38 insertions(+)
> 
> diff --git a/Documentation/networking/device_drivers/ethernet/amd/pds_core.rst b/Documentation/networking/device_drivers/ethernet/amd/pds_core.rst
> index 9449451b538f..c5ef20f361da 100644
> --- a/Documentation/networking/device_drivers/ethernet/amd/pds_core.rst
> +++ b/Documentation/networking/device_drivers/ethernet/amd/pds_core.rst
> @@ -114,6 +114,22 @@ The driver supports a devlink health reporter for FW status::
>    # devlink health diagnose pci/0000:2b:00.0 reporter fw
>     Status: healthy State: 1 Generation: 0 Recoveries: 0
>  
> +Enabling the driver
> +===================
> +
> +The driver is enabled via the standard kernel configuration system,
> +using the make command::
> +
> +  make oldconfig/menuconfig/etc.
> +
> +The driver is located in the menu structure at:
> +
> +  -> Device Drivers
> +    -> Network device support (NETDEVICES [=y])
> +      -> Ethernet driver support
> +        -> AMD devices
> +          -> AMD/Pensando Ethernet PDS_CORE Support
> +
>  Support
>  =======
>  
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 30ca644d704f..95b5f25a2c06 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -1041,6 +1041,15 @@ F:	drivers/gpu/drm/amd/include/vi_structs.h
>  F:	include/uapi/linux/kfd_ioctl.h
>  F:	include/uapi/linux/kfd_sysfs.h
>  
> +AMD PDS CORE DRIVER
> +M:	Shannon Nelson <shannon.nelson@amd.com>
> +M:	Brett Creeley <brett.creeley@amd.com>
> +M:	drivers@pensando.io

I don't know if we have any policy here, but prefer if we won't add
private distribution lists to MAINTAINERS file. It is very annoying
to send emails to these lists and get responses from random people.

> +L:	netdev@vger.kernel.org
> +S:	Supported
> +F:	Documentation/networking/device_drivers/ethernet/amd/pds_core.rst
> +F:	drivers/net/ethernet/amd/pds_core/

You forgot to add includes to this list.

Thanks

> +
>  AMD SPI DRIVER
>  M:	Sanjay R Mehta <sanju.mehta@amd.com>
>  S:	Maintained
> diff --git a/drivers/net/ethernet/amd/Kconfig b/drivers/net/ethernet/amd/Kconfig
> index ab42f75b9413..235fcacef5c5 100644
> --- a/drivers/net/ethernet/amd/Kconfig
> +++ b/drivers/net/ethernet/amd/Kconfig
> @@ -186,4 +186,16 @@ config AMD_XGBE_HAVE_ECC
>  	bool
>  	default n
>  
> +config PDS_CORE
> +	tristate "AMD/Pensando Data Systems Core Device Support"
> +	depends on 64BIT && PCI
> +	help
> +	  This enables the support for the AMD/Pensando Core device family of
> +	  adapters.  More specific information on this driver can be
> +	  found in
> +	  <file:Documentation/networking/device_drivers/ethernet/amd/pds_core.rst>.
> +
> +	  To compile this driver as a module, choose M here. The module
> +	  will be called pds_core.
> +
>  endif # NET_VENDOR_AMD
> diff --git a/drivers/net/ethernet/amd/Makefile b/drivers/net/ethernet/amd/Makefile
> index 42742afe9115..2dcfb84731e1 100644
> --- a/drivers/net/ethernet/amd/Makefile
> +++ b/drivers/net/ethernet/amd/Makefile
> @@ -17,3 +17,4 @@ obj-$(CONFIG_PCNET32) += pcnet32.o
>  obj-$(CONFIG_SUN3LANCE) += sun3lance.o
>  obj-$(CONFIG_SUNLANCE) += sunlance.o
>  obj-$(CONFIG_AMD_XGBE) += xgbe/
> +obj-$(CONFIG_PDS_CORE) += pds_core/
> -- 
> 2.17.1
>