cfg80211: don't export ieee80211_get_channel
[deliverable/linux.git] / net / mac80211 / sta_info.h
CommitLineData
f0706e82
JB
1/*
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>
f0706e82
JB
15#include "ieee80211_key.h"
16
238814fd
JB
17/**
18 * enum ieee80211_sta_info_flags - Stations flags
19 *
20 * These flags are used with &struct sta_info's @flags member.
21 *
22 * @WLAN_STA_AUTH: Station is authenticated.
23 * @WLAN_STA_ASSOC: Station is associated.
24 * @WLAN_STA_PS: Station is in power-save mode
238814fd
JB
25 * @WLAN_STA_AUTHORIZED: Station is authorized to send/receive traffic.
26 * This bit is always checked so needs to be enabled for all stations
27 * when virtual port control is not in use.
28 * @WLAN_STA_SHORT_PREAMBLE: Station is capable of receiving short-preamble
29 * frames.
30 * @WLAN_STA_ASSOC_AP: We're associated to that station, it is an AP.
31 * @WLAN_STA_WME: Station is a QoS-STA.
32 * @WLAN_STA_WDS: Station is one of our WDS peers.
4a9a66e9 33 * @WLAN_STA_PSPOLL: Station has just PS-polled us.
d46e144b
JB
34 * @WLAN_STA_CLEAR_PS_FILT: Clear PS filter in hardware (using the
35 * IEEE80211_TXCTL_CLEAR_PS_FILT control flag) when the next
36 * frame to this station is transmitted.
238814fd
JB
37 */
38enum ieee80211_sta_info_flags {
39 WLAN_STA_AUTH = 1<<0,
40 WLAN_STA_ASSOC = 1<<1,
41 WLAN_STA_PS = 1<<2,
836341a7
JB
42 WLAN_STA_AUTHORIZED = 1<<3,
43 WLAN_STA_SHORT_PREAMBLE = 1<<4,
44 WLAN_STA_ASSOC_AP = 1<<5,
45 WLAN_STA_WME = 1<<6,
46 WLAN_STA_WDS = 1<<7,
47 WLAN_STA_PSPOLL = 1<<8,
d46e144b 48 WLAN_STA_CLEAR_PS_FILT = 1<<9,
238814fd 49};
f0706e82 50
5aae2880
RR
51#define STA_TID_NUM 16
52#define ADDBA_RESP_INTERVAL HZ
80656c20 53#define HT_AGG_MAX_RETRIES (0x3)
5aae2880
RR
54
55#define HT_AGG_STATE_INITIATOR_SHIFT (4)
56
80656c20
RR
57#define HT_ADDBA_REQUESTED_MSK BIT(0)
58#define HT_ADDBA_DRV_READY_MSK BIT(1)
59#define HT_ADDBA_RECEIVED_MSK BIT(2)
5aae2880 60#define HT_AGG_STATE_REQ_STOP_BA_MSK BIT(3)
80656c20 61#define HT_AGG_STATE_INITIATOR_MSK BIT(HT_AGG_STATE_INITIATOR_SHIFT)
5aae2880 62#define HT_AGG_STATE_IDLE (0x0)
80656c20
RR
63#define HT_AGG_STATE_OPERATIONAL (HT_ADDBA_REQUESTED_MSK | \
64 HT_ADDBA_DRV_READY_MSK | \
65 HT_ADDBA_RECEIVED_MSK)
24709182 66#define HT_AGG_STATE_DEBUGFS_CTL BIT(7)
80656c20
RR
67
68/**
69 * struct tid_ampdu_tx - TID aggregation information (Tx).
70 *
71 * @state: TID's state in session state machine.
72 * @dialog_token: dialog token for aggregation session
73 * @ssn: Starting Sequence Number expected to be aggregated.
74 * @addba_resp_timer: timer for peer's response to addba request
75 * @addba_req_num: number of times addBA request has been sent.
76 */
77struct tid_ampdu_tx {
78 u8 state;
79 u8 dialog_token;
80 u16 ssn;
81 struct timer_list addba_resp_timer;
82 u8 addba_req_num;
83};
5aae2880
RR
84
85/**
86 * struct tid_ampdu_rx - TID aggregation information (Rx).
87 *
88 * @state: TID's state in session state machine.
89 * @dialog_token: dialog token for aggregation session
90 * @ssn: Starting Sequence Number expected to be aggregated.
91 * @buf_size: buffer size for incoming A-MPDUs
92 * @timeout: reset timer value.
93 * @head_seq_num: head sequence number in reordering buffer.
94 * @stored_mpdu_num: number of MPDUs in reordering buffer
95 * @reorder_buf: buffer to reorder incoming aggregated MPDUs
96 * @session_timer: check if peer keeps Tx-ing on the TID (by timeout value)
97 */
98struct tid_ampdu_rx {
99 u8 state;
100 u8 dialog_token;
101 u16 ssn;
102 u16 buf_size;
103 u16 timeout;
104 u16 head_seq_num;
105 u16 stored_mpdu_num;
106 struct sk_buff **reorder_buf;
107 struct timer_list session_timer;
108};
109
b4e08ea1
LCC
110/**
111 * enum plink_state - state of a mesh peer link finite state machine
112 *
113 * @PLINK_LISTEN: initial state, considered the implicit state of non existant
114 * mesh peer links
115 * @PLINK_OPN_SNT: mesh plink open frame has been sent to this mesh peer
116 * @PLINK_OPN_RCVD: mesh plink open frame has been received from this mesh peer
117 * @PLINK_CNF_RCVD: mesh plink confirm frame has been received from this mesh
118 * peer
119 * @PLINK_ESTAB: mesh peer link is established
120 * @PLINK_HOLDING: mesh peer link is being closed or cancelled
121 * @PLINK_BLOCKED: all frames transmitted from this mesh plink are discarded
122 */
ee385855 123enum plink_state {
b4e08ea1
LCC
124 PLINK_LISTEN,
125 PLINK_OPN_SNT,
126 PLINK_OPN_RCVD,
127 PLINK_CNF_RCVD,
128 PLINK_ESTAB,
129 PLINK_HOLDING,
130 PLINK_BLOCKED
ee385855 131};
ee385855 132
5aae2880
RR
133/**
134 * struct sta_ampdu_mlme - STA aggregation information.
135 *
80656c20
RR
136 * @tid_rx: aggregation info for Rx per TID
137 * @tid_tx: aggregation info for Tx per TID
5aae2880 138 * @ampdu_rx: for locking sections in aggregation Rx flow
80656c20
RR
139 * @ampdu_tx: for locking sectionsi in aggregation Tx flow
140 * @dialog_token_allocator: dialog token enumerator for each new session;
5aae2880
RR
141 */
142struct sta_ampdu_mlme {
143 struct tid_ampdu_rx tid_rx[STA_TID_NUM];
80656c20 144 struct tid_ampdu_tx tid_tx[STA_TID_NUM];
5aae2880 145 spinlock_t ampdu_rx;
80656c20
RR
146 spinlock_t ampdu_tx;
147 u8 dialog_token_allocator;
5aae2880 148};
f0706e82 149
d0709a65
JB
150
151/* see __sta_info_unlink */
152#define STA_INFO_PIN_STAT_NORMAL 0
153#define STA_INFO_PIN_STAT_PINNED 1
154#define STA_INFO_PIN_STAT_DESTROY 2
155
693b1bbc
JB
156/**
157 * struct sta_info - STA information
158 *
159 * This structure collects information about a station that
160 * mac80211 is communicating with.
161 *
162 * @list: global linked list entry
163 * @hnext: hash table linked list pointer
164 * @local: pointer to the global information
165 * @addr: MAC address of this STA
166 * @aid: STA's unique AID (1..2007, 0 = not assigned yet),
167 * only used in AP (and IBSS?) mode
168 * @flags: STA flags, see &enum ieee80211_sta_info_flags
169 * @ps_tx_buf: buffer of frames to transmit to this station
170 * when it leaves power saving state
171 * @tx_filtered: buffer of frames we already tried to transmit
172 * but were filtered by hardware due to STA having entered
173 * power saving state
174 * @rx_packets: Number of MSDUs received from this STA
175 * @rx_bytes: Number of bytes received from this STA
176 * @supp_rates: Bitmap of supported rates (per band)
177 * @ht_info: HT capabilities of this STA
178 */
f0706e82 179struct sta_info {
693b1bbc 180 /* General information, mostly static */
f0706e82 181 struct list_head list;
693b1bbc 182 struct sta_info *hnext;
f0706e82 183 struct ieee80211_local *local;
d0709a65 184 struct ieee80211_sub_if_data *sdata;
f0706e82 185 struct ieee80211_key *key;
f0706e82
JB
186 struct rate_control_ref *rate_ctrl;
187 void *rate_ctrl_priv;
693b1bbc
JB
188 struct ieee80211_ht_info ht_info;
189 u64 supp_rates[IEEE80211_NUM_BANDS];
190 u8 addr[ETH_ALEN];
191 u16 aid;
192 u16 listen_interval;
f0706e82 193
693b1bbc
JB
194 /*
195 * for use by the internal lifetime management,
196 * see __sta_info_unlink
197 */
198 u8 pin_status;
199
200 /* frequently updated information, needs locking? */
201 u32 flags;
202
203 /*
204 * STA powersave frame queues, no more than the internal
205 * locking required.
206 */
207 struct sk_buff_head ps_tx_buf;
208 struct sk_buff_head tx_filtered;
209
210 /* Updated from RX path only, no locking requirements */
211 unsigned long rx_packets, rx_bytes;
212 unsigned long wep_weak_iv_count;
213 unsigned long last_rx;
f0706e82
JB
214 unsigned long num_duplicates; /* number of duplicate frames received
215 * from this STA */
f0706e82
JB
216 unsigned long rx_fragments; /* number of received MPDUs */
217 unsigned long rx_dropped; /* number of dropped MPDUs from this STA */
f0706e82
JB
218 int last_rssi; /* RSSI of last received frame from this STA */
219 int last_signal; /* signal of last received frame from this STA */
220 int last_noise; /* noise of last received frame from this STA */
693b1bbc
JB
221 /* last received seq/frag number from this STA (per RX queue) */
222 __le16 last_seq_ctrl[NUM_RX_DATA_QUEUES];
f0706e82
JB
223#ifdef CONFIG_MAC80211_DEBUG_COUNTERS
224 unsigned int wme_rx_queue[NUM_RX_DATA_QUEUES];
693b1bbc
JB
225#endif
226
227 /* Updated from TX status path only, no locking requirements */
228 unsigned long tx_filtered_count;
229 unsigned long tx_retry_failed, tx_retry_count;
230 /* TODO: update in generic code not rate control? */
231 u32 tx_num_consecutive_failures;
232 u32 tx_num_mpdu_ok;
233 u32 tx_num_mpdu_fail;
234 /* moving percentage of failed MSDUs */
235 unsigned int fail_avg;
236
237 /* Updated from TX path only, no locking requirements */
238 unsigned long tx_packets; /* number of RX/TX MSDUs */
239 unsigned long tx_bytes;
240 unsigned long tx_fragments; /* number of transmitted MPDUs */
241 int txrate_idx;
242 int last_txrate_idx;
243#ifdef CONFIG_MAC80211_DEBUG_COUNTERS
f0706e82 244 unsigned int wme_tx_queue[NUM_RX_DATA_QUEUES];
693b1bbc 245#endif
f0706e82 246
693b1bbc
JB
247 /* Debug counters, no locking doesn't matter */
248 int channel_use;
249 int channel_use_raw;
e9f207f0 250
d0709a65 251 /*
693b1bbc 252 * Aggregation information, comes with own locking.
d0709a65 253 */
5aae2880 254 struct sta_ampdu_mlme ampdu_mlme;
693b1bbc 255 u8 timer_to_tid[STA_TID_NUM]; /* identity mapping to ID timers */
80656c20 256 u8 tid_to_tx_q[STA_TID_NUM]; /* map tid to tx queue */
693b1bbc 257
ee385855 258#ifdef CONFIG_MAC80211_MESH
693b1bbc
JB
259 /*
260 * Mesh peer link attributes
261 * TODO: move to a sub-structure that is referenced with pointer?
262 */
ee385855
LCC
263 __le16 llid; /* Local link ID */
264 __le16 plid; /* Peer link ID */
b4e08ea1 265 __le16 reason; /* Cancel reason on PLINK_HOLDING state */
7495883b
JB
266 u8 plink_retries; /* Retries in establishment */
267 bool ignore_plink_timer;
ee385855
LCC
268 enum plink_state plink_state;
269 u32 plink_timeout;
270 struct timer_list plink_timer;
ee385855
LCC
271 spinlock_t plink_lock; /* For peer_state reads / updates and other
272 updates in the structure. Ensures robust
273 transitions for the peerlink FSM */
274#endif
10816d40 275
e9f207f0
JB
276#ifdef CONFIG_MAC80211_DEBUGFS
277 struct sta_info_debugfsdentries {
278 struct dentry *dir;
279 struct dentry *flags;
280 struct dentry *num_ps_buf_frames;
e9f207f0
JB
281 struct dentry *inactive_ms;
282 struct dentry *last_seq_ctrl;
283#ifdef CONFIG_MAC80211_DEBUG_COUNTERS
284 struct dentry *wme_rx_queue;
285 struct dentry *wme_tx_queue;
286#endif
eb2ba62e 287 struct dentry *agg_status;
e9f207f0
JB
288 } debugfs;
289#endif
f0706e82
JB
290};
291
d6d1a5a7
JB
292static inline enum plink_state sta_plink_state(struct sta_info *sta)
293{
294#ifdef CONFIG_MAC80211_MESH
295 return sta->plink_state;
296#endif
b4e08ea1 297 return PLINK_LISTEN;
d6d1a5a7
JB
298}
299
f0706e82
JB
300
301/* Maximum number of concurrently registered stations */
302#define MAX_STA_COUNT 2007
303
304#define STA_HASH_SIZE 256
305#define STA_HASH(sta) (sta[5])
306
307
308/* Maximum number of frames to buffer per power saving station */
309#define STA_MAX_TX_BUFFER 128
310
311/* Minimum buffered frame expiry time. If STA uses listen interval that is
312 * smaller than this value, the minimum value here is used instead. */
313#define STA_TX_BUFFER_EXPIRE (10 * HZ)
314
315/* How often station data is cleaned up (e.g., expiration of buffered frames)
316 */
317#define STA_INFO_CLEANUP_INTERVAL (10 * HZ)
318
d0709a65
JB
319/*
320 * Get a STA info, must have be under RCU read lock.
321 */
322struct sta_info *sta_info_get(struct ieee80211_local *local, u8 *addr);
323/*
324 * Get STA info by index, BROKEN!
325 */
ee385855
LCC
326struct sta_info *sta_info_get_by_idx(struct ieee80211_local *local, int idx,
327 struct net_device *dev);
d0709a65 328/*
73651ee6
JB
329 * Create a new STA info, caller owns returned structure
330 * until sta_info_insert().
d0709a65 331 */
73651ee6
JB
332struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
333 u8 *addr, gfp_t gfp);
334/*
335 * Insert STA info into hash table/list, returns zero or a
336 * -EEXIST if (if the same MAC address is already present).
337 *
338 * Calling this without RCU protection makes the caller
339 * relinquish its reference to @sta.
340 */
341int sta_info_insert(struct sta_info *sta);
d0709a65
JB
342/*
343 * Unlink a STA info from the hash table/list.
344 * This can NULL the STA pointer if somebody else
345 * has already unlinked it.
346 */
347void sta_info_unlink(struct sta_info **sta);
f0706e82 348
d0709a65 349void sta_info_destroy(struct sta_info *sta);
004c872e
JB
350void sta_info_set_tim_bit(struct sta_info *sta);
351void sta_info_clear_tim_bit(struct sta_info *sta);
352
d0709a65
JB
353void sta_info_init(struct ieee80211_local *local);
354int sta_info_start(struct ieee80211_local *local);
355void sta_info_stop(struct ieee80211_local *local);
44213b5e 356int sta_info_flush(struct ieee80211_local *local,
d0709a65
JB
357 struct ieee80211_sub_if_data *sdata);
358
f0706e82 359#endif /* STA_INFO_H */
This page took 0.167852 seconds and 5 git commands to generate.