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.
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
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
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 * @WLAN_STA_TDLS_PEER: Station is a TDLS peer.
49 * @WLAN_STA_TDLS_PEER_AUTH: This TDLS peer is authorized to send direct
50 * packets. This means the link is enabled.
52 enum ieee80211_sta_info_flags
{
54 WLAN_STA_ASSOC
= 1<<1,
55 WLAN_STA_PS_STA
= 1<<2,
56 WLAN_STA_AUTHORIZED
= 1<<3,
57 WLAN_STA_SHORT_PREAMBLE
= 1<<4,
58 WLAN_STA_ASSOC_AP
= 1<<5,
61 WLAN_STA_CLEAR_PS_FILT
= 1<<9,
63 WLAN_STA_BLOCK_BA
= 1<<11,
64 WLAN_STA_PS_DRIVER
= 1<<12,
65 WLAN_STA_PSPOLL
= 1<<13,
66 WLAN_STA_PS_DRIVER_BUF
= 1<<14,
67 WLAN_STA_TDLS_PEER
= 1<<15,
68 WLAN_STA_TDLS_PEER_AUTH
= 1<<16,
71 #define STA_TID_NUM 16
72 #define ADDBA_RESP_INTERVAL HZ
73 #define HT_AGG_MAX_RETRIES 0x3
75 #define HT_AGG_STATE_DRV_READY 0
76 #define HT_AGG_STATE_RESPONSE_RECEIVED 1
77 #define HT_AGG_STATE_OPERATIONAL 2
78 #define HT_AGG_STATE_STOPPING 3
79 #define HT_AGG_STATE_WANT_START 4
80 #define HT_AGG_STATE_WANT_STOP 5
83 * struct tid_ampdu_tx - TID aggregation information (Tx).
85 * @rcu_head: rcu head for freeing structure
86 * @addba_resp_timer: timer for peer's response to addba request
87 * @pending: pending frames queue -- use sta's spinlock to protect
88 * @dialog_token: dialog token for aggregation session
89 * @timeout: session timeout value to be filled in ADDBA requests
90 * @state: session state (see above)
91 * @stop_initiator: initiator of a session stop
92 * @tx_stop: TX DelBA frame when stopping
93 * @buf_size: reorder buffer size at receiver
94 * @failed_bar_ssn: ssn of the last failed BAR tx attempt
95 * @bar_pending: BAR needs to be re-sent
97 * This structure's lifetime is managed by RCU, assignments to
98 * the array holding it must hold the aggregation mutex.
100 * The TX path can access it under RCU lock-free if, and
101 * only if, the state has the flag %HT_AGG_STATE_OPERATIONAL
102 * set. Otherwise, the TX path must also acquire the spinlock
103 * and re-check the state, see comments in the tx code
106 struct tid_ampdu_tx
{
107 struct rcu_head rcu_head
;
108 struct timer_list addba_resp_timer
;
109 struct sk_buff_head pending
;
122 * struct tid_ampdu_rx - TID aggregation information (Rx).
124 * @reorder_buf: buffer to reorder incoming aggregated MPDUs
125 * @reorder_time: jiffies when skb was added
126 * @session_timer: check if peer keeps Tx-ing on the TID (by timeout value)
127 * @reorder_timer: releases expired frames from the reorder buffer.
128 * @head_seq_num: head sequence number in reordering buffer.
129 * @stored_mpdu_num: number of MPDUs in reordering buffer
130 * @ssn: Starting Sequence Number expected to be aggregated.
131 * @buf_size: buffer size for incoming A-MPDUs
132 * @timeout: reset timer value (in TUs).
133 * @dialog_token: dialog token for aggregation session
134 * @rcu_head: RCU head used for freeing this struct
135 * @reorder_lock: serializes access to reorder buffer, see below.
137 * This structure's lifetime is managed by RCU, assignments to
138 * the array holding it must hold the aggregation mutex.
140 * The @reorder_lock is used to protect the members of this
141 * struct, except for @timeout, @buf_size and @dialog_token,
142 * which are constant across the lifetime of the struct (the
143 * dialog token being used only for debugging).
145 struct tid_ampdu_rx
{
146 struct rcu_head rcu_head
;
147 spinlock_t reorder_lock
;
148 struct sk_buff
**reorder_buf
;
149 unsigned long *reorder_time
;
150 struct timer_list session_timer
;
151 struct timer_list reorder_timer
;
161 * struct sta_ampdu_mlme - STA aggregation information.
163 * @tid_rx: aggregation info for Rx per TID -- RCU protected
164 * @tid_tx: aggregation info for Tx per TID
165 * @tid_start_tx: sessions where start was requested
166 * @addba_req_num: number of times addBA request has been sent.
167 * @dialog_token_allocator: dialog token enumerator for each new session;
168 * @work: work struct for starting/stopping aggregation
169 * @tid_rx_timer_expired: bitmap indicating on which TIDs the
170 * RX timer expired until the work for it runs
171 * @tid_rx_stop_requested: bitmap indicating which BA sessions per TID the
172 * driver requested to close until the work for it runs
173 * @mtx: mutex to protect all TX data (except non-NULL assignments
174 * to tid_tx[idx], which are protected by the sta spinlock)
176 struct sta_ampdu_mlme
{
179 struct tid_ampdu_rx __rcu
*tid_rx
[STA_TID_NUM
];
180 unsigned long tid_rx_timer_expired
[BITS_TO_LONGS(STA_TID_NUM
)];
181 unsigned long tid_rx_stop_requested
[BITS_TO_LONGS(STA_TID_NUM
)];
183 struct work_struct work
;
184 struct tid_ampdu_tx __rcu
*tid_tx
[STA_TID_NUM
];
185 struct tid_ampdu_tx
*tid_start_tx
[STA_TID_NUM
];
186 u8 addba_req_num
[STA_TID_NUM
];
187 u8 dialog_token_allocator
;
192 * struct sta_info - STA information
194 * This structure collects information about a station that
195 * mac80211 is communicating with.
197 * @list: global linked list entry
198 * @hnext: hash table linked list pointer
199 * @local: pointer to the global information
200 * @sdata: virtual interface this station belongs to
201 * @ptk: peer key negotiated with this station, if any
202 * @gtk: group keys negotiated with this station, if any
203 * @rate_ctrl: rate control algorithm reference
204 * @rate_ctrl_priv: rate control private per-STA pointer
205 * @last_tx_rate: rate used for last transmit, to report to userspace as
206 * "the" transmit rate
207 * @last_rx_rate_idx: rx status rate index of the last data packet
208 * @last_rx_rate_flag: rx status flag of the last data packet
209 * @lock: used for locking all fields that require locking, see comments
210 * in the header file.
211 * @flaglock: spinlock for flags accesses
212 * @drv_unblock_wk: used for driver PS unblocking
213 * @listen_interval: listen interval of this station, when we're acting as AP
214 * @flags: STA flags, see &enum ieee80211_sta_info_flags
215 * @ps_tx_buf: buffer of frames to transmit to this station
216 * when it leaves power saving state
217 * @tx_filtered: buffer of frames we already tried to transmit
218 * but were filtered by hardware due to STA having entered
220 * @rx_packets: Number of MSDUs received from this STA
221 * @rx_bytes: Number of bytes received from this STA
222 * @wep_weak_iv_count: number of weak WEP IVs received from this station
223 * @last_rx: time (in jiffies) when last frame was received from this STA
224 * @last_connected: time (in seconds) when a station got connected
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 * @dead: set to true when sta is unlinked
252 * @uploaded: set to true when sta is uploaded to the driver
253 * @lost_packets: number of consecutive lost packets
254 * @dummy: indicate a dummy station created for receiving
255 * EAP frames before association
256 * @sta: station information we share with the driver
259 /* General information, mostly static */
260 struct list_head list
;
261 struct sta_info __rcu
*hnext
;
262 struct ieee80211_local
*local
;
263 struct ieee80211_sub_if_data
*sdata
;
264 struct ieee80211_key __rcu
*gtk
[NUM_DEFAULT_KEYS
+ NUM_DEFAULT_MGMT_KEYS
];
265 struct ieee80211_key __rcu
*ptk
;
266 struct rate_control_ref
*rate_ctrl
;
267 void *rate_ctrl_priv
;
271 struct work_struct drv_unblock_wk
;
280 * frequently updated, locked with own spinlock (flaglock),
281 * use the accessors defined below
286 * STA powersave frame queues, no more than the internal
289 struct sk_buff_head ps_tx_buf
;
290 struct sk_buff_head tx_filtered
;
292 /* Updated from RX path only, no locking requirements */
293 unsigned long rx_packets
, rx_bytes
;
294 unsigned long wep_weak_iv_count
;
295 unsigned long last_rx
;
297 unsigned long num_duplicates
;
298 unsigned long rx_fragments
;
299 unsigned long rx_dropped
;
301 struct ewma avg_signal
;
302 /* Plus 1 for non-QoS frames */
303 __le16 last_seq_ctrl
[NUM_RX_DATA_QUEUES
+ 1];
305 /* Updated from TX status path only, no locking requirements */
306 unsigned long tx_filtered_count
;
307 unsigned long tx_retry_failed
, tx_retry_count
;
308 /* moving percentage of failed MSDUs */
309 unsigned int fail_avg
;
311 /* Updated from TX path only, no locking requirements */
312 unsigned long tx_packets
;
313 unsigned long tx_bytes
;
314 unsigned long tx_fragments
;
315 struct ieee80211_tx_rate last_tx_rate
;
316 int last_rx_rate_idx
;
317 int last_rx_rate_flag
;
318 u16 tid_seq
[IEEE80211_QOS_CTL_TID_MASK
+ 1];
321 * Aggregation information, locked with lock.
323 struct sta_ampdu_mlme ampdu_mlme
;
324 u8 timer_to_tid
[STA_TID_NUM
];
326 #ifdef CONFIG_MAC80211_MESH
328 * Mesh peer link attributes
329 * TODO: move to a sub-structure that is referenced with pointer?
335 bool ignore_plink_timer
;
336 bool plink_timer_was_running
;
337 enum nl80211_plink_state plink_state
;
339 struct timer_list plink_timer
;
342 #ifdef CONFIG_MAC80211_DEBUGFS
343 struct sta_info_debugfsdentries
{
349 unsigned int lost_packets
;
351 /* should be right in front of sta to be in the same cache line */
355 struct ieee80211_sta sta
;
358 static inline enum nl80211_plink_state
sta_plink_state(struct sta_info
*sta
)
360 #ifdef CONFIG_MAC80211_MESH
361 return sta
->plink_state
;
363 return NL80211_PLINK_LISTEN
;
366 static inline void set_sta_flags(struct sta_info
*sta
, const u32 flags
)
370 spin_lock_irqsave(&sta
->flaglock
, irqfl
);
372 spin_unlock_irqrestore(&sta
->flaglock
, irqfl
);
375 static inline void clear_sta_flags(struct sta_info
*sta
, const u32 flags
)
379 spin_lock_irqsave(&sta
->flaglock
, irqfl
);
380 sta
->flags
&= ~flags
;
381 spin_unlock_irqrestore(&sta
->flaglock
, irqfl
);
384 static inline u32
test_sta_flags(struct sta_info
*sta
, const u32 flags
)
389 spin_lock_irqsave(&sta
->flaglock
, irqfl
);
390 ret
= sta
->flags
& flags
;
391 spin_unlock_irqrestore(&sta
->flaglock
, irqfl
);
396 static inline u32
test_and_clear_sta_flags(struct sta_info
*sta
,
402 spin_lock_irqsave(&sta
->flaglock
, irqfl
);
403 ret
= sta
->flags
& flags
;
404 sta
->flags
&= ~flags
;
405 spin_unlock_irqrestore(&sta
->flaglock
, irqfl
);
410 static inline u32
get_sta_flags(struct sta_info
*sta
)
415 spin_lock_irqsave(&sta
->flaglock
, irqfl
);
417 spin_unlock_irqrestore(&sta
->flaglock
, irqfl
);
422 void ieee80211_assign_tid_tx(struct sta_info
*sta
, int tid
,
423 struct tid_ampdu_tx
*tid_tx
);
425 static inline struct tid_ampdu_tx
*
426 rcu_dereference_protected_tid_tx(struct sta_info
*sta
, int tid
)
428 return rcu_dereference_protected(sta
->ampdu_mlme
.tid_tx
[tid
],
429 lockdep_is_held(&sta
->lock
) ||
430 lockdep_is_held(&sta
->ampdu_mlme
.mtx
));
433 #define STA_HASH_SIZE 256
434 #define STA_HASH(sta) (sta[5])
437 /* Maximum number of frames to buffer per power saving station */
438 #define STA_MAX_TX_BUFFER 128
440 /* Minimum buffered frame expiry time. If STA uses listen interval that is
441 * smaller than this value, the minimum value here is used instead. */
442 #define STA_TX_BUFFER_EXPIRE (10 * HZ)
444 /* How often station data is cleaned up (e.g., expiration of buffered frames)
446 #define STA_INFO_CLEANUP_INTERVAL (10 * HZ)
449 * Get a STA info, must be under RCU read lock.
451 struct sta_info
*sta_info_get(struct ieee80211_sub_if_data
*sdata
,
454 struct sta_info
*sta_info_get_rx(struct ieee80211_sub_if_data
*sdata
,
457 struct sta_info
*sta_info_get_bss(struct ieee80211_sub_if_data
*sdata
,
460 struct sta_info
*sta_info_get_bss_rx(struct ieee80211_sub_if_data
*sdata
,
464 void for_each_sta_info_type_check(struct ieee80211_local
*local
,
466 struct sta_info
*sta
,
467 struct sta_info
*nxt
)
471 #define for_each_sta_info(local, _addr, _sta, nxt) \
472 for ( /* initialise loop */ \
473 _sta = rcu_dereference(local->sta_hash[STA_HASH(_addr)]),\
474 nxt = _sta ? rcu_dereference(_sta->hnext) : NULL; \
476 for_each_sta_info_type_check(local, (_addr), _sta, nxt),\
477 /* continue condition */ \
481 nxt = _sta ? rcu_dereference(_sta->hnext) : NULL \
483 /* run code only if address matches and it's not a dummy sta */ \
484 if (memcmp(_sta->sta.addr, (_addr), ETH_ALEN) == 0 && \
487 #define for_each_sta_info_rx(local, _addr, _sta, nxt) \
488 for ( /* initialise loop */ \
489 _sta = rcu_dereference(local->sta_hash[STA_HASH(_addr)]),\
490 nxt = _sta ? rcu_dereference(_sta->hnext) : NULL; \
492 for_each_sta_info_type_check(local, (_addr), _sta, nxt),\
493 /* continue condition */ \
497 nxt = _sta ? rcu_dereference(_sta->hnext) : NULL \
499 /* compare address and run code only if it matches */ \
500 if (memcmp(_sta->sta.addr, (_addr), ETH_ALEN) == 0)
503 * Get STA info by index, BROKEN!
505 struct sta_info
*sta_info_get_by_idx(struct ieee80211_sub_if_data
*sdata
,
508 * Create a new STA info, caller owns returned structure
509 * until sta_info_insert().
511 struct sta_info
*sta_info_alloc(struct ieee80211_sub_if_data
*sdata
,
512 u8
*addr
, gfp_t gfp
);
514 * Insert STA info into hash table/list, returns zero or a
515 * -EEXIST if (if the same MAC address is already present).
517 * Calling the non-rcu version makes the caller relinquish,
518 * the _rcu version calls read_lock_rcu() and must be called
521 int sta_info_insert(struct sta_info
*sta
);
522 int sta_info_insert_rcu(struct sta_info
*sta
) __acquires(RCU
);
523 int sta_info_insert_atomic(struct sta_info
*sta
);
524 int sta_info_reinsert(struct sta_info
*sta
);
526 int sta_info_destroy_addr(struct ieee80211_sub_if_data
*sdata
,
528 int sta_info_destroy_addr_bss(struct ieee80211_sub_if_data
*sdata
,
531 void sta_info_recalc_tim(struct sta_info
*sta
);
533 void sta_info_init(struct ieee80211_local
*local
);
534 void sta_info_stop(struct ieee80211_local
*local
);
535 int sta_info_flush(struct ieee80211_local
*local
,
536 struct ieee80211_sub_if_data
*sdata
);
537 void ieee80211_sta_expire(struct ieee80211_sub_if_data
*sdata
,
538 unsigned long exp_time
);
540 void ieee80211_sta_ps_deliver_wakeup(struct sta_info
*sta
);
541 void ieee80211_sta_ps_deliver_poll_response(struct sta_info
*sta
);
543 #endif /* STA_INFO_H */