diff mbox series

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

Message ID 20240122184543.2501493-18-leitao@debian.org (mailing list archive)
State Changes Requested
Delegated to: Kalle Valo
Headers show
Series None | expand

Commit Message

Breno Leitao Jan. 22, 2024, 6:45 p.m. UTC
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(+)

Comments

Kalle Valo Jan. 23, 2024, 6:38 a.m. UTC | #1
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.
Kalle Valo Jan. 23, 2024, 11:47 a.m. UTC | #2
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
Arend Van Spriel Jan. 27, 2024, 8:26 a.m. UTC | #3
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
Breno Leitao Jan. 29, 2024, 9:12 a.m. UTC | #4
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.
diff mbox series

Patch

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);