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 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 */ 77 enum 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 124 DECLARE_EWMA(avg_signal, 10, 8) 125 enum 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 136 struct 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 145 void ieee80211_sta_update_pending_airtime(struct ieee80211_local *local, 146 struct sta_info *sta, u8 ac, 147 u16 tx_airtime, bool tx_completed); 148 149 struct 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 */ 180 struct 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 194 u16 failed_bar_ssn; 195 bool bar_pending; 196 bool amsdu; 197 u8 tid; 198 }; 199 200 /** 201 * struct tid_ampdu_rx - TID aggregation information (Rx). 202 * 203 * @reorder_buf: buffer to reorder incoming aggregated MPDUs. An MPDU may be an 204 * A-MSDU with individually reported subframes. 205 * @reorder_buf_filtered: bitmap indicating where there are filtered frames in 206 * the reorder buffer that should be ignored when releasing frames 207 * @reorder_time: jiffies when skb was added 208 * @session_timer: check if peer keeps Tx-ing on the TID (by timeout value) 209 * @reorder_timer: releases expired frames from the reorder buffer. 210 * @sta: station we are attached to 211 * @last_rx: jiffies of last rx activity 212 * @head_seq_num: head sequence number in reordering buffer. 213 * @stored_mpdu_num: number of MPDUs in reordering buffer 214 * @ssn: Starting Sequence Number expected to be aggregated. 215 * @buf_size: buffer size for incoming A-MPDUs 216 * @timeout: reset timer value (in TUs). 217 * @tid: TID number 218 * @rcu_head: RCU head used for freeing this struct 219 * @reorder_lock: serializes access to reorder buffer, see below. 220 * @auto_seq: used for offloaded BA sessions to automatically pick head_seq_and 221 * and ssn. 222 * @removed: this session is removed (but might have been found due to RCU) 223 * @started: this session has started (head ssn or higher was received) 224 * 225 * This structure's lifetime is managed by RCU, assignments to 226 * the array holding it must hold the aggregation mutex. 227 * 228 * The @reorder_lock is used to protect the members of this 229 * struct, except for @timeout, @buf_size and @dialog_token, 230 * which are constant across the lifetime of the struct (the 231 * dialog token being used only for debugging). 232 */ 233 struct tid_ampdu_rx { 234 struct rcu_head rcu_head; 235 spinlock_t reorder_lock; 236 u64 reorder_buf_filtered; 237 struct sk_buff_head *reorder_buf; 238 unsigned long *reorder_time; 239 struct sta_info *sta; 240 struct timer_list session_timer; 241 struct timer_list reorder_timer; 242 unsigned long last_rx; 243 u16 head_seq_num; 244 u16 stored_mpdu_num; 245 u16 ssn; 246 u16 buf_size; 247 u16 timeout; 248 u8 tid; 249 u8 auto_seq:1, 250 removed:1, 251 started:1; 252 }; 253 254 /** 255 * struct sta_ampdu_mlme - STA aggregation information. 256 * 257 * @mtx: mutex to protect all TX data (except non-NULL assignments 258 * to tid_tx[idx], which are protected by the sta spinlock) 259 * tid_start_tx is also protected by sta->lock. 260 * @tid_rx: aggregation info for Rx per TID -- RCU protected 261 * @tid_rx_token: dialog tokens for valid aggregation sessions 262 * @tid_rx_timer_expired: bitmap indicating on which TIDs the 263 * RX timer expired until the work for it runs 264 * @tid_rx_stop_requested: bitmap indicating which BA sessions per TID the 265 * driver requested to close until the work for it runs 266 * @tid_rx_manage_offl: bitmap indicating which BA sessions were requested 267 * to be treated as started/stopped due to offloading 268 * @agg_session_valid: bitmap indicating which TID has a rx BA session open on 269 * @unexpected_agg: bitmap indicating which TID already sent a delBA due to 270 * unexpected aggregation related frames outside a session 271 * @work: work struct for starting/stopping aggregation 272 * @tid_tx: aggregation info for Tx per TID 273 * @tid_start_tx: sessions where start was requested 274 * @last_addba_req_time: timestamp of the last addBA request. 275 * @addba_req_num: number of times addBA request has been sent. 276 * @dialog_token_allocator: dialog token enumerator for each new session; 277 */ 278 struct sta_ampdu_mlme { 279 struct mutex mtx; 280 /* rx */ 281 struct tid_ampdu_rx __rcu *tid_rx[IEEE80211_NUM_TIDS]; 282 u8 tid_rx_token[IEEE80211_NUM_TIDS]; 283 unsigned long tid_rx_timer_expired[BITS_TO_LONGS(IEEE80211_NUM_TIDS)]; 284 unsigned long tid_rx_stop_requested[BITS_TO_LONGS(IEEE80211_NUM_TIDS)]; 285 unsigned long tid_rx_manage_offl[BITS_TO_LONGS(2 * IEEE80211_NUM_TIDS)]; 286 unsigned long agg_session_valid[BITS_TO_LONGS(IEEE80211_NUM_TIDS)]; 287 unsigned long unexpected_agg[BITS_TO_LONGS(IEEE80211_NUM_TIDS)]; 288 /* tx */ 289 struct work_struct work; 290 struct tid_ampdu_tx __rcu *tid_tx[IEEE80211_NUM_TIDS]; 291 struct tid_ampdu_tx *tid_start_tx[IEEE80211_NUM_TIDS]; 292 unsigned long last_addba_req_time[IEEE80211_NUM_TIDS]; 293 u8 addba_req_num[IEEE80211_NUM_TIDS]; 294 u8 dialog_token_allocator; 295 }; 296 297 298 /* Value to indicate no TID reservation */ 299 #define IEEE80211_TID_UNRESERVED 0xff 300 301 #define IEEE80211_FAST_XMIT_MAX_IV 18 302 303 /** 304 * struct ieee80211_fast_tx - TX fastpath information 305 * @key: key to use for hw crypto 306 * @hdr: the 802.11 header to put with the frame 307 * @hdr_len: actual 802.11 header length 308 * @sa_offs: offset of the SA 309 * @da_offs: offset of the DA 310 * @pn_offs: offset where to put PN for crypto (or 0 if not needed) 311 * @band: band this will be transmitted on, for tx_info 312 * @rcu_head: RCU head to free this struct 313 * 314 * This struct is small enough so that the common case (maximum crypto 315 * header length of 8 like for CCMP/GCMP) fits into a single 64-byte 316 * cache line. 317 */ 318 struct ieee80211_fast_tx { 319 struct ieee80211_key *key; 320 u8 hdr_len; 321 u8 sa_offs, da_offs, pn_offs; 322 u8 band; 323 u8 hdr[30 + 2 + IEEE80211_FAST_XMIT_MAX_IV + 324 sizeof(rfc1042_header)] __aligned(2); 325 326 struct rcu_head rcu_head; 327 }; 328 329 /** 330 * struct ieee80211_fast_rx - RX fastpath information 331 * @dev: netdevice for reporting the SKB 332 * @vif_type: (P2P-less) interface type of the original sdata (sdata->vif.type) 333 * @vif_addr: interface address 334 * @rfc1042_hdr: copy of the RFC 1042 SNAP header (to have in cache) 335 * @control_port_protocol: control port protocol copied from sdata 336 * @expected_ds_bits: from/to DS bits expected 337 * @icv_len: length of the MIC if present 338 * @key: bool indicating encryption is expected (key is set) 339 * @sta_notify: notify the MLME code (once) 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 */ 346 struct 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 sta_notify: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 * The bandwidth threshold below which the per-station CoDel parameters will be 443 * scaled to be more lenient (to prevent starvation of slow stations). This 444 * value will be scaled by the number of active stations when it is being 445 * applied. 446 */ 447 #define STA_SLOW_THRESHOLD 6000 /* 6 Mbps */ 448 449 /** 450 * struct sta_info - STA information 451 * 452 * This structure collects information about a station that 453 * mac80211 is communicating with. 454 * 455 * @list: global linked list entry 456 * @free_list: list entry for keeping track of stations to free 457 * @hash_node: hash node for rhashtable 458 * @addr: station's MAC address - duplicated from public part to 459 * let the hash table work with just a single cacheline 460 * @local: pointer to the global information 461 * @sdata: virtual interface this station belongs to 462 * @ptk: peer keys negotiated with this station, if any 463 * @ptk_idx: last installed peer key index 464 * @gtk: group keys negotiated with this station, if any 465 * @rate_ctrl: rate control algorithm reference 466 * @rate_ctrl_lock: spinlock used to protect rate control data 467 * (data inside the algorithm, so serializes calls there) 468 * @rate_ctrl_priv: rate control private per-STA pointer 469 * @lock: used for locking all fields that require locking, see comments 470 * in the header file. 471 * @drv_deliver_wk: used for delivering frames after driver PS unblocking 472 * @listen_interval: listen interval of this station, when we're acting as AP 473 * @_flags: STA flags, see &enum ieee80211_sta_info_flags, do not use directly 474 * @ps_lock: used for powersave (when mac80211 is the AP) related locking 475 * @ps_tx_buf: buffers (per AC) of frames to transmit to this station 476 * when it leaves power saving state or polls 477 * @tx_filtered: buffers (per AC) of frames we already tried to 478 * transmit but were filtered by hardware due to STA having 479 * entered power saving state, these are also delivered to 480 * the station when it leaves powersave or polls for frames 481 * @driver_buffered_tids: bitmap of TIDs the driver has data buffered on 482 * @txq_buffered_tids: bitmap of TIDs that mac80211 has txq data buffered on 483 * @assoc_at: clock boottime (in ns) of last association 484 * @last_connected: time (in seconds) when a station got connected 485 * @last_seq_ctrl: last received seq/frag number from this STA (per TID 486 * plus one for non-QoS frames) 487 * @tid_seq: per-TID sequence numbers for sending to this STA 488 * @airtime: per-AC struct airtime_info describing airtime statistics for this 489 * station 490 * @airtime_weight: station weight for airtime fairness calculation purposes 491 * @ampdu_mlme: A-MPDU state machine state 492 * @mesh: mesh STA information 493 * @debugfs_dir: debug filesystem directory dentry 494 * @dead: set to true when sta is unlinked 495 * @removed: set to true when sta is being removed from sta_list 496 * @uploaded: set to true when sta is uploaded to the driver 497 * @sta: station information we share with the driver 498 * @sta_state: duplicates information about station state (for debug) 499 * @rcu_head: RCU head used for freeing this station struct 500 * @cur_max_bandwidth: maximum bandwidth to use for TX to the station, 501 * taken from HT/VHT capabilities or VHT operating mode notification 502 * @known_smps_mode: the smps_mode the client thinks we are in. Relevant for 503 * AP only. 504 * @cipher_scheme: optional cipher scheme for this station 505 * @cparams: CoDel parameters for this station. 506 * @reserved_tid: reserved TID (if any, otherwise IEEE80211_TID_UNRESERVED) 507 * @fast_tx: TX fastpath information 508 * @fast_rx: RX fastpath information 509 * @tdls_chandef: a TDLS peer can have a wider chandef that is compatible to 510 * the BSS one. 511 * @tx_stats: TX statistics 512 * @tx_stats.packets: # of packets transmitted 513 * @tx_stats.bytes: # of bytes in all packets transmitted 514 * @tx_stats.last_rate: last TX rate 515 * @tx_stats.msdu: # of transmitted MSDUs per TID 516 * @rx_stats: RX statistics 517 * @rx_stats_avg: averaged RX statistics 518 * @rx_stats_avg.signal: averaged signal 519 * @rx_stats_avg.chain_signal: averaged per-chain signal 520 * @pcpu_rx_stats: per-CPU RX statistics, assigned only if the driver needs 521 * this (by advertising the USES_RSS hw flag) 522 * @status_stats: TX status statistics 523 * @status_stats.filtered: # of filtered frames 524 * @status_stats.retry_failed: # of frames that failed after retry 525 * @status_stats.retry_count: # of retries attempted 526 * @status_stats.lost_packets: # of lost packets 527 * @status_stats.last_tdls_pkt_time: timestamp of last TDLS packet 528 * @status_stats.msdu_retries: # of MSDU retries 529 * @status_stats.msdu_failed: # of failed MSDUs 530 * @status_stats.last_ack: last ack timestamp (jiffies) 531 * @status_stats.last_ack_signal: last ACK signal 532 * @status_stats.ack_signal_filled: last ACK signal validity 533 * @status_stats.avg_ack_signal: average ACK signal 534 */ 535 struct sta_info { 536 /* General information, mostly static */ 537 struct list_head list, free_list; 538 struct rcu_head rcu_head; 539 struct rhlist_head hash_node; 540 u8 addr[ETH_ALEN]; 541 struct ieee80211_local *local; 542 struct ieee80211_sub_if_data *sdata; 543 struct ieee80211_key __rcu *gtk[NUM_DEFAULT_KEYS + 544 NUM_DEFAULT_MGMT_KEYS + 545 NUM_DEFAULT_BEACON_KEYS]; 546 struct ieee80211_key __rcu *ptk[NUM_DEFAULT_KEYS]; 547 u8 ptk_idx; 548 struct rate_control_ref *rate_ctrl; 549 void *rate_ctrl_priv; 550 spinlock_t rate_ctrl_lock; 551 spinlock_t lock; 552 553 struct ieee80211_fast_tx __rcu *fast_tx; 554 struct ieee80211_fast_rx __rcu *fast_rx; 555 struct ieee80211_sta_rx_stats __percpu *pcpu_rx_stats; 556 557 #ifdef CONFIG_MAC80211_MESH 558 struct mesh_sta *mesh; 559 #endif 560 561 struct work_struct drv_deliver_wk; 562 563 u16 listen_interval; 564 565 bool dead; 566 bool removed; 567 568 bool uploaded; 569 570 enum ieee80211_sta_state sta_state; 571 572 /* use the accessors defined below */ 573 unsigned long _flags; 574 575 /* STA powersave lock and frame queues */ 576 spinlock_t ps_lock; 577 struct sk_buff_head ps_tx_buf[IEEE80211_NUM_ACS]; 578 struct sk_buff_head tx_filtered[IEEE80211_NUM_ACS]; 579 unsigned long driver_buffered_tids; 580 unsigned long txq_buffered_tids; 581 582 u64 assoc_at; 583 long last_connected; 584 585 /* Updated from RX path only, no locking requirements */ 586 struct ieee80211_sta_rx_stats rx_stats; 587 struct { 588 struct ewma_signal signal; 589 struct ewma_signal chain_signal[IEEE80211_MAX_CHAINS]; 590 } rx_stats_avg; 591 592 /* Plus 1 for non-QoS frames */ 593 __le16 last_seq_ctrl[IEEE80211_NUM_TIDS + 1]; 594 595 /* Updated from TX status path only, no locking requirements */ 596 struct { 597 unsigned long filtered; 598 unsigned long retry_failed, retry_count; 599 unsigned int lost_packets; 600 unsigned long last_tdls_pkt_time; 601 u64 msdu_retries[IEEE80211_NUM_TIDS + 1]; 602 u64 msdu_failed[IEEE80211_NUM_TIDS + 1]; 603 unsigned long last_ack; 604 s8 last_ack_signal; 605 bool ack_signal_filled; 606 struct ewma_avg_signal avg_ack_signal; 607 } status_stats; 608 609 /* Updated from TX path only, no locking requirements */ 610 struct { 611 u64 packets[IEEE80211_NUM_ACS]; 612 u64 bytes[IEEE80211_NUM_ACS]; 613 struct ieee80211_tx_rate last_rate; 614 u64 msdu[IEEE80211_NUM_TIDS + 1]; 615 } tx_stats; 616 u16 tid_seq[IEEE80211_QOS_CTL_TID_MASK + 1]; 617 618 struct airtime_info airtime[IEEE80211_NUM_ACS]; 619 u16 airtime_weight; 620 621 /* 622 * Aggregation information, locked with lock. 623 */ 624 struct sta_ampdu_mlme ampdu_mlme; 625 626 #ifdef CONFIG_MAC80211_DEBUGFS 627 struct dentry *debugfs_dir; 628 #endif 629 630 enum ieee80211_sta_rx_bandwidth cur_max_bandwidth; 631 632 enum ieee80211_smps_mode known_smps_mode; 633 const struct ieee80211_cipher_scheme *cipher_scheme; 634 635 struct codel_params cparams; 636 637 u8 reserved_tid; 638 639 struct cfg80211_chan_def tdls_chandef; 640 641 /* keep last! */ 642 struct ieee80211_sta sta; 643 }; 644 645 static inline enum nl80211_plink_state sta_plink_state(struct sta_info *sta) 646 { 647 #ifdef CONFIG_MAC80211_MESH 648 return sta->mesh->plink_state; 649 #endif 650 return NL80211_PLINK_LISTEN; 651 } 652 653 static inline void set_sta_flag(struct sta_info *sta, 654 enum ieee80211_sta_info_flags flag) 655 { 656 WARN_ON(flag == WLAN_STA_AUTH || 657 flag == WLAN_STA_ASSOC || 658 flag == WLAN_STA_AUTHORIZED); 659 set_bit(flag, &sta->_flags); 660 } 661 662 static inline void clear_sta_flag(struct sta_info *sta, 663 enum ieee80211_sta_info_flags flag) 664 { 665 WARN_ON(flag == WLAN_STA_AUTH || 666 flag == WLAN_STA_ASSOC || 667 flag == WLAN_STA_AUTHORIZED); 668 clear_bit(flag, &sta->_flags); 669 } 670 671 static inline int test_sta_flag(struct sta_info *sta, 672 enum ieee80211_sta_info_flags flag) 673 { 674 return test_bit(flag, &sta->_flags); 675 } 676 677 static inline int test_and_clear_sta_flag(struct sta_info *sta, 678 enum ieee80211_sta_info_flags flag) 679 { 680 WARN_ON(flag == WLAN_STA_AUTH || 681 flag == WLAN_STA_ASSOC || 682 flag == WLAN_STA_AUTHORIZED); 683 return test_and_clear_bit(flag, &sta->_flags); 684 } 685 686 static inline int test_and_set_sta_flag(struct sta_info *sta, 687 enum ieee80211_sta_info_flags flag) 688 { 689 WARN_ON(flag == WLAN_STA_AUTH || 690 flag == WLAN_STA_ASSOC || 691 flag == WLAN_STA_AUTHORIZED); 692 return test_and_set_bit(flag, &sta->_flags); 693 } 694 695 int sta_info_move_state(struct sta_info *sta, 696 enum ieee80211_sta_state new_state); 697 698 static inline void sta_info_pre_move_state(struct sta_info *sta, 699 enum ieee80211_sta_state new_state) 700 { 701 int ret; 702 703 WARN_ON_ONCE(test_sta_flag(sta, WLAN_STA_INSERTED)); 704 705 ret = sta_info_move_state(sta, new_state); 706 WARN_ON_ONCE(ret); 707 } 708 709 710 void ieee80211_assign_tid_tx(struct sta_info *sta, int tid, 711 struct tid_ampdu_tx *tid_tx); 712 713 static inline struct tid_ampdu_tx * 714 rcu_dereference_protected_tid_tx(struct sta_info *sta, int tid) 715 { 716 return rcu_dereference_protected(sta->ampdu_mlme.tid_tx[tid], 717 lockdep_is_held(&sta->lock) || 718 lockdep_is_held(&sta->ampdu_mlme.mtx)); 719 } 720 721 /* Maximum number of frames to buffer per power saving station per AC */ 722 #define STA_MAX_TX_BUFFER 64 723 724 /* Minimum buffered frame expiry time. If STA uses listen interval that is 725 * smaller than this value, the minimum value here is used instead. */ 726 #define STA_TX_BUFFER_EXPIRE (10 * HZ) 727 728 /* How often station data is cleaned up (e.g., expiration of buffered frames) 729 */ 730 #define STA_INFO_CLEANUP_INTERVAL (10 * HZ) 731 732 struct rhlist_head *sta_info_hash_lookup(struct ieee80211_local *local, 733 const u8 *addr); 734 735 /* 736 * Get a STA info, must be under RCU read lock. 737 */ 738 struct sta_info *sta_info_get(struct ieee80211_sub_if_data *sdata, 739 const u8 *addr); 740 741 struct sta_info *sta_info_get_bss(struct ieee80211_sub_if_data *sdata, 742 const u8 *addr); 743 744 /* user must hold sta_mtx or be in RCU critical section */ 745 struct sta_info *sta_info_get_by_addrs(struct ieee80211_local *local, 746 const u8 *sta_addr, const u8 *vif_addr); 747 748 #define for_each_sta_info(local, _addr, _sta, _tmp) \ 749 rhl_for_each_entry_rcu(_sta, _tmp, \ 750 sta_info_hash_lookup(local, _addr), hash_node) 751 752 /* 753 * Get STA info by index, BROKEN! 754 */ 755 struct sta_info *sta_info_get_by_idx(struct ieee80211_sub_if_data *sdata, 756 int idx); 757 /* 758 * Create a new STA info, caller owns returned structure 759 * until sta_info_insert(). 760 */ 761 struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata, 762 const u8 *addr, gfp_t gfp); 763 764 void sta_info_free(struct ieee80211_local *local, struct sta_info *sta); 765 766 /* 767 * Insert STA info into hash table/list, returns zero or a 768 * -EEXIST if (if the same MAC address is already present). 769 * 770 * Calling the non-rcu version makes the caller relinquish, 771 * the _rcu version calls read_lock_rcu() and must be called 772 * without it held. 773 */ 774 int sta_info_insert(struct sta_info *sta); 775 int sta_info_insert_rcu(struct sta_info *sta) __acquires(RCU); 776 777 int __must_check __sta_info_destroy(struct sta_info *sta); 778 int sta_info_destroy_addr(struct ieee80211_sub_if_data *sdata, 779 const u8 *addr); 780 int sta_info_destroy_addr_bss(struct ieee80211_sub_if_data *sdata, 781 const u8 *addr); 782 783 void sta_info_recalc_tim(struct sta_info *sta); 784 785 int sta_info_init(struct ieee80211_local *local); 786 void sta_info_stop(struct ieee80211_local *local); 787 788 /** 789 * sta_info_flush - flush matching STA entries from the STA table 790 * 791 * Returns the number of removed STA entries. 792 * 793 * @sdata: sdata to remove all stations from 794 * @vlans: if the given interface is an AP interface, also flush VLANs 795 */ 796 int __sta_info_flush(struct ieee80211_sub_if_data *sdata, bool vlans); 797 798 static inline int sta_info_flush(struct ieee80211_sub_if_data *sdata) 799 { 800 return __sta_info_flush(sdata, false); 801 } 802 803 void sta_set_rate_info_tx(struct sta_info *sta, 804 const struct ieee80211_tx_rate *rate, 805 struct rate_info *rinfo); 806 void sta_set_sinfo(struct sta_info *sta, struct station_info *sinfo, 807 bool tidstats); 808 809 u32 sta_get_expected_throughput(struct sta_info *sta); 810 811 void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata, 812 unsigned long exp_time); 813 u8 sta_info_tx_streams(struct sta_info *sta); 814 815 void ieee80211_sta_ps_deliver_wakeup(struct sta_info *sta); 816 void ieee80211_sta_ps_deliver_poll_response(struct sta_info *sta); 817 void ieee80211_sta_ps_deliver_uapsd(struct sta_info *sta); 818 819 unsigned long ieee80211_sta_last_active(struct sta_info *sta); 820 821 enum sta_stats_type { 822 STA_STATS_RATE_TYPE_INVALID = 0, 823 STA_STATS_RATE_TYPE_LEGACY, 824 STA_STATS_RATE_TYPE_HT, 825 STA_STATS_RATE_TYPE_VHT, 826 STA_STATS_RATE_TYPE_HE, 827 }; 828 829 #define STA_STATS_FIELD_HT_MCS GENMASK( 7, 0) 830 #define STA_STATS_FIELD_LEGACY_IDX GENMASK( 3, 0) 831 #define STA_STATS_FIELD_LEGACY_BAND GENMASK( 7, 4) 832 #define STA_STATS_FIELD_VHT_MCS GENMASK( 3, 0) 833 #define STA_STATS_FIELD_VHT_NSS GENMASK( 7, 4) 834 #define STA_STATS_FIELD_HE_MCS GENMASK( 3, 0) 835 #define STA_STATS_FIELD_HE_NSS GENMASK( 7, 4) 836 #define STA_STATS_FIELD_BW GENMASK(11, 8) 837 #define STA_STATS_FIELD_SGI GENMASK(12, 12) 838 #define STA_STATS_FIELD_TYPE GENMASK(15, 13) 839 #define STA_STATS_FIELD_HE_RU GENMASK(18, 16) 840 #define STA_STATS_FIELD_HE_GI GENMASK(20, 19) 841 #define STA_STATS_FIELD_HE_DCM GENMASK(21, 21) 842 843 #define STA_STATS_FIELD(_n, _v) FIELD_PREP(STA_STATS_FIELD_ ## _n, _v) 844 #define STA_STATS_GET(_n, _v) FIELD_GET(STA_STATS_FIELD_ ## _n, _v) 845 846 #define STA_STATS_RATE_INVALID 0 847 848 static inline u32 sta_stats_encode_rate(struct ieee80211_rx_status *s) 849 { 850 u32 r; 851 852 r = STA_STATS_FIELD(BW, s->bw); 853 854 if (s->enc_flags & RX_ENC_FLAG_SHORT_GI) 855 r |= STA_STATS_FIELD(SGI, 1); 856 857 switch (s->encoding) { 858 case RX_ENC_VHT: 859 r |= STA_STATS_FIELD(TYPE, STA_STATS_RATE_TYPE_VHT); 860 r |= STA_STATS_FIELD(VHT_NSS, s->nss); 861 r |= STA_STATS_FIELD(VHT_MCS, s->rate_idx); 862 break; 863 case RX_ENC_HT: 864 r |= STA_STATS_FIELD(TYPE, STA_STATS_RATE_TYPE_HT); 865 r |= STA_STATS_FIELD(HT_MCS, s->rate_idx); 866 break; 867 case RX_ENC_LEGACY: 868 r |= STA_STATS_FIELD(TYPE, STA_STATS_RATE_TYPE_LEGACY); 869 r |= STA_STATS_FIELD(LEGACY_BAND, s->band); 870 r |= STA_STATS_FIELD(LEGACY_IDX, s->rate_idx); 871 break; 872 case RX_ENC_HE: 873 r |= STA_STATS_FIELD(TYPE, STA_STATS_RATE_TYPE_HE); 874 r |= STA_STATS_FIELD(HE_NSS, s->nss); 875 r |= STA_STATS_FIELD(HE_MCS, s->rate_idx); 876 r |= STA_STATS_FIELD(HE_GI, s->he_gi); 877 r |= STA_STATS_FIELD(HE_RU, s->he_ru); 878 r |= STA_STATS_FIELD(HE_DCM, s->he_dcm); 879 break; 880 default: 881 WARN_ON(1); 882 return STA_STATS_RATE_INVALID; 883 } 884 885 return r; 886 } 887 888 #endif /* STA_INFO_H */ 889