xref: /openbmc/linux/net/mac80211/sta_info.h (revision 5b628549)
1 /*
2  * Copyright 2002-2005, Devicescape Software, Inc.
3  * Copyright 2013-2014  Intel Mobile Communications GmbH
4  * Copyright(c) 2015-2017 Intel Deutschland GmbH
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 as
8  * published by the Free Software Foundation.
9  */
10 
11 #ifndef STA_INFO_H
12 #define STA_INFO_H
13 
14 #include <linux/list.h>
15 #include <linux/types.h>
16 #include <linux/if_ether.h>
17 #include <linux/workqueue.h>
18 #include <linux/average.h>
19 #include <linux/bitfield.h>
20 #include <linux/etherdevice.h>
21 #include <linux/rhashtable.h>
22 #include <linux/u64_stats_sync.h>
23 #include "key.h"
24 
25 /**
26  * enum ieee80211_sta_info_flags - Stations flags
27  *
28  * These flags are used with &struct sta_info's @flags member, but
29  * only indirectly with set_sta_flag() and friends.
30  *
31  * @WLAN_STA_AUTH: Station is authenticated.
32  * @WLAN_STA_ASSOC: Station is associated.
33  * @WLAN_STA_PS_STA: Station is in power-save mode
34  * @WLAN_STA_AUTHORIZED: Station is authorized to send/receive traffic.
35  *	This bit is always checked so needs to be enabled for all stations
36  *	when virtual port control is not in use.
37  * @WLAN_STA_SHORT_PREAMBLE: Station is capable of receiving short-preamble
38  *	frames.
39  * @WLAN_STA_WDS: Station is one of our WDS peers.
40  * @WLAN_STA_CLEAR_PS_FILT: Clear PS filter in hardware (using the
41  *	IEEE80211_TX_CTL_CLEAR_PS_FILT control flag) when the next
42  *	frame to this station is transmitted.
43  * @WLAN_STA_MFP: Management frame protection is used with this STA.
44  * @WLAN_STA_BLOCK_BA: Used to deny ADDBA requests (both TX and RX)
45  *	during suspend/resume and station removal.
46  * @WLAN_STA_PS_DRIVER: driver requires keeping this station in
47  *	power-save mode logically to flush frames that might still
48  *	be in the queues
49  * @WLAN_STA_PSPOLL: Station sent PS-poll while driver was keeping
50  *	station in power-save mode, reply when the driver unblocks.
51  * @WLAN_STA_TDLS_PEER: Station is a TDLS peer.
52  * @WLAN_STA_TDLS_PEER_AUTH: This TDLS peer is authorized to send direct
53  *	packets. This means the link is enabled.
54  * @WLAN_STA_TDLS_INITIATOR: We are the initiator of the TDLS link with this
55  *	station.
56  * @WLAN_STA_TDLS_CHAN_SWITCH: This TDLS peer supports TDLS channel-switching
57  * @WLAN_STA_TDLS_OFF_CHANNEL: The local STA is currently off-channel with this
58  *	TDLS peer
59  * @WLAN_STA_TDLS_WIDER_BW: This TDLS peer supports working on a wider bw on
60  *	the BSS base channel.
61  * @WLAN_STA_UAPSD: Station requested unscheduled SP while driver was
62  *	keeping station in power-save mode, reply when the driver
63  *	unblocks the station.
64  * @WLAN_STA_SP: Station is in a service period, so don't try to
65  *	reply to other uAPSD trigger frames or PS-Poll.
66  * @WLAN_STA_4ADDR_EVENT: 4-addr event was already sent for this frame.
67  * @WLAN_STA_INSERTED: This station is inserted into the hash table.
68  * @WLAN_STA_RATE_CONTROL: rate control was initialized for this station.
69  * @WLAN_STA_TOFFSET_KNOWN: toffset calculated for this station is valid.
70  * @WLAN_STA_MPSP_OWNER: local STA is owner of a mesh Peer Service Period.
71  * @WLAN_STA_MPSP_RECIPIENT: local STA is recipient of a MPSP.
72  * @WLAN_STA_PS_DELIVER: station woke up, but we're still blocking TX
73  *	until pending frames are delivered
74  *
75  * @NUM_WLAN_STA_FLAGS: number of defined flags
76  */
77 enum ieee80211_sta_info_flags {
78 	WLAN_STA_AUTH,
79 	WLAN_STA_ASSOC,
80 	WLAN_STA_PS_STA,
81 	WLAN_STA_AUTHORIZED,
82 	WLAN_STA_SHORT_PREAMBLE,
83 	WLAN_STA_WDS,
84 	WLAN_STA_CLEAR_PS_FILT,
85 	WLAN_STA_MFP,
86 	WLAN_STA_BLOCK_BA,
87 	WLAN_STA_PS_DRIVER,
88 	WLAN_STA_PSPOLL,
89 	WLAN_STA_TDLS_PEER,
90 	WLAN_STA_TDLS_PEER_AUTH,
91 	WLAN_STA_TDLS_INITIATOR,
92 	WLAN_STA_TDLS_CHAN_SWITCH,
93 	WLAN_STA_TDLS_OFF_CHANNEL,
94 	WLAN_STA_TDLS_WIDER_BW,
95 	WLAN_STA_UAPSD,
96 	WLAN_STA_SP,
97 	WLAN_STA_4ADDR_EVENT,
98 	WLAN_STA_INSERTED,
99 	WLAN_STA_RATE_CONTROL,
100 	WLAN_STA_TOFFSET_KNOWN,
101 	WLAN_STA_MPSP_OWNER,
102 	WLAN_STA_MPSP_RECIPIENT,
103 	WLAN_STA_PS_DELIVER,
104 
105 	NUM_WLAN_STA_FLAGS,
106 };
107 
108 #define ADDBA_RESP_INTERVAL HZ
109 #define HT_AGG_MAX_RETRIES		15
110 #define HT_AGG_BURST_RETRIES		3
111 #define HT_AGG_RETRIES_PERIOD		(15 * HZ)
112 
113 #define HT_AGG_STATE_DRV_READY		0
114 #define HT_AGG_STATE_RESPONSE_RECEIVED	1
115 #define HT_AGG_STATE_OPERATIONAL	2
116 #define HT_AGG_STATE_STOPPING		3
117 #define HT_AGG_STATE_WANT_START		4
118 #define HT_AGG_STATE_WANT_STOP		5
119 #define HT_AGG_STATE_START_CB		6
120 #define HT_AGG_STATE_STOP_CB		7
121 
122 DECLARE_EWMA(avg_signal, 10, 8)
123 enum ieee80211_agg_stop_reason {
124 	AGG_STOP_DECLINED,
125 	AGG_STOP_LOCAL_REQUEST,
126 	AGG_STOP_PEER_REQUEST,
127 	AGG_STOP_DESTROY_STA,
128 };
129 
130 /* Debugfs flags to enable/disable use of RX/TX airtime in scheduler */
131 #define AIRTIME_USE_TX		BIT(0)
132 #define AIRTIME_USE_RX		BIT(1)
133 
134 struct airtime_info {
135 	u64 rx_airtime;
136 	u64 tx_airtime;
137 	s64 deficit;
138 };
139 
140 struct sta_info;
141 
142 /**
143  * struct tid_ampdu_tx - TID aggregation information (Tx).
144  *
145  * @rcu_head: rcu head for freeing structure
146  * @session_timer: check if we keep Tx-ing on the TID (by timeout value)
147  * @addba_resp_timer: timer for peer's response to addba request
148  * @pending: pending frames queue -- use sta's spinlock to protect
149  * @sta: station we are attached to
150  * @dialog_token: dialog token for aggregation session
151  * @timeout: session timeout value to be filled in ADDBA requests
152  * @tid: TID number
153  * @state: session state (see above)
154  * @last_tx: jiffies of last tx activity
155  * @stop_initiator: initiator of a session stop
156  * @tx_stop: TX DelBA frame when stopping
157  * @buf_size: reorder buffer size at receiver
158  * @failed_bar_ssn: ssn of the last failed BAR tx attempt
159  * @bar_pending: BAR needs to be re-sent
160  * @amsdu: support A-MSDU withing A-MDPU
161  *
162  * This structure's lifetime is managed by RCU, assignments to
163  * the array holding it must hold the aggregation mutex.
164  *
165  * The TX path can access it under RCU lock-free if, and
166  * only if, the state has the flag %HT_AGG_STATE_OPERATIONAL
167  * set. Otherwise, the TX path must also acquire the spinlock
168  * and re-check the state, see comments in the tx code
169  * touching it.
170  */
171 struct tid_ampdu_tx {
172 	struct rcu_head rcu_head;
173 	struct timer_list session_timer;
174 	struct timer_list addba_resp_timer;
175 	struct sk_buff_head pending;
176 	struct sta_info *sta;
177 	unsigned long state;
178 	unsigned long last_tx;
179 	u16 timeout;
180 	u8 dialog_token;
181 	u8 stop_initiator;
182 	bool tx_stop;
183 	u16 buf_size;
184 
185 	u16 failed_bar_ssn;
186 	bool bar_pending;
187 	bool amsdu;
188 	u8 tid;
189 };
190 
191 /**
192  * struct tid_ampdu_rx - TID aggregation information (Rx).
193  *
194  * @reorder_buf: buffer to reorder incoming aggregated MPDUs. An MPDU may be an
195  *	A-MSDU with individually reported subframes.
196  * @reorder_buf_filtered: bitmap indicating where there are filtered frames in
197  *	the reorder buffer that should be ignored when releasing frames
198  * @reorder_time: jiffies when skb was added
199  * @session_timer: check if peer keeps Tx-ing on the TID (by timeout value)
200  * @reorder_timer: releases expired frames from the reorder buffer.
201  * @sta: station we are attached to
202  * @last_rx: jiffies of last rx activity
203  * @head_seq_num: head sequence number in reordering buffer.
204  * @stored_mpdu_num: number of MPDUs in reordering buffer
205  * @ssn: Starting Sequence Number expected to be aggregated.
206  * @buf_size: buffer size for incoming A-MPDUs
207  * @timeout: reset timer value (in TUs).
208  * @tid: TID number
209  * @rcu_head: RCU head used for freeing this struct
210  * @reorder_lock: serializes access to reorder buffer, see below.
211  * @auto_seq: used for offloaded BA sessions to automatically pick head_seq_and
212  *	and ssn.
213  * @removed: this session is removed (but might have been found due to RCU)
214  * @started: this session has started (head ssn or higher was received)
215  *
216  * This structure's lifetime is managed by RCU, assignments to
217  * the array holding it must hold the aggregation mutex.
218  *
219  * The @reorder_lock is used to protect the members of this
220  * struct, except for @timeout, @buf_size and @dialog_token,
221  * which are constant across the lifetime of the struct (the
222  * dialog token being used only for debugging).
223  */
224 struct tid_ampdu_rx {
225 	struct rcu_head rcu_head;
226 	spinlock_t reorder_lock;
227 	u64 reorder_buf_filtered;
228 	struct sk_buff_head *reorder_buf;
229 	unsigned long *reorder_time;
230 	struct sta_info *sta;
231 	struct timer_list session_timer;
232 	struct timer_list reorder_timer;
233 	unsigned long last_rx;
234 	u16 head_seq_num;
235 	u16 stored_mpdu_num;
236 	u16 ssn;
237 	u16 buf_size;
238 	u16 timeout;
239 	u8 tid;
240 	u8 auto_seq:1,
241 	   removed:1,
242 	   started:1;
243 };
244 
245 /**
246  * struct sta_ampdu_mlme - STA aggregation information.
247  *
248  * @mtx: mutex to protect all TX data (except non-NULL assignments
249  *	to tid_tx[idx], which are protected by the sta spinlock)
250  *	tid_start_tx is also protected by sta->lock.
251  * @tid_rx: aggregation info for Rx per TID -- RCU protected
252  * @tid_rx_token: dialog tokens for valid aggregation sessions
253  * @tid_rx_timer_expired: bitmap indicating on which TIDs the
254  *	RX timer expired until the work for it runs
255  * @tid_rx_stop_requested:  bitmap indicating which BA sessions per TID the
256  *	driver requested to close until the work for it runs
257  * @tid_rx_manage_offl: bitmap indicating which BA sessions were requested
258  *	to be treated as started/stopped due to offloading
259  * @agg_session_valid: bitmap indicating which TID has a rx BA session open on
260  * @unexpected_agg: bitmap indicating which TID already sent a delBA due to
261  *	unexpected aggregation related frames outside a session
262  * @work: work struct for starting/stopping aggregation
263  * @tid_tx: aggregation info for Tx per TID
264  * @tid_start_tx: sessions where start was requested
265  * @last_addba_req_time: timestamp of the last addBA request.
266  * @addba_req_num: number of times addBA request has been sent.
267  * @dialog_token_allocator: dialog token enumerator for each new session;
268  */
269 struct sta_ampdu_mlme {
270 	struct mutex mtx;
271 	/* rx */
272 	struct tid_ampdu_rx __rcu *tid_rx[IEEE80211_NUM_TIDS];
273 	u8 tid_rx_token[IEEE80211_NUM_TIDS];
274 	unsigned long tid_rx_timer_expired[BITS_TO_LONGS(IEEE80211_NUM_TIDS)];
275 	unsigned long tid_rx_stop_requested[BITS_TO_LONGS(IEEE80211_NUM_TIDS)];
276 	unsigned long tid_rx_manage_offl[BITS_TO_LONGS(2 * IEEE80211_NUM_TIDS)];
277 	unsigned long agg_session_valid[BITS_TO_LONGS(IEEE80211_NUM_TIDS)];
278 	unsigned long unexpected_agg[BITS_TO_LONGS(IEEE80211_NUM_TIDS)];
279 	/* tx */
280 	struct work_struct work;
281 	struct tid_ampdu_tx __rcu *tid_tx[IEEE80211_NUM_TIDS];
282 	struct tid_ampdu_tx *tid_start_tx[IEEE80211_NUM_TIDS];
283 	unsigned long last_addba_req_time[IEEE80211_NUM_TIDS];
284 	u8 addba_req_num[IEEE80211_NUM_TIDS];
285 	u8 dialog_token_allocator;
286 };
287 
288 
289 /* Value to indicate no TID reservation */
290 #define IEEE80211_TID_UNRESERVED	0xff
291 
292 #define IEEE80211_FAST_XMIT_MAX_IV	18
293 
294 /**
295  * struct ieee80211_fast_tx - TX fastpath information
296  * @key: key to use for hw crypto
297  * @hdr: the 802.11 header to put with the frame
298  * @hdr_len: actual 802.11 header length
299  * @sa_offs: offset of the SA
300  * @da_offs: offset of the DA
301  * @pn_offs: offset where to put PN for crypto (or 0 if not needed)
302  * @band: band this will be transmitted on, for tx_info
303  * @rcu_head: RCU head to free this struct
304  *
305  * This struct is small enough so that the common case (maximum crypto
306  * header length of 8 like for CCMP/GCMP) fits into a single 64-byte
307  * cache line.
308  */
309 struct ieee80211_fast_tx {
310 	struct ieee80211_key *key;
311 	u8 hdr_len;
312 	u8 sa_offs, da_offs, pn_offs;
313 	u8 band;
314 	u8 hdr[30 + 2 + IEEE80211_FAST_XMIT_MAX_IV +
315 	       sizeof(rfc1042_header)] __aligned(2);
316 
317 	struct rcu_head rcu_head;
318 };
319 
320 /**
321  * struct ieee80211_fast_rx - RX fastpath information
322  * @dev: netdevice for reporting the SKB
323  * @vif_type: (P2P-less) interface type of the original sdata (sdata->vif.type)
324  * @vif_addr: interface address
325  * @rfc1042_hdr: copy of the RFC 1042 SNAP header (to have in cache)
326  * @control_port_protocol: control port protocol copied from sdata
327  * @expected_ds_bits: from/to DS bits expected
328  * @icv_len: length of the MIC if present
329  * @key: bool indicating encryption is expected (key is set)
330  * @sta_notify: notify the MLME code (once)
331  * @internal_forward: forward froms internally on AP/VLAN type interfaces
332  * @uses_rss: copy of USES_RSS hw flag
333  * @da_offs: offset of the DA in the header (for header conversion)
334  * @sa_offs: offset of the SA in the header (for header conversion)
335  * @rcu_head: RCU head for freeing this structure
336  */
337 struct ieee80211_fast_rx {
338 	struct net_device *dev;
339 	enum nl80211_iftype vif_type;
340 	u8 vif_addr[ETH_ALEN] __aligned(2);
341 	u8 rfc1042_hdr[6] __aligned(2);
342 	__be16 control_port_protocol;
343 	__le16 expected_ds_bits;
344 	u8 icv_len;
345 	u8 key:1,
346 	   sta_notify:1,
347 	   internal_forward:1,
348 	   uses_rss:1;
349 	u8 da_offs, sa_offs;
350 
351 	struct rcu_head rcu_head;
352 };
353 
354 /* we use only values in the range 0-100, so pick a large precision */
355 DECLARE_EWMA(mesh_fail_avg, 20, 8)
356 DECLARE_EWMA(mesh_tx_rate_avg, 8, 16)
357 
358 /**
359  * struct mesh_sta - mesh STA information
360  * @plink_lock: serialize access to plink fields
361  * @llid: Local link ID
362  * @plid: Peer link ID
363  * @aid: local aid supplied by peer
364  * @reason: Cancel reason on PLINK_HOLDING state
365  * @plink_retries: Retries in establishment
366  * @plink_state: peer link state
367  * @plink_timeout: timeout of peer link
368  * @plink_timer: peer link watch timer
369  * @plink_sta: peer link watch timer's sta_info
370  * @t_offset: timing offset relative to this host
371  * @t_offset_setpoint: reference timing offset of this sta to be used when
372  * 	calculating clockdrift
373  * @local_pm: local link-specific power save mode
374  * @peer_pm: peer-specific power save mode towards local STA
375  * @nonpeer_pm: STA power save mode towards non-peer neighbors
376  * @processed_beacon: set to true after peer rates and capabilities are
377  *	processed
378  * @connected_to_gate: true if mesh STA has a path to a mesh gate
379  * @fail_avg: moving percentage of failed MSDUs
380  * @tx_rate_avg: moving average of tx bitrate
381  */
382 struct mesh_sta {
383 	struct timer_list plink_timer;
384 	struct sta_info *plink_sta;
385 
386 	s64 t_offset;
387 	s64 t_offset_setpoint;
388 
389 	spinlock_t plink_lock;
390 	u16 llid;
391 	u16 plid;
392 	u16 aid;
393 	u16 reason;
394 	u8 plink_retries;
395 
396 	bool processed_beacon;
397 	bool connected_to_gate;
398 
399 	enum nl80211_plink_state plink_state;
400 	u32 plink_timeout;
401 
402 	/* mesh power save */
403 	enum nl80211_mesh_power_mode local_pm;
404 	enum nl80211_mesh_power_mode peer_pm;
405 	enum nl80211_mesh_power_mode nonpeer_pm;
406 
407 	/* moving percentage of failed MSDUs */
408 	struct ewma_mesh_fail_avg fail_avg;
409 	/* moving average of tx bitrate */
410 	struct ewma_mesh_tx_rate_avg tx_rate_avg;
411 };
412 
413 DECLARE_EWMA(signal, 10, 8)
414 
415 struct ieee80211_sta_rx_stats {
416 	unsigned long packets;
417 	unsigned long last_rx;
418 	unsigned long num_duplicates;
419 	unsigned long fragments;
420 	unsigned long dropped;
421 	int last_signal;
422 	u8 chains;
423 	s8 chain_signal_last[IEEE80211_MAX_CHAINS];
424 	u32 last_rate;
425 	struct u64_stats_sync syncp;
426 	u64 bytes;
427 	u64 msdu[IEEE80211_NUM_TIDS + 1];
428 };
429 
430 /*
431  * The bandwidth threshold below which the per-station CoDel parameters will be
432  * scaled to be more lenient (to prevent starvation of slow stations). This
433  * value will be scaled by the number of active stations when it is being
434  * applied.
435  */
436 #define STA_SLOW_THRESHOLD 6000 /* 6 Mbps */
437 
438 /**
439  * struct sta_info - STA information
440  *
441  * This structure collects information about a station that
442  * mac80211 is communicating with.
443  *
444  * @list: global linked list entry
445  * @free_list: list entry for keeping track of stations to free
446  * @hash_node: hash node for rhashtable
447  * @addr: station's MAC address - duplicated from public part to
448  *	let the hash table work with just a single cacheline
449  * @local: pointer to the global information
450  * @sdata: virtual interface this station belongs to
451  * @ptk: peer keys negotiated with this station, if any
452  * @ptk_idx: last installed peer key index
453  * @gtk: group keys negotiated with this station, if any
454  * @rate_ctrl: rate control algorithm reference
455  * @rate_ctrl_lock: spinlock used to protect rate control data
456  *	(data inside the algorithm, so serializes calls there)
457  * @rate_ctrl_priv: rate control private per-STA pointer
458  * @lock: used for locking all fields that require locking, see comments
459  *	in the header file.
460  * @drv_deliver_wk: used for delivering frames after driver PS unblocking
461  * @listen_interval: listen interval of this station, when we're acting as AP
462  * @_flags: STA flags, see &enum ieee80211_sta_info_flags, do not use directly
463  * @ps_lock: used for powersave (when mac80211 is the AP) related locking
464  * @ps_tx_buf: buffers (per AC) of frames to transmit to this station
465  *	when it leaves power saving state or polls
466  * @tx_filtered: buffers (per AC) of frames we already tried to
467  *	transmit but were filtered by hardware due to STA having
468  *	entered power saving state, these are also delivered to
469  *	the station when it leaves powersave or polls for frames
470  * @driver_buffered_tids: bitmap of TIDs the driver has data buffered on
471  * @txq_buffered_tids: bitmap of TIDs that mac80211 has txq data buffered on
472  * @last_connected: time (in seconds) when a station got connected
473  * @last_seq_ctrl: last received seq/frag number from this STA (per TID
474  *	plus one for non-QoS frames)
475  * @tid_seq: per-TID sequence numbers for sending to this STA
476  * @airtime: per-AC struct airtime_info describing airtime statistics for this
477  *	station
478  * @airtime_weight: station weight for airtime fairness calculation purposes
479  * @ampdu_mlme: A-MPDU state machine state
480  * @mesh: mesh STA information
481  * @debugfs_dir: debug filesystem directory dentry
482  * @dead: set to true when sta is unlinked
483  * @removed: set to true when sta is being removed from sta_list
484  * @uploaded: set to true when sta is uploaded to the driver
485  * @sta: station information we share with the driver
486  * @sta_state: duplicates information about station state (for debug)
487  * @rcu_head: RCU head used for freeing this station struct
488  * @cur_max_bandwidth: maximum bandwidth to use for TX to the station,
489  *	taken from HT/VHT capabilities or VHT operating mode notification
490  * @known_smps_mode: the smps_mode the client thinks we are in. Relevant for
491  *	AP only.
492  * @cipher_scheme: optional cipher scheme for this station
493  * @cparams: CoDel parameters for this station.
494  * @reserved_tid: reserved TID (if any, otherwise IEEE80211_TID_UNRESERVED)
495  * @fast_tx: TX fastpath information
496  * @fast_rx: RX fastpath information
497  * @tdls_chandef: a TDLS peer can have a wider chandef that is compatible to
498  *	the BSS one.
499  * @tx_stats: TX statistics
500  * @tx_stats.packets: # of packets transmitted
501  * @tx_stats.bytes: # of bytes in all packets transmitted
502  * @tx_stats.last_rate: last TX rate
503  * @tx_stats.msdu: # of transmitted MSDUs per TID
504  * @rx_stats: RX statistics
505  * @rx_stats_avg: averaged RX statistics
506  * @rx_stats_avg.signal: averaged signal
507  * @rx_stats_avg.chain_signal: averaged per-chain signal
508  * @pcpu_rx_stats: per-CPU RX statistics, assigned only if the driver needs
509  *	this (by advertising the USES_RSS hw flag)
510  * @status_stats: TX status statistics
511  * @status_stats.filtered: # of filtered frames
512  * @status_stats.retry_failed: # of frames that failed after retry
513  * @status_stats.retry_count: # of retries attempted
514  * @status_stats.lost_packets: # of lost packets
515  * @status_stats.last_tdls_pkt_time: timestamp of last TDLS packet
516  * @status_stats.msdu_retries: # of MSDU retries
517  * @status_stats.msdu_failed: # of failed MSDUs
518  * @status_stats.last_ack: last ack timestamp (jiffies)
519  * @status_stats.last_ack_signal: last ACK signal
520  * @status_stats.ack_signal_filled: last ACK signal validity
521  * @status_stats.avg_ack_signal: average ACK signal
522  */
523 struct sta_info {
524 	/* General information, mostly static */
525 	struct list_head list, free_list;
526 	struct rcu_head rcu_head;
527 	struct rhlist_head hash_node;
528 	u8 addr[ETH_ALEN];
529 	struct ieee80211_local *local;
530 	struct ieee80211_sub_if_data *sdata;
531 	struct ieee80211_key __rcu *gtk[NUM_DEFAULT_KEYS + NUM_DEFAULT_MGMT_KEYS];
532 	struct ieee80211_key __rcu *ptk[NUM_DEFAULT_KEYS];
533 	u8 ptk_idx;
534 	struct rate_control_ref *rate_ctrl;
535 	void *rate_ctrl_priv;
536 	spinlock_t rate_ctrl_lock;
537 	spinlock_t lock;
538 
539 	struct ieee80211_fast_tx __rcu *fast_tx;
540 	struct ieee80211_fast_rx __rcu *fast_rx;
541 	struct ieee80211_sta_rx_stats __percpu *pcpu_rx_stats;
542 
543 #ifdef CONFIG_MAC80211_MESH
544 	struct mesh_sta *mesh;
545 #endif
546 
547 	struct work_struct drv_deliver_wk;
548 
549 	u16 listen_interval;
550 
551 	bool dead;
552 	bool removed;
553 
554 	bool uploaded;
555 
556 	enum ieee80211_sta_state sta_state;
557 
558 	/* use the accessors defined below */
559 	unsigned long _flags;
560 
561 	/* STA powersave lock and frame queues */
562 	spinlock_t ps_lock;
563 	struct sk_buff_head ps_tx_buf[IEEE80211_NUM_ACS];
564 	struct sk_buff_head tx_filtered[IEEE80211_NUM_ACS];
565 	unsigned long driver_buffered_tids;
566 	unsigned long txq_buffered_tids;
567 
568 	long last_connected;
569 
570 	/* Updated from RX path only, no locking requirements */
571 	struct ieee80211_sta_rx_stats rx_stats;
572 	struct {
573 		struct ewma_signal signal;
574 		struct ewma_signal chain_signal[IEEE80211_MAX_CHAINS];
575 	} rx_stats_avg;
576 
577 	/* Plus 1 for non-QoS frames */
578 	__le16 last_seq_ctrl[IEEE80211_NUM_TIDS + 1];
579 
580 	/* Updated from TX status path only, no locking requirements */
581 	struct {
582 		unsigned long filtered;
583 		unsigned long retry_failed, retry_count;
584 		unsigned int lost_packets;
585 		unsigned long last_tdls_pkt_time;
586 		u64 msdu_retries[IEEE80211_NUM_TIDS + 1];
587 		u64 msdu_failed[IEEE80211_NUM_TIDS + 1];
588 		unsigned long last_ack;
589 		s8 last_ack_signal;
590 		bool ack_signal_filled;
591 		struct ewma_avg_signal avg_ack_signal;
592 	} status_stats;
593 
594 	/* Updated from TX path only, no locking requirements */
595 	struct {
596 		u64 packets[IEEE80211_NUM_ACS];
597 		u64 bytes[IEEE80211_NUM_ACS];
598 		struct ieee80211_tx_rate last_rate;
599 		u64 msdu[IEEE80211_NUM_TIDS + 1];
600 	} tx_stats;
601 	u16 tid_seq[IEEE80211_QOS_CTL_TID_MASK + 1];
602 
603 	struct airtime_info airtime[IEEE80211_NUM_ACS];
604 	u16 airtime_weight;
605 
606 	/*
607 	 * Aggregation information, locked with lock.
608 	 */
609 	struct sta_ampdu_mlme ampdu_mlme;
610 
611 #ifdef CONFIG_MAC80211_DEBUGFS
612 	struct dentry *debugfs_dir;
613 #endif
614 
615 	enum ieee80211_sta_rx_bandwidth cur_max_bandwidth;
616 
617 	enum ieee80211_smps_mode known_smps_mode;
618 	const struct ieee80211_cipher_scheme *cipher_scheme;
619 
620 	struct codel_params cparams;
621 
622 	u8 reserved_tid;
623 
624 	struct cfg80211_chan_def tdls_chandef;
625 
626 	/* keep last! */
627 	struct ieee80211_sta sta;
628 };
629 
630 static inline enum nl80211_plink_state sta_plink_state(struct sta_info *sta)
631 {
632 #ifdef CONFIG_MAC80211_MESH
633 	return sta->mesh->plink_state;
634 #endif
635 	return NL80211_PLINK_LISTEN;
636 }
637 
638 static inline void set_sta_flag(struct sta_info *sta,
639 				enum ieee80211_sta_info_flags flag)
640 {
641 	WARN_ON(flag == WLAN_STA_AUTH ||
642 		flag == WLAN_STA_ASSOC ||
643 		flag == WLAN_STA_AUTHORIZED);
644 	set_bit(flag, &sta->_flags);
645 }
646 
647 static inline void clear_sta_flag(struct sta_info *sta,
648 				  enum ieee80211_sta_info_flags flag)
649 {
650 	WARN_ON(flag == WLAN_STA_AUTH ||
651 		flag == WLAN_STA_ASSOC ||
652 		flag == WLAN_STA_AUTHORIZED);
653 	clear_bit(flag, &sta->_flags);
654 }
655 
656 static inline int test_sta_flag(struct sta_info *sta,
657 				enum ieee80211_sta_info_flags flag)
658 {
659 	return test_bit(flag, &sta->_flags);
660 }
661 
662 static inline int test_and_clear_sta_flag(struct sta_info *sta,
663 					  enum ieee80211_sta_info_flags flag)
664 {
665 	WARN_ON(flag == WLAN_STA_AUTH ||
666 		flag == WLAN_STA_ASSOC ||
667 		flag == WLAN_STA_AUTHORIZED);
668 	return test_and_clear_bit(flag, &sta->_flags);
669 }
670 
671 static inline int test_and_set_sta_flag(struct sta_info *sta,
672 					enum ieee80211_sta_info_flags flag)
673 {
674 	WARN_ON(flag == WLAN_STA_AUTH ||
675 		flag == WLAN_STA_ASSOC ||
676 		flag == WLAN_STA_AUTHORIZED);
677 	return test_and_set_bit(flag, &sta->_flags);
678 }
679 
680 int sta_info_move_state(struct sta_info *sta,
681 			enum ieee80211_sta_state new_state);
682 
683 static inline void sta_info_pre_move_state(struct sta_info *sta,
684 					   enum ieee80211_sta_state new_state)
685 {
686 	int ret;
687 
688 	WARN_ON_ONCE(test_sta_flag(sta, WLAN_STA_INSERTED));
689 
690 	ret = sta_info_move_state(sta, new_state);
691 	WARN_ON_ONCE(ret);
692 }
693 
694 
695 void ieee80211_assign_tid_tx(struct sta_info *sta, int tid,
696 			     struct tid_ampdu_tx *tid_tx);
697 
698 static inline struct tid_ampdu_tx *
699 rcu_dereference_protected_tid_tx(struct sta_info *sta, int tid)
700 {
701 	return rcu_dereference_protected(sta->ampdu_mlme.tid_tx[tid],
702 					 lockdep_is_held(&sta->lock) ||
703 					 lockdep_is_held(&sta->ampdu_mlme.mtx));
704 }
705 
706 /* Maximum number of frames to buffer per power saving station per AC */
707 #define STA_MAX_TX_BUFFER	64
708 
709 /* Minimum buffered frame expiry time. If STA uses listen interval that is
710  * smaller than this value, the minimum value here is used instead. */
711 #define STA_TX_BUFFER_EXPIRE (10 * HZ)
712 
713 /* How often station data is cleaned up (e.g., expiration of buffered frames)
714  */
715 #define STA_INFO_CLEANUP_INTERVAL (10 * HZ)
716 
717 struct rhlist_head *sta_info_hash_lookup(struct ieee80211_local *local,
718 					 const u8 *addr);
719 
720 /*
721  * Get a STA info, must be under RCU read lock.
722  */
723 struct sta_info *sta_info_get(struct ieee80211_sub_if_data *sdata,
724 			      const u8 *addr);
725 
726 struct sta_info *sta_info_get_bss(struct ieee80211_sub_if_data *sdata,
727 				  const u8 *addr);
728 
729 #define for_each_sta_info(local, _addr, _sta, _tmp)			\
730 	rhl_for_each_entry_rcu(_sta, _tmp,				\
731 			       sta_info_hash_lookup(local, _addr), hash_node)
732 
733 /*
734  * Get STA info by index, BROKEN!
735  */
736 struct sta_info *sta_info_get_by_idx(struct ieee80211_sub_if_data *sdata,
737 				     int idx);
738 /*
739  * Create a new STA info, caller owns returned structure
740  * until sta_info_insert().
741  */
742 struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
743 				const u8 *addr, gfp_t gfp);
744 
745 void sta_info_free(struct ieee80211_local *local, struct sta_info *sta);
746 
747 /*
748  * Insert STA info into hash table/list, returns zero or a
749  * -EEXIST if (if the same MAC address is already present).
750  *
751  * Calling the non-rcu version makes the caller relinquish,
752  * the _rcu version calls read_lock_rcu() and must be called
753  * without it held.
754  */
755 int sta_info_insert(struct sta_info *sta);
756 int sta_info_insert_rcu(struct sta_info *sta) __acquires(RCU);
757 
758 int __must_check __sta_info_destroy(struct sta_info *sta);
759 int sta_info_destroy_addr(struct ieee80211_sub_if_data *sdata,
760 			  const u8 *addr);
761 int sta_info_destroy_addr_bss(struct ieee80211_sub_if_data *sdata,
762 			      const u8 *addr);
763 
764 void sta_info_recalc_tim(struct sta_info *sta);
765 
766 int sta_info_init(struct ieee80211_local *local);
767 void sta_info_stop(struct ieee80211_local *local);
768 
769 /**
770  * sta_info_flush - flush matching STA entries from the STA table
771  *
772  * Returns the number of removed STA entries.
773  *
774  * @sdata: sdata to remove all stations from
775  * @vlans: if the given interface is an AP interface, also flush VLANs
776  */
777 int __sta_info_flush(struct ieee80211_sub_if_data *sdata, bool vlans);
778 
779 static inline int sta_info_flush(struct ieee80211_sub_if_data *sdata)
780 {
781 	return __sta_info_flush(sdata, false);
782 }
783 
784 void sta_set_rate_info_tx(struct sta_info *sta,
785 			  const struct ieee80211_tx_rate *rate,
786 			  struct rate_info *rinfo);
787 void sta_set_sinfo(struct sta_info *sta, struct station_info *sinfo,
788 		   bool tidstats);
789 
790 u32 sta_get_expected_throughput(struct sta_info *sta);
791 
792 void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata,
793 			  unsigned long exp_time);
794 u8 sta_info_tx_streams(struct sta_info *sta);
795 
796 void ieee80211_sta_ps_deliver_wakeup(struct sta_info *sta);
797 void ieee80211_sta_ps_deliver_poll_response(struct sta_info *sta);
798 void ieee80211_sta_ps_deliver_uapsd(struct sta_info *sta);
799 
800 unsigned long ieee80211_sta_last_active(struct sta_info *sta);
801 
802 enum sta_stats_type {
803 	STA_STATS_RATE_TYPE_INVALID = 0,
804 	STA_STATS_RATE_TYPE_LEGACY,
805 	STA_STATS_RATE_TYPE_HT,
806 	STA_STATS_RATE_TYPE_VHT,
807 	STA_STATS_RATE_TYPE_HE,
808 };
809 
810 #define STA_STATS_FIELD_HT_MCS		GENMASK( 7,  0)
811 #define STA_STATS_FIELD_LEGACY_IDX	GENMASK( 3,  0)
812 #define STA_STATS_FIELD_LEGACY_BAND	GENMASK( 7,  4)
813 #define STA_STATS_FIELD_VHT_MCS		GENMASK( 3,  0)
814 #define STA_STATS_FIELD_VHT_NSS		GENMASK( 7,  4)
815 #define STA_STATS_FIELD_HE_MCS		GENMASK( 3,  0)
816 #define STA_STATS_FIELD_HE_NSS		GENMASK( 7,  4)
817 #define STA_STATS_FIELD_BW		GENMASK(11,  8)
818 #define STA_STATS_FIELD_SGI		GENMASK(12, 12)
819 #define STA_STATS_FIELD_TYPE		GENMASK(15, 13)
820 #define STA_STATS_FIELD_HE_RU		GENMASK(18, 16)
821 #define STA_STATS_FIELD_HE_GI		GENMASK(20, 19)
822 #define STA_STATS_FIELD_HE_DCM		GENMASK(21, 21)
823 
824 #define STA_STATS_FIELD(_n, _v)		FIELD_PREP(STA_STATS_FIELD_ ## _n, _v)
825 #define STA_STATS_GET(_n, _v)		FIELD_GET(STA_STATS_FIELD_ ## _n, _v)
826 
827 #define STA_STATS_RATE_INVALID		0
828 
829 static inline u32 sta_stats_encode_rate(struct ieee80211_rx_status *s)
830 {
831 	u32 r;
832 
833 	r = STA_STATS_FIELD(BW, s->bw);
834 
835 	if (s->enc_flags & RX_ENC_FLAG_SHORT_GI)
836 		r |= STA_STATS_FIELD(SGI, 1);
837 
838 	switch (s->encoding) {
839 	case RX_ENC_VHT:
840 		r |= STA_STATS_FIELD(TYPE, STA_STATS_RATE_TYPE_VHT);
841 		r |= STA_STATS_FIELD(VHT_NSS, s->nss);
842 		r |= STA_STATS_FIELD(VHT_MCS, s->rate_idx);
843 		break;
844 	case RX_ENC_HT:
845 		r |= STA_STATS_FIELD(TYPE, STA_STATS_RATE_TYPE_HT);
846 		r |= STA_STATS_FIELD(HT_MCS, s->rate_idx);
847 		break;
848 	case RX_ENC_LEGACY:
849 		r |= STA_STATS_FIELD(TYPE, STA_STATS_RATE_TYPE_LEGACY);
850 		r |= STA_STATS_FIELD(LEGACY_BAND, s->band);
851 		r |= STA_STATS_FIELD(LEGACY_IDX, s->rate_idx);
852 		break;
853 	case RX_ENC_HE:
854 		r |= STA_STATS_FIELD(TYPE, STA_STATS_RATE_TYPE_HE);
855 		r |= STA_STATS_FIELD(HE_NSS, s->nss);
856 		r |= STA_STATS_FIELD(HE_MCS, s->rate_idx);
857 		r |= STA_STATS_FIELD(HE_GI, s->he_gi);
858 		r |= STA_STATS_FIELD(HE_RU, s->he_ru);
859 		r |= STA_STATS_FIELD(HE_DCM, s->he_dcm);
860 		break;
861 	default:
862 		WARN_ON(1);
863 		return STA_STATS_RATE_INVALID;
864 	}
865 
866 	return r;
867 }
868 
869 #endif /* STA_INFO_H */
870