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