sta_info.h 21.3 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.
50 51
 * @WLAN_STA_TDLS_INITIATOR: We are the initiator of the TDLS link with this
 *	station.
J
Johannes Berg 已提交
52 53 54 55
 * @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
56
 *	reply to other uAPSD trigger frames or PS-Poll.
57
 * @WLAN_STA_4ADDR_EVENT: 4-addr event was already sent for this frame.
58
 * @WLAN_STA_INSERTED: This station is inserted into the hash table.
59
 * @WLAN_STA_RATE_CONTROL: rate control was initialized for this station.
60
 * @WLAN_STA_TOFFSET_KNOWN: toffset calculated for this station is valid.
M
Marco Porsch 已提交
61 62
 * @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.
63 64
 * @WLAN_STA_PS_DELIVER: station woke up, but we're still blocking TX
 *	until pending frames are delivered
65 66
 */
enum ieee80211_sta_info_flags {
J
Johannes Berg 已提交
67 68 69 70 71 72 73 74 75 76 77 78 79 80
	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,
81
	WLAN_STA_TDLS_INITIATOR,
J
Johannes Berg 已提交
82 83
	WLAN_STA_UAPSD,
	WLAN_STA_SP,
84
	WLAN_STA_4ADDR_EVENT,
85
	WLAN_STA_INSERTED,
86
	WLAN_STA_RATE_CONTROL,
87
	WLAN_STA_TOFFSET_KNOWN,
M
Marco Porsch 已提交
88 89
	WLAN_STA_MPSP_OWNER,
	WLAN_STA_MPSP_RECIPIENT,
90
	WLAN_STA_PS_DELIVER,
91
};
92

93
#define ADDBA_RESP_INTERVAL HZ
94 95 96
#define HT_AGG_MAX_RETRIES		15
#define HT_AGG_BURST_RETRIES		3
#define HT_AGG_RETRIES_PERIOD		(15 * HZ)
97

98 99 100 101
#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
102 103
#define HT_AGG_STATE_WANT_START		4
#define HT_AGG_STATE_WANT_STOP		5
104

105 106 107 108 109 110 111
enum ieee80211_agg_stop_reason {
	AGG_STOP_DECLINED,
	AGG_STOP_LOCAL_REQUEST,
	AGG_STOP_PEER_REQUEST,
	AGG_STOP_DESTROY_STA,
};

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

	u16 failed_bar_ssn;
	bool bar_pending;
153
};
154 155 156 157 158

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

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

229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
/*
 * struct ieee80211_tx_latency_stat - Tx latency statistics
 *
 * Measures TX latency and jitter for a station per TID.
 *
 * @max: worst case latency
 * @sum: sum of all latencies
 * @counter: amount of Tx frames sent from interface
 * @bins: each bin counts how many frames transmitted within a certain
 * latency range. when disabled it is NULL.
 * @bin_count: amount of bins.
 */
struct ieee80211_tx_latency_stat {
	u32 max;
	u32 sum;
	u32 counter;
	u32 *bins;
	u32 bin_count;
};
J
Johannes Berg 已提交
248

249 250 251 252 253 254 255
/**
 * struct sta_info - STA information
 *
 * This structure collects information about a station that
 * mac80211 is communicating with.
 *
 * @list: global linked list entry
256
 * @free_list: list entry for keeping track of stations to free
257 258
 * @hnext: hash table linked list pointer
 * @local: pointer to the global information
259
 * @sdata: virtual interface this station belongs to
260 261
 * @ptk: peer keys negotiated with this station, if any
 * @ptk_idx: last installed peer key index
262
 * @gtk: group keys negotiated with this station, if any
263
 * @gtk_idx: last installed group key index
264 265 266 267
 * @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
268 269
 * @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
270
 * @last_rx_rate_vht_flag: rx status vht flag of the last data packet
271
 * @last_rx_rate_vht_nss: rx status nss of last data packet
R
Randy Dunlap 已提交
272 273
 * @lock: used for locking all fields that require locking, see comments
 *	in the header file.
274
 * @drv_deliver_wk: used for delivering frames after driver PS unblocking
275
 * @listen_interval: listen interval of this station, when we're acting as AP
J
Johannes Berg 已提交
276
 * @_flags: STA flags, see &enum ieee80211_sta_info_flags, do not use directly
277
 * @ps_lock: used for powersave (when mac80211 is the AP) related locking
278 279 280 281 282 283 284
 * @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
285 286
 * @rx_packets: Number of MSDUs received from this STA
 * @rx_bytes: Number of bytes received from this STA
287
 * @last_rx: time (in jiffies) when last frame was received from this STA
288
 * @last_connected: time (in seconds) when a station got connected
R
Randy Dunlap 已提交
289 290 291 292
 * @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
293
 * @avg_signal: moving average of signal of received frames from this STA
294
 * @last_ack_signal: signal of last received Ack frame from this STA
R
Randy Dunlap 已提交
295
 * @last_seq_ctrl: last received seq/frag number from this STA (per RX queue)
296 297 298
 * @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 已提交
299 300
 * @fail_avg: moving percentage of failed MSDUs
 * @tx_packets: number of RX/TX MSDUs
301
 * @tx_bytes: number of bytes transmitted to this STA
R
Randy Dunlap 已提交
302
 * @tx_fragments: number of transmitted MPDUs
303 304
 * @tid_seq: per-TID sequence numbers for sending to this STA
 * @ampdu_mlme: A-MPDU state machine state
R
Randy Dunlap 已提交
305
 * @timer_to_tid: identity mapping to ID timers
306
 * @tx_lat: Tx latency statistics
R
Randy Dunlap 已提交
307 308 309 310
 * @llid: Local link ID
 * @plid: Peer link ID
 * @reason: Cancel reason on PLINK_HOLDING state
 * @plink_retries: Retries in establishment
311 312 313
 * @plink_state: peer link state
 * @plink_timeout: timeout of peer link
 * @plink_timer: peer link watch timer
314
 * @t_offset: timing offset relative to this host
315 316
 * @t_offset_setpoint: reference timing offset of this sta to be used when
 * 	calculating clockdrift
M
Marco Porsch 已提交
317 318 319
 * @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 已提交
320
 * @debugfs: debug filesystem info
321
 * @dead: set to true when sta is unlinked
322
 * @uploaded: set to true when sta is uploaded to the driver
323
 * @lost_packets: number of consecutive lost packets
324
 * @sta: station information we share with the driver
325
 * @sta_state: duplicates information about station state (for debug)
326
 * @beacon_loss_count: number of times beacon loss has triggered
J
Johannes Berg 已提交
327
 * @rcu_head: RCU head used for freeing this station struct
328 329
 * @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 已提交
330 331 332
 * @chains: chains ever used for RX from this station
 * @chain_signal_last: last signal (per chain)
 * @chain_signal_avg: signal average (per chain)
333 334
 * @known_smps_mode: the smps_mode the client thinks we are in. Relevant for
 *	AP only.
335
 * @cipher_scheme: optional cipher scheme for this station
336
 */
337
struct sta_info {
338
	/* General information, mostly static */
339
	struct list_head list, free_list;
340
	struct rcu_head rcu_head;
J
Johannes Berg 已提交
341
	struct sta_info __rcu *hnext;
342
	struct ieee80211_local *local;
343
	struct ieee80211_sub_if_data *sdata;
J
Johannes Berg 已提交
344
	struct ieee80211_key __rcu *gtk[NUM_DEFAULT_KEYS + NUM_DEFAULT_MGMT_KEYS];
345 346 347
	struct ieee80211_key __rcu *ptk[NUM_DEFAULT_KEYS];
	u8 gtk_idx;
	u8 ptk_idx;
348 349
	struct rate_control_ref *rate_ctrl;
	void *rate_ctrl_priv;
350
	spinlock_t lock;
351

352
	struct work_struct drv_deliver_wk;
353

354
	u16 listen_interval;
355

356 357
	bool dead;

358
	bool uploaded;
359

360 361
	enum ieee80211_sta_state sta_state;

J
Johannes Berg 已提交
362 363
	/* use the accessors defined below */
	unsigned long _flags;
364

365 366
	/* STA powersave lock and frame queues */
	spinlock_t ps_lock;
367 368 369
	struct sk_buff_head ps_tx_buf[IEEE80211_NUM_ACS];
	struct sk_buff_head tx_filtered[IEEE80211_NUM_ACS];
	unsigned long driver_buffered_tids;
370 371

	/* Updated from RX path only, no locking requirements */
372 373
	unsigned long rx_packets;
	u64 rx_bytes;
374
	unsigned long last_rx;
375
	long last_connected;
R
Randy Dunlap 已提交
376 377 378 379
	unsigned long num_duplicates;
	unsigned long rx_fragments;
	unsigned long rx_dropped;
	int last_signal;
380
	struct ewma avg_signal;
381
	int last_ack_signal;
382 383 384 385 386

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

387
	/* Plus 1 for non-QoS frames */
388
	__le16 last_seq_ctrl[IEEE80211_NUM_TIDS + 1];
389 390 391 392 393 394 395 396

	/* 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 */
397 398 399
	u32 tx_fragments;
	u64 tx_packets[IEEE80211_NUM_ACS];
	u64 tx_bytes[IEEE80211_NUM_ACS];
400
	struct ieee80211_tx_rate last_tx_rate;
401
	int last_rx_rate_idx;
402
	u32 last_rx_rate_flag;
403
	u32 last_rx_rate_vht_flag;
404
	u8 last_rx_rate_vht_nss;
405
	u16 tid_seq[IEEE80211_QOS_CTL_TID_MASK + 1];
406

407
	/*
408
	 * Aggregation information, locked with lock.
409
	 */
410
	struct sta_ampdu_mlme ampdu_mlme;
411
	u8 timer_to_tid[IEEE80211_NUM_TIDS];
412

413 414
	struct ieee80211_tx_latency_stat *tx_lat;

415
#ifdef CONFIG_MAC80211_MESH
416 417 418 419
	/*
	 * Mesh peer link attributes
	 * TODO: move to a sub-structure that is referenced with pointer?
	 */
420 421 422
	u16 llid;
	u16 plid;
	u16 reason;
R
Randy Dunlap 已提交
423
	u8 plink_retries;
424
	enum nl80211_plink_state plink_state;
425 426
	u32 plink_timeout;
	struct timer_list plink_timer;
427 428
	s64 t_offset;
	s64 t_offset_setpoint;
M
Marco Porsch 已提交
429 430 431 432
	/* mesh power save */
	enum nl80211_mesh_power_mode local_pm;
	enum nl80211_mesh_power_mode peer_pm;
	enum nl80211_mesh_power_mode nonpeer_pm;
433
#endif
434

J
Jiri Benc 已提交
435 436 437
#ifdef CONFIG_MAC80211_DEBUGFS
	struct sta_info_debugfsdentries {
		struct dentry *dir;
J
Johannes Berg 已提交
438
		bool add_has_run;
J
Jiri Benc 已提交
439 440
	} debugfs;
#endif
441

442 443
	enum ieee80211_sta_rx_bandwidth cur_max_bandwidth;

444
	unsigned int lost_packets;
445
	unsigned int beacon_loss_count;
446

447
	enum ieee80211_smps_mode known_smps_mode;
448
	const struct ieee80211_cipher_scheme *cipher_scheme;
449

450 451
	/* keep last! */
	struct ieee80211_sta sta;
452 453
};

454
static inline enum nl80211_plink_state sta_plink_state(struct sta_info *sta)
455 456 457 458
{
#ifdef CONFIG_MAC80211_MESH
	return sta->plink_state;
#endif
459
	return NL80211_PLINK_LISTEN;
460 461
}

J
Johannes Berg 已提交
462 463
static inline void set_sta_flag(struct sta_info *sta,
				enum ieee80211_sta_info_flags flag)
464
{
465 466 467
	WARN_ON(flag == WLAN_STA_AUTH ||
		flag == WLAN_STA_ASSOC ||
		flag == WLAN_STA_AUTHORIZED);
J
Johannes Berg 已提交
468
	set_bit(flag, &sta->_flags);
469 470
}

J
Johannes Berg 已提交
471 472
static inline void clear_sta_flag(struct sta_info *sta,
				  enum ieee80211_sta_info_flags flag)
473
{
474 475 476
	WARN_ON(flag == WLAN_STA_AUTH ||
		flag == WLAN_STA_ASSOC ||
		flag == WLAN_STA_AUTHORIZED);
J
Johannes Berg 已提交
477
	clear_bit(flag, &sta->_flags);
478 479
}

J
Johannes Berg 已提交
480 481
static inline int test_sta_flag(struct sta_info *sta,
				enum ieee80211_sta_info_flags flag)
482
{
J
Johannes Berg 已提交
483
	return test_bit(flag, &sta->_flags);
484 485
}

J
Johannes Berg 已提交
486 487
static inline int test_and_clear_sta_flag(struct sta_info *sta,
					  enum ieee80211_sta_info_flags flag)
488
{
489 490 491
	WARN_ON(flag == WLAN_STA_AUTH ||
		flag == WLAN_STA_ASSOC ||
		flag == WLAN_STA_AUTHORIZED);
J
Johannes Berg 已提交
492
	return test_and_clear_bit(flag, &sta->_flags);
493 494
}

495 496 497
static inline int test_and_set_sta_flag(struct sta_info *sta,
					enum ieee80211_sta_info_flags flag)
{
498 499 500
	WARN_ON(flag == WLAN_STA_AUTH ||
		flag == WLAN_STA_ASSOC ||
		flag == WLAN_STA_AUTHORIZED);
501 502 503
	return test_and_set_bit(flag, &sta->_flags);
}

504 505
int sta_info_move_state(struct sta_info *sta,
			enum ieee80211_sta_state new_state);
506

507 508
static inline void sta_info_pre_move_state(struct sta_info *sta,
					   enum ieee80211_sta_state new_state)
509
{
510 511 512 513 514
	int ret;

	WARN_ON_ONCE(test_sta_flag(sta, WLAN_STA_INSERTED));

	ret = sta_info_move_state(sta, new_state);
515 516 517 518
	WARN_ON_ONCE(ret);
}


J
Johannes Berg 已提交
519 520
void ieee80211_assign_tid_tx(struct sta_info *sta, int tid,
			     struct tid_ampdu_tx *tid_tx);
521

J
Johannes Berg 已提交
522 523 524 525 526 527 528
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));
}
529 530 531 532 533

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


534 535
/* Maximum number of frames to buffer per power saving station per AC */
#define STA_MAX_TX_BUFFER	64
536 537 538 539 540 541 542 543 544

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

545
/*
546
 * Get a STA info, must be under RCU read lock.
547
 */
548 549 550
struct sta_info *sta_info_get(struct ieee80211_sub_if_data *sdata,
			      const u8 *addr);

551 552 553
struct sta_info *sta_info_get_bss(struct ieee80211_sub_if_data *sdata,
				  const u8 *addr);

554 555 556 557 558 559 560 561
static inline
void for_each_sta_info_type_check(struct ieee80211_local *local,
				  const u8 *addr,
				  struct sta_info *sta,
				  struct sta_info *nxt)
{
}

562
#define for_each_sta_info(local, _addr, _sta, nxt)			\
563
	for (	/* initialise loop */					\
564 565
		_sta = rcu_dereference(local->sta_hash[STA_HASH(_addr)]),\
		nxt = _sta ? rcu_dereference(_sta->hnext) : NULL;	\
566
		/* typecheck */						\
567
		for_each_sta_info_type_check(local, (_addr), _sta, nxt),\
568
		/* continue condition */				\
569
		_sta;							\
570
		/* advance loop */					\
571 572
		_sta = nxt,						\
		nxt = _sta ? rcu_dereference(_sta->hnext) : NULL	\
573 574
	     )								\
	/* compare address and run code only if it matches */		\
575
	if (ether_addr_equal(_sta->sta.addr, (_addr)))
576

577 578 579
/*
 * Get STA info by index, BROKEN!
 */
580 581
struct sta_info *sta_info_get_by_idx(struct ieee80211_sub_if_data *sdata,
				     int idx);
582
/*
J
Johannes Berg 已提交
583 584
 * Create a new STA info, caller owns returned structure
 * until sta_info_insert().
585
 */
J
Johannes Berg 已提交
586
struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
587
				const u8 *addr, gfp_t gfp);
588 589 590

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

J
Johannes Berg 已提交
591 592 593 594
/*
 * Insert STA info into hash table/list, returns zero or a
 * -EEXIST if (if the same MAC address is already present).
 *
595 596 597
 * 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 已提交
598 599
 */
int sta_info_insert(struct sta_info *sta);
600 601
int sta_info_insert_rcu(struct sta_info *sta) __acquires(RCU);

602
int __must_check __sta_info_destroy(struct sta_info *sta);
603 604 605 606
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);
607

J
Johannes Berg 已提交
608
void sta_info_recalc_tim(struct sta_info *sta);
609

610 611
void sta_info_init(struct ieee80211_local *local);
void sta_info_stop(struct ieee80211_local *local);
612 613 614 615 616 617 618

/**
 * 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
619
 * @vlans: if the given interface is an AP interface, also flush VLANs
620
 */
621 622 623 624 625 626
int __sta_info_flush(struct ieee80211_sub_if_data *sdata, bool vlans);

static inline int sta_info_flush(struct ieee80211_sub_if_data *sdata)
{
	return __sta_info_flush(sdata, false);
}
627

628 629 630
void sta_set_rate_info_tx(struct sta_info *sta,
			  const struct ieee80211_tx_rate *rate,
			  struct rate_info *rinfo);
631 632
void sta_set_rate_info_rx(struct sta_info *sta,
			  struct rate_info *rinfo);
633 634
void sta_set_sinfo(struct sta_info *sta, struct station_info *sinfo);

635 636
void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata,
			  unsigned long exp_time);
637
u8 sta_info_tx_streams(struct sta_info *sta);
638

639 640
void ieee80211_sta_ps_deliver_wakeup(struct sta_info *sta);
void ieee80211_sta_ps_deliver_poll_response(struct sta_info *sta);
J
Johannes Berg 已提交
641
void ieee80211_sta_ps_deliver_uapsd(struct sta_info *sta);
642

643
#endif /* STA_INFO_H */