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