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-2021 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 
139 struct airtime_info {
140 	u64 rx_airtime;
141 	u64 tx_airtime;
142 	u64 v_t;
143 	u64 last_scheduled;
144 	struct list_head list;
145 	atomic_t aql_tx_pending; /* Estimated airtime for frames pending */
146 	u32 aql_limit_low;
147 	u32 aql_limit_high;
148 	u32 weight_reciprocal;
149 	u16 weight;
150 };
151 
152 void ieee80211_sta_update_pending_airtime(struct ieee80211_local *local,
153 					  struct sta_info *sta, u8 ac,
154 					  u16 tx_airtime, bool tx_completed);
155 void ieee80211_register_airtime(struct ieee80211_txq *txq,
156 				u32 tx_airtime, u32 rx_airtime);
157 
158 struct sta_info;
159 
160 /**
161  * struct tid_ampdu_tx - TID aggregation information (Tx).
162  *
163  * @rcu_head: rcu head for freeing structure
164  * @session_timer: check if we keep Tx-ing on the TID (by timeout value)
165  * @addba_resp_timer: timer for peer's response to addba request
166  * @pending: pending frames queue -- use sta's spinlock to protect
167  * @sta: station we are attached to
168  * @dialog_token: dialog token for aggregation session
169  * @timeout: session timeout value to be filled in ADDBA requests
170  * @tid: TID number
171  * @state: session state (see above)
172  * @last_tx: jiffies of last tx activity
173  * @stop_initiator: initiator of a session stop
174  * @tx_stop: TX DelBA frame when stopping
175  * @buf_size: reorder buffer size at receiver
176  * @failed_bar_ssn: ssn of the last failed BAR tx attempt
177  * @bar_pending: BAR needs to be re-sent
178  * @amsdu: support A-MSDU withing A-MDPU
179  * @ssn: starting sequence number of the session
180  *
181  * This structure's lifetime is managed by RCU, assignments to
182  * the array holding it must hold the aggregation mutex.
183  *
184  * The TX path can access it under RCU lock-free if, and
185  * only if, the state has the flag %HT_AGG_STATE_OPERATIONAL
186  * set. Otherwise, the TX path must also acquire the spinlock
187  * and re-check the state, see comments in the tx code
188  * touching it.
189  */
190 struct tid_ampdu_tx {
191 	struct rcu_head rcu_head;
192 	struct timer_list session_timer;
193 	struct timer_list addba_resp_timer;
194 	struct sk_buff_head pending;
195 	struct sta_info *sta;
196 	unsigned long state;
197 	unsigned long last_tx;
198 	u16 timeout;
199 	u8 dialog_token;
200 	u8 stop_initiator;
201 	bool tx_stop;
202 	u16 buf_size;
203 	u16 ssn;
204 
205 	u16 failed_bar_ssn;
206 	bool bar_pending;
207 	bool amsdu;
208 	u8 tid;
209 };
210 
211 /**
212  * struct tid_ampdu_rx - TID aggregation information (Rx).
213  *
214  * @reorder_buf: buffer to reorder incoming aggregated MPDUs. An MPDU may be an
215  *	A-MSDU with individually reported subframes.
216  * @reorder_buf_filtered: bitmap indicating where there are filtered frames in
217  *	the reorder buffer that should be ignored when releasing frames
218  * @reorder_time: jiffies when skb was added
219  * @session_timer: check if peer keeps Tx-ing on the TID (by timeout value)
220  * @reorder_timer: releases expired frames from the reorder buffer.
221  * @sta: station we are attached to
222  * @last_rx: jiffies of last rx activity
223  * @head_seq_num: head sequence number in reordering buffer.
224  * @stored_mpdu_num: number of MPDUs in reordering buffer
225  * @ssn: Starting Sequence Number expected to be aggregated.
226  * @buf_size: buffer size for incoming A-MPDUs
227  * @timeout: reset timer value (in TUs).
228  * @tid: TID number
229  * @rcu_head: RCU head used for freeing this struct
230  * @reorder_lock: serializes access to reorder buffer, see below.
231  * @auto_seq: used for offloaded BA sessions to automatically pick head_seq_and
232  *	and ssn.
233  * @removed: this session is removed (but might have been found due to RCU)
234  * @started: this session has started (head ssn or higher was received)
235  *
236  * This structure's lifetime is managed by RCU, assignments to
237  * the array holding it must hold the aggregation mutex.
238  *
239  * The @reorder_lock is used to protect the members of this
240  * struct, except for @timeout, @buf_size and @dialog_token,
241  * which are constant across the lifetime of the struct (the
242  * dialog token being used only for debugging).
243  */
244 struct tid_ampdu_rx {
245 	struct rcu_head rcu_head;
246 	spinlock_t reorder_lock;
247 	u64 reorder_buf_filtered;
248 	struct sk_buff_head *reorder_buf;
249 	unsigned long *reorder_time;
250 	struct sta_info *sta;
251 	struct timer_list session_timer;
252 	struct timer_list reorder_timer;
253 	unsigned long last_rx;
254 	u16 head_seq_num;
255 	u16 stored_mpdu_num;
256 	u16 ssn;
257 	u16 buf_size;
258 	u16 timeout;
259 	u8 tid;
260 	u8 auto_seq:1,
261 	   removed:1,
262 	   started:1;
263 };
264 
265 /**
266  * struct sta_ampdu_mlme - STA aggregation information.
267  *
268  * @mtx: mutex to protect all TX data (except non-NULL assignments
269  *	to tid_tx[idx], which are protected by the sta spinlock)
270  *	tid_start_tx is also protected by sta->lock.
271  * @tid_rx: aggregation info for Rx per TID -- RCU protected
272  * @tid_rx_token: dialog tokens for valid aggregation sessions
273  * @tid_rx_timer_expired: bitmap indicating on which TIDs the
274  *	RX timer expired until the work for it runs
275  * @tid_rx_stop_requested:  bitmap indicating which BA sessions per TID the
276  *	driver requested to close until the work for it runs
277  * @tid_rx_manage_offl: bitmap indicating which BA sessions were requested
278  *	to be treated as started/stopped due to offloading
279  * @agg_session_valid: bitmap indicating which TID has a rx BA session open on
280  * @unexpected_agg: bitmap indicating which TID already sent a delBA due to
281  *	unexpected aggregation related frames outside a session
282  * @work: work struct for starting/stopping aggregation
283  * @tid_tx: aggregation info for Tx per TID
284  * @tid_start_tx: sessions where start was requested
285  * @last_addba_req_time: timestamp of the last addBA request.
286  * @addba_req_num: number of times addBA request has been sent.
287  * @dialog_token_allocator: dialog token enumerator for each new session;
288  */
289 struct sta_ampdu_mlme {
290 	struct mutex mtx;
291 	/* rx */
292 	struct tid_ampdu_rx __rcu *tid_rx[IEEE80211_NUM_TIDS];
293 	u8 tid_rx_token[IEEE80211_NUM_TIDS];
294 	unsigned long tid_rx_timer_expired[BITS_TO_LONGS(IEEE80211_NUM_TIDS)];
295 	unsigned long tid_rx_stop_requested[BITS_TO_LONGS(IEEE80211_NUM_TIDS)];
296 	unsigned long tid_rx_manage_offl[BITS_TO_LONGS(2 * IEEE80211_NUM_TIDS)];
297 	unsigned long agg_session_valid[BITS_TO_LONGS(IEEE80211_NUM_TIDS)];
298 	unsigned long unexpected_agg[BITS_TO_LONGS(IEEE80211_NUM_TIDS)];
299 	/* tx */
300 	struct work_struct work;
301 	struct tid_ampdu_tx __rcu *tid_tx[IEEE80211_NUM_TIDS];
302 	struct tid_ampdu_tx *tid_start_tx[IEEE80211_NUM_TIDS];
303 	unsigned long last_addba_req_time[IEEE80211_NUM_TIDS];
304 	u8 addba_req_num[IEEE80211_NUM_TIDS];
305 	u8 dialog_token_allocator;
306 };
307 
308 
309 /* Value to indicate no TID reservation */
310 #define IEEE80211_TID_UNRESERVED	0xff
311 
312 #define IEEE80211_FAST_XMIT_MAX_IV	18
313 
314 /**
315  * struct ieee80211_fast_tx - TX fastpath information
316  * @key: key to use for hw crypto
317  * @hdr: the 802.11 header to put with the frame
318  * @hdr_len: actual 802.11 header length
319  * @sa_offs: offset of the SA
320  * @da_offs: offset of the DA
321  * @pn_offs: offset where to put PN for crypto (or 0 if not needed)
322  * @band: band this will be transmitted on, for tx_info
323  * @rcu_head: RCU head to free this struct
324  *
325  * This struct is small enough so that the common case (maximum crypto
326  * header length of 8 like for CCMP/GCMP) fits into a single 64-byte
327  * cache line.
328  */
329 struct ieee80211_fast_tx {
330 	struct ieee80211_key *key;
331 	u8 hdr_len;
332 	u8 sa_offs, da_offs, pn_offs;
333 	u8 band;
334 	u8 hdr[30 + 2 + IEEE80211_FAST_XMIT_MAX_IV +
335 	       sizeof(rfc1042_header)] __aligned(2);
336 
337 	struct rcu_head rcu_head;
338 };
339 
340 /**
341  * struct ieee80211_fast_rx - RX fastpath information
342  * @dev: netdevice for reporting the SKB
343  * @vif_type: (P2P-less) interface type of the original sdata (sdata->vif.type)
344  * @vif_addr: interface address
345  * @rfc1042_hdr: copy of the RFC 1042 SNAP header (to have in cache)
346  * @control_port_protocol: control port protocol copied from sdata
347  * @expected_ds_bits: from/to DS bits expected
348  * @icv_len: length of the MIC if present
349  * @key: bool indicating encryption is expected (key is set)
350  * @internal_forward: forward froms internally on AP/VLAN type interfaces
351  * @uses_rss: copy of USES_RSS hw flag
352  * @da_offs: offset of the DA in the header (for header conversion)
353  * @sa_offs: offset of the SA in the header (for header conversion)
354  * @rcu_head: RCU head for freeing this structure
355  */
356 struct ieee80211_fast_rx {
357 	struct net_device *dev;
358 	enum nl80211_iftype vif_type;
359 	u8 vif_addr[ETH_ALEN] __aligned(2);
360 	u8 rfc1042_hdr[6] __aligned(2);
361 	__be16 control_port_protocol;
362 	__le16 expected_ds_bits;
363 	u8 icv_len;
364 	u8 key:1,
365 	   internal_forward:1,
366 	   uses_rss:1;
367 	u8 da_offs, sa_offs;
368 
369 	struct rcu_head rcu_head;
370 };
371 
372 /* we use only values in the range 0-100, so pick a large precision */
373 DECLARE_EWMA(mesh_fail_avg, 20, 8)
374 DECLARE_EWMA(mesh_tx_rate_avg, 8, 16)
375 
376 /**
377  * struct mesh_sta - mesh STA information
378  * @plink_lock: serialize access to plink fields
379  * @llid: Local link ID
380  * @plid: Peer link ID
381  * @aid: local aid supplied by peer
382  * @reason: Cancel reason on PLINK_HOLDING state
383  * @plink_retries: Retries in establishment
384  * @plink_state: peer link state
385  * @plink_timeout: timeout of peer link
386  * @plink_timer: peer link watch timer
387  * @plink_sta: peer link watch timer's sta_info
388  * @t_offset: timing offset relative to this host
389  * @t_offset_setpoint: reference timing offset of this sta to be used when
390  * 	calculating clockdrift
391  * @local_pm: local link-specific power save mode
392  * @peer_pm: peer-specific power save mode towards local STA
393  * @nonpeer_pm: STA power save mode towards non-peer neighbors
394  * @processed_beacon: set to true after peer rates and capabilities are
395  *	processed
396  * @connected_to_gate: true if mesh STA has a path to a mesh gate
397  * @connected_to_as: true if mesh STA has a path to a authentication server
398  * @fail_avg: moving percentage of failed MSDUs
399  * @tx_rate_avg: moving average of tx bitrate
400  */
401 struct mesh_sta {
402 	struct timer_list plink_timer;
403 	struct sta_info *plink_sta;
404 
405 	s64 t_offset;
406 	s64 t_offset_setpoint;
407 
408 	spinlock_t plink_lock;
409 	u16 llid;
410 	u16 plid;
411 	u16 aid;
412 	u16 reason;
413 	u8 plink_retries;
414 
415 	bool processed_beacon;
416 	bool connected_to_gate;
417 	bool connected_to_as;
418 
419 	enum nl80211_plink_state plink_state;
420 	u32 plink_timeout;
421 
422 	/* mesh power save */
423 	enum nl80211_mesh_power_mode local_pm;
424 	enum nl80211_mesh_power_mode peer_pm;
425 	enum nl80211_mesh_power_mode nonpeer_pm;
426 
427 	/* moving percentage of failed MSDUs */
428 	struct ewma_mesh_fail_avg fail_avg;
429 	/* moving average of tx bitrate */
430 	struct ewma_mesh_tx_rate_avg tx_rate_avg;
431 };
432 
433 DECLARE_EWMA(signal, 10, 8)
434 
435 struct ieee80211_sta_rx_stats {
436 	unsigned long packets;
437 	unsigned long last_rx;
438 	unsigned long num_duplicates;
439 	unsigned long fragments;
440 	unsigned long dropped;
441 	int last_signal;
442 	u8 chains;
443 	s8 chain_signal_last[IEEE80211_MAX_CHAINS];
444 	u32 last_rate;
445 	struct u64_stats_sync syncp;
446 	u64 bytes;
447 	u64 msdu[IEEE80211_NUM_TIDS + 1];
448 };
449 
450 /*
451  * IEEE 802.11-2016 (10.6 "Defragmentation") recommends support for "concurrent
452  * reception of at least one MSDU per access category per associated STA"
453  * on APs, or "at least one MSDU per access category" on other interface types.
454  *
455  * This limit can be increased by changing this define, at the cost of slower
456  * frame reassembly and increased memory use while fragments are pending.
457  */
458 #define IEEE80211_FRAGMENT_MAX 4
459 
460 struct ieee80211_fragment_entry {
461 	struct sk_buff_head skb_list;
462 	unsigned long first_frag_time;
463 	u16 seq;
464 	u16 extra_len;
465 	u16 last_frag;
466 	u8 rx_queue;
467 	u8 check_sequential_pn:1, /* needed for CCMP/GCMP */
468 	   is_protected:1;
469 	u8 last_pn[6]; /* PN of the last fragment if CCMP was used */
470 	unsigned int key_color;
471 };
472 
473 struct ieee80211_fragment_cache {
474 	struct ieee80211_fragment_entry	entries[IEEE80211_FRAGMENT_MAX];
475 	unsigned int next;
476 };
477 
478 /*
479  * The bandwidth threshold below which the per-station CoDel parameters will be
480  * scaled to be more lenient (to prevent starvation of slow stations). This
481  * value will be scaled by the number of active stations when it is being
482  * applied.
483  */
484 #define STA_SLOW_THRESHOLD 6000 /* 6 Mbps */
485 
486 /**
487  * struct link_sta_info - Link STA information
488  * All link specific sta info are stored here for reference. This can be
489  * a single entry for non-MLD STA or multiple entries for MLD STA
490  * @addr: Link MAC address - Can be same as MLD STA mac address and is always
491  *	same for non-MLD STA. This is used as key for searching link STA
492  * @link_id: Link ID uniquely identifying the link STA. This is 0 for non-MLD
493  *	and set to the corresponding vif LinkId for MLD STA
494  * @sta: Points to the STA info
495  * @gtk: group keys negotiated with this station, if any
496  * @tx_stats: TX statistics
497  * @tx_stats.packets: # of packets transmitted
498  * @tx_stats.bytes: # of bytes in all packets transmitted
499  * @tx_stats.last_rate: last TX rate
500  * @tx_stats.msdu: # of transmitted MSDUs per TID
501  * @rx_stats: RX statistics
502  * @rx_stats_avg: averaged RX statistics
503  * @rx_stats_avg.signal: averaged signal
504  * @rx_stats_avg.chain_signal: averaged per-chain signal
505  * @pcpu_rx_stats: per-CPU RX statistics, assigned only if the driver needs
506  *	this (by advertising the USES_RSS hw flag)
507  * @status_stats: TX status statistics
508  * @status_stats.filtered: # of filtered frames
509  * @status_stats.retry_failed: # of frames that failed after retry
510  * @status_stats.retry_count: # of retries attempted
511  * @status_stats.lost_packets: # of lost packets
512  * @status_stats.last_pkt_time: timestamp of last ACKed packet
513  * @status_stats.msdu_retries: # of MSDU retries
514  * @status_stats.msdu_failed: # of failed MSDUs
515  * @status_stats.last_ack: last ack timestamp (jiffies)
516  * @status_stats.last_ack_signal: last ACK signal
517  * @status_stats.ack_signal_filled: last ACK signal validity
518  * @status_stats.avg_ack_signal: average ACK signal
519  * TODO Move other link params from sta_info as required for MLD operation
520  */
521 struct link_sta_info {
522 	u8 addr[ETH_ALEN];
523 	u8 link_id;
524 
525 	/* TODO rhash head/node for finding link_sta based on addr */
526 
527 	struct sta_info *sta;
528 	struct ieee80211_key __rcu *gtk[NUM_DEFAULT_KEYS +
529 					NUM_DEFAULT_MGMT_KEYS +
530 					NUM_DEFAULT_BEACON_KEYS];
531 	struct ieee80211_sta_rx_stats __percpu *pcpu_rx_stats;
532 
533 	/* Updated from RX path only, no locking requirements */
534 	struct ieee80211_sta_rx_stats rx_stats;
535 	struct {
536 		struct ewma_signal signal;
537 		struct ewma_signal chain_signal[IEEE80211_MAX_CHAINS];
538 	} rx_stats_avg;
539 
540 	/* Updated from TX status path only, no locking requirements */
541 	struct {
542 		unsigned long filtered;
543 		unsigned long retry_failed, retry_count;
544 		unsigned int lost_packets;
545 		unsigned long last_pkt_time;
546 		u64 msdu_retries[IEEE80211_NUM_TIDS + 1];
547 		u64 msdu_failed[IEEE80211_NUM_TIDS + 1];
548 		unsigned long last_ack;
549 		s8 last_ack_signal;
550 		bool ack_signal_filled;
551 		struct ewma_avg_signal avg_ack_signal;
552 	} status_stats;
553 
554 	/* Updated from TX path only, no locking requirements */
555 	struct {
556 		u64 packets[IEEE80211_NUM_ACS];
557 		u64 bytes[IEEE80211_NUM_ACS];
558 		struct ieee80211_tx_rate last_rate;
559 		struct rate_info last_rate_info;
560 		u64 msdu[IEEE80211_NUM_TIDS + 1];
561 	} tx_stats;
562 
563 	enum ieee80211_sta_rx_bandwidth cur_max_bandwidth;
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  * @ampdu_mlme: A-MPDU state machine state
607  * @mesh: mesh STA information
608  * @debugfs_dir: debug filesystem directory dentry
609  * @dead: set to true when sta is unlinked
610  * @removed: set to true when sta is being removed from sta_list
611  * @uploaded: set to true when sta is uploaded to the driver
612  * @sta: station information we share with the driver
613  * @sta_state: duplicates information about station state (for debug)
614  * @rcu_head: RCU head used for freeing this station struct
615  * @cur_max_bandwidth: maximum bandwidth to use for TX to the station,
616  *	taken from HT/VHT capabilities or VHT operating mode notification
617  * @known_smps_mode: the smps_mode the client thinks we are in. Relevant for
618  *	AP only.
619  * @cipher_scheme: optional cipher scheme for this station
620  * @cparams: CoDel parameters for this station.
621  * @reserved_tid: reserved TID (if any, otherwise IEEE80211_TID_UNRESERVED)
622  * @fast_tx: TX fastpath information
623  * @fast_rx: RX fastpath information
624  * @tdls_chandef: a TDLS peer can have a wider chandef that is compatible to
625  *	the BSS one.
626  * @frags: fragment cache
627  * @multi_link_sta: Identifies if this sta is a MLD STA or regular STA
628  * @deflink: This is the default link STA information, for non MLO STA all link
629  *	specific STA information is accessed through @deflink or through
630  *	link[0] which points to address of @deflink. For MLO Link STA
631  *	the first added link STA will point to deflink.
632  * @link: reference to Link Sta entries. For Non MLO STA, except 1st link,
633  *	i.e link[0] all links would be assigned to NULL by default and
634  *	would access link information via @deflink or link[0]. For MLO
635  *	STA, first link STA being added will point its link pointer to
636  *	@deflink address and remaining would be allocated and the address
637  *	would be assigned to link[link_id] where link_id is the id assigned
638  *	by the AP.
639  */
640 struct sta_info {
641 	/* General information, mostly static */
642 	struct list_head list, free_list;
643 	struct rcu_head rcu_head;
644 	struct rhlist_head hash_node;
645 	u8 addr[ETH_ALEN];
646 	struct ieee80211_local *local;
647 	struct ieee80211_sub_if_data *sdata;
648 	struct ieee80211_key __rcu *ptk[NUM_DEFAULT_KEYS];
649 	u8 ptk_idx;
650 	struct rate_control_ref *rate_ctrl;
651 	void *rate_ctrl_priv;
652 	spinlock_t rate_ctrl_lock;
653 	spinlock_t lock;
654 
655 	struct ieee80211_fast_tx __rcu *fast_tx;
656 	struct ieee80211_fast_rx __rcu *fast_rx;
657 
658 #ifdef CONFIG_MAC80211_MESH
659 	struct mesh_sta *mesh;
660 #endif
661 
662 	struct work_struct drv_deliver_wk;
663 
664 	u16 listen_interval;
665 
666 	bool dead;
667 	bool removed;
668 
669 	bool uploaded;
670 
671 	enum ieee80211_sta_state sta_state;
672 
673 	/* use the accessors defined below */
674 	unsigned long _flags;
675 
676 	/* STA powersave lock and frame queues */
677 	spinlock_t ps_lock;
678 	struct sk_buff_head ps_tx_buf[IEEE80211_NUM_ACS];
679 	struct sk_buff_head tx_filtered[IEEE80211_NUM_ACS];
680 	unsigned long driver_buffered_tids;
681 	unsigned long txq_buffered_tids;
682 
683 	u64 assoc_at;
684 	long last_connected;
685 
686 	/* Plus 1 for non-QoS frames */
687 	__le16 last_seq_ctrl[IEEE80211_NUM_TIDS + 1];
688 
689 	u16 tid_seq[IEEE80211_QOS_CTL_TID_MASK + 1];
690 
691 	struct airtime_info airtime[IEEE80211_NUM_ACS];
692 
693 	/*
694 	 * Aggregation information, locked with lock.
695 	 */
696 	struct sta_ampdu_mlme ampdu_mlme;
697 
698 #ifdef CONFIG_MAC80211_DEBUGFS
699 	struct dentry *debugfs_dir;
700 #endif
701 
702 	enum ieee80211_smps_mode known_smps_mode;
703 	const struct ieee80211_cipher_scheme *cipher_scheme;
704 
705 	struct codel_params cparams;
706 
707 	u8 reserved_tid;
708 
709 	struct cfg80211_chan_def tdls_chandef;
710 
711 	struct ieee80211_fragment_cache frags;
712 
713 	bool multi_link_sta;
714 	struct link_sta_info deflink;
715 	struct link_sta_info *link[MAX_STA_LINKS];
716 
717 	/* keep last! */
718 	struct ieee80211_sta sta;
719 };
720 
sta_plink_state(struct sta_info * sta)721 static inline enum nl80211_plink_state sta_plink_state(struct sta_info *sta)
722 {
723 #ifdef CONFIG_MAC80211_MESH
724 	return sta->mesh->plink_state;
725 #endif
726 	return NL80211_PLINK_LISTEN;
727 }
728 
set_sta_flag(struct sta_info * sta,enum ieee80211_sta_info_flags flag)729 static inline void set_sta_flag(struct sta_info *sta,
730 				enum ieee80211_sta_info_flags flag)
731 {
732 	WARN_ON(flag == WLAN_STA_AUTH ||
733 		flag == WLAN_STA_ASSOC ||
734 		flag == WLAN_STA_AUTHORIZED);
735 	set_bit(flag, &sta->_flags);
736 }
737 
clear_sta_flag(struct sta_info * sta,enum ieee80211_sta_info_flags flag)738 static inline void clear_sta_flag(struct sta_info *sta,
739 				  enum ieee80211_sta_info_flags flag)
740 {
741 	WARN_ON(flag == WLAN_STA_AUTH ||
742 		flag == WLAN_STA_ASSOC ||
743 		flag == WLAN_STA_AUTHORIZED);
744 	clear_bit(flag, &sta->_flags);
745 }
746 
test_sta_flag(struct sta_info * sta,enum ieee80211_sta_info_flags flag)747 static inline int test_sta_flag(struct sta_info *sta,
748 				enum ieee80211_sta_info_flags flag)
749 {
750 	return test_bit(flag, &sta->_flags);
751 }
752 
test_and_clear_sta_flag(struct sta_info * sta,enum ieee80211_sta_info_flags flag)753 static inline int test_and_clear_sta_flag(struct sta_info *sta,
754 					  enum ieee80211_sta_info_flags flag)
755 {
756 	WARN_ON(flag == WLAN_STA_AUTH ||
757 		flag == WLAN_STA_ASSOC ||
758 		flag == WLAN_STA_AUTHORIZED);
759 	return test_and_clear_bit(flag, &sta->_flags);
760 }
761 
test_and_set_sta_flag(struct sta_info * sta,enum ieee80211_sta_info_flags flag)762 static inline int test_and_set_sta_flag(struct sta_info *sta,
763 					enum ieee80211_sta_info_flags flag)
764 {
765 	WARN_ON(flag == WLAN_STA_AUTH ||
766 		flag == WLAN_STA_ASSOC ||
767 		flag == WLAN_STA_AUTHORIZED);
768 	return test_and_set_bit(flag, &sta->_flags);
769 }
770 
771 int sta_info_move_state(struct sta_info *sta,
772 			enum ieee80211_sta_state new_state);
773 
sta_info_pre_move_state(struct sta_info * sta,enum ieee80211_sta_state new_state)774 static inline void sta_info_pre_move_state(struct sta_info *sta,
775 					   enum ieee80211_sta_state new_state)
776 {
777 	int ret;
778 
779 	WARN_ON_ONCE(test_sta_flag(sta, WLAN_STA_INSERTED));
780 
781 	ret = sta_info_move_state(sta, new_state);
782 	WARN_ON_ONCE(ret);
783 }
784 
785 
786 void ieee80211_assign_tid_tx(struct sta_info *sta, int tid,
787 			     struct tid_ampdu_tx *tid_tx);
788 
789 static inline struct tid_ampdu_tx *
rcu_dereference_protected_tid_tx(struct sta_info * sta,int tid)790 rcu_dereference_protected_tid_tx(struct sta_info *sta, int tid)
791 {
792 	return rcu_dereference_protected(sta->ampdu_mlme.tid_tx[tid],
793 					 lockdep_is_held(&sta->lock) ||
794 					 lockdep_is_held(&sta->ampdu_mlme.mtx));
795 }
796 
797 /* Maximum number of frames to buffer per power saving station per AC */
798 #define STA_MAX_TX_BUFFER	64
799 
800 /* Minimum buffered frame expiry time. If STA uses listen interval that is
801  * smaller than this value, the minimum value here is used instead. */
802 #define STA_TX_BUFFER_EXPIRE (10 * HZ)
803 
804 /* How often station data is cleaned up (e.g., expiration of buffered frames)
805  */
806 #define STA_INFO_CLEANUP_INTERVAL (10 * HZ)
807 
808 struct rhlist_head *sta_info_hash_lookup(struct ieee80211_local *local,
809 					 const u8 *addr);
810 
811 /*
812  * Get a STA info, must be under RCU read lock.
813  */
814 struct sta_info *sta_info_get(struct ieee80211_sub_if_data *sdata,
815 			      const u8 *addr);
816 
817 struct sta_info *sta_info_get_bss(struct ieee80211_sub_if_data *sdata,
818 				  const u8 *addr);
819 
820 /* user must hold sta_mtx or be in RCU critical section */
821 struct sta_info *sta_info_get_by_addrs(struct ieee80211_local *local,
822 				       const u8 *sta_addr, const u8 *vif_addr);
823 
824 #define for_each_sta_info(local, _addr, _sta, _tmp)			\
825 	rhl_for_each_entry_rcu(_sta, _tmp,				\
826 			       sta_info_hash_lookup(local, _addr), hash_node)
827 
828 /*
829  * Get STA info by index, BROKEN!
830  */
831 struct sta_info *sta_info_get_by_idx(struct ieee80211_sub_if_data *sdata,
832 				     int idx);
833 /*
834  * Create a new STA info, caller owns returned structure
835  * until sta_info_insert().
836  */
837 struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
838 				const u8 *addr, gfp_t gfp);
839 
840 void sta_info_free(struct ieee80211_local *local, struct sta_info *sta);
841 
842 /*
843  * Insert STA info into hash table/list, returns zero or a
844  * -EEXIST if (if the same MAC address is already present).
845  *
846  * Calling the non-rcu version makes the caller relinquish,
847  * the _rcu version calls read_lock_rcu() and must be called
848  * without it held.
849  */
850 int sta_info_insert(struct sta_info *sta);
851 int sta_info_insert_rcu(struct sta_info *sta) __acquires(RCU);
852 
853 int __must_check __sta_info_destroy(struct sta_info *sta);
854 int sta_info_destroy_addr(struct ieee80211_sub_if_data *sdata,
855 			  const u8 *addr);
856 int sta_info_destroy_addr_bss(struct ieee80211_sub_if_data *sdata,
857 			      const u8 *addr);
858 
859 void sta_info_recalc_tim(struct sta_info *sta);
860 
861 int sta_info_init(struct ieee80211_local *local);
862 void sta_info_stop(struct ieee80211_local *local);
863 
864 /**
865  * __sta_info_flush - flush matching STA entries from the STA table
866  *
867  * Returns the number of removed STA entries.
868  *
869  * @sdata: sdata to remove all stations from
870  * @vlans: if the given interface is an AP interface, also flush VLANs
871  */
872 int __sta_info_flush(struct ieee80211_sub_if_data *sdata, bool vlans);
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  */
sta_info_flush(struct ieee80211_sub_if_data * sdata)881 static inline int sta_info_flush(struct ieee80211_sub_if_data *sdata)
882 {
883 	return __sta_info_flush(sdata, false);
884 }
885 
886 void sta_set_rate_info_tx(struct sta_info *sta,
887 			  const struct ieee80211_tx_rate *rate,
888 			  struct rate_info *rinfo);
889 void sta_set_sinfo(struct sta_info *sta, struct station_info *sinfo,
890 		   bool tidstats);
891 
892 u32 sta_get_expected_throughput(struct sta_info *sta);
893 
894 void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata,
895 			  unsigned long exp_time);
896 u8 sta_info_tx_streams(struct sta_info *sta);
897 
898 void ieee80211_sta_ps_deliver_wakeup(struct sta_info *sta);
899 void ieee80211_sta_ps_deliver_poll_response(struct sta_info *sta);
900 void ieee80211_sta_ps_deliver_uapsd(struct sta_info *sta);
901 
902 unsigned long ieee80211_sta_last_active(struct sta_info *sta);
903 
904 enum sta_stats_type {
905 	STA_STATS_RATE_TYPE_INVALID = 0,
906 	STA_STATS_RATE_TYPE_LEGACY,
907 	STA_STATS_RATE_TYPE_HT,
908 	STA_STATS_RATE_TYPE_VHT,
909 	STA_STATS_RATE_TYPE_HE,
910 	STA_STATS_RATE_TYPE_S1G,
911 };
912 
913 #define STA_STATS_FIELD_HT_MCS		GENMASK( 7,  0)
914 #define STA_STATS_FIELD_LEGACY_IDX	GENMASK( 3,  0)
915 #define STA_STATS_FIELD_LEGACY_BAND	GENMASK( 7,  4)
916 #define STA_STATS_FIELD_VHT_MCS		GENMASK( 3,  0)
917 #define STA_STATS_FIELD_VHT_NSS		GENMASK( 7,  4)
918 #define STA_STATS_FIELD_HE_MCS		GENMASK( 3,  0)
919 #define STA_STATS_FIELD_HE_NSS		GENMASK( 7,  4)
920 #define STA_STATS_FIELD_BW		GENMASK(11,  8)
921 #define STA_STATS_FIELD_SGI		GENMASK(12, 12)
922 #define STA_STATS_FIELD_TYPE		GENMASK(15, 13)
923 #define STA_STATS_FIELD_HE_RU		GENMASK(18, 16)
924 #define STA_STATS_FIELD_HE_GI		GENMASK(20, 19)
925 #define STA_STATS_FIELD_HE_DCM		GENMASK(21, 21)
926 
927 #define STA_STATS_FIELD(_n, _v)		FIELD_PREP(STA_STATS_FIELD_ ## _n, _v)
928 #define STA_STATS_GET(_n, _v)		FIELD_GET(STA_STATS_FIELD_ ## _n, _v)
929 
930 #define STA_STATS_RATE_INVALID		0
931 
sta_stats_encode_rate(struct ieee80211_rx_status * s)932 static inline u32 sta_stats_encode_rate(struct ieee80211_rx_status *s)
933 {
934 	u32 r;
935 
936 	r = STA_STATS_FIELD(BW, s->bw);
937 
938 	if (s->enc_flags & RX_ENC_FLAG_SHORT_GI)
939 		r |= STA_STATS_FIELD(SGI, 1);
940 
941 	switch (s->encoding) {
942 	case RX_ENC_VHT:
943 		r |= STA_STATS_FIELD(TYPE, STA_STATS_RATE_TYPE_VHT);
944 		r |= STA_STATS_FIELD(VHT_NSS, s->nss);
945 		r |= STA_STATS_FIELD(VHT_MCS, s->rate_idx);
946 		break;
947 	case RX_ENC_HT:
948 		r |= STA_STATS_FIELD(TYPE, STA_STATS_RATE_TYPE_HT);
949 		r |= STA_STATS_FIELD(HT_MCS, s->rate_idx);
950 		break;
951 	case RX_ENC_LEGACY:
952 		r |= STA_STATS_FIELD(TYPE, STA_STATS_RATE_TYPE_LEGACY);
953 		r |= STA_STATS_FIELD(LEGACY_BAND, s->band);
954 		r |= STA_STATS_FIELD(LEGACY_IDX, s->rate_idx);
955 		break;
956 	case RX_ENC_HE:
957 		r |= STA_STATS_FIELD(TYPE, STA_STATS_RATE_TYPE_HE);
958 		r |= STA_STATS_FIELD(HE_NSS, s->nss);
959 		r |= STA_STATS_FIELD(HE_MCS, s->rate_idx);
960 		r |= STA_STATS_FIELD(HE_GI, s->he_gi);
961 		r |= STA_STATS_FIELD(HE_RU, s->he_ru);
962 		r |= STA_STATS_FIELD(HE_DCM, s->he_dcm);
963 		break;
964 	default:
965 		WARN_ON(1);
966 		return STA_STATS_RATE_INVALID;
967 	}
968 
969 	return r;
970 }
971 
972 #endif /* STA_INFO_H */
973