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