qcacld-3.0: Fix kernel-doc errors in qcacld 1 of n

Fix and update kernel documentation errors in qcacld.

Change-Id: Id62fb82c0a0ee5a4f3a4ac0fbaeb98c397ef5d0b
CRs-Fixed: 3635453

core/sap/inc/sap_api.h

@@ -20,7 +20,7 @@
 #ifndef WLAN_QCT_WLANSAP_H
 #define WLAN_QCT_WLANSAP_H
 
-/**
+/*
  * W L A N   S O F T A P  P A L   L A Y E R
  * E X T E R N A L  A P I
  *
@@ -350,11 +350,11 @@ typedef struct sap_MaxAssocExceededEvent_s {
 } tSap_MaxAssocExceededEvent;
 
 /**
- * sap_acs_ch_selected_s - the structure to hold the selected channels
- * @pri_chan_freq: Holds the ACS selected primary channel frequency
+ * struct sap_ch_selected_s - structure to hold the selected channels
+ * @pri_ch_freq: Holds the ACS selected primary channel frequency
  * @ht_sec_ch_freq: Holds the ACS selected secondary ht channel frequency
- * @vht_seg0_center_ch: Holds the ACS selected center channel of vht seg0
- * @vht_seg1_center_ch: Holds the ACS selected center channel of vht seg1
+ * @vht_seg0_center_ch_freq: Holds the ACS selected center channel of vht seg0
+ * @vht_seg1_center_ch_freq: Holds the ACS selected center channel of vht seg1
  * @ch_width: Holds the ACS selected channel bandwidth
  *
  * Holds the primary and secondary channel selected by ACS and is
@@ -726,7 +726,7 @@ typedef struct tagSapStruct {
 #endif
 } tSapStruct, *tpSapStruct;
 
-/**
+/*
  * struct sap_context - per-BSS Context for SAP
  *
  * struct sap_context is used to share per-BSS context between SAP and
@@ -1078,7 +1078,7 @@ QDF_STATUS wlansap_modify_acl(struct sap_context *sap_ctx,
 /**
  * wlansap_channel_change_request() - Send channel change request
  * @sap_ctx: Pointer to the SAP context
- * @target_channel: Target channel
+ * @target_chan_freq: Target channel
  *
  * This API is used to send an Indication to SME/PE to change the
  * current operating channel to a different target channel.
@@ -1326,8 +1326,8 @@ void wlansap_extend_to_acs_range(mac_handle_t mac_handle,
  *                                           phy_mode. This API is for son,
  *                                           There is no band switching when
  *                                           son phy mode is changed.
- * @sap_ctx:  Pointer to Sap Context
- * @sap_config:  Pointer to sap config
+ * @vdev:  Pointer to vdev object
+ * @config:  Pointer to sap config
  * @phy_mode: pointer to phy mode
  *
  * Return: QDF_STATUS
@@ -1418,7 +1418,8 @@ QDF_STATUS wlansap_acs_chselect(struct sap_context *sap_context,
 
 /**
  * sap_undo_acs() - Undo acs i.e free the allocated ch lists
- * @sap_ctx: pointer to the SAP context
+ * @sap_context: pointer to the SAP context
+ * @sap_cfg: pointer to the SAP confid structure
  *
  * This function will free the memory allocated to the sap ctx channel list, acs
  * cfg ch list and master ch list.
@@ -1468,7 +1469,7 @@ QDF_STATUS wlansap_release_vdev_ref(struct sap_context *sap_ctx);
 
 /**
  * sap_get_cac_dur_dfs_region() - get cac duration and dfs region.
- * @sap_ctxt: sap context
+ * @sap_ctx: sap context
  * @cac_duration_ms: pointer to cac duration
  * @dfs_region: pointer to dfs region
  * @chan_freq: channel frequency
@@ -1615,7 +1616,7 @@ qdf_freq_t wlansap_get_chan_band_restrict(struct sap_context *sap_ctx,
 
 /**
  * wlansap_override_csa_strict_for_sap() - check user CSA strict or not
- * @mac: mac ctx
+ * @mac_handle: Opaque handle to the global MAC context
  * @sap_ctx: sap context
  * @target_chan_freq: target channel frequency in MHz
  * @strict: CSA strict flag
@@ -1775,7 +1776,7 @@ bool wlansap_filter_vendor_unsafe_ch_freq(
 
 /**
  * wlansap_dump_acs_ch_freq() - print acs channel frequency
- * @sap_ctx: sap context
+ * @sap_context: sap context
  *
  * This function is used to print acs channel frequecny
  *
@@ -1785,7 +1786,7 @@ void wlansap_dump_acs_ch_freq(struct sap_context *sap_context);
 
 /**
  * wlansap_set_acs_ch_freq() - set acs channel frequency
- * @sap_ctx: sap context
+ * @sap_context: sap context
  * @ch_freq: ch_freq to be set
  *
  * This function is used to set acs channel frequency
@@ -1895,6 +1896,7 @@ static inline void sap_acs_set_puncture_support(struct sap_context *sap_ctx,
 /**
  * sap_cac_end_notify() - Notify CAC end to HDD
  * @mac_handle: Opaque handle to the global MAC context
+ * @roamInfo: pointer to the struct csr_roam_info
  *
  * Function will be called to notify eSAP_DFS_CAC_END event to HDD
  *

core/sap/src/sap_ch_select.c

@@ -215,7 +215,7 @@ sap_check_n_add_channel(struct sap_context *sap_ctx,
  * sap_check_n_add_overlapped_chnls() - checks & add overlapped channels
  *                                      to primary channel in 2.4Ghz band.
  * @sap_ctx:           sap context.
- * @primary_chnl:      primary channel to be avoided.
+ * @primary_channel:      primary channel to be avoided.
  *
  * sap_ctx contains sap_avoid_ch_info struct containing the list of channels on
  * which MDM device's AP with MCC was detected. This function will add channels
@@ -276,7 +276,7 @@ sap_check_n_add_overlapped_chnls(struct sap_context *sap_ctx,
  * context's avoid_channels_info struct
  * @mac_ctx:            pointer to mac_context structure
  * @sap_ctx:            sap context.
- * @scan_result:        scan results for ACS scan.
+ * @scan_list:        scan results for ACS scan.
  * @spect_info:         spectrum weights array to update
  *
  * Detection of Q2Q IE indicates presence of another MDM device with its AP
@@ -402,7 +402,7 @@ uint32_t sap_select_preferred_channel_from_channel_list(uint32_t best_ch_freq,
 
 /**
  * sap_chan_sel_init() - Initialize channel select
- * @mac_handle: Opaque handle to the global MAC context
+ * @mac: Opaque handle to the global MAC context
  * @ch_info_params: Pointer to tSapChSelSpectInfo structure
  * @sap_ctx: Pointer to SAP Context
  * @ignore_acs_range: Whether ignore channel which is out of acs range
@@ -544,7 +544,7 @@ static bool sap_chan_sel_init(struct mac_context *mac,
 
 /**
  * sapweight_rssi_count() - calculates the channel weight due to rssi
-    and data count(here number of BSS observed)
+ *                          and data count(here number of BSS observed)
  * @sap_ctx     : Softap context
  * @rssi        : Max signal strength received from a BSS for the channel
  * @count       : Number of BSS observed in the channel
@@ -604,7 +604,7 @@ uint32_t sapweight_rssi_count(struct sap_context *sap_ctx, int8_t rssi,
 /**
  * sap_get_channel_status() - get channel info via channel number
  * @p_mac: Pointer to Global MAC structure
- * @channel_id: channel id
+ * @chan_freq: channel frequency
  *
  * Return: chan status info
  */
@@ -640,7 +640,7 @@ static void sap_clear_channel_status(struct mac_context *p_mac)
 /**
  * sap_weight_channel_noise_floor() - compute noise floor weight
  * @sap_ctx:  sap context
- * @chn_stat: Pointer to chan status info
+ * @channel_stat: Pointer to chan status info
  *
  * Return: channel noise floor weight
  */
@@ -685,7 +685,7 @@ static uint32_t sap_weight_channel_noise_floor(struct sap_context *sap_ctx,
 /**
  * sap_weight_channel_free() - compute channel free weight
  * @sap_ctx:  sap context
- * @chn_stat: Pointer to chan status info
+ * @channel_stat: Pointer to chan status info
  *
  * Return: channel free weight
  */
@@ -743,7 +743,7 @@ static uint32_t sap_weight_channel_free(struct sap_context *sap_ctx,
 /**
  * sap_weight_channel_txpwr_range() - compute channel tx power range weight
  * @sap_ctx:  sap context
- * @chn_stat: Pointer to chan status info
+ * @channel_stat: Pointer to chan status info
  *
  * Return: tx power range weight
  */
@@ -791,7 +791,7 @@ static uint32_t sap_weight_channel_txpwr_range(struct sap_context *sap_ctx,
  * sap_weight_channel_txpwr_tput() - compute channel tx power
  * throughput weight
  * @sap_ctx:  sap context
- * @chn_stat: Pointer to chan status info
+ * @channel_stat: Pointer to chan status info
  *
  * Return: tx power throughput weight
  */
@@ -837,7 +837,7 @@ static uint32_t sap_weight_channel_txpwr_tput(struct sap_context *sap_ctx,
 /**
  * sap_weight_channel_status() - compute chan status weight
  * @sap_ctx:  sap context
- * @chn_stat: Pointer to chan status info
+ * @channel_stat: Pointer to chan status info
  *
  * Return: chan status weight
  */
@@ -977,8 +977,9 @@ static void sap_update_rssi_bsscount_vht_5G(
  * @spect_ch:        Channel Information
  * @chan_width:      Channel width parsed from beacon IE
  * @sec_chan_offset: Secondary Channel Offset
- * @center_freq:     Central frequency for the given channel.
- * @channel_id:      channel_id
+ * @ch_freq0:     frequency_0 for the given channel.
+ * @ch_freq1:     frequency_1 for the given channel.
+ * @op_chan_freq: Operating channel frequency.
  * @ch_start: the start of spect ch array
  * @ch_end: the end of spect ch array
  *
@@ -1063,9 +1064,10 @@ static void sap_interference_rssi_count_5G(struct sap_ch_info *spect_ch,
  * sap_interference_rssi_count() - sap_interference_rssi_count
  *                                 considers the Adjacent channel rssi
  *                                 and data count(here number of BSS observed)
- * @spect_ch    Channel Information
+ * @spect_ch: Channel Information
  * @ch_start: the start of spect ch array
  * @ch_end: the end of spect ch array
+ * @mac: Opaque handle to the global MAC context
  *
  * sap_interference_rssi_count considers the Adjacent channel rssi
  * and data count(here number of BSS observed)
@@ -1226,13 +1228,11 @@ static void sap_interference_rssi_count(struct sap_ch_info *spect_ch,
 /**
  * ch_in_pcl() - Is channel in the Preferred Channel List (PCL)
  * @sap_ctx: SAP context which contains the current PCL
- * @channel: Input channel number to be checked
+ * @ch_freq: Input channel number to be checked
  *
  * Check if a channel is in the preferred channel list
  *
- * Return:
- *   true:    channel is in PCL,
- *   false:   channel is not in PCL
+ * Return: True if channel is in PCL, else False
  */
 static bool ch_in_pcl(struct sap_context *sap_ctx, uint32_t ch_freq)
 {
@@ -1476,7 +1476,7 @@ static void sap_update_6ghz_max_weight(struct sap_sel_ch_info *ch_info_params,
  * sap_compute_spect_weight() - Compute spectrum weight
  * @ch_info_params: Pointer to the tSpectInfoParams structure
  * @mac: Pointer to mac_context struucture
- * @pResult: Pointer to tScanResultHandle
+ * @scan_list: Pointer to channel list
  * @sap_ctx: Context of the SAP
  *
  * Main function for computing the weight of each channel in the
@@ -1883,7 +1883,7 @@ sap_sort_chl_weight_80_mhz(struct mac_context *mac_ctx,
 }
 
 /**
- * sap_sort_chl_weight_vht160() - to sort the channels with the least weight
+ * sap_sort_chl_weight_160_mhz() - to sort the channels with the least weight
  * @mac_ctx: pointer to max context
  * @sap_ctx: Pointer to the struct sap_context *structure
  * @ch_info_params: Pointer to the tSapChSelSpectInfo structure
@@ -2302,7 +2302,7 @@ sap_sort_chl_weight_320_mhz(struct mac_context *mac_ctx,
 #endif /* WLAN_FEATURE_11BE */
 
 /**
- * sap_allocate_max_weight_ht40_24_g() - allocate max weight for 40Mhz
+ * sap_allocate_max_weight_40_mhz_24_g() - allocate max weight for 40Mhz
  *                                       to all 2.4Ghz channels
  * @spect_info_params: Pointer to the tSapChSelSpectInfo structure
  *
@@ -2326,7 +2326,7 @@ sap_allocate_max_weight_40_mhz_24_g(struct sap_sel_ch_info *spect_info_params)
 }
 
 /**
- * sap_allocate_max_weight_ht40_5_g() - allocate max weight for 40Mhz
+ * sap_allocate_max_weight_40_mhz() - allocate max weight for 40Mhz
  *                                      to all 5Ghz channels
  * @spect_info_params: Pointer to the tSapChSelSpectInfo structure
  *

core/sap/src/sap_fsm.c

@@ -996,9 +996,9 @@ static bool is_mcc_preferred(struct sap_context *sap_context,
 }
 
 /**
- * sap_process_force_scc_with_go_start - Check GO force SCC or not
- * psoc: psoc object
- * sap_context: sap_context
+ * sap_process_force_scc_with_go_start() - Check GO force SCC or not
+ * @psoc: psoc object
+ * @sap_context: sap_context
  *
  * This function checks the current SAP MCC or not with the GO's home channel.
  * If it is, skip the GO's force SCC. The SAP will do force SCC after
@@ -1037,9 +1037,9 @@ sap_process_force_scc_with_go_start(struct wlan_objmgr_psoc *psoc,
 
 #ifdef WLAN_FEATURE_P2P_P2P_STA
 /**
- * sap_set_forcescc_required - set force scc flag for provided p2p go vdev
+ * sap_set_forcescc_required() - set force scc flag for provided p2p go vdev
  *
- * vdev_id - vdev_id for which flag needs to be set
+ * @vdev_id: vdev_id for which flag needs to be set
  *
  * Return: None
  */
@@ -1067,11 +1067,11 @@ static void sap_set_forcescc_required(uint8_t vdev_id)
 }
 
 /**
- * sap_process_liberal_scc_for_go - based on existing connections this
+ * sap_process_liberal_scc_for_go() - based on existing connections this
  * function decides current go should start on provided channel or not and
  * sets force scc required bit for existing GO.
  *
- * sap_context: sap_context
+ * @sap_context: sap_context
  *
  * Return: bool
  */
@@ -1335,14 +1335,14 @@ static void sap_sort_freq_list(struct chan_list *list,
 }
 
 /**
- * sap_acs_scan_freq_list_optimize - optimize the ACS scan freq list based
+ * sap_acs_scan_freq_list_optimize() - optimize the ACS scan freq list based
  * on when last scan was performed on particular frequency. If last scan
  * performed on particular frequency is less than configured last_scan_ageout
  * time, then skip that frequency from ACS scan freq list.
  *
- * sap_ctx: sap context
- * list: ACS scan frequency list
- * ch_count: number of frequency in list
+ * @sap_ctx: sap context
+ * @list: ACS scan frequency list
+ * @ch_count: number of frequency in list
  *
  * Return: None
  */
@@ -1390,7 +1390,7 @@ static void sap_acs_scan_freq_list_optimize(struct sap_context *sap_ctx,
 
 #ifdef WLAN_FEATURE_SAP_ACS_OPTIMIZE
 /**
- * sap_reset_clean_freq_array(): clear freq array that contains info
+ * sap_reset_clean_freq_array() - clear freq array that contains info
  * channel is free or not
  * @sap_context: sap context
  *
@@ -1408,14 +1408,14 @@ void sap_reset_clean_freq_array(struct sap_context *sap_context)
 #endif
 
 /**
- * wlansap_set_aux_scan_ctrl_ext_flag() – update aux scan policy
+ * wlansap_set_aux_scan_ctrl_ext_flag() - update aux scan policy
  * @req: pointer to scan request
  *
- * Set aux scan bits in scan_ctrl_ext_flag value depending on scan type.
+ * Set aux scan bits in scan_ctrl_ext_flag value depending on scan type
  *
  * Return: None
  */
-static void wlansap_set_aux_scan_ctrl_ext_flag(struct scan_start_request  *req)
+static void wlansap_set_aux_scan_ctrl_ext_flag(struct scan_start_request *req)
 {
 	sap_debug("Set Reliable Scan Flag");
 	req->scan_req.scan_ctrl_flags_ext |=
@@ -2173,6 +2173,7 @@ bool find_ch_freq_in_radar_hist(struct dfs_radar_history *radar_result,
 
 /**
  * sap_append_cac_history() - Add CAC history to list
+ * @mac_ctx: pointer to mac context
  * @radar_result: radar history buffer
  * @idx: current radar history element number
  * @max_elems: max elements number of radar history buffer.
@@ -3094,7 +3095,7 @@ QDF_STATUS sap_cac_end_notify(mac_handle_t mac_handle,
 /**
  * sap_validate_dfs_nol() - Validate SAP channel with NOL list
  * @sap_ctx: SAP context
- * @sap_ctx: MAC context
+ * @mac_ctx: pointer to mac context
  *
  * Function will be called to validate SAP channel and bonded sub channels
  * included in DFS NOL or not.
@@ -3731,6 +3732,7 @@ sap_fsm_send_csa_restart_req(struct mac_context *mac_ctx,
  * sap_fsm_validate_and_change_channel() - handle channel Avoid event event
  *                                         or channel list update during cac
  * @mac_ctx: global MAC context
+ * @sap_ctx: SAP context
  *
  * Return: QDF_STATUS
  */
@@ -4050,6 +4052,7 @@ static QDF_STATUS sap_fsm_state_started(struct sap_context *sap_ctx,
  * @sap_ctx: SAP context
  * @sap_event: SAP event buffer
  * @mac_ctx: global MAC context
+ * @mac_handle: Opaque handle to the global MAC context
  *
  * This function is called for state transition from "SAP_STOPPING"
  *
@@ -4964,7 +4967,7 @@ bool is_concurrent_sap_ready_for_channel_change(mac_handle_t mac_handle,
 /**
  * sap_is_conc_sap_doing_scc_dfs() - check if conc SAPs are doing SCC DFS
  * @mac_handle: Opaque handle to the global MAC context
- * @sap_context: current SAP persona's channel
+ * @given_sapctx: current SAP persona's channel
  *
  * If provided SAP's channel is DFS then Loop through each SAP or GO persona and
  * check if other beaconing entity's channel is same DFS channel. If they are