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