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