xref: /freebsd/sys/net80211/_ieee80211.h (revision 3642298923e528d795e3a30ec165d2b469e28b40)
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  * $FreeBSD$
33  */
34 #ifndef _NET80211__IEEE80211_H_
35 #define _NET80211__IEEE80211_H_
36 
37 enum ieee80211_phytype {
38 	IEEE80211_T_DS,			/* direct sequence spread spectrum */
39 	IEEE80211_T_FH,			/* frequency hopping */
40 	IEEE80211_T_OFDM,		/* frequency division multiplexing */
41 	IEEE80211_T_TURBO,		/* high rate OFDM, aka turbo mode */
42 };
43 #define	IEEE80211_T_CCK	IEEE80211_T_DS	/* more common nomenclature */
44 
45 /* XXX not really a mode; there are really multiple PHY's */
46 enum ieee80211_phymode {
47 	IEEE80211_MODE_AUTO	= 0,	/* autoselect */
48 	IEEE80211_MODE_11A	= 1,	/* 5GHz, OFDM */
49 	IEEE80211_MODE_11B	= 2,	/* 2GHz, CCK */
50 	IEEE80211_MODE_11G	= 3,	/* 2GHz, OFDM */
51 	IEEE80211_MODE_FH	= 4,	/* 2GHz, GFSK */
52 	IEEE80211_MODE_TURBO_A	= 5,	/* 5GHz, OFDM, 2x clock */
53 	IEEE80211_MODE_TURBO_G	= 6,	/* 2GHz, OFDM, 2x clock */
54 };
55 #define	IEEE80211_MODE_MAX	(IEEE80211_MODE_TURBO_G+1)
56 
57 enum ieee80211_opmode {
58 	IEEE80211_M_STA		= 1,	/* infrastructure station */
59 	IEEE80211_M_IBSS 	= 0,	/* IBSS (adhoc) station */
60 	IEEE80211_M_AHDEMO	= 3,	/* Old lucent compatible adhoc demo */
61 	IEEE80211_M_HOSTAP	= 6,	/* Software Access Point */
62 	IEEE80211_M_MONITOR	= 8	/* Monitor mode */
63 };
64 
65 /*
66  * 802.11g protection mode.
67  */
68 enum ieee80211_protmode {
69 	IEEE80211_PROT_NONE	= 0,	/* no protection */
70 	IEEE80211_PROT_CTSONLY	= 1,	/* CTS to self */
71 	IEEE80211_PROT_RTSCTS	= 2,	/* RTS-CTS */
72 };
73 
74 /*
75  * Authentication mode.
76  */
77 enum ieee80211_authmode {
78 	IEEE80211_AUTH_NONE	= 0,
79 	IEEE80211_AUTH_OPEN	= 1,		/* open */
80 	IEEE80211_AUTH_SHARED	= 2,		/* shared-key */
81 	IEEE80211_AUTH_8021X	= 3,		/* 802.1x */
82 	IEEE80211_AUTH_AUTO	= 4,		/* auto-select/accept */
83 	/* NB: these are used only for ioctls */
84 	IEEE80211_AUTH_WPA	= 5,		/* WPA/RSN w/ 802.1x/PSK */
85 };
86 
87 /*
88  * Roaming mode is effectively who controls the operation
89  * of the 802.11 state machine when operating as a station.
90  * State transitions are controlled either by the driver
91  * (typically when management frames are processed by the
92  * hardware/firmware), the host (auto/normal operation of
93  * the 802.11 layer), or explicitly through ioctl requests
94  * when applications like wpa_supplicant want control.
95  */
96 enum ieee80211_roamingmode {
97 	IEEE80211_ROAMING_DEVICE= 0,	/* driver/hardware control */
98 	IEEE80211_ROAMING_AUTO	= 1,	/* 802.11 layer control */
99 	IEEE80211_ROAMING_MANUAL= 2,	/* application control */
100 };
101 
102 /*
103  * Channels are specified by frequency and attributes.
104  */
105 struct ieee80211_channel {
106 	u_int16_t	ic_freq;	/* setting in Mhz */
107 	u_int16_t	ic_flags;	/* see below */
108 };
109 
110 #define	IEEE80211_CHAN_MAX	255
111 #define	IEEE80211_CHAN_BYTES	32	/* howmany(IEEE80211_CHAN_MAX, NBBY) */
112 #define	IEEE80211_CHAN_ANY	0xffff	/* token for ``any channel'' */
113 #define	IEEE80211_CHAN_ANYC \
114 	((struct ieee80211_channel *) IEEE80211_CHAN_ANY)
115 
116 /* bits 0-3 are for private use by drivers */
117 /* channel attributes */
118 #define	IEEE80211_CHAN_TURBO	0x0010	/* Turbo channel */
119 #define	IEEE80211_CHAN_CCK	0x0020	/* CCK channel */
120 #define	IEEE80211_CHAN_OFDM	0x0040	/* OFDM channel */
121 #define	IEEE80211_CHAN_2GHZ	0x0080	/* 2 GHz spectrum channel. */
122 #define	IEEE80211_CHAN_5GHZ	0x0100	/* 5 GHz spectrum channel */
123 #define	IEEE80211_CHAN_PASSIVE	0x0200	/* Only passive scan allowed */
124 #define	IEEE80211_CHAN_DYN	0x0400	/* Dynamic CCK-OFDM channel */
125 #define	IEEE80211_CHAN_GFSK	0x0800	/* GFSK channel (FHSS PHY) */
126 
127 /*
128  * Useful combinations of channel characteristics.
129  */
130 #define	IEEE80211_CHAN_FHSS \
131 	(IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_GFSK)
132 #define	IEEE80211_CHAN_A \
133 	(IEEE80211_CHAN_5GHZ | IEEE80211_CHAN_OFDM)
134 #define	IEEE80211_CHAN_B \
135 	(IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_CCK)
136 #define	IEEE80211_CHAN_PUREG \
137 	(IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_OFDM)
138 #define	IEEE80211_CHAN_G \
139 	(IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_DYN)
140 #define	IEEE80211_CHAN_T \
141 	(IEEE80211_CHAN_5GHZ | IEEE80211_CHAN_OFDM | IEEE80211_CHAN_TURBO)
142 #define	IEEE80211_CHAN_108G \
143 	(IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_OFDM | IEEE80211_CHAN_TURBO)
144 
145 #define	IEEE80211_IS_CHAN_FHSS(_c) \
146 	(((_c)->ic_flags & IEEE80211_CHAN_FHSS) == IEEE80211_CHAN_FHSS)
147 #define	IEEE80211_IS_CHAN_A(_c) \
148 	(((_c)->ic_flags & IEEE80211_CHAN_A) == IEEE80211_CHAN_A)
149 #define	IEEE80211_IS_CHAN_B(_c) \
150 	(((_c)->ic_flags & IEEE80211_CHAN_B) == IEEE80211_CHAN_B)
151 #define	IEEE80211_IS_CHAN_PUREG(_c) \
152 	(((_c)->ic_flags & IEEE80211_CHAN_PUREG) == IEEE80211_CHAN_PUREG)
153 #define	IEEE80211_IS_CHAN_G(_c) \
154 	(((_c)->ic_flags & IEEE80211_CHAN_G) == IEEE80211_CHAN_G)
155 #define	IEEE80211_IS_CHAN_ANYG(_c) \
156 	(IEEE80211_IS_CHAN_PUREG(_c) || IEEE80211_IS_CHAN_G(_c))
157 #define	IEEE80211_IS_CHAN_T(_c) \
158 	(((_c)->ic_flags & IEEE80211_CHAN_T) == IEEE80211_CHAN_T)
159 #define	IEEE80211_IS_CHAN_108G(_c) \
160 	(((_c)->ic_flags & IEEE80211_CHAN_108G) == IEEE80211_CHAN_108G)
161 
162 #define	IEEE80211_IS_CHAN_2GHZ(_c) \
163 	(((_c)->ic_flags & IEEE80211_CHAN_2GHZ) != 0)
164 #define	IEEE80211_IS_CHAN_5GHZ(_c) \
165 	(((_c)->ic_flags & IEEE80211_CHAN_5GHZ) != 0)
166 #define	IEEE80211_IS_CHAN_OFDM(_c) \
167 	(((_c)->ic_flags & IEEE80211_CHAN_OFDM) != 0)
168 #define	IEEE80211_IS_CHAN_CCK(_c) \
169 	(((_c)->ic_flags & IEEE80211_CHAN_CCK) != 0)
170 #define	IEEE80211_IS_CHAN_GFSK(_c) \
171 	(((_c)->ic_flags & IEEE80211_CHAN_GFSK) != 0)
172 
173 /* ni_chan encoding for FH phy */
174 #define	IEEE80211_FH_CHANMOD	80
175 #define	IEEE80211_FH_CHAN(set,pat)	(((set)-1)*IEEE80211_FH_CHANMOD+(pat))
176 #define	IEEE80211_FH_CHANSET(chan)	((chan)/IEEE80211_FH_CHANMOD+1)
177 #define	IEEE80211_FH_CHANPAT(chan)	((chan)%IEEE80211_FH_CHANMOD)
178 
179 /*
180  * 802.11 rate set.
181  */
182 #define	IEEE80211_RATE_SIZE	8		/* 802.11 standard */
183 #define	IEEE80211_RATE_MAXSIZE	15		/* max rates we'll handle */
184 
185 struct ieee80211_rateset {
186 	u_int8_t		rs_nrates;
187 	u_int8_t		rs_rates[IEEE80211_RATE_MAXSIZE];
188 };
189 
190 #endif /* _NET80211__IEEE80211_H_ */
191