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;
224 * struct ieee80211_tx_latency_stat - Tx latency statistics
226 * Measures TX latency and jitter for a station per TID.
228 * @max: worst case latency
229 * @sum: sum of all latencies
230 * @counter: amount of Tx frames sent from interface
231 * @bins: each bin counts how many frames transmitted within a certain
232 * latency range. when disabled it is NULL.
233 * @bin_count: amount of bins.
235 struct ieee80211_tx_latency_stat {
244 * struct sta_info - STA information
246 * This structure collects information about a station that
247 * mac80211 is communicating with.
249 * @list: global linked list entry
250 * @free_list: list entry for keeping track of stations to free
251 * @hnext: hash table linked list pointer
252 * @local: pointer to the global information
253 * @sdata: virtual interface this station belongs to
254 * @ptk: peer keys negotiated with this station, if any
255 * @ptk_idx: last installed peer key index
256 * @gtk: group keys negotiated with this station, if any
257 * @gtk_idx: last installed group key index
258 * @rate_ctrl: rate control algorithm reference
259 * @rate_ctrl_priv: rate control private per-STA pointer
260 * @last_tx_rate: rate used for last transmit, to report to userspace as
261 * "the" transmit rate
262 * @last_rx_rate_idx: rx status rate index of the last data packet
263 * @last_rx_rate_flag: rx status flag of the last data packet
264 * @last_rx_rate_vht_nss: rx status nss of last data packet
265 * @lock: used for locking all fields that require locking, see comments
266 * in the header file.
267 * @drv_unblock_wk: used for driver PS unblocking
268 * @listen_interval: listen interval of this station, when we're acting as AP
269 * @_flags: STA flags, see &enum ieee80211_sta_info_flags, do not use directly
270 * @ps_lock: used for powersave (when mac80211 is the AP) related locking
271 * @ps_tx_buf: buffers (per AC) of frames to transmit to this station
272 * when it leaves power saving state or polls
273 * @tx_filtered: buffers (per AC) of frames we already tried to
274 * transmit but were filtered by hardware due to STA having
275 * entered power saving state, these are also delivered to
276 * the station when it leaves powersave or polls for frames
277 * @driver_buffered_tids: bitmap of TIDs the driver has data buffered on
278 * @rx_packets: Number of MSDUs received from this STA
279 * @rx_bytes: Number of bytes received from this STA
280 * @wep_weak_iv_count: number of weak WEP IVs received from this station
281 * @last_rx: time (in jiffies) when last frame was received from this STA
282 * @last_connected: time (in seconds) when a station got connected
283 * @num_duplicates: number of duplicate frames received from this STA
284 * @rx_fragments: number of received MPDUs
285 * @rx_dropped: number of dropped MPDUs from this STA
286 * @last_signal: signal of last received frame from this STA
287 * @avg_signal: moving average of signal of received frames from this STA
288 * @last_ack_signal: signal of last received Ack frame from this STA
289 * @last_seq_ctrl: last received seq/frag number from this STA (per RX queue)
290 * @tx_filtered_count: number of frames the hardware filtered for this STA
291 * @tx_retry_failed: number of frames that failed retry
292 * @tx_retry_count: total number of retries for frames to this STA
293 * @fail_avg: moving percentage of failed MSDUs
294 * @tx_packets: number of RX/TX MSDUs
295 * @tx_bytes: number of bytes transmitted to this STA
296 * @tx_fragments: number of transmitted MPDUs
297 * @tid_seq: per-TID sequence numbers for sending to this STA
298 * @ampdu_mlme: A-MPDU state machine state
299 * @timer_to_tid: identity mapping to ID timers
300 * @tx_lat: Tx latency statistics
301 * @llid: Local link ID
302 * @plid: Peer link ID
303 * @reason: Cancel reason on PLINK_HOLDING state
304 * @plink_retries: Retries in establishment
305 * @ignore_plink_timer: ignore the peer-link timer (used internally)
306 * @plink_state: peer link state
307 * @plink_timeout: timeout of peer link
308 * @plink_timer: peer link watch timer
309 * @t_offset: timing offset relative to this host
310 * @t_offset_setpoint: reference timing offset of this sta to be used when
311 * calculating clockdrift
312 * @local_pm: local link-specific power save mode
313 * @peer_pm: peer-specific power save mode towards local STA
314 * @nonpeer_pm: STA power save mode towards non-peer neighbors
315 * @debugfs: debug filesystem info
316 * @dead: set to true when sta is unlinked
317 * @uploaded: set to true when sta is uploaded to the driver
318 * @lost_packets: number of consecutive lost packets
319 * @sta: station information we share with the driver
320 * @sta_state: duplicates information about station state (for debug)
321 * @beacon_loss_count: number of times beacon loss has triggered
322 * @rcu_head: RCU head used for freeing this station struct
323 * @cur_max_bandwidth: maximum bandwidth to use for TX to the station,
324 * taken from HT/VHT capabilities or VHT operating mode notification
325 * @chains: chains ever used for RX from this station
326 * @chain_signal_last: last signal (per chain)
327 * @chain_signal_avg: signal average (per chain)
328 * @known_smps_mode: the smps_mode the client thinks we are in. Relevant for
330 * @cipher_scheme: optional cipher scheme for this station
333 /* General information, mostly static */
334 struct list_head list, free_list;
335 struct rcu_head rcu_head;
336 struct sta_info __rcu *hnext;
337 struct ieee80211_local *local;
338 struct ieee80211_sub_if_data *sdata;
339 struct ieee80211_key __rcu *gtk[NUM_DEFAULT_KEYS + NUM_DEFAULT_MGMT_KEYS];
340 struct ieee80211_key __rcu *ptk[NUM_DEFAULT_KEYS];
343 struct rate_control_ref *rate_ctrl;
344 void *rate_ctrl_priv;
347 struct work_struct drv_unblock_wk;
355 enum ieee80211_sta_state sta_state;
357 /* use the accessors defined below */
358 unsigned long _flags;
360 /* STA powersave lock and frame queues */
362 struct sk_buff_head ps_tx_buf[IEEE80211_NUM_ACS];
363 struct sk_buff_head tx_filtered[IEEE80211_NUM_ACS];
364 unsigned long driver_buffered_tids;
366 /* Updated from RX path only, no locking requirements */
367 unsigned long rx_packets;
369 unsigned long wep_weak_iv_count;
370 unsigned long last_rx;
372 unsigned long num_duplicates;
373 unsigned long rx_fragments;
374 unsigned long rx_dropped;
376 struct ewma avg_signal;
380 s8 chain_signal_last[IEEE80211_MAX_CHAINS];
381 struct ewma chain_signal_avg[IEEE80211_MAX_CHAINS];
383 /* Plus 1 for non-QoS frames */
384 __le16 last_seq_ctrl[IEEE80211_NUM_TIDS + 1];
386 /* Updated from TX status path only, no locking requirements */
387 unsigned long tx_filtered_count;
388 unsigned long tx_retry_failed, tx_retry_count;
389 /* moving percentage of failed MSDUs */
390 unsigned int fail_avg;
392 /* Updated from TX path only, no locking requirements */
394 u64 tx_packets[IEEE80211_NUM_ACS];
395 u64 tx_bytes[IEEE80211_NUM_ACS];
396 struct ieee80211_tx_rate last_tx_rate;
397 int last_rx_rate_idx;
398 u32 last_rx_rate_flag;
399 u8 last_rx_rate_vht_nss;
400 u16 tid_seq[IEEE80211_QOS_CTL_TID_MASK + 1];
403 * Aggregation information, locked with lock.
405 struct sta_ampdu_mlme ampdu_mlme;
406 u8 timer_to_tid[IEEE80211_NUM_TIDS];
408 struct ieee80211_tx_latency_stat *tx_lat;
410 #ifdef CONFIG_MAC80211_MESH
412 * Mesh peer link attributes
413 * TODO: move to a sub-structure that is referenced with pointer?
419 bool ignore_plink_timer;
420 enum nl80211_plink_state plink_state;
422 struct timer_list plink_timer;
424 s64 t_offset_setpoint;
425 /* mesh power save */
426 enum nl80211_mesh_power_mode local_pm;
427 enum nl80211_mesh_power_mode peer_pm;
428 enum nl80211_mesh_power_mode nonpeer_pm;
431 #ifdef CONFIG_MAC80211_DEBUGFS
432 struct sta_info_debugfsdentries {
438 enum ieee80211_sta_rx_bandwidth cur_max_bandwidth;
440 unsigned int lost_packets;
441 unsigned int beacon_loss_count;
443 enum ieee80211_smps_mode known_smps_mode;
444 const struct ieee80211_cipher_scheme *cipher_scheme;
447 struct ieee80211_sta sta;
450 static inline enum nl80211_plink_state sta_plink_state(struct sta_info *sta)
452 #ifdef CONFIG_MAC80211_MESH
453 return sta->plink_state;
455 return NL80211_PLINK_LISTEN;
458 static inline void set_sta_flag(struct sta_info *sta,
459 enum ieee80211_sta_info_flags flag)
461 WARN_ON(flag == WLAN_STA_AUTH ||
462 flag == WLAN_STA_ASSOC ||
463 flag == WLAN_STA_AUTHORIZED);
464 set_bit(flag, &sta->_flags);
467 static inline void clear_sta_flag(struct sta_info *sta,
468 enum ieee80211_sta_info_flags flag)
470 WARN_ON(flag == WLAN_STA_AUTH ||
471 flag == WLAN_STA_ASSOC ||
472 flag == WLAN_STA_AUTHORIZED);
473 clear_bit(flag, &sta->_flags);
476 static inline int test_sta_flag(struct sta_info *sta,
477 enum ieee80211_sta_info_flags flag)
479 return test_bit(flag, &sta->_flags);
482 static inline int test_and_clear_sta_flag(struct sta_info *sta,
483 enum ieee80211_sta_info_flags flag)
485 WARN_ON(flag == WLAN_STA_AUTH ||
486 flag == WLAN_STA_ASSOC ||
487 flag == WLAN_STA_AUTHORIZED);
488 return test_and_clear_bit(flag, &sta->_flags);
491 static inline int test_and_set_sta_flag(struct sta_info *sta,
492 enum ieee80211_sta_info_flags flag)
494 WARN_ON(flag == WLAN_STA_AUTH ||
495 flag == WLAN_STA_ASSOC ||
496 flag == WLAN_STA_AUTHORIZED);
497 return test_and_set_bit(flag, &sta->_flags);
500 int sta_info_move_state(struct sta_info *sta,
501 enum ieee80211_sta_state new_state);
503 static inline void sta_info_pre_move_state(struct sta_info *sta,
504 enum ieee80211_sta_state new_state)
508 WARN_ON_ONCE(test_sta_flag(sta, WLAN_STA_INSERTED));
510 ret = sta_info_move_state(sta, new_state);
515 void ieee80211_assign_tid_tx(struct sta_info *sta, int tid,
516 struct tid_ampdu_tx *tid_tx);
518 static inline struct tid_ampdu_tx *
519 rcu_dereference_protected_tid_tx(struct sta_info *sta, int tid)
521 return rcu_dereference_protected(sta->ampdu_mlme.tid_tx[tid],
522 lockdep_is_held(&sta->lock) ||
523 lockdep_is_held(&sta->ampdu_mlme.mtx));
526 #define STA_HASH_SIZE 256
527 #define STA_HASH(sta) (sta[5])
530 /* Maximum number of frames to buffer per power saving station per AC */
531 #define STA_MAX_TX_BUFFER 64
533 /* Minimum buffered frame expiry time. If STA uses listen interval that is
534 * smaller than this value, the minimum value here is used instead. */
535 #define STA_TX_BUFFER_EXPIRE (10 * HZ)
537 /* How often station data is cleaned up (e.g., expiration of buffered frames)
539 #define STA_INFO_CLEANUP_INTERVAL (10 * HZ)
542 * Get a STA info, must be under RCU read lock.
544 struct sta_info *sta_info_get(struct ieee80211_sub_if_data *sdata,
547 struct sta_info *sta_info_get_bss(struct ieee80211_sub_if_data *sdata,
551 void for_each_sta_info_type_check(struct ieee80211_local *local,
553 struct sta_info *sta,
554 struct sta_info *nxt)
558 #define for_each_sta_info(local, _addr, _sta, nxt) \
559 for ( /* initialise loop */ \
560 _sta = rcu_dereference(local->sta_hash[STA_HASH(_addr)]),\
561 nxt = _sta ? rcu_dereference(_sta->hnext) : NULL; \
563 for_each_sta_info_type_check(local, (_addr), _sta, nxt),\
564 /* continue condition */ \
568 nxt = _sta ? rcu_dereference(_sta->hnext) : NULL \
570 /* compare address and run code only if it matches */ \
571 if (ether_addr_equal(_sta->sta.addr, (_addr)))
574 * Get STA info by index, BROKEN!
576 struct sta_info *sta_info_get_by_idx(struct ieee80211_sub_if_data *sdata,
579 * Create a new STA info, caller owns returned structure
580 * until sta_info_insert().
582 struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
583 const u8 *addr, gfp_t gfp);
585 void sta_info_free(struct ieee80211_local *local, struct sta_info *sta);
588 * Insert STA info into hash table/list, returns zero or a
589 * -EEXIST if (if the same MAC address is already present).
591 * Calling the non-rcu version makes the caller relinquish,
592 * the _rcu version calls read_lock_rcu() and must be called
595 int sta_info_insert(struct sta_info *sta);
596 int sta_info_insert_rcu(struct sta_info *sta) __acquires(RCU);
598 int __must_check __sta_info_destroy(struct sta_info *sta);
599 int sta_info_destroy_addr(struct ieee80211_sub_if_data *sdata,
601 int sta_info_destroy_addr_bss(struct ieee80211_sub_if_data *sdata,
604 void sta_info_recalc_tim(struct sta_info *sta);
606 void sta_info_init(struct ieee80211_local *local);
607 void sta_info_stop(struct ieee80211_local *local);
610 * sta_info_flush - flush matching STA entries from the STA table
612 * Returns the number of removed STA entries.
614 * @sdata: sdata to remove all stations from
615 * @vlans: if the given interface is an AP interface, also flush VLANs
617 int __sta_info_flush(struct ieee80211_sub_if_data *sdata, bool vlans);
619 static inline int sta_info_flush(struct ieee80211_sub_if_data *sdata)
621 return __sta_info_flush(sdata, false);
624 void sta_set_rate_info_tx(struct sta_info *sta,
625 const struct ieee80211_tx_rate *rate,
626 struct rate_info *rinfo);
627 void sta_set_rate_info_rx(struct sta_info *sta,
628 struct rate_info *rinfo);
629 void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata,
630 unsigned long exp_time);
631 u8 sta_info_tx_streams(struct sta_info *sta);
633 void ieee80211_sta_ps_deliver_wakeup(struct sta_info *sta);
634 void ieee80211_sta_ps_deliver_poll_response(struct sta_info *sta);
635 void ieee80211_sta_ps_deliver_uapsd(struct sta_info *sta);
637 #endif /* STA_INFO_H */