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_ht(struct ieee80211vap *, int flag);
62 void ieee80211_syncflag_ext(struct ieee80211vap *, int flag);
64 #define IEEE80211_R_NF 0x0000001 /* global NF value valid */
65 #define IEEE80211_R_RSSI 0x0000002 /* global RSSI value valid */
66 #define IEEE80211_R_C_CHAIN 0x0000004 /* RX chain count valid */
67 #define IEEE80211_R_C_NF 0x0000008 /* per-chain NF value valid */
68 #define IEEE80211_R_C_RSSI 0x0000010 /* per-chain RSSI value valid */
69 #define IEEE80211_R_C_EVM 0x0000020 /* per-chain EVM valid */
70 #define IEEE80211_R_C_HT40 0x0000040 /* RX'ed packet is 40mhz, pilots 4,5 valid */
72 struct ieee80211_rx_stats {
73 uint32_t r_flags; /* IEEE80211_R_* flags */
74 uint8_t c_chain; /* number of RX chains involved */
75 int16_t c_nf_ctl[IEEE80211_MAX_CHAINS]; /* per-chain NF */
76 int16_t c_nf_ext[IEEE80211_MAX_CHAINS]; /* per-chain NF */
77 int16_t c_rssi_ctl[IEEE80211_MAX_CHAINS]; /* per-chain RSSI */
78 int16_t c_rssi_ext[IEEE80211_MAX_CHAINS]; /* per-chain RSSI */
79 uint8_t nf; /* global NF */
80 uint8_t rssi; /* global RSSI */
81 uint8_t evm[IEEE80211_MAX_CHAINS][IEEE80211_MAX_EVM_PILOTS];
82 /* per-chain, per-pilot EVM values */
85 #if defined(__DragonFly__)
89 #define ieee80211_input(ni, m, rssi, nf) \
90 ((ni)->ni_vap->iv_input(ni, m, rssi, nf))
91 int ieee80211_input_all(struct ieee80211com *, struct mbuf *, int, int);
93 int ieee80211_input_mimo(struct ieee80211_node *, struct mbuf *,
94 struct ieee80211_rx_stats *);
95 int ieee80211_input_mimo_all(struct ieee80211com *, struct mbuf *,
96 struct ieee80211_rx_stats *);
98 struct ieee80211_bpf_params;
99 int ieee80211_mgmt_output(struct ieee80211_node *, struct mbuf *, int,
100 struct ieee80211_bpf_params *);
101 int ieee80211_raw_xmit(struct ieee80211_node *, struct mbuf *,
102 const struct ieee80211_bpf_params *);
103 #if defined(__DragonFly__)
104 int ieee80211_output(struct ifnet *, struct mbuf *,
105 struct sockaddr *, struct rtentry *rt);
106 #elif __FreeBSD_version >= 1000031
107 int ieee80211_output(struct ifnet *, struct mbuf *,
108 const struct sockaddr *, struct route *ro);
110 int ieee80211_output(struct ifnet *, struct mbuf *,
111 struct sockaddr *, struct route *ro);
113 int ieee80211_vap_pkt_send_dest(struct ieee80211vap *, struct mbuf *,
114 struct ieee80211_node *);
115 int ieee80211_raw_output(struct ieee80211vap *, struct ieee80211_node *,
116 struct mbuf *, const struct ieee80211_bpf_params *);
117 void ieee80211_send_setup(struct ieee80211_node *, struct mbuf *, int, int,
118 const uint8_t [IEEE80211_ADDR_LEN], const uint8_t [IEEE80211_ADDR_LEN],
119 const uint8_t [IEEE80211_ADDR_LEN]);
120 void ieee80211_vap_start(struct ifnet *ifp, struct ifaltq_subque *ifsq);
121 int ieee80211_vap_transmit(struct ifnet *ifp, struct mbuf *m);
122 void ieee80211_vap_qflush(struct ifnet *ifp);
123 int ieee80211_send_nulldata(struct ieee80211_node *);
124 int ieee80211_classify(struct ieee80211_node *, struct mbuf *m);
125 struct mbuf *ieee80211_mbuf_adjust(struct ieee80211vap *, int,
126 struct ieee80211_key *, struct mbuf *);
127 struct mbuf *ieee80211_encap(struct ieee80211vap *, struct ieee80211_node *,
129 int ieee80211_send_mgmt(struct ieee80211_node *, int, int);
130 struct ieee80211_appie;
131 int ieee80211_send_probereq(struct ieee80211_node *ni,
132 const uint8_t sa[IEEE80211_ADDR_LEN],
133 const uint8_t da[IEEE80211_ADDR_LEN],
134 const uint8_t bssid[IEEE80211_ADDR_LEN],
135 const uint8_t *ssid, size_t ssidlen);
136 struct mbuf * ieee80211_ff_encap1(struct ieee80211vap *, struct mbuf *,
137 const struct ether_header *);
138 void ieee80211_tx_complete(struct ieee80211_node *,
142 * The formation of ProbeResponse frames requires guidance to
143 * deal with legacy clients. When the client is identified as
144 * "legacy 11b" ieee80211_send_proberesp is passed this token.
146 #define IEEE80211_SEND_LEGACY_11B 0x1 /* legacy 11b client */
147 #define IEEE80211_SEND_LEGACY_11 0x2 /* other legacy client */
148 #define IEEE80211_SEND_LEGACY 0x3 /* any legacy client */
149 struct mbuf *ieee80211_alloc_proberesp(struct ieee80211_node *, int);
150 int ieee80211_send_proberesp(struct ieee80211vap *,
151 const uint8_t da[IEEE80211_ADDR_LEN], int);
152 struct mbuf *ieee80211_alloc_rts(struct ieee80211com *ic,
153 const uint8_t [IEEE80211_ADDR_LEN],
154 const uint8_t [IEEE80211_ADDR_LEN], uint16_t);
155 struct mbuf *ieee80211_alloc_cts(struct ieee80211com *,
156 const uint8_t [IEEE80211_ADDR_LEN], uint16_t);
158 uint8_t *ieee80211_add_rates(uint8_t *, const struct ieee80211_rateset *);
159 uint8_t *ieee80211_add_xrates(uint8_t *, const struct ieee80211_rateset *);
160 uint8_t *ieee80211_add_ssid(uint8_t *frm, const uint8_t *ssid, u_int len);
161 uint8_t *ieee80211_add_wpa(uint8_t *, const struct ieee80211vap *);
162 uint8_t *ieee80211_add_rsn(uint8_t *, const struct ieee80211vap *);
163 uint8_t *ieee80211_add_qos(uint8_t *, const struct ieee80211_node *);
164 uint16_t ieee80211_getcapinfo(struct ieee80211vap *,
165 struct ieee80211_channel *);
167 void ieee80211_reset_erp(struct ieee80211com *);
168 void ieee80211_set_shortslottime(struct ieee80211com *, int onoff);
169 int ieee80211_iserp_rateset(const struct ieee80211_rateset *);
170 void ieee80211_setbasicrates(struct ieee80211_rateset *,
171 enum ieee80211_phymode);
172 void ieee80211_addbasicrates(struct ieee80211_rateset *,
173 enum ieee80211_phymode);
176 * Return the size of the 802.11 header for a management or data frame.
179 ieee80211_hdrsize(const void *data)
181 const struct ieee80211_frame *wh = data;
182 int size = sizeof(struct ieee80211_frame);
184 /* NB: we don't handle control frames */
185 KASSERT((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) != IEEE80211_FC0_TYPE_CTL,
186 ("%s: control frame", __func__));
187 if (IEEE80211_IS_DSTODS(wh))
188 size += IEEE80211_ADDR_LEN;
189 if (IEEE80211_QOS_HAS_SEQ(wh))
190 size += sizeof(uint16_t);
195 * Like ieee80211_hdrsize, but handles any type of frame.
198 ieee80211_anyhdrsize(const void *data)
200 const struct ieee80211_frame *wh = data;
202 if ((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) == IEEE80211_FC0_TYPE_CTL) {
203 switch (wh->i_fc[0] & IEEE80211_FC0_SUBTYPE_MASK) {
204 case IEEE80211_FC0_SUBTYPE_CTS:
205 case IEEE80211_FC0_SUBTYPE_ACK:
206 return sizeof(struct ieee80211_frame_ack);
207 case IEEE80211_FC0_SUBTYPE_BAR:
208 return sizeof(struct ieee80211_frame_bar);
210 return sizeof(struct ieee80211_frame_min);
212 return ieee80211_hdrsize(data);
216 * Template for an in-kernel authenticator. Authenticators
217 * register with the protocol code and are typically loaded
218 * as separate modules as needed. One special authenticator
219 * is xauth; it intercepts requests so that protocols like
220 * WPA can be handled in user space.
222 struct ieee80211_authenticator {
223 const char *ia_name; /* printable name */
224 int (*ia_attach)(struct ieee80211vap *);
225 void (*ia_detach)(struct ieee80211vap *);
226 void (*ia_node_join)(struct ieee80211_node *);
227 void (*ia_node_leave)(struct ieee80211_node *);
229 void ieee80211_authenticator_register(int type,
230 const struct ieee80211_authenticator *);
231 void ieee80211_authenticator_unregister(int type);
232 const struct ieee80211_authenticator *ieee80211_authenticator_get(int auth);
236 * Template for an MAC ACL policy module. Such modules
237 * register with the protocol code and are passed the sender's
238 * address of each received auth frame for validation.
240 struct ieee80211_aclator {
241 const char *iac_name; /* printable name */
242 int (*iac_attach)(struct ieee80211vap *);
243 void (*iac_detach)(struct ieee80211vap *);
244 int (*iac_check)(struct ieee80211vap *,
245 const struct ieee80211_frame *wh);
246 int (*iac_add)(struct ieee80211vap *,
247 const uint8_t mac[IEEE80211_ADDR_LEN]);
248 int (*iac_remove)(struct ieee80211vap *,
249 const uint8_t mac[IEEE80211_ADDR_LEN]);
250 int (*iac_flush)(struct ieee80211vap *);
251 int (*iac_setpolicy)(struct ieee80211vap *, int);
252 int (*iac_getpolicy)(struct ieee80211vap *);
253 int (*iac_setioctl)(struct ieee80211vap *, struct ieee80211req *);
254 int (*iac_getioctl)(struct ieee80211vap *, struct ieee80211req *);
256 void ieee80211_aclator_register(const struct ieee80211_aclator *);
257 void ieee80211_aclator_unregister(const struct ieee80211_aclator *);
258 const struct ieee80211_aclator *ieee80211_aclator_get(const char *name);
260 /* flags for ieee80211_fix_rate() */
261 #define IEEE80211_F_DOSORT 0x00000001 /* sort rate list */
262 #define IEEE80211_F_DOFRATE 0x00000002 /* use fixed legacy rate */
263 #define IEEE80211_F_DONEGO 0x00000004 /* calc negotiated rate */
264 #define IEEE80211_F_DODEL 0x00000008 /* delete ignore rate */
265 #define IEEE80211_F_DOBRS 0x00000010 /* check basic rate set */
266 #define IEEE80211_F_JOIN 0x00000020 /* sta joining our bss */
267 #define IEEE80211_F_DOFMCS 0x00000040 /* use fixed HT rate */
268 int ieee80211_fix_rate(struct ieee80211_node *,
269 struct ieee80211_rateset *, int);
277 uint8_t wmep_logcwmin; /* log2(cwmin) */
278 uint8_t wmep_logcwmax; /* log2(cwmax) */
279 uint8_t wmep_txopLimit;
280 uint8_t wmep_noackPolicy; /* 0 (ack), 1 (no ack) */
282 #define IEEE80211_TXOP_TO_US(_txop) ((_txop)<<5)
283 #define IEEE80211_US_TO_TXOP(_us) ((_us)>>5)
285 struct chanAccParams {
286 uint8_t cap_info; /* version of the current set */
287 struct wmeParams cap_wmeParams[WME_NUM_AC];
290 struct ieee80211_wme_state {
292 #define WME_F_AGGRMODE 0x00000001 /* STATUS: WME agressive mode */
293 u_int wme_hipri_traffic; /* VI/VO frames in beacon interval */
294 u_int wme_hipri_switch_thresh;/* agressive mode switch thresh */
295 u_int wme_hipri_switch_hysteresis;/* agressive mode switch hysteresis */
297 struct wmeParams wme_params[4]; /* from assoc resp for each AC*/
298 struct chanAccParams wme_wmeChanParams; /* WME params applied to self */
299 struct chanAccParams wme_wmeBssChanParams;/* WME params bcast to stations */
300 struct chanAccParams wme_chanParams; /* params applied to self */
301 struct chanAccParams wme_bssChanParams; /* params bcast to stations */
303 int (*wme_update)(struct ieee80211com *);
306 void ieee80211_wme_initparams(struct ieee80211vap *);
307 void ieee80211_wme_updateparams(struct ieee80211vap *);
308 void ieee80211_wme_updateparams_locked(struct ieee80211vap *);
311 * Return the WME TID from a QoS frame. If no TID
312 * is present return the index for the "non-QoS" entry.
314 static __inline uint8_t
315 ieee80211_gettid(const struct ieee80211_frame *wh)
319 if (IEEE80211_QOS_HAS_SEQ(wh)) {
320 if (IEEE80211_IS_DSTODS(wh))
321 tid = ((const struct ieee80211_qosframe_addr4 *)wh)->
324 tid = ((const struct ieee80211_qosframe *)wh)->i_qos[0];
325 tid &= IEEE80211_QOS_TID;
327 tid = IEEE80211_NONQOS_TID;
331 void ieee80211_waitfor_parent(struct ieee80211com *);
332 void ieee80211_start_locked(struct ieee80211vap *);
333 void ieee80211_init(void *);
334 void ieee80211_start_all(struct ieee80211com *);
335 void ieee80211_stop_locked(struct ieee80211vap *);
336 void ieee80211_stop(struct ieee80211vap *);
337 void ieee80211_stop_all(struct ieee80211com *);
338 void ieee80211_suspend_all(struct ieee80211com *);
339 void ieee80211_resume_all(struct ieee80211com *);
340 void ieee80211_dturbo_switch(struct ieee80211vap *, int newflags);
341 void ieee80211_swbmiss(void *arg);
342 void ieee80211_beacon_miss(struct ieee80211com *);
343 int ieee80211_new_state(struct ieee80211vap *, enum ieee80211_state, int);
344 int ieee80211_new_state_locked(struct ieee80211vap *, enum ieee80211_state,
346 void ieee80211_print_essid(const uint8_t *, int);
347 void ieee80211_dump_pkt(struct ieee80211com *,
348 const uint8_t *, int, int, int);
350 extern const char *ieee80211_opmode_name[];
351 extern const char *ieee80211_state_name[IEEE80211_S_MAX];
352 extern const char *ieee80211_wme_acnames[];
355 * Beacon frames constructed by ieee80211_beacon_alloc
356 * have the following structure filled in so drivers
357 * can update the frame later w/ minimal overhead.
359 struct ieee80211_beacon_offsets {
360 uint8_t bo_flags[4]; /* update/state flags */
361 uint16_t *bo_caps; /* capabilities */
362 uint8_t *bo_cfp; /* start of CFParms element */
363 uint8_t *bo_tim; /* start of atim/dtim */
364 uint8_t *bo_wme; /* start of WME parameters */
365 uint8_t *bo_tdma; /* start of TDMA parameters */
366 uint8_t *bo_tim_trailer;/* start of fixed-size trailer */
367 uint16_t bo_tim_len; /* atim/dtim length in bytes */
368 uint16_t bo_tim_trailer_len;/* tim trailer length in bytes */
369 uint8_t *bo_erp; /* start of ERP element */
370 uint8_t *bo_htinfo; /* start of HT info element */
371 uint8_t *bo_ath; /* start of ATH parameters */
372 uint8_t *bo_appie; /* start of AppIE element */
373 uint16_t bo_appie_len; /* AppIE length in bytes */
374 uint16_t bo_csa_trailer_len;
375 uint8_t *bo_csa; /* start of CSA element */
376 uint8_t *bo_quiet; /* start of Quiet element */
377 uint8_t *bo_meshconf; /* start of MESHCONF element */
378 uint8_t *bo_spare[3];
380 struct mbuf *ieee80211_beacon_alloc(struct ieee80211_node *,
381 struct ieee80211_beacon_offsets *);
384 * Beacon frame updates are signaled through calls to iv_update_beacon
385 * with one of the IEEE80211_BEACON_* tokens defined below. For devices
386 * that construct beacon frames on the host this can trigger a rebuild
387 * or defer the processing. For devices that offload beacon frame
388 * handling this callback can be used to signal a rebuild. The bo_flags
389 * array in the ieee80211_beacon_offsets structure is intended to record
390 * deferred processing requirements; ieee80211_beacon_update uses the
391 * state to optimize work. Since this structure is owned by the driver
392 * and not visible to the 802.11 layer drivers must supply an iv_update_beacon
393 * callback that marks the flag bits and schedules (as necessary) an update.
396 IEEE80211_BEACON_CAPS = 0, /* capabilities */
397 IEEE80211_BEACON_TIM = 1, /* DTIM/ATIM */
398 IEEE80211_BEACON_WME = 2,
399 IEEE80211_BEACON_ERP = 3, /* Extended Rate Phy */
400 IEEE80211_BEACON_HTINFO = 4, /* HT Information */
401 IEEE80211_BEACON_APPIE = 5, /* Application IE's */
402 IEEE80211_BEACON_CFP = 6, /* CFParms */
403 IEEE80211_BEACON_CSA = 7, /* Channel Switch Announcement */
404 IEEE80211_BEACON_TDMA = 9, /* TDMA Info */
405 IEEE80211_BEACON_ATH = 10, /* ATH parameters */
406 IEEE80211_BEACON_MESHCONF = 11, /* Mesh Configuration */
408 int ieee80211_beacon_update(struct ieee80211_node *,
409 struct ieee80211_beacon_offsets *, struct mbuf *, int mcast);
411 void ieee80211_csa_startswitch(struct ieee80211com *,
412 struct ieee80211_channel *, int mode, int count);
413 void ieee80211_csa_completeswitch(struct ieee80211com *);
414 void ieee80211_csa_cancelswitch(struct ieee80211com *);
415 void ieee80211_cac_completeswitch(struct ieee80211vap *);
418 * Notification methods called from the 802.11 state machine.
419 * Note that while these are defined here, their implementation
422 void ieee80211_notify_node_join(struct ieee80211_node *, int newassoc);
423 void ieee80211_notify_node_leave(struct ieee80211_node *);
424 void ieee80211_notify_scan_done(struct ieee80211vap *);
425 void ieee80211_notify_wds_discover(struct ieee80211_node *);
426 void ieee80211_notify_csa(struct ieee80211com *,
427 const struct ieee80211_channel *, int mode, int count);
428 void ieee80211_notify_radar(struct ieee80211com *,
429 const struct ieee80211_channel *);
430 enum ieee80211_notify_cac_event {
431 IEEE80211_NOTIFY_CAC_START = 0, /* CAC timer started */
432 IEEE80211_NOTIFY_CAC_STOP = 1, /* CAC intentionally stopped */
433 IEEE80211_NOTIFY_CAC_RADAR = 2, /* CAC stopped due to radar detectio */
434 IEEE80211_NOTIFY_CAC_EXPIRE = 3, /* CAC expired w/o radar */
436 void ieee80211_notify_cac(struct ieee80211com *,
437 const struct ieee80211_channel *,
438 enum ieee80211_notify_cac_event);
439 void ieee80211_notify_node_deauth(struct ieee80211_node *);
440 void ieee80211_notify_node_auth(struct ieee80211_node *);
441 void ieee80211_notify_country(struct ieee80211vap *, const uint8_t [],
442 const uint8_t cc[2]);
443 void ieee80211_notify_radio(struct ieee80211com *, int);
444 #endif /* _NET80211_IEEE80211_PROTO_H_ */