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