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