net/mac80211/sta_info.h

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