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