xref: /openbmc/linux/net/mac80211/sta_info.h (revision 8730046c)
1 /*
2  * Copyright 2002-2005, Devicescape Software, Inc.
3  * Copyright 2013-2014  Intel Mobile Communications GmbH
4  * Copyright(c) 2015-2016 Intel Deutschland GmbH
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 as
8  * published by the Free Software Foundation.
9  */
10 
11 #ifndef STA_INFO_H
12 #define STA_INFO_H
13 
14 #include <linux/list.h>
15 #include <linux/types.h>
16 #include <linux/if_ether.h>
17 #include <linux/workqueue.h>
18 #include <linux/average.h>
19 #include <linux/etherdevice.h>
20 #include <linux/rhashtable.h>
21 #include <linux/u64_stats_sync.h>
22 #include "key.h"
23 
24 /**
25  * enum ieee80211_sta_info_flags - Stations flags
26  *
27  * These flags are used with &struct sta_info's @flags member, but
28  * only indirectly with set_sta_flag() and friends.
29  *
30  * @WLAN_STA_AUTH: Station is authenticated.
31  * @WLAN_STA_ASSOC: Station is associated.
32  * @WLAN_STA_PS_STA: Station is in power-save mode
33  * @WLAN_STA_AUTHORIZED: Station is authorized to send/receive traffic.
34  *	This bit is always checked so needs to be enabled for all stations
35  *	when virtual port control is not in use.
36  * @WLAN_STA_SHORT_PREAMBLE: Station is capable of receiving short-preamble
37  *	frames.
38  * @WLAN_STA_WDS: Station is one of our WDS peers.
39  * @WLAN_STA_CLEAR_PS_FILT: Clear PS filter in hardware (using the
40  *	IEEE80211_TX_CTL_CLEAR_PS_FILT control flag) when the next
41  *	frame to this station is transmitted.
42  * @WLAN_STA_MFP: Management frame protection is used with this STA.
43  * @WLAN_STA_BLOCK_BA: Used to deny ADDBA requests (both TX and RX)
44  *	during suspend/resume and station removal.
45  * @WLAN_STA_PS_DRIVER: driver requires keeping this station in
46  *	power-save mode logically to flush frames that might still
47  *	be in the queues
48  * @WLAN_STA_PSPOLL: Station sent PS-poll while driver was keeping
49  *	station in power-save mode, reply when the driver unblocks.
50  * @WLAN_STA_TDLS_PEER: Station is a TDLS peer.
51  * @WLAN_STA_TDLS_PEER_AUTH: This TDLS peer is authorized to send direct
52  *	packets. This means the link is enabled.
53  * @WLAN_STA_TDLS_INITIATOR: We are the initiator of the TDLS link with this
54  *	station.
55  * @WLAN_STA_TDLS_CHAN_SWITCH: This TDLS peer supports TDLS channel-switching
56  * @WLAN_STA_TDLS_OFF_CHANNEL: The local STA is currently off-channel with this
57  *	TDLS peer
58  * @WLAN_STA_TDLS_WIDER_BW: This TDLS peer supports working on a wider bw on
59  *	the BSS base channel.
60  * @WLAN_STA_UAPSD: Station requested unscheduled SP while driver was
61  *	keeping station in power-save mode, reply when the driver
62  *	unblocks the station.
63  * @WLAN_STA_SP: Station is in a service period, so don't try to
64  *	reply to other uAPSD trigger frames or PS-Poll.
65  * @WLAN_STA_4ADDR_EVENT: 4-addr event was already sent for this frame.
66  * @WLAN_STA_INSERTED: This station is inserted into the hash table.
67  * @WLAN_STA_RATE_CONTROL: rate control was initialized for this station.
68  * @WLAN_STA_TOFFSET_KNOWN: toffset calculated for this station is valid.
69  * @WLAN_STA_MPSP_OWNER: local STA is owner of a mesh Peer Service Period.
70  * @WLAN_STA_MPSP_RECIPIENT: local STA is recipient of a MPSP.
71  * @WLAN_STA_PS_DELIVER: station woke up, but we're still blocking TX
72  *	until pending frames are delivered
73  *
74  * @NUM_WLAN_STA_FLAGS: number of defined flags
75  */
76 enum ieee80211_sta_info_flags {
77 	WLAN_STA_AUTH,
78 	WLAN_STA_ASSOC,
79 	WLAN_STA_PS_STA,
80 	WLAN_STA_AUTHORIZED,
81 	WLAN_STA_SHORT_PREAMBLE,
82 	WLAN_STA_WDS,
83 	WLAN_STA_CLEAR_PS_FILT,
84 	WLAN_STA_MFP,
85 	WLAN_STA_BLOCK_BA,
86 	WLAN_STA_PS_DRIVER,
87 	WLAN_STA_PSPOLL,
88 	WLAN_STA_TDLS_PEER,
89 	WLAN_STA_TDLS_PEER_AUTH,
90 	WLAN_STA_TDLS_INITIATOR,
91 	WLAN_STA_TDLS_CHAN_SWITCH,
92 	WLAN_STA_TDLS_OFF_CHANNEL,
93 	WLAN_STA_TDLS_WIDER_BW,
94 	WLAN_STA_UAPSD,
95 	WLAN_STA_SP,
96 	WLAN_STA_4ADDR_EVENT,
97 	WLAN_STA_INSERTED,
98 	WLAN_STA_RATE_CONTROL,
99 	WLAN_STA_TOFFSET_KNOWN,
100 	WLAN_STA_MPSP_OWNER,
101 	WLAN_STA_MPSP_RECIPIENT,
102 	WLAN_STA_PS_DELIVER,
103 
104 	NUM_WLAN_STA_FLAGS,
105 };
106 
107 #define ADDBA_RESP_INTERVAL HZ
108 #define HT_AGG_MAX_RETRIES		15
109 #define HT_AGG_BURST_RETRIES		3
110 #define HT_AGG_RETRIES_PERIOD		(15 * HZ)
111 
112 #define HT_AGG_STATE_DRV_READY		0
113 #define HT_AGG_STATE_RESPONSE_RECEIVED	1
114 #define HT_AGG_STATE_OPERATIONAL	2
115 #define HT_AGG_STATE_STOPPING		3
116 #define HT_AGG_STATE_WANT_START		4
117 #define HT_AGG_STATE_WANT_STOP		5
118 
119 enum ieee80211_agg_stop_reason {
120 	AGG_STOP_DECLINED,
121 	AGG_STOP_LOCAL_REQUEST,
122 	AGG_STOP_PEER_REQUEST,
123 	AGG_STOP_DESTROY_STA,
124 };
125 
126 /**
127  * struct tid_ampdu_tx - TID aggregation information (Tx).
128  *
129  * @rcu_head: rcu head for freeing structure
130  * @session_timer: check if we keep Tx-ing on the TID (by timeout value)
131  * @addba_resp_timer: timer for peer's response to addba request
132  * @pending: pending frames queue -- use sta's spinlock to protect
133  * @dialog_token: dialog token for aggregation session
134  * @timeout: session timeout value to be filled in ADDBA requests
135  * @state: session state (see above)
136  * @last_tx: jiffies of last tx activity
137  * @stop_initiator: initiator of a session stop
138  * @tx_stop: TX DelBA frame when stopping
139  * @buf_size: reorder buffer size at receiver
140  * @failed_bar_ssn: ssn of the last failed BAR tx attempt
141  * @bar_pending: BAR needs to be re-sent
142  * @amsdu: support A-MSDU withing A-MDPU
143  *
144  * This structure's lifetime is managed by RCU, assignments to
145  * the array holding it must hold the aggregation mutex.
146  *
147  * The TX path can access it under RCU lock-free if, and
148  * only if, the state has the flag %HT_AGG_STATE_OPERATIONAL
149  * set. Otherwise, the TX path must also acquire the spinlock
150  * and re-check the state, see comments in the tx code
151  * touching it.
152  */
153 struct tid_ampdu_tx {
154 	struct rcu_head rcu_head;
155 	struct timer_list session_timer;
156 	struct timer_list addba_resp_timer;
157 	struct sk_buff_head pending;
158 	unsigned long state;
159 	unsigned long last_tx;
160 	u16 timeout;
161 	u8 dialog_token;
162 	u8 stop_initiator;
163 	bool tx_stop;
164 	u8 buf_size;
165 
166 	u16 failed_bar_ssn;
167 	bool bar_pending;
168 	bool amsdu;
169 };
170 
171 /**
172  * struct tid_ampdu_rx - TID aggregation information (Rx).
173  *
174  * @reorder_buf: buffer to reorder incoming aggregated MPDUs. An MPDU may be an
175  *	A-MSDU with individually reported subframes.
176  * @reorder_buf_filtered: bitmap indicating where there are filtered frames in
177  *	the reorder buffer that should be ignored when releasing frames
178  * @reorder_time: jiffies when skb was added
179  * @session_timer: check if peer keeps Tx-ing on the TID (by timeout value)
180  * @reorder_timer: releases expired frames from the reorder buffer.
181  * @last_rx: jiffies of last rx activity
182  * @head_seq_num: head sequence number in reordering buffer.
183  * @stored_mpdu_num: number of MPDUs in reordering buffer
184  * @ssn: Starting Sequence Number expected to be aggregated.
185  * @buf_size: buffer size for incoming A-MPDUs
186  * @timeout: reset timer value (in TUs).
187  * @rcu_head: RCU head used for freeing this struct
188  * @reorder_lock: serializes access to reorder buffer, see below.
189  * @auto_seq: used for offloaded BA sessions to automatically pick head_seq_and
190  *	and ssn.
191  * @removed: this session is removed (but might have been found due to RCU)
192  *
193  * This structure's lifetime is managed by RCU, assignments to
194  * the array holding it must hold the aggregation mutex.
195  *
196  * The @reorder_lock is used to protect the members of this
197  * struct, except for @timeout, @buf_size and @dialog_token,
198  * which are constant across the lifetime of the struct (the
199  * dialog token being used only for debugging).
200  */
201 struct tid_ampdu_rx {
202 	struct rcu_head rcu_head;
203 	spinlock_t reorder_lock;
204 	u64 reorder_buf_filtered;
205 	struct sk_buff_head *reorder_buf;
206 	unsigned long *reorder_time;
207 	struct timer_list session_timer;
208 	struct timer_list reorder_timer;
209 	unsigned long last_rx;
210 	u16 head_seq_num;
211 	u16 stored_mpdu_num;
212 	u16 ssn;
213 	u16 buf_size;
214 	u16 timeout;
215 	bool auto_seq;
216 	bool removed;
217 };
218 
219 /**
220  * struct sta_ampdu_mlme - STA aggregation information.
221  *
222  * @mtx: mutex to protect all TX data (except non-NULL assignments
223  *	to tid_tx[idx], which are protected by the sta spinlock)
224  *	tid_start_tx is also protected by sta->lock.
225  * @tid_rx: aggregation info for Rx per TID -- RCU protected
226  * @tid_rx_token: dialog tokens for valid aggregation sessions
227  * @tid_rx_timer_expired: bitmap indicating on which TIDs the
228  *	RX timer expired until the work for it runs
229  * @tid_rx_stop_requested:  bitmap indicating which BA sessions per TID the
230  *	driver requested to close until the work for it runs
231  * @agg_session_valid: bitmap indicating which TID has a rx BA session open on
232  * @unexpected_agg: bitmap indicating which TID already sent a delBA due to
233  *	unexpected aggregation related frames outside a session
234  * @work: work struct for starting/stopping aggregation
235  * @tid_tx: aggregation info for Tx per TID
236  * @tid_start_tx: sessions where start was requested
237  * @last_addba_req_time: timestamp of the last addBA request.
238  * @addba_req_num: number of times addBA request has been sent.
239  * @dialog_token_allocator: dialog token enumerator for each new session;
240  */
241 struct sta_ampdu_mlme {
242 	struct mutex mtx;
243 	/* rx */
244 	struct tid_ampdu_rx __rcu *tid_rx[IEEE80211_NUM_TIDS];
245 	u8 tid_rx_token[IEEE80211_NUM_TIDS];
246 	unsigned long tid_rx_timer_expired[BITS_TO_LONGS(IEEE80211_NUM_TIDS)];
247 	unsigned long tid_rx_stop_requested[BITS_TO_LONGS(IEEE80211_NUM_TIDS)];
248 	unsigned long agg_session_valid[BITS_TO_LONGS(IEEE80211_NUM_TIDS)];
249 	unsigned long unexpected_agg[BITS_TO_LONGS(IEEE80211_NUM_TIDS)];
250 	/* tx */
251 	struct work_struct work;
252 	struct tid_ampdu_tx __rcu *tid_tx[IEEE80211_NUM_TIDS];
253 	struct tid_ampdu_tx *tid_start_tx[IEEE80211_NUM_TIDS];
254 	unsigned long last_addba_req_time[IEEE80211_NUM_TIDS];
255 	u8 addba_req_num[IEEE80211_NUM_TIDS];
256 	u8 dialog_token_allocator;
257 };
258 
259 
260 /* Value to indicate no TID reservation */
261 #define IEEE80211_TID_UNRESERVED	0xff
262 
263 #define IEEE80211_FAST_XMIT_MAX_IV	18
264 
265 /**
266  * struct ieee80211_fast_tx - TX fastpath information
267  * @key: key to use for hw crypto
268  * @hdr: the 802.11 header to put with the frame
269  * @hdr_len: actual 802.11 header length
270  * @sa_offs: offset of the SA
271  * @da_offs: offset of the DA
272  * @pn_offs: offset where to put PN for crypto (or 0 if not needed)
273  * @band: band this will be transmitted on, for tx_info
274  * @rcu_head: RCU head to free this struct
275  *
276  * This struct is small enough so that the common case (maximum crypto
277  * header length of 8 like for CCMP/GCMP) fits into a single 64-byte
278  * cache line.
279  */
280 struct ieee80211_fast_tx {
281 	struct ieee80211_key *key;
282 	u8 hdr_len;
283 	u8 sa_offs, da_offs, pn_offs;
284 	u8 band;
285 	u8 hdr[30 + 2 + IEEE80211_FAST_XMIT_MAX_IV +
286 	       sizeof(rfc1042_header)] __aligned(2);
287 
288 	struct rcu_head rcu_head;
289 };
290 
291 /**
292  * struct ieee80211_fast_rx - RX fastpath information
293  * @dev: netdevice for reporting the SKB
294  * @vif_type: (P2P-less) interface type of the original sdata (sdata->vif.type)
295  * @vif_addr: interface address
296  * @rfc1042_hdr: copy of the RFC 1042 SNAP header (to have in cache)
297  * @control_port_protocol: control port protocol copied from sdata
298  * @expected_ds_bits: from/to DS bits expected
299  * @icv_len: length of the MIC if present
300  * @key: bool indicating encryption is expected (key is set)
301  * @sta_notify: notify the MLME code (once)
302  * @internal_forward: forward froms internally on AP/VLAN type interfaces
303  * @uses_rss: copy of USES_RSS hw flag
304  * @da_offs: offset of the DA in the header (for header conversion)
305  * @sa_offs: offset of the SA in the header (for header conversion)
306  * @rcu_head: RCU head for freeing this structure
307  */
308 struct ieee80211_fast_rx {
309 	struct net_device *dev;
310 	enum nl80211_iftype vif_type;
311 	u8 vif_addr[ETH_ALEN] __aligned(2);
312 	u8 rfc1042_hdr[6] __aligned(2);
313 	__be16 control_port_protocol;
314 	__le16 expected_ds_bits;
315 	u8 icv_len;
316 	u8 key:1,
317 	   sta_notify:1,
318 	   internal_forward:1,
319 	   uses_rss:1;
320 	u8 da_offs, sa_offs;
321 
322 	struct rcu_head rcu_head;
323 };
324 
325 /**
326  * struct mesh_sta - mesh STA information
327  * @plink_lock: serialize access to plink fields
328  * @llid: Local link ID
329  * @plid: Peer link ID
330  * @aid: local aid supplied by peer
331  * @reason: Cancel reason on PLINK_HOLDING state
332  * @plink_retries: Retries in establishment
333  * @plink_state: peer link state
334  * @plink_timeout: timeout of peer link
335  * @plink_timer: peer link watch timer
336  * @t_offset: timing offset relative to this host
337  * @t_offset_setpoint: reference timing offset of this sta to be used when
338  * 	calculating clockdrift
339  * @local_pm: local link-specific power save mode
340  * @peer_pm: peer-specific power save mode towards local STA
341  * @nonpeer_pm: STA power save mode towards non-peer neighbors
342  * @processed_beacon: set to true after peer rates and capabilities are
343  *	processed
344  * @fail_avg: moving percentage of failed MSDUs
345  */
346 struct mesh_sta {
347 	struct timer_list plink_timer;
348 
349 	s64 t_offset;
350 	s64 t_offset_setpoint;
351 
352 	spinlock_t plink_lock;
353 	u16 llid;
354 	u16 plid;
355 	u16 aid;
356 	u16 reason;
357 	u8 plink_retries;
358 
359 	bool processed_beacon;
360 
361 	enum nl80211_plink_state plink_state;
362 	u32 plink_timeout;
363 
364 	/* mesh power save */
365 	enum nl80211_mesh_power_mode local_pm;
366 	enum nl80211_mesh_power_mode peer_pm;
367 	enum nl80211_mesh_power_mode nonpeer_pm;
368 
369 	/* moving percentage of failed MSDUs */
370 	unsigned int fail_avg;
371 };
372 
373 DECLARE_EWMA(signal, 1024, 8)
374 
375 struct ieee80211_sta_rx_stats {
376 	unsigned long packets;
377 	unsigned long last_rx;
378 	unsigned long num_duplicates;
379 	unsigned long fragments;
380 	unsigned long dropped;
381 	int last_signal;
382 	u8 chains;
383 	s8 chain_signal_last[IEEE80211_MAX_CHAINS];
384 	u16 last_rate;
385 	struct u64_stats_sync syncp;
386 	u64 bytes;
387 	u64 msdu[IEEE80211_NUM_TIDS + 1];
388 };
389 
390 /**
391  * struct sta_info - STA information
392  *
393  * This structure collects information about a station that
394  * mac80211 is communicating with.
395  *
396  * @list: global linked list entry
397  * @free_list: list entry for keeping track of stations to free
398  * @hash_node: hash node for rhashtable
399  * @addr: station's MAC address - duplicated from public part to
400  *	let the hash table work with just a single cacheline
401  * @local: pointer to the global information
402  * @sdata: virtual interface this station belongs to
403  * @ptk: peer keys negotiated with this station, if any
404  * @ptk_idx: last installed peer key index
405  * @gtk: group keys negotiated with this station, if any
406  * @rate_ctrl: rate control algorithm reference
407  * @rate_ctrl_lock: spinlock used to protect rate control data
408  *	(data inside the algorithm, so serializes calls there)
409  * @rate_ctrl_priv: rate control private per-STA pointer
410  * @lock: used for locking all fields that require locking, see comments
411  *	in the header file.
412  * @drv_deliver_wk: used for delivering frames after driver PS unblocking
413  * @listen_interval: listen interval of this station, when we're acting as AP
414  * @_flags: STA flags, see &enum ieee80211_sta_info_flags, do not use directly
415  * @ps_lock: used for powersave (when mac80211 is the AP) related locking
416  * @ps_tx_buf: buffers (per AC) of frames to transmit to this station
417  *	when it leaves power saving state or polls
418  * @tx_filtered: buffers (per AC) of frames we already tried to
419  *	transmit but were filtered by hardware due to STA having
420  *	entered power saving state, these are also delivered to
421  *	the station when it leaves powersave or polls for frames
422  * @driver_buffered_tids: bitmap of TIDs the driver has data buffered on
423  * @txq_buffered_tids: bitmap of TIDs that mac80211 has txq data buffered on
424  * @last_connected: time (in seconds) when a station got connected
425  * @last_seq_ctrl: last received seq/frag number from this STA (per TID
426  *	plus one for non-QoS frames)
427  * @tid_seq: per-TID sequence numbers for sending to this STA
428  * @ampdu_mlme: A-MPDU state machine state
429  * @timer_to_tid: identity mapping to ID timers
430  * @mesh: mesh STA information
431  * @debugfs_dir: debug filesystem directory dentry
432  * @dead: set to true when sta is unlinked
433  * @removed: set to true when sta is being removed from sta_list
434  * @uploaded: set to true when sta is uploaded to the driver
435  * @sta: station information we share with the driver
436  * @sta_state: duplicates information about station state (for debug)
437  * @rcu_head: RCU head used for freeing this station struct
438  * @cur_max_bandwidth: maximum bandwidth to use for TX to the station,
439  *	taken from HT/VHT capabilities or VHT operating mode notification
440  * @known_smps_mode: the smps_mode the client thinks we are in. Relevant for
441  *	AP only.
442  * @cipher_scheme: optional cipher scheme for this station
443  * @reserved_tid: reserved TID (if any, otherwise IEEE80211_TID_UNRESERVED)
444  * @fast_tx: TX fastpath information
445  * @fast_rx: RX fastpath information
446  * @tdls_chandef: a TDLS peer can have a wider chandef that is compatible to
447  *	the BSS one.
448  * @tx_stats: TX statistics
449  * @rx_stats: RX statistics
450  * @pcpu_rx_stats: per-CPU RX statistics, assigned only if the driver needs
451  *	this (by advertising the USES_RSS hw flag)
452  * @status_stats: TX status statistics
453  */
454 struct sta_info {
455 	/* General information, mostly static */
456 	struct list_head list, free_list;
457 	struct rcu_head rcu_head;
458 	struct rhlist_head hash_node;
459 	u8 addr[ETH_ALEN];
460 	struct ieee80211_local *local;
461 	struct ieee80211_sub_if_data *sdata;
462 	struct ieee80211_key __rcu *gtk[NUM_DEFAULT_KEYS + NUM_DEFAULT_MGMT_KEYS];
463 	struct ieee80211_key __rcu *ptk[NUM_DEFAULT_KEYS];
464 	u8 ptk_idx;
465 	struct rate_control_ref *rate_ctrl;
466 	void *rate_ctrl_priv;
467 	spinlock_t rate_ctrl_lock;
468 	spinlock_t lock;
469 
470 	struct ieee80211_fast_tx __rcu *fast_tx;
471 	struct ieee80211_fast_rx __rcu *fast_rx;
472 	struct ieee80211_sta_rx_stats __percpu *pcpu_rx_stats;
473 
474 #ifdef CONFIG_MAC80211_MESH
475 	struct mesh_sta *mesh;
476 #endif
477 
478 	struct work_struct drv_deliver_wk;
479 
480 	u16 listen_interval;
481 
482 	bool dead;
483 	bool removed;
484 
485 	bool uploaded;
486 
487 	enum ieee80211_sta_state sta_state;
488 
489 	/* use the accessors defined below */
490 	unsigned long _flags;
491 
492 	/* STA powersave lock and frame queues */
493 	spinlock_t ps_lock;
494 	struct sk_buff_head ps_tx_buf[IEEE80211_NUM_ACS];
495 	struct sk_buff_head tx_filtered[IEEE80211_NUM_ACS];
496 	unsigned long driver_buffered_tids;
497 	unsigned long txq_buffered_tids;
498 
499 	long last_connected;
500 
501 	/* Updated from RX path only, no locking requirements */
502 	struct ieee80211_sta_rx_stats rx_stats;
503 	struct {
504 		struct ewma_signal signal;
505 		struct ewma_signal chain_signal[IEEE80211_MAX_CHAINS];
506 	} rx_stats_avg;
507 
508 	/* Plus 1 for non-QoS frames */
509 	__le16 last_seq_ctrl[IEEE80211_NUM_TIDS + 1];
510 
511 	/* Updated from TX status path only, no locking requirements */
512 	struct {
513 		unsigned long filtered;
514 		unsigned long retry_failed, retry_count;
515 		unsigned int lost_packets;
516 		unsigned long last_tdls_pkt_time;
517 		u64 msdu_retries[IEEE80211_NUM_TIDS + 1];
518 		u64 msdu_failed[IEEE80211_NUM_TIDS + 1];
519 		unsigned long last_ack;
520 	} status_stats;
521 
522 	/* Updated from TX path only, no locking requirements */
523 	struct {
524 		u64 packets[IEEE80211_NUM_ACS];
525 		u64 bytes[IEEE80211_NUM_ACS];
526 		struct ieee80211_tx_rate last_rate;
527 		u64 msdu[IEEE80211_NUM_TIDS + 1];
528 	} tx_stats;
529 	u16 tid_seq[IEEE80211_QOS_CTL_TID_MASK + 1];
530 
531 	/*
532 	 * Aggregation information, locked with lock.
533 	 */
534 	struct sta_ampdu_mlme ampdu_mlme;
535 	u8 timer_to_tid[IEEE80211_NUM_TIDS];
536 
537 #ifdef CONFIG_MAC80211_DEBUGFS
538 	struct dentry *debugfs_dir;
539 #endif
540 
541 	enum ieee80211_sta_rx_bandwidth cur_max_bandwidth;
542 
543 	enum ieee80211_smps_mode known_smps_mode;
544 	const struct ieee80211_cipher_scheme *cipher_scheme;
545 
546 	u8 reserved_tid;
547 
548 	struct cfg80211_chan_def tdls_chandef;
549 
550 	/* keep last! */
551 	struct ieee80211_sta sta;
552 };
553 
554 static inline enum nl80211_plink_state sta_plink_state(struct sta_info *sta)
555 {
556 #ifdef CONFIG_MAC80211_MESH
557 	return sta->mesh->plink_state;
558 #endif
559 	return NL80211_PLINK_LISTEN;
560 }
561 
562 static inline void set_sta_flag(struct sta_info *sta,
563 				enum ieee80211_sta_info_flags flag)
564 {
565 	WARN_ON(flag == WLAN_STA_AUTH ||
566 		flag == WLAN_STA_ASSOC ||
567 		flag == WLAN_STA_AUTHORIZED);
568 	set_bit(flag, &sta->_flags);
569 }
570 
571 static inline void clear_sta_flag(struct sta_info *sta,
572 				  enum ieee80211_sta_info_flags flag)
573 {
574 	WARN_ON(flag == WLAN_STA_AUTH ||
575 		flag == WLAN_STA_ASSOC ||
576 		flag == WLAN_STA_AUTHORIZED);
577 	clear_bit(flag, &sta->_flags);
578 }
579 
580 static inline int test_sta_flag(struct sta_info *sta,
581 				enum ieee80211_sta_info_flags flag)
582 {
583 	return test_bit(flag, &sta->_flags);
584 }
585 
586 static inline int test_and_clear_sta_flag(struct sta_info *sta,
587 					  enum ieee80211_sta_info_flags flag)
588 {
589 	WARN_ON(flag == WLAN_STA_AUTH ||
590 		flag == WLAN_STA_ASSOC ||
591 		flag == WLAN_STA_AUTHORIZED);
592 	return test_and_clear_bit(flag, &sta->_flags);
593 }
594 
595 static inline int test_and_set_sta_flag(struct sta_info *sta,
596 					enum ieee80211_sta_info_flags flag)
597 {
598 	WARN_ON(flag == WLAN_STA_AUTH ||
599 		flag == WLAN_STA_ASSOC ||
600 		flag == WLAN_STA_AUTHORIZED);
601 	return test_and_set_bit(flag, &sta->_flags);
602 }
603 
604 int sta_info_move_state(struct sta_info *sta,
605 			enum ieee80211_sta_state new_state);
606 
607 static inline void sta_info_pre_move_state(struct sta_info *sta,
608 					   enum ieee80211_sta_state new_state)
609 {
610 	int ret;
611 
612 	WARN_ON_ONCE(test_sta_flag(sta, WLAN_STA_INSERTED));
613 
614 	ret = sta_info_move_state(sta, new_state);
615 	WARN_ON_ONCE(ret);
616 }
617 
618 
619 void ieee80211_assign_tid_tx(struct sta_info *sta, int tid,
620 			     struct tid_ampdu_tx *tid_tx);
621 
622 static inline struct tid_ampdu_tx *
623 rcu_dereference_protected_tid_tx(struct sta_info *sta, int tid)
624 {
625 	return rcu_dereference_protected(sta->ampdu_mlme.tid_tx[tid],
626 					 lockdep_is_held(&sta->lock) ||
627 					 lockdep_is_held(&sta->ampdu_mlme.mtx));
628 }
629 
630 /* Maximum number of frames to buffer per power saving station per AC */
631 #define STA_MAX_TX_BUFFER	64
632 
633 /* Minimum buffered frame expiry time. If STA uses listen interval that is
634  * smaller than this value, the minimum value here is used instead. */
635 #define STA_TX_BUFFER_EXPIRE (10 * HZ)
636 
637 /* How often station data is cleaned up (e.g., expiration of buffered frames)
638  */
639 #define STA_INFO_CLEANUP_INTERVAL (10 * HZ)
640 
641 struct rhlist_head *sta_info_hash_lookup(struct ieee80211_local *local,
642 					 const u8 *addr);
643 
644 /*
645  * Get a STA info, must be under RCU read lock.
646  */
647 struct sta_info *sta_info_get(struct ieee80211_sub_if_data *sdata,
648 			      const u8 *addr);
649 
650 struct sta_info *sta_info_get_bss(struct ieee80211_sub_if_data *sdata,
651 				  const u8 *addr);
652 
653 #define for_each_sta_info(local, _addr, _sta, _tmp)			\
654 	rhl_for_each_entry_rcu(_sta, _tmp,				\
655 			       sta_info_hash_lookup(local, _addr), hash_node)
656 
657 /*
658  * Get STA info by index, BROKEN!
659  */
660 struct sta_info *sta_info_get_by_idx(struct ieee80211_sub_if_data *sdata,
661 				     int idx);
662 /*
663  * Create a new STA info, caller owns returned structure
664  * until sta_info_insert().
665  */
666 struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
667 				const u8 *addr, gfp_t gfp);
668 
669 void sta_info_free(struct ieee80211_local *local, struct sta_info *sta);
670 
671 /*
672  * Insert STA info into hash table/list, returns zero or a
673  * -EEXIST if (if the same MAC address is already present).
674  *
675  * Calling the non-rcu version makes the caller relinquish,
676  * the _rcu version calls read_lock_rcu() and must be called
677  * without it held.
678  */
679 int sta_info_insert(struct sta_info *sta);
680 int sta_info_insert_rcu(struct sta_info *sta) __acquires(RCU);
681 
682 int __must_check __sta_info_destroy(struct sta_info *sta);
683 int sta_info_destroy_addr(struct ieee80211_sub_if_data *sdata,
684 			  const u8 *addr);
685 int sta_info_destroy_addr_bss(struct ieee80211_sub_if_data *sdata,
686 			      const u8 *addr);
687 
688 void sta_info_recalc_tim(struct sta_info *sta);
689 
690 int sta_info_init(struct ieee80211_local *local);
691 void sta_info_stop(struct ieee80211_local *local);
692 
693 /**
694  * sta_info_flush - flush matching STA entries from the STA table
695  *
696  * Returns the number of removed STA entries.
697  *
698  * @sdata: sdata to remove all stations from
699  * @vlans: if the given interface is an AP interface, also flush VLANs
700  */
701 int __sta_info_flush(struct ieee80211_sub_if_data *sdata, bool vlans);
702 
703 static inline int sta_info_flush(struct ieee80211_sub_if_data *sdata)
704 {
705 	return __sta_info_flush(sdata, false);
706 }
707 
708 void sta_set_rate_info_tx(struct sta_info *sta,
709 			  const struct ieee80211_tx_rate *rate,
710 			  struct rate_info *rinfo);
711 void sta_set_sinfo(struct sta_info *sta, struct station_info *sinfo);
712 
713 u32 sta_get_expected_throughput(struct sta_info *sta);
714 
715 void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata,
716 			  unsigned long exp_time);
717 u8 sta_info_tx_streams(struct sta_info *sta);
718 
719 void ieee80211_sta_ps_deliver_wakeup(struct sta_info *sta);
720 void ieee80211_sta_ps_deliver_poll_response(struct sta_info *sta);
721 void ieee80211_sta_ps_deliver_uapsd(struct sta_info *sta);
722 
723 unsigned long ieee80211_sta_last_active(struct sta_info *sta);
724 
725 #define STA_STATS_RATE_INVALID		0
726 #define STA_STATS_RATE_VHT		0x8000
727 #define STA_STATS_RATE_HT		0x4000
728 #define STA_STATS_RATE_LEGACY		0x2000
729 #define STA_STATS_RATE_SGI		0x1000
730 #define STA_STATS_RATE_BW_SHIFT		9
731 #define STA_STATS_RATE_BW_MASK		(0x7 << STA_STATS_RATE_BW_SHIFT)
732 
733 static inline u16 sta_stats_encode_rate(struct ieee80211_rx_status *s)
734 {
735 	u16 r = s->rate_idx;
736 
737 	if (s->vht_flag & RX_VHT_FLAG_80MHZ)
738 		r |= RATE_INFO_BW_80 << STA_STATS_RATE_BW_SHIFT;
739 	else if (s->vht_flag & RX_VHT_FLAG_160MHZ)
740 		r |= RATE_INFO_BW_160 << STA_STATS_RATE_BW_SHIFT;
741 	else if (s->flag & RX_FLAG_40MHZ)
742 		r |= RATE_INFO_BW_40 << STA_STATS_RATE_BW_SHIFT;
743 	else if (s->flag & RX_FLAG_10MHZ)
744 		r |= RATE_INFO_BW_10 << STA_STATS_RATE_BW_SHIFT;
745 	else if (s->flag & RX_FLAG_5MHZ)
746 		r |= RATE_INFO_BW_5 << STA_STATS_RATE_BW_SHIFT;
747 	else
748 		r |= RATE_INFO_BW_20 << STA_STATS_RATE_BW_SHIFT;
749 
750 	if (s->flag & RX_FLAG_SHORT_GI)
751 		r |= STA_STATS_RATE_SGI;
752 
753 	if (s->flag & RX_FLAG_VHT)
754 		r |= STA_STATS_RATE_VHT | (s->vht_nss << 4);
755 	else if (s->flag & RX_FLAG_HT)
756 		r |= STA_STATS_RATE_HT;
757 	else
758 		r |= STA_STATS_RATE_LEGACY | (s->band << 4);
759 
760 	return r;
761 }
762 
763 #endif /* STA_INFO_H */
764