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

qcacmn: Fix umac/mlme documentation

Browse Source 
The kernel-doc script identified some documentation errors in the
umac/mlme folder, so fix them.

Change-Id: I84617fe2007e51dcb009801ebc6cdf87c0d0a686
CRs-Fixed: 3381478
This commit is contained in:
Jeff Johnson
2023-01-16 17:09:07 -08:00
committed by Madan Koyyalamudi
parent de12add913
commit b4b8c2933f
30 changed files with 519 additions and 329 deletions
Download Patch File Download Diff File Expand all files Collapse all files

84
umac/mlme/include/wlan_vdev_mlme.h
View File

@@ -223,6 +223,9 @@ struct vdev_mlme_he_ops_info {
* @eht_phycap_mubfmrlt80mhz : MU Beamformer (BW <= 80 MHz)
* @eht_phycap_mubfmr160mhz : MU Beamformer (BW = 160 MHz)
* @eht_phycap_mubfmr320mhz : MU Beamformer (BW = 320 MHz)
* @eht_phycap_tb_sounding_feedback_rl:
* @eht_phycap_rx1024qamwiderbwdlofdma:
* @eht_phycap_rx4096qamwiderbwdlofdma:
*/
struct vdev_mlme_eht_caps_info {
uint32_t eht_maccap_epcspriaccess_support :1,
@@ -291,11 +294,11 @@ struct vdev_mlme_eht_ops_info {
/**
* enum mlme_vdev_dot11_mode - Dot11 mode of the vdev
* MLME_VDEV_DOT11_MODE_AUTO: vdev uses mlme_dot11_mode
* MLME_VDEV_DOT11_MODE_11N: vdev supports 11N mode
* MLME_VDEV_DOT11_MODE_11AC: vdev supports 11AC mode
* MLME_VDEV_DOT11_MODE_11AX: vdev supports 11AX mode
* MLME_VDEV_DOT11_MODE_11BE: vdev supports 11BE mode
* @MLME_VDEV_DOT11_MODE_AUTO: vdev uses mlme_dot11_mode
* @MLME_VDEV_DOT11_MODE_11N: vdev supports 11N mode
* @MLME_VDEV_DOT11_MODE_11AC: vdev supports 11AC mode
* @MLME_VDEV_DOT11_MODE_11AX: vdev supports 11AX mode
* @MLME_VDEV_DOT11_MODE_11BE: vdev supports 11BE mode
*/
enum mlme_vdev_dot11_mode {
MLME_VDEV_DOT11_MODE_AUTO,
@@ -306,7 +309,7 @@ enum mlme_vdev_dot11_mode {
};
/**
* struct vdev_mlme_he_ops_info - vdev protocol structure holding information
* struct vdev_mlme_proto - vdev protocol structure holding information
* that is used in frames
* @vdev_dot11_mode: supported dot11 mode
* @generic: generic protocol information
@@ -341,7 +344,7 @@ struct vdev_mlme_proto {
* @probe_delay: time in msec for delaying to send first probe request
* @repeat_probe_time: probe request transmission time
* @drop_unencry: drop unencrypted status
* @ tx_pwrlimit: Tx power limit
* @tx_pwrlimit: Tx power limit
* @tx_power: Tx power
* @minpower: Min power
* @maxpower: Max power
@@ -353,7 +356,7 @@ struct vdev_mlme_proto {
* @ssid: service set identifier
* @ssid_len: ssid length
* @type: vdev type
* @sub_type: vdev subtype
* @subtype: vdev subtype
* @rx_decap_type: rx decap type
* @tx_encap_type: tx encap type
* @disable_hw_ack: disable ha ack flag
@@ -366,6 +369,7 @@ struct vdev_mlme_proto {
* @he_spr_srg_min_pd_offset: SRG PD min offset
* @he_spr_enabled: Spatial reuse enabled or not
* @he_spr_disabled_due_conc: spr disabled due to concurrency
* @sr_prohibit_enabled:
* @srg_bss_color: srg bss color
* @srg_partial_bssid: srg partial bssid
* @he_curr_non_srg_pd_threshold: current configured NON-SRG PD threshold
@@ -414,11 +418,14 @@ struct vdev_mlme_mgmt_generic {
};
/*
* struct wlan_vdev_aid_mgr – AID manager
* struct wlan_vdev_aid_mgr - AID manager
* @aid_bitmap: AID bitmap array
* @start_aid: start of AID index
* @max_aid: Max allowed AID
* @ref_cnt: to share AID across VDEVs for MBSSID
*
* NB: Not using kernel-doc comment since the kernel-doc script
* doesn't handle the qdf_bitmap() macro.
*/
struct wlan_vdev_aid_mgr {
qdf_bitmap(aid_bitmap, WLAN_UMAC_MAX_AID);
@@ -477,7 +484,8 @@ struct vdev_mlme_inactivity_params {
* @WLAN_VDEV_RATEMASK_TYPE_CCK: phy type CCK
* @WLAN_VDEV_RATEMASK_TYPE_HT: phy type ht
* @WLAN_VDEV_RATEMASK_TYPE_VHT: phy type vht
* WLAN_VDEV_RATEMASK_TYPE_HE: phy type he
* @WLAN_VDEV_RATEMASK_TYPE_HE: phy type he
* @WLAN_VDEV_RATEMASK_TYPE_MAX: Maximum enumeration
*/
enum vdev_ratemask_type {
WLAN_VDEV_RATEMASK_TYPE_CCK,
@@ -510,6 +518,7 @@ struct vdev_ratemask_params {
* @tx_mgmt_rate: Tx Mgmt rate
* @bcn_tx_rate: beacon Tx rate
* @bcn_tx_rate_code: beacon Tx rate code
* @rtscts_tx_rate: RTS/CTS Tx rate
* @ratemask_params: vdev ratemask params per phy type
* @half_rate: Half rate
* @quarter_rate: quarter rate
@@ -574,10 +583,9 @@ struct vdev_mlme_beacon_info {
* struct vdev_mlme_mbss_11ax - mbss 11ax fields required for up cmd
* @profile_idx: profile index of the connected non-trans ap (mbssid case).
* 0 means invalid.
* @profile_num: the total profile numbers of non-trans aps (mbssid
* case).
* @profile_num: the total profile numbers of non-trans aps (mbssid case).
* 0 means non-MBSS AP.
* @mbssid-flags: MBSS IE flags indicating vdev type
* @mbssid_flags: MBSS IE flags indicating vdev type
* @vdevid_trans: id of transmitting vdev for MBSS IE
* @vdev_bmap: vdev bitmap of VAPs in MBSS group
* @is_cmn_param: flag to check mbss common param
@@ -674,6 +682,7 @@ enum vdev_start_resp_type {
* @mlme_vdev_start_continue: callback to initiate operations on
* LMAC/FW start response
* @mlme_vdev_sta_conn_start: callback to initiate STA connection
* @mlme_vdev_start_req_failed:
* @mlme_vdev_up_send: callback to initiate actions of VDEV
* MLME up operation
* @mlme_vdev_notify_up_complete: callback to notify VDEV MLME on moving
@@ -691,6 +700,9 @@ enum vdev_start_resp_type {
* peer delete completion
* @mlme_vdev_down_send: callback to initiate actions of VDEV
* MLME down operation
* @mlme_vdev_notify_down_complete:
* @mlme_vdev_ext_stop_rsp:
* @mlme_vdev_ext_start_rsp:
* @mlme_vdev_notify_start_state_exit: callback to notify on vdev start
* start state exit
* @mlme_vdev_is_newchan_no_cac: callback to check CAC is required
@@ -701,6 +713,7 @@ enum vdev_start_resp_type {
* @mlme_vdev_sta_disconn_start: callback to initiate STA disconnection
* @mlme_vdev_reconfig_timer_complete: callback to process ml reconfing
* operation
* @mlme_vdev_notify_mlo_sync_wait_entry:
*/
struct vdev_mlme_ops {
QDF_STATUS (*mlme_vdev_validate_basic_params)(
@@ -829,8 +842,8 @@ struct vdev_mlme_obj {
*
* Caller need to acquire lock with wlan_vdev_obj_lock()
*
* Return: SUCCESS, if update is done
* FAILURE, if ssid length is > max ssid len
* Return: QDF_STATUS_SUCCESS, if update is done
* QDF_STATUS error, if ssid length is > max ssid len
*/
static inline QDF_STATUS wlan_vdev_mlme_set_ssid(
struct wlan_objmgr_vdev *vdev,
@@ -916,8 +929,7 @@ static inline void wlan_vdev_mlme_set_nss(
*
* API to get the Number of Spatial Streams
*
* Return:
* @nss: nss value
* Return: nss value
*/
static inline uint8_t wlan_vdev_mlme_get_nss(
struct wlan_objmgr_vdev *vdev)
@@ -960,8 +972,7 @@ static inline void wlan_vdev_mlme_set_txchainmask(
*
* API to get the Tx chainmask
*
* Return:
* @chainmask : Tx chainmask either configured by user or max supported
* Return: Tx chainmask either configured by user or max supported
*/
static inline uint8_t wlan_vdev_mlme_get_txchainmask(
struct wlan_objmgr_vdev *vdev)
@@ -1003,8 +1014,7 @@ static inline void wlan_vdev_mlme_set_rxchainmask(
*
* API to get the Rx chainmask
*
* Return:
* @chainmask : Rx chainmask either configured by user or max supported
* Return: Rx chainmask either configured by user or max supported
*/
static inline uint8_t wlan_vdev_mlme_get_rxchainmask(
struct wlan_objmgr_vdev *vdev)
@@ -1047,8 +1057,7 @@ static inline void wlan_vdev_mlme_set_txpower(
*
* API to get the tx power
*
* Return:
* @txpow: tx power either configured by used or max allowed
* Return: tx power either configured by used or max allowed
*/
static inline uint8_t wlan_vdev_mlme_get_txpower(
struct wlan_objmgr_vdev *vdev)
@@ -1090,8 +1099,7 @@ static inline void wlan_vdev_mlme_set_maxrate(
*
* API to get the max rate the vdev supports
*
* Return:
* @maxrate: configured by used or based on configured mode
* Return: configured by used or based on configured mode
*/
static inline uint32_t wlan_vdev_mlme_get_maxrate(
struct wlan_objmgr_vdev *vdev)
@@ -1133,8 +1141,7 @@ static inline void wlan_vdev_mlme_set_txmgmtrate(
*
* API to get Mgmt Tx rate
*
* Return:
* @txmgmtrate: Tx Mgmt rate
* Return: Tx Mgmt rate
*/
static inline uint32_t wlan_vdev_mlme_get_txmgmtrate(
struct wlan_objmgr_vdev *vdev)
@@ -1200,8 +1207,7 @@ static inline void wlan_vdev_mlme_set_he_mcs_12_13_map(
*
* API to get he mcs12/13 support capability
*
* Return:
* @he_mcs_12_13_map: he mcs12/13 map
* Return: he mcs12/13 map
*/
static inline uint16_t wlan_vdev_mlme_get_he_mcs_12_13_map(
struct wlan_objmgr_vdev *vdev)
@@ -1224,8 +1230,7 @@ static inline uint16_t wlan_vdev_mlme_get_he_mcs_12_13_map(
*
* Caller need to acquire lock with wlan_vdev_obj_lock()
*
* Return:
* @he_spr_sr_ctrl: SR control
* Return: SR control
*/
static inline uint8_t wlan_vdev_mlme_get_sr_ctrl(struct wlan_objmgr_vdev *vdev)
{
@@ -1244,8 +1249,7 @@ static inline uint8_t wlan_vdev_mlme_get_sr_ctrl(struct wlan_objmgr_vdev *vdev)
*
* API to retrieve the spatial reuse pd offset from VDEV
*
* Return:
* @he_spr_non_srg_pd_max_offset: max non srg pd offset
* Return: max non srg pd offset
*/
static inline uint8_t wlan_vdev_mlme_get_non_srg_pd_offset(
struct wlan_objmgr_vdev *vdev)
@@ -1265,8 +1269,7 @@ static inline uint8_t wlan_vdev_mlme_get_non_srg_pd_offset(
*
* API to check whether the spatial reuse enabled or not
*
* Return:
* @he_spr_enabled: Spatial reuse enabled or not
* Return: true if Spatial reuse enabled, false if not
*/
static inline bool wlan_vdev_mlme_get_he_spr_enabled(
struct wlan_objmgr_vdev *vdev)
@@ -1313,8 +1316,7 @@ bool wlan_vdev_mlme_is_sr_disable_due_conc(struct wlan_objmgr_vdev *vdev)
*
* Caller need to acquire lock with wlan_vdev_obj_lock()
*
* Return:
* @sr_prohibit_enabled: Spatial reuse PD prohibit enabled / disabled
* Return: true/false: Spatial reuse PD prohibit enabled / disabled
*/
static inline
bool wlan_vdev_mlme_is_sr_prohibit_en(struct wlan_objmgr_vdev *vdev)
@@ -1331,6 +1333,7 @@ bool wlan_vdev_mlme_is_sr_prohibit_en(struct wlan_objmgr_vdev *vdev)
/**
* wlan_vdev_mlme_set_sr_ctrl() - set spatial reuse SR control
* @vdev: VDEV object
* @sr_ctrl: value to set
*
* API to set the spatial reuse SR control
*
@@ -1354,6 +1357,7 @@ static inline void wlan_vdev_mlme_set_sr_ctrl(struct wlan_objmgr_vdev *vdev,
* wlan_vdev_mlme_set_non_srg_pd_offset() - set spatial reuse non srg
* pd max offset
* @vdev: VDEV object
* @non_srg_pd_max_offset: value to set
*
* API to set the spatial reuse pd max offset
*
@@ -1376,6 +1380,7 @@ wlan_vdev_mlme_set_non_srg_pd_offset(struct wlan_objmgr_vdev *vdev,
/**
* wlan_vdev_mlme_set_he_spr_enabled() - set spatial reuse enabled
* @vdev: VDEV object
* @enable_he_spr: value to set
*
* API to set the spatial reuse enabled
*
@@ -1398,6 +1403,7 @@ static inline void wlan_vdev_mlme_set_he_spr_enabled(
* wlan_vdev_mlme_set_sr_disable_due_conc() - set spatial reuse disabled due
* to concurrency
* @vdev: VDEV object
* @he_spr_disabled_due_conc: value to set
*
* API to set the spatial reuse disabled due to concurrency
*
@@ -1495,8 +1501,8 @@ void wlan_vdev_mlme_get_srg_pd_offset(struct wlan_objmgr_vdev *vdev,
}
/**
* wlan_vdev_mlme_set_srg_bss_color() - set spatial reuse bss
* colorbitmap
* wlan_vdev_mlme_set_srg_bss_color_bit_map() - set spatial reuse bss
* color bitmap
* @vdev: VDEV object
* @srg_bss_color: SRG BSS color bitmap
*