net/mac80211/sta_info.h

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