Home | History | Annotate | Line # | Download | only in net80211
ieee80211_proto.h revision 1.1.1.2
      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_proto.h,v 1.11 2005/04/04 04:27:20 sam Exp $
     33  */
     34 #ifndef _NET80211_IEEE80211_PROTO_H_
     35 #define _NET80211_IEEE80211_PROTO_H_
     36 
     37 /*
     38  * 802.11 protocol implementation definitions.
     39  */
     40 
     41 enum ieee80211_state {
     42 	IEEE80211_S_INIT	= 0,	/* default state */
     43 	IEEE80211_S_SCAN	= 1,	/* scanning */
     44 	IEEE80211_S_AUTH	= 2,	/* try to authenticate */
     45 	IEEE80211_S_ASSOC	= 3,	/* try to assoc */
     46 	IEEE80211_S_RUN		= 4,	/* associated */
     47 };
     48 #define	IEEE80211_S_MAX		(IEEE80211_S_RUN+1)
     49 
     50 #define	IEEE80211_SEND_MGMT(_ic,_ni,_type,_arg) \
     51 	((*(_ic)->ic_send_mgmt)(_ic, _ni, _type, _arg))
     52 
     53 extern	const char *ieee80211_mgt_subtype_name[];
     54 extern	const char *ieee80211_phymode_name[];
     55 
     56 void	ieee80211_proto_attach(struct ieee80211com *);
     57 void	ieee80211_proto_detach(struct ieee80211com *);
     58 
     59 struct ieee80211_node;
     60 int	ieee80211_input(struct ieee80211com *, struct mbuf *,
     61 		struct ieee80211_node *, int, u_int32_t);
     62 void	ieee80211_recv_mgmt(struct ieee80211com *, struct mbuf *,
     63 		struct ieee80211_node *, int, int, u_int32_t);
     64 int	ieee80211_send_nulldata(struct ieee80211com *, struct ieee80211_node *);
     65 int	ieee80211_send_mgmt(struct ieee80211com *, struct ieee80211_node *,
     66 		int, int);
     67 int	ieee80211_classify(struct ieee80211com *, struct mbuf *,
     68 		struct ieee80211_node *);
     69 struct mbuf *ieee80211_encap(struct ieee80211com *, struct mbuf *,
     70 		struct ieee80211_node *);
     71 void	ieee80211_pwrsave(struct ieee80211com *, struct ieee80211_node *,
     72 		struct mbuf *);
     73 
     74 void	ieee80211_reset_erp(struct ieee80211com *);
     75 void	ieee80211_set_shortslottime(struct ieee80211com *, int onoff);
     76 int	ieee80211_iserp_rateset(struct ieee80211com *,
     77 		struct ieee80211_rateset *);
     78 void	ieee80211_set11gbasicrates(struct ieee80211_rateset *,
     79 		enum ieee80211_phymode);
     80 
     81 /*
     82  * Return the size of the 802.11 header for a management or data frame.
     83  */
     84 static __inline int
     85 ieee80211_hdrsize(const void *data)
     86 {
     87 	const struct ieee80211_frame *wh = data;
     88 	int size = sizeof(struct ieee80211_frame);
     89 
     90 	/* NB: we don't handle control frames */
     91 	KASSERT((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) != IEEE80211_FC0_TYPE_CTL,
     92 		("%s: control frame", __func__));
     93 	if ((wh->i_fc[1] & IEEE80211_FC1_DIR_MASK) == IEEE80211_FC1_DIR_DSTODS)
     94 		size += IEEE80211_ADDR_LEN;
     95 	if (IEEE80211_QOS_HAS_SEQ(wh))
     96 		size += sizeof(u_int16_t);
     97 	return size;
     98 }
     99 
    100 /*
    101  * Return the size of the 802.11 header; handles any type of frame.
    102  */
    103 static __inline int
    104 ieee80211_anyhdrsize(const void *data)
    105 {
    106 	const struct ieee80211_frame *wh = data;
    107 
    108 	if ((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) == IEEE80211_FC0_TYPE_CTL) {
    109 		switch (wh->i_fc[0] & IEEE80211_FC0_SUBTYPE_MASK) {
    110 		case IEEE80211_FC0_SUBTYPE_CTS:
    111 		case IEEE80211_FC0_SUBTYPE_ACK:
    112 			return sizeof(struct ieee80211_frame_ack);
    113 		}
    114 		return sizeof(struct ieee80211_frame_min);
    115 	} else
    116 		return ieee80211_hdrsize(data);
    117 }
    118 
    119 /*
    120  * Template for an in-kernel authenticator.  Authenticators
    121  * register with the protocol code and are typically loaded
    122  * as separate modules as needed.
    123  */
    124 struct ieee80211_authenticator {
    125 	const char *ia_name;		/* printable name */
    126 	int	(*ia_attach)(struct ieee80211com *);
    127 	void	(*ia_detach)(struct ieee80211com *);
    128 	void	(*ia_node_join)(struct ieee80211com *,
    129 				struct ieee80211_node *);
    130 	void	(*ia_node_leave)(struct ieee80211com *,
    131 				struct ieee80211_node *);
    132 };
    133 void	ieee80211_authenticator_register(int type,
    134 		const struct ieee80211_authenticator *);
    135 void	ieee80211_authenticator_unregister(int type);
    136 const struct ieee80211_authenticator *ieee80211_authenticator_get(int auth);
    137 
    138 /*
    139  * Template for an MAC ACL policy module.  Such modules
    140  * register with the protocol code and are passed the sender's
    141  * address of each received frame for validation.
    142  */
    143 struct ieee80211_aclator {
    144 	const char *iac_name;		/* printable name */
    145 	int	(*iac_attach)(struct ieee80211com *);
    146 	void	(*iac_detach)(struct ieee80211com *);
    147 	int	(*iac_check)(struct ieee80211com *,
    148 			const u_int8_t mac[IEEE80211_ADDR_LEN]);
    149 	int	(*iac_add)(struct ieee80211com *,
    150 			const u_int8_t mac[IEEE80211_ADDR_LEN]);
    151 	int	(*iac_remove)(struct ieee80211com *,
    152 			const u_int8_t mac[IEEE80211_ADDR_LEN]);
    153 	int	(*iac_flush)(struct ieee80211com *);
    154 	int	(*iac_setpolicy)(struct ieee80211com *, int);
    155 	int	(*iac_getpolicy)(struct ieee80211com *);
    156 };
    157 void	ieee80211_aclator_register(const struct ieee80211_aclator *);
    158 void	ieee80211_aclator_unregister(const struct ieee80211_aclator *);
    159 const struct ieee80211_aclator *ieee80211_aclator_get(const char *name);
    160 
    161 /* flags for ieee80211_fix_rate() */
    162 #define	IEEE80211_F_DOSORT	0x00000001	/* sort rate list */
    163 #define	IEEE80211_F_DOFRATE	0x00000002	/* use fixed rate */
    164 #define	IEEE80211_F_DONEGO	0x00000004	/* calc negotiated rate */
    165 #define	IEEE80211_F_DODEL	0x00000008	/* delete ignore rate */
    166 int	ieee80211_fix_rate(struct ieee80211com *, struct ieee80211_node *, int);
    167 
    168 /*
    169  * WME/WMM support.
    170  */
    171 struct wmeParams {
    172 	u_int8_t	wmep_acm;
    173 	u_int8_t	wmep_aifsn;
    174 	u_int8_t	wmep_logcwmin;		/* log2(cwmin) */
    175 	u_int8_t	wmep_logcwmax;		/* log2(cwmax) */
    176 	u_int8_t	wmep_txopLimit;
    177 	u_int8_t	wmep_noackPolicy;	/* 0 (ack), 1 (no ack) */
    178 };
    179 #define	IEEE80211_TXOP_TO_US(_txop)	((_txop)<<5)
    180 #define	IEEE80211_US_TO_TXOP(_us)	((_us)>>5)
    181 
    182 struct chanAccParams {
    183 	u_int8_t	cap_info;		/* version of the current set */
    184 	struct wmeParams cap_wmeParams[WME_NUM_AC];
    185 };
    186 
    187 struct ieee80211_wme_state {
    188 	u_int	wme_flags;
    189 #define	WME_F_AGGRMODE	0x00000001	/* STATUS: WME agressive mode */
    190 	u_int	wme_hipri_traffic;	/* VI/VO frames in beacon interval */
    191 	u_int	wme_hipri_switch_thresh;/* agressive mode switch thresh */
    192 	u_int	wme_hipri_switch_hysteresis;/* agressive mode switch hysteresis */
    193 
    194 	struct wmeParams wme_params[4];		/* from assoc resp for each AC*/
    195 	struct chanAccParams wme_wmeChanParams;	/* WME params applied to self */
    196 	struct chanAccParams wme_wmeBssChanParams;/* WME params bcast to stations */
    197 	struct chanAccParams wme_chanParams;	/* params applied to self */
    198 	struct chanAccParams wme_bssChanParams;	/* params bcast to stations */
    199 
    200 	int	(*wme_update)(struct ieee80211com *);
    201 };
    202 
    203 void	ieee80211_wme_initparams(struct ieee80211com *);
    204 void	ieee80211_wme_updateparams(struct ieee80211com *);
    205 void	ieee80211_wme_updateparams_locked(struct ieee80211com *);
    206 
    207 #define	ieee80211_new_state(_ic, _nstate, _arg) \
    208 	(((_ic)->ic_newstate)((_ic), (_nstate), (_arg)))
    209 void	ieee80211_print_essid(const u_int8_t *, int);
    210 void	ieee80211_dump_pkt(const u_int8_t *, int, int, int);
    211 
    212 extern	const char *ieee80211_state_name[IEEE80211_S_MAX];
    213 extern	const char *ieee80211_wme_acnames[];
    214 
    215 /*
    216  * Beacon frames constructed by ieee80211_beacon_alloc
    217  * have the following structure filled in so drivers
    218  * can update the frame later w/ minimal overhead.
    219  */
    220 struct ieee80211_beacon_offsets {
    221 	u_int16_t	*bo_caps;	/* capabilities */
    222 	u_int8_t	*bo_tim;	/* start of atim/dtim */
    223 	u_int8_t	*bo_wme;	/* start of WME parameters */
    224 	u_int8_t	*bo_trailer;	/* start of fixed-size trailer */
    225 	u_int16_t	bo_tim_len;	/* atim/dtim length in bytes */
    226 	u_int16_t	bo_trailer_len;	/* trailer length in bytes */
    227 };
    228 struct mbuf *ieee80211_beacon_alloc(struct ieee80211com *,
    229 		struct ieee80211_node *, struct ieee80211_beacon_offsets *);
    230 int	ieee80211_beacon_update(struct ieee80211com *,
    231 		struct ieee80211_node *, struct ieee80211_beacon_offsets *,
    232 		struct mbuf *, int broadcast);
    233 
    234 /*
    235  * Notification methods called from the 802.11 state machine.
    236  * Note that while these are defined here, their implementation
    237  * is OS-specific.
    238  */
    239 void	ieee80211_notify_node_join(struct ieee80211com *,
    240 		struct ieee80211_node *, int newassoc);
    241 void	ieee80211_notify_node_leave(struct ieee80211com *,
    242 		struct ieee80211_node *);
    243 void	ieee80211_notify_scan_done(struct ieee80211com *);
    244 #endif /* _NET80211_IEEE80211_PROTO_H_ */
    245