sys/netproto/802_11/ieee80211_var.h

   1 /*
   2  * Copyright (c) 2001 Atsushi Onoe
   3  * Copyright (c) 2002, 2003 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_var.h,v 1.15 2004/04/05 22:10:26 sam Exp $
  33  * $DragonFly: src/sys/netproto/802_11/ieee80211_var.h,v 1.2 2005/01/26 00:37:40 joerg Exp $
  34  */
  35
  36 #ifndef _NETPROTO_802_11_IEEE80211_VAR_H_
  37 #define _NETPROTO_802_11_IEEE80211_VAR_H_
  38
  39 /*
  40  * Definitions for IEEE 802.11 drivers.
  41  */
  42
  43 #include <netproto/802_11/ieee80211.h>
  44 #include <netproto/802_11/ieee80211_crypto.h>
  45 #include <netproto/802_11/ieee80211_ioctl.h>            /* for ieee80211_stats */
  46 #include <netproto/802_11/ieee80211_node.h>
  47 #include <netproto/802_11/ieee80211_proto.h>
  48
  49 #define IEEE80211_CHAN_MAX      255
  50 #define IEEE80211_CHAN_ANY      0xffff          /* token for ``any channel'' */
  51 #define IEEE80211_CHAN_ANYC \
  52         ((struct ieee80211_channel *) IEEE80211_CHAN_ANY)
  53
  54 #define IEEE80211_TXPOWER_MAX   100     /* max power */
  55 #define IEEE80211_TXPOWER_MIN   0       /* kill radio (if possible) */
  56
  57 enum ieee80211_phytype {
  58         IEEE80211_T_DS,                 /* direct sequence spread spectrum */
  59         IEEE80211_T_FH,                 /* frequency hopping */
  60         IEEE80211_T_OFDM,               /* frequency division multiplexing */
  61         IEEE80211_T_TURBO,              /* high rate OFDM, aka turbo mode */
  62 };
  63 #define IEEE80211_T_CCK IEEE80211_T_DS  /* more common nomenclature */
  64
  65 /* XXX not really a mode; there are really multiple PHY's */
  66 enum ieee80211_phymode {
  67         IEEE80211_MODE_AUTO     = 0,    /* autoselect */
  68         IEEE80211_MODE_11A      = 1,    /* 5GHz, OFDM */
  69         IEEE80211_MODE_11B      = 2,    /* 2GHz, CCK */
  70         IEEE80211_MODE_11G      = 3,    /* 2GHz, OFDM */
  71         IEEE80211_MODE_FH       = 4,    /* 2GHz, GFSK */
  72         IEEE80211_MODE_TURBO    = 5,    /* 5GHz, OFDM, 2x clock */
  73 };
  74 #define IEEE80211_MODE_MAX      (IEEE80211_MODE_TURBO+1)
  75
  76 enum ieee80211_opmode {
  77         IEEE80211_M_STA         = 1,    /* infrastructure station */
  78         IEEE80211_M_IBSS        = 0,    /* IBSS (adhoc) station */
  79         IEEE80211_M_AHDEMO      = 3,    /* Old lucent compatible adhoc demo */
  80         IEEE80211_M_HOSTAP      = 6,    /* Software Access Point */
  81         IEEE80211_M_MONITOR     = 8     /* Monitor mode */
  82 };
  83
  84 /*
  85  * 802.11g protection mode.
  86  */
  87 enum ieee80211_protmode {
  88         IEEE80211_PROT_NONE     = 0,    /* no protection */
  89         IEEE80211_PROT_CTSONLY  = 1,    /* CTS to self */
  90         IEEE80211_PROT_RTSCTS   = 2,    /* RTS-CTS */
  91 };
  92
  93 /*
  94  * Channels are specified by frequency and attributes.
  95  */
  96 struct ieee80211_channel {
  97         uint16_t        ic_freq;        /* setting in Mhz */
  98         uint16_t        ic_flags;       /* see below */
  99 };
 100
 101 /* bits 0-3 are for private use by drivers */
 102 /* channel attributes */
 103 #define IEEE80211_CHAN_TURBO    0x0010  /* Turbo channel */
 104 #define IEEE80211_CHAN_CCK      0x0020  /* CCK channel */
 105 #define IEEE80211_CHAN_OFDM     0x0040  /* OFDM channel */
 106 #define IEEE80211_CHAN_2GHZ     0x0080  /* 2 GHz spectrum channel. */
 107 #define IEEE80211_CHAN_5GHZ     0x0100  /* 5 GHz spectrum channel */
 108 #define IEEE80211_CHAN_PASSIVE  0x0200  /* Only passive scan allowed */
 109 #define IEEE80211_CHAN_DYN      0x0400  /* Dynamic CCK-OFDM channel */
 110 #define IEEE80211_CHAN_GFSK     0x0800  /* GFSK channel (FHSS PHY) */
 111
 112 /*
 113  * Useful combinations of channel characteristics.
 114  */
 115 #define IEEE80211_CHAN_FHSS \
 116         (IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_GFSK)
 117 #define IEEE80211_CHAN_A \
 118         (IEEE80211_CHAN_5GHZ | IEEE80211_CHAN_OFDM)
 119 #define IEEE80211_CHAN_B \
 120         (IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_CCK)
 121 #define IEEE80211_CHAN_PUREG \
 122         (IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_OFDM)
 123 #define IEEE80211_CHAN_G \
 124         (IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_DYN)
 125 #define IEEE80211_CHAN_T \
 126         (IEEE80211_CHAN_5GHZ | IEEE80211_CHAN_OFDM | IEEE80211_CHAN_TURBO)
 127
 128 #define IEEE80211_IS_CHAN_FHSS(_c) \
 129         (((_c)->ic_flags & IEEE80211_CHAN_FHSS) == IEEE80211_CHAN_FHSS)
 130 #define IEEE80211_IS_CHAN_A(_c) \
 131         (((_c)->ic_flags & IEEE80211_CHAN_A) == IEEE80211_CHAN_A)
 132 #define IEEE80211_IS_CHAN_B(_c) \
 133         (((_c)->ic_flags & IEEE80211_CHAN_B) == IEEE80211_CHAN_B)
 134 #define IEEE80211_IS_CHAN_PUREG(_c) \
 135         (((_c)->ic_flags & IEEE80211_CHAN_PUREG) == IEEE80211_CHAN_PUREG)
 136 #define IEEE80211_IS_CHAN_G(_c) \
 137         (((_c)->ic_flags & IEEE80211_CHAN_G) == IEEE80211_CHAN_G)
 138 #define IEEE80211_IS_CHAN_T(_c) \
 139         (((_c)->ic_flags & IEEE80211_CHAN_T) == IEEE80211_CHAN_T)
 140
 141 #define IEEE80211_IS_CHAN_2GHZ(_c) \
 142         (((_c)->ic_flags & IEEE80211_CHAN_2GHZ) != 0)
 143 #define IEEE80211_IS_CHAN_5GHZ(_c) \
 144         (((_c)->ic_flags & IEEE80211_CHAN_5GHZ) != 0)
 145 #define IEEE80211_IS_CHAN_OFDM(_c) \
 146         (((_c)->ic_flags & IEEE80211_CHAN_OFDM) != 0)
 147 #define IEEE80211_IS_CHAN_CCK(_c) \
 148         (((_c)->ic_flags & IEEE80211_CHAN_CCK) != 0)
 149 #define IEEE80211_IS_CHAN_GFSK(_c) \
 150         (((_c)->ic_flags & IEEE80211_CHAN_GFSK) != 0)
 151
 152 /* ni_chan encoding for FH phy */
 153 #define IEEE80211_FH_CHANMOD    80
 154 #define IEEE80211_FH_CHAN(set,pat)      (((set)-1)*IEEE80211_FH_CHANMOD+(pat))
 155 #define IEEE80211_FH_CHANSET(chan)      ((chan)/IEEE80211_FH_CHANMOD+1)
 156 #define IEEE80211_FH_CHANPAT(chan)      ((chan)%IEEE80211_FH_CHANMOD)
 157
 158 struct ieee80211com {
 159         struct arpcom           ic_ac;
 160         void                    (*ic_recv_mgmt)(struct ieee80211com *,
 161                                     struct mbuf *, struct ieee80211_node *,
 162                                     int, int, uint32_t);
 163         int                     (*ic_send_mgmt)(struct ieee80211com *,
 164                                     struct ieee80211_node *, int, int);
 165         int                     (*ic_newstate)(struct ieee80211com *,
 166                                     enum ieee80211_state, int);
 167         void                    (*ic_newassoc)(struct ieee80211com *,
 168                                     struct ieee80211_node *, int);
 169         uint8_t                 ic_myaddr[IEEE80211_ADDR_LEN];
 170         struct ieee80211_rateset ic_sup_rates[IEEE80211_MODE_MAX];
 171         struct ieee80211_channel ic_channels[IEEE80211_CHAN_MAX+1];
 172         u_char                  ic_chan_avail[roundup(IEEE80211_CHAN_MAX,NBBY)];
 173         u_char                  ic_chan_active[roundup(IEEE80211_CHAN_MAX, NBBY)];
 174         u_char                  ic_chan_scan[roundup(IEEE80211_CHAN_MAX,NBBY)];
 175         struct ifqueue          ic_mgtq;
 176         uint32_t                ic_flags;       /* state flags */
 177         uint32_t                ic_caps;        /* capabilities */
 178         uint16_t                ic_modecaps;    /* set of mode capabilities */
 179         uint16_t                ic_curmode;     /* current mode */
 180         enum ieee80211_phytype  ic_phytype;     /* XXX wrong for multi-mode */
 181         enum ieee80211_opmode   ic_opmode;      /* operation mode */
 182         enum ieee80211_state    ic_state;       /* 802.11 state */
 183         enum ieee80211_protmode ic_protmode;    /* 802.11g protection mode */
 184         struct ifmedia          ic_media;       /* interface media config */
 185         struct bpf_if           *ic_rawbpf;     /* packet filter structure */
 186         struct ieee80211_node   *ic_bss;        /* information for this node */
 187         struct ieee80211_channel *ic_ibss_chan;
 188         int                     ic_fixed_rate;  /* index to ic_sup_rates[] */
 189         uint16_t                ic_rtsthreshold;
 190         uint16_t                ic_fragthreshold;
 191         struct lwkt_token       ic_nodetoken;   /* on node table */
 192         u_int                   ic_scangen;     /* gen# for timeout scan */
 193         struct ieee80211_node   *(*ic_node_alloc)(struct ieee80211com *);
 194         void                    (*ic_node_free)(struct ieee80211com *,
 195                                         struct ieee80211_node *);
 196         void                    (*ic_node_copy)(struct ieee80211com *,
 197                                         struct ieee80211_node *,
 198                                         const struct ieee80211_node *);
 199         uint8_t                 (*ic_node_getrssi)(struct ieee80211com *,
 200                                         struct ieee80211_node *);
 201         TAILQ_HEAD(, ieee80211_node) ic_node;   /* information of all nodes */
 202         LIST_HEAD(, ieee80211_node) ic_hash[IEEE80211_NODE_HASHSIZE];
 203         uint16_t                ic_lintval;     /* listen interval */
 204         uint16_t                ic_holdover;    /* PM hold over duration */
 205         uint16_t                ic_txmin;       /* min tx retry count */
 206         uint16_t                ic_txmax;       /* max tx retry count */
 207         uint16_t                ic_txlifetime;  /* tx lifetime */
 208         uint16_t                ic_txpower;     /* tx power setting (dbM) */
 209         uint16_t                ic_bmisstimeout;/* beacon miss threshold (ms) */
 210         int                     ic_mgt_timer;   /* mgmt timeout */
 211         int                     ic_inact_timer; /* inactivity timer wait */
 212         int                     ic_des_esslen;
 213         uint8_t                 ic_des_essid[IEEE80211_NWID_LEN];
 214         struct ieee80211_channel *ic_des_chan;  /* desired channel */
 215         uint8_t                 ic_des_bssid[IEEE80211_ADDR_LEN];
 216         struct ieee80211_wepkey ic_nw_keys[IEEE80211_WEP_NKID];
 217         int                     ic_wep_txkey;   /* default tx key index */
 218         void                    *ic_wep_ctx;    /* wep crypt context */
 219         uint32_t                ic_iv;          /* initial vector for wep */
 220         struct ieee80211_stats  ic_stats;       /* statistics */
 221 };
 222 #define ic_if           ic_ac.ac_if
 223 #define ic_softc        ic_if.if_softc
 224
 225 #define IEEE80211_ADDR_EQ(a1,a2)        (memcmp(a1,a2,IEEE80211_ADDR_LEN) == 0)
 226 #define IEEE80211_ADDR_COPY(dst,src)    memcpy(dst,src,IEEE80211_ADDR_LEN)
 227
 228 /* ic_flags */
 229 #define IEEE80211_F_ASCAN       0x00000001      /* STATUS: active scan */
 230 #define IEEE80211_F_SIBSS       0x00000002      /* STATUS: start IBSS */
 231 #define IEEE80211_F_WEPON       0x00000100      /* CONF: WEP enabled */
 232 #define IEEE80211_F_IBSSON      0x00000200      /* CONF: IBSS creation enable */
 233 #define IEEE80211_F_PMGTON      0x00000400      /* CONF: Power mgmt enable */
 234 #define IEEE80211_F_DESBSSID    0x00000800      /* CONF: des_bssid is set */
 235 #define IEEE80211_F_SCANAP      0x00001000      /* CONF: Scanning AP */
 236 #define IEEE80211_F_ROAMING     0x00002000      /* CONF: roaming enabled */
 237 #define IEEE80211_F_SWRETRY     0x00004000      /* CONF: sw tx retry enabled */
 238 #define IEEE80211_F_TXPMGT      0x00018000      /* STATUS: tx power */
 239 #define IEEE80211_F_TXPOW_OFF   0x00000000      /* TX Power: radio disabled */
 240 #define IEEE80211_F_TXPOW_FIXED 0x00008000      /* TX Power: fixed rate */
 241 #define IEEE80211_F_TXPOW_AUTO  0x00010000      /* TX Power: undefined */
 242 #define IEEE80211_F_SHSLOT      0x00020000      /* CONF: short slot time */
 243 #define IEEE80211_F_SHPREAMBLE  0x00040000      /* CONF: short preamble */
 244 #define IEEE80211_F_USEPROT     0x00100000      /* STATUS: protection enabled */
 245 #define IEEE80211_F_USEBARKER   0x00200000      /* STATUS: use barker preamble*/
 246
 247 /* ic_caps */
 248 #define IEEE80211_C_WEP         0x00000001      /* CAPABILITY: WEP available */
 249 #define IEEE80211_C_IBSS        0x00000002      /* CAPABILITY: IBSS available */
 250 #define IEEE80211_C_PMGT        0x00000004      /* CAPABILITY: Power mgmt */
 251 #define IEEE80211_C_HOSTAP      0x00000008      /* CAPABILITY: HOSTAP avail */
 252 #define IEEE80211_C_AHDEMO      0x00000010      /* CAPABILITY: Old Adhoc Demo */
 253 #define IEEE80211_C_SWRETRY     0x00000020      /* CAPABILITY: sw tx retry */
 254 #define IEEE80211_C_TXPMGT      0x00000040      /* CAPABILITY: tx power mgmt */
 255 #define IEEE80211_C_SHSLOT      0x00000080      /* CAPABILITY: short slottime */
 256 #define IEEE80211_C_SHPREAMBLE  0x00000100      /* CAPABILITY: short preamble */
 257 #define IEEE80211_C_MONITOR     0x00000200      /* CAPABILITY: monitor mode */
 258
 259 /* flags for ieee80211_fix_rate() */
 260 #define IEEE80211_F_DOSORT      0x00000001      /* sort rate list */
 261 #define IEEE80211_F_DOFRATE     0x00000002      /* use fixed rate */
 262 #define IEEE80211_F_DONEGO      0x00000004      /* calc negotiated rate */
 263 #define IEEE80211_F_DODEL       0x00000008      /* delete ignore rate */
 264
 265 void    ieee80211_ifattach(struct ifnet *);
 266 void    ieee80211_ifdetach(struct ifnet *);
 267 void    ieee80211_media_init(struct ifnet *, ifm_change_cb_t, ifm_stat_cb_t);
 268 int     ieee80211_media_change(struct ifnet *);
 269 void    ieee80211_media_status(struct ifnet *, struct ifmediareq *);
 270 int     ieee80211_ioctl(struct ifnet *, u_long, caddr_t, struct ucred *);
 271 int     ieee80211_cfgget(struct ifnet *, u_long, caddr_t, struct ucred *);
 272 int     ieee80211_cfgset(struct ifnet *, u_long, caddr_t);
 273 void    ieee80211_watchdog(struct ifnet *);
 274 int     ieee80211_fix_rate(struct ieee80211com *, struct ieee80211_node *, int);
 275 int     ieee80211_rate2media(struct ieee80211com *, int,
 276                 enum ieee80211_phymode);
 277 int     ieee80211_media2rate(int);
 278 u_int   ieee80211_mhz2ieee(u_int, u_int);
 279 u_int   ieee80211_chan2ieee(struct ieee80211com *, struct ieee80211_channel *);
 280 u_int   ieee80211_ieee2mhz(u_int, u_int);
 281 int     ieee80211_setmode(struct ieee80211com *, enum ieee80211_phymode);
 282 enum ieee80211_phymode ieee80211_chan2mode(struct ieee80211com *,
 283                 struct ieee80211_channel *);
 284
 285 #define IEEE80211_DEBUG
 286 #ifdef IEEE80211_DEBUG
 287 extern  int ieee80211_debug;
 288 #define IEEE80211_DPRINTF(X)    if (ieee80211_debug) printf X
 289 #define IEEE80211_DPRINTF2(X)   if (ieee80211_debug>1) printf X
 290 #else
 291 #define IEEE80211_DPRINTF(X)
 292 #define IEEE80211_DPRINTF2(X)
 293 #endif
 294
 295 #endif /* _NETPROTO_802_11_IEEE80211_VAR_H_ */