platform/x86: add missing MODULE_DESCRIPTION() macros

[PATCH] platform/x86: add missing MODULE_DESCRIPTION() macros

Posted by Jeff Johnson 1 year, 8 months ago

With ARCH=x86, make allmodconfig && make W=1 C=1 reports:
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/platform/x86/amilo-rfkill.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/platform/x86/uv_sysfs.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/platform/x86/ibm_rtl.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/platform/x86/xo1-rfkill.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/platform/x86/firmware_attributes_class.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/platform/x86/wireless-hotkey.o

Add the missing invocations of the MODULE_DESCRIPTION() macro.

Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>
---
This is the last of the issues present (that I'm aware of) in
drivers/platform/x86
---
 drivers/platform/x86/amilo-rfkill.c              | 1 +
 drivers/platform/x86/firmware_attributes_class.c | 1 +
 drivers/platform/x86/ibm_rtl.c                   | 1 +
 drivers/platform/x86/uv_sysfs.c                  | 1 +
 drivers/platform/x86/wireless-hotkey.c           | 1 +
 drivers/platform/x86/xo1-rfkill.c                | 1 +
 6 files changed, 6 insertions(+)

diff --git a/drivers/platform/x86/amilo-rfkill.c b/drivers/platform/x86/amilo-rfkill.c
index efcf909786a5..2423dc91debb 100644
--- a/drivers/platform/x86/amilo-rfkill.c
+++ b/drivers/platform/x86/amilo-rfkill.c
@@ -171,6 +171,7 @@ static void __exit amilo_rfkill_exit(void)
 }
 
 MODULE_AUTHOR("Ben Hutchings <ben@decadent.org.uk>");
+MODULE_DESCRIPTION("Fujitsu-Siemens Amilo rfkill support");
 MODULE_LICENSE("GPL");
 MODULE_DEVICE_TABLE(dmi, amilo_rfkill_id_table);
 
diff --git a/drivers/platform/x86/firmware_attributes_class.c b/drivers/platform/x86/firmware_attributes_class.c
index dd8240009565..182a07d8ae3d 100644
--- a/drivers/platform/x86/firmware_attributes_class.c
+++ b/drivers/platform/x86/firmware_attributes_class.c
@@ -49,4 +49,5 @@ int fw_attributes_class_put(void)
 EXPORT_SYMBOL_GPL(fw_attributes_class_put);
 
 MODULE_AUTHOR("Mark Pearson <markpearson@lenovo.com>");
+MODULE_DESCRIPTION("Firmware attributes class helper module");
 MODULE_LICENSE("GPL");
diff --git a/drivers/platform/x86/ibm_rtl.c b/drivers/platform/x86/ibm_rtl.c
index 1d4bbae115f1..231b37909801 100644
--- a/drivers/platform/x86/ibm_rtl.c
+++ b/drivers/platform/x86/ibm_rtl.c
@@ -29,6 +29,7 @@ static bool debug;
 module_param(debug, bool, 0644);
 MODULE_PARM_DESC(debug, "Show debug output");
 
+MODULE_DESCRIPTION("IBM Premium Real Time Mode (PRTM) driver");
 MODULE_LICENSE("GPL");
 MODULE_AUTHOR("Keith Mannthey <kmmanth@us.ibm.com>");
 MODULE_AUTHOR("Vernon Mauery <vernux@us.ibm.com>");
diff --git a/drivers/platform/x86/uv_sysfs.c b/drivers/platform/x86/uv_sysfs.c
index 37372d7cc54a..f6a0627f36db 100644
--- a/drivers/platform/x86/uv_sysfs.c
+++ b/drivers/platform/x86/uv_sysfs.c
@@ -929,4 +929,5 @@ module_init(uv_sysfs_init);
 module_exit(uv_sysfs_exit);
 
 MODULE_AUTHOR("Hewlett Packard Enterprise");
+MODULE_DESCRIPTION("Sysfs structure for HPE UV systems");
 MODULE_LICENSE("GPL");
diff --git a/drivers/platform/x86/wireless-hotkey.c b/drivers/platform/x86/wireless-hotkey.c
index e95cdbbfb708..459e20f7e161 100644
--- a/drivers/platform/x86/wireless-hotkey.c
+++ b/drivers/platform/x86/wireless-hotkey.c
@@ -14,6 +14,7 @@
 #include <linux/acpi.h>
 #include <acpi/acpi_bus.h>
 
+MODULE_DESCRIPTION("Airplane mode button for AMD, HP & Xiaomi laptops");
 MODULE_LICENSE("GPL");
 MODULE_AUTHOR("Alex Hung");
 MODULE_ALIAS("acpi*:HPQ6001:*");
diff --git a/drivers/platform/x86/xo1-rfkill.c b/drivers/platform/x86/xo1-rfkill.c
index e64d5646b4c7..5fe68296501c 100644
--- a/drivers/platform/x86/xo1-rfkill.c
+++ b/drivers/platform/x86/xo1-rfkill.c
@@ -74,5 +74,6 @@ static struct platform_driver xo1_rfkill_driver = {
 module_platform_driver(xo1_rfkill_driver);
 
 MODULE_AUTHOR("Daniel Drake <dsd@laptop.org>");
+MODULE_DESCRIPTION("OLPC XO-1 software RF kill switch");
 MODULE_LICENSE("GPL");
 MODULE_ALIAS("platform:xo1-rfkill");

---
base-commit: 83a7eefedc9b56fe7bfeff13b6c7356688ffa670
change-id: 20240611-md-drivers-platform-x86-a3a06234d33c

Re: [PATCH] platform/x86: add missing MODULE_DESCRIPTION() macros

Posted by Hans de Goede 1 year, 7 months ago

Hi,

On 6/12/24 7:20 AM, Jeff Johnson wrote:
> With ARCH=x86, make allmodconfig && make W=1 C=1 reports:
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/platform/x86/amilo-rfkill.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/platform/x86/uv_sysfs.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/platform/x86/ibm_rtl.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/platform/x86/xo1-rfkill.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/platform/x86/firmware_attributes_class.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/platform/x86/wireless-hotkey.o
> 
> Add the missing invocations of the MODULE_DESCRIPTION() macro.
> 
> Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>

Thank you for your patch, I've applied this patch to my review-hans 
branch:
https://git.kernel.org/pub/scm/linux/kernel/git/pdx86/platform-drivers-x86.git/log/?h=review-hans

Note it will show up in my review-hans branch once I've pushed my
local branch there, which might take a while.

I will include this patch in my next fixes pull-req to Linus
for the current kernel development cycle.

Regards,

Hans



> ---
> This is the last of the issues present (that I'm aware of) in
> drivers/platform/x86
> ---
>  drivers/platform/x86/amilo-rfkill.c              | 1 +
>  drivers/platform/x86/firmware_attributes_class.c | 1 +
>  drivers/platform/x86/ibm_rtl.c                   | 1 +
>  drivers/platform/x86/uv_sysfs.c                  | 1 +
>  drivers/platform/x86/wireless-hotkey.c           | 1 +
>  drivers/platform/x86/xo1-rfkill.c                | 1 +
>  6 files changed, 6 insertions(+)
> 
> diff --git a/drivers/platform/x86/amilo-rfkill.c b/drivers/platform/x86/amilo-rfkill.c
> index efcf909786a5..2423dc91debb 100644
> --- a/drivers/platform/x86/amilo-rfkill.c
> +++ b/drivers/platform/x86/amilo-rfkill.c
> @@ -171,6 +171,7 @@ static void __exit amilo_rfkill_exit(void)
>  }
>  
>  MODULE_AUTHOR("Ben Hutchings <ben@decadent.org.uk>");
> +MODULE_DESCRIPTION("Fujitsu-Siemens Amilo rfkill support");
>  MODULE_LICENSE("GPL");
>  MODULE_DEVICE_TABLE(dmi, amilo_rfkill_id_table);
>  
> diff --git a/drivers/platform/x86/firmware_attributes_class.c b/drivers/platform/x86/firmware_attributes_class.c
> index dd8240009565..182a07d8ae3d 100644
> --- a/drivers/platform/x86/firmware_attributes_class.c
> +++ b/drivers/platform/x86/firmware_attributes_class.c
> @@ -49,4 +49,5 @@ int fw_attributes_class_put(void)
>  EXPORT_SYMBOL_GPL(fw_attributes_class_put);
>  
>  MODULE_AUTHOR("Mark Pearson <markpearson@lenovo.com>");
> +MODULE_DESCRIPTION("Firmware attributes class helper module");
>  MODULE_LICENSE("GPL");
> diff --git a/drivers/platform/x86/ibm_rtl.c b/drivers/platform/x86/ibm_rtl.c
> index 1d4bbae115f1..231b37909801 100644
> --- a/drivers/platform/x86/ibm_rtl.c
> +++ b/drivers/platform/x86/ibm_rtl.c
> @@ -29,6 +29,7 @@ static bool debug;
>  module_param(debug, bool, 0644);
>  MODULE_PARM_DESC(debug, "Show debug output");
>  
> +MODULE_DESCRIPTION("IBM Premium Real Time Mode (PRTM) driver");
>  MODULE_LICENSE("GPL");
>  MODULE_AUTHOR("Keith Mannthey <kmmanth@us.ibm.com>");
>  MODULE_AUTHOR("Vernon Mauery <vernux@us.ibm.com>");
> diff --git a/drivers/platform/x86/uv_sysfs.c b/drivers/platform/x86/uv_sysfs.c
> index 37372d7cc54a..f6a0627f36db 100644
> --- a/drivers/platform/x86/uv_sysfs.c
> +++ b/drivers/platform/x86/uv_sysfs.c
> @@ -929,4 +929,5 @@ module_init(uv_sysfs_init);
>  module_exit(uv_sysfs_exit);
>  
>  MODULE_AUTHOR("Hewlett Packard Enterprise");
> +MODULE_DESCRIPTION("Sysfs structure for HPE UV systems");
>  MODULE_LICENSE("GPL");
> diff --git a/drivers/platform/x86/wireless-hotkey.c b/drivers/platform/x86/wireless-hotkey.c
> index e95cdbbfb708..459e20f7e161 100644
> --- a/drivers/platform/x86/wireless-hotkey.c
> +++ b/drivers/platform/x86/wireless-hotkey.c
> @@ -14,6 +14,7 @@
>  #include <linux/acpi.h>
>  #include <acpi/acpi_bus.h>
>  
> +MODULE_DESCRIPTION("Airplane mode button for AMD, HP & Xiaomi laptops");
>  MODULE_LICENSE("GPL");
>  MODULE_AUTHOR("Alex Hung");
>  MODULE_ALIAS("acpi*:HPQ6001:*");
> diff --git a/drivers/platform/x86/xo1-rfkill.c b/drivers/platform/x86/xo1-rfkill.c
> index e64d5646b4c7..5fe68296501c 100644
> --- a/drivers/platform/x86/xo1-rfkill.c
> +++ b/drivers/platform/x86/xo1-rfkill.c
> @@ -74,5 +74,6 @@ static struct platform_driver xo1_rfkill_driver = {
>  module_platform_driver(xo1_rfkill_driver);
>  
>  MODULE_AUTHOR("Daniel Drake <dsd@laptop.org>");
> +MODULE_DESCRIPTION("OLPC XO-1 software RF kill switch");
>  MODULE_LICENSE("GPL");
>  MODULE_ALIAS("platform:xo1-rfkill");
> 
> ---
> base-commit: 83a7eefedc9b56fe7bfeff13b6c7356688ffa670
> change-id: 20240611-md-drivers-platform-x86-a3a06234d33c
>