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