2024-06-12 02:37:48

by Jeff Johnson

Subject: [PATCH] usb: add missing MODULE_DESCRIPTION() macros

With ARCH=x86, make allmodconfig && make W=1 C=1 reports:
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/usb/core/usbcore.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/usb/mon/usbmon.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/usb/class/usbtmc.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/usb/storage/uas.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/usb/chipidea/ci_hdrc_msm.o

Add the missing invocations of the MODULE_DESCRIPTION() macro.

Signed-off-by: Jeff Johnson <[email protected]>
---
This is the remaining one-off fixes in usb.

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.

Let me know if any of these changes need to be segregated into
separate patches to go through different maintainer trees.
---
drivers/usb/chipidea/ci_hdrc_msm.c | 1 +
drivers/usb/class/usbtmc.c | 1 +
drivers/usb/core/usb.c | 1 +
drivers/usb/mon/mon_main.c | 1 +
drivers/usb/storage/uas.c | 1 +
5 files changed, 5 insertions(+)

diff --git a/drivers/usb/chipidea/ci_hdrc_msm.c b/drivers/usb/chipidea/ci_hdrc_msm.c
index 7b5b47ce8a02..1661639cd2eb 100644
--- a/drivers/usb/chipidea/ci_hdrc_msm.c
+++ b/drivers/usb/chipidea/ci_hdrc_msm.c
@@ -303,4 +303,5 @@ module_platform_driver(ci_hdrc_msm_driver);

MODULE_ALIAS("platform:msm_hsusb");
MODULE_ALIAS("platform:ci13xxx_msm");
+MODULE_DESCRIPTION("ChipIdea Highspeed Dual Role Controller");
MODULE_LICENSE("GPL v2");
diff --git a/drivers/usb/class/usbtmc.c b/drivers/usb/class/usbtmc.c
index 311007b1d904..6bd9fe565385 100644
--- a/drivers/usb/class/usbtmc.c
+++ b/drivers/usb/class/usbtmc.c
@@ -2592,4 +2592,5 @@ static struct usb_driver usbtmc_driver = {

module_usb_driver(usbtmc_driver);

+MODULE_DESCRIPTION("USB Test & Measurement class driver");
MODULE_LICENSE("GPL");
diff --git a/drivers/usb/core/usb.c b/drivers/usb/core/usb.c
index a0c432b14b20..65f9940bc7e8 100644
--- a/drivers/usb/core/usb.c
+++ b/drivers/usb/core/usb.c
@@ -1150,4 +1150,5 @@ static void __exit usb_exit(void)

subsys_initcall(usb_init);
module_exit(usb_exit);
+MODULE_DESCRIPTION("USB support library");
MODULE_LICENSE("GPL");
diff --git a/drivers/usb/mon/mon_main.c b/drivers/usb/mon/mon_main.c
index 824904abe76f..af852d53aac6 100644
--- a/drivers/usb/mon/mon_main.c
+++ b/drivers/usb/mon/mon_main.c
@@ -419,4 +419,5 @@ static void __exit mon_exit(void)
module_init(mon_init);
module_exit(mon_exit);

+MODULE_DESCRIPTION("USB Monitor");
MODULE_LICENSE("GPL");
diff --git a/drivers/usb/storage/uas.c b/drivers/usb/storage/uas.c
index a48870a87a29..9b8f578eef53 100644
--- a/drivers/usb/storage/uas.c
+++ b/drivers/usb/storage/uas.c
@@ -1280,6 +1280,7 @@ static void __exit uas_exit(void)
module_init(uas_init);
module_exit(uas_exit);

+MODULE_DESCRIPTION("USB Attached SCSI driver");
MODULE_LICENSE("GPL");
MODULE_IMPORT_NS(USB_STORAGE);
MODULE_AUTHOR(

---
base-commit: 83a7eefedc9b56fe7bfeff13b6c7356688ffa670
change-id: 20240611-md-drivers-usb-86999d57ed16

2024-06-12 18:16:29

by Alan Stern

Subject: Re: [PATCH] usb: add missing MODULE_DESCRIPTION() macros

On Tue, Jun 11, 2024 at 07:37:20PM -0700, Jeff Johnson wrote:
> With ARCH=x86, make allmodconfig && make W=1 C=1 reports:
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/usb/core/usbcore.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/usb/mon/usbmon.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/usb/class/usbtmc.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/usb/storage/uas.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/usb/chipidea/ci_hdrc_msm.o
>
> Add the missing invocations of the MODULE_DESCRIPTION() macro.
>
> Signed-off-by: Jeff Johnson <[email protected]>
> ---
> This is the remaining one-off fixes in usb.
>
> 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.
>
> Let me know if any of these changes need to be segregated into
> separate patches to go through different maintainer trees.

> diff --git a/drivers/usb/core/usb.c b/drivers/usb/core/usb.c
> index a0c432b14b20..65f9940bc7e8 100644
> --- a/drivers/usb/core/usb.c
> +++ b/drivers/usb/core/usb.c
> @@ -1150,4 +1150,5 @@ static void __exit usb_exit(void)
>
> subsys_initcall(usb_init);
> module_exit(usb_exit);
> +MODULE_DESCRIPTION("USB support library");
> MODULE_LICENSE("GPL");

I would change this to "USB core host-side support", or something more
along those lines. It's not just a library because it does include
several drivers (such as the USB hub driver). And it's host-side rather
than device-side -- that's a separate module.

Alan Stern

2024-06-12 18:28:23

by Jeff Johnson

Subject: Re: [PATCH] usb: add missing MODULE_DESCRIPTION() macros

On 6/12/2024 11:16 AM, Alan Stern wrote:
> On Tue, Jun 11, 2024 at 07:37:20PM -0700, Jeff Johnson wrote:
>> With ARCH=x86, make allmodconfig && make W=1 C=1 reports:
>> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/usb/core/usbcore.o
>> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/usb/mon/usbmon.o
>> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/usb/class/usbtmc.o
>> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/usb/storage/uas.o
>> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/usb/chipidea/ci_hdrc_msm.o
>>
>> Add the missing invocations of the MODULE_DESCRIPTION() macro.
>>
>> Signed-off-by: Jeff Johnson <[email protected]>
>> ---
>> This is the remaining one-off fixes in usb.
>>
>> 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.
>>
>> Let me know if any of these changes need to be segregated into
>> separate patches to go through different maintainer trees.
>
>> diff --git a/drivers/usb/core/usb.c b/drivers/usb/core/usb.c
>> index a0c432b14b20..65f9940bc7e8 100644
>> --- a/drivers/usb/core/usb.c
>> +++ b/drivers/usb/core/usb.c
>> @@ -1150,4 +1150,5 @@ static void __exit usb_exit(void)
>>
>> subsys_initcall(usb_init);
>> module_exit(usb_exit);
>> +MODULE_DESCRIPTION("USB support library");
>> MODULE_LICENSE("GPL");
>
> I would change this to "USB core host-side support", or something more
> along those lines. It's not just a library because it does include
> several drivers (such as the USB hub driver). And it's host-side rather
> than device-side -- that's a separate module.
>
> Alan Stern

thanks, will reword in the next version

/jeff