Browse Source

qcacmn: Fix umac/dcs documentation

The kernel-doc script identified some kernel-doc issues in the
umac/dcs folder, so fix them.

Change-Id: I5cae5285e87954de22b52a995e952981f94c5662
CRs-Fixed: 3383807
Jeff Johnson 2 years ago
parent
commit
b4c593eaee

+ 4 - 4
umac/dcs/core/src/wlan_dcs.c

@@ -1,6 +1,6 @@
 /*
  * Copyright (c) 2020-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
@@ -1024,7 +1024,7 @@ wlan_dcs_get_available_chan_for_bw(struct wlan_objmgr_pdev *pdev,
 		if (!WLAN_REG_IS_SAME_BAND_FREQS(freq, awgn_info->center_freq))
 			continue;
 
-		/**
+		/*
 		 * DFS channel may need CAC during restart, which costs time
 		 * and may cause failure.
 		 */
@@ -1096,7 +1096,7 @@ wlan_dcs_get_available_chan_for_bw(struct wlan_objmgr_pdev *pdev,
 }
 
 /**
- * wlan_dcs_sap_get_available_chan() - get available channel for sap
+ * wlan_dcs_sap_select_chan() - get available channel for sap
  * @vdev: vdev ptr
  * @awgn_info: pointer to awgn info
  * @tgt_freq: frequency of the selected channel
@@ -1329,7 +1329,7 @@ static void wlan_dcs_process_awgn_sap(struct wlan_objmgr_pdev *pdev,
 }
 
 /**
- * wlan_dcs_awgnim_process() - process awgn IM
+ * wlan_dcs_awgn_process() - process awgn IM
  * @psoc: psoc ptr
  * @pdev_id: pdev id
  * @awgn_info: pointer to awgn info

+ 4 - 4
umac/dcs/core/src/wlan_dcs.h

@@ -1,6 +1,6 @@
 /*
  * Copyright (c) 2020-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
@@ -59,7 +59,7 @@ enum wlan_dcs_debug_level {
  * @dcs_ch_util_im_stats: chan utilization statistics
  * @im_intfr_cnt: number of times the interference is
  *                detected within detection window
- * @im_sample_cnt: sample counter
+ * @im_samp_cnt: sample counter
  */
 struct pdev_dcs_im_stats {
 	struct wlan_host_dcs_im_tgt_stats prev_dcs_im_stats;
@@ -215,7 +215,7 @@ struct dcs_pdev_priv_obj {
 };
 
 /**
- * wlan_dcs_chan_seg - Different segments in the channel band.
+ * enum wlan_dcs_chan_seg - Different segments in the channel band.
  * @WLAN_DCS_SEG_INVALID: invalid segment
  * @WLAN_DCS_SEG_PRI20: primary 20MHz
  * @WLAN_DCS_SEG_SEC20: secondary 20MHz
@@ -370,7 +370,7 @@ void wlan_dcs_set_algorithm_process(struct wlan_objmgr_psoc *psoc,
 				    uint32_t pdev_id,
 				    bool dcs_algorithm_process);
 
-/*
+/**
  * wlan_dcs_pdev_obj_lock() - private API to acquire spinlock at pdev
  * @dcs_pdev: pointer to dcs pdev object
  *

+ 3 - 3
umac/dcs/dispatcher/inc/wlan_dcs_public_structs.h

@@ -1,6 +1,6 @@
 /*
  * Copyright (c) 2020-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
@@ -41,7 +41,7 @@ enum wlan_host_dcs_type {
 /**
  * struct wlan_host_dcs_interference_param - dcs interference parameters
  * @interference_type: type of DCS interference
- * @uint32_t pdev_id: pdev id
+ * @pdev_id: pdev id
  */
 struct wlan_host_dcs_interference_param {
 	uint32_t interference_type;
@@ -104,7 +104,7 @@ struct wlan_host_dcs_im_tgt_stats {
  * struct wlan_host_dcs_ch_util_stats - DCS IM chan utilization stats
  * @rx_cu: rx channel utilization
  * @tx_cu: tx channel utilization
- * @rx_obss_cu: obss rx channel utilization
+ * @obss_rx_cu: obss rx channel utilization
  * @total_cu: total channel utilization
  * @chan_nf: Channel noise floor (units are in dBm)
  */