Back to home page

OSCL-LXR
 
 

     

0001 /* SPDX-License-Identifier: GPL-2.0-only */
0002 /*
0003  * Copyright 2002-2005, Devicescape Software, Inc.
0004  * Copyright 2013-2014  Intel Mobile Communications GmbH
0005  * Copyright(c) 2015-2017 Intel Deutschland GmbH
0006  * Copyright(c) 2020-2022 Intel Corporation
0007  */
0008 
0009 #ifndef STA_INFO_H
0010 #define STA_INFO_H
0011 
0012 #include <linux/list.h>
0013 #include <linux/types.h>
0014 #include <linux/if_ether.h>
0015 #include <linux/workqueue.h>
0016 #include <linux/average.h>
0017 #include <linux/bitfield.h>
0018 #include <linux/etherdevice.h>
0019 #include <linux/rhashtable.h>
0020 #include <linux/u64_stats_sync.h>
0021 #include "key.h"
0022 
0023 /**
0024  * enum ieee80211_sta_info_flags - Stations flags
0025  *
0026  * These flags are used with &struct sta_info's @flags member, but
0027  * only indirectly with set_sta_flag() and friends.
0028  *
0029  * @WLAN_STA_AUTH: Station is authenticated.
0030  * @WLAN_STA_ASSOC: Station is associated.
0031  * @WLAN_STA_PS_STA: Station is in power-save mode
0032  * @WLAN_STA_AUTHORIZED: Station is authorized to send/receive traffic.
0033  *  This bit is always checked so needs to be enabled for all stations
0034  *  when virtual port control is not in use.
0035  * @WLAN_STA_SHORT_PREAMBLE: Station is capable of receiving short-preamble
0036  *  frames.
0037  * @WLAN_STA_WDS: Station is one of our WDS peers.
0038  * @WLAN_STA_CLEAR_PS_FILT: Clear PS filter in hardware (using the
0039  *  IEEE80211_TX_CTL_CLEAR_PS_FILT control flag) when the next
0040  *  frame to this station is transmitted.
0041  * @WLAN_STA_MFP: Management frame protection is used with this STA.
0042  * @WLAN_STA_BLOCK_BA: Used to deny ADDBA requests (both TX and RX)
0043  *  during suspend/resume and station removal.
0044  * @WLAN_STA_PS_DRIVER: driver requires keeping this station in
0045  *  power-save mode logically to flush frames that might still
0046  *  be in the queues
0047  * @WLAN_STA_PSPOLL: Station sent PS-poll while driver was keeping
0048  *  station in power-save mode, reply when the driver unblocks.
0049  * @WLAN_STA_TDLS_PEER: Station is a TDLS peer.
0050  * @WLAN_STA_TDLS_PEER_AUTH: This TDLS peer is authorized to send direct
0051  *  packets. This means the link is enabled.
0052  * @WLAN_STA_TDLS_INITIATOR: We are the initiator of the TDLS link with this
0053  *  station.
0054  * @WLAN_STA_TDLS_CHAN_SWITCH: This TDLS peer supports TDLS channel-switching
0055  * @WLAN_STA_TDLS_OFF_CHANNEL: The local STA is currently off-channel with this
0056  *  TDLS peer
0057  * @WLAN_STA_TDLS_WIDER_BW: This TDLS peer supports working on a wider bw on
0058  *  the BSS base channel.
0059  * @WLAN_STA_UAPSD: Station requested unscheduled SP while driver was
0060  *  keeping station in power-save mode, reply when the driver
0061  *  unblocks the station.
0062  * @WLAN_STA_SP: Station is in a service period, so don't try to
0063  *  reply to other uAPSD trigger frames or PS-Poll.
0064  * @WLAN_STA_4ADDR_EVENT: 4-addr event was already sent for this frame.
0065  * @WLAN_STA_INSERTED: This station is inserted into the hash table.
0066  * @WLAN_STA_RATE_CONTROL: rate control was initialized for this station.
0067  * @WLAN_STA_TOFFSET_KNOWN: toffset calculated for this station is valid.
0068  * @WLAN_STA_MPSP_OWNER: local STA is owner of a mesh Peer Service Period.
0069  * @WLAN_STA_MPSP_RECIPIENT: local STA is recipient of a MPSP.
0070  * @WLAN_STA_PS_DELIVER: station woke up, but we're still blocking TX
0071  *  until pending frames are delivered
0072  * @WLAN_STA_USES_ENCRYPTION: This station was configured for encryption,
0073  *  so drop all packets without a key later.
0074  * @WLAN_STA_DECAP_OFFLOAD: This station uses rx decap offload
0075  *
0076  * @NUM_WLAN_STA_FLAGS: number of defined flags
0077  */
0078 enum ieee80211_sta_info_flags {
0079     WLAN_STA_AUTH,
0080     WLAN_STA_ASSOC,
0081     WLAN_STA_PS_STA,
0082     WLAN_STA_AUTHORIZED,
0083     WLAN_STA_SHORT_PREAMBLE,
0084     WLAN_STA_WDS,
0085     WLAN_STA_CLEAR_PS_FILT,
0086     WLAN_STA_MFP,
0087     WLAN_STA_BLOCK_BA,
0088     WLAN_STA_PS_DRIVER,
0089     WLAN_STA_PSPOLL,
0090     WLAN_STA_TDLS_PEER,
0091     WLAN_STA_TDLS_PEER_AUTH,
0092     WLAN_STA_TDLS_INITIATOR,
0093     WLAN_STA_TDLS_CHAN_SWITCH,
0094     WLAN_STA_TDLS_OFF_CHANNEL,
0095     WLAN_STA_TDLS_WIDER_BW,
0096     WLAN_STA_UAPSD,
0097     WLAN_STA_SP,
0098     WLAN_STA_4ADDR_EVENT,
0099     WLAN_STA_INSERTED,
0100     WLAN_STA_RATE_CONTROL,
0101     WLAN_STA_TOFFSET_KNOWN,
0102     WLAN_STA_MPSP_OWNER,
0103     WLAN_STA_MPSP_RECIPIENT,
0104     WLAN_STA_PS_DELIVER,
0105     WLAN_STA_USES_ENCRYPTION,
0106     WLAN_STA_DECAP_OFFLOAD,
0107 
0108     NUM_WLAN_STA_FLAGS,
0109 };
0110 
0111 #define ADDBA_RESP_INTERVAL HZ
0112 #define HT_AGG_MAX_RETRIES      15
0113 #define HT_AGG_BURST_RETRIES        3
0114 #define HT_AGG_RETRIES_PERIOD       (15 * HZ)
0115 
0116 #define HT_AGG_STATE_DRV_READY      0
0117 #define HT_AGG_STATE_RESPONSE_RECEIVED  1
0118 #define HT_AGG_STATE_OPERATIONAL    2
0119 #define HT_AGG_STATE_STOPPING       3
0120 #define HT_AGG_STATE_WANT_START     4
0121 #define HT_AGG_STATE_WANT_STOP      5
0122 #define HT_AGG_STATE_START_CB       6
0123 #define HT_AGG_STATE_STOP_CB        7
0124 #define HT_AGG_STATE_SENT_ADDBA     8
0125 
0126 DECLARE_EWMA(avg_signal, 10, 8)
0127 enum ieee80211_agg_stop_reason {
0128     AGG_STOP_DECLINED,
0129     AGG_STOP_LOCAL_REQUEST,
0130     AGG_STOP_PEER_REQUEST,
0131     AGG_STOP_DESTROY_STA,
0132 };
0133 
0134 /* Debugfs flags to enable/disable use of RX/TX airtime in scheduler */
0135 #define AIRTIME_USE_TX      BIT(0)
0136 #define AIRTIME_USE_RX      BIT(1)
0137 
0138 struct airtime_info {
0139     u64 rx_airtime;
0140     u64 tx_airtime;
0141     u32 last_active;
0142     s32 deficit;
0143     atomic_t aql_tx_pending; /* Estimated airtime for frames pending */
0144     u32 aql_limit_low;
0145     u32 aql_limit_high;
0146 };
0147 
0148 void ieee80211_sta_update_pending_airtime(struct ieee80211_local *local,
0149                       struct sta_info *sta, u8 ac,
0150                       u16 tx_airtime, bool tx_completed);
0151 
0152 struct sta_info;
0153 
0154 /**
0155  * struct tid_ampdu_tx - TID aggregation information (Tx).
0156  *
0157  * @rcu_head: rcu head for freeing structure
0158  * @session_timer: check if we keep Tx-ing on the TID (by timeout value)
0159  * @addba_resp_timer: timer for peer's response to addba request
0160  * @pending: pending frames queue -- use sta's spinlock to protect
0161  * @sta: station we are attached to
0162  * @dialog_token: dialog token for aggregation session
0163  * @timeout: session timeout value to be filled in ADDBA requests
0164  * @tid: TID number
0165  * @state: session state (see above)
0166  * @last_tx: jiffies of last tx activity
0167  * @stop_initiator: initiator of a session stop
0168  * @tx_stop: TX DelBA frame when stopping
0169  * @buf_size: reorder buffer size at receiver
0170  * @failed_bar_ssn: ssn of the last failed BAR tx attempt
0171  * @bar_pending: BAR needs to be re-sent
0172  * @amsdu: support A-MSDU withing A-MDPU
0173  * @ssn: starting sequence number of the session
0174  *
0175  * This structure's lifetime is managed by RCU, assignments to
0176  * the array holding it must hold the aggregation mutex.
0177  *
0178  * The TX path can access it under RCU lock-free if, and
0179  * only if, the state has the flag %HT_AGG_STATE_OPERATIONAL
0180  * set. Otherwise, the TX path must also acquire the spinlock
0181  * and re-check the state, see comments in the tx code
0182  * touching it.
0183  */
0184 struct tid_ampdu_tx {
0185     struct rcu_head rcu_head;
0186     struct timer_list session_timer;
0187     struct timer_list addba_resp_timer;
0188     struct sk_buff_head pending;
0189     struct sta_info *sta;
0190     unsigned long state;
0191     unsigned long last_tx;
0192     u16 timeout;
0193     u8 dialog_token;
0194     u8 stop_initiator;
0195     bool tx_stop;
0196     u16 buf_size;
0197     u16 ssn;
0198 
0199     u16 failed_bar_ssn;
0200     bool bar_pending;
0201     bool amsdu;
0202     u8 tid;
0203 };
0204 
0205 /**
0206  * struct tid_ampdu_rx - TID aggregation information (Rx).
0207  *
0208  * @reorder_buf: buffer to reorder incoming aggregated MPDUs. An MPDU may be an
0209  *  A-MSDU with individually reported subframes.
0210  * @reorder_buf_filtered: bitmap indicating where there are filtered frames in
0211  *  the reorder buffer that should be ignored when releasing frames
0212  * @reorder_time: jiffies when skb was added
0213  * @session_timer: check if peer keeps Tx-ing on the TID (by timeout value)
0214  * @reorder_timer: releases expired frames from the reorder buffer.
0215  * @sta: station we are attached to
0216  * @last_rx: jiffies of last rx activity
0217  * @head_seq_num: head sequence number in reordering buffer.
0218  * @stored_mpdu_num: number of MPDUs in reordering buffer
0219  * @ssn: Starting Sequence Number expected to be aggregated.
0220  * @buf_size: buffer size for incoming A-MPDUs
0221  * @timeout: reset timer value (in TUs).
0222  * @tid: TID number
0223  * @rcu_head: RCU head used for freeing this struct
0224  * @reorder_lock: serializes access to reorder buffer, see below.
0225  * @auto_seq: used for offloaded BA sessions to automatically pick head_seq_and
0226  *  and ssn.
0227  * @removed: this session is removed (but might have been found due to RCU)
0228  * @started: this session has started (head ssn or higher was received)
0229  *
0230  * This structure's lifetime is managed by RCU, assignments to
0231  * the array holding it must hold the aggregation mutex.
0232  *
0233  * The @reorder_lock is used to protect the members of this
0234  * struct, except for @timeout, @buf_size and @dialog_token,
0235  * which are constant across the lifetime of the struct (the
0236  * dialog token being used only for debugging).
0237  */
0238 struct tid_ampdu_rx {
0239     struct rcu_head rcu_head;
0240     spinlock_t reorder_lock;
0241     u64 reorder_buf_filtered;
0242     struct sk_buff_head *reorder_buf;
0243     unsigned long *reorder_time;
0244     struct sta_info *sta;
0245     struct timer_list session_timer;
0246     struct timer_list reorder_timer;
0247     unsigned long last_rx;
0248     u16 head_seq_num;
0249     u16 stored_mpdu_num;
0250     u16 ssn;
0251     u16 buf_size;
0252     u16 timeout;
0253     u8 tid;
0254     u8 auto_seq:1,
0255        removed:1,
0256        started:1;
0257 };
0258 
0259 /**
0260  * struct sta_ampdu_mlme - STA aggregation information.
0261  *
0262  * @mtx: mutex to protect all TX data (except non-NULL assignments
0263  *  to tid_tx[idx], which are protected by the sta spinlock)
0264  *  tid_start_tx is also protected by sta->lock.
0265  * @tid_rx: aggregation info for Rx per TID -- RCU protected
0266  * @tid_rx_token: dialog tokens for valid aggregation sessions
0267  * @tid_rx_timer_expired: bitmap indicating on which TIDs the
0268  *  RX timer expired until the work for it runs
0269  * @tid_rx_stop_requested:  bitmap indicating which BA sessions per TID the
0270  *  driver requested to close until the work for it runs
0271  * @tid_rx_manage_offl: bitmap indicating which BA sessions were requested
0272  *  to be treated as started/stopped due to offloading
0273  * @agg_session_valid: bitmap indicating which TID has a rx BA session open on
0274  * @unexpected_agg: bitmap indicating which TID already sent a delBA due to
0275  *  unexpected aggregation related frames outside a session
0276  * @work: work struct for starting/stopping aggregation
0277  * @tid_tx: aggregation info for Tx per TID
0278  * @tid_start_tx: sessions where start was requested
0279  * @last_addba_req_time: timestamp of the last addBA request.
0280  * @addba_req_num: number of times addBA request has been sent.
0281  * @dialog_token_allocator: dialog token enumerator for each new session;
0282  */
0283 struct sta_ampdu_mlme {
0284     struct mutex mtx;
0285     /* rx */
0286     struct tid_ampdu_rx __rcu *tid_rx[IEEE80211_NUM_TIDS];
0287     u8 tid_rx_token[IEEE80211_NUM_TIDS];
0288     unsigned long tid_rx_timer_expired[BITS_TO_LONGS(IEEE80211_NUM_TIDS)];
0289     unsigned long tid_rx_stop_requested[BITS_TO_LONGS(IEEE80211_NUM_TIDS)];
0290     unsigned long tid_rx_manage_offl[BITS_TO_LONGS(2 * IEEE80211_NUM_TIDS)];
0291     unsigned long agg_session_valid[BITS_TO_LONGS(IEEE80211_NUM_TIDS)];
0292     unsigned long unexpected_agg[BITS_TO_LONGS(IEEE80211_NUM_TIDS)];
0293     /* tx */
0294     struct work_struct work;
0295     struct tid_ampdu_tx __rcu *tid_tx[IEEE80211_NUM_TIDS];
0296     struct tid_ampdu_tx *tid_start_tx[IEEE80211_NUM_TIDS];
0297     unsigned long last_addba_req_time[IEEE80211_NUM_TIDS];
0298     u8 addba_req_num[IEEE80211_NUM_TIDS];
0299     u8 dialog_token_allocator;
0300 };
0301 
0302 
0303 /* Value to indicate no TID reservation */
0304 #define IEEE80211_TID_UNRESERVED    0xff
0305 
0306 #define IEEE80211_FAST_XMIT_MAX_IV  18
0307 
0308 /**
0309  * struct ieee80211_fast_tx - TX fastpath information
0310  * @key: key to use for hw crypto
0311  * @hdr: the 802.11 header to put with the frame
0312  * @hdr_len: actual 802.11 header length
0313  * @sa_offs: offset of the SA
0314  * @da_offs: offset of the DA
0315  * @pn_offs: offset where to put PN for crypto (or 0 if not needed)
0316  * @band: band this will be transmitted on, for tx_info
0317  * @rcu_head: RCU head to free this struct
0318  *
0319  * This struct is small enough so that the common case (maximum crypto
0320  * header length of 8 like for CCMP/GCMP) fits into a single 64-byte
0321  * cache line.
0322  */
0323 struct ieee80211_fast_tx {
0324     struct ieee80211_key *key;
0325     u8 hdr_len;
0326     u8 sa_offs, da_offs, pn_offs;
0327     u8 band;
0328     u8 hdr[30 + 2 + IEEE80211_FAST_XMIT_MAX_IV +
0329            sizeof(rfc1042_header)] __aligned(2);
0330 
0331     struct rcu_head rcu_head;
0332 };
0333 
0334 /**
0335  * struct ieee80211_fast_rx - RX fastpath information
0336  * @dev: netdevice for reporting the SKB
0337  * @vif_type: (P2P-less) interface type of the original sdata (sdata->vif.type)
0338  * @vif_addr: interface address
0339  * @rfc1042_hdr: copy of the RFC 1042 SNAP header (to have in cache)
0340  * @control_port_protocol: control port protocol copied from sdata
0341  * @expected_ds_bits: from/to DS bits expected
0342  * @icv_len: length of the MIC if present
0343  * @key: bool indicating encryption is expected (key is set)
0344  * @internal_forward: forward froms internally on AP/VLAN type interfaces
0345  * @uses_rss: copy of USES_RSS hw flag
0346  * @da_offs: offset of the DA in the header (for header conversion)
0347  * @sa_offs: offset of the SA in the header (for header conversion)
0348  * @rcu_head: RCU head for freeing this structure
0349  */
0350 struct ieee80211_fast_rx {
0351     struct net_device *dev;
0352     enum nl80211_iftype vif_type;
0353     u8 vif_addr[ETH_ALEN] __aligned(2);
0354     u8 rfc1042_hdr[6] __aligned(2);
0355     __be16 control_port_protocol;
0356     __le16 expected_ds_bits;
0357     u8 icv_len;
0358     u8 key:1,
0359        internal_forward:1,
0360        uses_rss:1;
0361     u8 da_offs, sa_offs;
0362 
0363     struct rcu_head rcu_head;
0364 };
0365 
0366 /* we use only values in the range 0-100, so pick a large precision */
0367 DECLARE_EWMA(mesh_fail_avg, 20, 8)
0368 DECLARE_EWMA(mesh_tx_rate_avg, 8, 16)
0369 
0370 /**
0371  * struct mesh_sta - mesh STA information
0372  * @plink_lock: serialize access to plink fields
0373  * @llid: Local link ID
0374  * @plid: Peer link ID
0375  * @aid: local aid supplied by peer
0376  * @reason: Cancel reason on PLINK_HOLDING state
0377  * @plink_retries: Retries in establishment
0378  * @plink_state: peer link state
0379  * @plink_timeout: timeout of peer link
0380  * @plink_timer: peer link watch timer
0381  * @plink_sta: peer link watch timer's sta_info
0382  * @t_offset: timing offset relative to this host
0383  * @t_offset_setpoint: reference timing offset of this sta to be used when
0384  *  calculating clockdrift
0385  * @local_pm: local link-specific power save mode
0386  * @peer_pm: peer-specific power save mode towards local STA
0387  * @nonpeer_pm: STA power save mode towards non-peer neighbors
0388  * @processed_beacon: set to true after peer rates and capabilities are
0389  *  processed
0390  * @connected_to_gate: true if mesh STA has a path to a mesh gate
0391  * @connected_to_as: true if mesh STA has a path to a authentication server
0392  * @fail_avg: moving percentage of failed MSDUs
0393  * @tx_rate_avg: moving average of tx bitrate
0394  */
0395 struct mesh_sta {
0396     struct timer_list plink_timer;
0397     struct sta_info *plink_sta;
0398 
0399     s64 t_offset;
0400     s64 t_offset_setpoint;
0401 
0402     spinlock_t plink_lock;
0403     u16 llid;
0404     u16 plid;
0405     u16 aid;
0406     u16 reason;
0407     u8 plink_retries;
0408 
0409     bool processed_beacon;
0410     bool connected_to_gate;
0411     bool connected_to_as;
0412 
0413     enum nl80211_plink_state plink_state;
0414     u32 plink_timeout;
0415 
0416     /* mesh power save */
0417     enum nl80211_mesh_power_mode local_pm;
0418     enum nl80211_mesh_power_mode peer_pm;
0419     enum nl80211_mesh_power_mode nonpeer_pm;
0420 
0421     /* moving percentage of failed MSDUs */
0422     struct ewma_mesh_fail_avg fail_avg;
0423     /* moving average of tx bitrate */
0424     struct ewma_mesh_tx_rate_avg tx_rate_avg;
0425 };
0426 
0427 DECLARE_EWMA(signal, 10, 8)
0428 
0429 struct ieee80211_sta_rx_stats {
0430     unsigned long packets;
0431     unsigned long last_rx;
0432     unsigned long num_duplicates;
0433     unsigned long fragments;
0434     unsigned long dropped;
0435     int last_signal;
0436     u8 chains;
0437     s8 chain_signal_last[IEEE80211_MAX_CHAINS];
0438     u32 last_rate;
0439     struct u64_stats_sync syncp;
0440     u64 bytes;
0441     u64 msdu[IEEE80211_NUM_TIDS + 1];
0442 };
0443 
0444 /*
0445  * IEEE 802.11-2016 (10.6 "Defragmentation") recommends support for "concurrent
0446  * reception of at least one MSDU per access category per associated STA"
0447  * on APs, or "at least one MSDU per access category" on other interface types.
0448  *
0449  * This limit can be increased by changing this define, at the cost of slower
0450  * frame reassembly and increased memory use while fragments are pending.
0451  */
0452 #define IEEE80211_FRAGMENT_MAX 4
0453 
0454 struct ieee80211_fragment_entry {
0455     struct sk_buff_head skb_list;
0456     unsigned long first_frag_time;
0457     u16 seq;
0458     u16 extra_len;
0459     u16 last_frag;
0460     u8 rx_queue;
0461     u8 check_sequential_pn:1, /* needed for CCMP/GCMP */
0462        is_protected:1;
0463     u8 last_pn[6]; /* PN of the last fragment if CCMP was used */
0464     unsigned int key_color;
0465 };
0466 
0467 struct ieee80211_fragment_cache {
0468     struct ieee80211_fragment_entry entries[IEEE80211_FRAGMENT_MAX];
0469     unsigned int next;
0470 };
0471 
0472 /*
0473  * The bandwidth threshold below which the per-station CoDel parameters will be
0474  * scaled to be more lenient (to prevent starvation of slow stations). This
0475  * value will be scaled by the number of active stations when it is being
0476  * applied.
0477  */
0478 #define STA_SLOW_THRESHOLD 6000 /* 6 Mbps */
0479 
0480 /**
0481  * struct link_sta_info - Link STA information
0482  * All link specific sta info are stored here for reference. This can be
0483  * a single entry for non-MLD STA or multiple entries for MLD STA
0484  * @addr: Link MAC address - Can be same as MLD STA mac address and is always
0485  *  same for non-MLD STA. This is used as key for searching link STA
0486  * @link_id: Link ID uniquely identifying the link STA. This is 0 for non-MLD
0487  *  and set to the corresponding vif LinkId for MLD STA
0488  * @link_hash_node: hash node for rhashtable
0489  * @sta: Points to the STA info
0490  * @gtk: group keys negotiated with this station, if any
0491  * @tx_stats: TX statistics
0492  * @tx_stats.packets: # of packets transmitted
0493  * @tx_stats.bytes: # of bytes in all packets transmitted
0494  * @tx_stats.last_rate: last TX rate
0495  * @tx_stats.msdu: # of transmitted MSDUs per TID
0496  * @rx_stats: RX statistics
0497  * @rx_stats_avg: averaged RX statistics
0498  * @rx_stats_avg.signal: averaged signal
0499  * @rx_stats_avg.chain_signal: averaged per-chain signal
0500  * @pcpu_rx_stats: per-CPU RX statistics, assigned only if the driver needs
0501  *  this (by advertising the USES_RSS hw flag)
0502  * @status_stats: TX status statistics
0503  * @status_stats.filtered: # of filtered frames
0504  * @status_stats.retry_failed: # of frames that failed after retry
0505  * @status_stats.retry_count: # of retries attempted
0506  * @status_stats.lost_packets: # of lost packets
0507  * @status_stats.last_pkt_time: timestamp of last ACKed packet
0508  * @status_stats.msdu_retries: # of MSDU retries
0509  * @status_stats.msdu_failed: # of failed MSDUs
0510  * @status_stats.last_ack: last ack timestamp (jiffies)
0511  * @status_stats.last_ack_signal: last ACK signal
0512  * @status_stats.ack_signal_filled: last ACK signal validity
0513  * @status_stats.avg_ack_signal: average ACK signal
0514  * @cur_max_bandwidth: maximum bandwidth to use for TX to the station,
0515  *  taken from HT/VHT capabilities or VHT operating mode notification
0516  * @pub: public (driver visible) link STA data
0517  * TODO Move other link params from sta_info as required for MLD operation
0518  */
0519 struct link_sta_info {
0520     u8 addr[ETH_ALEN];
0521     u8 link_id;
0522 
0523     struct rhlist_head link_hash_node;
0524 
0525     struct sta_info *sta;
0526     struct ieee80211_key __rcu *gtk[NUM_DEFAULT_KEYS +
0527                     NUM_DEFAULT_MGMT_KEYS +
0528                     NUM_DEFAULT_BEACON_KEYS];
0529     struct ieee80211_sta_rx_stats __percpu *pcpu_rx_stats;
0530 
0531     /* Updated from RX path only, no locking requirements */
0532     struct ieee80211_sta_rx_stats rx_stats;
0533     struct {
0534         struct ewma_signal signal;
0535         struct ewma_signal chain_signal[IEEE80211_MAX_CHAINS];
0536     } rx_stats_avg;
0537 
0538     /* Updated from TX status path only, no locking requirements */
0539     struct {
0540         unsigned long filtered;
0541         unsigned long retry_failed, retry_count;
0542         unsigned int lost_packets;
0543         unsigned long last_pkt_time;
0544         u64 msdu_retries[IEEE80211_NUM_TIDS + 1];
0545         u64 msdu_failed[IEEE80211_NUM_TIDS + 1];
0546         unsigned long last_ack;
0547         s8 last_ack_signal;
0548         bool ack_signal_filled;
0549         struct ewma_avg_signal avg_ack_signal;
0550     } status_stats;
0551 
0552     /* Updated from TX path only, no locking requirements */
0553     struct {
0554         u64 packets[IEEE80211_NUM_ACS];
0555         u64 bytes[IEEE80211_NUM_ACS];
0556         struct ieee80211_tx_rate last_rate;
0557         struct rate_info last_rate_info;
0558         u64 msdu[IEEE80211_NUM_TIDS + 1];
0559     } tx_stats;
0560 
0561     enum ieee80211_sta_rx_bandwidth cur_max_bandwidth;
0562 
0563     struct ieee80211_link_sta *pub;
0564 };
0565 
0566 /**
0567  * struct sta_info - STA information
0568  *
0569  * This structure collects information about a station that
0570  * mac80211 is communicating with.
0571  *
0572  * @list: global linked list entry
0573  * @free_list: list entry for keeping track of stations to free
0574  * @hash_node: hash node for rhashtable
0575  * @addr: station's MAC address - duplicated from public part to
0576  *  let the hash table work with just a single cacheline
0577  * @local: pointer to the global information
0578  * @sdata: virtual interface this station belongs to
0579  * @ptk: peer keys negotiated with this station, if any
0580  * @ptk_idx: last installed peer key index
0581  * @rate_ctrl: rate control algorithm reference
0582  * @rate_ctrl_lock: spinlock used to protect rate control data
0583  *  (data inside the algorithm, so serializes calls there)
0584  * @rate_ctrl_priv: rate control private per-STA pointer
0585  * @lock: used for locking all fields that require locking, see comments
0586  *  in the header file.
0587  * @drv_deliver_wk: used for delivering frames after driver PS unblocking
0588  * @listen_interval: listen interval of this station, when we're acting as AP
0589  * @_flags: STA flags, see &enum ieee80211_sta_info_flags, do not use directly
0590  * @ps_lock: used for powersave (when mac80211 is the AP) related locking
0591  * @ps_tx_buf: buffers (per AC) of frames to transmit to this station
0592  *  when it leaves power saving state or polls
0593  * @tx_filtered: buffers (per AC) of frames we already tried to
0594  *  transmit but were filtered by hardware due to STA having
0595  *  entered power saving state, these are also delivered to
0596  *  the station when it leaves powersave or polls for frames
0597  * @driver_buffered_tids: bitmap of TIDs the driver has data buffered on
0598  * @txq_buffered_tids: bitmap of TIDs that mac80211 has txq data buffered on
0599  * @assoc_at: clock boottime (in ns) of last association
0600  * @last_connected: time (in seconds) when a station got connected
0601  * @last_seq_ctrl: last received seq/frag number from this STA (per TID
0602  *  plus one for non-QoS frames)
0603  * @tid_seq: per-TID sequence numbers for sending to this STA
0604  * @airtime: per-AC struct airtime_info describing airtime statistics for this
0605  *  station
0606  * @airtime_weight: station weight for airtime fairness calculation purposes
0607  * @ampdu_mlme: A-MPDU state machine state
0608  * @mesh: mesh STA information
0609  * @debugfs_dir: debug filesystem directory dentry
0610  * @dead: set to true when sta is unlinked
0611  * @removed: set to true when sta is being removed from sta_list
0612  * @uploaded: set to true when sta is uploaded to the driver
0613  * @sta: station information we share with the driver
0614  * @sta_state: duplicates information about station state (for debug)
0615  * @rcu_head: RCU head used for freeing this station struct
0616  * @cur_max_bandwidth: maximum bandwidth to use for TX to the station,
0617  *  taken from HT/VHT capabilities or VHT operating mode notification
0618  * @cparams: CoDel parameters for this station.
0619  * @reserved_tid: reserved TID (if any, otherwise IEEE80211_TID_UNRESERVED)
0620  * @fast_tx: TX fastpath information
0621  * @fast_rx: RX fastpath information
0622  * @tdls_chandef: a TDLS peer can have a wider chandef that is compatible to
0623  *  the BSS one.
0624  * @frags: fragment cache
0625  * @deflink: This is the default link STA information, for non MLO STA all link
0626  *  specific STA information is accessed through @deflink or through
0627  *  link[0] which points to address of @deflink. For MLO Link STA
0628  *  the first added link STA will point to deflink.
0629  * @link: reference to Link Sta entries. For Non MLO STA, except 1st link,
0630  *  i.e link[0] all links would be assigned to NULL by default and
0631  *  would access link information via @deflink or link[0]. For MLO
0632  *  STA, first link STA being added will point its link pointer to
0633  *  @deflink address and remaining would be allocated and the address
0634  *  would be assigned to link[link_id] where link_id is the id assigned
0635  *  by the AP.
0636  */
0637 struct sta_info {
0638     /* General information, mostly static */
0639     struct list_head list, free_list;
0640     struct rcu_head rcu_head;
0641     struct rhlist_head hash_node;
0642     u8 addr[ETH_ALEN];
0643     struct ieee80211_local *local;
0644     struct ieee80211_sub_if_data *sdata;
0645     struct ieee80211_key __rcu *ptk[NUM_DEFAULT_KEYS];
0646     u8 ptk_idx;
0647     struct rate_control_ref *rate_ctrl;
0648     void *rate_ctrl_priv;
0649     spinlock_t rate_ctrl_lock;
0650     spinlock_t lock;
0651 
0652     struct ieee80211_fast_tx __rcu *fast_tx;
0653     struct ieee80211_fast_rx __rcu *fast_rx;
0654 
0655 #ifdef CONFIG_MAC80211_MESH
0656     struct mesh_sta *mesh;
0657 #endif
0658 
0659     struct work_struct drv_deliver_wk;
0660 
0661     u16 listen_interval;
0662 
0663     bool dead;
0664     bool removed;
0665 
0666     bool uploaded;
0667 
0668     enum ieee80211_sta_state sta_state;
0669 
0670     /* use the accessors defined below */
0671     unsigned long _flags;
0672 
0673     /* STA powersave lock and frame queues */
0674     spinlock_t ps_lock;
0675     struct sk_buff_head ps_tx_buf[IEEE80211_NUM_ACS];
0676     struct sk_buff_head tx_filtered[IEEE80211_NUM_ACS];
0677     unsigned long driver_buffered_tids;
0678     unsigned long txq_buffered_tids;
0679 
0680     u64 assoc_at;
0681     long last_connected;
0682 
0683     /* Plus 1 for non-QoS frames */
0684     __le16 last_seq_ctrl[IEEE80211_NUM_TIDS + 1];
0685 
0686     u16 tid_seq[IEEE80211_QOS_CTL_TID_MASK + 1];
0687 
0688     struct airtime_info airtime[IEEE80211_NUM_ACS];
0689     u16 airtime_weight;
0690 
0691     /*
0692      * Aggregation information, locked with lock.
0693      */
0694     struct sta_ampdu_mlme ampdu_mlme;
0695 
0696 #ifdef CONFIG_MAC80211_DEBUGFS
0697     struct dentry *debugfs_dir;
0698 #endif
0699 
0700     struct codel_params cparams;
0701 
0702     u8 reserved_tid;
0703 
0704     struct cfg80211_chan_def tdls_chandef;
0705 
0706     struct ieee80211_fragment_cache frags;
0707 
0708     struct link_sta_info deflink;
0709     struct link_sta_info __rcu *link[IEEE80211_MLD_MAX_NUM_LINKS];
0710 
0711     /* keep last! */
0712     struct ieee80211_sta sta;
0713 };
0714 
0715 static inline enum nl80211_plink_state sta_plink_state(struct sta_info *sta)
0716 {
0717 #ifdef CONFIG_MAC80211_MESH
0718     return sta->mesh->plink_state;
0719 #endif
0720     return NL80211_PLINK_LISTEN;
0721 }
0722 
0723 static inline void set_sta_flag(struct sta_info *sta,
0724                 enum ieee80211_sta_info_flags flag)
0725 {
0726     WARN_ON(flag == WLAN_STA_AUTH ||
0727         flag == WLAN_STA_ASSOC ||
0728         flag == WLAN_STA_AUTHORIZED);
0729     set_bit(flag, &sta->_flags);
0730 }
0731 
0732 static inline void clear_sta_flag(struct sta_info *sta,
0733                   enum ieee80211_sta_info_flags flag)
0734 {
0735     WARN_ON(flag == WLAN_STA_AUTH ||
0736         flag == WLAN_STA_ASSOC ||
0737         flag == WLAN_STA_AUTHORIZED);
0738     clear_bit(flag, &sta->_flags);
0739 }
0740 
0741 static inline int test_sta_flag(struct sta_info *sta,
0742                 enum ieee80211_sta_info_flags flag)
0743 {
0744     return test_bit(flag, &sta->_flags);
0745 }
0746 
0747 static inline int test_and_clear_sta_flag(struct sta_info *sta,
0748                       enum ieee80211_sta_info_flags flag)
0749 {
0750     WARN_ON(flag == WLAN_STA_AUTH ||
0751         flag == WLAN_STA_ASSOC ||
0752         flag == WLAN_STA_AUTHORIZED);
0753     return test_and_clear_bit(flag, &sta->_flags);
0754 }
0755 
0756 static inline int test_and_set_sta_flag(struct sta_info *sta,
0757                     enum ieee80211_sta_info_flags flag)
0758 {
0759     WARN_ON(flag == WLAN_STA_AUTH ||
0760         flag == WLAN_STA_ASSOC ||
0761         flag == WLAN_STA_AUTHORIZED);
0762     return test_and_set_bit(flag, &sta->_flags);
0763 }
0764 
0765 int sta_info_move_state(struct sta_info *sta,
0766             enum ieee80211_sta_state new_state);
0767 
0768 static inline void sta_info_pre_move_state(struct sta_info *sta,
0769                        enum ieee80211_sta_state new_state)
0770 {
0771     int ret;
0772 
0773     WARN_ON_ONCE(test_sta_flag(sta, WLAN_STA_INSERTED));
0774 
0775     ret = sta_info_move_state(sta, new_state);
0776     WARN_ON_ONCE(ret);
0777 }
0778 
0779 
0780 void ieee80211_assign_tid_tx(struct sta_info *sta, int tid,
0781                  struct tid_ampdu_tx *tid_tx);
0782 
0783 static inline struct tid_ampdu_tx *
0784 rcu_dereference_protected_tid_tx(struct sta_info *sta, int tid)
0785 {
0786     return rcu_dereference_protected(sta->ampdu_mlme.tid_tx[tid],
0787                      lockdep_is_held(&sta->lock) ||
0788                      lockdep_is_held(&sta->ampdu_mlme.mtx));
0789 }
0790 
0791 /* Maximum number of frames to buffer per power saving station per AC */
0792 #define STA_MAX_TX_BUFFER   64
0793 
0794 /* Minimum buffered frame expiry time. If STA uses listen interval that is
0795  * smaller than this value, the minimum value here is used instead. */
0796 #define STA_TX_BUFFER_EXPIRE (10 * HZ)
0797 
0798 /* How often station data is cleaned up (e.g., expiration of buffered frames)
0799  */
0800 #define STA_INFO_CLEANUP_INTERVAL (10 * HZ)
0801 
0802 struct rhlist_head *sta_info_hash_lookup(struct ieee80211_local *local,
0803                      const u8 *addr);
0804 
0805 /*
0806  * Get a STA info, must be under RCU read lock.
0807  */
0808 struct sta_info *sta_info_get(struct ieee80211_sub_if_data *sdata,
0809                   const u8 *addr);
0810 
0811 struct sta_info *sta_info_get_bss(struct ieee80211_sub_if_data *sdata,
0812                   const u8 *addr);
0813 
0814 /* user must hold sta_mtx or be in RCU critical section */
0815 struct sta_info *sta_info_get_by_addrs(struct ieee80211_local *local,
0816                        const u8 *sta_addr, const u8 *vif_addr);
0817 
0818 #define for_each_sta_info(local, _addr, _sta, _tmp)         \
0819     rhl_for_each_entry_rcu(_sta, _tmp,              \
0820                    sta_info_hash_lookup(local, _addr), hash_node)
0821 
0822 struct rhlist_head *link_sta_info_hash_lookup(struct ieee80211_local *local,
0823                           const u8 *addr);
0824 
0825 #define for_each_link_sta_info(local, _addr, _sta, _tmp)        \
0826     rhl_for_each_entry_rcu(_sta, _tmp,              \
0827                    link_sta_info_hash_lookup(local, _addr), \
0828                    link_hash_node)
0829 
0830 struct link_sta_info *
0831 link_sta_info_get_bss(struct ieee80211_sub_if_data *sdata, const u8 *addr);
0832 
0833 /*
0834  * Get STA info by index, BROKEN!
0835  */
0836 struct sta_info *sta_info_get_by_idx(struct ieee80211_sub_if_data *sdata,
0837                      int idx);
0838 /*
0839  * Create a new STA info, caller owns returned structure
0840  * until sta_info_insert().
0841  */
0842 struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
0843                 const u8 *addr, gfp_t gfp);
0844 struct sta_info *sta_info_alloc_with_link(struct ieee80211_sub_if_data *sdata,
0845                       const u8 *mld_addr,
0846                       unsigned int link_id,
0847                       const u8 *link_addr,
0848                       gfp_t gfp);
0849 
0850 void sta_info_free(struct ieee80211_local *local, struct sta_info *sta);
0851 
0852 /*
0853  * Insert STA info into hash table/list, returns zero or a
0854  * -EEXIST if (if the same MAC address is already present).
0855  *
0856  * Calling the non-rcu version makes the caller relinquish,
0857  * the _rcu version calls read_lock_rcu() and must be called
0858  * without it held.
0859  */
0860 int sta_info_insert(struct sta_info *sta);
0861 int sta_info_insert_rcu(struct sta_info *sta) __acquires(RCU);
0862 
0863 int __must_check __sta_info_destroy(struct sta_info *sta);
0864 int sta_info_destroy_addr(struct ieee80211_sub_if_data *sdata,
0865               const u8 *addr);
0866 int sta_info_destroy_addr_bss(struct ieee80211_sub_if_data *sdata,
0867                   const u8 *addr);
0868 
0869 void sta_info_recalc_tim(struct sta_info *sta);
0870 
0871 int sta_info_init(struct ieee80211_local *local);
0872 void sta_info_stop(struct ieee80211_local *local);
0873 
0874 /**
0875  * __sta_info_flush - flush matching STA entries from the STA table
0876  *
0877  * Returns the number of removed STA entries.
0878  *
0879  * @sdata: sdata to remove all stations from
0880  * @vlans: if the given interface is an AP interface, also flush VLANs
0881  */
0882 int __sta_info_flush(struct ieee80211_sub_if_data *sdata, bool vlans);
0883 
0884 /**
0885  * sta_info_flush - flush matching STA entries from the STA table
0886  *
0887  * Returns the number of removed STA entries.
0888  *
0889  * @sdata: sdata to remove all stations from
0890  */
0891 static inline int sta_info_flush(struct ieee80211_sub_if_data *sdata)
0892 {
0893     return __sta_info_flush(sdata, false);
0894 }
0895 
0896 void sta_set_rate_info_tx(struct sta_info *sta,
0897               const struct ieee80211_tx_rate *rate,
0898               struct rate_info *rinfo);
0899 void sta_set_sinfo(struct sta_info *sta, struct station_info *sinfo,
0900            bool tidstats);
0901 
0902 u32 sta_get_expected_throughput(struct sta_info *sta);
0903 
0904 void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata,
0905               unsigned long exp_time);
0906 
0907 int ieee80211_sta_allocate_link(struct sta_info *sta, unsigned int link_id);
0908 void ieee80211_sta_free_link(struct sta_info *sta, unsigned int link_id);
0909 int ieee80211_sta_activate_link(struct sta_info *sta, unsigned int link_id);
0910 void ieee80211_sta_remove_link(struct sta_info *sta, unsigned int link_id);
0911 
0912 void ieee80211_sta_ps_deliver_wakeup(struct sta_info *sta);
0913 void ieee80211_sta_ps_deliver_poll_response(struct sta_info *sta);
0914 void ieee80211_sta_ps_deliver_uapsd(struct sta_info *sta);
0915 
0916 unsigned long ieee80211_sta_last_active(struct sta_info *sta);
0917 
0918 void ieee80211_sta_set_max_amsdu_subframes(struct sta_info *sta,
0919                        const u8 *ext_capab,
0920                        unsigned int ext_capab_len);
0921 
0922 enum sta_stats_type {
0923     STA_STATS_RATE_TYPE_INVALID = 0,
0924     STA_STATS_RATE_TYPE_LEGACY,
0925     STA_STATS_RATE_TYPE_HT,
0926     STA_STATS_RATE_TYPE_VHT,
0927     STA_STATS_RATE_TYPE_HE,
0928     STA_STATS_RATE_TYPE_S1G,
0929 };
0930 
0931 #define STA_STATS_FIELD_HT_MCS      GENMASK( 7,  0)
0932 #define STA_STATS_FIELD_LEGACY_IDX  GENMASK( 3,  0)
0933 #define STA_STATS_FIELD_LEGACY_BAND GENMASK( 7,  4)
0934 #define STA_STATS_FIELD_VHT_MCS     GENMASK( 3,  0)
0935 #define STA_STATS_FIELD_VHT_NSS     GENMASK( 7,  4)
0936 #define STA_STATS_FIELD_HE_MCS      GENMASK( 3,  0)
0937 #define STA_STATS_FIELD_HE_NSS      GENMASK( 7,  4)
0938 #define STA_STATS_FIELD_BW      GENMASK(11,  8)
0939 #define STA_STATS_FIELD_SGI     GENMASK(12, 12)
0940 #define STA_STATS_FIELD_TYPE        GENMASK(15, 13)
0941 #define STA_STATS_FIELD_HE_RU       GENMASK(18, 16)
0942 #define STA_STATS_FIELD_HE_GI       GENMASK(20, 19)
0943 #define STA_STATS_FIELD_HE_DCM      GENMASK(21, 21)
0944 
0945 #define STA_STATS_FIELD(_n, _v)     FIELD_PREP(STA_STATS_FIELD_ ## _n, _v)
0946 #define STA_STATS_GET(_n, _v)       FIELD_GET(STA_STATS_FIELD_ ## _n, _v)
0947 
0948 #define STA_STATS_RATE_INVALID      0
0949 
0950 static inline u32 sta_stats_encode_rate(struct ieee80211_rx_status *s)
0951 {
0952     u32 r;
0953 
0954     r = STA_STATS_FIELD(BW, s->bw);
0955 
0956     if (s->enc_flags & RX_ENC_FLAG_SHORT_GI)
0957         r |= STA_STATS_FIELD(SGI, 1);
0958 
0959     switch (s->encoding) {
0960     case RX_ENC_VHT:
0961         r |= STA_STATS_FIELD(TYPE, STA_STATS_RATE_TYPE_VHT);
0962         r |= STA_STATS_FIELD(VHT_NSS, s->nss);
0963         r |= STA_STATS_FIELD(VHT_MCS, s->rate_idx);
0964         break;
0965     case RX_ENC_HT:
0966         r |= STA_STATS_FIELD(TYPE, STA_STATS_RATE_TYPE_HT);
0967         r |= STA_STATS_FIELD(HT_MCS, s->rate_idx);
0968         break;
0969     case RX_ENC_LEGACY:
0970         r |= STA_STATS_FIELD(TYPE, STA_STATS_RATE_TYPE_LEGACY);
0971         r |= STA_STATS_FIELD(LEGACY_BAND, s->band);
0972         r |= STA_STATS_FIELD(LEGACY_IDX, s->rate_idx);
0973         break;
0974     case RX_ENC_HE:
0975         r |= STA_STATS_FIELD(TYPE, STA_STATS_RATE_TYPE_HE);
0976         r |= STA_STATS_FIELD(HE_NSS, s->nss);
0977         r |= STA_STATS_FIELD(HE_MCS, s->rate_idx);
0978         r |= STA_STATS_FIELD(HE_GI, s->he_gi);
0979         r |= STA_STATS_FIELD(HE_RU, s->he_ru);
0980         r |= STA_STATS_FIELD(HE_DCM, s->he_dcm);
0981         break;
0982     default:
0983         WARN_ON(1);
0984         return STA_STATS_RATE_INVALID;
0985     }
0986 
0987     return r;
0988 }
0989 
0990 #endif /* STA_INFO_H */
[ Source navigation ] [ Diff markup ] [ Identifier search ] [ general search ]

This page was automatically generated by the 2.1.0 LXR engine.

The LXR team
Valid CSS 2.1! Valid HTML 4.01!