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

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,

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
  */

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
  */

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

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
  */

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);