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