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