Home | History | Annotate | Line # | Download | only in net80211
ieee80211_var.h revision 1.1.1.4
      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_var.h,v 1.20 2005/01/24 19:39:07 sam Exp $
     33  */
     34 #ifndef _NET80211_IEEE80211_VAR_H_
     35 #define _NET80211_IEEE80211_VAR_H_
     36 
     37 /*
     38  * Definitions for IEEE 802.11 drivers.
     39  */
     40 #define	IEEE80211_DEBUG
     41 #undef	IEEE80211_DEBUG_REFCNT			/* node refcnt stuff */
     42 
     43 /* NB: portability glue must go first */
     44 #ifdef __NetBSD__
     45 #include <net80211/ieee80211_netbsd.h>
     46 #elif __FreeBSD__
     47 #include <net80211/ieee80211_freebsd.h>
     48 #elif __linux__
     49 #include <net80211/ieee80211_linux.h>
     50 #else
     51 #error	"No support for your operating system!"
     52 #endif
     53 
     54 #include <net80211/_ieee80211.h>
     55 #include <net80211/ieee80211.h>
     56 #include <net80211/ieee80211_crypto.h>
     57 #include <net80211/ieee80211_ioctl.h>		/* for ieee80211_stats */
     58 #include <net80211/ieee80211_node.h>
     59 #include <net80211/ieee80211_proto.h>
     60 
     61 #define	IEEE80211_TXPOWER_MAX	100	/* .5 dbM (XXX units?) */
     62 #define	IEEE80211_TXPOWER_MIN	0	/* kill radio */
     63 
     64 #define	IEEE80211_DTIM_MAX	15	/* max DTIM period */
     65 #define	IEEE80211_DTIM_MIN	1	/* min DTIM period */
     66 #define	IEEE80211_DTIM_DEFAULT	1	/* default DTIM period */
     67 
     68 #define	IEEE80211_BINTVAL_MAX	500	/* max beacon interval (TU's) */
     69 #define	IEEE80211_BINTVAL_MIN	25	/* min beacon interval (TU's) */
     70 #define	IEEE80211_BINTVAL_DEFAULT 100	/* default beacon interval (TU's) */
     71 
     72 #define	IEEE80211_PS_SLEEP	0x1	/* STA is in power saving mode */
     73 #define	IEEE80211_PS_MAX_QUEUE	50	/* maximum saved packets */
     74 
     75 #define	IEEE80211_MS_TO_TU(x)	(((x) * 1000) / 1024)
     76 #define	IEEE80211_TU_TO_MS(x)	(((x) * 1024) / 1000)
     77 
     78 struct ieee80211_aclator;
     79 struct sysctl_ctx_list;
     80 
     81 struct ieee80211com {
     82 	SLIST_ENTRY(ieee80211com) ic_next;
     83 	struct ifnet		*ic_ifp;	/* associated device */
     84 	struct ieee80211_stats	ic_stats;	/* statistics */
     85 	struct sysctl_ctx_list	*ic_sysctl;	/* dynamic sysctl context */
     86 	u_int32_t		ic_debug;	/* debug msg flags */
     87 	int			ic_vap;		/* virtual AP index */
     88 	ieee80211_beacon_lock_t	ic_beaconlock;	/* beacon update lock */
     89 
     90 	int			(*ic_reset)(struct ifnet *);
     91 	void			(*ic_recv_mgmt)(struct ieee80211com *,
     92 				    struct mbuf *, struct ieee80211_node *,
     93 				    int, int, u_int32_t);
     94 	int			(*ic_send_mgmt)(struct ieee80211com *,
     95 				    struct ieee80211_node *, int, int);
     96 	int			(*ic_newstate)(struct ieee80211com *,
     97 				    enum ieee80211_state, int);
     98 	void			(*ic_newassoc)(struct ieee80211com *,
     99 				    struct ieee80211_node *, int);
    100 	void			(*ic_updateslot)(struct ifnet *);
    101 	void			(*ic_set_tim)(struct ieee80211com *,
    102 				    struct ieee80211_node *, int);
    103 	u_int8_t		ic_myaddr[IEEE80211_ADDR_LEN];
    104 	struct ieee80211_rateset ic_sup_rates[IEEE80211_MODE_MAX];
    105 	struct ieee80211_channel ic_channels[IEEE80211_CHAN_MAX+1];
    106 	u_int8_t		ic_chan_avail[IEEE80211_CHAN_BYTES];
    107 	u_int8_t		ic_chan_active[IEEE80211_CHAN_BYTES];
    108 	u_int8_t		ic_chan_scan[IEEE80211_CHAN_BYTES];
    109 	struct ieee80211_node_table ic_scan;	/* scan candidates */
    110 	struct ifqueue		ic_mgtq;
    111 	u_int32_t		ic_flags;	/* state flags */
    112 	u_int32_t		ic_caps;	/* capabilities */
    113 	u_int16_t		ic_modecaps;	/* set of mode capabilities */
    114 	u_int16_t		ic_curmode;	/* current mode */
    115 	enum ieee80211_phytype	ic_phytype;	/* XXX wrong for multi-mode */
    116 	enum ieee80211_opmode	ic_opmode;	/* operation mode */
    117 	enum ieee80211_state	ic_state;	/* 802.11 state */
    118 	enum ieee80211_protmode	ic_protmode;	/* 802.11g protection mode */
    119 	enum ieee80211_roamingmode ic_roaming;	/* roaming mode */
    120 	struct ieee80211_node_table ic_sta;	/* stations/neighbors */
    121 	u_int32_t		*ic_aid_bitmap;	/* association id map */
    122 	u_int16_t		ic_max_aid;
    123 	u_int16_t		ic_sta_assoc;	/* stations associated */
    124 	u_int16_t		ic_ps_sta;	/* stations in power save */
    125 	u_int16_t		ic_ps_pending;	/* ps sta's w/ pending frames */
    126 	u_int8_t		*ic_tim_bitmap;	/* power-save stations w/ data*/
    127 	u_int16_t		ic_tim_len;	/* ic_tim_bitmap size (bytes) */
    128 	u_int16_t		ic_dtim_period;	/* DTIM period */
    129 	struct ifmedia		ic_media;	/* interface media config */
    130 	struct bpf_if		*ic_rawbpf;	/* packet filter structure */
    131 	struct ieee80211_node	*ic_bss;	/* information for this node */
    132 	struct ieee80211_channel *ic_ibss_chan;
    133 	int			ic_fixed_rate;	/* index to ic_sup_rates[] */
    134 	u_int16_t		ic_rtsthreshold;
    135 	u_int16_t		ic_fragthreshold;
    136 	struct ieee80211_node	*(*ic_node_alloc)(struct ieee80211_node_table*);
    137 	void			(*ic_node_free)(struct ieee80211_node *);
    138 	void			(*ic_node_cleanup)(struct ieee80211_node *);
    139 	u_int8_t		(*ic_node_getrssi)(const struct ieee80211_node*);
    140 	u_int16_t		ic_lintval;	/* listen interval */
    141 	u_int16_t		ic_holdover;	/* PM hold over duration */
    142 	u_int16_t		ic_txmin;	/* min tx retry count */
    143 	u_int16_t		ic_txmax;	/* max tx retry count */
    144 	u_int16_t		ic_txlifetime;	/* tx lifetime */
    145 	u_int16_t		ic_txpowlimit;	/* global tx power limit */
    146 	u_int16_t		ic_bmisstimeout;/* beacon miss threshold (ms) */
    147 	u_int16_t		ic_nonerpsta;	/* # non-ERP stations */
    148 	u_int16_t		ic_longslotsta;	/* # long slot time stations */
    149 	int			ic_mgt_timer;	/* mgmt timeout */
    150 	int			ic_inact_timer;	/* inactivity timer wait */
    151 	int			ic_des_esslen;
    152 	u_int8_t		ic_des_essid[IEEE80211_NWID_LEN];
    153 	struct ieee80211_channel *ic_des_chan;	/* desired channel */
    154 	u_int8_t		ic_des_bssid[IEEE80211_ADDR_LEN];
    155 	void			*ic_opt_ie;	/* user-specified IE's */
    156 	u_int16_t		ic_opt_ie_len;	/* length of ni_opt_ie */
    157 	/*
    158 	 * Inactivity timer settings for nodes.
    159 	 */
    160 	int			ic_inact_init;	/* initial setting */
    161 	int			ic_inact_auth;	/* auth but not assoc setting */
    162 	int			ic_inact_run;	/* authorized setting */
    163 	int			ic_inact_probe;	/* inactive probe time */
    164 
    165 	/*
    166 	 * WME/WMM state.
    167 	 */
    168 	struct ieee80211_wme_state ic_wme;
    169 
    170 	/*
    171 	 * Cipher state/configuration.
    172 	 */
    173 	struct ieee80211_crypto_state ic_crypto;
    174 #define	ic_nw_keys	ic_crypto.cs_nw_keys	/* XXX compatibility */
    175 #define	ic_def_txkey	ic_crypto.cs_def_txkey	/* XXX compatibility */
    176 
    177 	/*
    178 	 * 802.1x glue.  When an authenticator attaches it
    179 	 * fills in this section.  We assume that when ic_ec
    180 	 * is setup that the methods are safe to call.
    181 	 */
    182 	const struct ieee80211_authenticator *ic_auth;
    183 	struct eapolcom		*ic_ec;
    184 
    185 	/*
    186 	 * Access control glue.  When a control agent attaches
    187 	 * it fills in this section.  We assume that when ic_ac
    188 	 * is setup that the methods are safe to call.
    189 	 */
    190 	const struct ieee80211_aclator *ic_acl;
    191 	void			*ic_as;
    192 };
    193 
    194 #define	IEEE80211_ADDR_EQ(a1,a2)	(memcmp(a1,a2,IEEE80211_ADDR_LEN) == 0)
    195 #define	IEEE80211_ADDR_COPY(dst,src)	memcpy(dst,src,IEEE80211_ADDR_LEN)
    196 
    197 /* ic_flags */
    198 /* NB: bits 0x6f available */
    199 /* NB: this is intentionally setup to be IEEE80211_CAPINFO_PRIVACY */
    200 #define	IEEE80211_F_PRIVACY	0x00000010	/* CONF: privacy enabled */
    201 #define	IEEE80211_F_SCAN	0x00000080	/* STATUS: scanning */
    202 #define	IEEE80211_F_ASCAN	0x00000100	/* STATUS: active scan */
    203 #define	IEEE80211_F_SIBSS	0x00000200	/* STATUS: start IBSS */
    204 /* NB: this is intentionally setup to be IEEE80211_CAPINFO_SHORT_SLOTTIME */
    205 #define	IEEE80211_F_SHSLOT	0x00000400	/* STATUS: use short slot time*/
    206 #define	IEEE80211_F_PMGTON	0x00000800	/* CONF: Power mgmt enable */
    207 #define	IEEE80211_F_DESBSSID	0x00001000	/* CONF: des_bssid is set */
    208 #define	IEEE80211_F_WME		0x00002000	/* CONF: enable WME use */
    209 #define	IEEE80211_F_ROAMING	0x00004000	/* CONF: roaming enabled (???)*/
    210 #define	IEEE80211_F_SWRETRY	0x00008000	/* CONF: sw tx retry enabled */
    211 #define IEEE80211_F_TXPOW_FIXED	0x00010000	/* TX Power: fixed rate */
    212 #define	IEEE80211_F_IBSSON	0x00020000	/* CONF: IBSS creation enable */
    213 #define	IEEE80211_F_SHPREAMBLE	0x00040000	/* STATUS: use short preamble */
    214 #define	IEEE80211_F_DATAPAD	0x00080000	/* CONF: do alignment pad */
    215 #define	IEEE80211_F_USEPROT	0x00100000	/* STATUS: protection enabled */
    216 #define	IEEE80211_F_USEBARKER	0x00200000	/* STATUS: use barker preamble*/
    217 #define	IEEE80211_F_TIMUPDATE	0x00400000	/* STATUS: update beacon tim */
    218 #define	IEEE80211_F_WPA1	0x00800000	/* CONF: WPA enabled */
    219 #define	IEEE80211_F_WPA2	0x01000000	/* CONF: WPA2 enabled */
    220 #define	IEEE80211_F_WPA		0x01800000	/* CONF: WPA/WPA2 enabled */
    221 #define	IEEE80211_F_DROPUNENC	0x02000000	/* CONF: drop unencrypted */
    222 #define	IEEE80211_F_COUNTERM	0x04000000	/* CONF: TKIP countermeasures */
    223 #define	IEEE80211_F_HIDESSID	0x08000000	/* CONF: hide SSID in beacon */
    224 #define	IEEE80211_F_NOBRIDGE	0x10000000	/* CONF: dis. internal bridge */
    225 #define	IEEE80211_F_WMEUPDATE	0x20000000	/* STATUS: update beacon wme */
    226 
    227 /* ic_caps */
    228 #define	IEEE80211_C_WEP		0x00000001	/* CAPABILITY: WEP available */
    229 #define	IEEE80211_C_TKIP	0x00000002	/* CAPABILITY: TKIP available */
    230 #define	IEEE80211_C_AES		0x00000004	/* CAPABILITY: AES OCB avail */
    231 #define	IEEE80211_C_AES_CCM	0x00000008	/* CAPABILITY: AES CCM avail */
    232 #define	IEEE80211_C_CKIP	0x00000020	/* CAPABILITY: CKIP available */
    233 #define	IEEE80211_C_IBSS	0x00000100	/* CAPABILITY: IBSS available */
    234 #define	IEEE80211_C_PMGT	0x00000200	/* CAPABILITY: Power mgmt */
    235 #define	IEEE80211_C_HOSTAP	0x00000400	/* CAPABILITY: HOSTAP avail */
    236 #define	IEEE80211_C_AHDEMO	0x00000800	/* CAPABILITY: Old Adhoc Demo */
    237 #define	IEEE80211_C_SWRETRY	0x00001000	/* CAPABILITY: sw tx retry */
    238 #define	IEEE80211_C_TXPMGT	0x00002000	/* CAPABILITY: tx power mgmt */
    239 #define	IEEE80211_C_SHSLOT	0x00004000	/* CAPABILITY: short slottime */
    240 #define	IEEE80211_C_SHPREAMBLE	0x00008000	/* CAPABILITY: short preamble */
    241 #define	IEEE80211_C_MONITOR	0x00010000	/* CAPABILITY: monitor mode */
    242 #define	IEEE80211_C_TKIPMIC	0x00020000	/* CAPABILITY: TKIP MIC avail */
    243 #define	IEEE80211_C_WPA1	0x00800000	/* CAPABILITY: WPA1 avail */
    244 #define	IEEE80211_C_WPA2	0x01000000	/* CAPABILITY: WPA2 avail */
    245 #define	IEEE80211_C_WPA		0x01800000	/* CAPABILITY: WPA1+WPA2 avail*/
    246 #define	IEEE80211_C_BURST	0x02000000	/* CAPABILITY: frame bursting */
    247 #define	IEEE80211_C_WME		0x04000000	/* CAPABILITY: WME avail */
    248 /* XXX protection/barker? */
    249 
    250 #define	IEEE80211_C_CRYPTO	0x0000002f	/* CAPABILITY: crypto alg's */
    251 
    252 void	ieee80211_ifattach(struct ieee80211com *);
    253 void	ieee80211_ifdetach(struct ieee80211com *);
    254 void	ieee80211_announce(struct ieee80211com *);
    255 void	ieee80211_media_init(struct ieee80211com *,
    256 		ifm_change_cb_t, ifm_stat_cb_t);
    257 struct ieee80211com *ieee80211_find_vap(const u_int8_t mac[IEEE80211_ADDR_LEN]);
    258 int	ieee80211_media_change(struct ifnet *);
    259 void	ieee80211_media_status(struct ifnet *, struct ifmediareq *);
    260 int	ieee80211_ioctl(struct ieee80211com *, u_long, caddr_t);
    261 int	ieee80211_cfgget(struct ieee80211com *, u_long, caddr_t);
    262 int	ieee80211_cfgset(struct ieee80211com *, u_long, caddr_t);
    263 void	ieee80211_watchdog(struct ieee80211com *);
    264 int	ieee80211_rate2media(struct ieee80211com *, int,
    265 		enum ieee80211_phymode);
    266 int	ieee80211_media2rate(int);
    267 u_int	ieee80211_mhz2ieee(u_int, u_int);
    268 u_int	ieee80211_chan2ieee(struct ieee80211com *, struct ieee80211_channel *);
    269 u_int	ieee80211_ieee2mhz(u_int, u_int);
    270 int	ieee80211_setmode(struct ieee80211com *, enum ieee80211_phymode);
    271 enum ieee80211_phymode ieee80211_chan2mode(struct ieee80211com *,
    272 		struct ieee80211_channel *);
    273 
    274 /*
    275  * Key update synchronization methods.  XXX should not be visible.
    276  */
    277 static __inline void
    278 ieee80211_key_update_begin(struct ieee80211com *ic)
    279 {
    280 	ic->ic_crypto.cs_key_update_begin(ic);
    281 }
    282 static __inline void
    283 ieee80211_key_update_end(struct ieee80211com *ic)
    284 {
    285 	ic->ic_crypto.cs_key_update_end(ic);
    286 }
    287 
    288 /*
    289  * XXX these need to be here for IEEE80211_F_DATAPAD
    290  */
    291 
    292 /*
    293  * Return the space occupied by the 802.11 header and any
    294  * padding required by the driver.  This works for a
    295  * management or data frame.
    296  */
    297 static __inline int
    298 ieee80211_hdrspace(struct ieee80211com *ic, const void *data)
    299 {
    300 	int size = ieee80211_hdrsize(data);
    301 	if (ic->ic_flags & IEEE80211_F_DATAPAD)
    302 		size = roundup(size, sizeof(u_int32_t));
    303 	return size;
    304 }
    305 
    306 /*
    307  * Like ieee80211_hdrspace, but handles any type of frame.
    308  */
    309 static __inline int
    310 ieee80211_anyhdrspace(struct ieee80211com *ic, const void *data)
    311 {
    312 	int size = ieee80211_anyhdrsize(data);
    313 	if (ic->ic_flags & IEEE80211_F_DATAPAD)
    314 		size = roundup(size, sizeof(u_int32_t));
    315 	return size;
    316 }
    317 
    318 #define	IEEE80211_MSG_DEBUG	0x40000000	/* IFF_DEBUG equivalent */
    319 #define	IEEE80211_MSG_DUMPPKTS	0x20000000	/* IFF_LINK2 equivalant */
    320 #define	IEEE80211_MSG_CRYPTO	0x10000000	/* crypto work */
    321 #define	IEEE80211_MSG_INPUT	0x08000000	/* input handling */
    322 #define	IEEE80211_MSG_XRATE	0x04000000	/* rate set handling */
    323 #define	IEEE80211_MSG_ELEMID	0x02000000	/* element id parsing */
    324 #define	IEEE80211_MSG_NODE	0x01000000	/* node handling */
    325 #define	IEEE80211_MSG_ASSOC	0x00800000	/* association handling */
    326 #define	IEEE80211_MSG_AUTH	0x00400000	/* authentication handling */
    327 #define	IEEE80211_MSG_SCAN	0x00200000	/* scanning */
    328 #define	IEEE80211_MSG_OUTPUT	0x00100000	/* output handling */
    329 #define	IEEE80211_MSG_STATE	0x00080000	/* state machine */
    330 #define	IEEE80211_MSG_POWER	0x00040000	/* power save handling */
    331 #define	IEEE80211_MSG_DOT1X	0x00020000	/* 802.1x authenticator */
    332 #define	IEEE80211_MSG_DOT1XSM	0x00010000	/* 802.1x state machine */
    333 #define	IEEE80211_MSG_RADIUS	0x00008000	/* 802.1x radius client */
    334 #define	IEEE80211_MSG_RADDUMP	0x00004000	/* dump 802.1x radius packets */
    335 #define	IEEE80211_MSG_RADKEYS	0x00002000	/* dump 802.1x keys */
    336 #define	IEEE80211_MSG_WPA	0x00001000	/* WPA/RSN protocol */
    337 #define	IEEE80211_MSG_ACL	0x00000800	/* ACL handling */
    338 #define	IEEE80211_MSG_WME	0x00000400	/* WME protocol */
    339 
    340 #define	IEEE80211_MSG_ANY	0xffffffff	/* anything */
    341 
    342 #ifdef IEEE80211_DEBUG
    343 #define	IEEE80211_DPRINTF(_ic, _m, _fmt, ...) do {	\
    344 	if (_ic->ic_debug & (_m))			\
    345 		printf(_fmt, __VA_ARGS__);		\
    346 } while (0)
    347 #define	ieee80211_msg_debug(_ic) \
    348 	((_ic)->ic_debug & IEEE80211_MSG_DEBUG)
    349 #define	ieee80211_msg_dumppkts(_ic) \
    350 	((_ic)->ic_debug & IEEE80211_MSG_DUMPPKTS)
    351 #define	ieee80211_msg_input(_ic) \
    352 	((_ic)->ic_debug & IEEE80211_MSG_INPUT)
    353 #define	ieee80211_msg_radius(_ic) \
    354 	((_ic)->ic_debug & IEEE80211_MSG_RADIUS)
    355 #define	ieee80211_msg_dumpradius(_ic) \
    356 	((_ic)->ic_debug & IEEE80211_MSG_RADDUMP)
    357 #define	ieee80211_msg_dumpradkeys(_ic) \
    358 	((_ic)->ic_debug & IEEE80211_MSG_RADKEYS)
    359 #define	ieee80211_msg_scan(_ic) \
    360 	((_ic)->ic_debug & IEEE80211_MSG_SCAN)
    361 #else
    362 #define	IEEE80211_DPRINTF(_ic, _m, _fmt, ...)
    363 #endif
    364 
    365 #endif /* _NET80211_IEEE80211_VAR_H_ */
    366