DEV messaging stage 2/4: In this stage all DEV commands are now being
[dragonfly.git] / 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  * $FreeBSD: src/sys/dev/usb/usb_ethersubr.c,v 1.4.2.4 2002/11/06 14:23:20 joe Exp $
33  * $DragonFly: src/sys/bus/usb/usb_ethersubr.c,v 1.2 2003/06/17 04:28:32 dillon Exp $
34  *
35  * $FreeBSD: src/sys/dev/usb/usb_ethersubr.c,v 1.4.2.4 2002/11/06 14:23:20 joe Exp $
36  */
37
38 /*
39  * Callbacks in the USB code operate at splusb() (actually splbio()
40  * in FreeBSD). However adding packets to the input queues has to be
41  * done at splimp(). It is conceivable that this arrangement could
42  * trigger a condition where the splimp() is ignored and the input
43  * queues could get trampled in spite of our best effors to prevent
44  * it. To work around this, we implement a special input queue for
45  * USB ethernet adapter drivers. Rather than passing the frames directly
46  * to ether_input(), we pass them here, then schedule a soft interrupt
47  * to hand them to ether_input() later, outside of the USB interrupt
48  * context.
49  *
50  * It's questional as to whether this code should be expanded to
51  * handle other kinds of devices, or handle USB transfer callbacks
52  * in general. Right now, I need USB network interfaces to work
53  * properly.
54  */
55
56 #include <sys/param.h>
57 #include <sys/systm.h>
58 #include <sys/sockio.h>
59 #include <sys/mbuf.h>
60 #include <sys/malloc.h>
61 #include <sys/socket.h>
62
63 #include <net/if.h>
64 #include <net/if_types.h>
65 #include <net/if_arp.h>
66 #include <net/ethernet.h>
67 #include <net/netisr.h>
68 #include <net/bpf.h>
69
70 #include <dev/usb/usb.h>
71 #include <dev/usb/usb_ethersubr.h>
72
73 Static struct ifqueue usbq_rx;
74 Static struct ifqueue usbq_tx;
75
76 Static void usbintr             (void);
77
78 Static void usbintr()
79 {
80         struct ether_header     *eh;
81         struct mbuf             *m;
82         struct usb_qdat         *q;
83         struct ifnet            *ifp;
84         int                     s;
85
86         s = splimp();
87
88         /* Check the RX queue */
89         while(1) {
90                 IF_DEQUEUE(&usbq_rx, m);
91                 if (m == NULL)
92                         break;
93                 eh = mtod(m, struct ether_header *);
94                 q = (struct usb_qdat *)m->m_pkthdr.rcvif;
95                 ifp = q->ifp;
96                 m->m_pkthdr.rcvif = ifp;
97                 m_adj(m, sizeof(struct ether_header));
98                 ether_input(ifp, eh, m);
99
100                 /* Re-arm the receiver */
101                 (*q->if_rxstart)(ifp);
102                 if (ifp->if_snd.ifq_head != NULL)
103                         (*ifp->if_start)(ifp);
104         }
105
106         /* Check the TX queue */
107         while(1) {
108                 IF_DEQUEUE(&usbq_tx, m);
109                 if (m == NULL)
110                         break;
111                 ifp = m->m_pkthdr.rcvif;
112                 m_freem(m);
113                 if (ifp->if_snd.ifq_head != NULL)
114                         (*ifp->if_start)(ifp);
115         }
116
117         splx(s);
118
119         return;
120 }
121
122 void usb_register_netisr()
123 {
124         register_netisr(NETISR_USB, usbintr);
125         return;
126 }
127
128 /*
129  * Must be called at splusp() (actually splbio()). This should be
130  * the case when called from a transfer callback routine.
131  */
132 void usb_ether_input(m)
133         struct mbuf             *m;
134 {
135         int                     s;
136         s = splimp();
137         IF_ENQUEUE(&usbq_rx, m);
138         schednetisr(NETISR_USB);
139         splx(s);
140         return;
141 }
142
143 void usb_tx_done(m)
144         struct mbuf             *m;
145 {
146         int                     s;
147         s = splimp();
148         IF_ENQUEUE(&usbq_tx, m);
149         schednetisr(NETISR_USB);
150         splx(s);
151         return;
152 }