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