]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - net/mac80211/sta_info.h
mac80211: fix station/driver powersave race
[mirror_ubuntu-jammy-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>
541a45a1 16#include <linux/average.h>
888d04df 17#include <linux/etherdevice.h>
2c8dccc7 18#include "key.h"
f0706e82 19
238814fd
JB
20/**
21 * enum ieee80211_sta_info_flags - Stations flags
22 *
c2c98fde
JB
23 * These flags are used with &struct sta_info's @flags member, but
24 * only indirectly with set_sta_flag() and friends.
238814fd
JB
25 *
26 * @WLAN_STA_AUTH: Station is authenticated.
27 * @WLAN_STA_ASSOC: Station is associated.
af818581 28 * @WLAN_STA_PS_STA: Station is in power-save mode
238814fd
JB
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.
238814fd
JB
34 * @WLAN_STA_WME: Station is a QoS-STA.
35 * @WLAN_STA_WDS: Station is one of our WDS peers.
d46e144b 36 * @WLAN_STA_CLEAR_PS_FILT: Clear PS filter in hardware (using the
e039fa4a 37 * IEEE80211_TX_CTL_CLEAR_PS_FILT control flag) when the next
d46e144b 38 * frame to this station is transmitted.
5394af4d 39 * @WLAN_STA_MFP: Management frame protection is used with this STA.
618f356b 40 * @WLAN_STA_BLOCK_BA: Used to deny ADDBA requests (both TX and RX)
098a6070 41 * during suspend/resume and station removal.
af818581
JB
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.
941c93cd
AN
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.
47086fc5
JB
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
deeaee19 54 * reply to other uAPSD trigger frames or PS-Poll.
e7f4a940 55 * @WLAN_STA_4ADDR_EVENT: 4-addr event was already sent for this frame.
83d5cc01 56 * @WLAN_STA_INSERTED: This station is inserted into the hash table.
e1936e94 57 * @WLAN_STA_RATE_CONTROL: rate control was initialized for this station.
dbf498fb 58 * @WLAN_STA_TOFFSET_KNOWN: toffset calculated for this station is valid.
3f52b7e3
MP
59 * @WLAN_STA_MPSP_OWNER: local STA is owner of a mesh Peer Service Period.
60 * @WLAN_STA_MPSP_RECIPIENT: local STA is recipient of a MPSP.
5ac2e350
JB
61 * @WLAN_STA_PS_DELIVER: station woke up, but we're still blocking TX
62 * until pending frames are delivered
238814fd
JB
63 */
64enum ieee80211_sta_info_flags {
c2c98fde
JB
65 WLAN_STA_AUTH,
66 WLAN_STA_ASSOC,
67 WLAN_STA_PS_STA,
68 WLAN_STA_AUTHORIZED,
69 WLAN_STA_SHORT_PREAMBLE,
c2c98fde
JB
70 WLAN_STA_WME,
71 WLAN_STA_WDS,
72 WLAN_STA_CLEAR_PS_FILT,
73 WLAN_STA_MFP,
74 WLAN_STA_BLOCK_BA,
75 WLAN_STA_PS_DRIVER,
76 WLAN_STA_PSPOLL,
77 WLAN_STA_TDLS_PEER,
78 WLAN_STA_TDLS_PEER_AUTH,
79 WLAN_STA_UAPSD,
80 WLAN_STA_SP,
e7f4a940 81 WLAN_STA_4ADDR_EVENT,
83d5cc01 82 WLAN_STA_INSERTED,
e1936e94 83 WLAN_STA_RATE_CONTROL,
dbf498fb 84 WLAN_STA_TOFFSET_KNOWN,
3f52b7e3
MP
85 WLAN_STA_MPSP_OWNER,
86 WLAN_STA_MPSP_RECIPIENT,
5ac2e350 87 WLAN_STA_PS_DELIVER,
238814fd 88};
d9a7ddb0 89
5aae2880 90#define ADDBA_RESP_INTERVAL HZ
84381b4e
NM
91#define HT_AGG_MAX_RETRIES 15
92#define HT_AGG_BURST_RETRIES 3
93#define HT_AGG_RETRIES_PERIOD (15 * HZ)
5aae2880 94
a622ab72
JB
95#define HT_AGG_STATE_DRV_READY 0
96#define HT_AGG_STATE_RESPONSE_RECEIVED 1
97#define HT_AGG_STATE_OPERATIONAL 2
98#define HT_AGG_STATE_STOPPING 3
0ab33703
JB
99#define HT_AGG_STATE_WANT_START 4
100#define HT_AGG_STATE_WANT_STOP 5
80656c20 101
c82c4a80
JB
102enum ieee80211_agg_stop_reason {
103 AGG_STOP_DECLINED,
104 AGG_STOP_LOCAL_REQUEST,
105 AGG_STOP_PEER_REQUEST,
106 AGG_STOP_DESTROY_STA,
107};
108
80656c20
RR
109/**
110 * struct tid_ampdu_tx - TID aggregation information (Tx).
111 *
a622ab72 112 * @rcu_head: rcu head for freeing structure
285fa695 113 * @session_timer: check if we keep Tx-ing on the TID (by timeout value)
80656c20 114 * @addba_resp_timer: timer for peer's response to addba request
cd8ffc80 115 * @pending: pending frames queue -- use sta's spinlock to protect
cee24a3e 116 * @dialog_token: dialog token for aggregation session
bd2ce6e4 117 * @timeout: session timeout value to be filled in ADDBA requests
a622ab72 118 * @state: session state (see above)
12d3952f 119 * @last_tx: jiffies of last tx activity
a622ab72 120 * @stop_initiator: initiator of a session stop
53f73c09 121 * @tx_stop: TX DelBA frame when stopping
0b01f030 122 * @buf_size: reorder buffer size at receiver
f0425bed
FF
123 * @failed_bar_ssn: ssn of the last failed BAR tx attempt
124 * @bar_pending: BAR needs to be re-sent
a622ab72 125 *
dd318575
JB
126 * This structure's lifetime is managed by RCU, assignments to
127 * the array holding it must hold the aggregation mutex.
128 *
129 * The TX path can access it under RCU lock-free if, and
130 * only if, the state has the flag %HT_AGG_STATE_OPERATIONAL
131 * set. Otherwise, the TX path must also acquire the spinlock
132 * and re-check the state, see comments in the tx code
133 * touching it.
80656c20
RR
134 */
135struct tid_ampdu_tx {
a622ab72 136 struct rcu_head rcu_head;
285fa695 137 struct timer_list session_timer;
80656c20 138 struct timer_list addba_resp_timer;
cd8ffc80 139 struct sk_buff_head pending;
a622ab72 140 unsigned long state;
12d3952f 141 unsigned long last_tx;
bd2ce6e4 142 u16 timeout;
cee24a3e 143 u8 dialog_token;
a622ab72 144 u8 stop_initiator;
53f73c09 145 bool tx_stop;
0b01f030 146 u8 buf_size;
f0425bed
FF
147
148 u16 failed_bar_ssn;
149 bool bar_pending;
80656c20 150};
5aae2880
RR
151
152/**
153 * struct tid_ampdu_rx - TID aggregation information (Rx).
154 *
5aae2880 155 * @reorder_buf: buffer to reorder incoming aggregated MPDUs
4d050f1d 156 * @reorder_time: jiffies when skb was added
5aae2880 157 * @session_timer: check if peer keeps Tx-ing on the TID (by timeout value)
2bff8ebf 158 * @reorder_timer: releases expired frames from the reorder buffer.
12d3952f 159 * @last_rx: jiffies of last rx activity
056cdd59
JB
160 * @head_seq_num: head sequence number in reordering buffer.
161 * @stored_mpdu_num: number of MPDUs in reordering buffer
cee24a3e
RR
162 * @ssn: Starting Sequence Number expected to be aggregated.
163 * @buf_size: buffer size for incoming A-MPDUs
20ad19d0 164 * @timeout: reset timer value (in TUs).
cee24a3e 165 * @dialog_token: dialog token for aggregation session
a87f736d 166 * @rcu_head: RCU head used for freeing this struct
2bff8ebf 167 * @reorder_lock: serializes access to reorder buffer, see below.
a87f736d 168 *
dd318575
JB
169 * This structure's lifetime is managed by RCU, assignments to
170 * the array holding it must hold the aggregation mutex.
2bff8ebf 171 *
dd318575
JB
172 * The @reorder_lock is used to protect the members of this
173 * struct, except for @timeout, @buf_size and @dialog_token,
174 * which are constant across the lifetime of the struct (the
175 * dialog token being used only for debugging).
5aae2880
RR
176 */
177struct tid_ampdu_rx {
a87f736d 178 struct rcu_head rcu_head;
2bff8ebf 179 spinlock_t reorder_lock;
5aae2880 180 struct sk_buff **reorder_buf;
4d050f1d 181 unsigned long *reorder_time;
5aae2880 182 struct timer_list session_timer;
2bff8ebf 183 struct timer_list reorder_timer;
12d3952f 184 unsigned long last_rx;
056cdd59
JB
185 u16 head_seq_num;
186 u16 stored_mpdu_num;
cee24a3e
RR
187 u16 ssn;
188 u16 buf_size;
189 u16 timeout;
190 u8 dialog_token;
5aae2880
RR
191};
192
fcea6007
JB
193/**
194 * struct sta_ampdu_mlme - STA aggregation information.
195 *
a87f736d 196 * @tid_rx: aggregation info for Rx per TID -- RCU protected
fcea6007 197 * @tid_tx: aggregation info for Tx per TID
ec034b20 198 * @tid_start_tx: sessions where start was requested
fcea6007 199 * @addba_req_num: number of times addBA request has been sent.
84381b4e 200 * @last_addba_req_time: timestamp of the last addBA request.
fcea6007 201 * @dialog_token_allocator: dialog token enumerator for each new session;
0ab33703 202 * @work: work struct for starting/stopping aggregation
7c3b1dd8
JB
203 * @tid_rx_timer_expired: bitmap indicating on which TIDs the
204 * RX timer expired until the work for it runs
f41ccd71
SL
205 * @tid_rx_stop_requested: bitmap indicating which BA sessions per TID the
206 * driver requested to close until the work for it runs
a93e3644
JB
207 * @mtx: mutex to protect all TX data (except non-NULL assignments
208 * to tid_tx[idx], which are protected by the sta spinlock)
e562078a 209 * tid_start_tx is also protected by sta->lock.
fcea6007
JB
210 */
211struct sta_ampdu_mlme {
a93e3644 212 struct mutex mtx;
fcea6007 213 /* rx */
5a306f58
JB
214 struct tid_ampdu_rx __rcu *tid_rx[IEEE80211_NUM_TIDS];
215 unsigned long tid_rx_timer_expired[BITS_TO_LONGS(IEEE80211_NUM_TIDS)];
216 unsigned long tid_rx_stop_requested[BITS_TO_LONGS(IEEE80211_NUM_TIDS)];
fcea6007 217 /* tx */
0ab33703 218 struct work_struct work;
5a306f58
JB
219 struct tid_ampdu_tx __rcu *tid_tx[IEEE80211_NUM_TIDS];
220 struct tid_ampdu_tx *tid_start_tx[IEEE80211_NUM_TIDS];
221 unsigned long last_addba_req_time[IEEE80211_NUM_TIDS];
222 u8 addba_req_num[IEEE80211_NUM_TIDS];
fcea6007
JB
223 u8 dialog_token_allocator;
224};
225
ad38bfc9
MG
226/*
227 * struct ieee80211_tx_latency_stat - Tx latency statistics
228 *
229 * Measures TX latency and jitter for a station per TID.
230 *
231 * @max: worst case latency
232 * @sum: sum of all latencies
233 * @counter: amount of Tx frames sent from interface
234 * @bins: each bin counts how many frames transmitted within a certain
235 * latency range. when disabled it is NULL.
236 * @bin_count: amount of bins.
237 */
238struct ieee80211_tx_latency_stat {
239 u32 max;
240 u32 sum;
241 u32 counter;
242 u32 *bins;
243 u32 bin_count;
244};
fcea6007 245
693b1bbc
JB
246/**
247 * struct sta_info - STA information
248 *
249 * This structure collects information about a station that
250 * mac80211 is communicating with.
251 *
252 * @list: global linked list entry
d778207b 253 * @free_list: list entry for keeping track of stations to free
693b1bbc
JB
254 * @hnext: hash table linked list pointer
255 * @local: pointer to the global information
e25cf4a6 256 * @sdata: virtual interface this station belongs to
2475b1cc
MS
257 * @ptk: peer keys negotiated with this station, if any
258 * @ptk_idx: last installed peer key index
e31b8213 259 * @gtk: group keys negotiated with this station, if any
2475b1cc 260 * @gtk_idx: last installed group key index
e25cf4a6
JB
261 * @rate_ctrl: rate control algorithm reference
262 * @rate_ctrl_priv: rate control private per-STA pointer
263 * @last_tx_rate: rate used for last transmit, to report to userspace as
264 * "the" transmit rate
3af6334c
FF
265 * @last_rx_rate_idx: rx status rate index of the last data packet
266 * @last_rx_rate_flag: rx status flag of the last data packet
1b8d242a 267 * @last_rx_rate_vht_flag: rx status vht flag of the last data packet
5614618e 268 * @last_rx_rate_vht_nss: rx status nss of last data packet
6ef307bc
RD
269 * @lock: used for locking all fields that require locking, see comments
270 * in the header file.
5ac2e350 271 * @drv_deliver_wk: used for delivering frames after driver PS unblocking
e25cf4a6 272 * @listen_interval: listen interval of this station, when we're acting as AP
c2c98fde 273 * @_flags: STA flags, see &enum ieee80211_sta_info_flags, do not use directly
1d147bfa 274 * @ps_lock: used for powersave (when mac80211 is the AP) related locking
948d887d
JB
275 * @ps_tx_buf: buffers (per AC) of frames to transmit to this station
276 * when it leaves power saving state or polls
277 * @tx_filtered: buffers (per AC) of frames we already tried to
278 * transmit but were filtered by hardware due to STA having
279 * entered power saving state, these are also delivered to
280 * the station when it leaves powersave or polls for frames
281 * @driver_buffered_tids: bitmap of TIDs the driver has data buffered on
693b1bbc
JB
282 * @rx_packets: Number of MSDUs received from this STA
283 * @rx_bytes: Number of bytes received from this STA
e25cf4a6
JB
284 * @wep_weak_iv_count: number of weak WEP IVs received from this station
285 * @last_rx: time (in jiffies) when last frame was received from this STA
ebe27c91 286 * @last_connected: time (in seconds) when a station got connected
6ef307bc
RD
287 * @num_duplicates: number of duplicate frames received from this STA
288 * @rx_fragments: number of received MPDUs
289 * @rx_dropped: number of dropped MPDUs from this STA
290 * @last_signal: signal of last received frame from this STA
541a45a1 291 * @avg_signal: moving average of signal of received frames from this STA
db94357d 292 * @last_ack_signal: signal of last received Ack frame from this STA
6ef307bc 293 * @last_seq_ctrl: last received seq/frag number from this STA (per RX queue)
e25cf4a6
JB
294 * @tx_filtered_count: number of frames the hardware filtered for this STA
295 * @tx_retry_failed: number of frames that failed retry
296 * @tx_retry_count: total number of retries for frames to this STA
6ef307bc
RD
297 * @fail_avg: moving percentage of failed MSDUs
298 * @tx_packets: number of RX/TX MSDUs
e25cf4a6 299 * @tx_bytes: number of bytes transmitted to this STA
6ef307bc 300 * @tx_fragments: number of transmitted MPDUs
e25cf4a6
JB
301 * @tid_seq: per-TID sequence numbers for sending to this STA
302 * @ampdu_mlme: A-MPDU state machine state
6ef307bc 303 * @timer_to_tid: identity mapping to ID timers
ad38bfc9 304 * @tx_lat: Tx latency statistics
6ef307bc
RD
305 * @llid: Local link ID
306 * @plid: Peer link ID
307 * @reason: Cancel reason on PLINK_HOLDING state
308 * @plink_retries: Retries in establishment
e25cf4a6
JB
309 * @ignore_plink_timer: ignore the peer-link timer (used internally)
310 * @plink_state: peer link state
311 * @plink_timeout: timeout of peer link
312 * @plink_timer: peer link watch timer
dbf498fb 313 * @t_offset: timing offset relative to this host
1dd45581
AN
314 * @t_offset_setpoint: reference timing offset of this sta to be used when
315 * calculating clockdrift
3f52b7e3
MP
316 * @local_pm: local link-specific power save mode
317 * @peer_pm: peer-specific power save mode towards local STA
318 * @nonpeer_pm: STA power save mode towards non-peer neighbors
6ef307bc 319 * @debugfs: debug filesystem info
af818581 320 * @dead: set to true when sta is unlinked
34e89507 321 * @uploaded: set to true when sta is uploaded to the driver
99ba2a14 322 * @lost_packets: number of consecutive lost packets
2a33bee2 323 * @sta: station information we share with the driver
d9a7ddb0 324 * @sta_state: duplicates information about station state (for debug)
a85e1d55 325 * @beacon_loss_count: number of times beacon loss has triggered
077f897a 326 * @rcu_head: RCU head used for freeing this station struct
0af83d3d
JB
327 * @cur_max_bandwidth: maximum bandwidth to use for TX to the station,
328 * taken from HT/VHT capabilities or VHT operating mode notification
780b40df
JB
329 * @chains: chains ever used for RX from this station
330 * @chain_signal_last: last signal (per chain)
331 * @chain_signal_avg: signal average (per chain)
687da132
EG
332 * @known_smps_mode: the smps_mode the client thinks we are in. Relevant for
333 * AP only.
2475b1cc 334 * @cipher_scheme: optional cipher scheme for this station
693b1bbc 335 */
f0706e82 336struct sta_info {
693b1bbc 337 /* General information, mostly static */
d778207b 338 struct list_head list, free_list;
b22cfcfc 339 struct rcu_head rcu_head;
40b275b6 340 struct sta_info __rcu *hnext;
f0706e82 341 struct ieee80211_local *local;
d0709a65 342 struct ieee80211_sub_if_data *sdata;
40b275b6 343 struct ieee80211_key __rcu *gtk[NUM_DEFAULT_KEYS + NUM_DEFAULT_MGMT_KEYS];
2475b1cc
MS
344 struct ieee80211_key __rcu *ptk[NUM_DEFAULT_KEYS];
345 u8 gtk_idx;
346 u8 ptk_idx;
f0706e82
JB
347 struct rate_control_ref *rate_ctrl;
348 void *rate_ctrl_priv;
07346f81 349 spinlock_t lock;
17741cdc 350
5ac2e350 351 struct work_struct drv_deliver_wk;
af818581 352
693b1bbc 353 u16 listen_interval;
f0706e82 354
af818581
JB
355 bool dead;
356
34e89507 357 bool uploaded;
693b1bbc 358
d9a7ddb0
JB
359 enum ieee80211_sta_state sta_state;
360
c2c98fde
JB
361 /* use the accessors defined below */
362 unsigned long _flags;
693b1bbc 363
1d147bfa
EG
364 /* STA powersave lock and frame queues */
365 spinlock_t ps_lock;
948d887d
JB
366 struct sk_buff_head ps_tx_buf[IEEE80211_NUM_ACS];
367 struct sk_buff_head tx_filtered[IEEE80211_NUM_ACS];
368 unsigned long driver_buffered_tids;
693b1bbc
JB
369
370 /* Updated from RX path only, no locking requirements */
560d2682
JB
371 unsigned long rx_packets;
372 u64 rx_bytes;
693b1bbc
JB
373 unsigned long wep_weak_iv_count;
374 unsigned long last_rx;
ebe27c91 375 long last_connected;
6ef307bc
RD
376 unsigned long num_duplicates;
377 unsigned long rx_fragments;
378 unsigned long rx_dropped;
379 int last_signal;
541a45a1 380 struct ewma avg_signal;
db94357d 381 int last_ack_signal;
ef0621e8
FF
382
383 u8 chains;
384 s8 chain_signal_last[IEEE80211_MAX_CHAINS];
385 struct ewma chain_signal_avg[IEEE80211_MAX_CHAINS];
386
9e26297a 387 /* Plus 1 for non-QoS frames */
5a306f58 388 __le16 last_seq_ctrl[IEEE80211_NUM_TIDS + 1];
693b1bbc
JB
389
390 /* Updated from TX status path only, no locking requirements */
391 unsigned long tx_filtered_count;
392 unsigned long tx_retry_failed, tx_retry_count;
693b1bbc
JB
393 /* moving percentage of failed MSDUs */
394 unsigned int fail_avg;
395
396 /* Updated from TX path only, no locking requirements */
560d2682
JB
397 u32 tx_fragments;
398 u64 tx_packets[IEEE80211_NUM_ACS];
399 u64 tx_bytes[IEEE80211_NUM_ACS];
e6a9854b 400 struct ieee80211_tx_rate last_tx_rate;
3af6334c 401 int last_rx_rate_idx;
5614618e 402 u32 last_rx_rate_flag;
1b8d242a 403 u32 last_rx_rate_vht_flag;
5614618e 404 u8 last_rx_rate_vht_nss;
f591fa5d 405 u16 tid_seq[IEEE80211_QOS_CTL_TID_MASK + 1];
f0706e82 406
d0709a65 407 /*
07346f81 408 * Aggregation information, locked with lock.
d0709a65 409 */
5aae2880 410 struct sta_ampdu_mlme ampdu_mlme;
5a306f58 411 u8 timer_to_tid[IEEE80211_NUM_TIDS];
693b1bbc 412
ad38bfc9
MG
413 struct ieee80211_tx_latency_stat *tx_lat;
414
ee385855 415#ifdef CONFIG_MAC80211_MESH
693b1bbc
JB
416 /*
417 * Mesh peer link attributes
418 * TODO: move to a sub-structure that is referenced with pointer?
419 */
6f101ef0
CYY
420 u16 llid;
421 u16 plid;
422 u16 reason;
6ef307bc 423 u8 plink_retries;
7495883b 424 bool ignore_plink_timer;
57cf8043 425 enum nl80211_plink_state plink_state;
ee385855
LCC
426 u32 plink_timeout;
427 struct timer_list plink_timer;
dbf498fb
JC
428 s64 t_offset;
429 s64 t_offset_setpoint;
3f52b7e3
MP
430 /* mesh power save */
431 enum nl80211_mesh_power_mode local_pm;
432 enum nl80211_mesh_power_mode peer_pm;
433 enum nl80211_mesh_power_mode nonpeer_pm;
ee385855 434#endif
10816d40 435
e9f207f0
JB
436#ifdef CONFIG_MAC80211_DEBUGFS
437 struct sta_info_debugfsdentries {
438 struct dentry *dir;
63044e9f 439 bool add_has_run;
e9f207f0
JB
440 } debugfs;
441#endif
17741cdc 442
0af83d3d
JB
443 enum ieee80211_sta_rx_bandwidth cur_max_bandwidth;
444
99ba2a14 445 unsigned int lost_packets;
a85e1d55 446 unsigned int beacon_loss_count;
99ba2a14 447
687da132 448 enum ieee80211_smps_mode known_smps_mode;
2475b1cc 449 const struct ieee80211_cipher_scheme *cipher_scheme;
687da132 450
17741cdc
JB
451 /* keep last! */
452 struct ieee80211_sta sta;
f0706e82
JB
453};
454
57cf8043 455static inline enum nl80211_plink_state sta_plink_state(struct sta_info *sta)
d6d1a5a7
JB
456{
457#ifdef CONFIG_MAC80211_MESH
458 return sta->plink_state;
459#endif
57cf8043 460 return NL80211_PLINK_LISTEN;
d6d1a5a7
JB
461}
462
c2c98fde
JB
463static inline void set_sta_flag(struct sta_info *sta,
464 enum ieee80211_sta_info_flags flag)
07346f81 465{
d9a7ddb0
JB
466 WARN_ON(flag == WLAN_STA_AUTH ||
467 flag == WLAN_STA_ASSOC ||
468 flag == WLAN_STA_AUTHORIZED);
c2c98fde 469 set_bit(flag, &sta->_flags);
07346f81
JB
470}
471
c2c98fde
JB
472static inline void clear_sta_flag(struct sta_info *sta,
473 enum ieee80211_sta_info_flags flag)
07346f81 474{
d9a7ddb0
JB
475 WARN_ON(flag == WLAN_STA_AUTH ||
476 flag == WLAN_STA_ASSOC ||
477 flag == WLAN_STA_AUTHORIZED);
c2c98fde 478 clear_bit(flag, &sta->_flags);
07346f81
JB
479}
480
c2c98fde
JB
481static inline int test_sta_flag(struct sta_info *sta,
482 enum ieee80211_sta_info_flags flag)
07346f81 483{
c2c98fde 484 return test_bit(flag, &sta->_flags);
07346f81
JB
485}
486
c2c98fde
JB
487static inline int test_and_clear_sta_flag(struct sta_info *sta,
488 enum ieee80211_sta_info_flags flag)
07346f81 489{
d9a7ddb0
JB
490 WARN_ON(flag == WLAN_STA_AUTH ||
491 flag == WLAN_STA_ASSOC ||
492 flag == WLAN_STA_AUTHORIZED);
c2c98fde 493 return test_and_clear_bit(flag, &sta->_flags);
07346f81
JB
494}
495
e7f4a940
JB
496static inline int test_and_set_sta_flag(struct sta_info *sta,
497 enum ieee80211_sta_info_flags flag)
498{
d9a7ddb0
JB
499 WARN_ON(flag == WLAN_STA_AUTH ||
500 flag == WLAN_STA_ASSOC ||
501 flag == WLAN_STA_AUTHORIZED);
e7f4a940
JB
502 return test_and_set_bit(flag, &sta->_flags);
503}
504
83d5cc01
JB
505int sta_info_move_state(struct sta_info *sta,
506 enum ieee80211_sta_state new_state);
d9a7ddb0 507
83d5cc01
JB
508static inline void sta_info_pre_move_state(struct sta_info *sta,
509 enum ieee80211_sta_state new_state)
d9a7ddb0 510{
83d5cc01
JB
511 int ret;
512
513 WARN_ON_ONCE(test_sta_flag(sta, WLAN_STA_INSERTED));
514
515 ret = sta_info_move_state(sta, new_state);
d9a7ddb0
JB
516 WARN_ON_ONCE(ret);
517}
518
519
ec034b20
JB
520void ieee80211_assign_tid_tx(struct sta_info *sta, int tid,
521 struct tid_ampdu_tx *tid_tx);
f0706e82 522
40b275b6
JB
523static inline struct tid_ampdu_tx *
524rcu_dereference_protected_tid_tx(struct sta_info *sta, int tid)
525{
526 return rcu_dereference_protected(sta->ampdu_mlme.tid_tx[tid],
527 lockdep_is_held(&sta->lock) ||
528 lockdep_is_held(&sta->ampdu_mlme.mtx));
529}
f0706e82
JB
530
531#define STA_HASH_SIZE 256
532#define STA_HASH(sta) (sta[5])
533
534
948d887d
JB
535/* Maximum number of frames to buffer per power saving station per AC */
536#define STA_MAX_TX_BUFFER 64
f0706e82
JB
537
538/* Minimum buffered frame expiry time. If STA uses listen interval that is
539 * smaller than this value, the minimum value here is used instead. */
540#define STA_TX_BUFFER_EXPIRE (10 * HZ)
541
542/* How often station data is cleaned up (e.g., expiration of buffered frames)
543 */
544#define STA_INFO_CLEANUP_INTERVAL (10 * HZ)
545
d0709a65 546/*
abe60632 547 * Get a STA info, must be under RCU read lock.
d0709a65 548 */
abe60632
JB
549struct sta_info *sta_info_get(struct ieee80211_sub_if_data *sdata,
550 const u8 *addr);
551
0e5ded5a
FF
552struct sta_info *sta_info_get_bss(struct ieee80211_sub_if_data *sdata,
553 const u8 *addr);
554
abe60632
JB
555static inline
556void for_each_sta_info_type_check(struct ieee80211_local *local,
557 const u8 *addr,
558 struct sta_info *sta,
559 struct sta_info *nxt)
560{
561}
562
7852e361 563#define for_each_sta_info(local, _addr, _sta, nxt) \
abe60632 564 for ( /* initialise loop */ \
38bdb650
FF
565 _sta = rcu_dereference(local->sta_hash[STA_HASH(_addr)]),\
566 nxt = _sta ? rcu_dereference(_sta->hnext) : NULL; \
abe60632 567 /* typecheck */ \
38bdb650 568 for_each_sta_info_type_check(local, (_addr), _sta, nxt),\
abe60632 569 /* continue condition */ \
38bdb650 570 _sta; \
abe60632 571 /* advance loop */ \
38bdb650
FF
572 _sta = nxt, \
573 nxt = _sta ? rcu_dereference(_sta->hnext) : NULL \
abe60632
JB
574 ) \
575 /* compare address and run code only if it matches */ \
3bc7945e 576 if (ether_addr_equal(_sta->sta.addr, (_addr)))
abe60632 577
d0709a65
JB
578/*
579 * Get STA info by index, BROKEN!
580 */
3b53fde8
JB
581struct sta_info *sta_info_get_by_idx(struct ieee80211_sub_if_data *sdata,
582 int idx);
d0709a65 583/*
73651ee6
JB
584 * Create a new STA info, caller owns returned structure
585 * until sta_info_insert().
d0709a65 586 */
73651ee6 587struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
56544160 588 const u8 *addr, gfp_t gfp);
d9a7ddb0
JB
589
590void sta_info_free(struct ieee80211_local *local, struct sta_info *sta);
591
73651ee6
JB
592/*
593 * Insert STA info into hash table/list, returns zero or a
594 * -EEXIST if (if the same MAC address is already present).
595 *
34e89507
JB
596 * Calling the non-rcu version makes the caller relinquish,
597 * the _rcu version calls read_lock_rcu() and must be called
598 * without it held.
73651ee6
JB
599 */
600int sta_info_insert(struct sta_info *sta);
34e89507 601int sta_info_insert_rcu(struct sta_info *sta) __acquires(RCU);
34e89507 602
83d5cc01 603int __must_check __sta_info_destroy(struct sta_info *sta);
34e89507
JB
604int sta_info_destroy_addr(struct ieee80211_sub_if_data *sdata,
605 const u8 *addr);
606int sta_info_destroy_addr_bss(struct ieee80211_sub_if_data *sdata,
607 const u8 *addr);
f0706e82 608
c868cb35 609void sta_info_recalc_tim(struct sta_info *sta);
004c872e 610
d0709a65 611void sta_info_init(struct ieee80211_local *local);
d0709a65 612void sta_info_stop(struct ieee80211_local *local);
051007d9
JB
613
614/**
615 * sta_info_flush - flush matching STA entries from the STA table
616 *
617 * Returns the number of removed STA entries.
618 *
619 * @sdata: sdata to remove all stations from
e716251d 620 * @vlans: if the given interface is an AP interface, also flush VLANs
051007d9 621 */
e716251d
JB
622int __sta_info_flush(struct ieee80211_sub_if_data *sdata, bool vlans);
623
624static inline int sta_info_flush(struct ieee80211_sub_if_data *sdata)
625{
626 return __sta_info_flush(sdata, false);
627}
051007d9 628
6b62bf32
TP
629void sta_set_rate_info_tx(struct sta_info *sta,
630 const struct ieee80211_tx_rate *rate,
631 struct rate_info *rinfo);
003e676a
S
632void sta_set_rate_info_rx(struct sta_info *sta,
633 struct rate_info *rinfo);
24723d1b
JB
634void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata,
635 unsigned long exp_time);
687da132 636u8 sta_info_tx_streams(struct sta_info *sta);
d0709a65 637
af818581
JB
638void ieee80211_sta_ps_deliver_wakeup(struct sta_info *sta);
639void ieee80211_sta_ps_deliver_poll_response(struct sta_info *sta);
47086fc5 640void ieee80211_sta_ps_deliver_uapsd(struct sta_info *sta);
af818581 641
f0706e82 642#endif /* STA_INFO_H */