2 * Copyright 2002-2005, Devicescape Software, Inc.
3 * Copyright 2013-2014 Intel Mobile Communications GmbH
4 * Copyright(c) 2015-2017 Intel Deutschland GmbH
5 * Copyright(c) 2020-2021 Intel Corporation
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 as
9 * published by the Free Software Foundation.
15 #include <linux/list.h>
16 #include <linux/types.h>
17 #include <linux/if_ether.h>
18 #include <linux/workqueue.h>
19 #include <linux/average.h>
20 #include <linux/bitfield.h>
21 #include <linux/etherdevice.h>
22 #include <linux/rhashtable.h>
23 #include <linux/u64_stats_sync.h>
27 * enum ieee80211_sta_info_flags - Stations flags
29 * These flags are used with &struct sta_info's @flags member, but
30 * only indirectly with set_sta_flag() and friends.
32 * @WLAN_STA_AUTH: Station is authenticated.
33 * @WLAN_STA_ASSOC: Station is associated.
34 * @WLAN_STA_PS_STA: Station is in power-save mode
35 * @WLAN_STA_AUTHORIZED: Station is authorized to send/receive traffic.
36 * This bit is always checked so needs to be enabled for all stations
37 * when virtual port control is not in use.
38 * @WLAN_STA_SHORT_PREAMBLE: Station is capable of receiving short-preamble
40 * @WLAN_STA_WDS: Station is one of our WDS peers.
41 * @WLAN_STA_CLEAR_PS_FILT: Clear PS filter in hardware (using the
42 * IEEE80211_TX_CTL_CLEAR_PS_FILT control flag) when the next
43 * frame to this station is transmitted.
44 * @WLAN_STA_MFP: Management frame protection is used with this STA.
45 * @WLAN_STA_BLOCK_BA: Used to deny ADDBA requests (both TX and RX)
46 * during suspend/resume and station removal.
47 * @WLAN_STA_PS_DRIVER: driver requires keeping this station in
48 * power-save mode logically to flush frames that might still
50 * @WLAN_STA_PSPOLL: Station sent PS-poll while driver was keeping
51 * station in power-save mode, reply when the driver unblocks.
52 * @WLAN_STA_TDLS_PEER: Station is a TDLS peer.
53 * @WLAN_STA_TDLS_PEER_AUTH: This TDLS peer is authorized to send direct
54 * packets. This means the link is enabled.
55 * @WLAN_STA_TDLS_INITIATOR: We are the initiator of the TDLS link with this
57 * @WLAN_STA_TDLS_CHAN_SWITCH: This TDLS peer supports TDLS channel-switching
58 * @WLAN_STA_TDLS_OFF_CHANNEL: The local STA is currently off-channel with this
60 * @WLAN_STA_TDLS_WIDER_BW: This TDLS peer supports working on a wider bw on
61 * the BSS base channel.
62 * @WLAN_STA_UAPSD: Station requested unscheduled SP while driver was
63 * keeping station in power-save mode, reply when the driver
64 * unblocks the station.
65 * @WLAN_STA_SP: Station is in a service period, so don't try to
66 * reply to other uAPSD trigger frames or PS-Poll.
67 * @WLAN_STA_4ADDR_EVENT: 4-addr event was already sent for this frame.
68 * @WLAN_STA_INSERTED: This station is inserted into the hash table.
69 * @WLAN_STA_RATE_CONTROL: rate control was initialized for this station.
70 * @WLAN_STA_TOFFSET_KNOWN: toffset calculated for this station is valid.
71 * @WLAN_STA_MPSP_OWNER: local STA is owner of a mesh Peer Service Period.
72 * @WLAN_STA_MPSP_RECIPIENT: local STA is recipient of a MPSP.
73 * @WLAN_STA_PS_DELIVER: station woke up, but we're still blocking TX
74 * until pending frames are delivered
76 * @NUM_WLAN_STA_FLAGS: number of defined flags
78 enum ieee80211_sta_info_flags {
83 WLAN_STA_SHORT_PREAMBLE,
85 WLAN_STA_CLEAR_PS_FILT,
91 WLAN_STA_TDLS_PEER_AUTH,
92 WLAN_STA_TDLS_INITIATOR,
93 WLAN_STA_TDLS_CHAN_SWITCH,
94 WLAN_STA_TDLS_OFF_CHANNEL,
95 WLAN_STA_TDLS_WIDER_BW,
100 WLAN_STA_RATE_CONTROL,
101 WLAN_STA_TOFFSET_KNOWN,
103 WLAN_STA_MPSP_RECIPIENT,
105 WLAN_STA_USES_ENCRYPTION,
110 #define ADDBA_RESP_INTERVAL HZ
111 #define HT_AGG_MAX_RETRIES 15
112 #define HT_AGG_BURST_RETRIES 3
113 #define HT_AGG_RETRIES_PERIOD (15 * HZ)
115 #define HT_AGG_STATE_DRV_READY 0
116 #define HT_AGG_STATE_RESPONSE_RECEIVED 1
117 #define HT_AGG_STATE_OPERATIONAL 2
118 #define HT_AGG_STATE_STOPPING 3
119 #define HT_AGG_STATE_WANT_START 4
120 #define HT_AGG_STATE_WANT_STOP 5
121 #define HT_AGG_STATE_START_CB 6
122 #define HT_AGG_STATE_STOP_CB 7
124 DECLARE_EWMA(avg_signal, 10, 8)
125 enum ieee80211_agg_stop_reason {
127 AGG_STOP_LOCAL_REQUEST,
128 AGG_STOP_PEER_REQUEST,
129 AGG_STOP_DESTROY_STA,
135 * struct tid_ampdu_tx - TID aggregation information (Tx).
137 * @rcu_head: rcu head for freeing structure
138 * @session_timer: check if we keep Tx-ing on the TID (by timeout value)
139 * @addba_resp_timer: timer for peer's response to addba request
140 * @pending: pending frames queue -- use sta's spinlock to protect
141 * @sta: station we are attached to
142 * @dialog_token: dialog token for aggregation session
143 * @timeout: session timeout value to be filled in ADDBA requests
145 * @state: session state (see above)
146 * @last_tx: jiffies of last tx activity
147 * @stop_initiator: initiator of a session stop
148 * @tx_stop: TX DelBA frame when stopping
149 * @buf_size: reorder buffer size at receiver
150 * @failed_bar_ssn: ssn of the last failed BAR tx attempt
151 * @bar_pending: BAR needs to be re-sent
152 * @amsdu: support A-MSDU withing A-MDPU
154 * This structure's lifetime is managed by RCU, assignments to
155 * the array holding it must hold the aggregation mutex.
157 * The TX path can access it under RCU lock-free if, and
158 * only if, the state has the flag %HT_AGG_STATE_OPERATIONAL
159 * set. Otherwise, the TX path must also acquire the spinlock
160 * and re-check the state, see comments in the tx code
163 struct tid_ampdu_tx {
164 struct rcu_head rcu_head;
165 struct timer_list session_timer;
166 struct timer_list addba_resp_timer;
167 struct sk_buff_head pending;
168 struct sta_info *sta;
170 unsigned long last_tx;
184 * struct tid_ampdu_rx - TID aggregation information (Rx).
186 * @reorder_buf: buffer to reorder incoming aggregated MPDUs. An MPDU may be an
187 * A-MSDU with individually reported subframes.
188 * @reorder_buf_filtered: bitmap indicating where there are filtered frames in
189 * the reorder buffer that should be ignored when releasing frames
190 * @reorder_time: jiffies when skb was added
191 * @session_timer: check if peer keeps Tx-ing on the TID (by timeout value)
192 * @reorder_timer: releases expired frames from the reorder buffer.
193 * @sta: station we are attached to
194 * @last_rx: jiffies of last rx activity
195 * @head_seq_num: head sequence number in reordering buffer.
196 * @stored_mpdu_num: number of MPDUs in reordering buffer
197 * @ssn: Starting Sequence Number expected to be aggregated.
198 * @buf_size: buffer size for incoming A-MPDUs
199 * @timeout: reset timer value (in TUs).
201 * @rcu_head: RCU head used for freeing this struct
202 * @reorder_lock: serializes access to reorder buffer, see below.
203 * @auto_seq: used for offloaded BA sessions to automatically pick head_seq_and
205 * @removed: this session is removed (but might have been found due to RCU)
206 * @started: this session has started (head ssn or higher was received)
208 * This structure's lifetime is managed by RCU, assignments to
209 * the array holding it must hold the aggregation mutex.
211 * The @reorder_lock is used to protect the members of this
212 * struct, except for @timeout, @buf_size and @dialog_token,
213 * which are constant across the lifetime of the struct (the
214 * dialog token being used only for debugging).
216 struct tid_ampdu_rx {
217 struct rcu_head rcu_head;
218 spinlock_t reorder_lock;
219 u64 reorder_buf_filtered;
220 struct sk_buff_head *reorder_buf;
221 unsigned long *reorder_time;
222 struct sta_info *sta;
223 struct timer_list session_timer;
224 struct timer_list reorder_timer;
225 unsigned long last_rx;
238 * struct sta_ampdu_mlme - STA aggregation information.
240 * @mtx: mutex to protect all TX data (except non-NULL assignments
241 * to tid_tx[idx], which are protected by the sta spinlock)
242 * tid_start_tx is also protected by sta->lock.
243 * @tid_rx: aggregation info for Rx per TID -- RCU protected
244 * @tid_rx_token: dialog tokens for valid aggregation sessions
245 * @tid_rx_timer_expired: bitmap indicating on which TIDs the
246 * RX timer expired until the work for it runs
247 * @tid_rx_stop_requested: bitmap indicating which BA sessions per TID the
248 * driver requested to close until the work for it runs
249 * @tid_rx_manage_offl: bitmap indicating which BA sessions were requested
250 * to be treated as started/stopped due to offloading
251 * @agg_session_valid: bitmap indicating which TID has a rx BA session open on
252 * @unexpected_agg: bitmap indicating which TID already sent a delBA due to
253 * unexpected aggregation related frames outside a session
254 * @work: work struct for starting/stopping aggregation
255 * @tid_tx: aggregation info for Tx per TID
256 * @tid_start_tx: sessions where start was requested
257 * @last_addba_req_time: timestamp of the last addBA request.
258 * @addba_req_num: number of times addBA request has been sent.
259 * @dialog_token_allocator: dialog token enumerator for each new session;
261 struct sta_ampdu_mlme {
264 struct tid_ampdu_rx __rcu *tid_rx[IEEE80211_NUM_TIDS];
265 u8 tid_rx_token[IEEE80211_NUM_TIDS];
266 unsigned long tid_rx_timer_expired[BITS_TO_LONGS(IEEE80211_NUM_TIDS)];
267 unsigned long tid_rx_stop_requested[BITS_TO_LONGS(IEEE80211_NUM_TIDS)];
268 unsigned long tid_rx_manage_offl[BITS_TO_LONGS(2 * IEEE80211_NUM_TIDS)];
269 unsigned long agg_session_valid[BITS_TO_LONGS(IEEE80211_NUM_TIDS)];
270 unsigned long unexpected_agg[BITS_TO_LONGS(IEEE80211_NUM_TIDS)];
272 struct work_struct work;
273 struct tid_ampdu_tx __rcu *tid_tx[IEEE80211_NUM_TIDS];
274 struct tid_ampdu_tx *tid_start_tx[IEEE80211_NUM_TIDS];
275 unsigned long last_addba_req_time[IEEE80211_NUM_TIDS];
276 u8 addba_req_num[IEEE80211_NUM_TIDS];
277 u8 dialog_token_allocator;
281 /* Value to indicate no TID reservation */
282 #define IEEE80211_TID_UNRESERVED 0xff
284 #define IEEE80211_FAST_XMIT_MAX_IV 18
287 * struct ieee80211_fast_tx - TX fastpath information
288 * @key: key to use for hw crypto
289 * @hdr: the 802.11 header to put with the frame
290 * @hdr_len: actual 802.11 header length
291 * @sa_offs: offset of the SA
292 * @da_offs: offset of the DA
293 * @pn_offs: offset where to put PN for crypto (or 0 if not needed)
294 * @band: band this will be transmitted on, for tx_info
295 * @rcu_head: RCU head to free this struct
297 * This struct is small enough so that the common case (maximum crypto
298 * header length of 8 like for CCMP/GCMP) fits into a single 64-byte
301 struct ieee80211_fast_tx {
302 struct ieee80211_key *key;
304 u8 sa_offs, da_offs, pn_offs;
306 u8 hdr[30 + 2 + IEEE80211_FAST_XMIT_MAX_IV +
307 sizeof(rfc1042_header)] __aligned(2);
309 struct rcu_head rcu_head;
313 * struct ieee80211_fast_rx - RX fastpath information
314 * @dev: netdevice for reporting the SKB
315 * @vif_type: (P2P-less) interface type of the original sdata (sdata->vif.type)
316 * @vif_addr: interface address
317 * @rfc1042_hdr: copy of the RFC 1042 SNAP header (to have in cache)
318 * @control_port_protocol: control port protocol copied from sdata
319 * @expected_ds_bits: from/to DS bits expected
320 * @icv_len: length of the MIC if present
321 * @key: bool indicating encryption is expected (key is set)
322 * @sta_notify: notify the MLME code (once)
323 * @internal_forward: forward froms internally on AP/VLAN type interfaces
324 * @uses_rss: copy of USES_RSS hw flag
325 * @da_offs: offset of the DA in the header (for header conversion)
326 * @sa_offs: offset of the SA in the header (for header conversion)
327 * @rcu_head: RCU head for freeing this structure
329 struct ieee80211_fast_rx {
330 struct net_device *dev;
331 enum nl80211_iftype vif_type;
332 u8 vif_addr[ETH_ALEN] __aligned(2);
333 u8 rfc1042_hdr[6] __aligned(2);
334 __be16 control_port_protocol;
335 __le16 expected_ds_bits;
343 struct rcu_head rcu_head;
346 /* we use only values in the range 0-100, so pick a large precision */
347 DECLARE_EWMA(mesh_fail_avg, 20, 8)
350 * struct mesh_sta - mesh STA information
351 * @plink_lock: serialize access to plink fields
352 * @llid: Local link ID
353 * @plid: Peer link ID
354 * @aid: local aid supplied by peer
355 * @reason: Cancel reason on PLINK_HOLDING state
356 * @plink_retries: Retries in establishment
357 * @plink_state: peer link state
358 * @plink_timeout: timeout of peer link
359 * @plink_timer: peer link watch timer
360 * @plink_sta: peer link watch timer's sta_info
361 * @t_offset: timing offset relative to this host
362 * @t_offset_setpoint: reference timing offset of this sta to be used when
363 * calculating clockdrift
364 * @local_pm: local link-specific power save mode
365 * @peer_pm: peer-specific power save mode towards local STA
366 * @nonpeer_pm: STA power save mode towards non-peer neighbors
367 * @processed_beacon: set to true after peer rates and capabilities are
369 * @fail_avg: moving percentage of failed MSDUs
372 struct timer_list plink_timer;
373 struct sta_info *plink_sta;
376 s64 t_offset_setpoint;
378 spinlock_t plink_lock;
385 bool processed_beacon;
387 enum nl80211_plink_state plink_state;
390 /* mesh power save */
391 enum nl80211_mesh_power_mode local_pm;
392 enum nl80211_mesh_power_mode peer_pm;
393 enum nl80211_mesh_power_mode nonpeer_pm;
395 /* moving percentage of failed MSDUs */
396 struct ewma_mesh_fail_avg fail_avg;
399 DECLARE_EWMA(signal, 10, 8)
401 struct ieee80211_sta_rx_stats {
402 unsigned long packets;
403 unsigned long last_rx;
404 unsigned long num_duplicates;
405 unsigned long fragments;
406 unsigned long dropped;
409 s8 chain_signal_last[IEEE80211_MAX_CHAINS];
411 struct u64_stats_sync syncp;
413 u64 msdu[IEEE80211_NUM_TIDS + 1];
417 * IEEE 802.11-2016 (10.6 "Defragmentation") recommends support for "concurrent
418 * reception of at least one MSDU per access category per associated STA"
419 * on APs, or "at least one MSDU per access category" on other interface types.
421 * This limit can be increased by changing this define, at the cost of slower
422 * frame reassembly and increased memory use while fragments are pending.
424 #define IEEE80211_FRAGMENT_MAX 4
426 struct ieee80211_fragment_entry {
427 struct sk_buff_head skb_list;
428 unsigned long first_frag_time;
433 u8 check_sequential_pn:1, /* needed for CCMP/GCMP */
435 u8 last_pn[6]; /* PN of the last fragment if CCMP was used */
436 unsigned int key_color;
439 struct ieee80211_fragment_cache {
440 struct ieee80211_fragment_entry entries[IEEE80211_FRAGMENT_MAX];
445 * The bandwidth threshold below which the per-station CoDel parameters will be
446 * scaled to be more lenient (to prevent starvation of slow stations). This
447 * value will be scaled by the number of active stations when it is being
450 #define STA_SLOW_THRESHOLD 6000 /* 6 Mbps */
453 * struct sta_info - STA information
455 * This structure collects information about a station that
456 * mac80211 is communicating with.
458 * @list: global linked list entry
459 * @free_list: list entry for keeping track of stations to free
460 * @hash_node: hash node for rhashtable
461 * @addr: station's MAC address - duplicated from public part to
462 * let the hash table work with just a single cacheline
463 * @local: pointer to the global information
464 * @sdata: virtual interface this station belongs to
465 * @ptk: peer keys negotiated with this station, if any
466 * @ptk_idx: last installed peer key index
467 * @gtk: group keys negotiated with this station, if any
468 * @rate_ctrl: rate control algorithm reference
469 * @rate_ctrl_lock: spinlock used to protect rate control data
470 * (data inside the algorithm, so serializes calls there)
471 * @rate_ctrl_priv: rate control private per-STA pointer
472 * @lock: used for locking all fields that require locking, see comments
473 * in the header file.
474 * @drv_deliver_wk: used for delivering frames after driver PS unblocking
475 * @listen_interval: listen interval of this station, when we're acting as AP
476 * @_flags: STA flags, see &enum ieee80211_sta_info_flags, do not use directly
477 * @ps_lock: used for powersave (when mac80211 is the AP) related locking
478 * @ps_tx_buf: buffers (per AC) of frames to transmit to this station
479 * when it leaves power saving state or polls
480 * @tx_filtered: buffers (per AC) of frames we already tried to
481 * transmit but were filtered by hardware due to STA having
482 * entered power saving state, these are also delivered to
483 * the station when it leaves powersave or polls for frames
484 * @driver_buffered_tids: bitmap of TIDs the driver has data buffered on
485 * @txq_buffered_tids: bitmap of TIDs that mac80211 has txq data buffered on
486 * @last_connected: time (in seconds) when a station got connected
487 * @last_seq_ctrl: last received seq/frag number from this STA (per TID
488 * plus one for non-QoS frames)
489 * @tid_seq: per-TID sequence numbers for sending to this STA
490 * @ampdu_mlme: A-MPDU state machine state
491 * @mesh: mesh STA information
492 * @debugfs_dir: debug filesystem directory dentry
493 * @dead: set to true when sta is unlinked
494 * @removed: set to true when sta is being removed from sta_list
495 * @uploaded: set to true when sta is uploaded to the driver
496 * @sta: station information we share with the driver
497 * @sta_state: duplicates information about station state (for debug)
498 * @rcu_head: RCU head used for freeing this station struct
499 * @cur_max_bandwidth: maximum bandwidth to use for TX to the station,
500 * taken from HT/VHT capabilities or VHT operating mode notification
501 * @known_smps_mode: the smps_mode the client thinks we are in. Relevant for
503 * @cipher_scheme: optional cipher scheme for this station
504 * @cparams: CoDel parameters for this station.
505 * @reserved_tid: reserved TID (if any, otherwise IEEE80211_TID_UNRESERVED)
506 * @fast_tx: TX fastpath information
507 * @fast_rx: RX fastpath information
508 * @tdls_chandef: a TDLS peer can have a wider chandef that is compatible to
510 * @tx_stats: TX statistics
511 * @rx_stats: RX statistics
512 * @pcpu_rx_stats: per-CPU RX statistics, assigned only if the driver needs
513 * this (by advertising the USES_RSS hw flag)
514 * @status_stats: TX status statistics
515 * @frags: fragment cache
518 /* General information, mostly static */
519 struct list_head list, free_list;
520 struct rcu_head rcu_head;
521 struct rhlist_head hash_node;
523 struct ieee80211_local *local;
524 struct ieee80211_sub_if_data *sdata;
525 struct ieee80211_key __rcu *gtk[NUM_DEFAULT_KEYS + NUM_DEFAULT_MGMT_KEYS];
526 struct ieee80211_key __rcu *ptk[NUM_DEFAULT_KEYS];
528 struct rate_control_ref *rate_ctrl;
529 void *rate_ctrl_priv;
530 spinlock_t rate_ctrl_lock;
533 struct ieee80211_fast_tx __rcu *fast_tx;
534 struct ieee80211_fast_rx __rcu *fast_rx;
535 struct ieee80211_sta_rx_stats __percpu *pcpu_rx_stats;
537 #ifdef CONFIG_MAC80211_MESH
538 struct mesh_sta *mesh;
541 struct work_struct drv_deliver_wk;
550 enum ieee80211_sta_state sta_state;
552 /* use the accessors defined below */
553 unsigned long _flags;
555 /* STA powersave lock and frame queues */
557 struct sk_buff_head ps_tx_buf[IEEE80211_NUM_ACS];
558 struct sk_buff_head tx_filtered[IEEE80211_NUM_ACS];
559 unsigned long driver_buffered_tids;
560 unsigned long txq_buffered_tids;
564 /* Updated from RX path only, no locking requirements */
565 struct ieee80211_sta_rx_stats rx_stats;
567 struct ewma_signal signal;
568 struct ewma_signal chain_signal[IEEE80211_MAX_CHAINS];
571 /* Plus 1 for non-QoS frames */
572 __le16 last_seq_ctrl[IEEE80211_NUM_TIDS + 1];
574 /* Updated from TX status path only, no locking requirements */
576 unsigned long filtered;
577 unsigned long retry_failed, retry_count;
578 unsigned int lost_packets;
579 unsigned long last_tdls_pkt_time;
580 u64 msdu_retries[IEEE80211_NUM_TIDS + 1];
581 u64 msdu_failed[IEEE80211_NUM_TIDS + 1];
582 unsigned long last_ack;
584 bool ack_signal_filled;
585 struct ewma_avg_signal avg_ack_signal;
588 /* Updated from TX path only, no locking requirements */
590 u64 packets[IEEE80211_NUM_ACS];
591 u64 bytes[IEEE80211_NUM_ACS];
592 struct ieee80211_tx_rate last_rate;
593 u64 msdu[IEEE80211_NUM_TIDS + 1];
595 u16 tid_seq[IEEE80211_QOS_CTL_TID_MASK + 1];
598 * Aggregation information, locked with lock.
600 struct sta_ampdu_mlme ampdu_mlme;
602 #ifdef CONFIG_MAC80211_DEBUGFS
603 struct dentry *debugfs_dir;
606 enum ieee80211_sta_rx_bandwidth cur_max_bandwidth;
608 enum ieee80211_smps_mode known_smps_mode;
609 const struct ieee80211_cipher_scheme *cipher_scheme;
611 struct codel_params cparams;
615 struct cfg80211_chan_def tdls_chandef;
617 struct ieee80211_fragment_cache frags;
620 struct ieee80211_sta sta;
623 static inline enum nl80211_plink_state sta_plink_state(struct sta_info *sta)
625 #ifdef CONFIG_MAC80211_MESH
626 return sta->mesh->plink_state;
628 return NL80211_PLINK_LISTEN;
631 static inline void set_sta_flag(struct sta_info *sta,
632 enum ieee80211_sta_info_flags flag)
634 WARN_ON(flag == WLAN_STA_AUTH ||
635 flag == WLAN_STA_ASSOC ||
636 flag == WLAN_STA_AUTHORIZED);
637 set_bit(flag, &sta->_flags);
640 static inline void clear_sta_flag(struct sta_info *sta,
641 enum ieee80211_sta_info_flags flag)
643 WARN_ON(flag == WLAN_STA_AUTH ||
644 flag == WLAN_STA_ASSOC ||
645 flag == WLAN_STA_AUTHORIZED);
646 clear_bit(flag, &sta->_flags);
649 static inline int test_sta_flag(struct sta_info *sta,
650 enum ieee80211_sta_info_flags flag)
652 return test_bit(flag, &sta->_flags);
655 static inline int test_and_clear_sta_flag(struct sta_info *sta,
656 enum ieee80211_sta_info_flags flag)
658 WARN_ON(flag == WLAN_STA_AUTH ||
659 flag == WLAN_STA_ASSOC ||
660 flag == WLAN_STA_AUTHORIZED);
661 return test_and_clear_bit(flag, &sta->_flags);
664 static inline int test_and_set_sta_flag(struct sta_info *sta,
665 enum ieee80211_sta_info_flags flag)
667 WARN_ON(flag == WLAN_STA_AUTH ||
668 flag == WLAN_STA_ASSOC ||
669 flag == WLAN_STA_AUTHORIZED);
670 return test_and_set_bit(flag, &sta->_flags);
673 int sta_info_move_state(struct sta_info *sta,
674 enum ieee80211_sta_state new_state);
676 static inline void sta_info_pre_move_state(struct sta_info *sta,
677 enum ieee80211_sta_state new_state)
681 WARN_ON_ONCE(test_sta_flag(sta, WLAN_STA_INSERTED));
683 ret = sta_info_move_state(sta, new_state);
688 void ieee80211_assign_tid_tx(struct sta_info *sta, int tid,
689 struct tid_ampdu_tx *tid_tx);
691 static inline struct tid_ampdu_tx *
692 rcu_dereference_protected_tid_tx(struct sta_info *sta, int tid)
694 return rcu_dereference_protected(sta->ampdu_mlme.tid_tx[tid],
695 lockdep_is_held(&sta->lock) ||
696 lockdep_is_held(&sta->ampdu_mlme.mtx));
699 /* Maximum number of frames to buffer per power saving station per AC */
700 #define STA_MAX_TX_BUFFER 64
702 /* Minimum buffered frame expiry time. If STA uses listen interval that is
703 * smaller than this value, the minimum value here is used instead. */
704 #define STA_TX_BUFFER_EXPIRE (10 * HZ)
706 /* How often station data is cleaned up (e.g., expiration of buffered frames)
708 #define STA_INFO_CLEANUP_INTERVAL (10 * HZ)
710 struct rhlist_head *sta_info_hash_lookup(struct ieee80211_local *local,
714 * Get a STA info, must be under RCU read lock.
716 struct sta_info *sta_info_get(struct ieee80211_sub_if_data *sdata,
719 struct sta_info *sta_info_get_bss(struct ieee80211_sub_if_data *sdata,
722 #define for_each_sta_info(local, _addr, _sta, _tmp) \
723 rhl_for_each_entry_rcu(_sta, _tmp, \
724 sta_info_hash_lookup(local, _addr), hash_node)
727 * Get STA info by index, BROKEN!
729 struct sta_info *sta_info_get_by_idx(struct ieee80211_sub_if_data *sdata,
732 * Create a new STA info, caller owns returned structure
733 * until sta_info_insert().
735 struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
736 const u8 *addr, gfp_t gfp);
738 void sta_info_free(struct ieee80211_local *local, struct sta_info *sta);
741 * Insert STA info into hash table/list, returns zero or a
742 * -EEXIST if (if the same MAC address is already present).
744 * Calling the non-rcu version makes the caller relinquish,
745 * the _rcu version calls read_lock_rcu() and must be called
748 int sta_info_insert(struct sta_info *sta);
749 int sta_info_insert_rcu(struct sta_info *sta) __acquires(RCU);
751 int __must_check __sta_info_destroy(struct sta_info *sta);
752 int sta_info_destroy_addr(struct ieee80211_sub_if_data *sdata,
754 int sta_info_destroy_addr_bss(struct ieee80211_sub_if_data *sdata,
757 void sta_info_recalc_tim(struct sta_info *sta);
759 int sta_info_init(struct ieee80211_local *local);
760 void sta_info_stop(struct ieee80211_local *local);
763 * sta_info_flush - flush matching STA entries from the STA table
765 * Returns the number of removed STA entries.
767 * @sdata: sdata to remove all stations from
768 * @vlans: if the given interface is an AP interface, also flush VLANs
770 int __sta_info_flush(struct ieee80211_sub_if_data *sdata, bool vlans);
772 static inline int sta_info_flush(struct ieee80211_sub_if_data *sdata)
774 return __sta_info_flush(sdata, false);
777 void sta_set_rate_info_tx(struct sta_info *sta,
778 const struct ieee80211_tx_rate *rate,
779 struct rate_info *rinfo);
780 void sta_set_sinfo(struct sta_info *sta, struct station_info *sinfo,
783 u32 sta_get_expected_throughput(struct sta_info *sta);
785 void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata,
786 unsigned long exp_time);
787 u8 sta_info_tx_streams(struct sta_info *sta);
789 void ieee80211_sta_ps_deliver_wakeup(struct sta_info *sta);
790 void ieee80211_sta_ps_deliver_poll_response(struct sta_info *sta);
791 void ieee80211_sta_ps_deliver_uapsd(struct sta_info *sta);
793 unsigned long ieee80211_sta_last_active(struct sta_info *sta);
795 enum sta_stats_type {
796 STA_STATS_RATE_TYPE_INVALID = 0,
797 STA_STATS_RATE_TYPE_LEGACY,
798 STA_STATS_RATE_TYPE_HT,
799 STA_STATS_RATE_TYPE_VHT,
800 STA_STATS_RATE_TYPE_HE,
803 #define STA_STATS_FIELD_HT_MCS GENMASK( 7, 0)
804 #define STA_STATS_FIELD_LEGACY_IDX GENMASK( 3, 0)
805 #define STA_STATS_FIELD_LEGACY_BAND GENMASK( 7, 4)
806 #define STA_STATS_FIELD_VHT_MCS GENMASK( 3, 0)
807 #define STA_STATS_FIELD_VHT_NSS GENMASK( 7, 4)
808 #define STA_STATS_FIELD_HE_MCS GENMASK( 3, 0)
809 #define STA_STATS_FIELD_HE_NSS GENMASK( 7, 4)
810 #define STA_STATS_FIELD_BW GENMASK(11, 8)
811 #define STA_STATS_FIELD_SGI GENMASK(12, 12)
812 #define STA_STATS_FIELD_TYPE GENMASK(15, 13)
813 #define STA_STATS_FIELD_HE_RU GENMASK(18, 16)
814 #define STA_STATS_FIELD_HE_GI GENMASK(20, 19)
815 #define STA_STATS_FIELD_HE_DCM GENMASK(21, 21)
817 #define STA_STATS_FIELD(_n, _v) FIELD_PREP(STA_STATS_FIELD_ ## _n, _v)
818 #define STA_STATS_GET(_n, _v) FIELD_GET(STA_STATS_FIELD_ ## _n, _v)
820 #define STA_STATS_RATE_INVALID 0
822 static inline u32 sta_stats_encode_rate(struct ieee80211_rx_status *s)
826 r = STA_STATS_FIELD(BW, s->bw);
828 if (s->enc_flags & RX_ENC_FLAG_SHORT_GI)
829 r |= STA_STATS_FIELD(SGI, 1);
831 switch (s->encoding) {
833 r |= STA_STATS_FIELD(TYPE, STA_STATS_RATE_TYPE_VHT);
834 r |= STA_STATS_FIELD(VHT_NSS, s->nss);
835 r |= STA_STATS_FIELD(VHT_MCS, s->rate_idx);
838 r |= STA_STATS_FIELD(TYPE, STA_STATS_RATE_TYPE_HT);
839 r |= STA_STATS_FIELD(HT_MCS, s->rate_idx);
842 r |= STA_STATS_FIELD(TYPE, STA_STATS_RATE_TYPE_LEGACY);
843 r |= STA_STATS_FIELD(LEGACY_BAND, s->band);
844 r |= STA_STATS_FIELD(LEGACY_IDX, s->rate_idx);
847 r |= STA_STATS_FIELD(TYPE, STA_STATS_RATE_TYPE_HE);
848 r |= STA_STATS_FIELD(HE_NSS, s->nss);
849 r |= STA_STATS_FIELD(HE_MCS, s->rate_idx);
850 r |= STA_STATS_FIELD(HE_GI, s->he_gi);
851 r |= STA_STATS_FIELD(HE_RU, s->he_ru);
852 r |= STA_STATS_FIELD(HE_DCM, s->he_dcm);
856 return STA_STATS_RATE_INVALID;
862 #endif /* STA_INFO_H */