1/* $FreeBSD: stable/11/sys/dev/usb/net/usb_ethernet.c 334757 2018-06-07 07:32:51Z hselasky $ */ 2/*- 3 * Copyright (c) 2009 Andrew Thompson (thompsa@FreeBSD.org) 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 * 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 24 * SUCH DAMAGE. 25 */ 26 27#include <sys/cdefs.h> 28__FBSDID("$FreeBSD: stable/11/sys/dev/usb/net/usb_ethernet.c 334757 2018-06-07 07:32:51Z hselasky $"); 29 30#include <sys/param.h> 31#include <sys/systm.h> 32#include <sys/bus.h> 33#include <sys/condvar.h> 34#include <sys/kernel.h> 35#include <sys/lock.h> 36#include <sys/malloc.h> 37#include <sys/mbuf.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> 43#include <sys/sx.h> 44 45#include <net/if.h> 46#include <net/if_var.h> 47#include <net/ethernet.h> 48#include <net/if_types.h> 49#include <net/if_media.h> 50#include <net/if_vlan_var.h> 51 52#include <dev/mii/mii.h> 53#include <dev/mii/miivar.h> 54 55#include <dev/usb/usb.h> 56#include <dev/usb/usbdi.h> 57 58#include <dev/usb/usb_process.h> 59#include <dev/usb/net/usb_ethernet.h> 60 61static SYSCTL_NODE(_net, OID_AUTO, ue, CTLFLAG_RD, 0, 62 "USB Ethernet parameters"); 63 64#define UE_LOCK(_ue) mtx_lock((_ue)->ue_mtx) 65#define UE_UNLOCK(_ue) mtx_unlock((_ue)->ue_mtx) 66#define UE_LOCK_ASSERT(_ue, t) mtx_assert((_ue)->ue_mtx, t) 67 68MODULE_DEPEND(uether, usb, 1, 1, 1); 69MODULE_DEPEND(uether, miibus, 1, 1, 1); 70 71static struct unrhdr *ueunit; 72 73static usb_proc_callback_t ue_attach_post_task; 74static usb_proc_callback_t ue_promisc_task; 75static usb_proc_callback_t ue_setmulti_task; 76static usb_proc_callback_t ue_ifmedia_task; 77static usb_proc_callback_t ue_tick_task; 78static usb_proc_callback_t ue_start_task; 79static usb_proc_callback_t ue_stop_task; 80 81static void ue_init(void *); 82static void ue_start(struct ifnet *); 83static int ue_ifmedia_upd(struct ifnet *); 84static void ue_watchdog(void *); 85 86/* 87 * Return values: 88 * 0: success 89 * Else: device has been detached 90 */ 91uint8_t 92uether_pause(struct usb_ether *ue, unsigned int _ticks) 93{ 94 if (usb_proc_is_gone(&ue->ue_tq)) { 95 /* nothing to do */ 96 return (1); 97 } 98 usb_pause_mtx(ue->ue_mtx, _ticks); 99 return (0); 100} 101 102static void 103ue_queue_command(struct usb_ether *ue, 104 usb_proc_callback_t *fn, 105 struct usb_proc_msg *t0, struct usb_proc_msg *t1) 106{ 107 struct usb_ether_cfg_task *task; 108 109 UE_LOCK_ASSERT(ue, MA_OWNED); 110 111 if (usb_proc_is_gone(&ue->ue_tq)) { 112 return; /* nothing to do */ 113 } 114 /* 115 * NOTE: The task cannot get executed before we drop the 116 * "sc_mtx" mutex. It is safe to update fields in the message 117 * structure after that the message got queued. 118 */ 119 task = (struct usb_ether_cfg_task *) 120 usb_proc_msignal(&ue->ue_tq, t0, t1); 121 122 /* Setup callback and self pointers */ 123 task->hdr.pm_callback = fn; 124 task->ue = ue; 125 126 /* 127 * Start and stop must be synchronous! 128 */ 129 if ((fn == ue_start_task) || (fn == ue_stop_task)) 130 usb_proc_mwait(&ue->ue_tq, t0, t1); 131} 132 133struct ifnet * 134uether_getifp(struct usb_ether *ue) 135{ 136 return (ue->ue_ifp); 137} 138 139struct mii_data * 140uether_getmii(struct usb_ether *ue) 141{ 142 return (device_get_softc(ue->ue_miibus)); 143} 144 145void * 146uether_getsc(struct usb_ether *ue) 147{ 148 return (ue->ue_sc); 149} 150 151static int 152ue_sysctl_parent(SYSCTL_HANDLER_ARGS) 153{ 154 struct usb_ether *ue = arg1; 155 const char *name; 156 157 name = device_get_nameunit(ue->ue_dev); 158 return SYSCTL_OUT_STR(req, name); 159} 160 161int 162uether_ifattach(struct usb_ether *ue) 163{ 164 int error; 165 166 /* check some critical parameters */ 167 if ((ue->ue_dev == NULL) || 168 (ue->ue_udev == NULL) || 169 (ue->ue_mtx == NULL) || 170 (ue->ue_methods == NULL)) 171 return (EINVAL); 172 173 error = usb_proc_create(&ue->ue_tq, ue->ue_mtx, 174 device_get_nameunit(ue->ue_dev), USB_PRI_MED); 175 if (error) { 176 device_printf(ue->ue_dev, "could not setup taskqueue\n"); 177 goto error; 178 } 179 180 /* fork rest of the attach code */ 181 UE_LOCK(ue); 182 ue_queue_command(ue, ue_attach_post_task, 183 &ue->ue_sync_task[0].hdr, 184 &ue->ue_sync_task[1].hdr); 185 UE_UNLOCK(ue); 186 187error: 188 return (error); 189} 190 191void 192uether_ifattach_wait(struct usb_ether *ue) 193{ 194 195 UE_LOCK(ue); 196 usb_proc_mwait(&ue->ue_tq, 197 &ue->ue_sync_task[0].hdr, 198 &ue->ue_sync_task[1].hdr); 199 UE_UNLOCK(ue); 200} 201 202static void 203ue_attach_post_task(struct usb_proc_msg *_task) 204{ 205 struct usb_ether_cfg_task *task = 206 (struct usb_ether_cfg_task *)_task; 207 struct usb_ether *ue = task->ue; 208 struct ifnet *ifp; 209 int error; 210 char num[14]; /* sufficient for 32 bits */ 211 212 /* first call driver's post attach routine */ 213 ue->ue_methods->ue_attach_post(ue); 214 215 UE_UNLOCK(ue); 216 217 ue->ue_unit = alloc_unr(ueunit); 218 usb_callout_init_mtx(&ue->ue_watchdog, ue->ue_mtx, 0); 219 sysctl_ctx_init(&ue->ue_sysctl_ctx); 220 221 error = 0; 222 CURVNET_SET_QUIET(vnet0); 223 ifp = if_alloc(IFT_ETHER); 224 if (ifp == NULL) { 225 device_printf(ue->ue_dev, "could not allocate ifnet\n"); 226 goto fail; 227 } 228 229 ifp->if_softc = ue; 230 if_initname(ifp, "ue", ue->ue_unit); 231 if (ue->ue_methods->ue_attach_post_sub != NULL) { 232 ue->ue_ifp = ifp; 233 error = ue->ue_methods->ue_attach_post_sub(ue); 234 } else { 235 ifp->if_flags = IFF_BROADCAST | IFF_SIMPLEX | IFF_MULTICAST; 236 if (ue->ue_methods->ue_ioctl != NULL) 237 ifp->if_ioctl = ue->ue_methods->ue_ioctl; 238 else 239 ifp->if_ioctl = uether_ioctl; 240 ifp->if_start = ue_start; 241 ifp->if_init = ue_init; 242 IFQ_SET_MAXLEN(&ifp->if_snd, ifqmaxlen); 243 ifp->if_snd.ifq_drv_maxlen = ifqmaxlen; 244 IFQ_SET_READY(&ifp->if_snd); 245 ue->ue_ifp = ifp; 246 247 if (ue->ue_methods->ue_mii_upd != NULL && 248 ue->ue_methods->ue_mii_sts != NULL) { 249 /* device_xxx() depends on this */ 250 mtx_lock(&Giant); 251 error = mii_attach(ue->ue_dev, &ue->ue_miibus, ifp, 252 ue_ifmedia_upd, ue->ue_methods->ue_mii_sts, 253 BMSR_DEFCAPMASK, MII_PHY_ANY, MII_OFFSET_ANY, 0); 254 mtx_unlock(&Giant); 255 } 256 } 257 258 if (error) { 259 device_printf(ue->ue_dev, "attaching PHYs failed\n"); 260 goto fail; 261 } 262 263 if_printf(ifp, "<USB Ethernet> on %s\n", device_get_nameunit(ue->ue_dev)); 264 ether_ifattach(ifp, ue->ue_eaddr); 265 /* Tell upper layer we support VLAN oversized frames. */ 266 if (ifp->if_capabilities & IFCAP_VLAN_MTU) 267 ifp->if_hdrlen = sizeof(struct ether_vlan_header); 268 269 CURVNET_RESTORE(); 270 271 snprintf(num, sizeof(num), "%u", ue->ue_unit); 272 ue->ue_sysctl_oid = SYSCTL_ADD_NODE(&ue->ue_sysctl_ctx, 273 &SYSCTL_NODE_CHILDREN(_net, ue), 274 OID_AUTO, num, CTLFLAG_RD, NULL, ""); 275 SYSCTL_ADD_PROC(&ue->ue_sysctl_ctx, 276 SYSCTL_CHILDREN(ue->ue_sysctl_oid), OID_AUTO, 277 "%parent", CTLTYPE_STRING | CTLFLAG_RD, ue, 0, 278 ue_sysctl_parent, "A", "parent device"); 279 280 UE_LOCK(ue); 281 return; 282 283fail: 284 CURVNET_RESTORE(); 285 free_unr(ueunit, ue->ue_unit); 286 if (ue->ue_ifp != NULL) { 287 if_free(ue->ue_ifp); 288 ue->ue_ifp = NULL; 289 } 290 UE_LOCK(ue); 291 return; 292} 293 294void 295uether_ifdetach(struct usb_ether *ue) 296{ 297 struct ifnet *ifp; 298 299 /* wait for any post attach or other command to complete */ 300 usb_proc_drain(&ue->ue_tq); 301 302 /* read "ifnet" pointer after taskqueue drain */ 303 ifp = ue->ue_ifp; 304 305 if (ifp != NULL) { 306 307 /* we are not running any more */ 308 UE_LOCK(ue); 309 ifp->if_drv_flags &= ~IFF_DRV_RUNNING; 310 UE_UNLOCK(ue); 311 312 /* drain any callouts */ 313 usb_callout_drain(&ue->ue_watchdog); 314 315 /* detach miibus */ 316 if (ue->ue_miibus != NULL) { 317 mtx_lock(&Giant); /* device_xxx() depends on this */ 318 device_delete_child(ue->ue_dev, ue->ue_miibus); 319 mtx_unlock(&Giant); 320 } 321 322 /* detach ethernet */ 323 ether_ifdetach(ifp); 324 325 /* free interface instance */ 326 if_free(ifp); 327 328 /* free sysctl */ 329 sysctl_ctx_free(&ue->ue_sysctl_ctx); 330 331 /* free unit */ 332 free_unr(ueunit, ue->ue_unit); 333 } 334 335 /* free taskqueue, if any */ 336 usb_proc_free(&ue->ue_tq); 337} 338 339uint8_t 340uether_is_gone(struct usb_ether *ue) 341{ 342 return (usb_proc_is_gone(&ue->ue_tq)); 343} 344 345void 346uether_init(void *arg) 347{ 348 349 ue_init(arg); 350} 351 352static void 353ue_init(void *arg) 354{ 355 struct usb_ether *ue = arg; 356 357 UE_LOCK(ue); 358 ue_queue_command(ue, ue_start_task, 359 &ue->ue_sync_task[0].hdr, 360 &ue->ue_sync_task[1].hdr); 361 UE_UNLOCK(ue); 362} 363 364static void 365ue_start_task(struct usb_proc_msg *_task) 366{ 367 struct usb_ether_cfg_task *task = 368 (struct usb_ether_cfg_task *)_task; 369 struct usb_ether *ue = task->ue; 370 struct ifnet *ifp = ue->ue_ifp; 371 372 UE_LOCK_ASSERT(ue, MA_OWNED); 373 374 ue->ue_methods->ue_init(ue); 375 376 if ((ifp->if_drv_flags & IFF_DRV_RUNNING) == 0) 377 return; 378 379 if (ue->ue_methods->ue_tick != NULL) 380 usb_callout_reset(&ue->ue_watchdog, hz, ue_watchdog, ue); 381} 382 383static void 384ue_stop_task(struct usb_proc_msg *_task) 385{ 386 struct usb_ether_cfg_task *task = 387 (struct usb_ether_cfg_task *)_task; 388 struct usb_ether *ue = task->ue; 389 390 UE_LOCK_ASSERT(ue, MA_OWNED); 391 392 usb_callout_stop(&ue->ue_watchdog); 393 394 ue->ue_methods->ue_stop(ue); 395} 396 397void 398uether_start(struct ifnet *ifp) 399{ 400 401 ue_start(ifp); 402} 403 404static void 405ue_start(struct ifnet *ifp) 406{ 407 struct usb_ether *ue = ifp->if_softc; 408 409 if ((ifp->if_drv_flags & IFF_DRV_RUNNING) == 0) 410 return; 411 412 UE_LOCK(ue); 413 ue->ue_methods->ue_start(ue); 414 UE_UNLOCK(ue); 415} 416 417static void 418ue_promisc_task(struct usb_proc_msg *_task) 419{ 420 struct usb_ether_cfg_task *task = 421 (struct usb_ether_cfg_task *)_task; 422 struct usb_ether *ue = task->ue; 423 424 ue->ue_methods->ue_setpromisc(ue); 425} 426 427static void 428ue_setmulti_task(struct usb_proc_msg *_task) 429{ 430 struct usb_ether_cfg_task *task = 431 (struct usb_ether_cfg_task *)_task; 432 struct usb_ether *ue = task->ue; 433 434 ue->ue_methods->ue_setmulti(ue); 435} 436 437int 438uether_ifmedia_upd(struct ifnet *ifp) 439{ 440 441 return (ue_ifmedia_upd(ifp)); 442} 443 444static int 445ue_ifmedia_upd(struct ifnet *ifp) 446{ 447 struct usb_ether *ue = ifp->if_softc; 448 449 /* Defer to process context */ 450 UE_LOCK(ue); 451 ue_queue_command(ue, ue_ifmedia_task, 452 &ue->ue_media_task[0].hdr, 453 &ue->ue_media_task[1].hdr); 454 UE_UNLOCK(ue); 455 456 return (0); 457} 458 459static void 460ue_ifmedia_task(struct usb_proc_msg *_task) 461{ 462 struct usb_ether_cfg_task *task = 463 (struct usb_ether_cfg_task *)_task; 464 struct usb_ether *ue = task->ue; 465 struct ifnet *ifp = ue->ue_ifp; 466 467 ue->ue_methods->ue_mii_upd(ifp); 468} 469 470static void 471ue_watchdog(void *arg) 472{ 473 struct usb_ether *ue = arg; 474 struct ifnet *ifp = ue->ue_ifp; 475 476 if ((ifp->if_drv_flags & IFF_DRV_RUNNING) == 0) 477 return; 478 479 ue_queue_command(ue, ue_tick_task, 480 &ue->ue_tick_task[0].hdr, 481 &ue->ue_tick_task[1].hdr); 482 483 usb_callout_reset(&ue->ue_watchdog, hz, ue_watchdog, ue); 484} 485 486static void 487ue_tick_task(struct usb_proc_msg *_task) 488{ 489 struct usb_ether_cfg_task *task = 490 (struct usb_ether_cfg_task *)_task; 491 struct usb_ether *ue = task->ue; 492 struct ifnet *ifp = ue->ue_ifp; 493 494 if ((ifp->if_drv_flags & IFF_DRV_RUNNING) == 0) 495 return; 496 497 ue->ue_methods->ue_tick(ue); 498} 499 500int 501uether_ioctl(struct ifnet *ifp, u_long command, caddr_t data) 502{ 503 struct usb_ether *ue = ifp->if_softc; 504 struct ifreq *ifr = (struct ifreq *)data; 505 struct mii_data *mii; 506 int error = 0; 507 508 switch (command) { 509 case SIOCSIFFLAGS: 510 UE_LOCK(ue); 511 if (ifp->if_flags & IFF_UP) { 512 if (ifp->if_drv_flags & IFF_DRV_RUNNING) 513 ue_queue_command(ue, ue_promisc_task, 514 &ue->ue_promisc_task[0].hdr, 515 &ue->ue_promisc_task[1].hdr); 516 else 517 ue_queue_command(ue, ue_start_task, 518 &ue->ue_sync_task[0].hdr, 519 &ue->ue_sync_task[1].hdr); 520 } else { 521 ue_queue_command(ue, ue_stop_task, 522 &ue->ue_sync_task[0].hdr, 523 &ue->ue_sync_task[1].hdr); 524 } 525 UE_UNLOCK(ue); 526 break; 527 case SIOCADDMULTI: 528 case SIOCDELMULTI: 529 UE_LOCK(ue); 530 ue_queue_command(ue, ue_setmulti_task, 531 &ue->ue_multi_task[0].hdr, 532 &ue->ue_multi_task[1].hdr); 533 UE_UNLOCK(ue); 534 break; 535 case SIOCGIFMEDIA: 536 case SIOCSIFMEDIA: 537 if (ue->ue_miibus != NULL) { 538 mii = device_get_softc(ue->ue_miibus); 539 error = ifmedia_ioctl(ifp, ifr, &mii->mii_media, command); 540 } else 541 error = ether_ioctl(ifp, command, data); 542 break; 543 default: 544 error = ether_ioctl(ifp, command, data); 545 break; 546 } 547 return (error); 548} 549 550static int 551uether_modevent(module_t mod, int type, void *data) 552{ 553 554 switch (type) { 555 case MOD_LOAD: 556 ueunit = new_unrhdr(0, INT_MAX, NULL); 557 break; 558 case MOD_UNLOAD: 559 break; 560 default: 561 return (EOPNOTSUPP); 562 } 563 return (0); 564} 565static moduledata_t uether_mod = { 566 "uether", 567 uether_modevent, 568 0 569}; 570 571struct mbuf * 572uether_newbuf(void) 573{ 574 struct mbuf *m_new; 575 576 m_new = m_getcl(M_NOWAIT, MT_DATA, M_PKTHDR); 577 if (m_new == NULL) 578 return (NULL); 579 m_new->m_len = m_new->m_pkthdr.len = MCLBYTES; 580 581 m_adj(m_new, ETHER_ALIGN); 582 return (m_new); 583} 584 585int 586uether_rxmbuf(struct usb_ether *ue, struct mbuf *m, 587 unsigned int len) 588{ 589 struct ifnet *ifp = ue->ue_ifp; 590 591 UE_LOCK_ASSERT(ue, MA_OWNED); 592 593 /* finalize mbuf */ 594 if_inc_counter(ifp, IFCOUNTER_IPACKETS, 1); 595 m->m_pkthdr.rcvif = ifp; 596 m->m_pkthdr.len = m->m_len = len; 597 598 /* enqueue for later when the lock can be released */ 599 _IF_ENQUEUE(&ue->ue_rxq, m); 600 return (0); 601} 602 603int 604uether_rxbuf(struct usb_ether *ue, struct usb_page_cache *pc, 605 unsigned int offset, unsigned int len) 606{ 607 struct ifnet *ifp = ue->ue_ifp; 608 struct mbuf *m; 609 610 UE_LOCK_ASSERT(ue, MA_OWNED); 611 612 if (len < ETHER_HDR_LEN || len > MCLBYTES - ETHER_ALIGN) 613 return (1); 614 615 m = uether_newbuf(); 616 if (m == NULL) { 617 if_inc_counter(ifp, IFCOUNTER_IQDROPS, 1); 618 return (ENOMEM); 619 } 620 621 usbd_copy_out(pc, offset, mtod(m, uint8_t *), len); 622 623 /* finalize mbuf */ 624 if_inc_counter(ifp, IFCOUNTER_IPACKETS, 1); 625 m->m_pkthdr.rcvif = ifp; 626 m->m_pkthdr.len = m->m_len = len; 627 628 /* enqueue for later when the lock can be released */ 629 _IF_ENQUEUE(&ue->ue_rxq, m); 630 return (0); 631} 632 633void 634uether_rxflush(struct usb_ether *ue) 635{ 636 struct ifnet *ifp = ue->ue_ifp; 637 struct mbuf *m; 638 639 UE_LOCK_ASSERT(ue, MA_OWNED); 640 641 for (;;) { 642 _IF_DEQUEUE(&ue->ue_rxq, m); 643 if (m == NULL) 644 break; 645 646 /* 647 * The USB xfer has been resubmitted so its safe to unlock now. 648 */ 649 UE_UNLOCK(ue); 650 ifp->if_input(ifp, m); 651 UE_LOCK(ue); 652 } 653} 654 655/* 656 * USB net drivers are run by DRIVER_MODULE() thus SI_SUB_DRIVERS, 657 * SI_ORDER_MIDDLE. Run uether after that. 658 */ 659DECLARE_MODULE(uether, uether_mod, SI_SUB_DRIVERS, SI_ORDER_ANY); 660MODULE_VERSION(uether, 1); 661