2 * Copyright (c) 2001 Atsushi Onoe
3 * Copyright (c) 2002-2009 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_CAC = 4, /* doing channel availability check */
41 IEEE80211_S_RUN = 5, /* operational (e.g. associated) */
42 IEEE80211_S_CSA = 6, /* channel switch announce pending */
43 IEEE80211_S_SLEEP = 7, /* power save */
45 #define IEEE80211_S_MAX (IEEE80211_S_SLEEP+1)
47 #define IEEE80211_SEND_MGMT(_ni,_type,_arg) \
48 ((*(_ni)->ni_ic->ic_send_mgmt)(_ni, _type, _arg))
50 extern const char *ieee80211_mgt_subtype_name[];
51 extern const char *ieee80211_phymode_name[IEEE80211_MODE_MAX];
52 extern const int ieee80211_opcap[IEEE80211_OPMODE_MAX];
54 void ieee80211_proto_attach(struct ieee80211com *);
55 void ieee80211_proto_detach(struct ieee80211com *);
56 void ieee80211_proto_vattach(struct ieee80211vap *);
57 void ieee80211_proto_vdetach(struct ieee80211vap *);
59 void ieee80211_syncifflag_locked(struct ieee80211com *, int flag);
60 void ieee80211_syncflag(struct ieee80211vap *, int flag);
61 void ieee80211_syncflag_ext(struct ieee80211vap *, int flag);
63 #define ieee80211_input(ni, m, rssi, nf) \
64 ((ni)->ni_vap->iv_input(ni, m, rssi, nf))
65 int ieee80211_input_all(struct ieee80211com *, struct mbuf *, int, int);
66 struct ieee80211_bpf_params;
67 int ieee80211_mgmt_output(struct ieee80211_node *, struct mbuf *, int,
68 struct ieee80211_bpf_params *);
69 int ieee80211_raw_xmit(struct ieee80211_node *, struct mbuf *,
70 const struct ieee80211_bpf_params *);
71 int ieee80211_output(struct ifnet *, struct mbuf *,
72 struct sockaddr *, struct route *ro);
73 void ieee80211_start(struct ifnet *);
74 int ieee80211_send_nulldata(struct ieee80211_node *);
75 int ieee80211_classify(struct ieee80211_node *, struct mbuf *m);
76 struct mbuf *ieee80211_mbuf_adjust(struct ieee80211vap *, int,
77 struct ieee80211_key *, struct mbuf *);
78 struct mbuf *ieee80211_encap(struct ieee80211vap *, struct ieee80211_node *,
80 int ieee80211_send_mgmt(struct ieee80211_node *, int, int);
81 struct ieee80211_appie;
82 int ieee80211_send_probereq(struct ieee80211_node *ni,
83 const uint8_t sa[IEEE80211_ADDR_LEN],
84 const uint8_t da[IEEE80211_ADDR_LEN],
85 const uint8_t bssid[IEEE80211_ADDR_LEN],
86 const uint8_t *ssid, size_t ssidlen);
88 * The formation of ProbeResponse frames requires guidance to
89 * deal with legacy clients. When the client is identified as
90 * "legacy 11b" ieee80211_send_proberesp is passed this token.
92 #define IEEE80211_SEND_LEGACY_11B 0x1 /* legacy 11b client */
93 #define IEEE80211_SEND_LEGACY_11 0x2 /* other legacy client */
94 #define IEEE80211_SEND_LEGACY 0x3 /* any legacy client */
95 struct mbuf *ieee80211_alloc_proberesp(struct ieee80211_node *, int);
96 int ieee80211_send_proberesp(struct ieee80211vap *,
97 const uint8_t da[IEEE80211_ADDR_LEN], int);
98 struct mbuf *ieee80211_alloc_rts(struct ieee80211com *ic,
99 const uint8_t [IEEE80211_ADDR_LEN],
100 const uint8_t [IEEE80211_ADDR_LEN], uint16_t);
101 struct mbuf *ieee80211_alloc_cts(struct ieee80211com *,
102 const uint8_t [IEEE80211_ADDR_LEN], uint16_t);
104 void ieee80211_reset_erp(struct ieee80211com *);
105 void ieee80211_set_shortslottime(struct ieee80211com *, int onoff);
106 int ieee80211_iserp_rateset(const struct ieee80211_rateset *);
107 void ieee80211_setbasicrates(struct ieee80211_rateset *,
108 enum ieee80211_phymode);
109 void ieee80211_addbasicrates(struct ieee80211_rateset *,
110 enum ieee80211_phymode);
113 * Return the size of the 802.11 header for a management or data frame.
116 ieee80211_hdrsize(const void *data)
118 const struct ieee80211_frame *wh = data;
119 int size = sizeof(struct ieee80211_frame);
121 /* NB: we don't handle control frames */
122 KASSERT((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) != IEEE80211_FC0_TYPE_CTL,
123 ("%s: control frame", __func__));
124 if ((wh->i_fc[1] & IEEE80211_FC1_DIR_MASK) == IEEE80211_FC1_DIR_DSTODS)
125 size += IEEE80211_ADDR_LEN;
126 if (IEEE80211_QOS_HAS_SEQ(wh))
127 size += sizeof(uint16_t);
132 * Like ieee80211_hdrsize, but handles any type of frame.
135 ieee80211_anyhdrsize(const void *data)
137 const struct ieee80211_frame *wh = data;
139 if ((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) == IEEE80211_FC0_TYPE_CTL) {
140 switch (wh->i_fc[0] & IEEE80211_FC0_SUBTYPE_MASK) {
141 case IEEE80211_FC0_SUBTYPE_CTS:
142 case IEEE80211_FC0_SUBTYPE_ACK:
143 return sizeof(struct ieee80211_frame_ack);
144 case IEEE80211_FC0_SUBTYPE_BAR:
145 return sizeof(struct ieee80211_frame_bar);
147 return sizeof(struct ieee80211_frame_min);
149 return ieee80211_hdrsize(data);
153 * Template for an in-kernel authenticator. Authenticators
154 * register with the protocol code and are typically loaded
155 * as separate modules as needed. One special authenticator
156 * is xauth; it intercepts requests so that protocols like
157 * WPA can be handled in user space.
159 struct ieee80211_authenticator {
160 const char *ia_name; /* printable name */
161 int (*ia_attach)(struct ieee80211vap *);
162 void (*ia_detach)(struct ieee80211vap *);
163 void (*ia_node_join)(struct ieee80211_node *);
164 void (*ia_node_leave)(struct ieee80211_node *);
166 void ieee80211_authenticator_register(int type,
167 const struct ieee80211_authenticator *);
168 void ieee80211_authenticator_unregister(int type);
169 const struct ieee80211_authenticator *ieee80211_authenticator_get(int auth);
173 * Template for an MAC ACL policy module. Such modules
174 * register with the protocol code and are passed the sender's
175 * address of each received auth frame for validation.
177 struct ieee80211_aclator {
178 const char *iac_name; /* printable name */
179 int (*iac_attach)(struct ieee80211vap *);
180 void (*iac_detach)(struct ieee80211vap *);
181 int (*iac_check)(struct ieee80211vap *,
182 const uint8_t mac[IEEE80211_ADDR_LEN]);
183 int (*iac_add)(struct ieee80211vap *,
184 const uint8_t mac[IEEE80211_ADDR_LEN]);
185 int (*iac_remove)(struct ieee80211vap *,
186 const uint8_t mac[IEEE80211_ADDR_LEN]);
187 int (*iac_flush)(struct ieee80211vap *);
188 int (*iac_setpolicy)(struct ieee80211vap *, int);
189 int (*iac_getpolicy)(struct ieee80211vap *);
190 int (*iac_setioctl)(struct ieee80211vap *, struct ieee80211req *);
191 int (*iac_getioctl)(struct ieee80211vap *, struct ieee80211req *);
193 void ieee80211_aclator_register(const struct ieee80211_aclator *);
194 void ieee80211_aclator_unregister(const struct ieee80211_aclator *);
195 const struct ieee80211_aclator *ieee80211_aclator_get(const char *name);
197 /* flags for ieee80211_fix_rate() */
198 #define IEEE80211_F_DOSORT 0x00000001 /* sort rate list */
199 #define IEEE80211_F_DOFRATE 0x00000002 /* use fixed legacy rate */
200 #define IEEE80211_F_DONEGO 0x00000004 /* calc negotiated rate */
201 #define IEEE80211_F_DODEL 0x00000008 /* delete ignore rate */
202 #define IEEE80211_F_DOBRS 0x00000010 /* check basic rate set */
203 #define IEEE80211_F_JOIN 0x00000020 /* sta joining our bss */
204 #define IEEE80211_F_DOFMCS 0x00000040 /* use fixed HT rate */
205 int ieee80211_fix_rate(struct ieee80211_node *,
206 struct ieee80211_rateset *, int);
214 uint8_t wmep_logcwmin; /* log2(cwmin) */
215 uint8_t wmep_logcwmax; /* log2(cwmax) */
216 uint8_t wmep_txopLimit;
217 uint8_t wmep_noackPolicy; /* 0 (ack), 1 (no ack) */
219 #define IEEE80211_TXOP_TO_US(_txop) ((_txop)<<5)
220 #define IEEE80211_US_TO_TXOP(_us) ((_us)>>5)
222 struct chanAccParams {
223 uint8_t cap_info; /* version of the current set */
224 struct wmeParams cap_wmeParams[WME_NUM_AC];
227 struct ieee80211_wme_state {
229 #define WME_F_AGGRMODE 0x00000001 /* STATUS: WME agressive mode */
230 u_int wme_hipri_traffic; /* VI/VO frames in beacon interval */
231 u_int wme_hipri_switch_thresh;/* agressive mode switch thresh */
232 u_int wme_hipri_switch_hysteresis;/* agressive mode switch hysteresis */
234 struct wmeParams wme_params[4]; /* from assoc resp for each AC*/
235 struct chanAccParams wme_wmeChanParams; /* WME params applied to self */
236 struct chanAccParams wme_wmeBssChanParams;/* WME params bcast to stations */
237 struct chanAccParams wme_chanParams; /* params applied to self */
238 struct chanAccParams wme_bssChanParams; /* params bcast to stations */
240 int (*wme_update)(struct ieee80211com *);
243 void ieee80211_wme_initparams(struct ieee80211vap *);
244 void ieee80211_wme_updateparams(struct ieee80211vap *);
245 void ieee80211_wme_updateparams_locked(struct ieee80211vap *);
248 * Return the WME TID from a QoS frame. If no TID
249 * is present return the index for the "non-QoS" entry.
251 static __inline uint8_t
252 ieee80211_gettid(const struct ieee80211_frame *wh)
256 if (IEEE80211_QOS_HAS_SEQ(wh)) {
257 tid = ((const struct ieee80211_qosframe *)wh)->
258 i_qos[0] & IEEE80211_QOS_TID;
261 tid = IEEE80211_NONQOS_TID;
265 void ieee80211_waitfor_parent(struct ieee80211com *);
266 void ieee80211_start_locked(struct ieee80211vap *);
267 void ieee80211_init(void *);
268 void ieee80211_start_all(struct ieee80211com *);
269 void ieee80211_stop_locked(struct ieee80211vap *);
270 void ieee80211_stop(struct ieee80211vap *);
271 void ieee80211_stop_all(struct ieee80211com *);
272 void ieee80211_suspend_all(struct ieee80211com *);
273 void ieee80211_resume_all(struct ieee80211com *);
274 void ieee80211_dturbo_switch(struct ieee80211vap *, int newflags);
275 void ieee80211_swbmiss(void *arg);
276 void ieee80211_beacon_miss(struct ieee80211com *);
277 int ieee80211_new_state(struct ieee80211vap *, enum ieee80211_state, int);
278 void ieee80211_print_essid(const uint8_t *, int);
279 void ieee80211_dump_pkt(struct ieee80211com *,
280 const uint8_t *, int, int, int);
282 extern const char *ieee80211_opmode_name[];
283 extern const char *ieee80211_state_name[IEEE80211_S_MAX];
284 extern const char *ieee80211_wme_acnames[];
287 * Beacon frames constructed by ieee80211_beacon_alloc
288 * have the following structure filled in so drivers
289 * can update the frame later w/ minimal overhead.
291 struct ieee80211_beacon_offsets {
292 uint8_t bo_flags[4]; /* update/state flags */
293 uint16_t *bo_caps; /* capabilities */
294 uint8_t *bo_cfp; /* start of CFParms element */
295 uint8_t *bo_tim; /* start of atim/dtim */
296 uint8_t *bo_wme; /* start of WME parameters */
297 uint8_t *bo_tdma; /* start of TDMA parameters */
298 uint8_t *bo_tim_trailer;/* start of fixed-size trailer */
299 uint16_t bo_tim_len; /* atim/dtim length in bytes */
300 uint16_t bo_tim_trailer_len;/* tim trailer length in bytes */
301 uint8_t *bo_erp; /* start of ERP element */
302 uint8_t *bo_htinfo; /* start of HT info element */
303 uint8_t *bo_ath; /* start of ATH parameters */
304 uint8_t *bo_appie; /* start of AppIE element */
305 uint16_t bo_appie_len; /* AppIE length in bytes */
306 uint16_t bo_csa_trailer_len;;
307 uint8_t *bo_csa; /* start of CSA element */
308 uint8_t *bo_spare[4];
310 struct mbuf *ieee80211_beacon_alloc(struct ieee80211_node *,
311 struct ieee80211_beacon_offsets *);
314 * Beacon frame updates are signaled through calls to iv_update_beacon
315 * with one of the IEEE80211_BEACON_* tokens defined below. For devices
316 * that construct beacon frames on the host this can trigger a rebuild
317 * or defer the processing. For devices that offload beacon frame
318 * handling this callback can be used to signal a rebuild. The bo_flags
319 * array in the ieee80211_beacon_offsets structure is intended to record
320 * deferred processing requirements; ieee80211_beacon_update uses the
321 * state to optimize work. Since this structure is owned by the driver
322 * and not visible to the 802.11 layer drivers must supply an iv_update_beacon
323 * callback that marks the flag bits and schedules (as necessary) an update.
326 IEEE80211_BEACON_CAPS = 0, /* capabilities */
327 IEEE80211_BEACON_TIM = 1, /* DTIM/ATIM */
328 IEEE80211_BEACON_WME = 2,
329 IEEE80211_BEACON_ERP = 3, /* Extended Rate Phy */
330 IEEE80211_BEACON_HTINFO = 4, /* HT Information */
331 IEEE80211_BEACON_APPIE = 5, /* Application IE's */
332 IEEE80211_BEACON_CFP = 6, /* CFParms */
333 IEEE80211_BEACON_CSA = 7, /* Channel Switch Announcement */
334 IEEE80211_BEACON_TDMA = 9, /* TDMA Info */
335 IEEE80211_BEACON_ATH = 10, /* ATH parameters */
337 int ieee80211_beacon_update(struct ieee80211_node *,
338 struct ieee80211_beacon_offsets *, struct mbuf *, int mcast);
340 void ieee80211_csa_startswitch(struct ieee80211com *,
341 struct ieee80211_channel *, int mode, int count);
342 void ieee80211_csa_completeswitch(struct ieee80211com *);
343 void ieee80211_csa_cancelswitch(struct ieee80211com *);
344 void ieee80211_cac_completeswitch(struct ieee80211vap *);
347 * Notification methods called from the 802.11 state machine.
348 * Note that while these are defined here, their implementation
351 void ieee80211_notify_node_join(struct ieee80211_node *, int newassoc);
352 void ieee80211_notify_node_leave(struct ieee80211_node *);
353 void ieee80211_notify_scan_done(struct ieee80211vap *);
354 void ieee80211_notify_wds_discover(struct ieee80211_node *);
355 void ieee80211_notify_csa(struct ieee80211com *,
356 const struct ieee80211_channel *, int mode, int count);
357 void ieee80211_notify_radar(struct ieee80211com *,
358 const struct ieee80211_channel *);
359 enum ieee80211_notify_cac_event {
360 IEEE80211_NOTIFY_CAC_START = 0, /* CAC timer started */
361 IEEE80211_NOTIFY_CAC_STOP = 1, /* CAC intentionally stopped */
362 IEEE80211_NOTIFY_CAC_RADAR = 2, /* CAC stopped due to radar detectio */
363 IEEE80211_NOTIFY_CAC_EXPIRE = 3, /* CAC expired w/o radar */
365 void ieee80211_notify_cac(struct ieee80211com *,
366 const struct ieee80211_channel *,
367 enum ieee80211_notify_cac_event);
368 void ieee80211_notify_node_deauth(struct ieee80211_node *);
369 void ieee80211_notify_node_auth(struct ieee80211_node *);
370 void ieee80211_notify_country(struct ieee80211vap *, const uint8_t [],
371 const uint8_t cc[2]);
372 void ieee80211_notify_radio(struct ieee80211com *, int);
373 #endif /* _NET80211_IEEE80211_PROTO_H_ */