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  */
  59 enum ieee80211_sta_info_flags {
  60         WLAN_STA_AUTH,
  61         WLAN_STA_ASSOC,
  62         WLAN_STA_PS_STA,
  63         WLAN_STA_AUTHORIZED,
  64         WLAN_STA_SHORT_PREAMBLE,
  65         WLAN_STA_WME,
  66         WLAN_STA_WDS,
  67         WLAN_STA_CLEAR_PS_FILT,
  68         WLAN_STA_MFP,
  69         WLAN_STA_BLOCK_BA,
  70         WLAN_STA_PS_DRIVER,
  71         WLAN_STA_PSPOLL,
  72         WLAN_STA_TDLS_PEER,
  73         WLAN_STA_TDLS_PEER_AUTH,
  74         WLAN_STA_UAPSD,
  75         WLAN_STA_SP,
  76         WLAN_STA_4ADDR_EVENT,
  77         WLAN_STA_INSERTED,
  78         WLAN_STA_RATE_CONTROL,
  79 };
  80
  81 #define STA_TID_NUM 16
  82 #define ADDBA_RESP_INTERVAL HZ
  83 #define HT_AGG_MAX_RETRIES              15
  84 #define HT_AGG_BURST_RETRIES            3
  85 #define HT_AGG_RETRIES_PERIOD           (15 * HZ)
  86
  87 #define HT_AGG_STATE_DRV_READY          0
  88 #define HT_AGG_STATE_RESPONSE_RECEIVED  1
  89 #define HT_AGG_STATE_OPERATIONAL        2
  90 #define HT_AGG_STATE_STOPPING           3
  91 #define HT_AGG_STATE_WANT_START         4
  92 #define HT_AGG_STATE_WANT_STOP          5
  93
  94 /**
  95  * struct tid_ampdu_tx - TID aggregation information (Tx).
  96  *
  97  * @rcu_head: rcu head for freeing structure
  98  * @session_timer: check if we keep Tx-ing on the TID (by timeout value)
  99  * @addba_resp_timer: timer for peer's response to addba request
 100  * @pending: pending frames queue -- use sta's spinlock to protect
 101  * @dialog_token: dialog token for aggregation session
 102  * @timeout: session timeout value to be filled in ADDBA requests
 103  * @state: session state (see above)
 104  * @stop_initiator: initiator of a session stop
 105  * @tx_stop: TX DelBA frame when stopping
 106  * @buf_size: reorder buffer size at receiver
 107  * @failed_bar_ssn: ssn of the last failed BAR tx attempt
 108  * @bar_pending: BAR needs to be re-sent
 109  *
 110  * This structure's lifetime is managed by RCU, assignments to
 111  * the array holding it must hold the aggregation mutex.
 112  *
 113  * The TX path can access it under RCU lock-free if, and
 114  * only if, the state has the flag %HT_AGG_STATE_OPERATIONAL
 115  * set. Otherwise, the TX path must also acquire the spinlock
 116  * and re-check the state, see comments in the tx code
 117  * touching it.
 118  */
 119 struct tid_ampdu_tx {
 120         struct rcu_head rcu_head;
 121         struct timer_list session_timer;
 122         struct timer_list addba_resp_timer;
 123         struct sk_buff_head pending;
 124         unsigned long state;
 125         u16 timeout;
 126         u8 dialog_token;
 127         u8 stop_initiator;
 128         bool tx_stop;
 129         u8 buf_size;
 130
 131         u16 failed_bar_ssn;
 132         bool bar_pending;
 133 };
 134
 135 /**
 136  * struct tid_ampdu_rx - TID aggregation information (Rx).
 137  *
 138  * @reorder_buf: buffer to reorder incoming aggregated MPDUs
 139  * @reorder_time: jiffies when skb was added
 140  * @session_timer: check if peer keeps Tx-ing on the TID (by timeout value)
 141  * @reorder_timer: releases expired frames from the reorder buffer.
 142  * @head_seq_num: head sequence number in reordering buffer.
 143  * @stored_mpdu_num: number of MPDUs in reordering buffer
 144  * @ssn: Starting Sequence Number expected to be aggregated.
 145  * @buf_size: buffer size for incoming A-MPDUs
 146  * @timeout: reset timer value (in TUs).
 147  * @dialog_token: dialog token for aggregation session
 148  * @rcu_head: RCU head used for freeing this struct
 149  * @reorder_lock: serializes access to reorder buffer, see below.
 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 @reorder_lock is used to protect the members of this
 155  * struct, except for @timeout, @buf_size and @dialog_token,
 156  * which are constant across the lifetime of the struct (the
 157  * dialog token being used only for debugging).
 158  */
 159 struct tid_ampdu_rx {
 160         struct rcu_head rcu_head;
 161         spinlock_t reorder_lock;
 162         struct sk_buff **reorder_buf;
 163         unsigned long *reorder_time;
 164         struct timer_list session_timer;
 165         struct timer_list reorder_timer;
 166         u16 head_seq_num;
 167         u16 stored_mpdu_num;
 168         u16 ssn;
 169         u16 buf_size;
 170         u16 timeout;
 171         u8 dialog_token;
 172 };
 173
 174 /**
 175  * struct sta_ampdu_mlme - STA aggregation information.
 176  *
 177  * @tid_rx: aggregation info for Rx per TID -- RCU protected
 178  * @tid_tx: aggregation info for Tx per TID
 179  * @tid_start_tx: sessions where start was requested
 180  * @addba_req_num: number of times addBA request has been sent.
 181  * @last_addba_req_time: timestamp of the last addBA request.
 182  * @dialog_token_allocator: dialog token enumerator for each new session;
 183  * @work: work struct for starting/stopping aggregation
 184  * @tid_rx_timer_expired: bitmap indicating on which TIDs the
 185  *      RX timer expired until the work for it runs
 186  * @tid_rx_stop_requested:  bitmap indicating which BA sessions per TID the
 187  *      driver requested to close until the work for it runs
 188  * @mtx: mutex to protect all TX data (except non-NULL assignments
 189  *      to tid_tx[idx], which are protected by the sta spinlock)
 190  */
 191 struct sta_ampdu_mlme {
 192         struct mutex mtx;
 193         /* rx */
 194         struct tid_ampdu_rx __rcu *tid_rx[STA_TID_NUM];
 195         unsigned long tid_rx_timer_expired[BITS_TO_LONGS(STA_TID_NUM)];
 196         unsigned long tid_rx_stop_requested[BITS_TO_LONGS(STA_TID_NUM)];
 197         /* tx */
 198         struct work_struct work;
 199         struct tid_ampdu_tx __rcu *tid_tx[STA_TID_NUM];
 200         struct tid_ampdu_tx *tid_start_tx[STA_TID_NUM];
 201         unsigned long last_addba_req_time[STA_TID_NUM];
 202         u8 addba_req_num[STA_TID_NUM];
 203         u8 dialog_token_allocator;
 204 };
 205
 206
 207 /**
 208  * struct sta_info - STA information
 209  *
 210  * This structure collects information about a station that
 211  * mac80211 is communicating with.
 212  *
 213  * @list: global linked list entry
 214  * @hnext: hash table linked list pointer
 215  * @local: pointer to the global information
 216  * @sdata: virtual interface this station belongs to
 217  * @ptk: peer key negotiated with this station, if any
 218  * @gtk: group keys negotiated with this station, if any
 219  * @rate_ctrl: rate control algorithm reference
 220  * @rate_ctrl_priv: rate control private per-STA pointer
 221  * @last_tx_rate: rate used for last transmit, to report to userspace as
 222  *      "the" transmit rate
 223  * @last_rx_rate_idx: rx status rate index of the last data packet
 224  * @last_rx_rate_flag: rx status flag of the last data packet
 225  * @lock: used for locking all fields that require locking, see comments
 226  *      in the header file.
 227  * @drv_unblock_wk: used for driver PS unblocking
 228  * @listen_interval: listen interval of this station, when we're acting as AP
 229  * @_flags: STA flags, see &enum ieee80211_sta_info_flags, do not use directly
 230  * @ps_tx_buf: buffers (per AC) of frames to transmit to this station
 231  *      when it leaves power saving state or polls
 232  * @tx_filtered: buffers (per AC) of frames we already tried to
 233  *      transmit but were filtered by hardware due to STA having
 234  *      entered power saving state, these are also delivered to
 235  *      the station when it leaves powersave or polls for frames
 236  * @driver_buffered_tids: bitmap of TIDs the driver has data buffered on
 237  * @rx_packets: Number of MSDUs received from this STA
 238  * @rx_bytes: Number of bytes received from this STA
 239  * @wep_weak_iv_count: number of weak WEP IVs received from this station
 240  * @last_rx: time (in jiffies) when last frame was received from this STA
 241  * @last_connected: time (in seconds) when a station got connected
 242  * @num_duplicates: number of duplicate frames received from this STA
 243  * @rx_fragments: number of received MPDUs
 244  * @rx_dropped: number of dropped MPDUs from this STA
 245  * @last_signal: signal of last received frame from this STA
 246  * @avg_signal: moving average of signal of received frames from this STA
 247  * @last_seq_ctrl: last received seq/frag number from this STA (per RX queue)
 248  * @tx_filtered_count: number of frames the hardware filtered for this STA
 249  * @tx_retry_failed: number of frames that failed retry
 250  * @tx_retry_count: total number of retries for frames to this STA
 251  * @fail_avg: moving percentage of failed MSDUs
 252  * @tx_packets: number of RX/TX MSDUs
 253  * @tx_bytes: number of bytes transmitted to this STA
 254  * @tx_fragments: number of transmitted MPDUs
 255  * @tid_seq: per-TID sequence numbers for sending to this STA
 256  * @ampdu_mlme: A-MPDU state machine state
 257  * @timer_to_tid: identity mapping to ID timers
 258  * @llid: Local link ID
 259  * @plid: Peer link ID
 260  * @reason: Cancel reason on PLINK_HOLDING state
 261  * @plink_retries: Retries in establishment
 262  * @ignore_plink_timer: ignore the peer-link timer (used internally)
 263  * @plink_state: peer link state
 264  * @plink_timeout: timeout of peer link
 265  * @plink_timer: peer link watch timer
 266  * @plink_timer_was_running: used by suspend/resume to restore timers
 267  * @debugfs: debug filesystem info
 268  * @dead: set to true when sta is unlinked
 269  * @uploaded: set to true when sta is uploaded to the driver
 270  * @lost_packets: number of consecutive lost packets
 271  * @sta: station information we share with the driver
 272  * @sta_state: duplicates information about station state (for debug)
 273  * @beacon_loss_count: number of times beacon loss has triggered
 274  */
 275 struct sta_info {
 276         /* General information, mostly static */
 277         struct list_head list;
 278         struct sta_info __rcu *hnext;
 279         struct ieee80211_local *local;
 280         struct ieee80211_sub_if_data *sdata;
 281         struct ieee80211_key __rcu *gtk[NUM_DEFAULT_KEYS + NUM_DEFAULT_MGMT_KEYS];
 282         struct ieee80211_key __rcu *ptk;
 283         struct rate_control_ref *rate_ctrl;
 284         void *rate_ctrl_priv;
 285         spinlock_t lock;
 286
 287         struct work_struct drv_unblock_wk;
 288
 289         u16 listen_interval;
 290
 291         bool dead;
 292
 293         bool uploaded;
 294
 295         enum ieee80211_sta_state sta_state;
 296
 297         /* use the accessors defined below */
 298         unsigned long _flags;
 299
 300         /*
 301          * STA powersave frame queues, no more than the internal
 302          * locking required.
 303          */
 304         struct sk_buff_head ps_tx_buf[IEEE80211_NUM_ACS];
 305         struct sk_buff_head tx_filtered[IEEE80211_NUM_ACS];
 306         unsigned long driver_buffered_tids;
 307
 308         /* Updated from RX path only, no locking requirements */
 309         unsigned long rx_packets, rx_bytes;
 310         unsigned long wep_weak_iv_count;
 311         unsigned long last_rx;
 312         long last_connected;
 313         unsigned long num_duplicates;
 314         unsigned long rx_fragments;
 315         unsigned long rx_dropped;
 316         int last_signal;
 317         struct ewma avg_signal;
 318         /* Plus 1 for non-QoS frames */
 319         __le16 last_seq_ctrl[NUM_RX_DATA_QUEUES + 1];
 320
 321         /* Updated from TX status path only, no locking requirements */
 322         unsigned long tx_filtered_count;
 323         unsigned long tx_retry_failed, tx_retry_count;
 324         /* moving percentage of failed MSDUs */
 325         unsigned int fail_avg;
 326
 327         /* Updated from TX path only, no locking requirements */
 328         unsigned long tx_packets;
 329         unsigned long tx_bytes;
 330         unsigned long tx_fragments;
 331         struct ieee80211_tx_rate last_tx_rate;
 332         int last_rx_rate_idx;
 333         int last_rx_rate_flag;
 334         u16 tid_seq[IEEE80211_QOS_CTL_TID_MASK + 1];
 335
 336         /*
 337          * Aggregation information, locked with lock.
 338          */
 339         struct sta_ampdu_mlme ampdu_mlme;
 340         u8 timer_to_tid[STA_TID_NUM];
 341
 342 #ifdef CONFIG_MAC80211_MESH
 343         /*
 344          * Mesh peer link attributes
 345          * TODO: move to a sub-structure that is referenced with pointer?
 346          */
 347         __le16 llid;
 348         __le16 plid;
 349         __le16 reason;
 350         u8 plink_retries;
 351         bool ignore_plink_timer;
 352         bool plink_timer_was_running;
 353         enum nl80211_plink_state plink_state;
 354         u32 plink_timeout;
 355         struct timer_list plink_timer;
 356 #endif
 357
 358 #ifdef CONFIG_MAC80211_DEBUGFS
 359         struct sta_info_debugfsdentries {
 360                 struct dentry *dir;
 361                 bool add_has_run;
 362         } debugfs;
 363 #endif
 364
 365         unsigned int lost_packets;
 366         unsigned int beacon_loss_count;
 367
 368         /* keep last! */
 369         struct ieee80211_sta sta;
 370 };
 371
 372 static inline enum nl80211_plink_state sta_plink_state(struct sta_info *sta)
 373 {
 374 #ifdef CONFIG_MAC80211_MESH
 375         return sta->plink_state;
 376 #endif
 377         return NL80211_PLINK_LISTEN;
 378 }
 379
 380 static inline void set_sta_flag(struct sta_info *sta,
 381                                 enum ieee80211_sta_info_flags flag)
 382 {
 383         WARN_ON(flag == WLAN_STA_AUTH ||
 384                 flag == WLAN_STA_ASSOC ||
 385                 flag == WLAN_STA_AUTHORIZED);
 386         set_bit(flag, &sta->_flags);
 387 }
 388
 389 static inline void clear_sta_flag(struct sta_info *sta,
 390                                   enum ieee80211_sta_info_flags flag)
 391 {
 392         WARN_ON(flag == WLAN_STA_AUTH ||
 393                 flag == WLAN_STA_ASSOC ||
 394                 flag == WLAN_STA_AUTHORIZED);
 395         clear_bit(flag, &sta->_flags);
 396 }
 397
 398 static inline int test_sta_flag(struct sta_info *sta,
 399                                 enum ieee80211_sta_info_flags flag)
 400 {
 401         return test_bit(flag, &sta->_flags);
 402 }
 403
 404 static inline int test_and_clear_sta_flag(struct sta_info *sta,
 405                                           enum ieee80211_sta_info_flags flag)
 406 {
 407         WARN_ON(flag == WLAN_STA_AUTH ||
 408                 flag == WLAN_STA_ASSOC ||
 409                 flag == WLAN_STA_AUTHORIZED);
 410         return test_and_clear_bit(flag, &sta->_flags);
 411 }
 412
 413 static inline int test_and_set_sta_flag(struct sta_info *sta,
 414                                         enum ieee80211_sta_info_flags flag)
 415 {
 416         WARN_ON(flag == WLAN_STA_AUTH ||
 417                 flag == WLAN_STA_ASSOC ||
 418                 flag == WLAN_STA_AUTHORIZED);
 419         return test_and_set_bit(flag, &sta->_flags);
 420 }
 421
 422 int sta_info_move_state(struct sta_info *sta,
 423                         enum ieee80211_sta_state new_state);
 424
 425 static inline void sta_info_pre_move_state(struct sta_info *sta,
 426                                            enum ieee80211_sta_state new_state)
 427 {
 428         int ret;
 429
 430         WARN_ON_ONCE(test_sta_flag(sta, WLAN_STA_INSERTED));
 431
 432         ret = sta_info_move_state(sta, new_state);
 433         WARN_ON_ONCE(ret);
 434 }
 435
 436
 437 void ieee80211_assign_tid_tx(struct sta_info *sta, int tid,
 438                              struct tid_ampdu_tx *tid_tx);
 439
 440 static inline struct tid_ampdu_tx *
 441 rcu_dereference_protected_tid_tx(struct sta_info *sta, int tid)
 442 {
 443         return rcu_dereference_protected(sta->ampdu_mlme.tid_tx[tid],
 444                                          lockdep_is_held(&sta->lock) ||
 445                                          lockdep_is_held(&sta->ampdu_mlme.mtx));
 446 }
 447
 448 #define STA_HASH_SIZE 256
 449 #define STA_HASH(sta) (sta[5])
 450
 451
 452 /* Maximum number of frames to buffer per power saving station per AC */
 453 #define STA_MAX_TX_BUFFER       64
 454
 455 /* Minimum buffered frame expiry time. If STA uses listen interval that is
 456  * smaller than this value, the minimum value here is used instead. */
 457 #define STA_TX_BUFFER_EXPIRE (10 * HZ)
 458
 459 /* How often station data is cleaned up (e.g., expiration of buffered frames)
 460  */
 461 #define STA_INFO_CLEANUP_INTERVAL (10 * HZ)
 462
 463 /*
 464  * Get a STA info, must be under RCU read lock.
 465  */
 466 struct sta_info *sta_info_get(struct ieee80211_sub_if_data *sdata,
 467                               const u8 *addr);
 468
 469 struct sta_info *sta_info_get_bss(struct ieee80211_sub_if_data *sdata,
 470                                   const u8 *addr);
 471
 472 static inline
 473 void for_each_sta_info_type_check(struct ieee80211_local *local,
 474                                   const u8 *addr,
 475                                   struct sta_info *sta,
 476                                   struct sta_info *nxt)
 477 {
 478 }
 479
 480 #define for_each_sta_info(local, _addr, _sta, nxt)                      \
 481         for (   /* initialise loop */                                   \
 482                 _sta = rcu_dereference(local->sta_hash[STA_HASH(_addr)]),\
 483                 nxt = _sta ? rcu_dereference(_sta->hnext) : NULL;       \
 484                 /* typecheck */                                         \
 485                 for_each_sta_info_type_check(local, (_addr), _sta, nxt),\
 486                 /* continue condition */                                \
 487                 _sta;                                                   \
 488                 /* advance loop */                                      \
 489                 _sta = nxt,                                             \
 490                 nxt = _sta ? rcu_dereference(_sta->hnext) : NULL        \
 491              )                                                          \
 492         /* compare address and run code only if it matches */           \
 493         if (compare_ether_addr(_sta->sta.addr, (_addr)) == 0)
 494
 495 /*
 496  * Get STA info by index, BROKEN!
 497  */
 498 struct sta_info *sta_info_get_by_idx(struct ieee80211_sub_if_data *sdata,
 499                                      int idx);
 500 /*
 501  * Create a new STA info, caller owns returned structure
 502  * until sta_info_insert().
 503  */
 504 struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
 505                                 const u8 *addr, gfp_t gfp);
 506
 507 void sta_info_free(struct ieee80211_local *local, struct sta_info *sta);
 508
 509 /*
 510  * Insert STA info into hash table/list, returns zero or a
 511  * -EEXIST if (if the same MAC address is already present).
 512  *
 513  * Calling the non-rcu version makes the caller relinquish,
 514  * the _rcu version calls read_lock_rcu() and must be called
 515  * without it held.
 516  */
 517 int sta_info_insert(struct sta_info *sta);
 518 int sta_info_insert_rcu(struct sta_info *sta) __acquires(RCU);
 519
 520 int __must_check __sta_info_destroy(struct sta_info *sta);
 521 int sta_info_destroy_addr(struct ieee80211_sub_if_data *sdata,
 522                           const u8 *addr);
 523 int sta_info_destroy_addr_bss(struct ieee80211_sub_if_data *sdata,
 524                               const u8 *addr);
 525
 526 void sta_info_recalc_tim(struct sta_info *sta);
 527
 528 void sta_info_init(struct ieee80211_local *local);
 529 void sta_info_stop(struct ieee80211_local *local);
 530 int sta_info_flush(struct ieee80211_local *local,
 531                    struct ieee80211_sub_if_data *sdata);
 532 void sta_set_rate_info_tx(struct sta_info *sta,
 533                           const struct ieee80211_tx_rate *rate,
 534                           struct rate_info *rinfo);
 535 void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata,
 536                           unsigned long exp_time);
 537
 538 void ieee80211_sta_ps_deliver_wakeup(struct sta_info *sta);
 539 void ieee80211_sta_ps_deliver_poll_response(struct sta_info *sta);
 540 void ieee80211_sta_ps_deliver_uapsd(struct sta_info *sta);
 541
 542 #endif /* STA_INFO_H */