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>
17 #include <linux/etherdevice.h>
21 * enum ieee80211_sta_info_flags - Stations flags
23 * These flags are used with &struct sta_info's @flags member, but
24 * only indirectly with set_sta_flag() and friends.
26 * @WLAN_STA_AUTH: Station is authenticated.
27 * @WLAN_STA_ASSOC: Station is associated.
28 * @WLAN_STA_PS_STA: Station is in power-save mode
29 * @WLAN_STA_AUTHORIZED: Station is authorized to send/receive traffic.
30 * This bit is always checked so needs to be enabled for all stations
31 * when virtual port control is not in use.
32 * @WLAN_STA_SHORT_PREAMBLE: Station is capable of receiving short-preamble
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.
55 * @WLAN_STA_4ADDR_EVENT: 4-addr event was already sent for this frame.
56 * @WLAN_STA_INSERTED: This station is inserted into the hash table.
57 * @WLAN_STA_RATE_CONTROL: rate control was initialized for this station.
58 * @WLAN_STA_TOFFSET_KNOWN: toffset calculated for this station is valid.
60 enum ieee80211_sta_info_flags {
65 WLAN_STA_SHORT_PREAMBLE,
68 WLAN_STA_CLEAR_PS_FILT,
74 WLAN_STA_TDLS_PEER_AUTH,
79 WLAN_STA_RATE_CONTROL,
80 WLAN_STA_TOFFSET_KNOWN,
83 #define STA_TID_NUM 16
84 #define ADDBA_RESP_INTERVAL HZ
85 #define HT_AGG_MAX_RETRIES 15
86 #define HT_AGG_BURST_RETRIES 3
87 #define HT_AGG_RETRIES_PERIOD (15 * HZ)
89 #define HT_AGG_STATE_DRV_READY 0
90 #define HT_AGG_STATE_RESPONSE_RECEIVED 1
91 #define HT_AGG_STATE_OPERATIONAL 2
92 #define HT_AGG_STATE_STOPPING 3
93 #define HT_AGG_STATE_WANT_START 4
94 #define HT_AGG_STATE_WANT_STOP 5
97 * struct tid_ampdu_tx - TID aggregation information (Tx).
99 * @rcu_head: rcu head for freeing structure
100 * @session_timer: check if we keep Tx-ing on the TID (by timeout value)
101 * @addba_resp_timer: timer for peer's response to addba request
102 * @pending: pending frames queue -- use sta's spinlock to protect
103 * @dialog_token: dialog token for aggregation session
104 * @timeout: session timeout value to be filled in ADDBA requests
105 * @state: session state (see above)
106 * @last_tx: jiffies of last tx activity
107 * @stop_initiator: initiator of a session stop
108 * @tx_stop: TX DelBA frame when stopping
109 * @buf_size: reorder buffer size at receiver
110 * @failed_bar_ssn: ssn of the last failed BAR tx attempt
111 * @bar_pending: BAR needs to be re-sent
113 * This structure's lifetime is managed by RCU, assignments to
114 * the array holding it must hold the aggregation mutex.
116 * The TX path can access it under RCU lock-free if, and
117 * only if, the state has the flag %HT_AGG_STATE_OPERATIONAL
118 * set. Otherwise, the TX path must also acquire the spinlock
119 * and re-check the state, see comments in the tx code
122 struct tid_ampdu_tx {
123 struct rcu_head rcu_head;
124 struct timer_list session_timer;
125 struct timer_list addba_resp_timer;
126 struct sk_buff_head pending;
128 unsigned long last_tx;
140 * struct tid_ampdu_rx - TID aggregation information (Rx).
142 * @reorder_buf: buffer to reorder incoming aggregated MPDUs
143 * @reorder_time: jiffies when skb was added
144 * @session_timer: check if peer keeps Tx-ing on the TID (by timeout value)
145 * @reorder_timer: releases expired frames from the reorder buffer.
146 * @last_rx: jiffies of last rx activity
147 * @head_seq_num: head sequence number in reordering buffer.
148 * @stored_mpdu_num: number of MPDUs in reordering buffer
149 * @ssn: Starting Sequence Number expected to be aggregated.
150 * @buf_size: buffer size for incoming A-MPDUs
151 * @timeout: reset timer value (in TUs).
152 * @dialog_token: dialog token for aggregation session
153 * @rcu_head: RCU head used for freeing this struct
154 * @reorder_lock: serializes access to reorder buffer, see below.
156 * This structure's lifetime is managed by RCU, assignments to
157 * the array holding it must hold the aggregation mutex.
159 * The @reorder_lock is used to protect the members of this
160 * struct, except for @timeout, @buf_size and @dialog_token,
161 * which are constant across the lifetime of the struct (the
162 * dialog token being used only for debugging).
164 struct tid_ampdu_rx {
165 struct rcu_head rcu_head;
166 spinlock_t reorder_lock;
167 struct sk_buff **reorder_buf;
168 unsigned long *reorder_time;
169 struct timer_list session_timer;
170 struct timer_list reorder_timer;
171 unsigned long last_rx;
181 * struct sta_ampdu_mlme - STA aggregation information.
183 * @tid_rx: aggregation info for Rx per TID -- RCU protected
184 * @tid_tx: aggregation info for Tx per TID
185 * @tid_start_tx: sessions where start was requested
186 * @addba_req_num: number of times addBA request has been sent.
187 * @last_addba_req_time: timestamp of the last addBA request.
188 * @dialog_token_allocator: dialog token enumerator for each new session;
189 * @work: work struct for starting/stopping aggregation
190 * @tid_rx_timer_expired: bitmap indicating on which TIDs the
191 * RX timer expired until the work for it runs
192 * @tid_rx_stop_requested: bitmap indicating which BA sessions per TID the
193 * driver requested to close until the work for it runs
194 * @mtx: mutex to protect all TX data (except non-NULL assignments
195 * to tid_tx[idx], which are protected by the sta spinlock)
197 struct sta_ampdu_mlme {
200 struct tid_ampdu_rx __rcu *tid_rx[STA_TID_NUM];
201 unsigned long tid_rx_timer_expired[BITS_TO_LONGS(STA_TID_NUM)];
202 unsigned long tid_rx_stop_requested[BITS_TO_LONGS(STA_TID_NUM)];
204 struct work_struct work;
205 struct tid_ampdu_tx __rcu *tid_tx[STA_TID_NUM];
206 struct tid_ampdu_tx *tid_start_tx[STA_TID_NUM];
207 unsigned long last_addba_req_time[STA_TID_NUM];
208 u8 addba_req_num[STA_TID_NUM];
209 u8 dialog_token_allocator;
214 * struct sta_info - STA information
216 * This structure collects information about a station that
217 * mac80211 is communicating with.
219 * @list: global linked list entry
220 * @hnext: hash table linked list pointer
221 * @local: pointer to the global information
222 * @sdata: virtual interface this station belongs to
223 * @ptk: peer key negotiated with this station, if any
224 * @gtk: group keys negotiated with this station, if any
225 * @rate_ctrl: rate control algorithm reference
226 * @rate_ctrl_priv: rate control private per-STA pointer
227 * @last_tx_rate: rate used for last transmit, to report to userspace as
228 * "the" transmit rate
229 * @last_rx_rate_idx: rx status rate index of the last data packet
230 * @last_rx_rate_flag: rx status flag of the last data packet
231 * @lock: used for locking all fields that require locking, see comments
232 * in the header file.
233 * @drv_unblock_wk: used for driver PS unblocking
234 * @listen_interval: listen interval of this station, when we're acting as AP
235 * @_flags: STA flags, see &enum ieee80211_sta_info_flags, do not use directly
236 * @ps_tx_buf: buffers (per AC) of frames to transmit to this station
237 * when it leaves power saving state or polls
238 * @tx_filtered: buffers (per AC) of frames we already tried to
239 * transmit but were filtered by hardware due to STA having
240 * entered power saving state, these are also delivered to
241 * the station when it leaves powersave or polls for frames
242 * @driver_buffered_tids: bitmap of TIDs the driver has data buffered on
243 * @rx_packets: Number of MSDUs received from this STA
244 * @rx_bytes: Number of bytes received from this STA
245 * @wep_weak_iv_count: number of weak WEP IVs received from this station
246 * @last_rx: time (in jiffies) when last frame was received from this STA
247 * @last_connected: time (in seconds) when a station got connected
248 * @num_duplicates: number of duplicate frames received from this STA
249 * @rx_fragments: number of received MPDUs
250 * @rx_dropped: number of dropped MPDUs from this STA
251 * @last_signal: signal of last received frame from this STA
252 * @avg_signal: moving average of signal of received frames from this STA
253 * @last_seq_ctrl: last received seq/frag number from this STA (per RX queue)
254 * @tx_filtered_count: number of frames the hardware filtered for this STA
255 * @tx_retry_failed: number of frames that failed retry
256 * @tx_retry_count: total number of retries for frames to this STA
257 * @fail_avg: moving percentage of failed MSDUs
258 * @tx_packets: number of RX/TX MSDUs
259 * @tx_bytes: number of bytes transmitted to this STA
260 * @tx_fragments: number of transmitted MPDUs
261 * @tid_seq: per-TID sequence numbers for sending to this STA
262 * @ampdu_mlme: A-MPDU state machine state
263 * @timer_to_tid: identity mapping to ID timers
264 * @llid: Local link ID
265 * @plid: Peer link ID
266 * @reason: Cancel reason on PLINK_HOLDING state
267 * @plink_retries: Retries in establishment
268 * @ignore_plink_timer: ignore the peer-link timer (used internally)
269 * @plink_state: peer link state
270 * @plink_timeout: timeout of peer link
271 * @plink_timer: peer link watch timer
272 * @plink_timer_was_running: used by suspend/resume to restore timers
273 * @t_offset: timing offset relative to this host
274 * @debugfs: debug filesystem info
275 * @dead: set to true when sta is unlinked
276 * @uploaded: set to true when sta is uploaded to the driver
277 * @lost_packets: number of consecutive lost packets
278 * @sta: station information we share with the driver
279 * @sta_state: duplicates information about station state (for debug)
280 * @beacon_loss_count: number of times beacon loss has triggered
283 /* General information, mostly static */
284 struct list_head list;
285 struct sta_info __rcu *hnext;
286 struct ieee80211_local *local;
287 struct ieee80211_sub_if_data *sdata;
288 struct ieee80211_key __rcu *gtk[NUM_DEFAULT_KEYS + NUM_DEFAULT_MGMT_KEYS];
289 struct ieee80211_key __rcu *ptk;
290 struct rate_control_ref *rate_ctrl;
291 void *rate_ctrl_priv;
294 struct work_struct drv_unblock_wk;
302 enum ieee80211_sta_state sta_state;
304 /* use the accessors defined below */
305 unsigned long _flags;
308 * STA powersave frame queues, no more than the internal
311 struct sk_buff_head ps_tx_buf[IEEE80211_NUM_ACS];
312 struct sk_buff_head tx_filtered[IEEE80211_NUM_ACS];
313 unsigned long driver_buffered_tids;
315 /* Updated from RX path only, no locking requirements */
316 unsigned long rx_packets, rx_bytes;
317 unsigned long wep_weak_iv_count;
318 unsigned long last_rx;
320 unsigned long num_duplicates;
321 unsigned long rx_fragments;
322 unsigned long rx_dropped;
324 struct ewma avg_signal;
325 /* Plus 1 for non-QoS frames */
326 __le16 last_seq_ctrl[NUM_RX_DATA_QUEUES + 1];
328 /* Updated from TX status path only, no locking requirements */
329 unsigned long tx_filtered_count;
330 unsigned long tx_retry_failed, tx_retry_count;
331 /* moving percentage of failed MSDUs */
332 unsigned int fail_avg;
334 /* Updated from TX path only, no locking requirements */
335 unsigned long tx_packets;
336 unsigned long tx_bytes;
337 unsigned long tx_fragments;
338 struct ieee80211_tx_rate last_tx_rate;
339 int last_rx_rate_idx;
340 int last_rx_rate_flag;
341 u16 tid_seq[IEEE80211_QOS_CTL_TID_MASK + 1];
344 * Aggregation information, locked with lock.
346 struct sta_ampdu_mlme ampdu_mlme;
347 u8 timer_to_tid[STA_TID_NUM];
349 #ifdef CONFIG_MAC80211_MESH
351 * Mesh peer link attributes
352 * TODO: move to a sub-structure that is referenced with pointer?
358 bool ignore_plink_timer;
359 bool plink_timer_was_running;
360 enum nl80211_plink_state plink_state;
362 struct timer_list plink_timer;
364 s64 t_offset_setpoint;
365 enum nl80211_channel_type ch_type;
368 #ifdef CONFIG_MAC80211_DEBUGFS
369 struct sta_info_debugfsdentries {
375 unsigned int lost_packets;
376 unsigned int beacon_loss_count;
381 struct ieee80211_sta sta;
384 static inline enum nl80211_plink_state sta_plink_state(struct sta_info *sta)
386 #ifdef CONFIG_MAC80211_MESH
387 return sta->plink_state;
389 return NL80211_PLINK_LISTEN;
392 static inline void set_sta_flag(struct sta_info *sta,
393 enum ieee80211_sta_info_flags flag)
395 WARN_ON(flag == WLAN_STA_AUTH ||
396 flag == WLAN_STA_ASSOC ||
397 flag == WLAN_STA_AUTHORIZED);
398 set_bit(flag, &sta->_flags);
401 static inline void clear_sta_flag(struct sta_info *sta,
402 enum ieee80211_sta_info_flags flag)
404 WARN_ON(flag == WLAN_STA_AUTH ||
405 flag == WLAN_STA_ASSOC ||
406 flag == WLAN_STA_AUTHORIZED);
407 clear_bit(flag, &sta->_flags);
410 static inline int test_sta_flag(struct sta_info *sta,
411 enum ieee80211_sta_info_flags flag)
413 return test_bit(flag, &sta->_flags);
416 static inline int test_and_clear_sta_flag(struct sta_info *sta,
417 enum ieee80211_sta_info_flags flag)
419 WARN_ON(flag == WLAN_STA_AUTH ||
420 flag == WLAN_STA_ASSOC ||
421 flag == WLAN_STA_AUTHORIZED);
422 return test_and_clear_bit(flag, &sta->_flags);
425 static inline int test_and_set_sta_flag(struct sta_info *sta,
426 enum ieee80211_sta_info_flags flag)
428 WARN_ON(flag == WLAN_STA_AUTH ||
429 flag == WLAN_STA_ASSOC ||
430 flag == WLAN_STA_AUTHORIZED);
431 return test_and_set_bit(flag, &sta->_flags);
434 int sta_info_move_state(struct sta_info *sta,
435 enum ieee80211_sta_state new_state);
437 static inline void sta_info_pre_move_state(struct sta_info *sta,
438 enum ieee80211_sta_state new_state)
442 WARN_ON_ONCE(test_sta_flag(sta, WLAN_STA_INSERTED));
444 ret = sta_info_move_state(sta, new_state);
449 void ieee80211_assign_tid_tx(struct sta_info *sta, int tid,
450 struct tid_ampdu_tx *tid_tx);
452 static inline struct tid_ampdu_tx *
453 rcu_dereference_protected_tid_tx(struct sta_info *sta, int tid)
455 return rcu_dereference_protected(sta->ampdu_mlme.tid_tx[tid],
456 lockdep_is_held(&sta->lock) ||
457 lockdep_is_held(&sta->ampdu_mlme.mtx));
460 #define STA_HASH_SIZE 256
461 #define STA_HASH(sta) (sta[5])
464 /* Maximum number of frames to buffer per power saving station per AC */
465 #define STA_MAX_TX_BUFFER 64
467 /* Minimum buffered frame expiry time. If STA uses listen interval that is
468 * smaller than this value, the minimum value here is used instead. */
469 #define STA_TX_BUFFER_EXPIRE (10 * HZ)
471 /* How often station data is cleaned up (e.g., expiration of buffered frames)
473 #define STA_INFO_CLEANUP_INTERVAL (10 * HZ)
476 * Get a STA info, must be under RCU read lock.
478 struct sta_info *sta_info_get(struct ieee80211_sub_if_data *sdata,
481 struct sta_info *sta_info_get_bss(struct ieee80211_sub_if_data *sdata,
485 void for_each_sta_info_type_check(struct ieee80211_local *local,
487 struct sta_info *sta,
488 struct sta_info *nxt)
492 #define for_each_sta_info(local, _addr, _sta, nxt) \
493 for ( /* initialise loop */ \
494 _sta = rcu_dereference(local->sta_hash[STA_HASH(_addr)]),\
495 nxt = _sta ? rcu_dereference(_sta->hnext) : NULL; \
497 for_each_sta_info_type_check(local, (_addr), _sta, nxt),\
498 /* continue condition */ \
502 nxt = _sta ? rcu_dereference(_sta->hnext) : NULL \
504 /* compare address and run code only if it matches */ \
505 if (ether_addr_equal(_sta->sta.addr, (_addr)))
508 * Get STA info by index, BROKEN!
510 struct sta_info *sta_info_get_by_idx(struct ieee80211_sub_if_data *sdata,
513 * Create a new STA info, caller owns returned structure
514 * until sta_info_insert().
516 struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
517 const u8 *addr, gfp_t gfp);
519 void sta_info_free(struct ieee80211_local *local, struct sta_info *sta);
522 * Insert STA info into hash table/list, returns zero or a
523 * -EEXIST if (if the same MAC address is already present).
525 * Calling the non-rcu version makes the caller relinquish,
526 * the _rcu version calls read_lock_rcu() and must be called
529 int sta_info_insert(struct sta_info *sta);
530 int sta_info_insert_rcu(struct sta_info *sta) __acquires(RCU);
532 int __must_check __sta_info_destroy(struct sta_info *sta);
533 int sta_info_destroy_addr(struct ieee80211_sub_if_data *sdata,
535 int sta_info_destroy_addr_bss(struct ieee80211_sub_if_data *sdata,
538 void sta_info_recalc_tim(struct sta_info *sta);
540 void sta_info_init(struct ieee80211_local *local);
541 void sta_info_stop(struct ieee80211_local *local);
542 int sta_info_flush(struct ieee80211_local *local,
543 struct ieee80211_sub_if_data *sdata);
544 void sta_set_rate_info_tx(struct sta_info *sta,
545 const struct ieee80211_tx_rate *rate,
546 struct rate_info *rinfo);
547 void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata,
548 unsigned long exp_time);
550 void ieee80211_sta_ps_deliver_wakeup(struct sta_info *sta);
551 void ieee80211_sta_ps_deliver_poll_response(struct sta_info *sta);
552 void ieee80211_sta_ps_deliver_uapsd(struct sta_info *sta);
554 #endif /* STA_INFO_H */