diff mbox series

perf: add missing MODULE_DESCRIPTION() macros

Message ID 20240611-md-drivers-perf-v1-1-c001bae6da5c@quicinc.com (mailing list archive)
State Superseded
Headers show
Series perf: add missing MODULE_DESCRIPTION() macros | expand

Commit Message

Jeff Johnson June 11, 2024, 6:31 p.m. UTC 
With ARCH=x86, make allmodconfig && make W=1 C=1 reports:
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/perf/arm-ccn.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/perf/fsl_imx8_ddr_perf.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/perf/marvell_cn10k_ddr_pmu.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/perf/arm_cspmu/arm_cspmu_module.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/perf/arm_cspmu/nvidia_cspmu.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/perf/arm_cspmu/ampere_cspmu.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/perf/cxl_pmu.o

Add the missing invocation of the MODULE_DESCRIPTION() macro to all
files which have a MODULE_LICENSE().

This includes drivers/perf/hisilicon/hisi_uncore_pmu.c which, although
it did not produce a warning with the x86 allmodconfig configuration,
may cause this warning with arm64 configurations.

Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>
---
 drivers/perf/arm-ccn.c                   | 1 +
 drivers/perf/arm_cspmu/ampere_cspmu.c    | 1 +
 drivers/perf/arm_cspmu/arm_cspmu.c       | 1 +
 drivers/perf/arm_cspmu/nvidia_cspmu.c    | 1 +
 drivers/perf/cxl_pmu.c                   | 1 +
 drivers/perf/fsl_imx8_ddr_perf.c         | 1 +
 drivers/perf/hisilicon/hisi_uncore_pmu.c | 1 +
 drivers/perf/marvell_cn10k_ddr_pmu.c     | 1 +
 8 files changed, 8 insertions(+)


---
base-commit: 83a7eefedc9b56fe7bfeff13b6c7356688ffa670
change-id: 20240611-md-drivers-perf-5d834208964d

Comments

Yicong Yang June 18, 2024, 2:33 p.m. UTC | #1 
Hi Jeff,

On 2024/6/12 2:31, Jeff Johnson wrote:
> With ARCH=x86, make allmodconfig && make W=1 C=1 reports:
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/perf/arm-ccn.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/perf/fsl_imx8_ddr_perf.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/perf/marvell_cn10k_ddr_pmu.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/perf/arm_cspmu/arm_cspmu_module.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/perf/arm_cspmu/nvidia_cspmu.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/perf/arm_cspmu/ampere_cspmu.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/perf/cxl_pmu.o
> 
> Add the missing invocation of the MODULE_DESCRIPTION() macro to all
> files which have a MODULE_LICENSE().
> 
> This includes drivers/perf/hisilicon/hisi_uncore_pmu.c which, although
> it did not produce a warning with the x86 allmodconfig configuration,
> may cause this warning with arm64 configurations.
> 

Thanks for catching this. I can reproduce this by my config:

➜  hisilicon git:(master) make -C ../../../ M=$(pwd) W=1
make: Entering directory '/home/yangyicong/mainline_linux/linux'
  CC [M]  /home/yangyicong/mainline_linux/linux/drivers/perf/hisilicon/hisi_uncore_pmu.o
  CC [M]  /home/yangyicong/mainline_linux/linux/drivers/perf/hisilicon/hisi_uncore_l3c_pmu.o
  CC [M]  /home/yangyicong/mainline_linux/linux/drivers/perf/hisilicon/hisi_uncore_hha_pmu.o
  CC [M]  /home/yangyicong/mainline_linux/linux/drivers/perf/hisilicon/hisi_uncore_ddrc_pmu.o
  CC [M]  /home/yangyicong/mainline_linux/linux/drivers/perf/hisilicon/hisi_uncore_sllc_pmu.o
  CC [M]  /home/yangyicong/mainline_linux/linux/drivers/perf/hisilicon/hisi_uncore_pa_pmu.o
  CC [M]  /home/yangyicong/mainline_linux/linux/drivers/perf/hisilicon/hisi_uncore_cpa_pmu.o
  CC [M]  /home/yangyicong/mainline_linux/linux/drivers/perf/hisilicon/hisi_uncore_uc_pmu.o
  CC [M]  /home/yangyicong/mainline_linux/linux/drivers/perf/hisilicon/hisi_pcie_pmu.o
  CC [M]  /home/yangyicong/mainline_linux/linux/drivers/perf/hisilicon/hns3_pmu.o
  MODPOST /home/yangyicong/mainline_linux/linux/drivers/perf/hisilicon/Module.symvers
WARNING: modpost: missing MODULE_DESCRIPTION() in /home/yangyicong/mainline_linux/linux/drivers/perf/hisilicon/hisi_uncore_pmu.o

This warning is introduced by 1fffe7a34c89 ("script: modpost: emit a warning when the description is missing")
from v6.5 so we didn't catch this. Once comment below.

> Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>
> ---
>  drivers/perf/arm-ccn.c                   | 1 +
>  drivers/perf/arm_cspmu/ampere_cspmu.c    | 1 +
>  drivers/perf/arm_cspmu/arm_cspmu.c       | 1 +
>  drivers/perf/arm_cspmu/nvidia_cspmu.c    | 1 +
>  drivers/perf/cxl_pmu.c                   | 1 +
>  drivers/perf/fsl_imx8_ddr_perf.c         | 1 +
>  drivers/perf/hisilicon/hisi_uncore_pmu.c | 1 +
>  drivers/perf/marvell_cn10k_ddr_pmu.c     | 1 +
>  8 files changed, 8 insertions(+)
> 
> diff --git a/drivers/perf/arm-ccn.c b/drivers/perf/arm-ccn.c
> index 86ef31ac7503..65f4882531db 100644
> --- a/drivers/perf/arm-ccn.c
> +++ b/drivers/perf/arm-ccn.c
> @@ -1561,4 +1561,5 @@ module_init(arm_ccn_init);
>  module_exit(arm_ccn_exit);
>  
>  MODULE_AUTHOR("Pawel Moll <pawel.moll@arm.com>");
> +MODULE_DESCRIPTION("ARM CCN (Cache Coherent Network) driver support");
>  MODULE_LICENSE("GPL v2");
> diff --git a/drivers/perf/arm_cspmu/ampere_cspmu.c b/drivers/perf/arm_cspmu/ampere_cspmu.c
> index f146a455e838..426b3cfcb52e 100644
> --- a/drivers/perf/arm_cspmu/ampere_cspmu.c
> +++ b/drivers/perf/arm_cspmu/ampere_cspmu.c
> @@ -269,4 +269,5 @@ static void __exit ampere_cspmu_exit(void)
>  module_init(ampere_cspmu_init);
>  module_exit(ampere_cspmu_exit);
>  
> +MODULE_DESCRIPTION("Ampere SoC PMU (Performance Monitor Unit) driver");
>  MODULE_LICENSE("GPL");
> diff --git a/drivers/perf/arm_cspmu/arm_cspmu.c b/drivers/perf/arm_cspmu/arm_cspmu.c
> index c318dc909767..c21c564840d6 100644
> --- a/drivers/perf/arm_cspmu/arm_cspmu.c
> +++ b/drivers/perf/arm_cspmu/arm_cspmu.c
> @@ -1427,4 +1427,5 @@ EXPORT_SYMBOL_GPL(arm_cspmu_impl_unregister);
>  module_init(arm_cspmu_init);
>  module_exit(arm_cspmu_exit);
>  
> +MODULE_DESCRIPTION("ARM CoreSight Architecture PMU driver");
>  MODULE_LICENSE("GPL v2");
> diff --git a/drivers/perf/arm_cspmu/nvidia_cspmu.c b/drivers/perf/arm_cspmu/nvidia_cspmu.c
> index 5b84b701ad62..0dea47e48ac5 100644
> --- a/drivers/perf/arm_cspmu/nvidia_cspmu.c
> +++ b/drivers/perf/arm_cspmu/nvidia_cspmu.c
> @@ -417,4 +417,5 @@ static void __exit nvidia_cspmu_exit(void)
>  module_init(nvidia_cspmu_init);
>  module_exit(nvidia_cspmu_exit);
>  
> +MODULE_DESCRIPTION("NVIDIA Coresight Architecture PMU driver");
>  MODULE_LICENSE("GPL v2");
> diff --git a/drivers/perf/cxl_pmu.c b/drivers/perf/cxl_pmu.c
> index 1f93a66eff5b..8b6ce9ea5a55 100644
> --- a/drivers/perf/cxl_pmu.c
> +++ b/drivers/perf/cxl_pmu.c
> @@ -972,6 +972,7 @@ static __exit void cxl_pmu_exit(void)
>  	cpuhp_remove_multi_state(cxl_pmu_cpuhp_state_num);
>  }
>  
> +MODULE_DESCRIPTION("CXL Performance Monitoring Unit driver");
>  MODULE_LICENSE("GPL");
>  MODULE_IMPORT_NS(CXL);
>  module_init(cxl_pmu_init);
> diff --git a/drivers/perf/fsl_imx8_ddr_perf.c b/drivers/perf/fsl_imx8_ddr_perf.c
> index 1bbdb29743c4..a6683b38315c 100644
> --- a/drivers/perf/fsl_imx8_ddr_perf.c
> +++ b/drivers/perf/fsl_imx8_ddr_perf.c
> @@ -850,4 +850,5 @@ static struct platform_driver imx_ddr_pmu_driver = {
>  };
>  
>  module_platform_driver(imx_ddr_pmu_driver);
> +MODULE_DESCRIPTION("Freescale i.MX8 DDR PMU driver");
>  MODULE_LICENSE("GPL v2");
> diff --git a/drivers/perf/hisilicon/hisi_uncore_pmu.c b/drivers/perf/hisilicon/hisi_uncore_pmu.c
> index 6392cbedcd06..e1df9db498e9 100644
> --- a/drivers/perf/hisilicon/hisi_uncore_pmu.c
> +++ b/drivers/perf/hisilicon/hisi_uncore_pmu.c
> @@ -537,4 +537,5 @@ void hisi_pmu_init(struct hisi_pmu *hisi_pmu, struct module *module)
>  }
>  EXPORT_SYMBOL_GPL(hisi_pmu_init);
>  
> +MODULE_DESCRIPTION("HiSilicon SoC PMU driver");

This module's not a driver but provides the framework for other HiSilicon uncore PMUs. Should be
more proper to make this "HiSilicon SoC uncore PMU driver framework".

Thanks.

>  MODULE_LICENSE("GPL v2");
> diff --git a/drivers/perf/marvell_cn10k_ddr_pmu.c b/drivers/perf/marvell_cn10k_ddr_pmu.c
> index e2abca188dbe..94f1ebcd2a27 100644
> --- a/drivers/perf/marvell_cn10k_ddr_pmu.c
> +++ b/drivers/perf/marvell_cn10k_ddr_pmu.c
> @@ -763,4 +763,5 @@ module_init(cn10k_ddr_pmu_init);
>  module_exit(cn10k_ddr_pmu_exit);
>  
>  MODULE_AUTHOR("Bharat Bhushan <bbhushan2@marvell.com>");
> +MODULE_DESCRIPTION("Marvell CN10K DRAM Subsystem (DSS) Performance Monitor Driver");
>  MODULE_LICENSE("GPL v2");
> 
> ---
> base-commit: 83a7eefedc9b56fe7bfeff13b6c7356688ffa670
> change-id: 20240611-md-drivers-perf-5d834208964d
> 
> .
>
Jeff Johnson June 18, 2024, 2:55 p.m. UTC | #2 
On 6/18/2024 7:33 AM, Yicong Yang wrote:
...

>> +MODULE_DESCRIPTION("HiSilicon SoC PMU driver");
> 
> This module's not a driver but provides the framework for other HiSilicon uncore PMUs. Should be
> more proper to make this "HiSilicon SoC uncore PMU driver framework".

Thanks for the clarification. I'll update in v2
Jonathan Cameron June 18, 2024, 5:06 p.m. UTC | #3 
On Tue, 11 Jun 2024 11:31:06 -0700
Jeff Johnson <quic_jjohnson@quicinc.com> wrote:

> With ARCH=x86, make allmodconfig && make W=1 C=1 reports:
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/perf/arm-ccn.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/perf/fsl_imx8_ddr_perf.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/perf/marvell_cn10k_ddr_pmu.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/perf/arm_cspmu/arm_cspmu_module.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/perf/arm_cspmu/nvidia_cspmu.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/perf/arm_cspmu/ampere_cspmu.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/perf/cxl_pmu.o
> 
> Add the missing invocation of the MODULE_DESCRIPTION() macro to all
> files which have a MODULE_LICENSE().
> 
> This includes drivers/perf/hisilicon/hisi_uncore_pmu.c which, although
> it did not produce a warning with the x86 allmodconfig configuration,
> may cause this warning with arm64 configurations.
> 
> Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>
Acked-by: Jonathan Cameron <Jonathan.Cameron@huawei.com> # for CXL PMU
diff mbox series

Patch

diff --git a/drivers/perf/arm-ccn.c b/drivers/perf/arm-ccn.c
index 86ef31ac7503..65f4882531db 100644
--- a/drivers/perf/arm-ccn.c
+++ b/drivers/perf/arm-ccn.c
@@ -1561,4 +1561,5 @@  module_init(arm_ccn_init);
 module_exit(arm_ccn_exit);
 
 MODULE_AUTHOR("Pawel Moll <pawel.moll@arm.com>");
+MODULE_DESCRIPTION("ARM CCN (Cache Coherent Network) driver support");
 MODULE_LICENSE("GPL v2");
diff --git a/drivers/perf/arm_cspmu/ampere_cspmu.c b/drivers/perf/arm_cspmu/ampere_cspmu.c
index f146a455e838..426b3cfcb52e 100644
--- a/drivers/perf/arm_cspmu/ampere_cspmu.c
+++ b/drivers/perf/arm_cspmu/ampere_cspmu.c
@@ -269,4 +269,5 @@  static void __exit ampere_cspmu_exit(void)
 module_init(ampere_cspmu_init);
 module_exit(ampere_cspmu_exit);
 
+MODULE_DESCRIPTION("Ampere SoC PMU (Performance Monitor Unit) driver");
 MODULE_LICENSE("GPL");
diff --git a/drivers/perf/arm_cspmu/arm_cspmu.c b/drivers/perf/arm_cspmu/arm_cspmu.c
index c318dc909767..c21c564840d6 100644
--- a/drivers/perf/arm_cspmu/arm_cspmu.c
+++ b/drivers/perf/arm_cspmu/arm_cspmu.c
@@ -1427,4 +1427,5 @@  EXPORT_SYMBOL_GPL(arm_cspmu_impl_unregister);
 module_init(arm_cspmu_init);
 module_exit(arm_cspmu_exit);
 
+MODULE_DESCRIPTION("ARM CoreSight Architecture PMU driver");
 MODULE_LICENSE("GPL v2");
diff --git a/drivers/perf/arm_cspmu/nvidia_cspmu.c b/drivers/perf/arm_cspmu/nvidia_cspmu.c
index 5b84b701ad62..0dea47e48ac5 100644
--- a/drivers/perf/arm_cspmu/nvidia_cspmu.c
+++ b/drivers/perf/arm_cspmu/nvidia_cspmu.c
@@ -417,4 +417,5 @@  static void __exit nvidia_cspmu_exit(void)
 module_init(nvidia_cspmu_init);
 module_exit(nvidia_cspmu_exit);
 
+MODULE_DESCRIPTION("NVIDIA Coresight Architecture PMU driver");
 MODULE_LICENSE("GPL v2");
diff --git a/drivers/perf/cxl_pmu.c b/drivers/perf/cxl_pmu.c
index 1f93a66eff5b..8b6ce9ea5a55 100644
--- a/drivers/perf/cxl_pmu.c
+++ b/drivers/perf/cxl_pmu.c
@@ -972,6 +972,7 @@  static __exit void cxl_pmu_exit(void)
 	cpuhp_remove_multi_state(cxl_pmu_cpuhp_state_num);
 }
 
+MODULE_DESCRIPTION("CXL Performance Monitoring Unit driver");
 MODULE_LICENSE("GPL");
 MODULE_IMPORT_NS(CXL);
 module_init(cxl_pmu_init);
diff --git a/drivers/perf/fsl_imx8_ddr_perf.c b/drivers/perf/fsl_imx8_ddr_perf.c
index 1bbdb29743c4..a6683b38315c 100644
--- a/drivers/perf/fsl_imx8_ddr_perf.c
+++ b/drivers/perf/fsl_imx8_ddr_perf.c
@@ -850,4 +850,5 @@  static struct platform_driver imx_ddr_pmu_driver = {
 };
 
 module_platform_driver(imx_ddr_pmu_driver);
+MODULE_DESCRIPTION("Freescale i.MX8 DDR PMU driver");
 MODULE_LICENSE("GPL v2");
diff --git a/drivers/perf/hisilicon/hisi_uncore_pmu.c b/drivers/perf/hisilicon/hisi_uncore_pmu.c
index 6392cbedcd06..e1df9db498e9 100644
--- a/drivers/perf/hisilicon/hisi_uncore_pmu.c
+++ b/drivers/perf/hisilicon/hisi_uncore_pmu.c
@@ -537,4 +537,5 @@  void hisi_pmu_init(struct hisi_pmu *hisi_pmu, struct module *module)
 }
 EXPORT_SYMBOL_GPL(hisi_pmu_init);
 
+MODULE_DESCRIPTION("HiSilicon SoC PMU driver");
 MODULE_LICENSE("GPL v2");
diff --git a/drivers/perf/marvell_cn10k_ddr_pmu.c b/drivers/perf/marvell_cn10k_ddr_pmu.c
index e2abca188dbe..94f1ebcd2a27 100644
--- a/drivers/perf/marvell_cn10k_ddr_pmu.c
+++ b/drivers/perf/marvell_cn10k_ddr_pmu.c
@@ -763,4 +763,5 @@  module_init(cn10k_ddr_pmu_init);
 module_exit(cn10k_ddr_pmu_exit);
 
 MODULE_AUTHOR("Bharat Bhushan <bbhushan2@marvell.com>");
+MODULE_DESCRIPTION("Marvell CN10K DRAM Subsystem (DSS) Performance Monitor Driver");
 MODULE_LICENSE("GPL v2");