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