Home | History | Annotate | Line # | Download | only in net80211
_ieee80211.h revision 1.6.4.1
      1 /*-
      2  * Copyright (c) 2001 Atsushi Onoe
      3  * Copyright (c) 2002-2007 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: src/sys/net80211/_ieee80211.h,v 1.14 2007/09/18 20:46:36 sam Exp $
     27  */
     28 #ifndef _NET80211__IEEE80211_H_
     29 #define _NET80211__IEEE80211_H_
     30 
     31 enum ieee80211_phytype {
     32 	IEEE80211_T_DS,			/* direct sequence spread spectrum */
     33 	IEEE80211_T_FH,			/* frequency hopping */
     34 	IEEE80211_T_OFDM,		/* frequency division multiplexing */
     35 	IEEE80211_T_TURBO,		/* high rate OFDM, aka turbo mode */
     36 	IEEE80211_T_HT,			/* high throughput, full GI */
     37 };
     38 #define	IEEE80211_T_CCK	IEEE80211_T_DS	/* more common nomenclature */
     39 
     40 /* XXX not really a mode; there are really multiple PHY's */
     41 enum ieee80211_phymode {
     42 	IEEE80211_MODE_AUTO	= 0,	/* autoselect */
     43 	IEEE80211_MODE_11A	= 1,	/* 5GHz, OFDM */
     44 	IEEE80211_MODE_11B	= 2,	/* 2GHz, CCK */
     45 	IEEE80211_MODE_11G	= 3,	/* 2GHz, OFDM */
     46 	IEEE80211_MODE_FH	= 4,	/* 2GHz, GFSK */
     47 	IEEE80211_MODE_TURBO_A	= 5,	/* 5GHz, OFDM, 2x clock */
     48 	IEEE80211_MODE_TURBO_G	= 6,	/* 2GHz, OFDM, 2x clock */
     49 	IEEE80211_MODE_STURBO_A	= 7,	/* 5GHz, OFDM, 2x clock, static */
     50 	IEEE80211_MODE_11NA	= 8,	/* 5GHz, w/ HT */
     51 	IEEE80211_MODE_11NG	= 9,	/* 2GHz, w/ HT */
     52 };
     53 #define	IEEE80211_MODE_MAX	(IEEE80211_MODE_11NG+1)
     54 
     55 enum ieee80211_opmode {
     56 	IEEE80211_M_STA		= 1,	/* infrastructure station */
     57 	IEEE80211_M_IBSS 	= 0,	/* IBSS (adhoc) station */
     58 	IEEE80211_M_AHDEMO	= 3,	/* Old lucent compatible adhoc demo */
     59 	IEEE80211_M_HOSTAP	= 6,	/* Software Access Point */
     60 	IEEE80211_M_MONITOR	= 8,	/* Monitor mode */
     61 	IEEE80211_M_WDS		= 2	/* WDS link */
     62 };
     63 #define	IEEE80211_OPMODE_MAX	(IEEE80211_M_MONITOR+1)
     64 
     65 /*
     66  * 802.11g/802.11n 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 	uint32_t	ic_flags;	/* see below */
    107 	uint16_t	ic_freq;	/* setting in Mhz */
    108 	uint8_t		ic_ieee;	/* IEEE channel number */
    109 	int8_t		ic_maxregpower;	/* maximum regulatory tx power in dBm */
    110 	int8_t		ic_maxpower;	/* maximum tx power in .5 dBm */
    111 	int8_t		ic_minpower;	/* minimum tx power in .5 dBm */
    112 	uint8_t		ic_state;	/* dynamic state */
    113 	uint8_t		ic_extieee;	/* HT40 extension channel number */
    114 };
    115 
    116 #define	IEEE80211_CHAN_MAX	255
    117 #define	IEEE80211_CHAN_BYTES	32	/* howmany(IEEE80211_CHAN_MAX, NBBY) */
    118 #define	IEEE80211_CHAN_ANY	0xffff	/* token for ``any channel'' */
    119 #define	IEEE80211_CHAN_ANYC \
    120 	((struct ieee80211_channel *) 0x1)
    121 
    122 /* bits 0-3 are for private use by drivers */
    123 /* channel attributes */
    124 #define	IEEE80211_CHAN_TURBO	0x00000010 /* Turbo channel */
    125 #define	IEEE80211_CHAN_CCK	0x00000020 /* CCK channel */
    126 #define	IEEE80211_CHAN_OFDM	0x00000040 /* OFDM channel */
    127 #define	IEEE80211_CHAN_2GHZ	0x00000080 /* 2 GHz spectrum channel. */
    128 #define	IEEE80211_CHAN_5GHZ	0x00000100 /* 5 GHz spectrum channel */
    129 #define	IEEE80211_CHAN_PASSIVE	0x00000200 /* Only passive scan allowed */
    130 #define	IEEE80211_CHAN_DYN	0x00000400 /* Dynamic CCK-OFDM channel */
    131 #define	IEEE80211_CHAN_GFSK	0x00000800 /* GFSK channel (FHSS PHY) */
    132 #define	IEEE80211_CHAN_GSM	0x00001000 /* 900 MHz spectrum channel */
    133 #define	IEEE80211_CHAN_STURBO	0x00002000 /* 11a static turbo channel only */
    134 #define	IEEE80211_CHAN_HALF	0x00004000 /* Half rate channel */
    135 #define	IEEE80211_CHAN_QUARTER	0x00008000 /* Quarter rate channel */
    136 #define	IEEE80211_CHAN_HT20	0x00010000 /* HT 20 channel */
    137 #define	IEEE80211_CHAN_HT40U	0x00020000 /* HT 40 channel w/ ext above */
    138 #define	IEEE80211_CHAN_HT40D	0x00040000 /* HT 40 channel w/ ext below */
    139 #define	IEEE80211_CHAN_DFS	0x00080000 /* DFS required */
    140 #define	IEEE80211_CHAN_4MSXMIT	0x00100000 /* 4ms limit on frame length */
    141 #define	IEEE80211_CHAN_NOADHOC	0x00200000 /* adhoc mode not allowed */
    142 #define	IEEE80211_CHAN_NOHOSTAP	0x00400000 /* hostap mode not allowed */
    143 #define	IEEE80211_CHAN_11D	0x00800000 /* 802.11d required */
    144 
    145 #define	IEEE80211_CHAN_HT40	(IEEE80211_CHAN_HT40U | IEEE80211_CHAN_HT40D)
    146 #define	IEEE80211_CHAN_HT	(IEEE80211_CHAN_HT20 | IEEE80211_CHAN_HT40)
    147 
    148 /*
    149  * Useful combinations of channel characteristics.
    150  */
    151 #define	IEEE80211_CHAN_FHSS \
    152 	(IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_GFSK)
    153 #define	IEEE80211_CHAN_A \
    154 	(IEEE80211_CHAN_5GHZ | IEEE80211_CHAN_OFDM)
    155 #define	IEEE80211_CHAN_B \
    156 	(IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_CCK)
    157 #define	IEEE80211_CHAN_PUREG \
    158 	(IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_OFDM)
    159 #define	IEEE80211_CHAN_G \
    160 	(IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_DYN)
    161 #define IEEE80211_CHAN_108A \
    162 	(IEEE80211_CHAN_5GHZ | IEEE80211_CHAN_OFDM | IEEE80211_CHAN_TURBO)
    163 #define	IEEE80211_CHAN_108G \
    164 	(IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_OFDM | IEEE80211_CHAN_TURBO)
    165 #define	IEEE80211_CHAN_ST \
    166 	(IEEE80211_CHAN_108A | IEEE80211_CHAN_STURBO)
    167 
    168 #define	IEEE80211_CHAN_ALL \
    169 	(IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_5GHZ | IEEE80211_CHAN_GFSK | \
    170 	 IEEE80211_CHAN_CCK | IEEE80211_CHAN_OFDM | IEEE80211_CHAN_DYN | \
    171 	 IEEE80211_CHAN_HT)
    172 #define	IEEE80211_CHAN_ALLTURBO \
    173 	(IEEE80211_CHAN_ALL | IEEE80211_CHAN_TURBO | IEEE80211_CHAN_STURBO)
    174 
    175 #define	IEEE80211_IS_CHAN_FHSS(_c) \
    176 	(((_c)->ic_flags & IEEE80211_CHAN_FHSS) == IEEE80211_CHAN_FHSS)
    177 #define	IEEE80211_IS_CHAN_A(_c) \
    178 	(((_c)->ic_flags & IEEE80211_CHAN_A) == IEEE80211_CHAN_A)
    179 #define	IEEE80211_IS_CHAN_B(_c) \
    180 	(((_c)->ic_flags & IEEE80211_CHAN_B) == IEEE80211_CHAN_B)
    181 #define	IEEE80211_IS_CHAN_PUREG(_c) \
    182 	(((_c)->ic_flags & IEEE80211_CHAN_PUREG) == IEEE80211_CHAN_PUREG)
    183 #define	IEEE80211_IS_CHAN_G(_c) \
    184 	(((_c)->ic_flags & IEEE80211_CHAN_G) == IEEE80211_CHAN_G)
    185 #define	IEEE80211_IS_CHAN_ANYG(_c) \
    186 	(IEEE80211_IS_CHAN_PUREG(_c) || IEEE80211_IS_CHAN_G(_c))
    187 #define	IEEE80211_IS_CHAN_ST(_c) \
    188 	(((_c)->ic_flags & IEEE80211_CHAN_ST) == IEEE80211_CHAN_ST)
    189 #define	IEEE80211_IS_CHAN_108A(_c) \
    190 	(((_c)->ic_flags & IEEE80211_CHAN_108A) == IEEE80211_CHAN_108A)
    191 #define	IEEE80211_IS_CHAN_108G(_c) \
    192 	(((_c)->ic_flags & IEEE80211_CHAN_108G) == IEEE80211_CHAN_108G)
    193 
    194 #define	IEEE80211_IS_CHAN_2GHZ(_c) \
    195 	(((_c)->ic_flags & IEEE80211_CHAN_2GHZ) != 0)
    196 #define	IEEE80211_IS_CHAN_5GHZ(_c) \
    197 	(((_c)->ic_flags & IEEE80211_CHAN_5GHZ) != 0)
    198 #define	IEEE80211_IS_CHAN_PASSIVE(_c) \
    199 	(((_c)->ic_flags & IEEE80211_CHAN_PASSIVE) != 0)
    200 #define	IEEE80211_IS_CHAN_OFDM(_c) \
    201 	(((_c)->ic_flags & IEEE80211_CHAN_OFDM) != 0)
    202 #define	IEEE80211_IS_CHAN_CCK(_c) \
    203 	(((_c)->ic_flags & IEEE80211_CHAN_CCK) != 0)
    204 #define	IEEE80211_IS_CHAN_GFSK(_c) \
    205 	(((_c)->ic_flags & IEEE80211_CHAN_GFSK) != 0)
    206 #define	IEEE80211_IS_CHAN_TURBO(_c) \
    207 	(((_c)->ic_flags & IEEE80211_CHAN_TURBO) != 0)
    208 #define	IEEE80211_IS_CHAN_STURBO(_c) \
    209 	(((_c)->ic_flags & IEEE80211_CHAN_STURBO) != 0)
    210 #define	IEEE80211_IS_CHAN_DTURBO(_c) \
    211 	(((_c)->ic_flags & \
    212 	(IEEE80211_CHAN_TURBO | IEEE80211_CHAN_STURBO)) == IEEE80211_CHAN_TURBO)
    213 #define	IEEE80211_IS_CHAN_HALF(_c) \
    214 	(((_c)->ic_flags & IEEE80211_CHAN_HALF) != 0)
    215 #define	IEEE80211_IS_CHAN_QUARTER(_c) \
    216 	(((_c)->ic_flags & IEEE80211_CHAN_QUARTER) != 0)
    217 #define	IEEE80211_IS_CHAN_FULL(_c) \
    218 	(((_c)->ic_flags & (IEEE80211_CHAN_QUARTER | IEEE80211_CHAN_HALF)) == 0)
    219 #define	IEEE80211_IS_CHAN_GSM(_c) \
    220 	(((_c)->ic_flags & IEEE80211_CHAN_GSM) != 0)
    221 #define	IEEE80211_IS_CHAN_HT(_c) \
    222 	(((_c)->ic_flags & IEEE80211_CHAN_HT) != 0)
    223 #define	IEEE80211_IS_CHAN_HT20(_c) \
    224 	(((_c)->ic_flags & IEEE80211_CHAN_HT20) != 0)
    225 #define	IEEE80211_IS_CHAN_HT40(_c) \
    226 	(((_c)->ic_flags & IEEE80211_CHAN_HT40) != 0)
    227 #define	IEEE80211_IS_CHAN_HT40U(_c) \
    228 	(((_c)->ic_flags & IEEE80211_CHAN_HT40U) != 0)
    229 #define	IEEE80211_IS_CHAN_HT40D(_c) \
    230 	(((_c)->ic_flags & IEEE80211_CHAN_HT40D) != 0)
    231 #define	IEEE80211_IS_CHAN_HTA(_c) \
    232 	(IEEE80211_IS_CHAN_5GHZ(_c) && \
    233 	 ((_c)->ic_flags & IEEE80211_CHAN_HT) != 0)
    234 #define	IEEE80211_IS_CHAN_HTG(_c) \
    235 	(IEEE80211_IS_CHAN_2GHZ(_c) && \
    236 	 ((_c)->ic_flags & IEEE80211_CHAN_HT) != 0)
    237 #define	IEEE80211_IS_CHAN_DFS(_c) \
    238 	(((_c)->ic_flags & IEEE80211_CHAN_DFS) != 0)
    239 #define	IEEE80211_IS_CHAN_NOADHOC(_c) \
    240 	(((_c)->ic_flags & IEEE80211_CHAN_NOADHOC) != 0)
    241 #define	IEEE80211_IS_CHAN_NOHOSTAP(_c) \
    242 	(((_c)->ic_flags & IEEE80211_CHAN_NOHOSTAP) != 0)
    243 #define	IEEE80211_IS_CHAN_11D(_c) \
    244 	(((_c)->ic_flags & IEEE80211_CHAN_11D) != 0)
    245 
    246 #define	IEEE80211_CHAN2IEEE(_c)		(_c)->ic_ieee
    247 
    248 /* dynamic state */
    249 #define	IEEE80211_CHANSTATE_RADAR	0x01	/* radar detected */
    250 #define	IEEE80211_CHANSTATE_CACDONE	0x02	/* CAC completed */
    251 #define	IEEE80211_CHANSTATE_NORADAR	0x10	/* post notify on radar clear */
    252 
    253 #define	IEEE80211_IS_CHAN_RADAR(_c) \
    254 	(((_c)->ic_state & IEEE80211_CHANSTATE_RADAR) != 0)
    255 #define	IEEE80211_IS_CHAN_CACDONE(_c) \
    256 	(((_c)->ic_state & IEEE80211_CHANSTATE_CACDONE) != 0)
    257 
    258 /* ni_chan encoding for FH phy */
    259 #define	IEEE80211_FH_CHANMOD	80
    260 #define	IEEE80211_FH_CHAN(set,pat)	(((set)-1)*IEEE80211_FH_CHANMOD+(pat))
    261 #define	IEEE80211_FH_CHANSET(chan)	((chan)/IEEE80211_FH_CHANMOD+1)
    262 #define	IEEE80211_FH_CHANPAT(chan)	((chan)%IEEE80211_FH_CHANMOD)
    263 
    264 #define	IEEE80211_TID_SIZE	(WME_NUM_TID+1)	/* WME TID's +1 for non-QoS */
    265 #define	IEEE80211_NONQOS_TID	WME_NUM_TID	/* index for non-QoS sta */
    266 
    267 /*
    268  * 802.11 rate set.
    269  */
    270 #define	IEEE80211_RATE_SIZE	8		/* 802.11 standard */
    271 #define	IEEE80211_RATE_MAXSIZE	15		/* max rates we'll handle */
    272 
    273 struct ieee80211_rateset {
    274 	uint8_t			rs_nrates;
    275 	uint8_t			rs_rates[IEEE80211_RATE_MAXSIZE];
    276 };
    277 
    278 /*
    279  * 802.11n variant of ieee80211_rateset.  Instead
    280  * legacy rates the entries are MCS rates.  We define
    281  * the structure such that it can be used interchangeably
    282  * with an ieee80211_rateset (modulo structure size).
    283  */
    284 #define	IEEE80211_HTRATE_MAXSIZE 127
    285 
    286 struct ieee80211_htrateset {
    287 	uint8_t			rs_nrates;
    288 	uint8_t			rs_rates[IEEE80211_HTRATE_MAXSIZE];
    289 };
    290 
    291 #define	IEEE80211_RATE_MCS	0x80
    292 
    293 /*
    294  * Roaming state visible to user space.  There are two
    295  * thresholds that control whether roaming is considered;
    296  * when either is exceeded the 802.11 layer will check
    297  * the scan cache for another AP.  If the cache is stale
    298  * then a scan may be triggered.
    299  */
    300 struct ieee80211_roam {
    301 	int8_t			rssi11a;	/* rssi thresh for 11a bss */
    302 	int8_t			rssi11b;	/* for 11g sta in 11b bss */
    303 	int8_t			rssi11bOnly;	/* for 11b sta */
    304 	uint8_t			pad1;
    305 	uint8_t			rate11a;	/* rate thresh for 11a bss */
    306 	uint8_t			rate11b;	/* for 11g sta in 11b bss */
    307 	uint8_t			rate11bOnly;	/* for 11b sta */
    308 	uint8_t			pad2;
    309 };
    310 #endif /* !_NET80211__IEEE80211_H_ */
    311