3 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
5 * Copyright (c) 2009 Andrew Thompson (thompsa@FreeBSD.org)
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
32 #include <sys/param.h>
33 #include <sys/systm.h>
35 #include <sys/condvar.h>
36 #include <sys/kernel.h>
38 #include <sys/malloc.h>
40 #include <sys/module.h>
41 #include <sys/mutex.h>
42 #include <sys/socket.h>
43 #include <sys/sockio.h>
44 #include <sys/sysctl.h>
48 #include <net/if_var.h>
49 #include <net/ethernet.h>
50 #include <net/if_types.h>
51 #include <net/if_media.h>
52 #include <net/if_vlan_var.h>
54 #include <dev/mii/mii.h>
55 #include <dev/mii/miivar.h>
57 #include <dev/usb/usb.h>
58 #include <dev/usb/usbdi.h>
60 #include <dev/usb/usb_process.h>
61 #include <dev/usb/net/usb_ethernet.h>
63 static SYSCTL_NODE(_net, OID_AUTO, ue, CTLFLAG_RD, 0,
64 "USB Ethernet parameters");
66 #define UE_LOCK(_ue) mtx_lock((_ue)->ue_mtx)
67 #define UE_UNLOCK(_ue) mtx_unlock((_ue)->ue_mtx)
68 #define UE_LOCK_ASSERT(_ue, t) mtx_assert((_ue)->ue_mtx, t)
70 MODULE_DEPEND(uether, usb, 1, 1, 1);
71 MODULE_DEPEND(uether, miibus, 1, 1, 1);
73 static struct unrhdr *ueunit;
75 static usb_proc_callback_t ue_attach_post_task;
76 static usb_proc_callback_t ue_promisc_task;
77 static usb_proc_callback_t ue_setmulti_task;
78 static usb_proc_callback_t ue_ifmedia_task;
79 static usb_proc_callback_t ue_tick_task;
80 static usb_proc_callback_t ue_start_task;
81 static usb_proc_callback_t ue_stop_task;
83 static void ue_init(void *);
84 static void ue_start(struct ifnet *);
85 static int ue_ifmedia_upd(struct ifnet *);
86 static void ue_watchdog(void *);
91 * Else: device has been detached
94 uether_pause(struct usb_ether *ue, unsigned int _ticks)
96 if (usb_proc_is_gone(&ue->ue_tq)) {
100 usb_pause_mtx(ue->ue_mtx, _ticks);
105 ue_queue_command(struct usb_ether *ue,
106 usb_proc_callback_t *fn,
107 struct usb_proc_msg *t0, struct usb_proc_msg *t1)
109 struct usb_ether_cfg_task *task;
111 UE_LOCK_ASSERT(ue, MA_OWNED);
113 if (usb_proc_is_gone(&ue->ue_tq)) {
114 return; /* nothing to do */
117 * NOTE: The task cannot get executed before we drop the
118 * "sc_mtx" mutex. It is safe to update fields in the message
119 * structure after that the message got queued.
121 task = (struct usb_ether_cfg_task *)
122 usb_proc_msignal(&ue->ue_tq, t0, t1);
124 /* Setup callback and self pointers */
125 task->hdr.pm_callback = fn;
129 * Start and stop must be synchronous!
131 if ((fn == ue_start_task) || (fn == ue_stop_task))
132 usb_proc_mwait(&ue->ue_tq, t0, t1);
136 uether_getifp(struct usb_ether *ue)
142 uether_getmii(struct usb_ether *ue)
144 return (device_get_softc(ue->ue_miibus));
148 uether_getsc(struct usb_ether *ue)
154 ue_sysctl_parent(SYSCTL_HANDLER_ARGS)
156 struct usb_ether *ue = arg1;
159 name = device_get_nameunit(ue->ue_dev);
160 return SYSCTL_OUT_STR(req, name);
164 uether_ifattach(struct usb_ether *ue)
168 /* check some critical parameters */
169 if ((ue->ue_dev == NULL) ||
170 (ue->ue_udev == NULL) ||
171 (ue->ue_mtx == NULL) ||
172 (ue->ue_methods == NULL))
175 error = usb_proc_create(&ue->ue_tq, ue->ue_mtx,
176 device_get_nameunit(ue->ue_dev), USB_PRI_MED);
178 device_printf(ue->ue_dev, "could not setup taskqueue\n");
182 /* fork rest of the attach code */
184 ue_queue_command(ue, ue_attach_post_task,
185 &ue->ue_sync_task[0].hdr,
186 &ue->ue_sync_task[1].hdr);
194 ue_attach_post_task(struct usb_proc_msg *_task)
196 struct usb_ether_cfg_task *task =
197 (struct usb_ether_cfg_task *)_task;
198 struct usb_ether *ue = task->ue;
201 char num[14]; /* sufficient for 32 bits */
203 /* first call driver's post attach routine */
204 ue->ue_methods->ue_attach_post(ue);
208 ue->ue_unit = alloc_unr(ueunit);
209 usb_callout_init_mtx(&ue->ue_watchdog, ue->ue_mtx, 0);
210 sysctl_ctx_init(&ue->ue_sysctl_ctx);
213 CURVNET_SET_QUIET(vnet0);
214 ifp = if_alloc(IFT_ETHER);
216 device_printf(ue->ue_dev, "could not allocate ifnet\n");
221 if_initname(ifp, "ue", ue->ue_unit);
222 if (ue->ue_methods->ue_attach_post_sub != NULL) {
224 error = ue->ue_methods->ue_attach_post_sub(ue);
226 ifp->if_flags = IFF_BROADCAST | IFF_SIMPLEX | IFF_MULTICAST;
227 if (ue->ue_methods->ue_ioctl != NULL)
228 ifp->if_ioctl = ue->ue_methods->ue_ioctl;
230 ifp->if_ioctl = uether_ioctl;
231 ifp->if_start = ue_start;
232 ifp->if_init = ue_init;
233 IFQ_SET_MAXLEN(&ifp->if_snd, ifqmaxlen);
234 ifp->if_snd.ifq_drv_maxlen = ifqmaxlen;
235 IFQ_SET_READY(&ifp->if_snd);
238 if (ue->ue_methods->ue_mii_upd != NULL &&
239 ue->ue_methods->ue_mii_sts != NULL) {
240 /* device_xxx() depends on this */
242 error = mii_attach(ue->ue_dev, &ue->ue_miibus, ifp,
243 ue_ifmedia_upd, ue->ue_methods->ue_mii_sts,
244 BMSR_DEFCAPMASK, MII_PHY_ANY, MII_OFFSET_ANY, 0);
250 device_printf(ue->ue_dev, "attaching PHYs failed\n");
254 if_printf(ifp, "<USB Ethernet> on %s\n", device_get_nameunit(ue->ue_dev));
255 ether_ifattach(ifp, ue->ue_eaddr);
256 /* Tell upper layer we support VLAN oversized frames. */
257 if (ifp->if_capabilities & IFCAP_VLAN_MTU)
258 ifp->if_hdrlen = sizeof(struct ether_vlan_header);
262 snprintf(num, sizeof(num), "%u", ue->ue_unit);
263 ue->ue_sysctl_oid = SYSCTL_ADD_NODE(&ue->ue_sysctl_ctx,
264 &SYSCTL_NODE_CHILDREN(_net, ue),
265 OID_AUTO, num, CTLFLAG_RD, NULL, "");
266 SYSCTL_ADD_PROC(&ue->ue_sysctl_ctx,
267 SYSCTL_CHILDREN(ue->ue_sysctl_oid), OID_AUTO,
268 "%parent", CTLTYPE_STRING | CTLFLAG_RD, ue, 0,
269 ue_sysctl_parent, "A", "parent device");
276 free_unr(ueunit, ue->ue_unit);
277 if (ue->ue_ifp != NULL) {
286 uether_ifdetach(struct usb_ether *ue)
290 /* wait for any post attach or other command to complete */
291 usb_proc_drain(&ue->ue_tq);
293 /* read "ifnet" pointer after taskqueue drain */
298 /* we are not running any more */
300 ifp->if_drv_flags &= ~IFF_DRV_RUNNING;
303 /* drain any callouts */
304 usb_callout_drain(&ue->ue_watchdog);
307 if (ue->ue_miibus != NULL) {
308 mtx_lock(&Giant); /* device_xxx() depends on this */
309 device_delete_child(ue->ue_dev, ue->ue_miibus);
313 /* detach ethernet */
316 /* free interface instance */
320 sysctl_ctx_free(&ue->ue_sysctl_ctx);
323 free_unr(ueunit, ue->ue_unit);
326 /* free taskqueue, if any */
327 usb_proc_free(&ue->ue_tq);
331 uether_is_gone(struct usb_ether *ue)
333 return (usb_proc_is_gone(&ue->ue_tq));
337 uether_init(void *arg)
346 struct usb_ether *ue = arg;
349 ue_queue_command(ue, ue_start_task,
350 &ue->ue_sync_task[0].hdr,
351 &ue->ue_sync_task[1].hdr);
356 ue_start_task(struct usb_proc_msg *_task)
358 struct usb_ether_cfg_task *task =
359 (struct usb_ether_cfg_task *)_task;
360 struct usb_ether *ue = task->ue;
361 struct ifnet *ifp = ue->ue_ifp;
363 UE_LOCK_ASSERT(ue, MA_OWNED);
365 ue->ue_methods->ue_init(ue);
367 if ((ifp->if_drv_flags & IFF_DRV_RUNNING) == 0)
370 if (ue->ue_methods->ue_tick != NULL)
371 usb_callout_reset(&ue->ue_watchdog, hz, ue_watchdog, ue);
375 ue_stop_task(struct usb_proc_msg *_task)
377 struct usb_ether_cfg_task *task =
378 (struct usb_ether_cfg_task *)_task;
379 struct usb_ether *ue = task->ue;
381 UE_LOCK_ASSERT(ue, MA_OWNED);
383 usb_callout_stop(&ue->ue_watchdog);
385 ue->ue_methods->ue_stop(ue);
389 uether_start(struct ifnet *ifp)
396 ue_start(struct ifnet *ifp)
398 struct usb_ether *ue = ifp->if_softc;
400 if ((ifp->if_drv_flags & IFF_DRV_RUNNING) == 0)
404 ue->ue_methods->ue_start(ue);
409 ue_promisc_task(struct usb_proc_msg *_task)
411 struct usb_ether_cfg_task *task =
412 (struct usb_ether_cfg_task *)_task;
413 struct usb_ether *ue = task->ue;
415 ue->ue_methods->ue_setpromisc(ue);
419 ue_setmulti_task(struct usb_proc_msg *_task)
421 struct usb_ether_cfg_task *task =
422 (struct usb_ether_cfg_task *)_task;
423 struct usb_ether *ue = task->ue;
425 ue->ue_methods->ue_setmulti(ue);
429 uether_ifmedia_upd(struct ifnet *ifp)
432 return (ue_ifmedia_upd(ifp));
436 ue_ifmedia_upd(struct ifnet *ifp)
438 struct usb_ether *ue = ifp->if_softc;
440 /* Defer to process context */
442 ue_queue_command(ue, ue_ifmedia_task,
443 &ue->ue_media_task[0].hdr,
444 &ue->ue_media_task[1].hdr);
451 ue_ifmedia_task(struct usb_proc_msg *_task)
453 struct usb_ether_cfg_task *task =
454 (struct usb_ether_cfg_task *)_task;
455 struct usb_ether *ue = task->ue;
456 struct ifnet *ifp = ue->ue_ifp;
458 ue->ue_methods->ue_mii_upd(ifp);
462 ue_watchdog(void *arg)
464 struct usb_ether *ue = arg;
465 struct ifnet *ifp = ue->ue_ifp;
467 if ((ifp->if_drv_flags & IFF_DRV_RUNNING) == 0)
470 ue_queue_command(ue, ue_tick_task,
471 &ue->ue_tick_task[0].hdr,
472 &ue->ue_tick_task[1].hdr);
474 usb_callout_reset(&ue->ue_watchdog, hz, ue_watchdog, ue);
478 ue_tick_task(struct usb_proc_msg *_task)
480 struct usb_ether_cfg_task *task =
481 (struct usb_ether_cfg_task *)_task;
482 struct usb_ether *ue = task->ue;
483 struct ifnet *ifp = ue->ue_ifp;
485 if ((ifp->if_drv_flags & IFF_DRV_RUNNING) == 0)
488 ue->ue_methods->ue_tick(ue);
492 uether_ioctl(struct ifnet *ifp, u_long command, caddr_t data)
494 struct usb_ether *ue = ifp->if_softc;
495 struct ifreq *ifr = (struct ifreq *)data;
496 struct mii_data *mii;
502 if (ifp->if_flags & IFF_UP) {
503 if (ifp->if_drv_flags & IFF_DRV_RUNNING)
504 ue_queue_command(ue, ue_promisc_task,
505 &ue->ue_promisc_task[0].hdr,
506 &ue->ue_promisc_task[1].hdr);
508 ue_queue_command(ue, ue_start_task,
509 &ue->ue_sync_task[0].hdr,
510 &ue->ue_sync_task[1].hdr);
512 ue_queue_command(ue, ue_stop_task,
513 &ue->ue_sync_task[0].hdr,
514 &ue->ue_sync_task[1].hdr);
521 ue_queue_command(ue, ue_setmulti_task,
522 &ue->ue_multi_task[0].hdr,
523 &ue->ue_multi_task[1].hdr);
528 if (ue->ue_miibus != NULL) {
529 mii = device_get_softc(ue->ue_miibus);
530 error = ifmedia_ioctl(ifp, ifr, &mii->mii_media, command);
532 error = ether_ioctl(ifp, command, data);
535 error = ether_ioctl(ifp, command, data);
542 uether_modevent(module_t mod, int type, void *data)
547 ueunit = new_unrhdr(0, INT_MAX, NULL);
556 static moduledata_t uether_mod = {
567 m_new = m_getcl(M_NOWAIT, MT_DATA, M_PKTHDR);
570 m_new->m_len = m_new->m_pkthdr.len = MCLBYTES;
572 m_adj(m_new, ETHER_ALIGN);
577 uether_rxmbuf(struct usb_ether *ue, struct mbuf *m,
580 struct ifnet *ifp = ue->ue_ifp;
582 UE_LOCK_ASSERT(ue, MA_OWNED);
585 if_inc_counter(ifp, IFCOUNTER_IPACKETS, 1);
586 m->m_pkthdr.rcvif = ifp;
587 m->m_pkthdr.len = m->m_len = len;
589 /* enqueue for later when the lock can be released */
590 _IF_ENQUEUE(&ue->ue_rxq, m);
595 uether_rxbuf(struct usb_ether *ue, struct usb_page_cache *pc,
596 unsigned int offset, unsigned int len)
598 struct ifnet *ifp = ue->ue_ifp;
601 UE_LOCK_ASSERT(ue, MA_OWNED);
603 if (len < ETHER_HDR_LEN || len > MCLBYTES - ETHER_ALIGN)
608 if_inc_counter(ifp, IFCOUNTER_IQDROPS, 1);
612 usbd_copy_out(pc, offset, mtod(m, uint8_t *), len);
615 if_inc_counter(ifp, IFCOUNTER_IPACKETS, 1);
616 m->m_pkthdr.rcvif = ifp;
617 m->m_pkthdr.len = m->m_len = len;
619 /* enqueue for later when the lock can be released */
620 _IF_ENQUEUE(&ue->ue_rxq, m);
625 uether_rxflush(struct usb_ether *ue)
627 struct ifnet *ifp = ue->ue_ifp;
630 UE_LOCK_ASSERT(ue, MA_OWNED);
633 _IF_DEQUEUE(&ue->ue_rxq, m);
638 * The USB xfer has been resubmitted so its safe to unlock now.
641 ifp->if_input(ifp, m);
647 * USB net drivers are run by DRIVER_MODULE() thus SI_SUB_DRIVERS,
648 * SI_ORDER_MIDDLE. Run uether after that.
650 DECLARE_MODULE(uether, uether_mod, SI_SUB_DRIVERS, SI_ORDER_ANY);
651 MODULE_VERSION(uether, 1);