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