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

From: Arend van Spriel
Date: Sat Jan 27 2024 - 03:26:52 EST


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

Breno Leitao <leitao@xxxxxxxxxx> 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@xxxxxxxxxx>
---
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