sys/net80211/_ieee80211.h

   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 #define IEEE80211_OPMODE_MAX    (IEEE80211_M_MONITOR+1)
  65
  66 /*
  67  * 802.11g protection mode.
  68  */
  69 enum ieee80211_protmode {
  70         IEEE80211_PROT_NONE     = 0,    /* no protection */
  71         IEEE80211_PROT_CTSONLY  = 1,    /* CTS to self */
  72         IEEE80211_PROT_RTSCTS   = 2,    /* RTS-CTS */
  73 };
  74
  75 /*
  76  * Authentication mode.
  77  */
  78 enum ieee80211_authmode {
  79         IEEE80211_AUTH_NONE     = 0,
  80         IEEE80211_AUTH_OPEN     = 1,            /* open */
  81         IEEE80211_AUTH_SHARED   = 2,            /* shared-key */
  82         IEEE80211_AUTH_8021X    = 3,            /* 802.1x */
  83         IEEE80211_AUTH_AUTO     = 4,            /* auto-select/accept */
  84         /* NB: these are used only for ioctls */
  85         IEEE80211_AUTH_WPA      = 5,            /* WPA/RSN w/ 802.1x/PSK */
  86 };
  87
  88 /*
  89  * Roaming mode is effectively who controls the operation
  90  * of the 802.11 state machine when operating as a station.
  91  * State transitions are controlled either by the driver
  92  * (typically when management frames are processed by the
  93  * hardware/firmware), the host (auto/normal operation of
  94  * the 802.11 layer), or explicitly through ioctl requests
  95  * when applications like wpa_supplicant want control.
  96  */
  97 enum ieee80211_roamingmode {
  98         IEEE80211_ROAMING_DEVICE= 0,    /* driver/hardware control */
  99         IEEE80211_ROAMING_AUTO  = 1,    /* 802.11 layer control */
 100         IEEE80211_ROAMING_MANUAL= 2,    /* application control */
 101 };
 102
 103 /*
 104  * Channels are specified by frequency and attributes.
 105  */
 106 struct ieee80211_channel {
 107         u_int16_t       ic_freq;        /* setting in Mhz */
 108         u_int16_t       ic_flags;       /* see below */
 109 };
 110
 111 #define IEEE80211_CHAN_MAX      255
 112 #define IEEE80211_CHAN_BYTES    32      /* howmany(IEEE80211_CHAN_MAX, NBBY) */
 113 #define IEEE80211_CHAN_ANY      0xffff  /* token for ``any channel'' */
 114 #define IEEE80211_CHAN_ANYC \
 115         ((struct ieee80211_channel *) IEEE80211_CHAN_ANY)
 116
 117 /* bits 0-3 are for private use by drivers */
 118 /* channel attributes */
 119 #define IEEE80211_CHAN_TURBO    0x0010  /* Turbo channel */
 120 #define IEEE80211_CHAN_CCK      0x0020  /* CCK channel */
 121 #define IEEE80211_CHAN_OFDM     0x0040  /* OFDM channel */
 122 #define IEEE80211_CHAN_2GHZ     0x0080  /* 2 GHz spectrum channel. */
 123 #define IEEE80211_CHAN_5GHZ     0x0100  /* 5 GHz spectrum channel */
 124 #define IEEE80211_CHAN_PASSIVE  0x0200  /* Only passive scan allowed */
 125 #define IEEE80211_CHAN_DYN      0x0400  /* Dynamic CCK-OFDM channel */
 126 #define IEEE80211_CHAN_GFSK     0x0800  /* GFSK channel (FHSS PHY) */
 127 #define IEEE80211_CHAN_GSM      0x1000  /* 900 MHz spectrum channel */
 128 #define IEEE80211_CHAN_HALF     0x4000  /* Half rate channel */
 129 #define IEEE80211_CHAN_QUARTER  0x8000  /* Quarter rate channel */
 130
 131 /*
 132  * Useful combinations of channel characteristics.
 133  */
 134 #define IEEE80211_CHAN_FHSS \
 135         (IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_GFSK)
 136 #define IEEE80211_CHAN_A \
 137         (IEEE80211_CHAN_5GHZ | IEEE80211_CHAN_OFDM)
 138 #define IEEE80211_CHAN_B \
 139         (IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_CCK)
 140 #define IEEE80211_CHAN_PUREG \
 141         (IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_OFDM)
 142 #define IEEE80211_CHAN_G \
 143         (IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_DYN)
 144 #define IEEE80211_CHAN_T \
 145         (IEEE80211_CHAN_5GHZ | IEEE80211_CHAN_OFDM | IEEE80211_CHAN_TURBO)
 146 #define IEEE80211_CHAN_108G \
 147         (IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_OFDM | IEEE80211_CHAN_TURBO)
 148
 149 #define IEEE80211_CHAN_ALL \
 150         (IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_5GHZ | IEEE80211_CHAN_GFSK | \
 151          IEEE80211_CHAN_CCK | IEEE80211_CHAN_OFDM | IEEE80211_CHAN_DYN)
 152 #define IEEE80211_CHAN_ALLTURBO \
 153         (IEEE80211_CHAN_ALL | IEEE80211_CHAN_TURBO)
 154
 155 #define IEEE80211_IS_CHAN_FHSS(_c) \
 156         (((_c)->ic_flags & IEEE80211_CHAN_FHSS) == IEEE80211_CHAN_FHSS)
 157 #define IEEE80211_IS_CHAN_A(_c) \
 158         (((_c)->ic_flags & IEEE80211_CHAN_A) == IEEE80211_CHAN_A)
 159 #define IEEE80211_IS_CHAN_B(_c) \
 160         (((_c)->ic_flags & IEEE80211_CHAN_B) == IEEE80211_CHAN_B)
 161 #define IEEE80211_IS_CHAN_PUREG(_c) \
 162         (((_c)->ic_flags & IEEE80211_CHAN_PUREG) == IEEE80211_CHAN_PUREG)
 163 #define IEEE80211_IS_CHAN_G(_c) \
 164         (((_c)->ic_flags & IEEE80211_CHAN_G) == IEEE80211_CHAN_G)
 165 #define IEEE80211_IS_CHAN_ANYG(_c) \
 166         (IEEE80211_IS_CHAN_PUREG(_c) || IEEE80211_IS_CHAN_G(_c))
 167 #define IEEE80211_IS_CHAN_T(_c) \
 168         (((_c)->ic_flags & IEEE80211_CHAN_T) == IEEE80211_CHAN_T)
 169 #define IEEE80211_IS_CHAN_108G(_c) \
 170         (((_c)->ic_flags & IEEE80211_CHAN_108G) == IEEE80211_CHAN_108G)
 171
 172 #define IEEE80211_IS_CHAN_2GHZ(_c) \
 173         (((_c)->ic_flags & IEEE80211_CHAN_2GHZ) != 0)
 174 #define IEEE80211_IS_CHAN_5GHZ(_c) \
 175         (((_c)->ic_flags & IEEE80211_CHAN_5GHZ) != 0)
 176 #define IEEE80211_IS_CHAN_OFDM(_c) \
 177         (((_c)->ic_flags & IEEE80211_CHAN_OFDM) != 0)
 178 #define IEEE80211_IS_CHAN_CCK(_c) \
 179         (((_c)->ic_flags & IEEE80211_CHAN_CCK) != 0)
 180 #define IEEE80211_IS_CHAN_GFSK(_c) \
 181         (((_c)->ic_flags & IEEE80211_CHAN_GFSK) != 0)
 182 #define IEEE80211_IS_CHAN_HALF(_c) \
 183         (((_c)->ic_flags & IEEE80211_CHAN_HALF) != 0)
 184 #define IEEE80211_IS_CHAN_QUARTER(_c) \
 185         (((_c)->ic_flags & IEEE80211_CHAN_QUARTER) != 0)
 186 #define IEEE80211_IS_CHAN_FULL(_c) \
 187         (((_c)->ic_flags & (IEEE80211_CHAN_QUARTER | IEEE80211_CHAN_HALF)) == 0)
 188 #define IEEE80211_IS_CHAN_GSM(_c) \
 189         (((_c)->ic_flags & IEEE80211_CHAN_GSM) != 0)
 190 #define IEEE80211_IS_CHAN_PASSIVE(_c) \
 191         (((_c)->ic_flags & IEEE80211_CHAN_PASSIVE) != 0)
 192
 193 /* ni_chan encoding for FH phy */
 194 #define IEEE80211_FH_CHANMOD    80
 195 #define IEEE80211_FH_CHAN(set,pat)      (((set)-1)*IEEE80211_FH_CHANMOD+(pat))
 196 #define IEEE80211_FH_CHANSET(chan)      ((chan)/IEEE80211_FH_CHANMOD+1)
 197 #define IEEE80211_FH_CHANPAT(chan)      ((chan)%IEEE80211_FH_CHANMOD)
 198
 199 /*
 200  * 802.11 rate set.
 201  */
 202 #define IEEE80211_RATE_SIZE     8               /* 802.11 standard */
 203 #define IEEE80211_RATE_MAXSIZE  15              /* max rates we'll handle */
 204
 205 struct ieee80211_rateset {
 206         u_int8_t                rs_nrates;
 207         u_int8_t                rs_rates[IEEE80211_RATE_MAXSIZE];
 208 };
 209
 210 #endif /* _NET80211__IEEE80211_H_ */