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-2023 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 152 struct sta_info; 153 154 /** 155 * struct tid_ampdu_tx - TID aggregation information (Tx). 156 * 157 * @rcu_head: rcu head for freeing structure 158 * @session_timer: check if we keep Tx-ing on the TID (by timeout value) 159 * @addba_resp_timer: timer for peer's response to addba request 160 * @pending: pending frames queue -- use sta's spinlock to protect 161 * @sta: station we are attached to 162 * @dialog_token: dialog token for aggregation session 163 * @timeout: session timeout value to be filled in ADDBA requests 164 * @tid: TID number 165 * @state: session state (see above) 166 * @last_tx: jiffies of last tx activity 167 * @stop_initiator: initiator of a session stop 168 * @tx_stop: TX DelBA frame when stopping 169 * @buf_size: reorder buffer size at receiver 170 * @failed_bar_ssn: ssn of the last failed BAR tx attempt 171 * @bar_pending: BAR needs to be re-sent 172 * @amsdu: support A-MSDU withing A-MDPU 173 * @ssn: starting sequence number of the session 174 * 175 * This structure's lifetime is managed by RCU, assignments to 176 * the array holding it must hold the aggregation mutex. 177 * 178 * The TX path can access it under RCU lock-free if, and 179 * only if, the state has the flag %HT_AGG_STATE_OPERATIONAL 180 * set. Otherwise, the TX path must also acquire the spinlock 181 * and re-check the state, see comments in the tx code 182 * touching it. 183 */ 184 struct tid_ampdu_tx { 185 struct rcu_head rcu_head; 186 struct timer_list session_timer; 187 struct timer_list addba_resp_timer; 188 struct sk_buff_head pending; 189 struct sta_info *sta; 190 unsigned long state; 191 unsigned long last_tx; 192 u16 timeout; 193 u8 dialog_token; 194 u8 stop_initiator; 195 bool tx_stop; 196 u16 buf_size; 197 u16 ssn; 198 199 u16 failed_bar_ssn; 200 bool bar_pending; 201 bool amsdu; 202 u8 tid; 203 }; 204 205 /** 206 * struct tid_ampdu_rx - TID aggregation information (Rx). 207 * 208 * @reorder_buf: buffer to reorder incoming aggregated MPDUs. An MPDU may be an 209 * A-MSDU with individually reported subframes. 210 * @reorder_buf_filtered: bitmap indicating where there are filtered frames in 211 * the reorder buffer that should be ignored when releasing frames 212 * @reorder_time: jiffies when skb was added 213 * @session_timer: check if peer keeps Tx-ing on the TID (by timeout value) 214 * @reorder_timer: releases expired frames from the reorder buffer. 215 * @sta: station we are attached to 216 * @last_rx: jiffies of last rx activity 217 * @head_seq_num: head sequence number in reordering buffer. 218 * @stored_mpdu_num: number of MPDUs in reordering buffer 219 * @ssn: Starting Sequence Number expected to be aggregated. 220 * @buf_size: buffer size for incoming A-MPDUs 221 * @timeout: reset timer value (in TUs). 222 * @tid: TID number 223 * @rcu_head: RCU head used for freeing this struct 224 * @reorder_lock: serializes access to reorder buffer, see below. 225 * @auto_seq: used for offloaded BA sessions to automatically pick head_seq_and 226 * and ssn. 227 * @removed: this session is removed (but might have been found due to RCU) 228 * @started: this session has started (head ssn or higher was received) 229 * 230 * This structure's lifetime is managed by RCU, assignments to 231 * the array holding it must hold the aggregation mutex. 232 * 233 * The @reorder_lock is used to protect the members of this 234 * struct, except for @timeout, @buf_size and @dialog_token, 235 * which are constant across the lifetime of the struct (the 236 * dialog token being used only for debugging). 237 */ 238 struct tid_ampdu_rx { 239 struct rcu_head rcu_head; 240 spinlock_t reorder_lock; 241 u64 reorder_buf_filtered; 242 struct sk_buff_head *reorder_buf; 243 unsigned long *reorder_time; 244 struct sta_info *sta; 245 struct timer_list session_timer; 246 struct timer_list reorder_timer; 247 unsigned long last_rx; 248 u16 head_seq_num; 249 u16 stored_mpdu_num; 250 u16 ssn; 251 u16 buf_size; 252 u16 timeout; 253 u8 tid; 254 u8 auto_seq:1, 255 removed:1, 256 started:1; 257 }; 258 259 /** 260 * struct sta_ampdu_mlme - STA aggregation information. 261 * 262 * @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 */ 281 struct 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 */ 320 struct 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 */ 347 struct 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 */ 364 DECLARE_EWMA(mesh_fail_avg, 20, 8) 365 DECLARE_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 */ 392 struct 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 424 DECLARE_EWMA(signal, 10, 8) 425 426 struct 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 451 struct 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 464 struct ieee80211_fragment_cache { 465 struct ieee80211_fragment_entry entries[IEEE80211_FRAGMENT_MAX]; 466 unsigned int next; 467 }; 468 469 /* 470 * The bandwidth threshold below which the per-station CoDel parameters will be 471 * scaled to be more lenient (to prevent starvation of slow stations). This 472 * value will be scaled by the number of active stations when it is being 473 * applied. 474 */ 475 #define STA_SLOW_THRESHOLD 6000 /* 6 Mbps */ 476 477 /** 478 * struct link_sta_info - Link STA information 479 * All link specific sta info are stored here for reference. This can be 480 * a single entry for non-MLD STA or multiple entries for MLD STA 481 * @addr: Link MAC address - Can be same as MLD STA mac address and is always 482 * same for non-MLD STA. This is used as key for searching link STA 483 * @link_id: Link ID uniquely identifying the link STA. This is 0 for non-MLD 484 * and set to the corresponding vif LinkId for MLD STA 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 * @cur_max_bandwidth: maximum bandwidth to use for TX to the station, 512 * taken from HT/VHT capabilities or VHT operating mode notification 513 * @debugfs_dir: debug filesystem directory dentry 514 * @pub: public (driver visible) link STA data 515 * TODO Move other link params from sta_info as required for MLD operation 516 */ 517 struct link_sta_info { 518 u8 addr[ETH_ALEN]; 519 u8 link_id; 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 561 #ifdef CONFIG_MAC80211_DEBUGFS 562 struct dentry *debugfs_dir; 563 #endif 564 565 struct ieee80211_link_sta *pub; 566 }; 567 568 /** 569 * struct sta_info - STA information 570 * 571 * This structure collects information about a station that 572 * mac80211 is communicating with. 573 * 574 * @list: global linked list entry 575 * @free_list: list entry for keeping track of stations to free 576 * @hash_node: hash node for rhashtable 577 * @addr: station's MAC address - duplicated from public part to 578 * let the hash table work with just a single cacheline 579 * @local: pointer to the global information 580 * @sdata: virtual interface this station belongs to 581 * @ptk: peer keys negotiated with this station, if any 582 * @ptk_idx: last installed peer key index 583 * @rate_ctrl: rate control algorithm reference 584 * @rate_ctrl_lock: spinlock used to protect rate control data 585 * (data inside the algorithm, so serializes calls there) 586 * @rate_ctrl_priv: rate control private per-STA pointer 587 * @lock: used for locking all fields that require locking, see comments 588 * in the header file. 589 * @drv_deliver_wk: used for delivering frames after driver PS unblocking 590 * @listen_interval: listen interval of this station, when we're acting as AP 591 * @_flags: STA flags, see &enum ieee80211_sta_info_flags, do not use directly 592 * @ps_lock: used for powersave (when mac80211 is the AP) related locking 593 * @ps_tx_buf: buffers (per AC) of frames to transmit to this station 594 * when it leaves power saving state or polls 595 * @tx_filtered: buffers (per AC) of frames we already tried to 596 * transmit but were filtered by hardware due to STA having 597 * entered power saving state, these are also delivered to 598 * the station when it leaves powersave or polls for frames 599 * @driver_buffered_tids: bitmap of TIDs the driver has data buffered on 600 * @txq_buffered_tids: bitmap of TIDs that mac80211 has txq data buffered on 601 * @assoc_at: clock boottime (in ns) of last association 602 * @last_connected: time (in seconds) when a station got connected 603 * @last_seq_ctrl: last received seq/frag number from this STA (per TID 604 * plus one for non-QoS frames) 605 * @tid_seq: per-TID sequence numbers for sending to this STA 606 * @airtime: per-AC struct airtime_info describing airtime statistics for this 607 * station 608 * @airtime_weight: station weight for airtime fairness calculation purposes 609 * @ampdu_mlme: A-MPDU state machine state 610 * @mesh: mesh STA information 611 * @debugfs_dir: debug filesystem directory dentry 612 * @dead: set to true when sta is unlinked 613 * @removed: set to true when sta is being removed from sta_list 614 * @uploaded: set to true when sta is uploaded to the driver 615 * @sta: station information we share with the driver 616 * @sta_state: duplicates information about station state (for debug) 617 * @rcu_head: RCU head used for freeing this station struct 618 * @cparams: CoDel parameters for this station. 619 * @reserved_tid: reserved TID (if any, otherwise IEEE80211_TID_UNRESERVED) 620 * @amsdu_mesh_control: track the mesh A-MSDU format used by the peer: 621 * 622 * * -1: not yet known 623 * * 0: non-mesh A-MSDU length field 624 * * 1: big-endian mesh A-MSDU length field 625 * * 2: little-endian mesh A-MSDU length field 626 * 627 * @fast_tx: TX fastpath information 628 * @fast_rx: RX fastpath information 629 * @tdls_chandef: a TDLS peer can have a wider chandef that is compatible to 630 * the BSS one. 631 * @frags: fragment cache 632 * @cur: storage for aggregation data 633 * &struct ieee80211_sta points either here or to deflink.agg. 634 * @deflink: This is the default link STA information, for non MLO STA all link 635 * specific STA information is accessed through @deflink or through 636 * link[0] which points to address of @deflink. For MLO Link STA 637 * the first added link STA will point to deflink. 638 * @link: reference to Link Sta entries. For Non MLO STA, except 1st link, 639 * i.e link[0] all links would be assigned to NULL by default and 640 * would access link information via @deflink or link[0]. For MLO 641 * STA, first link STA being added will point its link pointer to 642 * @deflink address and remaining would be allocated and the address 643 * would be assigned to link[link_id] where link_id is the id assigned 644 * by the AP. 645 */ 646 struct sta_info { 647 /* General information, mostly static */ 648 struct list_head list, free_list; 649 struct rcu_head rcu_head; 650 struct rhlist_head hash_node; 651 u8 addr[ETH_ALEN]; 652 struct ieee80211_local *local; 653 struct ieee80211_sub_if_data *sdata; 654 struct ieee80211_key __rcu *ptk[NUM_DEFAULT_KEYS]; 655 u8 ptk_idx; 656 struct rate_control_ref *rate_ctrl; 657 void *rate_ctrl_priv; 658 spinlock_t rate_ctrl_lock; 659 spinlock_t lock; 660 661 struct ieee80211_fast_tx __rcu *fast_tx; 662 struct ieee80211_fast_rx __rcu *fast_rx; 663 664 #ifdef CONFIG_MAC80211_MESH 665 struct mesh_sta *mesh; 666 #endif 667 668 struct work_struct drv_deliver_wk; 669 670 u16 listen_interval; 671 672 bool dead; 673 bool removed; 674 675 bool uploaded; 676 677 enum ieee80211_sta_state sta_state; 678 679 /* use the accessors defined below */ 680 unsigned long _flags; 681 682 /* STA powersave lock and frame queues */ 683 spinlock_t ps_lock; 684 struct sk_buff_head ps_tx_buf[IEEE80211_NUM_ACS]; 685 struct sk_buff_head tx_filtered[IEEE80211_NUM_ACS]; 686 unsigned long driver_buffered_tids; 687 unsigned long txq_buffered_tids; 688 689 u64 assoc_at; 690 long last_connected; 691 692 /* Plus 1 for non-QoS frames */ 693 __le16 last_seq_ctrl[IEEE80211_NUM_TIDS + 1]; 694 695 u16 tid_seq[IEEE80211_QOS_CTL_TID_MASK + 1]; 696 697 struct airtime_info airtime[IEEE80211_NUM_ACS]; 698 u16 airtime_weight; 699 700 /* 701 * Aggregation information, locked with lock. 702 */ 703 struct sta_ampdu_mlme ampdu_mlme; 704 705 #ifdef CONFIG_MAC80211_DEBUGFS 706 struct dentry *debugfs_dir; 707 #endif 708 709 struct codel_params cparams; 710 711 u8 reserved_tid; 712 s8 amsdu_mesh_control; 713 714 struct cfg80211_chan_def tdls_chandef; 715 716 struct ieee80211_fragment_cache frags; 717 718 struct ieee80211_sta_aggregates cur; 719 struct link_sta_info deflink; 720 struct link_sta_info __rcu *link[IEEE80211_MLD_MAX_NUM_LINKS]; 721 722 /* keep last! */ 723 struct ieee80211_sta sta; 724 }; 725 726 static inline enum nl80211_plink_state sta_plink_state(struct sta_info *sta) 727 { 728 #ifdef CONFIG_MAC80211_MESH 729 return sta->mesh->plink_state; 730 #endif 731 return NL80211_PLINK_LISTEN; 732 } 733 734 static inline void set_sta_flag(struct sta_info *sta, 735 enum ieee80211_sta_info_flags flag) 736 { 737 WARN_ON(flag == WLAN_STA_AUTH || 738 flag == WLAN_STA_ASSOC || 739 flag == WLAN_STA_AUTHORIZED); 740 set_bit(flag, &sta->_flags); 741 } 742 743 static inline void clear_sta_flag(struct sta_info *sta, 744 enum ieee80211_sta_info_flags flag) 745 { 746 WARN_ON(flag == WLAN_STA_AUTH || 747 flag == WLAN_STA_ASSOC || 748 flag == WLAN_STA_AUTHORIZED); 749 clear_bit(flag, &sta->_flags); 750 } 751 752 static inline int test_sta_flag(struct sta_info *sta, 753 enum ieee80211_sta_info_flags flag) 754 { 755 return test_bit(flag, &sta->_flags); 756 } 757 758 static inline int test_and_clear_sta_flag(struct sta_info *sta, 759 enum ieee80211_sta_info_flags flag) 760 { 761 WARN_ON(flag == WLAN_STA_AUTH || 762 flag == WLAN_STA_ASSOC || 763 flag == WLAN_STA_AUTHORIZED); 764 return test_and_clear_bit(flag, &sta->_flags); 765 } 766 767 static inline int test_and_set_sta_flag(struct sta_info *sta, 768 enum ieee80211_sta_info_flags flag) 769 { 770 WARN_ON(flag == WLAN_STA_AUTH || 771 flag == WLAN_STA_ASSOC || 772 flag == WLAN_STA_AUTHORIZED); 773 return test_and_set_bit(flag, &sta->_flags); 774 } 775 776 int sta_info_move_state(struct sta_info *sta, 777 enum ieee80211_sta_state new_state); 778 779 static inline void sta_info_pre_move_state(struct sta_info *sta, 780 enum ieee80211_sta_state new_state) 781 { 782 int ret; 783 784 WARN_ON_ONCE(test_sta_flag(sta, WLAN_STA_INSERTED)); 785 786 ret = sta_info_move_state(sta, new_state); 787 WARN_ON_ONCE(ret); 788 } 789 790 791 void ieee80211_assign_tid_tx(struct sta_info *sta, int tid, 792 struct tid_ampdu_tx *tid_tx); 793 794 #define rcu_dereference_protected_tid_tx(sta, tid) \ 795 rcu_dereference_protected((sta)->ampdu_mlme.tid_tx[tid], \ 796 lockdep_is_held(&(sta)->lock) || \ 797 lockdep_is_held(&(sta)->local->hw.wiphy->mtx)); 798 799 /* Maximum number of frames to buffer per power saving station per AC */ 800 #define STA_MAX_TX_BUFFER 64 801 802 /* Minimum buffered frame expiry time. If STA uses listen interval that is 803 * smaller than this value, the minimum value here is used instead. */ 804 #define STA_TX_BUFFER_EXPIRE (10 * HZ) 805 806 /* How often station data is cleaned up (e.g., expiration of buffered frames) 807 */ 808 #define STA_INFO_CLEANUP_INTERVAL (10 * HZ) 809 810 struct rhlist_head *sta_info_hash_lookup(struct ieee80211_local *local, 811 const u8 *addr); 812 813 /* 814 * Get a STA info, must be under RCU read lock. 815 */ 816 struct sta_info *sta_info_get(struct ieee80211_sub_if_data *sdata, 817 const u8 *addr); 818 819 struct sta_info *sta_info_get_bss(struct ieee80211_sub_if_data *sdata, 820 const u8 *addr); 821 822 /* user must hold wiphy mutex or be in RCU critical section */ 823 struct sta_info *sta_info_get_by_addrs(struct ieee80211_local *local, 824 const u8 *sta_addr, const u8 *vif_addr); 825 826 #define for_each_sta_info(local, _addr, _sta, _tmp) \ 827 rhl_for_each_entry_rcu(_sta, _tmp, \ 828 sta_info_hash_lookup(local, _addr), hash_node) 829 830 struct rhlist_head *link_sta_info_hash_lookup(struct ieee80211_local *local, 831 const u8 *addr); 832 833 #define for_each_link_sta_info(local, _addr, _sta, _tmp) \ 834 rhl_for_each_entry_rcu(_sta, _tmp, \ 835 link_sta_info_hash_lookup(local, _addr), \ 836 link_hash_node) 837 838 struct link_sta_info * 839 link_sta_info_get_bss(struct ieee80211_sub_if_data *sdata, const u8 *addr); 840 841 /* 842 * Get STA info by index, BROKEN! 843 */ 844 struct sta_info *sta_info_get_by_idx(struct ieee80211_sub_if_data *sdata, 845 int idx); 846 /* 847 * Create a new STA info, caller owns returned structure 848 * until sta_info_insert(). 849 */ 850 struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata, 851 const u8 *addr, gfp_t gfp); 852 struct sta_info *sta_info_alloc_with_link(struct ieee80211_sub_if_data *sdata, 853 const u8 *mld_addr, 854 unsigned int link_id, 855 const u8 *link_addr, 856 gfp_t gfp); 857 858 void sta_info_free(struct ieee80211_local *local, struct sta_info *sta); 859 860 /* 861 * Insert STA info into hash table/list, returns zero or a 862 * -EEXIST if (if the same MAC address is already present). 863 * 864 * Calling the non-rcu version makes the caller relinquish, 865 * the _rcu version calls read_lock_rcu() and must be called 866 * without it held. 867 */ 868 int sta_info_insert(struct sta_info *sta); 869 int sta_info_insert_rcu(struct sta_info *sta) __acquires(RCU); 870 871 int __must_check __sta_info_destroy(struct sta_info *sta); 872 int sta_info_destroy_addr(struct ieee80211_sub_if_data *sdata, 873 const u8 *addr); 874 int sta_info_destroy_addr_bss(struct ieee80211_sub_if_data *sdata, 875 const u8 *addr); 876 877 void sta_info_recalc_tim(struct sta_info *sta); 878 879 int sta_info_init(struct ieee80211_local *local); 880 void sta_info_stop(struct ieee80211_local *local); 881 882 /** 883 * __sta_info_flush - flush matching STA entries from the STA table 884 * 885 * Returns the number of removed STA entries. 886 * 887 * @sdata: sdata to remove all stations from 888 * @vlans: if the given interface is an AP interface, also flush VLANs 889 */ 890 int __sta_info_flush(struct ieee80211_sub_if_data *sdata, bool vlans); 891 892 /** 893 * sta_info_flush - flush matching STA entries from the STA table 894 * 895 * Returns the number of removed STA entries. 896 * 897 * @sdata: sdata to remove all stations from 898 */ 899 static inline int sta_info_flush(struct ieee80211_sub_if_data *sdata) 900 { 901 return __sta_info_flush(sdata, false); 902 } 903 904 void sta_set_rate_info_tx(struct sta_info *sta, 905 const struct ieee80211_tx_rate *rate, 906 struct rate_info *rinfo); 907 void sta_set_sinfo(struct sta_info *sta, struct station_info *sinfo, 908 bool tidstats); 909 910 u32 sta_get_expected_throughput(struct sta_info *sta); 911 912 void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata, 913 unsigned long exp_time); 914 915 int ieee80211_sta_allocate_link(struct sta_info *sta, unsigned int link_id); 916 void ieee80211_sta_free_link(struct sta_info *sta, unsigned int link_id); 917 int ieee80211_sta_activate_link(struct sta_info *sta, unsigned int link_id); 918 void ieee80211_sta_remove_link(struct sta_info *sta, unsigned int link_id); 919 920 void ieee80211_sta_ps_deliver_wakeup(struct sta_info *sta); 921 void ieee80211_sta_ps_deliver_poll_response(struct sta_info *sta); 922 void ieee80211_sta_ps_deliver_uapsd(struct sta_info *sta); 923 924 unsigned long ieee80211_sta_last_active(struct sta_info *sta); 925 926 void ieee80211_sta_set_max_amsdu_subframes(struct sta_info *sta, 927 const u8 *ext_capab, 928 unsigned int ext_capab_len); 929 930 void __ieee80211_sta_recalc_aggregates(struct sta_info *sta, u16 active_links); 931 932 enum sta_stats_type { 933 STA_STATS_RATE_TYPE_INVALID = 0, 934 STA_STATS_RATE_TYPE_LEGACY, 935 STA_STATS_RATE_TYPE_HT, 936 STA_STATS_RATE_TYPE_VHT, 937 STA_STATS_RATE_TYPE_HE, 938 STA_STATS_RATE_TYPE_S1G, 939 STA_STATS_RATE_TYPE_EHT, 940 }; 941 942 #define STA_STATS_FIELD_HT_MCS GENMASK( 7, 0) 943 #define STA_STATS_FIELD_LEGACY_IDX GENMASK( 3, 0) 944 #define STA_STATS_FIELD_LEGACY_BAND GENMASK( 7, 4) 945 #define STA_STATS_FIELD_VHT_MCS GENMASK( 3, 0) 946 #define STA_STATS_FIELD_VHT_NSS GENMASK( 7, 4) 947 #define STA_STATS_FIELD_HE_MCS GENMASK( 3, 0) 948 #define STA_STATS_FIELD_HE_NSS GENMASK( 7, 4) 949 #define STA_STATS_FIELD_EHT_MCS GENMASK( 3, 0) 950 #define STA_STATS_FIELD_EHT_NSS GENMASK( 7, 4) 951 #define STA_STATS_FIELD_BW GENMASK(12, 8) 952 #define STA_STATS_FIELD_SGI GENMASK(13, 13) 953 #define STA_STATS_FIELD_TYPE GENMASK(16, 14) 954 #define STA_STATS_FIELD_HE_RU GENMASK(19, 17) 955 #define STA_STATS_FIELD_HE_GI GENMASK(21, 20) 956 #define STA_STATS_FIELD_HE_DCM GENMASK(22, 22) 957 #define STA_STATS_FIELD_EHT_RU GENMASK(20, 17) 958 #define STA_STATS_FIELD_EHT_GI GENMASK(22, 21) 959 960 #define STA_STATS_FIELD(_n, _v) FIELD_PREP(STA_STATS_FIELD_ ## _n, _v) 961 #define STA_STATS_GET(_n, _v) FIELD_GET(STA_STATS_FIELD_ ## _n, _v) 962 963 #define STA_STATS_RATE_INVALID 0 964 965 static inline u32 sta_stats_encode_rate(struct ieee80211_rx_status *s) 966 { 967 u32 r; 968 969 r = STA_STATS_FIELD(BW, s->bw); 970 971 if (s->enc_flags & RX_ENC_FLAG_SHORT_GI) 972 r |= STA_STATS_FIELD(SGI, 1); 973 974 switch (s->encoding) { 975 case RX_ENC_VHT: 976 r |= STA_STATS_FIELD(TYPE, STA_STATS_RATE_TYPE_VHT); 977 r |= STA_STATS_FIELD(VHT_NSS, s->nss); 978 r |= STA_STATS_FIELD(VHT_MCS, s->rate_idx); 979 break; 980 case RX_ENC_HT: 981 r |= STA_STATS_FIELD(TYPE, STA_STATS_RATE_TYPE_HT); 982 r |= STA_STATS_FIELD(HT_MCS, s->rate_idx); 983 break; 984 case RX_ENC_LEGACY: 985 r |= STA_STATS_FIELD(TYPE, STA_STATS_RATE_TYPE_LEGACY); 986 r |= STA_STATS_FIELD(LEGACY_BAND, s->band); 987 r |= STA_STATS_FIELD(LEGACY_IDX, s->rate_idx); 988 break; 989 case RX_ENC_HE: 990 r |= STA_STATS_FIELD(TYPE, STA_STATS_RATE_TYPE_HE); 991 r |= STA_STATS_FIELD(HE_NSS, s->nss); 992 r |= STA_STATS_FIELD(HE_MCS, s->rate_idx); 993 r |= STA_STATS_FIELD(HE_GI, s->he_gi); 994 r |= STA_STATS_FIELD(HE_RU, s->he_ru); 995 r |= STA_STATS_FIELD(HE_DCM, s->he_dcm); 996 break; 997 case RX_ENC_EHT: 998 r |= STA_STATS_FIELD(TYPE, STA_STATS_RATE_TYPE_EHT); 999 r |= STA_STATS_FIELD(EHT_NSS, s->nss); 1000 r |= STA_STATS_FIELD(EHT_MCS, s->rate_idx); 1001 r |= STA_STATS_FIELD(EHT_GI, s->eht.gi); 1002 r |= STA_STATS_FIELD(EHT_RU, s->eht.ru); 1003 break; 1004 default: 1005 WARN_ON(1); 1006 return STA_STATS_RATE_INVALID; 1007 } 1008 1009 return r; 1010 } 1011 1012 #endif /* STA_INFO_H */ 1013