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>
19 * enum ieee80211_sta_info_flags - Stations flags
21 * These flags are used with &struct sta_info's @flags member.
23 * @WLAN_STA_AUTH: Station is authenticated.
24 * @WLAN_STA_ASSOC: Station is associated.
25 * @WLAN_STA_PS_STA: Station is in power-save mode
26 * @WLAN_STA_AUTHORIZED: Station is authorized to send/receive traffic.
27 * This bit is always checked so needs to be enabled for all stations
28 * when virtual port control is not in use.
29 * @WLAN_STA_SHORT_PREAMBLE: Station is capable of receiving short-preamble
31 * @WLAN_STA_ASSOC_AP: We're associated to that station, it is an AP.
32 * @WLAN_STA_WME: Station is a QoS-STA.
33 * @WLAN_STA_WDS: Station is one of our WDS peers.
34 * @WLAN_STA_CLEAR_PS_FILT: Clear PS filter in hardware (using the
35 * IEEE80211_TX_CTL_CLEAR_PS_FILT control flag) when the next
36 * frame to this station is transmitted.
37 * @WLAN_STA_MFP: Management frame protection is used with this STA.
38 * @WLAN_STA_BLOCK_BA: Used to deny ADDBA requests (both TX and RX)
39 * during suspend/resume.
40 * @WLAN_STA_PS_DRIVER: driver requires keeping this station in
41 * power-save mode logically to flush frames that might still
43 * @WLAN_STA_PSPOLL: Station sent PS-poll while driver was keeping
44 * station in power-save mode, reply when the driver unblocks.
45 * @WLAN_STA_DISASSOC: Disassociation in progress.
46 * This is used to reject TX BA session requests when disassociation
49 enum ieee80211_sta_info_flags {
51 WLAN_STA_ASSOC = 1<<1,
52 WLAN_STA_PS_STA = 1<<2,
53 WLAN_STA_AUTHORIZED = 1<<3,
54 WLAN_STA_SHORT_PREAMBLE = 1<<4,
55 WLAN_STA_ASSOC_AP = 1<<5,
58 WLAN_STA_CLEAR_PS_FILT = 1<<9,
60 WLAN_STA_BLOCK_BA = 1<<11,
61 WLAN_STA_PS_DRIVER = 1<<12,
62 WLAN_STA_PSPOLL = 1<<13,
63 WLAN_STA_DISASSOC = 1<<14,
66 #define STA_TID_NUM 16
67 #define ADDBA_RESP_INTERVAL HZ
68 #define HT_AGG_MAX_RETRIES (0x3)
70 #define HT_AGG_STATE_INITIATOR_SHIFT (4)
72 #define HT_ADDBA_REQUESTED_MSK BIT(0)
73 #define HT_ADDBA_DRV_READY_MSK BIT(1)
74 #define HT_ADDBA_RECEIVED_MSK BIT(2)
75 #define HT_AGG_STATE_REQ_STOP_BA_MSK BIT(3)
76 #define HT_AGG_STATE_INITIATOR_MSK BIT(HT_AGG_STATE_INITIATOR_SHIFT)
77 #define HT_AGG_STATE_IDLE (0x0)
78 #define HT_AGG_STATE_OPERATIONAL (HT_ADDBA_REQUESTED_MSK | \
79 HT_ADDBA_DRV_READY_MSK | \
80 HT_ADDBA_RECEIVED_MSK)
83 * struct tid_ampdu_tx - TID aggregation information (Tx).
85 * @addba_resp_timer: timer for peer's response to addba request
86 * @pending: pending frames queue -- use sta's spinlock to protect
87 * @ssn: Starting Sequence Number expected to be aggregated.
88 * @dialog_token: dialog token for aggregation session
91 struct timer_list addba_resp_timer;
92 struct sk_buff_head pending;
98 * struct tid_ampdu_rx - TID aggregation information (Rx).
100 * @reorder_buf: buffer to reorder incoming aggregated MPDUs
101 * @reorder_time: jiffies when skb was added
102 * @session_timer: check if peer keeps Tx-ing on the TID (by timeout value)
103 * @head_seq_num: head sequence number in reordering buffer.
104 * @stored_mpdu_num: number of MPDUs in reordering buffer
105 * @ssn: Starting Sequence Number expected to be aggregated.
106 * @buf_size: buffer size for incoming A-MPDUs
107 * @timeout: reset timer value (in TUs).
108 * @dialog_token: dialog token for aggregation session
109 * @shutdown: this session is being shut down due to STA removal
111 struct tid_ampdu_rx {
112 struct sk_buff **reorder_buf;
113 unsigned long *reorder_time;
114 struct timer_list session_timer;
125 * enum plink_state - state of a mesh peer link finite state machine
127 * @PLINK_LISTEN: initial state, considered the implicit state of non existant
129 * @PLINK_OPN_SNT: mesh plink open frame has been sent to this mesh peer
130 * @PLINK_OPN_RCVD: mesh plink open frame has been received from this mesh peer
131 * @PLINK_CNF_RCVD: mesh plink confirm frame has been received from this mesh
133 * @PLINK_ESTAB: mesh peer link is established
134 * @PLINK_HOLDING: mesh peer link is being closed or cancelled
135 * @PLINK_BLOCKED: all frames transmitted from this mesh plink are discarded
148 * struct sta_ampdu_mlme - STA aggregation information.
150 * @tid_state_rx: TID's state in Rx session state machine.
151 * @tid_rx: aggregation info for Rx per TID
152 * @tid_state_tx: TID's state in Tx session state machine.
153 * @tid_tx: aggregation info for Tx per TID
154 * @addba_req_num: number of times addBA request has been sent.
155 * @dialog_token_allocator: dialog token enumerator for each new session;
157 struct sta_ampdu_mlme {
159 u8 tid_state_rx[STA_TID_NUM];
160 struct tid_ampdu_rx *tid_rx[STA_TID_NUM];
162 u8 tid_state_tx[STA_TID_NUM];
163 struct tid_ampdu_tx *tid_tx[STA_TID_NUM];
164 u8 addba_req_num[STA_TID_NUM];
165 u8 dialog_token_allocator;
170 * struct sta_info - STA information
172 * This structure collects information about a station that
173 * mac80211 is communicating with.
175 * @list: global linked list entry
176 * @hnext: hash table linked list pointer
177 * @local: pointer to the global information
178 * @sdata: virtual interface this station belongs to
179 * @key: peer key negotiated with this station, if any
180 * @rate_ctrl: rate control algorithm reference
181 * @rate_ctrl_priv: rate control private per-STA pointer
182 * @last_tx_rate: rate used for last transmit, to report to userspace as
183 * "the" transmit rate
184 * @lock: used for locking all fields that require locking, see comments
185 * in the header file.
186 * @flaglock: spinlock for flags accesses
187 * @drv_unblock_wk: used for driver PS unblocking
188 * @listen_interval: listen interval of this station, when we're acting as AP
189 * @flags: STA flags, see &enum ieee80211_sta_info_flags
190 * @ps_tx_buf: buffer of frames to transmit to this station
191 * when it leaves power saving state
192 * @tx_filtered: buffer of frames we already tried to transmit
193 * but were filtered by hardware due to STA having entered
195 * @rx_packets: Number of MSDUs received from this STA
196 * @rx_bytes: Number of bytes received from this STA
197 * @wep_weak_iv_count: number of weak WEP IVs received from this station
198 * @last_rx: time (in jiffies) when last frame was received from this STA
199 * @num_duplicates: number of duplicate frames received from this STA
200 * @rx_fragments: number of received MPDUs
201 * @rx_dropped: number of dropped MPDUs from this STA
202 * @last_signal: signal of last received frame from this STA
203 * @last_seq_ctrl: last received seq/frag number from this STA (per RX queue)
204 * @tx_filtered_count: number of frames the hardware filtered for this STA
205 * @tx_retry_failed: number of frames that failed retry
206 * @tx_retry_count: total number of retries for frames to this STA
207 * @fail_avg: moving percentage of failed MSDUs
208 * @tx_packets: number of RX/TX MSDUs
209 * @tx_bytes: number of bytes transmitted to this STA
210 * @tx_fragments: number of transmitted MPDUs
211 * @tid_seq: per-TID sequence numbers for sending to this STA
212 * @ampdu_mlme: A-MPDU state machine state
213 * @timer_to_tid: identity mapping to ID timers
214 * @llid: Local link ID
215 * @plid: Peer link ID
216 * @reason: Cancel reason on PLINK_HOLDING state
217 * @plink_retries: Retries in establishment
218 * @ignore_plink_timer: ignore the peer-link timer (used internally)
219 * @plink_state: peer link state
220 * @plink_timeout: timeout of peer link
221 * @plink_timer: peer link watch timer
222 * @plink_timer_was_running: used by suspend/resume to restore timers
223 * @debugfs: debug filesystem info
224 * @sta: station information we share with the driver
225 * @dead: set to true when sta is unlinked
226 * @uploaded: set to true when sta is uploaded to the driver
229 /* General information, mostly static */
230 struct list_head list;
231 struct sta_info *hnext;
232 struct ieee80211_local *local;
233 struct ieee80211_sub_if_data *sdata;
234 struct ieee80211_key *key;
235 struct rate_control_ref *rate_ctrl;
236 void *rate_ctrl_priv;
240 struct work_struct drv_unblock_wk;
249 * frequently updated, locked with own spinlock (flaglock),
250 * use the accessors defined below
255 * STA powersave frame queues, no more than the internal
258 struct sk_buff_head ps_tx_buf;
259 struct sk_buff_head tx_filtered;
261 /* Updated from RX path only, no locking requirements */
262 unsigned long rx_packets, rx_bytes;
263 unsigned long wep_weak_iv_count;
264 unsigned long last_rx;
265 unsigned long num_duplicates;
266 unsigned long rx_fragments;
267 unsigned long rx_dropped;
269 __le16 last_seq_ctrl[NUM_RX_DATA_QUEUES];
271 /* Updated from TX status path only, no locking requirements */
272 unsigned long tx_filtered_count;
273 unsigned long tx_retry_failed, tx_retry_count;
274 /* moving percentage of failed MSDUs */
275 unsigned int fail_avg;
277 /* Updated from TX path only, no locking requirements */
278 unsigned long tx_packets;
279 unsigned long tx_bytes;
280 unsigned long tx_fragments;
281 struct ieee80211_tx_rate last_tx_rate;
282 u16 tid_seq[IEEE80211_QOS_CTL_TID_MASK + 1];
285 * Aggregation information, locked with lock.
287 struct sta_ampdu_mlme ampdu_mlme;
288 u8 timer_to_tid[STA_TID_NUM];
290 #ifdef CONFIG_MAC80211_MESH
292 * Mesh peer link attributes
293 * TODO: move to a sub-structure that is referenced with pointer?
299 bool ignore_plink_timer;
300 bool plink_timer_was_running;
301 enum plink_state plink_state;
303 struct timer_list plink_timer;
306 #ifdef CONFIG_MAC80211_DEBUGFS
307 struct sta_info_debugfsdentries {
314 struct ieee80211_sta sta;
317 static inline enum plink_state sta_plink_state(struct sta_info *sta)
319 #ifdef CONFIG_MAC80211_MESH
320 return sta->plink_state;
325 static inline void set_sta_flags(struct sta_info *sta, const u32 flags)
329 spin_lock_irqsave(&sta->flaglock, irqfl);
331 spin_unlock_irqrestore(&sta->flaglock, irqfl);
334 static inline void clear_sta_flags(struct sta_info *sta, const u32 flags)
338 spin_lock_irqsave(&sta->flaglock, irqfl);
339 sta->flags &= ~flags;
340 spin_unlock_irqrestore(&sta->flaglock, irqfl);
343 static inline u32 test_sta_flags(struct sta_info *sta, const u32 flags)
348 spin_lock_irqsave(&sta->flaglock, irqfl);
349 ret = sta->flags & flags;
350 spin_unlock_irqrestore(&sta->flaglock, irqfl);
355 static inline u32 test_and_clear_sta_flags(struct sta_info *sta,
361 spin_lock_irqsave(&sta->flaglock, irqfl);
362 ret = sta->flags & flags;
363 sta->flags &= ~flags;
364 spin_unlock_irqrestore(&sta->flaglock, irqfl);
369 static inline u32 get_sta_flags(struct sta_info *sta)
374 spin_lock_irqsave(&sta->flaglock, irqfl);
376 spin_unlock_irqrestore(&sta->flaglock, irqfl);
383 #define STA_HASH_SIZE 256
384 #define STA_HASH(sta) (sta[5])
387 /* Maximum number of frames to buffer per power saving station */
388 #define STA_MAX_TX_BUFFER 128
390 /* Minimum buffered frame expiry time. If STA uses listen interval that is
391 * smaller than this value, the minimum value here is used instead. */
392 #define STA_TX_BUFFER_EXPIRE (10 * HZ)
394 /* How often station data is cleaned up (e.g., expiration of buffered frames)
396 #define STA_INFO_CLEANUP_INTERVAL (10 * HZ)
399 * Get a STA info, must be under RCU read lock.
401 struct sta_info *sta_info_get(struct ieee80211_sub_if_data *sdata,
404 struct sta_info *sta_info_get_bss(struct ieee80211_sub_if_data *sdata,
408 void for_each_sta_info_type_check(struct ieee80211_local *local,
410 struct sta_info *sta,
411 struct sta_info *nxt)
415 #define for_each_sta_info(local, _addr, sta, nxt) \
416 for ( /* initialise loop */ \
417 sta = rcu_dereference(local->sta_hash[STA_HASH(_addr)]),\
418 nxt = sta ? rcu_dereference(sta->hnext) : NULL; \
420 for_each_sta_info_type_check(local, (_addr), sta, nxt), \
421 /* continue condition */ \
425 nxt = sta ? rcu_dereference(sta->hnext) : NULL \
427 /* compare address and run code only if it matches */ \
428 if (memcmp(sta->sta.addr, (_addr), ETH_ALEN) == 0)
431 * Get STA info by index, BROKEN!
433 struct sta_info *sta_info_get_by_idx(struct ieee80211_sub_if_data *sdata,
436 * Create a new STA info, caller owns returned structure
437 * until sta_info_insert().
439 struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
440 u8 *addr, gfp_t gfp);
442 * Insert STA info into hash table/list, returns zero or a
443 * -EEXIST if (if the same MAC address is already present).
445 * Calling the non-rcu version makes the caller relinquish,
446 * the _rcu version calls read_lock_rcu() and must be called
449 int sta_info_insert(struct sta_info *sta);
450 int sta_info_insert_rcu(struct sta_info *sta) __acquires(RCU);
451 int sta_info_insert_atomic(struct sta_info *sta);
453 int sta_info_destroy_addr(struct ieee80211_sub_if_data *sdata,
455 int sta_info_destroy_addr_bss(struct ieee80211_sub_if_data *sdata,
458 void sta_info_set_tim_bit(struct sta_info *sta);
459 void sta_info_clear_tim_bit(struct sta_info *sta);
461 void sta_info_init(struct ieee80211_local *local);
462 int sta_info_start(struct ieee80211_local *local);
463 void sta_info_stop(struct ieee80211_local *local);
464 int sta_info_flush(struct ieee80211_local *local,
465 struct ieee80211_sub_if_data *sdata);
466 void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata,
467 unsigned long exp_time);
469 void ieee80211_sta_ps_deliver_wakeup(struct sta_info *sta);
470 void ieee80211_sta_ps_deliver_poll_response(struct sta_info *sta);
472 #endif /* STA_INFO_H */