blob: dee0b645b34cca800d4ffb350d289591d7c95494 [file] [log] [blame]
Jiri Bencf0706e82007-05-05 11:45:53 -07001/*
2 * Copyright 2002-2005, Devicescape Software, Inc.
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 as
6 * published by the Free Software Foundation.
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>
Johannes Bergaf818582009-11-06 11:35:50 +010015#include <linux/workqueue.h>
Bruno Randolf541a45a2010-12-02 19:12:43 +090016#include <linux/average.h>
Felix Fietkau888d04d2012-03-01 15:22:09 +010017#include <linux/etherdevice.h>
Johannes Berg2c8dccc2008-04-08 15:14:40 -040018#include "key.h"
Jiri Bencf0706e82007-05-05 11:45:53 -070019
Johannes Berg238814f2008-01-28 17:19:37 +010020/**
21 * enum ieee80211_sta_info_flags - Stations flags
22 *
Johannes Bergc2c98fd2011-09-29 16:04:36 +020023 * These flags are used with &struct sta_info's @flags member, but
24 * only indirectly with set_sta_flag() and friends.
Johannes Berg238814f2008-01-28 17:19:37 +010025 *
26 * @WLAN_STA_AUTH: Station is authenticated.
27 * @WLAN_STA_ASSOC: Station is associated.
Johannes Bergaf818582009-11-06 11:35:50 +010028 * @WLAN_STA_PS_STA: Station is in power-save mode
Johannes Berg238814f2008-01-28 17:19:37 +010029 * @WLAN_STA_AUTHORIZED: Station is authorized to send/receive traffic.
30 * This bit is always checked so needs to be enabled for all stations
31 * when virtual port control is not in use.
32 * @WLAN_STA_SHORT_PREAMBLE: Station is capable of receiving short-preamble
33 * frames.
Johannes Berg238814f2008-01-28 17:19:37 +010034 * @WLAN_STA_WME: Station is a QoS-STA.
35 * @WLAN_STA_WDS: Station is one of our WDS peers.
Johannes Bergd46e1442008-02-20 23:59:33 +010036 * @WLAN_STA_CLEAR_PS_FILT: Clear PS filter in hardware (using the
Johannes Berge039fa42008-05-15 12:55:29 +020037 * IEEE80211_TX_CTL_CLEAR_PS_FILT control flag) when the next
Johannes Bergd46e1442008-02-20 23:59:33 +010038 * frame to this station is transmitted.
Jouni Malinen5394af42009-01-08 13:31:59 +020039 * @WLAN_STA_MFP: Management frame protection is used with this STA.
Johannes Berg618f3562010-04-06 11:18:46 +020040 * @WLAN_STA_BLOCK_BA: Used to deny ADDBA requests (both TX and RX)
Johannes Berg098a6072010-04-06 11:18:47 +020041 * during suspend/resume and station removal.
Johannes Bergaf818582009-11-06 11:35:50 +010042 * @WLAN_STA_PS_DRIVER: driver requires keeping this station in
43 * power-save mode logically to flush frames that might still
44 * be in the queues
45 * @WLAN_STA_PSPOLL: Station sent PS-poll while driver was keeping
46 * station in power-save mode, reply when the driver unblocks.
Arik Nemtsov941c93c2011-09-28 14:12:54 +030047 * @WLAN_STA_TDLS_PEER: Station is a TDLS peer.
48 * @WLAN_STA_TDLS_PEER_AUTH: This TDLS peer is authorized to send direct
49 * packets. This means the link is enabled.
Johannes Berg47086fc2011-09-29 16:04:33 +020050 * @WLAN_STA_UAPSD: Station requested unscheduled SP while driver was
51 * keeping station in power-save mode, reply when the driver
52 * unblocks the station.
53 * @WLAN_STA_SP: Station is in a service period, so don't try to
Johannes Bergdeeaee12011-09-29 16:04:35 +020054 * reply to other uAPSD trigger frames or PS-Poll.
Johannes Berge7f4a942011-11-04 11:18:20 +010055 * @WLAN_STA_4ADDR_EVENT: 4-addr event was already sent for this frame.
Johannes Berg83d5cc02012-01-12 09:31:10 +010056 * @WLAN_STA_INSERTED: This station is inserted into the hash table.
Johannes Berge1936e92012-01-20 13:55:23 +010057 * @WLAN_STA_RATE_CONTROL: rate control was initialized for this station.
Javier Cardonadbf498f2012-03-31 11:31:32 -070058 * @WLAN_STA_TOFFSET_KNOWN: toffset calculated for this station is valid.
Marco Porsch3f52b7e2013-01-30 18:14:08 +010059 * @WLAN_STA_MPSP_OWNER: local STA is owner of a mesh Peer Service Period.
60 * @WLAN_STA_MPSP_RECIPIENT: local STA is recipient of a MPSP.
Johannes Berg5ac2e352014-05-27 16:32:27 +020061 * @WLAN_STA_PS_DELIVER: station woke up, but we're still blocking TX
62 * until pending frames are delivered
Johannes Berg238814f2008-01-28 17:19:37 +010063 */
64enum ieee80211_sta_info_flags {
Johannes Bergc2c98fd2011-09-29 16:04:36 +020065 WLAN_STA_AUTH,
66 WLAN_STA_ASSOC,
67 WLAN_STA_PS_STA,
68 WLAN_STA_AUTHORIZED,
69 WLAN_STA_SHORT_PREAMBLE,
Johannes Bergc2c98fd2011-09-29 16:04:36 +020070 WLAN_STA_WME,
71 WLAN_STA_WDS,
72 WLAN_STA_CLEAR_PS_FILT,
73 WLAN_STA_MFP,
74 WLAN_STA_BLOCK_BA,
75 WLAN_STA_PS_DRIVER,
76 WLAN_STA_PSPOLL,
77 WLAN_STA_TDLS_PEER,
78 WLAN_STA_TDLS_PEER_AUTH,
79 WLAN_STA_UAPSD,
80 WLAN_STA_SP,
Johannes Berge7f4a942011-11-04 11:18:20 +010081 WLAN_STA_4ADDR_EVENT,
Johannes Berg83d5cc02012-01-12 09:31:10 +010082 WLAN_STA_INSERTED,
Johannes Berge1936e92012-01-20 13:55:23 +010083 WLAN_STA_RATE_CONTROL,
Javier Cardonadbf498f2012-03-31 11:31:32 -070084 WLAN_STA_TOFFSET_KNOWN,
Marco Porsch3f52b7e2013-01-30 18:14:08 +010085 WLAN_STA_MPSP_OWNER,
86 WLAN_STA_MPSP_RECIPIENT,
Johannes Berg5ac2e352014-05-27 16:32:27 +020087 WLAN_STA_PS_DELIVER,
Johannes Berg238814f2008-01-28 17:19:37 +010088};
Jiri Bencf0706e82007-05-05 11:45:53 -070089
Ron Rindjunsky5aae2882007-12-25 17:00:32 +020090#define ADDBA_RESP_INTERVAL HZ
Nikolay Martynov84381b42011-12-17 19:39:35 -050091#define HT_AGG_MAX_RETRIES 15
92#define HT_AGG_BURST_RETRIES 3
93#define HT_AGG_RETRIES_PERIOD (15 * HZ)
Ron Rindjunsky5aae2882007-12-25 17:00:32 +020094
Johannes Berga622ab72010-06-10 10:21:39 +020095#define HT_AGG_STATE_DRV_READY 0
96#define HT_AGG_STATE_RESPONSE_RECEIVED 1
97#define HT_AGG_STATE_OPERATIONAL 2
98#define HT_AGG_STATE_STOPPING 3
Johannes Berg0ab33702010-06-10 10:21:42 +020099#define HT_AGG_STATE_WANT_START 4
100#define HT_AGG_STATE_WANT_STOP 5
Ron Rindjunsky80656c22008-01-28 14:07:16 +0200101
Johannes Bergc82c4a82012-07-18 13:31:31 +0200102enum ieee80211_agg_stop_reason {
103 AGG_STOP_DECLINED,
104 AGG_STOP_LOCAL_REQUEST,
105 AGG_STOP_PEER_REQUEST,
106 AGG_STOP_DESTROY_STA,
107};
108
Ron Rindjunsky80656c22008-01-28 14:07:16 +0200109/**
110 * struct tid_ampdu_tx - TID aggregation information (Tx).
111 *
Johannes Berga622ab72010-06-10 10:21:39 +0200112 * @rcu_head: rcu head for freeing structure
Nikolay Martynov285fa692011-11-22 21:50:28 -0500113 * @session_timer: check if we keep Tx-ing on the TID (by timeout value)
Ron Rindjunsky80656c22008-01-28 14:07:16 +0200114 * @addba_resp_timer: timer for peer's response to addba request
Johannes Bergcd8ffc82009-03-23 17:28:41 +0100115 * @pending: pending frames queue -- use sta's spinlock to protect
Ron Rindjunskycee24a32008-03-26 20:36:03 +0200116 * @dialog_token: dialog token for aggregation session
Sujith Manoharanbd2ce6e2010-12-15 07:47:10 +0530117 * @timeout: session timeout value to be filled in ADDBA requests
Johannes Berga622ab72010-06-10 10:21:39 +0200118 * @state: session state (see above)
Felix Fietkau12d3952f2012-03-18 22:58:06 +0100119 * @last_tx: jiffies of last tx activity
Johannes Berga622ab72010-06-10 10:21:39 +0200120 * @stop_initiator: initiator of a session stop
Johannes Berg53f73c02010-10-05 19:37:40 +0200121 * @tx_stop: TX DelBA frame when stopping
Johannes Berg0b01f032011-01-18 13:51:05 +0100122 * @buf_size: reorder buffer size at receiver
Felix Fietkauf0425be2011-08-28 21:11:01 +0200123 * @failed_bar_ssn: ssn of the last failed BAR tx attempt
124 * @bar_pending: BAR needs to be re-sent
Johannes Berga622ab72010-06-10 10:21:39 +0200125 *
Johannes Bergdd318572010-11-29 11:09:16 +0100126 * This structure's lifetime is managed by RCU, assignments to
127 * the array holding it must hold the aggregation mutex.
128 *
129 * The TX path can access it under RCU lock-free if, and
130 * only if, the state has the flag %HT_AGG_STATE_OPERATIONAL
131 * set. Otherwise, the TX path must also acquire the spinlock
132 * and re-check the state, see comments in the tx code
133 * touching it.
Ron Rindjunsky80656c22008-01-28 14:07:16 +0200134 */
135struct tid_ampdu_tx {
Johannes Berga622ab72010-06-10 10:21:39 +0200136 struct rcu_head rcu_head;
Nikolay Martynov285fa692011-11-22 21:50:28 -0500137 struct timer_list session_timer;
Ron Rindjunsky80656c22008-01-28 14:07:16 +0200138 struct timer_list addba_resp_timer;
Johannes Bergcd8ffc82009-03-23 17:28:41 +0100139 struct sk_buff_head pending;
Johannes Berga622ab72010-06-10 10:21:39 +0200140 unsigned long state;
Felix Fietkau12d3952f2012-03-18 22:58:06 +0100141 unsigned long last_tx;
Sujith Manoharanbd2ce6e2010-12-15 07:47:10 +0530142 u16 timeout;
Ron Rindjunskycee24a32008-03-26 20:36:03 +0200143 u8 dialog_token;
Johannes Berga622ab72010-06-10 10:21:39 +0200144 u8 stop_initiator;
Johannes Berg53f73c02010-10-05 19:37:40 +0200145 bool tx_stop;
Johannes Berg0b01f032011-01-18 13:51:05 +0100146 u8 buf_size;
Felix Fietkauf0425be2011-08-28 21:11:01 +0200147
148 u16 failed_bar_ssn;
149 bool bar_pending;
Ron Rindjunsky80656c22008-01-28 14:07:16 +0200150};
Ron Rindjunsky5aae2882007-12-25 17:00:32 +0200151
152/**
153 * struct tid_ampdu_rx - TID aggregation information (Rx).
154 *
Ron Rindjunsky5aae2882007-12-25 17:00:32 +0200155 * @reorder_buf: buffer to reorder incoming aggregated MPDUs
Jouni Malinen4d050f12009-05-05 20:35:14 +0300156 * @reorder_time: jiffies when skb was added
Ron Rindjunsky5aae2882007-12-25 17:00:32 +0200157 * @session_timer: check if peer keeps Tx-ing on the TID (by timeout value)
Christian Lamparter2bff8eb2010-08-05 01:36:41 +0200158 * @reorder_timer: releases expired frames from the reorder buffer.
Felix Fietkau12d3952f2012-03-18 22:58:06 +0100159 * @last_rx: jiffies of last rx activity
Johannes Berg056cdd52008-03-26 23:21:47 +0100160 * @head_seq_num: head sequence number in reordering buffer.
161 * @stored_mpdu_num: number of MPDUs in reordering buffer
Ron Rindjunskycee24a32008-03-26 20:36:03 +0200162 * @ssn: Starting Sequence Number expected to be aggregated.
163 * @buf_size: buffer size for incoming A-MPDUs
Johannes Berg20ad19d2009-02-10 21:25:45 +0100164 * @timeout: reset timer value (in TUs).
Ron Rindjunskycee24a32008-03-26 20:36:03 +0200165 * @dialog_token: dialog token for aggregation session
Johannes Berga87f7362010-06-10 10:21:38 +0200166 * @rcu_head: RCU head used for freeing this struct
Christian Lamparter2bff8eb2010-08-05 01:36:41 +0200167 * @reorder_lock: serializes access to reorder buffer, see below.
Johannes Berga87f7362010-06-10 10:21:38 +0200168 *
Johannes Bergdd318572010-11-29 11:09:16 +0100169 * This structure's lifetime is managed by RCU, assignments to
170 * the array holding it must hold the aggregation mutex.
Christian Lamparter2bff8eb2010-08-05 01:36:41 +0200171 *
Johannes Bergdd318572010-11-29 11:09:16 +0100172 * The @reorder_lock is used to protect the members of this
173 * struct, except for @timeout, @buf_size and @dialog_token,
174 * which are constant across the lifetime of the struct (the
175 * dialog token being used only for debugging).
Ron Rindjunsky5aae2882007-12-25 17:00:32 +0200176 */
177struct tid_ampdu_rx {
Johannes Berga87f7362010-06-10 10:21:38 +0200178 struct rcu_head rcu_head;
Christian Lamparter2bff8eb2010-08-05 01:36:41 +0200179 spinlock_t reorder_lock;
Ron Rindjunsky5aae2882007-12-25 17:00:32 +0200180 struct sk_buff **reorder_buf;
Jouni Malinen4d050f12009-05-05 20:35:14 +0300181 unsigned long *reorder_time;
Ron Rindjunsky5aae2882007-12-25 17:00:32 +0200182 struct timer_list session_timer;
Christian Lamparter2bff8eb2010-08-05 01:36:41 +0200183 struct timer_list reorder_timer;
Felix Fietkau12d3952f2012-03-18 22:58:06 +0100184 unsigned long last_rx;
Johannes Berg056cdd52008-03-26 23:21:47 +0100185 u16 head_seq_num;
186 u16 stored_mpdu_num;
Ron Rindjunskycee24a32008-03-26 20:36:03 +0200187 u16 ssn;
188 u16 buf_size;
189 u16 timeout;
190 u8 dialog_token;
Ron Rindjunsky5aae2882007-12-25 17:00:32 +0200191};
192
Luis Carlos Cobob4e08ea2008-02-29 15:46:08 -0800193/**
Johannes Bergfcea6002010-05-31 11:40:23 +0200194 * struct sta_ampdu_mlme - STA aggregation information.
195 *
Johannes Berga87f7362010-06-10 10:21:38 +0200196 * @tid_rx: aggregation info for Rx per TID -- RCU protected
Johannes Bergfcea6002010-05-31 11:40:23 +0200197 * @tid_tx: aggregation info for Tx per TID
Johannes Bergec034b22011-05-13 13:35:40 +0200198 * @tid_start_tx: sessions where start was requested
Johannes Bergfcea6002010-05-31 11:40:23 +0200199 * @addba_req_num: number of times addBA request has been sent.
Nikolay Martynov84381b42011-12-17 19:39:35 -0500200 * @last_addba_req_time: timestamp of the last addBA request.
Johannes Bergfcea6002010-05-31 11:40:23 +0200201 * @dialog_token_allocator: dialog token enumerator for each new session;
Johannes Berg0ab33702010-06-10 10:21:42 +0200202 * @work: work struct for starting/stopping aggregation
Johannes Berg7c3b1dd2010-06-10 10:21:44 +0200203 * @tid_rx_timer_expired: bitmap indicating on which TIDs the
204 * RX timer expired until the work for it runs
Shahar Levif41ccd72011-05-22 16:10:21 +0300205 * @tid_rx_stop_requested: bitmap indicating which BA sessions per TID the
206 * driver requested to close until the work for it runs
Johannes Berga93e3642010-06-10 10:21:46 +0200207 * @mtx: mutex to protect all TX data (except non-NULL assignments
208 * to tid_tx[idx], which are protected by the sta spinlock)
Ben Greeare5620782013-06-12 14:08:44 -0700209 * tid_start_tx is also protected by sta->lock.
Johannes Bergfcea6002010-05-31 11:40:23 +0200210 */
211struct sta_ampdu_mlme {
Johannes Berga93e3642010-06-10 10:21:46 +0200212 struct mutex mtx;
Johannes Bergfcea6002010-05-31 11:40:23 +0200213 /* rx */
Johannes Berg5a306f52012-11-14 23:22:21 +0100214 struct tid_ampdu_rx __rcu *tid_rx[IEEE80211_NUM_TIDS];
215 unsigned long tid_rx_timer_expired[BITS_TO_LONGS(IEEE80211_NUM_TIDS)];
216 unsigned long tid_rx_stop_requested[BITS_TO_LONGS(IEEE80211_NUM_TIDS)];
Johannes Bergfcea6002010-05-31 11:40:23 +0200217 /* tx */
Johannes Berg0ab33702010-06-10 10:21:42 +0200218 struct work_struct work;
Johannes Berg5a306f52012-11-14 23:22:21 +0100219 struct tid_ampdu_tx __rcu *tid_tx[IEEE80211_NUM_TIDS];
220 struct tid_ampdu_tx *tid_start_tx[IEEE80211_NUM_TIDS];
221 unsigned long last_addba_req_time[IEEE80211_NUM_TIDS];
222 u8 addba_req_num[IEEE80211_NUM_TIDS];
Johannes Bergfcea6002010-05-31 11:40:23 +0200223 u8 dialog_token_allocator;
224};
225
Matti Gottliebad38bfc2013-11-18 19:06:45 +0200226/*
227 * struct ieee80211_tx_latency_stat - Tx latency statistics
228 *
229 * Measures TX latency and jitter for a station per TID.
230 *
231 * @max: worst case latency
232 * @sum: sum of all latencies
233 * @counter: amount of Tx frames sent from interface
234 * @bins: each bin counts how many frames transmitted within a certain
235 * latency range. when disabled it is NULL.
236 * @bin_count: amount of bins.
237 */
238struct ieee80211_tx_latency_stat {
239 u32 max;
240 u32 sum;
241 u32 counter;
242 u32 *bins;
243 u32 bin_count;
244};
Johannes Bergfcea6002010-05-31 11:40:23 +0200245
246/**
Johannes Berg693b1bb2008-02-25 16:27:48 +0100247 * struct sta_info - STA information
248 *
249 * This structure collects information about a station that
250 * mac80211 is communicating with.
251 *
252 * @list: global linked list entry
Johannes Bergd7782072013-12-04 23:12:31 +0100253 * @free_list: list entry for keeping track of stations to free
Johannes Berg693b1bb2008-02-25 16:27:48 +0100254 * @hnext: hash table linked list pointer
255 * @local: pointer to the global information
Johannes Berge25cf4a2008-10-23 08:51:20 +0200256 * @sdata: virtual interface this station belongs to
Max Stepanov2475b1cc2013-03-24 14:23:27 +0200257 * @ptk: peer keys negotiated with this station, if any
258 * @ptk_idx: last installed peer key index
Johannes Berge31b8212010-10-05 19:39:30 +0200259 * @gtk: group keys negotiated with this station, if any
Max Stepanov2475b1cc2013-03-24 14:23:27 +0200260 * @gtk_idx: last installed group key index
Johannes Berge25cf4a2008-10-23 08:51:20 +0200261 * @rate_ctrl: rate control algorithm reference
262 * @rate_ctrl_priv: rate control private per-STA pointer
263 * @last_tx_rate: rate used for last transmit, to report to userspace as
264 * "the" transmit rate
Felix Fietkau3af63342011-02-27 22:08:01 +0100265 * @last_rx_rate_idx: rx status rate index of the last data packet
266 * @last_rx_rate_flag: rx status flag of the last data packet
Emmanuel Grumbach1b8d2422014-02-05 16:37:11 +0200267 * @last_rx_rate_vht_flag: rx status vht flag of the last data packet
Johannes Berg56146182012-11-09 15:07:02 +0100268 * @last_rx_rate_vht_nss: rx status nss of last data packet
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700269 * @lock: used for locking all fields that require locking, see comments
270 * in the header file.
Johannes Berg5ac2e352014-05-27 16:32:27 +0200271 * @drv_deliver_wk: used for delivering frames after driver PS unblocking
Johannes Berge25cf4a2008-10-23 08:51:20 +0200272 * @listen_interval: listen interval of this station, when we're acting as AP
Johannes Bergc2c98fd2011-09-29 16:04:36 +0200273 * @_flags: STA flags, see &enum ieee80211_sta_info_flags, do not use directly
Emmanuel Grumbach1d147bf2014-02-20 09:22:11 +0200274 * @ps_lock: used for powersave (when mac80211 is the AP) related locking
Johannes Berg948d8872011-09-29 16:04:29 +0200275 * @ps_tx_buf: buffers (per AC) of frames to transmit to this station
276 * when it leaves power saving state or polls
277 * @tx_filtered: buffers (per AC) of frames we already tried to
278 * transmit but were filtered by hardware due to STA having
279 * entered power saving state, these are also delivered to
280 * the station when it leaves powersave or polls for frames
281 * @driver_buffered_tids: bitmap of TIDs the driver has data buffered on
Johannes Berg693b1bb2008-02-25 16:27:48 +0100282 * @rx_packets: Number of MSDUs received from this STA
283 * @rx_bytes: Number of bytes received from this STA
Johannes Berge25cf4a2008-10-23 08:51:20 +0200284 * @wep_weak_iv_count: number of weak WEP IVs received from this station
285 * @last_rx: time (in jiffies) when last frame was received from this STA
Mohammed Shafi Shajakhanebe27c92011-04-08 21:24:24 +0530286 * @last_connected: time (in seconds) when a station got connected
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700287 * @num_duplicates: number of duplicate frames received from this STA
288 * @rx_fragments: number of received MPDUs
289 * @rx_dropped: number of dropped MPDUs from this STA
290 * @last_signal: signal of last received frame from this STA
Bruno Randolf541a45a2010-12-02 19:12:43 +0900291 * @avg_signal: moving average of signal of received frames from this STA
Saravanadb943572012-11-28 18:27:09 +0530292 * @last_ack_signal: signal of last received Ack frame from this STA
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700293 * @last_seq_ctrl: last received seq/frag number from this STA (per RX queue)
Johannes Berge25cf4a2008-10-23 08:51:20 +0200294 * @tx_filtered_count: number of frames the hardware filtered for this STA
295 * @tx_retry_failed: number of frames that failed retry
296 * @tx_retry_count: total number of retries for frames to this STA
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700297 * @fail_avg: moving percentage of failed MSDUs
298 * @tx_packets: number of RX/TX MSDUs
Johannes Berge25cf4a2008-10-23 08:51:20 +0200299 * @tx_bytes: number of bytes transmitted to this STA
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700300 * @tx_fragments: number of transmitted MPDUs
Johannes Berge25cf4a2008-10-23 08:51:20 +0200301 * @tid_seq: per-TID sequence numbers for sending to this STA
302 * @ampdu_mlme: A-MPDU state machine state
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700303 * @timer_to_tid: identity mapping to ID timers
Matti Gottliebad38bfc2013-11-18 19:06:45 +0200304 * @tx_lat: Tx latency statistics
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700305 * @llid: Local link ID
306 * @plid: Peer link ID
307 * @reason: Cancel reason on PLINK_HOLDING state
308 * @plink_retries: Retries in establishment
Johannes Berge25cf4a2008-10-23 08:51:20 +0200309 * @ignore_plink_timer: ignore the peer-link timer (used internally)
310 * @plink_state: peer link state
311 * @plink_timeout: timeout of peer link
312 * @plink_timer: peer link watch timer
Javier Cardonadbf498f2012-03-31 11:31:32 -0700313 * @t_offset: timing offset relative to this host
Ashok Nagarajan1dd45582012-06-11 10:23:35 -0700314 * @t_offset_setpoint: reference timing offset of this sta to be used when
315 * calculating clockdrift
Marco Porsch3f52b7e2013-01-30 18:14:08 +0100316 * @local_pm: local link-specific power save mode
317 * @peer_pm: peer-specific power save mode towards local STA
318 * @nonpeer_pm: STA power save mode towards non-peer neighbors
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700319 * @debugfs: debug filesystem info
Johannes Bergaf818582009-11-06 11:35:50 +0100320 * @dead: set to true when sta is unlinked
Johannes Berg34e89502010-02-03 13:59:58 +0100321 * @uploaded: set to true when sta is uploaded to the driver
Johannes Berg99ba2a12010-11-24 08:10:06 +0100322 * @lost_packets: number of consecutive lost packets
Guy Eilam2a33bee2011-08-17 15:18:15 +0300323 * @sta: station information we share with the driver
Johannes Bergd9a7ddb2011-12-14 12:35:30 +0100324 * @sta_state: duplicates information about station state (for debug)
Paul Stewarta85e1d52011-12-09 11:01:49 -0800325 * @beacon_loss_count: number of times beacon loss has triggered
Johannes Berg077f8972013-02-08 09:06:36 +0100326 * @rcu_head: RCU head used for freeing this station struct
Johannes Berg0af83d32012-12-27 18:55:36 +0100327 * @cur_max_bandwidth: maximum bandwidth to use for TX to the station,
328 * taken from HT/VHT capabilities or VHT operating mode notification
Johannes Berg780b40d2013-06-05 09:32:50 +0200329 * @chains: chains ever used for RX from this station
330 * @chain_signal_last: last signal (per chain)
331 * @chain_signal_avg: signal average (per chain)
Emmanuel Grumbach687da132013-10-01 16:45:43 +0300332 * @known_smps_mode: the smps_mode the client thinks we are in. Relevant for
333 * AP only.
Max Stepanov2475b1cc2013-03-24 14:23:27 +0200334 * @cipher_scheme: optional cipher scheme for this station
Johannes Berg693b1bb2008-02-25 16:27:48 +0100335 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700336struct sta_info {
Johannes Berg693b1bb2008-02-25 16:27:48 +0100337 /* General information, mostly static */
Johannes Bergd7782072013-12-04 23:12:31 +0100338 struct list_head list, free_list;
Eliad Pellerb22cfcf2012-09-09 14:43:51 +0300339 struct rcu_head rcu_head;
Johannes Berg40b275b2011-05-13 14:15:49 +0200340 struct sta_info __rcu *hnext;
Jiri Bencf0706e82007-05-05 11:45:53 -0700341 struct ieee80211_local *local;
Johannes Bergd0709a62008-02-25 16:27:46 +0100342 struct ieee80211_sub_if_data *sdata;
Johannes Berg40b275b2011-05-13 14:15:49 +0200343 struct ieee80211_key __rcu *gtk[NUM_DEFAULT_KEYS + NUM_DEFAULT_MGMT_KEYS];
Max Stepanov2475b1cc2013-03-24 14:23:27 +0200344 struct ieee80211_key __rcu *ptk[NUM_DEFAULT_KEYS];
345 u8 gtk_idx;
346 u8 ptk_idx;
Jiri Bencf0706e82007-05-05 11:45:53 -0700347 struct rate_control_ref *rate_ctrl;
348 void *rate_ctrl_priv;
Johannes Berg07346f812008-05-03 01:02:02 +0200349 spinlock_t lock;
Johannes Berg17741cd2008-09-11 00:02:02 +0200350
Johannes Berg5ac2e352014-05-27 16:32:27 +0200351 struct work_struct drv_deliver_wk;
Johannes Bergaf818582009-11-06 11:35:50 +0100352
Jiri Bencf0706e82007-05-05 11:45:53 -0700353 u16 listen_interval;
Jiri Bence9f207f2007-05-05 11:46:38 -0700354
Johannes Bergaf818582009-11-06 11:35:50 +0100355 bool dead;
356
Johannes Berg34e89502010-02-03 13:59:58 +0100357 bool uploaded;
Johannes Bergd0709a62008-02-25 16:27:46 +0100358
Johannes Bergd9a7ddb2011-12-14 12:35:30 +0100359 enum ieee80211_sta_state sta_state;
360
Johannes Bergc2c98fd2011-09-29 16:04:36 +0200361 /* use the accessors defined below */
362 unsigned long _flags;
Johannes Berg693b1bb2008-02-25 16:27:48 +0100363
Emmanuel Grumbach1d147bf2014-02-20 09:22:11 +0200364 /* STA powersave lock and frame queues */
365 spinlock_t ps_lock;
Johannes Berg948d8872011-09-29 16:04:29 +0200366 struct sk_buff_head ps_tx_buf[IEEE80211_NUM_ACS];
367 struct sk_buff_head tx_filtered[IEEE80211_NUM_ACS];
368 unsigned long driver_buffered_tids;
Johannes Berg693b1bb2008-02-25 16:27:48 +0100369
370 /* Updated from RX path only, no locking requirements */
Johannes Berg560d2682013-02-05 10:55:21 +0100371 unsigned long rx_packets;
372 u64 rx_bytes;
Johannes Berg693b1bb2008-02-25 16:27:48 +0100373 unsigned long wep_weak_iv_count;
374 unsigned long last_rx;
Mohammed Shafi Shajakhanebe27c92011-04-08 21:24:24 +0530375 long last_connected;
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700376 unsigned long num_duplicates;
377 unsigned long rx_fragments;
378 unsigned long rx_dropped;
379 int last_signal;
Bruno Randolf541a45a2010-12-02 19:12:43 +0900380 struct ewma avg_signal;
Saravanadb943572012-11-28 18:27:09 +0530381 int last_ack_signal;
Felix Fietkauef0621e2013-04-22 16:29:31 +0200382
383 u8 chains;
384 s8 chain_signal_last[IEEE80211_MAX_CHAINS];
385 struct ewma chain_signal_avg[IEEE80211_MAX_CHAINS];
386
Johannes Berg9e262972011-07-07 18:45:03 +0200387 /* Plus 1 for non-QoS frames */
Johannes Berg5a306f52012-11-14 23:22:21 +0100388 __le16 last_seq_ctrl[IEEE80211_NUM_TIDS + 1];
Johannes Berg693b1bb2008-02-25 16:27:48 +0100389
390 /* Updated from TX status path only, no locking requirements */
391 unsigned long tx_filtered_count;
392 unsigned long tx_retry_failed, tx_retry_count;
Johannes Berg693b1bb2008-02-25 16:27:48 +0100393 /* moving percentage of failed MSDUs */
394 unsigned int fail_avg;
395
396 /* Updated from TX path only, no locking requirements */
Johannes Berg560d2682013-02-05 10:55:21 +0100397 u32 tx_fragments;
398 u64 tx_packets[IEEE80211_NUM_ACS];
399 u64 tx_bytes[IEEE80211_NUM_ACS];
Johannes Berge6a98542008-10-21 12:40:02 +0200400 struct ieee80211_tx_rate last_tx_rate;
Felix Fietkau3af63342011-02-27 22:08:01 +0100401 int last_rx_rate_idx;
Johannes Berg56146182012-11-09 15:07:02 +0100402 u32 last_rx_rate_flag;
Emmanuel Grumbach1b8d2422014-02-05 16:37:11 +0200403 u32 last_rx_rate_vht_flag;
Johannes Berg56146182012-11-09 15:07:02 +0100404 u8 last_rx_rate_vht_nss;
Johannes Bergf591fa52008-07-10 11:21:26 +0200405 u16 tid_seq[IEEE80211_QOS_CTL_TID_MASK + 1];
Johannes Berg693b1bb2008-02-25 16:27:48 +0100406
Johannes Berg693b1bb2008-02-25 16:27:48 +0100407 /*
Johannes Berg07346f812008-05-03 01:02:02 +0200408 * Aggregation information, locked with lock.
Johannes Berg693b1bb2008-02-25 16:27:48 +0100409 */
Ron Rindjunsky5aae2882007-12-25 17:00:32 +0200410 struct sta_ampdu_mlme ampdu_mlme;
Johannes Berg5a306f52012-11-14 23:22:21 +0100411 u8 timer_to_tid[IEEE80211_NUM_TIDS];
Johannes Berg693b1bb2008-02-25 16:27:48 +0100412
Matti Gottliebad38bfc2013-11-18 19:06:45 +0200413 struct ieee80211_tx_latency_stat *tx_lat;
414
Luis Carlos Coboee385852008-02-23 15:17:11 +0100415#ifdef CONFIG_MAC80211_MESH
Johannes Berg693b1bb2008-02-25 16:27:48 +0100416 /*
417 * Mesh peer link attributes
418 * TODO: move to a sub-structure that is referenced with pointer?
419 */
Chun-Yeow Yeoh6f101ef2013-11-13 15:43:03 +0800420 u16 llid;
421 u16 plid;
422 u16 reason;
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700423 u8 plink_retries;
Johannes Berg74958832008-02-25 22:17:30 +0100424 bool ignore_plink_timer;
Javier Cardona57cf8042011-05-13 10:45:43 -0700425 enum nl80211_plink_state plink_state;
Luis Carlos Coboee385852008-02-23 15:17:11 +0100426 u32 plink_timeout;
427 struct timer_list plink_timer;
Javier Cardonadbf498f2012-03-31 11:31:32 -0700428 s64 t_offset;
429 s64 t_offset_setpoint;
Marco Porsch3f52b7e2013-01-30 18:14:08 +0100430 /* mesh power save */
431 enum nl80211_mesh_power_mode local_pm;
432 enum nl80211_mesh_power_mode peer_pm;
433 enum nl80211_mesh_power_mode nonpeer_pm;
Luis Carlos Coboee385852008-02-23 15:17:11 +0100434#endif
Ron Rindjunsky10816d42007-11-26 16:14:30 +0200435
Jiri Bence9f207f2007-05-05 11:46:38 -0700436#ifdef CONFIG_MAC80211_DEBUGFS
437 struct sta_info_debugfsdentries {
438 struct dentry *dir;
Johannes Berg63044e92008-10-07 12:04:29 +0200439 bool add_has_run;
Jiri Bence9f207f2007-05-05 11:46:38 -0700440 } debugfs;
441#endif
Johannes Berg17741cd2008-09-11 00:02:02 +0200442
Johannes Berg0af83d32012-12-27 18:55:36 +0100443 enum ieee80211_sta_rx_bandwidth cur_max_bandwidth;
444
Johannes Berg99ba2a12010-11-24 08:10:06 +0100445 unsigned int lost_packets;
Paul Stewarta85e1d52011-12-09 11:01:49 -0800446 unsigned int beacon_loss_count;
Johannes Berg99ba2a12010-11-24 08:10:06 +0100447
Emmanuel Grumbach687da132013-10-01 16:45:43 +0300448 enum ieee80211_smps_mode known_smps_mode;
Max Stepanov2475b1cc2013-03-24 14:23:27 +0200449 const struct ieee80211_cipher_scheme *cipher_scheme;
Emmanuel Grumbach687da132013-10-01 16:45:43 +0300450
Johannes Berg17741cd2008-09-11 00:02:02 +0200451 /* keep last! */
452 struct ieee80211_sta sta;
Jiri Bencf0706e82007-05-05 11:45:53 -0700453};
454
Javier Cardona57cf8042011-05-13 10:45:43 -0700455static inline enum nl80211_plink_state sta_plink_state(struct sta_info *sta)
Johannes Bergd6d1a5a2008-02-25 16:24:38 +0100456{
457#ifdef CONFIG_MAC80211_MESH
458 return sta->plink_state;
459#endif
Javier Cardona57cf8042011-05-13 10:45:43 -0700460 return NL80211_PLINK_LISTEN;
Johannes Bergd6d1a5a2008-02-25 16:24:38 +0100461}
462
Johannes Bergc2c98fd2011-09-29 16:04:36 +0200463static inline void set_sta_flag(struct sta_info *sta,
464 enum ieee80211_sta_info_flags flag)
Johannes Berg07346f812008-05-03 01:02:02 +0200465{
Johannes Bergd9a7ddb2011-12-14 12:35:30 +0100466 WARN_ON(flag == WLAN_STA_AUTH ||
467 flag == WLAN_STA_ASSOC ||
468 flag == WLAN_STA_AUTHORIZED);
Johannes Bergc2c98fd2011-09-29 16:04:36 +0200469 set_bit(flag, &sta->_flags);
Johannes Berg07346f812008-05-03 01:02:02 +0200470}
471
Johannes Bergc2c98fd2011-09-29 16:04:36 +0200472static inline void clear_sta_flag(struct sta_info *sta,
473 enum ieee80211_sta_info_flags flag)
Johannes Berg07346f812008-05-03 01:02:02 +0200474{
Johannes Bergd9a7ddb2011-12-14 12:35:30 +0100475 WARN_ON(flag == WLAN_STA_AUTH ||
476 flag == WLAN_STA_ASSOC ||
477 flag == WLAN_STA_AUTHORIZED);
Johannes Bergc2c98fd2011-09-29 16:04:36 +0200478 clear_bit(flag, &sta->_flags);
Johannes Berg07346f812008-05-03 01:02:02 +0200479}
480
Johannes Bergc2c98fd2011-09-29 16:04:36 +0200481static inline int test_sta_flag(struct sta_info *sta,
482 enum ieee80211_sta_info_flags flag)
Johannes Berg07346f812008-05-03 01:02:02 +0200483{
Johannes Bergc2c98fd2011-09-29 16:04:36 +0200484 return test_bit(flag, &sta->_flags);
Johannes Berg07346f812008-05-03 01:02:02 +0200485}
486
Johannes Bergc2c98fd2011-09-29 16:04:36 +0200487static inline int test_and_clear_sta_flag(struct sta_info *sta,
488 enum ieee80211_sta_info_flags flag)
Johannes Berg07346f812008-05-03 01:02:02 +0200489{
Johannes Bergd9a7ddb2011-12-14 12:35:30 +0100490 WARN_ON(flag == WLAN_STA_AUTH ||
491 flag == WLAN_STA_ASSOC ||
492 flag == WLAN_STA_AUTHORIZED);
Johannes Bergc2c98fd2011-09-29 16:04:36 +0200493 return test_and_clear_bit(flag, &sta->_flags);
Johannes Berg07346f812008-05-03 01:02:02 +0200494}
495
Johannes Berge7f4a942011-11-04 11:18:20 +0100496static inline int test_and_set_sta_flag(struct sta_info *sta,
497 enum ieee80211_sta_info_flags flag)
498{
Johannes Bergd9a7ddb2011-12-14 12:35:30 +0100499 WARN_ON(flag == WLAN_STA_AUTH ||
500 flag == WLAN_STA_ASSOC ||
501 flag == WLAN_STA_AUTHORIZED);
Johannes Berge7f4a942011-11-04 11:18:20 +0100502 return test_and_set_bit(flag, &sta->_flags);
503}
504
Johannes Berg83d5cc02012-01-12 09:31:10 +0100505int sta_info_move_state(struct sta_info *sta,
506 enum ieee80211_sta_state new_state);
Johannes Bergd9a7ddb2011-12-14 12:35:30 +0100507
Johannes Berg83d5cc02012-01-12 09:31:10 +0100508static inline void sta_info_pre_move_state(struct sta_info *sta,
509 enum ieee80211_sta_state new_state)
Johannes Bergd9a7ddb2011-12-14 12:35:30 +0100510{
Johannes Berg83d5cc02012-01-12 09:31:10 +0100511 int ret;
512
513 WARN_ON_ONCE(test_sta_flag(sta, WLAN_STA_INSERTED));
514
515 ret = sta_info_move_state(sta, new_state);
Johannes Bergd9a7ddb2011-12-14 12:35:30 +0100516 WARN_ON_ONCE(ret);
517}
518
519
Johannes Bergec034b22011-05-13 13:35:40 +0200520void ieee80211_assign_tid_tx(struct sta_info *sta, int tid,
521 struct tid_ampdu_tx *tid_tx);
Jiri Bencf0706e82007-05-05 11:45:53 -0700522
Johannes Berg40b275b2011-05-13 14:15:49 +0200523static inline struct tid_ampdu_tx *
524rcu_dereference_protected_tid_tx(struct sta_info *sta, int tid)
525{
526 return rcu_dereference_protected(sta->ampdu_mlme.tid_tx[tid],
527 lockdep_is_held(&sta->lock) ||
528 lockdep_is_held(&sta->ampdu_mlme.mtx));
529}
Jiri Bencf0706e82007-05-05 11:45:53 -0700530
531#define STA_HASH_SIZE 256
532#define STA_HASH(sta) (sta[5])
533
534
Johannes Berg948d8872011-09-29 16:04:29 +0200535/* Maximum number of frames to buffer per power saving station per AC */
536#define STA_MAX_TX_BUFFER 64
Jiri Bencf0706e82007-05-05 11:45:53 -0700537
538/* Minimum buffered frame expiry time. If STA uses listen interval that is
539 * smaller than this value, the minimum value here is used instead. */
540#define STA_TX_BUFFER_EXPIRE (10 * HZ)
541
542/* How often station data is cleaned up (e.g., expiration of buffered frames)
543 */
544#define STA_INFO_CLEANUP_INTERVAL (10 * HZ)
545
Johannes Bergd0709a62008-02-25 16:27:46 +0100546/*
Johannes Bergabe60632009-11-25 17:46:18 +0100547 * Get a STA info, must be under RCU read lock.
Johannes Bergd0709a62008-02-25 16:27:46 +0100548 */
Johannes Bergabe60632009-11-25 17:46:18 +0100549struct sta_info *sta_info_get(struct ieee80211_sub_if_data *sdata,
550 const u8 *addr);
551
Felix Fietkau0e5ded52010-01-08 18:10:58 +0100552struct sta_info *sta_info_get_bss(struct ieee80211_sub_if_data *sdata,
553 const u8 *addr);
554
Johannes Bergabe60632009-11-25 17:46:18 +0100555static inline
556void for_each_sta_info_type_check(struct ieee80211_local *local,
557 const u8 *addr,
558 struct sta_info *sta,
559 struct sta_info *nxt)
560{
561}
562
Johannes Berg7852e362012-01-20 13:55:24 +0100563#define for_each_sta_info(local, _addr, _sta, nxt) \
Guy Eilam2a33bee2011-08-17 15:18:15 +0300564 for ( /* initialise loop */ \
565 _sta = rcu_dereference(local->sta_hash[STA_HASH(_addr)]),\
566 nxt = _sta ? rcu_dereference(_sta->hnext) : NULL; \
567 /* typecheck */ \
568 for_each_sta_info_type_check(local, (_addr), _sta, nxt),\
569 /* continue condition */ \
570 _sta; \
571 /* advance loop */ \
572 _sta = nxt, \
573 nxt = _sta ? rcu_dereference(_sta->hnext) : NULL \
574 ) \
Johannes Bergabe60632009-11-25 17:46:18 +0100575 /* compare address and run code only if it matches */ \
Joe Perches3bc79452012-05-08 18:56:53 +0000576 if (ether_addr_equal(_sta->sta.addr, (_addr)))
Johannes Bergabe60632009-11-25 17:46:18 +0100577
Johannes Bergd0709a62008-02-25 16:27:46 +0100578/*
579 * Get STA info by index, BROKEN!
580 */
Johannes Berg3b53fde82009-11-16 12:00:37 +0100581struct sta_info *sta_info_get_by_idx(struct ieee80211_sub_if_data *sdata,
582 int idx);
Johannes Bergd0709a62008-02-25 16:27:46 +0100583/*
Johannes Berg73651ee2008-02-25 16:27:47 +0100584 * Create a new STA info, caller owns returned structure
585 * until sta_info_insert().
Johannes Bergd0709a62008-02-25 16:27:46 +0100586 */
Johannes Berg73651ee2008-02-25 16:27:47 +0100587struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
Johannes Berg56544162011-12-14 13:28:46 +0100588 const u8 *addr, gfp_t gfp);
Johannes Bergd9a7ddb2011-12-14 12:35:30 +0100589
590void sta_info_free(struct ieee80211_local *local, struct sta_info *sta);
591
Johannes Berg73651ee2008-02-25 16:27:47 +0100592/*
593 * Insert STA info into hash table/list, returns zero or a
594 * -EEXIST if (if the same MAC address is already present).
595 *
Johannes Berg34e89502010-02-03 13:59:58 +0100596 * Calling the non-rcu version makes the caller relinquish,
597 * the _rcu version calls read_lock_rcu() and must be called
598 * without it held.
Johannes Berg73651ee2008-02-25 16:27:47 +0100599 */
600int sta_info_insert(struct sta_info *sta);
Johannes Berg34e89502010-02-03 13:59:58 +0100601int sta_info_insert_rcu(struct sta_info *sta) __acquires(RCU);
Johannes Bergd0709a62008-02-25 16:27:46 +0100602
Johannes Berg83d5cc02012-01-12 09:31:10 +0100603int __must_check __sta_info_destroy(struct sta_info *sta);
Johannes Berg34e89502010-02-03 13:59:58 +0100604int sta_info_destroy_addr(struct ieee80211_sub_if_data *sdata,
605 const u8 *addr);
606int sta_info_destroy_addr_bss(struct ieee80211_sub_if_data *sdata,
607 const u8 *addr);
608
Johannes Bergc868cb352011-09-29 16:04:27 +0200609void sta_info_recalc_tim(struct sta_info *sta);
Johannes Bergd0709a62008-02-25 16:27:46 +0100610
Jiri Bencf0706e82007-05-05 11:45:53 -0700611void sta_info_init(struct ieee80211_local *local);
Jiri Bencf0706e82007-05-05 11:45:53 -0700612void sta_info_stop(struct ieee80211_local *local);
Johannes Berg051007d2012-12-13 23:49:02 +0100613
614/**
615 * sta_info_flush - flush matching STA entries from the STA table
616 *
617 * Returns the number of removed STA entries.
618 *
619 * @sdata: sdata to remove all stations from
Johannes Berge7162512013-12-04 23:18:37 +0100620 * @vlans: if the given interface is an AP interface, also flush VLANs
Johannes Berg051007d2012-12-13 23:49:02 +0100621 */
Johannes Berge7162512013-12-04 23:18:37 +0100622int __sta_info_flush(struct ieee80211_sub_if_data *sdata, bool vlans);
623
624static inline int sta_info_flush(struct ieee80211_sub_if_data *sdata)
625{
626 return __sta_info_flush(sdata, false);
627}
Johannes Berg051007d2012-12-13 23:49:02 +0100628
Thomas Pedersen6b62bf32012-03-05 15:31:48 -0800629void sta_set_rate_info_tx(struct sta_info *sta,
630 const struct ieee80211_tx_rate *rate,
631 struct rate_info *rinfo);
Saravana003e6762012-11-28 18:29:38 +0530632void sta_set_rate_info_rx(struct sta_info *sta,
633 struct rate_info *rinfo);
Johannes Berg24723d12008-09-11 00:01:46 +0200634void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata,
635 unsigned long exp_time);
Emmanuel Grumbach687da132013-10-01 16:45:43 +0300636u8 sta_info_tx_streams(struct sta_info *sta);
Johannes Berg004c8722008-02-20 11:21:35 +0100637
Johannes Bergaf818582009-11-06 11:35:50 +0100638void ieee80211_sta_ps_deliver_wakeup(struct sta_info *sta);
639void ieee80211_sta_ps_deliver_poll_response(struct sta_info *sta);
Johannes Berg47086fc2011-09-29 16:04:33 +0200640void ieee80211_sta_ps_deliver_uapsd(struct sta_info *sta);
Johannes Bergaf818582009-11-06 11:35:50 +0100641
Jiri Bencf0706e82007-05-05 11:45:53 -0700642#endif /* STA_INFO_H */