sta_info.h 20.8 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>
17
#include <linux/etherdevice.h>
J
Johannes Berg 已提交
18
#include "key.h"
19

20 21 22
/**
 * enum ieee80211_sta_info_flags - Stations flags
 *
J
Johannes Berg 已提交
23 24
 * These flags are used with &struct sta_info's @flags member, but
 * only indirectly with set_sta_flag() and friends.
25 26 27
 *
 * @WLAN_STA_AUTH: Station is authenticated.
 * @WLAN_STA_ASSOC: Station is associated.
28
 * @WLAN_STA_PS_STA: Station is in power-save mode
29 30 31 32 33 34 35
 * @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_WME: Station is a QoS-STA.
 * @WLAN_STA_WDS: Station is one of our WDS peers.
36
 * @WLAN_STA_CLEAR_PS_FILT: Clear PS filter in hardware (using the
37
 *	IEEE80211_TX_CTL_CLEAR_PS_FILT control flag) when the next
38
 *	frame to this station is transmitted.
39
 * @WLAN_STA_MFP: Management frame protection is used with this STA.
40
 * @WLAN_STA_BLOCK_BA: Used to deny ADDBA requests (both TX and RX)
41
 *	during suspend/resume and station removal.
42 43 44 45 46
 * @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.
47 48 49
 * @WLAN_STA_TDLS_PEER: Station is a TDLS peer.
 * @WLAN_STA_TDLS_PEER_AUTH: This TDLS peer is authorized to send direct
 *	packets. This means the link is enabled.
J
Johannes Berg 已提交
50 51 52 53
 * @WLAN_STA_UAPSD: Station requested unscheduled SP while driver was
 *	keeping station in power-save mode, reply when the driver
 *	unblocks the station.
 * @WLAN_STA_SP: Station is in a service period, so don't try to
54
 *	reply to other uAPSD trigger frames or PS-Poll.
55
 * @WLAN_STA_4ADDR_EVENT: 4-addr event was already sent for this frame.
56
 * @WLAN_STA_INSERTED: This station is inserted into the hash table.
57
 * @WLAN_STA_RATE_CONTROL: rate control was initialized for this station.
58
 * @WLAN_STA_TOFFSET_KNOWN: toffset calculated for this station is valid.
M
Marco Porsch 已提交
59 60
 * @WLAN_STA_MPSP_OWNER: local STA is owner of a mesh Peer Service Period.
 * @WLAN_STA_MPSP_RECIPIENT: local STA is recipient of a MPSP.
61 62
 */
enum ieee80211_sta_info_flags {
J
Johannes Berg 已提交
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78
	WLAN_STA_AUTH,
	WLAN_STA_ASSOC,
	WLAN_STA_PS_STA,
	WLAN_STA_AUTHORIZED,
	WLAN_STA_SHORT_PREAMBLE,
	WLAN_STA_WME,
	WLAN_STA_WDS,
	WLAN_STA_CLEAR_PS_FILT,
	WLAN_STA_MFP,
	WLAN_STA_BLOCK_BA,
	WLAN_STA_PS_DRIVER,
	WLAN_STA_PSPOLL,
	WLAN_STA_TDLS_PEER,
	WLAN_STA_TDLS_PEER_AUTH,
	WLAN_STA_UAPSD,
	WLAN_STA_SP,
79
	WLAN_STA_4ADDR_EVENT,
80
	WLAN_STA_INSERTED,
81
	WLAN_STA_RATE_CONTROL,
82
	WLAN_STA_TOFFSET_KNOWN,
M
Marco Porsch 已提交
83 84
	WLAN_STA_MPSP_OWNER,
	WLAN_STA_MPSP_RECIPIENT,
85
};
86

87
#define ADDBA_RESP_INTERVAL HZ
88 89 90
#define HT_AGG_MAX_RETRIES		15
#define HT_AGG_BURST_RETRIES		3
#define HT_AGG_RETRIES_PERIOD		(15 * HZ)
91

92 93 94 95
#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
96 97
#define HT_AGG_STATE_WANT_START		4
#define HT_AGG_STATE_WANT_STOP		5
98

99 100 101 102 103 104 105
enum ieee80211_agg_stop_reason {
	AGG_STOP_DECLINED,
	AGG_STOP_LOCAL_REQUEST,
	AGG_STOP_PEER_REQUEST,
	AGG_STOP_DESTROY_STA,
};

106 107 108
/**
 * struct tid_ampdu_tx - TID aggregation information (Tx).
 *
109
 * @rcu_head: rcu head for freeing structure
110
 * @session_timer: check if we keep Tx-ing on the TID (by timeout value)
111
 * @addba_resp_timer: timer for peer's response to addba request
112
 * @pending: pending frames queue -- use sta's spinlock to protect
113
 * @dialog_token: dialog token for aggregation session
114
 * @timeout: session timeout value to be filled in ADDBA requests
115
 * @state: session state (see above)
116
 * @last_tx: jiffies of last tx activity
117
 * @stop_initiator: initiator of a session stop
118
 * @tx_stop: TX DelBA frame when stopping
119
 * @buf_size: reorder buffer size at receiver
120 121
 * @failed_bar_ssn: ssn of the last failed BAR tx attempt
 * @bar_pending: BAR needs to be re-sent
122
 *
123 124 125 126 127 128 129 130
 * 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.
131 132
 */
struct tid_ampdu_tx {
133
	struct rcu_head rcu_head;
134
	struct timer_list session_timer;
135
	struct timer_list addba_resp_timer;
136
	struct sk_buff_head pending;
137
	unsigned long state;
138
	unsigned long last_tx;
139
	u16 timeout;
140
	u8 dialog_token;
141
	u8 stop_initiator;
142
	bool tx_stop;
143
	u8 buf_size;
144 145 146

	u16 failed_bar_ssn;
	bool bar_pending;
147
};
148 149 150 151 152

/**
 * struct tid_ampdu_rx - TID aggregation information (Rx).
 *
 * @reorder_buf: buffer to reorder incoming aggregated MPDUs
153
 * @reorder_time: jiffies when skb was added
154
 * @session_timer: check if peer keeps Tx-ing on the TID (by timeout value)
155
 * @reorder_timer: releases expired frames from the reorder buffer.
156
 * @last_rx: jiffies of last rx activity
157 158
 * @head_seq_num: head sequence number in reordering buffer.
 * @stored_mpdu_num: number of MPDUs in reordering buffer
159 160
 * @ssn: Starting Sequence Number expected to be aggregated.
 * @buf_size: buffer size for incoming A-MPDUs
161
 * @timeout: reset timer value (in TUs).
162
 * @dialog_token: dialog token for aggregation session
163
 * @rcu_head: RCU head used for freeing this struct
164
 * @reorder_lock: serializes access to reorder buffer, see below.
165
 *
166 167
 * This structure's lifetime is managed by RCU, assignments to
 * the array holding it must hold the aggregation mutex.
168
 *
169 170 171 172
 * 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).
173 174
 */
struct tid_ampdu_rx {
175
	struct rcu_head rcu_head;
176
	spinlock_t reorder_lock;
177
	struct sk_buff **reorder_buf;
178
	unsigned long *reorder_time;
179
	struct timer_list session_timer;
180
	struct timer_list reorder_timer;
181
	unsigned long last_rx;
182 183
	u16 head_seq_num;
	u16 stored_mpdu_num;
184 185 186 187
	u16 ssn;
	u16 buf_size;
	u16 timeout;
	u8 dialog_token;
188 189
};

J
Johannes Berg 已提交
190 191 192
/**
 * struct sta_ampdu_mlme - STA aggregation information.
 *
193
 * @tid_rx: aggregation info for Rx per TID -- RCU protected
J
Johannes Berg 已提交
194
 * @tid_tx: aggregation info for Tx per TID
J
Johannes Berg 已提交
195
 * @tid_start_tx: sessions where start was requested
J
Johannes Berg 已提交
196
 * @addba_req_num: number of times addBA request has been sent.
197
 * @last_addba_req_time: timestamp of the last addBA request.
J
Johannes Berg 已提交
198
 * @dialog_token_allocator: dialog token enumerator for each new session;
199
 * @work: work struct for starting/stopping aggregation
200 201
 * @tid_rx_timer_expired: bitmap indicating on which TIDs the
 *	RX timer expired until the work for it runs
202 203
 * @tid_rx_stop_requested:  bitmap indicating which BA sessions per TID the
 *	driver requested to close until the work for it runs
204 205
 * @mtx: mutex to protect all TX data (except non-NULL assignments
 *	to tid_tx[idx], which are protected by the sta spinlock)
206
 *	tid_start_tx is also protected by sta->lock.
J
Johannes Berg 已提交
207 208
 */
struct sta_ampdu_mlme {
209
	struct mutex mtx;
J
Johannes Berg 已提交
210
	/* rx */
211 212 213
	struct tid_ampdu_rx __rcu *tid_rx[IEEE80211_NUM_TIDS];
	unsigned long tid_rx_timer_expired[BITS_TO_LONGS(IEEE80211_NUM_TIDS)];
	unsigned long tid_rx_stop_requested[BITS_TO_LONGS(IEEE80211_NUM_TIDS)];
J
Johannes Berg 已提交
214
	/* tx */
215
	struct work_struct work;
216 217 218 219
	struct tid_ampdu_tx __rcu *tid_tx[IEEE80211_NUM_TIDS];
	struct tid_ampdu_tx *tid_start_tx[IEEE80211_NUM_TIDS];
	unsigned long last_addba_req_time[IEEE80211_NUM_TIDS];
	u8 addba_req_num[IEEE80211_NUM_TIDS];
J
Johannes Berg 已提交
220 221 222 223
	u8 dialog_token_allocator;
};


224 225 226 227 228 229 230 231 232
/**
 * 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
233
 * @sdata: virtual interface this station belongs to
234 235
 * @ptk: peer key negotiated with this station, if any
 * @gtk: group keys negotiated with this station, if any
236 237 238 239
 * @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
240 241
 * @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
242
 * @last_rx_rate_vht_nss: rx status nss of last data packet
R
Randy Dunlap 已提交
243 244
 * @lock: used for locking all fields that require locking, see comments
 *	in the header file.
245
 * @drv_unblock_wk: used for driver PS unblocking
246
 * @listen_interval: listen interval of this station, when we're acting as AP
J
Johannes Berg 已提交
247
 * @_flags: STA flags, see &enum ieee80211_sta_info_flags, do not use directly
248 249 250 251 252 253 254
 * @ps_tx_buf: buffers (per AC) of frames to transmit to this station
 *	when it leaves power saving state or polls
 * @tx_filtered: buffers (per AC) of frames we already tried to
 *	transmit but were filtered by hardware due to STA having
 *	entered power saving state, these are also delivered to
 *	the station when it leaves powersave or polls for frames
 * @driver_buffered_tids: bitmap of TIDs the driver has data buffered on
255 256
 * @rx_packets: Number of MSDUs received from this STA
 * @rx_bytes: Number of bytes received from this STA
257 258
 * @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
259
 * @last_connected: time (in seconds) when a station got connected
R
Randy Dunlap 已提交
260 261 262 263
 * @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
264
 * @avg_signal: moving average of signal of received frames from this STA
265
 * @last_ack_signal: signal of last received Ack frame from this STA
R
Randy Dunlap 已提交
266
 * @last_seq_ctrl: last received seq/frag number from this STA (per RX queue)
267 268 269
 * @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 已提交
270 271
 * @fail_avg: moving percentage of failed MSDUs
 * @tx_packets: number of RX/TX MSDUs
272
 * @tx_bytes: number of bytes transmitted to this STA
R
Randy Dunlap 已提交
273
 * @tx_fragments: number of transmitted MPDUs
274 275
 * @tid_seq: per-TID sequence numbers for sending to this STA
 * @ampdu_mlme: A-MPDU state machine state
R
Randy Dunlap 已提交
276 277 278 279 280
 * @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
281 282 283 284
 * @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
285
 * @t_offset: timing offset relative to this host
286 287
 * @t_offset_setpoint: reference timing offset of this sta to be used when
 * 	calculating clockdrift
M
Marco Porsch 已提交
288 289 290
 * @local_pm: local link-specific power save mode
 * @peer_pm: peer-specific power save mode towards local STA
 * @nonpeer_pm: STA power save mode towards non-peer neighbors
R
Randy Dunlap 已提交
291
 * @debugfs: debug filesystem info
292
 * @dead: set to true when sta is unlinked
293
 * @uploaded: set to true when sta is uploaded to the driver
294
 * @lost_packets: number of consecutive lost packets
295
 * @sta: station information we share with the driver
296
 * @sta_state: duplicates information about station state (for debug)
297
 * @beacon_loss_count: number of times beacon loss has triggered
J
Johannes Berg 已提交
298
 * @rcu_head: RCU head used for freeing this station struct
299 300
 * @cur_max_bandwidth: maximum bandwidth to use for TX to the station,
 *	taken from HT/VHT capabilities or VHT operating mode notification
J
Johannes Berg 已提交
301 302 303
 * @chains: chains ever used for RX from this station
 * @chain_signal_last: last signal (per chain)
 * @chain_signal_avg: signal average (per chain)
304 305
 * @known_smps_mode: the smps_mode the client thinks we are in. Relevant for
 *	AP only.
306
 */
307
struct sta_info {
308
	/* General information, mostly static */
309
	struct list_head list;
310
	struct rcu_head rcu_head;
J
Johannes Berg 已提交
311
	struct sta_info __rcu *hnext;
312
	struct ieee80211_local *local;
313
	struct ieee80211_sub_if_data *sdata;
J
Johannes Berg 已提交
314 315
	struct ieee80211_key __rcu *gtk[NUM_DEFAULT_KEYS + NUM_DEFAULT_MGMT_KEYS];
	struct ieee80211_key __rcu *ptk;
316 317
	struct rate_control_ref *rate_ctrl;
	void *rate_ctrl_priv;
318
	spinlock_t lock;
319

320 321
	struct work_struct drv_unblock_wk;

322
	u16 listen_interval;
323

324 325
	bool dead;

326
	bool uploaded;
327

328 329
	enum ieee80211_sta_state sta_state;

J
Johannes Berg 已提交
330 331
	/* use the accessors defined below */
	unsigned long _flags;
332 333 334 335 336

	/*
	 * STA powersave frame queues, no more than the internal
	 * locking required.
	 */
337 338 339
	struct sk_buff_head ps_tx_buf[IEEE80211_NUM_ACS];
	struct sk_buff_head tx_filtered[IEEE80211_NUM_ACS];
	unsigned long driver_buffered_tids;
340 341

	/* Updated from RX path only, no locking requirements */
342 343
	unsigned long rx_packets;
	u64 rx_bytes;
344 345
	unsigned long wep_weak_iv_count;
	unsigned long last_rx;
346
	long last_connected;
R
Randy Dunlap 已提交
347 348 349 350
	unsigned long num_duplicates;
	unsigned long rx_fragments;
	unsigned long rx_dropped;
	int last_signal;
351
	struct ewma avg_signal;
352
	int last_ack_signal;
353 354 355 356 357

	u8 chains;
	s8 chain_signal_last[IEEE80211_MAX_CHAINS];
	struct ewma chain_signal_avg[IEEE80211_MAX_CHAINS];

358
	/* Plus 1 for non-QoS frames */
359
	__le16 last_seq_ctrl[IEEE80211_NUM_TIDS + 1];
360 361 362 363 364 365 366 367

	/* 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 */
368 369 370
	u32 tx_fragments;
	u64 tx_packets[IEEE80211_NUM_ACS];
	u64 tx_bytes[IEEE80211_NUM_ACS];
371
	struct ieee80211_tx_rate last_tx_rate;
372
	int last_rx_rate_idx;
373 374
	u32 last_rx_rate_flag;
	u8 last_rx_rate_vht_nss;
375
	u16 tid_seq[IEEE80211_QOS_CTL_TID_MASK + 1];
376

377
	/*
378
	 * Aggregation information, locked with lock.
379
	 */
380
	struct sta_ampdu_mlme ampdu_mlme;
381
	u8 timer_to_tid[IEEE80211_NUM_TIDS];
382

383
#ifdef CONFIG_MAC80211_MESH
384 385 386 387
	/*
	 * Mesh peer link attributes
	 * TODO: move to a sub-structure that is referenced with pointer?
	 */
R
Randy Dunlap 已提交
388 389 390 391
	__le16 llid;
	__le16 plid;
	__le16 reason;
	u8 plink_retries;
392
	bool ignore_plink_timer;
393
	enum nl80211_plink_state plink_state;
394 395
	u32 plink_timeout;
	struct timer_list plink_timer;
396 397
	s64 t_offset;
	s64 t_offset_setpoint;
M
Marco Porsch 已提交
398 399 400 401
	/* mesh power save */
	enum nl80211_mesh_power_mode local_pm;
	enum nl80211_mesh_power_mode peer_pm;
	enum nl80211_mesh_power_mode nonpeer_pm;
402
#endif
403

J
Jiri Benc 已提交
404 405 406
#ifdef CONFIG_MAC80211_DEBUGFS
	struct sta_info_debugfsdentries {
		struct dentry *dir;
J
Johannes Berg 已提交
407
		bool add_has_run;
J
Jiri Benc 已提交
408 409
	} debugfs;
#endif
410

411 412
	enum ieee80211_sta_rx_bandwidth cur_max_bandwidth;

413
	unsigned int lost_packets;
414
	unsigned int beacon_loss_count;
415

416 417
	enum ieee80211_smps_mode known_smps_mode;

418 419
	/* keep last! */
	struct ieee80211_sta sta;
420 421
};

422
static inline enum nl80211_plink_state sta_plink_state(struct sta_info *sta)
423 424 425 426
{
#ifdef CONFIG_MAC80211_MESH
	return sta->plink_state;
#endif
427
	return NL80211_PLINK_LISTEN;
428 429
}

J
Johannes Berg 已提交
430 431
static inline void set_sta_flag(struct sta_info *sta,
				enum ieee80211_sta_info_flags flag)
432
{
433 434 435
	WARN_ON(flag == WLAN_STA_AUTH ||
		flag == WLAN_STA_ASSOC ||
		flag == WLAN_STA_AUTHORIZED);
J
Johannes Berg 已提交
436
	set_bit(flag, &sta->_flags);
437 438
}

J
Johannes Berg 已提交
439 440
static inline void clear_sta_flag(struct sta_info *sta,
				  enum ieee80211_sta_info_flags flag)
441
{
442 443 444
	WARN_ON(flag == WLAN_STA_AUTH ||
		flag == WLAN_STA_ASSOC ||
		flag == WLAN_STA_AUTHORIZED);
J
Johannes Berg 已提交
445
	clear_bit(flag, &sta->_flags);
446 447
}

J
Johannes Berg 已提交
448 449
static inline int test_sta_flag(struct sta_info *sta,
				enum ieee80211_sta_info_flags flag)
450
{
J
Johannes Berg 已提交
451
	return test_bit(flag, &sta->_flags);
452 453
}

J
Johannes Berg 已提交
454 455
static inline int test_and_clear_sta_flag(struct sta_info *sta,
					  enum ieee80211_sta_info_flags flag)
456
{
457 458 459
	WARN_ON(flag == WLAN_STA_AUTH ||
		flag == WLAN_STA_ASSOC ||
		flag == WLAN_STA_AUTHORIZED);
J
Johannes Berg 已提交
460
	return test_and_clear_bit(flag, &sta->_flags);
461 462
}

463 464 465
static inline int test_and_set_sta_flag(struct sta_info *sta,
					enum ieee80211_sta_info_flags flag)
{
466 467 468
	WARN_ON(flag == WLAN_STA_AUTH ||
		flag == WLAN_STA_ASSOC ||
		flag == WLAN_STA_AUTHORIZED);
469 470 471
	return test_and_set_bit(flag, &sta->_flags);
}

472 473
int sta_info_move_state(struct sta_info *sta,
			enum ieee80211_sta_state new_state);
474

475 476
static inline void sta_info_pre_move_state(struct sta_info *sta,
					   enum ieee80211_sta_state new_state)
477
{
478 479 480 481 482
	int ret;

	WARN_ON_ONCE(test_sta_flag(sta, WLAN_STA_INSERTED));

	ret = sta_info_move_state(sta, new_state);
483 484 485 486
	WARN_ON_ONCE(ret);
}


J
Johannes Berg 已提交
487 488
void ieee80211_assign_tid_tx(struct sta_info *sta, int tid,
			     struct tid_ampdu_tx *tid_tx);
489

J
Johannes Berg 已提交
490 491 492 493 494 495 496
static inline struct tid_ampdu_tx *
rcu_dereference_protected_tid_tx(struct sta_info *sta, int tid)
{
	return rcu_dereference_protected(sta->ampdu_mlme.tid_tx[tid],
					 lockdep_is_held(&sta->lock) ||
					 lockdep_is_held(&sta->ampdu_mlme.mtx));
}
497 498 499 500 501

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


502 503
/* Maximum number of frames to buffer per power saving station per AC */
#define STA_MAX_TX_BUFFER	64
504 505 506 507 508 509 510 511 512

/* 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)

513
/*
514
 * Get a STA info, must be under RCU read lock.
515
 */
516 517 518
struct sta_info *sta_info_get(struct ieee80211_sub_if_data *sdata,
			      const u8 *addr);

519 520 521
struct sta_info *sta_info_get_bss(struct ieee80211_sub_if_data *sdata,
				  const u8 *addr);

522 523 524 525 526 527 528 529
static inline
void for_each_sta_info_type_check(struct ieee80211_local *local,
				  const u8 *addr,
				  struct sta_info *sta,
				  struct sta_info *nxt)
{
}

530
#define for_each_sta_info(local, _addr, _sta, nxt)			\
531
	for (	/* initialise loop */					\
532 533
		_sta = rcu_dereference(local->sta_hash[STA_HASH(_addr)]),\
		nxt = _sta ? rcu_dereference(_sta->hnext) : NULL;	\
534
		/* typecheck */						\
535
		for_each_sta_info_type_check(local, (_addr), _sta, nxt),\
536
		/* continue condition */				\
537
		_sta;							\
538
		/* advance loop */					\
539 540
		_sta = nxt,						\
		nxt = _sta ? rcu_dereference(_sta->hnext) : NULL	\
541 542
	     )								\
	/* compare address and run code only if it matches */		\
543
	if (ether_addr_equal(_sta->sta.addr, (_addr)))
544

545 546 547
/*
 * Get STA info by index, BROKEN!
 */
548 549
struct sta_info *sta_info_get_by_idx(struct ieee80211_sub_if_data *sdata,
				     int idx);
550
/*
J
Johannes Berg 已提交
551 552
 * Create a new STA info, caller owns returned structure
 * until sta_info_insert().
553
 */
J
Johannes Berg 已提交
554
struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
555
				const u8 *addr, gfp_t gfp);
556 557 558

void sta_info_free(struct ieee80211_local *local, struct sta_info *sta);

J
Johannes Berg 已提交
559 560 561 562
/*
 * Insert STA info into hash table/list, returns zero or a
 * -EEXIST if (if the same MAC address is already present).
 *
563 564 565
 * 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 已提交
566 567
 */
int sta_info_insert(struct sta_info *sta);
568 569
int sta_info_insert_rcu(struct sta_info *sta) __acquires(RCU);

570
int __must_check __sta_info_destroy(struct sta_info *sta);
571 572 573 574
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);
575

J
Johannes Berg 已提交
576
void sta_info_recalc_tim(struct sta_info *sta);
577

578 579
void sta_info_init(struct ieee80211_local *local);
void sta_info_stop(struct ieee80211_local *local);
580
int sta_info_flush_defer(struct ieee80211_sub_if_data *sdata);
581 582 583 584 585 586 587 588 589 590 591 592 593

/**
 * sta_info_flush_cleanup - flush the sta_info cleanup queue
 * @sdata: the interface
 *
 * Flushes the sta_info cleanup queue for a given interface;
 * this is necessary before the interface is removed or, for
 * AP/mesh interfaces, before it is deconfigured.
 *
 * Note an rcu_barrier() must precede the function, after all
 * stations have been flushed/removed to ensure the call_rcu()
 * calls that add stations to the cleanup queue have completed.
 */
594 595 596 597 598 599 600 601 602 603 604 605 606
void sta_info_flush_cleanup(struct ieee80211_sub_if_data *sdata);

/**
 * sta_info_flush - flush matching STA entries from the STA table
 *
 * Returns the number of removed STA entries.
 *
 * @sdata: sdata to remove all stations from
 */
static inline int sta_info_flush(struct ieee80211_sub_if_data *sdata)
{
	int ret = sta_info_flush_defer(sdata);

607
	rcu_barrier();
608 609 610 611 612
	sta_info_flush_cleanup(sdata);

	return ret;
}

613 614 615
void sta_set_rate_info_tx(struct sta_info *sta,
			  const struct ieee80211_tx_rate *rate,
			  struct rate_info *rinfo);
616 617
void sta_set_rate_info_rx(struct sta_info *sta,
			  struct rate_info *rinfo);
618 619
void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata,
			  unsigned long exp_time);
620
u8 sta_info_tx_streams(struct sta_info *sta);
621

622 623
void ieee80211_sta_ps_deliver_wakeup(struct sta_info *sta);
void ieee80211_sta_ps_deliver_poll_response(struct sta_info *sta);
J
Johannes Berg 已提交
624
void ieee80211_sta_ps_deliver_uapsd(struct sta_info *sta);
625

626 627
void ieee80211_cleanup_sdata_stas(struct ieee80211_sub_if_data *sdata);

628
#endif /* STA_INFO_H */