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/cdefs.h>
28 __FBSDID("$FreeBSD$");
30 #include <sys/param.h>
31 #include <sys/systm.h>
33 #include <sys/condvar.h>
34 #include <sys/kernel.h>
36 #include <sys/malloc.h>
38 #include <sys/module.h>
39 #include <sys/mutex.h>
40 #include <sys/socket.h>
41 #include <sys/sockio.h>
42 #include <sys/sysctl.h>
46 #include <net/ethernet.h>
47 #include <net/if_types.h>
48 #include <net/if_media.h>
49 #include <net/if_vlan_var.h>
51 #include <dev/mii/mii.h>
52 #include <dev/mii/miivar.h>
54 #include <dev/usb/usb.h>
55 #include <dev/usb/usbdi.h>
57 #include <dev/usb/usb_process.h>
58 #include <dev/usb/net/usb_ethernet.h>
60 static SYSCTL_NODE(_net, OID_AUTO, ue, CTLFLAG_RD, 0,
61 "USB Ethernet parameters");
63 #define UE_LOCK(_ue) mtx_lock((_ue)->ue_mtx)
64 #define UE_UNLOCK(_ue) mtx_unlock((_ue)->ue_mtx)
65 #define UE_LOCK_ASSERT(_ue, t) mtx_assert((_ue)->ue_mtx, t)
67 MODULE_DEPEND(uether, usb, 1, 1, 1);
68 MODULE_DEPEND(uether, miibus, 1, 1, 1);
70 static struct unrhdr *ueunit;
72 static usb_proc_callback_t ue_attach_post_task;
73 static usb_proc_callback_t ue_promisc_task;
74 static usb_proc_callback_t ue_setmulti_task;
75 static usb_proc_callback_t ue_ifmedia_task;
76 static usb_proc_callback_t ue_tick_task;
77 static usb_proc_callback_t ue_start_task;
78 static usb_proc_callback_t ue_stop_task;
80 static void ue_init(void *);
81 static void ue_start(struct ifnet *);
82 static int ue_ifmedia_upd(struct ifnet *);
83 static void ue_watchdog(void *);
88 * Else: device has been detached
91 uether_pause(struct usb_ether *ue, unsigned int _ticks)
93 if (usb_proc_is_gone(&ue->ue_tq)) {
97 usb_pause_mtx(ue->ue_mtx, _ticks);
102 ue_queue_command(struct usb_ether *ue,
103 usb_proc_callback_t *fn,
104 struct usb_proc_msg *t0, struct usb_proc_msg *t1)
106 struct usb_ether_cfg_task *task;
108 UE_LOCK_ASSERT(ue, MA_OWNED);
110 if (usb_proc_is_gone(&ue->ue_tq)) {
111 return; /* nothing to do */
114 * NOTE: The task cannot get executed before we drop the
115 * "sc_mtx" mutex. It is safe to update fields in the message
116 * structure after that the message got queued.
118 task = (struct usb_ether_cfg_task *)
119 usb_proc_msignal(&ue->ue_tq, t0, t1);
121 /* Setup callback and self pointers */
122 task->hdr.pm_callback = fn;
126 * Start and stop must be synchronous!
128 if ((fn == ue_start_task) || (fn == ue_stop_task))
129 usb_proc_mwait(&ue->ue_tq, t0, t1);
133 uether_getifp(struct usb_ether *ue)
139 uether_getmii(struct usb_ether *ue)
141 return (device_get_softc(ue->ue_miibus));
145 uether_getsc(struct usb_ether *ue)
151 ue_sysctl_parent(SYSCTL_HANDLER_ARGS)
153 struct usb_ether *ue = arg1;
156 name = device_get_nameunit(ue->ue_dev);
157 return SYSCTL_OUT(req, name, strlen(name));
161 uether_ifattach(struct usb_ether *ue)
165 /* check some critical parameters */
166 if ((ue->ue_dev == NULL) ||
167 (ue->ue_udev == NULL) ||
168 (ue->ue_mtx == NULL) ||
169 (ue->ue_methods == NULL))
172 error = usb_proc_create(&ue->ue_tq, ue->ue_mtx,
173 device_get_nameunit(ue->ue_dev), USB_PRI_MED);
175 device_printf(ue->ue_dev, "could not setup taskqueue\n");
179 /* fork rest of the attach code */
181 ue_queue_command(ue, ue_attach_post_task,
182 &ue->ue_sync_task[0].hdr,
183 &ue->ue_sync_task[1].hdr);
191 ue_attach_post_task(struct usb_proc_msg *_task)
193 struct usb_ether_cfg_task *task =
194 (struct usb_ether_cfg_task *)_task;
195 struct usb_ether *ue = task->ue;
198 char num[14]; /* sufficient for 32 bits */
200 /* first call driver's post attach routine */
201 ue->ue_methods->ue_attach_post(ue);
205 ue->ue_unit = alloc_unr(ueunit);
206 usb_callout_init_mtx(&ue->ue_watchdog, ue->ue_mtx, 0);
207 sysctl_ctx_init(&ue->ue_sysctl_ctx);
210 ifp = if_alloc(IFT_ETHER);
212 device_printf(ue->ue_dev, "could not allocate ifnet\n");
217 if_initname(ifp, "ue", ue->ue_unit);
218 if (ue->ue_methods->ue_attach_post_sub != NULL) {
220 error = ue->ue_methods->ue_attach_post_sub(ue);
222 ifp->if_flags = IFF_BROADCAST | IFF_SIMPLEX | IFF_MULTICAST;
223 if (ue->ue_methods->ue_ioctl != NULL)
224 ifp->if_ioctl = ue->ue_methods->ue_ioctl;
226 ifp->if_ioctl = uether_ioctl;
227 ifp->if_start = ue_start;
228 ifp->if_init = ue_init;
229 IFQ_SET_MAXLEN(&ifp->if_snd, ifqmaxlen);
230 ifp->if_snd.ifq_drv_maxlen = ifqmaxlen;
231 IFQ_SET_READY(&ifp->if_snd);
234 if (ue->ue_methods->ue_mii_upd != NULL &&
235 ue->ue_methods->ue_mii_sts != NULL) {
236 /* device_xxx() depends on this */
238 error = mii_attach(ue->ue_dev, &ue->ue_miibus, ifp,
239 ue_ifmedia_upd, ue->ue_methods->ue_mii_sts,
240 BMSR_DEFCAPMASK, MII_PHY_ANY, MII_OFFSET_ANY, 0);
246 device_printf(ue->ue_dev, "attaching PHYs failed\n");
250 if_printf(ifp, "<USB Ethernet> on %s\n", device_get_nameunit(ue->ue_dev));
251 ether_ifattach(ifp, ue->ue_eaddr);
252 /* Tell upper layer we support VLAN oversized frames. */
253 if (ifp->if_capabilities & IFCAP_VLAN_MTU)
254 ifp->if_hdrlen = sizeof(struct ether_vlan_header);
256 snprintf(num, sizeof(num), "%u", ue->ue_unit);
257 ue->ue_sysctl_oid = SYSCTL_ADD_NODE(&ue->ue_sysctl_ctx,
258 &SYSCTL_NODE_CHILDREN(_net, ue),
259 OID_AUTO, num, CTLFLAG_RD, NULL, "");
260 SYSCTL_ADD_PROC(&ue->ue_sysctl_ctx,
261 SYSCTL_CHILDREN(ue->ue_sysctl_oid), OID_AUTO,
262 "%parent", CTLTYPE_STRING | CTLFLAG_RD, ue, 0,
263 ue_sysctl_parent, "A", "parent device");
269 free_unr(ueunit, ue->ue_unit);
270 if (ue->ue_ifp != NULL) {
279 uether_ifdetach(struct usb_ether *ue)
283 /* wait for any post attach or other command to complete */
284 usb_proc_drain(&ue->ue_tq);
286 /* read "ifnet" pointer after taskqueue drain */
291 /* we are not running any more */
293 ifp->if_drv_flags &= ~IFF_DRV_RUNNING;
296 /* drain any callouts */
297 usb_callout_drain(&ue->ue_watchdog);
300 if (ue->ue_miibus != NULL) {
301 mtx_lock(&Giant); /* device_xxx() depends on this */
302 device_delete_child(ue->ue_dev, ue->ue_miibus);
306 /* detach ethernet */
309 /* free interface instance */
313 sysctl_ctx_free(&ue->ue_sysctl_ctx);
316 free_unr(ueunit, ue->ue_unit);
319 /* free taskqueue, if any */
320 usb_proc_free(&ue->ue_tq);
324 uether_is_gone(struct usb_ether *ue)
326 return (usb_proc_is_gone(&ue->ue_tq));
330 uether_init(void *arg)
339 struct usb_ether *ue = arg;
342 ue_queue_command(ue, ue_start_task,
343 &ue->ue_sync_task[0].hdr,
344 &ue->ue_sync_task[1].hdr);
349 ue_start_task(struct usb_proc_msg *_task)
351 struct usb_ether_cfg_task *task =
352 (struct usb_ether_cfg_task *)_task;
353 struct usb_ether *ue = task->ue;
354 struct ifnet *ifp = ue->ue_ifp;
356 UE_LOCK_ASSERT(ue, MA_OWNED);
358 ue->ue_methods->ue_init(ue);
360 if ((ifp->if_drv_flags & IFF_DRV_RUNNING) == 0)
363 if (ue->ue_methods->ue_tick != NULL)
364 usb_callout_reset(&ue->ue_watchdog, hz, ue_watchdog, ue);
368 ue_stop_task(struct usb_proc_msg *_task)
370 struct usb_ether_cfg_task *task =
371 (struct usb_ether_cfg_task *)_task;
372 struct usb_ether *ue = task->ue;
374 UE_LOCK_ASSERT(ue, MA_OWNED);
376 usb_callout_stop(&ue->ue_watchdog);
378 ue->ue_methods->ue_stop(ue);
382 uether_start(struct ifnet *ifp)
389 ue_start(struct ifnet *ifp)
391 struct usb_ether *ue = ifp->if_softc;
393 if ((ifp->if_drv_flags & IFF_DRV_RUNNING) == 0)
397 ue->ue_methods->ue_start(ue);
402 ue_promisc_task(struct usb_proc_msg *_task)
404 struct usb_ether_cfg_task *task =
405 (struct usb_ether_cfg_task *)_task;
406 struct usb_ether *ue = task->ue;
408 ue->ue_methods->ue_setpromisc(ue);
412 ue_setmulti_task(struct usb_proc_msg *_task)
414 struct usb_ether_cfg_task *task =
415 (struct usb_ether_cfg_task *)_task;
416 struct usb_ether *ue = task->ue;
418 ue->ue_methods->ue_setmulti(ue);
422 uether_ifmedia_upd(struct ifnet *ifp)
425 return (ue_ifmedia_upd(ifp));
429 ue_ifmedia_upd(struct ifnet *ifp)
431 struct usb_ether *ue = ifp->if_softc;
433 /* Defer to process context */
435 ue_queue_command(ue, ue_ifmedia_task,
436 &ue->ue_media_task[0].hdr,
437 &ue->ue_media_task[1].hdr);
444 ue_ifmedia_task(struct usb_proc_msg *_task)
446 struct usb_ether_cfg_task *task =
447 (struct usb_ether_cfg_task *)_task;
448 struct usb_ether *ue = task->ue;
449 struct ifnet *ifp = ue->ue_ifp;
451 ue->ue_methods->ue_mii_upd(ifp);
455 ue_watchdog(void *arg)
457 struct usb_ether *ue = arg;
458 struct ifnet *ifp = ue->ue_ifp;
460 if ((ifp->if_drv_flags & IFF_DRV_RUNNING) == 0)
463 ue_queue_command(ue, ue_tick_task,
464 &ue->ue_tick_task[0].hdr,
465 &ue->ue_tick_task[1].hdr);
467 usb_callout_reset(&ue->ue_watchdog, hz, ue_watchdog, ue);
471 ue_tick_task(struct usb_proc_msg *_task)
473 struct usb_ether_cfg_task *task =
474 (struct usb_ether_cfg_task *)_task;
475 struct usb_ether *ue = task->ue;
476 struct ifnet *ifp = ue->ue_ifp;
478 if ((ifp->if_drv_flags & IFF_DRV_RUNNING) == 0)
481 ue->ue_methods->ue_tick(ue);
485 uether_ioctl(struct ifnet *ifp, u_long command, caddr_t data)
487 struct usb_ether *ue = ifp->if_softc;
488 struct ifreq *ifr = (struct ifreq *)data;
489 struct mii_data *mii;
495 if (ifp->if_flags & IFF_UP) {
496 if (ifp->if_drv_flags & IFF_DRV_RUNNING)
497 ue_queue_command(ue, ue_promisc_task,
498 &ue->ue_promisc_task[0].hdr,
499 &ue->ue_promisc_task[1].hdr);
501 ue_queue_command(ue, ue_start_task,
502 &ue->ue_sync_task[0].hdr,
503 &ue->ue_sync_task[1].hdr);
505 ue_queue_command(ue, ue_stop_task,
506 &ue->ue_sync_task[0].hdr,
507 &ue->ue_sync_task[1].hdr);
514 ue_queue_command(ue, ue_setmulti_task,
515 &ue->ue_multi_task[0].hdr,
516 &ue->ue_multi_task[1].hdr);
521 if (ue->ue_miibus != NULL) {
522 mii = device_get_softc(ue->ue_miibus);
523 error = ifmedia_ioctl(ifp, ifr, &mii->mii_media, command);
525 error = ether_ioctl(ifp, command, data);
528 error = ether_ioctl(ifp, command, data);
535 uether_modevent(module_t mod, int type, void *data)
540 ueunit = new_unrhdr(0, INT_MAX, NULL);
549 static moduledata_t uether_mod = {
560 m_new = m_getcl(M_DONTWAIT, MT_DATA, M_PKTHDR);
563 m_new->m_len = m_new->m_pkthdr.len = MCLBYTES;
565 m_adj(m_new, ETHER_ALIGN);
570 uether_rxmbuf(struct usb_ether *ue, struct mbuf *m,
573 struct ifnet *ifp = ue->ue_ifp;
575 UE_LOCK_ASSERT(ue, MA_OWNED);
579 m->m_pkthdr.rcvif = ifp;
580 m->m_pkthdr.len = m->m_len = len;
582 /* enqueue for later when the lock can be released */
583 _IF_ENQUEUE(&ue->ue_rxq, m);
588 uether_rxbuf(struct usb_ether *ue, struct usb_page_cache *pc,
589 unsigned int offset, unsigned int len)
591 struct ifnet *ifp = ue->ue_ifp;
594 UE_LOCK_ASSERT(ue, MA_OWNED);
596 if (len < ETHER_HDR_LEN || len > MCLBYTES - ETHER_ALIGN)
605 usbd_copy_out(pc, offset, mtod(m, uint8_t *), len);
609 m->m_pkthdr.rcvif = ifp;
610 m->m_pkthdr.len = m->m_len = len;
612 /* enqueue for later when the lock can be released */
613 _IF_ENQUEUE(&ue->ue_rxq, m);
618 uether_rxflush(struct usb_ether *ue)
620 struct ifnet *ifp = ue->ue_ifp;
623 UE_LOCK_ASSERT(ue, MA_OWNED);
626 _IF_DEQUEUE(&ue->ue_rxq, m);
631 * The USB xfer has been resubmitted so its safe to unlock now.
634 ifp->if_input(ifp, m);
639 DECLARE_MODULE(uether, uether_mod, SI_SUB_PSEUDO, SI_ORDER_ANY);
640 MODULE_VERSION(uether, 1);