ieee80211_var.h revision 1.19 1 /* $NetBSD: ieee80211_var.h,v 1.19 2005/06/22 06:16:02 dyoung Exp $ */
2 /*-
3 * Copyright (c) 2001 Atsushi Onoe
4 * Copyright (c) 2002-2005 Sam Leffler, Errno Consulting
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. The name of the author may not be used to endorse or promote products
16 * derived from this software without specific prior written permission.
17 *
18 * Alternatively, this software may be distributed under the terms of the
19 * GNU General Public License ("GPL") version 2 as published by the Free
20 * Software Foundation.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
23 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
24 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
25 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
27 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
31 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 *
33 * $FreeBSD: src/sys/net80211/ieee80211_var.h,v 1.20 2005/01/24 19:39:07 sam Exp $
34 */
35 #ifndef _NET80211_IEEE80211_VAR_H_
36 #define _NET80211_IEEE80211_VAR_H_
37
38 /*
39 * Definitions for IEEE 802.11 drivers.
40 */
41 #define IEEE80211_DEBUG
42 #undef IEEE80211_DEBUG_REFCNT /* node refcnt stuff */
43
44 /* NB: portability glue must go first */
45 #ifdef __NetBSD__
46 #include <net80211/ieee80211_netbsd.h>
47 #elif __FreeBSD__
48 #include <net80211/ieee80211_freebsd.h>
49 #elif __linux__
50 #include <net80211/ieee80211_linux.h>
51 #else
52 #error "No support for your operating system!"
53 #endif
54
55 #include <sys/queue.h> /* XXX */
56
57 #include <net80211/_ieee80211.h>
58 #include <net80211/ieee80211.h>
59 #include <net80211/ieee80211_crypto.h>
60 #include <net80211/ieee80211_ioctl.h> /* for ieee80211_stats */
61 #include <net80211/ieee80211_node.h>
62 #include <net80211/ieee80211_proto.h>
63
64 #define IEEE80211_TXPOWER_MAX 100 /* .5 dbM (XXX units?) */
65 #define IEEE80211_TXPOWER_MIN 0 /* kill radio */
66
67 #define IEEE80211_DTIM_MAX 15 /* max DTIM period */
68 #define IEEE80211_DTIM_MIN 1 /* min DTIM period */
69 #define IEEE80211_DTIM_DEFAULT 1 /* default DTIM period */
70
71 #define IEEE80211_BINTVAL_MAX 500 /* max beacon interval (TU's) */
72 #define IEEE80211_BINTVAL_MIN 25 /* min beacon interval (TU's) */
73 #define IEEE80211_BINTVAL_DEFAULT 100 /* default beacon interval (TU's) */
74
75 #define IEEE80211_PS_SLEEP 0x1 /* STA is in power saving mode */
76 #define IEEE80211_PS_MAX_QUEUE 50 /* maximum saved packets */
77
78 #define IEEE80211_MS_TO_TU(x) (((x) * 1000) / 1024)
79 #define IEEE80211_TU_TO_MS(x) (((x) * 1024) / 1000)
80
81 struct ieee80211_aclator;
82
83 #define IEEE80211_PS_SLEEP 0x1 /* STA is in power saving mode */
84
85 #define IEEE80211_PS_MAX_QUEUE 50 /* maximum saved packets */
86
87 struct ieee80211com {
88 SLIST_ENTRY(ieee80211com) ic_next;
89 struct ifnet *ic_ifp; /* associated device */
90 struct ieee80211_stats ic_stats; /* statistics */
91 struct sysctllog *ic_sysctllog; /* for destroying sysctl tree */
92 u_int32_t ic_debug; /* debug msg flags */
93 int ic_vap; /* virtual AP index */
94 ieee80211_beacon_lock_t ic_beaconlock; /* beacon update lock */
95
96 LIST_ENTRY(ieee80211com) ic_list; /* chain of all ieee80211com */
97 int (*ic_reset)(struct ifnet *);
98 void (*ic_recv_mgmt)(struct ieee80211com *,
99 struct mbuf *, struct ieee80211_node *,
100 int, int, u_int32_t);
101 int (*ic_send_mgmt)(struct ieee80211com *,
102 struct ieee80211_node *, int, int);
103 int (*ic_newstate)(struct ieee80211com *,
104 enum ieee80211_state, int);
105 void (*ic_newassoc)(struct ieee80211com *,
106 struct ieee80211_node *, int);
107 void (*ic_updateslot)(struct ifnet *);
108 void (*ic_set_tim)(struct ieee80211com *,
109 struct ieee80211_node *, int);
110 u_int8_t ic_myaddr[IEEE80211_ADDR_LEN];
111 struct ieee80211_rateset ic_sup_rates[IEEE80211_MODE_MAX];
112 struct ieee80211_channel ic_channels[IEEE80211_CHAN_MAX+1];
113 u_int8_t ic_chan_avail[IEEE80211_CHAN_BYTES];
114 u_int8_t ic_chan_active[IEEE80211_CHAN_BYTES];
115 u_int8_t ic_chan_scan[IEEE80211_CHAN_BYTES];
116 struct ieee80211_node_table ic_scan; /* scan candidates */
117 struct ifqueue ic_mgtq;
118 u_int32_t ic_flags; /* state flags */
119 u_int32_t ic_caps; /* capabilities */
120 u_int16_t ic_modecaps; /* set of mode capabilities */
121 u_int16_t ic_curmode; /* current mode */
122 enum ieee80211_phytype ic_phytype; /* XXX wrong for multi-mode */
123 enum ieee80211_opmode ic_opmode; /* operation mode */
124 enum ieee80211_state ic_state; /* 802.11 state */
125 enum ieee80211_protmode ic_protmode; /* 802.11g protection mode */
126 enum ieee80211_roamingmode ic_roaming; /* roaming mode */
127 struct ieee80211_node_table ic_sta; /* stations/neighbors */
128 u_int32_t *ic_aid_bitmap; /* association id map */
129 u_int16_t ic_max_aid;
130 u_int16_t ic_sta_assoc; /* stations associated */
131 u_int16_t ic_ps_sta; /* stations in power save */
132 u_int16_t ic_ps_pending; /* ps sta's w/ pending frames */
133 u_int8_t *ic_tim_bitmap; /* power-save stations w/ data*/
134 u_int16_t ic_tim_len; /* ic_tim_bitmap size (bytes) */
135 u_int16_t ic_dtim_period; /* DTIM period */
136 struct ifmedia ic_media; /* interface media config */
137 caddr_t ic_rawbpf; /* packet filter structure */
138 struct ieee80211_node *ic_bss; /* information for this node */
139 struct ieee80211_channel *ic_ibss_chan;
140 int ic_fixed_rate; /* index to ic_sup_rates[] */
141 u_int16_t ic_rtsthreshold;
142 u_int16_t ic_fragthreshold;
143 struct ieee80211_node *(*ic_node_alloc)(struct ieee80211_node_table*);
144 void (*ic_node_free)(struct ieee80211_node *);
145 void (*ic_node_cleanup)(struct ieee80211_node *);
146 u_int8_t (*ic_node_getrssi)(const struct ieee80211_node*);
147 u_int16_t ic_lintval; /* listen interval */
148 u_int16_t ic_holdover; /* PM hold over duration */
149 u_int16_t ic_txmin; /* min tx retry count */
150 u_int16_t ic_txmax; /* max tx retry count */
151 u_int16_t ic_txlifetime; /* tx lifetime */
152 u_int16_t ic_txpowlimit; /* global tx power limit */
153 u_int16_t ic_bmisstimeout;/* beacon miss threshold (ms) */
154 u_int16_t ic_nonerpsta; /* # non-ERP stations */
155 u_int16_t ic_longslotsta; /* # long slot time stations */
156 int ic_mgt_timer; /* mgmt timeout */
157 int ic_inact_timer; /* inactivity timer wait */
158 int ic_des_esslen;
159 u_int8_t ic_des_essid[IEEE80211_NWID_LEN];
160 struct ieee80211_channel *ic_des_chan; /* desired channel */
161 u_int8_t ic_des_bssid[IEEE80211_ADDR_LEN];
162 void *ic_opt_ie; /* user-specified IE's */
163 u_int16_t ic_opt_ie_len; /* length of ni_opt_ie */
164 /*
165 * Inactivity timer settings for nodes.
166 */
167 int ic_inact_init; /* initial setting */
168 int ic_inact_auth; /* auth but not assoc setting */
169 int ic_inact_run; /* authorized setting */
170 int ic_inact_probe; /* inactive probe time */
171
172 /*
173 * WME/WMM state.
174 */
175 struct ieee80211_wme_state ic_wme;
176
177 /*
178 * Cipher state/configuration.
179 */
180 struct ieee80211_crypto_state ic_crypto;
181 #define ic_nw_keys ic_crypto.cs_nw_keys /* XXX compatibility */
182 #define ic_def_txkey ic_crypto.cs_def_txkey /* XXX compatibility */
183
184 /*
185 * 802.1x glue. When an authenticator attaches it
186 * fills in this section. We assume that when ic_ec
187 * is setup that the methods are safe to call.
188 */
189 const struct ieee80211_authenticator *ic_auth;
190 struct eapolcom *ic_ec;
191
192 /*
193 * Access control glue. When a control agent attaches
194 * it fills in this section. We assume that when ic_ac
195 * is setup that the methods are safe to call.
196 */
197 const struct ieee80211_aclator *ic_acl;
198 void *ic_as;
199 };
200
201 LIST_HEAD(ieee80211com_head, ieee80211com);
202
203 extern struct ieee80211com_head ieee80211com_head;
204
205 #define IEEE80211_ADDR_EQ(a1,a2) (memcmp(a1,a2,IEEE80211_ADDR_LEN) == 0)
206 #define IEEE80211_ADDR_COPY(dst,src) memcpy(dst,src,IEEE80211_ADDR_LEN)
207
208 /* ic_flags */
209 /* NB: bits 0x6f available */
210 /* NB: this is intentionally setup to be IEEE80211_CAPINFO_PRIVACY */
211 #define IEEE80211_F_PRIVACY 0x00000010 /* CONF: privacy enabled */
212 #define IEEE80211_F_SCAN 0x00000080 /* STATUS: scanning */
213 #define IEEE80211_F_ASCAN 0x00000100 /* STATUS: active scan */
214 #define IEEE80211_F_SIBSS 0x00000200 /* STATUS: start IBSS */
215 /* NB: this is intentionally setup to be IEEE80211_CAPINFO_SHORT_SLOTTIME */
216 #define IEEE80211_F_SHSLOT 0x00000400 /* STATUS: use short slot time*/
217 #define IEEE80211_F_PMGTON 0x00000800 /* CONF: Power mgmt enable */
218 #define IEEE80211_F_DESBSSID 0x00001000 /* CONF: des_bssid is set */
219 #define IEEE80211_F_WME 0x00002000 /* CONF: enable WME use */
220 #define IEEE80211_F_ROAMING 0x00004000 /* CONF: roaming enabled (???)*/
221 #define IEEE80211_F_SWRETRY 0x00008000 /* CONF: sw tx retry enabled */
222 #define IEEE80211_F_TXPOW_FIXED 0x00010000 /* TX Power: fixed rate */
223 #define IEEE80211_F_IBSSON 0x00020000 /* CONF: IBSS creation enable */
224 #define IEEE80211_F_SHPREAMBLE 0x00040000 /* STATUS: use short preamble */
225 #define IEEE80211_F_DATAPAD 0x00080000 /* CONF: do alignment pad */
226 #define IEEE80211_F_USEPROT 0x00100000 /* STATUS: protection enabled */
227 #define IEEE80211_F_USEBARKER 0x00200000 /* STATUS: use barker preamble*/
228 #define IEEE80211_F_TIMUPDATE 0x00400000 /* STATUS: update beacon tim */
229 #define IEEE80211_F_WPA1 0x00800000 /* CONF: WPA enabled */
230 #define IEEE80211_F_WPA2 0x01000000 /* CONF: WPA2 enabled */
231 #define IEEE80211_F_WPA 0x01800000 /* CONF: WPA/WPA2 enabled */
232 #define IEEE80211_F_DROPUNENC 0x02000000 /* CONF: drop unencrypted */
233 #define IEEE80211_F_COUNTERM 0x04000000 /* CONF: TKIP countermeasures */
234 #define IEEE80211_F_HIDESSID 0x08000000 /* CONF: hide SSID in beacon */
235 #define IEEE80211_F_NOBRIDGE 0x10000000 /* CONF: dis. internal bridge */
236 #define IEEE80211_F_WMEUPDATE 0x20000000 /* STATUS: update beacon wme */
237
238 /* ic_caps */
239 #define IEEE80211_C_WEP 0x00000001 /* CAPABILITY: WEP available */
240 #define IEEE80211_C_TKIP 0x00000002 /* CAPABILITY: TKIP available */
241 #define IEEE80211_C_AES 0x00000004 /* CAPABILITY: AES OCB avail */
242 #define IEEE80211_C_AES_CCM 0x00000008 /* CAPABILITY: AES CCM avail */
243 #define IEEE80211_C_CKIP 0x00000020 /* CAPABILITY: CKIP available */
244 #define IEEE80211_C_IBSS 0x00000100 /* CAPABILITY: IBSS available */
245 #define IEEE80211_C_PMGT 0x00000200 /* CAPABILITY: Power mgmt */
246 #define IEEE80211_C_HOSTAP 0x00000400 /* CAPABILITY: HOSTAP avail */
247 #define IEEE80211_C_AHDEMO 0x00000800 /* CAPABILITY: Old Adhoc Demo */
248 #define IEEE80211_C_SWRETRY 0x00001000 /* CAPABILITY: sw tx retry */
249 #define IEEE80211_C_TXPMGT 0x00002000 /* CAPABILITY: tx power mgmt */
250 #define IEEE80211_C_SHSLOT 0x00004000 /* CAPABILITY: short slottime */
251 #define IEEE80211_C_SHPREAMBLE 0x00008000 /* CAPABILITY: short preamble */
252 #define IEEE80211_C_MONITOR 0x00010000 /* CAPABILITY: monitor mode */
253 #define IEEE80211_C_TKIPMIC 0x00020000 /* CAPABILITY: TKIP MIC avail */
254 #define IEEE80211_C_WPA1 0x00800000 /* CAPABILITY: WPA1 avail */
255 #define IEEE80211_C_WPA2 0x01000000 /* CAPABILITY: WPA2 avail */
256 #define IEEE80211_C_WPA 0x01800000 /* CAPABILITY: WPA1+WPA2 avail*/
257 #define IEEE80211_C_BURST 0x02000000 /* CAPABILITY: frame bursting */
258 #define IEEE80211_C_WME 0x04000000 /* CAPABILITY: WME avail */
259 /* XXX protection/barker? */
260
261 #define IEEE80211_C_CRYPTO 0x0000002f /* CAPABILITY: crypto alg's */
262
263 void ieee80211_ifattach(struct ieee80211com *);
264 void ieee80211_ifdetach(struct ieee80211com *);
265 void ieee80211_announce(struct ieee80211com *);
266 void ieee80211_media_init(struct ieee80211com *,
267 ifm_change_cb_t, ifm_stat_cb_t);
268 struct ieee80211com *ieee80211_find_vap(const u_int8_t mac[IEEE80211_ADDR_LEN]);
269 int ieee80211_media_change(struct ifnet *);
270 void ieee80211_media_status(struct ifnet *, struct ifmediareq *);
271 int ieee80211_ioctl(struct ieee80211com *, u_long, caddr_t);
272 int ieee80211_cfgget(struct ieee80211com *, u_long, caddr_t);
273 int ieee80211_cfgset(struct ieee80211com *, u_long, caddr_t);
274 void ieee80211_watchdog(struct ieee80211com *);
275 int ieee80211_rate2media(struct ieee80211com *, int,
276 enum ieee80211_phymode);
277 int ieee80211_media2rate(int);
278 u_int ieee80211_mhz2ieee(u_int, u_int);
279 u_int ieee80211_chan2ieee(struct ieee80211com *, struct ieee80211_channel *);
280 u_int ieee80211_ieee2mhz(u_int, u_int);
281 int ieee80211_setmode(struct ieee80211com *, enum ieee80211_phymode);
282 enum ieee80211_phymode ieee80211_chan2mode(struct ieee80211com *,
283 struct ieee80211_channel *);
284 int ieee80211_get_rate(struct ieee80211com *);
285
286 /*
287 * Key update synchronization methods. XXX should not be visible.
288 */
289 static __inline void
290 ieee80211_key_update_begin(struct ieee80211com *ic)
291 {
292 ic->ic_crypto.cs_key_update_begin(ic);
293 }
294 static __inline void
295 ieee80211_key_update_end(struct ieee80211com *ic)
296 {
297 ic->ic_crypto.cs_key_update_end(ic);
298 }
299
300 /*
301 * XXX these need to be here for IEEE80211_F_DATAPAD
302 */
303
304 /*
305 * Return the space occupied by the 802.11 header and any
306 * padding required by the driver. This works for a
307 * management or data frame.
308 */
309 static __inline int
310 ieee80211_hdrspace(struct ieee80211com *ic, const void *data)
311 {
312 int size = ieee80211_hdrsize(data);
313 if (ic->ic_flags & IEEE80211_F_DATAPAD)
314 size = roundup(size, sizeof(u_int32_t));
315 return size;
316 }
317
318 /*
319 * Like ieee80211_hdrspace, but handles any type of frame.
320 */
321 static __inline int
322 ieee80211_anyhdrspace(struct ieee80211com *ic, const void *data)
323 {
324 int size = ieee80211_anyhdrsize(data);
325 if (ic->ic_flags & IEEE80211_F_DATAPAD)
326 size = roundup(size, sizeof(u_int32_t));
327 return size;
328 }
329
330 #define IEEE80211_MSG_DEBUG 0x40000000 /* IFF_DEBUG equivalent */
331 #define IEEE80211_MSG_DUMPPKTS 0x20000000 /* IFF_LINK2 equivalant */
332 #define IEEE80211_MSG_CRYPTO 0x10000000 /* crypto work */
333 #define IEEE80211_MSG_INPUT 0x08000000 /* input handling */
334 #define IEEE80211_MSG_XRATE 0x04000000 /* rate set handling */
335 #define IEEE80211_MSG_ELEMID 0x02000000 /* element id parsing */
336 #define IEEE80211_MSG_NODE 0x01000000 /* node handling */
337 #define IEEE80211_MSG_ASSOC 0x00800000 /* association handling */
338 #define IEEE80211_MSG_AUTH 0x00400000 /* authentication handling */
339 #define IEEE80211_MSG_SCAN 0x00200000 /* scanning */
340 #define IEEE80211_MSG_OUTPUT 0x00100000 /* output handling */
341 #define IEEE80211_MSG_STATE 0x00080000 /* state machine */
342 #define IEEE80211_MSG_POWER 0x00040000 /* power save handling */
343 #define IEEE80211_MSG_DOT1X 0x00020000 /* 802.1x authenticator */
344 #define IEEE80211_MSG_DOT1XSM 0x00010000 /* 802.1x state machine */
345 #define IEEE80211_MSG_RADIUS 0x00008000 /* 802.1x radius client */
346 #define IEEE80211_MSG_RADDUMP 0x00004000 /* dump 802.1x radius packets */
347 #define IEEE80211_MSG_RADKEYS 0x00002000 /* dump 802.1x keys */
348 #define IEEE80211_MSG_WPA 0x00001000 /* WPA/RSN protocol */
349 #define IEEE80211_MSG_ACL 0x00000800 /* ACL handling */
350 #define IEEE80211_MSG_WME 0x00000400 /* WME protocol */
351
352 #define IEEE80211_MSG_ANY 0xffffffff /* anything */
353
354 #ifdef IEEE80211_DEBUG
355 #define IEEE80211_DPRINTF(_ic, _m, _fmt, ...) do { \
356 if (_ic->ic_debug & (_m)) \
357 printf(_fmt, __VA_ARGS__); \
358 } while (0)
359 #define ieee80211_msg_debug(_ic) \
360 ((_ic)->ic_debug & IEEE80211_MSG_DEBUG)
361 #define ieee80211_msg_dumppkts(_ic) \
362 ((_ic)->ic_debug & IEEE80211_MSG_DUMPPKTS)
363 #define ieee80211_msg_input(_ic) \
364 ((_ic)->ic_debug & IEEE80211_MSG_INPUT)
365 #define ieee80211_msg_radius(_ic) \
366 ((_ic)->ic_debug & IEEE80211_MSG_RADIUS)
367 #define ieee80211_msg_dumpradius(_ic) \
368 ((_ic)->ic_debug & IEEE80211_MSG_RADDUMP)
369 #define ieee80211_msg_dumpradkeys(_ic) \
370 ((_ic)->ic_debug & IEEE80211_MSG_RADKEYS)
371 #define ieee80211_msg_scan(_ic) \
372 ((_ic)->ic_debug & IEEE80211_MSG_SCAN)
373 #else
374 #define IEEE80211_DPRINTF(_ic, _m, _fmt, ...)
375 #endif
376
377 #endif /* _NET80211_IEEE80211_VAR_H_ */
378