Commit 6b9739c8 authored by Lee Jones's avatar Lee Jones Committed by Kalle Valo

wil6210: wmi: Fix formatting and demote non-conforming function headers

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

 drivers/net/wireless/ath/wil6210/wmi.c:52: warning: Incorrect use of kernel-doc format:  * Addressing - theory of operations
 drivers/net/wireless/ath/wil6210/wmi.c:70: warning: Incorrect use of kernel-doc format:  * @sparrow_fw_mapping provides memory remapping table for sparrow
 drivers/net/wireless/ath/wil6210/wmi.c:80: warning: cannot understand function prototype: 'const struct fw_map sparrow_fw_mapping[] = '
 drivers/net/wireless/ath/wil6210/wmi.c:107: warning: Cannot understand  * @sparrow_d0_mac_rgf_ext - mac_rgf_ext section for Sparrow D0
 drivers/net/wireless/ath/wil6210/wmi.c:115: warning: Cannot understand  * @talyn_fw_mapping provides memory remapping table for Talyn
 drivers/net/wireless/ath/wil6210/wmi.c:158: warning: Cannot understand  * @talyn_mb_fw_mapping provides memory remapping table for Talyn-MB
 drivers/net/wireless/ath/wil6210/wmi.c:236: warning: Function parameter or member 'x' not described in 'wmi_addr_remap'
 drivers/net/wireless/ath/wil6210/wmi.c:255: warning: Function parameter or member 'section' not described in 'wil_find_fw_mapping'
 drivers/net/wireless/ath/wil6210/wmi.c:278: warning: Function parameter or member 'wil' not described in 'wmi_buffer_block'
 drivers/net/wireless/ath/wil6210/wmi.c:278: warning: Function parameter or member 'ptr_' not described in 'wmi_buffer_block'
 drivers/net/wireless/ath/wil6210/wmi.c:278: warning: Function parameter or member 'size' not described in 'wmi_buffer_block'
 drivers/net/wireless/ath/wil6210/wmi.c:307: warning: Function parameter or member 'wil' not described in 'wmi_addr'
 drivers/net/wireless/ath/wil6210/wmi.c:307: warning: Function parameter or member 'ptr' not described in 'wmi_addr'
 drivers/net/wireless/ath/wil6210/wmi.c:1589: warning: Function parameter or member 'wil' not described in 'wil_find_cid_ringid_sta'
 drivers/net/wireless/ath/wil6210/wmi.c:1589: warning: Function parameter or member 'vif' not described in 'wil_find_cid_ringid_sta'
 drivers/net/wireless/ath/wil6210/wmi.c:1589: warning: Function parameter or member 'cid' not described in 'wil_find_cid_ringid_sta'
 drivers/net/wireless/ath/wil6210/wmi.c:1589: warning: Function parameter or member 'ringid' not described in 'wil_find_cid_ringid_sta'
 drivers/net/wireless/ath/wil6210/wmi.c:1876: warning: Function parameter or member 'vif' not described in 'wmi_evt_ignore'
 drivers/net/wireless/ath/wil6210/wmi.c:1876: warning: Function parameter or member 'id' not described in 'wmi_evt_ignore'
 drivers/net/wireless/ath/wil6210/wmi.c:1876: warning: Function parameter or member 'd' not described in 'wmi_evt_ignore'
 drivers/net/wireless/ath/wil6210/wmi.c:1876: warning: Function parameter or member 'len' not described in 'wmi_evt_ignore'
 drivers/net/wireless/ath/wil6210/wmi.c:2588: warning: Function parameter or member 'wil' not described in 'wmi_rxon'

Cc: Maya Erez <merez@codeaurora.org>
Cc: Kalle Valo <kvalo@codeaurora.org>
Cc: "David S. Miller" <davem@davemloft.net>
Cc: Jakub Kicinski <kuba@kernel.org>
Cc: linux-wireless@vger.kernel.org
Cc: wil6210@qti.qualcomm.com
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/20200827073201.GR3248864@dell
parent b2c09458
...@@ -32,7 +32,7 @@ MODULE_PARM_DESC(led_id, ...@@ -32,7 +32,7 @@ MODULE_PARM_DESC(led_id,
#define WIL_WMI_PCP_STOP_TO_MS 5000 #define WIL_WMI_PCP_STOP_TO_MS 5000
/** /**
* WMI event receiving - theory of operations * DOC: WMI event receiving - theory of operations
* *
* When firmware about to report WMI event, it fills memory area * When firmware about to report WMI event, it fills memory area
* in the mailbox and raises misc. IRQ. Thread interrupt handler invoked for * in the mailbox and raises misc. IRQ. Thread interrupt handler invoked for
...@@ -49,7 +49,7 @@ MODULE_PARM_DESC(led_id, ...@@ -49,7 +49,7 @@ MODULE_PARM_DESC(led_id,
*/ */
/** /**
* Addressing - theory of operations * DOC: Addressing - theory of operations
* *
* There are several buses present on the WIL6210 card. * There are several buses present on the WIL6210 card.
* Same memory areas are visible at different address on * Same memory areas are visible at different address on
...@@ -66,8 +66,7 @@ MODULE_PARM_DESC(led_id, ...@@ -66,8 +66,7 @@ MODULE_PARM_DESC(led_id,
* AHB address must be used. * AHB address must be used.
*/ */
/** /* sparrow_fw_mapping provides memory remapping table for sparrow
* @sparrow_fw_mapping provides memory remapping table for sparrow
* *
* array size should be in sync with the declaration in the wil6210.h * array size should be in sync with the declaration in the wil6210.h
* *
...@@ -103,16 +102,14 @@ const struct fw_map sparrow_fw_mapping[] = { ...@@ -103,16 +102,14 @@ const struct fw_map sparrow_fw_mapping[] = {
{0x800000, 0x804000, 0x940000, "uc_data", false, false}, {0x800000, 0x804000, 0x940000, "uc_data", false, false},
}; };
/** /* sparrow_d0_mac_rgf_ext - mac_rgf_ext section for Sparrow D0
* @sparrow_d0_mac_rgf_ext - mac_rgf_ext section for Sparrow D0
* it is a bit larger to support extra features * it is a bit larger to support extra features
*/ */
const struct fw_map sparrow_d0_mac_rgf_ext = { const struct fw_map sparrow_d0_mac_rgf_ext = {
0x88c000, 0x88c500, 0x88c000, "mac_rgf_ext", true, true 0x88c000, 0x88c500, 0x88c000, "mac_rgf_ext", true, true
}; };
/** /* talyn_fw_mapping provides memory remapping table for Talyn
* @talyn_fw_mapping provides memory remapping table for Talyn
* *
* array size should be in sync with the declaration in the wil6210.h * array size should be in sync with the declaration in the wil6210.h
* *
...@@ -154,8 +151,7 @@ const struct fw_map talyn_fw_mapping[] = { ...@@ -154,8 +151,7 @@ const struct fw_map talyn_fw_mapping[] = {
{0x800000, 0x808000, 0xa78000, "uc_data", false, false}, {0x800000, 0x808000, 0xa78000, "uc_data", false, false},
}; };
/** /* talyn_mb_fw_mapping provides memory remapping table for Talyn-MB
* @talyn_mb_fw_mapping provides memory remapping table for Talyn-MB
* *
* array size should be in sync with the declaration in the wil6210.h * array size should be in sync with the declaration in the wil6210.h
* *
...@@ -229,7 +225,7 @@ u8 led_polarity = LED_POLARITY_LOW_ACTIVE; ...@@ -229,7 +225,7 @@ u8 led_polarity = LED_POLARITY_LOW_ACTIVE;
/** /**
* return AHB address for given firmware internal (linker) address * return AHB address for given firmware internal (linker) address
* @x - internal address * @x: internal address
* If address have no valid AHB mapping, return 0 * If address have no valid AHB mapping, return 0
*/ */
static u32 wmi_addr_remap(u32 x) static u32 wmi_addr_remap(u32 x)
...@@ -247,7 +243,7 @@ static u32 wmi_addr_remap(u32 x) ...@@ -247,7 +243,7 @@ static u32 wmi_addr_remap(u32 x)
/** /**
* find fw_mapping entry by section name * find fw_mapping entry by section name
* @section - section name * @section: section name
* *
* Return pointer to section or NULL if not found * Return pointer to section or NULL if not found
*/ */
...@@ -265,8 +261,9 @@ struct fw_map *wil_find_fw_mapping(const char *section) ...@@ -265,8 +261,9 @@ struct fw_map *wil_find_fw_mapping(const char *section)
/** /**
* Check address validity for WMI buffer; remap if needed * Check address validity for WMI buffer; remap if needed
* @ptr - internal (linker) fw/ucode address * @wil: driver data
* @size - if non zero, validate the block does not * @ptr: internal (linker) fw/ucode address
* @size: if non zero, validate the block does not
* exceed the device memory (bar) * exceed the device memory (bar)
* *
* Valid buffer should be DWORD aligned * Valid buffer should be DWORD aligned
...@@ -300,9 +297,7 @@ void __iomem *wmi_buffer(struct wil6210_priv *wil, __le32 ptr_) ...@@ -300,9 +297,7 @@ void __iomem *wmi_buffer(struct wil6210_priv *wil, __le32 ptr_)
return wmi_buffer_block(wil, ptr_, 0); return wmi_buffer_block(wil, ptr_, 0);
} }
/** /* Check address validity */
* Check address validity
*/
void __iomem *wmi_addr(struct wil6210_priv *wil, u32 ptr) void __iomem *wmi_addr(struct wil6210_priv *wil, u32 ptr)
{ {
u32 off; u32 off;
...@@ -1577,8 +1572,7 @@ wmi_evt_link_stats(struct wil6210_vif *vif, int id, void *d, int len) ...@@ -1577,8 +1572,7 @@ wmi_evt_link_stats(struct wil6210_vif *vif, int id, void *d, int len)
evt->payload, payload_size); evt->payload, payload_size);
} }
/** /* find cid and ringid for the station vif
* find cid and ringid for the station vif
* *
* return error, if other interfaces are used or ring was not found * return error, if other interfaces are used or ring was not found
*/ */
...@@ -1868,8 +1862,7 @@ wmi_evt_link_monitor(struct wil6210_vif *vif, int id, void *d, int len) ...@@ -1868,8 +1862,7 @@ wmi_evt_link_monitor(struct wil6210_vif *vif, int id, void *d, int len)
cfg80211_cqm_rssi_notify(ndev, event_type, evt->rssi_level, GFP_KERNEL); cfg80211_cqm_rssi_notify(ndev, event_type, evt->rssi_level, GFP_KERNEL);
} }
/** /* Some events are ignored for purpose; and need not be interpreted as
* Some events are ignored for purpose; and need not be interpreted as
* "unhandled events" * "unhandled events"
*/ */
static void wmi_evt_ignore(struct wil6210_vif *vif, int id, void *d, int len) static void wmi_evt_ignore(struct wil6210_vif *vif, int id, void *d, int len)
...@@ -2578,6 +2571,7 @@ int wmi_update_ft_ies(struct wil6210_vif *vif, u16 ie_len, const void *ie) ...@@ -2578,6 +2571,7 @@ int wmi_update_ft_ies(struct wil6210_vif *vif, u16 ie_len, const void *ie)
/** /**
* wmi_rxon - turn radio on/off * wmi_rxon - turn radio on/off
* @wil: driver data
* @on: turn on if true, off otherwise * @on: turn on if true, off otherwise
* *
* Only switch radio. Channel should be set separately. * Only switch radio. Channel should be set separately.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment