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