2 * Copyright (c) 2001 Atsushi Onoe
3 * Copyright (c) 2002-2007 Sam Leffler, Errno Consulting
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
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.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 #ifndef _NET80211_IEEE80211_PROTO_H_
29 #define _NET80211_IEEE80211_PROTO_H_
32 * 802.11 protocol implementation definitions.
35 enum ieee80211_state {
36 IEEE80211_S_INIT = 0, /* default state */
37 IEEE80211_S_SCAN = 1, /* scanning */
38 IEEE80211_S_AUTH = 2, /* try to authenticate */
39 IEEE80211_S_ASSOC = 3, /* try to assoc */
40 IEEE80211_S_RUN = 4, /* associated */
42 #define IEEE80211_S_MAX (IEEE80211_S_RUN+1)
44 #define IEEE80211_SEND_MGMT(_ic,_ni,_type,_arg) \
45 ((*(_ic)->ic_send_mgmt)(_ic, _ni, _type, _arg))
47 extern const char *ieee80211_mgt_subtype_name[];
48 extern const char *ieee80211_phymode_name[];
50 void ieee80211_proto_attach(struct ieee80211com *);
51 void ieee80211_proto_detach(struct ieee80211com *);
53 struct ieee80211_node;
54 int ieee80211_input(struct ieee80211com *, struct mbuf *,
55 struct ieee80211_node *, int, int, uint32_t);
56 void ieee80211_deliver_data(struct ieee80211com *,
57 struct ieee80211_node *, struct mbuf *);
58 struct mbuf *ieee80211_decap1(struct mbuf *, int *);
59 int ieee80211_setup_rates(struct ieee80211_node *ni,
60 const uint8_t *rates, const uint8_t *xrates, int flags);
61 void ieee80211_saveie(uint8_t **, const uint8_t *);
62 void ieee80211_saveath(struct ieee80211_node *, uint8_t *);
63 void ieee80211_recv_mgmt(struct ieee80211com *, struct mbuf *,
64 struct ieee80211_node *, int, int, int, uint32_t);
65 int ieee80211_mgmt_output(struct ieee80211com *, struct ieee80211_node *,
66 struct mbuf *, int type);
67 struct ieee80211_bpf_params;
68 int ieee80211_raw_xmit(struct ieee80211_node *, struct mbuf *,
69 const struct ieee80211_bpf_params *);
70 int ieee80211_output(struct ifnet *, struct mbuf *,
71 struct sockaddr *, struct rtentry *);
72 int ieee80211_send_nulldata(struct ieee80211_node *);
73 int ieee80211_send_mgmt(struct ieee80211com *, struct ieee80211_node *,
75 int ieee80211_send_probereq(struct ieee80211_node *ni,
76 const uint8_t sa[IEEE80211_ADDR_LEN],
77 const uint8_t da[IEEE80211_ADDR_LEN],
78 const uint8_t bssid[IEEE80211_ADDR_LEN],
79 const uint8_t *ssid, size_t ssidlen,
80 const void *optie, size_t optielen);
81 int ieee80211_classify(struct ieee80211com *, struct mbuf *,
82 struct ieee80211_node *);
83 struct mbuf *ieee80211_encap(struct ieee80211com *, struct mbuf *,
84 struct ieee80211_node *);
86 void ieee80211_reset_erp(struct ieee80211com *);
87 void ieee80211_set_shortslottime(struct ieee80211com *, int onoff);
88 int ieee80211_iserp_rateset(struct ieee80211com *,
89 struct ieee80211_rateset *);
90 void ieee80211_set11gbasicrates(struct ieee80211_rateset *,
91 enum ieee80211_phymode);
94 * Return the size of the 802.11 header for a management or data frame.
97 ieee80211_hdrsize(const void *data)
99 const struct ieee80211_frame *wh = data;
100 int size = sizeof(struct ieee80211_frame);
102 /* NB: we don't handle control frames */
103 KASSERT((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) != IEEE80211_FC0_TYPE_CTL,
104 ("%s: control frame", __func__));
105 if ((wh->i_fc[1] & IEEE80211_FC1_DIR_MASK) == IEEE80211_FC1_DIR_DSTODS)
106 size += IEEE80211_ADDR_LEN;
107 if (IEEE80211_QOS_HAS_SEQ(wh))
108 size += sizeof(uint16_t);
113 * Like ieee80211_hdrsize, but handles any type of frame.
116 ieee80211_anyhdrsize(const void *data)
118 const struct ieee80211_frame *wh = data;
120 if ((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) == IEEE80211_FC0_TYPE_CTL) {
121 switch (wh->i_fc[0] & IEEE80211_FC0_SUBTYPE_MASK) {
122 case IEEE80211_FC0_SUBTYPE_CTS:
123 case IEEE80211_FC0_SUBTYPE_ACK:
124 return sizeof(struct ieee80211_frame_ack);
125 case IEEE80211_FC0_SUBTYPE_BAR:
126 return sizeof(struct ieee80211_frame_bar);
128 return sizeof(struct ieee80211_frame_min);
130 return ieee80211_hdrsize(data);
134 * Template for an in-kernel authenticator. Authenticators
135 * register with the protocol code and are typically loaded
136 * as separate modules as needed.
138 struct ieee80211_authenticator {
139 const char *ia_name; /* printable name */
140 int (*ia_attach)(struct ieee80211com *);
141 void (*ia_detach)(struct ieee80211com *);
142 void (*ia_node_join)(struct ieee80211com *,
143 struct ieee80211_node *);
144 void (*ia_node_leave)(struct ieee80211com *,
145 struct ieee80211_node *);
147 void ieee80211_authenticator_register(int type,
148 const struct ieee80211_authenticator *);
149 void ieee80211_authenticator_unregister(int type);
150 const struct ieee80211_authenticator *ieee80211_authenticator_get(int auth);
154 * Template for an MAC ACL policy module. Such modules
155 * register with the protocol code and are passed the sender's
156 * address of each received frame for validation.
158 struct ieee80211_aclator {
159 const char *iac_name; /* printable name */
160 int (*iac_attach)(struct ieee80211com *);
161 void (*iac_detach)(struct ieee80211com *);
162 int (*iac_check)(struct ieee80211com *,
163 const uint8_t mac[IEEE80211_ADDR_LEN]);
164 int (*iac_add)(struct ieee80211com *,
165 const uint8_t mac[IEEE80211_ADDR_LEN]);
166 int (*iac_remove)(struct ieee80211com *,
167 const uint8_t mac[IEEE80211_ADDR_LEN]);
168 int (*iac_flush)(struct ieee80211com *);
169 int (*iac_setpolicy)(struct ieee80211com *, int);
170 int (*iac_getpolicy)(struct ieee80211com *);
171 int (*iac_setioctl)(struct ieee80211com *, struct ieee80211req *);
172 int (*iac_getioctl)(struct ieee80211com *, struct ieee80211req *);
174 void ieee80211_aclator_register(const struct ieee80211_aclator *);
175 void ieee80211_aclator_unregister(const struct ieee80211_aclator *);
176 const struct ieee80211_aclator *ieee80211_aclator_get(const char *name);
178 /* flags for ieee80211_fix_rate() */
179 #define IEEE80211_F_DOSORT 0x00000001 /* sort rate list */
180 #define IEEE80211_F_DOFRATE 0x00000002 /* use fixed rate */
181 #define IEEE80211_F_DONEGO 0x00000004 /* calc negotiated rate */
182 #define IEEE80211_F_DODEL 0x00000008 /* delete ignore rate */
183 #define IEEE80211_F_DOBRS 0x00000010 /* check basic rate set */
184 #define IEEE80211_F_JOIN 0x00000020 /* sta joining our bss */
185 int ieee80211_fix_rate(struct ieee80211_node *,
186 struct ieee80211_rateset *, int);
194 uint8_t wmep_logcwmin; /* log2(cwmin) */
195 uint8_t wmep_logcwmax; /* log2(cwmax) */
196 uint8_t wmep_txopLimit;
197 uint8_t wmep_noackPolicy; /* 0 (ack), 1 (no ack) */
199 #define IEEE80211_TXOP_TO_US(_txop) ((_txop)<<5)
200 #define IEEE80211_US_TO_TXOP(_us) ((_us)>>5)
202 struct chanAccParams {
203 uint8_t cap_info; /* version of the current set */
204 struct wmeParams cap_wmeParams[WME_NUM_AC];
207 struct ieee80211_wme_state {
209 #define WME_F_AGGRMODE 0x00000001 /* STATUS: WME agressive mode */
210 u_int wme_hipri_traffic; /* VI/VO frames in beacon interval */
211 u_int wme_hipri_switch_thresh;/* agressive mode switch thresh */
212 u_int wme_hipri_switch_hysteresis;/* agressive mode switch hysteresis */
214 struct wmeParams wme_params[4]; /* from assoc resp for each AC*/
215 struct chanAccParams wme_wmeChanParams; /* WME params applied to self */
216 struct chanAccParams wme_wmeBssChanParams;/* WME params bcast to stations */
217 struct chanAccParams wme_chanParams; /* params applied to self */
218 struct chanAccParams wme_bssChanParams; /* params bcast to stations */
220 int (*wme_update)(struct ieee80211com *);
223 void ieee80211_wme_initparams(struct ieee80211com *);
224 void ieee80211_wme_updateparams(struct ieee80211com *);
225 void ieee80211_wme_updateparams_locked(struct ieee80211com *);
227 #define ieee80211_new_state(_ic, _nstate, _arg) \
228 (((_ic)->ic_newstate)((_ic), (_nstate), (_arg)))
229 int ieee80211_init(struct ieee80211com *, int forcescan);
230 void ieee80211_dturbo_switch(struct ieee80211com *, int newflags);
231 void ieee80211_beacon_miss(struct ieee80211com *);
232 void ieee80211_print_essid(const uint8_t *, int);
233 void ieee80211_dump_pkt(struct ieee80211com *,
234 const uint8_t *, int, int, int);
236 extern const char *ieee80211_opmode_name[];
237 extern const char *ieee80211_state_name[IEEE80211_S_MAX];
238 extern const char *ieee80211_wme_acnames[];
241 * Beacon frames constructed by ieee80211_beacon_alloc
242 * have the following structure filled in so drivers
243 * can update the frame later w/ minimal overhead.
245 struct ieee80211_beacon_offsets {
246 uint16_t *bo_caps; /* capabilities */
247 uint8_t *bo_tim; /* start of atim/dtim */
248 uint8_t *bo_wme; /* start of WME parameters */
249 uint8_t *bo_trailer; /* start of fixed-size trailer */
250 uint16_t bo_tim_len; /* atim/dtim length in bytes */
251 uint16_t bo_trailer_len; /* trailer length in bytes */
252 uint8_t *bo_erp; /* start of ERP element */
253 uint8_t *bo_htinfo; /* start of HT info element */
255 struct mbuf *ieee80211_beacon_alloc(struct ieee80211com *,
256 struct ieee80211_node *, struct ieee80211_beacon_offsets *);
257 int ieee80211_beacon_update(struct ieee80211com *,
258 struct ieee80211_node *, struct ieee80211_beacon_offsets *,
259 struct mbuf *, int broadcast);
262 * Notification methods called from the 802.11 state machine.
263 * Note that while these are defined here, their implementation
266 void ieee80211_notify_node_join(struct ieee80211com *,
267 struct ieee80211_node *, int newassoc);
268 void ieee80211_notify_node_leave(struct ieee80211com *,
269 struct ieee80211_node *);
270 void ieee80211_notify_scan_done(struct ieee80211com *);
271 #endif /* _NET80211_IEEE80211_PROTO_H_ */