qcacmn: Fix umac/cp_stats documentation

The kernel-doc script identified some documentation errors in the
umac/cp_stats folder, so fix them.

Change-Id: Ib99f6c4f7e0f83531949509d1040cee5590bd345
CRs-Fixed: 3380566

umac/cp_stats/core/src/wlan_cp_stats_cmn_api_i.h

@@ -1,5 +1,6 @@
 /*
  * Copyright (c) 2018 The Linux Foundation. All rights reserved.
+ * Copyright (c) 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
@@ -29,7 +30,7 @@
 
 /**
  * wlan_cp_stats_psoc_cs_init() - common psoc obj initialization
- * @psoc: pointer to psoc object
+ * @psoc_cs: pointer to psoc control path statistics
  *
  * Return: QDF_STATUS - Success or Failure
  */
@@ -37,7 +38,7 @@ QDF_STATUS wlan_cp_stats_psoc_cs_init(struct psoc_cp_stats *psoc_cs);
 
 /**
  * wlan_cp_stats_psoc_cs_deinit() - common psoc obj deinitialization
- * @psoc: pointer to psoc object
+ * @psoc_cs: pointer to psoc control path statistics
  *
  * Return: QDF_STATUS - Success or Failure
  */
@@ -45,7 +46,7 @@ QDF_STATUS wlan_cp_stats_psoc_cs_deinit(struct psoc_cp_stats *psoc_cs);
 
 /**
  * wlan_cp_stats_pdev_cs_init() - common pdev obj initialization
- * @pdev: pointer to pdev object
+ * @pdev_cs: pointer to pdev control path statistics
  *
  * Return: QDF_STATUS - Success or Failure
  */
@@ -53,7 +54,7 @@ QDF_STATUS wlan_cp_stats_pdev_cs_init(struct pdev_cp_stats *pdev_cs);
 
 /**
  * wlan_cp_stats_pdev_cs_deinit() - common pdev obj deinitialization
- * @pdev: pointer to pdev object
+ * @pdev_cs: pointer to pdev control path statistics
  *
  * Return: QDF_STATUS - Success or Failure
  */
@@ -61,7 +62,7 @@ QDF_STATUS wlan_cp_stats_pdev_cs_deinit(struct pdev_cp_stats *pdev_cs);
 
 /**
  * wlan_cp_stats_vdev_cs_init() - common vdev obj initialization
- * @vdev: pointer to vdev object
+ * @vdev_cs: pointer to vdev control path statistics
  *
  * Return: QDF_STATUS - Success or Failure
  */
@@ -69,7 +70,7 @@ QDF_STATUS wlan_cp_stats_vdev_cs_init(struct vdev_cp_stats *vdev_cs);
 
 /**
  * wlan_cp_stats_vdev_cs_deinit() - common vdev obj deinitialization
- * @vdev: pointer to vdev object
+ * @vdev_cs: pointer to vdev control path statistics
  *
  * Return: QDF_STATUS - Success or Failure
  */
@@ -77,7 +78,7 @@ QDF_STATUS wlan_cp_stats_vdev_cs_deinit(struct vdev_cp_stats *vdev_cs);
 
 /**
  * wlan_cp_stats_peer_cs_init() - common peer obj initialization
- * @peer: pointer to peer object
+ * @peer_cs: pointer to peer control path statistics
  *
  * Return: QDF_STATUS - Success or Failure
  */
@@ -85,7 +86,7 @@ QDF_STATUS wlan_cp_stats_peer_cs_init(struct peer_cp_stats *peer_cs);
 
 /**
  * wlan_cp_stats_peer_cs_deinit() - common peer obj deinitialization
- * @peer: pointer to peer object
+ * @peer_cs: pointer to peer control path statistics
  *
  * Return: QDF_STATUS - Success or Failure
  */

umac/cp_stats/core/src/wlan_cp_stats_defs.h

@@ -51,12 +51,14 @@ typedef void (*get_infra_cp_stats_cb)(struct infra_cp_stats_event *ev,
 /**
  * struct psoc_cp_stats - defines cp stats at psoc object
  * @psoc_obj: pointer to psoc
- * @psoc_comp_priv_obj[]: component's private object pointers
+ * @psoc_comp_priv_obj: component's private object pointers
  * @psoc_cp_stats_lock: lock to protect object
  * @cmn_stats: stats common for AP and STA devices
  * @obj_stats: stats specific to AP or STA devices
  * @legacy_stats_cb: callback to update the stats received from FW through
  * asynchronous events.
+ * @get_infra_cp_stats: callback to update infra CP stats
+ * @infra_cp_stats_req_context: context to pass @get_infra_cp_stats
  */
 struct psoc_cp_stats {
 	struct wlan_objmgr_psoc *psoc_obj;
@@ -76,8 +78,8 @@ struct psoc_cp_stats {
  * struct pdev_cp_stats - defines cp stats at pdev object
  * @pdev_obj: pointer to pdev
  * @pdev_stats: pointer to ic/mc specific stats
- * @pdev_comp_priv_obj[]: component's private object pointers
- * @pdev_cp_stats_lock:	lock to protect object
+ * @pdev_comp_priv_obj: component's private object pointers
+ * @pdev_cp_stats_lock: lock to protect object
  */
 struct pdev_cp_stats {
 	struct wlan_objmgr_pdev  *pdev_obj;
@@ -90,7 +92,7 @@ struct pdev_cp_stats {
  * struct vdev_cp_stats - defines cp stats at vdev object
  * @vdev_obj: pointer to vdev
  * @vdev_stats: pointer to ic/mc specific stats
- * @vdev_comp_priv_obj[]: component's private object pointers
+ * @vdev_comp_priv_obj: component's private object pointers
  * @vdev_cp_stats_lock:	lock to protect object
  * @mcast_rx_pnerr_stats_inc: callback function to update rx PN error stats
  */
@@ -108,7 +110,7 @@ struct vdev_cp_stats {
  * struct peer_cp_stats - defines cp stats at peer object
  * @peer_obj: pointer to peer
  * @peer_stats: pointer to ic/mc specific stats
- * @peer_comp_priv_obj[]: component's private object pointers
+ * @peer_comp_priv_obj: component's private object pointers
  * @peer_cp_stats_lock:	lock to protect object
  * @rx_pnerr_stats_inc: callback function to update rx PN error stats
  * @twt_param: Pointer to peer twt session parameters

umac/cp_stats/core/src/wlan_cp_stats_obj_mgr_handler.c

@@ -18,7 +18,7 @@
  */
 
 /**
- * Doc: wlan_cp_stats_om_handler.c
+ * DOC: wlan_cp_stats_om_handler.c
  *
  * This file provide definitions to APIs invoked on receiving common object
  * respective create/destroy event notifications, which further
@@ -491,9 +491,9 @@ wlan_cp_stats_send_telemetry_cp_req(struct wlan_objmgr_pdev *pdev,
 /**
  * wlan_cp_stats_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
+ * @peer_cp_stat_prv: pointer to peer specific stats
+ * @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
@@ -533,7 +533,7 @@ wlan_cp_stats_twt_get_peer_session_param(struct peer_cp_stats *peer_cp_stat_prv,
  * wlan_cp_stats_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

umac/cp_stats/dispatcher/inc/wlan_cp_stats_public_structs.h

@@ -42,8 +42,9 @@
 /**
  * struct twt_infra_cp_stats_event - TWT statistics event structure
  * @vdev_id: virtual interface id
- * @peer_mac_addr: peer mac address corresponding to a TWT session
+ * @peer_macaddr: peer mac address corresponding to a TWT session
  * @dialog_id: Represents dialog_id of the TWT session
+ * @status:
  * @num_sp_cycles: Number of TWT service period elapsed so far
  * @avg_sp_dur_us: Average of actual wake duration observed so far
  * @min_sp_dur_us: Minimum value of wake duration observed across
@@ -96,7 +97,7 @@ struct consecutive_bmiss_stats {
 /**
  * struct bmiss_infra_cp_stats_event -  bmiss statistics event structure
  * @vdev_id: virtual interface id
- * @peer_mac_addr: peer mac address
+ * @peer_macaddr: peer mac address
  * @num_pre_bmiss: number of pre_bmiss
  * @rssi_samples: Rssi samples at pre bmiss
  * @rssi_sample_curr_index: current index of Rssi sampelse at pre bmiss
@@ -182,8 +183,9 @@ struct ctrl_path_pmlo_telemetry_stats_struct {
  * @num_twt_infra_cp_stats: number of twt_infra_cp_stats buffers
  *                          available
  * @twt_infra_cp_stats: pointer to TWT session statistics structures
- * @ctrl_path_pmlo_telemetry_stats_struct - pointer to pmlo
- * telemetry stats struct
+ * @bmiss_infra_cp_stats: pointer to beacon miss statistics
+ * @ctrl_path_pmlo_telemetry_stats_struct: pointer to pmlo telemetry
+ *                                         stats struct
  *
  * This structure is used to store the statistics information
  * extracted from firmware event(wmi_pdev_cp_fwstats_eventid)

umac/cp_stats/dispatcher/inc/wlan_cp_stats_ucfg_api.h

@@ -32,7 +32,7 @@
 #include "../../core/src/wlan_cp_stats_cmn_api_i.h"
 
 /**
- * @ucfg_infra_cp_stats_register_resp_cb() - Register the response callback
+ * ucfg_infra_cp_stats_register_resp_cb() - Register the response callback
  * and cookie in the psoc mc_stats object
  * @psoc: pointer to psoc object
  * @req: pointer to request parameter structure
@@ -45,7 +45,7 @@ ucfg_infra_cp_stats_register_resp_cb(struct wlan_objmgr_psoc *psoc,
 				     struct infra_cp_stats_cmd_info *req);
 
 /**
- * @ucfg_send_infra_cp_stats_request() - send a infra cp stats command
+ * ucfg_send_infra_cp_stats_request() - send a infra cp stats command
  * @vdev: pointer to vdev object
  * @req: pointer to request parameter structure
  *

umac/cp_stats/dispatcher/inc/wlan_cp_stats_utils_api.h

@@ -75,7 +75,7 @@ enum wlan_cp_stats_comp_id {
 QDF_STATUS wlan_cp_stats_init(void);
 
 /**
- * wlan_cp_stats_init(): API to deinit stats component
+ * wlan_cp_stats_deinit(): API to deinit stats component
  *
  * This API is invoked from dispatcher deinit during all component deinit.
  * This API will unregister all required handlers for psoc, pdev,vdev
@@ -130,14 +130,13 @@ QDF_STATUS wlan_cp_stats_enable(struct wlan_objmgr_psoc *psoc);
 QDF_STATUS wlan_cp_stats_disable(struct wlan_objmgr_psoc *psoc);
 
 /**
- * wlan_cp_stats_comp_obj_cfg() - public API to umac for
- * attach/detach
+ * wlan_cp_stats_comp_obj_cfg() - public API to umac for attach/detach
  * component specific stat obj to cp stats obj
  * @obj_type: common object type
  * @cfg_state: config state either to attach of detach
  * @comp_id: umac component id
  * @cmn_obj: pointer to common object
- * @comp_priv_obj: pointer to component specific cp stats object
+ * @data: pointer to component specific cp stats object
  *
  * Return: QDF_STATUS_SUCCESS on success, QDF_STATUS_E_** on error
  */