1 /* 2 * Copyright 2002-2005, Devicescape Software, Inc. 3 * 4 * This program is free software; you can redistribute it and/or modify 5 * it under the terms of the GNU General Public License version 2 as 6 * published by the Free Software Foundation. 7 */ 8 9 #ifndef STA_INFO_H 10 #define STA_INFO_H 11 12 #include <linux/list.h> 13 #include <linux/types.h> 14 #include <linux/if_ether.h> 15 #include <linux/workqueue.h> 16 #include <linux/average.h> 17 #include "key.h" 18 19 /** 20 * enum ieee80211_sta_info_flags - Stations flags 21 * 22 * These flags are used with &struct sta_info's @flags member, but 23 * only indirectly with set_sta_flag() and friends. 24 * 25 * @WLAN_STA_AUTH: Station is authenticated. 26 * @WLAN_STA_ASSOC: Station is associated. 27 * @WLAN_STA_PS_STA: Station is in power-save mode 28 * @WLAN_STA_AUTHORIZED: Station is authorized to send/receive traffic. 29 * This bit is always checked so needs to be enabled for all stations 30 * when virtual port control is not in use. 31 * @WLAN_STA_SHORT_PREAMBLE: Station is capable of receiving short-preamble 32 * frames. 33 * @WLAN_STA_ASSOC_AP: We're associated to that station, it is an AP. 34 * @WLAN_STA_WME: Station is a QoS-STA. 35 * @WLAN_STA_WDS: Station is one of our WDS peers. 36 * @WLAN_STA_CLEAR_PS_FILT: Clear PS filter in hardware (using the 37 * IEEE80211_TX_CTL_CLEAR_PS_FILT control flag) when the next 38 * frame to this station is transmitted. 39 * @WLAN_STA_MFP: Management frame protection is used with this STA. 40 * @WLAN_STA_BLOCK_BA: Used to deny ADDBA requests (both TX and RX) 41 * during suspend/resume and station removal. 42 * @WLAN_STA_PS_DRIVER: driver requires keeping this station in 43 * power-save mode logically to flush frames that might still 44 * be in the queues 45 * @WLAN_STA_PSPOLL: Station sent PS-poll while driver was keeping 46 * station in power-save mode, reply when the driver unblocks. 47 * @WLAN_STA_TDLS_PEER: Station is a TDLS peer. 48 * @WLAN_STA_TDLS_PEER_AUTH: This TDLS peer is authorized to send direct 49 * packets. This means the link is enabled. 50 * @WLAN_STA_UAPSD: Station requested unscheduled SP while driver was 51 * keeping station in power-save mode, reply when the driver 52 * unblocks the station. 53 * @WLAN_STA_SP: Station is in a service period, so don't try to 54 * reply to other uAPSD trigger frames or PS-Poll. 55 */ 56 enum ieee80211_sta_info_flags { 57 WLAN_STA_AUTH, 58 WLAN_STA_ASSOC, 59 WLAN_STA_PS_STA, 60 WLAN_STA_AUTHORIZED, 61 WLAN_STA_SHORT_PREAMBLE, 62 WLAN_STA_ASSOC_AP, 63 WLAN_STA_WME, 64 WLAN_STA_WDS, 65 WLAN_STA_CLEAR_PS_FILT, 66 WLAN_STA_MFP, 67 WLAN_STA_BLOCK_BA, 68 WLAN_STA_PS_DRIVER, 69 WLAN_STA_PSPOLL, 70 WLAN_STA_TDLS_PEER, 71 WLAN_STA_TDLS_PEER_AUTH, 72 WLAN_STA_UAPSD, 73 WLAN_STA_SP, 74 }; 75 76 #define STA_TID_NUM 16 77 #define ADDBA_RESP_INTERVAL HZ 78 #define HT_AGG_MAX_RETRIES 0x3 79 80 #define HT_AGG_STATE_DRV_READY 0 81 #define HT_AGG_STATE_RESPONSE_RECEIVED 1 82 #define HT_AGG_STATE_OPERATIONAL 2 83 #define HT_AGG_STATE_STOPPING 3 84 #define HT_AGG_STATE_WANT_START 4 85 #define HT_AGG_STATE_WANT_STOP 5 86 87 /** 88 * struct tid_ampdu_tx - TID aggregation information (Tx). 89 * 90 * @rcu_head: rcu head for freeing structure 91 * @addba_resp_timer: timer for peer's response to addba request 92 * @pending: pending frames queue -- use sta's spinlock to protect 93 * @dialog_token: dialog token for aggregation session 94 * @timeout: session timeout value to be filled in ADDBA requests 95 * @state: session state (see above) 96 * @stop_initiator: initiator of a session stop 97 * @tx_stop: TX DelBA frame when stopping 98 * @buf_size: reorder buffer size at receiver 99 * @failed_bar_ssn: ssn of the last failed BAR tx attempt 100 * @bar_pending: BAR needs to be re-sent 101 * 102 * This structure's lifetime is managed by RCU, assignments to 103 * the array holding it must hold the aggregation mutex. 104 * 105 * The TX path can access it under RCU lock-free if, and 106 * only if, the state has the flag %HT_AGG_STATE_OPERATIONAL 107 * set. Otherwise, the TX path must also acquire the spinlock 108 * and re-check the state, see comments in the tx code 109 * touching it. 110 */ 111 struct tid_ampdu_tx { 112 struct rcu_head rcu_head; 113 struct timer_list addba_resp_timer; 114 struct sk_buff_head pending; 115 unsigned long state; 116 u16 timeout; 117 u8 dialog_token; 118 u8 stop_initiator; 119 bool tx_stop; 120 u8 buf_size; 121 122 u16 failed_bar_ssn; 123 bool bar_pending; 124 }; 125 126 /** 127 * struct tid_ampdu_rx - TID aggregation information (Rx). 128 * 129 * @reorder_buf: buffer to reorder incoming aggregated MPDUs 130 * @reorder_time: jiffies when skb was added 131 * @session_timer: check if peer keeps Tx-ing on the TID (by timeout value) 132 * @reorder_timer: releases expired frames from the reorder buffer. 133 * @head_seq_num: head sequence number in reordering buffer. 134 * @stored_mpdu_num: number of MPDUs in reordering buffer 135 * @ssn: Starting Sequence Number expected to be aggregated. 136 * @buf_size: buffer size for incoming A-MPDUs 137 * @timeout: reset timer value (in TUs). 138 * @dialog_token: dialog token for aggregation session 139 * @rcu_head: RCU head used for freeing this struct 140 * @reorder_lock: serializes access to reorder buffer, see below. 141 * 142 * This structure's lifetime is managed by RCU, assignments to 143 * the array holding it must hold the aggregation mutex. 144 * 145 * The @reorder_lock is used to protect the members of this 146 * struct, except for @timeout, @buf_size and @dialog_token, 147 * which are constant across the lifetime of the struct (the 148 * dialog token being used only for debugging). 149 */ 150 struct tid_ampdu_rx { 151 struct rcu_head rcu_head; 152 spinlock_t reorder_lock; 153 struct sk_buff **reorder_buf; 154 unsigned long *reorder_time; 155 struct timer_list session_timer; 156 struct timer_list reorder_timer; 157 u16 head_seq_num; 158 u16 stored_mpdu_num; 159 u16 ssn; 160 u16 buf_size; 161 u16 timeout; 162 u8 dialog_token; 163 }; 164 165 /** 166 * struct sta_ampdu_mlme - STA aggregation information. 167 * 168 * @tid_rx: aggregation info for Rx per TID -- RCU protected 169 * @tid_tx: aggregation info for Tx per TID 170 * @tid_start_tx: sessions where start was requested 171 * @addba_req_num: number of times addBA request has been sent. 172 * @dialog_token_allocator: dialog token enumerator for each new session; 173 * @work: work struct for starting/stopping aggregation 174 * @tid_rx_timer_expired: bitmap indicating on which TIDs the 175 * RX timer expired until the work for it runs 176 * @tid_rx_stop_requested: bitmap indicating which BA sessions per TID the 177 * driver requested to close until the work for it runs 178 * @mtx: mutex to protect all TX data (except non-NULL assignments 179 * to tid_tx[idx], which are protected by the sta spinlock) 180 */ 181 struct sta_ampdu_mlme { 182 struct mutex mtx; 183 /* rx */ 184 struct tid_ampdu_rx __rcu *tid_rx[STA_TID_NUM]; 185 unsigned long tid_rx_timer_expired[BITS_TO_LONGS(STA_TID_NUM)]; 186 unsigned long tid_rx_stop_requested[BITS_TO_LONGS(STA_TID_NUM)]; 187 /* tx */ 188 struct work_struct work; 189 struct tid_ampdu_tx __rcu *tid_tx[STA_TID_NUM]; 190 struct tid_ampdu_tx *tid_start_tx[STA_TID_NUM]; 191 u8 addba_req_num[STA_TID_NUM]; 192 u8 dialog_token_allocator; 193 }; 194 195 196 /** 197 * struct sta_info - STA information 198 * 199 * This structure collects information about a station that 200 * mac80211 is communicating with. 201 * 202 * @list: global linked list entry 203 * @hnext: hash table linked list pointer 204 * @local: pointer to the global information 205 * @sdata: virtual interface this station belongs to 206 * @ptk: peer key negotiated with this station, if any 207 * @gtk: group keys negotiated with this station, if any 208 * @rate_ctrl: rate control algorithm reference 209 * @rate_ctrl_priv: rate control private per-STA pointer 210 * @last_tx_rate: rate used for last transmit, to report to userspace as 211 * "the" transmit rate 212 * @last_rx_rate_idx: rx status rate index of the last data packet 213 * @last_rx_rate_flag: rx status flag of the last data packet 214 * @lock: used for locking all fields that require locking, see comments 215 * in the header file. 216 * @drv_unblock_wk: used for driver PS unblocking 217 * @listen_interval: listen interval of this station, when we're acting as AP 218 * @_flags: STA flags, see &enum ieee80211_sta_info_flags, do not use directly 219 * @ps_tx_buf: buffers (per AC) of frames to transmit to this station 220 * when it leaves power saving state or polls 221 * @tx_filtered: buffers (per AC) of frames we already tried to 222 * transmit but were filtered by hardware due to STA having 223 * entered power saving state, these are also delivered to 224 * the station when it leaves powersave or polls for frames 225 * @driver_buffered_tids: bitmap of TIDs the driver has data buffered on 226 * @rx_packets: Number of MSDUs received from this STA 227 * @rx_bytes: Number of bytes received from this STA 228 * @wep_weak_iv_count: number of weak WEP IVs received from this station 229 * @last_rx: time (in jiffies) when last frame was received from this STA 230 * @last_connected: time (in seconds) when a station got connected 231 * @num_duplicates: number of duplicate frames received from this STA 232 * @rx_fragments: number of received MPDUs 233 * @rx_dropped: number of dropped MPDUs from this STA 234 * @last_signal: signal of last received frame from this STA 235 * @avg_signal: moving average of signal of received frames from this STA 236 * @last_seq_ctrl: last received seq/frag number from this STA (per RX queue) 237 * @tx_filtered_count: number of frames the hardware filtered for this STA 238 * @tx_retry_failed: number of frames that failed retry 239 * @tx_retry_count: total number of retries for frames to this STA 240 * @fail_avg: moving percentage of failed MSDUs 241 * @tx_packets: number of RX/TX MSDUs 242 * @tx_bytes: number of bytes transmitted to this STA 243 * @tx_fragments: number of transmitted MPDUs 244 * @tid_seq: per-TID sequence numbers for sending to this STA 245 * @ampdu_mlme: A-MPDU state machine state 246 * @timer_to_tid: identity mapping to ID timers 247 * @llid: Local link ID 248 * @plid: Peer link ID 249 * @reason: Cancel reason on PLINK_HOLDING state 250 * @plink_retries: Retries in establishment 251 * @ignore_plink_timer: ignore the peer-link timer (used internally) 252 * @plink_state: peer link state 253 * @plink_timeout: timeout of peer link 254 * @plink_timer: peer link watch timer 255 * @plink_timer_was_running: used by suspend/resume to restore timers 256 * @debugfs: debug filesystem info 257 * @dead: set to true when sta is unlinked 258 * @uploaded: set to true when sta is uploaded to the driver 259 * @lost_packets: number of consecutive lost packets 260 * @dummy: indicate a dummy station created for receiving 261 * EAP frames before association 262 * @sta: station information we share with the driver 263 */ 264 struct sta_info { 265 /* General information, mostly static */ 266 struct list_head list; 267 struct sta_info __rcu *hnext; 268 struct ieee80211_local *local; 269 struct ieee80211_sub_if_data *sdata; 270 struct ieee80211_key __rcu *gtk[NUM_DEFAULT_KEYS + NUM_DEFAULT_MGMT_KEYS]; 271 struct ieee80211_key __rcu *ptk; 272 struct rate_control_ref *rate_ctrl; 273 void *rate_ctrl_priv; 274 spinlock_t lock; 275 276 struct work_struct drv_unblock_wk; 277 278 u16 listen_interval; 279 280 bool dead; 281 282 bool uploaded; 283 284 /* use the accessors defined below */ 285 unsigned long _flags; 286 287 /* 288 * STA powersave frame queues, no more than the internal 289 * locking required. 290 */ 291 struct sk_buff_head ps_tx_buf[IEEE80211_NUM_ACS]; 292 struct sk_buff_head tx_filtered[IEEE80211_NUM_ACS]; 293 unsigned long driver_buffered_tids; 294 295 /* Updated from RX path only, no locking requirements */ 296 unsigned long rx_packets, rx_bytes; 297 unsigned long wep_weak_iv_count; 298 unsigned long last_rx; 299 long last_connected; 300 unsigned long num_duplicates; 301 unsigned long rx_fragments; 302 unsigned long rx_dropped; 303 int last_signal; 304 struct ewma avg_signal; 305 /* Plus 1 for non-QoS frames */ 306 __le16 last_seq_ctrl[NUM_RX_DATA_QUEUES + 1]; 307 308 /* Updated from TX status path only, no locking requirements */ 309 unsigned long tx_filtered_count; 310 unsigned long tx_retry_failed, tx_retry_count; 311 /* moving percentage of failed MSDUs */ 312 unsigned int fail_avg; 313 314 /* Updated from TX path only, no locking requirements */ 315 unsigned long tx_packets; 316 unsigned long tx_bytes; 317 unsigned long tx_fragments; 318 struct ieee80211_tx_rate last_tx_rate; 319 int last_rx_rate_idx; 320 int last_rx_rate_flag; 321 u16 tid_seq[IEEE80211_QOS_CTL_TID_MASK + 1]; 322 323 /* 324 * Aggregation information, locked with lock. 325 */ 326 struct sta_ampdu_mlme ampdu_mlme; 327 u8 timer_to_tid[STA_TID_NUM]; 328 329 #ifdef CONFIG_MAC80211_MESH 330 /* 331 * Mesh peer link attributes 332 * TODO: move to a sub-structure that is referenced with pointer? 333 */ 334 __le16 llid; 335 __le16 plid; 336 __le16 reason; 337 u8 plink_retries; 338 bool ignore_plink_timer; 339 bool plink_timer_was_running; 340 enum nl80211_plink_state plink_state; 341 u32 plink_timeout; 342 struct timer_list plink_timer; 343 #endif 344 345 #ifdef CONFIG_MAC80211_DEBUGFS 346 struct sta_info_debugfsdentries { 347 struct dentry *dir; 348 bool add_has_run; 349 } debugfs; 350 #endif 351 352 unsigned int lost_packets; 353 354 /* should be right in front of sta to be in the same cache line */ 355 bool dummy; 356 357 /* keep last! */ 358 struct ieee80211_sta sta; 359 }; 360 361 static inline enum nl80211_plink_state sta_plink_state(struct sta_info *sta) 362 { 363 #ifdef CONFIG_MAC80211_MESH 364 return sta->plink_state; 365 #endif 366 return NL80211_PLINK_LISTEN; 367 } 368 369 static inline void set_sta_flag(struct sta_info *sta, 370 enum ieee80211_sta_info_flags flag) 371 { 372 set_bit(flag, &sta->_flags); 373 } 374 375 static inline void clear_sta_flag(struct sta_info *sta, 376 enum ieee80211_sta_info_flags flag) 377 { 378 clear_bit(flag, &sta->_flags); 379 } 380 381 static inline int test_sta_flag(struct sta_info *sta, 382 enum ieee80211_sta_info_flags flag) 383 { 384 return test_bit(flag, &sta->_flags); 385 } 386 387 static inline int test_and_clear_sta_flag(struct sta_info *sta, 388 enum ieee80211_sta_info_flags flag) 389 { 390 return test_and_clear_bit(flag, &sta->_flags); 391 } 392 393 void ieee80211_assign_tid_tx(struct sta_info *sta, int tid, 394 struct tid_ampdu_tx *tid_tx); 395 396 static inline struct tid_ampdu_tx * 397 rcu_dereference_protected_tid_tx(struct sta_info *sta, int tid) 398 { 399 return rcu_dereference_protected(sta->ampdu_mlme.tid_tx[tid], 400 lockdep_is_held(&sta->lock) || 401 lockdep_is_held(&sta->ampdu_mlme.mtx)); 402 } 403 404 #define STA_HASH_SIZE 256 405 #define STA_HASH(sta) (sta[5]) 406 407 408 /* Maximum number of frames to buffer per power saving station per AC */ 409 #define STA_MAX_TX_BUFFER 64 410 411 /* Minimum buffered frame expiry time. If STA uses listen interval that is 412 * smaller than this value, the minimum value here is used instead. */ 413 #define STA_TX_BUFFER_EXPIRE (10 * HZ) 414 415 /* How often station data is cleaned up (e.g., expiration of buffered frames) 416 */ 417 #define STA_INFO_CLEANUP_INTERVAL (10 * HZ) 418 419 /* 420 * Get a STA info, must be under RCU read lock. 421 */ 422 struct sta_info *sta_info_get(struct ieee80211_sub_if_data *sdata, 423 const u8 *addr); 424 425 struct sta_info *sta_info_get_rx(struct ieee80211_sub_if_data *sdata, 426 const u8 *addr); 427 428 struct sta_info *sta_info_get_bss(struct ieee80211_sub_if_data *sdata, 429 const u8 *addr); 430 431 struct sta_info *sta_info_get_bss_rx(struct ieee80211_sub_if_data *sdata, 432 const u8 *addr); 433 434 static inline 435 void for_each_sta_info_type_check(struct ieee80211_local *local, 436 const u8 *addr, 437 struct sta_info *sta, 438 struct sta_info *nxt) 439 { 440 } 441 442 #define for_each_sta_info(local, _addr, _sta, nxt) \ 443 for ( /* initialise loop */ \ 444 _sta = rcu_dereference(local->sta_hash[STA_HASH(_addr)]),\ 445 nxt = _sta ? rcu_dereference(_sta->hnext) : NULL; \ 446 /* typecheck */ \ 447 for_each_sta_info_type_check(local, (_addr), _sta, nxt),\ 448 /* continue condition */ \ 449 _sta; \ 450 /* advance loop */ \ 451 _sta = nxt, \ 452 nxt = _sta ? rcu_dereference(_sta->hnext) : NULL \ 453 ) \ 454 /* run code only if address matches and it's not a dummy sta */ \ 455 if (memcmp(_sta->sta.addr, (_addr), ETH_ALEN) == 0 && \ 456 !_sta->dummy) 457 458 #define for_each_sta_info_rx(local, _addr, _sta, nxt) \ 459 for ( /* initialise loop */ \ 460 _sta = rcu_dereference(local->sta_hash[STA_HASH(_addr)]),\ 461 nxt = _sta ? rcu_dereference(_sta->hnext) : NULL; \ 462 /* typecheck */ \ 463 for_each_sta_info_type_check(local, (_addr), _sta, nxt),\ 464 /* continue condition */ \ 465 _sta; \ 466 /* advance loop */ \ 467 _sta = nxt, \ 468 nxt = _sta ? rcu_dereference(_sta->hnext) : NULL \ 469 ) \ 470 /* compare address and run code only if it matches */ \ 471 if (memcmp(_sta->sta.addr, (_addr), ETH_ALEN) == 0) 472 473 /* 474 * Get STA info by index, BROKEN! 475 */ 476 struct sta_info *sta_info_get_by_idx(struct ieee80211_sub_if_data *sdata, 477 int idx); 478 /* 479 * Create a new STA info, caller owns returned structure 480 * until sta_info_insert(). 481 */ 482 struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata, 483 u8 *addr, gfp_t gfp); 484 /* 485 * Insert STA info into hash table/list, returns zero or a 486 * -EEXIST if (if the same MAC address is already present). 487 * 488 * Calling the non-rcu version makes the caller relinquish, 489 * the _rcu version calls read_lock_rcu() and must be called 490 * without it held. 491 */ 492 int sta_info_insert(struct sta_info *sta); 493 int sta_info_insert_rcu(struct sta_info *sta) __acquires(RCU); 494 int sta_info_insert_atomic(struct sta_info *sta); 495 int sta_info_reinsert(struct sta_info *sta); 496 497 int sta_info_destroy_addr(struct ieee80211_sub_if_data *sdata, 498 const u8 *addr); 499 int sta_info_destroy_addr_bss(struct ieee80211_sub_if_data *sdata, 500 const u8 *addr); 501 502 void sta_info_recalc_tim(struct sta_info *sta); 503 504 void sta_info_init(struct ieee80211_local *local); 505 void sta_info_stop(struct ieee80211_local *local); 506 int sta_info_flush(struct ieee80211_local *local, 507 struct ieee80211_sub_if_data *sdata); 508 void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata, 509 unsigned long exp_time); 510 511 void ieee80211_sta_ps_deliver_wakeup(struct sta_info *sta); 512 void ieee80211_sta_ps_deliver_poll_response(struct sta_info *sta); 513 void ieee80211_sta_ps_deliver_uapsd(struct sta_info *sta); 514 515 #endif /* STA_INFO_H */ 516