2 * Copyright (c) 2001 Atsushi Onoe
3 * Copyright (c) 2002-2007 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(_ic,_ni,_type,_arg) \
48 ((*(_ic)->ic_send_mgmt)(_ic, _ni, _type, _arg))
50 extern const char *ieee80211_mgt_subtype_name[];
51 extern const char *ieee80211_phymode_name[];
53 void ieee80211_proto_attach(struct ieee80211com *);
54 void ieee80211_proto_detach(struct ieee80211com *);
56 struct ieee80211_node;
57 int ieee80211_input(struct ieee80211com *, struct mbuf *,
58 struct ieee80211_node *, int, int, uint32_t);
59 void ieee80211_deliver_data(struct ieee80211com *,
60 struct ieee80211_node *, struct mbuf *);
61 struct mbuf *ieee80211_decap1(struct mbuf *, int *);
62 int ieee80211_setup_rates(struct ieee80211_node *ni,
63 const uint8_t *rates, const uint8_t *xrates, int flags);
64 void ieee80211_saveie(uint8_t **, const uint8_t *);
65 void ieee80211_saveath(struct ieee80211_node *, uint8_t *);
66 void ieee80211_recv_mgmt(struct ieee80211com *, struct mbuf *,
67 struct ieee80211_node *, int, int, int, uint32_t);
68 int ieee80211_mgmt_output(struct ieee80211com *, struct ieee80211_node *,
69 struct mbuf *, int type);
70 struct ieee80211_bpf_params;
71 int ieee80211_raw_xmit(struct ieee80211_node *, struct mbuf *,
72 const struct ieee80211_bpf_params *);
73 int ieee80211_output(struct ifnet *, struct mbuf *,
74 struct sockaddr *, struct rtentry *);
75 int ieee80211_send_nulldata(struct ieee80211_node *);
76 int ieee80211_send_mgmt(struct ieee80211com *, struct ieee80211_node *,
78 int ieee80211_send_probereq(struct ieee80211_node *ni,
79 const uint8_t sa[IEEE80211_ADDR_LEN],
80 const uint8_t da[IEEE80211_ADDR_LEN],
81 const uint8_t bssid[IEEE80211_ADDR_LEN],
82 const uint8_t *ssid, size_t ssidlen,
83 const void *optie, size_t optielen);
84 int ieee80211_classify(struct ieee80211com *, struct mbuf *,
85 struct ieee80211_node *);
86 struct mbuf *ieee80211_encap(struct ieee80211com *, struct mbuf *,
87 struct ieee80211_node *);
89 void ieee80211_reset_erp(struct ieee80211com *);
90 void ieee80211_set_shortslottime(struct ieee80211com *, int onoff);
91 int ieee80211_iserp_rateset(struct ieee80211com *,
92 struct ieee80211_rateset *);
93 void ieee80211_set11gbasicrates(struct ieee80211_rateset *,
94 enum ieee80211_phymode);
97 * Return the size of the 802.11 header for a management or data frame.
100 ieee80211_hdrsize(const void *data)
102 const struct ieee80211_frame *wh = data;
103 int size = sizeof(struct ieee80211_frame);
105 /* NB: we don't handle control frames */
106 KASSERT((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) != IEEE80211_FC0_TYPE_CTL,
107 ("%s: control frame", __func__));
108 if ((wh->i_fc[1] & IEEE80211_FC1_DIR_MASK) == IEEE80211_FC1_DIR_DSTODS)
109 size += IEEE80211_ADDR_LEN;
110 if (IEEE80211_QOS_HAS_SEQ(wh))
111 size += sizeof(uint16_t);
116 * Like ieee80211_hdrsize, but handles any type of frame.
119 ieee80211_anyhdrsize(const void *data)
121 const struct ieee80211_frame *wh = data;
123 if ((wh->i_fc[0]&IEEE80211_FC0_TYPE_MASK) == IEEE80211_FC0_TYPE_CTL) {
124 switch (wh->i_fc[0] & IEEE80211_FC0_SUBTYPE_MASK) {
125 case IEEE80211_FC0_SUBTYPE_CTS:
126 case IEEE80211_FC0_SUBTYPE_ACK:
127 return sizeof(struct ieee80211_frame_ack);
128 case IEEE80211_FC0_SUBTYPE_BAR:
129 return sizeof(struct ieee80211_frame_bar);
131 return sizeof(struct ieee80211_frame_min);
133 return ieee80211_hdrsize(data);
137 * Template for an in-kernel authenticator. Authenticators
138 * register with the protocol code and are typically loaded
139 * as separate modules as needed.
141 struct ieee80211_authenticator {
142 const char *ia_name; /* printable name */
143 int (*ia_attach)(struct ieee80211com *);
144 void (*ia_detach)(struct ieee80211com *);
145 void (*ia_node_join)(struct ieee80211com *,
146 struct ieee80211_node *);
147 void (*ia_node_leave)(struct ieee80211com *,
148 struct ieee80211_node *);
150 void ieee80211_authenticator_register(int type,
151 const struct ieee80211_authenticator *);
152 void ieee80211_authenticator_unregister(int type);
153 const struct ieee80211_authenticator *ieee80211_authenticator_get(int auth);
157 * Template for an MAC ACL policy module. Such modules
158 * register with the protocol code and are passed the sender's
159 * address of each received frame for validation.
161 struct ieee80211_aclator {
162 const char *iac_name; /* printable name */
163 int (*iac_attach)(struct ieee80211com *);
164 void (*iac_detach)(struct ieee80211com *);
165 int (*iac_check)(struct ieee80211com *,
166 const uint8_t mac[IEEE80211_ADDR_LEN]);
167 int (*iac_add)(struct ieee80211com *,
168 const uint8_t mac[IEEE80211_ADDR_LEN]);
169 int (*iac_remove)(struct ieee80211com *,
170 const uint8_t mac[IEEE80211_ADDR_LEN]);
171 int (*iac_flush)(struct ieee80211com *);
172 int (*iac_setpolicy)(struct ieee80211com *, int);
173 int (*iac_getpolicy)(struct ieee80211com *);
174 int (*iac_setioctl)(struct ieee80211com *, struct ieee80211req *);
175 int (*iac_getioctl)(struct ieee80211com *, struct ieee80211req *);
177 void ieee80211_aclator_register(const struct ieee80211_aclator *);
178 void ieee80211_aclator_unregister(const struct ieee80211_aclator *);
179 const struct ieee80211_aclator *ieee80211_aclator_get(const char *name);
181 /* flags for ieee80211_fix_rate() */
182 #define IEEE80211_F_DOSORT 0x00000001 /* sort rate list */
183 #define IEEE80211_F_DOFRATE 0x00000002 /* use fixed rate */
184 #define IEEE80211_F_DONEGO 0x00000004 /* calc negotiated rate */
185 #define IEEE80211_F_DODEL 0x00000008 /* delete ignore rate */
186 #define IEEE80211_F_DOBRS 0x00000010 /* check basic rate set */
187 #define IEEE80211_F_JOIN 0x00000020 /* sta joining our bss */
188 int ieee80211_fix_rate(struct ieee80211_node *,
189 struct ieee80211_rateset *, int);
197 uint8_t wmep_logcwmin; /* log2(cwmin) */
198 uint8_t wmep_logcwmax; /* log2(cwmax) */
199 uint8_t wmep_txopLimit;
200 uint8_t wmep_noackPolicy; /* 0 (ack), 1 (no ack) */
202 #define IEEE80211_TXOP_TO_US(_txop) ((_txop)<<5)
203 #define IEEE80211_US_TO_TXOP(_us) ((_us)>>5)
205 struct chanAccParams {
206 uint8_t cap_info; /* version of the current set */
207 struct wmeParams cap_wmeParams[WME_NUM_AC];
210 struct ieee80211_wme_state {
212 #define WME_F_AGGRMODE 0x00000001 /* STATUS: WME agressive mode */
213 u_int wme_hipri_traffic; /* VI/VO frames in beacon interval */
214 u_int wme_hipri_switch_thresh;/* agressive mode switch thresh */
215 u_int wme_hipri_switch_hysteresis;/* agressive mode switch hysteresis */
217 struct wmeParams wme_params[4]; /* from assoc resp for each AC*/
218 struct chanAccParams wme_wmeChanParams; /* WME params applied to self */
219 struct chanAccParams wme_wmeBssChanParams;/* WME params bcast to stations */
220 struct chanAccParams wme_chanParams; /* params applied to self */
221 struct chanAccParams wme_bssChanParams; /* params bcast to stations */
223 int (*wme_update)(struct ieee80211com *);
226 void ieee80211_wme_initparams(struct ieee80211com *);
227 void ieee80211_wme_updateparams(struct ieee80211com *);
228 void ieee80211_wme_updateparams_locked(struct ieee80211com *);
230 #define ieee80211_new_state(_ic, _nstate, _arg) \
231 (((_ic)->ic_newstate)((_ic), (_nstate), (_arg)))
232 int ieee80211_init(struct ieee80211com *, int forcescan);
233 void ieee80211_dturbo_switch(struct ieee80211com *, int newflags);
234 void ieee80211_beacon_miss(struct ieee80211com *);
235 void ieee80211_print_essid(const uint8_t *, int);
236 void ieee80211_dump_pkt(struct ieee80211com *,
237 const uint8_t *, int, int, int);
239 extern const char *ieee80211_opmode_name[];
240 extern const char *ieee80211_state_name[IEEE80211_S_MAX];
241 extern const char *ieee80211_wme_acnames[];
244 * Beacon frames constructed by ieee80211_beacon_alloc
245 * have the following structure filled in so drivers
246 * can update the frame later w/ minimal overhead.
248 struct ieee80211_beacon_offsets {
249 uint8_t bo_flags[4]; /* update/state flags */
250 uint16_t *bo_caps; /* capabilities */
251 uint8_t *bo_cfp; /* start of CFParms element */
252 uint8_t *bo_tim; /* start of atim/dtim */
253 uint8_t *bo_wme; /* start of WME parameters */
254 uint8_t *bo_tim_trailer;/* start of fixed-size trailer */
255 uint16_t bo_tim_len; /* atim/dtim length in bytes */
256 uint16_t bo_tim_trailer_len;/* tim trailer length in bytes */
257 uint8_t *bo_erp; /* start of ERP element */
258 uint8_t *bo_htinfo; /* start of HT info element */
259 uint8_t *bo_appie; /* start of AppIE element */
260 uint16_t bo_appie_len; /* AppIE length in bytes */
261 uint16_t bo_csa_trailer_len;;
262 uint8_t *bo_csa; /* start of CSA element */
264 struct mbuf *ieee80211_beacon_alloc(struct ieee80211_node *,
265 struct ieee80211_beacon_offsets *);
268 * Beacon frame updates are signaled through calls to ic_update_beacon
269 * with one of the IEEE80211_BEACON_* tokens defined below. For devices
270 * that construct beacon frames on the host this can trigger a rebuild
271 * or defer the processing. For devices that offload beacon frame
272 * handling this callback can be used to signal a rebuild. The bo_flags
273 * array in the ieee80211_beacon_offsets structure is intended to record
274 * deferred processing requirements; ieee80211_beacon_update uses the
275 * state to optimize work. Since this structure is owned by the driver
276 * and not visible to the 802.11 layer drivers must supply an ic_update_beacon
277 * callback that marks the flag bits and schedules (as necessary) an update.
280 IEEE80211_BEACON_CAPS = 0, /* capabilities */
281 IEEE80211_BEACON_TIM = 1, /* DTIM/ATIM */
282 IEEE80211_BEACON_WME = 2,
283 IEEE80211_BEACON_ERP = 3, /* Extended Rate Phy */
284 IEEE80211_BEACON_HTINFO = 4, /* HT Information */
285 IEEE80211_BEACON_APPIE = 5, /* Application IE's */
286 IEEE80211_BEACON_CFP = 6, /* CFParms */
287 IEEE80211_BEACON_CSA = 7, /* Channel Switch Announcement */
289 int ieee80211_beacon_update(struct ieee80211_node *,
290 struct ieee80211_beacon_offsets *, struct mbuf *, int mcast);
293 * Notification methods called from the 802.11 state machine.
294 * Note that while these are defined here, their implementation
297 void ieee80211_notify_node_join(struct ieee80211com *,
298 struct ieee80211_node *, int newassoc);
299 void ieee80211_notify_node_leave(struct ieee80211com *,
300 struct ieee80211_node *);
301 void ieee80211_notify_scan_done(struct ieee80211com *);
302 #endif /* _NET80211_IEEE80211_PROTO_H_ */