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 #define ieee80211_input(ni, m, rssi, nf) \
86 ((ni)->ni_vap->iv_input(ni, m, rssi, nf))
87 int ieee80211_input_all(struct ieee80211com *, struct mbuf *, int, int);
89 int ieee80211_input_mimo(struct ieee80211_node *, struct mbuf *,
90 struct ieee80211_rx_stats *);
91 int ieee80211_input_mimo_all(struct ieee80211com *, struct mbuf *,
92 struct ieee80211_rx_stats *);
94 struct ieee80211_bpf_params;
95 int ieee80211_mgmt_output(struct ieee80211_node *, struct mbuf *, int,
96 struct ieee80211_bpf_params *);
97 int ieee80211_raw_xmit(struct ieee80211_node *, struct mbuf *,
98 const struct ieee80211_bpf_params *);
99 #if __FreeBSD_version >= 1000031
100 int ieee80211_output(struct ifnet *, struct mbuf *,
101 const struct sockaddr *, struct route *ro);
103 int ieee80211_output(struct ifnet *, struct mbuf *,
104 struct sockaddr *, struct route *ro);
106 int ieee80211_vap_pkt_send_dest(struct ieee80211vap *, struct mbuf *,
107 struct ieee80211_node *);
108 int ieee80211_raw_output(struct ieee80211vap *, struct ieee80211_node *,
109 struct mbuf *, const struct ieee80211_bpf_params *);
110 void ieee80211_send_setup(struct ieee80211_node *, struct mbuf *, int, int,
111 const uint8_t [IEEE80211_ADDR_LEN], const uint8_t [IEEE80211_ADDR_LEN],
112 const uint8_t [IEEE80211_ADDR_LEN]);
113 int ieee80211_vap_transmit(struct ifnet *ifp, struct mbuf *m);
114 void ieee80211_vap_qflush(struct ifnet *ifp);
115 int ieee80211_send_nulldata(struct ieee80211_node *);
116 int ieee80211_classify(struct ieee80211_node *, struct mbuf *m);
117 struct mbuf *ieee80211_mbuf_adjust(struct ieee80211vap *, int,
118 struct ieee80211_key *, struct mbuf *);
119 struct mbuf *ieee80211_encap(struct ieee80211vap *, struct ieee80211_node *,
121 int ieee80211_send_mgmt(struct ieee80211_node *, int, int);
122 struct ieee80211_appie;
123 int ieee80211_send_probereq(struct ieee80211_node *ni,
124 const uint8_t sa[IEEE80211_ADDR_LEN],
125 const uint8_t da[IEEE80211_ADDR_LEN],
126 const uint8_t bssid[IEEE80211_ADDR_LEN],
127 const uint8_t *ssid, size_t ssidlen);
128 struct mbuf * ieee80211_ff_encap1(struct ieee80211vap *, struct mbuf *,
129 const struct ether_header *);
130 void ieee80211_tx_complete(struct ieee80211_node *,
134 * The formation of ProbeResponse frames requires guidance to
135 * deal with legacy clients. When the client is identified as
136 * "legacy 11b" ieee80211_send_proberesp is passed this token.
138 #define IEEE80211_SEND_LEGACY_11B 0x1 /* legacy 11b client */
139 #define IEEE80211_SEND_LEGACY_11 0x2 /* other legacy client */
140 #define IEEE80211_SEND_LEGACY 0x3 /* any legacy client */
141 struct mbuf *ieee80211_alloc_proberesp(struct ieee80211_node *, int);
142 int ieee80211_send_proberesp(struct ieee80211vap *,
143 const uint8_t da[IEEE80211_ADDR_LEN], int);
144 struct mbuf *ieee80211_alloc_rts(struct ieee80211com *ic,
145 const uint8_t [IEEE80211_ADDR_LEN],
146 const uint8_t [IEEE80211_ADDR_LEN], uint16_t);
147 struct mbuf *ieee80211_alloc_cts(struct ieee80211com *,
148 const uint8_t [IEEE80211_ADDR_LEN], uint16_t);
150 uint8_t *ieee80211_add_rates(uint8_t *, const struct ieee80211_rateset *);
151 uint8_t *ieee80211_add_xrates(uint8_t *, const struct ieee80211_rateset *);
152 uint8_t *ieee80211_add_wpa(uint8_t *, const struct ieee80211vap *);
153 uint8_t *ieee80211_add_rsn(uint8_t *, const struct ieee80211vap *);
154 uint8_t *ieee80211_add_qos(uint8_t *, const struct ieee80211_node *);
155 uint16_t ieee80211_getcapinfo(struct ieee80211vap *,
156 struct ieee80211_channel *);
158 void ieee80211_reset_erp(struct ieee80211com *);
159 void ieee80211_set_shortslottime(struct ieee80211com *, int onoff);
160 int ieee80211_iserp_rateset(const struct ieee80211_rateset *);
161 void ieee80211_setbasicrates(struct ieee80211_rateset *,
162 enum ieee80211_phymode);
163 void ieee80211_addbasicrates(struct ieee80211_rateset *,
164 enum ieee80211_phymode);
167 * Return the size of the 802.11 header for a management or data frame.
170 ieee80211_hdrsize(const void *data)
172 const struct ieee80211_frame *wh = data;
173 int size = sizeof(struct ieee80211_frame);
175 /* NB: we don't handle control frames */
176 KASSERT((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) != IEEE80211_FC0_TYPE_CTL,
177 ("%s: control frame", __func__));
178 if (IEEE80211_IS_DSTODS(wh))
179 size += IEEE80211_ADDR_LEN;
180 if (IEEE80211_QOS_HAS_SEQ(wh))
181 size += sizeof(uint16_t);
186 * Like ieee80211_hdrsize, but handles any type of frame.
189 ieee80211_anyhdrsize(const void *data)
191 const struct ieee80211_frame *wh = data;
193 if ((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) == IEEE80211_FC0_TYPE_CTL) {
194 switch (wh->i_fc[0] & IEEE80211_FC0_SUBTYPE_MASK) {
195 case IEEE80211_FC0_SUBTYPE_CTS:
196 case IEEE80211_FC0_SUBTYPE_ACK:
197 return sizeof(struct ieee80211_frame_ack);
198 case IEEE80211_FC0_SUBTYPE_BAR:
199 return sizeof(struct ieee80211_frame_bar);
201 return sizeof(struct ieee80211_frame_min);
203 return ieee80211_hdrsize(data);
207 * Template for an in-kernel authenticator. Authenticators
208 * register with the protocol code and are typically loaded
209 * as separate modules as needed. One special authenticator
210 * is xauth; it intercepts requests so that protocols like
211 * WPA can be handled in user space.
213 struct ieee80211_authenticator {
214 const char *ia_name; /* printable name */
215 int (*ia_attach)(struct ieee80211vap *);
216 void (*ia_detach)(struct ieee80211vap *);
217 void (*ia_node_join)(struct ieee80211_node *);
218 void (*ia_node_leave)(struct ieee80211_node *);
220 void ieee80211_authenticator_register(int type,
221 const struct ieee80211_authenticator *);
222 void ieee80211_authenticator_unregister(int type);
223 const struct ieee80211_authenticator *ieee80211_authenticator_get(int auth);
227 * Template for an MAC ACL policy module. Such modules
228 * register with the protocol code and are passed the sender's
229 * address of each received auth frame for validation.
231 struct ieee80211_aclator {
232 const char *iac_name; /* printable name */
233 int (*iac_attach)(struct ieee80211vap *);
234 void (*iac_detach)(struct ieee80211vap *);
235 int (*iac_check)(struct ieee80211vap *,
236 const struct ieee80211_frame *wh);
237 int (*iac_add)(struct ieee80211vap *,
238 const uint8_t mac[IEEE80211_ADDR_LEN]);
239 int (*iac_remove)(struct ieee80211vap *,
240 const uint8_t mac[IEEE80211_ADDR_LEN]);
241 int (*iac_flush)(struct ieee80211vap *);
242 int (*iac_setpolicy)(struct ieee80211vap *, int);
243 int (*iac_getpolicy)(struct ieee80211vap *);
244 int (*iac_setioctl)(struct ieee80211vap *, struct ieee80211req *);
245 int (*iac_getioctl)(struct ieee80211vap *, struct ieee80211req *);
247 void ieee80211_aclator_register(const struct ieee80211_aclator *);
248 void ieee80211_aclator_unregister(const struct ieee80211_aclator *);
249 const struct ieee80211_aclator *ieee80211_aclator_get(const char *name);
251 /* flags for ieee80211_fix_rate() */
252 #define IEEE80211_F_DOSORT 0x00000001 /* sort rate list */
253 #define IEEE80211_F_DOFRATE 0x00000002 /* use fixed legacy rate */
254 #define IEEE80211_F_DONEGO 0x00000004 /* calc negotiated rate */
255 #define IEEE80211_F_DODEL 0x00000008 /* delete ignore rate */
256 #define IEEE80211_F_DOBRS 0x00000010 /* check basic rate set */
257 #define IEEE80211_F_JOIN 0x00000020 /* sta joining our bss */
258 #define IEEE80211_F_DOFMCS 0x00000040 /* use fixed HT rate */
259 int ieee80211_fix_rate(struct ieee80211_node *,
260 struct ieee80211_rateset *, int);
268 uint8_t wmep_logcwmin; /* log2(cwmin) */
269 uint8_t wmep_logcwmax; /* log2(cwmax) */
270 uint8_t wmep_txopLimit;
271 uint8_t wmep_noackPolicy; /* 0 (ack), 1 (no ack) */
273 #define IEEE80211_TXOP_TO_US(_txop) ((_txop)<<5)
274 #define IEEE80211_US_TO_TXOP(_us) ((_us)>>5)
276 struct chanAccParams {
277 uint8_t cap_info; /* version of the current set */
278 struct wmeParams cap_wmeParams[WME_NUM_AC];
281 struct ieee80211_wme_state {
283 #define WME_F_AGGRMODE 0x00000001 /* STATUS: WME agressive mode */
284 u_int wme_hipri_traffic; /* VI/VO frames in beacon interval */
285 u_int wme_hipri_switch_thresh;/* agressive mode switch thresh */
286 u_int wme_hipri_switch_hysteresis;/* agressive mode switch hysteresis */
288 struct wmeParams wme_params[4]; /* from assoc resp for each AC*/
289 struct chanAccParams wme_wmeChanParams; /* WME params applied to self */
290 struct chanAccParams wme_wmeBssChanParams;/* WME params bcast to stations */
291 struct chanAccParams wme_chanParams; /* params applied to self */
292 struct chanAccParams wme_bssChanParams; /* params bcast to stations */
294 int (*wme_update)(struct ieee80211com *);
297 void ieee80211_wme_initparams(struct ieee80211vap *);
298 void ieee80211_wme_updateparams(struct ieee80211vap *);
299 void ieee80211_wme_updateparams_locked(struct ieee80211vap *);
302 * Return the WME TID from a QoS frame. If no TID
303 * is present return the index for the "non-QoS" entry.
305 static __inline uint8_t
306 ieee80211_gettid(const struct ieee80211_frame *wh)
310 if (IEEE80211_QOS_HAS_SEQ(wh)) {
311 if (IEEE80211_IS_DSTODS(wh))
312 tid = ((const struct ieee80211_qosframe_addr4 *)wh)->
315 tid = ((const struct ieee80211_qosframe *)wh)->i_qos[0];
316 tid &= IEEE80211_QOS_TID;
318 tid = IEEE80211_NONQOS_TID;
322 void ieee80211_waitfor_parent(struct ieee80211com *);
323 void ieee80211_start_locked(struct ieee80211vap *);
324 void ieee80211_init(void *);
325 void ieee80211_start_all(struct ieee80211com *);
326 void ieee80211_stop_locked(struct ieee80211vap *);
327 void ieee80211_stop(struct ieee80211vap *);
328 void ieee80211_stop_all(struct ieee80211com *);
329 void ieee80211_suspend_all(struct ieee80211com *);
330 void ieee80211_resume_all(struct ieee80211com *);
331 void ieee80211_dturbo_switch(struct ieee80211vap *, int newflags);
332 void ieee80211_swbmiss(void *arg);
333 void ieee80211_beacon_miss(struct ieee80211com *);
334 int ieee80211_new_state(struct ieee80211vap *, enum ieee80211_state, int);
335 int ieee80211_new_state_locked(struct ieee80211vap *, enum ieee80211_state,
337 void ieee80211_print_essid(const uint8_t *, int);
338 void ieee80211_dump_pkt(struct ieee80211com *,
339 const uint8_t *, int, int, int);
341 extern const char *ieee80211_opmode_name[];
342 extern const char *ieee80211_state_name[IEEE80211_S_MAX];
343 extern const char *ieee80211_wme_acnames[];
346 * Beacon frames constructed by ieee80211_beacon_alloc
347 * have the following structure filled in so drivers
348 * can update the frame later w/ minimal overhead.
350 struct ieee80211_beacon_offsets {
351 uint8_t bo_flags[4]; /* update/state flags */
352 uint16_t *bo_caps; /* capabilities */
353 uint8_t *bo_cfp; /* start of CFParms element */
354 uint8_t *bo_tim; /* start of atim/dtim */
355 uint8_t *bo_wme; /* start of WME parameters */
356 uint8_t *bo_tdma; /* start of TDMA parameters */
357 uint8_t *bo_tim_trailer;/* start of fixed-size trailer */
358 uint16_t bo_tim_len; /* atim/dtim length in bytes */
359 uint16_t bo_tim_trailer_len;/* tim trailer length in bytes */
360 uint8_t *bo_erp; /* start of ERP element */
361 uint8_t *bo_htinfo; /* start of HT info element */
362 uint8_t *bo_ath; /* start of ATH parameters */
363 uint8_t *bo_appie; /* start of AppIE element */
364 uint16_t bo_appie_len; /* AppIE length in bytes */
365 uint16_t bo_csa_trailer_len;
366 uint8_t *bo_csa; /* start of CSA element */
367 uint8_t *bo_quiet; /* start of Quiet element */
368 uint8_t *bo_meshconf; /* start of MESHCONF element */
369 uint8_t *bo_spare[3];
371 struct mbuf *ieee80211_beacon_alloc(struct ieee80211_node *,
372 struct ieee80211_beacon_offsets *);
375 * Beacon frame updates are signaled through calls to iv_update_beacon
376 * with one of the IEEE80211_BEACON_* tokens defined below. For devices
377 * that construct beacon frames on the host this can trigger a rebuild
378 * or defer the processing. For devices that offload beacon frame
379 * handling this callback can be used to signal a rebuild. The bo_flags
380 * array in the ieee80211_beacon_offsets structure is intended to record
381 * deferred processing requirements; ieee80211_beacon_update uses the
382 * state to optimize work. Since this structure is owned by the driver
383 * and not visible to the 802.11 layer drivers must supply an iv_update_beacon
384 * callback that marks the flag bits and schedules (as necessary) an update.
387 IEEE80211_BEACON_CAPS = 0, /* capabilities */
388 IEEE80211_BEACON_TIM = 1, /* DTIM/ATIM */
389 IEEE80211_BEACON_WME = 2,
390 IEEE80211_BEACON_ERP = 3, /* Extended Rate Phy */
391 IEEE80211_BEACON_HTINFO = 4, /* HT Information */
392 IEEE80211_BEACON_APPIE = 5, /* Application IE's */
393 IEEE80211_BEACON_CFP = 6, /* CFParms */
394 IEEE80211_BEACON_CSA = 7, /* Channel Switch Announcement */
395 IEEE80211_BEACON_TDMA = 9, /* TDMA Info */
396 IEEE80211_BEACON_ATH = 10, /* ATH parameters */
397 IEEE80211_BEACON_MESHCONF = 11, /* Mesh Configuration */
399 int ieee80211_beacon_update(struct ieee80211_node *,
400 struct ieee80211_beacon_offsets *, struct mbuf *, int mcast);
402 void ieee80211_csa_startswitch(struct ieee80211com *,
403 struct ieee80211_channel *, int mode, int count);
404 void ieee80211_csa_completeswitch(struct ieee80211com *);
405 void ieee80211_csa_cancelswitch(struct ieee80211com *);
406 void ieee80211_cac_completeswitch(struct ieee80211vap *);
409 * Notification methods called from the 802.11 state machine.
410 * Note that while these are defined here, their implementation
413 void ieee80211_notify_node_join(struct ieee80211_node *, int newassoc);
414 void ieee80211_notify_node_leave(struct ieee80211_node *);
415 void ieee80211_notify_scan_done(struct ieee80211vap *);
416 void ieee80211_notify_wds_discover(struct ieee80211_node *);
417 void ieee80211_notify_csa(struct ieee80211com *,
418 const struct ieee80211_channel *, int mode, int count);
419 void ieee80211_notify_radar(struct ieee80211com *,
420 const struct ieee80211_channel *);
421 enum ieee80211_notify_cac_event {
422 IEEE80211_NOTIFY_CAC_START = 0, /* CAC timer started */
423 IEEE80211_NOTIFY_CAC_STOP = 1, /* CAC intentionally stopped */
424 IEEE80211_NOTIFY_CAC_RADAR = 2, /* CAC stopped due to radar detectio */
425 IEEE80211_NOTIFY_CAC_EXPIRE = 3, /* CAC expired w/o radar */
427 void ieee80211_notify_cac(struct ieee80211com *,
428 const struct ieee80211_channel *,
429 enum ieee80211_notify_cac_event);
430 void ieee80211_notify_node_deauth(struct ieee80211_node *);
431 void ieee80211_notify_node_auth(struct ieee80211_node *);
432 void ieee80211_notify_country(struct ieee80211vap *, const uint8_t [],
433 const uint8_t cc[2]);
434 void ieee80211_notify_radio(struct ieee80211com *, int);
435 #endif /* _NET80211_IEEE80211_PROTO_H_ */