]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sys/net80211/_ieee80211.h
Merge OpenBSM 1.1 from OpenBSM vendor branch to head.
[FreeBSD/FreeBSD.git] / sys / net80211 / _ieee80211.h
1 /*-
2  * Copyright (c) 2001 Atsushi Onoe
3  * Copyright (c) 2002-2008 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  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28 #ifndef _NET80211__IEEE80211_H_
29 #define _NET80211__IEEE80211_H_
30
31 /*
32  * 802.11 implementation definitions.
33  *
34  * NB: this file is used by applications.
35  */
36
37 /*
38  * PHY type; mostly used to identify FH phys.
39  */
40 enum ieee80211_phytype {
41         IEEE80211_T_DS,                 /* direct sequence spread spectrum */
42         IEEE80211_T_FH,                 /* frequency hopping */
43         IEEE80211_T_OFDM,               /* frequency division multiplexing */
44         IEEE80211_T_TURBO,              /* high rate OFDM, aka turbo mode */
45         IEEE80211_T_HT,                 /* high throughput */
46         IEEE80211_T_OFDM_HALF,          /* 1/2 rate OFDM */
47         IEEE80211_T_OFDM_QUARTER,       /* 1/4 rate OFDM */
48 };
49 #define IEEE80211_T_CCK IEEE80211_T_DS  /* more common nomenclature */
50
51 /*
52  * PHY mode; this is not really a mode as multi-mode devices
53  * have multiple PHY's.  Mode is mostly used as a shorthand
54  * for constraining which channels to consider in setting up
55  * operation.  Modes used to be used more extensively when
56  * channels were identified as IEEE channel numbers.
57  */
58 enum ieee80211_phymode {
59         IEEE80211_MODE_AUTO     = 0,    /* autoselect */
60         IEEE80211_MODE_11A      = 1,    /* 5GHz, OFDM */
61         IEEE80211_MODE_11B      = 2,    /* 2GHz, CCK */
62         IEEE80211_MODE_11G      = 3,    /* 2GHz, OFDM */
63         IEEE80211_MODE_FH       = 4,    /* 2GHz, GFSK */
64         IEEE80211_MODE_TURBO_A  = 5,    /* 5GHz, OFDM, 2x clock */
65         IEEE80211_MODE_TURBO_G  = 6,    /* 2GHz, OFDM, 2x clock */
66         IEEE80211_MODE_STURBO_A = 7,    /* 5GHz, OFDM, 2x clock, static */
67         IEEE80211_MODE_11NA     = 8,    /* 5GHz, w/ HT */
68         IEEE80211_MODE_11NG     = 9,    /* 2GHz, w/ HT */
69         IEEE80211_MODE_HALF     = 10,   /* OFDM, 1/2x clock */
70         IEEE80211_MODE_QUARTER  = 11,   /* OFDM, 1/4x clock */
71 };
72 #define IEEE80211_MODE_MAX      (IEEE80211_MODE_QUARTER+1)
73
74 /*
75  * Operating mode.  Devices do not necessarily support
76  * all modes; they indicate which are supported in their
77  * capabilities.
78  */
79 enum ieee80211_opmode {
80         IEEE80211_M_IBSS        = 0,    /* IBSS (adhoc) station */
81         IEEE80211_M_STA         = 1,    /* infrastructure station */
82         IEEE80211_M_WDS         = 2,    /* WDS link */
83         IEEE80211_M_AHDEMO      = 3,    /* Old lucent compatible adhoc demo */
84         IEEE80211_M_HOSTAP      = 4,    /* Software Access Point */
85         IEEE80211_M_MONITOR     = 5,    /* Monitor mode */
86 };
87 #define IEEE80211_OPMODE_MAX    (IEEE80211_M_MONITOR+1)
88
89 /*
90  * 802.11g/802.11n protection mode.
91  */
92 enum ieee80211_protmode {
93         IEEE80211_PROT_NONE     = 0,    /* no protection */
94         IEEE80211_PROT_CTSONLY  = 1,    /* CTS to self */
95         IEEE80211_PROT_RTSCTS   = 2,    /* RTS-CTS */
96 };
97
98 /*
99  * Authentication mode.  The open and shared key authentication
100  * modes are implemented within the 802.11 layer.  802.1x and
101  * WPA/802.11i are implemented in user mode by setting the
102  * 802.11 layer into IEEE80211_AUTH_8021X and deferring
103  * authentication to user space programs.
104  */
105 enum ieee80211_authmode {
106         IEEE80211_AUTH_NONE     = 0,
107         IEEE80211_AUTH_OPEN     = 1,            /* open */
108         IEEE80211_AUTH_SHARED   = 2,            /* shared-key */
109         IEEE80211_AUTH_8021X    = 3,            /* 802.1x */
110         IEEE80211_AUTH_AUTO     = 4,            /* auto-select/accept */
111         /* NB: these are used only for ioctls */
112         IEEE80211_AUTH_WPA      = 5,            /* WPA/RSN w/ 802.1x/PSK */
113 };
114
115 /*
116  * Roaming mode is effectively who controls the operation
117  * of the 802.11 state machine when operating as a station.
118  * State transitions are controlled either by the driver
119  * (typically when management frames are processed by the
120  * hardware/firmware), the host (auto/normal operation of
121  * the 802.11 layer), or explicitly through ioctl requests
122  * when applications like wpa_supplicant want control.
123  */
124 enum ieee80211_roamingmode {
125         IEEE80211_ROAMING_DEVICE= 0,    /* driver/hardware control */
126         IEEE80211_ROAMING_AUTO  = 1,    /* 802.11 layer control */
127         IEEE80211_ROAMING_MANUAL= 2,    /* application control */
128 };
129
130 /*
131  * Channels are specified by frequency and attributes.
132  */
133 struct ieee80211_channel {
134         uint32_t        ic_flags;       /* see below */
135         uint16_t        ic_freq;        /* setting in Mhz */
136         uint8_t         ic_ieee;        /* IEEE channel number */
137         int8_t          ic_maxregpower; /* maximum regulatory tx power in dBm */
138         int8_t          ic_maxpower;    /* maximum tx power in .5 dBm */
139         int8_t          ic_minpower;    /* minimum tx power in .5 dBm */
140         uint8_t         ic_state;       /* dynamic state */
141         uint8_t         ic_extieee;     /* HT40 extension channel number */
142         int8_t          ic_maxantgain;  /* maximum antenna gain in .5 dBm */
143         uint8_t         ic_pad;
144         uint16_t        ic_devdata;     /* opaque device/driver data */
145 };
146
147 #define IEEE80211_CHAN_MAX      256
148 #define IEEE80211_CHAN_BYTES    32      /* howmany(IEEE80211_CHAN_MAX, NBBY) */
149 #define IEEE80211_CHAN_ANY      0xffff  /* token for ``any channel'' */
150 #define IEEE80211_CHAN_ANYC \
151         ((struct ieee80211_channel *) IEEE80211_CHAN_ANY)
152
153 /* channel attributes */
154 #define IEEE80211_CHAN_PRIV0    0x00000001 /* driver private bit 0 */
155 #define IEEE80211_CHAN_PRIV1    0x00000002 /* driver private bit 1 */
156 #define IEEE80211_CHAN_PRIV2    0x00000004 /* driver private bit 2 */
157 #define IEEE80211_CHAN_PRIV3    0x00000008 /* driver private bit 3 */
158 #define IEEE80211_CHAN_TURBO    0x00000010 /* Turbo channel */
159 #define IEEE80211_CHAN_CCK      0x00000020 /* CCK channel */
160 #define IEEE80211_CHAN_OFDM     0x00000040 /* OFDM channel */
161 #define IEEE80211_CHAN_2GHZ     0x00000080 /* 2 GHz spectrum channel. */
162 #define IEEE80211_CHAN_5GHZ     0x00000100 /* 5 GHz spectrum channel */
163 #define IEEE80211_CHAN_PASSIVE  0x00000200 /* Only passive scan allowed */
164 #define IEEE80211_CHAN_DYN      0x00000400 /* Dynamic CCK-OFDM channel */
165 #define IEEE80211_CHAN_GFSK     0x00000800 /* GFSK channel (FHSS PHY) */
166 #define IEEE80211_CHAN_GSM      0x00001000 /* 900 MHz spectrum channel */
167 #define IEEE80211_CHAN_STURBO   0x00002000 /* 11a static turbo channel only */
168 #define IEEE80211_CHAN_HALF     0x00004000 /* Half rate channel */
169 #define IEEE80211_CHAN_QUARTER  0x00008000 /* Quarter rate channel */
170 #define IEEE80211_CHAN_HT20     0x00010000 /* HT 20 channel */
171 #define IEEE80211_CHAN_HT40U    0x00020000 /* HT 40 channel w/ ext above */
172 #define IEEE80211_CHAN_HT40D    0x00040000 /* HT 40 channel w/ ext below */
173 #define IEEE80211_CHAN_DFS      0x00080000 /* DFS required */
174 #define IEEE80211_CHAN_4MSXMIT  0x00100000 /* 4ms limit on frame length */
175 #define IEEE80211_CHAN_NOADHOC  0x00200000 /* adhoc mode not allowed */
176 #define IEEE80211_CHAN_NOHOSTAP 0x00400000 /* hostap mode not allowed */
177 #define IEEE80211_CHAN_11D      0x00800000 /* 802.11d required */
178
179 #define IEEE80211_CHAN_HT40     (IEEE80211_CHAN_HT40U | IEEE80211_CHAN_HT40D)
180 #define IEEE80211_CHAN_HT       (IEEE80211_CHAN_HT20 | IEEE80211_CHAN_HT40)
181
182 #define IEEE80211_CHAN_BITS \
183         "\20\1PRIV0\2PRIV2\3PRIV3\4PRIV4\5TURBO\6CCK\7OFDM\0102GHZ\0115GHZ" \
184         "\12PASSIVE\13DYN\14GFSK\15GSM\16STURBO\17HALF\20QUARTER\21HT20" \
185         "\22HT40U\23HT40D\24DFS\0254MSXMIT\26NOADHOC\27NOHOSTAP\03011D"
186
187 /*
188  * Useful combinations of channel characteristics.
189  */
190 #define IEEE80211_CHAN_FHSS \
191         (IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_GFSK)
192 #define IEEE80211_CHAN_A \
193         (IEEE80211_CHAN_5GHZ | IEEE80211_CHAN_OFDM)
194 #define IEEE80211_CHAN_B \
195         (IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_CCK)
196 #define IEEE80211_CHAN_PUREG \
197         (IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_OFDM)
198 #define IEEE80211_CHAN_G \
199         (IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_DYN)
200 #define IEEE80211_CHAN_108A \
201         (IEEE80211_CHAN_A | IEEE80211_CHAN_TURBO)
202 #define IEEE80211_CHAN_108G \
203         (IEEE80211_CHAN_PUREG | IEEE80211_CHAN_TURBO)
204 #define IEEE80211_CHAN_ST \
205         (IEEE80211_CHAN_108A | IEEE80211_CHAN_STURBO)
206
207 #define IEEE80211_CHAN_ALL \
208         (IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_5GHZ | IEEE80211_CHAN_GFSK | \
209          IEEE80211_CHAN_CCK | IEEE80211_CHAN_OFDM | IEEE80211_CHAN_DYN | \
210          IEEE80211_CHAN_HALF | IEEE80211_CHAN_QUARTER | \
211          IEEE80211_CHAN_HT)
212 #define IEEE80211_CHAN_ALLTURBO \
213         (IEEE80211_CHAN_ALL | IEEE80211_CHAN_TURBO | IEEE80211_CHAN_STURBO)
214
215 #define IEEE80211_IS_CHAN_FHSS(_c) \
216         (((_c)->ic_flags & IEEE80211_CHAN_FHSS) == IEEE80211_CHAN_FHSS)
217 #define IEEE80211_IS_CHAN_A(_c) \
218         (((_c)->ic_flags & IEEE80211_CHAN_A) == IEEE80211_CHAN_A)
219 #define IEEE80211_IS_CHAN_B(_c) \
220         (((_c)->ic_flags & IEEE80211_CHAN_B) == IEEE80211_CHAN_B)
221 #define IEEE80211_IS_CHAN_PUREG(_c) \
222         (((_c)->ic_flags & IEEE80211_CHAN_PUREG) == IEEE80211_CHAN_PUREG)
223 #define IEEE80211_IS_CHAN_G(_c) \
224         (((_c)->ic_flags & IEEE80211_CHAN_G) == IEEE80211_CHAN_G)
225 #define IEEE80211_IS_CHAN_ANYG(_c) \
226         (IEEE80211_IS_CHAN_PUREG(_c) || IEEE80211_IS_CHAN_G(_c))
227 #define IEEE80211_IS_CHAN_ST(_c) \
228         (((_c)->ic_flags & IEEE80211_CHAN_ST) == IEEE80211_CHAN_ST)
229 #define IEEE80211_IS_CHAN_108A(_c) \
230         (((_c)->ic_flags & IEEE80211_CHAN_108A) == IEEE80211_CHAN_108A)
231 #define IEEE80211_IS_CHAN_108G(_c) \
232         (((_c)->ic_flags & IEEE80211_CHAN_108G) == IEEE80211_CHAN_108G)
233
234 #define IEEE80211_IS_CHAN_2GHZ(_c) \
235         (((_c)->ic_flags & IEEE80211_CHAN_2GHZ) != 0)
236 #define IEEE80211_IS_CHAN_5GHZ(_c) \
237         (((_c)->ic_flags & IEEE80211_CHAN_5GHZ) != 0)
238 #define IEEE80211_IS_CHAN_PASSIVE(_c) \
239         (((_c)->ic_flags & IEEE80211_CHAN_PASSIVE) != 0)
240 #define IEEE80211_IS_CHAN_OFDM(_c) \
241         (((_c)->ic_flags & (IEEE80211_CHAN_OFDM | IEEE80211_CHAN_DYN)) != 0)
242 #define IEEE80211_IS_CHAN_CCK(_c) \
243         (((_c)->ic_flags & (IEEE80211_CHAN_CCK | IEEE80211_CHAN_DYN)) != 0)
244 #define IEEE80211_IS_CHAN_GFSK(_c) \
245         (((_c)->ic_flags & IEEE80211_CHAN_GFSK) != 0)
246 #define IEEE80211_IS_CHAN_TURBO(_c) \
247         (((_c)->ic_flags & IEEE80211_CHAN_TURBO) != 0)
248 #define IEEE80211_IS_CHAN_STURBO(_c) \
249         (((_c)->ic_flags & IEEE80211_CHAN_STURBO) != 0)
250 #define IEEE80211_IS_CHAN_DTURBO(_c) \
251         (((_c)->ic_flags & \
252         (IEEE80211_CHAN_TURBO | IEEE80211_CHAN_STURBO)) == IEEE80211_CHAN_TURBO)
253 #define IEEE80211_IS_CHAN_HALF(_c) \
254         (((_c)->ic_flags & IEEE80211_CHAN_HALF) != 0)
255 #define IEEE80211_IS_CHAN_QUARTER(_c) \
256         (((_c)->ic_flags & IEEE80211_CHAN_QUARTER) != 0)
257 #define IEEE80211_IS_CHAN_FULL(_c) \
258         (((_c)->ic_flags & (IEEE80211_CHAN_QUARTER | IEEE80211_CHAN_HALF)) == 0)
259 #define IEEE80211_IS_CHAN_GSM(_c) \
260         (((_c)->ic_flags & IEEE80211_CHAN_GSM) != 0)
261 #define IEEE80211_IS_CHAN_HT(_c) \
262         (((_c)->ic_flags & IEEE80211_CHAN_HT) != 0)
263 #define IEEE80211_IS_CHAN_HT20(_c) \
264         (((_c)->ic_flags & IEEE80211_CHAN_HT20) != 0)
265 #define IEEE80211_IS_CHAN_HT40(_c) \
266         (((_c)->ic_flags & IEEE80211_CHAN_HT40) != 0)
267 #define IEEE80211_IS_CHAN_HT40U(_c) \
268         (((_c)->ic_flags & IEEE80211_CHAN_HT40U) != 0)
269 #define IEEE80211_IS_CHAN_HT40D(_c) \
270         (((_c)->ic_flags & IEEE80211_CHAN_HT40D) != 0)
271 #define IEEE80211_IS_CHAN_HTA(_c) \
272         (IEEE80211_IS_CHAN_5GHZ(_c) && \
273          ((_c)->ic_flags & IEEE80211_CHAN_HT) != 0)
274 #define IEEE80211_IS_CHAN_HTG(_c) \
275         (IEEE80211_IS_CHAN_2GHZ(_c) && \
276          ((_c)->ic_flags & IEEE80211_CHAN_HT) != 0)
277 #define IEEE80211_IS_CHAN_DFS(_c) \
278         (((_c)->ic_flags & IEEE80211_CHAN_DFS) != 0)
279 #define IEEE80211_IS_CHAN_NOADHOC(_c) \
280         (((_c)->ic_flags & IEEE80211_CHAN_NOADHOC) != 0)
281 #define IEEE80211_IS_CHAN_NOHOSTAP(_c) \
282         (((_c)->ic_flags & IEEE80211_CHAN_NOHOSTAP) != 0)
283 #define IEEE80211_IS_CHAN_11D(_c) \
284         (((_c)->ic_flags & IEEE80211_CHAN_11D) != 0)
285
286 #define IEEE80211_CHAN2IEEE(_c)         (_c)->ic_ieee
287
288 /* dynamic state */
289 #define IEEE80211_CHANSTATE_RADAR       0x01    /* radar detected */
290 #define IEEE80211_CHANSTATE_CACDONE     0x02    /* CAC completed */
291 #define IEEE80211_CHANSTATE_CWINT       0x04    /* interference detected */
292 #define IEEE80211_CHANSTATE_NORADAR     0x10    /* post notify on radar clear */
293
294 #define IEEE80211_IS_CHAN_RADAR(_c) \
295         (((_c)->ic_state & IEEE80211_CHANSTATE_RADAR) != 0)
296 #define IEEE80211_IS_CHAN_CACDONE(_c) \
297         (((_c)->ic_state & IEEE80211_CHANSTATE_CACDONE) != 0)
298 #define IEEE80211_IS_CHAN_CWINT(_c) \
299         (((_c)->ic_state & IEEE80211_CHANSTATE_CWINT) != 0)
300
301 /* ni_chan encoding for FH phy */
302 #define IEEE80211_FH_CHANMOD    80
303 #define IEEE80211_FH_CHAN(set,pat)      (((set)-1)*IEEE80211_FH_CHANMOD+(pat))
304 #define IEEE80211_FH_CHANSET(chan)      ((chan)/IEEE80211_FH_CHANMOD+1)
305 #define IEEE80211_FH_CHANPAT(chan)      ((chan)%IEEE80211_FH_CHANMOD)
306
307 #define IEEE80211_TID_SIZE      (WME_NUM_TID+1) /* WME TID's +1 for non-QoS */
308 #define IEEE80211_NONQOS_TID    WME_NUM_TID     /* index for non-QoS sta */
309
310 /*
311  * The 802.11 spec says at most 2007 stations may be
312  * associated at once.  For most AP's this is way more
313  * than is feasible so we use a default of 128.  This
314  * number may be overridden by the driver and/or by
315  * user configuration but may not be less than IEEE80211_AID_MIN.
316  */
317 #define IEEE80211_AID_DEF               128
318 #define IEEE80211_AID_MIN               16
319
320 /*
321  * 802.11 rate set.
322  */
323 #define IEEE80211_RATE_SIZE     8               /* 802.11 standard */
324 #define IEEE80211_RATE_MAXSIZE  15              /* max rates we'll handle */
325
326 struct ieee80211_rateset {
327         uint8_t         rs_nrates;
328         uint8_t         rs_rates[IEEE80211_RATE_MAXSIZE];
329 };
330
331 /*
332  * 802.11n variant of ieee80211_rateset.  Instead of
333  * legacy rates the entries are MCS rates.  We define
334  * the structure such that it can be used interchangeably
335  * with an ieee80211_rateset (modulo structure size).
336  */
337 #define IEEE80211_HTRATE_MAXSIZE 127
338
339 struct ieee80211_htrateset {
340         uint8_t         rs_nrates;
341         uint8_t         rs_rates[IEEE80211_HTRATE_MAXSIZE];
342 };
343
344 #define IEEE80211_RATE_MCS      0x80
345
346 /*
347  * Per-mode transmit parameters/controls visible to user space.
348  * These can be used to set fixed transmit rate for all operating
349  * modes or on a per-client basis according to the capabilities
350  * of the client (e.g. an 11b client associated to an 11g ap).
351  *
352  * MCS are distinguished from legacy rates by or'ing in 0x80.
353  */
354 struct ieee80211_txparam {
355         uint8_t         ucastrate;      /* ucast data rate (legacy/MCS|0x80) */
356         uint8_t         mgmtrate;       /* mgmt frame rate (legacy/MCS|0x80) */
357         uint8_t         mcastrate;      /* multicast rate (legacy/MCS|0x80) */
358         uint8_t         maxretry;       /* max unicast data retry count */
359 };
360
361 /*
362  * Per-mode roaming state visible to user space.  There are two
363  * thresholds that control whether roaming is considered; when
364  * either is exceeded the 802.11 layer will check the scan cache
365  * for another AP.  If the cache is stale then a scan may be
366  * triggered.
367  */
368 struct ieee80211_roamparam {
369         int8_t          rssi;           /* rssi thresh (.5 dBm) */
370         uint8_t         rate;           /* tx rate thresh (.5 Mb/s or MCS) */
371         uint16_t        pad;            /* reserve */
372 };
373
374 /*
375  * Regulatory Information.
376  */
377 struct ieee80211_regdomain {
378         uint16_t        regdomain;      /* SKU */
379         uint16_t        country;        /* ISO country code */
380         uint8_t         location;       /* I (indoor), O (outdoor), other */
381         uint8_t         ecm;            /* Extended Channel Mode */
382         char            isocc[2];       /* country code string */
383         short           pad[2];
384 };
385
386 /*
387  * MIMO antenna/radio state.
388  */
389 struct ieee80211_mimo_info {
390         int8_t          rssi[3];        /* per-antenna rssi */
391         int8_t          noise[3];       /* per-antenna noise floor */
392         uint32_t        evm[3];         /* EVM data */
393 };
394 #endif /* _NET80211__IEEE80211_H_ */