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