xref: /linux/net/mac80211/sta_info.h (revision 91ec2035134982b98fab0609a9fd8480e8217dc1)
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-2026 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 	unsigned long 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 					  bool mcast);
152 
153 struct sta_info;
154 
155 /**
156  * struct tid_ampdu_tx - TID aggregation information (Tx).
157  *
158  * @rcu_head: rcu head for freeing structure
159  * @session_timer: check if we keep Tx-ing on the TID (by timeout value)
160  * @addba_resp_timer: timer for peer's response to addba request
161  * @pending: pending frames queue -- use sta's spinlock to protect
162  * @sta: station we are attached to
163  * @dialog_token: dialog token for aggregation session
164  * @timeout: session timeout value to be filled in ADDBA requests
165  * @tid: TID number
166  * @state: session state (see above)
167  * @last_tx: jiffies of last tx activity
168  * @stop_initiator: initiator of a session stop
169  * @tx_stop: TX DelBA frame when stopping
170  * @buf_size: reorder buffer size at receiver
171  * @failed_bar_ssn: ssn of the last failed BAR tx attempt
172  * @bar_pending: BAR needs to be re-sent
173  * @amsdu: support A-MSDU within A-MDPU
174  * @ssn: starting sequence number of the session
175  * @ndp: this session is using NDP Block ACKs
176  *
177  * This structure's lifetime is managed by RCU, assignments to
178  * the array holding it must hold the aggregation mutex.
179  *
180  * The TX path can access it under RCU lock-free if, and
181  * only if, the state has the flag %HT_AGG_STATE_OPERATIONAL
182  * set. Otherwise, the TX path must also acquire the spinlock
183  * and re-check the state, see comments in the tx code
184  * touching it.
185  */
186 struct tid_ampdu_tx {
187 	struct rcu_head rcu_head;
188 	struct timer_list session_timer;
189 	struct timer_list addba_resp_timer;
190 	struct sk_buff_head pending;
191 	struct sta_info *sta;
192 	unsigned long state;
193 	unsigned long last_tx;
194 	u16 timeout;
195 	u8 dialog_token;
196 	u8 stop_initiator;
197 	bool tx_stop;
198 	u16 buf_size;
199 	u16 ssn;
200 
201 	u16 failed_bar_ssn;
202 	bool bar_pending;
203 	bool amsdu;
204 	bool ndp;
205 	u8 tid;
206 };
207 
208 /**
209  * struct tid_ampdu_rx - TID aggregation information (Rx).
210  *
211  * @reorder_buf_filtered: bitmap indicating where there are filtered frames in
212  *	the reorder buffer that should be ignored when releasing frames
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  * @reorder: reorder buffer entries
230  * @reorder.buf: &struct sk_buff_head for the frames, since there could be
231  *	multiple at each entry from an A-MSDU reported as individual subframes
232  * @reorder.time: time when this entry was filled (jiffies)
233  *
234  * This structure's lifetime is managed by RCU, assignments to
235  * the array holding it must hold the aggregation mutex.
236  *
237  * The @reorder_lock is used to protect the members of this
238  * struct, except for @timeout, @buf_size and @dialog_token,
239  * which are constant across the lifetime of the struct (the
240  * dialog token being used only for debugging).
241  */
242 struct tid_ampdu_rx {
243 	struct rcu_head rcu_head;
244 	spinlock_t reorder_lock;
245 	u64 reorder_buf_filtered;
246 	struct sta_info *sta;
247 	struct timer_list session_timer;
248 	struct timer_list reorder_timer;
249 	unsigned long last_rx;
250 	u16 head_seq_num;
251 	u16 stored_mpdu_num;
252 	u16 ssn;
253 	u16 buf_size;
254 	u16 timeout;
255 	u8 tid;
256 	u8 auto_seq:1,
257 	   removed:1,
258 	   started:1;
259 	struct {
260 		struct sk_buff_head buf;
261 		unsigned long time;
262 	} reorder[];
263 };
264 
265 /**
266  * struct sta_ampdu_mlme - STA aggregation information.
267  *
268  * @tid_rx: aggregation info for Rx per TID -- RCU protected
269  * @tid_rx_token: dialog tokens for valid aggregation sessions
270  * @tid_rx_timer_expired: bitmap indicating on which TIDs the
271  *	RX timer expired until the work for it runs
272  * @tid_rx_stop_requested:  bitmap indicating which BA sessions per TID the
273  *	driver requested to close until the work for it runs
274  * @tid_rx_manage_offl: bitmap indicating which BA sessions were requested
275  *	to be treated as started/stopped due to offloading
276  * @agg_session_valid: bitmap indicating which TID has a rx BA session open on
277  * @unexpected_agg: bitmap indicating which TID already sent a delBA due to
278  *	unexpected aggregation related frames outside a session
279  * @work: work struct for starting/stopping aggregation
280  * @tid_tx: aggregation info for Tx per TID
281  * @tid_start_tx: sessions where start was requested, not just protected
282  *	by wiphy mutex but also sta->lock
283  * @last_addba_req_time: timestamp of the last addBA request.
284  * @addba_req_num: number of times addBA request has been sent.
285  * @dialog_token_allocator: dialog token enumerator for each new session;
286  */
287 struct sta_ampdu_mlme {
288 	/* rx */
289 	struct tid_ampdu_rx __rcu *tid_rx[IEEE80211_NUM_TIDS];
290 	u8 tid_rx_token[IEEE80211_NUM_TIDS];
291 	unsigned long tid_rx_timer_expired[BITS_TO_LONGS(IEEE80211_NUM_TIDS)];
292 	unsigned long tid_rx_stop_requested[BITS_TO_LONGS(IEEE80211_NUM_TIDS)];
293 	unsigned long tid_rx_manage_offl[BITS_TO_LONGS(2 * IEEE80211_NUM_TIDS)];
294 	unsigned long agg_session_valid[BITS_TO_LONGS(IEEE80211_NUM_TIDS)];
295 	unsigned long unexpected_agg[BITS_TO_LONGS(IEEE80211_NUM_TIDS)];
296 	/* tx */
297 	struct wiphy_work work;
298 	struct tid_ampdu_tx __rcu *tid_tx[IEEE80211_NUM_TIDS];
299 	struct tid_ampdu_tx *tid_start_tx[IEEE80211_NUM_TIDS];
300 	unsigned long last_addba_req_time[IEEE80211_NUM_TIDS];
301 	u8 addba_req_num[IEEE80211_NUM_TIDS];
302 	u8 dialog_token_allocator;
303 };
304 
305 
306 /* Value to indicate no TID reservation */
307 #define IEEE80211_TID_UNRESERVED	0xff
308 
309 #define IEEE80211_FAST_XMIT_MAX_IV	18
310 
311 /**
312  * struct ieee80211_fast_tx - TX fastpath information
313  * @key: key to use for hw crypto
314  * @hdr: the 802.11 header to put with the frame
315  * @hdr_len: actual 802.11 header length
316  * @sa_offs: offset of the SA
317  * @da_offs: offset of the DA
318  * @pn_offs: offset where to put PN for crypto (or 0 if not needed)
319  * @band: band this will be transmitted on, for tx_info
320  * @rcu_head: RCU head to free this struct
321  *
322  * This struct is small enough so that the common case (maximum crypto
323  * header length of 8 like for CCMP/GCMP) fits into a single 64-byte
324  * cache line.
325  */
326 struct ieee80211_fast_tx {
327 	struct ieee80211_key *key;
328 	u8 hdr_len;
329 	u8 sa_offs, da_offs, pn_offs;
330 	u8 band;
331 	u8 hdr[30 + 2 + IEEE80211_FAST_XMIT_MAX_IV +
332 	       sizeof(rfc1042_header)] __aligned(2);
333 
334 	struct rcu_head rcu_head;
335 };
336 
337 /**
338  * struct ieee80211_fast_rx - RX fastpath information
339  * @dev: netdevice for reporting the SKB
340  * @vif_type: (P2P-less) interface type of the original sdata (sdata->vif.type)
341  * @vif_addr: interface address
342  * @rfc1042_hdr: copy of the RFC 1042 SNAP header (to have in cache)
343  * @control_port_protocol: control port protocol copied from sdata
344  * @expected_ds_bits: from/to DS bits expected
345  * @icv_len: length of the MIC if present
346  * @key: bool indicating encryption is expected (key is set)
347  * @internal_forward: forward froms internally on AP/VLAN type interfaces
348  * @uses_rss: copy of USES_RSS hw flag
349  * @da_offs: offset of the DA in the header (for header conversion)
350  * @sa_offs: offset of the SA in the header (for header conversion)
351  * @rcu_head: RCU head for freeing this structure
352  */
353 struct ieee80211_fast_rx {
354 	struct net_device *dev;
355 	enum nl80211_iftype vif_type;
356 	u8 vif_addr[ETH_ALEN] __aligned(2);
357 	u8 rfc1042_hdr[6] __aligned(2);
358 	__be16 control_port_protocol;
359 	__le16 expected_ds_bits;
360 	u8 icv_len;
361 	u8 key:1,
362 	   internal_forward:1,
363 	   uses_rss:1;
364 	u8 da_offs, sa_offs;
365 
366 	struct rcu_head rcu_head;
367 };
368 
369 /* we use only values in the range 0-100, so pick a large precision */
370 DECLARE_EWMA(mesh_fail_avg, 20, 8)
371 DECLARE_EWMA(mesh_tx_rate_avg, 8, 16)
372 
373 /**
374  * struct mesh_sta - mesh STA information
375  * @plink_lock: serialize access to plink fields
376  * @llid: Local link ID
377  * @plid: Peer link ID
378  * @aid: local aid supplied by peer
379  * @reason: Cancel reason on PLINK_HOLDING state
380  * @plink_retries: Retries in establishment
381  * @plink_state: peer link state
382  * @plink_timeout: timeout of peer link
383  * @plink_timer: peer link watch timer
384  * @plink_sta: peer link watch timer's sta_info
385  * @t_offset: timing offset relative to this host
386  * @t_offset_setpoint: reference timing offset of this sta to be used when
387  * 	calculating clockdrift
388  * @local_pm: local link-specific power save mode
389  * @peer_pm: peer-specific power save mode towards local STA
390  * @nonpeer_pm: STA power save mode towards non-peer neighbors
391  * @processed_beacon: set to true after peer rates and capabilities are
392  *	processed
393  * @connected_to_gate: true if mesh STA has a path to a mesh gate
394  * @connected_to_as: true if mesh STA has a path to a authentication server
395  * @fail_avg: moving percentage of failed MSDUs
396  * @tx_rate_avg: moving average of tx bitrate
397  */
398 struct mesh_sta {
399 	struct timer_list plink_timer;
400 	struct sta_info *plink_sta;
401 
402 	s64 t_offset;
403 	s64 t_offset_setpoint;
404 
405 	spinlock_t plink_lock;
406 	u16 llid;
407 	u16 plid;
408 	u16 aid;
409 	u16 reason;
410 	u8 plink_retries;
411 
412 	bool processed_beacon;
413 	bool connected_to_gate;
414 	bool connected_to_as;
415 
416 	enum nl80211_plink_state plink_state;
417 	u32 plink_timeout;
418 
419 	/* mesh power save */
420 	enum nl80211_mesh_power_mode local_pm;
421 	enum nl80211_mesh_power_mode peer_pm;
422 	enum nl80211_mesh_power_mode nonpeer_pm;
423 
424 	/* moving percentage of failed MSDUs */
425 	struct ewma_mesh_fail_avg fail_avg;
426 	/* moving average of tx bitrate */
427 	struct ewma_mesh_tx_rate_avg tx_rate_avg;
428 };
429 
430 DECLARE_EWMA(signal, 10, 8)
431 
432 struct ieee80211_sta_rx_stats {
433 	unsigned long packets;
434 	unsigned long last_rx;
435 	unsigned long num_duplicates;
436 	unsigned long fragments;
437 	unsigned long dropped;
438 	int last_signal;
439 	u8 chains;
440 	s8 chain_signal_last[IEEE80211_MAX_CHAINS];
441 	u32 last_rate;
442 	struct u64_stats_sync syncp;
443 	u64_stats_t bytes;
444 	u64_stats_t msdu[IEEE80211_NUM_TIDS + 1];
445 };
446 
447 /*
448  * IEEE 802.11-2016 (10.6 "Defragmentation") recommends support for "concurrent
449  * reception of at least one MSDU per access category per associated STA"
450  * on APs, or "at least one MSDU per access category" on other interface types.
451  *
452  * This limit can be increased by changing this define, at the cost of slower
453  * frame reassembly and increased memory use while fragments are pending.
454  */
455 #define IEEE80211_FRAGMENT_MAX 4
456 
457 struct ieee80211_fragment_entry {
458 	struct sk_buff_head skb_list;
459 	unsigned long first_frag_time;
460 	u16 seq;
461 	u16 extra_len;
462 	u16 last_frag;
463 	u8 rx_queue;
464 	u8 check_sequential_pn:1, /* needed for CCMP/GCMP */
465 	   is_protected:1;
466 	u8 last_pn[6]; /* PN of the last fragment if CCMP was used */
467 	unsigned int key_color;
468 };
469 
470 struct ieee80211_fragment_cache {
471 	struct ieee80211_fragment_entry	entries[IEEE80211_FRAGMENT_MAX];
472 	unsigned int next;
473 };
474 
475 /**
476  * struct link_sta_info - Link STA information
477  * All link specific sta info are stored here for reference. This can be
478  * a single entry for non-MLD STA or multiple entries for MLD STA
479  * @addr: Link MAC address - Can be same as MLD STA mac address and is always
480  *	same for non-MLD STA. This is used as key for searching link STA
481  * @link_id: Link ID uniquely identifying the link STA. This is 0 for non-MLD
482  *	and set to the corresponding vif LinkId for MLD STA
483  * @op_mode_nss: NSS limit as set by operating mode notification, or 0
484  * @capa_nss: NSS limit as determined by local and peer capabilities
485  * @link_hash_node: hash node for rhashtable
486  * @sta: Points to the STA info
487  * @gtk: group keys negotiated with this station, if any
488  * @tx_stats: TX statistics
489  * @tx_stats.packets: # of packets transmitted
490  * @tx_stats.bytes: # of bytes in all packets transmitted
491  * @tx_stats.last_rate: last TX rate
492  * @tx_stats.msdu: # of transmitted MSDUs per TID
493  * @rx_stats: RX statistics
494  * @rx_stats_avg: averaged RX statistics
495  * @rx_stats_avg.signal: averaged signal
496  * @rx_stats_avg.chain_signal: averaged per-chain signal
497  * @pcpu_rx_stats: per-CPU RX statistics, assigned only if the driver needs
498  *	this (by advertising the USES_RSS hw flag)
499  * @status_stats: TX status statistics
500  * @status_stats.filtered: # of filtered frames
501  * @status_stats.retry_failed: # of frames that failed after retry
502  * @status_stats.retry_count: # of retries attempted
503  * @status_stats.lost_packets: # of lost packets
504  * @status_stats.last_pkt_time: timestamp of last ACKed packet
505  * @status_stats.msdu_retries: # of MSDU retries
506  * @status_stats.msdu_failed: # of failed MSDUs
507  * @status_stats.last_ack: last ack timestamp (jiffies)
508  * @status_stats.last_ack_signal: last ACK signal
509  * @status_stats.ack_signal_filled: last ACK signal validity
510  * @status_stats.avg_ack_signal: average ACK signal
511  * @op_mode_bw: dynamic bandwidth limit to transmit to the STA,
512  *	taken from HT/VHT capabilities or VHT operating mode notification.
513  *	Invalid for NAN since that is operating on multiple bands.
514  * @rx_omi_bw_rx: RX OMI bandwidth restriction to apply for RX
515  * @rx_omi_bw_tx: RX OMI bandwidth restriction to apply for TX
516  * @rx_omi_bw_staging: RX OMI bandwidth restriction to apply later
517  *	during finalize
518  * @uhr_usable_tx_width: bandwidth restriction for UHR for TX, only when
519  *	the link_sta is an AP, to restrict TX to BSS width during DBE
520  *	enablement
521  * @uhr_dbe_enabled: for STAs as clients to an AP interface indicates
522  *	DBE is enabled by the STA
523  * @debugfs_dir: debug filesystem directory dentry
524  * @pub: public (driver visible) link STA data
525  */
526 struct link_sta_info {
527 	u8 addr[ETH_ALEN];
528 	u8 link_id;
529 
530 	u8 op_mode_nss, capa_nss;
531 
532 	struct rhlist_head link_hash_node;
533 
534 	struct sta_info *sta;
535 	struct ieee80211_key __rcu *gtk[NUM_DEFAULT_KEYS +
536 					NUM_DEFAULT_MGMT_KEYS +
537 					NUM_DEFAULT_BEACON_KEYS];
538 	struct ieee80211_sta_rx_stats __percpu *pcpu_rx_stats;
539 
540 	/* Updated from RX path only, no locking requirements */
541 	struct ieee80211_sta_rx_stats rx_stats;
542 	struct {
543 		struct ewma_signal signal;
544 		struct ewma_signal chain_signal[IEEE80211_MAX_CHAINS];
545 	} rx_stats_avg;
546 
547 	/* Updated from TX status path only, no locking requirements */
548 	struct {
549 		unsigned long filtered;
550 		unsigned long retry_failed, retry_count;
551 		unsigned int lost_packets;
552 		unsigned long last_pkt_time;
553 		u64 msdu_retries[IEEE80211_NUM_TIDS + 1];
554 		u64 msdu_failed[IEEE80211_NUM_TIDS + 1];
555 		unsigned long last_ack;
556 		s8 last_ack_signal;
557 		bool ack_signal_filled;
558 		struct ewma_avg_signal avg_ack_signal;
559 	} status_stats;
560 
561 	/* Updated from TX path only, no locking requirements */
562 	struct {
563 		u64 packets[IEEE80211_NUM_ACS];
564 		u64 bytes[IEEE80211_NUM_ACS];
565 		struct ieee80211_tx_rate last_rate;
566 		struct rate_info last_rate_info;
567 		u64 msdu[IEEE80211_NUM_TIDS + 1];
568 	} tx_stats;
569 
570 	enum ieee80211_sta_rx_bandwidth op_mode_bw;
571 	enum ieee80211_sta_rx_bandwidth rx_omi_bw_rx,
572 					rx_omi_bw_tx,
573 					rx_omi_bw_staging;
574 	enum ieee80211_sta_rx_bandwidth uhr_usable_tx_width;
575 
576 	bool uhr_dbe_enabled;
577 
578 #ifdef CONFIG_MAC80211_DEBUGFS
579 	struct dentry *debugfs_dir;
580 #endif
581 
582 	struct ieee80211_link_sta *pub;
583 };
584 
585 /**
586  * struct ieee80211_sta_removed_link_stats - Removed link sta data
587  *
588  * keep required accumulated removed link data for stats
589  *
590  * @rx_packets: accumulated packets (MSDUs & MMPDUs) received from
591  *	this station for removed links
592  * @tx_packets: accumulated packets (MSDUs & MMPDUs) transmitted to
593  *	this station for removed links
594  * @rx_bytes: accumulated bytes (size of MPDUs) received from this
595  *	station for removed links
596  * @tx_bytes: accumulated bytes (size of MPDUs) transmitted to this
597  *	station for removed links
598  * @tx_retries: cumulative retry counts (MPDUs) for removed links
599  * @tx_failed: accumulated number of failed transmissions (MPDUs)
600  *	(retries exceeded, no ACK) for removed links
601  * @rx_dropped_misc: accumulated dropped packets for un-specified reason
602  *	from this station for removed links
603  * @beacon_loss_count: Number of times beacon loss event has triggered
604  *	from this station for removed links.
605  * @expected_throughput: expected throughput in kbps (including 802.11
606  *	headers) towards this station for removed links
607  * @pertid_stats: accumulated per-TID statistics for removed link of
608  *	station
609  * @pertid_stats.rx_msdu : accumulated number of received MSDUs towards
610  *	this station for removed links.
611  * @pertid_stats.tx_msdu: accumulated number of (attempted) transmitted
612  *	MSDUs towards this station for removed links
613  * @pertid_stats.tx_msdu_retries: accumulated number of retries (not
614  *	counting the first) for transmitted MSDUs towards this station
615  *	for removed links
616  * @pertid_stats.tx_msdu_failed: accumulated number of failed transmitted
617  *	MSDUs towards this station for removed links
618  */
619 struct ieee80211_sta_removed_link_stats {
620 	u32 rx_packets;
621 	u32 tx_packets;
622 	u64 rx_bytes;
623 	u64 tx_bytes;
624 	u32 tx_retries;
625 	u32 tx_failed;
626 	u32 rx_dropped_misc;
627 	u32 beacon_loss_count;
628 	u32 expected_throughput;
629 	struct {
630 		u64 rx_msdu;
631 		u64 tx_msdu;
632 		u64 tx_msdu_retries;
633 		u64 tx_msdu_failed;
634 	} pertid_stats;
635 };
636 
637 /**
638  * struct sta_info - STA information
639  *
640  * This structure collects information about a station that
641  * mac80211 is communicating with.
642  *
643  * @list: global linked list entry
644  * @free_list: list entry for keeping track of stations to free
645  * @hash_node: hash node for rhashtable
646  * @addr: station's MAC address - duplicated from public part to
647  *	let the hash table work with just a single cacheline
648  * @local: pointer to the global information
649  * @sdata: virtual interface this station belongs to
650  * @ptk: peer keys negotiated with this station, if any
651  * @ptk_idx: last installed peer key index
652  * @rate_ctrl: rate control algorithm reference
653  * @rate_ctrl_lock: spinlock used to protect rate control data
654  *	(data inside the algorithm, so serializes calls there)
655  * @rate_ctrl_priv: rate control private per-STA pointer
656  * @lock: used for locking all fields that require locking, see comments
657  *	in the header file.
658  * @drv_deliver_wk: used for delivering frames after driver PS unblocking
659  * @listen_interval: listen interval of this station, when we're acting as AP
660  * @_flags: STA flags, see &enum ieee80211_sta_info_flags, do not use directly
661  * @ps_lock: used for powersave (when mac80211 is the AP) related locking
662  * @ps_tx_buf: buffers (per AC) of frames to transmit to this station
663  *	when it leaves power saving state or polls
664  * @tx_filtered: buffers (per AC) of frames we already tried to
665  *	transmit but were filtered by hardware due to STA having
666  *	entered power saving state, these are also delivered to
667  *	the station when it leaves powersave or polls for frames
668  * @driver_buffered_tids: bitmap of TIDs the driver has data buffered on
669  * @txq_buffered_tids: bitmap of TIDs that mac80211 has txq data buffered on
670  * @assoc_at: clock boottime (in ns) of last association
671  * @last_connected: time (in seconds) when a station got connected
672  * @last_seq_ctrl: last received seq/frag number from this STA (per TID
673  *	plus one for non-QoS frames)
674  * @tid_seq: per-TID sequence numbers for sending to this STA
675  * @airtime: per-AC struct airtime_info describing airtime statistics for this
676  *	station
677  * @airtime_weight: station weight for airtime fairness calculation purposes
678  * @ampdu_mlme: A-MPDU state machine state
679  * @mesh: mesh STA information
680  * @debugfs_dir: debug filesystem directory dentry
681  * @dead: set to true when sta is unlinked
682  * @removed: set to true when sta is being removed from sta_list
683  * @uploaded: set to true when sta is uploaded to the driver
684  * @sta: station information we share with the driver
685  * @sta_state: duplicates information about station state (for debug)
686  * @rcu_head: RCU head used for freeing this station struct
687  * @reserved_tid: reserved TID (if any, otherwise IEEE80211_TID_UNRESERVED)
688  * @amsdu_mesh_control: track the mesh A-MSDU format used by the peer:
689  *
690  *	  * -1: not yet known
691  *	  * 0: non-mesh A-MSDU length field
692  *	  * 1: big-endian mesh A-MSDU length field
693  *	  * 2: little-endian mesh A-MSDU length field
694  *
695  * @fast_tx: TX fastpath information
696  * @fast_rx: RX fastpath information
697  * @tdls_chandef: a TDLS peer can have a wider chandef that is compatible to
698  *	the BSS one.
699  * @frags: fragment cache
700  * @cur: storage for aggregation data
701  *	&struct ieee80211_sta points either here or to deflink.agg.
702  * @deflink: This is the default link STA information, for non MLO STA all link
703  *	specific STA information is accessed through @deflink or through
704  *	link[0] which points to address of @deflink. For MLO Link STA
705  *	the first added link STA will point to deflink.
706  * @link: reference to Link Sta entries. For Non MLO STA, except 1st link,
707  *	i.e link[0] all links would be assigned to NULL by default and
708  *	would access link information via @deflink or link[0]. For MLO
709  *	STA, first link STA being added will point its link pointer to
710  *	@deflink address and remaining would be allocated and the address
711  *	would be assigned to link[link_id] where link_id is the id assigned
712  *	by the AP.
713  * @rem_link_stats: accumulated removed link stats
714  */
715 struct sta_info {
716 	/* General information, mostly static */
717 	struct list_head list, free_list;
718 	struct rcu_head rcu_head;
719 	struct rhlist_head hash_node;
720 	u8 addr[ETH_ALEN];
721 	struct ieee80211_local *local;
722 	struct ieee80211_sub_if_data *sdata;
723 	struct ieee80211_key __rcu *ptk[NUM_DEFAULT_KEYS];
724 	u8 ptk_idx;
725 	struct rate_control_ref *rate_ctrl;
726 	void *rate_ctrl_priv;
727 	spinlock_t rate_ctrl_lock;
728 	spinlock_t lock;
729 
730 	struct ieee80211_fast_tx __rcu *fast_tx;
731 	struct ieee80211_fast_rx __rcu *fast_rx;
732 
733 #ifdef CONFIG_MAC80211_MESH
734 	struct mesh_sta *mesh;
735 #endif
736 
737 	struct work_struct drv_deliver_wk;
738 
739 	u16 listen_interval;
740 
741 	bool dead;
742 	bool removed;
743 
744 	bool uploaded;
745 
746 	enum ieee80211_sta_state sta_state;
747 
748 	/* use the accessors defined below */
749 	unsigned long _flags;
750 
751 	/* STA powersave lock and frame queues */
752 	spinlock_t ps_lock;
753 	struct sk_buff_head ps_tx_buf[IEEE80211_NUM_ACS];
754 	struct sk_buff_head tx_filtered[IEEE80211_NUM_ACS];
755 	unsigned long driver_buffered_tids;
756 	unsigned long txq_buffered_tids;
757 
758 	u64 assoc_at;
759 	long last_connected;
760 
761 	/* Plus 1 for non-QoS frames */
762 	__le16 last_seq_ctrl[IEEE80211_NUM_TIDS + 1];
763 
764 	u16 tid_seq[IEEE80211_QOS_CTL_TID_MASK + 1];
765 
766 	struct airtime_info airtime[IEEE80211_NUM_ACS];
767 	u16 airtime_weight;
768 
769 	/*
770 	 * Aggregation information, locked with lock.
771 	 */
772 	struct sta_ampdu_mlme ampdu_mlme;
773 
774 #ifdef CONFIG_MAC80211_DEBUGFS
775 	struct dentry *debugfs_dir;
776 #endif
777 
778 	u8 reserved_tid;
779 	s8 amsdu_mesh_control;
780 
781 	struct cfg80211_chan_def tdls_chandef;
782 
783 	struct ieee80211_fragment_cache frags;
784 
785 	struct ieee80211_sta_aggregates cur;
786 	struct link_sta_info deflink;
787 	struct link_sta_info __rcu *link[IEEE80211_MLD_MAX_NUM_LINKS];
788 	struct ieee80211_sta_removed_link_stats rem_link_stats;
789 
790 	/* keep last! */
791 	struct ieee80211_sta sta;
792 };
793 
ieee80211_tdls_sta_link_id(struct sta_info * sta)794 static inline int ieee80211_tdls_sta_link_id(struct sta_info *sta)
795 {
796 	/* TDLS STA can only have a single link */
797 	return sta->sta.valid_links ? __ffs(sta->sta.valid_links) : 0;
798 }
799 
sta_plink_state(struct sta_info * sta)800 static inline enum nl80211_plink_state sta_plink_state(struct sta_info *sta)
801 {
802 #ifdef CONFIG_MAC80211_MESH
803 	return sta->mesh->plink_state;
804 #endif
805 	return NL80211_PLINK_LISTEN;
806 }
807 
set_sta_flag(struct sta_info * sta,enum ieee80211_sta_info_flags flag)808 static inline void set_sta_flag(struct sta_info *sta,
809 				enum ieee80211_sta_info_flags flag)
810 {
811 	WARN_ON(flag == WLAN_STA_AUTH ||
812 		flag == WLAN_STA_ASSOC ||
813 		flag == WLAN_STA_AUTHORIZED);
814 	set_bit(flag, &sta->_flags);
815 }
816 
clear_sta_flag(struct sta_info * sta,enum ieee80211_sta_info_flags flag)817 static inline void clear_sta_flag(struct sta_info *sta,
818 				  enum ieee80211_sta_info_flags flag)
819 {
820 	WARN_ON(flag == WLAN_STA_AUTH ||
821 		flag == WLAN_STA_ASSOC ||
822 		flag == WLAN_STA_AUTHORIZED);
823 	clear_bit(flag, &sta->_flags);
824 }
825 
test_sta_flag(struct sta_info * sta,enum ieee80211_sta_info_flags flag)826 static inline int test_sta_flag(struct sta_info *sta,
827 				enum ieee80211_sta_info_flags flag)
828 {
829 	return test_bit(flag, &sta->_flags);
830 }
831 
test_and_clear_sta_flag(struct sta_info * sta,enum ieee80211_sta_info_flags flag)832 static inline int test_and_clear_sta_flag(struct sta_info *sta,
833 					  enum ieee80211_sta_info_flags flag)
834 {
835 	WARN_ON(flag == WLAN_STA_AUTH ||
836 		flag == WLAN_STA_ASSOC ||
837 		flag == WLAN_STA_AUTHORIZED);
838 	return test_and_clear_bit(flag, &sta->_flags);
839 }
840 
test_and_set_sta_flag(struct sta_info * sta,enum ieee80211_sta_info_flags flag)841 static inline int test_and_set_sta_flag(struct sta_info *sta,
842 					enum ieee80211_sta_info_flags flag)
843 {
844 	WARN_ON(flag == WLAN_STA_AUTH ||
845 		flag == WLAN_STA_ASSOC ||
846 		flag == WLAN_STA_AUTHORIZED);
847 	return test_and_set_bit(flag, &sta->_flags);
848 }
849 
850 int sta_info_move_state(struct sta_info *sta,
851 			enum ieee80211_sta_state new_state);
852 
sta_info_pre_move_state(struct sta_info * sta,enum ieee80211_sta_state new_state)853 static inline void sta_info_pre_move_state(struct sta_info *sta,
854 					   enum ieee80211_sta_state new_state)
855 {
856 	int ret;
857 
858 	WARN_ON_ONCE(test_sta_flag(sta, WLAN_STA_INSERTED));
859 
860 	ret = sta_info_move_state(sta, new_state);
861 	WARN_ON_ONCE(ret);
862 }
863 
864 
865 void ieee80211_assign_tid_tx(struct sta_info *sta, int tid,
866 			     struct tid_ampdu_tx *tid_tx);
867 
868 #define rcu_dereference_protected_tid_tx(sta, tid)			\
869 	rcu_dereference_protected((sta)->ampdu_mlme.tid_tx[tid],	\
870 				  lockdep_is_held(&(sta)->lock) ||	\
871 				  lockdep_is_held(&(sta)->local->hw.wiphy->mtx));
872 
873 /* Maximum number of frames to buffer per power saving station per AC */
874 #define STA_MAX_TX_BUFFER	64
875 
876 /* Minimum buffered frame expiry time. If STA uses listen interval that is
877  * smaller than this value, the minimum value here is used instead. */
878 #define STA_TX_BUFFER_EXPIRE (10 * HZ)
879 
880 /* How often station data is cleaned up (e.g., expiration of buffered frames)
881  */
882 #define STA_INFO_CLEANUP_INTERVAL (10 * HZ)
883 
884 struct rhlist_head *sta_info_hash_lookup(struct ieee80211_local *local,
885 					 const u8 *addr);
886 
887 /*
888  * Get a STA info, must be under RCU read lock.
889  */
890 struct sta_info *sta_info_get(struct ieee80211_sub_if_data *sdata,
891 			      const u8 *addr);
892 
893 struct sta_info *sta_info_get_bss(struct ieee80211_sub_if_data *sdata,
894 				  const u8 *addr);
895 
896 /* user must hold wiphy mutex or be in RCU critical section */
897 struct sta_info *sta_info_get_by_addrs(struct ieee80211_local *local,
898 				       const u8 *sta_addr, const u8 *vif_addr);
899 
900 #define for_each_sta_info(local, _addr, _sta, _tmp)			\
901 	rhl_for_each_entry_rcu(_sta, _tmp,				\
902 			       sta_info_hash_lookup(local, _addr), hash_node)
903 
904 struct rhlist_head *link_sta_info_hash_lookup(struct ieee80211_local *local,
905 					      const u8 *addr);
906 
907 #define for_each_link_sta_info(local, _addr, _sta, _tmp)		\
908 	rhl_for_each_entry_rcu(_sta, _tmp,				\
909 			       link_sta_info_hash_lookup(local, _addr),	\
910 			       link_hash_node)
911 
912 struct link_sta_info *
913 link_sta_info_get_bss(struct ieee80211_sub_if_data *sdata, const u8 *addr);
914 
915 /*
916  * Get STA info by index, BROKEN!
917  */
918 struct sta_info *sta_info_get_by_idx(struct ieee80211_sub_if_data *sdata,
919 				     int idx);
920 /*
921  * Create a new STA info, caller owns returned structure
922  * until sta_info_insert().
923  */
924 struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
925 				const u8 *addr, gfp_t gfp);
926 struct sta_info *sta_info_alloc_with_link(struct ieee80211_sub_if_data *sdata,
927 					  const u8 *mld_addr,
928 					  unsigned int link_id,
929 					  const u8 *link_addr,
930 					  gfp_t gfp);
931 
932 void sta_info_free(struct ieee80211_local *local, struct sta_info *sta);
933 
934 /*
935  * Insert STA info into hash table/list, returns zero or a
936  * -EEXIST if (if the same MAC address is already present).
937  *
938  * Calling the non-rcu version makes the caller relinquish,
939  * the _rcu version calls read_lock_rcu() and must be called
940  * without it held.
941  */
942 int sta_info_insert(struct sta_info *sta);
943 int sta_info_insert_rcu(struct sta_info *sta) __acquires(RCU);
944 
945 int __must_check __sta_info_destroy(struct sta_info *sta);
946 int sta_info_destroy_addr(struct ieee80211_sub_if_data *sdata,
947 			  const u8 *addr);
948 int sta_info_destroy_addr_bss(struct ieee80211_sub_if_data *sdata,
949 			      const u8 *addr);
950 
951 void sta_info_recalc_tim(struct sta_info *sta);
952 
953 int sta_info_init(struct ieee80211_local *local);
954 void sta_info_stop(struct ieee80211_local *local);
955 
956 /**
957  * __sta_info_flush - flush matching STA entries from the STA table
958  *
959  * Return: the number of removed STA entries.
960  *
961  * @sdata: sdata to remove all stations from
962  * @vlans: if the given interface is an AP interface, also flush VLANs
963  * @link_id: if given (>=0), all those STA entries using @link_id only
964  *	     will be removed. If -1 is passed, all STA entries will be
965  *	     removed.
966  * @do_not_flush_sta: a station that shouldn't be flushed.
967  */
968 int __sta_info_flush(struct ieee80211_sub_if_data *sdata, bool vlans,
969 		     int link_id, struct sta_info *do_not_flush_sta);
970 
971 /**
972  * sta_info_flush - flush matching STA entries from the STA table
973  *
974  * Return: the number of removed STA entries.
975  *
976  * @sdata: sdata to remove all stations from
977  * @link_id: if given (>=0), all those STA entries using @link_id only
978  *	     will be removed. If -1 is passed, all STA entries will be
979  *	     removed.
980  */
sta_info_flush(struct ieee80211_sub_if_data * sdata,int link_id)981 static inline int sta_info_flush(struct ieee80211_sub_if_data *sdata,
982 				 int link_id)
983 {
984 	return __sta_info_flush(sdata, false, link_id, NULL);
985 }
986 
987 void sta_set_rate_info_tx(struct sta_info *sta,
988 			  const struct ieee80211_tx_rate *rate,
989 			  struct rate_info *rinfo);
990 void sta_set_sinfo(struct sta_info *sta, struct station_info *sinfo,
991 		   bool tidstats);
992 
993 void sta_set_accumulated_removed_links_sinfo(struct sta_info *sta,
994 					     struct station_info *sinfo);
995 
996 u32 sta_get_expected_throughput(struct sta_info *sta);
997 
998 void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata,
999 			  unsigned long exp_time);
1000 
1001 int ieee80211_sta_allocate_link(struct sta_info *sta, unsigned int link_id);
1002 void ieee80211_sta_free_link(struct sta_info *sta, unsigned int link_id);
1003 int ieee80211_sta_activate_link(struct sta_info *sta, unsigned int link_id);
1004 void ieee80211_sta_remove_link(struct sta_info *sta, unsigned int link_id);
1005 
1006 void ieee80211_sta_ps_deliver_wakeup(struct sta_info *sta);
1007 void ieee80211_sta_ps_deliver_poll_response(struct sta_info *sta);
1008 void ieee80211_sta_ps_deliver_uapsd(struct sta_info *sta);
1009 
1010 unsigned long ieee80211_sta_last_active(struct sta_info *sta, int link_id);
1011 
1012 void ieee80211_sta_init_nss_bw_capa(struct link_sta_info *link_sta,
1013 				    struct cfg80211_chan_def *chandef);
1014 void ieee80211_sta_set_max_amsdu_subframes(struct sta_info *sta,
1015 					   const u8 *ext_capab,
1016 					   unsigned int ext_capab_len);
1017 
1018 void __ieee80211_sta_recalc_aggregates(struct sta_info *sta, u16 active_links);
1019 
1020 enum ieee80211_sta_bw_direction {
1021 	IEEE80211_STA_BW_RX_FROM_STA,
1022 	IEEE80211_STA_BW_TX_TO_STA,
1023 };
1024 
1025 enum ieee80211_sta_rx_bandwidth
1026 ieee80211_sta_current_bw(struct link_sta_info *link_sta,
1027 			 struct cfg80211_chan_def *chandef,
1028 			 enum ieee80211_sta_bw_direction direction);
1029 
1030 bool ieee80211_link_sta_update_rc_bw(struct ieee80211_link_data *link,
1031 				     struct link_sta_info *link_sta);
1032 
1033 enum sta_stats_type {
1034 	STA_STATS_RATE_TYPE_INVALID = 0,
1035 	STA_STATS_RATE_TYPE_LEGACY,
1036 	STA_STATS_RATE_TYPE_HT,
1037 	STA_STATS_RATE_TYPE_VHT,
1038 	STA_STATS_RATE_TYPE_HE,
1039 	STA_STATS_RATE_TYPE_S1G,
1040 	STA_STATS_RATE_TYPE_EHT,
1041 	STA_STATS_RATE_TYPE_UHR,
1042 };
1043 
1044 /* common */
1045 #define STA_STATS_FIELD_TYPE		0x0000000F
1046 #define STA_STATS_FIELD_BW		0x000001F0
1047 #define STA_STATS_FIELD_RESERVED	0x00000E00
1048 
1049 /* STA_STATS_RATE_TYPE_LEGACY */
1050 #define STA_STATS_FIELD_LEGACY_IDX	0x0000F000
1051 #define STA_STATS_FIELD_LEGACY_BAND	0x000F0000
1052 
1053 /* STA_STATS_RATE_TYPE_HT */
1054 #define STA_STATS_FIELD_HT_MCS		0x000FF000
1055 
1056 /* STA_STATS_RATE_TYPE_VHT */
1057 #define STA_STATS_FIELD_VHT_MCS		0x0000F000
1058 #define STA_STATS_FIELD_VHT_NSS		0x000F0000
1059 
1060 /* HT, VHT & S1G */
1061 #define STA_STATS_FIELD_SGI		0x00100000
1062 
1063 /* STA_STATS_RATE_TYPE_HE */
1064 #define STA_STATS_FIELD_HE_MCS		0x0000F000
1065 #define STA_STATS_FIELD_HE_NSS		0x000F0000
1066 #define STA_STATS_FIELD_HE_RU		0x00700000
1067 #define STA_STATS_FIELD_HE_GI		0x01800000
1068 #define STA_STATS_FIELD_HE_DCM		0x02000000
1069 
1070 /* STA_STATS_RATE_TYPE_EHT */
1071 #define STA_STATS_FIELD_EHT_MCS		0x0000F000
1072 #define STA_STATS_FIELD_EHT_NSS		0x000F0000
1073 #define STA_STATS_FIELD_EHT_RU		0x00F00000
1074 #define STA_STATS_FIELD_EHT_GI		0x03000000
1075 
1076 /* STA_STATS_RATE_TYPE_UHR */
1077 #define STA_STATS_FIELD_UHR_MCS		0x0001F000
1078 #define STA_STATS_FIELD_UHR_NSS		0x001E0000
1079 #define STA_STATS_FIELD_UHR_RU		0x01E00000
1080 #define STA_STATS_FIELD_UHR_GI		0x06000000
1081 #define STA_STATS_FIELD_UHR_ELR		0x08000000
1082 #define STA_STATS_FIELD_UHR_IM		0x10000000
1083 
1084 /* STA_STATS_RATE_TYPE_S1G */
1085 #define STA_STATS_FIELD_S1G_MCS		0x0000F000
1086 #define STA_STATS_FIELD_S1G_NSS		0x000F0000
1087 
1088 #define STA_STATS_FIELD(_n, _v)		FIELD_PREP(STA_STATS_FIELD_ ## _n, _v)
1089 #define STA_STATS_GET(_n, _v)		FIELD_GET(STA_STATS_FIELD_ ## _n, _v)
1090 
1091 #define STA_STATS_RATE_INVALID		0
1092 
sta_stats_encode_rate(struct ieee80211_rx_status * s)1093 static inline u32 sta_stats_encode_rate(struct ieee80211_rx_status *s)
1094 {
1095 	u32 r;
1096 
1097 	r = STA_STATS_FIELD(BW, s->bw);
1098 
1099 	switch (s->encoding) {
1100 	case RX_ENC_HT:
1101 	case RX_ENC_VHT:
1102 	case RX_ENC_S1G:
1103 		if (s->enc_flags & RX_ENC_FLAG_SHORT_GI)
1104 			r |= STA_STATS_FIELD(SGI, 1);
1105 		break;
1106 	default:
1107 		break;
1108 	}
1109 
1110 	switch (s->encoding) {
1111 	case RX_ENC_VHT:
1112 		r |= STA_STATS_FIELD(TYPE, STA_STATS_RATE_TYPE_VHT);
1113 		r |= STA_STATS_FIELD(VHT_NSS, s->nss);
1114 		r |= STA_STATS_FIELD(VHT_MCS, s->rate_idx);
1115 		break;
1116 	case RX_ENC_HT:
1117 		r |= STA_STATS_FIELD(TYPE, STA_STATS_RATE_TYPE_HT);
1118 		r |= STA_STATS_FIELD(HT_MCS, s->rate_idx);
1119 		break;
1120 	case RX_ENC_LEGACY:
1121 		r |= STA_STATS_FIELD(TYPE, STA_STATS_RATE_TYPE_LEGACY);
1122 		r |= STA_STATS_FIELD(LEGACY_BAND, s->band);
1123 		r |= STA_STATS_FIELD(LEGACY_IDX, s->rate_idx);
1124 		break;
1125 	case RX_ENC_HE:
1126 		r |= STA_STATS_FIELD(TYPE, STA_STATS_RATE_TYPE_HE);
1127 		r |= STA_STATS_FIELD(HE_NSS, s->nss);
1128 		r |= STA_STATS_FIELD(HE_MCS, s->rate_idx);
1129 		r |= STA_STATS_FIELD(HE_GI, s->he_gi);
1130 		r |= STA_STATS_FIELD(HE_RU, s->he_ru);
1131 		r |= STA_STATS_FIELD(HE_DCM, s->he_dcm);
1132 		break;
1133 	case RX_ENC_EHT:
1134 		r |= STA_STATS_FIELD(TYPE, STA_STATS_RATE_TYPE_EHT);
1135 		r |= STA_STATS_FIELD(EHT_NSS, s->nss);
1136 		r |= STA_STATS_FIELD(EHT_MCS, s->rate_idx);
1137 		r |= STA_STATS_FIELD(EHT_GI, s->eht.gi);
1138 		r |= STA_STATS_FIELD(EHT_RU, s->eht.ru);
1139 		break;
1140 	case RX_ENC_UHR:
1141 		r |= STA_STATS_FIELD(TYPE, STA_STATS_RATE_TYPE_UHR);
1142 		r |= STA_STATS_FIELD(UHR_NSS, s->nss);
1143 		r |= STA_STATS_FIELD(UHR_MCS, s->rate_idx);
1144 		r |= STA_STATS_FIELD(UHR_GI, s->uhr.gi);
1145 		r |= STA_STATS_FIELD(UHR_RU, s->uhr.ru);
1146 		r |= STA_STATS_FIELD(UHR_ELR, s->uhr.elr);
1147 		r |= STA_STATS_FIELD(UHR_IM, s->uhr.im);
1148 		break;
1149 	case RX_ENC_S1G:
1150 		r |= STA_STATS_FIELD(TYPE, STA_STATS_RATE_TYPE_S1G);
1151 		r |= STA_STATS_FIELD(S1G_NSS, s->nss);
1152 		r |= STA_STATS_FIELD(S1G_MCS, s->rate_idx);
1153 		break;
1154 	default:
1155 		WARN_ON(1);
1156 		return STA_STATS_RATE_INVALID;
1157 	}
1158 
1159 	return r;
1160 }
1161 
1162 #endif /* STA_INFO_H */
1163