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