qcacmn: Fix target_if/cfr documentation

The kernel-doc script identified documentation issues in the target_if/cfr folder, so fix them. Change-Id: I5af96dbc3b6adcd369134422dd2f9e5a6be799e9 CRs-Fixed: 3417466
2023-02-25 12:59:58 -08:00
parent b2e038a217
commit 04d130b0a6
7 changed files with 30 additions and 21 deletions
--- a/target_if/cfr/inc/target_if_cfr.h
+++ b/target_if/cfr/inc/target_if_cfr.h
@@ -1,6 +1,6 @@
 /*
 * Copyright (c) 2019-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
@@ -80,7 +80,7 @@ target_if_cfr_deinit_pdev(struct wlan_objmgr_psoc *psoc,

 /**
 * target_if_cfr_tx_ops_register() - Registers tx ops for cfr module
- * @tx_ops - pointer to tx_ops structure.
+ * @tx_ops: pointer to tx_ops structure.
 */
 void target_if_cfr_tx_ops_register(struct wlan_lmac_if_tx_ops *tx_ops);

@@ -95,7 +95,8 @@ int target_if_cfr_enable_cfr_timer(struct wlan_objmgr_pdev *pdev,
 				   uint32_t cfr_timer);

 /**
- * target_if_cfr_pdev_set_param() - Function to set params for cfr config
+ * target_if_cfr_periodic_peer_cfr_enable() - Function to set params
+ *                                            for cfr config
 * @pdev: pointer to pdev object
 * @param_value: value of param being set
 *
@@ -103,6 +104,7 @@ int target_if_cfr_enable_cfr_timer(struct wlan_objmgr_pdev *pdev,
 */
 int target_if_cfr_periodic_peer_cfr_enable(struct wlan_objmgr_pdev *pdev,
 					   uint32_t param_value);
+
 /**
 * target_if_cfr_start_capture() - Function to start cfr capture for a peer
 * @pdev: pointer to pdev object
@@ -114,6 +116,7 @@ int target_if_cfr_periodic_peer_cfr_enable(struct wlan_objmgr_pdev *pdev,
 int target_if_cfr_start_capture(struct wlan_objmgr_pdev *pdev,
 				struct wlan_objmgr_peer *peer,
 				struct cfr_capture_params *cfr_params);
+
 /**
 * target_if_cfr_stop_capture() - Function to stop cfr capture for a peer
 * @pdev: pointer to pdev object
--- a/target_if/cfr/inc/target_if_cfr_6490.h
+++ b/target_if/cfr/inc/target_if_cfr_6490.h
@@ -1,6 +1,6 @@
 /*
 * Copyright (c) 2020-2021 The Linux Foundation. All rights reserved.
- * Copyright (c) 2021 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
@@ -18,7 +18,7 @@
 */

 /**
- * DOC : target_if_cfr_6490.h
+ * DOC: target_if_cfr_6490.h
 *
 * Target interface of CFR for QCA6490 implementation
 *
--- a/target_if/cfr/inc/target_if_cfr_adrastea.h
+++ b/target_if/cfr/inc/target_if_cfr_adrastea.h
@@ -1,6 +1,6 @@
-
 /*
 * Copyright (c) 2020 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
@@ -18,7 +18,7 @@
 */

 /**
- * DOC : target_if_cfr_adrastea.h
+ * DOC: target_if_cfr_adrastea.h
 *
 * Target interface of CFR for ADRASTEA implementation
 *
--- a/target_if/cfr/src/target_if_cfr_6490.c
+++ b/target_if/cfr/src/target_if_cfr_6490.c
@@ -1,6 +1,6 @@
 /*
 * Copyright (c) 2020 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
@@ -18,7 +18,7 @@
 */

 /**
- * DOC : target_if_cfr_6490.c
+ * DOC: target_if_cfr_6490.c
 *
 * Target interface of CFR for QCA6490 implementation
 *
--- a/target_if/cfr/src/target_if_cfr_adrastea.c
+++ b/target_if/cfr/src/target_if_cfr_adrastea.c
@@ -1,5 +1,6 @@
 /*
 * Copyright (c) 2020 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
@@ -17,7 +18,7 @@
 */

 /**
- * DOC : target_if_cfr_adrastea.c
+ * DOC: target_if_cfr_adrastea.c
 *
 * Target interface of CFR for Adrastea implementation
 *
--- a/target_if/cfr/src/target_if_cfr_dbr.c
+++ b/target_if/cfr/src/target_if_cfr_dbr.c
@@ -1,6 +1,6 @@
 /*
 * Copyright (c) 2019-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
@@ -403,6 +403,7 @@ static void dump_cfr_peer_tx_event(wmi_cfr_peer_tx_event_param *event)
 * prepare_cfr_header_txstatus() - Prepare CFR metadata for TX failures
 * @tx_evt_param: ptr to WMI TX completion event
 * @header: pointer to metadata
+ * @target_type: target type
 *
 * Return: none
 */
@@ -644,9 +645,9 @@ target_if_peer_capture_event(ol_scn_t sc, uint8_t *data, uint32_t datalen)
 #endif

 /**
- * target_if_register_tx_completion_event_handler()
- * register TX completion handler
- * @pdev: pointer to pdev object
+ * target_if_register_tx_completion_event_handler() - register TX completion
+ *                                                    handler
+ * @psoc: pointer to psoc object
 *
 * Return: Status
 */
@@ -678,9 +679,9 @@ target_if_register_tx_completion_event_handler(struct wlan_objmgr_psoc *psoc)
 }

 /**
- * target_if_unregister_tx_completion_event_handler
- * unregister TX completion handler
- * @pdev: pointer to pdev object
+ * target_if_unregister_tx_completion_event_handler() - unregister TX
+ *                                                      completion handler
+ * @psoc: pointer to psoc object
 *
 * Return: Status
 */
--- a/target_if/cfr/src/target_if_cfr_enh.c
+++ b/target_if/cfr/src/target_if_cfr_enh.c
@@ -1,6 +1,6 @@
 /*
 * Copyright (c) 2019-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
@@ -705,7 +705,8 @@ extract_peer_mac_from_freeze_tlv(void *freeze_tlv, uint8_t *peermac)

 /**
 * check_dma_length() - Sanity check DMA header and payload length
- * @dma_hdr: pointer to enhanced DMA header
+ * @lut: lookup table entry to check
+ * @target_type: target type
 *
 * Return: QDF_STATUS
 */
@@ -870,7 +871,7 @@ done:
 /**
 * target_if_cfr_rx_tlv_process() - Process PPDU status TLVs and store info in
 * lookup table
- * @pdev_obj: PDEV object
+ * @pdev: PDEV object
 * @nbuf: ppdu info
 *
 * Return: none
@@ -1557,6 +1558,7 @@ target_if_pdev_aoa_phasedaelta_event_handler(ol_scn_t sc,
 * enh_prepare_cfr_header_txstatus() - Prepare CFR metadata for TX failures
 * @tx_evt_param: ptr to WMI TX completion event
 * @header: pointer to metadata
+ * @target_type: target type
 *
 * Return: none
 */
@@ -1956,10 +1958,12 @@ target_if_unregister_tx_completion_enh_event_handler(struct wlan_objmgr_psoc
 	return status;
 }

-/**
+/*
 * lut_ageout_timer_task() - Timer to flush pending TXRX/DBR events
 *
 * Return: none
+ * NB: kernel-doc script doesn't parse os_timer_func
+
 */
 static os_timer_func(lut_ageout_timer_task)
 {