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