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