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