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