Commit 4e124e1f authored Aug 14, 2020 by Lee Jones Committed by Kalle Valo Aug 27, 2020

brcmfmac: fweh: Fix docrot related function documentation issues

Also demote a commit block header which is clearly not suitable for kerneldoc.

Fixes the following W=1 kernel build warning(s):

drivers/net/wireless/broadcom/brcm80211/brcmfmac/fweh.c: In function ‘brcmf_fweh_handle_if_event’:
drivers/net/wireless/broadcom/brcm80211/brcmfmac/fweh.c:131:6: warning: variable ‘err’ set but not used [-Wunused-but-set-variable]
drivers/net/wireless/broadcom/brcm80211/brcmfmac/fweh.c:36: warning: Function parameter or member 'datalen' not described in 'brcmf_fweh_queue_item'
drivers/net/wireless/broadcom/brcm80211/brcmfmac/fweh.c:44: warning: Function parameter or member 'code' not described in 'brcmf_fweh_event_name'
drivers/net/wireless/broadcom/brcm80211/brcmfmac/fweh.c:44: warning: Function parameter or member 'name' not described in 'brcmf_fweh_event_name'
drivers/net/wireless/broadcom/brcm80211/brcmfmac/fweh.c:127: warning: Function parameter or member 'emsg' not described in 'brcmf_fweh_handle_if_event'
drivers/net/wireless/broadcom/brcm80211/brcmfmac/fweh.c:127: warning: Function parameter or member 'data' not described in 'brcmf_fweh_handle_if_event'
drivers/net/wireless/broadcom/brcm80211/brcmfmac/fweh.c:127: warning: Excess function parameter 'item' description in 'brcmf_fweh_handle_if_event'
drivers/net/wireless/broadcom/brcm80211/brcmfmac/fweh.c:127: warning: Excess function parameter 'ifpp' description in 'brcmf_fweh_handle_if_event'
drivers/net/wireless/broadcom/brcm80211/brcmfmac/fweh.c:391: warning: Function parameter or member 'packet_len' not described in 'brcmf_fweh_process_event'

Cc: Arend van Spriel <arend.vanspriel@broadcom.com>
Cc: Franky Lin <franky.lin@broadcom.com>
Cc: Hante Meuleman <hante.meuleman@broadcom.com>
Cc: Chi-Hsien Lin <chi-hsien.lin@cypress.com>
Cc: Wright Feng <wright.feng@cypress.com>
Cc: Kalle Valo <kvalo@codeaurora.org>
Cc: "David S. Miller" <davem@davemloft.net>
Cc: Jakub Kicinski <kuba@kernel.org>
Cc: Lee Jones <lee.jones@linaro.org>
Cc: linux-wireless@vger.kernel.org
Cc: brcm80211-dev-list.pdl@broadcom.com
Cc: brcm80211-dev-list@cypress.com
Cc: netdev@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
Signed-off-by: Kalle Valo <kvalo@codeaurora.org>
Link: https://lore.kernel.org/r/20200814113933.1903438-24-lee.jones@linaro.org

parent 10c3ba7d

drivers/net/wireless/broadcom/brcm80211/brcmfmac/fweh.c

+5 −3

Original line number	Diff line number	Diff line
		@@ -23,6 +23,7 @@
		* @ifidx: interface index related to this event.
		* @ifaddr: ethernet address for interface.
		* @emsg: common parameters of the firmware event message.
		* @datalen: length of the data array
		* @data: event specific data part of the firmware event.
		*/
		struct brcmf_fweh_queue_item {
		@@ -35,7 +36,7 @@ struct brcmf_fweh_queue_item {
		u8 data[];
		};

		/**
		/*
		* struct brcmf_fweh_event_name - code, name mapping entry.
		*/
		struct brcmf_fweh_event_name {
		@@ -118,8 +119,8 @@ static int brcmf_fweh_call_event_handler(struct brcmf_pub *drvr,
		* brcmf_fweh_handle_if_event() - handle IF event.
		*
		* @drvr: driver information object.
		* @item: queue entry.
		* @ifpp: interface object (may change upon ADD action).
		* @emsg: event message object.
		* @data: event object.
		*/
		static void brcmf_fweh_handle_if_event(struct brcmf_pub *drvr,
		struct brcmf_event_msg *emsg,
		@@ -380,6 +381,7 @@ int brcmf_fweh_activate_events(struct brcmf_if *ifp)
		*
		* @drvr: driver information object.
		* @event_packet: event packet to process.
		* @packet_len: length of the packet
		*
		* If the packet buffer contains a firmware event message it will
		* dispatch the event to a registered handler (using worker).

Admin message