sys/bus/usb/usb_ethersubr.c

   1 /*
   2  * Copyright (c) 1997, 1998, 1999, 2000
   3  *      Bill Paul <wpaul@ee.columbia.edu>.  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. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *      This product includes software developed by Bill Paul.
  16  * 4. Neither the name of the author nor the names of any co-contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
  21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
  24  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  30  * THE POSSIBILITY OF SUCH DAMAGE.
  31  *
  32  *
  33  * $FreeBSD: src/sys/dev/usb/usb_ethersubr.c,v 1.17 2003/11/14 11:09:45 johan Exp $
  34  * $DragonFly: src/sys/bus/usb/usb_ethersubr.c,v 1.6 2003/12/30 01:01:44 dillon Exp $
  35  */
  36
  37 /*
  38  * Callbacks in the USB code operate at splusb() (actually splbio()
  39  * in FreeBSD). However adding packets to the input queues has to be
  40  * done at splimp(). It is conceivable that this arrangement could
  41  * trigger a condition where the splimp() is ignored and the input
  42  * queues could get trampled in spite of our best effors to prevent
  43  * it. To work around this, we implement a special input queue for
  44  * USB ethernet adapter drivers. Rather than passing the frames directly
  45  * to ether_input(), we pass them here, then schedule a soft interrupt
  46  * to hand them to ether_input() later, outside of the USB interrupt
  47  * context.
  48  *
  49  * It's questional as to whether this code should be expanded to
  50  * handle other kinds of devices, or handle USB transfer callbacks
  51  * in general. Right now, I need USB network interfaces to work
  52  * properly.
  53  */
  54
  55 #include <sys/param.h>
  56 #include <sys/systm.h>
  57 #include <sys/sockio.h>
  58 #include <sys/mbuf.h>
  59 #include <sys/malloc.h>
  60 #include <sys/socket.h>
  61
  62 #include <net/if.h>
  63 #include <net/if_types.h>
  64 #include <net/if_arp.h>
  65 #include <net/ethernet.h>
  66 #include <net/netisr.h>
  67 #include <net/bpf.h>
  68
  69 #include "usb.h"
  70 #include "usb_ethersubr.h"
  71
  72 Static struct ifqueue usbq_rx;
  73 Static struct ifqueue usbq_tx;
  74 Static int mtx_inited = 0;
  75
  76 Static void usbintr(struct mbuf *m);
  77
  78 Static void usbintr(struct mbuf *m)     /* dummy mbuf */
  79 {
  80         struct ether_header     *eh;
  81         struct usb_qdat         *q;
  82         struct ifnet            *ifp;
  83         int                     s;
  84
  85         s = splimp();
  86
  87         /* Check the RX queue */
  88         while(1) {
  89                 IF_DEQUEUE(&usbq_rx, m);
  90                 if (m == NULL)
  91                         break;
  92                 eh = mtod(m, struct ether_header *);
  93                 q = (struct usb_qdat *)m->m_pkthdr.rcvif;
  94                 ifp = q->ifp;
  95                 m->m_pkthdr.rcvif = ifp;
  96                 m_adj(m, sizeof(struct ether_header));
  97                 ether_input(ifp, eh, m);
  98
  99                 /* Re-arm the receiver */
 100                 (*q->if_rxstart)(ifp);
 101                 if (ifp->if_snd.ifq_head != NULL)
 102                         (*ifp->if_start)(ifp);
 103         }
 104
 105         /* Check the TX queue */
 106         while(1) {
 107                 IF_DEQUEUE(&usbq_tx, m);
 108                 if (m == NULL)
 109                         break;
 110                 ifp = m->m_pkthdr.rcvif;
 111                 m_freem(m);
 112                 if (ifp->if_snd.ifq_head != NULL)
 113                         (*ifp->if_start)(ifp);
 114         }
 115
 116         splx(s);
 117
 118         return;
 119 }
 120
 121 void
 122 usb_register_netisr(void)
 123 {
 124         if (mtx_inited)
 125                 return;
 126         mtx_inited = 1;
 127         netisr_register(NETISR_USB, cpu0_portfn, usbintr);
 128         return;
 129 }
 130
 131 /*
 132  * Must be called at splusb() (actually splbio()). This should be
 133  * the case when called from a transfer callback routine.
 134  */
 135 void
 136 usb_ether_input(struct mbuf *m)
 137 {
 138         netisr_queue(NETISR_USB, m);
 139 }
 140
 141 void
 142 usb_tx_done(struct mbuf *m)
 143 {
 144         netisr_queue(NETISR_USB, m);
 145 }