qcacmn: Fix IPA documentation

The kernel-doc script identified some documentation issues in the top-level ipa folder, so fix them. Change-Id: Ie128c65a495bab06c5207fff768a111de6bab958 CRs-Fixed: 3420684
2023-02-28 20:03:52 -08:00
--- a/ipa/core/inc/wlan_ipa_core.h
+++ b/ipa/core/inc/wlan_ipa_core.h
@@ -373,8 +373,6 @@ QDF_STATUS wlan_ipa_uc_op_metering(struct wlan_ipa_priv *ipa_ctx,
 /**
 * wlan_ipa_wdi_meter_notifier_cb() - SSR wrapper for
 * __wlan_ipa_wdi_meter_notifier_cb
- * @priv: pointer to private data registered with IPA (we register a
- *        pointer to the global IPA context)
 * @evt: the IPA event which triggered the callback
 * @data: data associated with the event
 *
@@ -466,6 +464,7 @@ void wlan_ipa_uc_info(struct wlan_ipa_priv *ipa_ctx);
 /**
 * wlan_ipa_print_fw_wdi_stats() - Print FW IPA WDI stats
 * @ipa_ctx: IPA context
+ * @uc_fw_stat: stats to print
 *
 * Return: None
 */
@@ -602,7 +601,7 @@ void wlan_ipa_reg_rps_enable_cb(struct wlan_ipa_priv *ipa_ctx,
 }

 /**
- * ipa_set_rps_enable(): Enable/disable RPS for all interfaces of specific mode
+ * ipa_set_rps(): Enable/disable RPS for all interfaces of specific mode
 * @ipa_ctx: IPA context
 * @mode: mode of interface for which RPS needs to be enabled
 * @enable: Set true to enable RPS
@@ -776,9 +775,10 @@ static inline void wlan_ipa_mcc_work_handler(void *data)
 * @net_dev: Interface net device
 * @device_mode: Net interface device mode
 * @session_id: session id for the event
- * @type: event enum of type ipa_wlan_event
- * @mac_address: MAC address associated with the event
+ * @ipa_event_type: event enum of type ipa_wlan_event
+ * @mac_addr: MAC address associated with the event
 * @is_2g_iface: true if interface is operating on 2G band, otherwise false
+ * @ipa_obj: IPA context
 *
 * Return: QDF_STATUS
 */
@@ -863,7 +863,7 @@ void wlan_ipa_fw_rejuvenate_send_msg(struct wlan_ipa_priv *ipa_ctx);
 /**
 * wlan_ipa_flush_pending_vdev_events() - flush pending vdev ipa events
 * @ipa_ctx: IPA context
- * vdev_id: vdev id
+ * @vdev_id: vdev id
 *
 * This function is to flush vdev wlan ipa pending events
 *
--- a/ipa/core/inc/wlan_ipa_main.h
+++ b/ipa/core/inc/wlan_ipa_main.h
@@ -1,6 +1,6 @@
 /*
 * Copyright (c) 2018-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
@@ -95,7 +95,7 @@ bool ipa_get_pld_enable(void);
 bool ipa_check_hw_present(void);

 /**
- * wlan_get_pdev_ipa_obj() - private API to get ipa pdev object
+ * ipa_pdev_get_priv_obj() - private API to get ipa pdev object
 * @pdev: pdev object
 *
 * Return: ipa object
@@ -389,7 +389,7 @@ QDF_STATUS ipa_suspend(struct wlan_objmgr_pdev *pdev);
 QDF_STATUS ipa_resume(struct wlan_objmgr_pdev *pdev);

 /**
- * ucfg_ipa_uc_ol_init() - Initialize IPA uC offload
+ * ipa_uc_ol_init() - Initialize IPA uC offload
 * @pdev: pdev obj
 * @osdev: OS dev
 *
@@ -399,7 +399,7 @@ QDF_STATUS ipa_uc_ol_init(struct wlan_objmgr_pdev *pdev,
 			  qdf_device_t osdev);

 /**
- * ucfg_ipa_uc_ol_deinit() - Deinitialize IPA uC offload
+ * ipa_uc_ol_deinit() - Deinitialize IPA uC offload
 * @pdev: pdev obj
 *
 * Return: QDF STATUS
@@ -430,8 +430,8 @@ QDF_STATUS ipa_send_mcc_scc_msg(struct wlan_objmgr_pdev *pdev,
 * @net_dev: Interface net device
 * @device_mode: Net interface device mode
 * @session_id: session id for the event
- * @type: event enum of type ipa_wlan_event
- * @mac_address: MAC address associated with the event
+ * @ipa_event_type: event enum of type ipa_wlan_event
+ * @mac_addr: MAC address associated with the event
 * @is_2g_iface: true if interface is operating on 2G band, otherwise false
 *
 * Return: QDF_STATUS
--- a/ipa/core/inc/wlan_ipa_priv.h
+++ b/ipa/core/inc/wlan_ipa_priv.h
@@ -100,7 +100,7 @@
 #define WLAN_IPA_UC_BW_MONITOR_LEVEL        3

 /**
- * enum - IPA UC operation message
+ * enum wlan_ipa_uc_op_code - IPA UC operation message
 *
 * @WLAN_IPA_UC_OPCODE_TX_SUSPEND: IPA WDI TX pipe suspend
 * @WLAN_IPA_UC_OPCODE_TX_RESUME: IPA WDI TX pipe resume
@@ -135,7 +135,6 @@ enum wlan_ipa_uc_op_code {
 * @WLAN_IPA_UC_STAT_REASON_NONE: Initial value
 * @WLAN_IPA_UC_STAT_REASON_DEBUG: For debug/info
 * @WLAN_IPA_UC_STAT_REASON_BW_CAL: For bandwidth calibration
- * @WLAN_IPA_UC_STAT_REASON_DUMP_INFO: For debug info dump
 */
 enum {
 	WLAN_IPA_UC_STAT_REASON_NONE,
@@ -203,20 +202,25 @@ struct wlan_ipa_tx_hdr {
 	struct llc_snap_hdr llc_snap;
 } qdf_packed;

+#if defined(QCA_WIFI_QCA6290) || defined(QCA_WIFI_QCA6390) || \
+    defined(QCA_WIFI_QCA6490) || defined(QCA_WIFI_QCA6750) || \
+    defined(QCA_WIFI_WCN7850) || defined(QCA_WIFI_QCN9000) || \
+    defined(QCA_WIFI_KIWI) || defined(QCA_WIFI_KIWI_V2)
+/**
+ * struct frag_header - fragment header type registered to IPA hardware
+ * @length:    fragment length
+ * @reserved: Reserved not used
+ */
+struct frag_header {
+	uint8_t reserved[0];
+};
+#elif defined(QCA_WIFI_3_0)
 /**
 * struct frag_header - fragment header type registered to IPA hardware
 * @length:    fragment length
 * @reserved1: Reserved not used
 * @reserved2: Reserved not used
 */
-#if defined(QCA_WIFI_QCA6290) || defined(QCA_WIFI_QCA6390) || \
-    defined(QCA_WIFI_QCA6490) || defined(QCA_WIFI_QCA6750) || \
-    defined(QCA_WIFI_WCN7850) || defined(QCA_WIFI_QCN9000) || \
-    defined(QCA_WIFI_KIWI) || defined(QCA_WIFI_KIWI_V2)
-struct frag_header {
-	uint8_t reserved[0];
-};
-#elif defined(QCA_WIFI_3_0)
 struct frag_header {
 	uint16_t length;
 	uint32_t reserved1;
@@ -231,20 +235,23 @@ struct frag_header {
 } qdf_packed;
 #endif

+#if defined(QCA_WIFI_QCA6290) || defined(QCA_WIFI_QCA6390) || \
+    defined(QCA_WIFI_QCA6490) || defined(QCA_WIFI_QCA6750) || \
+    defined(QCA_WIFI_WCN7850) || defined(QCA_WIFI_QCN9000) || \
+    defined(QCA_WIFI_KIWI) || defined(QCA_WIFI_KIWI_V2)
+/**
+ * struct ipa_header - ipa header type registered to IPA hardware
+ * @reserved: Reserved not used
+ */
+struct ipa_header {
+	uint8_t reserved[0];
+};
+#else
 /**
 * struct ipa_header - ipa header type registered to IPA hardware
 * @vdev_id:  vdev id
 * @reserved: Reserved not used
 */
-
-#if defined(QCA_WIFI_QCA6290) || defined(QCA_WIFI_QCA6390) || \
-    defined(QCA_WIFI_QCA6490) || defined(QCA_WIFI_QCA6750) || \
-    defined(QCA_WIFI_WCN7850) || defined(QCA_WIFI_QCN9000) || \
-    defined(QCA_WIFI_KIWI) || defined(QCA_WIFI_KIWI_V2)
-struct ipa_header {
-	uint8_t reserved[0];
-};
-#else
 struct ipa_header {
 	uint32_t
 		vdev_id:8,	/* vdev_id field is LSB of IPA DESC */
@@ -339,10 +346,12 @@ struct wlan_ipa_priv;
 * @ipa_ctx: IPA private context
 * @cons_client: IPA consumer pipe
 * @prod_client: IPA producer pipe
- * @prod_client: IPA producer pipe
 * @iface_id: IPA interface ID
 * @dev: Net device structure
 * @device_mode: Interface device mode
+ * @mac_addr: MAC address
+ * @conn_count: Connect count
+ * @disconn_count: Disconnect count
 * @session_id: Session ID
 * @interface_lock: Interface lock
 * @ifa_address: Interface address
@@ -374,14 +383,15 @@ struct wlan_ipa_iface_context {
 * struct wlan_ipa_stats - IPA system stats
 * @event: WLAN IPA event record
 * @num_send_msg: Number of sent IPA messages
+ * @num_free_msg: Number of freed IPA messages
 * @num_rm_grant: Number of times IPA RM resource granted
 * @num_rm_release: Number of times IPA RM resource released
 * @num_rm_grant_imm: Number of immediate IPA RM granted
- e @num_cons_perf_req: Number of CONS pipe perf request
+ * @num_cons_perf_req: Number of CONS pipe perf request
 * @num_prod_perf_req: Number of PROD pipe perf request
 * @num_rx_drop: Number of RX packet drops
 * @num_tx_desc_q_cnt: Number of TX descriptor queue count
- * @num_tx_desc_err: Number of TX descriptor error
+ * @num_tx_desc_error: Number of TX descriptor error
 * @num_tx_comp_cnt: Number of TX qdf_event_t count
 * @num_tx_queued: Number of TX queued
 * @num_tx_dequeued: Number of TX dequeued
@@ -443,12 +453,13 @@ struct op_msg_type {

 /**
 * struct ipa_uc_fw_stats - IPA FW stats
+ * @tx_comp_ring_base: TX completion ring base address
 * @tx_comp_ring_size: TX completion ring size
- * @txcomp_ring_dbell_addr: TX comp ring door bell address
- * @txcomp_ring_dbell_ind_val: TX cop ring door bell indication
- * @txcomp_ring_dbell_cached_val: TX cop ring cached value
- * @txpkts_enqueued: TX packets enqueued
- * @txpkts_completed: TX packets completed
+ * @tx_comp_ring_dbell_addr: TX completion ring door bell address
+ * @tx_comp_ring_dbell_ind_val: TX completion ring door bell indication
+ * @tx_comp_ring_dbell_cached_val: TX completion ring cached value
+ * @tx_pkts_enqueued: TX packets enqueued
+ * @tx_pkts_completed: TX packets completed
 * @tx_is_suspend: TX suspend flag
 * @tx_reserved: Reserved for TX stat
 * @rx_ind_ring_base: RX indication ring base address
@@ -496,6 +507,7 @@ struct ipa_uc_fw_stats {
 * struct wlan_ipa_uc_pending_event - WLAN IPA UC pending event
 * @node: Pending event list node
 * @type: WLAN IPA event type
+ * @net_dev: network device
 * @device_mode: Device mode
 * @session_id: Session ID
 * @mac_addr: Mac address
@@ -585,7 +597,7 @@ struct ipa_uc_sharing_stats {
 /**
 * struct ipa_uc_quota_rsp - IPA UC quota response
 * @success: Success or fail flag
- * @reserved[3]: Reserved
+ * @reserved: Reserved
 * @quota_lo: Quota limit low bytes
 * @quota_hi: Quota limit high bytes
 */
--- a/ipa/core/src/wlan_ipa_stats.c
+++ b/ipa/core/src/wlan_ipa_stats.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
@@ -759,8 +759,6 @@ void wlan_ipa_uc_stat(struct wlan_ipa_priv *ipa_ctx)
 /**
 * __wlan_ipa_wdi_meter_notifier_cb() - WLAN to IPA callback handler.
 * IPA calls to get WLAN stats or set quota limit.
- * @priv: pointer to private data registered with IPA (we register a
- *	  pointer to the IPA context)
 * @evt: the IPA event which triggered the callback
 * @data: data associated with the event
 *
@@ -876,8 +874,6 @@ static void wlan_ipa_uc_set_quota(struct wlan_ipa_priv *ipa_ctx,
 /**
 * __wlan_ipa_wdi_meter_notifier_cb() - WLAN to IPA callback handler.
 * IPA calls to get WLAN stats or set quota limit.
- * @priv: pointer to private data registered with IPA (we register a
- *	  pointer to the IPA context)
 * @evt: the IPA event which triggered the callback
 * @data: data associated with the event
 *
@@ -1023,16 +1019,6 @@ QDF_STATUS wlan_ipa_uc_op_metering(struct wlan_ipa_priv *ipa_ctx,
 }
 #endif /* WDI3_STATS_UPDATE */

-/**
- * wlan_ipa_wdi_meter_notifier_cb() - SSR wrapper for
- * __wlan_ipa_wdi_meter_notifier_cb
- * @priv: pointer to private data registered with IPA (we register a
- *	  pointer to the IPA context)
- * @evt: the IPA event which triggered the callback
- * @data: data associated with the event
- *
- * Return: None
- */
 void wlan_ipa_wdi_meter_notifier_cb(qdf_ipa_wdi_meter_evt_type_t evt,
 				    void *data)
 {
--- a/ipa/dispatcher/inc/wlan_ipa_obj_mgmt_api.h
+++ b/ipa/dispatcher/inc/wlan_ipa_obj_mgmt_api.h
@@ -1,6 +1,6 @@
 /*
 * Copyright (c) 2018, 2020-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
@@ -72,7 +72,7 @@ static inline bool wlan_ipa_config_is_enabled(void)

 /**
 * wlan_ipa_get_hdl() - Get ipa hdl set by IPA driver
- * @psoc: void psoc object
+ * @soc: void psoc object
 * @pdev_id: pdev id
 *
 * Return: IPA handle
@@ -80,7 +80,7 @@ static inline bool wlan_ipa_config_is_enabled(void)
 qdf_ipa_wdi_hdl_t wlan_ipa_get_hdl(void *soc, uint8_t pdev_id);

 /**
- * wlan_ipa_is_vlan enabled() - get IPA vlan support enable status
+ * wlan_ipa_is_vlan_enabled() - get IPA vlan support enable status
 *
 * Return: true - ipa vlan support is enabled
 *         false - ipa vlan support is not enabled
--- a/ipa/dispatcher/inc/wlan_ipa_ucfg_api.h
+++ b/ipa/dispatcher/inc/wlan_ipa_ucfg_api.h
@@ -1,6 +1,6 @@
 /*
 * Copyright (c) 2018-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
@@ -88,7 +88,7 @@ bool ucfg_ipa_is_enabled(void);
 bool ucfg_ipa_uc_is_enabled(void);

 /**
- * ucfg_ipa_is_vlan enabled() - get IPA vlan support enable status
+ * ucfg_ipa_is_vlan_enabled() - get IPA vlan support enable status
 *
 * Return: true - ipa vlan support is enabled
 *         false - ipa vlan support is not enabled
@@ -318,6 +318,7 @@ bool ucfg_ipa_is_tx_pending(struct wlan_objmgr_pdev *pdev);

 /**
 * ucfg_ipa_send_mcc_scc_msg() - Send IPA WLAN_SWITCH_TO_MCC/SCC message
+ * @pdev: pdev obj
 * @mcc_mode: 0=MCC/1=SCC
 *
 * Return: QDF STATUS
@@ -331,8 +332,8 @@ QDF_STATUS ucfg_ipa_send_mcc_scc_msg(struct wlan_objmgr_pdev *pdev,
 * @net_dev: Interface net device
 * @device_mode: Net interface device mode
 * @session_id: session id for the event
- * @type: event enum of type ipa_wlan_event
- * @mac_address: MAC address associated with the event
+ * @ipa_event_type: event enum of type ipa_wlan_event
+ * @mac_addr: MAC address associated with the event
 * @is_2g_iface: true if interface is operating on 2G band, otherwise false
 *
 * Return: QDF_STATUS
@@ -432,7 +433,7 @@ void ucfg_ipa_component_config_update(struct wlan_objmgr_psoc *psoc);
 void ucfg_ipa_component_config_free(void);

 /**
- * ucfg_get_ipa_tx_buf_count() - get IPA tx buffer count
+ * ucfg_ipa_get_tx_buf_count() - get IPA tx buffer count
 *
 * Return: IPA tx buffer count
 */