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