[PATCH] net: dwc-xlgmac: fix missing MODULE_DESCRIPTION() warning

[PATCH] net: dwc-xlgmac: fix missing MODULE_DESCRIPTION() warning

[Jeff Johnson]

With ARCH=hexagon, make allmodconfig && make W=1 C=1 reports:
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/net/ethernet/synopsys/dwc-xlgmac.o

With most other ARCH settings the MODULE_DESCRIPTION() is provided by
the macro invocation in dwc-xlgmac-pci.c. However, for hexagon, the
PCI bus is not enabled, and hence CONFIG_DWC_XLGMAC_PCI is not set.
As a result, dwc-xlgmac-pci.c is not compiled, and hence is not linked
into dwc-xlgmac.o.

To avoid this issue, relocate the MODULE_DESCRIPTION() and other
related macros from dwc-xlgmac-pci.c to dwc-xlgmac-common.c, since
that file already has an existing MODULE_LICENSE() and it is
unconditionally linked into dwc-xlgmac.o.

Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>
---
 drivers/net/ethernet/synopsys/dwc-xlgmac-common.c | 7 +++++--
 drivers/net/ethernet/synopsys/dwc-xlgmac-pci.c    | 5 -----
 2 files changed, 5 insertions(+), 7 deletions(-)

diff --git a/drivers/net/ethernet/synopsys/dwc-xlgmac-common.c b/drivers/net/ethernet/synopsys/dwc-xlgmac-common.c
index f8e133604146..131786aa4d5b 100644
--- a/drivers/net/ethernet/synopsys/dwc-xlgmac-common.c
+++ b/drivers/net/ethernet/synopsys/dwc-xlgmac-common.c
@@ -21,8 +21,6 @@
 #include "dwc-xlgmac.h"
 #include "dwc-xlgmac-reg.h"
 
-MODULE_LICENSE("Dual BSD/GPL");
-
 static int debug = -1;
 module_param(debug, int, 0644);
 MODULE_PARM_DESC(debug, "DWC ethernet debug level (0=none,...,16=all)");
@@ -725,3 +723,8 @@ void xlgmac_print_all_hw_features(struct xlgmac_pdata *pdata)
 	XLGMAC_PR("=====================================================\n");
 	XLGMAC_PR("\n");
 }
+
+MODULE_DESCRIPTION(XLGMAC_DRV_DESC);
+MODULE_VERSION(XLGMAC_DRV_VERSION);
+MODULE_AUTHOR("Jie Deng <jiedeng@synopsys.com>");
+MODULE_LICENSE("Dual BSD/GPL");
diff --git a/drivers/net/ethernet/synopsys/dwc-xlgmac-pci.c b/drivers/net/ethernet/synopsys/dwc-xlgmac-pci.c
index fa8604d7b797..36fe538e3332 100644
--- a/drivers/net/ethernet/synopsys/dwc-xlgmac-pci.c
+++ b/drivers/net/ethernet/synopsys/dwc-xlgmac-pci.c
@@ -71,8 +71,3 @@ static struct pci_driver xlgmac_pci_driver = {
 };
 
 module_pci_driver(xlgmac_pci_driver);
-
-MODULE_DESCRIPTION(XLGMAC_DRV_DESC);
-MODULE_VERSION(XLGMAC_DRV_VERSION);
-MODULE_AUTHOR("Jie Deng <jiedeng@synopsys.com>");
-MODULE_LICENSE("Dual BSD/GPL");

---
base-commit: 83a7eefedc9b56fe7bfeff13b6c7356688ffa670
change-id: 20240616-md-hexagon-drivers-net-ethernet-synopsys-ec77b35f1a9a

Re: [PATCH] net: dwc-xlgmac: fix missing MODULE_DESCRIPTION() warning

[Jiri Pirko]

Sun, Jun 16, 2024 at 10:01:48PM CEST, quic_jjohnson@quicinc.com wrote:
>With ARCH=hexagon, make allmodconfig && make W=1 C=1 reports:
>WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/net/ethernet/synopsys/dwc-xlgmac.o
>
>With most other ARCH settings the MODULE_DESCRIPTION() is provided by
>the macro invocation in dwc-xlgmac-pci.c. However, for hexagon, the
>PCI bus is not enabled, and hence CONFIG_DWC_XLGMAC_PCI is not set.
>As a result, dwc-xlgmac-pci.c is not compiled, and hence is not linked
>into dwc-xlgmac.o.
>
>To avoid this issue, relocate the MODULE_DESCRIPTION() and other
>related macros from dwc-xlgmac-pci.c to dwc-xlgmac-common.c, since
>that file already has an existing MODULE_LICENSE() and it is
>unconditionally linked into dwc-xlgmac.o.
>
>Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>

Looks okay. Missing "Fixes" tag though. Please add it and send v2.
Also, please make obvious what tree you target using "[PATCH net]"
prefix.

Thanks.

pw-bot: cr

Re: [PATCH] net: dwc-xlgmac: fix missing MODULE_DESCRIPTION() warning

[Jakub Kicinski]

On Mon, 17 Jun 2024 13:04:53 +0200 Jiri Pirko wrote:
> Looks okay. Missing "Fixes" tag though. Please add it and send v2.
> Also, please make obvious what tree you target using "[PATCH net]"
> prefix.

I've been applying these to net-next lately, TBH.
Judging by the number of these warnings still left in the tree we are
the only ones who care.

Re: [PATCH] net: dwc-xlgmac: fix missing MODULE_DESCRIPTION() warning

[Jeff Johnson]

On 6/17/2024 5:14 PM, Jakub Kicinski wrote:
> On Mon, 17 Jun 2024 13:04:53 +0200 Jiri Pirko wrote:
>> Looks okay. Missing "Fixes" tag though. Please add it and send v2.
>> Also, please make obvious what tree you target using "[PATCH net]"
>> prefix.
> 
> I've been applying these to net-next lately, TBH.
> Judging by the number of these warnings still left in the tree we are
> the only ones who care.

I'm trying to get rid of these tree-wide.
Hope I'm not just tilting at windmills...

Re: [PATCH] net: dwc-xlgmac: fix missing MODULE_DESCRIPTION() warning

[Jakub Kicinski]

On Thu, 20 Jun 2024 16:41:04 -0700 Jeff Johnson wrote:
> > I've been applying these to net-next lately, TBH.
> > Judging by the number of these warnings still left in the tree we are
> > the only ones who care.  
> 
> I'm trying to get rid of these tree-wide.
> Hope I'm not just tilting at windmills...

Not at all, it's a lot of work but new ones don't get added very often
so there's a light at the end of the tunnel..
It'd be great if an incremental W=1 build didn't spit out 400+ warnings.

Re: [PATCH] net: dwc-xlgmac: fix missing MODULE_DESCRIPTION() warning

[patchwork-bot+netdevbpf]

Hello:

This patch was applied to netdev/net-next.git (main)
by Jakub Kicinski <kuba@kernel.org>:

On Sun, 16 Jun 2024 13:01:48 -0700 you wrote:
> With ARCH=hexagon, make allmodconfig && make W=1 C=1 reports:
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/net/ethernet/synopsys/dwc-xlgmac.o
> 
> With most other ARCH settings the MODULE_DESCRIPTION() is provided by
> the macro invocation in dwc-xlgmac-pci.c. However, for hexagon, the
> PCI bus is not enabled, and hence CONFIG_DWC_XLGMAC_PCI is not set.
> As a result, dwc-xlgmac-pci.c is not compiled, and hence is not linked
> into dwc-xlgmac.o.
> 
> [...]

Here is the summary with links:
  - net: dwc-xlgmac: fix missing MODULE_DESCRIPTION() warning
    https://git.kernel.org/netdev/net-next/c/0d9bb144276e

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html