sta_info.h 15.4 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>
15
#include <linux/workqueue.h>
16
#include <linux/average.h>
J
Johannes Berg 已提交
17
#include "key.h"
18

19 20 21 22 23 24 25
/**
 * 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.
26
 * @WLAN_STA_PS_STA: Station is in power-save mode
27 28 29 30 31 32 33 34
 * @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.
35
 * @WLAN_STA_CLEAR_PS_FILT: Clear PS filter in hardware (using the
36
 *	IEEE80211_TX_CTL_CLEAR_PS_FILT control flag) when the next
37
 *	frame to this station is transmitted.
38
 * @WLAN_STA_MFP: Management frame protection is used with this STA.
39
 * @WLAN_STA_BLOCK_BA: Used to deny ADDBA requests (both TX and RX)
40
 *	during suspend/resume and station removal.
41 42 43 44 45
 * @WLAN_STA_PS_DRIVER: driver requires keeping this station in
 *	power-save mode logically to flush frames that might still
 *	be in the queues
 * @WLAN_STA_PSPOLL: Station sent PS-poll while driver was keeping
 *	station in power-save mode, reply when the driver unblocks.
46 47
 * @WLAN_STA_PS_DRIVER_BUF: Station has frames pending in driver internal
 *	buffers. Automatically cleared on station wake-up.
48 49 50 51
 */
enum ieee80211_sta_info_flags {
	WLAN_STA_AUTH		= 1<<0,
	WLAN_STA_ASSOC		= 1<<1,
52
	WLAN_STA_PS_STA		= 1<<2,
53 54 55 56 57
	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,
58
	WLAN_STA_CLEAR_PS_FILT	= 1<<9,
59
	WLAN_STA_MFP		= 1<<10,
60
	WLAN_STA_BLOCK_BA	= 1<<11,
61 62
	WLAN_STA_PS_DRIVER	= 1<<12,
	WLAN_STA_PSPOLL		= 1<<13,
63
	WLAN_STA_PS_DRIVER_BUF	= 1<<14,
64
};
65

66 67
#define STA_TID_NUM 16
#define ADDBA_RESP_INTERVAL HZ
68
#define HT_AGG_MAX_RETRIES		0x3
69

70 71 72 73
#define HT_AGG_STATE_DRV_READY		0
#define HT_AGG_STATE_RESPONSE_RECEIVED	1
#define HT_AGG_STATE_OPERATIONAL	2
#define HT_AGG_STATE_STOPPING		3
74 75
#define HT_AGG_STATE_WANT_START		4
#define HT_AGG_STATE_WANT_STOP		5
76 77 78 79

/**
 * struct tid_ampdu_tx - TID aggregation information (Tx).
 *
80
 * @rcu_head: rcu head for freeing structure
81
 * @addba_resp_timer: timer for peer's response to addba request
82
 * @pending: pending frames queue -- use sta's spinlock to protect
83
 * @dialog_token: dialog token for aggregation session
84
 * @timeout: session timeout value to be filled in ADDBA requests
85 86
 * @state: session state (see above)
 * @stop_initiator: initiator of a session stop
87
 * @tx_stop: TX DelBA frame when stopping
88
 * @buf_size: reorder buffer size at receiver
89
 *
90 91 92 93 94 95 96 97
 * This structure's lifetime is managed by RCU, assignments to
 * the array holding it must hold the aggregation mutex.
 *
 * The TX path can access it under RCU lock-free if, and
 * only if, the state has the flag %HT_AGG_STATE_OPERATIONAL
 * set. Otherwise, the TX path must also acquire the spinlock
 * and re-check the state, see comments in the tx code
 * touching it.
98 99
 */
struct tid_ampdu_tx {
100
	struct rcu_head rcu_head;
101
	struct timer_list addba_resp_timer;
102
	struct sk_buff_head pending;
103
	unsigned long state;
104
	u16 timeout;
105
	u8 dialog_token;
106
	u8 stop_initiator;
107
	bool tx_stop;
108
	u8 buf_size;
109
};
110 111 112 113 114

/**
 * struct tid_ampdu_rx - TID aggregation information (Rx).
 *
 * @reorder_buf: buffer to reorder incoming aggregated MPDUs
115
 * @reorder_time: jiffies when skb was added
116
 * @session_timer: check if peer keeps Tx-ing on the TID (by timeout value)
117
 * @reorder_timer: releases expired frames from the reorder buffer.
118 119
 * @head_seq_num: head sequence number in reordering buffer.
 * @stored_mpdu_num: number of MPDUs in reordering buffer
120 121
 * @ssn: Starting Sequence Number expected to be aggregated.
 * @buf_size: buffer size for incoming A-MPDUs
122
 * @timeout: reset timer value (in TUs).
123
 * @dialog_token: dialog token for aggregation session
124
 * @rcu_head: RCU head used for freeing this struct
125
 * @reorder_lock: serializes access to reorder buffer, see below.
126
 *
127 128
 * This structure's lifetime is managed by RCU, assignments to
 * the array holding it must hold the aggregation mutex.
129
 *
130 131 132 133
 * The @reorder_lock is used to protect the members of this
 * struct, except for @timeout, @buf_size and @dialog_token,
 * which are constant across the lifetime of the struct (the
 * dialog token being used only for debugging).
134 135
 */
struct tid_ampdu_rx {
136
	struct rcu_head rcu_head;
137
	spinlock_t reorder_lock;
138
	struct sk_buff **reorder_buf;
139
	unsigned long *reorder_time;
140
	struct timer_list session_timer;
141
	struct timer_list reorder_timer;
142 143
	u16 head_seq_num;
	u16 stored_mpdu_num;
144 145 146 147
	u16 ssn;
	u16 buf_size;
	u16 timeout;
	u8 dialog_token;
148 149
};

J
Johannes Berg 已提交
150 151 152
/**
 * struct sta_ampdu_mlme - STA aggregation information.
 *
153
 * @tid_rx: aggregation info for Rx per TID -- RCU protected
J
Johannes Berg 已提交
154 155 156
 * @tid_tx: aggregation info for Tx per TID
 * @addba_req_num: number of times addBA request has been sent.
 * @dialog_token_allocator: dialog token enumerator for each new session;
157
 * @work: work struct for starting/stopping aggregation
158 159
 * @tid_rx_timer_expired: bitmap indicating on which TIDs the
 *	RX timer expired until the work for it runs
160 161
 * @mtx: mutex to protect all TX data (except non-NULL assignments
 *	to tid_tx[idx], which are protected by the sta spinlock)
J
Johannes Berg 已提交
162 163
 */
struct sta_ampdu_mlme {
164
	struct mutex mtx;
J
Johannes Berg 已提交
165 166
	/* rx */
	struct tid_ampdu_rx *tid_rx[STA_TID_NUM];
167
	unsigned long tid_rx_timer_expired[BITS_TO_LONGS(STA_TID_NUM)];
J
Johannes Berg 已提交
168
	/* tx */
169
	struct work_struct work;
J
Johannes Berg 已提交
170 171 172 173 174 175
	struct tid_ampdu_tx *tid_tx[STA_TID_NUM];
	u8 addba_req_num[STA_TID_NUM];
	u8 dialog_token_allocator;
};


176 177 178 179 180 181 182 183 184
/**
 * 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
185
 * @sdata: virtual interface this station belongs to
186 187
 * @ptk: peer key negotiated with this station, if any
 * @gtk: group keys negotiated with this station, if any
188 189 190 191
 * @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
192 193
 * @last_rx_rate_idx: rx status rate index of the last data packet
 * @last_rx_rate_flag: rx status flag of the last data packet
R
Randy Dunlap 已提交
194 195 196
 * @lock: used for locking all fields that require locking, see comments
 *	in the header file.
 * @flaglock: spinlock for flags accesses
197
 * @drv_unblock_wk: used for driver PS unblocking
198
 * @listen_interval: listen interval of this station, when we're acting as AP
199 200 201 202 203 204 205 206
 * @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
207 208
 * @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
209
 * @last_connected: time (in seconds) when a station got connected
R
Randy Dunlap 已提交
210 211 212 213
 * @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
214
 * @avg_signal: moving average of signal of received frames from this STA
R
Randy Dunlap 已提交
215
 * @last_seq_ctrl: last received seq/frag number from this STA (per RX queue)
216 217 218
 * @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
R
Randy Dunlap 已提交
219 220
 * @fail_avg: moving percentage of failed MSDUs
 * @tx_packets: number of RX/TX MSDUs
221
 * @tx_bytes: number of bytes transmitted to this STA
R
Randy Dunlap 已提交
222
 * @tx_fragments: number of transmitted MPDUs
223 224
 * @tid_seq: per-TID sequence numbers for sending to this STA
 * @ampdu_mlme: A-MPDU state machine state
R
Randy Dunlap 已提交
225 226 227 228 229
 * @timer_to_tid: identity mapping to ID timers
 * @llid: Local link ID
 * @plid: Peer link ID
 * @reason: Cancel reason on PLINK_HOLDING state
 * @plink_retries: Retries in establishment
230 231 232 233
 * @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
J
Johannes Berg 已提交
234
 * @plink_timer_was_running: used by suspend/resume to restore timers
R
Randy Dunlap 已提交
235
 * @debugfs: debug filesystem info
236
 * @sta: station information we share with the driver
237
 * @dead: set to true when sta is unlinked
238
 * @uploaded: set to true when sta is uploaded to the driver
239
 * @lost_packets: number of consecutive lost packets
240
 */
241
struct sta_info {
242
	/* General information, mostly static */
243
	struct list_head list;
244
	struct sta_info *hnext;
245
	struct ieee80211_local *local;
246
	struct ieee80211_sub_if_data *sdata;
247 248
	struct ieee80211_key *gtk[NUM_DEFAULT_KEYS + NUM_DEFAULT_MGMT_KEYS];
	struct ieee80211_key *ptk;
249 250
	struct rate_control_ref *rate_ctrl;
	void *rate_ctrl_priv;
251
	spinlock_t lock;
252
	spinlock_t flaglock;
253

254 255
	struct work_struct drv_unblock_wk;

256
	u16 listen_interval;
257

258 259
	bool dead;

260
	bool uploaded;
261

262 263 264 265
	/*
	 * frequently updated, locked with own spinlock (flaglock),
	 * use the accessors defined below
	 */
266 267 268 269 270 271 272 273 274 275 276 277 278
	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;
279
	long last_connected;
R
Randy Dunlap 已提交
280 281 282 283
	unsigned long num_duplicates;
	unsigned long rx_fragments;
	unsigned long rx_dropped;
	int last_signal;
284
	struct ewma avg_signal;
285 286 287 288 289 290 291 292 293
	__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 */
R
Randy Dunlap 已提交
294
	unsigned long tx_packets;
295
	unsigned long tx_bytes;
R
Randy Dunlap 已提交
296
	unsigned long tx_fragments;
297
	struct ieee80211_tx_rate last_tx_rate;
298 299
	int last_rx_rate_idx;
	int last_rx_rate_flag;
300
	u16 tid_seq[IEEE80211_QOS_CTL_TID_MASK + 1];
301

302
	/*
303
	 * Aggregation information, locked with lock.
304
	 */
305
	struct sta_ampdu_mlme ampdu_mlme;
R
Randy Dunlap 已提交
306
	u8 timer_to_tid[STA_TID_NUM];
307

308
#ifdef CONFIG_MAC80211_MESH
309 310 311 312
	/*
	 * Mesh peer link attributes
	 * TODO: move to a sub-structure that is referenced with pointer?
	 */
R
Randy Dunlap 已提交
313 314 315 316
	__le16 llid;
	__le16 plid;
	__le16 reason;
	u8 plink_retries;
317
	bool ignore_plink_timer;
318
	bool plink_timer_was_running;
319 320 321 322
	enum plink_state plink_state;
	u32 plink_timeout;
	struct timer_list plink_timer;
#endif
323

J
Jiri Benc 已提交
324 325 326
#ifdef CONFIG_MAC80211_DEBUGFS
	struct sta_info_debugfsdentries {
		struct dentry *dir;
J
Johannes Berg 已提交
327
		bool add_has_run;
J
Jiri Benc 已提交
328 329
	} debugfs;
#endif
330

331 332
	unsigned int lost_packets;

333 334
	/* keep last! */
	struct ieee80211_sta sta;
335 336
};

337 338 339 340 341
static inline enum plink_state sta_plink_state(struct sta_info *sta)
{
#ifdef CONFIG_MAC80211_MESH
	return sta->plink_state;
#endif
342
	return PLINK_LISTEN;
343 344
}

345 346
static inline void set_sta_flags(struct sta_info *sta, const u32 flags)
{
347 348 349
	unsigned long irqfl;

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

static inline void clear_sta_flags(struct sta_info *sta, const u32 flags)
{
356 357 358
	unsigned long irqfl;

	spin_lock_irqsave(&sta->flaglock, irqfl);
359
	sta->flags &= ~flags;
360
	spin_unlock_irqrestore(&sta->flaglock, irqfl);
361 362 363 364 365
}

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

368
	spin_lock_irqsave(&sta->flaglock, irqfl);
369
	ret = sta->flags & flags;
370
	spin_unlock_irqrestore(&sta->flaglock, irqfl);
371 372 373 374 375 376 377 378

	return ret;
}

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

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

	return ret;
}

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

394
	spin_lock_irqsave(&sta->flaglock, irqfl);
395
	ret = sta->flags;
396
	spin_unlock_irqrestore(&sta->flaglock, irqfl);
397 398 399 400

	return ret;
}

401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417


#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)

418
/*
419
 * Get a STA info, must be under RCU read lock.
420
 */
421 422 423
struct sta_info *sta_info_get(struct ieee80211_sub_if_data *sdata,
			      const u8 *addr);

424 425 426
struct sta_info *sta_info_get_bss(struct ieee80211_sub_if_data *sdata,
				  const u8 *addr);

427 428 429 430 431 432 433 434
static inline
void for_each_sta_info_type_check(struct ieee80211_local *local,
				  const u8 *addr,
				  struct sta_info *sta,
				  struct sta_info *nxt)
{
}

435
#define for_each_sta_info(local, _addr, _sta, nxt) 			\
436
	for (	/* initialise loop */					\
437 438
		_sta = rcu_dereference(local->sta_hash[STA_HASH(_addr)]),\
		nxt = _sta ? rcu_dereference(_sta->hnext) : NULL;	\
439
		/* typecheck */						\
440
		for_each_sta_info_type_check(local, (_addr), _sta, nxt),\
441
		/* continue condition */				\
442
		_sta;							\
443
		/* advance loop */					\
444 445
		_sta = nxt,						\
		nxt = _sta ? rcu_dereference(_sta->hnext) : NULL	\
446 447
	     )								\
	/* compare address and run code only if it matches */		\
448
	if (memcmp(_sta->sta.addr, (_addr), ETH_ALEN) == 0)
449

450 451 452
/*
 * Get STA info by index, BROKEN!
 */
453 454
struct sta_info *sta_info_get_by_idx(struct ieee80211_sub_if_data *sdata,
				     int idx);
455
/*
J
Johannes Berg 已提交
456 457
 * Create a new STA info, caller owns returned structure
 * until sta_info_insert().
458
 */
J
Johannes Berg 已提交
459 460 461 462 463 464
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).
 *
465 466 467
 * Calling the non-rcu version makes the caller relinquish,
 * the _rcu version calls read_lock_rcu() and must be called
 * without it held.
J
Johannes Berg 已提交
468 469
 */
int sta_info_insert(struct sta_info *sta);
470 471 472 473 474 475 476
int sta_info_insert_rcu(struct sta_info *sta) __acquires(RCU);
int sta_info_insert_atomic(struct sta_info *sta);

int sta_info_destroy_addr(struct ieee80211_sub_if_data *sdata,
			  const u8 *addr);
int sta_info_destroy_addr_bss(struct ieee80211_sub_if_data *sdata,
			      const u8 *addr);
477

478 479 480
void sta_info_set_tim_bit(struct sta_info *sta);
void sta_info_clear_tim_bit(struct sta_info *sta);

481 482
void sta_info_init(struct ieee80211_local *local);
void sta_info_stop(struct ieee80211_local *local);
483
int sta_info_flush(struct ieee80211_local *local,
484
		   struct ieee80211_sub_if_data *sdata);
485 486
void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata,
			  unsigned long exp_time);
487

488 489 490
void ieee80211_sta_ps_deliver_wakeup(struct sta_info *sta);
void ieee80211_sta_ps_deliver_poll_response(struct sta_info *sta);

491
#endif /* STA_INFO_H */