[PATCH net-next 17/22] net: fill in MODULE_DESCRIPTION()s for Broadcom WLAN

[PATCH net-next 17/22] net: fill in MODULE_DESCRIPTION()s for Broadcom WLAN

[Breno Leitao]

W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
Add descriptions to the Broadcom FullMac WLAN drivers.

Signed-off-by: Breno Leitao <leitao@debian.org>
---
 drivers/net/wireless/broadcom/brcm80211/brcmfmac/bca/module.c | 1 +
 drivers/net/wireless/broadcom/brcm80211/brcmfmac/cyw/module.c | 1 +
 drivers/net/wireless/broadcom/brcm80211/brcmfmac/wcc/module.c | 1 +
 3 files changed, 3 insertions(+)

diff --git a/drivers/net/wireless/broadcom/brcm80211/brcmfmac/bca/module.c b/drivers/net/wireless/broadcom/brcm80211/brcmfmac/bca/module.c
index d55f3271d619..c1f91dc151c2 100644
--- a/drivers/net/wireless/broadcom/brcm80211/brcmfmac/bca/module.c
+++ b/drivers/net/wireless/broadcom/brcm80211/brcmfmac/bca/module.c
@@ -20,6 +20,7 @@ static void __exit brcmf_bca_exit(void)
 	brcmf_fwvid_unregister_vendor(BRCMF_FWVENDOR_BCA, THIS_MODULE);
 }
 
+MODULE_DESCRIPTION("Broadcom FullMAC WLAN BCA driver");
 MODULE_LICENSE("Dual BSD/GPL");
 MODULE_IMPORT_NS(BRCMFMAC);
 
diff --git a/drivers/net/wireless/broadcom/brcm80211/brcmfmac/cyw/module.c b/drivers/net/wireless/broadcom/brcm80211/brcmfmac/cyw/module.c
index f82fbbe3ecef..09fadfc147f1 100644
--- a/drivers/net/wireless/broadcom/brcm80211/brcmfmac/cyw/module.c
+++ b/drivers/net/wireless/broadcom/brcm80211/brcmfmac/cyw/module.c
@@ -20,6 +20,7 @@ static void __exit brcmf_cyw_exit(void)
 	brcmf_fwvid_unregister_vendor(BRCMF_FWVENDOR_CYW, THIS_MODULE);
 }
 
+MODULE_DESCRIPTION("Broadcom FullMAC WLAN CYW driver");
 MODULE_LICENSE("Dual BSD/GPL");
 MODULE_IMPORT_NS(BRCMFMAC);
 
diff --git a/drivers/net/wireless/broadcom/brcm80211/brcmfmac/wcc/module.c b/drivers/net/wireless/broadcom/brcm80211/brcmfmac/wcc/module.c
index 02918d434556..54426a80e2c8 100644
--- a/drivers/net/wireless/broadcom/brcm80211/brcmfmac/wcc/module.c
+++ b/drivers/net/wireless/broadcom/brcm80211/brcmfmac/wcc/module.c
@@ -20,6 +20,7 @@ static void __exit brcmf_wcc_exit(void)
 	brcmf_fwvid_unregister_vendor(BRCMF_FWVENDOR_WCC, THIS_MODULE);
 }
 
+MODULE_DESCRIPTION("Broadcom FullMAC WLAN WCC driver");
 MODULE_LICENSE("Dual BSD/GPL");
 MODULE_IMPORT_NS(BRCMFMAC);
 
-- 
2.39.3

[PATCH net-next 18/22] net: fill in MODULE_DESCRIPTION()s for wlcore

[Breno Leitao]

W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
Add descriptions to the TI WLAN wlcore drivers.

Signed-off-by: Breno Leitao <leitao@debian.org>
---
 drivers/net/wireless/ti/wlcore/main.c | 1 +
 drivers/net/wireless/ti/wlcore/sdio.c | 1 +
 drivers/net/wireless/ti/wlcore/spi.c  | 1 +
 3 files changed, 3 insertions(+)

diff --git a/drivers/net/wireless/ti/wlcore/main.c b/drivers/net/wireless/ti/wlcore/main.c
index fb9ed97774c7..5736acb4d206 100644
--- a/drivers/net/wireless/ti/wlcore/main.c
+++ b/drivers/net/wireless/ti/wlcore/main.c
@@ -6793,6 +6793,7 @@ MODULE_PARM_DESC(bug_on_recovery, "BUG() on fw recovery");
 module_param(no_recovery, int, 0600);
 MODULE_PARM_DESC(no_recovery, "Prevent HW recovery. FW will remain stuck.");
 
+MODULE_DESCRIPTION("TI WLAN core driver");
 MODULE_LICENSE("GPL");
 MODULE_AUTHOR("Luciano Coelho <coelho@ti.com>");
 MODULE_AUTHOR("Juuso Oikarinen <juuso.oikarinen@nokia.com>");
diff --git a/drivers/net/wireless/ti/wlcore/sdio.c b/drivers/net/wireless/ti/wlcore/sdio.c
index f0686635db46..eb5482ed76ae 100644
--- a/drivers/net/wireless/ti/wlcore/sdio.c
+++ b/drivers/net/wireless/ti/wlcore/sdio.c
@@ -447,6 +447,7 @@ module_sdio_driver(wl1271_sdio_driver);
 module_param(dump, bool, 0600);
 MODULE_PARM_DESC(dump, "Enable sdio read/write dumps.");
 
+MODULE_DESCRIPTION("TI WLAN SDIO helpers");
 MODULE_LICENSE("GPL");
 MODULE_AUTHOR("Luciano Coelho <coelho@ti.com>");
 MODULE_AUTHOR("Juuso Oikarinen <juuso.oikarinen@nokia.com>");
diff --git a/drivers/net/wireless/ti/wlcore/spi.c b/drivers/net/wireless/ti/wlcore/spi.c
index 7d9a139db59e..0aa2b2f3c5c9 100644
--- a/drivers/net/wireless/ti/wlcore/spi.c
+++ b/drivers/net/wireless/ti/wlcore/spi.c
@@ -562,6 +562,7 @@ static struct spi_driver wl1271_spi_driver = {
 };
 
 module_spi_driver(wl1271_spi_driver);
+MODULE_DESCRIPTION("TI WLAN SPI helpers");
 MODULE_LICENSE("GPL");
 MODULE_AUTHOR("Luciano Coelho <coelho@ti.com>");
 MODULE_AUTHOR("Juuso Oikarinen <juuso.oikarinen@nokia.com>");
-- 
2.39.3

[PATCH net-next 19/22] net: fill in MODULE_DESCRIPTION()s for wl1251 and wl12xx

[Breno Leitao]

W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
Add descriptions to the TI wireless drivers wl12xx and wl1251.

Signed-off-by: Breno Leitao <leitao@debian.org>
---
 drivers/net/wireless/ti/wl1251/sdio.c | 1 +
 drivers/net/wireless/ti/wl1251/spi.c  | 1 +
 drivers/net/wireless/ti/wl12xx/main.c | 1 +
 3 files changed, 3 insertions(+)

diff --git a/drivers/net/wireless/ti/wl1251/sdio.c b/drivers/net/wireless/ti/wl1251/sdio.c
index 301bd0043a43..4e5b351f80f0 100644
--- a/drivers/net/wireless/ti/wl1251/sdio.c
+++ b/drivers/net/wireless/ti/wl1251/sdio.c
@@ -343,5 +343,6 @@ static void __exit wl1251_sdio_exit(void)
 module_init(wl1251_sdio_init);
 module_exit(wl1251_sdio_exit);
 
+MODULE_DESCRIPTION("TI WL1251 SDIO helpers");
 MODULE_LICENSE("GPL");
 MODULE_AUTHOR("Kalle Valo <kvalo@adurom.com>");
diff --git a/drivers/net/wireless/ti/wl1251/spi.c b/drivers/net/wireless/ti/wl1251/spi.c
index 29292f06bd3d..1936bb3af54a 100644
--- a/drivers/net/wireless/ti/wl1251/spi.c
+++ b/drivers/net/wireless/ti/wl1251/spi.c
@@ -342,6 +342,7 @@ static struct spi_driver wl1251_spi_driver = {
 
 module_spi_driver(wl1251_spi_driver);
 
+MODULE_DESCRIPTION("TI WL1251 SPI helpers");
 MODULE_LICENSE("GPL");
 MODULE_AUTHOR("Kalle Valo <kvalo@adurom.com>");
 MODULE_ALIAS("spi:wl1251");
diff --git a/drivers/net/wireless/ti/wl12xx/main.c b/drivers/net/wireless/ti/wl12xx/main.c
index de045fe4ca1e..9a12ce453f8d 100644
--- a/drivers/net/wireless/ti/wl12xx/main.c
+++ b/drivers/net/wireless/ti/wl12xx/main.c
@@ -1955,6 +1955,7 @@ module_param_named(tcxo, tcxo_param, charp, 0);
 MODULE_PARM_DESC(tcxo,
 		 "TCXO clock: 19.2, 26, 38.4, 52, 16.368, 32.736, 16.8, 33.6");
 
+MODULE_DESCRIPTION("TI WL12xx Wireless driver");
 MODULE_LICENSE("GPL v2");
 MODULE_AUTHOR("Luciano Coelho <coelho@ti.com>");
 MODULE_FIRMWARE(WL127X_FW_NAME_SINGLE);
-- 
2.39.3

Re: [PATCH net-next 00/22] Fix MODULE_DESCRIPTION() for net (p2)

[Jakub Kicinski]

On Mon, 22 Jan 2024 10:45:21 -0800 Breno Leitao wrote:
>   net: fill in MODULE_DESCRIPTION()s for Broadcom WLAN
>   net: fill in MODULE_DESCRIPTION()s for wlcore
>   net: fill in MODULE_DESCRIPTION()s for wl1251 and wl12xx

Thanks for making progress on these!

When you repost:
 - please send these 3 to linux-wireless as a separate series
 - make sure mailing lists are CCed on the cover letter
   (yes, get_maintainer is embarrassingly bad at its job)
 - please send 10 at-a-time, it's probably a good tradeoff
   between series size and reposting risk
 - please target net, I hope I convinced Paolo that it's okay :)

Re: [PATCH net-next 17/22] net: fill in MODULE_DESCRIPTION()s for Broadcom WLAN

[Kalle Valo]

Breno Leitao <leitao@debian.org> writes:

> W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
> Add descriptions to the Broadcom FullMac WLAN drivers.
>
> Signed-off-by: Breno Leitao <leitao@debian.org>
> ---
>  drivers/net/wireless/broadcom/brcm80211/brcmfmac/bca/module.c | 1 +
>  drivers/net/wireless/broadcom/brcm80211/brcmfmac/cyw/module.c | 1 +
>  drivers/net/wireless/broadcom/brcm80211/brcmfmac/wcc/module.c | 1 +
>  3 files changed, 3 insertions(+)
>
> diff --git a/drivers/net/wireless/broadcom/brcm80211/brcmfmac/bca/module.c b/drivers/net/wireless/broadcom/brcm80211/brcmfmac/bca/module.c
> index d55f3271d619..c1f91dc151c2 100644
> --- a/drivers/net/wireless/broadcom/brcm80211/brcmfmac/bca/module.c
> +++ b/drivers/net/wireless/broadcom/brcm80211/brcmfmac/bca/module.c
> @@ -20,6 +20,7 @@ static void __exit brcmf_bca_exit(void)
>  	brcmf_fwvid_unregister_vendor(BRCMF_FWVENDOR_BCA, THIS_MODULE);
>  }
>  
> +MODULE_DESCRIPTION("Broadcom FullMAC WLAN BCA driver");

It would be good to spell out BCA. I don't even know what it means :)

> --- a/drivers/net/wireless/broadcom/brcm80211/brcmfmac/cyw/module.c
> +++ b/drivers/net/wireless/broadcom/brcm80211/brcmfmac/cyw/module.c
> @@ -20,6 +20,7 @@ static void __exit brcmf_cyw_exit(void)
>  	brcmf_fwvid_unregister_vendor(BRCMF_FWVENDOR_CYW, THIS_MODULE);
>  }
>  
> +MODULE_DESCRIPTION("Broadcom FullMAC WLAN CYW driver");

Same for CYW.

-- 
https://patchwork.kernel.org/project/linux-wireless/list/

https://wireless.wiki.kernel.org/en/developers/documentation/submittingpatches

Re: [PATCH net-next 17/22] net: fill in MODULE_DESCRIPTION()s for Broadcom WLAN

[Kalle Valo]

Breno Leitao <leitao@debian.org> wrote:

> W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
> Add descriptions to the Broadcom FullMac WLAN drivers.
> 
> Signed-off-by: Breno Leitao <leitao@debian.org>

Wireless patches should use "wifi: " prefix:

ERROR: 'wifi:' prefix missing: '[PATCH net-next 17/22] net: fill in MODULE_DESCRIPTION()s for Broadcom WLAN'
ERROR: 'wifi:' prefix missing: '[PATCH net-next 18/22] net: fill in MODULE_DESCRIPTION()s for wlcore'
ERROR: 'wifi:' prefix missing: '[PATCH net-next 19/22] net: fill in MODULE_DESCRIPTION()s for wl1251 and wl12xx'

3 patches set to Changes Requested.

13526063 [net-next,17/22] net: fill in MODULE_DESCRIPTION()s for Broadcom WLAN
13526064 [net-next,18/22] net: fill in MODULE_DESCRIPTION()s for wlcore
13526065 [net-next,19/22] net: fill in MODULE_DESCRIPTION()s for wl1251 and wl12xx

-- 
https://patchwork.kernel.org/project/linux-wireless/patch/20240122184543.2501493-18-leitao@debian.org/

https://wireless.wiki.kernel.org/en/developers/documentation/submittingpatches

Re: [PATCH net-next 00/22] Fix MODULE_DESCRIPTION() for net (p2)

[Breno Leitao]

On Mon, Jan 22, 2024 at 10:57:08AM -0800, Jakub Kicinski wrote:
> On Mon, 22 Jan 2024 10:45:21 -0800 Breno Leitao wrote:
> >   net: fill in MODULE_DESCRIPTION()s for Broadcom WLAN
> >   net: fill in MODULE_DESCRIPTION()s for wlcore
> >   net: fill in MODULE_DESCRIPTION()s for wl1251 and wl12xx
> 
> Thanks for making progress on these!
> 
> When you repost:
>  - please send these 3 to linux-wireless as a separate series
>  - make sure mailing lists are CCed on the cover letter
>    (yes, get_maintainer is embarrassingly bad at its job)
>  - please send 10 at-a-time, it's probably a good tradeoff
>    between series size and reposting risk
>  - please target net, I hope I convinced Paolo that it's okay :)

Sure. I will split this series in 3 and target `net`.

I suppose it is OK to send the patchsets in parallel, instead of waiting
for the first patchset to be reviewed/accepted before sending the second
part. Is this correct?

Thanks!

Re: [PATCH net-next 00/22] Fix MODULE_DESCRIPTION() for net (p2)

[Jakub Kicinski]

On Tue, 23 Jan 2024 08:25:28 -0800 Breno Leitao wrote:
> > When you repost:
> >  - please send these 3 to linux-wireless as a separate series
> >  - make sure mailing lists are CCed on the cover letter
> >    (yes, get_maintainer is embarrassingly bad at its job)
> >  - please send 10 at-a-time, it's probably a good tradeoff
> >    between series size and reposting risk
> >  - please target net, I hope I convinced Paolo that it's okay :)  
> 
> Sure. I will split this series in 3 and target `net`.

The wireless ones need to target wireless, just to be clear.
The rest should fit into 2 series.

> I suppose it is OK to send the patchsets in parallel, instead of waiting
> for the first patchset to be reviewed/accepted before sending the second
> part. Is this correct?

The rate limit is to avoid having to give the same feedback to multiple
series, among other things. it'd be better to send one part at a time..
it won't take that long :)

Re: [PATCH net-next 00/22] Fix MODULE_DESCRIPTION() for net (p2)

[Breno Leitao]

On Tue, Jan 23, 2024 at 08:35:17AM -0800, Jakub Kicinski wrote:
> On Tue, 23 Jan 2024 08:25:28 -0800 Breno Leitao wrote:
> > > When you repost:
> > >  - please send these 3 to linux-wireless as a separate series
> > >  - make sure mailing lists are CCed on the cover letter
> > >    (yes, get_maintainer is embarrassingly bad at its job)
> > >  - please send 10 at-a-time, it's probably a good tradeoff
> > >    between series size and reposting risk
> > >  - please target net, I hope I convinced Paolo that it's okay :)  
> > 
> > Sure. I will split this series in 3 and target `net`.
> 
> The wireless ones need to target wireless, just to be clear.
> The rest should fit into 2 series.
> 
> > I suppose it is OK to send the patchsets in parallel, instead of waiting
> > for the first patchset to be reviewed/accepted before sending the second
> > part. Is this correct?
> 
> The rate limit is to avoid having to give the same feedback to multiple
> series, among other things. it'd be better to send one part at a time..
> it won't take that long :)

Sure. Thanks for the clarifications!

Re: [PATCH net-next 17/22] net: fill in MODULE_DESCRIPTION()s for Broadcom WLAN

[Arend van Spriel]

On January 23, 2024 7:38:36 AM Kalle Valo <kvalo@kernel.org> wrote:

> Breno Leitao <leitao@debian.org> writes:
>
>> W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
>> Add descriptions to the Broadcom FullMac WLAN drivers.
>>
>> Signed-off-by: Breno Leitao <leitao@debian.org>
>> ---
>> drivers/net/wireless/broadcom/brcm80211/brcmfmac/bca/module.c | 1 +
>> drivers/net/wireless/broadcom/brcm80211/brcmfmac/cyw/module.c | 1 +
>> drivers/net/wireless/broadcom/brcm80211/brcmfmac/wcc/module.c | 1 +
>> 3 files changed, 3 insertions(+)
>>
>> diff --git a/drivers/net/wireless/broadcom/brcm80211/brcmfmac/bca/module.c 
>> b/drivers/net/wireless/broadcom/brcm80211/brcmfmac/bca/module.c
>> index d55f3271d619..c1f91dc151c2 100644
>> --- a/drivers/net/wireless/broadcom/brcm80211/brcmfmac/bca/module.c
>> +++ b/drivers/net/wireless/broadcom/brcm80211/brcmfmac/bca/module.c
>> @@ -20,6 +20,7 @@ static void __exit brcmf_bca_exit(void)
>> brcmf_fwvid_unregister_vendor(BRCMF_FWVENDOR_BCA, THIS_MODULE);
>> }
>>
>> +MODULE_DESCRIPTION("Broadcom FullMAC WLAN BCA driver");
>
> It would be good to spell out BCA. I don't even know what it means :)

If my memory don't fail me it is Broadband Carrier Access. Basically it's 
the AP side of the Broadcom wifi business.

>
>
>> --- a/drivers/net/wireless/broadcom/brcm80211/brcmfmac/cyw/module.c
>> +++ b/drivers/net/wireless/broadcom/brcm80211/brcmfmac/cyw/module.c
>> @@ -20,6 +20,7 @@ static void __exit brcmf_cyw_exit(void)
>> brcmf_fwvid_unregister_vendor(BRCMF_FWVENDOR_CYW, THIS_MODULE);
>> }
>>
>> +MODULE_DESCRIPTION("Broadcom FullMAC WLAN CYW driver");
>
> Same for CYW.

A bit easier: Cypress Wifi.

Kalle does apparently knows what WCC stands for ;-p To be honest I am not 
sure but it is the mobility business.

So these modules a not standalone modules hence I didn't bother adding a 
description. My bad. These are plugin modules so to speak so if I can make 
a suggestion here please rephrase to something like:

BCA: "Broadcom FullMAC WLAN driver plugin for Broadcom AP chipsets" and
WCC: "... for Broadcom mobility chipsets" and
CYW: "... for Cypress/Infineon chipsets".

Regards,
Arend

Re: [PATCH net-next 17/22] net: fill in MODULE_DESCRIPTION()s for Broadcom WLAN

[Breno Leitao]

On Sat, Jan 27, 2024 at 09:26:35AM +0100, Arend van Spriel wrote:
> On January 23, 2024 7:38:36 AM Kalle Valo <kvalo@kernel.org> wrote:
> 
> > Breno Leitao <leitao@debian.org> writes:
> > 
> > > W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
> > > Add descriptions to the Broadcom FullMac WLAN drivers.
> > > 
> > > Signed-off-by: Breno Leitao <leitao@debian.org>
> > > ---
> > > drivers/net/wireless/broadcom/brcm80211/brcmfmac/bca/module.c | 1 +
> > > drivers/net/wireless/broadcom/brcm80211/brcmfmac/cyw/module.c | 1 +
> > > drivers/net/wireless/broadcom/brcm80211/brcmfmac/wcc/module.c | 1 +
> > > 3 files changed, 3 insertions(+)
> > > 
> > > diff --git
> > > a/drivers/net/wireless/broadcom/brcm80211/brcmfmac/bca/module.c
> > > b/drivers/net/wireless/broadcom/brcm80211/brcmfmac/bca/module.c
> > > index d55f3271d619..c1f91dc151c2 100644
> > > --- a/drivers/net/wireless/broadcom/brcm80211/brcmfmac/bca/module.c
> > > +++ b/drivers/net/wireless/broadcom/brcm80211/brcmfmac/bca/module.c
> > > @@ -20,6 +20,7 @@ static void __exit brcmf_bca_exit(void)
> > > brcmf_fwvid_unregister_vendor(BRCMF_FWVENDOR_BCA, THIS_MODULE);
> > > }
> > > 
> > > +MODULE_DESCRIPTION("Broadcom FullMAC WLAN BCA driver");
> > 
> > It would be good to spell out BCA. I don't even know what it means :)
> 
> If my memory don't fail me it is Broadband Carrier Access. Basically it's
> the AP side of the Broadcom wifi business.
> 
> > 
> > 
> > > --- a/drivers/net/wireless/broadcom/brcm80211/brcmfmac/cyw/module.c
> > > +++ b/drivers/net/wireless/broadcom/brcm80211/brcmfmac/cyw/module.c
> > > @@ -20,6 +20,7 @@ static void __exit brcmf_cyw_exit(void)
> > > brcmf_fwvid_unregister_vendor(BRCMF_FWVENDOR_CYW, THIS_MODULE);
> > > }
> > > 
> > > +MODULE_DESCRIPTION("Broadcom FullMAC WLAN CYW driver");
> > 
> > Same for CYW.
> 
> A bit easier: Cypress Wifi.
> 
> Kalle does apparently knows what WCC stands for ;-p To be honest I am not
> sure but it is the mobility business.
> 
> So these modules a not standalone modules hence I didn't bother adding a
> description. My bad. These are plugin modules so to speak so if I can make a
> suggestion here please rephrase to something like:
> 
> BCA: "Broadcom FullMAC WLAN driver plugin for Broadcom AP chipsets" and
> WCC: "... for Broadcom mobility chipsets" and
> CYW: "... for Cypress/Infineon chipsets".

Thanks Arend, I will update accordingly.