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.
59 * @WLAN_STA_MPSP_OWNER: local STA is owner of a mesh Peer Service Period.
60 * @WLAN_STA_MPSP_RECIPIENT: local STA is recipient of a MPSP.
62 enum ieee80211_sta_info_flags {
67 WLAN_STA_SHORT_PREAMBLE,
70 WLAN_STA_CLEAR_PS_FILT,
76 WLAN_STA_TDLS_PEER_AUTH,
81 WLAN_STA_RATE_CONTROL,
82 WLAN_STA_TOFFSET_KNOWN,
84 WLAN_STA_MPSP_RECIPIENT,
87 #define ADDBA_RESP_INTERVAL HZ
88 #define HT_AGG_MAX_RETRIES 15
89 #define HT_AGG_BURST_RETRIES 3
90 #define HT_AGG_RETRIES_PERIOD (15 * HZ)
92 #define HT_AGG_STATE_DRV_READY 0
93 #define HT_AGG_STATE_RESPONSE_RECEIVED 1
94 #define HT_AGG_STATE_OPERATIONAL 2
95 #define HT_AGG_STATE_STOPPING 3
96 #define HT_AGG_STATE_WANT_START 4
97 #define HT_AGG_STATE_WANT_STOP 5
99 enum ieee80211_agg_stop_reason {
101 AGG_STOP_LOCAL_REQUEST,
102 AGG_STOP_PEER_REQUEST,
103 AGG_STOP_DESTROY_STA,
107 * struct tid_ampdu_tx - TID aggregation information (Tx).
109 * @rcu_head: rcu head for freeing structure
110 * @session_timer: check if we keep Tx-ing on the TID (by timeout value)
111 * @addba_resp_timer: timer for peer's response to addba request
112 * @pending: pending frames queue -- use sta's spinlock to protect
113 * @dialog_token: dialog token for aggregation session
114 * @timeout: session timeout value to be filled in ADDBA requests
115 * @state: session state (see above)
116 * @last_tx: jiffies of last tx activity
117 * @stop_initiator: initiator of a session stop
118 * @tx_stop: TX DelBA frame when stopping
119 * @buf_size: reorder buffer size at receiver
120 * @failed_bar_ssn: ssn of the last failed BAR tx attempt
121 * @bar_pending: BAR needs to be re-sent
123 * This structure's lifetime is managed by RCU, assignments to
124 * the array holding it must hold the aggregation mutex.
126 * The TX path can access it under RCU lock-free if, and
127 * only if, the state has the flag %HT_AGG_STATE_OPERATIONAL
128 * set. Otherwise, the TX path must also acquire the spinlock
129 * and re-check the state, see comments in the tx code
132 struct tid_ampdu_tx {
133 struct rcu_head rcu_head;
134 struct timer_list session_timer;
135 struct timer_list addba_resp_timer;
136 struct sk_buff_head pending;
138 unsigned long last_tx;
150 * struct tid_ampdu_rx - TID aggregation information (Rx).
152 * @reorder_buf: buffer to reorder incoming aggregated MPDUs
153 * @reorder_time: jiffies when skb was added
154 * @session_timer: check if peer keeps Tx-ing on the TID (by timeout value)
155 * @reorder_timer: releases expired frames from the reorder buffer.
156 * @last_rx: jiffies of last rx activity
157 * @head_seq_num: head sequence number in reordering buffer.
158 * @stored_mpdu_num: number of MPDUs in reordering buffer
159 * @ssn: Starting Sequence Number expected to be aggregated.
160 * @buf_size: buffer size for incoming A-MPDUs
161 * @timeout: reset timer value (in TUs).
162 * @dialog_token: dialog token for aggregation session
163 * @rcu_head: RCU head used for freeing this struct
164 * @reorder_lock: serializes access to reorder buffer, see below.
166 * This structure's lifetime is managed by RCU, assignments to
167 * the array holding it must hold the aggregation mutex.
169 * The @reorder_lock is used to protect the members of this
170 * struct, except for @timeout, @buf_size and @dialog_token,
171 * which are constant across the lifetime of the struct (the
172 * dialog token being used only for debugging).
174 struct tid_ampdu_rx {
175 struct rcu_head rcu_head;
176 spinlock_t reorder_lock;
177 struct sk_buff **reorder_buf;
178 unsigned long *reorder_time;
179 struct timer_list session_timer;
180 struct timer_list reorder_timer;
181 unsigned long last_rx;
191 * struct sta_ampdu_mlme - STA aggregation information.
193 * @tid_rx: aggregation info for Rx per TID -- RCU protected
194 * @tid_tx: aggregation info for Tx per TID
195 * @tid_start_tx: sessions where start was requested
196 * @addba_req_num: number of times addBA request has been sent.
197 * @last_addba_req_time: timestamp of the last addBA request.
198 * @dialog_token_allocator: dialog token enumerator for each new session;
199 * @work: work struct for starting/stopping aggregation
200 * @tid_rx_timer_expired: bitmap indicating on which TIDs the
201 * RX timer expired until the work for it runs
202 * @tid_rx_stop_requested: bitmap indicating which BA sessions per TID the
203 * driver requested to close until the work for it runs
204 * @mtx: mutex to protect all TX data (except non-NULL assignments
205 * to tid_tx[idx], which are protected by the sta spinlock)
206 * tid_start_tx is also protected by sta->lock.
208 struct sta_ampdu_mlme {
211 struct tid_ampdu_rx __rcu *tid_rx[IEEE80211_NUM_TIDS];
212 unsigned long tid_rx_timer_expired[BITS_TO_LONGS(IEEE80211_NUM_TIDS)];
213 unsigned long tid_rx_stop_requested[BITS_TO_LONGS(IEEE80211_NUM_TIDS)];
215 struct work_struct work;
216 struct tid_ampdu_tx __rcu *tid_tx[IEEE80211_NUM_TIDS];
217 struct tid_ampdu_tx *tid_start_tx[IEEE80211_NUM_TIDS];
218 unsigned long last_addba_req_time[IEEE80211_NUM_TIDS];
219 u8 addba_req_num[IEEE80211_NUM_TIDS];
220 u8 dialog_token_allocator;
225 * struct sta_info - STA information
227 * This structure collects information about a station that
228 * mac80211 is communicating with.
230 * @list: global linked list entry
231 * @hnext: hash table linked list pointer
232 * @local: pointer to the global information
233 * @sdata: virtual interface this station belongs to
234 * @ptk: peer keys negotiated with this station, if any
235 * @ptk_idx: last installed peer key index
236 * @gtk: group keys negotiated with this station, if any
237 * @gtk_idx: last installed group key index
238 * @rate_ctrl: rate control algorithm reference
239 * @rate_ctrl_priv: rate control private per-STA pointer
240 * @last_tx_rate: rate used for last transmit, to report to userspace as
241 * "the" transmit rate
242 * @last_rx_rate_idx: rx status rate index of the last data packet
243 * @last_rx_rate_flag: rx status flag of the last data packet
244 * @last_rx_rate_vht_nss: rx status nss of last data packet
245 * @lock: used for locking all fields that require locking, see comments
246 * in the header file.
247 * @drv_unblock_wk: used for driver PS unblocking
248 * @listen_interval: listen interval of this station, when we're acting as AP
249 * @_flags: STA flags, see &enum ieee80211_sta_info_flags, do not use directly
250 * @ps_tx_buf: buffers (per AC) of frames to transmit to this station
251 * when it leaves power saving state or polls
252 * @tx_filtered: buffers (per AC) of frames we already tried to
253 * transmit but were filtered by hardware due to STA having
254 * entered power saving state, these are also delivered to
255 * the station when it leaves powersave or polls for frames
256 * @driver_buffered_tids: bitmap of TIDs the driver has data buffered on
257 * @rx_packets: Number of MSDUs received from this STA
258 * @rx_bytes: Number of bytes received from this STA
259 * @wep_weak_iv_count: number of weak WEP IVs received from this station
260 * @last_rx: time (in jiffies) when last frame was received from this STA
261 * @last_connected: time (in seconds) when a station got connected
262 * @num_duplicates: number of duplicate frames received from this STA
263 * @rx_fragments: number of received MPDUs
264 * @rx_dropped: number of dropped MPDUs from this STA
265 * @last_signal: signal of last received frame from this STA
266 * @avg_signal: moving average of signal of received frames from this STA
267 * @last_ack_signal: signal of last received Ack frame from this STA
268 * @last_seq_ctrl: last received seq/frag number from this STA (per RX queue)
269 * @tx_filtered_count: number of frames the hardware filtered for this STA
270 * @tx_retry_failed: number of frames that failed retry
271 * @tx_retry_count: total number of retries for frames to this STA
272 * @fail_avg: moving percentage of failed MSDUs
273 * @tx_packets: number of RX/TX MSDUs
274 * @tx_bytes: number of bytes transmitted to this STA
275 * @tx_fragments: number of transmitted MPDUs
276 * @tid_seq: per-TID sequence numbers for sending to this STA
277 * @ampdu_mlme: A-MPDU state machine state
278 * @timer_to_tid: identity mapping to ID timers
279 * @llid: Local link ID
280 * @plid: Peer link ID
281 * @reason: Cancel reason on PLINK_HOLDING state
282 * @plink_retries: Retries in establishment
283 * @ignore_plink_timer: ignore the peer-link timer (used internally)
284 * @plink_state: peer link state
285 * @plink_timeout: timeout of peer link
286 * @plink_timer: peer link watch timer
287 * @t_offset: timing offset relative to this host
288 * @t_offset_setpoint: reference timing offset of this sta to be used when
289 * calculating clockdrift
290 * @local_pm: local link-specific power save mode
291 * @peer_pm: peer-specific power save mode towards local STA
292 * @nonpeer_pm: STA power save mode towards non-peer neighbors
293 * @debugfs: debug filesystem info
294 * @dead: set to true when sta is unlinked
295 * @uploaded: set to true when sta is uploaded to the driver
296 * @lost_packets: number of consecutive lost packets
297 * @sta: station information we share with the driver
298 * @sta_state: duplicates information about station state (for debug)
299 * @beacon_loss_count: number of times beacon loss has triggered
300 * @rcu_head: RCU head used for freeing this station struct
301 * @cur_max_bandwidth: maximum bandwidth to use for TX to the station,
302 * taken from HT/VHT capabilities or VHT operating mode notification
303 * @chains: chains ever used for RX from this station
304 * @chain_signal_last: last signal (per chain)
305 * @chain_signal_avg: signal average (per chain)
306 * @known_smps_mode: the smps_mode the client thinks we are in. Relevant for
308 * @cipher_scheme: optional cipher scheme for this station
311 /* General information, mostly static */
312 struct list_head list;
313 struct rcu_head rcu_head;
314 struct sta_info __rcu *hnext;
315 struct ieee80211_local *local;
316 struct ieee80211_sub_if_data *sdata;
317 struct ieee80211_key __rcu *gtk[NUM_DEFAULT_KEYS + NUM_DEFAULT_MGMT_KEYS];
318 struct ieee80211_key __rcu *ptk[NUM_DEFAULT_KEYS];
321 struct rate_control_ref *rate_ctrl;
322 void *rate_ctrl_priv;
325 struct work_struct drv_unblock_wk;
333 enum ieee80211_sta_state sta_state;
335 /* use the accessors defined below */
336 unsigned long _flags;
339 * STA powersave frame queues, no more than the internal
342 struct sk_buff_head ps_tx_buf[IEEE80211_NUM_ACS];
343 struct sk_buff_head tx_filtered[IEEE80211_NUM_ACS];
344 unsigned long driver_buffered_tids;
346 /* Updated from RX path only, no locking requirements */
347 unsigned long rx_packets;
349 unsigned long wep_weak_iv_count;
350 unsigned long last_rx;
352 unsigned long num_duplicates;
353 unsigned long rx_fragments;
354 unsigned long rx_dropped;
356 struct ewma avg_signal;
360 s8 chain_signal_last[IEEE80211_MAX_CHAINS];
361 struct ewma chain_signal_avg[IEEE80211_MAX_CHAINS];
363 /* Plus 1 for non-QoS frames */
364 __le16 last_seq_ctrl[IEEE80211_NUM_TIDS + 1];
366 /* Updated from TX status path only, no locking requirements */
367 unsigned long tx_filtered_count;
368 unsigned long tx_retry_failed, tx_retry_count;
369 /* moving percentage of failed MSDUs */
370 unsigned int fail_avg;
372 /* Updated from TX path only, no locking requirements */
374 u64 tx_packets[IEEE80211_NUM_ACS];
375 u64 tx_bytes[IEEE80211_NUM_ACS];
376 struct ieee80211_tx_rate last_tx_rate;
377 int last_rx_rate_idx;
378 u32 last_rx_rate_flag;
379 u8 last_rx_rate_vht_nss;
380 u16 tid_seq[IEEE80211_QOS_CTL_TID_MASK + 1];
383 * Aggregation information, locked with lock.
385 struct sta_ampdu_mlme ampdu_mlme;
386 u8 timer_to_tid[IEEE80211_NUM_TIDS];
388 #ifdef CONFIG_MAC80211_MESH
390 * Mesh peer link attributes
391 * TODO: move to a sub-structure that is referenced with pointer?
397 bool ignore_plink_timer;
398 enum nl80211_plink_state plink_state;
400 struct timer_list plink_timer;
402 s64 t_offset_setpoint;
403 /* mesh power save */
404 enum nl80211_mesh_power_mode local_pm;
405 enum nl80211_mesh_power_mode peer_pm;
406 enum nl80211_mesh_power_mode nonpeer_pm;
409 #ifdef CONFIG_MAC80211_DEBUGFS
410 struct sta_info_debugfsdentries {
416 enum ieee80211_sta_rx_bandwidth cur_max_bandwidth;
418 unsigned int lost_packets;
419 unsigned int beacon_loss_count;
421 enum ieee80211_smps_mode known_smps_mode;
422 const struct ieee80211_cipher_scheme *cipher_scheme;
425 struct ieee80211_sta sta;
428 static inline enum nl80211_plink_state sta_plink_state(struct sta_info *sta)
430 #ifdef CONFIG_MAC80211_MESH
431 return sta->plink_state;
433 return NL80211_PLINK_LISTEN;
436 static inline void set_sta_flag(struct sta_info *sta,
437 enum ieee80211_sta_info_flags flag)
439 WARN_ON(flag == WLAN_STA_AUTH ||
440 flag == WLAN_STA_ASSOC ||
441 flag == WLAN_STA_AUTHORIZED);
442 set_bit(flag, &sta->_flags);
445 static inline void clear_sta_flag(struct sta_info *sta,
446 enum ieee80211_sta_info_flags flag)
448 WARN_ON(flag == WLAN_STA_AUTH ||
449 flag == WLAN_STA_ASSOC ||
450 flag == WLAN_STA_AUTHORIZED);
451 clear_bit(flag, &sta->_flags);
454 static inline int test_sta_flag(struct sta_info *sta,
455 enum ieee80211_sta_info_flags flag)
457 return test_bit(flag, &sta->_flags);
460 static inline int test_and_clear_sta_flag(struct sta_info *sta,
461 enum ieee80211_sta_info_flags flag)
463 WARN_ON(flag == WLAN_STA_AUTH ||
464 flag == WLAN_STA_ASSOC ||
465 flag == WLAN_STA_AUTHORIZED);
466 return test_and_clear_bit(flag, &sta->_flags);
469 static inline int test_and_set_sta_flag(struct sta_info *sta,
470 enum ieee80211_sta_info_flags flag)
472 WARN_ON(flag == WLAN_STA_AUTH ||
473 flag == WLAN_STA_ASSOC ||
474 flag == WLAN_STA_AUTHORIZED);
475 return test_and_set_bit(flag, &sta->_flags);
478 int sta_info_move_state(struct sta_info *sta,
479 enum ieee80211_sta_state new_state);
481 static inline void sta_info_pre_move_state(struct sta_info *sta,
482 enum ieee80211_sta_state new_state)
486 WARN_ON_ONCE(test_sta_flag(sta, WLAN_STA_INSERTED));
488 ret = sta_info_move_state(sta, new_state);
493 void ieee80211_assign_tid_tx(struct sta_info *sta, int tid,
494 struct tid_ampdu_tx *tid_tx);
496 static inline struct tid_ampdu_tx *
497 rcu_dereference_protected_tid_tx(struct sta_info *sta, int tid)
499 return rcu_dereference_protected(sta->ampdu_mlme.tid_tx[tid],
500 lockdep_is_held(&sta->lock) ||
501 lockdep_is_held(&sta->ampdu_mlme.mtx));
504 #define STA_HASH_SIZE 256
505 #define STA_HASH(sta) (sta[5])
508 /* Maximum number of frames to buffer per power saving station per AC */
509 #define STA_MAX_TX_BUFFER 64
511 /* Minimum buffered frame expiry time. If STA uses listen interval that is
512 * smaller than this value, the minimum value here is used instead. */
513 #define STA_TX_BUFFER_EXPIRE (10 * HZ)
515 /* How often station data is cleaned up (e.g., expiration of buffered frames)
517 #define STA_INFO_CLEANUP_INTERVAL (10 * HZ)
520 * Get a STA info, must be under RCU read lock.
522 struct sta_info *sta_info_get(struct ieee80211_sub_if_data *sdata,
525 struct sta_info *sta_info_get_bss(struct ieee80211_sub_if_data *sdata,
529 void for_each_sta_info_type_check(struct ieee80211_local *local,
531 struct sta_info *sta,
532 struct sta_info *nxt)
536 #define for_each_sta_info(local, _addr, _sta, nxt) \
537 for ( /* initialise loop */ \
538 _sta = rcu_dereference(local->sta_hash[STA_HASH(_addr)]),\
539 nxt = _sta ? rcu_dereference(_sta->hnext) : NULL; \
541 for_each_sta_info_type_check(local, (_addr), _sta, nxt),\
542 /* continue condition */ \
546 nxt = _sta ? rcu_dereference(_sta->hnext) : NULL \
548 /* compare address and run code only if it matches */ \
549 if (ether_addr_equal(_sta->sta.addr, (_addr)))
552 * Get STA info by index, BROKEN!
554 struct sta_info *sta_info_get_by_idx(struct ieee80211_sub_if_data *sdata,
557 * Create a new STA info, caller owns returned structure
558 * until sta_info_insert().
560 struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
561 const u8 *addr, gfp_t gfp);
563 void sta_info_free(struct ieee80211_local *local, struct sta_info *sta);
566 * Insert STA info into hash table/list, returns zero or a
567 * -EEXIST if (if the same MAC address is already present).
569 * Calling the non-rcu version makes the caller relinquish,
570 * the _rcu version calls read_lock_rcu() and must be called
573 int sta_info_insert(struct sta_info *sta);
574 int sta_info_insert_rcu(struct sta_info *sta) __acquires(RCU);
576 int __must_check __sta_info_destroy(struct sta_info *sta);
577 int sta_info_destroy_addr(struct ieee80211_sub_if_data *sdata,
579 int sta_info_destroy_addr_bss(struct ieee80211_sub_if_data *sdata,
582 void sta_info_recalc_tim(struct sta_info *sta);
584 void sta_info_init(struct ieee80211_local *local);
585 void sta_info_stop(struct ieee80211_local *local);
586 int sta_info_flush_defer(struct ieee80211_sub_if_data *sdata);
589 * sta_info_flush_cleanup - flush the sta_info cleanup queue
590 * @sdata: the interface
592 * Flushes the sta_info cleanup queue for a given interface;
593 * this is necessary before the interface is removed or, for
594 * AP/mesh interfaces, before it is deconfigured.
596 * Note an rcu_barrier() must precede the function, after all
597 * stations have been flushed/removed to ensure the call_rcu()
598 * calls that add stations to the cleanup queue have completed.
600 void sta_info_flush_cleanup(struct ieee80211_sub_if_data *sdata);
603 * sta_info_flush - flush matching STA entries from the STA table
605 * Returns the number of removed STA entries.
607 * @sdata: sdata to remove all stations from
609 static inline int sta_info_flush(struct ieee80211_sub_if_data *sdata)
611 int ret = sta_info_flush_defer(sdata);
614 sta_info_flush_cleanup(sdata);
619 void sta_set_rate_info_tx(struct sta_info *sta,
620 const struct ieee80211_tx_rate *rate,
621 struct rate_info *rinfo);
622 void sta_set_rate_info_rx(struct sta_info *sta,
623 struct rate_info *rinfo);
624 void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata,
625 unsigned long exp_time);
626 u8 sta_info_tx_streams(struct sta_info *sta);
628 void ieee80211_sta_ps_deliver_wakeup(struct sta_info *sta);
629 void ieee80211_sta_ps_deliver_poll_response(struct sta_info *sta);
630 void ieee80211_sta_ps_deliver_uapsd(struct sta_info *sta);
632 void ieee80211_cleanup_sdata_stas(struct ieee80211_sub_if_data *sdata);
634 #endif /* STA_INFO_H */