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