Commit f030ed40 authored Aug 19, 2020 by Lee Jones Committed by Kalle Valo Sep 01, 2020

libertas_tf: Fix function documentation formatting errors

Kerneldoc expects attributes/parameters to be in '@*.: ' format and
gets confused if the variable does not follow the type/attribute
definitions.

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

drivers/net/wireless/marvell/libertas_tf/if_usb.c:56: warning: Function parameter or member 'urb' not described in 'if_usb_write_bulk_callback'
drivers/net/wireless/marvell/libertas_tf/if_usb.c:73: warning: Function parameter or member 'cardp' not described in 'if_usb_free'
drivers/net/wireless/marvell/libertas_tf/if_usb.c:146: warning: Function parameter or member 'intf' not described in 'if_usb_probe'
drivers/net/wireless/marvell/libertas_tf/if_usb.c:146: warning: Function parameter or member 'id' not described in 'if_usb_probe'
drivers/net/wireless/marvell/libertas_tf/if_usb.c:244: warning: Function parameter or member 'intf' not described in 'if_usb_disconnect'
drivers/net/wireless/marvell/libertas_tf/if_usb.c:272: warning: Function parameter or member 'cardp' not described in 'if_usb_send_fw_pkt'
drivers/net/wireless/marvell/libertas_tf/if_usb.c:372: warning: Function parameter or member 'cardp' not described in 'usb_tx_block'
drivers/net/wireless/marvell/libertas_tf/if_usb.c:372: warning: Function parameter or member 'payload' not described in 'usb_tx_block'
drivers/net/wireless/marvell/libertas_tf/if_usb.c:372: warning: Function parameter or member 'nb' not described in 'usb_tx_block'
drivers/net/wireless/marvell/libertas_tf/if_usb.c:372: warning: Function parameter or member 'data' not described in 'usb_tx_block'
drivers/net/wireless/marvell/libertas_tf/if_usb.c:625: warning: Function parameter or member 'urb' not described in 'if_usb_receive'
drivers/net/wireless/marvell/libertas_tf/if_usb.c:714: warning: Function parameter or member 'priv' not described in 'if_usb_host_to_card'
drivers/net/wireless/marvell/libertas_tf/if_usb.c:714: warning: Function parameter or member 'type' not described in 'if_usb_host_to_card'
drivers/net/wireless/marvell/libertas_tf/if_usb.c:714: warning: Function parameter or member 'payload' not described in 'if_usb_host_to_card'
drivers/net/wireless/marvell/libertas_tf/if_usb.c:714: warning: Function parameter or member 'nb' not described in 'if_usb_host_to_card'
drivers/net/wireless/marvell/libertas_tf/if_usb.c:742: warning: Function parameter or member 'cardp' not described in 'if_usb_issue_boot_command'
drivers/net/wireless/marvell/libertas_tf/if_usb.c:742: warning: Function parameter or member 'ivalue' not described in 'if_usb_issue_boot_command'
drivers/net/wireless/marvell/libertas_tf/if_usb.c:766: warning: Function parameter or member 'data' not described in 'check_fwfile_format'
drivers/net/wireless/marvell/libertas_tf/if_usb.c:766: warning: Function parameter or member 'totlen' not described in 'check_fwfile_format'

Cc: Kalle Valo <kvalo@codeaurora.org>
Cc: "David S. Miller" <davem@davemloft.net>
Cc: Jakub Kicinski <kuba@kernel.org>
Cc: Colin Ian King <colin.king@canonical.com>
Cc: linux-wireless@vger.kernel.org
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/20200819072402.3085022-28-lee.jones@linaro.org

parent 45702355

drivers/net/wireless/marvell/libertas_tf/if_usb.c

+19 −18

Original line number	Diff line number	Diff line
		@@ -50,7 +50,7 @@ static int if_usb_reset_device(struct lbtf_private *priv);
		/**
		* if_usb_wrike_bulk_callback - call back to handle URB status
		*
		* @param urb pointer to urb structure
		* @urb: pointer to urb structure
		*/
		static void if_usb_write_bulk_callback(struct urb *urb)
		{
		@@ -67,7 +67,7 @@ static void if_usb_write_bulk_callback(struct urb *urb)
		/**
		* if_usb_free - free tx/rx urb, skb and rx buffer
		*
		* @param cardp pointer if_usb_card
		* @cardp: pointer if_usb_card
		*/
		static void if_usb_free(struct if_usb_card *cardp)
		{
		@@ -136,8 +136,8 @@ static const struct lbtf_ops if_usb_ops = {
		/**
		* if_usb_probe - sets the configuration values
		*
		* @ifnum interface number
		* @id pointer to usb_device_id
		* @intf: USB interface structure
		* @id: pointer to usb_device_id
		*
		* Returns: 0 on success, error code on failure
		*/
		@@ -238,7 +238,7 @@ lbtf_deb_leave(LBTF_DEB_MAIN);
		/**
		* if_usb_disconnect - free resource and cleanup
		*
		* @intf USB interface structure
		* @intf: USB interface structure
		*/
		static void if_usb_disconnect(struct usb_interface *intf)
		{
		@@ -264,7 +264,7 @@ static void if_usb_disconnect(struct usb_interface *intf)
		/**
		* if_usb_send_fw_pkt - This function downloads the FW
		*
		* @priv pointer to struct lbtf_private
		* @cardp: pointer if_usb_card
		*
		* Returns: 0
		*/
		@@ -360,10 +360,10 @@ static int if_usb_reset_device(struct lbtf_private *priv)
		/**
		* usb_tx_block - transfer data to the device
		*
		* @priv pointer to struct lbtf_private
		* @payload pointer to payload data
		* @nb data length
		* @data non-zero for data, zero for commands
		* @cardp: pointer if_usb_card
		* @payload: pointer to payload data
		* @nb: data length
		* @data: non-zero for data, zero for commands
		*
		* Returns: 0 on success, nonzero otherwise.
		*/
		@@ -619,7 +619,7 @@ static inline void process_cmdrequest(int recvlength, uint8_t *recvbuff,
		/**
		* if_usb_receive - read data received from the device.
		*
		* @urb pointer to struct urb
		* @urb: pointer to struct urb
		*/
		static void if_usb_receive(struct urb *urb)
		{
		@@ -702,10 +702,10 @@ static void if_usb_receive(struct urb *urb)
		/**
		* if_usb_host_to_card - Download data to the device
		*
		* @priv pointer to struct lbtf_private structure
		* @type type of data
		* @buf pointer to data buffer
		* @len number of bytes
		* @priv: pointer to struct lbtf_private structure
		* @type: type of data
		* @payload: pointer to payload buffer
		* @nb: number of bytes
		*
		* Returns: 0 on success, nonzero otherwise
		*/
		@@ -734,7 +734,8 @@ static int if_usb_host_to_card(struct lbtf_private *priv, uint8_t type,
		/**
		* if_usb_issue_boot_command - Issue boot command to Boot2.
		*
		* @ivalue 1 boots from FW by USB-Download, 2 boots from FW in EEPROM.
		* @cardp: pointer if_usb_card
		* @ivalue: 1 boots from FW by USB-Download, 2 boots from FW in EEPROM.
		*
		* Returns: 0
		*/
		@@ -757,8 +758,8 @@ static int if_usb_issue_boot_command(struct if_usb_card *cardp, int ivalue)
		/**
		* check_fwfile_format - Check the validity of Boot2/FW image.
		*
		* @data pointer to image
		* @totlen image length
		* @data: pointer to image
		* @totlen: image length
		*
		* Returns: 0 if the image is valid, nonzero otherwise.
		*/