samsung-sm8650/android_kernel_samsung_sm8650-modules
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

qcacld-3.0: Fix MLME documentation

Browse Source 
The kernel-doc script identified multiple documentation issues in
components/mlme, so fix them.

Change-Id: I1fdcdcc7e43c8945044d22aeeca7b2f1b8bec6f7
CRs-Fixed: 3358666
This commit is contained in:
Jeff Johnson
2022-12-12 09:11:16 -08:00
committed by Madan Koyyalamudi
parent e0da27d3c1
commit cb647fd309
11 changed files with 288 additions and 336 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
components/mlme/dispatcher/inc/wlan_mlme_api.h
View File

@@ -135,7 +135,7 @@ wlan_mlme_get_enable_deauth_to_disassoc_map(struct wlan_objmgr_psoc *psoc,
/**
* wlan_mlme_get_ht_cap_info() - Get the HT cap info config
* @psoc: pointer to psoc object
* @value: pointer to the value which will be filled for the caller
* @ht_cap_info: pointer to the value which will be filled for the caller
*
* Return: QDF Status
*/
@@ -216,7 +216,7 @@ wlan_mlme_get_manufacture_product_version(struct wlan_objmgr_psoc *psoc,
/**
* wlan_mlme_set_ht_cap_info() - Set the HT cap info config
* @psoc: pointer to psoc object
* @value: Value that needs to be set from the caller
* @ht_cap_info: Value that needs to be set from the caller
*
* Return: QDF Status
*/
@@ -296,7 +296,6 @@ wlan_mlme_get_wlm_multi_client_ll_caps(struct wlan_objmgr_psoc *psoc)
* wlan_mlme_get_coex_unsafe_chan_nb_user_prefer() - get coex unsafe nb
* support
* @psoc: pointer to psoc object
* @value: pointer to the value which will be filled for the caller
*
* Return: coex_unsafe_chan_nb_user_prefer
*/
@@ -545,11 +544,10 @@ wlan_mlme_get_external_acs_policy(struct wlan_objmgr_psoc *psoc,
bool *value);
/**
*
* wlan_mlme_get_sap_inactivity_override() - Check if sap max inactivity
* override flag is set.
* @psoc: pointer to psoc object
* @sme_config - Sme config struct
* @value: Value that needs to be set from the caller
*
* Return: QDF Status
*/
@@ -675,7 +673,7 @@ QDF_STATUS wlan_mlme_get_assoc_sta_limit(struct wlan_objmgr_psoc *psoc,
int *value);
/**
* wlan_mlme_set_sap_get_peer_info() - get the sap get peer info
* wlan_mlme_get_sap_get_peer_info() - get the sap get peer info
* @psoc: pointer to psoc object
* @value: Value that needs to be set from the caller
*
@@ -730,7 +728,7 @@ wlan_mlme_is_6g_sap_fd_enabled(struct wlan_objmgr_psoc *psoc,
bool *value);
/**
* wlan_mlme_get_sap_allow_all_channels() - get the value sap max peers
* wlan_mlme_get_sap_max_peers() - get the value sap max peers
* @psoc: pointer to psoc object
* @value: Value that needs to be set from the caller
*
@@ -1258,8 +1256,7 @@ QDF_STATUS wlan_mlme_peer_get_assoc_rsp_ies(struct wlan_objmgr_peer *peer,
/**
* wlan_mlme_get_mcc_duty_cycle_percentage() - Get primary STA iface duty
* cycle percentage
* @psoc: pointer to psoc object
* @value: value that needs to be set from the caller
* @pdev: pointer to pdev object
*
* API to get the MCC duty cycle for primary and secondary STA's
*
@@ -2352,7 +2349,7 @@ QDF_STATUS mlme_update_nss_vht_cap(struct wlan_objmgr_psoc *psoc);
* mlme_get_bss_11be_allowed() - Check BSS allowed in 11be mode
* @psoc: psoc context
* @bssid: bssid
* @ie_date: ie data
* @ie_data: ie data
* @ie_length: ie data length
*
* Return: true if AP in 11be oui allow list
@@ -2394,6 +2391,7 @@ QDF_STATUS wlan_mlme_set_sap_uapsd_flag(struct wlan_objmgr_psoc *psoc,
/**
* wlan_mlme_is_11h_enabled() - Get the 11h flag
* @psoc: psoc context
* @value: Enable/Disable value ptr.
*
* Return: QDF_STATUS
*/
@@ -2403,6 +2401,7 @@ wlan_mlme_is_11h_enabled(struct wlan_objmgr_psoc *psoc, bool *value);
/**
* wlan_mlme_set_11h_enabled() - Set the 11h flag
* @psoc: psoc context
* @value: Enable/Disable value
*
* Return: QDF_STATUS
*/
@@ -2412,6 +2411,7 @@ wlan_mlme_set_11h_enabled(struct wlan_objmgr_psoc *psoc, bool value);
/**
* wlan_mlme_is_11d_enabled() - Get the 11d flag
* @psoc: psoc context
* @value: Enable/Disable value ptr.
*
* Return: QDF_STATUS
*/
@@ -2421,6 +2421,7 @@ wlan_mlme_is_11d_enabled(struct wlan_objmgr_psoc *psoc, bool *value);
/**
* wlan_mlme_set_11d_enabled() - Set the 11h flag
* @psoc: psoc context
* @value: Enable/Disable value
*
* Return: QDF_STATUS
*/
@@ -2449,7 +2450,7 @@ wlan_mlme_set_rf_test_mode_enabled(struct wlan_objmgr_psoc *psoc, bool value);
#ifdef CONFIG_BAND_6GHZ
/**
* wlan_mlme_is_relaxed_6ghz_conn_policy_enabled() - Get the 6ghz relaxed
* wlan_mlme_is_relaxed_6ghz_conn_policy_enabled() - Get the 6 GHz relaxed
* connection policy flag
* @psoc: psoc context
* @value: Enable/Disable value ptr.
@@ -2461,8 +2462,8 @@ wlan_mlme_is_relaxed_6ghz_conn_policy_enabled(struct wlan_objmgr_psoc *psoc,
bool *value);
/**
* wlan_mlme_set_relaxed_6ghz_conn_policy_enabled() - Set the 6ghz relaxed
* connection policy flag
* wlan_mlme_set_relaxed_6ghz_conn_policy() - Set the 6 GHz relaxed
* connection policy flag
* @psoc: psoc context
* @value: True/False
*
@@ -2797,7 +2798,7 @@ wlan_mlme_get_wps_uuid(struct wlan_mlme_wps_params *wps_params, uint8_t *data);
/**
* wlan_mlme_get_self_gen_frm_pwr() - get self gen frm pwr
* @psoc: pointer to psoc object
* @val: Pointer to the value which will be filled for the caller
* @value: Pointer to the value which will be filled for the caller
*
* Return: QDF Status
*/
@@ -2808,7 +2809,7 @@ wlan_mlme_get_self_gen_frm_pwr(struct wlan_objmgr_psoc *psoc,
/**
* wlan_mlme_get_4way_hs_offload() - get 4-way hs offload to fw cfg
* @psoc: pointer to psoc object
* @val: Pointer to the value which will be filled for the caller
* @value: Pointer to the value which will be filled for the caller
*
* Return: QDF Status
*/
@@ -2819,7 +2820,7 @@ wlan_mlme_get_4way_hs_offload(struct wlan_objmgr_psoc *psoc, uint32_t *value);
* wlan_mlme_get_bmiss_skip_full_scan_value() - To get value of
* bmiss_skip_full_scan ini
* @psoc: pointer to psoc object
* @val: Pointer to the value which will be filled for the caller
* @value: Pointer to the value which will be filled for the caller
*
* Return: QDF Status
*/
@@ -3238,7 +3239,7 @@ QDF_STATUS
wlan_mlme_get_sae_assoc_retry_count(struct wlan_objmgr_psoc *psoc,
uint8_t *retry_count);
/**
* wlan_mlme_get_sae_assoc_retry_count() - Get the sae auth retry count
* wlan_mlme_get_sae_auth_retry_count() - Get the sae auth retry count
* @psoc: pointer to psoc object
* @retry_count: auth retry count
*
@@ -3681,7 +3682,6 @@ wlan_mlme_get_wds_mode(struct wlan_objmgr_psoc *psoc)
/**
* mlme_is_twt_enabled() - Get if TWT is enabled via ini.
* @psoc: pointer to psoc object
* @val: pointer to the value to be filled
*
* Return: True if TWT is enabled else false.
*/
@@ -3858,7 +3858,8 @@ wlan_mlme_get_last_delba_sent_time(struct wlan_objmgr_vdev *vdev);
/**
* mlme_set_user_ps() - Set the PS user config
* @vdev: Vdev object pointer
* @psoc: Pointer to psoc object
* @vdev_id: vdev id
* @ps_enable: User PS enable
*
* Return: QDF_STATUS
@@ -3879,7 +3880,6 @@ bool mlme_get_user_ps(struct wlan_objmgr_psoc *psoc, uint8_t vdev_id);
/**
* wlan_mlme_get_p2p_p2p_conc_support() - Get p2p+p2p conc support
* @psoc: pointer to psoc object
* @val : value
*
* Return: Success/failure
*/
@@ -4036,7 +4036,7 @@ uint8_t mlme_get_max_vht_mcs_idx(u_int16_t rx_vht_mcs_map,
#ifdef WLAN_FEATURE_SON
/**
* mlme_set_vdev_max_mcs_idx() - Save max mcs index of vdev
* mlme_save_vdev_max_mcs_idx() - Save max mcs index of vdev
* @vdev: pointer to vdev object
* @max_mcs_idx: max_mcs_idx to save
*