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