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