]> git.karo-electronics.de Git - karo-tx-linux.git/blob - net/mac80211/sta_info.h
Merge tag 'usb-3.3-rc6' of git://git.kernel.org/pub/scm/linux/kernel/git/gregkh/usb
[karo-tx-linux.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 <linux/average.h>
17 #include "key.h"
18
19 /**
20  * enum ieee80211_sta_info_flags - Stations flags
21  *
22  * These flags are used with &struct sta_info's @flags member, but
23  * only indirectly with set_sta_flag() and friends.
24  *
25  * @WLAN_STA_AUTH: Station is authenticated.
26  * @WLAN_STA_ASSOC: Station is associated.
27  * @WLAN_STA_PS_STA: Station is in power-save mode
28  * @WLAN_STA_AUTHORIZED: Station is authorized to send/receive traffic.
29  *      This bit is always checked so needs to be enabled for all stations
30  *      when virtual port control is not in use.
31  * @WLAN_STA_SHORT_PREAMBLE: Station is capable of receiving short-preamble
32  *      frames.
33  * @WLAN_STA_WME: Station is a QoS-STA.
34  * @WLAN_STA_WDS: Station is one of our WDS peers.
35  * @WLAN_STA_CLEAR_PS_FILT: Clear PS filter in hardware (using the
36  *      IEEE80211_TX_CTL_CLEAR_PS_FILT control flag) when the next
37  *      frame to this station is transmitted.
38  * @WLAN_STA_MFP: Management frame protection is used with this STA.
39  * @WLAN_STA_BLOCK_BA: Used to deny ADDBA requests (both TX and RX)
40  *      during suspend/resume and station removal.
41  * @WLAN_STA_PS_DRIVER: driver requires keeping this station in
42  *      power-save mode logically to flush frames that might still
43  *      be in the queues
44  * @WLAN_STA_PSPOLL: Station sent PS-poll while driver was keeping
45  *      station in power-save mode, reply when the driver unblocks.
46  * @WLAN_STA_TDLS_PEER: Station is a TDLS peer.
47  * @WLAN_STA_TDLS_PEER_AUTH: This TDLS peer is authorized to send direct
48  *      packets. This means the link is enabled.
49  * @WLAN_STA_UAPSD: Station requested unscheduled SP while driver was
50  *      keeping station in power-save mode, reply when the driver
51  *      unblocks the station.
52  * @WLAN_STA_SP: Station is in a service period, so don't try to
53  *      reply to other uAPSD trigger frames or PS-Poll.
54  * @WLAN_STA_4ADDR_EVENT: 4-addr event was already sent for this frame.
55  * @WLAN_STA_RATE_CONTROL: rate control was initialized for this station.
56  */
57 enum ieee80211_sta_info_flags {
58         WLAN_STA_AUTH,
59         WLAN_STA_ASSOC,
60         WLAN_STA_PS_STA,
61         WLAN_STA_AUTHORIZED,
62         WLAN_STA_SHORT_PREAMBLE,
63         WLAN_STA_WME,
64         WLAN_STA_WDS,
65         WLAN_STA_CLEAR_PS_FILT,
66         WLAN_STA_MFP,
67         WLAN_STA_BLOCK_BA,
68         WLAN_STA_PS_DRIVER,
69         WLAN_STA_PSPOLL,
70         WLAN_STA_TDLS_PEER,
71         WLAN_STA_TDLS_PEER_AUTH,
72         WLAN_STA_UAPSD,
73         WLAN_STA_SP,
74         WLAN_STA_4ADDR_EVENT,
75         WLAN_STA_RATE_CONTROL,
76 };
77
78 enum ieee80211_sta_state {
79         /* NOTE: These need to be ordered correctly! */
80         IEEE80211_STA_NONE,
81         IEEE80211_STA_AUTH,
82         IEEE80211_STA_ASSOC,
83         IEEE80211_STA_AUTHORIZED,
84 };
85
86 #define STA_TID_NUM 16
87 #define ADDBA_RESP_INTERVAL HZ
88 #define HT_AGG_MAX_RETRIES              15
89 #define HT_AGG_BURST_RETRIES            3
90 #define HT_AGG_RETRIES_PERIOD           (15 * HZ)
91
92 #define HT_AGG_STATE_DRV_READY          0
93 #define HT_AGG_STATE_RESPONSE_RECEIVED  1
94 #define HT_AGG_STATE_OPERATIONAL        2
95 #define HT_AGG_STATE_STOPPING           3
96 #define HT_AGG_STATE_WANT_START         4
97 #define HT_AGG_STATE_WANT_STOP          5
98
99 /**
100  * struct tid_ampdu_tx - TID aggregation information (Tx).
101  *
102  * @rcu_head: rcu head for freeing structure
103  * @session_timer: check if we keep Tx-ing on the TID (by timeout value)
104  * @addba_resp_timer: timer for peer's response to addba request
105  * @pending: pending frames queue -- use sta's spinlock to protect
106  * @dialog_token: dialog token for aggregation session
107  * @timeout: session timeout value to be filled in ADDBA requests
108  * @state: session state (see above)
109  * @stop_initiator: initiator of a session stop
110  * @tx_stop: TX DelBA frame when stopping
111  * @buf_size: reorder buffer size at receiver
112  * @failed_bar_ssn: ssn of the last failed BAR tx attempt
113  * @bar_pending: BAR needs to be re-sent
114  *
115  * This structure's lifetime is managed by RCU, assignments to
116  * the array holding it must hold the aggregation mutex.
117  *
118  * The TX path can access it under RCU lock-free if, and
119  * only if, the state has the flag %HT_AGG_STATE_OPERATIONAL
120  * set. Otherwise, the TX path must also acquire the spinlock
121  * and re-check the state, see comments in the tx code
122  * touching it.
123  */
124 struct tid_ampdu_tx {
125         struct rcu_head rcu_head;
126         struct timer_list session_timer;
127         struct timer_list addba_resp_timer;
128         struct sk_buff_head pending;
129         unsigned long state;
130         u16 timeout;
131         u8 dialog_token;
132         u8 stop_initiator;
133         bool tx_stop;
134         u8 buf_size;
135
136         u16 failed_bar_ssn;
137         bool bar_pending;
138 };
139
140 /**
141  * struct tid_ampdu_rx - TID aggregation information (Rx).
142  *
143  * @reorder_buf: buffer to reorder incoming aggregated MPDUs
144  * @reorder_time: jiffies when skb was added
145  * @session_timer: check if peer keeps Tx-ing on the TID (by timeout value)
146  * @reorder_timer: releases expired frames from the reorder buffer.
147  * @head_seq_num: head sequence number in reordering buffer.
148  * @stored_mpdu_num: number of MPDUs in reordering buffer
149  * @ssn: Starting Sequence Number expected to be aggregated.
150  * @buf_size: buffer size for incoming A-MPDUs
151  * @timeout: reset timer value (in TUs).
152  * @dialog_token: dialog token for aggregation session
153  * @rcu_head: RCU head used for freeing this struct
154  * @reorder_lock: serializes access to reorder buffer, see below.
155  *
156  * This structure's lifetime is managed by RCU, assignments to
157  * the array holding it must hold the aggregation mutex.
158  *
159  * The @reorder_lock is used to protect the members of this
160  * struct, except for @timeout, @buf_size and @dialog_token,
161  * which are constant across the lifetime of the struct (the
162  * dialog token being used only for debugging).
163  */
164 struct tid_ampdu_rx {
165         struct rcu_head rcu_head;
166         spinlock_t reorder_lock;
167         struct sk_buff **reorder_buf;
168         unsigned long *reorder_time;
169         struct timer_list session_timer;
170         struct timer_list reorder_timer;
171         u16 head_seq_num;
172         u16 stored_mpdu_num;
173         u16 ssn;
174         u16 buf_size;
175         u16 timeout;
176         u8 dialog_token;
177 };
178
179 /**
180  * struct sta_ampdu_mlme - STA aggregation information.
181  *
182  * @tid_rx: aggregation info for Rx per TID -- RCU protected
183  * @tid_tx: aggregation info for Tx per TID
184  * @tid_start_tx: sessions where start was requested
185  * @addba_req_num: number of times addBA request has been sent.
186  * @last_addba_req_time: timestamp of the last addBA request.
187  * @dialog_token_allocator: dialog token enumerator for each new session;
188  * @work: work struct for starting/stopping aggregation
189  * @tid_rx_timer_expired: bitmap indicating on which TIDs the
190  *      RX timer expired until the work for it runs
191  * @tid_rx_stop_requested:  bitmap indicating which BA sessions per TID the
192  *      driver requested to close until the work for it runs
193  * @mtx: mutex to protect all TX data (except non-NULL assignments
194  *      to tid_tx[idx], which are protected by the sta spinlock)
195  */
196 struct sta_ampdu_mlme {
197         struct mutex mtx;
198         /* rx */
199         struct tid_ampdu_rx __rcu *tid_rx[STA_TID_NUM];
200         unsigned long tid_rx_timer_expired[BITS_TO_LONGS(STA_TID_NUM)];
201         unsigned long tid_rx_stop_requested[BITS_TO_LONGS(STA_TID_NUM)];
202         /* tx */
203         struct work_struct work;
204         struct tid_ampdu_tx __rcu *tid_tx[STA_TID_NUM];
205         struct tid_ampdu_tx *tid_start_tx[STA_TID_NUM];
206         unsigned long last_addba_req_time[STA_TID_NUM];
207         u8 addba_req_num[STA_TID_NUM];
208         u8 dialog_token_allocator;
209 };
210
211
212 /**
213  * struct sta_info - STA information
214  *
215  * This structure collects information about a station that
216  * mac80211 is communicating with.
217  *
218  * @list: global linked list entry
219  * @hnext: hash table linked list pointer
220  * @local: pointer to the global information
221  * @sdata: virtual interface this station belongs to
222  * @ptk: peer key negotiated with this station, if any
223  * @gtk: group keys negotiated with this station, if any
224  * @rate_ctrl: rate control algorithm reference
225  * @rate_ctrl_priv: rate control private per-STA pointer
226  * @last_tx_rate: rate used for last transmit, to report to userspace as
227  *      "the" transmit rate
228  * @last_rx_rate_idx: rx status rate index of the last data packet
229  * @last_rx_rate_flag: rx status flag of the last data packet
230  * @lock: used for locking all fields that require locking, see comments
231  *      in the header file.
232  * @drv_unblock_wk: used for driver PS unblocking
233  * @listen_interval: listen interval of this station, when we're acting as AP
234  * @_flags: STA flags, see &enum ieee80211_sta_info_flags, do not use directly
235  * @ps_tx_buf: buffers (per AC) of frames to transmit to this station
236  *      when it leaves power saving state or polls
237  * @tx_filtered: buffers (per AC) of frames we already tried to
238  *      transmit but were filtered by hardware due to STA having
239  *      entered power saving state, these are also delivered to
240  *      the station when it leaves powersave or polls for frames
241  * @driver_buffered_tids: bitmap of TIDs the driver has data buffered on
242  * @rx_packets: Number of MSDUs received from this STA
243  * @rx_bytes: Number of bytes received from this STA
244  * @wep_weak_iv_count: number of weak WEP IVs received from this station
245  * @last_rx: time (in jiffies) when last frame was received from this STA
246  * @last_connected: time (in seconds) when a station got connected
247  * @num_duplicates: number of duplicate frames received from this STA
248  * @rx_fragments: number of received MPDUs
249  * @rx_dropped: number of dropped MPDUs from this STA
250  * @last_signal: signal of last received frame from this STA
251  * @avg_signal: moving average of signal of received frames from this STA
252  * @last_seq_ctrl: last received seq/frag number from this STA (per RX queue)
253  * @tx_filtered_count: number of frames the hardware filtered for this STA
254  * @tx_retry_failed: number of frames that failed retry
255  * @tx_retry_count: total number of retries for frames to this STA
256  * @fail_avg: moving percentage of failed MSDUs
257  * @tx_packets: number of RX/TX MSDUs
258  * @tx_bytes: number of bytes transmitted to this STA
259  * @tx_fragments: number of transmitted MPDUs
260  * @tid_seq: per-TID sequence numbers for sending to this STA
261  * @ampdu_mlme: A-MPDU state machine state
262  * @timer_to_tid: identity mapping to ID timers
263  * @llid: Local link ID
264  * @plid: Peer link ID
265  * @reason: Cancel reason on PLINK_HOLDING state
266  * @plink_retries: Retries in establishment
267  * @ignore_plink_timer: ignore the peer-link timer (used internally)
268  * @plink_state: peer link state
269  * @plink_timeout: timeout of peer link
270  * @plink_timer: peer link watch timer
271  * @plink_timer_was_running: used by suspend/resume to restore timers
272  * @debugfs: debug filesystem info
273  * @dead: set to true when sta is unlinked
274  * @uploaded: set to true when sta is uploaded to the driver
275  * @lost_packets: number of consecutive lost packets
276  * @dummy: indicate a dummy station created for receiving
277  *      EAP frames before association
278  * @sta: station information we share with the driver
279  * @sta_state: duplicates information about station state (for debug)
280  * @beacon_loss_count: number of times beacon loss has triggered
281  */
282 struct sta_info {
283         /* General information, mostly static */
284         struct list_head list;
285         struct sta_info __rcu *hnext;
286         struct ieee80211_local *local;
287         struct ieee80211_sub_if_data *sdata;
288         struct ieee80211_key __rcu *gtk[NUM_DEFAULT_KEYS + NUM_DEFAULT_MGMT_KEYS];
289         struct ieee80211_key __rcu *ptk;
290         struct rate_control_ref *rate_ctrl;
291         void *rate_ctrl_priv;
292         spinlock_t lock;
293
294         struct work_struct drv_unblock_wk;
295
296         u16 listen_interval;
297
298         bool dead;
299
300         bool uploaded;
301
302         enum ieee80211_sta_state sta_state;
303
304         /* use the accessors defined below */
305         unsigned long _flags;
306
307         /*
308          * STA powersave frame queues, no more than the internal
309          * locking required.
310          */
311         struct sk_buff_head ps_tx_buf[IEEE80211_NUM_ACS];
312         struct sk_buff_head tx_filtered[IEEE80211_NUM_ACS];
313         unsigned long driver_buffered_tids;
314
315         /* Updated from RX path only, no locking requirements */
316         unsigned long rx_packets, rx_bytes;
317         unsigned long wep_weak_iv_count;
318         unsigned long last_rx;
319         long last_connected;
320         unsigned long num_duplicates;
321         unsigned long rx_fragments;
322         unsigned long rx_dropped;
323         int last_signal;
324         struct ewma avg_signal;
325         /* Plus 1 for non-QoS frames */
326         __le16 last_seq_ctrl[NUM_RX_DATA_QUEUES + 1];
327
328         /* Updated from TX status path only, no locking requirements */
329         unsigned long tx_filtered_count;
330         unsigned long tx_retry_failed, tx_retry_count;
331         /* moving percentage of failed MSDUs */
332         unsigned int fail_avg;
333
334         /* Updated from TX path only, no locking requirements */
335         unsigned long tx_packets;
336         unsigned long tx_bytes;
337         unsigned long tx_fragments;
338         struct ieee80211_tx_rate last_tx_rate;
339         int last_rx_rate_idx;
340         int last_rx_rate_flag;
341         u16 tid_seq[IEEE80211_QOS_CTL_TID_MASK + 1];
342
343         /*
344          * Aggregation information, locked with lock.
345          */
346         struct sta_ampdu_mlme ampdu_mlme;
347         u8 timer_to_tid[STA_TID_NUM];
348
349 #ifdef CONFIG_MAC80211_MESH
350         /*
351          * Mesh peer link attributes
352          * TODO: move to a sub-structure that is referenced with pointer?
353          */
354         __le16 llid;
355         __le16 plid;
356         __le16 reason;
357         u8 plink_retries;
358         bool ignore_plink_timer;
359         bool plink_timer_was_running;
360         enum nl80211_plink_state plink_state;
361         u32 plink_timeout;
362         struct timer_list plink_timer;
363 #endif
364
365 #ifdef CONFIG_MAC80211_DEBUGFS
366         struct sta_info_debugfsdentries {
367                 struct dentry *dir;
368                 bool add_has_run;
369         } debugfs;
370 #endif
371
372         unsigned int lost_packets;
373         unsigned int beacon_loss_count;
374
375         /* should be right in front of sta to be in the same cache line */
376         bool dummy;
377
378         /* keep last! */
379         struct ieee80211_sta sta;
380 };
381
382 static inline enum nl80211_plink_state sta_plink_state(struct sta_info *sta)
383 {
384 #ifdef CONFIG_MAC80211_MESH
385         return sta->plink_state;
386 #endif
387         return NL80211_PLINK_LISTEN;
388 }
389
390 static inline void set_sta_flag(struct sta_info *sta,
391                                 enum ieee80211_sta_info_flags flag)
392 {
393         WARN_ON(flag == WLAN_STA_AUTH ||
394                 flag == WLAN_STA_ASSOC ||
395                 flag == WLAN_STA_AUTHORIZED);
396         set_bit(flag, &sta->_flags);
397 }
398
399 static inline void clear_sta_flag(struct sta_info *sta,
400                                   enum ieee80211_sta_info_flags flag)
401 {
402         WARN_ON(flag == WLAN_STA_AUTH ||
403                 flag == WLAN_STA_ASSOC ||
404                 flag == WLAN_STA_AUTHORIZED);
405         clear_bit(flag, &sta->_flags);
406 }
407
408 static inline int test_sta_flag(struct sta_info *sta,
409                                 enum ieee80211_sta_info_flags flag)
410 {
411         return test_bit(flag, &sta->_flags);
412 }
413
414 static inline int test_and_clear_sta_flag(struct sta_info *sta,
415                                           enum ieee80211_sta_info_flags flag)
416 {
417         WARN_ON(flag == WLAN_STA_AUTH ||
418                 flag == WLAN_STA_ASSOC ||
419                 flag == WLAN_STA_AUTHORIZED);
420         return test_and_clear_bit(flag, &sta->_flags);
421 }
422
423 static inline int test_and_set_sta_flag(struct sta_info *sta,
424                                         enum ieee80211_sta_info_flags flag)
425 {
426         WARN_ON(flag == WLAN_STA_AUTH ||
427                 flag == WLAN_STA_ASSOC ||
428                 flag == WLAN_STA_AUTHORIZED);
429         return test_and_set_bit(flag, &sta->_flags);
430 }
431
432 int sta_info_move_state_checked(struct sta_info *sta,
433                                 enum ieee80211_sta_state new_state);
434
435 static inline void sta_info_move_state(struct sta_info *sta,
436                                        enum ieee80211_sta_state new_state)
437 {
438         int ret = sta_info_move_state_checked(sta, new_state);
439         WARN_ON_ONCE(ret);
440 }
441
442
443 void ieee80211_assign_tid_tx(struct sta_info *sta, int tid,
444                              struct tid_ampdu_tx *tid_tx);
445
446 static inline struct tid_ampdu_tx *
447 rcu_dereference_protected_tid_tx(struct sta_info *sta, int tid)
448 {
449         return rcu_dereference_protected(sta->ampdu_mlme.tid_tx[tid],
450                                          lockdep_is_held(&sta->lock) ||
451                                          lockdep_is_held(&sta->ampdu_mlme.mtx));
452 }
453
454 #define STA_HASH_SIZE 256
455 #define STA_HASH(sta) (sta[5])
456
457
458 /* Maximum number of frames to buffer per power saving station per AC */
459 #define STA_MAX_TX_BUFFER       64
460
461 /* Minimum buffered frame expiry time. If STA uses listen interval that is
462  * smaller than this value, the minimum value here is used instead. */
463 #define STA_TX_BUFFER_EXPIRE (10 * HZ)
464
465 /* How often station data is cleaned up (e.g., expiration of buffered frames)
466  */
467 #define STA_INFO_CLEANUP_INTERVAL (10 * HZ)
468
469 /*
470  * Get a STA info, must be under RCU read lock.
471  */
472 struct sta_info *sta_info_get(struct ieee80211_sub_if_data *sdata,
473                               const u8 *addr);
474
475 struct sta_info *sta_info_get_rx(struct ieee80211_sub_if_data *sdata,
476                               const u8 *addr);
477
478 struct sta_info *sta_info_get_bss(struct ieee80211_sub_if_data *sdata,
479                                   const u8 *addr);
480
481 struct sta_info *sta_info_get_bss_rx(struct ieee80211_sub_if_data *sdata,
482                                   const u8 *addr);
483
484 static inline
485 void for_each_sta_info_type_check(struct ieee80211_local *local,
486                                   const u8 *addr,
487                                   struct sta_info *sta,
488                                   struct sta_info *nxt)
489 {
490 }
491
492 #define for_each_sta_info(local, _addr, _sta, nxt)                      \
493         for (   /* initialise loop */                                   \
494                 _sta = rcu_dereference(local->sta_hash[STA_HASH(_addr)]),\
495                 nxt = _sta ? rcu_dereference(_sta->hnext) : NULL;       \
496                 /* typecheck */                                         \
497                 for_each_sta_info_type_check(local, (_addr), _sta, nxt),\
498                 /* continue condition */                                \
499                 _sta;                                                   \
500                 /* advance loop */                                      \
501                 _sta = nxt,                                             \
502                 nxt = _sta ? rcu_dereference(_sta->hnext) : NULL        \
503              )                                                          \
504         /* run code only if address matches and it's not a dummy sta */ \
505         if (memcmp(_sta->sta.addr, (_addr), ETH_ALEN) == 0 &&           \
506                 !_sta->dummy)
507
508 #define for_each_sta_info_rx(local, _addr, _sta, nxt)                   \
509         for (   /* initialise loop */                                   \
510                 _sta = rcu_dereference(local->sta_hash[STA_HASH(_addr)]),\
511                 nxt = _sta ? rcu_dereference(_sta->hnext) : NULL;       \
512                 /* typecheck */                                         \
513                 for_each_sta_info_type_check(local, (_addr), _sta, nxt),\
514                 /* continue condition */                                \
515                 _sta;                                                   \
516                 /* advance loop */                                      \
517                 _sta = nxt,                                             \
518                 nxt = _sta ? rcu_dereference(_sta->hnext) : NULL        \
519              )                                                          \
520         /* compare address and run code only if it matches */           \
521         if (memcmp(_sta->sta.addr, (_addr), ETH_ALEN) == 0)
522
523 /*
524  * Get STA info by index, BROKEN!
525  */
526 struct sta_info *sta_info_get_by_idx(struct ieee80211_sub_if_data *sdata,
527                                      int idx);
528 /*
529  * Create a new STA info, caller owns returned structure
530  * until sta_info_insert().
531  */
532 struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
533                                 const u8 *addr, gfp_t gfp);
534
535 void sta_info_free(struct ieee80211_local *local, struct sta_info *sta);
536
537 /*
538  * Insert STA info into hash table/list, returns zero or a
539  * -EEXIST if (if the same MAC address is already present).
540  *
541  * Calling the non-rcu version makes the caller relinquish,
542  * the _rcu version calls read_lock_rcu() and must be called
543  * without it held.
544  */
545 int sta_info_insert(struct sta_info *sta);
546 int sta_info_insert_rcu(struct sta_info *sta) __acquires(RCU);
547 int sta_info_reinsert(struct sta_info *sta);
548
549 int sta_info_destroy_addr(struct ieee80211_sub_if_data *sdata,
550                           const u8 *addr);
551 int sta_info_destroy_addr_bss(struct ieee80211_sub_if_data *sdata,
552                               const u8 *addr);
553
554 void sta_info_recalc_tim(struct sta_info *sta);
555
556 void sta_info_init(struct ieee80211_local *local);
557 void sta_info_stop(struct ieee80211_local *local);
558 int sta_info_flush(struct ieee80211_local *local,
559                    struct ieee80211_sub_if_data *sdata);
560 void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata,
561                           unsigned long exp_time);
562
563 void ieee80211_sta_ps_deliver_wakeup(struct sta_info *sta);
564 void ieee80211_sta_ps_deliver_poll_response(struct sta_info *sta);
565 void ieee80211_sta_ps_deliver_uapsd(struct sta_info *sta);
566
567 #endif /* STA_INFO_H */