ieee80211_var.h revision 1.3 1 /* $NetBSD: ieee80211_var.h,v 1.3 2003/09/14 01:14:56 dyoung Exp $ */
2 /*-
3 * Copyright (c) 2001 Atsushi Onoe
4 * Copyright (c) 2002, 2003 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.5 2003/08/19 22:17:03 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
42 #include <net80211/ieee80211.h>
43 #include <net80211/ieee80211_crypto.h>
44 #include <net80211/ieee80211_node.h>
45 #include <net80211/ieee80211_proto.h>
46
47 #define IEEE80211_CHAN_MAX 255
48 #define IEEE80211_CHAN_ANY 0xffff /* token for ``any channel'' */
49 #define IEEE80211_CHAN_ANYC \
50 ((struct ieee80211_channel *) IEEE80211_CHAN_ANY)
51
52 enum ieee80211_phytype {
53 IEEE80211_T_DS, /* direct sequence spread spectrum */
54 IEEE80211_T_FH, /* frequency hopping */
55 IEEE80211_T_OFDM, /* frequency division multiplexing */
56 IEEE80211_T_TURBO, /* high rate OFDM, aka turbo mode */
57 };
58 #define IEEE80211_T_CCK IEEE80211_T_DS /* more common nomenclature */
59
60 /* XXX not really a mode; there are really multiple PHY's */
61 enum ieee80211_phymode {
62 IEEE80211_MODE_AUTO = 0, /* autoselect */
63 IEEE80211_MODE_11A = 1, /* 5GHz, OFDM */
64 IEEE80211_MODE_11B = 2, /* 2GHz, CCK */
65 IEEE80211_MODE_11G = 3, /* 2GHz, OFDM */
66 IEEE80211_MODE_TURBO = 4, /* 5GHz, OFDM, 2x clock */
67 };
68 #define IEEE80211_MODE_MAX (IEEE80211_MODE_TURBO+1)
69
70 enum ieee80211_opmode {
71 IEEE80211_M_STA = 1, /* infrastructure station */
72 IEEE80211_M_IBSS = 0, /* IBSS (adhoc) station */
73 IEEE80211_M_AHDEMO = 3, /* Old lucent compatible adhoc demo */
74 IEEE80211_M_HOSTAP = 6, /* Software Access Point */
75 IEEE80211_M_MONITOR = 8 /* Monitor mode */
76 };
77
78 /*
79 * Channels are specified by frequency and attributes.
80 */
81 struct ieee80211_channel {
82 u_int16_t ic_freq; /* setting in Mhz */
83 u_int16_t ic_flags; /* see below */
84 };
85
86 /* bits 0-3 are for private use by drivers */
87 /* channel attributes */
88 #define IEEE80211_CHAN_TURBO 0x0010 /* Turbo channel */
89 #define IEEE80211_CHAN_CCK 0x0020 /* CCK channel */
90 #define IEEE80211_CHAN_OFDM 0x0040 /* OFDM channel */
91 #define IEEE80211_CHAN_2GHZ 0x0080 /* 2 GHz spectrum channel. */
92 #define IEEE80211_CHAN_5GHZ 0x0100 /* 5 GHz spectrum channel */
93 #define IEEE80211_CHAN_PASSIVE 0x0200 /* Only passive scan allowed */
94 #define IEEE80211_CHAN_DYN 0x0400 /* Dynamic CCK-OFDM channel */
95
96 /*
97 * Useful combinations of channel characteristics.
98 */
99 #define IEEE80211_CHAN_A \
100 (IEEE80211_CHAN_5GHZ | IEEE80211_CHAN_OFDM)
101 #define IEEE80211_CHAN_B \
102 (IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_CCK)
103 #define IEEE80211_CHAN_PUREG \
104 (IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_OFDM)
105 #define IEEE80211_CHAN_G \
106 (IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_DYN)
107 #define IEEE80211_CHAN_T \
108 (IEEE80211_CHAN_5GHZ | IEEE80211_CHAN_OFDM | IEEE80211_CHAN_TURBO)
109
110 #define IEEE80211_IS_CHAN_A(_c) \
111 (((_c)->ic_flags & IEEE80211_CHAN_A) == IEEE80211_CHAN_A)
112 #define IEEE80211_IS_CHAN_B(_c) \
113 (((_c)->ic_flags & IEEE80211_CHAN_B) == IEEE80211_CHAN_B)
114 #define IEEE80211_IS_CHAN_PUREG(_c) \
115 (((_c)->ic_flags & IEEE80211_CHAN_PUREG) == IEEE80211_CHAN_PUREG)
116 #define IEEE80211_IS_CHAN_G(_c) \
117 (((_c)->ic_flags & IEEE80211_CHAN_G) == IEEE80211_CHAN_G)
118 #define IEEE80211_IS_CHAN_T(_c) \
119 (((_c)->ic_flags & IEEE80211_CHAN_T) == IEEE80211_CHAN_T)
120
121 #define IEEE80211_IS_CHAN_2GHZ(_c) \
122 (((_c)->ic_flags & IEEE80211_CHAN_2GHZ) != 0)
123 #define IEEE80211_IS_CHAN_5GHZ(_c) \
124 (((_c)->ic_flags & IEEE80211_CHAN_5GHZ) != 0)
125 #define IEEE80211_IS_CHAN_OFDM(_c) \
126 (((_c)->ic_flags & IEEE80211_CHAN_OFDM) != 0)
127 #define IEEE80211_IS_CHAN_CCK(_c) \
128 (((_c)->ic_flags & IEEE80211_CHAN_CCK) != 0)
129
130 /* ni_chan encoding for FH phy */
131 #define IEEE80211_FH_CHANMOD 80
132 #define IEEE80211_FH_CHAN(set,pat) (((set)-1)*IEEE80211_FH_CHANMOD+(pat))
133 #define IEEE80211_FH_CHANSET(chan) ((chan)/IEEE80211_FH_CHANMOD+1)
134 #define IEEE80211_FH_CHANPAT(chan) ((chan)%IEEE80211_FH_CHANMOD)
135
136 struct ieee80211com {
137 #ifdef __NetBSD__
138 struct ethercom ic_ec;
139 #else
140 struct arpcom ic_ac;
141 #endif
142 void (*ic_recv_mgmt)(struct ieee80211com *,
143 struct mbuf *, struct ieee80211_node *,
144 int, int, u_int32_t);
145 int (*ic_send_mgmt)(struct ieee80211com *,
146 struct ieee80211_node *, int, int);
147 int (*ic_newstate)(struct ieee80211com *,
148 enum ieee80211_state, int);
149 void (*ic_newassoc)(struct ieee80211com *,
150 struct ieee80211_node *, int);
151 u_int8_t ic_myaddr[IEEE80211_ADDR_LEN];
152 struct ieee80211_rateset ic_sup_rates[IEEE80211_MODE_MAX];
153 struct ieee80211_channel ic_channels[IEEE80211_CHAN_MAX+1];
154 u_char ic_chan_avail[roundup(IEEE80211_CHAN_MAX,NBBY)];
155 u_char ic_chan_active[roundup(IEEE80211_CHAN_MAX, NBBY)];
156 u_char ic_chan_scan[roundup(IEEE80211_CHAN_MAX,NBBY)];
157 struct ifqueue ic_mgtq;
158 u_int32_t ic_flags; /* state flags */
159 u_int32_t ic_caps; /* capabilities */
160 u_int16_t ic_modecaps; /* set of mode capabilities */
161 u_int16_t ic_curmode; /* current mode */
162 enum ieee80211_phytype ic_phytype; /* XXX wrong for multi-mode */
163 enum ieee80211_opmode ic_opmode; /* operation mode */
164 enum ieee80211_state ic_state; /* 802.11 state */
165 struct ifmedia ic_media; /* interface media config */
166 #ifdef __FreeBSD__
167 struct bpf_if *ic_rawbpf; /* packet filter structure */
168 #else
169 caddr_t ic_rawbpf; /* packet filter structure */
170 #endif
171 struct ieee80211_node *ic_bss; /* information for this node */
172 struct ieee80211_channel *ic_ibss_chan;
173 int ic_fixed_rate; /* index to ic_sup_rates[] */
174 u_int16_t ic_rtsthreshold;
175 u_int16_t ic_fragthreshold;
176 #ifdef __FreeBSD__
177 struct mtx ic_nodelock; /* on node table */
178 #endif
179 struct ieee80211_node *(*ic_node_alloc)(struct ieee80211com *);
180 void (*ic_node_free)(struct ieee80211com *,
181 struct ieee80211_node *);
182 void (*ic_node_copy)(struct ieee80211com *,
183 struct ieee80211_node *,
184 const struct ieee80211_node *);
185 TAILQ_HEAD(, ieee80211_node) ic_node; /* information of all nodes */
186 LIST_HEAD(, ieee80211_node) ic_hash[IEEE80211_NODE_HASHSIZE];
187 u_int16_t ic_lintval; /* listen interval */
188 u_int16_t ic_holdover; /* PM hold over duration */
189 u_int16_t ic_txmin; /* min tx retry count */
190 u_int16_t ic_txmax; /* max tx retry count */
191 u_int16_t ic_txlifetime; /* tx lifetime */
192 u_int16_t ic_txpower; /* tx power setting (dbM) */
193 u_int16_t ic_bmisstimeout;/* beacon miss threshold (ms) */
194 int ic_mgt_timer; /* mgmt timeout */
195 int ic_inact_timer; /* inactivity timer wait */
196 int ic_des_esslen;
197 u_int8_t ic_des_essid[IEEE80211_NWID_LEN];
198 struct ieee80211_channel *ic_des_chan; /* desired channel */
199 u_int8_t ic_des_bssid[IEEE80211_ADDR_LEN];
200 struct ieee80211_wepkey ic_nw_keys[IEEE80211_WEP_NKID];
201 int ic_wep_txkey; /* default tx key index */
202 void *ic_wep_ctx; /* wep crypt context */
203 u_int32_t ic_iv; /* initial vector for wep */
204 };
205 #ifdef __NetBSD__
206 #define ic_if ic_ec.ec_if
207 #else
208 #define ic_if ic_ac.ac_if
209 #endif
210 #define ic_softc ic_if.if_softc
211
212 #define IEEE80211_ADDR_EQ(a1,a2) (memcmp(a1,a2,IEEE80211_ADDR_LEN) == 0)
213 #define IEEE80211_ADDR_COPY(dst,src) memcpy(dst,src,IEEE80211_ADDR_LEN)
214
215 /* ic_flags */
216 #define IEEE80211_F_ASCAN 0x00000001 /* STATUS: active scan */
217 #define IEEE80211_F_SIBSS 0x00000002 /* STATUS: start IBSS */
218 #define IEEE80211_F_WEPON 0x00000100 /* CONF: WEP enabled */
219 #define IEEE80211_F_IBSSON 0x00000200 /* CONF: IBSS creation enable */
220 #define IEEE80211_F_PMGTON 0x00000400 /* CONF: Power mgmt enable */
221 #define IEEE80211_F_DESBSSID 0x00000800 /* CONF: des_bssid is set */
222 #define IEEE80211_F_SCANAP 0x00001000 /* CONF: Scanning AP */
223 #define IEEE80211_F_ROAMING 0x00002000 /* CONF: roaming enabled */
224 #define IEEE80211_F_SWRETRY 0x00004000 /* CONF: sw tx retry enabled */
225 #define IEEE80211_F_TXPMGT 0x00018000 /* STATUS: tx power */
226 #define IEEE80211_F_TXPOW_OFF 0x00000000 /* TX Power: radio disabled */
227 #define IEEE80211_F_TXPOW_FIXED 0x00008000 /* TX Power: fixed rate */
228 #define IEEE80211_F_TXPOW_AUTO 0x00010000 /* TX Power: undefined */
229 #define IEEE80211_F_SHSLOT 0x00020000 /* CONF: short slot time */
230 #define IEEE80211_F_SHPREAMBLE 0x00040000 /* CONF: short preamble */
231
232 /* ic_capabilities */
233 #define IEEE80211_C_WEP 0x00000001 /* CAPABILITY: WEP available */
234 #define IEEE80211_C_IBSS 0x00000002 /* CAPABILITY: IBSS available */
235 #define IEEE80211_C_PMGT 0x00000004 /* CAPABILITY: Power mgmt */
236 #define IEEE80211_C_HOSTAP 0x00000008 /* CAPABILITY: HOSTAP avail */
237 #define IEEE80211_C_AHDEMO 0x00000010 /* CAPABILITY: Old Adhoc Demo */
238 #define IEEE80211_C_SWRETRY 0x00000020 /* CAPABILITY: sw tx retry */
239 #define IEEE80211_C_TXPMGT 0x00000040 /* CAPABILITY: tx power mgmt */
240 #define IEEE80211_C_SHSLOT 0x00000080 /* CAPABILITY: short slottime */
241 #define IEEE80211_C_SHPREAMBLE 0x00000100 /* CAPABILITY: short preamble */
242 #define IEEE80211_C_MONITOR 0x00000200 /* CAPABILITY: monitor mode */
243
244 /* flags for ieee80211_fix_rate() */
245 #define IEEE80211_F_DOSORT 0x00000001 /* sort rate list */
246 #define IEEE80211_F_DOFRATE 0x00000002 /* use fixed rate */
247 #define IEEE80211_F_DONEGO 0x00000004 /* calc negotiated rate */
248 #define IEEE80211_F_DODEL 0x00000008 /* delete ignore rate */
249
250 void ieee80211_ifattach(struct ifnet *);
251 void ieee80211_ifdetach(struct ifnet *);
252 void ieee80211_media_init(struct ifnet *, ifm_change_cb_t, ifm_stat_cb_t);
253 int ieee80211_media_change(struct ifnet *);
254 void ieee80211_media_status(struct ifnet *, struct ifmediareq *);
255 int ieee80211_ioctl(struct ifnet *, u_long, caddr_t);
256 int ieee80211_cfgget(struct ifnet *, u_long, caddr_t);
257 int ieee80211_cfgset(struct ifnet *, u_long, caddr_t);
258 void ieee80211_watchdog(struct ifnet *);
259 int ieee80211_fix_rate(struct ieee80211com *, struct ieee80211_node *, int);
260 int ieee80211_rate2media(struct ieee80211com *, int,
261 enum ieee80211_phymode);
262 int ieee80211_media2rate(int);
263 u_int ieee80211_mhz2ieee(u_int, u_int);
264 u_int ieee80211_chan2ieee(struct ieee80211com *, struct ieee80211_channel *);
265 u_int ieee80211_ieee2mhz(u_int, u_int);
266 int ieee80211_setmode(struct ieee80211com *, enum ieee80211_phymode);
267 enum ieee80211_phymode ieee80211_chan2mode(struct ieee80211com *,
268 struct ieee80211_channel *);
269
270 #define IEEE80211_DEBUG
271 #ifdef IEEE80211_DEBUG
272 extern int ieee80211_debug;
273 #define IEEE80211_DPRINTF(X) if (ieee80211_debug) printf X
274 #define IEEE80211_DPRINTF2(X) if (ieee80211_debug>1) printf X
275 #else
276 #define IEEE80211_DPRINTF(X)
277 #define IEEE80211_DPRINTF2(X)
278 #endif
279
280 #endif /* _NET80211_IEEE80211_VAR_H_ */
281