sys/dev/usb/net/usb_ethernet.c

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