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