mac80211: move TX info into skb->cb
[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 "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  * @addr: MAC address of this STA
164  * @aid: STA's unique AID (1..2007, 0 = not assigned yet),
165  *      only used in AP (and IBSS?) mode
166  * @flags: STA flags, see &enum ieee80211_sta_info_flags
167  * @ps_tx_buf: buffer of frames to transmit to this station
168  *      when it leaves power saving state
169  * @tx_filtered: buffer of frames we already tried to transmit
170  *      but were filtered by hardware due to STA having entered
171  *      power saving state
172  * @rx_packets: Number of MSDUs received from this STA
173  * @rx_bytes: Number of bytes received from this STA
174  * @supp_rates: Bitmap of supported rates (per band)
175  * @ht_info: HT capabilities of this STA
176  * @lock: used for locking all fields that require locking, see comments
177  *      in the header file.
178  */
179 struct sta_info {
180         /* General information, mostly static */
181         struct list_head list;
182         struct sta_info *hnext;
183         struct ieee80211_local *local;
184         struct ieee80211_sub_if_data *sdata;
185         struct ieee80211_key *key;
186         struct rate_control_ref *rate_ctrl;
187         void *rate_ctrl_priv;
188         spinlock_t lock;
189         struct ieee80211_ht_info ht_info;
190         u64 supp_rates[IEEE80211_NUM_BANDS];
191         u8 addr[ETH_ALEN];
192         u16 aid;
193         u16 listen_interval;
194
195         /*
196          * for use by the internal lifetime management,
197          * see __sta_info_unlink
198          */
199         u8 pin_status;
200
201         /* frequently updated information, locked with lock spinlock */
202         u32 flags;
203
204         /*
205          * STA powersave frame queues, no more than the internal
206          * locking required.
207          */
208         struct sk_buff_head ps_tx_buf;
209         struct sk_buff_head tx_filtered;
210
211         /* Updated from RX path only, no locking requirements */
212         unsigned long rx_packets, rx_bytes;
213         unsigned long wep_weak_iv_count;
214         unsigned long last_rx;
215         unsigned long num_duplicates; /* number of duplicate frames received
216                                        * from this STA */
217         unsigned long rx_fragments; /* number of received MPDUs */
218         unsigned long rx_dropped; /* number of dropped MPDUs from this STA */
219         int last_signal; /* signal of last received frame from this STA */
220         int last_qual;  /* qual of last received frame from this STA */
221         int last_noise; /* noise of last received frame from this STA */
222         /* last received seq/frag number from this STA (per RX queue) */
223         __le16 last_seq_ctrl[NUM_RX_DATA_QUEUES];
224 #ifdef CONFIG_MAC80211_DEBUG_COUNTERS
225         unsigned int wme_rx_queue[NUM_RX_DATA_QUEUES];
226 #endif
227
228         /* Updated from TX status path only, no locking requirements */
229         unsigned long tx_filtered_count;
230         unsigned long tx_retry_failed, tx_retry_count;
231         /* TODO: update in generic code not rate control? */
232         u32 tx_num_consecutive_failures;
233         u32 tx_num_mpdu_ok;
234         u32 tx_num_mpdu_fail;
235         /* moving percentage of failed MSDUs */
236         unsigned int fail_avg;
237
238         /* Updated from TX path only, no locking requirements */
239         unsigned long tx_packets; /* number of RX/TX MSDUs */
240         unsigned long tx_bytes;
241         unsigned long tx_fragments; /* number of transmitted MPDUs */
242         int txrate_idx;
243         int last_txrate_idx;
244 #ifdef CONFIG_MAC80211_DEBUG_COUNTERS
245         unsigned int wme_tx_queue[NUM_RX_DATA_QUEUES];
246 #endif
247
248         /* Debug counters, no locking doesn't matter */
249         int channel_use;
250         int channel_use_raw;
251
252         /*
253          * Aggregation information, locked with lock.
254          */
255         struct sta_ampdu_mlme ampdu_mlme;
256         u8 timer_to_tid[STA_TID_NUM];   /* identity mapping to ID timers */
257         u8 tid_to_tx_q[STA_TID_NUM];    /* map tid to tx queue */
258
259 #ifdef CONFIG_MAC80211_MESH
260         /*
261          * Mesh peer link attributes
262          * TODO: move to a sub-structure that is referenced with pointer?
263          */
264         __le16 llid;            /* Local link ID */
265         __le16 plid;            /* Peer link ID */
266         __le16 reason;          /* Cancel reason on PLINK_HOLDING state */
267         u8 plink_retries;       /* Retries in establishment */
268         bool ignore_plink_timer;
269         enum plink_state plink_state;
270         u32 plink_timeout;
271         struct timer_list plink_timer;
272 #endif
273
274 #ifdef CONFIG_MAC80211_DEBUGFS
275         struct sta_info_debugfsdentries {
276                 struct dentry *dir;
277                 struct dentry *flags;
278                 struct dentry *num_ps_buf_frames;
279                 struct dentry *inactive_ms;
280                 struct dentry *last_seq_ctrl;
281 #ifdef CONFIG_MAC80211_DEBUG_COUNTERS
282                 struct dentry *wme_rx_queue;
283                 struct dentry *wme_tx_queue;
284 #endif
285                 struct dentry *agg_status;
286         } debugfs;
287 #endif
288 };
289
290 static inline enum plink_state sta_plink_state(struct sta_info *sta)
291 {
292 #ifdef CONFIG_MAC80211_MESH
293         return sta->plink_state;
294 #endif
295         return PLINK_LISTEN;
296 }
297
298 static inline void set_sta_flags(struct sta_info *sta, const u32 flags)
299 {
300         spin_lock_bh(&sta->lock);
301         sta->flags |= flags;
302         spin_unlock_bh(&sta->lock);
303 }
304
305 static inline void clear_sta_flags(struct sta_info *sta, const u32 flags)
306 {
307         spin_lock_bh(&sta->lock);
308         sta->flags &= ~flags;
309         spin_unlock_bh(&sta->lock);
310 }
311
312 static inline void set_and_clear_sta_flags(struct sta_info *sta,
313                                            const u32 set, const u32 clear)
314 {
315         spin_lock_bh(&sta->lock);
316         sta->flags |= set;
317         sta->flags &= ~clear;
318         spin_unlock_bh(&sta->lock);
319 }
320
321 static inline u32 test_sta_flags(struct sta_info *sta, const u32 flags)
322 {
323         u32 ret;
324
325         spin_lock_bh(&sta->lock);
326         ret = sta->flags & flags;
327         spin_unlock_bh(&sta->lock);
328
329         return ret;
330 }
331
332 static inline u32 test_and_clear_sta_flags(struct sta_info *sta,
333                                            const u32 flags)
334 {
335         u32 ret;
336
337         spin_lock_bh(&sta->lock);
338         ret = sta->flags & flags;
339         sta->flags &= ~flags;
340         spin_unlock_bh(&sta->lock);
341
342         return ret;
343 }
344
345 static inline u32 get_sta_flags(struct sta_info *sta)
346 {
347         u32 ret;
348
349         spin_lock_bh(&sta->lock);
350         ret = sta->flags;
351         spin_unlock_bh(&sta->lock);
352
353         return ret;
354 }
355
356
357 /* Maximum number of concurrently registered stations */
358 #define MAX_STA_COUNT 2007
359
360 #define STA_HASH_SIZE 256
361 #define STA_HASH(sta) (sta[5])
362
363
364 /* Maximum number of frames to buffer per power saving station */
365 #define STA_MAX_TX_BUFFER 128
366
367 /* Minimum buffered frame expiry time. If STA uses listen interval that is
368  * smaller than this value, the minimum value here is used instead. */
369 #define STA_TX_BUFFER_EXPIRE (10 * HZ)
370
371 /* How often station data is cleaned up (e.g., expiration of buffered frames)
372  */
373 #define STA_INFO_CLEANUP_INTERVAL (10 * HZ)
374
375 /*
376  * Get a STA info, must have be under RCU read lock.
377  */
378 struct sta_info *sta_info_get(struct ieee80211_local *local, u8 *addr);
379 /*
380  * Get STA info by index, BROKEN!
381  */
382 struct sta_info *sta_info_get_by_idx(struct ieee80211_local *local, int idx,
383                                       struct net_device *dev);
384 /*
385  * Create a new STA info, caller owns returned structure
386  * until sta_info_insert().
387  */
388 struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
389                                 u8 *addr, gfp_t gfp);
390 /*
391  * Insert STA info into hash table/list, returns zero or a
392  * -EEXIST if (if the same MAC address is already present).
393  *
394  * Calling this without RCU protection makes the caller
395  * relinquish its reference to @sta.
396  */
397 int sta_info_insert(struct sta_info *sta);
398 /*
399  * Unlink a STA info from the hash table/list.
400  * This can NULL the STA pointer if somebody else
401  * has already unlinked it.
402  */
403 void sta_info_unlink(struct sta_info **sta);
404 void __sta_info_unlink(struct sta_info **sta);
405
406 void sta_info_destroy(struct sta_info *sta);
407 void sta_info_set_tim_bit(struct sta_info *sta);
408 void sta_info_clear_tim_bit(struct sta_info *sta);
409
410 void sta_info_init(struct ieee80211_local *local);
411 int sta_info_start(struct ieee80211_local *local);
412 void sta_info_stop(struct ieee80211_local *local);
413 int sta_info_flush(struct ieee80211_local *local,
414                     struct ieee80211_sub_if_data *sdata);
415 void sta_info_flush_delayed(struct ieee80211_sub_if_data *sdata);
416
417 #endif /* STA_INFO_H */