b50076345d4f9ff9dbf0a26bb3a0a68b59504ca5
[dragonfly.git] / sys / netproto / 802_11 / wlan / ieee80211_dragonfly.c
1 /*
2  * Copyright (c) 2003-2005 Sam Leffler, Errno Consulting
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. The name of the author may not be used to endorse or promote products
14  *    derived from this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  *
27  * $FreeBSD: src/sys/net80211/ieee80211_freebsd.c,v 1.7.2.2 2005/12/22 19:22:51 sam Exp $
28  * $DragonFly: src/sys/netproto/802_11/wlan/ieee80211_dragonfly.c,v 1.4 2006/09/05 00:55:48 dillon Exp $
29  */
30
31 /*
32  * IEEE 802.11 support (DragonFlyBSD-specific code)
33  */
34 #include <sys/param.h>
35 #include <sys/kernel.h>
36 #include <sys/systm.h> 
37 #include <sys/linker.h>
38 #include <sys/mbuf.h>   
39 #include <sys/module.h>
40 #include <sys/proc.h>
41 #include <sys/sysctl.h>
42
43 #include <sys/socket.h>
44
45 #include <net/if.h>
46 #include <net/if_arp.h>
47 #include <net/if_media.h>
48 #include <net/ethernet.h>
49 #include <net/route.h>
50
51 #include <netproto/802_11/ieee80211_var.h>
52
53 #define if_link_state_change(ifp, state)        ((void)0)
54
55 SYSCTL_NODE(_net, OID_AUTO, wlan, CTLFLAG_RD, 0, "IEEE 80211 parameters");
56
57 #ifdef IEEE80211_DEBUG
58 int     ieee80211_debug = 0;
59 SYSCTL_INT(_net_wlan, OID_AUTO, debug, CTLFLAG_RW, &ieee80211_debug,
60             0, "debugging printfs");
61 #endif
62
63 static int
64 ieee80211_sysctl_inact(SYSCTL_HANDLER_ARGS)
65 {
66         int inact = (*(int *)arg1) * IEEE80211_INACT_WAIT;
67         int error;
68
69         error = sysctl_handle_int(oidp, &inact, 0, req);
70         if (error || !req->newptr)
71                 return error;
72         *(int *)arg1 = inact / IEEE80211_INACT_WAIT;
73         return 0;
74 }
75
76 static int
77 ieee80211_sysctl_parent(SYSCTL_HANDLER_ARGS)
78 {
79         struct ieee80211com *ic = arg1;
80         const char *name = ic->ic_ifp->if_xname;
81
82         return SYSCTL_OUT(req, name, strlen(name));
83 }
84
85 void
86 ieee80211_sysctl_attach(struct ieee80211com *ic)
87 {
88         struct sysctl_ctx_list *ctx;
89         struct sysctl_oid *oid;
90         char num[14];                   /* sufficient for 32 bits */
91
92         ctx = kmalloc(sizeof(struct sysctl_ctx_list), M_DEVBUF,
93                      M_WAITOK | M_ZERO);
94         sysctl_ctx_init(ctx);
95
96         snprintf(num, sizeof(num), "%u", ic->ic_vap);
97         oid = SYSCTL_ADD_NODE(ctx, &SYSCTL_NODE_CHILDREN(_net, wlan),
98                 OID_AUTO, num, CTLFLAG_RD, NULL, "");
99         if (oid == NULL) {
100                 printf("add sysctl node net.wlan.%s failed\n", num);
101                 kfree(ctx, M_DEVBUF);
102                 return;
103         }
104
105         SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(oid), OID_AUTO,
106                 "%parent", CTLFLAG_RD, ic, 0, ieee80211_sysctl_parent, "A",
107                 "parent device");
108 #ifdef IEEE80211_DEBUG
109         ic->ic_debug = ieee80211_debug;
110         SYSCTL_ADD_INT(ctx, SYSCTL_CHILDREN(oid), OID_AUTO,
111                 "debug", CTLFLAG_RW, &ic->ic_debug, 0,
112                 "control debugging printfs");
113 #endif
114         /* XXX inherit from tunables */
115         SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(oid), OID_AUTO,
116                 "inact_run", CTLTYPE_INT | CTLFLAG_RW, &ic->ic_inact_run, 0,
117                 ieee80211_sysctl_inact, "I",
118                 "station inactivity timeout (sec)");
119         SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(oid), OID_AUTO,
120                 "inact_probe", CTLTYPE_INT | CTLFLAG_RW, &ic->ic_inact_probe, 0,
121                 ieee80211_sysctl_inact, "I",
122                 "station inactivity probe timeout (sec)");
123         SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(oid), OID_AUTO,
124                 "inact_auth", CTLTYPE_INT | CTLFLAG_RW, &ic->ic_inact_auth, 0,
125                 ieee80211_sysctl_inact, "I",
126                 "station authentication timeout (sec)");
127         SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(oid), OID_AUTO,
128                 "inact_init", CTLTYPE_INT | CTLFLAG_RW, &ic->ic_inact_init, 0,
129                 ieee80211_sysctl_inact, "I",
130                 "station initial state timeout (sec)");
131         SYSCTL_ADD_INT(ctx, SYSCTL_CHILDREN(oid), OID_AUTO,
132                 "driver_caps", CTLFLAG_RW, &ic->ic_caps, 0,
133                 "driver capabilities");
134         SYSCTL_ADD_INT(ctx, SYSCTL_CHILDREN(oid), OID_AUTO,
135                 "bmiss_max", CTLFLAG_RW, &ic->ic_bmiss_max, 0,
136                 "consecutive beacon misses before scanning");
137
138         ic->ic_sysctl = ctx;
139         ic->ic_sysctl_oid = oid;
140 }
141
142 void
143 ieee80211_sysctl_detach(struct ieee80211com *ic)
144 {
145         if (ic->ic_sysctl != NULL) {
146                 sysctl_ctx_free(ic->ic_sysctl);
147                 kfree(ic->ic_sysctl, M_DEVBUF);
148                 ic->ic_sysctl = NULL;
149         }
150 }
151
152 int
153 ieee80211_node_dectestref(struct ieee80211_node *ni)
154 {
155         /* XXX need equivalent of atomic_dec_and_test */
156         atomic_subtract_int(&ni->ni_refcnt, 1);
157         return atomic_cmpset_int(&ni->ni_refcnt, 0, 1);
158 }
159
160 /*
161  * Allocate and setup a management frame of the specified
162  * size.  We return the mbuf and a pointer to the start
163  * of the contiguous data area that's been reserved based
164  * on the packet length.  The data area is forced to 32-bit
165  * alignment and the buffer length to a multiple of 4 bytes.
166  * This is done mainly so beacon frames (that require this)
167  * can use this interface too.
168  */
169 struct mbuf *
170 ieee80211_getmgtframe(uint8_t **frm, u_int pktlen)
171 {
172         struct mbuf *m;
173         u_int len;
174
175         /*
176          * NB: we know the mbuf routines will align the data area
177          *     so we don't need to do anything special.
178          */
179         /* XXX 4-address frame? */
180         len = roundup(sizeof(struct ieee80211_frame) + pktlen, 4);
181         KASSERT(len <= MCLBYTES, ("802.11 mgt frame too large: %u", len));
182         if (len < MINCLSIZE) {
183                 m = m_gethdr(M_NOWAIT, MT_HEADER);
184                 /*
185                  * Align the data in case additional headers are added.
186                  * This should only happen when a WEP header is added
187                  * which only happens for shared key authentication mgt
188                  * frames which all fit in MHLEN.
189                  */
190                 if (m != NULL)
191                         MH_ALIGN(m, len);
192         } else
193                 m = m_getcl(M_NOWAIT, MT_HEADER, M_PKTHDR);
194         if (m != NULL) {
195                 m->m_data += sizeof(struct ieee80211_frame);
196                 *frm = m->m_data;
197         }
198         return m;
199 }
200
201 #include <sys/libkern.h>
202
203 void
204 get_random_bytes(void *p, size_t n)
205 {
206         uint8_t *dp = p;
207
208         while (n > 0) {
209                 uint32_t v = karc4random();
210                 size_t nb = n > sizeof(uint32_t) ? sizeof(uint32_t) : n;
211
212                 bcopy(&v, dp, n > sizeof(uint32_t) ? sizeof(uint32_t) : n);
213                 dp += sizeof(uint32_t), n -= nb;
214         }
215 }
216
217 void
218 ieee80211_notify_node_join(struct ieee80211com *ic, struct ieee80211_node *ni,
219                            int newassoc)
220 {
221         struct ifnet *ifp = ic->ic_ifp;
222         struct ieee80211_join_event iev;
223
224         memset(&iev, 0, sizeof(iev));
225         if (ni == ic->ic_bss) {
226                 IEEE80211_ADDR_COPY(iev.iev_addr, ni->ni_bssid);
227                 rt_ieee80211msg(ifp, newassoc ?
228                         RTM_IEEE80211_ASSOC : RTM_IEEE80211_REASSOC,
229                         &iev, sizeof(iev));
230                 if_link_state_change(ifp, LINK_STATE_UP);
231         } else {
232                 IEEE80211_ADDR_COPY(iev.iev_addr, ni->ni_macaddr);
233                 rt_ieee80211msg(ifp, newassoc ?
234                         RTM_IEEE80211_JOIN : RTM_IEEE80211_REJOIN,
235                         &iev, sizeof(iev));
236         }
237 }
238
239 void
240 ieee80211_notify_node_leave(struct ieee80211com *ic, struct ieee80211_node *ni)
241 {
242         struct ifnet *ifp = ic->ic_ifp;
243         struct ieee80211_leave_event iev;
244
245         if (ni == ic->ic_bss) {
246                 rt_ieee80211msg(ifp, RTM_IEEE80211_DISASSOC, NULL, 0);
247                 if_link_state_change(ifp, LINK_STATE_DOWN);
248         } else {
249                 /* fire off wireless event station leaving */
250                 memset(&iev, 0, sizeof(iev));
251                 IEEE80211_ADDR_COPY(iev.iev_addr, ni->ni_macaddr);
252                 rt_ieee80211msg(ifp, RTM_IEEE80211_LEAVE, &iev, sizeof(iev));
253         }
254 }
255
256 void
257 ieee80211_notify_scan_done(struct ieee80211com *ic)
258 {
259         struct ifnet *ifp = ic->ic_ifp;
260
261         IEEE80211_DPRINTF(ic, IEEE80211_MSG_SCAN,
262                 "%s: notify scan done\n", ic->ic_ifp->if_xname);
263
264         /* dispatch wireless event indicating scan completed */
265         rt_ieee80211msg(ifp, RTM_IEEE80211_SCAN, NULL, 0);
266 }
267
268 void
269 ieee80211_notify_replay_failure(struct ieee80211com *ic,
270         const struct ieee80211_frame *wh, const struct ieee80211_key *k,
271         uint64_t rsc)
272 {
273         struct ifnet *ifp = ic->ic_ifp;
274
275         IEEE80211_DPRINTF(ic, IEEE80211_MSG_CRYPTO,
276             "[%6D] %s replay detected <rsc %ju, csc %ju, keyix %u rxkeyix %u>\n",
277             wh->i_addr2, ":", k->wk_cipher->ic_name,
278             (intmax_t) rsc, (intmax_t) k->wk_keyrsc,
279             k->wk_keyix, k->wk_rxkeyix);
280
281         if (ifp != NULL) {              /* NB: for cipher test modules */
282                 struct ieee80211_replay_event iev;
283
284                 IEEE80211_ADDR_COPY(iev.iev_dst, wh->i_addr1);
285                 IEEE80211_ADDR_COPY(iev.iev_src, wh->i_addr2);
286                 iev.iev_cipher = k->wk_cipher->ic_cipher;
287                 if (k->wk_rxkeyix != IEEE80211_KEYIX_NONE)
288                         iev.iev_keyix = k->wk_rxkeyix;
289                 else
290                         iev.iev_keyix = k->wk_keyix;
291                 iev.iev_keyrsc = k->wk_keyrsc;
292                 iev.iev_rsc = rsc;
293                 rt_ieee80211msg(ifp, RTM_IEEE80211_REPLAY, &iev, sizeof(iev));
294         }
295 }
296
297 void
298 ieee80211_notify_michael_failure(struct ieee80211com *ic,
299         const struct ieee80211_frame *wh, u_int keyix)
300 {
301         struct ifnet *ifp = ic->ic_ifp;
302
303         IEEE80211_DPRINTF(ic, IEEE80211_MSG_CRYPTO,
304                 "[%6D] michael MIC verification failed <keyix %u>\n",
305                wh->i_addr2, ":", keyix);
306         ic->ic_stats.is_rx_tkipmic++;
307
308         if (ifp != NULL) {              /* NB: for cipher test modules */
309                 struct ieee80211_michael_event iev;
310
311                 IEEE80211_ADDR_COPY(iev.iev_dst, wh->i_addr1);
312                 IEEE80211_ADDR_COPY(iev.iev_src, wh->i_addr2);
313                 iev.iev_cipher = IEEE80211_CIPHER_TKIP;
314                 iev.iev_keyix = keyix;
315                 rt_ieee80211msg(ifp, RTM_IEEE80211_MICHAEL, &iev, sizeof(iev));
316         }
317 }
318
319 void
320 ieee80211_load_module(const char *modname)
321 {
322 #ifdef notyet
323         struct thread *td = curthread;
324
325         if (suser(td) == 0 && securelevel_gt(td->td_ucred, 0) == 0) {
326                 crit_enter();   /* NB: need BGL here */
327                 linker_load_module(modname, NULL, NULL, NULL, NULL);
328                 crit_exit();
329         }
330 #else
331         printf("%s: load the %s module by hand for now.\n", __func__, modname);
332 #endif
333 }
334
335 /*
336  * Append the specified data to the indicated mbuf chain,
337  * Extend the mbuf chain if the new data does not fit in
338  * existing space.
339  *
340  * Return 1 if able to complete the job; otherwise 0.
341  */
342 int
343 ieee80211_mbuf_append(struct mbuf *m0, int len, const uint8_t *cp)
344 {
345         struct mbuf *m, *n;
346         int remainder, space;
347
348         for (m = m0; m->m_next != NULL; m = m->m_next)
349                 ;
350         remainder = len;
351         space = M_TRAILINGSPACE(m);
352         if (space > 0) {
353                 /*
354                  * Copy into available space.
355                  */
356                 if (space > remainder)
357                         space = remainder;
358                 bcopy(cp, mtod(m, caddr_t) + m->m_len, space);
359                 m->m_len += space;
360                 cp += space, remainder -= space;
361         }
362         while (remainder > 0) {
363                 /*
364                  * Allocate a new mbuf; could check space
365                  * and allocate a cluster instead.
366                  */
367                 n = m_get(MB_DONTWAIT, m->m_type);
368                 if (n == NULL)
369                         break;
370                 n->m_len = min(MLEN, remainder);
371                 bcopy(cp, mtod(n, caddr_t), n->m_len);
372                 cp += n->m_len, remainder -= n->m_len;
373                 m->m_next = n;
374                 m = n;
375         }
376         if (m0->m_flags & M_PKTHDR)
377                 m0->m_pkthdr.len += len - remainder;
378         return (remainder == 0);
379 }
380
381 /*
382  * Create a writable copy of the mbuf chain.  While doing this
383  * we compact the chain with a goal of producing a chain with
384  * at most two mbufs.  The second mbuf in this chain is likely
385  * to be a cluster.  The primary purpose of this work is to create
386  * a writable packet for encryption, compression, etc.  The
387  * secondary goal is to linearize the data so the data can be
388  * passed to crypto hardware in the most efficient manner possible.
389  */
390 struct mbuf *
391 ieee80211_mbuf_clone(struct mbuf *m0, int how)
392 {
393         struct mbuf *m, *mprev;
394         struct mbuf *n, *mfirst, *mlast;
395         int len, off;
396
397         mprev = NULL;
398         for (m = m0; m != NULL; m = mprev->m_next) {
399                 /*
400                  * Regular mbufs are ignored unless there's a cluster
401                  * in front of it that we can use to coalesce.  We do
402                  * the latter mainly so later clusters can be coalesced
403                  * also w/o having to handle them specially (i.e. convert
404                  * mbuf+cluster -> cluster).  This optimization is heavily
405                  * influenced by the assumption that we're running over
406                  * Ethernet where MCLBYTES is large enough that the max
407                  * packet size will permit lots of coalescing into a
408                  * single cluster.  This in turn permits efficient
409                  * crypto operations, especially when using hardware.
410                  */
411                 if ((m->m_flags & M_EXT) == 0) {
412                         if (mprev && (mprev->m_flags & M_EXT) &&
413                             m->m_len <= M_TRAILINGSPACE(mprev)) {
414                                 /* XXX: this ignores mbuf types */
415                                 memcpy(mtod(mprev, caddr_t) + mprev->m_len,
416                                        mtod(m, caddr_t), m->m_len);
417                                 mprev->m_len += m->m_len;
418                                 mprev->m_next = m->m_next;      /* unlink from chain */
419                                 m_free(m);                      /* reclaim mbuf */
420                         } else {
421                                 mprev = m;
422                         }
423                         continue;
424                 }
425                 /*
426                  * Writable mbufs are left alone (for now).
427                  */
428                 if (M_WRITABLE(m)) {
429                         mprev = m;
430                         continue;
431                 }
432
433                 /*
434                  * Not writable, replace with a copy or coalesce with
435                  * the previous mbuf if possible (since we have to copy
436                  * it anyway, we try to reduce the number of mbufs and
437                  * clusters so that future work is easier).
438                  */
439                 KASSERT(m->m_flags & M_EXT, ("m_flags 0x%x", m->m_flags));
440                 /* NB: we only coalesce into a cluster or larger */
441                 if (mprev != NULL && (mprev->m_flags & M_EXT) &&
442                     m->m_len <= M_TRAILINGSPACE(mprev)) {
443                         /* XXX: this ignores mbuf types */
444                         memcpy(mtod(mprev, caddr_t) + mprev->m_len,
445                                mtod(m, caddr_t), m->m_len);
446                         mprev->m_len += m->m_len;
447                         mprev->m_next = m->m_next;      /* unlink from chain */
448                         m_free(m);                      /* reclaim mbuf */
449                         continue;
450                 }
451
452                 /*
453                  * Allocate new space to hold the copy...
454                  */
455                 /* XXX why can M_PKTHDR be set past the first mbuf? */
456                 if (mprev == NULL && (m->m_flags & M_PKTHDR)) {
457                         /*
458                          * NB: if a packet header is present we must
459                          * allocate the mbuf separately from any cluster
460                          * because M_MOVE_PKTHDR will smash the data
461                          * pointer and drop the M_EXT marker.
462                          */
463                         MGETHDR(n, how, m->m_type);
464                         if (n == NULL) {
465                                 m_freem(m0);
466                                 return (NULL);
467                         }
468                         M_MOVE_PKTHDR(n, m);
469                         MCLGET(n, how);
470                         if ((n->m_flags & M_EXT) == 0) {
471                                 m_free(n);
472                                 m_freem(m0);
473                                 return (NULL);
474                         }
475                 } else {
476                         n = m_getcl(how, m->m_type, m->m_flags);
477                         if (n == NULL) {
478                                 m_freem(m0);
479                                 return (NULL);
480                         }
481                 }
482                 /*
483                  * ... and copy the data.  We deal with jumbo mbufs
484                  * (i.e. m_len > MCLBYTES) by splitting them into
485                  * clusters.  We could just malloc a buffer and make
486                  * it external but too many device drivers don't know
487                  * how to break up the non-contiguous memory when
488                  * doing DMA.
489                  */
490                 len = m->m_len;
491                 off = 0;
492                 mfirst = n;
493                 mlast = NULL;
494                 for (;;) {
495                         int cc = min(len, MCLBYTES);
496                         memcpy(mtod(n, caddr_t), mtod(m, caddr_t) + off, cc);
497                         n->m_len = cc;
498                         if (mlast != NULL)
499                                 mlast->m_next = n;
500                         mlast = n;      
501
502                         len -= cc;
503                         if (len <= 0)
504                                 break;
505                         off += cc;
506
507                         n = m_getcl(how, m->m_type, m->m_flags);
508                         if (n == NULL) {
509                                 m_freem(mfirst);
510                                 m_freem(m0);
511                                 return (NULL);
512                         }
513                 }
514                 n->m_next = m->m_next; 
515                 if (mprev == NULL)
516                         m0 = mfirst;            /* new head of chain */
517                 else
518                         mprev->m_next = mfirst; /* replace old mbuf */
519                 m_free(m);                      /* release old mbuf */
520                 mprev = mfirst;
521         }
522         return (m0);
523 }
524
525 /*
526  * Module glue.
527  *
528  * NB: the module name is "wlan" for compatibility with NetBSD.
529  */
530 static int
531 wlan_modevent(module_t mod, int type, void *unused)
532 {
533         switch (type) {
534         case MOD_LOAD:
535                 if (bootverbose)
536                         printf("wlan: <802.11 Link Layer>\n");
537                 return 0;
538         case MOD_UNLOAD:
539                 return 0;
540         }
541         return EINVAL;
542 }
543
544 static moduledata_t wlan_mod = {
545         "wlan",
546         wlan_modevent,
547         0
548 };
549 DECLARE_MODULE(wlan, wlan_mod, SI_SUB_DRIVERS, SI_ORDER_FIRST);
550 MODULE_VERSION(wlan, 1);
551 MODULE_DEPEND(wlan, crypto, 1, 1, 1);