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