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>
18 * enum ieee80211_sta_info_flags - Stations flags
20 * These flags are used with &struct sta_info's @flags member.
22 * @WLAN_STA_AUTH: Station is authenticated.
23 * @WLAN_STA_ASSOC: Station is associated.
24 * @WLAN_STA_PS: Station is in power-save mode
25 * @WLAN_STA_AUTHORIZED: Station is authorized to send/receive traffic.
26 * This bit is always checked so needs to be enabled for all stations
27 * when virtual port control is not in use.
28 * @WLAN_STA_SHORT_PREAMBLE: Station is capable of receiving short-preamble
30 * @WLAN_STA_ASSOC_AP: We're associated to that station, it is an AP.
31 * @WLAN_STA_WME: Station is a QoS-STA.
32 * @WLAN_STA_WDS: Station is one of our WDS peers.
33 * @WLAN_STA_PSPOLL: Station has just PS-polled us.
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.
38 enum ieee80211_sta_info_flags {
40 WLAN_STA_ASSOC = 1<<1,
42 WLAN_STA_AUTHORIZED = 1<<3,
43 WLAN_STA_SHORT_PREAMBLE = 1<<4,
44 WLAN_STA_ASSOC_AP = 1<<5,
47 WLAN_STA_PSPOLL = 1<<8,
48 WLAN_STA_CLEAR_PS_FILT = 1<<9,
51 #define STA_TID_NUM 16
52 #define ADDBA_RESP_INTERVAL HZ
53 #define HT_AGG_MAX_RETRIES (0x3)
55 #define HT_AGG_STATE_INITIATOR_SHIFT (4)
57 #define HT_ADDBA_REQUESTED_MSK BIT(0)
58 #define HT_ADDBA_DRV_READY_MSK BIT(1)
59 #define HT_ADDBA_RECEIVED_MSK BIT(2)
60 #define HT_AGG_STATE_REQ_STOP_BA_MSK BIT(3)
61 #define HT_AGG_STATE_INITIATOR_MSK BIT(HT_AGG_STATE_INITIATOR_SHIFT)
62 #define HT_AGG_STATE_IDLE (0x0)
63 #define HT_AGG_STATE_OPERATIONAL (HT_ADDBA_REQUESTED_MSK | \
64 HT_ADDBA_DRV_READY_MSK | \
65 HT_ADDBA_RECEIVED_MSK)
66 #define HT_AGG_STATE_DEBUGFS_CTL BIT(7)
69 * struct tid_ampdu_tx - TID aggregation information (Tx).
71 * @addba_resp_timer: timer for peer's response to addba request
72 * @ssn: Starting Sequence Number expected to be aggregated.
73 * @dialog_token: dialog token for aggregation session
76 struct timer_list addba_resp_timer;
82 * struct tid_ampdu_rx - TID aggregation information (Rx).
84 * @reorder_buf: buffer to reorder incoming aggregated MPDUs
85 * @session_timer: check if peer keeps Tx-ing on the TID (by timeout value)
86 * @head_seq_num: head sequence number in reordering buffer.
87 * @stored_mpdu_num: number of MPDUs in reordering buffer
88 * @ssn: Starting Sequence Number expected to be aggregated.
89 * @buf_size: buffer size for incoming A-MPDUs
90 * @timeout: reset timer value.
91 * @dialog_token: dialog token for aggregation session
94 struct sk_buff **reorder_buf;
95 struct timer_list session_timer;
105 * enum plink_state - state of a mesh peer link finite state machine
107 * @PLINK_LISTEN: initial state, considered the implicit state of non existant
109 * @PLINK_OPN_SNT: mesh plink open frame has been sent to this mesh peer
110 * @PLINK_OPN_RCVD: mesh plink open frame has been received from this mesh peer
111 * @PLINK_CNF_RCVD: mesh plink confirm frame has been received from this mesh
113 * @PLINK_ESTAB: mesh peer link is established
114 * @PLINK_HOLDING: mesh peer link is being closed or cancelled
115 * @PLINK_BLOCKED: all frames transmitted from this mesh plink are discarded
128 * struct sta_ampdu_mlme - STA aggregation information.
130 * @tid_state_rx: TID's state in Rx session state machine.
131 * @tid_rx: aggregation info for Rx per TID
132 * @tid_state_tx: TID's state in Tx session state machine.
133 * @tid_tx: aggregation info for Tx per TID
134 * @addba_req_num: number of times addBA request has been sent.
135 * @dialog_token_allocator: dialog token enumerator for each new session;
137 struct sta_ampdu_mlme {
139 u8 tid_state_rx[STA_TID_NUM];
140 struct tid_ampdu_rx *tid_rx[STA_TID_NUM];
142 u8 tid_state_tx[STA_TID_NUM];
143 struct tid_ampdu_tx *tid_tx[STA_TID_NUM];
144 u8 addba_req_num[STA_TID_NUM];
145 u8 dialog_token_allocator;
149 /* see __sta_info_unlink */
150 #define STA_INFO_PIN_STAT_NORMAL 0
151 #define STA_INFO_PIN_STAT_PINNED 1
152 #define STA_INFO_PIN_STAT_DESTROY 2
155 * struct sta_info - STA information
157 * This structure collects information about a station that
158 * mac80211 is communicating with.
160 * @list: global linked list entry
161 * @hnext: hash table linked list pointer
162 * @local: pointer to the global information
166 * @rate_ctrl_priv: TBD
167 * @lock: used for locking all fields that require locking, see comments
168 * in the header file.
169 * @flaglock: spinlock for flags accesses
170 * @addr: MAC address of this STA
171 * @aid: STA's unique AID (1..2007, 0 = not assigned yet),
172 * only used in AP (and IBSS?) mode
173 * @listen_interval: TBD
175 * @flags: STA flags, see &enum ieee80211_sta_info_flags
176 * @ps_tx_buf: buffer of frames to transmit to this station
177 * when it leaves power saving state
178 * @tx_filtered: buffer of frames we already tried to transmit
179 * but were filtered by hardware due to STA having entered
181 * @rx_packets: Number of MSDUs received from this STA
182 * @rx_bytes: Number of bytes received from this STA
183 * @wep_weak_iv_count: TBD
185 * @num_duplicates: number of duplicate frames received from this STA
186 * @rx_fragments: number of received MPDUs
187 * @rx_dropped: number of dropped MPDUs from this STA
188 * @last_signal: signal of last received frame from this STA
189 * @last_qual: qual of last received frame from this STA
190 * @last_noise: noise of last received frame from this STA
191 * @last_seq_ctrl: last received seq/frag number from this STA (per RX queue)
193 * @tx_filtered_count: TBD
194 * @tx_retry_failed: TBD
195 * @tx_retry_count: TBD
196 * @fail_avg: moving percentage of failed MSDUs
197 * @tx_packets: number of RX/TX MSDUs
199 * @tx_fragments: number of transmitted MPDUs
200 * @last_txrate_idx: Index of the last used transmit rate
204 * @timer_to_tid: identity mapping to ID timers
205 * @tid_to_tx_q: map tid to tx queue
206 * @llid: Local link ID
207 * @plid: Peer link ID
208 * @reason: Cancel reason on PLINK_HOLDING state
209 * @plink_retries: Retries in establishment
210 * @ignore_plink_timer: TBD
211 * @plink_state plink_state: TBD
212 * @plink_timeout: TBD
214 * @debugfs: debug filesystem info
215 * @sta: station information we share with the driver
218 /* General information, mostly static */
219 struct list_head list;
220 struct sta_info *hnext;
221 struct ieee80211_local *local;
222 struct ieee80211_sub_if_data *sdata;
223 struct ieee80211_key *key;
224 struct rate_control_ref *rate_ctrl;
225 void *rate_ctrl_priv;
232 * for use by the internal lifetime management,
233 * see __sta_info_unlink
238 * frequently updated, locked with own spinlock (flaglock),
239 * use the accessors defined below
244 * STA powersave frame queues, no more than the internal
247 struct sk_buff_head ps_tx_buf;
248 struct sk_buff_head tx_filtered;
250 /* Updated from RX path only, no locking requirements */
251 unsigned long rx_packets, rx_bytes;
252 unsigned long wep_weak_iv_count;
253 unsigned long last_rx;
254 unsigned long num_duplicates;
255 unsigned long rx_fragments;
256 unsigned long rx_dropped;
260 __le16 last_seq_ctrl[NUM_RX_DATA_QUEUES];
261 #ifdef CONFIG_MAC80211_DEBUG_COUNTERS
262 unsigned int wme_rx_queue[NUM_RX_DATA_QUEUES];
265 /* Updated from TX status path only, no locking requirements */
266 unsigned long tx_filtered_count;
267 unsigned long tx_retry_failed, tx_retry_count;
268 /* moving percentage of failed MSDUs */
269 unsigned int fail_avg;
271 /* Updated from TX path only, no locking requirements */
272 unsigned long tx_packets;
273 unsigned long tx_bytes;
274 unsigned long tx_fragments;
275 unsigned int last_txrate_idx;
276 u16 tid_seq[IEEE80211_QOS_CTL_TID_MASK + 1];
277 #ifdef CONFIG_MAC80211_DEBUG_COUNTERS
278 unsigned int wme_tx_queue[NUM_RX_DATA_QUEUES];
282 * Aggregation information, locked with lock.
284 struct sta_ampdu_mlme ampdu_mlme;
285 u8 timer_to_tid[STA_TID_NUM];
286 u8 tid_to_tx_q[STA_TID_NUM];
288 #ifdef CONFIG_MAC80211_MESH
290 * Mesh peer link attributes
291 * TODO: move to a sub-structure that is referenced with pointer?
297 bool ignore_plink_timer;
298 enum plink_state plink_state;
300 struct timer_list plink_timer;
303 #ifdef CONFIG_MAC80211_DEBUGFS
304 struct sta_info_debugfsdentries {
306 struct dentry *flags;
307 struct dentry *num_ps_buf_frames;
308 struct dentry *inactive_ms;
309 struct dentry *last_seq_ctrl;
310 #ifdef CONFIG_MAC80211_DEBUG_COUNTERS
311 struct dentry *wme_rx_queue;
312 struct dentry *wme_tx_queue;
314 struct dentry *agg_status;
319 struct ieee80211_sta sta;
322 static inline enum plink_state sta_plink_state(struct sta_info *sta)
324 #ifdef CONFIG_MAC80211_MESH
325 return sta->plink_state;
330 static inline void set_sta_flags(struct sta_info *sta, const u32 flags)
334 spin_lock_irqsave(&sta->flaglock, irqfl);
336 spin_unlock_irqrestore(&sta->flaglock, irqfl);
339 static inline void clear_sta_flags(struct sta_info *sta, const u32 flags)
343 spin_lock_irqsave(&sta->flaglock, irqfl);
344 sta->flags &= ~flags;
345 spin_unlock_irqrestore(&sta->flaglock, irqfl);
348 static inline void set_and_clear_sta_flags(struct sta_info *sta,
349 const u32 set, const u32 clear)
353 spin_lock_irqsave(&sta->flaglock, irqfl);
355 sta->flags &= ~clear;
356 spin_unlock_irqrestore(&sta->flaglock, irqfl);
359 static inline u32 test_sta_flags(struct sta_info *sta, const u32 flags)
364 spin_lock_irqsave(&sta->flaglock, irqfl);
365 ret = sta->flags & flags;
366 spin_unlock_irqrestore(&sta->flaglock, irqfl);
371 static inline u32 test_and_clear_sta_flags(struct sta_info *sta,
377 spin_lock_irqsave(&sta->flaglock, irqfl);
378 ret = sta->flags & flags;
379 sta->flags &= ~flags;
380 spin_unlock_irqrestore(&sta->flaglock, irqfl);
385 static inline u32 get_sta_flags(struct sta_info *sta)
390 spin_lock_irqsave(&sta->flaglock, irqfl);
392 spin_unlock_irqrestore(&sta->flaglock, irqfl);
398 /* Maximum number of concurrently registered stations */
399 #define MAX_STA_COUNT 2007
401 #define STA_HASH_SIZE 256
402 #define STA_HASH(sta) (sta[5])
405 /* Maximum number of frames to buffer per power saving station */
406 #define STA_MAX_TX_BUFFER 128
408 /* Minimum buffered frame expiry time. If STA uses listen interval that is
409 * smaller than this value, the minimum value here is used instead. */
410 #define STA_TX_BUFFER_EXPIRE (10 * HZ)
412 /* How often station data is cleaned up (e.g., expiration of buffered frames)
414 #define STA_INFO_CLEANUP_INTERVAL (10 * HZ)
417 * Get a STA info, must have be under RCU read lock.
419 struct sta_info *sta_info_get(struct ieee80211_local *local, u8 *addr);
421 * Get STA info by index, BROKEN!
423 struct sta_info *sta_info_get_by_idx(struct ieee80211_local *local, int idx,
424 struct net_device *dev);
426 * Create a new STA info, caller owns returned structure
427 * until sta_info_insert().
429 struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
430 u8 *addr, gfp_t gfp);
432 * Insert STA info into hash table/list, returns zero or a
433 * -EEXIST if (if the same MAC address is already present).
435 * Calling this without RCU protection makes the caller
436 * relinquish its reference to @sta.
438 int sta_info_insert(struct sta_info *sta);
440 * Unlink a STA info from the hash table/list.
441 * This can NULL the STA pointer if somebody else
442 * has already unlinked it.
444 void sta_info_unlink(struct sta_info **sta);
446 void sta_info_destroy(struct sta_info *sta);
447 void sta_info_set_tim_bit(struct sta_info *sta);
448 void sta_info_clear_tim_bit(struct sta_info *sta);
450 void sta_info_init(struct ieee80211_local *local);
451 int sta_info_start(struct ieee80211_local *local);
452 void sta_info_stop(struct ieee80211_local *local);
453 int sta_info_flush(struct ieee80211_local *local,
454 struct ieee80211_sub_if_data *sdata);
455 void sta_info_flush_delayed(struct ieee80211_sub_if_data *sdata);
456 void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata,
457 unsigned long exp_time);
459 #endif /* STA_INFO_H */