netdev.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] wifi: brcmfmac: fix/add kernel-doc comments
@ 2025-11-29  7:38 Randy Dunlap
  2025-11-29 11:59 ` Arend van Spriel
  0 siblings, 1 reply; 2+ messages in thread
From: Randy Dunlap @ 2025-11-29  7:38 UTC (permalink / raw)
  To: netdev
  Cc: Randy Dunlap, Arend van Spriel, brcm80211, brcm80211-dev-list.pdl,
	Johannes Berg, linux-wireless

Correct or add kernel-doc comments for:
- an enum name typo
- missing struct member comments in struct vif_saved_ie and
  struct brcmf_cfg80211_vif

fixing these warnings:
Warning: drivers/net/wireless/broadcom/brcm80211/brcmfmac/cfg80211.h:195
 Enum value 'BRCMF_VIF_STATUS_EAP_SUCCESS' not described in enum
 'brcmf_vif_status'
Warning: drivers/net/wireless/broadcom/brcm80211/brcmfmac/cfg80211.h:195
 Excess enum value '@BRCMF_VIF_STATUS_EAP_SUCCUSS' description in
 'brcmf_vif_status'
Warning: drivers/net/wireless/broadcom/brcm80211/brcmfmac/cfg80211.h:220
 struct member 'assoc_req_ie' not described in 'vif_saved_ie'
Warning: drivers/net/wireless/broadcom/brcm80211/brcmfmac/cfg80211.h:220
 struct member 'assoc_req_ie_len' not described in 'vif_saved_ie'
Warning: drivers/net/wireless/broadcom/brcm80211/brcmfmac/cfg80211.h:255
 struct member 'saved_ie' not described in 'brcmf_cfg80211_vif'
Warning: drivers/net/wireless/broadcom/brcm80211/brcmfmac/cfg80211.h:255
 struct member 'is_11d' not described in 'brcmf_cfg80211_vif'

kernel-doc warnings for missing struct member descriptions in struct
brcmf_cfg80211_info and struct brcmf_cfg80211_profile are still present.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Arend van Spriel <arend.vanspriel@broadcom.com>
Cc: brcm80211@lists.linux.dev
Cc: brcm80211-dev-list.pdl@broadcom.com
Cc: Johannes Berg <johannes@sipsolutions.net>
Cc: linux-wireless@vger.kernel.org
---
 drivers/net/wireless/broadcom/brcm80211/brcmfmac/cfg80211.h |    6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

--- linux-next-20251128.orig/drivers/net/wireless/broadcom/brcm80211/brcmfmac/cfg80211.h
+++ linux-next-20251128/drivers/net/wireless/broadcom/brcm80211/brcmfmac/cfg80211.h
@@ -182,7 +182,7 @@ struct brcmf_cfg80211_profile {
  * @BRCMF_VIF_STATUS_CONNECTED: connected/joined successfully.
  * @BRCMF_VIF_STATUS_DISCONNECTING: disconnect/disable in progress.
  * @BRCMF_VIF_STATUS_AP_CREATED: AP operation started.
- * @BRCMF_VIF_STATUS_EAP_SUCCUSS: EAPOL handshake successful.
+ * @BRCMF_VIF_STATUS_EAP_SUCCESS: EAPOL handshake successful.
  * @BRCMF_VIF_STATUS_ASSOC_SUCCESS: successful SET_SSID received.
  */
 enum brcmf_vif_status {
@@ -201,10 +201,12 @@ enum brcmf_vif_status {
  * @probe_req_ie: IE info for probe request.
  * @probe_res_ie: IE info for probe response.
  * @beacon_ie: IE info for beacon frame.
+ * @assoc_req_ie: IE info for association request frame.
  * @assoc_res_ie: IE info for association response frame.
  * @probe_req_ie_len: IE info length for probe request.
  * @probe_res_ie_len: IE info length for probe response.
  * @beacon_ie_len: IE info length for beacon frame.
+ * @assoc_req_ie_len: IE info length for association request frame.
  * @assoc_res_ie_len: IE info length for association response frame.
  */
 struct vif_saved_ie {
@@ -227,12 +229,14 @@ struct vif_saved_ie {
  * @wdev: wireless device.
  * @profile: profile information.
  * @sme_state: SME state using enum brcmf_vif_status bits.
+ * @saved_ie: saved IE info for a vif.
  * @list: linked list.
  * @mgmt_tx: completion for management frame transmit.
  * @mgmt_tx_status: status of last management frame sent to firmware.
  * @mgmt_tx_id:
  * @mgmt_rx_reg: registered rx mgmt frame types.
  * @mbss: Multiple BSS type, set if not first AP (not relevant for P2P).
+ * @is_11d: beacon contains country IE, enable regulatory 802.11d support
  * @cqm_rssi_low: Lower RSSI limit for CQM monitoring
  * @cqm_rssi_high: Upper RSSI limit for CQM monitoring
  * @cqm_rssi_last: Last RSSI reading for CQM monitoring

^ permalink raw reply	[flat|nested] 2+ messages in thread

* Re: [PATCH] wifi: brcmfmac: fix/add kernel-doc comments
  2025-11-29  7:38 [PATCH] wifi: brcmfmac: fix/add kernel-doc comments Randy Dunlap
@ 2025-11-29 11:59 ` Arend van Spriel
  0 siblings, 0 replies; 2+ messages in thread
From: Arend van Spriel @ 2025-11-29 11:59 UTC (permalink / raw)
  To: Randy Dunlap, netdev
  Cc: brcm80211, brcm80211-dev-list.pdl, Johannes Berg, linux-wireless

On 11/29/2025 8:38 AM, Randy Dunlap wrote:
> Correct or add kernel-doc comments for:
> - an enum name typo
> - missing struct member comments in struct vif_saved_ie and
>    struct brcmf_cfg80211_vif

Thanks, Randy

Acked-by: Arend van Spriel <arend.vanspriel@broadcom.com>

> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> ---
> Cc: Arend van Spriel <arend.vanspriel@broadcom.com>
> Cc: brcm80211@lists.linux.dev
> Cc: brcm80211-dev-list.pdl@broadcom.com
> Cc: Johannes Berg <johannes@sipsolutions.net>
> Cc: linux-wireless@vger.kernel.org
> ---
>   drivers/net/wireless/broadcom/brcm80211/brcmfmac/cfg80211.h |    6 +++++-
>   1 file changed, 5 insertions(+), 1 deletion(-)

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2025-11-29 11:59 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-11-29  7:38 [PATCH] wifi: brcmfmac: fix/add kernel-doc comments Randy Dunlap
2025-11-29 11:59 ` Arend van Spriel

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).