qcacmn: Fix umac/scan documentation

The kernel-doc script identified some documentation errors in the umac/scan folder, so fix them. In addition, Change-Id I8340c6c654cf03f63aee9ed622e3db38056d714f ("qcacmn: Add API to access scan entry partner info") made an incorrect copyright change, so fix that. Change-Id: I629f5961ab0a284c70a47fc7d71fe81d5572ae25 CRs-Fixed: 3380633
2023-01-15 12:36:14 -08:00
--- a/umac/scan/core/src/wlan_scan_cache_db.h
+++ b/umac/scan/core/src/wlan_scan_cache_db.h
@@ -1,6 +1,6 @@
 /*
 * Copyright (c) 2017-2020 The Linux Foundation. All rights reserved.
- * Copyright (c) 2021-2023 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
@@ -17,7 +17,7 @@
 * PERFORMANCE OF THIS SOFTWARE.
 */

-/*
+/**
 * DOC: contains scan cache entry api
 */

@@ -39,6 +39,7 @@
 /**
 * struct scan_dbs - scan cache data base definition
 * @num_entries: number of scan entries
+ * @scan_db_lock: lock for @scan_hash_tbl
 * @scan_hash_tbl: link list of bssid hashed scan cache entries for a pdev
 */
 struct scan_dbs {
@@ -172,7 +173,7 @@ scm_iterate_scan_db(struct wlan_objmgr_pdev *pdev,
 /**
 * scm_scan_register_bcn_cb() - API to register api to indicate bcn/probe
 * as soon as they are received
- * @pdev: psoc
+ * @psoc: psoc
 * @cb: callback to be registered
 * @type: Type of callback to be registered
 *
@@ -210,7 +211,7 @@ struct channel_list_db *scm_get_rnr_channel_db(struct wlan_objmgr_psoc *psoc);
 /**
 * scm_get_chan_meta() - API to return channel meta
 * @psoc: psoc
- * @freq: channel frequency
+ * @chan_freq: channel frequency
 *
 * Return: channel meta information
 */
@@ -255,7 +256,7 @@ void scm_update_rnr_from_scan_cache(struct wlan_objmgr_pdev *pdev);
 *                             during pno scan request
 * @vdev: vdev
 * @short_ssid: short ssid
- * @pno_chan_list: channel list
+ * @chan_list: channel list
 *
 * Remove FLAG_SCAN_ONLY_IF_RNR_FOUND flag in channel if ssid is different for
 * colocated AP, in pno scan request
@@ -291,6 +292,7 @@ scm_filter_rnr_flag_pno(struct wlan_objmgr_vdev *vdev,
 * scm_scan_update_mlme_by_bssinfo() - updates scan entry with mlme data
 * @pdev: pdev object
 * @bss_info: BSS information
+ * @mlme: scan entry MLME info
 *
 * This function updates scan db with scan_entry->mlme_info
 *
--- a/umac/scan/core/src/wlan_scan_cache_db_i.h
+++ b/umac/scan/core/src/wlan_scan_cache_db_i.h
@@ -1,5 +1,6 @@
 /*
 * Copyright (c) 2017, 2019-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
@@ -16,7 +17,7 @@
 * PERFORMANCE OF THIS SOFTWARE.
 */

-/*
+/**
 * DOC: contains scan internal api
 */

@@ -25,7 +26,7 @@

 /**
 * scm_filter_match() - private API to check if entry is match to filter
- * psoc: psoc ptr;
+ * @psoc: psoc ptr;
 * @db_entry: db entry
 * @filter: filter
 * @security: negotiated security if match is found
@@ -41,6 +42,7 @@ bool scm_filter_match(struct wlan_objmgr_psoc *psoc,
 * wlan_pdevid_get_scan_db() - private API to get scan db from pdev id
 * @psoc: psoc object
 * @pdev_id: Pdev_id
+ *
 * Return: scan db for the pdev id
 */
 static inline struct scan_dbs *
--- a/umac/scan/core/src/wlan_scan_main.h
+++ b/umac/scan/core/src/wlan_scan_main.h
@@ -178,7 +178,8 @@ struct cb_handler {

 /**
 * struct pdev_scan_ev_handler - pdev scan event handlers
- * @cb_handler: array of registered scan handlers
+ * @handler_cnt: number of valid entries in @cb_handler
+ * @cb_handlers: array of registered scan handlers
 */
 struct pdev_scan_ev_handler {
 	uint32_t handler_cnt;
@@ -187,7 +188,7 @@ struct pdev_scan_ev_handler {

 /**
 * struct global_scan_ev_handlers - per pdev registered scan event handlers
- * @pdev_scan_ev_handler: per pdev registered scan event handlers
+ * @pdev_ev_handlers: per pdev registered scan event handlers
 */
 struct global_scan_ev_handlers {
 	struct pdev_scan_ev_handler pdev_ev_handlers[WLAN_UMAC_MAX_PDEVS];
@@ -213,6 +214,7 @@ struct scan_requester_info {
 * @custom_chan_list: scan only these channels
 * @conf_bssid: configured bssid of the hidden AP
 * @conf_ssid: configured desired ssid
+ * @chan_scan_info: channel list scan info
 */
 struct pdev_scan_info {
 	bool wide_band_scan;
@@ -245,10 +247,10 @@ struct scan_vdev_obj {
 * @top_k_num_of_channels: def top K number of channels are used for tanimoto
 * distance calculation.
 * @stationary_thresh: def threshold val to determine that STA is stationary.
- * @pnoscan_adaptive_dwell_mode: def adaptive dwelltime mode for pno scan
+ * @adaptive_dwell_mode: def adaptive dwelltime mode for pno scan
 * @channel_prediction_full_scan: def periodic timer upon which full scan needs
 * to be triggered.
- * @dfs_chnl_scan_enable: Enable dfs channel PNO scan
+ * @dfs_chnl_scan_enabled: Enable dfs channel PNO scan
 * @scan_support_enabled: PNO scan support enabled/disabled
 * @scan_timer_repeat_value: PNO scan timer repeat value
 * @slow_scan_multiplier: PNO slow scan timer multiplier
@@ -331,16 +333,22 @@ struct extscan_def_config {
 * @burst_duration: default burst duration
 * @max_scan_time: default max scan time
 * @num_probes: default maximum number of probes to sent
- * @cache_aging_time: default scan cache aging time
- * @select_5gh_margin: Prefer connecting to 5G AP even if
- *      its RSSI is lower by select_5gh_margin dbm than 2.4G AP.
+ * @scan_cache_aging_time: default scan cache aging time
+ * @select_5ghz_margin: Prefer connecting to 5 GHz AP even if
+ *      its RSSI is lower by @select_5ghz_margin dbm than 2.4 GHz AP.
 *      applicable if prefer_5ghz is set.
 * @enable_mac_spoofing: enable mac address spoof in scan
+ * @usr_cfg_probe_rpt_time:
+ * @usr_cfg_num_probes:
 * @max_bss_per_pdev: maximum number of bss entries to be maintained per pdev
 * @max_active_scans_allowed: maximum number of active parallel scan allowed
 *                            per psoc
- * @scan_mode_6g: scan mode in 6Ghz
- * @duty_cycle_6ghz: Enable optimization on 6g channels for every full scan
+ * @sta_scan_burst_duration:
+ * @p2p_scan_burst_duration:
+ * @go_scan_burst_duration:
+ * @ap_scan_burst_duration:
+ * @scan_mode_6g: scan mode in 6 GHz
+ * @duty_cycle_6ghz: Enable optimization on 6 GHz channels for every full scan
 *                   except the duty cycle. So that every nth scan(depending on
 *                   duty cycle) is a full scan and rest are all optimized scans
 * @enable_connected_scan: enable scans after connection
@@ -349,7 +357,7 @@ struct extscan_def_config {
 * @adaptive_dwell_time_mode_nc: adaptive dwell mode without connection
 * @honour_nl_scan_policy_flags: honour nl80211 scan policy flags
 * @extscan_adaptive_dwell_mode: Adaptive dwell mode during ext scan
- * @skip_6g_and_indoor_freq: skip 6Ghz and 5Gh indoor freq channel for
+ * @skip_6g_and_indoor_freq: skip 6 GHz and 5 GHz indoor freq channel for
 * STA scan if hw is non-DBS and SAP is present
 * @last_scan_ageout_time: use last full scan results for provided time in ms
 * @scan_f_passive: passively scan all channels including active channels
@@ -394,7 +402,6 @@ struct extscan_def_config {
 * @scan_ev_resumed: notify scan resumed event
 * @scan_events: variable to read and set scan_ev_* flags in one shot
 *               can be used to dump all scan_ev_* flags for debug
- * @roam_params: roam related params
 */
 struct scan_default_params {
 	uint32_t active_dwell;
@@ -533,11 +540,14 @@ struct scan_cb {
 * @scan_start_request_buff: buffer used to pass
 *      scan config to event handlers
 * @rnr_channel_db: RNR channel list database
+ * @scan_listener_cb_exe_dur:
+ * @scm_scan_event_duration:
+ * @scm_scan_to_post_scan_duration:
 * @duty_cycle_cnt_6ghz: Scan count to track the full scans and decide whether
 *                        to optimizate 6g channels in the scan request based
 *                        on the ini scan_mode_6ghz_duty_cycle.
- * @allow_bss_with_incomplete_ie: Continue scan entry even if any corrupted IES are
- *			    present.
+ * @allow_bss_with_incomplete_ie: Continue scan entry even if any corrupted
+ *                                IEs are present.
 */
 struct wlan_scan_obj {
 	uint32_t scan_disabled;
@@ -715,7 +725,7 @@ wlan_psoc_get_scan_obj_fl(struct wlan_objmgr_psoc *psoc,

 /**
 * wlan_pdev_get_scan_obj() - private API to get scan object from pdev
- * @psoc: pdev object
+ * @pdev: pdev object
 *
 * Return: scan object
 */
@@ -731,7 +741,7 @@ wlan_pdev_get_scan_obj(struct wlan_objmgr_pdev *pdev)

 /**
 * wlan_vdev_get_scan_obj() - private API to get scan object from vdev
- * @psoc: vdev object
+ * @vdev: vdev object
 *
 * Return: scan object
 */
@@ -782,7 +792,7 @@ wlan_scan_vdev_get_pdev_id(struct wlan_objmgr_vdev *vdev)
 /**
 * wlan_pdev_get_pdev_scan_ev_handlers() - private API to get
 * pdev scan event handlers
- * @vdev: pdev object
+ * @pdev: pdev object
 *
 * Return: pdev_scan_ev_handler object
 */
@@ -923,7 +933,7 @@ QDF_STATUS wlan_scan_psoc_created_notification(struct wlan_objmgr_psoc *psoc,
 	void *arg_list);

 /**
- * wlan_scan_psoc_deleted_notification() - scan psoc delete handler
+ * wlan_scan_psoc_destroyed_notification() - scan psoc delete handler
 * @psoc: psoc object
 * @arg_list: Argument list
 *
--- a/umac/scan/core/src/wlan_scan_manager_6ghz.c
+++ b/umac/scan/core/src/wlan_scan_manager_6ghz.c
@@ -17,8 +17,8 @@
 * PERFORMANCE OF THIS SOFTWARE.
 */

-/*
- * DOC: contains 6ghz scan manager functionality
+/**
+ * DOC: contains 6 GHz scan manager functionality
 */

 #include "wlan_scan_main.h"
@@ -29,7 +29,7 @@
 /* Beacon/probe weightage multiplier */
 #define BCN_PROBE_WEIGHTAGE 5

-/* maximum number of 6ghz hints can be sent per scan request */
+/* maximum number of 6 GHz hints can be sent per scan request */
 #define MAX_HINTS_PER_SCAN_REQ 15

 /* Saved profile weightage multiplier */
@@ -39,13 +39,13 @@
 #ifdef FEATURE_6G_SCAN_CHAN_SORT_ALGO

 /**
- * scm_sort_6ghz_channel_list() - Sort the 6ghz channels based on weightage
+ * scm_sort_6ghz_channel_list() - Sort the 6 GHz channels based on weightage
 * @vdev: vdev on which scan request is issued
 * @chan_list: channel info of the scan request
 *
 * Calculate weightage of each channel based on beacon weightage and saved
 * profile weightage. Sort the channels based on this weight in descending order
- * to scan the most preferred channels first compared other 6ghz channels.
+ * to scan the most preferred channels first compared other 6 GHz channels.
 *
 * Return: None
 */
@@ -71,9 +71,9 @@ scm_sort_6ghz_channel_list(struct wlan_objmgr_vdev *vdev,
 			temp_list[j++] = chan_list->chan[i];

 	tmp_list_count = j;
-	scm_debug("Total 6ghz channels %d", tmp_list_count);
+	scm_debug("Total 6 GHz channels %d", tmp_list_count);

-	/* No Need to sort if the 6ghz channels are less than or one */
+	/* No Need to sort if the 6 GHz channels are less than or one */
 	if (tmp_list_count <= 1)
 		return;

@@ -201,7 +201,7 @@ static void scm_update_rnr_info(struct wlan_objmgr_psoc *psoc,

 /**
 * scm_add_rnr_info() - Add the cached RNR info to scan request
- * @vdev: vdev on which scan request is issued
+ * @pdev: pdev on which scan request is issued
 * @req: Scan start request
 *
 * Fetch the cached RNR info from scan db and update it to the scan request to
@@ -257,22 +257,6 @@ scm_is_scan_type_exempted_from_optimization(struct scan_start_request *req)
 	return (req->scan_req.scan_type == SCAN_TYPE_RRM);
 }

-/**
- * scm_add_all_valid_6g_channels() - Add all valid 6g channels to scan request
- * @vdev: vdev on which scan request is issued
- * @req: Scan start request
- * @num_scan_ch: Total number of scan channels
- * @is_colocated_6ghz_scan_enabled: colocated 6ghz scan flag enabled in scan req
- *
- * If colocated 6ghz scan flag present in host scan request or at least one 6G
- * channel is present in the host scan request, then this API
- * fills all remaining (other than channel(s) resent in host scan req) valid
- * 6 GHz channel(s) to scan requests channel list and set the flag
- * FLAG_SCAN_ONLY_IF_RNR_FOUND for each of those added channels.
- * By this driver allows Firmware to scan 6G channels based on RNR IEs only.
- *
- * Return: None
- */
 void scm_add_all_valid_6g_channels(struct wlan_objmgr_pdev *pdev,
 				   struct chan_list *chan_list,
 				   uint8_t *num_scan_ch,
--- a/umac/scan/core/src/wlan_scan_manager_6ghz.h
+++ b/umac/scan/core/src/wlan_scan_manager_6ghz.h
@@ -1,6 +1,6 @@
 /*
 * Copyright (c) 2017-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
@@ -17,8 +17,8 @@
 * PERFORMANCE OF THIS SOFTWARE.
 */

-/*
- * DOC: contains scan manager functionality
+/**
+ * DOC: contains scan manager 6 GHz-specific functionality
 */

 #ifndef _WLAN_SCAN_MANAGER_6GHZ_API_H_
@@ -48,14 +48,15 @@
 #define SET_RNR_FLAG_TO_ALL_6G_CHANNELS 0x3

 /**
- * scm_add_channel_flags() - Update 6ghz channel flags in active/pno scan req
+ * scm_add_channel_flags() - Update 6 GHz channel flags in active/pno scan req
 * @vdev: vdev
- * @pno_chan_list: channel list
+ * @chan_list: channel list
 * @num_chan: number channels
- * @is_colocated_6ghz_scan_enabled: Colacated 6ghz flag
+ * @is_colocated_6ghz_scan_enabled: Colocated 6 GHz flag
 * @is_pno_scan: is pno scan
 *
- * Add channel flags for 6ghz channels from active/pno scan request based on ini
+ * Add channel flags for 6 GHz channels from active/pno scan request
+ * based on ini
 *
 * Return: None
 */
@@ -67,12 +68,12 @@ scm_add_channel_flags(struct wlan_objmgr_vdev *vdev,
 		      bool is_pno_scan);

 /**
- * scm_update_6ghz_channel_list() - Update 6ghz channel list in the scan req
+ * scm_update_6ghz_channel_list() - Update 6 GHz channel list in the scan req
 * @req: scan start request
 * @scan_obj: scan component object
 *
- * Filter out the unsupported 6ghz channels from scan request and add supported
- * 6ghz channels based on the ini.
+ * Filter out the unsupported 6 GHz channels from scan request and add supported
+ * 6 GHz channels based on the ini.
 *
 * Return: None
 */
@@ -84,7 +85,7 @@ scm_update_6ghz_channel_list(struct scan_start_request *req,
 * scm_is_6ghz_scan_optimization_supported() - Check firmware capability
 * @psoc: psoc
 *
- * Check if firmware supports 6ghz scan optimization from fw_ext_caps of psoc.
+ * Check if firmware supports 6 GHz scan optimization from fw_ext_caps of psoc.
 *
 * Return: None
 */
@@ -92,24 +93,28 @@ bool
 scm_is_6ghz_scan_optimization_supported(struct wlan_objmgr_psoc *psoc);

 /**
- * scm_add_all_valid_6g_channels() - Add all valid 6g channels to scan request
- * @vdev: vdev on which scan request is issued
- * @req: Scan start request
+ * scm_add_all_valid_6g_channels() - Add all valid 6 GHz channels to scan
+ *                                   request
+ * @pdev: pdev on which scan request is issued
+ * @chan_list: Scan channel list
 * @num_scan_ch: Total number of scan channels
+ * @is_colocated_6ghz_scan_enabled: colocated 6 GHz scan flag enabled in
+ *                                  scan request
 *
- * If colocated 6ghz scan flag present in host scan request or at least one 6G
- * channel is present in the host scan request, then this API
- * fills all remaining (other than channel(s) resent in host scan req) valid
- * 6 GHz channel(s) to scan requests channel list and set the flag
- * FLAG_SCAN_ONLY_IF_RNR_FOUND for each of those added channels.
- * By this driver allows Firmware to scan 6G channels based on RNR IEs only.
+ * If @is_colocated_6ghz_scan_enabled is true or if at least one 6 GHz
+ * channel is present in the host scan request, then this API fills
+ * all remaining (other than channel(s) present in host scan req)
+ * valid 6 GHz channel(s) to scan requests channel list and set the
+ * flag FLAG_SCAN_ONLY_IF_RNR_FOUND for each of those added channels.
+ * By this driver allows Firmware to scan 6 GHz channels based on RNR
+ * IEs only.
 *
 * Return: None
 */
 void scm_add_all_valid_6g_channels(struct wlan_objmgr_pdev *pdev,
 				   struct chan_list *chan_list,
 				   uint8_t *num_scan_ch,
-				   bool is_colocated_6ghz);
+				   bool is_colocated_6ghz_scan_enabled);

 #else
 static inline void
@@ -133,10 +138,11 @@ scm_is_6ghz_scan_optimization_supported(struct wlan_objmgr_psoc *psoc)
 	return false;
 }

-static inline void scm_add_all_valid_6g_channels(struct wlan_objmgr_pdev *pdev,
-						 struct chan_list *chan_list,
-						 uint8_t *num_scan_ch,
-						 bool is_colocated_6ghz)
+static inline
+void scm_add_all_valid_6g_channels(struct wlan_objmgr_pdev *pdev,
+				   struct chan_list *chan_list,
+				   uint8_t *num_scan_ch,
+				   bool is_colocated_6ghz)
 {
 }
 #endif
--- a/umac/scan/dispatcher/inc/cfg_scan.h
+++ b/umac/scan/dispatcher/inc/cfg_scan.h
@@ -44,6 +44,7 @@
 *  channels and doesn't set the flag FLAG_SCAN_ONLY_IF_RNR_FOUND for any 6g
 *  (PSC/non-PSC) channels. Rest of the scans will be done only on RNR (PSC and
 *  non-PSC channels).
+ * @SCAN_MODE_6G_MAX: Max enumeration
 */
 enum scan_mode_6ghz {
 	SCAN_MODE_6G_NO_CHANNEL,
--- a/umac/scan/dispatcher/inc/wlan_extscan_api.h
+++ b/umac/scan/dispatcher/inc/wlan_extscan_api.h
@@ -1,5 +1,6 @@
 /*
 * Copyright (c) 2012-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
@@ -84,8 +85,6 @@ wlan_extscan_global_init(struct wlan_objmgr_psoc *psoc,

 /**
 * wlan_extscan_global_deinit() - Deinitialize extscan
- * @psoc: pointer to psoc object
- * @scan_obj: pointer to scan object
 *
 * Return: QDF_STATUS
 */
--- a/umac/scan/dispatcher/inc/wlan_scan_public_structs.h
+++ b/umac/scan/dispatcher/inc/wlan_scan_public_structs.h
@@ -68,7 +68,7 @@ typedef uint32_t wlan_scan_id;

 #define TBTT_INFO_COUNT 16

-/**
+/*
 * IE Field nomenclature
 * @MBSSID_INDICATOR_POS: Position of MaxBSSID indicator inside MBSSID tag
 * @MIN_IE_LEN: 2bytes, which includes Tag Number and Tag length field
@@ -284,7 +284,7 @@ struct ie_list {
 #endif
 	uint8_t *qcn;

-/**
+/*
 * For any new IEs in this structure, add handling in
 * util_scan_copy_beacon_data API.
 */
@@ -447,7 +447,7 @@ struct rnr_bss_info {

 /**
 * struct neighbor_ap_info_field - Neighbor information field
- * @tbtt_info_header: TBTT information header
+ * @tbtt_header: TBTT information header
 * @operting_class: operating class
 * @channel_number: channel number
 */
@@ -473,6 +473,7 @@ struct neighbor_ap_info_field {
 * @TBTT_NEIGHBOR_AP_BSSID_S_SSID_BSS_PARAM_20MHZ_PSD: neighbor AP, bssid,
 * short ssid, bss params and 20MHz PSD
 * bssid, short ssid, bss params, 20MHz PSD and MLD param
+ * @TBTT_NEIGHBOR_AP_BSSID_S_SSID_BSS_PARAM_20MHZ_PSD_MLD_PARAM:
 */
 enum tbtt_information_field {
 	TBTT_NEIGHBOR_AP_OFFSET_ONLY = 1,
@@ -569,7 +570,7 @@ struct ml_info {
 * @air_time_fraction: Air time fraction from ESP param
 * @qbss_chan_load: Qbss channel load
 * @nss: supported NSS information
- * @is_p2p_ssid: is P2P entry
+ * @is_p2p: is P2P entry
 * @adaptive_11r_ap: flag to check if AP supports adaptive 11r
 * @scan_entry_time: boottime in microsec when last beacon/probe is received
 * @rssi_timestamp: boottime in microsec when RSSI was updated
@@ -580,13 +581,13 @@ struct ml_info {
 * @channel: channel info on which AP is present
 * @channel_mismatch: if channel received in metadata
 *                    doesn't match the one in beacon
+ * @mlme_info: Mlme info, this will be updated by MLME for the scan entry
 * @tsf_delta: TSF delta
 * @bss_score: bss score calculated on basis of RSSI/caps etc.
 * @neg_sec_info: negotiated security info
 * @per_chain_rssi: per chain RSSI value received.
- * boottime_ns: boottime in ns.
+ * @boottime_ns: boottime in ns.
 * @rrm_parent_tsf: RRM parent tsf
- * @mlme_info: Mlme info, this will be updated by MLME for the scan entry
 * @alt_wcn_ie: alternate WCN IE
 * @ie_list: IE list pointers
 * @raw_frame: contain raw frame and the length of the raw frame
@@ -989,6 +990,7 @@ enum scan_request_type {
 * @vdev_id: vdev id where scan was originated
 * @pdev_id: pdev id of parent pdev
 * @scan_priority: scan priority
+ * @scan_type: scan request type
 * @scan_ev_started: notify scan started event
 * @scan_ev_completed: notify scan completed event
 * @scan_ev_bss_chan: notify bss chan event
@@ -1046,6 +1048,12 @@ enum scan_request_type {
 * @scan_f_wide_band: scan in 40 MHz or higher bandwidth
 * @scan_flags: variable to read and set scan_f_* flags in one shot
 *              can be used to dump all scan_f_* flags for debug
+ * @scan_policy_high_accuracy:
+ * @scan_policy_low_span:
+ * @scan_policy_low_power:
+ * @scan_policy_colocated_6ghz:
+ * @scan_policy_type: variable to read and set all scan_policy_* flags
+ * @adaptive_dwell_time_mode:
 * @burst_duration: burst duration
 * @num_bssid: no of bssid
 * @num_ssids: no of ssid
@@ -1175,9 +1183,9 @@ struct scan_start_request {
 };

 /**
- * enum scan_cancel_type - type specifiers for cancel scan request
+ * enum scan_cancel_req_type - type specifiers for cancel scan request
 * @WLAN_SCAN_CANCEL_SINGLE: cancel particular scan specified by scan_id
- * @WLAN_SCAN_CANCEL_VAP_ALL: cancel all scans running on a particular vdevid
+ * @WLAN_SCAN_CANCEL_VDEV_ALL: cancel all scans running on a particular vdevid
 * @WLAN_SCAN_CANCEL_PDEV_ALL: cancel all scans running on parent pdev of vdevid
 * @WLAN_SCAN_CANCEL_HOST_VDEV_ALL: Cancel all host triggered scans alone on
 * vdev
@@ -1343,14 +1351,14 @@ enum scm_scan_status {
 };

 /**
- * scan_event_handler() - function prototype of scan event handlers
+ * typedef scan_event_handler() - function prototype of scan event handlers
 * @vdev: vdev object
 * @event: scan event
 * @arg: argument
 *
 * PROTO TYPE, scan event handler call back function prototype
 *
- * @Return: void
+ * Return: void
 */
 typedef void (*scan_event_handler) (struct wlan_objmgr_vdev *vdev,
 	struct scan_event *event, void *arg);
@@ -1414,10 +1422,9 @@ struct pno_nw_type {
 };

 /**
- * struct connected_pno_band_rssi_pref - BSS preference based on band
- * and RSSI
+ * struct cpno_band_rssi_pref - BSS preference based on band and RSSI
 * @band: band preference
- * @rssi_pref: RSSI preference
+ * @rssi: RSSI preference
 */
 struct cpno_band_rssi_pref {
 	int8_t band;
@@ -1453,8 +1460,8 @@ struct nlo_mawc_params {
 * @fast_scan_max_cycles: Fast scan max cycles
 * @scan_backoff_multiplier: multiply fast scan period by this after max cycles
 * @pno_channel_prediction: PNO channel prediction feature status
- * @uint32_t active_dwell_time: active dwell time
- * @uint32_t passive_dwell_time: passive dwell time
+ * @active_dwell_time: active dwell time
+ * @passive_dwell_time: passive dwell time
 * @top_k_num_of_channels: top K number of channels are used for tanimoto
 * distance calculation.
 * @stationary_thresh: threshold value to determine that the STA is stationary.
@@ -1514,29 +1521,29 @@ struct scan_user_cfg {
 };

 /**
- * update_beacon_cb() - cb to inform/update beacon
- * @psoc: psoc pointer
- * @scan_params:  scan entry to inform/update
+ * typedef update_beacon_cb() - cb to inform/update beacon
+ * @pdev: pdev pointer
+ * @scan_entry:  scan entry to inform/update
 *
- * @Return: void
+ * Return: void
 */
 typedef void (*update_beacon_cb) (struct wlan_objmgr_pdev *pdev,
 	struct scan_cache_entry *scan_entry);

 /**
- * scan_iterator_func() - function prototype of scan iterator function
- * @scan_entry: scan entry object
+ * typedef scan_iterator_func() - function prototype of scan iterator function
 * @arg: extra argument
+ * @scan_entry: scan entry object
 *
 * PROTO TYPE, scan iterator function prototype
 *
- * @Return: QDF_STATUS
+ * Return: QDF_STATUS
 */
 typedef QDF_STATUS (*scan_iterator_func) (void *arg,
 	struct scan_cache_entry *scan_entry);

 /**
- * enum scan_priority - scan priority definitions
+ * enum scan_config - scan configuration definitions
 * @SCAN_CFG_DISABLE_SCAN_COMMAND_TIMEOUT: disable scan command timeout
 * @SCAN_CFG_DROP_BCN_ON_CHANNEL_MISMATCH: config to drop beacon/probe
 *  response frames if received channel and IE channels do not match
@@ -1558,7 +1565,7 @@ enum ext_cap_bit_field {
 };

 /**
- * scan_rnr_info - RNR information
+ * struct scan_rnr_info - RNR information
 * @timestamp: time stamp of beacon/probe
 * @short_ssid: Short SSID
 * @bssid: BSSID
@@ -1582,7 +1589,7 @@ struct scan_rnr_node {
 };

 /**
- * meta_rnr_channel - Channel information for scan priority algorithm
+ * struct meta_rnr_channel - Channel information for scan priority algorithm
 * @chan_freq: channel frequency
 * @bss_beacon_probe_count: Beacon and probe request count
 * @saved_profile_count: Saved profile count
@@ -1599,7 +1606,7 @@ struct meta_rnr_channel {

 #define RNR_UPDATE_SCAN_CNT_THRESHOLD 2
 /**
- * channel_list_db - Database for channel information
+ * struct channel_list_db - Database for channel information
 * @channel: channel meta information
 * @scan_count: scan count since the db was updated
 */
@@ -1609,7 +1616,7 @@ struct channel_list_db {
 };

 /**
- * rnr_chan_weight - RNR channel weightage
+ * struct rnr_chan_weight - RNR channel weightage
 * @chan_freq: channel frequency
 * @weight: weightage of the channel
 * @phymode: phymode in which @frequency should be scanned
@@ -1624,7 +1631,7 @@ struct rnr_chan_weight {
 };

 /**
- * trim_channel_list - which channel list need trim
+ * enum trim_channel_list - which channel list need trim
 * @TRIM_CHANNEL_LIST_NONE: no channel need trim
 * @TRIM_CHANNEL_LIST_5G: 5G channel need trim
 * @TRIM_CHANNEL_LIST_24G: 2.4G channel need trim
@@ -1637,7 +1644,7 @@ enum trim_channel_list {

 #ifdef FEATURE_SET
 /**
- * wlan_scan_features - Scan feature set structure
+ * struct wlan_scan_features - Scan feature set structure
 * @pno_in_unassoc_state: is pno supported in unassoc state
 * @pno_in_assoc_state: is pno supported in assoc state
 */
--- a/umac/scan/dispatcher/inc/wlan_scan_tgt_api.h
+++ b/umac/scan/dispatcher/inc/wlan_scan_tgt_api.h
@@ -1,6 +1,6 @@
 /*
 * Copyright (c) 2017,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
@@ -36,7 +36,7 @@
 * @psoc: psoc context
 * @peer: peer
 * @buf: frame buf
- * @params: rx event params
+ * @rx_param: rx event params
 * @frm_type: frame type
 *
 * The callbeack registered to tx/rx module and is called when beacon
--- a/umac/scan/dispatcher/inc/wlan_scan_ucfg_api.h
+++ b/umac/scan/dispatcher/inc/wlan_scan_ucfg_api.h
@@ -17,7 +17,7 @@
 * PERFORMANCE OF THIS SOFTWARE.
 */

-/*
+/**
 * DOC: contains scan north bound interface api
 */

@@ -135,7 +135,7 @@ void ucfg_scan_add_flags_to_pno_chan_list(struct wlan_objmgr_vdev *vdev,

 /**
 * ucfg_is_6ghz_pno_scan_optimization_supported() - Public API to check
- * 6ghz pno scan optimization supported in fw
+ * 6 GHz pno scan optimization supported in fw
 * @psoc: psoc object
 *
 * Return: 0 for success.
@@ -146,7 +146,6 @@ ucfg_is_6ghz_pno_scan_optimization_supported(struct wlan_objmgr_psoc *psoc);
 /**
 * ucfg_scan_pno_stop() - Public API to stop PNO
 * @vdev: vdev pointer
- * @req: pno req params
 *
 * Return: 0 for success or error code.
 */
@@ -227,7 +226,7 @@ static inline QDF_STATUS ucfg_scan_start(struct scan_start_request *req)
 }

 /**
- * ucfg_scan_set_psoc_enable() - Public API to enable scans for psoc
+ * ucfg_scan_psoc_set_enable() - Public API to enable scans for psoc
 * @psoc: psoc on which scans need to be disabled
 * @reason: reason for enable/disabled
 *
@@ -248,7 +247,7 @@ QDF_STATUS ucfg_scan_psoc_set_disable(struct wlan_objmgr_psoc *psoc,

 /**
 * ucfg_scan_vdev_set_enable() - Public API to enable scans for vdev
- * @psoc: psoc on which scans need to be disabled
+ * @vdev: vdev on which scans need to be disabled
 * @reason: reason for enable/disabled
 *
 * Return: QDF_STATUS.
@@ -258,7 +257,7 @@ QDF_STATUS ucfg_scan_vdev_set_enable(struct wlan_objmgr_vdev *vdev,

 /**
 * ucfg_scan_vdev_set_disable() - Public API to disable scans for vdev
- * @psoc: psoc on which scans need to be disabled
+ * @vdev: vdev on which scans need to be disabled
 * @reason: reason for enable/disabled
 *
 * Return: QDF_STATUS.
@@ -266,8 +265,6 @@ QDF_STATUS ucfg_scan_vdev_set_enable(struct wlan_objmgr_vdev *vdev,
 QDF_STATUS ucfg_scan_vdev_set_disable(struct wlan_objmgr_vdev *vdev,
 				      enum scan_disable_reason reason);

-
-
 /**
 * ucfg_scan_set_miracast() - Public API to disable/enable miracast flag
 * @psoc: psoc pointer
@@ -305,7 +302,7 @@ ucfg_scan_get_global_config(struct wlan_objmgr_psoc *psoc,
 /**
 * ucfg_scan_set_obss_scan_offload() - Public API to set obss scan flag
 * @psoc: psoc context
- * @val: the value to be set
+ * @value: the value to be set
 *
 * Return: void.
 */
@@ -340,8 +337,9 @@ bool ucfg_scan_get_wide_band_scan(struct wlan_objmgr_pdev *pdev);
 */
 QDF_STATUS ucfg_scan_set_custom_scan_chan_list(
 		struct wlan_objmgr_pdev *pdev, struct chan_list *chan_list);
+
 /**
- * ucfg_scan_set_ssid_bssid_hidden_ssid_beacon() - API to configure
+ * ucfg_scan_config_hidden_ssid_for_bssid() - API to configure
 * ssid, bssid of hidden beacon
 * @pdev: psoc on which ssid bssid need to configure
 * @bssid: bssid of the hidden AP
@@ -458,7 +456,7 @@ ucfg_scan_db_iterate(struct wlan_objmgr_pdev *pdev,
 * ucfg_scan_update_mlme_by_bssinfo() - The Public API to update mlme
 * info in the scan entry
 * @pdev: pdev object
- * @bssid: bssid info to find the matching scan entry
+ * @bss_info: bssid info to find the matching scan entry
 * @mlme_info: mlme info to be updated.
 *
 * The Public API to update mlme info in the scan entry.
@@ -580,7 +578,7 @@ ucfg_scan_get_pdev_status(struct wlan_objmgr_pdev *pdev);
 /**
 * ucfg_scan_register_bcn_cb() - API to register api
 * to inform/update bcn/probe as soon as they are received
- * @pdev: psoc
+ * @psoc: psoc
 * @cb: callback to be registered
 * @type: Type of callback to be registered
 *
@@ -589,7 +587,7 @@ ucfg_scan_get_pdev_status(struct wlan_objmgr_pdev *pdev);
 QDF_STATUS ucfg_scan_register_bcn_cb(struct wlan_objmgr_psoc *psoc,
 	update_beacon_cb cb, enum scan_cb_type type);

-/*
+/**
 * ucfg_scan_update_user_config() - Update scan cache user config
 * @psoc: psoc
 * @scan_cfg: scan user config
@@ -599,7 +597,7 @@ QDF_STATUS ucfg_scan_register_bcn_cb(struct wlan_objmgr_psoc *psoc,
 QDF_STATUS ucfg_scan_update_user_config(struct wlan_objmgr_psoc *psoc,
 	struct scan_user_cfg *scan_cfg);

-/*
+/**
 * ucfg_scan_init() - Scan module initialization API
 *
 * Return: QDF_STATUS
@@ -622,7 +620,7 @@ QDF_STATUS ucfg_scan_deinit(void);
 QDF_STATUS ucfg_scan_psoc_enable(struct wlan_objmgr_psoc *psoc);

 /**
- * ucfg_scan_psoc_enable() - Scan module disable API
+ * ucfg_scan_psoc_disable() - Scan module disable API
 * @psoc: psoc object
 *
 * Return: QDF_STATUS
@@ -917,7 +915,7 @@ void ucfg_scan_cfg_set_conc_passive_dwelltime(struct wlan_objmgr_psoc *psoc,
 /**
 * ucfg_scan_cfg_get_dfs_chan_scan_allowed() - API to get dfs scan enabled
 * @psoc: pointer to psoc object
- * @enable_dfs_scan: DFS scan enabled or not.
+ * @dfs_scan_enable: Set DFS scan enabled or not.
 *
 * Return: None
 */
@@ -929,9 +927,9 @@ void ucfg_scan_cfg_get_dfs_chan_scan_allowed(struct wlan_objmgr_psoc *psoc,
 }

 /**
- * ucfg_scan_cfg_set_dfs_channel_scan() - API to set dfs scan enabled
+ * ucfg_scan_cfg_set_dfs_chan_scan_allowed() - API to set dfs scan enabled
 * @psoc: pointer to psoc object
- * @enable_dfs_scan: Set DFS scan enabled or not.
+ * @dfs_scan_enable: Set DFS scan enabled or not.
 *
 * Return: None
 */
@@ -1005,7 +1003,7 @@ bool ucfg_scan_is_pno_offload_enabled(struct wlan_objmgr_psoc *psoc);
 * ucfg_scan_set_pno_offload() - API to set pno offload flag based on the
 * capability received from the firmware.
 * @psoc: pointer to psoc object
- * @rest_time: scan concurrent min rest time
+ * @value: pno offload flag value
 *
 * Return: scan concurrent min rest time
 */
@@ -1085,11 +1083,12 @@ bool
 ucfg_scan_get_user_config_sched_scan_plan(struct wlan_objmgr_psoc *psoc);

 #ifdef WLAN_POLICY_MGR_ENABLE
-/*
+/**
 * ucfg_scan_update_pno_dwell_time() - update active and passive dwell time
 * depending on active concurrency modes
 * @vdev: vdev object pointer
- * @req: scan request
+ * @req: pno scan request parameters
+ * @scan_def: scan default parameters
 *
 * Return: void
 */
--- a/umac/scan/dispatcher/inc/wlan_scan_utils_api.h
+++ b/umac/scan/dispatcher/inc/wlan_scan_utils_api.h
@@ -1,6 +1,6 @@
 /*
 * Copyright (c) 2017-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,9 +72,9 @@ qdf_list_t *util_scan_unpack_beacon_frame(
 /**
 * util_scan_add_hidden_ssid() - func to add hidden ssid
 * @pdev: pdev pointer
- * @frame: beacon buf
+ * @bcnbuf: beacon buf
 *
- * Return:
+ * Return: QDF_STATUS_SUCCESS on success, otherwise a QDF_STATUS error
 */
 #ifdef WLAN_DFS_CHAN_HIDDEN_SSID
 QDF_STATUS
@@ -99,7 +99,7 @@ const char *util_scan_get_ev_type_name(enum scan_event_type event);

 /**
 * util_scan_get_ev_reason_name() - converts enum reason to printable string
- * @reason      enum of scan completion reason
+ * @reason: enum of scan completion reason
 *
 * API, converts enum event to printable character string
 *
@@ -402,7 +402,7 @@ static inline bool util_is_bss_type_match(enum wlan_bss_type bss_type,
 /**
 * util_country_code_match() - to check if country match
 * @country: country code pointer
- * @country_ie: country IE in beacon
+ * @cc: country IE in beacon
 *
 * Return: true if country match
 */
@@ -582,6 +582,9 @@ util_scan_entry_frame_ptr(struct scan_cache_entry *scan_entry)
 /**
 * util_scan_entry_copy_ie_data() - function to get a copy of all tagged IEs
 * @scan_entry: scan entry
+ * @iebuf: destination IE buffer. May be NULL if only the
+ * @ie_len: pointer to the ie buffer length. On input must hold the size of
+ *          @iebuf. On output it will be filled with the length of the IEs.
 *
 * API, function to get a copy of all tagged IEs in passed memory
 *
@@ -756,6 +759,7 @@ util_scan_copy_beacon_data(struct scan_cache_entry *new_entry,
 /**
 * util_scan_get_ml_partner_info() - Get partner links info of an ML connection
 * @scan_entry: scan entry
+ * @partner_info: partner link info
 *
 * API, function to get partner link information from an ML scan cache entry
 *
@@ -1489,12 +1493,12 @@ util_scan_entry_get_extcap(struct scan_cache_entry *scan_entry,
 }

 /**
- * util_scan_entry_athcaps() - function to read ath caps vendor ie
+ * util_scan_entry_mlme_info() - function to read MLME info
 * @scan_entry: scan entry
 *
- * API, function to read ath caps vendor ie
+ * API, function to read MLME info
 *
- * Return: ath caps vendorie or NULL if ie is not present
+ * Return: MLME info or NULL if it is not present
 */
 static inline struct mlme_info*
 util_scan_entry_mlme_info(struct scan_cache_entry *scan_entry)
@@ -1679,6 +1683,7 @@ util_get_last_scan_time(struct wlan_objmgr_vdev *vdev);

 /**
 * util_scan_entry_update_mlme_info() - function to update mlme info
+ * @pdev: pdev object
 * @scan_entry: scan entry object
 *
 * API, function to update mlme info in scan DB
@@ -1716,7 +1721,7 @@ util_scan_entry_is_hidden_ap(struct scan_cache_entry *scan_entry)
 }

 /**
- * util_scan_entry_espinfo() - function to read ESP info
+ * util_scan_entry_esp_info() - function to read ESP info
 * @scan_entry: scan entry
 *
 * API, function to read ESP info
@@ -1842,9 +1847,9 @@ static inline bool util_scan_is_null_ssid(struct wlan_ssid *ssid)
 /**
 * util_scan_get_6g_oper_channel() - function to get primary channel
 * from he op IE
- * he_op_ie : ie pointer
+ * @he_op_ie : ie pointer
 *
- * Return : primary channel or 0 if 6g params is not present.
+ * Return: primary channel or 0 if 6g params is not present.
 */
 #ifdef CONFIG_BAND_6GHZ
 uint8_t util_scan_get_6g_oper_channel(uint8_t *he_op_ie);