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 "ieee80211_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_TXCTL_CLEAR_PS_FILT control flag) when the next
  36  *      frame to this station is transmitted.
  37  */
  38 enum ieee80211_sta_info_flags {
  39         WLAN_STA_AUTH           = 1<<0,
  40         WLAN_STA_ASSOC          = 1<<1,
  41         WLAN_STA_PS             = 1<<2,
  42         WLAN_STA_AUTHORIZED     = 1<<3,
  43         WLAN_STA_SHORT_PREAMBLE = 1<<4,
  44         WLAN_STA_ASSOC_AP       = 1<<5,
  45         WLAN_STA_WME            = 1<<6,
  46         WLAN_STA_WDS            = 1<<7,
  47         WLAN_STA_PSPOLL         = 1<<8,
  48         WLAN_STA_CLEAR_PS_FILT  = 1<<9,
  49 };
  50
  51 #define STA_TID_NUM 16
  52 #define ADDBA_RESP_INTERVAL HZ
  53 #define HT_AGG_MAX_RETRIES              (0x3)
  54
  55 #define HT_AGG_STATE_INITIATOR_SHIFT    (4)
  56
  57 #define HT_ADDBA_REQUESTED_MSK          BIT(0)
  58 #define HT_ADDBA_DRV_READY_MSK          BIT(1)
  59 #define HT_ADDBA_RECEIVED_MSK           BIT(2)
  60 #define HT_AGG_STATE_REQ_STOP_BA_MSK    BIT(3)
  61 #define HT_AGG_STATE_INITIATOR_MSK      BIT(HT_AGG_STATE_INITIATOR_SHIFT)
  62 #define HT_AGG_STATE_IDLE               (0x0)
  63 #define HT_AGG_STATE_OPERATIONAL        (HT_ADDBA_REQUESTED_MSK |       \
  64                                          HT_ADDBA_DRV_READY_MSK |       \
  65                                          HT_ADDBA_RECEIVED_MSK)
  66
  67 /**
  68  * struct tid_ampdu_tx - TID aggregation information (Tx).
  69  *
  70  * @state: TID's state in session state machine.
  71  * @dialog_token: dialog token for aggregation session
  72  * @ssn: Starting Sequence Number expected to be aggregated.
  73  * @addba_resp_timer: timer for peer's response to addba request
  74  * @addba_req_num: number of times addBA request has been sent.
  75  */
  76 struct tid_ampdu_tx {
  77         u8 state;
  78         u8 dialog_token;
  79         u16 ssn;
  80         struct timer_list addba_resp_timer;
  81         u8 addba_req_num;
  82 };
  83
  84 /**
  85  * struct tid_ampdu_rx - TID aggregation information (Rx).
  86  *
  87  * @state: TID's state in session state machine.
  88  * @dialog_token: dialog token for aggregation session
  89  * @ssn: Starting Sequence Number expected to be aggregated.
  90  * @buf_size: buffer size for incoming A-MPDUs
  91  * @timeout: reset timer value.
  92  * @head_seq_num: head sequence number in reordering buffer.
  93  * @stored_mpdu_num: number of MPDUs in reordering buffer
  94  * @reorder_buf: buffer to reorder incoming aggregated MPDUs
  95  * @session_timer: check if peer keeps Tx-ing on the TID (by timeout value)
  96  */
  97 struct tid_ampdu_rx {
  98         u8 state;
  99         u8 dialog_token;
 100         u16 ssn;
 101         u16 buf_size;
 102         u16 timeout;
 103         u16 head_seq_num;
 104         u16 stored_mpdu_num;
 105         struct sk_buff **reorder_buf;
 106         struct timer_list session_timer;
 107 };
 108
 109 /**
 110  * enum plink_state - state of a mesh peer link finite state machine
 111  *
 112  * @PLINK_LISTEN: initial state, considered the implicit state of non existant
 113  *      mesh peer links
 114  * @PLINK_OPN_SNT: mesh plink open frame has been sent to this mesh peer
 115  * @PLINK_OPN_RCVD: mesh plink open frame has been received from this mesh peer
 116  * @PLINK_CNF_RCVD: mesh plink confirm frame has been received from this mesh
 117  *      peer
 118  * @PLINK_ESTAB: mesh peer link is established
 119  * @PLINK_HOLDING: mesh peer link is being closed or cancelled
 120  * @PLINK_BLOCKED: all frames transmitted from this mesh plink are discarded
 121  */
 122 enum plink_state {
 123         PLINK_LISTEN,
 124         PLINK_OPN_SNT,
 125         PLINK_OPN_RCVD,
 126         PLINK_CNF_RCVD,
 127         PLINK_ESTAB,
 128         PLINK_HOLDING,
 129         PLINK_BLOCKED
 130 };
 131
 132 /**
 133  * struct sta_ampdu_mlme - STA aggregation information.
 134  *
 135  * @tid_rx: aggregation info for Rx per TID
 136  * @tid_tx: aggregation info for Tx per TID
 137  * @ampdu_rx: for locking sections in aggregation Rx flow
 138  * @ampdu_tx: for locking sectionsi in aggregation Tx flow
 139  * @dialog_token_allocator: dialog token enumerator for each new session;
 140  */
 141 struct sta_ampdu_mlme {
 142         struct tid_ampdu_rx tid_rx[STA_TID_NUM];
 143         struct tid_ampdu_tx tid_tx[STA_TID_NUM];
 144         spinlock_t ampdu_rx;
 145         spinlock_t ampdu_tx;
 146         u8 dialog_token_allocator;
 147 };
 148
 149
 150 /* see __sta_info_unlink */
 151 #define STA_INFO_PIN_STAT_NORMAL        0
 152 #define STA_INFO_PIN_STAT_PINNED        1
 153 #define STA_INFO_PIN_STAT_DESTROY       2
 154
 155 /**
 156  * struct sta_info - STA information
 157  *
 158  * This structure collects information about a station that
 159  * mac80211 is communicating with.
 160  *
 161  * @list: global linked list entry
 162  * @hnext: hash table linked list pointer
 163  * @local: pointer to the global information
 164  * @addr: MAC address of this STA
 165  * @aid: STA's unique AID (1..2007, 0 = not assigned yet),
 166  *      only used in AP (and IBSS?) mode
 167  * @flags: STA flags, see &enum ieee80211_sta_info_flags
 168  * @ps_tx_buf: buffer of frames to transmit to this station
 169  *      when it leaves power saving state
 170  * @tx_filtered: buffer of frames we already tried to transmit
 171  *      but were filtered by hardware due to STA having entered
 172  *      power saving state
 173  * @rx_packets: Number of MSDUs received from this STA
 174  * @rx_bytes: Number of bytes received from this STA
 175  * @supp_rates: Bitmap of supported rates (per band)
 176  * @ht_info: HT capabilities of this STA
 177  */
 178 struct sta_info {
 179         /* General information, mostly static */
 180         struct list_head list;
 181         struct sta_info *hnext;
 182         struct ieee80211_local *local;
 183         struct ieee80211_sub_if_data *sdata;
 184         struct ieee80211_key *key;
 185         struct rate_control_ref *rate_ctrl;
 186         void *rate_ctrl_priv;
 187         struct ieee80211_ht_info ht_info;
 188         u64 supp_rates[IEEE80211_NUM_BANDS];
 189         u8 addr[ETH_ALEN];
 190         u16 aid;
 191         u16 listen_interval;
 192
 193         /*
 194          * for use by the internal lifetime management,
 195          * see __sta_info_unlink
 196          */
 197         u8 pin_status;
 198
 199         /* frequently updated information, needs locking? */
 200         u32 flags;
 201
 202         /*
 203          * STA powersave frame queues, no more than the internal
 204          * locking required.
 205          */
 206         struct sk_buff_head ps_tx_buf;
 207         struct sk_buff_head tx_filtered;
 208
 209         /* Updated from RX path only, no locking requirements */
 210         unsigned long rx_packets, rx_bytes;
 211         unsigned long wep_weak_iv_count;
 212         unsigned long last_rx;
 213         unsigned long num_duplicates; /* number of duplicate frames received
 214                                        * from this STA */
 215         unsigned long rx_fragments; /* number of received MPDUs */
 216         unsigned long rx_dropped; /* number of dropped MPDUs from this STA */
 217         int last_rssi; /* RSSI of last received frame from this STA */
 218         int last_signal; /* signal of last received frame from this STA */
 219         int last_noise; /* noise of last received frame from this STA */
 220         /* last received seq/frag number from this STA (per RX queue) */
 221         __le16 last_seq_ctrl[NUM_RX_DATA_QUEUES];
 222 #ifdef CONFIG_MAC80211_DEBUG_COUNTERS
 223         unsigned int wme_rx_queue[NUM_RX_DATA_QUEUES];
 224 #endif
 225
 226         /* Updated from TX status path only, no locking requirements */
 227         unsigned long tx_filtered_count;
 228         unsigned long tx_retry_failed, tx_retry_count;
 229         /* TODO: update in generic code not rate control? */
 230         u32 tx_num_consecutive_failures;
 231         u32 tx_num_mpdu_ok;
 232         u32 tx_num_mpdu_fail;
 233         /* moving percentage of failed MSDUs */
 234         unsigned int fail_avg;
 235
 236         /* Updated from TX path only, no locking requirements */
 237         unsigned long tx_packets; /* number of RX/TX MSDUs */
 238         unsigned long tx_bytes;
 239         unsigned long tx_fragments; /* number of transmitted MPDUs */
 240         int txrate_idx;
 241         int last_txrate_idx;
 242 #ifdef CONFIG_MAC80211_DEBUG_COUNTERS
 243         unsigned int wme_tx_queue[NUM_RX_DATA_QUEUES];
 244 #endif
 245
 246         /* Debug counters, no locking doesn't matter */
 247         int channel_use;
 248         int channel_use_raw;
 249
 250         /*
 251          * Aggregation information, comes with own locking.
 252          */
 253         struct sta_ampdu_mlme ampdu_mlme;
 254         u8 timer_to_tid[STA_TID_NUM];   /* identity mapping to ID timers */
 255         u8 tid_to_tx_q[STA_TID_NUM];    /* map tid to tx queue */
 256
 257 #ifdef CONFIG_MAC80211_MESH
 258         /*
 259          * Mesh peer link attributes
 260          * TODO: move to a sub-structure that is referenced with pointer?
 261          */
 262         __le16 llid;            /* Local link ID */
 263         __le16 plid;            /* Peer link ID */
 264         __le16 reason;          /* Cancel reason on PLINK_HOLDING state */
 265         u8 plink_retries;       /* Retries in establishment */
 266         bool ignore_plink_timer;
 267         enum plink_state plink_state;
 268         u32 plink_timeout;
 269         struct timer_list plink_timer;
 270         spinlock_t plink_lock;  /* For peer_state reads / updates and other
 271                                    updates in the structure. Ensures robust
 272                                    transitions for the peerlink FSM */
 273 #endif
 274
 275 #ifdef CONFIG_MAC80211_DEBUGFS
 276         struct sta_info_debugfsdentries {
 277                 struct dentry *dir;
 278                 struct dentry *flags;
 279                 struct dentry *num_ps_buf_frames;
 280                 struct dentry *inactive_ms;
 281                 struct dentry *last_seq_ctrl;
 282 #ifdef CONFIG_MAC80211_DEBUG_COUNTERS
 283                 struct dentry *wme_rx_queue;
 284                 struct dentry *wme_tx_queue;
 285 #endif
 286                 struct dentry *agg_status;
 287         } debugfs;
 288 #endif
 289 };
 290
 291 static inline enum plink_state sta_plink_state(struct sta_info *sta)
 292 {
 293 #ifdef CONFIG_MAC80211_MESH
 294         return sta->plink_state;
 295 #endif
 296         return PLINK_LISTEN;
 297 }
 298
 299
 300 /* Maximum number of concurrently registered stations */
 301 #define MAX_STA_COUNT 2007
 302
 303 #define STA_HASH_SIZE 256
 304 #define STA_HASH(sta) (sta[5])
 305
 306
 307 /* Maximum number of frames to buffer per power saving station */
 308 #define STA_MAX_TX_BUFFER 128
 309
 310 /* Minimum buffered frame expiry time. If STA uses listen interval that is
 311  * smaller than this value, the minimum value here is used instead. */
 312 #define STA_TX_BUFFER_EXPIRE (10 * HZ)
 313
 314 /* How often station data is cleaned up (e.g., expiration of buffered frames)
 315  */
 316 #define STA_INFO_CLEANUP_INTERVAL (10 * HZ)
 317
 318 /*
 319  * Get a STA info, must have be under RCU read lock.
 320  */
 321 struct sta_info *sta_info_get(struct ieee80211_local *local, u8 *addr);
 322 /*
 323  * Get STA info by index, BROKEN!
 324  */
 325 struct sta_info *sta_info_get_by_idx(struct ieee80211_local *local, int idx,
 326                                       struct net_device *dev);
 327 /*
 328  * Create a new STA info, caller owns returned structure
 329  * until sta_info_insert().
 330  */
 331 struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
 332                                 u8 *addr, gfp_t gfp);
 333 /*
 334  * Insert STA info into hash table/list, returns zero or a
 335  * -EEXIST if (if the same MAC address is already present).
 336  *
 337  * Calling this without RCU protection makes the caller
 338  * relinquish its reference to @sta.
 339  */
 340 int sta_info_insert(struct sta_info *sta);
 341 /*
 342  * Unlink a STA info from the hash table/list.
 343  * This can NULL the STA pointer if somebody else
 344  * has already unlinked it.
 345  */
 346 void sta_info_unlink(struct sta_info **sta);
 347
 348 void sta_info_destroy(struct sta_info *sta);
 349 void sta_info_set_tim_bit(struct sta_info *sta);
 350 void sta_info_clear_tim_bit(struct sta_info *sta);
 351
 352 void sta_info_init(struct ieee80211_local *local);
 353 int sta_info_start(struct ieee80211_local *local);
 354 void sta_info_stop(struct ieee80211_local *local);
 355 int sta_info_flush(struct ieee80211_local *local,
 356                     struct ieee80211_sub_if_data *sdata);
 357
 358 #endif /* STA_INFO_H */