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