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