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 "ieee80211_key.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_TXCTL_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)
68 * struct tid_ampdu_tx - TID aggregation information (Tx).
70 * @state: TID's state in session state machine.
71 * @dialog_token: dialog token for aggregation session
72 * @ssn: Starting Sequence Number expected to be aggregated.
73 * @addba_resp_timer: timer for peer's response to addba request
74 * @addba_req_num: number of times addBA request has been sent.
80 struct timer_list addba_resp_timer;
85 * struct tid_ampdu_rx - TID aggregation information (Rx).
87 * @state: TID's state in session state machine.
88 * @dialog_token: dialog token for aggregation session
89 * @ssn: Starting Sequence Number expected to be aggregated.
90 * @buf_size: buffer size for incoming A-MPDUs
91 * @timeout: reset timer value.
92 * @head_seq_num: head sequence number in reordering buffer.
93 * @stored_mpdu_num: number of MPDUs in reordering buffer
94 * @reorder_buf: buffer to reorder incoming aggregated MPDUs
95 * @session_timer: check if peer keeps Tx-ing on the TID (by timeout value)
105 struct sk_buff **reorder_buf;
106 struct timer_list session_timer;
120 * struct sta_ampdu_mlme - STA aggregation information.
122 * @tid_rx: aggregation info for Rx per TID
123 * @tid_tx: aggregation info for Tx per TID
124 * @ampdu_rx: for locking sections in aggregation Rx flow
125 * @ampdu_tx: for locking sectionsi in aggregation Tx flow
126 * @dialog_token_allocator: dialog token enumerator for each new session;
128 struct sta_ampdu_mlme {
129 struct tid_ampdu_rx tid_rx[STA_TID_NUM];
130 struct tid_ampdu_tx tid_tx[STA_TID_NUM];
133 u8 dialog_token_allocator;
137 /* see __sta_info_unlink */
138 #define STA_INFO_PIN_STAT_NORMAL 0
139 #define STA_INFO_PIN_STAT_PINNED 1
140 #define STA_INFO_PIN_STAT_DESTROY 2
143 * struct sta_info - STA information
145 * This structure collects information about a station that
146 * mac80211 is communicating with.
148 * @list: global linked list entry
149 * @hnext: hash table linked list pointer
150 * @local: pointer to the global information
151 * @addr: MAC address of this STA
152 * @aid: STA's unique AID (1..2007, 0 = not assigned yet),
153 * only used in AP (and IBSS?) mode
154 * @flags: STA flags, see &enum ieee80211_sta_info_flags
155 * @ps_tx_buf: buffer of frames to transmit to this station
156 * when it leaves power saving state
157 * @tx_filtered: buffer of frames we already tried to transmit
158 * but were filtered by hardware due to STA having entered
160 * @rx_packets: Number of MSDUs received from this STA
161 * @rx_bytes: Number of bytes received from this STA
162 * @supp_rates: Bitmap of supported rates (per band)
163 * @ht_info: HT capabilities of this STA
166 /* General information, mostly static */
167 struct list_head list;
168 struct sta_info *hnext;
169 struct ieee80211_local *local;
170 struct ieee80211_sub_if_data *sdata;
171 struct ieee80211_key *key;
172 struct rate_control_ref *rate_ctrl;
173 void *rate_ctrl_priv;
174 struct ieee80211_ht_info ht_info;
175 u64 supp_rates[IEEE80211_NUM_BANDS];
181 * for use by the internal lifetime management,
182 * see __sta_info_unlink
186 /* frequently updated information, needs locking? */
190 * STA powersave frame queues, no more than the internal
193 struct sk_buff_head ps_tx_buf;
194 struct sk_buff_head tx_filtered;
196 /* Updated from RX path only, no locking requirements */
197 unsigned long rx_packets, rx_bytes;
198 unsigned long wep_weak_iv_count;
199 unsigned long last_rx;
200 unsigned long num_duplicates; /* number of duplicate frames received
202 unsigned long rx_fragments; /* number of received MPDUs */
203 unsigned long rx_dropped; /* number of dropped MPDUs from this STA */
204 int last_rssi; /* RSSI of last received frame from this STA */
205 int last_signal; /* signal of last received frame from this STA */
206 int last_noise; /* noise of last received frame from this STA */
207 /* last received seq/frag number from this STA (per RX queue) */
208 __le16 last_seq_ctrl[NUM_RX_DATA_QUEUES];
209 #ifdef CONFIG_MAC80211_DEBUG_COUNTERS
210 unsigned int wme_rx_queue[NUM_RX_DATA_QUEUES];
213 /* Updated from TX status path only, no locking requirements */
214 unsigned long tx_filtered_count;
215 unsigned long tx_retry_failed, tx_retry_count;
216 /* TODO: update in generic code not rate control? */
217 u32 tx_num_consecutive_failures;
219 u32 tx_num_mpdu_fail;
220 /* moving percentage of failed MSDUs */
221 unsigned int fail_avg;
223 /* Updated from TX path only, no locking requirements */
224 unsigned long tx_packets; /* number of RX/TX MSDUs */
225 unsigned long tx_bytes;
226 unsigned long tx_fragments; /* number of transmitted MPDUs */
229 #ifdef CONFIG_MAC80211_DEBUG_COUNTERS
230 unsigned int wme_tx_queue[NUM_RX_DATA_QUEUES];
233 /* Debug counters, no locking doesn't matter */
238 * Aggregation information, comes with own locking.
240 struct sta_ampdu_mlme ampdu_mlme;
241 u8 timer_to_tid[STA_TID_NUM]; /* identity mapping to ID timers */
242 u8 tid_to_tx_q[STA_TID_NUM]; /* map tid to tx queue */
244 #ifdef CONFIG_MAC80211_MESH
246 * Mesh peer link attributes
247 * TODO: move to a sub-structure that is referenced with pointer?
249 __le16 llid; /* Local link ID */
250 __le16 plid; /* Peer link ID */
251 __le16 reason; /* Buffer for cancel reason on HOLDING state */
252 u8 plink_retries; /* Retries in establishment */
253 bool ignore_plink_timer;
254 enum plink_state plink_state;
256 struct timer_list plink_timer;
257 spinlock_t plink_lock; /* For peer_state reads / updates and other
258 updates in the structure. Ensures robust
259 transitions for the peerlink FSM */
262 #ifdef CONFIG_MAC80211_DEBUGFS
263 struct sta_info_debugfsdentries {
265 struct dentry *flags;
266 struct dentry *num_ps_buf_frames;
267 struct dentry *inactive_ms;
268 struct dentry *last_seq_ctrl;
269 #ifdef CONFIG_MAC80211_DEBUG_COUNTERS
270 struct dentry *wme_rx_queue;
271 struct dentry *wme_tx_queue;
273 struct dentry *agg_status;
278 static inline enum plink_state sta_plink_state(struct sta_info *sta)
280 #ifdef CONFIG_MAC80211_MESH
281 return sta->plink_state;
287 /* Maximum number of concurrently registered stations */
288 #define MAX_STA_COUNT 2007
290 #define STA_HASH_SIZE 256
291 #define STA_HASH(sta) (sta[5])
294 /* Maximum number of frames to buffer per power saving station */
295 #define STA_MAX_TX_BUFFER 128
297 /* Minimum buffered frame expiry time. If STA uses listen interval that is
298 * smaller than this value, the minimum value here is used instead. */
299 #define STA_TX_BUFFER_EXPIRE (10 * HZ)
301 /* How often station data is cleaned up (e.g., expiration of buffered frames)
303 #define STA_INFO_CLEANUP_INTERVAL (10 * HZ)
306 * Get a STA info, must have be under RCU read lock.
308 struct sta_info *sta_info_get(struct ieee80211_local *local, u8 *addr);
310 * Get STA info by index, BROKEN!
312 struct sta_info *sta_info_get_by_idx(struct ieee80211_local *local, int idx,
313 struct net_device *dev);
315 * Create a new STA info, caller owns returned structure
316 * until sta_info_insert().
318 struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
319 u8 *addr, gfp_t gfp);
321 * Insert STA info into hash table/list, returns zero or a
322 * -EEXIST if (if the same MAC address is already present).
324 * Calling this without RCU protection makes the caller
325 * relinquish its reference to @sta.
327 int sta_info_insert(struct sta_info *sta);
329 * Unlink a STA info from the hash table/list.
330 * This can NULL the STA pointer if somebody else
331 * has already unlinked it.
333 void sta_info_unlink(struct sta_info **sta);
335 void sta_info_destroy(struct sta_info *sta);
336 void sta_info_set_tim_bit(struct sta_info *sta);
337 void sta_info_clear_tim_bit(struct sta_info *sta);
339 void sta_info_init(struct ieee80211_local *local);
340 int sta_info_start(struct ieee80211_local *local);
341 void sta_info_stop(struct ieee80211_local *local);
342 int sta_info_flush(struct ieee80211_local *local,
343 struct ieee80211_sub_if_data *sdata);
345 #endif /* STA_INFO_H */