qcacld-3.0: Fix WMI Documentation

The kernel-doc script identified multiple documentation issues
in components/wmi, so fix them.

Change-Id: Ic5bc41350ef846de91a1001d6fe1d28016e0f982
CRs-Fixed: 3361701

components/wmi/inc/wmi_unified_roam_api.h

@@ -1,6 +1,6 @@
 /*
  * Copyright (c) 2013-2021, The Linux Foundation. All rights reserved.
- * Copyright (c) 2021-2022 Qualcomm Innovation Center, Inc. All rights reserved.
+ * Copyright (c) 2021-2023 Qualcomm Innovation Center, Inc. All rights reserved.
  *
  * Permission to use, copy, modify, and/or distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
@@ -202,7 +202,7 @@ QDF_STATUS wmi_unified_roam_synch_complete_cmd(wmi_unified_t wmi_handle,
 					       uint8_t vdev_id);
 
 /**
- * wmi_unified__roam_invoke_cmd() - send roam invoke command to fw.
+ * wmi_unified_roam_invoke_cmd() - send roam invoke command to fw.
  * @wmi_handle: wmi handle
  * @roaminvoke: roam invoke command
  *
@@ -229,8 +229,8 @@ QDF_STATUS wmi_unified_set_roam_triggers(wmi_unified_t wmi_handle,
 /**
  * wmi_unified_send_disconnect_roam_params() - Send disconnect roam trigger
  * parameters to firmware
- * @wmi_hdl:  wmi handle
+ * @wmi_handle:  wmi handle
- * @params: pointer to wlan_roam_disconnect_params
+ * @req: pointer to wlan_roam_disconnect_params
  *
  * Return: QDF_STATUS
  */
@@ -256,8 +256,8 @@ QDF_STATUS wmi_unified_roam_vendor_handoff_req_cmd(wmi_unified_t wmi_handle,
 
 /**
  * wmi_unified_send_idle_roam_params() - Send idle roam trigger params to fw
- * @wmi_hdl:  wmi handle
+ * @wmi_handle:  wmi handle
- * @params: pointer to wlan_roam_idle_params
+ * @req: pointer to wlan_roam_idle_params
  *
  * Return: QDF_STATUS
  */
@@ -295,7 +295,7 @@ QDF_STATUS wmi_unified_vdev_set_pcl_cmd(wmi_unified_t wmi_handle,
  * @wmi_handle: WMI handle
  * @evt_buf: Event buffer
  * @len: evt buffer data len
- * @synd_ind: roam sync ptr
+ * @sync_ind: roam sync ptr
  *
  * This api will allocate memory for roam sync info, extract
  * the information sent by FW and pass to CM.The memory will be
@@ -440,7 +440,7 @@ wmi_unified_extract_roam_extract_frame_info(wmi_unified_t wmi, void *evt_buf,
  * @wmi_handle: WMI handle
  * @event: Event data received from firmware
  * @data_len: Event data length received from firmware
- * @roam_event: Extract the event and fill in auth_event
+ * @auth_event: Extract the event and fill in auth_event
  *
  * Return: QDF_STATUS
  */
@@ -493,7 +493,6 @@ wmi_unified_roam_mlo_config_cmd(wmi_unified_t wmi_handle,
 /**
  * wmi_unified_roam_scan_offload_mode_cmd() - set roam scan parameters
  * @wmi_handle: wmi handle
- * @scan_cmd_fp: scan related parameters
  * @rso_cfg: roam scan offload parameters
  *
  * This function reads the incoming @rso_cfg and fill in the destination

components/wmi/src/wmi_unified_mc_cp_stats_tlv.c

@@ -1,6 +1,6 @@
 /*
  * Copyright (c) 2013-2021, The Linux Foundation. All rights reserved.
- * Copyright (c) 2022 Qualcomm Innovation Center, Inc. All rights reserved.
+ * Copyright (c) 2022-2023 Qualcomm Innovation Center, Inc. All rights reserved.
  *
  * Permission to use, copy, modify, and/or distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
@@ -74,10 +74,9 @@ extract_per_chain_rssi_stats_tlv(wmi_unified_t wmi_handle, void *evt_buf,
 
 /**
  * extract_peer_adv_stats_tlv() - extract adv peer stats from event
- * @param wmi_handle: wmi handle
+ * @wmi_handle: wmi handle
- * @param evt_buf: pointer to event buffer
+ * @evt_buf: pointer to event buffer
- * @param index: Index into extended peer stats
+ * @peer_adv_stats: Pointer to hold adv peer stats
- * @param peer_adv_stats: Pointer to hold adv peer stats
  *
  * Return: QDF_STATUS_SUCCESS for success or error code
  */
@@ -116,8 +115,8 @@ static QDF_STATUS extract_peer_adv_stats_tlv(wmi_unified_t wmi_handle,
 /**
  * extract_mib_stats_tlv() - extract mib stats from event
  * @wmi_handle: wmi handle
- * @param evt_buf: pointer to event buffer
+ * @evt_buf: pointer to event buffer
- * @param mib_stats: pointer to hold mib stats
+ * @mib_stats: pointer to hold mib stats
  *
  * Return: QDF_STATUS_SUCCESS for success or error code
  */
@@ -518,9 +517,9 @@ extract_peer_stats_info_tlv(wmi_unified_t wmi_handle, void *evt_buf,
 #ifdef WLAN_FEATURE_BIG_DATA_STATS
 /**
  * extract_big_data_stats_tlv() - extract big data from event
- * @param wmi_handle: wmi handle
+ * @wmi_handle: wmi handle
- * @param evt_buf: pointer to event buffer
+ * @evt_buf: pointer to event buffer
- * @param stats_param: Pointer to hold big data stats
+ * @stats: Pointer to hold big data stats
  *
  * Return: QDF_STATUS_SUCCESS for success or error code
  */

components/wmi/src/wmi_unified_roam_tlv.c

@@ -1,6 +1,6 @@
 /*
  * Copyright (c) 2013-2021, The Linux Foundation. All rights reserved.
- * Copyright (c) 2021-2022 Qualcomm Innovation Center, Inc. All rights reserved.
+ * Copyright (c) 2021-2023 Qualcomm Innovation Center, Inc. All rights reserved.
  *
  * Permission to use, copy, modify, and/or distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
@@ -779,7 +779,7 @@ void wmi_ese_attach_tlv(wmi_unified_t wmi_handle)
 /**
  * convert_roam_trigger_reason() - Function to convert unified Roam trigger
  * enum to TLV specific WMI_ROAM_TRIGGER_REASON_ID
- * @reason: Roam trigger reason
+ * @trigger_reason: Roam trigger reason
  *
  * Return: WMI roam trigger reason
  */
@@ -986,7 +986,7 @@ wmi_extract_pdev_hw_mode_trans_ind(
 }
 
 /**
- * extract_roam_sync_event_tlv() - Extract the roam event
+ * extract_roam_event_tlv() - Extract the roam event
  * @wmi_handle: wmi handle
  * @evt_buf: Pointer to the event buffer
  * @len: Data length
@@ -1549,8 +1549,7 @@ static void wmi_fill_min_rssi_params(
 /**
  * send_set_roam_trigger_cmd_tlv() - send set roam triggers to fw
  * @wmi_handle: wmi handle
- * @vdev_id: vdev id
+ * @triggers: roam trigger bitmap to be enabled
- * @trigger_bitmap: roam trigger bitmap to be enabled
  *
  * Send WMI_ROAM_ENABLE_DISABLE_TRIGGER_REASON_CMDID to fw.
  *
@@ -2008,7 +2007,7 @@ wmi_get_converted_tx_status(
  * @wmi_handle: wmi handle
  * @evt_buf:    Pointer to the event buffer
  * @dst:        Pointer to destination structure to fill data
- * @idx:        TLV id
+ * @frame_idx:  TLV id
  * @num_frames: Number of Frame TLVs to be extracted
  */
 static QDF_STATUS
@@ -2087,9 +2086,8 @@ extract_roam_frame_info_tlv(wmi_unified_t wmi_handle, void *evt_buf,
 /**
  * wmi_fill_data_synch_frame_event() - Fill the the roam sync data buffer using
  * synch frame event data
- * @wma: Global WMA Handle
+ * @rso_cfg: Source buffer
  * @roam_sync_ind: Buffer to be filled
- * @param_buf: Source buffer
  *
  * Firmware sends all the required information required for roam
  * synch propagation as TLV's and stored in param_buf. These
@@ -2172,7 +2170,6 @@ wmi_fill_data_synch_frame_event(struct rso_config *rso_cfg,
 /**
  * wmi_fill_data_synch_event() - Fill the the roam sync data buffer
  * using synch event data
- * @wma: Global WMA Handle
  * @roam_sync_ind: Buffer to be filled
  * @param_buf: Source buffer
  *
@@ -2676,9 +2673,9 @@ abort_roam:
  * extract_roam_sync_frame_event_tlv() - Extract the roam sync frame event
  * from the wmi_roam_synch_event_id
  * @wmi_handle: wmi handle
- * @event:    Pointer to the event buffer
+ * @event: Pointer to the event buffer
- * @len:        Data length
+ * @len: event buffer length
- * @roam_synch_frame_ind_ptr: wmi sync frame event ptr
+ * @frame_ptr: wmi sync frame event ptr
  */
 static QDF_STATUS
 extract_roam_sync_frame_event_tlv(wmi_unified_t wmi_handle, void *event,
@@ -3539,6 +3536,7 @@ extract_roam_vendor_control_param_event_tlv(wmi_unified_t wmi_handle,
  * to fw.
  * @wmi_handle: wmi handle
  * @vdev_id: vdev id
+ * @param_id: parameter ID to set
  *
  * Return: QDF STATUS
  */
@@ -3756,7 +3754,7 @@ static bool wmi_is_ft_akm(int akm,
 }
 
 /**
- * wmi_get_rso_cmd_buf_len() - calculate the length needed to allocate buffer
+ * wmi_get_rso_buf_len() - calculate the length needed to allocate buffer
  * for RSO mode command
  * @roam_req: roam request parameters
  */
@@ -4370,8 +4368,7 @@ wmi_set_rso_stop_report_status(wmi_roam_scan_mode_fixed_param *rso_fp)
 /**
  * send_roam_scan_offload_mode_cmd_tlv() - send roam scan mode request to fw
  * @wmi_handle: wmi handle
- * @scan_cmd_fp: start scan command ptr
+ * @rso_req: roam request param
- * @roam_req: roam request param
  *
  * send WMI_ROAM_SCAN_MODE TLV to firmware. It has a piggyback
  * of WMI_ROAM_SCAN_MODE.
@@ -4570,7 +4567,7 @@ static void wmi_roam_mlo_attach_tlv(struct wmi_unified *wmi_handle)
 /**
  * send_roam_scan_offload_ap_profile_cmd_tlv() - set roam ap profile in fw
  * @wmi_handle: wmi handle
- * @ap_profile_p: ap profile
+ * @ap_profile: ap profile
  *
  * Send WMI_ROAM_AP_PROFILE to firmware
  *
@@ -5006,6 +5003,7 @@ error:
 /**
  * send_roam_scan_offload_chan_list_cmd_tlv() - set roam offload channel list
  * @wmi_handle: wmi handle
+ * @rso_ch_info: Roam offload channel information
  *
  * Set roam offload channel list.
  *
@@ -5076,9 +5074,7 @@ error:
 /**
  * send_roam_scan_offload_rssi_change_cmd_tlv() - set roam offload RSSI th
  * @wmi_handle: wmi handle
- * @rssi_change_thresh: RSSI Change threshold
+ * @params: RSSI change parameters
- * @bcn_rssi_weight: beacon RSSI weight
- * @vdev_id: vdev id
  *
  * Send WMI_ROAM_SCAN_RSSI_CHANGE_THRESHOLD parameters to fw.
  *
@@ -5418,8 +5414,8 @@ send_roam_bss_load_config_tlv(wmi_unified_t wmi_handle,
 /**
  * send_disconnect_roam_params_tlv() - send disconnect roam trigger parameters
  * @wmi_handle: wmi handle
- * @disconnect_roam: pointer to wlan_roam_disconnect_params which carries the
+ * @req: pointer to wlan_roam_disconnect_params which carries the
- * disconnect_roam_trigger parameters from CSR
+ * disconnect_roam_trigger parameters
  *
  * This function sends the disconnect roam trigger parameters to fw.
  *