blob: 54262e72376d0e662ebbb1b27b02a14e6a869cdb [file] [log] [blame]
Jiri Bencf0706e822007-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>
Johannes Berg2c8dccc2008-04-08 15:14:40 -040016#include "key.h"
Jiri Bencf0706e822007-05-05 11:45:53 -070017
Johannes Berg238814f2008-01-28 17:19:37 +010018/**
19 * enum ieee80211_sta_info_flags - Stations flags
20 *
21 * These flags are used with &struct sta_info's @flags member.
22 *
23 * @WLAN_STA_AUTH: Station is authenticated.
24 * @WLAN_STA_ASSOC: Station is associated.
Johannes Bergaf818582009-11-06 11:35:50 +010025 * @WLAN_STA_PS_STA: Station is in power-save mode
Johannes Berg238814f2008-01-28 17:19:37 +010026 * @WLAN_STA_AUTHORIZED: Station is authorized to send/receive traffic.
27 * This bit is always checked so needs to be enabled for all stations
28 * when virtual port control is not in use.
29 * @WLAN_STA_SHORT_PREAMBLE: Station is capable of receiving short-preamble
30 * frames.
31 * @WLAN_STA_ASSOC_AP: We're associated to that station, it is an AP.
32 * @WLAN_STA_WME: Station is a QoS-STA.
33 * @WLAN_STA_WDS: Station is one of our WDS peers.
Johannes Bergd46e1442008-02-20 23:59:33 +010034 * @WLAN_STA_CLEAR_PS_FILT: Clear PS filter in hardware (using the
Johannes Berge039fa42008-05-15 12:55:29 +020035 * IEEE80211_TX_CTL_CLEAR_PS_FILT control flag) when the next
Johannes Bergd46e1442008-02-20 23:59:33 +010036 * frame to this station is transmitted.
Jouni Malinen5394af42009-01-08 13:31:59 +020037 * @WLAN_STA_MFP: Management frame protection is used with this STA.
Johannes Berg618f3562010-04-06 11:18:46 +020038 * @WLAN_STA_BLOCK_BA: Used to deny ADDBA requests (both TX and RX)
Johannes Berg098a6072010-04-06 11:18:47 +020039 * during suspend/resume and station removal.
Johannes Bergaf818582009-11-06 11:35:50 +010040 * @WLAN_STA_PS_DRIVER: driver requires keeping this station in
41 * power-save mode logically to flush frames that might still
42 * be in the queues
43 * @WLAN_STA_PSPOLL: Station sent PS-poll while driver was keeping
44 * station in power-save mode, reply when the driver unblocks.
Johannes Berg238814f2008-01-28 17:19:37 +010045 */
46enum ieee80211_sta_info_flags {
47 WLAN_STA_AUTH = 1<<0,
48 WLAN_STA_ASSOC = 1<<1,
Johannes Bergaf818582009-11-06 11:35:50 +010049 WLAN_STA_PS_STA = 1<<2,
Johannes Berg836341a2008-02-20 02:07:21 +010050 WLAN_STA_AUTHORIZED = 1<<3,
51 WLAN_STA_SHORT_PREAMBLE = 1<<4,
52 WLAN_STA_ASSOC_AP = 1<<5,
53 WLAN_STA_WME = 1<<6,
54 WLAN_STA_WDS = 1<<7,
Johannes Bergd46e1442008-02-20 23:59:33 +010055 WLAN_STA_CLEAR_PS_FILT = 1<<9,
Jouni Malinen5394af42009-01-08 13:31:59 +020056 WLAN_STA_MFP = 1<<10,
Johannes Berg618f3562010-04-06 11:18:46 +020057 WLAN_STA_BLOCK_BA = 1<<11,
Johannes Bergaf818582009-11-06 11:35:50 +010058 WLAN_STA_PS_DRIVER = 1<<12,
59 WLAN_STA_PSPOLL = 1<<13,
Johannes Berg238814f2008-01-28 17:19:37 +010060};
Jiri Bencf0706e822007-05-05 11:45:53 -070061
Ron Rindjunsky5aae2882007-12-25 17:00:32 +020062#define STA_TID_NUM 16
63#define ADDBA_RESP_INTERVAL HZ
Johannes Berga622ab72010-06-10 10:21:39 +020064#define HT_AGG_MAX_RETRIES 0x3
Ron Rindjunsky5aae2882007-12-25 17:00:32 +020065
Johannes Berga622ab72010-06-10 10:21:39 +020066#define HT_AGG_STATE_DRV_READY 0
67#define HT_AGG_STATE_RESPONSE_RECEIVED 1
68#define HT_AGG_STATE_OPERATIONAL 2
69#define HT_AGG_STATE_STOPPING 3
Johannes Berg0ab33702010-06-10 10:21:42 +020070#define HT_AGG_STATE_WANT_START 4
71#define HT_AGG_STATE_WANT_STOP 5
Ron Rindjunsky80656c22008-01-28 14:07:16 +020072
73/**
74 * struct tid_ampdu_tx - TID aggregation information (Tx).
75 *
Johannes Berga622ab72010-06-10 10:21:39 +020076 * @rcu_head: rcu head for freeing structure
Ron Rindjunsky80656c22008-01-28 14:07:16 +020077 * @addba_resp_timer: timer for peer's response to addba request
Johannes Bergcd8ffc82009-03-23 17:28:41 +010078 * @pending: pending frames queue -- use sta's spinlock to protect
Ron Rindjunskycee24a32008-03-26 20:36:03 +020079 * @dialog_token: dialog token for aggregation session
Johannes Berga622ab72010-06-10 10:21:39 +020080 * @state: session state (see above)
81 * @stop_initiator: initiator of a session stop
82 *
83 * This structure is protected by RCU and the per-station
84 * spinlock. Assignments to the array holding it must hold
85 * the spinlock, only the TX path can access it under RCU
86 * lock-free if, and only if, the state has the flag
87 * %HT_AGG_STATE_OPERATIONAL set. Otherwise, the TX path
88 * must also acquire the spinlock and re-check the state,
89 * see comments in the tx code touching it.
Ron Rindjunsky80656c22008-01-28 14:07:16 +020090 */
91struct tid_ampdu_tx {
Johannes Berga622ab72010-06-10 10:21:39 +020092 struct rcu_head rcu_head;
Ron Rindjunsky80656c22008-01-28 14:07:16 +020093 struct timer_list addba_resp_timer;
Johannes Bergcd8ffc82009-03-23 17:28:41 +010094 struct sk_buff_head pending;
Johannes Berga622ab72010-06-10 10:21:39 +020095 unsigned long state;
Ron Rindjunskycee24a32008-03-26 20:36:03 +020096 u8 dialog_token;
Johannes Berga622ab72010-06-10 10:21:39 +020097 u8 stop_initiator;
Ron Rindjunsky80656c22008-01-28 14:07:16 +020098};
Ron Rindjunsky5aae2882007-12-25 17:00:32 +020099
100/**
101 * struct tid_ampdu_rx - TID aggregation information (Rx).
102 *
Ron Rindjunsky5aae2882007-12-25 17:00:32 +0200103 * @reorder_buf: buffer to reorder incoming aggregated MPDUs
Jouni Malinen4d050f12009-05-05 20:35:14 +0300104 * @reorder_time: jiffies when skb was added
Ron Rindjunsky5aae2882007-12-25 17:00:32 +0200105 * @session_timer: check if peer keeps Tx-ing on the TID (by timeout value)
Johannes Berg056cdd52008-03-26 23:21:47 +0100106 * @head_seq_num: head sequence number in reordering buffer.
107 * @stored_mpdu_num: number of MPDUs in reordering buffer
Ron Rindjunskycee24a32008-03-26 20:36:03 +0200108 * @ssn: Starting Sequence Number expected to be aggregated.
109 * @buf_size: buffer size for incoming A-MPDUs
Johannes Berg20ad19d2009-02-10 21:25:45 +0100110 * @timeout: reset timer value (in TUs).
Ron Rindjunskycee24a32008-03-26 20:36:03 +0200111 * @dialog_token: dialog token for aggregation session
Johannes Berga87f7362010-06-10 10:21:38 +0200112 * @rcu_head: RCU head used for freeing this struct
113 *
114 * This structure is protected by RCU and the per-station
115 * spinlock. Assignments to the array holding it must hold
116 * the spinlock, only the RX path can access it under RCU
117 * lock-free. The RX path, since it is single-threaded,
118 * can even modify the structure without locking since the
119 * only other modifications to it are done when the struct
120 * can not yet or no longer be found by the RX path.
Ron Rindjunsky5aae2882007-12-25 17:00:32 +0200121 */
122struct tid_ampdu_rx {
Johannes Berga87f7362010-06-10 10:21:38 +0200123 struct rcu_head rcu_head;
Ron Rindjunsky5aae2882007-12-25 17:00:32 +0200124 struct sk_buff **reorder_buf;
Jouni Malinen4d050f12009-05-05 20:35:14 +0300125 unsigned long *reorder_time;
Ron Rindjunsky5aae2882007-12-25 17:00:32 +0200126 struct timer_list session_timer;
Johannes Berg056cdd52008-03-26 23:21:47 +0100127 u16 head_seq_num;
128 u16 stored_mpdu_num;
Ron Rindjunskycee24a32008-03-26 20:36:03 +0200129 u16 ssn;
130 u16 buf_size;
131 u16 timeout;
132 u8 dialog_token;
Ron Rindjunsky5aae2882007-12-25 17:00:32 +0200133};
134
Luis Carlos Cobob4e08ea2008-02-29 15:46:08 -0800135/**
Johannes Bergfcea6002010-05-31 11:40:23 +0200136 * struct sta_ampdu_mlme - STA aggregation information.
137 *
Johannes Berga87f7362010-06-10 10:21:38 +0200138 * @tid_rx: aggregation info for Rx per TID -- RCU protected
Johannes Bergfcea6002010-05-31 11:40:23 +0200139 * @tid_tx: aggregation info for Tx per TID
140 * @addba_req_num: number of times addBA request has been sent.
141 * @dialog_token_allocator: dialog token enumerator for each new session;
Johannes Berg0ab33702010-06-10 10:21:42 +0200142 * @work: work struct for starting/stopping aggregation
Johannes Berg7c3b1dd2010-06-10 10:21:44 +0200143 * @tid_rx_timer_expired: bitmap indicating on which TIDs the
144 * RX timer expired until the work for it runs
Johannes Berga93e3642010-06-10 10:21:46 +0200145 * @mtx: mutex to protect all TX data (except non-NULL assignments
146 * to tid_tx[idx], which are protected by the sta spinlock)
Johannes Bergfcea6002010-05-31 11:40:23 +0200147 */
148struct sta_ampdu_mlme {
Johannes Berga93e3642010-06-10 10:21:46 +0200149 struct mutex mtx;
Johannes Bergfcea6002010-05-31 11:40:23 +0200150 /* rx */
Johannes Bergfcea6002010-05-31 11:40:23 +0200151 struct tid_ampdu_rx *tid_rx[STA_TID_NUM];
Johannes Berg7c3b1dd2010-06-10 10:21:44 +0200152 unsigned long tid_rx_timer_expired[BITS_TO_LONGS(STA_TID_NUM)];
Johannes Bergfcea6002010-05-31 11:40:23 +0200153 /* tx */
Johannes Berg0ab33702010-06-10 10:21:42 +0200154 struct work_struct work;
Johannes Bergfcea6002010-05-31 11:40:23 +0200155 struct tid_ampdu_tx *tid_tx[STA_TID_NUM];
156 u8 addba_req_num[STA_TID_NUM];
157 u8 dialog_token_allocator;
158};
159
160
161/**
Luis Carlos Cobob4e08ea2008-02-29 15:46:08 -0800162 * enum plink_state - state of a mesh peer link finite state machine
163 *
164 * @PLINK_LISTEN: initial state, considered the implicit state of non existant
165 * mesh peer links
166 * @PLINK_OPN_SNT: mesh plink open frame has been sent to this mesh peer
167 * @PLINK_OPN_RCVD: mesh plink open frame has been received from this mesh peer
168 * @PLINK_CNF_RCVD: mesh plink confirm frame has been received from this mesh
169 * peer
170 * @PLINK_ESTAB: mesh peer link is established
171 * @PLINK_HOLDING: mesh peer link is being closed or cancelled
172 * @PLINK_BLOCKED: all frames transmitted from this mesh plink are discarded
173 */
Luis Carlos Coboee385852008-02-23 15:17:11 +0100174enum plink_state {
Luis Carlos Cobob4e08ea2008-02-29 15:46:08 -0800175 PLINK_LISTEN,
176 PLINK_OPN_SNT,
177 PLINK_OPN_RCVD,
178 PLINK_CNF_RCVD,
179 PLINK_ESTAB,
180 PLINK_HOLDING,
181 PLINK_BLOCKED
Luis Carlos Coboee385852008-02-23 15:17:11 +0100182};
Luis Carlos Coboee385852008-02-23 15:17:11 +0100183
Ron Rindjunsky5aae2882007-12-25 17:00:32 +0200184/**
Johannes Berg693b1bb2008-02-25 16:27:48 +0100185 * struct sta_info - STA information
186 *
187 * This structure collects information about a station that
188 * mac80211 is communicating with.
189 *
190 * @list: global linked list entry
191 * @hnext: hash table linked list pointer
192 * @local: pointer to the global information
Johannes Berge25cf4a2008-10-23 08:51:20 +0200193 * @sdata: virtual interface this station belongs to
194 * @key: peer key negotiated with this station, if any
195 * @rate_ctrl: rate control algorithm reference
196 * @rate_ctrl_priv: rate control private per-STA pointer
197 * @last_tx_rate: rate used for last transmit, to report to userspace as
198 * "the" transmit rate
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700199 * @lock: used for locking all fields that require locking, see comments
200 * in the header file.
201 * @flaglock: spinlock for flags accesses
Jaswinder Singh Rajput841507f2009-11-22 13:47:58 +0530202 * @drv_unblock_wk: used for driver PS unblocking
Johannes Berge25cf4a2008-10-23 08:51:20 +0200203 * @listen_interval: listen interval of this station, when we're acting as AP
Johannes Berg693b1bb2008-02-25 16:27:48 +0100204 * @flags: STA flags, see &enum ieee80211_sta_info_flags
205 * @ps_tx_buf: buffer of frames to transmit to this station
206 * when it leaves power saving state
207 * @tx_filtered: buffer of frames we already tried to transmit
208 * but were filtered by hardware due to STA having entered
209 * power saving state
210 * @rx_packets: Number of MSDUs received from this STA
211 * @rx_bytes: Number of bytes received from this STA
Johannes Berge25cf4a2008-10-23 08:51:20 +0200212 * @wep_weak_iv_count: number of weak WEP IVs received from this station
213 * @last_rx: time (in jiffies) when last frame was received from this STA
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700214 * @num_duplicates: number of duplicate frames received from this STA
215 * @rx_fragments: number of received MPDUs
216 * @rx_dropped: number of dropped MPDUs from this STA
217 * @last_signal: signal of last received frame from this STA
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700218 * @last_seq_ctrl: last received seq/frag number from this STA (per RX queue)
Johannes Berge25cf4a2008-10-23 08:51:20 +0200219 * @tx_filtered_count: number of frames the hardware filtered for this STA
220 * @tx_retry_failed: number of frames that failed retry
221 * @tx_retry_count: total number of retries for frames to this STA
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700222 * @fail_avg: moving percentage of failed MSDUs
223 * @tx_packets: number of RX/TX MSDUs
Johannes Berge25cf4a2008-10-23 08:51:20 +0200224 * @tx_bytes: number of bytes transmitted to this STA
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700225 * @tx_fragments: number of transmitted MPDUs
Johannes Berge25cf4a2008-10-23 08:51:20 +0200226 * @tid_seq: per-TID sequence numbers for sending to this STA
227 * @ampdu_mlme: A-MPDU state machine state
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700228 * @timer_to_tid: identity mapping to ID timers
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700229 * @llid: Local link ID
230 * @plid: Peer link ID
231 * @reason: Cancel reason on PLINK_HOLDING state
232 * @plink_retries: Retries in establishment
Johannes Berge25cf4a2008-10-23 08:51:20 +0200233 * @ignore_plink_timer: ignore the peer-link timer (used internally)
234 * @plink_state: peer link state
235 * @plink_timeout: timeout of peer link
236 * @plink_timer: peer link watch timer
Johannes Bergcce4c772009-05-19 10:39:34 +0200237 * @plink_timer_was_running: used by suspend/resume to restore timers
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700238 * @debugfs: debug filesystem info
Johannes Berg17741cd2008-09-11 00:02:02 +0200239 * @sta: station information we share with the driver
Johannes Bergaf818582009-11-06 11:35:50 +0100240 * @dead: set to true when sta is unlinked
Johannes Berg34e89502010-02-03 13:59:58 +0100241 * @uploaded: set to true when sta is uploaded to the driver
Johannes Berg693b1bb2008-02-25 16:27:48 +0100242 */
Jiri Bencf0706e822007-05-05 11:45:53 -0700243struct sta_info {
Johannes Berg693b1bb2008-02-25 16:27:48 +0100244 /* General information, mostly static */
Jiri Bencf0706e822007-05-05 11:45:53 -0700245 struct list_head list;
Johannes Berg693b1bb2008-02-25 16:27:48 +0100246 struct sta_info *hnext;
Jiri Bencf0706e822007-05-05 11:45:53 -0700247 struct ieee80211_local *local;
Johannes Bergd0709a62008-02-25 16:27:46 +0100248 struct ieee80211_sub_if_data *sdata;
Jiri Bencf0706e822007-05-05 11:45:53 -0700249 struct ieee80211_key *key;
Jiri Bencf0706e822007-05-05 11:45:53 -0700250 struct rate_control_ref *rate_ctrl;
251 void *rate_ctrl_priv;
Johannes Berg07346f812008-05-03 01:02:02 +0200252 spinlock_t lock;
Johannes Berg5a9f7b02008-06-18 14:58:09 +0200253 spinlock_t flaglock;
Johannes Berg17741cd2008-09-11 00:02:02 +0200254
Johannes Bergaf818582009-11-06 11:35:50 +0100255 struct work_struct drv_unblock_wk;
256
Jiri Bencf0706e822007-05-05 11:45:53 -0700257 u16 listen_interval;
Jiri Bence9f207f2007-05-05 11:46:38 -0700258
Johannes Bergaf818582009-11-06 11:35:50 +0100259 bool dead;
260
Johannes Berg34e89502010-02-03 13:59:58 +0100261 bool uploaded;
Johannes Bergd0709a62008-02-25 16:27:46 +0100262
Johannes Berg5a9f7b02008-06-18 14:58:09 +0200263 /*
264 * frequently updated, locked with own spinlock (flaglock),
265 * use the accessors defined below
266 */
Johannes Berg693b1bb2008-02-25 16:27:48 +0100267 u32 flags;
268
269 /*
270 * STA powersave frame queues, no more than the internal
271 * locking required.
272 */
273 struct sk_buff_head ps_tx_buf;
274 struct sk_buff_head tx_filtered;
275
276 /* Updated from RX path only, no locking requirements */
277 unsigned long rx_packets, rx_bytes;
278 unsigned long wep_weak_iv_count;
279 unsigned long last_rx;
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700280 unsigned long num_duplicates;
281 unsigned long rx_fragments;
282 unsigned long rx_dropped;
283 int last_signal;
Johannes Berg693b1bb2008-02-25 16:27:48 +0100284 __le16 last_seq_ctrl[NUM_RX_DATA_QUEUES];
Johannes Berg693b1bb2008-02-25 16:27:48 +0100285
286 /* Updated from TX status path only, no locking requirements */
287 unsigned long tx_filtered_count;
288 unsigned long tx_retry_failed, tx_retry_count;
Johannes Berg693b1bb2008-02-25 16:27:48 +0100289 /* moving percentage of failed MSDUs */
290 unsigned int fail_avg;
291
292 /* Updated from TX path only, no locking requirements */
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700293 unsigned long tx_packets;
Johannes Berg693b1bb2008-02-25 16:27:48 +0100294 unsigned long tx_bytes;
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700295 unsigned long tx_fragments;
Johannes Berge6a98542008-10-21 12:40:02 +0200296 struct ieee80211_tx_rate last_tx_rate;
Johannes Bergf591fa52008-07-10 11:21:26 +0200297 u16 tid_seq[IEEE80211_QOS_CTL_TID_MASK + 1];
Johannes Berg693b1bb2008-02-25 16:27:48 +0100298
Johannes Berg693b1bb2008-02-25 16:27:48 +0100299 /*
Johannes Berg07346f812008-05-03 01:02:02 +0200300 * Aggregation information, locked with lock.
Johannes Berg693b1bb2008-02-25 16:27:48 +0100301 */
Ron Rindjunsky5aae2882007-12-25 17:00:32 +0200302 struct sta_ampdu_mlme ampdu_mlme;
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700303 u8 timer_to_tid[STA_TID_NUM];
Johannes Berg693b1bb2008-02-25 16:27:48 +0100304
Luis Carlos Coboee385852008-02-23 15:17:11 +0100305#ifdef CONFIG_MAC80211_MESH
Johannes Berg693b1bb2008-02-25 16:27:48 +0100306 /*
307 * Mesh peer link attributes
308 * TODO: move to a sub-structure that is referenced with pointer?
309 */
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700310 __le16 llid;
311 __le16 plid;
312 __le16 reason;
313 u8 plink_retries;
Johannes Berg74958832008-02-25 22:17:30 +0100314 bool ignore_plink_timer;
Johannes Berg5bb644a2009-05-17 11:40:42 +0200315 bool plink_timer_was_running;
Luis Carlos Coboee385852008-02-23 15:17:11 +0100316 enum plink_state plink_state;
317 u32 plink_timeout;
318 struct timer_list plink_timer;
Luis Carlos Coboee385852008-02-23 15:17:11 +0100319#endif
Ron Rindjunsky10816d42007-11-26 16:14:30 +0200320
Jiri Bence9f207f2007-05-05 11:46:38 -0700321#ifdef CONFIG_MAC80211_DEBUGFS
322 struct sta_info_debugfsdentries {
323 struct dentry *dir;
Johannes Berg63044e92008-10-07 12:04:29 +0200324 bool add_has_run;
Jiri Bence9f207f2007-05-05 11:46:38 -0700325 } debugfs;
326#endif
Johannes Berg17741cd2008-09-11 00:02:02 +0200327
328 /* keep last! */
329 struct ieee80211_sta sta;
Jiri Bencf0706e822007-05-05 11:45:53 -0700330};
331
Johannes Bergd6d1a5a2008-02-25 16:24:38 +0100332static inline enum plink_state sta_plink_state(struct sta_info *sta)
333{
334#ifdef CONFIG_MAC80211_MESH
335 return sta->plink_state;
336#endif
Luis Carlos Cobob4e08ea2008-02-29 15:46:08 -0800337 return PLINK_LISTEN;
Johannes Bergd6d1a5a2008-02-25 16:24:38 +0100338}
339
Johannes Berg07346f812008-05-03 01:02:02 +0200340static inline void set_sta_flags(struct sta_info *sta, const u32 flags)
341{
Johannes Berg5a9f7b02008-06-18 14:58:09 +0200342 unsigned long irqfl;
343
344 spin_lock_irqsave(&sta->flaglock, irqfl);
Johannes Berg07346f812008-05-03 01:02:02 +0200345 sta->flags |= flags;
Johannes Berg5a9f7b02008-06-18 14:58:09 +0200346 spin_unlock_irqrestore(&sta->flaglock, irqfl);
Johannes Berg07346f812008-05-03 01:02:02 +0200347}
348
349static inline void clear_sta_flags(struct sta_info *sta, const u32 flags)
350{
Johannes Berg5a9f7b02008-06-18 14:58:09 +0200351 unsigned long irqfl;
352
353 spin_lock_irqsave(&sta->flaglock, irqfl);
Johannes Berg07346f812008-05-03 01:02:02 +0200354 sta->flags &= ~flags;
Johannes Berg5a9f7b02008-06-18 14:58:09 +0200355 spin_unlock_irqrestore(&sta->flaglock, irqfl);
Johannes Berg07346f812008-05-03 01:02:02 +0200356}
357
Johannes Berg07346f812008-05-03 01:02:02 +0200358static inline u32 test_sta_flags(struct sta_info *sta, const u32 flags)
359{
360 u32 ret;
Johannes Berg5a9f7b02008-06-18 14:58:09 +0200361 unsigned long irqfl;
Johannes Berg07346f812008-05-03 01:02:02 +0200362
Johannes Berg5a9f7b02008-06-18 14:58:09 +0200363 spin_lock_irqsave(&sta->flaglock, irqfl);
Johannes Berg07346f812008-05-03 01:02:02 +0200364 ret = sta->flags & flags;
Johannes Berg5a9f7b02008-06-18 14:58:09 +0200365 spin_unlock_irqrestore(&sta->flaglock, irqfl);
Johannes Berg07346f812008-05-03 01:02:02 +0200366
367 return ret;
368}
369
370static inline u32 test_and_clear_sta_flags(struct sta_info *sta,
371 const u32 flags)
372{
373 u32 ret;
Johannes Berg5a9f7b02008-06-18 14:58:09 +0200374 unsigned long irqfl;
Johannes Berg07346f812008-05-03 01:02:02 +0200375
Johannes Berg5a9f7b02008-06-18 14:58:09 +0200376 spin_lock_irqsave(&sta->flaglock, irqfl);
Johannes Berg07346f812008-05-03 01:02:02 +0200377 ret = sta->flags & flags;
378 sta->flags &= ~flags;
Johannes Berg5a9f7b02008-06-18 14:58:09 +0200379 spin_unlock_irqrestore(&sta->flaglock, irqfl);
Johannes Berg07346f812008-05-03 01:02:02 +0200380
381 return ret;
382}
383
384static inline u32 get_sta_flags(struct sta_info *sta)
385{
386 u32 ret;
Johannes Berg5a9f7b02008-06-18 14:58:09 +0200387 unsigned long irqfl;
Johannes Berg07346f812008-05-03 01:02:02 +0200388
Johannes Berg5a9f7b02008-06-18 14:58:09 +0200389 spin_lock_irqsave(&sta->flaglock, irqfl);
Johannes Berg07346f812008-05-03 01:02:02 +0200390 ret = sta->flags;
Johannes Berg5a9f7b02008-06-18 14:58:09 +0200391 spin_unlock_irqrestore(&sta->flaglock, irqfl);
Johannes Berg07346f812008-05-03 01:02:02 +0200392
393 return ret;
394}
395
Jiri Bencf0706e822007-05-05 11:45:53 -0700396
Jiri Bencf0706e822007-05-05 11:45:53 -0700397
398#define STA_HASH_SIZE 256
399#define STA_HASH(sta) (sta[5])
400
401
402/* Maximum number of frames to buffer per power saving station */
403#define STA_MAX_TX_BUFFER 128
404
405/* Minimum buffered frame expiry time. If STA uses listen interval that is
406 * smaller than this value, the minimum value here is used instead. */
407#define STA_TX_BUFFER_EXPIRE (10 * HZ)
408
409/* How often station data is cleaned up (e.g., expiration of buffered frames)
410 */
411#define STA_INFO_CLEANUP_INTERVAL (10 * HZ)
412
Johannes Bergd0709a62008-02-25 16:27:46 +0100413/*
Johannes Bergabe60632009-11-25 17:46:18 +0100414 * Get a STA info, must be under RCU read lock.
Johannes Bergd0709a62008-02-25 16:27:46 +0100415 */
Johannes Bergabe60632009-11-25 17:46:18 +0100416struct sta_info *sta_info_get(struct ieee80211_sub_if_data *sdata,
417 const u8 *addr);
418
Felix Fietkau0e5ded52010-01-08 18:10:58 +0100419struct sta_info *sta_info_get_bss(struct ieee80211_sub_if_data *sdata,
420 const u8 *addr);
421
Johannes Bergabe60632009-11-25 17:46:18 +0100422static inline
423void for_each_sta_info_type_check(struct ieee80211_local *local,
424 const u8 *addr,
425 struct sta_info *sta,
426 struct sta_info *nxt)
427{
428}
429
Felix Fietkau38bdb652010-06-25 01:44:33 +0200430#define for_each_sta_info(local, _addr, _sta, nxt) \
Johannes Bergabe60632009-11-25 17:46:18 +0100431 for ( /* initialise loop */ \
Felix Fietkau38bdb652010-06-25 01:44:33 +0200432 _sta = rcu_dereference(local->sta_hash[STA_HASH(_addr)]),\
433 nxt = _sta ? rcu_dereference(_sta->hnext) : NULL; \
Johannes Bergabe60632009-11-25 17:46:18 +0100434 /* typecheck */ \
Felix Fietkau38bdb652010-06-25 01:44:33 +0200435 for_each_sta_info_type_check(local, (_addr), _sta, nxt),\
Johannes Bergabe60632009-11-25 17:46:18 +0100436 /* continue condition */ \
Felix Fietkau38bdb652010-06-25 01:44:33 +0200437 _sta; \
Johannes Bergabe60632009-11-25 17:46:18 +0100438 /* advance loop */ \
Felix Fietkau38bdb652010-06-25 01:44:33 +0200439 _sta = nxt, \
440 nxt = _sta ? rcu_dereference(_sta->hnext) : NULL \
Johannes Bergabe60632009-11-25 17:46:18 +0100441 ) \
442 /* compare address and run code only if it matches */ \
Felix Fietkau38bdb652010-06-25 01:44:33 +0200443 if (memcmp(_sta->sta.addr, (_addr), ETH_ALEN) == 0)
Johannes Bergabe60632009-11-25 17:46:18 +0100444
Johannes Bergd0709a62008-02-25 16:27:46 +0100445/*
446 * Get STA info by index, BROKEN!
447 */
Johannes Berg3b53fde82009-11-16 12:00:37 +0100448struct sta_info *sta_info_get_by_idx(struct ieee80211_sub_if_data *sdata,
449 int idx);
Johannes Bergd0709a62008-02-25 16:27:46 +0100450/*
Johannes Berg73651ee2008-02-25 16:27:47 +0100451 * Create a new STA info, caller owns returned structure
452 * until sta_info_insert().
Johannes Bergd0709a62008-02-25 16:27:46 +0100453 */
Johannes Berg73651ee2008-02-25 16:27:47 +0100454struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
455 u8 *addr, gfp_t gfp);
456/*
457 * Insert STA info into hash table/list, returns zero or a
458 * -EEXIST if (if the same MAC address is already present).
459 *
Johannes Berg34e89502010-02-03 13:59:58 +0100460 * Calling the non-rcu version makes the caller relinquish,
461 * the _rcu version calls read_lock_rcu() and must be called
462 * without it held.
Johannes Berg73651ee2008-02-25 16:27:47 +0100463 */
464int sta_info_insert(struct sta_info *sta);
Johannes Berg34e89502010-02-03 13:59:58 +0100465int sta_info_insert_rcu(struct sta_info *sta) __acquires(RCU);
466int sta_info_insert_atomic(struct sta_info *sta);
Johannes Bergd0709a62008-02-25 16:27:46 +0100467
Johannes Berg34e89502010-02-03 13:59:58 +0100468int sta_info_destroy_addr(struct ieee80211_sub_if_data *sdata,
469 const u8 *addr);
470int sta_info_destroy_addr_bss(struct ieee80211_sub_if_data *sdata,
471 const u8 *addr);
472
Johannes Bergd0709a62008-02-25 16:27:46 +0100473void sta_info_set_tim_bit(struct sta_info *sta);
474void sta_info_clear_tim_bit(struct sta_info *sta);
475
Jiri Bencf0706e822007-05-05 11:45:53 -0700476void sta_info_init(struct ieee80211_local *local);
477int sta_info_start(struct ieee80211_local *local);
478void sta_info_stop(struct ieee80211_local *local);
Johannes Berg44213b52008-02-25 16:27:49 +0100479int sta_info_flush(struct ieee80211_local *local,
Johannes Bergaf8cdcd2009-04-19 21:25:43 +0200480 struct ieee80211_sub_if_data *sdata);
Johannes Berg24723d12008-09-11 00:01:46 +0200481void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata,
482 unsigned long exp_time);
Johannes Berg004c8722008-02-20 11:21:35 +0100483
Johannes Bergaf818582009-11-06 11:35:50 +0100484void ieee80211_sta_ps_deliver_wakeup(struct sta_info *sta);
485void ieee80211_sta_ps_deliver_poll_response(struct sta_info *sta);
486
Jiri Bencf0706e822007-05-05 11:45:53 -0700487#endif /* STA_INFO_H */