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