Re: [PATCH] mmc: add missing MODULE_DESCRIPTION() macros

[Jeff Johnson <quic_jjohnson@quicinc.com>]

On 6/11/2024 12:29 AM, Dragan Simic wrote:
> Hello Jeff,
> 
> Thanks for the patch.  Please see a few comments below.
> 
> On 2024-06-10 16:17, Jeff Johnson wrote:
>> make allmodconfig && make W=1 C=1 reports:
>> WARNING: modpost: missing MODULE_DESCRIPTION() in 
>> drivers/mmc/host/of_mmc_spi.o
>> WARNING: modpost: missing MODULE_DESCRIPTION() in
>> drivers/mmc/host/tmio_mmc_core.o
>> WARNING: modpost: missing MODULE_DESCRIPTION() in
>> drivers/mmc/host/renesas_sdhi_core.o
>> WARNING: modpost: missing MODULE_DESCRIPTION() in 
>> drivers/mmc/core/mmc_core.o
>> WARNING: modpost: missing MODULE_DESCRIPTION() in
>> drivers/mmc/core/pwrseq_simple.o
>> WARNING: modpost: missing MODULE_DESCRIPTION() in
>> drivers/mmc/core/pwrseq_sd8787.o
>> WARNING: modpost: missing MODULE_DESCRIPTION() in 
>> drivers/mmc/core/pwrseq_emmc.o
>> WARNING: modpost: missing MODULE_DESCRIPTION() in 
>> drivers/mmc/core/sdio_uart.o
>>
>> Add the missing invocations of the MODULE_DESCRIPTION() macro.
>>
>> 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/mmc/core/core.c              | 1 +
>>  drivers/mmc/core/pwrseq_emmc.c       | 1 +
>>  drivers/mmc/core/pwrseq_sd8787.c     | 1 +
>>  drivers/mmc/core/pwrseq_simple.c     | 1 +
>>  drivers/mmc/core/sdio_uart.c         | 1 +
>>  drivers/mmc/host/of_mmc_spi.c        | 1 +
>>  drivers/mmc/host/renesas_sdhi_core.c | 1 +
>>  drivers/mmc/host/tmio_mmc_core.c     | 1 +
>>  8 files changed, 8 insertions(+)
>>
>> diff --git a/drivers/mmc/core/core.c b/drivers/mmc/core/core.c
>> index a8c17b4cd737..d6c819dd68ed 100644
>> --- a/drivers/mmc/core/core.c
>> +++ b/drivers/mmc/core/core.c
>> @@ -2362,4 +2362,5 @@ static void __exit mmc_exit(void)
>>  subsys_initcall(mmc_init);
>>  module_exit(mmc_exit);
>>
>> +MODULE_DESCRIPTION("MMC core driver");
>>  MODULE_LICENSE("GPL");
>> diff --git a/drivers/mmc/core/pwrseq_emmc.c 
>> b/drivers/mmc/core/pwrseq_emmc.c
>> index 3b6d69cefb4e..fff30330574f 100644
>> --- a/drivers/mmc/core/pwrseq_emmc.c
>> +++ b/drivers/mmc/core/pwrseq_emmc.c
>> @@ -115,4 +115,5 @@ static struct platform_driver 
>> mmc_pwrseq_emmc_driver = {
>>  };
>>
>>  module_platform_driver(mmc_pwrseq_emmc_driver);
>> +MODULE_DESCRIPTION("HW reset support for eMMC");
> 
> "Hardware reset support for eMMC" would read a bit better.
> 
>>  MODULE_LICENSE("GPL v2");
>> diff --git a/drivers/mmc/core/pwrseq_sd8787.c 
>> b/drivers/mmc/core/pwrseq_sd8787.c
>> index 0c5808fc3206..f24bbd68e251 100644
>> --- a/drivers/mmc/core/pwrseq_sd8787.c
>> +++ b/drivers/mmc/core/pwrseq_sd8787.c
>> @@ -130,4 +130,5 @@ static struct platform_driver 
>> mmc_pwrseq_sd8787_driver = {
>>  };
>>
>>  module_platform_driver(mmc_pwrseq_sd8787_driver);
>> +MODULE_DESCRIPTION("Power sequence support for Marvell SD8787 BT + 
>> Wifi chip");
>>  MODULE_LICENSE("GPL v2");
>> diff --git a/drivers/mmc/core/pwrseq_simple.c 
>> b/drivers/mmc/core/pwrseq_simple.c
>> index df9588503ad0..97f6d69d9c80 100644
>> --- a/drivers/mmc/core/pwrseq_simple.c
>> +++ b/drivers/mmc/core/pwrseq_simple.c
>> @@ -159,4 +159,5 @@ static struct platform_driver 
>> mmc_pwrseq_simple_driver = {
>>  };
>>
>>  module_platform_driver(mmc_pwrseq_simple_driver);
>> +MODULE_DESCRIPTION("Simple HW reset support for MMC");
> 
> "Simple power sequence management for MMC" would be more accurate.
> 
>>  MODULE_LICENSE("GPL v2");
>> diff --git a/drivers/mmc/core/sdio_uart.c 
>> b/drivers/mmc/core/sdio_uart.c
>> index 575ebbce378e..6b7471dba3bf 100644
>> --- a/drivers/mmc/core/sdio_uart.c
>> +++ b/drivers/mmc/core/sdio_uart.c
>> @@ -1162,4 +1162,5 @@ module_init(sdio_uart_init);
>>  module_exit(sdio_uart_exit);
>>
>>  MODULE_AUTHOR("Nicolas Pitre");
>> +MODULE_DESCRIPTION("SDIO UART/GPS driver");
>>  MODULE_LICENSE("GPL");
>> diff --git a/drivers/mmc/host/of_mmc_spi.c 
>> b/drivers/mmc/host/of_mmc_spi.c
>> index bf54776fb26c..05939f30a5ae 100644
>> --- a/drivers/mmc/host/of_mmc_spi.c
>> +++ b/drivers/mmc/host/of_mmc_spi.c
>> @@ -19,6 +19,7 @@
>>  #include <linux/mmc/core.h>
>>  #include <linux/mmc/host.h>
>>
>> +MODULE_DESCRIPTION("OpenFirmware bindings for the MMC-over-SPI 
>> driver");
>>  MODULE_LICENSE("GPL");
>>
>>  struct of_mmc_spi {
>> diff --git a/drivers/mmc/host/renesas_sdhi_core.c
>> b/drivers/mmc/host/renesas_sdhi_core.c
>> index 12f4faaaf4ee..d62a4ed86775 100644
>> --- a/drivers/mmc/host/renesas_sdhi_core.c
>> +++ b/drivers/mmc/host/renesas_sdhi_core.c
>> @@ -1162,4 +1162,5 @@ void renesas_sdhi_remove(struct platform_device 
>> *pdev)
>>  }
>>  EXPORT_SYMBOL_GPL(renesas_sdhi_remove);
>>
>> +MODULE_DESCRIPTION("Renesas SDHI driver");
> 
> "Renesas SDHI core driver" would be a bit more accurate.
> 
>>  MODULE_LICENSE("GPL v2");
>> diff --git a/drivers/mmc/host/tmio_mmc_core.c 
>> b/drivers/mmc/host/tmio_mmc_core.c
>> index 93e912afd3ae..c1a4ade5f949 100644
>> --- a/drivers/mmc/host/tmio_mmc_core.c
>> +++ b/drivers/mmc/host/tmio_mmc_core.c
>> @@ -1319,4 +1319,5 @@ int tmio_mmc_host_runtime_resume(struct device 
>> *dev)
>>  EXPORT_SYMBOL_GPL(tmio_mmc_host_runtime_resume);
>>  #endif
>>
>> +MODULE_DESCRIPTION("TMIO MMC core driver");
>>  MODULE_LICENSE("GPL v2");
>>
>> ---
>> base-commit: 83a7eefedc9b56fe7bfeff13b6c7356688ffa670
>> change-id: 20240610-md-drivers-mmc-cb5f273b5b33

Thank you for your clarifications. I'll incorporate them in the next version.

/jeff