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