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