linux-kernel - Re: [PATCH] pinctrl: add missing MODULE

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives
Hash Suite: Windows password security audit tool. GUI, reports in PDF.
[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID: <6c9bb16f-a1c1-474c-a753-9905d88c9022@linaro.org>
Date: Tue, 11 Jun 2024 09:43:41 +0200
From: Neil Armstrong <neil.armstrong@...aro.org>
To: Jeff Johnson <quic_jjohnson@...cinc.com>, Rafał Miłecki
 <rafal@...ecki.pl>,
 Broadcom internal kernel review list
 <bcm-kernel-feedback-list@...adcom.com>,
 Linus Walleij <linus.walleij@...aro.org>, Kevin Hilman
 <khilman@...libre.com>, Jerome Brunet <jbrunet@...libre.com>,
 Martin Blumenstingl <martin.blumenstingl@...glemail.com>
Cc: linux-gpio@...r.kernel.org, linux-kernel@...r.kernel.org,
 linux-arm-kernel@...ts.infradead.org, linux-amlogic@...ts.infradead.org,
 kernel-janitors@...r.kernel.org
Subject: Re: [PATCH] pinctrl: add missing MODULE_DESCRIPTION() macros

On 11/06/2024 06:21, Jeff Johnson wrote:
> When ARCH=x86, make allmodconfig && make W=1 C=1 reports:
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/pinctrl/bcm/pinctrl-bcm4908.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/pinctrl/pinctrl-mcp23s08_i2c.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/pinctrl/pinctrl-mcp23s08_spi.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/pinctrl/pinctrl-mcp23s08.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/pinctrl/meson/pinctrl-meson.o
> 
> Add the missing invocation of the MODULE_DESCRIPTION() macro to all
> files which have a MODULE_LICENSE().
> 
> This includes many meson drivers which, although they did not produce
> a warning with the x86 allmodconfig configuration, may cause this
> warning with ARM or ARM64 configurations.
> 
> Signed-off-by: Jeff Johnson <quic_jjohnson@...cinc.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.
> 
> Also let me know if any changes need to be split into a separate patch
> to go through a separate maintainer tree.
> ---
>   drivers/pinctrl/bcm/pinctrl-bcm4908.c         | 1 +
>   drivers/pinctrl/meson/pinctrl-meson-a1.c      | 1 +
>   drivers/pinctrl/meson/pinctrl-meson-axg-pmx.c | 1 +
>   drivers/pinctrl/meson/pinctrl-meson-axg.c     | 1 +
>   drivers/pinctrl/meson/pinctrl-meson-g12a.c    | 1 +
>   drivers/pinctrl/meson/pinctrl-meson-gxbb.c    | 1 +
>   drivers/pinctrl/meson/pinctrl-meson-gxl.c     | 1 +
>   drivers/pinctrl/meson/pinctrl-meson-s4.c      | 1 +
>   drivers/pinctrl/meson/pinctrl-meson.c         | 1 +
>   drivers/pinctrl/meson/pinctrl-meson8-pmx.c    | 1 +

Reviewed-by: Neil Armstrong <neil.armstrong@...aro.org> # for Amlogic Pinctrl drivers

>   drivers/pinctrl/pinctrl-mcp23s08.c            | 1 +
>   drivers/pinctrl/pinctrl-mcp23s08_i2c.c        | 1 +
>   drivers/pinctrl/pinctrl-mcp23s08_spi.c        | 1 +
>   drivers/pinctrl/pinctrl-tb10x.c               | 1 +
>   14 files changed, 14 insertions(+)
> 
> diff --git a/drivers/pinctrl/bcm/pinctrl-bcm4908.c b/drivers/pinctrl/bcm/pinctrl-bcm4908.c
> index cdfa165fc033..f190e0997f1f 100644
> --- a/drivers/pinctrl/bcm/pinctrl-bcm4908.c
> +++ b/drivers/pinctrl/bcm/pinctrl-bcm4908.c
> @@ -559,5 +559,6 @@ static struct platform_driver bcm4908_pinctrl_driver = {
>   module_platform_driver(bcm4908_pinctrl_driver);
>   
>   MODULE_AUTHOR("Rafał Miłecki");
> +MODULE_DESCRIPTION("Broadcom BCM4908 pinmux driver");
>   MODULE_LICENSE("GPL v2");
>   MODULE_DEVICE_TABLE(of, bcm4908_pinctrl_of_match_table);
> diff --git a/drivers/pinctrl/meson/pinctrl-meson-a1.c b/drivers/pinctrl/meson/pinctrl-meson-a1.c
> index 50a87d9618a8..d2ac9ca72a3e 100644
> --- a/drivers/pinctrl/meson/pinctrl-meson-a1.c
> +++ b/drivers/pinctrl/meson/pinctrl-meson-a1.c
> @@ -936,4 +936,5 @@ static struct platform_driver meson_a1_pinctrl_driver = {
>   };
>   
>   module_platform_driver(meson_a1_pinctrl_driver);
> +MODULE_DESCRIPTION("Amlogic Meson A1 SoC pinctrl driver");
>   MODULE_LICENSE("Dual BSD/GPL");
> diff --git a/drivers/pinctrl/meson/pinctrl-meson-axg-pmx.c b/drivers/pinctrl/meson/pinctrl-meson-axg-pmx.c
> index ae3f8d0da05f..cad411d90727 100644
> --- a/drivers/pinctrl/meson/pinctrl-meson-axg-pmx.c
> +++ b/drivers/pinctrl/meson/pinctrl-meson-axg-pmx.c
> @@ -117,4 +117,5 @@ const struct pinmux_ops meson_axg_pmx_ops = {
>   };
>   EXPORT_SYMBOL_GPL(meson_axg_pmx_ops);
>   
> +MODULE_DESCRIPTION("Amlogic Meson AXG second generation pinmux driver");
>   MODULE_LICENSE("Dual BSD/GPL");
> diff --git a/drivers/pinctrl/meson/pinctrl-meson-axg.c b/drivers/pinctrl/meson/pinctrl-meson-axg.c
> index 6667c9d0238f..8f4e7154b73f 100644
> --- a/drivers/pinctrl/meson/pinctrl-meson-axg.c
> +++ b/drivers/pinctrl/meson/pinctrl-meson-axg.c
> @@ -1091,4 +1091,5 @@ static struct platform_driver meson_axg_pinctrl_driver = {
>   };
>   
>   module_platform_driver(meson_axg_pinctrl_driver);
> +MODULE_DESCRIPTION("Amlogic Meson AXG pinctrl driver");
>   MODULE_LICENSE("Dual BSD/GPL");
> diff --git a/drivers/pinctrl/meson/pinctrl-meson-g12a.c b/drivers/pinctrl/meson/pinctrl-meson-g12a.c
> index 2c17891ba6a9..32830269a5b4 100644
> --- a/drivers/pinctrl/meson/pinctrl-meson-g12a.c
> +++ b/drivers/pinctrl/meson/pinctrl-meson-g12a.c
> @@ -1426,4 +1426,5 @@ static struct platform_driver meson_g12a_pinctrl_driver = {
>   };
>   
>   module_platform_driver(meson_g12a_pinctrl_driver);
> +MODULE_DESCRIPTION("Amlogic Meson G12A SoC pinctrl driver");
>   MODULE_LICENSE("Dual BSD/GPL");
> diff --git a/drivers/pinctrl/meson/pinctrl-meson-gxbb.c b/drivers/pinctrl/meson/pinctrl-meson-gxbb.c
> index f51fc3939252..2867f397fec6 100644
> --- a/drivers/pinctrl/meson/pinctrl-meson-gxbb.c
> +++ b/drivers/pinctrl/meson/pinctrl-meson-gxbb.c
> @@ -910,4 +910,5 @@ static struct platform_driver meson_gxbb_pinctrl_driver = {
>   	},
>   };
>   module_platform_driver(meson_gxbb_pinctrl_driver);
> +MODULE_DESCRIPTION("Amlogic Meson GXBB pinctrl driver");
>   MODULE_LICENSE("GPL v2");
> diff --git a/drivers/pinctrl/meson/pinctrl-meson-gxl.c b/drivers/pinctrl/meson/pinctrl-meson-gxl.c
> index 51408996255b..a2f25fa02852 100644
> --- a/drivers/pinctrl/meson/pinctrl-meson-gxl.c
> +++ b/drivers/pinctrl/meson/pinctrl-meson-gxl.c
> @@ -871,4 +871,5 @@ static struct platform_driver meson_gxl_pinctrl_driver = {
>   	},
>   };
>   module_platform_driver(meson_gxl_pinctrl_driver);
> +MODULE_DESCRIPTION("Amlogic Meson GXL pinctrl driver");
>   MODULE_LICENSE("GPL v2");
> diff --git a/drivers/pinctrl/meson/pinctrl-meson-s4.c b/drivers/pinctrl/meson/pinctrl-meson-s4.c
> index cea77864b880..60c7d5003e8a 100644
> --- a/drivers/pinctrl/meson/pinctrl-meson-s4.c
> +++ b/drivers/pinctrl/meson/pinctrl-meson-s4.c
> @@ -1230,4 +1230,5 @@ static struct platform_driver meson_s4_pinctrl_driver = {
>   };
>   module_platform_driver(meson_s4_pinctrl_driver);
>   
> +MODULE_DESCRIPTION("Amlogic Meson S4 SoC pinctrl driver");
>   MODULE_LICENSE("Dual BSD/GPL");
> diff --git a/drivers/pinctrl/meson/pinctrl-meson.c b/drivers/pinctrl/meson/pinctrl-meson.c
> index 524424ee6c4e..ef002b9dd464 100644
> --- a/drivers/pinctrl/meson/pinctrl-meson.c
> +++ b/drivers/pinctrl/meson/pinctrl-meson.c
> @@ -767,4 +767,5 @@ int meson_pinctrl_probe(struct platform_device *pdev)
>   }
>   EXPORT_SYMBOL_GPL(meson_pinctrl_probe);
>   
> +MODULE_DESCRIPTION("Amlogic Meson SoCs core pinctrl driver");
>   MODULE_LICENSE("GPL v2");
> diff --git a/drivers/pinctrl/meson/pinctrl-meson8-pmx.c b/drivers/pinctrl/meson/pinctrl-meson8-pmx.c
> index f767b6923f9f..7f22aa0f8e36 100644
> --- a/drivers/pinctrl/meson/pinctrl-meson8-pmx.c
> +++ b/drivers/pinctrl/meson/pinctrl-meson8-pmx.c
> @@ -101,4 +101,5 @@ const struct pinmux_ops meson8_pmx_ops = {
>   	.gpio_request_enable = meson8_pmx_request_gpio,
>   };
>   EXPORT_SYMBOL_GPL(meson8_pmx_ops);
> +MODULE_DESCRIPTION("Amlogic Meson SoCs first generation pinmux driver");
>   MODULE_LICENSE("GPL v2");
> diff --git a/drivers/pinctrl/pinctrl-mcp23s08.c b/drivers/pinctrl/pinctrl-mcp23s08.c
> index 38c3a14c8b58..737d0ae3d0b6 100644
> --- a/drivers/pinctrl/pinctrl-mcp23s08.c
> +++ b/drivers/pinctrl/pinctrl-mcp23s08.c
> @@ -696,4 +696,5 @@ int mcp23s08_probe_one(struct mcp23s08 *mcp, struct device *dev,
>   }
>   EXPORT_SYMBOL_GPL(mcp23s08_probe_one);
>   
> +MODULE_DESCRIPTION("MCP23S08 SPI/I2C GPIO driver");
>   MODULE_LICENSE("GPL");
> diff --git a/drivers/pinctrl/pinctrl-mcp23s08_i2c.c b/drivers/pinctrl/pinctrl-mcp23s08_i2c.c
> index 04e8e7d079f0..94e1add6ddd7 100644
> --- a/drivers/pinctrl/pinctrl-mcp23s08_i2c.c
> +++ b/drivers/pinctrl/pinctrl-mcp23s08_i2c.c
> @@ -111,4 +111,5 @@ static void mcp23s08_i2c_exit(void)
>   }
>   module_exit(mcp23s08_i2c_exit);
>   
> +MODULE_DESCRIPTION("MCP23S08 I2C GPIO driver");
>   MODULE_LICENSE("GPL");
> diff --git a/drivers/pinctrl/pinctrl-mcp23s08_spi.c b/drivers/pinctrl/pinctrl-mcp23s08_spi.c
> index 4a872fff5fe8..54f61c8cb1c0 100644
> --- a/drivers/pinctrl/pinctrl-mcp23s08_spi.c
> +++ b/drivers/pinctrl/pinctrl-mcp23s08_spi.c
> @@ -263,4 +263,5 @@ static void mcp23s08_spi_exit(void)
>   }
>   module_exit(mcp23s08_spi_exit);
>   
> +MODULE_DESCRIPTION("MCP23S08 SPI GPIO driver");
>   MODULE_LICENSE("GPL");
> diff --git a/drivers/pinctrl/pinctrl-tb10x.c b/drivers/pinctrl/pinctrl-tb10x.c
> index c3b76e6511ac..4f98f72565f4 100644
> --- a/drivers/pinctrl/pinctrl-tb10x.c
> +++ b/drivers/pinctrl/pinctrl-tb10x.c
> @@ -830,4 +830,5 @@ static struct platform_driver tb10x_pinctrl_pdrv = {
>   module_platform_driver(tb10x_pinctrl_pdrv);
>   
>   MODULE_AUTHOR("Christian Ruppert <christian.ruppert@...lis.com>");
> +MODULE_DESCRIPTION("Abilis Systems TB10x pinctrl driver");
>   MODULE_LICENSE("GPL");
> 
> ---
> base-commit: 83a7eefedc9b56fe7bfeff13b6c7356688ffa670
> change-id: 20240610-md-drivers-pinctrl-7c07354ac076
>