net/mac80211/sta_info.h

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