diff mbox series

cpufreq: powerpc: add missing MODULE_DESCRIPTION() macros

Message ID 20240614-md-powerpc-drivers-cpufreq-v1-1-de4034d87fd2@quicinc.com (mailing list archive)
State Handled Elsewhere, archived
Headers show
Series cpufreq: powerpc: add missing MODULE_DESCRIPTION() macros | expand

Checks

Context Check Description
snowpatch_ozlabs/github-powerpc_clang success Successfully ran 6 jobs.
snowpatch_ozlabs/github-powerpc_kernel_qemu success Successfully ran 23 jobs.
snowpatch_ozlabs/github-powerpc_sparse success Successfully ran 4 jobs.

Commit Message

Jeff Johnson June 15, 2024, 6:08 a.m. UTC 
With ARCH=powerpc, make allmodconfig && make W=1 C=1 reports:
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/cpufreq/ppc-cbe-cpufreq.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/cpufreq/powernv-cpufreq.o

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

This includes three additional files which, although they did not
produce a warning with the powerpc allmodconfig configuration, may
cause this warning with specific options enabled in the kernel
configuration.

Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>
---
Corrections to these descriptions are welcomed. I'm not an expert in
this code so in most cases I've taken these descriptions directly from
code comments, Kconfig descriptions, or git logs.  History has shown
that in some cases these are originally wrong due to cut-n-paste
errors, and in other cases the drivers have evolved such that the
original information is no longer accurate.
---
 drivers/cpufreq/maple-cpufreq.c   | 1 +
 drivers/cpufreq/pasemi-cpufreq.c  | 1 +
 drivers/cpufreq/pmac64-cpufreq.c  | 1 +
 drivers/cpufreq/powernv-cpufreq.c | 1 +
 drivers/cpufreq/ppc_cbe_cpufreq.c | 1 +
 5 files changed, 5 insertions(+)


---
base-commit: 83a7eefedc9b56fe7bfeff13b6c7356688ffa670
change-id: 20240614-md-powerpc-drivers-cpufreq-6d345e48164e

Comments

Jeff Johnson June 29, 2024, 3:01 a.m. UTC | #1 
On 6/14/2024 11:08 PM, Jeff Johnson wrote:
> With ARCH=powerpc, make allmodconfig && make W=1 C=1 reports:
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/cpufreq/ppc-cbe-cpufreq.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/cpufreq/powernv-cpufreq.o
> 
> Add the missing invocation of the MODULE_DESCRIPTION() macro to all
> files which have a MODULE_LICENSE().
> 
> This includes three additional files which, although they did not
> produce a warning with the powerpc allmodconfig configuration, may
> cause this warning with specific options enabled in the kernel
> configuration.
> 
> Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>
> ---
> Corrections to these descriptions are welcomed. I'm not an expert in
> this code so in most cases I've taken these descriptions directly from
> code comments, Kconfig descriptions, or git logs.  History has shown
> that in some cases these are originally wrong due to cut-n-paste
> errors, and in other cases the drivers have evolved such that the
> original information is no longer accurate.
> ---
>  drivers/cpufreq/maple-cpufreq.c   | 1 +
>  drivers/cpufreq/pasemi-cpufreq.c  | 1 +
>  drivers/cpufreq/pmac64-cpufreq.c  | 1 +
>  drivers/cpufreq/powernv-cpufreq.c | 1 +
>  drivers/cpufreq/ppc_cbe_cpufreq.c | 1 +
>  5 files changed, 5 insertions(+)
> 
> diff --git a/drivers/cpufreq/maple-cpufreq.c b/drivers/cpufreq/maple-cpufreq.c
> index f9306410a07f..19ca7f874d28 100644
> --- a/drivers/cpufreq/maple-cpufreq.c
> +++ b/drivers/cpufreq/maple-cpufreq.c
> @@ -238,4 +238,5 @@ static int __init maple_cpufreq_init(void)
>  module_init(maple_cpufreq_init);
>  
>  
> +MODULE_DESCRIPTION("cpufreq driver for Maple 970FX Evaluation Board");
>  MODULE_LICENSE("GPL");
> diff --git a/drivers/cpufreq/pasemi-cpufreq.c b/drivers/cpufreq/pasemi-cpufreq.c
> index 039a66bbe1be..92a99f09884a 100644
> --- a/drivers/cpufreq/pasemi-cpufreq.c
> +++ b/drivers/cpufreq/pasemi-cpufreq.c
> @@ -271,5 +271,6 @@ static void __exit pas_cpufreq_exit(void)
>  module_init(pas_cpufreq_init);
>  module_exit(pas_cpufreq_exit);
>  
> +MODULE_DESCRIPTION("cpufreq driver for PA Semi PWRficient");
>  MODULE_LICENSE("GPL");
>  MODULE_AUTHOR("Egor Martovetsky <egor@pasemi.com>, Olof Johansson <olof@lixom.net>");
> diff --git a/drivers/cpufreq/pmac64-cpufreq.c b/drivers/cpufreq/pmac64-cpufreq.c
> index 2cd2b06849a2..9d3fe36075f8 100644
> --- a/drivers/cpufreq/pmac64-cpufreq.c
> +++ b/drivers/cpufreq/pmac64-cpufreq.c
> @@ -671,4 +671,5 @@ static int __init g5_cpufreq_init(void)
>  module_init(g5_cpufreq_init);
>  
>  
> +MODULE_DESCRIPTION("cpufreq driver for SMU & 970FX based G5 Macs");
>  MODULE_LICENSE("GPL");
> diff --git a/drivers/cpufreq/powernv-cpufreq.c b/drivers/cpufreq/powernv-cpufreq.c
> index fddbd1ea1635..e923f717e1d7 100644
> --- a/drivers/cpufreq/powernv-cpufreq.c
> +++ b/drivers/cpufreq/powernv-cpufreq.c
> @@ -1162,5 +1162,6 @@ static void __exit powernv_cpufreq_exit(void)
>  }
>  module_exit(powernv_cpufreq_exit);
>  
> +MODULE_DESCRIPTION("cpufreq driver for the IBM POWER processors");
>  MODULE_LICENSE("GPL");
>  MODULE_AUTHOR("Vaidyanathan Srinivasan <svaidy at linux.vnet.ibm.com>");
> diff --git a/drivers/cpufreq/ppc_cbe_cpufreq.c b/drivers/cpufreq/ppc_cbe_cpufreq.c
> index 88afc49941b7..72f568d14f30 100644
> --- a/drivers/cpufreq/ppc_cbe_cpufreq.c
> +++ b/drivers/cpufreq/ppc_cbe_cpufreq.c
> @@ -169,5 +169,6 @@ static void __exit cbe_cpufreq_exit(void)
>  module_init(cbe_cpufreq_init);
>  module_exit(cbe_cpufreq_exit);
>  
> +MODULE_DESCRIPTION("cpufreq driver for Cell BE processors");
>  MODULE_LICENSE("GPL");
>  MODULE_AUTHOR("Christian Krafft <krafft@de.ibm.com>");
> 
> ---
> base-commit: 83a7eefedc9b56fe7bfeff13b6c7356688ffa670
> change-id: 20240614-md-powerpc-drivers-cpufreq-6d345e48164e

Following up to see if anything else is needed from me. Hoping to see this in
linux-next so I can remove it from my tracking spreadsheet :)

/jeff
Viresh Kumar July 1, 2024, 8:33 a.m. UTC | #2 
On 14-06-24, 23:08, Jeff Johnson wrote:
> With ARCH=powerpc, make allmodconfig && make W=1 C=1 reports:
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/cpufreq/ppc-cbe-cpufreq.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/cpufreq/powernv-cpufreq.o
> 
> Add the missing invocation of the MODULE_DESCRIPTION() macro to all
> files which have a MODULE_LICENSE().
> 
> This includes three additional files which, although they did not
> produce a warning with the powerpc allmodconfig configuration, may
> cause this warning with specific options enabled in the kernel
> configuration.
> 
> Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>

Acked-by: Viresh Kumar <viresh.kumar@linaro.org>
Jeff Johnson July 15, 2024, 7:35 p.m. UTC | #3 
On 7/1/2024 1:33 AM, Viresh Kumar wrote:
> On 14-06-24, 23:08, Jeff Johnson wrote:
>> With ARCH=powerpc, make allmodconfig && make W=1 C=1 reports:
>> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/cpufreq/ppc-cbe-cpufreq.o
>> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/cpufreq/powernv-cpufreq.o
>>
>> Add the missing invocation of the MODULE_DESCRIPTION() macro to all
>> files which have a MODULE_LICENSE().
>>
>> This includes three additional files which, although they did not
>> produce a warning with the powerpc allmodconfig configuration, may
>> cause this warning with specific options enabled in the kernel
>> configuration.
>>
>> Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>
> 
> Acked-by: Viresh Kumar <viresh.kumar@linaro.org>
> 

I still don't see this in linux-next. Is anything else needed from me?

Of the almost 300 patches I've submitted to fix these issues tree-wide, this
is one of the 13 remaining. Hopefully this can make it into the 6.11 merge
window. If not, Greg KH has indicated he'll take this as an -rc instead of
waiting for 6.12.
Michael Ellerman July 22, 2024, 7:13 a.m. UTC | #4 
Jeff Johnson <quic_jjohnson@quicinc.com> writes:
> With ARCH=powerpc, make allmodconfig && make W=1 C=1 reports:
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/cpufreq/ppc-cbe-cpufreq.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/cpufreq/powernv-cpufreq.o
>
> Add the missing invocation of the MODULE_DESCRIPTION() macro to all
> files which have a MODULE_LICENSE().
>
> This includes three additional files which, although they did not
> produce a warning with the powerpc allmodconfig configuration, may
> cause this warning with specific options enabled in the kernel
> configuration.
>
> Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>
> ---
> Corrections to these descriptions are welcomed. I'm not an expert in
> this code so in most cases I've taken these descriptions directly from
> code comments, Kconfig descriptions, or git logs.  History has shown
> that in some cases these are originally wrong due to cut-n-paste
> errors, and in other cases the drivers have evolved such that the
> original information is no longer accurate.
> ---
>  drivers/cpufreq/maple-cpufreq.c   | 1 +
>  drivers/cpufreq/pasemi-cpufreq.c  | 1 +
>  drivers/cpufreq/pmac64-cpufreq.c  | 1 +
>  drivers/cpufreq/powernv-cpufreq.c | 1 +
>  drivers/cpufreq/ppc_cbe_cpufreq.c | 1 +
>  5 files changed, 5 insertions(+)
>
> diff --git a/drivers/cpufreq/maple-cpufreq.c b/drivers/cpufreq/maple-cpufreq.c
> index f9306410a07f..19ca7f874d28 100644
> --- a/drivers/cpufreq/maple-cpufreq.c
> +++ b/drivers/cpufreq/maple-cpufreq.c
> @@ -238,4 +238,5 @@ static int __init maple_cpufreq_init(void)
>  module_init(maple_cpufreq_init);
>  
>  
> +MODULE_DESCRIPTION("cpufreq driver for Maple 970FX Evaluation Board");
 
Can you change this one to:

"cpufreq driver for Maple 970FX/970MP boards");

It looks for both those CPUs in probe.

> diff --git a/drivers/cpufreq/powernv-cpufreq.c b/drivers/cpufreq/powernv-cpufreq.c
> index fddbd1ea1635..e923f717e1d7 100644
> --- a/drivers/cpufreq/powernv-cpufreq.c
> +++ b/drivers/cpufreq/powernv-cpufreq.c
> @@ -1162,5 +1162,6 @@ static void __exit powernv_cpufreq_exit(void)
>  }
>  module_exit(powernv_cpufreq_exit);
>  
> +MODULE_DESCRIPTION("cpufreq driver for the IBM POWER processors");

This one's tricky, because it probes based on the device tree, though it
is restricted to CONFIG_POWERNV. It also supports non-IBM CPUs in theory
at least. Maybe something like:

"cpufreq driver for IBM/OpenPOWER powernv systems");

cheers
Jeff Johnson July 22, 2024, 3:23 p.m. UTC | #5 
On 7/22/2024 12:13 AM, Michael Ellerman wrote:
> Jeff Johnson <quic_jjohnson@quicinc.com> writes:
>> With ARCH=powerpc, make allmodconfig && make W=1 C=1 reports:
>> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/cpufreq/ppc-cbe-cpufreq.o
>> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/cpufreq/powernv-cpufreq.o
>>
>> Add the missing invocation of the MODULE_DESCRIPTION() macro to all
>> files which have a MODULE_LICENSE().
>>
>> This includes three additional files which, although they did not
>> produce a warning with the powerpc allmodconfig configuration, may
>> cause this warning with specific options enabled in the kernel
>> configuration.
>>
>> Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>
>> ---
>> Corrections to these descriptions are welcomed. I'm not an expert in
>> this code so in most cases I've taken these descriptions directly from
>> code comments, Kconfig descriptions, or git logs.  History has shown
>> that in some cases these are originally wrong due to cut-n-paste
>> errors, and in other cases the drivers have evolved such that the
>> original information is no longer accurate.
>> ---
>>  drivers/cpufreq/maple-cpufreq.c   | 1 +
>>  drivers/cpufreq/pasemi-cpufreq.c  | 1 +
>>  drivers/cpufreq/pmac64-cpufreq.c  | 1 +
>>  drivers/cpufreq/powernv-cpufreq.c | 1 +
>>  drivers/cpufreq/ppc_cbe_cpufreq.c | 1 +
>>  5 files changed, 5 insertions(+)
>>
>> diff --git a/drivers/cpufreq/maple-cpufreq.c b/drivers/cpufreq/maple-cpufreq.c
>> index f9306410a07f..19ca7f874d28 100644
>> --- a/drivers/cpufreq/maple-cpufreq.c
>> +++ b/drivers/cpufreq/maple-cpufreq.c
>> @@ -238,4 +238,5 @@ static int __init maple_cpufreq_init(void)
>>  module_init(maple_cpufreq_init);
>>  
>>  
>> +MODULE_DESCRIPTION("cpufreq driver for Maple 970FX Evaluation Board");
>  
> Can you change this one to:
> 
> "cpufreq driver for Maple 970FX/970MP boards");
> 
> It looks for both those CPUs in probe.
> 
>> diff --git a/drivers/cpufreq/powernv-cpufreq.c b/drivers/cpufreq/powernv-cpufreq.c
>> index fddbd1ea1635..e923f717e1d7 100644
>> --- a/drivers/cpufreq/powernv-cpufreq.c
>> +++ b/drivers/cpufreq/powernv-cpufreq.c
>> @@ -1162,5 +1162,6 @@ static void __exit powernv_cpufreq_exit(void)
>>  }
>>  module_exit(powernv_cpufreq_exit);
>>  
>> +MODULE_DESCRIPTION("cpufreq driver for the IBM POWER processors");
> 
> This one's tricky, because it probes based on the device tree, though it
> is restricted to CONFIG_POWERNV. It also supports non-IBM CPUs in theory
> at least. Maybe something like:
> 
> "cpufreq driver for IBM/OpenPOWER powernv systems");
> 
> cheers
Sure, I'll send an update shortly.

/jeff
diff mbox series

Patch

diff --git a/drivers/cpufreq/maple-cpufreq.c b/drivers/cpufreq/maple-cpufreq.c
index f9306410a07f..19ca7f874d28 100644
--- a/drivers/cpufreq/maple-cpufreq.c
+++ b/drivers/cpufreq/maple-cpufreq.c
@@ -238,4 +238,5 @@  static int __init maple_cpufreq_init(void)
 module_init(maple_cpufreq_init);
 
 
+MODULE_DESCRIPTION("cpufreq driver for Maple 970FX Evaluation Board");
 MODULE_LICENSE("GPL");
diff --git a/drivers/cpufreq/pasemi-cpufreq.c b/drivers/cpufreq/pasemi-cpufreq.c
index 039a66bbe1be..92a99f09884a 100644
--- a/drivers/cpufreq/pasemi-cpufreq.c
+++ b/drivers/cpufreq/pasemi-cpufreq.c
@@ -271,5 +271,6 @@  static void __exit pas_cpufreq_exit(void)
 module_init(pas_cpufreq_init);
 module_exit(pas_cpufreq_exit);
 
+MODULE_DESCRIPTION("cpufreq driver for PA Semi PWRficient");
 MODULE_LICENSE("GPL");
 MODULE_AUTHOR("Egor Martovetsky <egor@pasemi.com>, Olof Johansson <olof@lixom.net>");
diff --git a/drivers/cpufreq/pmac64-cpufreq.c b/drivers/cpufreq/pmac64-cpufreq.c
index 2cd2b06849a2..9d3fe36075f8 100644
--- a/drivers/cpufreq/pmac64-cpufreq.c
+++ b/drivers/cpufreq/pmac64-cpufreq.c
@@ -671,4 +671,5 @@  static int __init g5_cpufreq_init(void)
 module_init(g5_cpufreq_init);
 
 
+MODULE_DESCRIPTION("cpufreq driver for SMU & 970FX based G5 Macs");
 MODULE_LICENSE("GPL");
diff --git a/drivers/cpufreq/powernv-cpufreq.c b/drivers/cpufreq/powernv-cpufreq.c
index fddbd1ea1635..e923f717e1d7 100644
--- a/drivers/cpufreq/powernv-cpufreq.c
+++ b/drivers/cpufreq/powernv-cpufreq.c
@@ -1162,5 +1162,6 @@  static void __exit powernv_cpufreq_exit(void)
 }
 module_exit(powernv_cpufreq_exit);
 
+MODULE_DESCRIPTION("cpufreq driver for the IBM POWER processors");
 MODULE_LICENSE("GPL");
 MODULE_AUTHOR("Vaidyanathan Srinivasan <svaidy at linux.vnet.ibm.com>");
diff --git a/drivers/cpufreq/ppc_cbe_cpufreq.c b/drivers/cpufreq/ppc_cbe_cpufreq.c
index 88afc49941b7..72f568d14f30 100644
--- a/drivers/cpufreq/ppc_cbe_cpufreq.c
+++ b/drivers/cpufreq/ppc_cbe_cpufreq.c
@@ -169,5 +169,6 @@  static void __exit cbe_cpufreq_exit(void)
 module_init(cbe_cpufreq_init);
 module_exit(cbe_cpufreq_exit);
 
+MODULE_DESCRIPTION("cpufreq driver for Cell BE processors");
 MODULE_LICENSE("GPL");
 MODULE_AUTHOR("Christian Krafft <krafft@de.ibm.com>");