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 JB |
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. | |
238814fd JB |
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, | |
836341a7 JB |
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, | |
d46e144b | 48 | WLAN_STA_CLEAR_PS_FILT = 1<<9, |
238814fd | 49 | }; |
f0706e82 | 50 | |
5aae2880 RR |
51 | #define STA_TID_NUM 16 |
52 | #define ADDBA_RESP_INTERVAL HZ | |
80656c20 | 53 | #define HT_AGG_MAX_RETRIES (0x3) |
5aae2880 RR |
54 | |
55 | #define HT_AGG_STATE_INITIATOR_SHIFT (4) | |
56 | ||
80656c20 RR |
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) | |
5aae2880 | 60 | #define HT_AGG_STATE_REQ_STOP_BA_MSK BIT(3) |
80656c20 | 61 | #define HT_AGG_STATE_INITIATOR_MSK BIT(HT_AGG_STATE_INITIATOR_SHIFT) |
5aae2880 | 62 | #define HT_AGG_STATE_IDLE (0x0) |
80656c20 RR |
63 | #define HT_AGG_STATE_OPERATIONAL (HT_ADDBA_REQUESTED_MSK | \ |
64 | HT_ADDBA_DRV_READY_MSK | \ | |
65 | HT_ADDBA_RECEIVED_MSK) | |
24709182 | 66 | #define HT_AGG_STATE_DEBUGFS_CTL BIT(7) |
80656c20 RR |
67 | |
68 | /** | |
69 | * struct tid_ampdu_tx - TID aggregation information (Tx). | |
70 | * | |
80656c20 | 71 | * @addba_resp_timer: timer for peer's response to addba request |
cee24a3e RR |
72 | * @ssn: Starting Sequence Number expected to be aggregated. |
73 | * @dialog_token: dialog token for aggregation session | |
80656c20 RR |
74 | */ |
75 | struct tid_ampdu_tx { | |
80656c20 | 76 | struct timer_list addba_resp_timer; |
cee24a3e RR |
77 | u16 ssn; |
78 | u8 dialog_token; | |
80656c20 | 79 | }; |
5aae2880 RR |
80 | |
81 | /** | |
82 | * struct tid_ampdu_rx - TID aggregation information (Rx). | |
83 | * | |
5aae2880 RR |
84 | * @reorder_buf: buffer to reorder incoming aggregated MPDUs |
85 | * @session_timer: check if peer keeps Tx-ing on the TID (by timeout value) | |
056cdd59 JB |
86 | * @head_seq_num: head sequence number in reordering buffer. |
87 | * @stored_mpdu_num: number of MPDUs in reordering buffer | |
cee24a3e RR |
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 | |
5aae2880 RR |
92 | */ |
93 | struct tid_ampdu_rx { | |
5aae2880 RR |
94 | struct sk_buff **reorder_buf; |
95 | struct timer_list session_timer; | |
056cdd59 JB |
96 | u16 head_seq_num; |
97 | u16 stored_mpdu_num; | |
cee24a3e RR |
98 | u16 ssn; |
99 | u16 buf_size; | |
100 | u16 timeout; | |
101 | u8 dialog_token; | |
5aae2880 RR |
102 | }; |
103 | ||
b4e08ea1 LCC |
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 | */ | |
ee385855 | 117 | enum plink_state { |
b4e08ea1 LCC |
118 | PLINK_LISTEN, |
119 | PLINK_OPN_SNT, | |
120 | PLINK_OPN_RCVD, | |
121 | PLINK_CNF_RCVD, | |
122 | PLINK_ESTAB, | |
123 | PLINK_HOLDING, | |
124 | PLINK_BLOCKED | |
ee385855 | 125 | }; |
ee385855 | 126 | |
5aae2880 RR |
127 | /** |
128 | * struct sta_ampdu_mlme - STA aggregation information. | |
129 | * | |
cee24a3e | 130 | * @tid_state_rx: TID's state in Rx session state machine. |
80656c20 | 131 | * @tid_rx: aggregation info for Rx per TID |
5aae2880 | 132 | * @ampdu_rx: for locking sections in aggregation Rx flow |
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 RR |
136 | * @ampdu_tx: for locking sectionsi in aggregation Tx flow |
137 | * @dialog_token_allocator: dialog token enumerator for each new session; | |
5aae2880 RR |
138 | */ |
139 | struct sta_ampdu_mlme { | |
cee24a3e RR |
140 | /* rx */ |
141 | u8 tid_state_rx[STA_TID_NUM]; | |
142 | struct tid_ampdu_rx *tid_rx[STA_TID_NUM]; | |
5aae2880 | 143 | spinlock_t ampdu_rx; |
cee24a3e RR |
144 | /* tx */ |
145 | u8 tid_state_tx[STA_TID_NUM]; | |
146 | struct tid_ampdu_tx *tid_tx[STA_TID_NUM]; | |
147 | u8 addba_req_num[STA_TID_NUM]; | |
80656c20 RR |
148 | spinlock_t ampdu_tx; |
149 | u8 dialog_token_allocator; | |
5aae2880 | 150 | }; |
f0706e82 | 151 | |
d0709a65 JB |
152 | |
153 | /* see __sta_info_unlink */ | |
154 | #define STA_INFO_PIN_STAT_NORMAL 0 | |
155 | #define STA_INFO_PIN_STAT_PINNED 1 | |
156 | #define STA_INFO_PIN_STAT_DESTROY 2 | |
157 | ||
693b1bbc JB |
158 | /** |
159 | * struct sta_info - STA information | |
160 | * | |
161 | * This structure collects information about a station that | |
162 | * mac80211 is communicating with. | |
163 | * | |
164 | * @list: global linked list entry | |
165 | * @hnext: hash table linked list pointer | |
166 | * @local: pointer to the global information | |
167 | * @addr: MAC address of this STA | |
168 | * @aid: STA's unique AID (1..2007, 0 = not assigned yet), | |
169 | * only used in AP (and IBSS?) mode | |
170 | * @flags: STA flags, see &enum ieee80211_sta_info_flags | |
171 | * @ps_tx_buf: buffer of frames to transmit to this station | |
172 | * when it leaves power saving state | |
173 | * @tx_filtered: buffer of frames we already tried to transmit | |
174 | * but were filtered by hardware due to STA having entered | |
175 | * power saving state | |
176 | * @rx_packets: Number of MSDUs received from this STA | |
177 | * @rx_bytes: Number of bytes received from this STA | |
178 | * @supp_rates: Bitmap of supported rates (per band) | |
179 | * @ht_info: HT capabilities of this STA | |
180 | */ | |
f0706e82 | 181 | struct sta_info { |
693b1bbc | 182 | /* General information, mostly static */ |
f0706e82 | 183 | struct list_head list; |
693b1bbc | 184 | struct sta_info *hnext; |
f0706e82 | 185 | struct ieee80211_local *local; |
d0709a65 | 186 | struct ieee80211_sub_if_data *sdata; |
f0706e82 | 187 | struct ieee80211_key *key; |
f0706e82 JB |
188 | struct rate_control_ref *rate_ctrl; |
189 | void *rate_ctrl_priv; | |
693b1bbc JB |
190 | struct ieee80211_ht_info ht_info; |
191 | u64 supp_rates[IEEE80211_NUM_BANDS]; | |
192 | u8 addr[ETH_ALEN]; | |
193 | u16 aid; | |
194 | u16 listen_interval; | |
f0706e82 | 195 | |
693b1bbc JB |
196 | /* |
197 | * for use by the internal lifetime management, | |
198 | * see __sta_info_unlink | |
199 | */ | |
200 | u8 pin_status; | |
201 | ||
202 | /* frequently updated information, needs locking? */ | |
203 | u32 flags; | |
204 | ||
205 | /* | |
206 | * STA powersave frame queues, no more than the internal | |
207 | * locking required. | |
208 | */ | |
209 | struct sk_buff_head ps_tx_buf; | |
210 | struct sk_buff_head tx_filtered; | |
211 | ||
212 | /* Updated from RX path only, no locking requirements */ | |
213 | unsigned long rx_packets, rx_bytes; | |
214 | unsigned long wep_weak_iv_count; | |
215 | unsigned long last_rx; | |
f0706e82 JB |
216 | unsigned long num_duplicates; /* number of duplicate frames received |
217 | * from this STA */ | |
f0706e82 JB |
218 | unsigned long rx_fragments; /* number of received MPDUs */ |
219 | unsigned long rx_dropped; /* number of dropped MPDUs from this STA */ | |
f0706e82 JB |
220 | int last_rssi; /* RSSI of last received frame from this STA */ |
221 | int last_signal; /* signal of last received frame from this STA */ | |
222 | int last_noise; /* noise of last received frame from this STA */ | |
693b1bbc JB |
223 | /* last received seq/frag number from this STA (per RX queue) */ |
224 | __le16 last_seq_ctrl[NUM_RX_DATA_QUEUES]; | |
f0706e82 JB |
225 | #ifdef CONFIG_MAC80211_DEBUG_COUNTERS |
226 | unsigned int wme_rx_queue[NUM_RX_DATA_QUEUES]; | |
693b1bbc JB |
227 | #endif |
228 | ||
229 | /* Updated from TX status path only, no locking requirements */ | |
230 | unsigned long tx_filtered_count; | |
231 | unsigned long tx_retry_failed, tx_retry_count; | |
232 | /* TODO: update in generic code not rate control? */ | |
233 | u32 tx_num_consecutive_failures; | |
234 | u32 tx_num_mpdu_ok; | |
235 | u32 tx_num_mpdu_fail; | |
236 | /* moving percentage of failed MSDUs */ | |
237 | unsigned int fail_avg; | |
238 | ||
239 | /* Updated from TX path only, no locking requirements */ | |
240 | unsigned long tx_packets; /* number of RX/TX MSDUs */ | |
241 | unsigned long tx_bytes; | |
242 | unsigned long tx_fragments; /* number of transmitted MPDUs */ | |
243 | int txrate_idx; | |
244 | int last_txrate_idx; | |
245 | #ifdef CONFIG_MAC80211_DEBUG_COUNTERS | |
f0706e82 | 246 | unsigned int wme_tx_queue[NUM_RX_DATA_QUEUES]; |
693b1bbc | 247 | #endif |
f0706e82 | 248 | |
693b1bbc JB |
249 | /* Debug counters, no locking doesn't matter */ |
250 | int channel_use; | |
251 | int channel_use_raw; | |
e9f207f0 | 252 | |
d0709a65 | 253 | /* |
693b1bbc | 254 | * Aggregation information, comes with own locking. |
d0709a65 | 255 | */ |
5aae2880 | 256 | struct sta_ampdu_mlme ampdu_mlme; |
693b1bbc | 257 | u8 timer_to_tid[STA_TID_NUM]; /* identity mapping to ID timers */ |
80656c20 | 258 | u8 tid_to_tx_q[STA_TID_NUM]; /* map tid to tx queue */ |
693b1bbc | 259 | |
ee385855 | 260 | #ifdef CONFIG_MAC80211_MESH |
693b1bbc JB |
261 | /* |
262 | * Mesh peer link attributes | |
263 | * TODO: move to a sub-structure that is referenced with pointer? | |
264 | */ | |
ee385855 LCC |
265 | __le16 llid; /* Local link ID */ |
266 | __le16 plid; /* Peer link ID */ | |
b4e08ea1 | 267 | __le16 reason; /* Cancel reason on PLINK_HOLDING state */ |
7495883b JB |
268 | u8 plink_retries; /* Retries in establishment */ |
269 | bool ignore_plink_timer; | |
ee385855 LCC |
270 | enum plink_state plink_state; |
271 | u32 plink_timeout; | |
272 | struct timer_list plink_timer; | |
ee385855 LCC |
273 | spinlock_t plink_lock; /* For peer_state reads / updates and other |
274 | updates in the structure. Ensures robust | |
275 | transitions for the peerlink FSM */ | |
276 | #endif | |
10816d40 | 277 | |
e9f207f0 JB |
278 | #ifdef CONFIG_MAC80211_DEBUGFS |
279 | struct sta_info_debugfsdentries { | |
280 | struct dentry *dir; | |
281 | struct dentry *flags; | |
282 | struct dentry *num_ps_buf_frames; | |
e9f207f0 JB |
283 | struct dentry *inactive_ms; |
284 | struct dentry *last_seq_ctrl; | |
285 | #ifdef CONFIG_MAC80211_DEBUG_COUNTERS | |
286 | struct dentry *wme_rx_queue; | |
287 | struct dentry *wme_tx_queue; | |
288 | #endif | |
eb2ba62e | 289 | struct dentry *agg_status; |
e9f207f0 JB |
290 | } debugfs; |
291 | #endif | |
f0706e82 JB |
292 | }; |
293 | ||
d6d1a5a7 JB |
294 | static inline enum plink_state sta_plink_state(struct sta_info *sta) |
295 | { | |
296 | #ifdef CONFIG_MAC80211_MESH | |
297 | return sta->plink_state; | |
298 | #endif | |
b4e08ea1 | 299 | return PLINK_LISTEN; |
d6d1a5a7 JB |
300 | } |
301 | ||
f0706e82 JB |
302 | |
303 | /* Maximum number of concurrently registered stations */ | |
304 | #define MAX_STA_COUNT 2007 | |
305 | ||
306 | #define STA_HASH_SIZE 256 | |
307 | #define STA_HASH(sta) (sta[5]) | |
308 | ||
309 | ||
310 | /* Maximum number of frames to buffer per power saving station */ | |
311 | #define STA_MAX_TX_BUFFER 128 | |
312 | ||
313 | /* Minimum buffered frame expiry time. If STA uses listen interval that is | |
314 | * smaller than this value, the minimum value here is used instead. */ | |
315 | #define STA_TX_BUFFER_EXPIRE (10 * HZ) | |
316 | ||
317 | /* How often station data is cleaned up (e.g., expiration of buffered frames) | |
318 | */ | |
319 | #define STA_INFO_CLEANUP_INTERVAL (10 * HZ) | |
320 | ||
d0709a65 JB |
321 | /* |
322 | * Get a STA info, must have be under RCU read lock. | |
323 | */ | |
324 | struct sta_info *sta_info_get(struct ieee80211_local *local, u8 *addr); | |
325 | /* | |
326 | * Get STA info by index, BROKEN! | |
327 | */ | |
ee385855 LCC |
328 | struct sta_info *sta_info_get_by_idx(struct ieee80211_local *local, int idx, |
329 | struct net_device *dev); | |
d0709a65 | 330 | /* |
73651ee6 JB |
331 | * Create a new STA info, caller owns returned structure |
332 | * until sta_info_insert(). | |
d0709a65 | 333 | */ |
73651ee6 JB |
334 | struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata, |
335 | u8 *addr, gfp_t gfp); | |
336 | /* | |
337 | * Insert STA info into hash table/list, returns zero or a | |
338 | * -EEXIST if (if the same MAC address is already present). | |
339 | * | |
340 | * Calling this without RCU protection makes the caller | |
341 | * relinquish its reference to @sta. | |
342 | */ | |
343 | int sta_info_insert(struct sta_info *sta); | |
d0709a65 JB |
344 | /* |
345 | * Unlink a STA info from the hash table/list. | |
346 | * This can NULL the STA pointer if somebody else | |
347 | * has already unlinked it. | |
348 | */ | |
349 | void sta_info_unlink(struct sta_info **sta); | |
cb585bcc | 350 | void __sta_info_unlink(struct sta_info **sta); |
f0706e82 | 351 | |
d0709a65 | 352 | void sta_info_destroy(struct sta_info *sta); |
004c872e JB |
353 | void sta_info_set_tim_bit(struct sta_info *sta); |
354 | void sta_info_clear_tim_bit(struct sta_info *sta); | |
355 | ||
d0709a65 JB |
356 | void sta_info_init(struct ieee80211_local *local); |
357 | int sta_info_start(struct ieee80211_local *local); | |
358 | void sta_info_stop(struct ieee80211_local *local); | |
44213b5e | 359 | int sta_info_flush(struct ieee80211_local *local, |
d0709a65 | 360 | struct ieee80211_sub_if_data *sdata); |
dc6676b7 | 361 | void sta_info_flush_delayed(struct ieee80211_sub_if_data *sdata); |
d0709a65 | 362 | |
f0706e82 | 363 | #endif /* STA_INFO_H */ |