mac80211: allow station add/remove to sleep
[linux-2.6.git] / net / mac80211 / sta_info.h
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 <linux/workqueue.h>
16 #include "key.h"
17
18 /**
19  * enum ieee80211_sta_info_flags - Stations flags
20  *
21  * These flags are used with &struct sta_info's @flags member.
22  *
23  * @WLAN_STA_AUTH: Station is authenticated.
24  * @WLAN_STA_ASSOC: Station is associated.
25  * @WLAN_STA_PS_STA: Station is in power-save mode
26  * @WLAN_STA_AUTHORIZED: Station is authorized to send/receive traffic.
27  *      This bit is always checked so needs to be enabled for all stations
28  *      when virtual port control is not in use.
29  * @WLAN_STA_SHORT_PREAMBLE: Station is capable of receiving short-preamble
30  *      frames.
31  * @WLAN_STA_ASSOC_AP: We're associated to that station, it is an AP.
32  * @WLAN_STA_WME: Station is a QoS-STA.
33  * @WLAN_STA_WDS: Station is one of our WDS peers.
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  * @WLAN_STA_MFP: Management frame protection is used with this STA.
38  * @WLAN_STA_SUSPEND: Set/cleared during a suspend/resume cycle.
39  *      Used to deny ADDBA requests (both TX and RX).
40  * @WLAN_STA_PS_DRIVER: driver requires keeping this station in
41  *      power-save mode logically to flush frames that might still
42  *      be in the queues
43  * @WLAN_STA_PSPOLL: Station sent PS-poll while driver was keeping
44  *      station in power-save mode, reply when the driver unblocks.
45  */
46 enum ieee80211_sta_info_flags {
47         WLAN_STA_AUTH           = 1<<0,
48         WLAN_STA_ASSOC          = 1<<1,
49         WLAN_STA_PS_STA         = 1<<2,
50         WLAN_STA_AUTHORIZED     = 1<<3,
51         WLAN_STA_SHORT_PREAMBLE = 1<<4,
52         WLAN_STA_ASSOC_AP       = 1<<5,
53         WLAN_STA_WME            = 1<<6,
54         WLAN_STA_WDS            = 1<<7,
55         WLAN_STA_CLEAR_PS_FILT  = 1<<9,
56         WLAN_STA_MFP            = 1<<10,
57         WLAN_STA_SUSPEND        = 1<<11,
58         WLAN_STA_PS_DRIVER      = 1<<12,
59         WLAN_STA_PSPOLL         = 1<<13,
60 };
61
62 #define STA_TID_NUM 16
63 #define ADDBA_RESP_INTERVAL HZ
64 #define HT_AGG_MAX_RETRIES              (0x3)
65
66 #define HT_AGG_STATE_INITIATOR_SHIFT    (4)
67
68 #define HT_ADDBA_REQUESTED_MSK          BIT(0)
69 #define HT_ADDBA_DRV_READY_MSK          BIT(1)
70 #define HT_ADDBA_RECEIVED_MSK           BIT(2)
71 #define HT_AGG_STATE_REQ_STOP_BA_MSK    BIT(3)
72 #define HT_AGG_STATE_INITIATOR_MSK      BIT(HT_AGG_STATE_INITIATOR_SHIFT)
73 #define HT_AGG_STATE_IDLE               (0x0)
74 #define HT_AGG_STATE_OPERATIONAL        (HT_ADDBA_REQUESTED_MSK |       \
75                                          HT_ADDBA_DRV_READY_MSK |       \
76                                          HT_ADDBA_RECEIVED_MSK)
77
78 /**
79  * struct tid_ampdu_tx - TID aggregation information (Tx).
80  *
81  * @addba_resp_timer: timer for peer's response to addba request
82  * @pending: pending frames queue -- use sta's spinlock to protect
83  * @ssn: Starting Sequence Number expected to be aggregated.
84  * @dialog_token: dialog token for aggregation session
85  */
86 struct tid_ampdu_tx {
87         struct timer_list addba_resp_timer;
88         struct sk_buff_head pending;
89         u16 ssn;
90         u8 dialog_token;
91 };
92
93 /**
94  * struct tid_ampdu_rx - TID aggregation information (Rx).
95  *
96  * @reorder_buf: buffer to reorder incoming aggregated MPDUs
97  * @reorder_time: jiffies when skb was added
98  * @session_timer: check if peer keeps Tx-ing on the TID (by timeout value)
99  * @head_seq_num: head sequence number in reordering buffer.
100  * @stored_mpdu_num: number of MPDUs in reordering buffer
101  * @ssn: Starting Sequence Number expected to be aggregated.
102  * @buf_size: buffer size for incoming A-MPDUs
103  * @timeout: reset timer value (in TUs).
104  * @dialog_token: dialog token for aggregation session
105  * @shutdown: this session is being shut down due to STA removal
106  */
107 struct tid_ampdu_rx {
108         struct sk_buff **reorder_buf;
109         unsigned long *reorder_time;
110         struct timer_list session_timer;
111         u16 head_seq_num;
112         u16 stored_mpdu_num;
113         u16 ssn;
114         u16 buf_size;
115         u16 timeout;
116         u8 dialog_token;
117         bool shutdown;
118 };
119
120 /**
121  * enum plink_state - state of a mesh peer link finite state machine
122  *
123  * @PLINK_LISTEN: initial state, considered the implicit state of non existant
124  *      mesh peer links
125  * @PLINK_OPN_SNT: mesh plink open frame has been sent to this mesh peer
126  * @PLINK_OPN_RCVD: mesh plink open frame has been received from this mesh peer
127  * @PLINK_CNF_RCVD: mesh plink confirm frame has been received from this mesh
128  *      peer
129  * @PLINK_ESTAB: mesh peer link is established
130  * @PLINK_HOLDING: mesh peer link is being closed or cancelled
131  * @PLINK_BLOCKED: all frames transmitted from this mesh plink are discarded
132  */
133 enum plink_state {
134         PLINK_LISTEN,
135         PLINK_OPN_SNT,
136         PLINK_OPN_RCVD,
137         PLINK_CNF_RCVD,
138         PLINK_ESTAB,
139         PLINK_HOLDING,
140         PLINK_BLOCKED
141 };
142
143 /**
144  * struct sta_ampdu_mlme - STA aggregation information.
145  *
146  * @tid_state_rx: TID's state in Rx session state machine.
147  * @tid_rx: aggregation info for Rx per TID
148  * @tid_state_tx: TID's state in Tx session state machine.
149  * @tid_tx: aggregation info for Tx per TID
150  * @addba_req_num: number of times addBA request has been sent.
151  * @dialog_token_allocator: dialog token enumerator for each new session;
152  */
153 struct sta_ampdu_mlme {
154         /* rx */
155         u8 tid_state_rx[STA_TID_NUM];
156         struct tid_ampdu_rx *tid_rx[STA_TID_NUM];
157         /* tx */
158         u8 tid_state_tx[STA_TID_NUM];
159         struct tid_ampdu_tx *tid_tx[STA_TID_NUM];
160         u8 addba_req_num[STA_TID_NUM];
161         u8 dialog_token_allocator;
162 };
163
164
165 /**
166  * struct sta_info - STA information
167  *
168  * This structure collects information about a station that
169  * mac80211 is communicating with.
170  *
171  * @list: global linked list entry
172  * @hnext: hash table linked list pointer
173  * @local: pointer to the global information
174  * @sdata: virtual interface this station belongs to
175  * @key: peer key negotiated with this station, if any
176  * @rate_ctrl: rate control algorithm reference
177  * @rate_ctrl_priv: rate control private per-STA pointer
178  * @last_tx_rate: rate used for last transmit, to report to userspace as
179  *      "the" transmit rate
180  * @lock: used for locking all fields that require locking, see comments
181  *      in the header file.
182  * @flaglock: spinlock for flags accesses
183  * @drv_unblock_wk: used for driver PS unblocking
184  * @listen_interval: listen interval of this station, when we're acting as AP
185  * @flags: STA flags, see &enum ieee80211_sta_info_flags
186  * @ps_tx_buf: buffer of frames to transmit to this station
187  *      when it leaves power saving state
188  * @tx_filtered: buffer of frames we already tried to transmit
189  *      but were filtered by hardware due to STA having entered
190  *      power saving state
191  * @rx_packets: Number of MSDUs received from this STA
192  * @rx_bytes: Number of bytes received from this STA
193  * @wep_weak_iv_count: number of weak WEP IVs received from this station
194  * @last_rx: time (in jiffies) when last frame was received from this STA
195  * @num_duplicates: number of duplicate frames received from this STA
196  * @rx_fragments: number of received MPDUs
197  * @rx_dropped: number of dropped MPDUs from this STA
198  * @last_signal: signal of last received frame from this STA
199  * @last_noise: noise of last received frame from this STA
200  * @last_seq_ctrl: last received seq/frag number from this STA (per RX queue)
201  * @tx_filtered_count: number of frames the hardware filtered for this STA
202  * @tx_retry_failed: number of frames that failed retry
203  * @tx_retry_count: total number of retries for frames to this STA
204  * @fail_avg: moving percentage of failed MSDUs
205  * @tx_packets: number of RX/TX MSDUs
206  * @tx_bytes: number of bytes transmitted to this STA
207  * @tx_fragments: number of transmitted MPDUs
208  * @tid_seq: per-TID sequence numbers for sending to this STA
209  * @ampdu_mlme: A-MPDU state machine state
210  * @timer_to_tid: identity mapping to ID timers
211  * @llid: Local link ID
212  * @plid: Peer link ID
213  * @reason: Cancel reason on PLINK_HOLDING state
214  * @plink_retries: Retries in establishment
215  * @ignore_plink_timer: ignore the peer-link timer (used internally)
216  * @plink_state: peer link state
217  * @plink_timeout: timeout of peer link
218  * @plink_timer: peer link watch timer
219  * @plink_timer_was_running: used by suspend/resume to restore timers
220  * @debugfs: debug filesystem info
221  * @sta: station information we share with the driver
222  * @dead: set to true when sta is unlinked
223  * @uploaded: set to true when sta is uploaded to the driver
224  */
225 struct sta_info {
226         /* General information, mostly static */
227         struct list_head list;
228         struct sta_info *hnext;
229         struct ieee80211_local *local;
230         struct ieee80211_sub_if_data *sdata;
231         struct ieee80211_key *key;
232         struct rate_control_ref *rate_ctrl;
233         void *rate_ctrl_priv;
234         spinlock_t lock;
235         spinlock_t flaglock;
236
237         struct work_struct drv_unblock_wk;
238
239         u16 listen_interval;
240
241         bool dead;
242
243         bool uploaded;
244
245         /*
246          * frequently updated, locked with own spinlock (flaglock),
247          * use the accessors defined below
248          */
249         u32 flags;
250
251         /*
252          * STA powersave frame queues, no more than the internal
253          * locking required.
254          */
255         struct sk_buff_head ps_tx_buf;
256         struct sk_buff_head tx_filtered;
257
258         /* Updated from RX path only, no locking requirements */
259         unsigned long rx_packets, rx_bytes;
260         unsigned long wep_weak_iv_count;
261         unsigned long last_rx;
262         unsigned long num_duplicates;
263         unsigned long rx_fragments;
264         unsigned long rx_dropped;
265         int last_signal;
266         int last_noise;
267         __le16 last_seq_ctrl[NUM_RX_DATA_QUEUES];
268
269         /* Updated from TX status path only, no locking requirements */
270         unsigned long tx_filtered_count;
271         unsigned long tx_retry_failed, tx_retry_count;
272         /* moving percentage of failed MSDUs */
273         unsigned int fail_avg;
274
275         /* Updated from TX path only, no locking requirements */
276         unsigned long tx_packets;
277         unsigned long tx_bytes;
278         unsigned long tx_fragments;
279         struct ieee80211_tx_rate last_tx_rate;
280         u16 tid_seq[IEEE80211_QOS_CTL_TID_MASK + 1];
281
282         /*
283          * Aggregation information, locked with lock.
284          */
285         struct sta_ampdu_mlme ampdu_mlme;
286         u8 timer_to_tid[STA_TID_NUM];
287
288 #ifdef CONFIG_MAC80211_MESH
289         /*
290          * Mesh peer link attributes
291          * TODO: move to a sub-structure that is referenced with pointer?
292          */
293         __le16 llid;
294         __le16 plid;
295         __le16 reason;
296         u8 plink_retries;
297         bool ignore_plink_timer;
298         bool plink_timer_was_running;
299         enum plink_state plink_state;
300         u32 plink_timeout;
301         struct timer_list plink_timer;
302 #endif
303
304 #ifdef CONFIG_MAC80211_DEBUGFS
305         struct sta_info_debugfsdentries {
306                 struct dentry *dir;
307                 bool add_has_run;
308         } debugfs;
309 #endif
310
311         /* keep last! */
312         struct ieee80211_sta sta;
313 };
314
315 static inline enum plink_state sta_plink_state(struct sta_info *sta)
316 {
317 #ifdef CONFIG_MAC80211_MESH
318         return sta->plink_state;
319 #endif
320         return PLINK_LISTEN;
321 }
322
323 static inline void set_sta_flags(struct sta_info *sta, const u32 flags)
324 {
325         unsigned long irqfl;
326
327         spin_lock_irqsave(&sta->flaglock, irqfl);
328         sta->flags |= flags;
329         spin_unlock_irqrestore(&sta->flaglock, irqfl);
330 }
331
332 static inline void clear_sta_flags(struct sta_info *sta, const u32 flags)
333 {
334         unsigned long irqfl;
335
336         spin_lock_irqsave(&sta->flaglock, irqfl);
337         sta->flags &= ~flags;
338         spin_unlock_irqrestore(&sta->flaglock, irqfl);
339 }
340
341 static inline u32 test_sta_flags(struct sta_info *sta, const u32 flags)
342 {
343         u32 ret;
344         unsigned long irqfl;
345
346         spin_lock_irqsave(&sta->flaglock, irqfl);
347         ret = sta->flags & flags;
348         spin_unlock_irqrestore(&sta->flaglock, irqfl);
349
350         return ret;
351 }
352
353 static inline u32 test_and_clear_sta_flags(struct sta_info *sta,
354                                            const u32 flags)
355 {
356         u32 ret;
357         unsigned long irqfl;
358
359         spin_lock_irqsave(&sta->flaglock, irqfl);
360         ret = sta->flags & flags;
361         sta->flags &= ~flags;
362         spin_unlock_irqrestore(&sta->flaglock, irqfl);
363
364         return ret;
365 }
366
367 static inline u32 get_sta_flags(struct sta_info *sta)
368 {
369         u32 ret;
370         unsigned long irqfl;
371
372         spin_lock_irqsave(&sta->flaglock, irqfl);
373         ret = sta->flags;
374         spin_unlock_irqrestore(&sta->flaglock, irqfl);
375
376         return ret;
377 }
378
379
380
381 #define STA_HASH_SIZE 256
382 #define STA_HASH(sta) (sta[5])
383
384
385 /* Maximum number of frames to buffer per power saving station */
386 #define STA_MAX_TX_BUFFER 128
387
388 /* Minimum buffered frame expiry time. If STA uses listen interval that is
389  * smaller than this value, the minimum value here is used instead. */
390 #define STA_TX_BUFFER_EXPIRE (10 * HZ)
391
392 /* How often station data is cleaned up (e.g., expiration of buffered frames)
393  */
394 #define STA_INFO_CLEANUP_INTERVAL (10 * HZ)
395
396 /*
397  * Get a STA info, must be under RCU read lock.
398  */
399 struct sta_info *sta_info_get(struct ieee80211_sub_if_data *sdata,
400                               const u8 *addr);
401
402 struct sta_info *sta_info_get_bss(struct ieee80211_sub_if_data *sdata,
403                                   const u8 *addr);
404
405 static inline
406 void for_each_sta_info_type_check(struct ieee80211_local *local,
407                                   const u8 *addr,
408                                   struct sta_info *sta,
409                                   struct sta_info *nxt)
410 {
411 }
412
413 #define for_each_sta_info(local, _addr, sta, nxt)                       \
414         for (   /* initialise loop */                                   \
415                 sta = rcu_dereference(local->sta_hash[STA_HASH(_addr)]),\
416                 nxt = sta ? rcu_dereference(sta->hnext) : NULL;         \
417                 /* typecheck */                                         \
418                 for_each_sta_info_type_check(local, (_addr), sta, nxt), \
419                 /* continue condition */                                \
420                 sta;                                                    \
421                 /* advance loop */                                      \
422                 sta = nxt,                                              \
423                 nxt = sta ? rcu_dereference(sta->hnext) : NULL          \
424              )                                                          \
425         /* compare address and run code only if it matches */           \
426         if (memcmp(sta->sta.addr, (_addr), ETH_ALEN) == 0)
427
428 /*
429  * Get STA info by index, BROKEN!
430  */
431 struct sta_info *sta_info_get_by_idx(struct ieee80211_sub_if_data *sdata,
432                                      int idx);
433 /*
434  * Create a new STA info, caller owns returned structure
435  * until sta_info_insert().
436  */
437 struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
438                                 u8 *addr, gfp_t gfp);
439 /*
440  * Insert STA info into hash table/list, returns zero or a
441  * -EEXIST if (if the same MAC address is already present).
442  *
443  * Calling the non-rcu version makes the caller relinquish,
444  * the _rcu version calls read_lock_rcu() and must be called
445  * without it held.
446  */
447 int sta_info_insert(struct sta_info *sta);
448 int sta_info_insert_rcu(struct sta_info *sta) __acquires(RCU);
449 int sta_info_insert_atomic(struct sta_info *sta);
450
451 int sta_info_destroy_addr(struct ieee80211_sub_if_data *sdata,
452                           const u8 *addr);
453 int sta_info_destroy_addr_bss(struct ieee80211_sub_if_data *sdata,
454                               const u8 *addr);
455
456 void sta_info_set_tim_bit(struct sta_info *sta);
457 void sta_info_clear_tim_bit(struct sta_info *sta);
458
459 void sta_info_init(struct ieee80211_local *local);
460 int sta_info_start(struct ieee80211_local *local);
461 void sta_info_stop(struct ieee80211_local *local);
462 int sta_info_flush(struct ieee80211_local *local,
463                    struct ieee80211_sub_if_data *sdata);
464 void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata,
465                           unsigned long exp_time);
466
467 void ieee80211_sta_ps_deliver_wakeup(struct sta_info *sta);
468 void ieee80211_sta_ps_deliver_poll_response(struct sta_info *sta);
469
470 #endif /* STA_INFO_H */