xref: /openbmc/linux/net/mac80211/sta_info.h (revision e2f1cf25)
1 /*
2  * Copyright 2002-2005, Devicescape Software, Inc.
3  * Copyright 2013-2014  Intel Mobile Communications GmbH
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation.
8  */
9 
10 #ifndef STA_INFO_H
11 #define STA_INFO_H
12 
13 #include <linux/list.h>
14 #include <linux/types.h>
15 #include <linux/if_ether.h>
16 #include <linux/workqueue.h>
17 #include <linux/average.h>
18 #include <linux/etherdevice.h>
19 #include <linux/rhashtable.h>
20 #include "key.h"
21 
22 /**
23  * enum ieee80211_sta_info_flags - Stations flags
24  *
25  * These flags are used with &struct sta_info's @flags member, but
26  * only indirectly with set_sta_flag() and friends.
27  *
28  * @WLAN_STA_AUTH: Station is authenticated.
29  * @WLAN_STA_ASSOC: Station is associated.
30  * @WLAN_STA_PS_STA: Station is in power-save mode
31  * @WLAN_STA_AUTHORIZED: Station is authorized to send/receive traffic.
32  *	This bit is always checked so needs to be enabled for all stations
33  *	when virtual port control is not in use.
34  * @WLAN_STA_SHORT_PREAMBLE: Station is capable of receiving short-preamble
35  *	frames.
36  * @WLAN_STA_WDS: Station is one of our WDS peers.
37  * @WLAN_STA_CLEAR_PS_FILT: Clear PS filter in hardware (using the
38  *	IEEE80211_TX_CTL_CLEAR_PS_FILT control flag) when the next
39  *	frame to this station is transmitted.
40  * @WLAN_STA_MFP: Management frame protection is used with this STA.
41  * @WLAN_STA_BLOCK_BA: Used to deny ADDBA requests (both TX and RX)
42  *	during suspend/resume and station removal.
43  * @WLAN_STA_PS_DRIVER: driver requires keeping this station in
44  *	power-save mode logically to flush frames that might still
45  *	be in the queues
46  * @WLAN_STA_PSPOLL: Station sent PS-poll while driver was keeping
47  *	station in power-save mode, reply when the driver unblocks.
48  * @WLAN_STA_TDLS_PEER: Station is a TDLS peer.
49  * @WLAN_STA_TDLS_PEER_AUTH: This TDLS peer is authorized to send direct
50  *	packets. This means the link is enabled.
51  * @WLAN_STA_TDLS_INITIATOR: We are the initiator of the TDLS link with this
52  *	station.
53  * @WLAN_STA_TDLS_CHAN_SWITCH: This TDLS peer supports TDLS channel-switching
54  * @WLAN_STA_TDLS_OFF_CHANNEL: The local STA is currently off-channel with this
55  *	TDLS peer
56  * @WLAN_STA_UAPSD: Station requested unscheduled SP while driver was
57  *	keeping station in power-save mode, reply when the driver
58  *	unblocks the station.
59  * @WLAN_STA_SP: Station is in a service period, so don't try to
60  *	reply to other uAPSD trigger frames or PS-Poll.
61  * @WLAN_STA_4ADDR_EVENT: 4-addr event was already sent for this frame.
62  * @WLAN_STA_INSERTED: This station is inserted into the hash table.
63  * @WLAN_STA_RATE_CONTROL: rate control was initialized for this station.
64  * @WLAN_STA_TOFFSET_KNOWN: toffset calculated for this station is valid.
65  * @WLAN_STA_MPSP_OWNER: local STA is owner of a mesh Peer Service Period.
66  * @WLAN_STA_MPSP_RECIPIENT: local STA is recipient of a MPSP.
67  * @WLAN_STA_PS_DELIVER: station woke up, but we're still blocking TX
68  *	until pending frames are delivered
69  */
70 enum ieee80211_sta_info_flags {
71 	WLAN_STA_AUTH,
72 	WLAN_STA_ASSOC,
73 	WLAN_STA_PS_STA,
74 	WLAN_STA_AUTHORIZED,
75 	WLAN_STA_SHORT_PREAMBLE,
76 	WLAN_STA_WDS,
77 	WLAN_STA_CLEAR_PS_FILT,
78 	WLAN_STA_MFP,
79 	WLAN_STA_BLOCK_BA,
80 	WLAN_STA_PS_DRIVER,
81 	WLAN_STA_PSPOLL,
82 	WLAN_STA_TDLS_PEER,
83 	WLAN_STA_TDLS_PEER_AUTH,
84 	WLAN_STA_TDLS_INITIATOR,
85 	WLAN_STA_TDLS_CHAN_SWITCH,
86 	WLAN_STA_TDLS_OFF_CHANNEL,
87 	WLAN_STA_UAPSD,
88 	WLAN_STA_SP,
89 	WLAN_STA_4ADDR_EVENT,
90 	WLAN_STA_INSERTED,
91 	WLAN_STA_RATE_CONTROL,
92 	WLAN_STA_TOFFSET_KNOWN,
93 	WLAN_STA_MPSP_OWNER,
94 	WLAN_STA_MPSP_RECIPIENT,
95 	WLAN_STA_PS_DELIVER,
96 };
97 
98 #define ADDBA_RESP_INTERVAL HZ
99 #define HT_AGG_MAX_RETRIES		15
100 #define HT_AGG_BURST_RETRIES		3
101 #define HT_AGG_RETRIES_PERIOD		(15 * HZ)
102 
103 #define HT_AGG_STATE_DRV_READY		0
104 #define HT_AGG_STATE_RESPONSE_RECEIVED	1
105 #define HT_AGG_STATE_OPERATIONAL	2
106 #define HT_AGG_STATE_STOPPING		3
107 #define HT_AGG_STATE_WANT_START		4
108 #define HT_AGG_STATE_WANT_STOP		5
109 
110 enum ieee80211_agg_stop_reason {
111 	AGG_STOP_DECLINED,
112 	AGG_STOP_LOCAL_REQUEST,
113 	AGG_STOP_PEER_REQUEST,
114 	AGG_STOP_DESTROY_STA,
115 };
116 
117 /**
118  * struct tid_ampdu_tx - TID aggregation information (Tx).
119  *
120  * @rcu_head: rcu head for freeing structure
121  * @session_timer: check if we keep Tx-ing on the TID (by timeout value)
122  * @addba_resp_timer: timer for peer's response to addba request
123  * @pending: pending frames queue -- use sta's spinlock to protect
124  * @dialog_token: dialog token for aggregation session
125  * @timeout: session timeout value to be filled in ADDBA requests
126  * @state: session state (see above)
127  * @last_tx: jiffies of last tx activity
128  * @stop_initiator: initiator of a session stop
129  * @tx_stop: TX DelBA frame when stopping
130  * @buf_size: reorder buffer size at receiver
131  * @failed_bar_ssn: ssn of the last failed BAR tx attempt
132  * @bar_pending: BAR needs to be re-sent
133  *
134  * This structure's lifetime is managed by RCU, assignments to
135  * the array holding it must hold the aggregation mutex.
136  *
137  * The TX path can access it under RCU lock-free if, and
138  * only if, the state has the flag %HT_AGG_STATE_OPERATIONAL
139  * set. Otherwise, the TX path must also acquire the spinlock
140  * and re-check the state, see comments in the tx code
141  * touching it.
142  */
143 struct tid_ampdu_tx {
144 	struct rcu_head rcu_head;
145 	struct timer_list session_timer;
146 	struct timer_list addba_resp_timer;
147 	struct sk_buff_head pending;
148 	unsigned long state;
149 	unsigned long last_tx;
150 	u16 timeout;
151 	u8 dialog_token;
152 	u8 stop_initiator;
153 	bool tx_stop;
154 	u8 buf_size;
155 
156 	u16 failed_bar_ssn;
157 	bool bar_pending;
158 };
159 
160 /**
161  * struct tid_ampdu_rx - TID aggregation information (Rx).
162  *
163  * @reorder_buf: buffer to reorder incoming aggregated MPDUs. An MPDU may be an
164  *	A-MSDU with individually reported subframes.
165  * @reorder_time: jiffies when skb was added
166  * @session_timer: check if peer keeps Tx-ing on the TID (by timeout value)
167  * @reorder_timer: releases expired frames from the reorder buffer.
168  * @last_rx: jiffies of last rx activity
169  * @head_seq_num: head sequence number in reordering buffer.
170  * @stored_mpdu_num: number of MPDUs in reordering buffer
171  * @ssn: Starting Sequence Number expected to be aggregated.
172  * @buf_size: buffer size for incoming A-MPDUs
173  * @timeout: reset timer value (in TUs).
174  * @dialog_token: dialog token for aggregation session
175  * @rcu_head: RCU head used for freeing this struct
176  * @reorder_lock: serializes access to reorder buffer, see below.
177  * @auto_seq: used for offloaded BA sessions to automatically pick head_seq_and
178  *	and ssn.
179  * @removed: this session is removed (but might have been found due to RCU)
180  *
181  * This structure's lifetime is managed by RCU, assignments to
182  * the array holding it must hold the aggregation mutex.
183  *
184  * The @reorder_lock is used to protect the members of this
185  * struct, except for @timeout, @buf_size and @dialog_token,
186  * which are constant across the lifetime of the struct (the
187  * dialog token being used only for debugging).
188  */
189 struct tid_ampdu_rx {
190 	struct rcu_head rcu_head;
191 	spinlock_t reorder_lock;
192 	struct sk_buff_head *reorder_buf;
193 	unsigned long *reorder_time;
194 	struct timer_list session_timer;
195 	struct timer_list reorder_timer;
196 	unsigned long last_rx;
197 	u16 head_seq_num;
198 	u16 stored_mpdu_num;
199 	u16 ssn;
200 	u16 buf_size;
201 	u16 timeout;
202 	u8 dialog_token;
203 	bool auto_seq;
204 	bool removed;
205 };
206 
207 /**
208  * struct sta_ampdu_mlme - STA aggregation information.
209  *
210  * @tid_rx: aggregation info for Rx per TID -- RCU protected
211  * @tid_tx: aggregation info for Tx per TID
212  * @tid_start_tx: sessions where start was requested
213  * @addba_req_num: number of times addBA request has been sent.
214  * @last_addba_req_time: timestamp of the last addBA request.
215  * @dialog_token_allocator: dialog token enumerator for each new session;
216  * @work: work struct for starting/stopping aggregation
217  * @tid_rx_timer_expired: bitmap indicating on which TIDs the
218  *	RX timer expired until the work for it runs
219  * @tid_rx_stop_requested:  bitmap indicating which BA sessions per TID the
220  *	driver requested to close until the work for it runs
221  * @mtx: mutex to protect all TX data (except non-NULL assignments
222  *	to tid_tx[idx], which are protected by the sta spinlock)
223  *	tid_start_tx is also protected by sta->lock.
224  */
225 struct sta_ampdu_mlme {
226 	struct mutex mtx;
227 	/* rx */
228 	struct tid_ampdu_rx __rcu *tid_rx[IEEE80211_NUM_TIDS];
229 	unsigned long tid_rx_timer_expired[BITS_TO_LONGS(IEEE80211_NUM_TIDS)];
230 	unsigned long tid_rx_stop_requested[BITS_TO_LONGS(IEEE80211_NUM_TIDS)];
231 	/* tx */
232 	struct work_struct work;
233 	struct tid_ampdu_tx __rcu *tid_tx[IEEE80211_NUM_TIDS];
234 	struct tid_ampdu_tx *tid_start_tx[IEEE80211_NUM_TIDS];
235 	unsigned long last_addba_req_time[IEEE80211_NUM_TIDS];
236 	u8 addba_req_num[IEEE80211_NUM_TIDS];
237 	u8 dialog_token_allocator;
238 };
239 
240 
241 /* Value to indicate no TID reservation */
242 #define IEEE80211_TID_UNRESERVED	0xff
243 
244 #define IEEE80211_FAST_XMIT_MAX_IV	18
245 
246 /**
247  * struct ieee80211_fast_tx - TX fastpath information
248  * @key: key to use for hw crypto
249  * @hdr: the 802.11 header to put with the frame
250  * @hdr_len: actual 802.11 header length
251  * @sa_offs: offset of the SA
252  * @da_offs: offset of the DA
253  * @pn_offs: offset where to put PN for crypto (or 0 if not needed)
254  * @band: band this will be transmitted on, for tx_info
255  * @rcu_head: RCU head to free this struct
256  *
257  * This struct is small enough so that the common case (maximum crypto
258  * header length of 8 like for CCMP/GCMP) fits into a single 64-byte
259  * cache line.
260  */
261 struct ieee80211_fast_tx {
262 	struct ieee80211_key *key;
263 	u8 hdr_len;
264 	u8 sa_offs, da_offs, pn_offs;
265 	u8 band;
266 	u8 hdr[30 + 2 + IEEE80211_FAST_XMIT_MAX_IV +
267 	       sizeof(rfc1042_header)];
268 
269 	struct rcu_head rcu_head;
270 };
271 
272 /**
273  * struct sta_info - STA information
274  *
275  * This structure collects information about a station that
276  * mac80211 is communicating with.
277  *
278  * @list: global linked list entry
279  * @free_list: list entry for keeping track of stations to free
280  * @hash_node: hash node for rhashtable
281  * @local: pointer to the global information
282  * @sdata: virtual interface this station belongs to
283  * @ptk: peer keys negotiated with this station, if any
284  * @ptk_idx: last installed peer key index
285  * @gtk: group keys negotiated with this station, if any
286  * @gtk_idx: last installed group key index
287  * @rate_ctrl: rate control algorithm reference
288  * @rate_ctrl_lock: spinlock used to protect rate control data
289  *	(data inside the algorithm, so serializes calls there)
290  * @rate_ctrl_priv: rate control private per-STA pointer
291  * @last_tx_rate: rate used for last transmit, to report to userspace as
292  *	"the" transmit rate
293  * @last_rx_rate_idx: rx status rate index of the last data packet
294  * @last_rx_rate_flag: rx status flag of the last data packet
295  * @last_rx_rate_vht_flag: rx status vht flag of the last data packet
296  * @last_rx_rate_vht_nss: rx status nss of last data packet
297  * @lock: used for locking all fields that require locking, see comments
298  *	in the header file.
299  * @drv_deliver_wk: used for delivering frames after driver PS unblocking
300  * @listen_interval: listen interval of this station, when we're acting as AP
301  * @_flags: STA flags, see &enum ieee80211_sta_info_flags, do not use directly
302  * @ps_lock: used for powersave (when mac80211 is the AP) related locking
303  * @ps_tx_buf: buffers (per AC) of frames to transmit to this station
304  *	when it leaves power saving state or polls
305  * @tx_filtered: buffers (per AC) of frames we already tried to
306  *	transmit but were filtered by hardware due to STA having
307  *	entered power saving state, these are also delivered to
308  *	the station when it leaves powersave or polls for frames
309  * @driver_buffered_tids: bitmap of TIDs the driver has data buffered on
310  * @txq_buffered_tids: bitmap of TIDs that mac80211 has txq data buffered on
311  * @rx_packets: Number of MSDUs received from this STA
312  * @rx_bytes: Number of bytes received from this STA
313  * @last_rx: time (in jiffies) when last frame was received from this STA
314  * @last_connected: time (in seconds) when a station got connected
315  * @num_duplicates: number of duplicate frames received from this STA
316  * @rx_fragments: number of received MPDUs
317  * @rx_dropped: number of dropped MPDUs from this STA
318  * @last_signal: signal of last received frame from this STA
319  * @avg_signal: moving average of signal of received frames from this STA
320  * @last_ack_signal: signal of last received Ack frame from this STA
321  * @last_seq_ctrl: last received seq/frag number from this STA (per RX queue)
322  * @tx_filtered_count: number of frames the hardware filtered for this STA
323  * @tx_retry_failed: number of frames that failed retry
324  * @tx_retry_count: total number of retries for frames to this STA
325  * @fail_avg: moving percentage of failed MSDUs
326  * @tx_packets: number of RX/TX MSDUs
327  * @tx_bytes: number of bytes transmitted to this STA
328  * @tid_seq: per-TID sequence numbers for sending to this STA
329  * @ampdu_mlme: A-MPDU state machine state
330  * @timer_to_tid: identity mapping to ID timers
331  * @plink_lock: serialize access to plink fields
332  * @llid: Local link ID
333  * @plid: Peer link ID
334  * @reason: Cancel reason on PLINK_HOLDING state
335  * @plink_retries: Retries in establishment
336  * @plink_state: peer link state
337  * @plink_timeout: timeout of peer link
338  * @plink_timer: peer link watch timer
339  * @t_offset: timing offset relative to this host
340  * @t_offset_setpoint: reference timing offset of this sta to be used when
341  * 	calculating clockdrift
342  * @local_pm: local link-specific power save mode
343  * @peer_pm: peer-specific power save mode towards local STA
344  * @nonpeer_pm: STA power save mode towards non-peer neighbors
345  * @debugfs: debug filesystem info
346  * @dead: set to true when sta is unlinked
347  * @uploaded: set to true when sta is uploaded to the driver
348  * @lost_packets: number of consecutive lost packets
349  * @sta: station information we share with the driver
350  * @sta_state: duplicates information about station state (for debug)
351  * @beacon_loss_count: number of times beacon loss has triggered
352  * @rcu_head: RCU head used for freeing this station struct
353  * @cur_max_bandwidth: maximum bandwidth to use for TX to the station,
354  *	taken from HT/VHT capabilities or VHT operating mode notification
355  * @chains: chains ever used for RX from this station
356  * @chain_signal_last: last signal (per chain)
357  * @chain_signal_avg: signal average (per chain)
358  * @known_smps_mode: the smps_mode the client thinks we are in. Relevant for
359  *	AP only.
360  * @cipher_scheme: optional cipher scheme for this station
361  * @last_tdls_pkt_time: holds the time in jiffies of last TDLS pkt ACKed
362  * @reserved_tid: reserved TID (if any, otherwise IEEE80211_TID_UNRESERVED)
363  * @tx_msdu: MSDUs transmitted to this station, using IEEE80211_NUM_TID
364  *	entry for non-QoS frames
365  * @tx_msdu_retries: MSDU retries for transmissions to to this station,
366  *	using IEEE80211_NUM_TID entry for non-QoS frames
367  * @tx_msdu_failed: MSDU failures for transmissions to to this station,
368  *	using IEEE80211_NUM_TID entry for non-QoS frames
369  * @rx_msdu: MSDUs received from this station, using IEEE80211_NUM_TID
370  *	entry for non-QoS frames
371  * @fast_tx: TX fastpath information
372  * @processed_beacon: set to true after peer rates and capabilities are
373  *	processed
374  */
375 struct sta_info {
376 	/* General information, mostly static */
377 	struct list_head list, free_list;
378 	struct rcu_head rcu_head;
379 	struct rhash_head hash_node;
380 	struct ieee80211_local *local;
381 	struct ieee80211_sub_if_data *sdata;
382 	struct ieee80211_key __rcu *gtk[NUM_DEFAULT_KEYS + NUM_DEFAULT_MGMT_KEYS];
383 	struct ieee80211_key __rcu *ptk[NUM_DEFAULT_KEYS];
384 	u8 gtk_idx;
385 	u8 ptk_idx;
386 	struct rate_control_ref *rate_ctrl;
387 	void *rate_ctrl_priv;
388 	spinlock_t rate_ctrl_lock;
389 	spinlock_t lock;
390 
391 	struct ieee80211_fast_tx __rcu *fast_tx;
392 
393 	struct work_struct drv_deliver_wk;
394 
395 	u16 listen_interval;
396 
397 	bool dead;
398 
399 	bool uploaded;
400 
401 	enum ieee80211_sta_state sta_state;
402 
403 	/* use the accessors defined below */
404 	unsigned long _flags;
405 
406 	/* STA powersave lock and frame queues */
407 	spinlock_t ps_lock;
408 	struct sk_buff_head ps_tx_buf[IEEE80211_NUM_ACS];
409 	struct sk_buff_head tx_filtered[IEEE80211_NUM_ACS];
410 	unsigned long driver_buffered_tids;
411 	unsigned long txq_buffered_tids;
412 
413 	/* Updated from RX path only, no locking requirements */
414 	unsigned long rx_packets;
415 	u64 rx_bytes;
416 	unsigned long last_rx;
417 	long last_connected;
418 	unsigned long num_duplicates;
419 	unsigned long rx_fragments;
420 	unsigned long rx_dropped;
421 	int last_signal;
422 	struct ewma avg_signal;
423 	int last_ack_signal;
424 
425 	u8 chains;
426 	s8 chain_signal_last[IEEE80211_MAX_CHAINS];
427 	struct ewma chain_signal_avg[IEEE80211_MAX_CHAINS];
428 
429 	/* Plus 1 for non-QoS frames */
430 	__le16 last_seq_ctrl[IEEE80211_NUM_TIDS + 1];
431 
432 	/* Updated from TX status path only, no locking requirements */
433 	unsigned long tx_filtered_count;
434 	unsigned long tx_retry_failed, tx_retry_count;
435 	/* moving percentage of failed MSDUs */
436 	unsigned int fail_avg;
437 
438 	/* Updated from TX path only, no locking requirements */
439 	u64 tx_packets[IEEE80211_NUM_ACS];
440 	u64 tx_bytes[IEEE80211_NUM_ACS];
441 	struct ieee80211_tx_rate last_tx_rate;
442 	int last_rx_rate_idx;
443 	u32 last_rx_rate_flag;
444 	u32 last_rx_rate_vht_flag;
445 	u8 last_rx_rate_vht_nss;
446 	u16 tid_seq[IEEE80211_QOS_CTL_TID_MASK + 1];
447 	u64 tx_msdu[IEEE80211_NUM_TIDS + 1];
448 	u64 tx_msdu_retries[IEEE80211_NUM_TIDS + 1];
449 	u64 tx_msdu_failed[IEEE80211_NUM_TIDS + 1];
450 	u64 rx_msdu[IEEE80211_NUM_TIDS + 1];
451 
452 	/*
453 	 * Aggregation information, locked with lock.
454 	 */
455 	struct sta_ampdu_mlme ampdu_mlme;
456 	u8 timer_to_tid[IEEE80211_NUM_TIDS];
457 
458 #ifdef CONFIG_MAC80211_MESH
459 	/*
460 	 * Mesh peer link attributes, protected by plink_lock.
461 	 * TODO: move to a sub-structure that is referenced with pointer?
462 	 */
463 	spinlock_t plink_lock;
464 	u16 llid;
465 	u16 plid;
466 	u16 reason;
467 	u8 plink_retries;
468 	enum nl80211_plink_state plink_state;
469 	u32 plink_timeout;
470 	struct timer_list plink_timer;
471 
472 	s64 t_offset;
473 	s64 t_offset_setpoint;
474 	/* mesh power save */
475 	enum nl80211_mesh_power_mode local_pm;
476 	enum nl80211_mesh_power_mode peer_pm;
477 	enum nl80211_mesh_power_mode nonpeer_pm;
478 	bool processed_beacon;
479 #endif
480 
481 #ifdef CONFIG_MAC80211_DEBUGFS
482 	struct sta_info_debugfsdentries {
483 		struct dentry *dir;
484 		bool add_has_run;
485 	} debugfs;
486 #endif
487 
488 	enum ieee80211_sta_rx_bandwidth cur_max_bandwidth;
489 
490 	unsigned int lost_packets;
491 	unsigned int beacon_loss_count;
492 
493 	enum ieee80211_smps_mode known_smps_mode;
494 	const struct ieee80211_cipher_scheme *cipher_scheme;
495 
496 	/* TDLS timeout data */
497 	unsigned long last_tdls_pkt_time;
498 
499 	u8 reserved_tid;
500 
501 	/* keep last! */
502 	struct ieee80211_sta sta;
503 };
504 
505 static inline enum nl80211_plink_state sta_plink_state(struct sta_info *sta)
506 {
507 #ifdef CONFIG_MAC80211_MESH
508 	return sta->plink_state;
509 #endif
510 	return NL80211_PLINK_LISTEN;
511 }
512 
513 static inline void set_sta_flag(struct sta_info *sta,
514 				enum ieee80211_sta_info_flags flag)
515 {
516 	WARN_ON(flag == WLAN_STA_AUTH ||
517 		flag == WLAN_STA_ASSOC ||
518 		flag == WLAN_STA_AUTHORIZED);
519 	set_bit(flag, &sta->_flags);
520 }
521 
522 static inline void clear_sta_flag(struct sta_info *sta,
523 				  enum ieee80211_sta_info_flags flag)
524 {
525 	WARN_ON(flag == WLAN_STA_AUTH ||
526 		flag == WLAN_STA_ASSOC ||
527 		flag == WLAN_STA_AUTHORIZED);
528 	clear_bit(flag, &sta->_flags);
529 }
530 
531 static inline int test_sta_flag(struct sta_info *sta,
532 				enum ieee80211_sta_info_flags flag)
533 {
534 	return test_bit(flag, &sta->_flags);
535 }
536 
537 static inline int test_and_clear_sta_flag(struct sta_info *sta,
538 					  enum ieee80211_sta_info_flags flag)
539 {
540 	WARN_ON(flag == WLAN_STA_AUTH ||
541 		flag == WLAN_STA_ASSOC ||
542 		flag == WLAN_STA_AUTHORIZED);
543 	return test_and_clear_bit(flag, &sta->_flags);
544 }
545 
546 static inline int test_and_set_sta_flag(struct sta_info *sta,
547 					enum ieee80211_sta_info_flags flag)
548 {
549 	WARN_ON(flag == WLAN_STA_AUTH ||
550 		flag == WLAN_STA_ASSOC ||
551 		flag == WLAN_STA_AUTHORIZED);
552 	return test_and_set_bit(flag, &sta->_flags);
553 }
554 
555 int sta_info_move_state(struct sta_info *sta,
556 			enum ieee80211_sta_state new_state);
557 
558 static inline void sta_info_pre_move_state(struct sta_info *sta,
559 					   enum ieee80211_sta_state new_state)
560 {
561 	int ret;
562 
563 	WARN_ON_ONCE(test_sta_flag(sta, WLAN_STA_INSERTED));
564 
565 	ret = sta_info_move_state(sta, new_state);
566 	WARN_ON_ONCE(ret);
567 }
568 
569 
570 void ieee80211_assign_tid_tx(struct sta_info *sta, int tid,
571 			     struct tid_ampdu_tx *tid_tx);
572 
573 static inline struct tid_ampdu_tx *
574 rcu_dereference_protected_tid_tx(struct sta_info *sta, int tid)
575 {
576 	return rcu_dereference_protected(sta->ampdu_mlme.tid_tx[tid],
577 					 lockdep_is_held(&sta->lock) ||
578 					 lockdep_is_held(&sta->ampdu_mlme.mtx));
579 }
580 
581 /* Maximum number of frames to buffer per power saving station per AC */
582 #define STA_MAX_TX_BUFFER	64
583 
584 /* Minimum buffered frame expiry time. If STA uses listen interval that is
585  * smaller than this value, the minimum value here is used instead. */
586 #define STA_TX_BUFFER_EXPIRE (10 * HZ)
587 
588 /* How often station data is cleaned up (e.g., expiration of buffered frames)
589  */
590 #define STA_INFO_CLEANUP_INTERVAL (10 * HZ)
591 
592 /*
593  * Get a STA info, must be under RCU read lock.
594  */
595 struct sta_info *sta_info_get(struct ieee80211_sub_if_data *sdata,
596 			      const u8 *addr);
597 
598 struct sta_info *sta_info_get_bss(struct ieee80211_sub_if_data *sdata,
599 				  const u8 *addr);
600 
601 u32 sta_addr_hash(const void *key, u32 length, u32 seed);
602 
603 #define _sta_bucket_idx(_tbl, _a)					\
604 	rht_bucket_index(_tbl, sta_addr_hash(_a, ETH_ALEN, (_tbl)->hash_rnd))
605 
606 #define for_each_sta_info(local, tbl, _addr, _sta, _tmp)		\
607 	rht_for_each_entry_rcu(_sta, _tmp, tbl, 			\
608 			       _sta_bucket_idx(tbl, _addr),		\
609 			       hash_node)				\
610 	/* compare address and run code only if it matches */		\
611 	if (ether_addr_equal(_sta->sta.addr, (_addr)))
612 
613 /*
614  * Get STA info by index, BROKEN!
615  */
616 struct sta_info *sta_info_get_by_idx(struct ieee80211_sub_if_data *sdata,
617 				     int idx);
618 /*
619  * Create a new STA info, caller owns returned structure
620  * until sta_info_insert().
621  */
622 struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
623 				const u8 *addr, gfp_t gfp);
624 
625 void sta_info_free(struct ieee80211_local *local, struct sta_info *sta);
626 
627 /*
628  * Insert STA info into hash table/list, returns zero or a
629  * -EEXIST if (if the same MAC address is already present).
630  *
631  * Calling the non-rcu version makes the caller relinquish,
632  * the _rcu version calls read_lock_rcu() and must be called
633  * without it held.
634  */
635 int sta_info_insert(struct sta_info *sta);
636 int sta_info_insert_rcu(struct sta_info *sta) __acquires(RCU);
637 
638 int __must_check __sta_info_destroy(struct sta_info *sta);
639 int sta_info_destroy_addr(struct ieee80211_sub_if_data *sdata,
640 			  const u8 *addr);
641 int sta_info_destroy_addr_bss(struct ieee80211_sub_if_data *sdata,
642 			      const u8 *addr);
643 
644 void sta_info_recalc_tim(struct sta_info *sta);
645 
646 int sta_info_init(struct ieee80211_local *local);
647 void sta_info_stop(struct ieee80211_local *local);
648 
649 /**
650  * sta_info_flush - flush matching STA entries from the STA table
651  *
652  * Returns the number of removed STA entries.
653  *
654  * @sdata: sdata to remove all stations from
655  * @vlans: if the given interface is an AP interface, also flush VLANs
656  */
657 int __sta_info_flush(struct ieee80211_sub_if_data *sdata, bool vlans);
658 
659 static inline int sta_info_flush(struct ieee80211_sub_if_data *sdata)
660 {
661 	return __sta_info_flush(sdata, false);
662 }
663 
664 void sta_set_rate_info_tx(struct sta_info *sta,
665 			  const struct ieee80211_tx_rate *rate,
666 			  struct rate_info *rinfo);
667 void sta_set_rate_info_rx(struct sta_info *sta,
668 			  struct rate_info *rinfo);
669 void sta_set_sinfo(struct sta_info *sta, struct station_info *sinfo);
670 
671 void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata,
672 			  unsigned long exp_time);
673 u8 sta_info_tx_streams(struct sta_info *sta);
674 
675 void ieee80211_sta_ps_deliver_wakeup(struct sta_info *sta);
676 void ieee80211_sta_ps_deliver_poll_response(struct sta_info *sta);
677 void ieee80211_sta_ps_deliver_uapsd(struct sta_info *sta);
678 
679 #endif /* STA_INFO_H */
680