Home | History | Annotate | Line # | Download | only in net80211
ieee80211_var.h revision 1.5
      1 /*	$NetBSD: ieee80211_var.h,v 1.5 2003/12/14 09:56:53 dyoung Exp $	*/
      2 /*-
      3  * Copyright (c) 2001 Atsushi Onoe
      4  * Copyright (c) 2002, 2003 Sam Leffler, Errno Consulting
      5  * All rights reserved.
      6  *
      7  * Redistribution and use in source and binary forms, with or without
      8  * modification, are permitted provided that the following conditions
      9  * are met:
     10  * 1. Redistributions of source code must retain the above copyright
     11  *    notice, this list of conditions and the following disclaimer.
     12  * 2. Redistributions in binary form must reproduce the above copyright
     13  *    notice, this list of conditions and the following disclaimer in the
     14  *    documentation and/or other materials provided with the distribution.
     15  * 3. The name of the author may not be used to endorse or promote products
     16  *    derived from this software without specific prior written permission.
     17  *
     18  * Alternatively, this software may be distributed under the terms of the
     19  * GNU General Public License ("GPL") version 2 as published by the Free
     20  * Software Foundation.
     21  *
     22  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
     23  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
     24  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
     25  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
     26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
     27  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     28  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     29  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     30  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
     31  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     32  *
     33  * $FreeBSD: src/sys/net80211/ieee80211_var.h,v 1.10 2003/10/17 23:15:30 sam Exp $
     34  */
     35 #ifndef _NET80211_IEEE80211_VAR_H_
     36 #define _NET80211_IEEE80211_VAR_H_
     37 
     38 /*
     39  * Definitions for IEEE 802.11 drivers.
     40  */
     41 
     42 #include <net80211/ieee80211.h>
     43 #include <net80211/ieee80211_crypto.h>
     44 #include <net80211/ieee80211_ioctl.h>		/* for ieee80211_stats */
     45 #include <net80211/ieee80211_node.h>
     46 #include <net80211/ieee80211_proto.h>
     47 
     48 #define	IEEE80211_CHAN_MAX	255
     49 #define	IEEE80211_CHAN_ANY	0xffff		/* token for ``any channel'' */
     50 #define	IEEE80211_CHAN_ANYC \
     51 	((struct ieee80211_channel *) IEEE80211_CHAN_ANY)
     52 
     53 enum ieee80211_phytype {
     54 	IEEE80211_T_DS,			/* direct sequence spread spectrum */
     55 	IEEE80211_T_FH,			/* frequency hopping */
     56 	IEEE80211_T_OFDM,		/* frequency division multiplexing */
     57 	IEEE80211_T_TURBO,		/* high rate OFDM, aka turbo mode */
     58 };
     59 #define	IEEE80211_T_CCK	IEEE80211_T_DS	/* more common nomenclature */
     60 
     61 /* XXX not really a mode; there are really multiple PHY's */
     62 enum ieee80211_phymode {
     63 	IEEE80211_MODE_AUTO	= 0,	/* autoselect */
     64 	IEEE80211_MODE_11A	= 1,	/* 5GHz, OFDM */
     65 	IEEE80211_MODE_11B	= 2,	/* 2GHz, CCK */
     66 	IEEE80211_MODE_11G	= 3,	/* 2GHz, OFDM */
     67 	IEEE80211_MODE_FH	= 4,	/* 2GHz, GFSK */
     68 	IEEE80211_MODE_TURBO	= 5,	/* 5GHz, OFDM, 2x clock */
     69 };
     70 #define	IEEE80211_MODE_MAX	(IEEE80211_MODE_TURBO+1)
     71 
     72 enum ieee80211_opmode {
     73 	IEEE80211_M_STA		= 1,	/* infrastructure station */
     74 	IEEE80211_M_IBSS 	= 0,	/* IBSS (adhoc) station */
     75 	IEEE80211_M_AHDEMO	= 3,	/* Old lucent compatible adhoc demo */
     76 	IEEE80211_M_HOSTAP	= 6,	/* Software Access Point */
     77 	IEEE80211_M_MONITOR	= 8	/* Monitor mode */
     78 };
     79 
     80 /*
     81  * Channels are specified by frequency and attributes.
     82  */
     83 struct ieee80211_channel {
     84 	u_int16_t	ic_freq;	/* setting in Mhz */
     85 	u_int16_t	ic_flags;	/* see below */
     86 };
     87 
     88 /* bits 0-3 are for private use by drivers */
     89 /* channel attributes */
     90 #define	IEEE80211_CHAN_TURBO	0x0010	/* Turbo channel */
     91 #define	IEEE80211_CHAN_CCK	0x0020	/* CCK channel */
     92 #define	IEEE80211_CHAN_OFDM	0x0040	/* OFDM channel */
     93 #define	IEEE80211_CHAN_2GHZ	0x0080	/* 2 GHz spectrum channel. */
     94 #define	IEEE80211_CHAN_5GHZ	0x0100	/* 5 GHz spectrum channel */
     95 #define	IEEE80211_CHAN_PASSIVE	0x0200	/* Only passive scan allowed */
     96 #define	IEEE80211_CHAN_DYN	0x0400	/* Dynamic CCK-OFDM channel */
     97 #define	IEEE80211_CHAN_GFSK	0x0800	/* GFSK channel (FHSS PHY) */
     98 
     99 /*
    100  * Useful combinations of channel characteristics.
    101  */
    102 #define	IEEE80211_CHAN_FHSS \
    103 	(IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_GFSK)
    104 #define	IEEE80211_CHAN_A \
    105 	(IEEE80211_CHAN_5GHZ | IEEE80211_CHAN_OFDM)
    106 #define	IEEE80211_CHAN_B \
    107 	(IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_CCK)
    108 #define	IEEE80211_CHAN_PUREG \
    109 	(IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_OFDM)
    110 #define	IEEE80211_CHAN_G \
    111 	(IEEE80211_CHAN_2GHZ | IEEE80211_CHAN_DYN)
    112 #define	IEEE80211_CHAN_T \
    113 	(IEEE80211_CHAN_5GHZ | IEEE80211_CHAN_OFDM | IEEE80211_CHAN_TURBO)
    114 
    115 #define	IEEE80211_IS_CHAN_FHSS(_c) \
    116 	(((_c)->ic_flags & IEEE80211_CHAN_FHSS) == IEEE80211_CHAN_FHSS)
    117 #define	IEEE80211_IS_CHAN_A(_c) \
    118 	(((_c)->ic_flags & IEEE80211_CHAN_A) == IEEE80211_CHAN_A)
    119 #define	IEEE80211_IS_CHAN_B(_c) \
    120 	(((_c)->ic_flags & IEEE80211_CHAN_B) == IEEE80211_CHAN_B)
    121 #define	IEEE80211_IS_CHAN_PUREG(_c) \
    122 	(((_c)->ic_flags & IEEE80211_CHAN_PUREG) == IEEE80211_CHAN_PUREG)
    123 #define	IEEE80211_IS_CHAN_G(_c) \
    124 	(((_c)->ic_flags & IEEE80211_CHAN_G) == IEEE80211_CHAN_G)
    125 #define	IEEE80211_IS_CHAN_T(_c) \
    126 	(((_c)->ic_flags & IEEE80211_CHAN_T) == IEEE80211_CHAN_T)
    127 
    128 #define	IEEE80211_IS_CHAN_2GHZ(_c) \
    129 	(((_c)->ic_flags & IEEE80211_CHAN_2GHZ) != 0)
    130 #define	IEEE80211_IS_CHAN_5GHZ(_c) \
    131 	(((_c)->ic_flags & IEEE80211_CHAN_5GHZ) != 0)
    132 #define	IEEE80211_IS_CHAN_OFDM(_c) \
    133 	(((_c)->ic_flags & IEEE80211_CHAN_OFDM) != 0)
    134 #define	IEEE80211_IS_CHAN_CCK(_c) \
    135 	(((_c)->ic_flags & IEEE80211_CHAN_CCK) != 0)
    136 #define	IEEE80211_IS_CHAN_GFSK(_c) \
    137 	(((_c)->ic_flags & IEEE80211_CHAN_GFSK) != 0)
    138 
    139 /* ni_chan encoding for FH phy */
    140 #define	IEEE80211_FH_CHANMOD	80
    141 #define	IEEE80211_FH_CHAN(set,pat)	(((set)-1)*IEEE80211_FH_CHANMOD+(pat))
    142 #define	IEEE80211_FH_CHANSET(chan)	((chan)/IEEE80211_FH_CHANMOD+1)
    143 #define	IEEE80211_FH_CHANPAT(chan)	((chan)%IEEE80211_FH_CHANMOD)
    144 
    145 #define	IEEE80211_PS_SLEEP	0x1	/* STA is in power saving mode */
    146 
    147 #define	IEEE80211_PS_MAX_QUEUE	50	/* maximum saved packets */
    148 
    149 struct ieee80211com {
    150 #ifdef __NetBSD__
    151 	struct ethercom		ic_ec;
    152 #else
    153 	struct arpcom		ic_ac;
    154 #endif
    155 	void			(*ic_recv_mgmt)(struct ieee80211com *,
    156 				    struct mbuf *, struct ieee80211_node *,
    157 				    int, int, u_int32_t);
    158 	int			(*ic_send_mgmt)(struct ieee80211com *,
    159 				    struct ieee80211_node *, int, int);
    160 	int			(*ic_newstate)(struct ieee80211com *,
    161 				    enum ieee80211_state, int);
    162 	void			(*ic_newassoc)(struct ieee80211com *,
    163 				    struct ieee80211_node *, int);
    164 	int			(*ic_set_tim)(struct ieee80211com *, int, int);
    165 	u_int8_t		ic_myaddr[IEEE80211_ADDR_LEN];
    166 	struct ieee80211_rateset ic_sup_rates[IEEE80211_MODE_MAX];
    167 	struct ieee80211_channel ic_channels[IEEE80211_CHAN_MAX+1];
    168 	u_char			ic_chan_avail[roundup(IEEE80211_CHAN_MAX,NBBY)];
    169 	u_char			ic_chan_active[roundup(IEEE80211_CHAN_MAX, NBBY)];
    170 	u_char			ic_chan_scan[roundup(IEEE80211_CHAN_MAX,NBBY)];
    171 	struct ifqueue		ic_mgtq;
    172 	struct ifqueue		ic_pwrsaveq;
    173 	u_int32_t		ic_flags;	/* state flags */
    174 	u_int32_t		ic_caps;	/* capabilities */
    175 	u_int16_t		ic_modecaps;	/* set of mode capabilities */
    176 	u_int16_t		ic_curmode;	/* current mode */
    177 	enum ieee80211_phytype	ic_phytype;	/* XXX wrong for multi-mode */
    178 	enum ieee80211_opmode	ic_opmode;	/* operation mode */
    179 	enum ieee80211_state	ic_state;	/* 802.11 state */
    180 	u_int32_t		ic_aid_bitmap[IEEE80211_MAX_AID / 32 + 1];
    181 	u_int16_t		ic_max_aid;
    182 	struct ifmedia		ic_media;	/* interface media config */
    183 #ifdef __FreeBSD__
    184 	struct bpf_if		*ic_rawbpf;	/* packet filter structure */
    185 #else
    186 	caddr_t			ic_rawbpf;	/* packet filter structure */
    187 #endif
    188 	struct ieee80211_node	*ic_bss;	/* information for this node */
    189 	struct ieee80211_channel *ic_ibss_chan;
    190 	int			ic_fixed_rate;	/* index to ic_sup_rates[] */
    191 	u_int16_t		ic_rtsthreshold;
    192 	u_int16_t		ic_fragthreshold;
    193 #ifdef __FreeBSD__
    194 	struct mtx		ic_nodelock;	/* on node table */
    195 #endif
    196 	u_int			ic_scangen;	/* gen# for timeout scan */
    197 	struct ieee80211_node	*(*ic_node_alloc)(struct ieee80211com *);
    198 	void			(*ic_node_free)(struct ieee80211com *,
    199 					struct ieee80211_node *);
    200 	void			(*ic_node_copy)(struct ieee80211com *,
    201 					struct ieee80211_node *,
    202 					const struct ieee80211_node *);
    203 	u_int8_t		(*ic_node_getrssi)(struct ieee80211com *,
    204 					struct ieee80211_node *);
    205 	TAILQ_HEAD(, ieee80211_node) ic_node;	/* information of all nodes */
    206 	LIST_HEAD(, ieee80211_node) ic_hash[IEEE80211_NODE_HASHSIZE];
    207 	u_int16_t		ic_lintval;	/* listen interval */
    208 	u_int16_t		ic_holdover;	/* PM hold over duration */
    209 	u_int16_t		ic_txmin;	/* min tx retry count */
    210 	u_int16_t		ic_txmax;	/* max tx retry count */
    211 	u_int16_t		ic_txlifetime;	/* tx lifetime */
    212 	u_int16_t		ic_txpower;	/* tx power setting (dbM) */
    213 	u_int16_t		ic_bmisstimeout;/* beacon miss threshold (ms) */
    214 	int			ic_mgt_timer;	/* mgmt timeout */
    215 	int			ic_inact_timer;	/* inactivity timer wait */
    216 	int			ic_des_esslen;
    217 	u_int8_t		ic_des_essid[IEEE80211_NWID_LEN];
    218 	struct ieee80211_channel *ic_des_chan;	/* desired channel */
    219 	u_int8_t		ic_des_bssid[IEEE80211_ADDR_LEN];
    220 	struct ieee80211_wepkey	ic_nw_keys[IEEE80211_WEP_NKID];
    221 	int			ic_wep_txkey;	/* default tx key index */
    222 	void			*ic_wep_ctx;	/* wep crypt context */
    223 	u_int32_t		ic_iv;		/* initial vector for wep */
    224 	struct ieee80211_stats	ic_stats;	/* statistics */
    225 };
    226 #ifdef __NetBSD__
    227 #define	ic_if		ic_ec.ec_if
    228 #else
    229 #define	ic_if		ic_ac.ac_if
    230 #endif
    231 #define	ic_softc	ic_if.if_softc
    232 
    233 #define	IEEE80211_ADDR_EQ(a1,a2)	(memcmp(a1,a2,IEEE80211_ADDR_LEN) == 0)
    234 #define	IEEE80211_ADDR_COPY(dst,src)	memcpy(dst,src,IEEE80211_ADDR_LEN)
    235 
    236 /* ic_flags */
    237 #define	IEEE80211_F_ASCAN	0x00000001	/* STATUS: active scan */
    238 #define	IEEE80211_F_SIBSS	0x00000002	/* STATUS: start IBSS */
    239 #define	IEEE80211_F_WEPON	0x00000100	/* CONF: WEP enabled */
    240 #define	IEEE80211_F_IBSSON	0x00000200	/* CONF: IBSS creation enable */
    241 #define	IEEE80211_F_PMGTON	0x00000400	/* CONF: Power mgmt enable */
    242 #define	IEEE80211_F_DESBSSID	0x00000800	/* CONF: des_bssid is set */
    243 #define	IEEE80211_F_SCANAP	0x00001000	/* CONF: Scanning AP */
    244 #define	IEEE80211_F_ROAMING	0x00002000	/* CONF: roaming enabled */
    245 #define	IEEE80211_F_SWRETRY	0x00004000	/* CONF: sw tx retry enabled */
    246 #define	IEEE80211_F_TXPMGT	0x00018000	/* STATUS: tx power */
    247 #define IEEE80211_F_TXPOW_OFF	0x00000000	/* TX Power: radio disabled */
    248 #define IEEE80211_F_TXPOW_FIXED	0x00008000	/* TX Power: fixed rate */
    249 #define IEEE80211_F_TXPOW_AUTO	0x00010000	/* TX Power: undefined */
    250 #define	IEEE80211_F_SHSLOT	0x00020000	/* CONF: short slot time */
    251 #define	IEEE80211_F_SHPREAMBLE	0x00040000	/* CONF: short preamble */
    252 
    253 /* ic_caps */
    254 #define	IEEE80211_C_WEP		0x00000001	/* CAPABILITY: WEP available */
    255 #define	IEEE80211_C_IBSS	0x00000002	/* CAPABILITY: IBSS available */
    256 #define	IEEE80211_C_PMGT	0x00000004	/* CAPABILITY: Power mgmt */
    257 #define	IEEE80211_C_HOSTAP	0x00000008	/* CAPABILITY: HOSTAP avail */
    258 #define	IEEE80211_C_AHDEMO	0x00000010	/* CAPABILITY: Old Adhoc Demo */
    259 #define	IEEE80211_C_SWRETRY	0x00000020	/* CAPABILITY: sw tx retry */
    260 #define	IEEE80211_C_TXPMGT	0x00000040	/* CAPABILITY: tx power mgmt */
    261 #define	IEEE80211_C_SHSLOT	0x00000080	/* CAPABILITY: short slottime */
    262 #define	IEEE80211_C_SHPREAMBLE	0x00000100	/* CAPABILITY: short preamble */
    263 #define	IEEE80211_C_MONITOR	0x00000200	/* CAPABILITY: monitor mode */
    264 #define	IEEE80211_C_RCVMGT	0x00000400	/* CAPABILITY: rcv mgt frames */
    265 
    266 /* flags for ieee80211_fix_rate() */
    267 #define	IEEE80211_F_DOSORT	0x00000001	/* sort rate list */
    268 #define	IEEE80211_F_DOFRATE	0x00000002	/* use fixed rate */
    269 #define	IEEE80211_F_DONEGO	0x00000004	/* calc negotiated rate */
    270 #define	IEEE80211_F_DODEL	0x00000008	/* delete ignore rate */
    271 
    272 void	ieee80211_ifattach(struct ifnet *);
    273 void	ieee80211_ifdetach(struct ifnet *);
    274 void	ieee80211_media_init(struct ifnet *, ifm_change_cb_t, ifm_stat_cb_t);
    275 int	ieee80211_media_change(struct ifnet *);
    276 void	ieee80211_media_status(struct ifnet *, struct ifmediareq *);
    277 int	ieee80211_ioctl(struct ifnet *, u_long, caddr_t);
    278 int	ieee80211_get_rate(struct ieee80211com *);
    279 int	ieee80211_cfgget(struct ifnet *, u_long, caddr_t);
    280 int	ieee80211_cfgset(struct ifnet *, u_long, caddr_t);
    281 void	ieee80211_watchdog(struct ifnet *);
    282 int	ieee80211_fix_rate(struct ieee80211com *, struct ieee80211_node *, int);
    283 int	ieee80211_rate2media(struct ieee80211com *, int,
    284 		enum ieee80211_phymode);
    285 int	ieee80211_media2rate(int);
    286 u_int	ieee80211_mhz2ieee(u_int, u_int);
    287 u_int	ieee80211_chan2ieee(struct ieee80211com *, struct ieee80211_channel *);
    288 u_int	ieee80211_ieee2mhz(u_int, u_int);
    289 int	ieee80211_setmode(struct ieee80211com *, enum ieee80211_phymode);
    290 enum ieee80211_phymode ieee80211_chan2mode(struct ieee80211com *,
    291 		struct ieee80211_channel *);
    292 
    293 #ifdef IEEE80211_DEBUG
    294 extern	int ieee80211_debug;
    295 #define	IEEE80211_DPRINTF(X)	if (ieee80211_debug) printf X
    296 #define	IEEE80211_DPRINTF2(X)	if (ieee80211_debug>1) printf X
    297 #else
    298 #define	IEEE80211_DPRINTF(X)
    299 #define	IEEE80211_DPRINTF2(X)
    300 #endif
    301 
    302 #endif /* _NET80211_IEEE80211_VAR_H_ */
    303