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