qcacld-3.0: Fix cp_stats documentation

The kernel-doc script identified several documentation issues in
the cp_stats component, so fix them.

Change-Id: I33e42894365048b75a23f1a2070de72a975d456f
CRs-Fixed: 3340094

components/cp_stats/dispatcher/inc/wlan_cp_stats_mc_defs.h

@@ -64,6 +64,7 @@
  * @TYPE_PEER_STATS_INFO_EXT: peer stats info ext was requested
  * @TYPE_CONGESTION_STATS: congestion stats was requested
  * @TYPE_BIG_DATA_STATS: big data stats was requested
+ * @TYPE_MAX: maximum value
  */
 enum stats_req_type {
 	TYPE_CONNECTION_TX_POWER = 0,
@@ -119,11 +120,11 @@ enum tx_rate_info {
 };
 
 /**
- * enum - txrate_gi
- * @txrate_gi_0_8_US: guard interval 0.8 us
- * @txrate_gi_0_4_US: guard interval 0.4 us for legacy
- * @txrate_gi_1_6_US: guard interval 1.6 us
- * @txrate_gi_3_2_US: guard interval 3.2 us
+ * enum txrate_gi - Guard Intervals
+ * @TXRATE_GI_0_8_US: guard interval 0.8 us
+ * @TXRATE_GI_0_4_US: guard interval 0.4 us for legacy
+ * @TXRATE_GI_1_6_US: guard interval 1.6 us
+ * @TXRATE_GI_3_2_US: guard interval 3.2 us
  */
 enum txrate_gi {
 	TXRATE_GI_0_8_US = 0,
@@ -152,7 +153,7 @@ enum txrate_gi {
  * @uc_drop_wake_up_count:      local data uc drop wakeup count
  * @fatal_event_wake_up_count:  fatal event wakeup count
  * @pwr_save_fail_detected:     pwr save fail detected wakeup count
- * @scan_11d                    11d scan wakeup count
+ * @scan_11d:                   11d scan wakeup count
  * @mgmt_assoc: association request management frame
  * @mgmt_disassoc: disassociation management frame
  * @mgmt_assoc_resp: association response management frame
@@ -312,7 +313,7 @@ struct psoc_mc_cp_stats {
 };
 
 /**
- * struct pdev_extd_stats - pdev extd stats
+ * struct pdev_mc_cp_extd_stats - pdev extd stats
  * @pdev_id: pdev id
  * @my_rx_count: What portion of time, as measured by the MAC HW clock was
  *               occupied, by receiving PPDUs addressed to one of the vdevs
@@ -552,7 +553,7 @@ struct dot11_mac_statistics {
 };
 
 /**
- * dot11_qos_counters - qos mac counters
+ * struct dot11_qos_counters - qos mac counters
  * @qos_tx_frag_cnt: transmitted QoS fragments
  * @qos_failed_cnt: failed Qos fragments
  * @qos_retry_cnt: Qos frames transmitted after retransmissions
@@ -586,7 +587,7 @@ struct dot11_qos_counters {
 };
 
 /**
- * dot11_rsna_stats - mib rsn stats
+ * struct dot11_rsna_stats - mib rsn stats
  * @rm_ccmp_replays: received robust management CCMP MPDUs discarded
  *                   by the replay mechanism
  * @tkip_icv_err: TKIP ICV errors encountered
@@ -607,7 +608,7 @@ struct dot11_rsna_stats {
 };
 
 /**
- * dot11_counters_group3 - dot11 group3 stats
+ * struct dot11_counters_group3 - dot11 group3 stats
  * @tx_ampdu_cnt: transmitted AMPDUs
  * @tx_mpdus_in_ampdu_cnt: number of MPDUs in the A-MPDU in transmitted AMPDUs
  * @tx_octets_in_ampdu_cnt: octets in the transmitted A-MPDUs
@@ -627,7 +628,7 @@ struct dot11_counters_group3 {
 };
 
 /**
- * mib_stats_metrics - mib stats counters
+ * struct mib_stats_metrics - mib stats counters
  * @mib_counters: dot11Counters group
  * @mib_mac_statistics: dot11MACStatistics group
  * @mib_qos_counters: dot11QoSCounters group
@@ -736,12 +737,13 @@ struct peer_stats_info_ext_event {
  * @num_chain_rssi_stats: number of chain rssi stats
  * @vdev_chain_rssi: if populated indicates array of chain rssi per vdev
  * @tx_rate: tx rate (kbps)
+ * @rx_rate: rx rate (kbps)
  * @tx_rate_flags: tx rate flags, (enum tx_rate_info)
  * @last_event: The LSB indicates if the event is the last event or not and the
  *              MSB indicates if this feature is supported by FW or not.
  * @num_peer_stats_info_ext: number of peer extended stats info
  * @peer_stats_info_ext: peer extended stats info
- * @pmf_bcn_protect_stats: pmf bcn protect stats
+ * @bcn_protect_stats: pmf bcn protect stats
  */
 struct stats_event {
 	uint32_t num_pdev_stats;

components/cp_stats/dispatcher/inc/wlan_cp_stats_mc_tgt_api.h

@@ -48,7 +48,7 @@ uint8_t target_if_mc_cp_get_mac_id(struct vdev_mlme_obj *vdev_mlme);
 /**
  * tgt_mc_cp_stats_process_stats_event(): API to process stats event
  * @psoc: pointer to psoc object
- * @event: event parameters
+ * @ev: event parameters
  *
  * Return: QDF_STATUS_SUCCESS on Success, other QDF_STATUS error codes on
  * failure
@@ -102,6 +102,7 @@ QDF_STATUS tgt_send_cp_big_data_stats_req(struct wlan_objmgr_psoc *psoc,
 /**
  * tgt_send_mc_cp_stats_req(): API to send stats request to lmac
  * @psoc: pointer to psoc object
+ * @type: specific type of stats requested
  * @req: pointer to stats request
  *
  * Return: status of operation

components/cp_stats/dispatcher/inc/wlan_cp_stats_mc_ucfg_api.h

@@ -47,7 +47,7 @@
  * If dialog_id is TWT_GET_ALL_PEER_PARAMS_DIALOG_ID retrieves twt session
  * parameters of all peers with valid twt session
  * @psoc_obj: psoc object
- * @params: array pointer to store peer twt session parameters, should contain
+ * @param: array pointer to store peer twt session parameters, should contain
  * mac_addr and dialog id of a peer for which twt session stats to be retrieved
  *
  * Return: total number of valid twt session
@@ -99,10 +99,11 @@ QDF_STATUS ucfg_mc_cp_stats_inc_wake_lock_stats_by_protocol(
 					enum qdf_proto_subtype protocol);
 
 /**
- * ucfg_mc_cp_stats_inc_wake_lock_stats_by_protocol() : API to increment wake
- * lock stats given destnation of packet that was received.
+ * ucfg_mc_cp_stats_inc_wake_lock_stats_by_dst_addr() : API to increment wake
+ * lock stats given destination of packet that was received.
  * @psoc: pointer to psoc object
- * @dest_mac: destinamtion mac address of packet that was received
+ * @vdev_id: vdev_id for which the packet was received
+ * @dest_mac: destination mac address of packet that was received
  *
  * Return : status of operation
  */
@@ -137,16 +138,17 @@ QDF_STATUS ucfg_mc_cp_stats_write_wow_stats(
 				char *buffer, uint16_t max_len, int *ret);
 
 /**
- * ucfg_mc_cp_stats_send_tx_power_request() - API to send tx_power request to
- * lmac
+ * ucfg_mc_cp_stats_send_stats_request() - API to send stats request to lmac
  * @vdev: pointer to vdev object
  * @type: request type
+ * @info: specific request information
  *
  * Return: status of operation
  */
 QDF_STATUS ucfg_mc_cp_stats_send_stats_request(struct wlan_objmgr_vdev *vdev,
 					       enum stats_req_type type,
 					       struct request_info *info);
+
 /**
  * wlan_cfg80211_mc_twt_clear_infra_cp_stats() - send request to reset
  * control path statistics
@@ -313,6 +315,7 @@ QDF_STATUS ucfg_send_big_data_stats_request(struct wlan_objmgr_vdev *vdev,
 /**
  * ucfg_mc_cp_set_big_data_fw_support() - set big data fw support
  * @psoc: PSOC object
+ * @enable: Set true if firmware supports big data, otherwise false
  *
  * API to set fw supports big data feature or not
  *
@@ -325,6 +328,7 @@ ucfg_mc_cp_set_big_data_fw_support(struct wlan_objmgr_psoc *psoc,
 /**
  * ucfg_mc_cp_get_big_data_fw_support() - get big data fw support
  * @psoc: PSOC object
+ * @enable: Set true if firmware supports big data, otherwise false
  *
  * API to get fw supports big data feature or not
  *

components/cp_stats/dispatcher/src/wlan_cp_stats_mc_ucfg_api.c

@@ -149,8 +149,8 @@ ucfg_twt_get_single_peer_session_params(struct wlan_objmgr_psoc *psoc_obj,
  * ucfg_twt_get_peer_session_param() - Obtains twt session parameters of
  * a peer if twt session is valid
  * @mc_cp_stats: pointer to peer specific stats
- * @param: Pointer to copy twt session parameters
- * @num_twt_sessions Pointer holding total number of valid twt sessions
+ * @params: Pointer to copy twt session parameters
+ * @num_twt_session: Pointer holding total number of valid twt sessions
  *
  * Return: QDF_STATUS success if valid twt session parameters are obtained
  * else other qdf error values
@@ -188,7 +188,7 @@ ucfg_twt_get_peer_session_param(struct peer_mc_cp_stats *mc_cp_stats,
  * ucfg_twt_get_all_peer_session_params()- Retrieves twt session parameters
  * of all peers with valid twt session
  * @psoc_obj: psoc object
- * @vdvev_id: vdev_id
+ * @vdev_id: vdev_id
  * @params: array of pointer to store peer twt session parameters
  *
  * Return: total number of valid twt sessions