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 "key.h" 17 18 /** 19 * enum ieee80211_sta_info_flags - Stations flags 20 * 21 * These flags are used with &struct sta_info's @flags member. 22 * 23 * @WLAN_STA_AUTH: Station is authenticated. 24 * @WLAN_STA_ASSOC: Station is associated. 25 * @WLAN_STA_PS_STA: Station is in power-save mode 26 * @WLAN_STA_AUTHORIZED: Station is authorized to send/receive traffic. 27 * This bit is always checked so needs to be enabled for all stations 28 * when virtual port control is not in use. 29 * @WLAN_STA_SHORT_PREAMBLE: Station is capable of receiving short-preamble 30 * frames. 31 * @WLAN_STA_ASSOC_AP: We're associated to that station, it is an AP. 32 * @WLAN_STA_WME: Station is a QoS-STA. 33 * @WLAN_STA_WDS: Station is one of our WDS peers. 34 * @WLAN_STA_CLEAR_PS_FILT: Clear PS filter in hardware (using the 35 * IEEE80211_TX_CTL_CLEAR_PS_FILT control flag) when the next 36 * frame to this station is transmitted. 37 * @WLAN_STA_MFP: Management frame protection is used with this STA. 38 * @WLAN_STA_SUSPEND: Set/cleared during a suspend/resume cycle. 39 * Used to deny ADDBA requests (both TX and RX). 40 * @WLAN_STA_PS_DRIVER: driver requires keeping this station in 41 * power-save mode logically to flush frames that might still 42 * be in the queues 43 * @WLAN_STA_PSPOLL: Station sent PS-poll while driver was keeping 44 * station in power-save mode, reply when the driver unblocks. 45 */ 46 enum ieee80211_sta_info_flags { 47 WLAN_STA_AUTH = 1<<0, 48 WLAN_STA_ASSOC = 1<<1, 49 WLAN_STA_PS_STA = 1<<2, 50 WLAN_STA_AUTHORIZED = 1<<3, 51 WLAN_STA_SHORT_PREAMBLE = 1<<4, 52 WLAN_STA_ASSOC_AP = 1<<5, 53 WLAN_STA_WME = 1<<6, 54 WLAN_STA_WDS = 1<<7, 55 WLAN_STA_CLEAR_PS_FILT = 1<<9, 56 WLAN_STA_MFP = 1<<10, 57 WLAN_STA_SUSPEND = 1<<11, 58 WLAN_STA_PS_DRIVER = 1<<12, 59 WLAN_STA_PSPOLL = 1<<13, 60 }; 61 62 #define STA_TID_NUM 16 63 #define ADDBA_RESP_INTERVAL HZ 64 #define HT_AGG_MAX_RETRIES (0x3) 65 66 #define HT_AGG_STATE_INITIATOR_SHIFT (4) 67 68 #define HT_ADDBA_REQUESTED_MSK BIT(0) 69 #define HT_ADDBA_DRV_READY_MSK BIT(1) 70 #define HT_ADDBA_RECEIVED_MSK BIT(2) 71 #define HT_AGG_STATE_REQ_STOP_BA_MSK BIT(3) 72 #define HT_AGG_STATE_INITIATOR_MSK BIT(HT_AGG_STATE_INITIATOR_SHIFT) 73 #define HT_AGG_STATE_IDLE (0x0) 74 #define HT_AGG_STATE_OPERATIONAL (HT_ADDBA_REQUESTED_MSK | \ 75 HT_ADDBA_DRV_READY_MSK | \ 76 HT_ADDBA_RECEIVED_MSK) 77 78 /** 79 * struct tid_ampdu_tx - TID aggregation information (Tx). 80 * 81 * @addba_resp_timer: timer for peer's response to addba request 82 * @pending: pending frames queue -- use sta's spinlock to protect 83 * @ssn: Starting Sequence Number expected to be aggregated. 84 * @dialog_token: dialog token for aggregation session 85 */ 86 struct tid_ampdu_tx { 87 struct timer_list addba_resp_timer; 88 struct sk_buff_head pending; 89 u16 ssn; 90 u8 dialog_token; 91 }; 92 93 /** 94 * struct tid_ampdu_rx - TID aggregation information (Rx). 95 * 96 * @reorder_buf: buffer to reorder incoming aggregated MPDUs 97 * @reorder_time: jiffies when skb was added 98 * @session_timer: check if peer keeps Tx-ing on the TID (by timeout value) 99 * @head_seq_num: head sequence number in reordering buffer. 100 * @stored_mpdu_num: number of MPDUs in reordering buffer 101 * @ssn: Starting Sequence Number expected to be aggregated. 102 * @buf_size: buffer size for incoming A-MPDUs 103 * @timeout: reset timer value (in TUs). 104 * @dialog_token: dialog token for aggregation session 105 * @shutdown: this session is being shut down due to STA removal 106 */ 107 struct tid_ampdu_rx { 108 struct sk_buff **reorder_buf; 109 unsigned long *reorder_time; 110 struct timer_list session_timer; 111 u16 head_seq_num; 112 u16 stored_mpdu_num; 113 u16 ssn; 114 u16 buf_size; 115 u16 timeout; 116 u8 dialog_token; 117 bool shutdown; 118 }; 119 120 /** 121 * enum plink_state - state of a mesh peer link finite state machine 122 * 123 * @PLINK_LISTEN: initial state, considered the implicit state of non existant 124 * mesh peer links 125 * @PLINK_OPN_SNT: mesh plink open frame has been sent to this mesh peer 126 * @PLINK_OPN_RCVD: mesh plink open frame has been received from this mesh peer 127 * @PLINK_CNF_RCVD: mesh plink confirm frame has been received from this mesh 128 * peer 129 * @PLINK_ESTAB: mesh peer link is established 130 * @PLINK_HOLDING: mesh peer link is being closed or cancelled 131 * @PLINK_BLOCKED: all frames transmitted from this mesh plink are discarded 132 */ 133 enum plink_state { 134 PLINK_LISTEN, 135 PLINK_OPN_SNT, 136 PLINK_OPN_RCVD, 137 PLINK_CNF_RCVD, 138 PLINK_ESTAB, 139 PLINK_HOLDING, 140 PLINK_BLOCKED 141 }; 142 143 /** 144 * struct sta_ampdu_mlme - STA aggregation information. 145 * 146 * @tid_state_rx: TID's state in Rx session state machine. 147 * @tid_rx: aggregation info for Rx per TID 148 * @tid_state_tx: TID's state in Tx session state machine. 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 */ 153 struct sta_ampdu_mlme { 154 /* rx */ 155 u8 tid_state_rx[STA_TID_NUM]; 156 struct tid_ampdu_rx *tid_rx[STA_TID_NUM]; 157 /* tx */ 158 u8 tid_state_tx[STA_TID_NUM]; 159 struct tid_ampdu_tx *tid_tx[STA_TID_NUM]; 160 u8 addba_req_num[STA_TID_NUM]; 161 u8 dialog_token_allocator; 162 }; 163 164 165 /* see __sta_info_unlink */ 166 #define STA_INFO_PIN_STAT_NORMAL 0 167 #define STA_INFO_PIN_STAT_PINNED 1 168 #define STA_INFO_PIN_STAT_DESTROY 2 169 170 /** 171 * struct sta_info - STA information 172 * 173 * This structure collects information about a station that 174 * mac80211 is communicating with. 175 * 176 * @list: global linked list entry 177 * @hnext: hash table linked list pointer 178 * @local: pointer to the global information 179 * @sdata: virtual interface this station belongs to 180 * @key: peer key negotiated with this station, if any 181 * @rate_ctrl: rate control algorithm reference 182 * @rate_ctrl_priv: rate control private per-STA pointer 183 * @last_tx_rate: rate used for last transmit, to report to userspace as 184 * "the" transmit rate 185 * @lock: used for locking all fields that require locking, see comments 186 * in the header file. 187 * @flaglock: spinlock for flags accesses 188 * @drv_unblock_wk: used for driver PS unblocking 189 * @listen_interval: listen interval of this station, when we're acting as AP 190 * @pin_status: used internally for pinning a STA struct into memory 191 * @flags: STA flags, see &enum ieee80211_sta_info_flags 192 * @ps_tx_buf: buffer of frames to transmit to this station 193 * when it leaves power saving state 194 * @tx_filtered: buffer of frames we already tried to transmit 195 * but were filtered by hardware due to STA having entered 196 * power saving state 197 * @rx_packets: Number of MSDUs received from this STA 198 * @rx_bytes: Number of bytes received from this STA 199 * @wep_weak_iv_count: number of weak WEP IVs received from this station 200 * @last_rx: time (in jiffies) when last frame was received from this STA 201 * @num_duplicates: number of duplicate frames received from this STA 202 * @rx_fragments: number of received MPDUs 203 * @rx_dropped: number of dropped MPDUs from this STA 204 * @last_signal: signal of last received frame from this STA 205 * @last_noise: noise of last received frame from this STA 206 * @last_seq_ctrl: last received seq/frag number from this STA (per RX queue) 207 * @tx_filtered_count: number of frames the hardware filtered for this STA 208 * @tx_retry_failed: number of frames that failed retry 209 * @tx_retry_count: total number of retries for frames to this STA 210 * @fail_avg: moving percentage of failed MSDUs 211 * @tx_packets: number of RX/TX MSDUs 212 * @tx_bytes: number of bytes transmitted to this STA 213 * @tx_fragments: number of transmitted MPDUs 214 * @tid_seq: per-TID sequence numbers for sending to this STA 215 * @ampdu_mlme: A-MPDU state machine state 216 * @timer_to_tid: identity mapping to ID timers 217 * @llid: Local link ID 218 * @plid: Peer link ID 219 * @reason: Cancel reason on PLINK_HOLDING state 220 * @plink_retries: Retries in establishment 221 * @ignore_plink_timer: ignore the peer-link timer (used internally) 222 * @plink_state: peer link state 223 * @plink_timeout: timeout of peer link 224 * @plink_timer: peer link watch timer 225 * @plink_timer_was_running: used by suspend/resume to restore timers 226 * @debugfs: debug filesystem info 227 * @sta: station information we share with the driver 228 * @dead: set to true when sta is unlinked 229 */ 230 struct sta_info { 231 /* General information, mostly static */ 232 struct list_head list; 233 struct sta_info *hnext; 234 struct ieee80211_local *local; 235 struct ieee80211_sub_if_data *sdata; 236 struct ieee80211_key *key; 237 struct rate_control_ref *rate_ctrl; 238 void *rate_ctrl_priv; 239 spinlock_t lock; 240 spinlock_t flaglock; 241 242 struct work_struct drv_unblock_wk; 243 244 u16 listen_interval; 245 246 bool dead; 247 248 /* 249 * for use by the internal lifetime management, 250 * see __sta_info_unlink 251 */ 252 u8 pin_status; 253 254 /* 255 * frequently updated, locked with own spinlock (flaglock), 256 * use the accessors defined below 257 */ 258 u32 flags; 259 260 /* 261 * STA powersave frame queues, no more than the internal 262 * locking required. 263 */ 264 struct sk_buff_head ps_tx_buf; 265 struct sk_buff_head tx_filtered; 266 267 /* Updated from RX path only, no locking requirements */ 268 unsigned long rx_packets, rx_bytes; 269 unsigned long wep_weak_iv_count; 270 unsigned long last_rx; 271 unsigned long num_duplicates; 272 unsigned long rx_fragments; 273 unsigned long rx_dropped; 274 int last_signal; 275 int last_noise; 276 __le16 last_seq_ctrl[NUM_RX_DATA_QUEUES]; 277 278 /* Updated from TX status path only, no locking requirements */ 279 unsigned long tx_filtered_count; 280 unsigned long tx_retry_failed, tx_retry_count; 281 /* moving percentage of failed MSDUs */ 282 unsigned int fail_avg; 283 284 /* Updated from TX path only, no locking requirements */ 285 unsigned long tx_packets; 286 unsigned long tx_bytes; 287 unsigned long tx_fragments; 288 struct ieee80211_tx_rate last_tx_rate; 289 u16 tid_seq[IEEE80211_QOS_CTL_TID_MASK + 1]; 290 291 /* 292 * Aggregation information, locked with lock. 293 */ 294 struct sta_ampdu_mlme ampdu_mlme; 295 u8 timer_to_tid[STA_TID_NUM]; 296 297 #ifdef CONFIG_MAC80211_MESH 298 /* 299 * Mesh peer link attributes 300 * TODO: move to a sub-structure that is referenced with pointer? 301 */ 302 __le16 llid; 303 __le16 plid; 304 __le16 reason; 305 u8 plink_retries; 306 bool ignore_plink_timer; 307 bool plink_timer_was_running; 308 enum plink_state plink_state; 309 u32 plink_timeout; 310 struct timer_list plink_timer; 311 #endif 312 313 #ifdef CONFIG_MAC80211_DEBUGFS 314 struct sta_info_debugfsdentries { 315 struct dentry *dir; 316 bool add_has_run; 317 } debugfs; 318 #endif 319 320 /* keep last! */ 321 struct ieee80211_sta sta; 322 }; 323 324 static inline enum plink_state sta_plink_state(struct sta_info *sta) 325 { 326 #ifdef CONFIG_MAC80211_MESH 327 return sta->plink_state; 328 #endif 329 return PLINK_LISTEN; 330 } 331 332 static inline void set_sta_flags(struct sta_info *sta, const u32 flags) 333 { 334 unsigned long irqfl; 335 336 spin_lock_irqsave(&sta->flaglock, irqfl); 337 sta->flags |= flags; 338 spin_unlock_irqrestore(&sta->flaglock, irqfl); 339 } 340 341 static inline void clear_sta_flags(struct sta_info *sta, const u32 flags) 342 { 343 unsigned long irqfl; 344 345 spin_lock_irqsave(&sta->flaglock, irqfl); 346 sta->flags &= ~flags; 347 spin_unlock_irqrestore(&sta->flaglock, irqfl); 348 } 349 350 static inline u32 test_sta_flags(struct sta_info *sta, const u32 flags) 351 { 352 u32 ret; 353 unsigned long irqfl; 354 355 spin_lock_irqsave(&sta->flaglock, irqfl); 356 ret = sta->flags & flags; 357 spin_unlock_irqrestore(&sta->flaglock, irqfl); 358 359 return ret; 360 } 361 362 static inline u32 test_and_clear_sta_flags(struct sta_info *sta, 363 const u32 flags) 364 { 365 u32 ret; 366 unsigned long irqfl; 367 368 spin_lock_irqsave(&sta->flaglock, irqfl); 369 ret = sta->flags & flags; 370 sta->flags &= ~flags; 371 spin_unlock_irqrestore(&sta->flaglock, irqfl); 372 373 return ret; 374 } 375 376 static inline u32 get_sta_flags(struct sta_info *sta) 377 { 378 u32 ret; 379 unsigned long irqfl; 380 381 spin_lock_irqsave(&sta->flaglock, irqfl); 382 ret = sta->flags; 383 spin_unlock_irqrestore(&sta->flaglock, irqfl); 384 385 return ret; 386 } 387 388 389 390 #define STA_HASH_SIZE 256 391 #define STA_HASH(sta) (sta[5]) 392 393 394 /* Maximum number of frames to buffer per power saving station */ 395 #define STA_MAX_TX_BUFFER 128 396 397 /* Minimum buffered frame expiry time. If STA uses listen interval that is 398 * smaller than this value, the minimum value here is used instead. */ 399 #define STA_TX_BUFFER_EXPIRE (10 * HZ) 400 401 /* How often station data is cleaned up (e.g., expiration of buffered frames) 402 */ 403 #define STA_INFO_CLEANUP_INTERVAL (10 * HZ) 404 405 /* 406 * Get a STA info, must have be under RCU read lock. 407 */ 408 struct sta_info *sta_info_get(struct ieee80211_local *local, const u8 *addr); 409 /* 410 * Get STA info by index, BROKEN! 411 */ 412 struct sta_info *sta_info_get_by_idx(struct ieee80211_sub_if_data *sdata, 413 int idx); 414 /* 415 * Create a new STA info, caller owns returned structure 416 * until sta_info_insert(). 417 */ 418 struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata, 419 u8 *addr, gfp_t gfp); 420 /* 421 * Insert STA info into hash table/list, returns zero or a 422 * -EEXIST if (if the same MAC address is already present). 423 * 424 * Calling this without RCU protection makes the caller 425 * relinquish its reference to @sta. 426 */ 427 int sta_info_insert(struct sta_info *sta); 428 /* 429 * Unlink a STA info from the hash table/list. 430 * This can NULL the STA pointer if somebody else 431 * has already unlinked it. 432 */ 433 void sta_info_unlink(struct sta_info **sta); 434 435 void sta_info_destroy(struct sta_info *sta); 436 void sta_info_set_tim_bit(struct sta_info *sta); 437 void sta_info_clear_tim_bit(struct sta_info *sta); 438 439 void sta_info_init(struct ieee80211_local *local); 440 int sta_info_start(struct ieee80211_local *local); 441 void sta_info_stop(struct ieee80211_local *local); 442 int sta_info_flush(struct ieee80211_local *local, 443 struct ieee80211_sub_if_data *sdata); 444 void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata, 445 unsigned long exp_time); 446 447 void ieee80211_sta_ps_deliver_wakeup(struct sta_info *sta); 448 void ieee80211_sta_ps_deliver_poll_response(struct sta_info *sta); 449 450 #endif /* STA_INFO_H */ 451