1 /*
2 * Copyright 2002-2005, Devicescape Software, Inc.
3 *
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.
7 */
8
9 #ifndef STA_INFO_H
10 #define STA_INFO_H
11
12 #include <linux/list.h>
13 #include <linux/types.h>
14 #include <linux/if_ether.h>
15 #include "key.h"
16
17 /**
18 * enum ieee80211_sta_info_flags - Stations flags
19 *
20 * These flags are used with &struct sta_info's @flags member.
21 *
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
29 * frames.
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.
37 */
38 enum ieee80211_sta_info_flags {
39 WLAN_STA_AUTH = 1<<0,
40 WLAN_STA_ASSOC = 1<<1,
41 WLAN_STA_PS = 1<<2,
42 WLAN_STA_AUTHORIZED = 1<<3,
43 WLAN_STA_SHORT_PREAMBLE = 1<<4,
44 WLAN_STA_ASSOC_AP = 1<<5,
45 WLAN_STA_WME = 1<<6,
46 WLAN_STA_WDS = 1<<7,
47 WLAN_STA_PSPOLL = 1<<8,
48 WLAN_STA_CLEAR_PS_FILT = 1<<9,
49 };
50
51 #define STA_TID_NUM 16
52 #define ADDBA_RESP_INTERVAL HZ
53 #define HT_AGG_MAX_RETRIES (0x3)
54
55 #define HT_AGG_STATE_INITIATOR_SHIFT (4)
56
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)
67
68 /**
69 * struct tid_ampdu_tx - TID aggregation information (Tx).
70 *
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
74 */
75 struct tid_ampdu_tx {
76 struct timer_list addba_resp_timer;
77 u16 ssn;
78 u8 dialog_token;
79 };
80
81 /**
82 * struct tid_ampdu_rx - TID aggregation information (Rx).
83 *
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
92 */
93 struct tid_ampdu_rx {
94 struct sk_buff **reorder_buf;
95 struct timer_list session_timer;
96 u16 head_seq_num;
97 u16 stored_mpdu_num;
98 u16 ssn;
99 u16 buf_size;
100 u16 timeout;
101 u8 dialog_token;
102 };
103
104 /**
105 * enum plink_state - state of a mesh peer link finite state machine
106 *
107 * @PLINK_LISTEN: initial state, considered the implicit state of non existant
108 * mesh peer links
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
112 * peer
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
116 */
117 enum plink_state {
118 PLINK_LISTEN,
119 PLINK_OPN_SNT,
120 PLINK_OPN_RCVD,
121 PLINK_CNF_RCVD,
122 PLINK_ESTAB,
123 PLINK_HOLDING,
124 PLINK_BLOCKED
125 };
126
127 /**
128 * struct sta_ampdu_mlme - STA aggregation information.
129 *
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;
136 */
137 struct sta_ampdu_mlme {
138 /* rx */
139 u8 tid_state_rx[STA_TID_NUM];
140 struct tid_ampdu_rx *tid_rx[STA_TID_NUM];
141 /* tx */
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;
146 };
147
148
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
153
154 /**
155 * struct sta_info - STA information
156 *
157 * This structure collects information about a station that
158 * mac80211 is communicating with.
159 *
160 * @list: global linked list entry
161 * @hnext: hash table linked list pointer
162 * @local: pointer to the global information
163 * @sdata: virtual interface this station belongs to
164 * @key: peer key negotiated with this station, if any
165 * @rate_ctrl: rate control algorithm reference
166 * @rate_ctrl_priv: rate control private per-STA pointer
167 * @last_tx_rate: rate used for last transmit, to report to userspace as
168 * "the" transmit rate
169 * @lock: used for locking all fields that require locking, see comments
170 * in the header file.
171 * @flaglock: spinlock for flags accesses
172 * @listen_interval: listen interval of this station, when we're acting as AP
173 * @pin_status: used internally for pinning a STA struct into memory
174 * @flags: STA flags, see &enum ieee80211_sta_info_flags
175 * @ps_tx_buf: buffer of frames to transmit to this station
176 * when it leaves power saving state
177 * @tx_filtered: buffer of frames we already tried to transmit
178 * but were filtered by hardware due to STA having entered
179 * power saving state
180 * @rx_packets: Number of MSDUs received from this STA
181 * @rx_bytes: Number of bytes received from this STA
182 * @wep_weak_iv_count: number of weak WEP IVs received from this station
183 * @last_rx: time (in jiffies) when last frame was received from this STA
184 * @num_duplicates: number of duplicate frames received from this STA
185 * @rx_fragments: number of received MPDUs
186 * @rx_dropped: number of dropped MPDUs from this STA
187 * @last_signal: signal of last received frame from this STA
188 * @last_qual: qual of last received frame from this STA
189 * @last_noise: noise of last received frame from this STA
190 * @last_seq_ctrl: last received seq/frag number from this STA (per RX queue)
191 * @tx_filtered_count: number of frames the hardware filtered for this STA
192 * @tx_retry_failed: number of frames that failed retry
193 * @tx_retry_count: total number of retries for frames to this STA
194 * @fail_avg: moving percentage of failed MSDUs
195 * @tx_packets: number of RX/TX MSDUs
196 * @tx_bytes: number of bytes transmitted to this STA
197 * @tx_fragments: number of transmitted MPDUs
198 * @tid_seq: per-TID sequence numbers for sending to this STA
199 * @ampdu_mlme: A-MPDU state machine state
200 * @timer_to_tid: identity mapping to ID timers
201 * @tid_to_tx_q: map tid to tx queue
202 * @llid: Local link ID
203 * @plid: Peer link ID
204 * @reason: Cancel reason on PLINK_HOLDING state
205 * @plink_retries: Retries in establishment
206 * @ignore_plink_timer: ignore the peer-link timer (used internally)
207 * @plink_state: peer link state
208 * @plink_timeout: timeout of peer link
209 * @plink_timer: peer link watch timer
210 * @debugfs: debug filesystem info
211 * @sta: station information we share with the driver
212 */
213 struct sta_info {
214 /* General information, mostly static */
215 struct list_head list;
216 struct sta_info *hnext;
217 struct ieee80211_local *local;
218 struct ieee80211_sub_if_data *sdata;
219 struct ieee80211_key *key;
220 struct rate_control_ref *rate_ctrl;
221 void *rate_ctrl_priv;
222 spinlock_t lock;
223 spinlock_t flaglock;
224
225 u16 listen_interval;
226
227 /*
228 * for use by the internal lifetime management,
229 * see __sta_info_unlink
230 */
231 u8 pin_status;
232
233 /*
234 * frequently updated, locked with own spinlock (flaglock),
235 * use the accessors defined below
236 */
237 u32 flags;
238
239 /*
240 * STA powersave frame queues, no more than the internal
241 * locking required.
242 */
243 struct sk_buff_head ps_tx_buf;
244 struct sk_buff_head tx_filtered;
245
246 /* Updated from RX path only, no locking requirements */
247 unsigned long rx_packets, rx_bytes;
248 unsigned long wep_weak_iv_count;
249 unsigned long last_rx;
250 unsigned long num_duplicates;
251 unsigned long rx_fragments;
252 unsigned long rx_dropped;
253 int last_signal;
254 int last_qual;
255 int last_noise;
256 __le16 last_seq_ctrl[NUM_RX_DATA_QUEUES];
257
258 /* Updated from TX status path only, no locking requirements */
259 unsigned long tx_filtered_count;
260 unsigned long tx_retry_failed, tx_retry_count;
261 /* moving percentage of failed MSDUs */
262 unsigned int fail_avg;
263
264 /* Updated from TX path only, no locking requirements */
265 unsigned long tx_packets;
266 unsigned long tx_bytes;
267 unsigned long tx_fragments;
268 struct ieee80211_tx_rate last_tx_rate;
269 u16 tid_seq[IEEE80211_QOS_CTL_TID_MASK + 1];
270
271 /*
272 * Aggregation information, locked with lock.
273 */
274 struct sta_ampdu_mlme ampdu_mlme;
275 u8 timer_to_tid[STA_TID_NUM];
276 u8 tid_to_tx_q[STA_TID_NUM];
277
278 #ifdef CONFIG_MAC80211_MESH
279 /*
280 * Mesh peer link attributes
281 * TODO: move to a sub-structure that is referenced with pointer?
282 */
283 __le16 llid;
284 __le16 plid;
285 __le16 reason;
286 u8 plink_retries;
287 bool ignore_plink_timer;
288 enum plink_state plink_state;
289 u32 plink_timeout;
290 struct timer_list plink_timer;
291 #endif
292
293 #ifdef CONFIG_MAC80211_DEBUGFS
294 struct sta_info_debugfsdentries {
295 struct dentry *dir;
296 struct dentry *flags;
297 struct dentry *num_ps_buf_frames;
298 struct dentry *inactive_ms;
299 struct dentry *last_seq_ctrl;
300 struct dentry *agg_status;
301 bool add_has_run;
302 } debugfs;
303 #endif
304
305 /* keep last! */
306 struct ieee80211_sta sta;
307 };
308
sta_plink_state(struct sta_info * sta)309 static inline enum plink_state sta_plink_state(struct sta_info *sta)
310 {
311 #ifdef CONFIG_MAC80211_MESH
312 return sta->plink_state;
313 #endif
314 return PLINK_LISTEN;
315 }
316
set_sta_flags(struct sta_info * sta,const u32 flags)317 static inline void set_sta_flags(struct sta_info *sta, const u32 flags)
318 {
319 unsigned long irqfl;
320
321 spin_lock_irqsave(&sta->flaglock, irqfl);
322 sta->flags |= flags;
323 spin_unlock_irqrestore(&sta->flaglock, irqfl);
324 }
325
clear_sta_flags(struct sta_info * sta,const u32 flags)326 static inline void clear_sta_flags(struct sta_info *sta, const u32 flags)
327 {
328 unsigned long irqfl;
329
330 spin_lock_irqsave(&sta->flaglock, irqfl);
331 sta->flags &= ~flags;
332 spin_unlock_irqrestore(&sta->flaglock, irqfl);
333 }
334
set_and_clear_sta_flags(struct sta_info * sta,const u32 set,const u32 clear)335 static inline void set_and_clear_sta_flags(struct sta_info *sta,
336 const u32 set, const u32 clear)
337 {
338 unsigned long irqfl;
339
340 spin_lock_irqsave(&sta->flaglock, irqfl);
341 sta->flags |= set;
342 sta->flags &= ~clear;
343 spin_unlock_irqrestore(&sta->flaglock, irqfl);
344 }
345
test_sta_flags(struct sta_info * sta,const u32 flags)346 static inline u32 test_sta_flags(struct sta_info *sta, const u32 flags)
347 {
348 u32 ret;
349 unsigned long irqfl;
350
351 spin_lock_irqsave(&sta->flaglock, irqfl);
352 ret = sta->flags & flags;
353 spin_unlock_irqrestore(&sta->flaglock, irqfl);
354
355 return ret;
356 }
357
test_and_clear_sta_flags(struct sta_info * sta,const u32 flags)358 static inline u32 test_and_clear_sta_flags(struct sta_info *sta,
359 const u32 flags)
360 {
361 u32 ret;
362 unsigned long irqfl;
363
364 spin_lock_irqsave(&sta->flaglock, irqfl);
365 ret = sta->flags & flags;
366 sta->flags &= ~flags;
367 spin_unlock_irqrestore(&sta->flaglock, irqfl);
368
369 return ret;
370 }
371
get_sta_flags(struct sta_info * sta)372 static inline u32 get_sta_flags(struct sta_info *sta)
373 {
374 u32 ret;
375 unsigned long irqfl;
376
377 spin_lock_irqsave(&sta->flaglock, irqfl);
378 ret = sta->flags;
379 spin_unlock_irqrestore(&sta->flaglock, irqfl);
380
381 return ret;
382 }
383
384
385 /* Maximum number of concurrently registered stations */
386 #define MAX_STA_COUNT 2007
387
388 #define STA_HASH_SIZE 256
389 #define STA_HASH(sta) (sta[5])
390
391
392 /* Maximum number of frames to buffer per power saving station */
393 #define STA_MAX_TX_BUFFER 128
394
395 /* Minimum buffered frame expiry time. If STA uses listen interval that is
396 * smaller than this value, the minimum value here is used instead. */
397 #define STA_TX_BUFFER_EXPIRE (10 * HZ)
398
399 /* How often station data is cleaned up (e.g., expiration of buffered frames)
400 */
401 #define STA_INFO_CLEANUP_INTERVAL (10 * HZ)
402
403 /*
404 * Get a STA info, must have be under RCU read lock.
405 */
406 struct sta_info *sta_info_get(struct ieee80211_local *local, const u8 *addr);
407 /*
408 * Get STA info by index, BROKEN!
409 */
410 struct sta_info *sta_info_get_by_idx(struct ieee80211_local *local, int idx,
411 struct net_device *dev);
412 /*
413 * Create a new STA info, caller owns returned structure
414 * until sta_info_insert().
415 */
416 struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
417 u8 *addr, gfp_t gfp);
418 /*
419 * Insert STA info into hash table/list, returns zero or a
420 * -EEXIST if (if the same MAC address is already present).
421 *
422 * Calling this without RCU protection makes the caller
423 * relinquish its reference to @sta.
424 */
425 int sta_info_insert(struct sta_info *sta);
426 /*
427 * Unlink a STA info from the hash table/list.
428 * This can NULL the STA pointer if somebody else
429 * has already unlinked it.
430 */
431 void sta_info_unlink(struct sta_info **sta);
432
433 void sta_info_destroy(struct sta_info *sta);
434 void sta_info_set_tim_bit(struct sta_info *sta);
435 void sta_info_clear_tim_bit(struct sta_info *sta);
436
437 void sta_info_init(struct ieee80211_local *local);
438 int sta_info_start(struct ieee80211_local *local);
439 void sta_info_stop(struct ieee80211_local *local);
440 int sta_info_flush(struct ieee80211_local *local,
441 struct ieee80211_sub_if_data *sdata);
442 void sta_info_flush_delayed(struct ieee80211_sub_if_data *sdata);
443 void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata,
444 unsigned long exp_time);
445
446 #endif /* STA_INFO_H */
447