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