2 * Copyright 2002-2005, Devicescape Software, Inc.
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.
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>
20 * enum ieee80211_sta_info_flags - Stations flags
22 * These flags are used with &struct sta_info's @flags member, but
23 * only indirectly with set_sta_flag() and friends.
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
33 * @WLAN_STA_ASSOC_AP: We're associated to that station, it is an AP.
34 * @WLAN_STA_WME: Station is a QoS-STA.
35 * @WLAN_STA_WDS: Station is one of our WDS peers.
36 * @WLAN_STA_CLEAR_PS_FILT: Clear PS filter in hardware (using the
37 * IEEE80211_TX_CTL_CLEAR_PS_FILT control flag) when the next
38 * frame to this station is transmitted.
39 * @WLAN_STA_MFP: Management frame protection is used with this STA.
40 * @WLAN_STA_BLOCK_BA: Used to deny ADDBA requests (both TX and RX)
41 * during suspend/resume and station removal.
42 * @WLAN_STA_PS_DRIVER: driver requires keeping this station in
43 * power-save mode logically to flush frames that might still
45 * @WLAN_STA_PSPOLL: Station sent PS-poll while driver was keeping
46 * station in power-save mode, reply when the driver unblocks.
47 * @WLAN_STA_TDLS_PEER: Station is a TDLS peer.
48 * @WLAN_STA_TDLS_PEER_AUTH: This TDLS peer is authorized to send direct
49 * packets. This means the link is enabled.
50 * @WLAN_STA_UAPSD: Station requested unscheduled SP while driver was
51 * keeping station in power-save mode, reply when the driver
52 * unblocks the station.
53 * @WLAN_STA_SP: Station is in a service period, so don't try to
54 * reply to other uAPSD trigger frames or PS-Poll.
56 enum ieee80211_sta_info_flags {
61 WLAN_STA_SHORT_PREAMBLE,
65 WLAN_STA_CLEAR_PS_FILT,
71 WLAN_STA_TDLS_PEER_AUTH,
76 #define STA_TID_NUM 16
77 #define ADDBA_RESP_INTERVAL HZ
78 #define HT_AGG_MAX_RETRIES 0x3
80 #define HT_AGG_STATE_DRV_READY 0
81 #define HT_AGG_STATE_RESPONSE_RECEIVED 1
82 #define HT_AGG_STATE_OPERATIONAL 2
83 #define HT_AGG_STATE_STOPPING 3
84 #define HT_AGG_STATE_WANT_START 4
85 #define HT_AGG_STATE_WANT_STOP 5
88 * struct tid_ampdu_tx - TID aggregation information (Tx).
90 * @rcu_head: rcu head for freeing structure
91 * @addba_resp_timer: timer for peer's response to addba request
92 * @pending: pending frames queue -- use sta's spinlock to protect
93 * @dialog_token: dialog token for aggregation session
94 * @timeout: session timeout value to be filled in ADDBA requests
95 * @state: session state (see above)
96 * @stop_initiator: initiator of a session stop
97 * @tx_stop: TX DelBA frame when stopping
98 * @buf_size: reorder buffer size at receiver
99 * @failed_bar_ssn: ssn of the last failed BAR tx attempt
100 * @bar_pending: BAR needs to be re-sent
102 * This structure's lifetime is managed by RCU, assignments to
103 * the array holding it must hold the aggregation mutex.
105 * The TX path can access it under RCU lock-free if, and
106 * only if, the state has the flag %HT_AGG_STATE_OPERATIONAL
107 * set. Otherwise, the TX path must also acquire the spinlock
108 * and re-check the state, see comments in the tx code
111 struct tid_ampdu_tx {
112 struct rcu_head rcu_head;
113 struct timer_list addba_resp_timer;
114 struct sk_buff_head pending;
127 * struct tid_ampdu_rx - TID aggregation information (Rx).
129 * @reorder_buf: buffer to reorder incoming aggregated MPDUs
130 * @reorder_time: jiffies when skb was added
131 * @session_timer: check if peer keeps Tx-ing on the TID (by timeout value)
132 * @reorder_timer: releases expired frames from the reorder buffer.
133 * @head_seq_num: head sequence number in reordering buffer.
134 * @stored_mpdu_num: number of MPDUs in reordering buffer
135 * @ssn: Starting Sequence Number expected to be aggregated.
136 * @buf_size: buffer size for incoming A-MPDUs
137 * @timeout: reset timer value (in TUs).
138 * @dialog_token: dialog token for aggregation session
139 * @rcu_head: RCU head used for freeing this struct
140 * @reorder_lock: serializes access to reorder buffer, see below.
141 * @removed: this session is removed (but might have been found due to RCU)
143 * This structure's lifetime is managed by RCU, assignments to
144 * the array holding it must hold the aggregation mutex.
146 * The @reorder_lock is used to protect the members of this
147 * struct, except for @timeout, @buf_size and @dialog_token,
148 * which are constant across the lifetime of the struct (the
149 * dialog token being used only for debugging).
151 struct tid_ampdu_rx {
152 struct rcu_head rcu_head;
153 spinlock_t reorder_lock;
154 struct sk_buff **reorder_buf;
155 unsigned long *reorder_time;
156 struct timer_list session_timer;
157 struct timer_list reorder_timer;
168 * struct sta_ampdu_mlme - STA aggregation information.
170 * @tid_rx: aggregation info for Rx per TID -- RCU protected
171 * @tid_tx: aggregation info for Tx per TID
172 * @tid_start_tx: sessions where start was requested
173 * @addba_req_num: number of times addBA request has been sent.
174 * @dialog_token_allocator: dialog token enumerator for each new session;
175 * @work: work struct for starting/stopping aggregation
176 * @tid_rx_timer_expired: bitmap indicating on which TIDs the
177 * RX timer expired until the work for it runs
178 * @tid_rx_stop_requested: bitmap indicating which BA sessions per TID the
179 * driver requested to close until the work for it runs
180 * @mtx: mutex to protect all TX data (except non-NULL assignments
181 * to tid_tx[idx], which are protected by the sta spinlock)
183 struct sta_ampdu_mlme {
186 struct tid_ampdu_rx __rcu *tid_rx[STA_TID_NUM];
187 unsigned long tid_rx_timer_expired[BITS_TO_LONGS(STA_TID_NUM)];
188 unsigned long tid_rx_stop_requested[BITS_TO_LONGS(STA_TID_NUM)];
190 struct work_struct work;
191 struct tid_ampdu_tx __rcu *tid_tx[STA_TID_NUM];
192 struct tid_ampdu_tx *tid_start_tx[STA_TID_NUM];
193 u8 addba_req_num[STA_TID_NUM];
194 u8 dialog_token_allocator;
199 * struct sta_info - STA information
201 * This structure collects information about a station that
202 * mac80211 is communicating with.
204 * @list: global linked list entry
205 * @hnext: hash table linked list pointer
206 * @local: pointer to the global information
207 * @sdata: virtual interface this station belongs to
208 * @ptk: peer key negotiated with this station, if any
209 * @gtk: group keys negotiated with this station, if any
210 * @rate_ctrl: rate control algorithm reference
211 * @rate_ctrl_priv: rate control private per-STA pointer
212 * @last_tx_rate: rate used for last transmit, to report to userspace as
213 * "the" transmit rate
214 * @last_rx_rate_idx: rx status rate index of the last data packet
215 * @last_rx_rate_flag: rx status flag of the last data packet
216 * @lock: used for locking all fields that require locking, see comments
217 * in the header file.
218 * @drv_unblock_wk: used for driver PS unblocking
219 * @listen_interval: listen interval of this station, when we're acting as AP
220 * @_flags: STA flags, see &enum ieee80211_sta_info_flags, do not use directly
221 * @ps_lock: used for powersave (when mac80211 is the AP) related locking
222 * @ps_tx_buf: buffers (per AC) of frames to transmit to this station
223 * when it leaves power saving state or polls
224 * @tx_filtered: buffers (per AC) of frames we already tried to
225 * transmit but were filtered by hardware due to STA having
226 * entered power saving state, these are also delivered to
227 * the station when it leaves powersave or polls for frames
228 * @driver_buffered_tids: bitmap of TIDs the driver has data buffered on
229 * @rx_packets: Number of MSDUs received from this STA
230 * @rx_bytes: Number of bytes received from this STA
231 * @wep_weak_iv_count: number of weak WEP IVs received from this station
232 * @last_rx: time (in jiffies) when last frame was received from this STA
233 * @last_connected: time (in seconds) when a station got connected
234 * @num_duplicates: number of duplicate frames received from this STA
235 * @rx_fragments: number of received MPDUs
236 * @rx_dropped: number of dropped MPDUs from this STA
237 * @last_signal: signal of last received frame from this STA
238 * @avg_signal: moving average of signal of received frames from this STA
239 * @last_seq_ctrl: last received seq/frag number from this STA (per RX queue)
240 * @tx_filtered_count: number of frames the hardware filtered for this STA
241 * @tx_retry_failed: number of frames that failed retry
242 * @tx_retry_count: total number of retries for frames to this STA
243 * @fail_avg: moving percentage of failed MSDUs
244 * @tx_packets: number of RX/TX MSDUs
245 * @tx_bytes: number of bytes transmitted to this STA
246 * @tx_fragments: number of transmitted MPDUs
247 * @tid_seq: per-TID sequence numbers for sending to this STA
248 * @ampdu_mlme: A-MPDU state machine state
249 * @timer_to_tid: identity mapping to ID timers
250 * @llid: Local link ID
251 * @plid: Peer link ID
252 * @reason: Cancel reason on PLINK_HOLDING state
253 * @plink_retries: Retries in establishment
254 * @ignore_plink_timer: ignore the peer-link timer (used internally)
255 * @plink_state: peer link state
256 * @plink_timeout: timeout of peer link
257 * @plink_timer: peer link watch timer
258 * @plink_timer_was_running: used by suspend/resume to restore timers
259 * @debugfs: debug filesystem info
260 * @dead: set to true when sta is unlinked
261 * @uploaded: set to true when sta is uploaded to the driver
262 * @lost_packets: number of consecutive lost packets
263 * @dummy: indicate a dummy station created for receiving
264 * EAP frames before association
265 * @sta: station information we share with the driver
268 /* General information, mostly static */
269 struct list_head list;
270 struct sta_info __rcu *hnext;
271 struct ieee80211_local *local;
272 struct ieee80211_sub_if_data *sdata;
273 struct ieee80211_key __rcu *gtk[NUM_DEFAULT_KEYS + NUM_DEFAULT_MGMT_KEYS];
274 struct ieee80211_key __rcu *ptk;
275 struct rate_control_ref *rate_ctrl;
276 void *rate_ctrl_priv;
279 struct work_struct drv_unblock_wk;
287 /* use the accessors defined below */
288 unsigned long _flags;
290 /* STA powersave lock and frame queues */
292 struct sk_buff_head ps_tx_buf[IEEE80211_NUM_ACS];
293 struct sk_buff_head tx_filtered[IEEE80211_NUM_ACS];
294 unsigned long driver_buffered_tids;
296 /* Updated from RX path only, no locking requirements */
297 unsigned long rx_packets, rx_bytes;
298 unsigned long wep_weak_iv_count;
299 unsigned long last_rx;
301 unsigned long num_duplicates;
302 unsigned long rx_fragments;
303 unsigned long rx_dropped;
305 struct ewma avg_signal;
306 /* Plus 1 for non-QoS frames */
307 __le16 last_seq_ctrl[NUM_RX_DATA_QUEUES + 1];
309 /* Updated from TX status path only, no locking requirements */
310 unsigned long tx_filtered_count;
311 unsigned long tx_retry_failed, tx_retry_count;
312 /* moving percentage of failed MSDUs */
313 unsigned int fail_avg;
315 /* Updated from TX path only, no locking requirements */
316 unsigned long tx_packets;
317 unsigned long tx_bytes;
318 unsigned long tx_fragments;
319 struct ieee80211_tx_rate last_tx_rate;
320 int last_rx_rate_idx;
321 int last_rx_rate_flag;
322 u16 tid_seq[IEEE80211_QOS_CTL_TID_MASK + 1];
325 * Aggregation information, locked with lock.
327 struct sta_ampdu_mlme ampdu_mlme;
328 u8 timer_to_tid[STA_TID_NUM];
330 #ifdef CONFIG_MAC80211_MESH
332 * Mesh peer link attributes
333 * TODO: move to a sub-structure that is referenced with pointer?
339 bool ignore_plink_timer;
340 bool plink_timer_was_running;
341 enum nl80211_plink_state plink_state;
343 struct timer_list plink_timer;
346 #ifdef CONFIG_MAC80211_DEBUGFS
347 struct sta_info_debugfsdentries {
353 unsigned int lost_packets;
355 /* should be right in front of sta to be in the same cache line */
359 struct ieee80211_sta sta;
362 static inline enum nl80211_plink_state sta_plink_state(struct sta_info *sta)
364 #ifdef CONFIG_MAC80211_MESH
365 return sta->plink_state;
367 return NL80211_PLINK_LISTEN;
370 static inline void set_sta_flag(struct sta_info *sta,
371 enum ieee80211_sta_info_flags flag)
373 set_bit(flag, &sta->_flags);
376 static inline void clear_sta_flag(struct sta_info *sta,
377 enum ieee80211_sta_info_flags flag)
379 clear_bit(flag, &sta->_flags);
382 static inline int test_sta_flag(struct sta_info *sta,
383 enum ieee80211_sta_info_flags flag)
385 return test_bit(flag, &sta->_flags);
388 static inline int test_and_clear_sta_flag(struct sta_info *sta,
389 enum ieee80211_sta_info_flags flag)
391 return test_and_clear_bit(flag, &sta->_flags);
394 void ieee80211_assign_tid_tx(struct sta_info *sta, int tid,
395 struct tid_ampdu_tx *tid_tx);
397 static inline struct tid_ampdu_tx *
398 rcu_dereference_protected_tid_tx(struct sta_info *sta, int tid)
400 return rcu_dereference_protected(sta->ampdu_mlme.tid_tx[tid],
401 lockdep_is_held(&sta->lock) ||
402 lockdep_is_held(&sta->ampdu_mlme.mtx));
405 #define STA_HASH_SIZE 256
406 #define STA_HASH(sta) (sta[5])
409 /* Maximum number of frames to buffer per power saving station per AC */
410 #define STA_MAX_TX_BUFFER 64
412 /* Minimum buffered frame expiry time. If STA uses listen interval that is
413 * smaller than this value, the minimum value here is used instead. */
414 #define STA_TX_BUFFER_EXPIRE (10 * HZ)
416 /* How often station data is cleaned up (e.g., expiration of buffered frames)
418 #define STA_INFO_CLEANUP_INTERVAL (10 * HZ)
421 * Get a STA info, must be under RCU read lock.
423 struct sta_info *sta_info_get(struct ieee80211_sub_if_data *sdata,
426 struct sta_info *sta_info_get_rx(struct ieee80211_sub_if_data *sdata,
429 struct sta_info *sta_info_get_bss(struct ieee80211_sub_if_data *sdata,
432 struct sta_info *sta_info_get_bss_rx(struct ieee80211_sub_if_data *sdata,
436 void for_each_sta_info_type_check(struct ieee80211_local *local,
438 struct sta_info *sta,
439 struct sta_info *nxt)
443 #define for_each_sta_info(local, _addr, _sta, nxt) \
444 for ( /* initialise loop */ \
445 _sta = rcu_dereference(local->sta_hash[STA_HASH(_addr)]),\
446 nxt = _sta ? rcu_dereference(_sta->hnext) : NULL; \
448 for_each_sta_info_type_check(local, (_addr), _sta, nxt),\
449 /* continue condition */ \
453 nxt = _sta ? rcu_dereference(_sta->hnext) : NULL \
455 /* run code only if address matches and it's not a dummy sta */ \
456 if (memcmp(_sta->sta.addr, (_addr), ETH_ALEN) == 0 && \
459 #define for_each_sta_info_rx(local, _addr, _sta, nxt) \
460 for ( /* initialise loop */ \
461 _sta = rcu_dereference(local->sta_hash[STA_HASH(_addr)]),\
462 nxt = _sta ? rcu_dereference(_sta->hnext) : NULL; \
464 for_each_sta_info_type_check(local, (_addr), _sta, nxt),\
465 /* continue condition */ \
469 nxt = _sta ? rcu_dereference(_sta->hnext) : NULL \
471 /* compare address and run code only if it matches */ \
472 if (memcmp(_sta->sta.addr, (_addr), ETH_ALEN) == 0)
475 * Get STA info by index, BROKEN!
477 struct sta_info *sta_info_get_by_idx(struct ieee80211_sub_if_data *sdata,
480 * Create a new STA info, caller owns returned structure
481 * until sta_info_insert().
483 struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
484 u8 *addr, gfp_t gfp);
486 * Insert STA info into hash table/list, returns zero or a
487 * -EEXIST if (if the same MAC address is already present).
489 * Calling the non-rcu version makes the caller relinquish,
490 * the _rcu version calls read_lock_rcu() and must be called
493 int sta_info_insert(struct sta_info *sta);
494 int sta_info_insert_rcu(struct sta_info *sta) __acquires(RCU);
495 int sta_info_insert_atomic(struct sta_info *sta);
496 int sta_info_reinsert(struct sta_info *sta);
498 int sta_info_destroy_addr(struct ieee80211_sub_if_data *sdata,
500 int sta_info_destroy_addr_bss(struct ieee80211_sub_if_data *sdata,
503 void sta_info_recalc_tim(struct sta_info *sta);
505 void sta_info_init(struct ieee80211_local *local);
506 void sta_info_stop(struct ieee80211_local *local);
507 int sta_info_flush(struct ieee80211_local *local,
508 struct ieee80211_sub_if_data *sdata);
509 void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata,
510 unsigned long exp_time);
512 void ieee80211_sta_ps_deliver_wakeup(struct sta_info *sta);
513 void ieee80211_sta_ps_deliver_poll_response(struct sta_info *sta);
514 void ieee80211_sta_ps_deliver_uapsd(struct sta_info *sta);
516 #endif /* STA_INFO_H */