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