Commit 2307d0bc authored by Lee Jones's avatar Lee Jones Committed by Kalle Valo
Browse files

wl3501_cs: Fix a bunch of formatting issues related to function docs 



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

 In file included from drivers/net/wireless/wl3501_cs.c:57:
 drivers/net/wireless/wl3501_cs.c:143: warning: Function parameter or member 'reg_domain' not described in 'iw_valid_channel'
 drivers/net/wireless/wl3501_cs.c:143: warning: Function parameter or member 'channel' not described in 'iw_valid_channel'
 drivers/net/wireless/wl3501_cs.c:162: warning: Function parameter or member 'reg_domain' not described in 'iw_default_channel'
 drivers/net/wireless/wl3501_cs.c:248: warning: Function parameter or member 'this' not described in 'wl3501_set_to_wla'
 drivers/net/wireless/wl3501_cs.c:270: warning: Function parameter or member 'this' not described in 'wl3501_get_from_wla'
 drivers/net/wireless/wl3501_cs.c:467: warning: Function parameter or member 'this' not described in 'wl3501_send_pkt'
 drivers/net/wireless/wl3501_cs.c:467: warning: Function parameter or member 'data' not described in 'wl3501_send_pkt'
 drivers/net/wireless/wl3501_cs.c:467: warning: Function parameter or member 'len' not described in 'wl3501_send_pkt'
 drivers/net/wireless/wl3501_cs.c:729: warning: Function parameter or member 'this' not described in 'wl3501_block_interrupt'
 drivers/net/wireless/wl3501_cs.c:746: warning: Function parameter or member 'this' not described in 'wl3501_unblock_interrupt'
 drivers/net/wireless/wl3501_cs.c:1124: warning: Function parameter or member 'irq' not described in 'wl3501_interrupt'
 drivers/net/wireless/wl3501_cs.c:1124: warning: Function parameter or member 'dev_id' not described in 'wl3501_interrupt'
 drivers/net/wireless/wl3501_cs.c:1257: warning: Function parameter or member 'dev' not described in 'wl3501_reset'
 drivers/net/wireless/wl3501_cs.c:1420: warning: Function parameter or member 'link' not described in 'wl3501_detach'

Cc: Kalle Valo <kvalo@codeaurora.org>
Cc: "David S. Miller" <davem@davemloft.net>
Cc: Jakub Kicinski <kuba@kernel.org>
Cc: Fox Chen <mhchen@golf.ccl.itri.org.tw>
Cc: de Melo <acme@conectiva.com.br>
Cc: Gustavo Niemeyer <niemeyer@conectiva.com>
Cc: linux-wireless@vger.kernel.org
Cc: netdev@vger.kernel.org
Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
Signed-off-by: default avatarKalle Valo <kvalo@codeaurora.org>
Link: https://lore.kernel.org/r/20200826093401.1458456-21-lee.jones@linaro.org
parent 8cea7f1c

drivers/net/wireless/wl3501_cs.c

+12 −10
Original line number Diff line number Diff line
@@ -134,8 +134,8 @@ static const struct { 


/**

 * iw_valid_channel - validate channel in regulatory domain

 * @reg_comain - regulatory domain

 * @channel - channel to validate

 * @reg_comain: regulatory domain

 * @channel: channel to validate

 *

 * Returns 0 if invalid in the specified regulatory domain, non-zero if valid.

 */
@@ -154,7 +154,7 @@ static int iw_valid_channel(int reg_domain, int channel) 


/**

 * iw_default_channel - get default channel for a regulatory domain

 * @reg_comain - regulatory domain

 * @reg_domain: regulatory domain

 *

 * Returns the default channel for a regulatory domain

 */
@@ -237,6 +237,7 @@ static int wl3501_get_flash_mac_addr(struct wl3501_card *this) 


/**

 * wl3501_set_to_wla - Move 'size' bytes from PC to card

 * @this: Card

 * @dest: Card addressing space

 * @src: PC addressing space

 * @size: Bytes to move
@@ -259,6 +260,7 @@ static void wl3501_set_to_wla(struct wl3501_card *this, u16 dest, void *src, 


/**

 * wl3501_get_from_wla - Move 'size' bytes from card to PC

 * @this: Card

 * @src: Card addressing space

 * @dest: PC addressing space

 * @size: Bytes to move
@@ -455,7 +457,7 @@ out: 


/**

 * wl3501_send_pkt - Send a packet.

 * @this - card

 * @this: Card

 *

 * Send a packet.

 *
@@ -720,7 +722,7 @@ static void wl3501_mgmt_scan_confirm(struct wl3501_card *this, u16 addr) 


/**

 * wl3501_block_interrupt - Mask interrupt from SUTRO

 * @this - card

 * @this: Card

 *

 * Mask interrupt from SUTRO. (i.e. SUTRO cannot interrupt the HOST)

 * Return: 1 if interrupt is originally enabled
@@ -737,7 +739,7 @@ static int wl3501_block_interrupt(struct wl3501_card *this) 


/**

 * wl3501_unblock_interrupt - Enable interrupt from SUTRO

 * @this - card

 * @this: Card

 *

 * Enable interrupt from SUTRO. (i.e. SUTRO can interrupt the HOST)

 * Return: 1 if interrupt is originally enabled
@@ -1110,8 +1112,8 @@ static inline void wl3501_ack_interrupt(struct wl3501_card *this) 


/**

 * wl3501_interrupt - Hardware interrupt from card.

 * @irq - Interrupt number

 * @dev_id - net_device

 * @irq: Interrupt number

 * @dev_id: net_device

 *

 * We must acknowledge the interrupt as soon as possible, and block the

 * interrupt from the same card immediately to prevent re-entry.
@@ -1247,7 +1249,7 @@ static int wl3501_close(struct net_device *dev) 


/**

 * wl3501_reset - Reset the SUTRO.

 * @dev - network device

 * @dev: network device

 *

 * It is almost the same as wl3501_open(). In fact, we may just wl3501_close()

 * and wl3501_open() again, but I wouldn't like to free_irq() when the driver
@@ -1410,7 +1412,7 @@ static struct iw_statistics *wl3501_get_wireless_stats(struct net_device *dev) 


/**

 * wl3501_detach - deletes a driver "instance"

 * @link - FILL_IN

 * @link: FILL_IN

 *

 * This deletes a driver "instance". The device is de-registered with Card

 * Services. If it has been released, all local data structures are freed.

CRA Git | Maintained and supported by SUSTech CRA and CCSE