3 * Copyright (c) 2009 Andrew Thompson (thompsa@FreeBSD.org)
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/stdint.h>
28 #include <sys/stddef.h>
29 #include <sys/param.h>
30 #include <sys/queue.h>
31 #include <sys/types.h>
32 #include <sys/systm.h>
33 #include <sys/kernel.h>
35 #include <sys/module.h>
37 #include <sys/mutex.h>
38 #include <sys/condvar.h>
39 #include <sys/sysctl.h>
41 #include <sys/unistd.h>
42 #include <sys/callout.h>
43 #include <sys/malloc.h>
46 #include <dev/usb/usb.h>
47 #include <dev/usb/usbdi.h>
49 #include <dev/usb/usb_process.h>
50 #include <dev/usb/net/usb_ethernet.h>
52 SYSCTL_NODE(_net, OID_AUTO, ue, CTLFLAG_RD, 0, "USB Ethernet parameters");
54 #define UE_LOCK(_ue) mtx_lock((_ue)->ue_mtx)
55 #define UE_UNLOCK(_ue) mtx_unlock((_ue)->ue_mtx)
56 #define UE_LOCK_ASSERT(_ue, t) mtx_assert((_ue)->ue_mtx, t)
58 MODULE_DEPEND(uether, usb, 1, 1, 1);
59 MODULE_DEPEND(uether, miibus, 1, 1, 1);
61 static struct unrhdr *ueunit;
63 static usb_proc_callback_t ue_attach_post_task;
64 static usb_proc_callback_t ue_promisc_task;
65 static usb_proc_callback_t ue_setmulti_task;
66 static usb_proc_callback_t ue_ifmedia_task;
67 static usb_proc_callback_t ue_tick_task;
68 static usb_proc_callback_t ue_start_task;
69 static usb_proc_callback_t ue_stop_task;
71 static void ue_init(void *);
72 static void ue_start(struct ifnet *);
73 static int ue_ifmedia_upd(struct ifnet *);
74 static void ue_watchdog(void *);
79 * Else: device has been detached
82 uether_pause(struct usb_ether *ue, unsigned int _ticks)
84 if (usb_proc_is_gone(&ue->ue_tq)) {
88 usb_pause_mtx(ue->ue_mtx, _ticks);
93 ue_queue_command(struct usb_ether *ue,
94 usb_proc_callback_t *fn,
95 struct usb_proc_msg *t0, struct usb_proc_msg *t1)
97 struct usb_ether_cfg_task *task;
99 UE_LOCK_ASSERT(ue, MA_OWNED);
101 if (usb_proc_is_gone(&ue->ue_tq)) {
102 return; /* nothing to do */
105 * NOTE: The task cannot get executed before we drop the
106 * "sc_mtx" mutex. It is safe to update fields in the message
107 * structure after that the message got queued.
109 task = (struct usb_ether_cfg_task *)
110 usb_proc_msignal(&ue->ue_tq, t0, t1);
112 /* Setup callback and self pointers */
113 task->hdr.pm_callback = fn;
117 * Start and stop must be synchronous!
119 if ((fn == ue_start_task) || (fn == ue_stop_task))
120 usb_proc_mwait(&ue->ue_tq, t0, t1);
124 uether_getifp(struct usb_ether *ue)
130 uether_getmii(struct usb_ether *ue)
132 return (device_get_softc(ue->ue_miibus));
136 uether_getsc(struct usb_ether *ue)
142 ue_sysctl_parent(SYSCTL_HANDLER_ARGS)
144 struct usb_ether *ue = arg1;
147 name = device_get_nameunit(ue->ue_dev);
148 return SYSCTL_OUT(req, name, strlen(name));
152 uether_ifattach(struct usb_ether *ue)
156 /* check some critical parameters */
157 if ((ue->ue_dev == NULL) ||
158 (ue->ue_udev == NULL) ||
159 (ue->ue_mtx == NULL) ||
160 (ue->ue_methods == NULL))
163 error = usb_proc_create(&ue->ue_tq, ue->ue_mtx,
164 device_get_nameunit(ue->ue_dev), USB_PRI_MED);
166 device_printf(ue->ue_dev, "could not setup taskqueue\n");
170 /* fork rest of the attach code */
172 ue_queue_command(ue, ue_attach_post_task,
173 &ue->ue_sync_task[0].hdr,
174 &ue->ue_sync_task[1].hdr);
182 ue_attach_post_task(struct usb_proc_msg *_task)
184 struct usb_ether_cfg_task *task =
185 (struct usb_ether_cfg_task *)_task;
186 struct usb_ether *ue = task->ue;
189 char num[14]; /* sufficient for 32 bits */
191 /* first call driver's post attach routine */
192 ue->ue_methods->ue_attach_post(ue);
196 ue->ue_unit = alloc_unr(ueunit);
197 usb_callout_init_mtx(&ue->ue_watchdog, ue->ue_mtx, 0);
198 sysctl_ctx_init(&ue->ue_sysctl_ctx);
200 ifp = if_alloc(IFT_ETHER);
202 device_printf(ue->ue_dev, "could not allocate ifnet\n");
207 if_initname(ifp, "ue", ue->ue_unit);
208 ifp->if_mtu = ETHERMTU;
209 ifp->if_flags = IFF_BROADCAST | IFF_SIMPLEX | IFF_MULTICAST;
210 if (ue->ue_methods->ue_ioctl != NULL)
211 ifp->if_ioctl = ue->ue_methods->ue_ioctl;
213 ifp->if_ioctl = uether_ioctl;
214 ifp->if_start = ue_start;
215 ifp->if_init = ue_init;
216 IFQ_SET_MAXLEN(&ifp->if_snd, ifqmaxlen);
217 ifp->if_snd.ifq_drv_maxlen = ifqmaxlen;
218 IFQ_SET_READY(&ifp->if_snd);
221 if (ue->ue_methods->ue_mii_upd != NULL &&
222 ue->ue_methods->ue_mii_sts != NULL) {
223 mtx_lock(&Giant); /* device_xxx() depends on this */
224 error = mii_attach(ue->ue_dev, &ue->ue_miibus, ifp,
225 ue_ifmedia_upd, ue->ue_methods->ue_mii_sts,
226 BMSR_DEFCAPMASK, MII_PHY_ANY, MII_OFFSET_ANY, 0);
229 device_printf(ue->ue_dev, "attaching PHYs failed\n");
234 if_printf(ifp, "<USB Ethernet> on %s\n", device_get_nameunit(ue->ue_dev));
235 ether_ifattach(ifp, ue->ue_eaddr);
237 snprintf(num, sizeof(num), "%u", ue->ue_unit);
238 ue->ue_sysctl_oid = SYSCTL_ADD_NODE(&ue->ue_sysctl_ctx,
239 &SYSCTL_NODE_CHILDREN(_net, ue),
240 OID_AUTO, num, CTLFLAG_RD, NULL, "");
241 SYSCTL_ADD_PROC(&ue->ue_sysctl_ctx,
242 SYSCTL_CHILDREN(ue->ue_sysctl_oid), OID_AUTO,
243 "%parent", CTLTYPE_STRING | CTLFLAG_RD, ue, 0,
244 ue_sysctl_parent, "A", "parent device");
250 free_unr(ueunit, ue->ue_unit);
251 if (ue->ue_ifp != NULL) {
260 uether_ifdetach(struct usb_ether *ue)
264 /* wait for any post attach or other command to complete */
265 usb_proc_drain(&ue->ue_tq);
267 /* read "ifnet" pointer after taskqueue drain */
272 /* we are not running any more */
274 ifp->if_drv_flags &= ~IFF_DRV_RUNNING;
277 /* drain any callouts */
278 usb_callout_drain(&ue->ue_watchdog);
281 if (ue->ue_miibus != NULL) {
282 mtx_lock(&Giant); /* device_xxx() depends on this */
283 device_delete_child(ue->ue_dev, ue->ue_miibus);
287 /* detach ethernet */
290 /* free interface instance */
294 sysctl_ctx_free(&ue->ue_sysctl_ctx);
297 free_unr(ueunit, ue->ue_unit);
300 /* free taskqueue, if any */
301 usb_proc_free(&ue->ue_tq);
305 uether_is_gone(struct usb_ether *ue)
307 return (usb_proc_is_gone(&ue->ue_tq));
313 struct usb_ether *ue = arg;
316 ue_queue_command(ue, ue_start_task,
317 &ue->ue_sync_task[0].hdr,
318 &ue->ue_sync_task[1].hdr);
323 ue_start_task(struct usb_proc_msg *_task)
325 struct usb_ether_cfg_task *task =
326 (struct usb_ether_cfg_task *)_task;
327 struct usb_ether *ue = task->ue;
328 struct ifnet *ifp = ue->ue_ifp;
330 UE_LOCK_ASSERT(ue, MA_OWNED);
332 ue->ue_methods->ue_init(ue);
334 if ((ifp->if_drv_flags & IFF_DRV_RUNNING) == 0)
337 if (ue->ue_methods->ue_tick != NULL)
338 usb_callout_reset(&ue->ue_watchdog, hz, ue_watchdog, ue);
342 ue_stop_task(struct usb_proc_msg *_task)
344 struct usb_ether_cfg_task *task =
345 (struct usb_ether_cfg_task *)_task;
346 struct usb_ether *ue = task->ue;
348 UE_LOCK_ASSERT(ue, MA_OWNED);
350 usb_callout_stop(&ue->ue_watchdog);
352 ue->ue_methods->ue_stop(ue);
356 ue_start(struct ifnet *ifp)
358 struct usb_ether *ue = ifp->if_softc;
360 if ((ifp->if_drv_flags & IFF_DRV_RUNNING) == 0)
364 ue->ue_methods->ue_start(ue);
369 ue_promisc_task(struct usb_proc_msg *_task)
371 struct usb_ether_cfg_task *task =
372 (struct usb_ether_cfg_task *)_task;
373 struct usb_ether *ue = task->ue;
375 ue->ue_methods->ue_setpromisc(ue);
379 ue_setmulti_task(struct usb_proc_msg *_task)
381 struct usb_ether_cfg_task *task =
382 (struct usb_ether_cfg_task *)_task;
383 struct usb_ether *ue = task->ue;
385 ue->ue_methods->ue_setmulti(ue);
389 ue_ifmedia_upd(struct ifnet *ifp)
391 struct usb_ether *ue = ifp->if_softc;
393 /* Defer to process context */
395 ue_queue_command(ue, ue_ifmedia_task,
396 &ue->ue_media_task[0].hdr,
397 &ue->ue_media_task[1].hdr);
404 ue_ifmedia_task(struct usb_proc_msg *_task)
406 struct usb_ether_cfg_task *task =
407 (struct usb_ether_cfg_task *)_task;
408 struct usb_ether *ue = task->ue;
409 struct ifnet *ifp = ue->ue_ifp;
411 ue->ue_methods->ue_mii_upd(ifp);
415 ue_watchdog(void *arg)
417 struct usb_ether *ue = arg;
418 struct ifnet *ifp = ue->ue_ifp;
420 if ((ifp->if_drv_flags & IFF_DRV_RUNNING) == 0)
423 ue_queue_command(ue, ue_tick_task,
424 &ue->ue_tick_task[0].hdr,
425 &ue->ue_tick_task[1].hdr);
427 usb_callout_reset(&ue->ue_watchdog, hz, ue_watchdog, ue);
431 ue_tick_task(struct usb_proc_msg *_task)
433 struct usb_ether_cfg_task *task =
434 (struct usb_ether_cfg_task *)_task;
435 struct usb_ether *ue = task->ue;
436 struct ifnet *ifp = ue->ue_ifp;
438 if ((ifp->if_drv_flags & IFF_DRV_RUNNING) == 0)
441 ue->ue_methods->ue_tick(ue);
445 uether_ioctl(struct ifnet *ifp, u_long command, caddr_t data)
447 struct usb_ether *ue = ifp->if_softc;
448 struct ifreq *ifr = (struct ifreq *)data;
449 struct mii_data *mii;
455 if (ifp->if_flags & IFF_UP) {
456 if (ifp->if_drv_flags & IFF_DRV_RUNNING)
457 ue_queue_command(ue, ue_promisc_task,
458 &ue->ue_promisc_task[0].hdr,
459 &ue->ue_promisc_task[1].hdr);
461 ue_queue_command(ue, ue_start_task,
462 &ue->ue_sync_task[0].hdr,
463 &ue->ue_sync_task[1].hdr);
465 ue_queue_command(ue, ue_stop_task,
466 &ue->ue_sync_task[0].hdr,
467 &ue->ue_sync_task[1].hdr);
474 ue_queue_command(ue, ue_setmulti_task,
475 &ue->ue_multi_task[0].hdr,
476 &ue->ue_multi_task[1].hdr);
481 if (ue->ue_miibus != NULL) {
482 mii = device_get_softc(ue->ue_miibus);
483 error = ifmedia_ioctl(ifp, ifr, &mii->mii_media, command);
485 error = ether_ioctl(ifp, command, data);
488 error = ether_ioctl(ifp, command, data);
495 uether_modevent(module_t mod, int type, void *data)
500 ueunit = new_unrhdr(0, INT_MAX, NULL);
509 static moduledata_t uether_mod = {
520 m_new = m_getcl(M_DONTWAIT, MT_DATA, M_PKTHDR);
523 m_new->m_len = m_new->m_pkthdr.len = MCLBYTES;
525 m_adj(m_new, ETHER_ALIGN);
530 uether_rxmbuf(struct usb_ether *ue, struct mbuf *m,
533 struct ifnet *ifp = ue->ue_ifp;
535 UE_LOCK_ASSERT(ue, MA_OWNED);
539 m->m_pkthdr.rcvif = ifp;
540 m->m_pkthdr.len = m->m_len = len;
542 /* enqueue for later when the lock can be released */
543 _IF_ENQUEUE(&ue->ue_rxq, m);
548 uether_rxbuf(struct usb_ether *ue, struct usb_page_cache *pc,
549 unsigned int offset, unsigned int len)
551 struct ifnet *ifp = ue->ue_ifp;
554 UE_LOCK_ASSERT(ue, MA_OWNED);
556 if (len < ETHER_HDR_LEN || len > MCLBYTES - ETHER_ALIGN)
565 usbd_copy_out(pc, offset, mtod(m, uint8_t *), len);
569 m->m_pkthdr.rcvif = ifp;
570 m->m_pkthdr.len = m->m_len = len;
572 /* enqueue for later when the lock can be released */
573 _IF_ENQUEUE(&ue->ue_rxq, m);
578 uether_rxflush(struct usb_ether *ue)
580 struct ifnet *ifp = ue->ue_ifp;
583 UE_LOCK_ASSERT(ue, MA_OWNED);
586 _IF_DEQUEUE(&ue->ue_rxq, m);
591 * The USB xfer has been resubmitted so its safe to unlock now.
594 ifp->if_input(ifp, m);
599 DECLARE_MODULE(uether, uether_mod, SI_SUB_PSEUDO, SI_ORDER_ANY);
600 MODULE_VERSION(uether, 1);