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