sys/dev/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 #include <sys/cdefs.h>
  34 __FBSDID("$FreeBSD$");
  35
  36 /*
  37  * Callbacks in the USB code operate at splusb() (actually splbio()
  38  * in FreeBSD). However adding packets to the input queues has to be
  39  * done at splimp(). It is conceivable that this arrangement could
  40  * trigger a condition where the splimp() is ignored and the input
  41  * queues could get trampled in spite of our best effors to prevent
  42  * it. To work around this, we implement a special input queue for
  43  * USB ethernet adapter drivers. Rather than passing the frames directly
  44  * to ether_input(), we pass them here, then schedule a soft interrupt
  45  * to hand them to ether_input() later, outside of the USB interrupt
  46  * context.
  47  *
  48  * It's questional as to whether this code should be expanded to
  49  * handle other kinds of devices, or handle USB transfer callbacks
  50  * in general. Right now, I need USB network interfaces to work
  51  * properly.
  52  */
  53
  54 #include <sys/param.h>
  55 #include <sys/systm.h>
  56 #include <sys/sockio.h>
  57 #include <sys/mbuf.h>
  58 #include <sys/malloc.h>
  59 #include <sys/socket.h>
  60 #include <sys/taskqueue.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 <dev/usb/usb.h>
  70 #include <dev/usb/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             (void);
  77
  78 static void
  79 usbintr(void)
  80 {
  81         struct mbuf             *m;
  82         struct usb_qdat         *q;
  83         struct ifnet            *ifp;
  84
  85         mtx_lock(&Giant);
  86
  87         /* Check the RX queue */
  88         while(1) {
  89                 IF_DEQUEUE(&usbq_rx, m);
  90                 if (m == NULL)
  91                         break;
  92                 q = (struct usb_qdat *)m->m_pkthdr.rcvif;
  93                 ifp = q->ifp;
  94                 m->m_pkthdr.rcvif = ifp;
  95                 (*ifp->if_input)(ifp, m);
  96
  97                 /* Re-arm the receiver */
  98                 (*q->if_rxstart)(ifp);
  99                 if (ifp->if_snd.ifq_head != NULL)
 100                         (*ifp->if_start)(ifp);
 101         }
 102
 103         /* Check the TX queue */
 104         while(1) {
 105                 IF_DEQUEUE(&usbq_tx, m);
 106                 if (m == NULL)
 107                         break;
 108                 ifp = m->m_pkthdr.rcvif;
 109                 m_freem(m);
 110                 if (ifp->if_snd.ifq_head != NULL)
 111                         (*ifp->if_start)(ifp);
 112         }
 113
 114         mtx_unlock(&Giant);
 115
 116         return;
 117 }
 118
 119 void
 120 usb_register_netisr(void)
 121 {
 122         if (mtx_inited)
 123                 return;
 124         netisr_register(NETISR_USB, (netisr_t *)usbintr, NULL,
 125             NETISR_FORCEQUEUE);
 126         mtx_init(&usbq_tx.ifq_mtx, "usbq_tx_mtx", NULL, MTX_DEF);
 127         mtx_init(&usbq_rx.ifq_mtx, "usbq_rx_mtx", NULL, MTX_DEF);
 128         mtx_inited++;
 129         return;
 130 }
 131
 132 /*
 133  * Must be called at splusb() (actually splbio()). This should be
 134  * the case when called from a transfer callback routine.
 135  */
 136 void
 137 usb_ether_input(m)
 138         struct mbuf             *m;
 139 {
 140         IF_ENQUEUE(&usbq_rx, m);
 141         schednetisr(NETISR_USB);
 142
 143         return;
 144 }
 145
 146 void
 147 usb_tx_done(m)
 148         struct mbuf             *m;
 149 {
 150         IF_ENQUEUE(&usbq_tx, m);
 151         schednetisr(NETISR_USB);
 152
 153         return;
 154 }
 155
 156 struct mbuf *
 157 usb_ether_newbuf(void)
 158 {
 159         struct mbuf *m_new;
 160
 161         m_new = m_getcl(M_DONTWAIT, MT_DATA, M_PKTHDR);
 162         if (m_new == NULL)
 163                 return (NULL);
 164         m_new->m_len = m_new->m_pkthdr.len = MCLBYTES;
 165
 166         m_adj(m_new, ETHER_ALIGN);
 167         return (m_new);
 168 }
 169
 170 int
 171 usb_ether_rx_list_init(void *sc, struct ue_cdata *cd,
 172     usbd_device_handle ue_udev)
 173 {
 174         struct ue_chain *c;
 175         int i;
 176
 177         for (i = 0; i < UE_RX_LIST_CNT; i++) {
 178                 c = &cd->ue_rx_chain[i];
 179                 c->ue_sc = sc;
 180                 c->ue_idx = i;
 181                 c->ue_mbuf = usb_ether_newbuf();
 182                 if (c->ue_mbuf == NULL)
 183                         return (ENOBUFS);
 184                 if (c->ue_xfer == NULL) {
 185                         c->ue_xfer = usbd_alloc_xfer(ue_udev);
 186                         if (c->ue_xfer == NULL)
 187                                 return (ENOBUFS);
 188                         c->ue_buf = usbd_alloc_buffer(c->ue_xfer, UE_BUFSZ);
 189                         if (c->ue_buf == NULL)
 190                                 return (ENOBUFS);
 191                 }
 192         }
 193
 194         return (0);
 195 }
 196
 197 int
 198 usb_ether_tx_list_init(void *sc, struct ue_cdata *cd,
 199     usbd_device_handle ue_udev)
 200 {
 201         struct ue_chain *c;
 202         int i;
 203
 204         for (i = 0; i < UE_TX_LIST_CNT; i++) {
 205                 c = &cd->ue_tx_chain[i];
 206                 c->ue_sc = sc;
 207                 c->ue_idx = i;
 208                 c->ue_mbuf = NULL;
 209                 if (c->ue_xfer == NULL) {
 210                         c->ue_xfer = usbd_alloc_xfer(ue_udev);
 211                         if (c->ue_xfer == NULL)
 212                                 return (ENOBUFS);
 213                         c->ue_buf = usbd_alloc_buffer(c->ue_xfer, UE_BUFSZ);
 214                         if (c->ue_buf == NULL)
 215                                 return (ENOBUFS);
 216                 }
 217         }
 218
 219         return (0);
 220 }
 221
 222 void
 223 usb_ether_rx_list_free(struct ue_cdata *cd)
 224 {
 225         int i;
 226
 227         for (i = 0; i < UE_RX_LIST_CNT; i++) {
 228                 if (cd->ue_rx_chain[i].ue_mbuf != NULL) {
 229                         m_freem(cd->ue_rx_chain[i].ue_mbuf);
 230                         cd->ue_rx_chain[i].ue_mbuf = NULL;
 231                 }
 232                 if (cd->ue_rx_chain[i].ue_xfer != NULL) {
 233                         usbd_free_xfer(cd->ue_rx_chain[i].ue_xfer);
 234                         cd->ue_rx_chain[i].ue_xfer = NULL;
 235                 }
 236         }
 237 }
 238
 239 void
 240 usb_ether_tx_list_free(struct ue_cdata *cd)
 241 {
 242         int i;
 243
 244         for (i = 0; i < UE_RX_LIST_CNT; i++) {
 245                 if (cd->ue_tx_chain[i].ue_mbuf != NULL) {
 246                         m_freem(cd->ue_tx_chain[i].ue_mbuf);
 247                         cd->ue_tx_chain[i].ue_mbuf = NULL;
 248                 }
 249                 if (cd->ue_tx_chain[i].ue_xfer != NULL) {
 250                         usbd_free_xfer(cd->ue_tx_chain[i].ue_xfer);
 251                         cd->ue_tx_chain[i].ue_xfer = NULL;
 252                 }
 253         }
 254 }
 255
 256 void
 257 usb_ether_task_init(device_t dev, int flags, struct usb_taskqueue *tq)
 258 {
 259
 260         /* nothing for now. */
 261 }
 262
 263 void
 264 usb_ether_task_enqueue(struct usb_taskqueue *tq, struct task *task)
 265 {
 266
 267         taskqueue_enqueue(taskqueue_thread, task);
 268 }
 269
 270 void
 271 usb_ether_task_drain(struct usb_taskqueue *tq, struct task *task)
 272 {
 273
 274         taskqueue_drain(taskqueue_thread, task);
 275 }
 276
 277 void
 278 usb_ether_task_destroy(struct usb_taskqueue *tq)
 279 {
 280
 281         /* nothing for now */
 282
 283 }