[svn-upgrade] new version madwifi (0.9.4+r4133.20100922)
[debian/madwifi.git] / net80211 / ieee80211_node.h
1 /*-
2  * Copyright (c) 2001 Atsushi Onoe
3  * Copyright (c) 2002-2005 Sam Leffler, Errno Consulting
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  * 3. The name of the author may not be used to endorse or promote products
15  *    derived from this software without specific prior written permission.
16  *
17  * Alternatively, this software may be distributed under the terms of the
18  * GNU General Public License ("GPL") version 2 as published by the Free
19  * Software Foundation.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
26  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  *
32  * $Id: ieee80211_node.h 4126 2010-03-23 22:50:36Z proski $
33  */
34 #ifndef _NET80211_IEEE80211_NODE_H_
35 #define _NET80211_IEEE80211_NODE_H_
36
37 #include <net80211/ieee80211_ioctl.h>           /* for ieee80211_nodestats */
38 #include <net80211/ieee80211_proto.h>           /* for proto macros on node */
39
40 /*
41  * Each ieee80211com instance has a single timer that fires once a
42  * second.  This is used to initiate various work depending on the
43  * state of the instance: scanning (passive or active), ``transition''
44  * (waiting for a response to a management frame when operating
45  * as a station), and node inactivity processing (when operating
46  * as an AP).  For inactivity processing each node has a timeout
47  * set in it's ni_inact field that is decremented on each timeout
48  * and the node is reclaimed when the counter goes to zero.  We
49  * use different inactivity timeout values depending on whether
50  * the node is associated and authorized (either by 802.1x or
51  * open/shared key authentication) or associated but yet to be
52  * authorized.  The latter timeout is shorter to more aggressively
53  * reclaim nodes that leave part way through the 802.1x exchange.
54  */
55 #define IEEE80211_INACT_WAIT    15              /* inactivity interval (secs) */
56 #define IEEE80211_INACT_INIT    (30/IEEE80211_INACT_WAIT)       /* initial */
57 #define IEEE80211_INACT_AUTH    (180/IEEE80211_INACT_WAIT)      /* associated but not authorized */
58 #define IEEE80211_INACT_RUN     (300/IEEE80211_INACT_WAIT)      /* authorized */
59 #define IEEE80211_INACT_PROBE   (30/IEEE80211_INACT_WAIT)       /* probe */
60 #define IEEE80211_INACT_SCAN    (300/IEEE80211_INACT_WAIT)      /* scanned */
61
62 #define IEEE80211_TRANS_WAIT    5               /* mgt frame tx timer (secs) */
63
64 #define IEEE80211_NODE_HASHSIZE 32
65 /* simple hash is enough for variation of macaddr */
66 #define IEEE80211_NODE_HASH(addr)       \
67         (((const u_int8_t *)(addr))[IEEE80211_ADDR_LEN - 1] % \
68                 IEEE80211_NODE_HASHSIZE)
69
70 struct ieee80211_rsnparms {
71         u_int8_t rsn_mcastcipher;       /* mcast/group cipher */
72         u_int8_t rsn_mcastkeylen;       /* mcast key length */
73         u_int8_t rsn_ucastcipherset;    /* unicast cipher set */
74         u_int8_t rsn_ucastcipher;       /* selected unicast cipher */
75         u_int8_t rsn_ucastkeylen;       /* unicast key length */
76         u_int8_t rsn_keymgmtset;        /* key management algorithms */
77         u_int8_t rsn_keymgmt;           /* selected key mgmt algo */
78         u_int16_t rsn_caps;             /* capabilities */
79 };
80
81 struct ieee80211_node_table;
82 struct ieee80211com;
83 struct ieee80211vap;
84
85 /*
86  * Node specific information.  Note that drivers are expected
87  * to derive from this structure to add device-specific per-node
88  * state.  This is done by overriding the ic_node_* methods in
89  * the ieee80211com structure.
90  */
91 struct ieee80211_node {
92         struct ieee80211vap *ni_vap;
93         struct ieee80211com *ni_ic;
94         struct ieee80211_node_table *ni_table;
95         TAILQ_ENTRY(ieee80211_node) ni_list;
96         LIST_ENTRY(ieee80211_node) ni_hash;
97         atomic_t ni_refcnt;
98         u_int ni_scangen;                       /* gen# for timeout scan */
99         u_int8_t ni_authmode;                   /* authentication algorithm */
100         u_int16_t ni_flags;                     /* special-purpose state */
101 #define IEEE80211_NODE_AUTH     0x0001          /* authorized for data */
102 #define IEEE80211_NODE_QOS      0x0002          /* QoS enabled */
103 #define IEEE80211_NODE_ERP      0x0004          /* ERP enabled */
104 /* NB: this must have the same value as IEEE80211_FC1_PWR_MGT */
105 #define IEEE80211_NODE_PWR_MGT  0x0010          /* power save mode enabled */
106 #define IEEE80211_NODE_AREF     0x0020          /* authentication ref held */
107 #define IEEE80211_NODE_UAPSD    0x0040          /* U-APSD power save enabled */
108 #define IEEE80211_NODE_UAPSD_TRIG 0x0080        /* U-APSD triggerable state */
109 #define IEEE80211_NODE_UAPSD_SP 0x0100          /* U-APSD SP in progress */
110         u_int8_t ni_ath_flags;                  /* Atheros feature flags */
111         /* NB: These must have the same values as IEEE80211_ATHC_* */
112 #define IEEE80211_NODE_TURBOP   0x0001          /* Turbo prime enable */
113 #define IEEE80211_NODE_COMP     0x0002          /* Compression enable */
114 #define IEEE80211_NODE_FF       0x0004          /* Fast Frame capable */
115 #define IEEE80211_NODE_XR       0x0008          /* Atheros WME enable */
116 #define IEEE80211_NODE_AR       0x0010          /* AR capable */
117 #define IEEE80211_NODE_BOOST    0x0080 
118 #define IEEE80211_NODE_PS_CHANGED       0x0200  /* PS state change */ 
119         u_int16_t ni_ath_defkeyindex;           /* Atheros def key index */
120 #define IEEE80211_INVAL_DEFKEY  0x7FFF
121         u_int16_t ni_associd;                   /* assoc response */
122         u_int16_t ni_txpower;                   /* current transmit power (in 0.5 dBm) */
123         u_int16_t ni_vlan;                      /* vlan tag */
124         u_int32_t *ni_challenge;                        /* shared-key challenge */
125         u_int8_t *ni_wpa_ie;                    /* captured WPA ie */
126         u_int8_t *ni_rsn_ie;                    /* captured RSN ie */
127         u_int8_t *ni_wme_ie;                    /* captured WME ie */
128         u_int8_t *ni_ath_ie;                    /* captured Atheros ie */
129         u_int16_t ni_txseqs[17];                        /* tx seq per-tid */
130         u_int16_t ni_rxseqs[17];                        /* rx seq previous per-tid*/
131         u_int32_t ni_rxfragstamp;               /* time stamp of last rx frag */
132         struct sk_buff *ni_rxfrag;              /* rx frag reassembly */
133         struct ieee80211_rsnparms ni_rsn;       /* RSN/WPA parameters */
134         struct ieee80211_key ni_ucastkey;       /* unicast key */
135         int ni_rxkeyoff;                        /* Receive key offset */
136
137         /* hardware */
138         u_int32_t ni_rstamp;                    /* recv timestamp */
139         u_int32_t ni_last_rx;                   /* recv jiffies */
140         u_int8_t ni_rssi;                       /* recv ssi */
141
142         /* header */
143         u_int8_t ni_macaddr[IEEE80211_ADDR_LEN];
144         u_int8_t ni_bssid[IEEE80211_ADDR_LEN];
145
146         /* beacon, probe response */
147         union {
148                 u_int8_t data[8];
149                 __le64 tsf;
150         } ni_tstamp;                            /* from last rcv'd beacon */
151
152         u_int16_t ni_intval;                    /* beacon interval */
153         u_int16_t ni_intval_old;                /* beacon interval before first change */
154         u_int16_t ni_intval_cnt;                /* count of ni_intval != ni_intval_old */
155         unsigned long ni_intval_end;            /* end of transition interval jiffies */
156
157         u_int16_t ni_capinfo;                   /* capabilities */
158         u_int8_t ni_esslen;
159         u_int8_t ni_essid[IEEE80211_NWID_LEN];
160         struct ieee80211_rateset ni_rates;      /* negotiated rate set */
161         struct ieee80211_channel *ni_chan;
162         u_int16_t ni_fhdwell;                   /* FH only */
163         u_int8_t ni_fhindex;                    /* FH only */
164         u_int8_t ni_erp;                                /* ERP from beacon/probe resp */
165         u_int16_t ni_timoff;                    /* byte offset to TIM ie */
166
167         /* others */
168         struct sk_buff_head ni_savedq;          /* packets queued for pspoll */
169         short ni_inact;                         /* inactivity mark count */
170         short ni_inact_reload;                  /* inactivity reload value */
171         int ni_txrate;                          /* index to ni_rates[] */
172         struct ieee80211_nodestats ni_stats;    /* per-node statistics */
173         struct ieee80211vap *ni_prev_vap;       /* previously associated vap */
174         u_int8_t ni_uapsd;                      /* U-APSD per-node flags matching WMM STA Qos Info field */
175         u_int8_t ni_uapsd_maxsp;                /* maxsp from flags above */
176         u_int16_t ni_uapsd_trigseq[WME_NUM_AC];         /* trigger suppression on retry */
177         __le16 ni_pschangeseq;
178 };
179 MALLOC_DECLARE(M_80211_NODE);
180
181 #define IEEE80211_NODE_AID(ni)                  IEEE80211_AID(ni->ni_associd)
182
183 #define IEEE80211_NODE_STAT(ni,stat)            (ni->ni_stats.ns_##stat++)
184 #define IEEE80211_NODE_STAT_ADD(ni,stat,v)      (ni->ni_stats.ns_##stat += v)
185 #define IEEE80211_NODE_STAT_SET(ni,stat,v)      (ni->ni_stats.ns_##stat = v)
186
187 #define WME_UAPSD_AC_CAN_TRIGGER(_ac, _ni) ( \
188                 ((_ni)->ni_flags & IEEE80211_NODE_UAPSD_TRIG) && WME_UAPSD_AC_ENABLED((_ac), (_ni)->ni_uapsd) )
189 #define WME_UAPSD_NODE_MAXQDEPTH        8
190 #define IEEE80211_NODE_UAPSD_USETIM(_ni) (((_ni)->ni_uapsd & 0xF) == 0xF )
191 #define WME_UAPSD_NODE_INVALIDSEQ       0xffff
192 #define WME_UAPSD_NODE_TRIGSEQINIT(_ni) (memset(&(_ni)->ni_uapsd_trigseq[0], 0xff, sizeof((_ni)->ni_uapsd_trigseq)))
193
194 static __inline struct ieee80211_node *
195 ieee80211_ref_node(struct ieee80211_node *ni)
196 {
197         ieee80211_node_incref(ni);
198         return ni;
199 }
200
201 static __inline void
202 ieee80211_unref_node(struct ieee80211_node **ni)
203 {
204         ieee80211_node_decref(*ni);
205         *ni = NULL;                     /* guard against use */
206 }
207
208 void ieee80211_node_attach(struct ieee80211com *);
209 void ieee80211_node_detach(struct ieee80211com *);
210 void ieee80211_node_vattach(struct ieee80211vap *);
211 void ieee80211_node_latevattach(struct ieee80211vap *);
212 void ieee80211_node_vdetach(struct ieee80211vap *);
213
214 static __inline int
215 ieee80211_node_is_authorized(const struct ieee80211_node *ni)
216 {
217         return (ni->ni_flags & IEEE80211_NODE_AUTH);
218 }
219
220 void ieee80211_node_authorize(struct ieee80211_node *);
221 void ieee80211_node_unauthorize(struct ieee80211_node *);
222
223 void ieee80211_create_ibss(struct ieee80211vap *, struct ieee80211_channel *);
224 void ieee80211_reset_bss(struct ieee80211vap *);
225 int ieee80211_ibss_merge(struct ieee80211_node *);
226 struct ieee80211_scan_entry;
227 int ieee80211_sta_join(struct ieee80211vap *, const struct ieee80211_scan_entry *);
228 void ieee80211_sta_join1_tasklet(IEEE80211_TQUEUE_ARG);
229 void ieee80211_sta_leave(struct ieee80211_node *);
230
231 #define WDS_AGING_TIME          600   /* 10 minutes */ 
232 #define WDS_AGING_COUNT         2 
233 #define WDS_AGING_STATIC        0xffff
234 #define WDS_AGING_TIMER_VAL     (WDS_AGING_TIME / 2)
235
236 struct ieee80211_wds_addr {
237         LIST_ENTRY(ieee80211_wds_addr) wds_hash;
238         u_int8_t        wds_macaddr[IEEE80211_ADDR_LEN];
239         struct ieee80211_node *wds_ni;
240         u_int16_t wds_agingcount;
241 };
242         
243 /*
244  * Table of ieee80211_node instances.  Each ieee80211com
245  * has at least one for holding the scan candidates.
246  * When operating as an access point or in ibss mode there
247  * is a second table for associated stations or neighbors.
248  */
249 struct ieee80211_node_table {
250         struct ieee80211com *nt_ic;             /* back reference */
251         ieee80211_node_lock_t nt_nodelock;      /* on node table */
252         TAILQ_HEAD(, ieee80211_node) nt_node;   /* information of all nodes */
253         ATH_LIST_HEAD(, ieee80211_node) nt_hash[IEEE80211_NODE_HASHSIZE];
254         ATH_LIST_HEAD(, ieee80211_wds_addr) nt_wds_hash[IEEE80211_NODE_HASHSIZE];
255         const char *nt_name;                    /* for debugging */
256         ieee80211_scan_lock_t nt_scanlock;      /* on nt_scangen */
257         u_int nt_scangen;                       /* gen# for timeout scan */
258         int nt_inact_init;                      /* initial node inact setting */
259         struct timer_list nt_wds_aging_timer;   /* timer to age out wds entries */
260 };
261
262 struct ieee80211_node *ieee80211_alloc_node(struct ieee80211_node_table *,
263         struct ieee80211vap *, const u_int8_t *);
264 struct ieee80211_node *ieee80211_tmp_node(struct ieee80211vap *,
265         const u_int8_t *);
266 struct ieee80211_node *ieee80211_dup_bss(struct ieee80211vap *,
267         const u_int8_t *);
268 void ieee80211_node_reset(struct ieee80211_node *, struct ieee80211vap *);
269 #ifdef IEEE80211_DEBUG_REFCNT
270 void ieee80211_free_node_debug(struct ieee80211_node *, const char *, int);
271 struct ieee80211_node *ieee80211_find_node_debug(struct ieee80211_node_table *,
272         const u_int8_t *, const char *, int);
273 struct ieee80211_node *ieee80211_find_rxnode_debug(struct ieee80211com *,
274         const struct ieee80211_frame_min *, const char *, int);
275 struct ieee80211_node *ieee80211_find_txnode_debug(struct ieee80211vap *,
276         const u_int8_t *, const char *, int);
277 #define ieee80211_free_node(ni) \
278         ieee80211_free_node_debug(ni, __func__, __LINE__)
279 #define ieee80211_find_node(nt, mac) \
280         ieee80211_find_node_debug(nt, mac, __func__, __LINE__)
281 #define ieee80211_find_rxnode(nt, wh) \
282         ieee80211_find_rxnode_debug(nt, wh, __func__, __LINE__)
283 #define ieee80211_find_txnode(nt, mac) \
284         ieee80211_find_txnode_debug(nt, mac, __func__, __LINE__)
285 #else
286 void ieee80211_free_node(struct ieee80211_node *);
287
288 struct ieee80211_node *ieee80211_find_node(struct ieee80211_node_table *,
289         const u_int8_t *);
290 struct ieee80211_node * ieee80211_find_rxnode(struct ieee80211com *,
291         const struct ieee80211_frame_min *);
292 struct ieee80211_node *ieee80211_find_txnode(struct ieee80211vap *,
293         const u_int8_t *);
294 #endif
295 int ieee80211_add_wds_addr(struct ieee80211_node_table *, struct ieee80211_node *,
296         const u_int8_t *, u_int8_t);
297 void ieee80211_remove_wds_addr(struct ieee80211_node_table *, const u_int8_t *);
298 void ieee80211_del_wds_node(struct ieee80211_node_table *,
299         struct ieee80211_node *);
300 struct ieee80211_node *ieee80211_find_wds_node(struct ieee80211_node_table *,
301         const u_int8_t *);
302
303 typedef void ieee80211_iter_func(void *, struct ieee80211_node *);
304 void ieee80211_iterate_nodes(struct ieee80211_node_table *,
305         ieee80211_iter_func *, void *);
306 void ieee80211_iterate_dev_nodes(struct net_device *, 
307         struct ieee80211_node_table *, ieee80211_iter_func *, void *);
308
309 void    ieee80211_dump_node(struct ieee80211_node_table *,
310         struct ieee80211_node *);
311 void    ieee80211_dump_nodes(struct ieee80211_node_table *);
312
313 struct ieee80211_node *ieee80211_fakeup_adhoc_node(struct ieee80211vap *,
314         const u_int8_t macaddr[]);
315 struct ieee80211_scanparams;
316 struct ieee80211_node *ieee80211_add_neighbor(struct ieee80211vap *,
317         const struct ieee80211_frame *, const struct ieee80211_scanparams *);
318 void ieee80211_node_join(struct ieee80211_node *, int);
319 void ieee80211_node_leave(struct ieee80211_node *);
320 u_int8_t ieee80211_getrssi(struct ieee80211com *);
321 #endif /* _NET80211_IEEE80211_NODE_H_ */