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