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