sta_info.h 13.5 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14
/*
 * Copyright 2002-2005, Devicescape Software, Inc.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */

#ifndef STA_INFO_H
#define STA_INFO_H

#include <linux/list.h>
#include <linux/types.h>
#include <linux/if_ether.h>
Johannes Berg's avatar
Johannes Berg committed
15
#include "key.h"
16

17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
/**
 * enum ieee80211_sta_info_flags - Stations flags
 *
 * These flags are used with &struct sta_info's @flags member.
 *
 * @WLAN_STA_AUTH: Station is authenticated.
 * @WLAN_STA_ASSOC: Station is associated.
 * @WLAN_STA_PS: Station is in power-save mode
 * @WLAN_STA_AUTHORIZED: Station is authorized to send/receive traffic.
 *	This bit is always checked so needs to be enabled for all stations
 *	when virtual port control is not in use.
 * @WLAN_STA_SHORT_PREAMBLE: Station is capable of receiving short-preamble
 *	frames.
 * @WLAN_STA_ASSOC_AP: We're associated to that station, it is an AP.
 * @WLAN_STA_WME: Station is a QoS-STA.
 * @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
 * @WLAN_STA_SUSPEND: Set/cleared during a suspend/resume cycle.
 *	Used to deny ADDBA requests (both TX and RX).
40 41 42 43 44
 */
enum ieee80211_sta_info_flags {
	WLAN_STA_AUTH		= 1<<0,
	WLAN_STA_ASSOC		= 1<<1,
	WLAN_STA_PS		= 1<<2,
45 46 47 48 49 50
	WLAN_STA_AUTHORIZED	= 1<<3,
	WLAN_STA_SHORT_PREAMBLE	= 1<<4,
	WLAN_STA_ASSOC_AP	= 1<<5,
	WLAN_STA_WME		= 1<<6,
	WLAN_STA_WDS		= 1<<7,
	WLAN_STA_PSPOLL		= 1<<8,
51
	WLAN_STA_CLEAR_PS_FILT	= 1<<9,
52
	WLAN_STA_MFP		= 1<<10,
53
	WLAN_STA_SUSPEND	= 1<<11
54
};
55

56 57
#define STA_TID_NUM 16
#define ADDBA_RESP_INTERVAL HZ
58
#define HT_AGG_MAX_RETRIES		(0x3)
59 60 61

#define HT_AGG_STATE_INITIATOR_SHIFT	(4)

62 63 64
#define HT_ADDBA_REQUESTED_MSK		BIT(0)
#define HT_ADDBA_DRV_READY_MSK		BIT(1)
#define HT_ADDBA_RECEIVED_MSK		BIT(2)
65
#define HT_AGG_STATE_REQ_STOP_BA_MSK	BIT(3)
66
#define HT_AGG_STATE_INITIATOR_MSK      BIT(HT_AGG_STATE_INITIATOR_SHIFT)
67
#define HT_AGG_STATE_IDLE		(0x0)
68 69 70 71 72 73 74 75
#define HT_AGG_STATE_OPERATIONAL	(HT_ADDBA_REQUESTED_MSK |	\
					 HT_ADDBA_DRV_READY_MSK |	\
					 HT_ADDBA_RECEIVED_MSK)

/**
 * struct tid_ampdu_tx - TID aggregation information (Tx).
 *
 * @addba_resp_timer: timer for peer's response to addba request
76
 * @pending: pending frames queue -- use sta's spinlock to protect
77 78
 * @ssn: Starting Sequence Number expected to be aggregated.
 * @dialog_token: dialog token for aggregation session
79 80 81
 */
struct tid_ampdu_tx {
	struct timer_list addba_resp_timer;
82
	struct sk_buff_head pending;
83 84
	u16 ssn;
	u8 dialog_token;
85
};
86 87 88 89 90 91

/**
 * struct tid_ampdu_rx - TID aggregation information (Rx).
 *
 * @reorder_buf: buffer to reorder incoming aggregated MPDUs
 * @session_timer: check if peer keeps Tx-ing on the TID (by timeout value)
92 93
 * @head_seq_num: head sequence number in reordering buffer.
 * @stored_mpdu_num: number of MPDUs in reordering buffer
94 95
 * @ssn: Starting Sequence Number expected to be aggregated.
 * @buf_size: buffer size for incoming A-MPDUs
96
 * @timeout: reset timer value (in TUs).
97
 * @dialog_token: dialog token for aggregation session
98
 * @shutdown: this session is being shut down due to STA removal
99 100 101 102
 */
struct tid_ampdu_rx {
	struct sk_buff **reorder_buf;
	struct timer_list session_timer;
103 104
	u16 head_seq_num;
	u16 stored_mpdu_num;
105 106 107 108
	u16 ssn;
	u16 buf_size;
	u16 timeout;
	u8 dialog_token;
109
	bool shutdown;
110 111
};

112 113 114 115 116 117 118 119 120 121 122 123 124
/**
 * enum plink_state - state of a mesh peer link finite state machine
 *
 * @PLINK_LISTEN: initial state, considered the implicit state of non existant
 * 	mesh peer links
 * @PLINK_OPN_SNT: mesh plink open frame has been sent to this mesh peer
 * @PLINK_OPN_RCVD: mesh plink open frame has been received from this mesh peer
 * @PLINK_CNF_RCVD: mesh plink confirm frame has been received from this mesh
 * 	peer
 * @PLINK_ESTAB: mesh peer link is established
 * @PLINK_HOLDING: mesh peer link is being closed or cancelled
 * @PLINK_BLOCKED: all frames transmitted from this mesh plink are discarded
 */
125
enum plink_state {
126 127 128 129 130 131 132
	PLINK_LISTEN,
	PLINK_OPN_SNT,
	PLINK_OPN_RCVD,
	PLINK_CNF_RCVD,
	PLINK_ESTAB,
	PLINK_HOLDING,
	PLINK_BLOCKED
133 134
};

135 136 137
/**
 * struct sta_ampdu_mlme - STA aggregation information.
 *
138
 * @tid_state_rx: TID's state in Rx session state machine.
139
 * @tid_rx: aggregation info for Rx per TID
140 141 142
 * @tid_state_tx: TID's state in Tx session state machine.
 * @tid_tx: aggregation info for Tx per TID
 * @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 147 148 149 150 151 152
	/* rx */
	u8 tid_state_rx[STA_TID_NUM];
	struct tid_ampdu_rx *tid_rx[STA_TID_NUM];
	/* tx */
	u8 tid_state_tx[STA_TID_NUM];
	struct tid_ampdu_tx *tid_tx[STA_TID_NUM];
	u8 addba_req_num[STA_TID_NUM];
153
	u8 dialog_token_allocator;
154
};
155

156 157 158 159 160 161

/* see __sta_info_unlink */
#define STA_INFO_PIN_STAT_NORMAL	0
#define STA_INFO_PIN_STAT_PINNED	1
#define STA_INFO_PIN_STAT_DESTROY	2

162 163 164 165 166 167 168 169 170
/**
 * struct sta_info - STA information
 *
 * This structure collects information about a station that
 * mac80211 is communicating with.
 *
 * @list: global linked list entry
 * @hnext: hash table linked list pointer
 * @local: pointer to the global information
171 172 173 174 175 176
 * @sdata: virtual interface this station belongs to
 * @key: peer key negotiated with this station, if any
 * @rate_ctrl: rate control algorithm reference
 * @rate_ctrl_priv: rate control private per-STA pointer
 * @last_tx_rate: rate used for last transmit, to report to userspace as
 *	"the" transmit rate
177 178 179
 * @lock: used for locking all fields that require locking, see comments
 *	in the header file.
 * @flaglock: spinlock for flags accesses
180 181
 * @listen_interval: listen interval of this station, when we're acting as AP
 * @pin_status: used internally for pinning a STA struct into memory
182 183 184 185 186 187 188 189
 * @flags: STA flags, see &enum ieee80211_sta_info_flags
 * @ps_tx_buf: buffer of frames to transmit to this station
 *	when it leaves power saving state
 * @tx_filtered: buffer of frames we already tried to transmit
 *	but were filtered by hardware due to STA having entered
 *	power saving state
 * @rx_packets: Number of MSDUs received from this STA
 * @rx_bytes: Number of bytes received from this STA
190 191
 * @wep_weak_iv_count: number of weak WEP IVs received from this station
 * @last_rx: time (in jiffies) when last frame was received from this STA
192 193 194 195 196 197 198
 * @num_duplicates: number of duplicate frames received from this STA
 * @rx_fragments: number of received MPDUs
 * @rx_dropped: number of dropped MPDUs from this STA
 * @last_signal: signal of last received frame from this STA
 * @last_qual: qual of last received frame from this STA
 * @last_noise: noise of last received frame from this STA
 * @last_seq_ctrl: last received seq/frag number from this STA (per RX queue)
199 200 201
 * @tx_filtered_count: number of frames the hardware filtered for this STA
 * @tx_retry_failed: number of frames that failed retry
 * @tx_retry_count: total number of retries for frames to this STA
202 203
 * @fail_avg: moving percentage of failed MSDUs
 * @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 207
 * @tid_seq: per-TID sequence numbers for sending to this STA
 * @ampdu_mlme: A-MPDU state machine state
208
 * @timer_to_tid: identity mapping to ID timers
209
 * @tid_to_tx_q: map tid to tx queue (invalid == negative values)
210 211 212 213
 * @llid: Local link ID
 * @plid: Peer link ID
 * @reason: Cancel reason on PLINK_HOLDING state
 * @plink_retries: Retries in establishment
214 215 216 217
 * @ignore_plink_timer: ignore the peer-link timer (used internally)
 * @plink_state: peer link state
 * @plink_timeout: timeout of peer link
 * @plink_timer: peer link watch timer
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 228 229
	struct ieee80211_key *key;
	struct rate_control_ref *rate_ctrl;
	void *rate_ctrl_priv;
230
	spinlock_t lock;
231
	spinlock_t flaglock;
232

233
	u16 listen_interval;
234

235 236 237 238 239 240
	/*
	 * for use by the internal lifetime management,
	 * see __sta_info_unlink
	 */
	u8 pin_status;

241 242 243 244
	/*
	 * frequently updated, locked with own spinlock (flaglock),
	 * use the accessors defined below
	 */
245 246 247 248 249 250 251 252 253 254 255 256 257
	u32 flags;

	/*
	 * STA powersave frame queues, no more than the internal
	 * locking required.
	 */
	struct sk_buff_head ps_tx_buf;
	struct sk_buff_head tx_filtered;

	/* Updated from RX path only, no locking requirements */
	unsigned long rx_packets, rx_bytes;
	unsigned long wep_weak_iv_count;
	unsigned long last_rx;
258 259 260 261 262 263
	unsigned long num_duplicates;
	unsigned long rx_fragments;
	unsigned long rx_dropped;
	int last_signal;
	int last_qual;
	int last_noise;
264 265 266 267 268 269 270 271 272
	__le16 last_seq_ctrl[NUM_RX_DATA_QUEUES];

	/* Updated from TX status path only, no locking requirements */
	unsigned long tx_filtered_count;
	unsigned long tx_retry_failed, tx_retry_count;
	/* moving percentage of failed MSDUs */
	unsigned int fail_avg;

	/* 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
	s8 tid_to_tx_q[STA_TID_NUM];
285

286
#ifdef CONFIG_MAC80211_MESH
287 288 289 290
	/*
	 * Mesh peer link attributes
	 * TODO: move to a sub-structure that is referenced with pointer?
	 */
291 292 293 294
	__le16 llid;
	__le16 plid;
	__le16 reason;
	u8 plink_retries;
295
	bool ignore_plink_timer;
296 297 298 299
	enum plink_state plink_state;
	u32 plink_timeout;
	struct timer_list plink_timer;
#endif
300

301 302 303 304 305 306 307
#ifdef CONFIG_MAC80211_DEBUGFS
	struct sta_info_debugfsdentries {
		struct dentry *dir;
		struct dentry *flags;
		struct dentry *num_ps_buf_frames;
		struct dentry *inactive_ms;
		struct dentry *last_seq_ctrl;
308
		struct dentry *agg_status;
Johannes Berg's avatar
Johannes Berg committed
309
		bool add_has_run;
310 311
	} debugfs;
#endif
312 313 314

	/* keep last! */
	struct ieee80211_sta sta;
315 316
};

317 318 319 320 321
static inline enum plink_state sta_plink_state(struct sta_info *sta)
{
#ifdef CONFIG_MAC80211_MESH
	return sta->plink_state;
#endif
322
	return PLINK_LISTEN;
323 324
}

325 326
static inline void set_sta_flags(struct sta_info *sta, const u32 flags)
{
327 328 329
	unsigned long irqfl;

	spin_lock_irqsave(&sta->flaglock, irqfl);
330
	sta->flags |= flags;
331
	spin_unlock_irqrestore(&sta->flaglock, irqfl);
332 333 334 335
}

static inline void clear_sta_flags(struct sta_info *sta, const u32 flags)
{
336 337 338
	unsigned long irqfl;

	spin_lock_irqsave(&sta->flaglock, irqfl);
339
	sta->flags &= ~flags;
340
	spin_unlock_irqrestore(&sta->flaglock, irqfl);
341 342 343 344 345
}

static inline void set_and_clear_sta_flags(struct sta_info *sta,
					   const u32 set, const u32 clear)
{
346 347 348
	unsigned long irqfl;

	spin_lock_irqsave(&sta->flaglock, irqfl);
349 350
	sta->flags |= set;
	sta->flags &= ~clear;
351
	spin_unlock_irqrestore(&sta->flaglock, irqfl);
352 353 354 355 356
}

static inline u32 test_sta_flags(struct sta_info *sta, const u32 flags)
{
	u32 ret;
357
	unsigned long irqfl;
358

359
	spin_lock_irqsave(&sta->flaglock, irqfl);
360
	ret = sta->flags & flags;
361
	spin_unlock_irqrestore(&sta->flaglock, irqfl);
362 363 364 365 366 367 368 369

	return ret;
}

static inline u32 test_and_clear_sta_flags(struct sta_info *sta,
					   const u32 flags)
{
	u32 ret;
370
	unsigned long irqfl;
371

372
	spin_lock_irqsave(&sta->flaglock, irqfl);
373 374
	ret = sta->flags & flags;
	sta->flags &= ~flags;
375
	spin_unlock_irqrestore(&sta->flaglock, irqfl);
376 377 378 379 380 381 382

	return ret;
}

static inline u32 get_sta_flags(struct sta_info *sta)
{
	u32 ret;
383
	unsigned long irqfl;
384

385
	spin_lock_irqsave(&sta->flaglock, irqfl);
386
	ret = sta->flags;
387
	spin_unlock_irqrestore(&sta->flaglock, irqfl);
388 389 390 391

	return ret;
}

392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408


#define STA_HASH_SIZE 256
#define STA_HASH(sta) (sta[5])


/* Maximum number of frames to buffer per power saving station */
#define STA_MAX_TX_BUFFER 128

/* Minimum buffered frame expiry time. If STA uses listen interval that is
 * smaller than this value, the minimum value here is used instead. */
#define STA_TX_BUFFER_EXPIRE (10 * HZ)

/* How often station data is cleaned up (e.g., expiration of buffered frames)
 */
#define STA_INFO_CLEANUP_INTERVAL (10 * HZ)

409 410 411
/*
 * Get a STA info, must have be under RCU read lock.
 */
412
struct sta_info *sta_info_get(struct ieee80211_local *local, const u8 *addr);
413 414 415
/*
 * Get STA info by index, BROKEN!
 */
416 417
struct sta_info *sta_info_get_by_idx(struct ieee80211_local *local, int idx,
				      struct net_device *dev);
418
/*
Johannes Berg's avatar
Johannes Berg committed
419 420
 * Create a new STA info, caller owns returned structure
 * until sta_info_insert().
421
 */
Johannes Berg's avatar
Johannes Berg committed
422 423 424 425 426 427 428 429 430 431
struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
				u8 *addr, gfp_t gfp);
/*
 * Insert STA info into hash table/list, returns zero or a
 * -EEXIST if (if the same MAC address is already present).
 *
 * Calling this without RCU protection makes the caller
 * relinquish its reference to @sta.
 */
int sta_info_insert(struct sta_info *sta);
432 433 434 435 436 437
/*
 * Unlink a STA info from the hash table/list.
 * This can NULL the STA pointer if somebody else
 * has already unlinked it.
 */
void sta_info_unlink(struct sta_info **sta);
438

439
void sta_info_destroy(struct sta_info *sta);
440 441 442
void sta_info_set_tim_bit(struct sta_info *sta);
void sta_info_clear_tim_bit(struct sta_info *sta);

443 444 445
void sta_info_init(struct ieee80211_local *local);
int sta_info_start(struct ieee80211_local *local);
void sta_info_stop(struct ieee80211_local *local);
446
int sta_info_flush(struct ieee80211_local *local,
447
		    struct ieee80211_sub_if_data *sdata);
448
void sta_info_flush_delayed(struct ieee80211_sub_if_data *sdata);
449 450
void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata,
			  unsigned long exp_time);
451

452
#endif /* STA_INFO_H */