1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /****************************************************************************** 3 * 4 * Copyright(c) 2007 - 2011 Realtek Corporation. All rights reserved. 5 * 6 ******************************************************************************/ 7 #ifndef __RTW_MLME_H_ 8 #define __RTW_MLME_H_ 9 10 11 #define MAX_BSS_CNT 128 12 /* define MAX_JOIN_TIMEOUT 2000 */ 13 /* define MAX_JOIN_TIMEOUT 2500 */ 14 #define MAX_JOIN_TIMEOUT 6500 15 16 /* Commented by Albert 20101105 */ 17 /* Increase the scanning timeout because of increasing the SURVEY_TO value. */ 18 19 #define SCANNING_TIMEOUT 8000 20 21 #define SCANQUEUE_LIFETIME 20000 /* 20sec, unit:msec */ 22 23 #define WIFI_NULL_STATE 0x00000000 24 #define WIFI_ASOC_STATE 0x00000001 /* Under Linked state... */ 25 #define WIFI_SLEEP_STATE 0x00000004 26 #define WIFI_STATION_STATE 0x00000008 27 #define WIFI_AP_STATE 0x00000010 28 #define WIFI_ADHOC_STATE 0x00000020 29 #define WIFI_ADHOC_MASTER_STATE 0x00000040 30 #define WIFI_UNDER_LINKING 0x00000080 31 32 #define WIFI_UNDER_WPS 0x00000100 33 #define WIFI_STA_ALIVE_CHK_STATE 0x00000400 34 #define WIFI_SITE_MONITOR 0x00000800 /* to indicate the station is under site surveying */ 35 36 /* ifdef UNDER_MPTEST */ 37 #define WIFI_MP_STATE 0x00010000 38 /* endif */ 39 40 /* define _FW_UNDER_CMD WIFI_UNDER_CMD */ 41 #define _FW_UNDER_LINKING WIFI_UNDER_LINKING 42 #define _FW_LINKED WIFI_ASOC_STATE 43 #define _FW_UNDER_SURVEY WIFI_SITE_MONITOR 44 45 46 enum { 47 dot11AuthAlgrthm_Open = 0, 48 dot11AuthAlgrthm_Shared, 49 dot11AuthAlgrthm_8021X, 50 dot11AuthAlgrthm_Auto, 51 dot11AuthAlgrthm_WAPI, 52 dot11AuthAlgrthm_MaxNum 53 }; 54 55 /* Scan type including active and passive scan. */ 56 enum rt_scan_type { 57 SCAN_PASSIVE, 58 SCAN_ACTIVE, 59 SCAN_MIX, 60 }; 61 62 enum { 63 GHZ24_50 = 0, 64 GHZ_50, 65 GHZ_24, 66 GHZ_MAX, 67 }; 68 69 /* 70 71 there are several "locks" in mlme_priv, 72 since mlme_priv is a shared resource between many threads, 73 like ISR/Call-Back functions, the OID handlers, and even timer functions. 74 75 Each struct __queue has its own locks, already. 76 Other items in mlme_priv are protected by mlme_priv.lock, while items in 77 xmit_priv are protected by xmit_priv.lock. 78 79 To avoid possible dead lock, any thread trying to modifying mlme_priv 80 SHALL not lock up more than one locks at a time! 81 82 The only exception is that queue functions which take the __queue.lock 83 may be called with the xmit_priv.lock held. In this case the order 84 MUST always be first lock xmit_priv.lock and then call any queue functions 85 which take __queue.lock. 86 */ 87 88 struct sitesurvey_ctrl { 89 u64 last_tx_pkts; 90 uint last_rx_pkts; 91 signed int traffic_busy; 92 struct timer_list sitesurvey_ctrl_timer; 93 }; 94 95 struct rt_link_detect_t { 96 u32 num_tx_ok_in_period; 97 u32 num_rx_ok_in_period; 98 u32 num_rx_unicast_ok_in_period; 99 bool busy_traffic; 100 bool tx_busy_traffic; 101 bool rx_busy_traffic; 102 /* For interrupt migration purpose. */ 103 bool higher_busy_traffic; 104 /* We may disable Tx interrupt according as Rx traffic. */ 105 bool higher_busy_rx_traffic; 106 /* We may disable Tx interrupt according as Tx traffic. */ 107 bool higher_busy_tx_traffic; 108 u8 traffic_transition_count; 109 u32 low_power_transition_count; 110 }; 111 112 /* used for mlme_priv.roam_flags */ 113 enum { 114 RTW_ROAM_ON_EXPIRED = BIT0, 115 RTW_ROAM_ON_RESUME = BIT1, 116 RTW_ROAM_ACTIVE = BIT2, 117 }; 118 119 struct mlme_priv { 120 121 spinlock_t lock; 122 signed int fw_state; /* shall we protect this variable? maybe not necessarily... */ 123 u8 bScanInProcess; 124 u8 to_join; /* flag */ 125 126 u8 to_roam; /* roaming trying times */ 127 struct wlan_network *roam_network; /* the target of active roam */ 128 u8 roam_flags; 129 u8 roam_rssi_diff_th; /* rssi difference threshold for active scan candidate selection */ 130 u32 roam_scan_int_ms; /* scan interval for active roam */ 131 u32 roam_scanr_exp_ms; /* scan result expire time in ms for roam */ 132 u8 roam_tgt_addr[ETH_ALEN]; /* request to roam to specific target without other consideration */ 133 134 u8 *nic_hdl; 135 136 u8 not_indic_disco; 137 struct list_head *pscanned; 138 struct __queue free_bss_pool; 139 struct __queue scanned_queue; 140 u8 *free_bss_buf; 141 142 struct ndis_802_11_ssid assoc_ssid; 143 u8 assoc_bssid[6]; 144 145 struct wlan_network cur_network; 146 struct wlan_network *cur_network_scanned; 147 148 /* uint wireless_mode; no used, remove it */ 149 150 u32 auto_scan_int_ms; 151 152 struct timer_list assoc_timer; 153 154 uint assoc_by_bssid; 155 uint assoc_by_rssi; 156 157 struct timer_list scan_to_timer; /* driver itself handles scan_timeout status. */ 158 unsigned long scan_start_time; /* used to evaluate the time spent in scanning */ 159 160 struct timer_list set_scan_deny_timer; 161 atomic_t set_scan_deny; /* 0: allowed, 1: deny */ 162 163 struct qos_priv qospriv; 164 165 /* Number of non-HT AP/stations */ 166 int num_sta_no_ht; 167 168 /* Number of HT AP/stations 20 MHz */ 169 /* int num_sta_ht_20mhz; */ 170 171 172 int num_FortyMHzIntolerant; 173 174 struct ht_priv htpriv; 175 176 struct rt_link_detect_t link_detect_info; 177 struct timer_list dynamic_chk_timer; /* dynamic/periodic check timer */ 178 179 u8 acm_mask; /* for wmm acm mask */ 180 u8 ChannelPlan; 181 enum rt_scan_type scan_mode; /* active: 1, passive: 0 */ 182 183 u8 *wps_probe_req_ie; 184 u32 wps_probe_req_ie_len; 185 186 /* Number of associated Non-ERP stations (i.e., stations using 802.11b 187 * in 802.11g BSS) */ 188 int num_sta_non_erp; 189 190 /* Number of associated stations that do not support Short Slot Time */ 191 int num_sta_no_short_slot_time; 192 193 /* Number of associated stations that do not support Short Preamble */ 194 int num_sta_no_short_preamble; 195 196 int olbc; /* Overlapping Legacy BSS Condition */ 197 198 /* Number of HT associated stations that do not support greenfield */ 199 int num_sta_ht_no_gf; 200 201 /* Number of associated non-HT stations */ 202 /* int num_sta_no_ht; */ 203 204 /* Number of HT associated stations 20 MHz */ 205 int num_sta_ht_20mhz; 206 207 /* Overlapping BSS information */ 208 int olbc_ht; 209 210 u16 ht_op_mode; 211 212 u8 *assoc_req; 213 u32 assoc_req_len; 214 u8 *assoc_rsp; 215 u32 assoc_rsp_len; 216 217 u8 *wps_beacon_ie; 218 /* u8 *wps_probe_req_ie; */ 219 u8 *wps_probe_resp_ie; 220 u8 *wps_assoc_resp_ie; /* for CONFIG_IOCTL_CFG80211, this IE could include p2p ie / wfd ie */ 221 222 u32 wps_beacon_ie_len; 223 /* u32 wps_probe_req_ie_len; */ 224 u32 wps_probe_resp_ie_len; 225 u32 wps_assoc_resp_ie_len; /* for CONFIG_IOCTL_CFG80211, this IE len could include p2p ie / wfd ie */ 226 227 u8 *p2p_beacon_ie; 228 u8 *p2p_probe_req_ie; 229 u8 *p2p_probe_resp_ie; 230 u8 *p2p_go_probe_resp_ie; /* for GO */ 231 u8 *p2p_assoc_req_ie; 232 233 u32 p2p_beacon_ie_len; 234 u32 p2p_probe_req_ie_len; 235 u32 p2p_probe_resp_ie_len; 236 u32 p2p_go_probe_resp_ie_len; /* for GO */ 237 u32 p2p_assoc_req_ie_len; 238 239 spinlock_t bcn_update_lock; 240 u8 update_bcn; 241 242 u8 NumOfBcnInfoChkFail; 243 unsigned long timeBcnInfoChkStart; 244 }; 245 246 void rtw_mlme_reset_auto_scan_int(struct adapter *adapter); 247 248 struct hostapd_priv { 249 struct adapter *padapter; 250 }; 251 252 extern int hostapd_mode_init(struct adapter *padapter); 253 extern void hostapd_mode_unload(struct adapter *padapter); 254 255 extern void rtw_joinbss_event_prehandle(struct adapter *adapter, u8 *pbuf); 256 extern void rtw_survey_event_callback(struct adapter *adapter, u8 *pbuf); 257 extern void rtw_surveydone_event_callback(struct adapter *adapter, u8 *pbuf); 258 extern void rtw_joinbss_event_callback(struct adapter *adapter, u8 *pbuf); 259 extern void rtw_stassoc_event_callback(struct adapter *adapter, u8 *pbuf); 260 extern void rtw_stadel_event_callback(struct adapter *adapter, u8 *pbuf); 261 extern void rtw_atimdone_event_callback(struct adapter *adapter, u8 *pbuf); 262 extern void rtw_cpwm_event_callback(struct adapter *adapter, u8 *pbuf); 263 extern void rtw_wmm_event_callback(struct adapter *padapter, u8 *pbuf); 264 265 extern void rtw_join_timeout_handler(struct timer_list *t); 266 extern void _rtw_scan_timeout_handler(struct timer_list *t); 267 268 int event_thread(void *context); 269 270 extern void rtw_free_network_queue(struct adapter *adapter, u8 isfreeall); 271 extern int rtw_init_mlme_priv(struct adapter *adapter);/* (struct mlme_priv *pmlmepriv); */ 272 273 extern void rtw_free_mlme_priv(struct mlme_priv *pmlmepriv); 274 275 276 extern signed int rtw_select_and_join_from_scanned_queue(struct mlme_priv *pmlmepriv); 277 extern signed int rtw_set_key(struct adapter *adapter, struct security_priv *psecuritypriv, signed int keyid, u8 set_tx, bool enqueue); 278 extern signed int rtw_set_auth(struct adapter *adapter, struct security_priv *psecuritypriv); 279 280 static inline u8 *get_bssid(struct mlme_priv *pmlmepriv) 281 { /* if sta_mode:pmlmepriv->cur_network.network.mac_address => bssid */ 282 /* if adhoc_mode:pmlmepriv->cur_network.network.mac_address => ibss mac address */ 283 return pmlmepriv->cur_network.network.mac_address; 284 } 285 286 static inline signed int check_fwstate(struct mlme_priv *pmlmepriv, signed int state) 287 { 288 if (pmlmepriv->fw_state & state) 289 return true; 290 291 return false; 292 } 293 294 static inline signed int get_fwstate(struct mlme_priv *pmlmepriv) 295 { 296 return pmlmepriv->fw_state; 297 } 298 299 /* 300 * No Limit on the calling context, 301 * therefore set it to be the critical section... 302 * 303 * ### NOTE:#### (!!!!) 304 * MUST TAKE CARE THAT BEFORE CALLING THIS FUNC, YOU SHOULD HAVE LOCKED pmlmepriv->lock 305 */ 306 static inline void set_fwstate(struct mlme_priv *pmlmepriv, signed int state) 307 { 308 pmlmepriv->fw_state |= state; 309 /* FOR HW integration */ 310 if (state == _FW_UNDER_SURVEY) 311 pmlmepriv->bScanInProcess = true; 312 } 313 314 static inline void _clr_fwstate_(struct mlme_priv *pmlmepriv, signed int state) 315 { 316 pmlmepriv->fw_state &= ~state; 317 /* FOR HW integration */ 318 if (state == _FW_UNDER_SURVEY) 319 pmlmepriv->bScanInProcess = false; 320 } 321 322 extern u16 rtw_get_capability(struct wlan_bssid_ex *bss); 323 extern void rtw_update_scanned_network(struct adapter *adapter, struct wlan_bssid_ex *target); 324 extern void rtw_disconnect_hdl_under_linked(struct adapter *adapter, struct sta_info *psta, u8 free_assoc); 325 extern void rtw_generate_random_ibss(u8 *pibss); 326 extern struct wlan_network *rtw_find_network(struct __queue *scanned_queue, u8 *addr); 327 extern struct wlan_network *rtw_get_oldest_wlan_network(struct __queue *scanned_queue); 328 struct wlan_network *_rtw_find_same_network(struct __queue *scanned_queue, struct wlan_network *network); 329 330 extern void rtw_free_assoc_resources(struct adapter *adapter, int lock_scanned_queue); 331 extern void rtw_indicate_disconnect(struct adapter *adapter); 332 extern void rtw_indicate_connect(struct adapter *adapter); 333 void rtw_indicate_scan_done(struct adapter *padapter, bool aborted); 334 void rtw_scan_abort(struct adapter *adapter); 335 336 extern int rtw_restruct_sec_ie(struct adapter *adapter, u8 *in_ie, u8 *out_ie, uint in_len); 337 extern int rtw_restruct_wmm_ie(struct adapter *adapter, u8 *in_ie, u8 *out_ie, uint in_len, uint initial_out_len); 338 extern void rtw_init_registrypriv_dev_network(struct adapter *adapter); 339 340 extern void rtw_update_registrypriv_dev_network(struct adapter *adapter); 341 342 extern void _rtw_join_timeout_handler(struct timer_list *t); 343 extern void rtw_scan_timeout_handler(struct timer_list *t); 344 345 extern void rtw_dynamic_check_timer_handler(struct adapter *adapter); 346 bool rtw_is_scan_deny(struct adapter *adapter); 347 void rtw_clear_scan_deny(struct adapter *adapter); 348 void rtw_set_scan_deny(struct adapter *adapter, u32 ms); 349 350 void rtw_free_mlme_priv_ie_data(struct mlme_priv *pmlmepriv); 351 352 extern void _rtw_free_mlme_priv(struct mlme_priv *pmlmepriv); 353 354 /* extern struct wlan_network* _rtw_dequeue_network(struct __queue *queue); */ 355 356 extern struct wlan_network *rtw_alloc_network(struct mlme_priv *pmlmepriv); 357 358 359 extern void _rtw_free_network(struct mlme_priv *pmlmepriv, struct wlan_network *pnetwork, u8 isfreeall); 360 extern void _rtw_free_network_nolock(struct mlme_priv *pmlmepriv, struct wlan_network *pnetwork); 361 362 363 extern struct wlan_network *_rtw_find_network(struct __queue *scanned_queue, u8 *addr); 364 365 bool rtw_if_up(struct adapter *padapter); 366 367 bool rtw_linked_check(struct adapter *padapter); 368 369 u8 *rtw_get_capability_from_ie(u8 *ie); 370 u8 *rtw_get_beacon_interval_from_ie(u8 *ie); 371 372 373 void rtw_joinbss_reset(struct adapter *padapter); 374 375 void rtw_ht_use_default_setting(struct adapter *padapter); 376 void rtw_build_wmm_ie_ht(struct adapter *padapter, u8 *out_ie, uint *pout_len); 377 unsigned int rtw_restructure_ht_ie(struct adapter *padapter, u8 *in_ie, u8 *out_ie, uint in_len, uint *pout_len, u8 channel); 378 void rtw_update_ht_cap(struct adapter *padapter, u8 *pie, uint ie_len, u8 channel); 379 void rtw_issue_addbareq_cmd(struct adapter *padapter, struct xmit_frame *pxmitframe); 380 void rtw_append_exented_cap(struct adapter *padapter, u8 *out_ie, uint *pout_len); 381 382 bool rtw_is_same_ibss(struct adapter *adapter, struct wlan_network *pnetwork); 383 int is_same_network(struct wlan_bssid_ex *src, struct wlan_bssid_ex *dst, u8 feature); 384 385 #define rtw_roam_flags(adapter) ((adapter)->mlmepriv.roam_flags) 386 #define rtw_chk_roam_flags(adapter, flags) ((adapter)->mlmepriv.roam_flags & flags) 387 388 void _rtw_roaming(struct adapter *adapter, struct wlan_network *tgt_network); 389 void rtw_roaming(struct adapter *adapter, struct wlan_network *tgt_network); 390 void rtw_set_to_roam(struct adapter *adapter, u8 to_roam); 391 u8 rtw_dec_to_roam(struct adapter *adapter); 392 u8 rtw_to_roam(struct adapter *adapter); 393 int rtw_select_roaming_candidate(struct mlme_priv *pmlmepriv); 394 395 void rtw_sta_media_status_rpt(struct adapter *adapter, struct sta_info *psta, u32 mstatus); 396 void rtw_reset_securitypriv(struct adapter *adapter); 397 398 #endif /* __RTL871X_MLME_H_ */ 399