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