Home | History | Annotate | Line # | Download | only in net80211
ieee80211_var.h revision 1.12
      1 /*	$NetBSD: ieee80211_var.h,v 1.12 2004/07/23 07:24:21 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.15 2004/04/05 22:10:26 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 #include <net80211/ieee80211_channel.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 /* ni_chan encoding for FH phy */
     94 #define	IEEE80211_FH_CHANMOD	80
     95 #define	IEEE80211_FH_CHAN(set,pat)	(((set)-1)*IEEE80211_FH_CHANMOD+(pat))
     96 #define	IEEE80211_FH_CHANSET(chan)	((chan)/IEEE80211_FH_CHANMOD+1)
     97 #define	IEEE80211_FH_CHANPAT(chan)	((chan)%IEEE80211_FH_CHANMOD)
     98 
     99 #define	IEEE80211_PS_SLEEP	0x1	/* STA is in power saving mode */
    100 
    101 #define	IEEE80211_PS_MAX_QUEUE	50	/* maximum saved packets */
    102 
    103 struct ieee80211com {
    104 #ifdef __NetBSD__
    105 	struct ethercom		ic_ec;
    106 #else
    107 	struct arpcom		ic_ac;
    108 #endif
    109 	LIST_ENTRY(ieee80211com) ic_list;	/* chain of all ieee80211com */
    110 	void			(*ic_recv_mgmt)(struct ieee80211com *,
    111 				    struct mbuf *, struct ieee80211_node *,
    112 				    int, int, u_int32_t);
    113 	int			(*ic_send_mgmt)(struct ieee80211com *,
    114 				    struct ieee80211_node *, int, int);
    115 	int			(*ic_newstate)(struct ieee80211com *,
    116 				    enum ieee80211_state, int);
    117 	void			(*ic_newassoc)(struct ieee80211com *,
    118 				    struct ieee80211_node *, int);
    119 	int			(*ic_set_tim)(struct ieee80211com *, int, int);
    120 	u_int8_t		ic_myaddr[IEEE80211_ADDR_LEN];
    121 	struct ieee80211_rateset ic_sup_rates[IEEE80211_MODE_MAX];
    122 	struct ieee80211_channel ic_channels[IEEE80211_CHAN_MAX+1];
    123 	u_char			ic_chan_avail[roundup(IEEE80211_CHAN_MAX,NBBY)];
    124 	u_char			ic_chan_active[roundup(IEEE80211_CHAN_MAX, NBBY)];
    125 	u_char			ic_chan_scan[roundup(IEEE80211_CHAN_MAX,NBBY)];
    126 	struct ifqueue		ic_mgtq;
    127 	struct ifqueue		ic_pwrsaveq;
    128 	u_int32_t		ic_flags;	/* state flags */
    129 	u_int32_t		ic_caps;	/* capabilities */
    130 	u_int16_t		ic_modecaps;	/* set of mode capabilities */
    131 	u_int16_t		ic_curmode;	/* current mode */
    132 	enum ieee80211_phytype	ic_phytype;	/* XXX wrong for multi-mode */
    133 	enum ieee80211_opmode	ic_opmode;	/* operation mode */
    134 	enum ieee80211_state	ic_state;	/* 802.11 state */
    135 	u_int32_t		ic_aid_bitmap[IEEE80211_AID_MAX / 32 + 1];
    136 	u_int16_t		ic_max_aid;
    137 	enum ieee80211_protmode	ic_protmode;	/* 802.11g protection mode */
    138 	struct ifmedia		ic_media;	/* interface media config */
    139 #ifdef __FreeBSD__
    140 	struct bpf_if		*ic_rawbpf;	/* packet filter structure */
    141 #else
    142 	caddr_t			ic_rawbpf;	/* packet filter structure */
    143 #endif
    144 	struct ieee80211_node	*ic_bss;	/* information for this node */
    145 	struct ieee80211_channel *ic_ibss_chan;
    146 	int			ic_fixed_rate;	/* index to ic_sup_rates[] */
    147 	u_int16_t		ic_rtsthreshold;
    148 	u_int16_t		ic_fragthreshold;
    149 #ifdef __FreeBSD__
    150 	struct mtx		ic_nodelock;	/* on node table */
    151 #endif
    152 	u_int			ic_scangen;	/* gen# for timeout scan */
    153 	struct ieee80211_node	*(*ic_node_alloc)(struct ieee80211com *);
    154 	void			(*ic_node_free)(struct ieee80211com *,
    155 					struct ieee80211_node *);
    156 	void			(*ic_node_copy)(struct ieee80211com *,
    157 					struct ieee80211_node *,
    158 					const struct ieee80211_node *);
    159 	u_int8_t		(*ic_node_getrssi)(struct ieee80211com *,
    160 					struct ieee80211_node *);
    161 	TAILQ_HEAD(, ieee80211_node) ic_node;	/* information of all nodes */
    162 	LIST_HEAD(, ieee80211_node) ic_hash[IEEE80211_NODE_HASHSIZE];
    163 	u_int16_t		ic_lintval;	/* listen interval */
    164 	u_int16_t		ic_holdover;	/* PM hold over duration */
    165 	u_int16_t		ic_txmin;	/* min tx retry count */
    166 	u_int16_t		ic_txmax;	/* max tx retry count */
    167 	u_int16_t		ic_txlifetime;	/* tx lifetime */
    168 	u_int16_t		ic_txpower;	/* tx power setting (dbM) */
    169 	u_int16_t		ic_bmisstimeout;/* beacon miss threshold (ms) */
    170 	int			ic_mgt_timer;	/* mgmt timeout */
    171 	int			ic_inact_timer;	/* inactivity timer wait */
    172 	int			ic_des_esslen;
    173 	u_int8_t		ic_des_essid[IEEE80211_NWID_LEN];
    174 	struct ieee80211_channel *ic_des_chan;	/* desired channel */
    175 	u_int8_t		ic_des_bssid[IEEE80211_ADDR_LEN];
    176 	struct ieee80211_wepkey	ic_nw_keys[IEEE80211_WEP_NKID];
    177 	int			ic_wep_txkey;	/* default tx key index */
    178 	void			*ic_wep_ctx;	/* wep crypt context */
    179 	u_int32_t		ic_iv;		/* initial vector for wep */
    180 	struct ieee80211_stats	ic_stats;	/* statistics */
    181 };
    182 #ifdef __NetBSD__
    183 #define	ic_if		ic_ec.ec_if
    184 #else
    185 #define	ic_if		ic_ac.ac_if
    186 #endif
    187 #define	ic_softc	ic_if.if_softc
    188 
    189 LIST_HEAD(ieee80211com_head, ieee80211com);
    190 
    191 extern struct ieee80211com_head ieee80211com_head;
    192 
    193 #define	IEEE80211_ADDR_EQ(a1,a2)	(memcmp(a1,a2,IEEE80211_ADDR_LEN) == 0)
    194 #define	IEEE80211_ADDR_COPY(dst,src)	memcpy(dst,src,IEEE80211_ADDR_LEN)
    195 
    196 /* ic_flags */
    197 #define	IEEE80211_F_ASCAN	0x00000001	/* STATUS: active scan */
    198 #define	IEEE80211_F_SIBSS	0x00000002	/* STATUS: start IBSS */
    199 #define	IEEE80211_F_WEPON	0x00000100	/* CONF: WEP enabled */
    200 #define	IEEE80211_F_IBSSON	0x00000200	/* CONF: IBSS creation enable */
    201 #define	IEEE80211_F_PMGTON	0x00000400	/* CONF: Power mgmt enable */
    202 #define	IEEE80211_F_DESBSSID	0x00000800	/* CONF: des_bssid is set */
    203 #define	IEEE80211_F_SCANAP	0x00001000	/* CONF: Scanning AP */
    204 #define	IEEE80211_F_ROAMING	0x00002000	/* CONF: roaming enabled */
    205 #define	IEEE80211_F_SWRETRY	0x00004000	/* CONF: sw tx retry enabled */
    206 #define	IEEE80211_F_TXPMGT	0x00018000	/* STATUS: tx power */
    207 #define IEEE80211_F_TXPOW_OFF	0x00000000	/* TX Power: radio disabled */
    208 #define IEEE80211_F_TXPOW_FIXED	0x00008000	/* TX Power: fixed rate */
    209 #define IEEE80211_F_TXPOW_AUTO	0x00010000	/* TX Power: undefined */
    210 #define	IEEE80211_F_SHSLOT	0x00020000	/* CONF: short slot time */
    211 #define	IEEE80211_F_SHPREAMBLE	0x00040000	/* CONF: short preamble */
    212 #define	IEEE80211_F_USEPROT	0x00100000	/* STATUS: protection enabled */
    213 #define	IEEE80211_F_USEBARKER	0x00200000	/* STATUS: use barker preamble*/
    214 
    215 /* ic_caps */
    216 #define	IEEE80211_C_WEP		0x00000001	/* CAPABILITY: WEP available */
    217 #define	IEEE80211_C_IBSS	0x00000002	/* CAPABILITY: IBSS available */
    218 #define	IEEE80211_C_PMGT	0x00000004	/* CAPABILITY: Power mgmt */
    219 #define	IEEE80211_C_HOSTAP	0x00000008	/* CAPABILITY: HOSTAP avail */
    220 #define	IEEE80211_C_AHDEMO	0x00000010	/* CAPABILITY: Old Adhoc Demo */
    221 #define	IEEE80211_C_SWRETRY	0x00000020	/* CAPABILITY: sw tx retry */
    222 #define	IEEE80211_C_TXPMGT	0x00000040	/* CAPABILITY: tx power mgmt */
    223 #define	IEEE80211_C_SHSLOT	0x00000080	/* CAPABILITY: short slottime */
    224 #define	IEEE80211_C_SHPREAMBLE	0x00000100	/* CAPABILITY: short preamble */
    225 #define	IEEE80211_C_MONITOR	0x00000200	/* CAPABILITY: monitor mode */
    226 
    227 /* flags for ieee80211_fix_rate() */
    228 #define	IEEE80211_F_DOSORT	0x00000001	/* sort rate list */
    229 #define	IEEE80211_F_DOFRATE	0x00000002	/* use fixed rate */
    230 #define	IEEE80211_F_DONEGO	0x00000004	/* calc negotiated rate */
    231 #define	IEEE80211_F_DODEL	0x00000008	/* delete ignore rate */
    232 
    233 void	ieee80211_ifattach(struct ifnet *);
    234 void	ieee80211_ifdetach(struct ifnet *);
    235 void	ieee80211_media_init(struct ifnet *, ifm_change_cb_t, ifm_stat_cb_t);
    236 int	ieee80211_media_change(struct ifnet *);
    237 void	ieee80211_media_status(struct ifnet *, struct ifmediareq *);
    238 int	ieee80211_ioctl(struct ifnet *, u_long, caddr_t);
    239 int	ieee80211_get_rate(struct ieee80211com *);
    240 int	ieee80211_cfgget(struct ifnet *, u_long, caddr_t);
    241 int	ieee80211_cfgset(struct ifnet *, u_long, caddr_t);
    242 void	ieee80211_watchdog(struct ifnet *);
    243 int	ieee80211_fix_rate(struct ieee80211com *, struct ieee80211_node *, int);
    244 int	ieee80211_rate2media(struct ieee80211com *, int,
    245 		enum ieee80211_phymode);
    246 int	ieee80211_media2rate(int);
    247 u_int	ieee80211_mhz2ieee(u_int, u_int);
    248 u_int	ieee80211_chan2ieee(struct ieee80211com *, struct ieee80211_channel *);
    249 u_int	ieee80211_ieee2mhz(u_int, u_int);
    250 int	ieee80211_setmode(struct ieee80211com *, enum ieee80211_phymode);
    251 enum ieee80211_phymode ieee80211_chan2mode(struct ieee80211com *,
    252 		struct ieee80211_channel *);
    253 
    254 #define	IEEE80211_MSG_DEBUG	0x40000000	/* IFF_DEBUG equivalent */
    255 #define	IEEE80211_MSG_DUMPPKTS	0x20000000	/* IFF_LINK2 equivalant */
    256 #define	IEEE80211_MSG_CRYPTO	0x10000000	/* crypto work */
    257 #define	IEEE80211_MSG_INPUT	0x08000000	/* input handling */
    258 #define	IEEE80211_MSG_XRATE	0x04000000	/* rate set handling */
    259 #define	IEEE80211_MSG_ELEMID	0x02000000	/* element id parsing */
    260 #define	IEEE80211_MSG_NODE	0x01000000	/* node handling */
    261 #define	IEEE80211_MSG_ASSOC	0x00800000	/* association handling */
    262 #define	IEEE80211_MSG_AUTH	0x00400000	/* authentication handling */
    263 #define	IEEE80211_MSG_SCAN	0x00200000	/* scanning */
    264 #define	IEEE80211_MSG_OUTPUT	0x00100000	/* output handling */
    265 #define	IEEE80211_MSG_STATE	0x00080000	/* state machine */
    266 #define	IEEE80211_MSG_POWER	0x00040000	/* power save handling */
    267 #define	IEEE80211_MSG_DOT1X	0x00020000	/* 802.1x authenticator */
    268 #define	IEEE80211_MSG_DOT1XSM	0x00010000	/* 802.1x state machine */
    269 #define	IEEE80211_MSG_RADIUS	0x00008000	/* 802.1x radius client */
    270 #define	IEEE80211_MSG_RADDUMP	0x00004000	/* dump 802.1x radius packets */
    271 #define	IEEE80211_MSG_RADKEYS	0x00002000	/* dump 802.1x keys */
    272 #define	IEEE80211_MSG_WPA	0x00001000	/* WPA/RSN protocol */
    273 #define	IEEE80211_MSG_ACL	0x00000800	/* ACL handling */
    274 
    275 #define	IEEE80211_MSG_ANY	0xffffffff	/* anything */
    276 
    277 #ifdef IEEE80211_DEBUG
    278 extern int ieee80211_debug;
    279 #define	IEEE80211_DPRINTF(_ic, _m, _args) do {		\
    280 	if (ieee80211_debug & (_m))			\
    281 		printf _args;				\
    282 } while (0)
    283 #define	ieee80211_msg_debug(_ic) \
    284 	(ieee80211_debug & IEEE80211_MSG_DEBUG)
    285 #define	ieee80211_msg_dumppkts(_ic) \
    286 	(ieee80211_debug & IEEE80211_MSG_DUMPPKTS)
    287 #define	ieee80211_msg_input(_ic) \
    288 	(ieee80211_debug & IEEE80211_MSG_INPUT)
    289 #define	ieee80211_msg_radius(_ic) \
    290 	(ieee80211_debug & IEEE80211_MSG_RADIUS)
    291 #define	ieee80211_msg_dumpradius(_ic) \
    292 	(ieee80211_debug & IEEE80211_MSG_RADDUMP)
    293 #define	ieee80211_msg_dumpradkeys(_ic) \
    294 	(ieee80211_debug & IEEE80211_MSG_RADKEYS)
    295 #define	ieee80211_msg_scan(_ic) \
    296 	(ieee80211_debug & IEEE80211_MSG_SCAN)
    297 #else
    298 #define	IEEE80211_DPRINTF(_ic, _fmt, ...)
    299 #endif
    300 
    301 extern	int ieee80211_inact_max;
    302 
    303 #endif /* _NET80211_IEEE80211_VAR_H_ */
    304