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