]>
Commit | Line | Data |
---|---|---|
f0706e82 JB |
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> | |
2c8dccc7 | 15 | #include "key.h" |
f0706e82 | 16 | |
238814fd JB |
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 | |
238814fd JB |
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. | |
4a9a66e9 | 33 | * @WLAN_STA_PSPOLL: Station has just PS-polled us. |
d46e144b | 34 | * @WLAN_STA_CLEAR_PS_FILT: Clear PS filter in hardware (using the |
e039fa4a | 35 | * IEEE80211_TX_CTL_CLEAR_PS_FILT control flag) when the next |
d46e144b | 36 | * frame to this station is transmitted. |
5394af4d | 37 | * @WLAN_STA_MFP: Management frame protection is used with this STA. |
238814fd JB |
38 | */ |
39 | enum ieee80211_sta_info_flags { | |
40 | WLAN_STA_AUTH = 1<<0, | |
41 | WLAN_STA_ASSOC = 1<<1, | |
42 | WLAN_STA_PS = 1<<2, | |
836341a7 JB |
43 | WLAN_STA_AUTHORIZED = 1<<3, |
44 | WLAN_STA_SHORT_PREAMBLE = 1<<4, | |
45 | WLAN_STA_ASSOC_AP = 1<<5, | |
46 | WLAN_STA_WME = 1<<6, | |
47 | WLAN_STA_WDS = 1<<7, | |
48 | WLAN_STA_PSPOLL = 1<<8, | |
d46e144b | 49 | WLAN_STA_CLEAR_PS_FILT = 1<<9, |
5394af4d | 50 | WLAN_STA_MFP = 1<<10, |
238814fd | 51 | }; |
f0706e82 | 52 | |
5aae2880 RR |
53 | #define STA_TID_NUM 16 |
54 | #define ADDBA_RESP_INTERVAL HZ | |
80656c20 | 55 | #define HT_AGG_MAX_RETRIES (0x3) |
5aae2880 RR |
56 | |
57 | #define HT_AGG_STATE_INITIATOR_SHIFT (4) | |
58 | ||
80656c20 RR |
59 | #define HT_ADDBA_REQUESTED_MSK BIT(0) |
60 | #define HT_ADDBA_DRV_READY_MSK BIT(1) | |
61 | #define HT_ADDBA_RECEIVED_MSK BIT(2) | |
5aae2880 | 62 | #define HT_AGG_STATE_REQ_STOP_BA_MSK BIT(3) |
80656c20 | 63 | #define HT_AGG_STATE_INITIATOR_MSK BIT(HT_AGG_STATE_INITIATOR_SHIFT) |
5aae2880 | 64 | #define HT_AGG_STATE_IDLE (0x0) |
80656c20 RR |
65 | #define HT_AGG_STATE_OPERATIONAL (HT_ADDBA_REQUESTED_MSK | \ |
66 | HT_ADDBA_DRV_READY_MSK | \ | |
67 | HT_ADDBA_RECEIVED_MSK) | |
68 | ||
69 | /** | |
70 | * struct tid_ampdu_tx - TID aggregation information (Tx). | |
71 | * | |
80656c20 | 72 | * @addba_resp_timer: timer for peer's response to addba request |
cee24a3e RR |
73 | * @ssn: Starting Sequence Number expected to be aggregated. |
74 | * @dialog_token: dialog token for aggregation session | |
80656c20 RR |
75 | */ |
76 | struct tid_ampdu_tx { | |
80656c20 | 77 | struct timer_list addba_resp_timer; |
cee24a3e RR |
78 | u16 ssn; |
79 | u8 dialog_token; | |
80656c20 | 80 | }; |
5aae2880 RR |
81 | |
82 | /** | |
83 | * struct tid_ampdu_rx - TID aggregation information (Rx). | |
84 | * | |
5aae2880 RR |
85 | * @reorder_buf: buffer to reorder incoming aggregated MPDUs |
86 | * @session_timer: check if peer keeps Tx-ing on the TID (by timeout value) | |
056cdd59 JB |
87 | * @head_seq_num: head sequence number in reordering buffer. |
88 | * @stored_mpdu_num: number of MPDUs in reordering buffer | |
cee24a3e RR |
89 | * @ssn: Starting Sequence Number expected to be aggregated. |
90 | * @buf_size: buffer size for incoming A-MPDUs | |
91 | * @timeout: reset timer value. | |
92 | * @dialog_token: dialog token for aggregation session | |
5aae2880 RR |
93 | */ |
94 | struct tid_ampdu_rx { | |
5aae2880 RR |
95 | struct sk_buff **reorder_buf; |
96 | struct timer_list session_timer; | |
056cdd59 JB |
97 | u16 head_seq_num; |
98 | u16 stored_mpdu_num; | |
cee24a3e RR |
99 | u16 ssn; |
100 | u16 buf_size; | |
101 | u16 timeout; | |
102 | u8 dialog_token; | |
5aae2880 RR |
103 | }; |
104 | ||
b4e08ea1 LCC |
105 | /** |
106 | * enum plink_state - state of a mesh peer link finite state machine | |
107 | * | |
108 | * @PLINK_LISTEN: initial state, considered the implicit state of non existant | |
109 | * mesh peer links | |
110 | * @PLINK_OPN_SNT: mesh plink open frame has been sent to this mesh peer | |
111 | * @PLINK_OPN_RCVD: mesh plink open frame has been received from this mesh peer | |
112 | * @PLINK_CNF_RCVD: mesh plink confirm frame has been received from this mesh | |
113 | * peer | |
114 | * @PLINK_ESTAB: mesh peer link is established | |
115 | * @PLINK_HOLDING: mesh peer link is being closed or cancelled | |
116 | * @PLINK_BLOCKED: all frames transmitted from this mesh plink are discarded | |
117 | */ | |
ee385855 | 118 | enum plink_state { |
b4e08ea1 LCC |
119 | PLINK_LISTEN, |
120 | PLINK_OPN_SNT, | |
121 | PLINK_OPN_RCVD, | |
122 | PLINK_CNF_RCVD, | |
123 | PLINK_ESTAB, | |
124 | PLINK_HOLDING, | |
125 | PLINK_BLOCKED | |
ee385855 | 126 | }; |
ee385855 | 127 | |
5aae2880 RR |
128 | /** |
129 | * struct sta_ampdu_mlme - STA aggregation information. | |
130 | * | |
cee24a3e | 131 | * @tid_state_rx: TID's state in Rx session state machine. |
80656c20 | 132 | * @tid_rx: aggregation info for Rx per TID |
cee24a3e RR |
133 | * @tid_state_tx: TID's state in Tx session state machine. |
134 | * @tid_tx: aggregation info for Tx per TID | |
135 | * @addba_req_num: number of times addBA request has been sent. | |
80656c20 | 136 | * @dialog_token_allocator: dialog token enumerator for each new session; |
5aae2880 RR |
137 | */ |
138 | struct sta_ampdu_mlme { | |
cee24a3e RR |
139 | /* rx */ |
140 | u8 tid_state_rx[STA_TID_NUM]; | |
141 | struct tid_ampdu_rx *tid_rx[STA_TID_NUM]; | |
cee24a3e RR |
142 | /* tx */ |
143 | u8 tid_state_tx[STA_TID_NUM]; | |
144 | struct tid_ampdu_tx *tid_tx[STA_TID_NUM]; | |
145 | u8 addba_req_num[STA_TID_NUM]; | |
80656c20 | 146 | u8 dialog_token_allocator; |
5aae2880 | 147 | }; |
f0706e82 | 148 | |
d0709a65 JB |
149 | |
150 | /* see __sta_info_unlink */ | |
151 | #define STA_INFO_PIN_STAT_NORMAL 0 | |
152 | #define STA_INFO_PIN_STAT_PINNED 1 | |
153 | #define STA_INFO_PIN_STAT_DESTROY 2 | |
154 | ||
693b1bbc JB |
155 | /** |
156 | * struct sta_info - STA information | |
157 | * | |
158 | * This structure collects information about a station that | |
159 | * mac80211 is communicating with. | |
160 | * | |
161 | * @list: global linked list entry | |
162 | * @hnext: hash table linked list pointer | |
163 | * @local: pointer to the global information | |
e25cf4a6 JB |
164 | * @sdata: virtual interface this station belongs to |
165 | * @key: peer key negotiated with this station, if any | |
166 | * @rate_ctrl: rate control algorithm reference | |
167 | * @rate_ctrl_priv: rate control private per-STA pointer | |
168 | * @last_tx_rate: rate used for last transmit, to report to userspace as | |
169 | * "the" transmit rate | |
6ef307bc RD |
170 | * @lock: used for locking all fields that require locking, see comments |
171 | * in the header file. | |
172 | * @flaglock: spinlock for flags accesses | |
e25cf4a6 JB |
173 | * @listen_interval: listen interval of this station, when we're acting as AP |
174 | * @pin_status: used internally for pinning a STA struct into memory | |
693b1bbc JB |
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 | |
180 | * power saving state | |
181 | * @rx_packets: Number of MSDUs received from this STA | |
182 | * @rx_bytes: Number of bytes received from this STA | |
e25cf4a6 JB |
183 | * @wep_weak_iv_count: number of weak WEP IVs received from this station |
184 | * @last_rx: time (in jiffies) when last frame was received from this STA | |
6ef307bc RD |
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) | |
e25cf4a6 JB |
192 | * @tx_filtered_count: number of frames the hardware filtered for this STA |
193 | * @tx_retry_failed: number of frames that failed retry | |
194 | * @tx_retry_count: total number of retries for frames to this STA | |
6ef307bc RD |
195 | * @fail_avg: moving percentage of failed MSDUs |
196 | * @tx_packets: number of RX/TX MSDUs | |
e25cf4a6 | 197 | * @tx_bytes: number of bytes transmitted to this STA |
6ef307bc | 198 | * @tx_fragments: number of transmitted MPDUs |
e25cf4a6 JB |
199 | * @tid_seq: per-TID sequence numbers for sending to this STA |
200 | * @ampdu_mlme: A-MPDU state machine state | |
6ef307bc RD |
201 | * @timer_to_tid: identity mapping to ID timers |
202 | * @tid_to_tx_q: map tid to tx queue | |
203 | * @llid: Local link ID | |
204 | * @plid: Peer link ID | |
205 | * @reason: Cancel reason on PLINK_HOLDING state | |
206 | * @plink_retries: Retries in establishment | |
e25cf4a6 JB |
207 | * @ignore_plink_timer: ignore the peer-link timer (used internally) |
208 | * @plink_state: peer link state | |
209 | * @plink_timeout: timeout of peer link | |
210 | * @plink_timer: peer link watch timer | |
6ef307bc | 211 | * @debugfs: debug filesystem info |
17741cdc | 212 | * @sta: station information we share with the driver |
693b1bbc | 213 | */ |
f0706e82 | 214 | struct sta_info { |
693b1bbc | 215 | /* General information, mostly static */ |
f0706e82 | 216 | struct list_head list; |
693b1bbc | 217 | struct sta_info *hnext; |
f0706e82 | 218 | struct ieee80211_local *local; |
d0709a65 | 219 | struct ieee80211_sub_if_data *sdata; |
f0706e82 | 220 | struct ieee80211_key *key; |
f0706e82 JB |
221 | struct rate_control_ref *rate_ctrl; |
222 | void *rate_ctrl_priv; | |
07346f81 | 223 | spinlock_t lock; |
5a9f7b04 | 224 | spinlock_t flaglock; |
17741cdc | 225 | |
693b1bbc | 226 | u16 listen_interval; |
f0706e82 | 227 | |
693b1bbc JB |
228 | /* |
229 | * for use by the internal lifetime management, | |
230 | * see __sta_info_unlink | |
231 | */ | |
232 | u8 pin_status; | |
233 | ||
5a9f7b04 JB |
234 | /* |
235 | * frequently updated, locked with own spinlock (flaglock), | |
236 | * use the accessors defined below | |
237 | */ | |
693b1bbc JB |
238 | u32 flags; |
239 | ||
240 | /* | |
241 | * STA powersave frame queues, no more than the internal | |
242 | * locking required. | |
243 | */ | |
244 | struct sk_buff_head ps_tx_buf; | |
245 | struct sk_buff_head tx_filtered; | |
246 | ||
247 | /* Updated from RX path only, no locking requirements */ | |
248 | unsigned long rx_packets, rx_bytes; | |
249 | unsigned long wep_weak_iv_count; | |
250 | unsigned long last_rx; | |
6ef307bc RD |
251 | unsigned long num_duplicates; |
252 | unsigned long rx_fragments; | |
253 | unsigned long rx_dropped; | |
254 | int last_signal; | |
255 | int last_qual; | |
256 | int last_noise; | |
693b1bbc | 257 | __le16 last_seq_ctrl[NUM_RX_DATA_QUEUES]; |
693b1bbc JB |
258 | |
259 | /* Updated from TX status path only, no locking requirements */ | |
260 | unsigned long tx_filtered_count; | |
261 | unsigned long tx_retry_failed, tx_retry_count; | |
693b1bbc JB |
262 | /* moving percentage of failed MSDUs */ |
263 | unsigned int fail_avg; | |
264 | ||
265 | /* Updated from TX path only, no locking requirements */ | |
6ef307bc | 266 | unsigned long tx_packets; |
693b1bbc | 267 | unsigned long tx_bytes; |
6ef307bc | 268 | unsigned long tx_fragments; |
e6a9854b | 269 | struct ieee80211_tx_rate last_tx_rate; |
f591fa5d | 270 | u16 tid_seq[IEEE80211_QOS_CTL_TID_MASK + 1]; |
f0706e82 | 271 | |
d0709a65 | 272 | /* |
07346f81 | 273 | * Aggregation information, locked with lock. |
d0709a65 | 274 | */ |
5aae2880 | 275 | struct sta_ampdu_mlme ampdu_mlme; |
6ef307bc RD |
276 | u8 timer_to_tid[STA_TID_NUM]; |
277 | u8 tid_to_tx_q[STA_TID_NUM]; | |
693b1bbc | 278 | |
ee385855 | 279 | #ifdef CONFIG_MAC80211_MESH |
693b1bbc JB |
280 | /* |
281 | * Mesh peer link attributes | |
282 | * TODO: move to a sub-structure that is referenced with pointer? | |
283 | */ | |
6ef307bc RD |
284 | __le16 llid; |
285 | __le16 plid; | |
286 | __le16 reason; | |
287 | u8 plink_retries; | |
7495883b | 288 | bool ignore_plink_timer; |
ee385855 LCC |
289 | enum plink_state plink_state; |
290 | u32 plink_timeout; | |
291 | struct timer_list plink_timer; | |
ee385855 | 292 | #endif |
10816d40 | 293 | |
e9f207f0 JB |
294 | #ifdef CONFIG_MAC80211_DEBUGFS |
295 | struct sta_info_debugfsdentries { | |
296 | struct dentry *dir; | |
297 | struct dentry *flags; | |
298 | struct dentry *num_ps_buf_frames; | |
e9f207f0 JB |
299 | struct dentry *inactive_ms; |
300 | struct dentry *last_seq_ctrl; | |
eb2ba62e | 301 | struct dentry *agg_status; |
63044e9f | 302 | bool add_has_run; |
e9f207f0 JB |
303 | } debugfs; |
304 | #endif | |
17741cdc JB |
305 | |
306 | /* keep last! */ | |
307 | struct ieee80211_sta sta; | |
f0706e82 JB |
308 | }; |
309 | ||
d6d1a5a7 JB |
310 | static inline enum plink_state sta_plink_state(struct sta_info *sta) |
311 | { | |
312 | #ifdef CONFIG_MAC80211_MESH | |
313 | return sta->plink_state; | |
314 | #endif | |
b4e08ea1 | 315 | return PLINK_LISTEN; |
d6d1a5a7 JB |
316 | } |
317 | ||
07346f81 JB |
318 | static inline void set_sta_flags(struct sta_info *sta, const u32 flags) |
319 | { | |
5a9f7b04 JB |
320 | unsigned long irqfl; |
321 | ||
322 | spin_lock_irqsave(&sta->flaglock, irqfl); | |
07346f81 | 323 | sta->flags |= flags; |
5a9f7b04 | 324 | spin_unlock_irqrestore(&sta->flaglock, irqfl); |
07346f81 JB |
325 | } |
326 | ||
327 | static inline void clear_sta_flags(struct sta_info *sta, const u32 flags) | |
328 | { | |
5a9f7b04 JB |
329 | unsigned long irqfl; |
330 | ||
331 | spin_lock_irqsave(&sta->flaglock, irqfl); | |
07346f81 | 332 | sta->flags &= ~flags; |
5a9f7b04 | 333 | spin_unlock_irqrestore(&sta->flaglock, irqfl); |
07346f81 JB |
334 | } |
335 | ||
336 | static inline void set_and_clear_sta_flags(struct sta_info *sta, | |
337 | const u32 set, const u32 clear) | |
338 | { | |
5a9f7b04 JB |
339 | unsigned long irqfl; |
340 | ||
341 | spin_lock_irqsave(&sta->flaglock, irqfl); | |
07346f81 JB |
342 | sta->flags |= set; |
343 | sta->flags &= ~clear; | |
5a9f7b04 | 344 | spin_unlock_irqrestore(&sta->flaglock, irqfl); |
07346f81 JB |
345 | } |
346 | ||
347 | static inline u32 test_sta_flags(struct sta_info *sta, const u32 flags) | |
348 | { | |
349 | u32 ret; | |
5a9f7b04 | 350 | unsigned long irqfl; |
07346f81 | 351 | |
5a9f7b04 | 352 | spin_lock_irqsave(&sta->flaglock, irqfl); |
07346f81 | 353 | ret = sta->flags & flags; |
5a9f7b04 | 354 | spin_unlock_irqrestore(&sta->flaglock, irqfl); |
07346f81 JB |
355 | |
356 | return ret; | |
357 | } | |
358 | ||
359 | static inline u32 test_and_clear_sta_flags(struct sta_info *sta, | |
360 | const u32 flags) | |
361 | { | |
362 | u32 ret; | |
5a9f7b04 | 363 | unsigned long irqfl; |
07346f81 | 364 | |
5a9f7b04 | 365 | spin_lock_irqsave(&sta->flaglock, irqfl); |
07346f81 JB |
366 | ret = sta->flags & flags; |
367 | sta->flags &= ~flags; | |
5a9f7b04 | 368 | spin_unlock_irqrestore(&sta->flaglock, irqfl); |
07346f81 JB |
369 | |
370 | return ret; | |
371 | } | |
372 | ||
373 | static inline u32 get_sta_flags(struct sta_info *sta) | |
374 | { | |
375 | u32 ret; | |
5a9f7b04 | 376 | unsigned long irqfl; |
07346f81 | 377 | |
5a9f7b04 | 378 | spin_lock_irqsave(&sta->flaglock, irqfl); |
07346f81 | 379 | ret = sta->flags; |
5a9f7b04 | 380 | spin_unlock_irqrestore(&sta->flaglock, irqfl); |
07346f81 JB |
381 | |
382 | return ret; | |
383 | } | |
384 | ||
f0706e82 | 385 | |
f0706e82 JB |
386 | |
387 | #define STA_HASH_SIZE 256 | |
388 | #define STA_HASH(sta) (sta[5]) | |
389 | ||
390 | ||
391 | /* Maximum number of frames to buffer per power saving station */ | |
392 | #define STA_MAX_TX_BUFFER 128 | |
393 | ||
394 | /* Minimum buffered frame expiry time. If STA uses listen interval that is | |
395 | * smaller than this value, the minimum value here is used instead. */ | |
396 | #define STA_TX_BUFFER_EXPIRE (10 * HZ) | |
397 | ||
398 | /* How often station data is cleaned up (e.g., expiration of buffered frames) | |
399 | */ | |
400 | #define STA_INFO_CLEANUP_INTERVAL (10 * HZ) | |
401 | ||
d0709a65 JB |
402 | /* |
403 | * Get a STA info, must have be under RCU read lock. | |
404 | */ | |
4b7679a5 | 405 | struct sta_info *sta_info_get(struct ieee80211_local *local, const u8 *addr); |
d0709a65 JB |
406 | /* |
407 | * Get STA info by index, BROKEN! | |
408 | */ | |
ee385855 LCC |
409 | struct sta_info *sta_info_get_by_idx(struct ieee80211_local *local, int idx, |
410 | struct net_device *dev); | |
d0709a65 | 411 | /* |
73651ee6 JB |
412 | * Create a new STA info, caller owns returned structure |
413 | * until sta_info_insert(). | |
d0709a65 | 414 | */ |
73651ee6 JB |
415 | struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata, |
416 | u8 *addr, gfp_t gfp); | |
417 | /* | |
418 | * Insert STA info into hash table/list, returns zero or a | |
419 | * -EEXIST if (if the same MAC address is already present). | |
420 | * | |
421 | * Calling this without RCU protection makes the caller | |
422 | * relinquish its reference to @sta. | |
423 | */ | |
424 | int sta_info_insert(struct sta_info *sta); | |
d0709a65 JB |
425 | /* |
426 | * Unlink a STA info from the hash table/list. | |
427 | * This can NULL the STA pointer if somebody else | |
428 | * has already unlinked it. | |
429 | */ | |
430 | void sta_info_unlink(struct sta_info **sta); | |
f0706e82 | 431 | |
d0709a65 | 432 | void sta_info_destroy(struct sta_info *sta); |
004c872e JB |
433 | void sta_info_set_tim_bit(struct sta_info *sta); |
434 | void sta_info_clear_tim_bit(struct sta_info *sta); | |
435 | ||
d0709a65 JB |
436 | void sta_info_init(struct ieee80211_local *local); |
437 | int sta_info_start(struct ieee80211_local *local); | |
438 | void sta_info_stop(struct ieee80211_local *local); | |
44213b5e | 439 | int sta_info_flush(struct ieee80211_local *local, |
d0709a65 | 440 | struct ieee80211_sub_if_data *sdata); |
dc6676b7 | 441 | void sta_info_flush_delayed(struct ieee80211_sub_if_data *sdata); |
24723d1b JB |
442 | void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata, |
443 | unsigned long exp_time); | |
d0709a65 | 444 | |
f0706e82 | 445 | #endif /* STA_INFO_H */ |