usb_ethernet.c revision 241394 
1/* $FreeBSD: head/sys/dev/usb/net/usb_ethernet.c 241394 2012-10-10 08:36:38Z kevlo $ */
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: head/sys/dev/usb/net/usb_ethernet.c 241394 2012-10-10 08:36:38Z kevlo $");
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
60static 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
67MODULE_DEPEND(uether, usb, 1, 1, 1);
68MODULE_DEPEND(uether, miibus, 1, 1, 1);
69
70static struct unrhdr *ueunit;
71
72static usb_proc_callback_t ue_attach_post_task;
73static usb_proc_callback_t ue_promisc_task;
74static usb_proc_callback_t ue_setmulti_task;
75static usb_proc_callback_t ue_ifmedia_task;
76static usb_proc_callback_t ue_tick_task;
77static usb_proc_callback_t ue_start_task;
78static usb_proc_callback_t ue_stop_task;
79
80static void	ue_init(void *);
81static void	ue_start(struct ifnet *);
82static int	ue_ifmedia_upd(struct ifnet *);
83static void	ue_watchdog(void *);
84
85/*
86 * Return values:
87 *    0: success
88 * Else: device has been detached
89 */
90uint8_t
91uether_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
101static void
102ue_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
132struct ifnet *
133uether_getifp(struct usb_ether *ue)
134{
135	return (ue->ue_ifp);
136}
137
138struct mii_data *
139uether_getmii(struct usb_ether *ue)
140{
141	return (device_get_softc(ue->ue_miibus));
142}
143
144void *
145uether_getsc(struct usb_ether *ue)
146{
147	return (ue->ue_sc);
148}
149
150static int
151ue_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
160int
161uether_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
186error:
187	return (error);
188}
189
190static void
191ue_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	ifp = if_alloc(IFT_ETHER);
211	if (ifp == NULL) {
212		device_printf(ue->ue_dev, "could not allocate ifnet\n");
213		goto fail;
214	}
215
216	ifp->if_softc = ue;
217	if_initname(ifp, "ue", ue->ue_unit);
218	if (ue->ue_methods->ue_attach_post_sub != NULL) {
219		ue->ue_ifp = ifp;
220		error = ue->ue_methods->ue_attach_post_sub(ue);
221	} else {
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;
225		else
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);
232		ue->ue_ifp = ifp;
233
234		if (ue->ue_methods->ue_mii_upd != NULL &&
235		    ue->ue_methods->ue_mii_sts != NULL) {
236			/* device_xxx() depends on this */
237			mtx_lock(&Giant);
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);
241			mtx_unlock(&Giant);
242		}
243	}
244
245	if (error) {
246		device_printf(ue->ue_dev, "attaching PHYs failed\n");
247		goto fail;
248	}
249
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);
255
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");
264
265	UE_LOCK(ue);
266	return;
267
268fail:
269	free_unr(ueunit, ue->ue_unit);
270	if (ue->ue_ifp != NULL) {
271		if_free(ue->ue_ifp);
272		ue->ue_ifp = NULL;
273	}
274	UE_LOCK(ue);
275	return;
276}
277
278void
279uether_ifdetach(struct usb_ether *ue)
280{
281	struct ifnet *ifp;
282
283	/* wait for any post attach or other command to complete */
284	usb_proc_drain(&ue->ue_tq);
285
286	/* read "ifnet" pointer after taskqueue drain */
287	ifp = ue->ue_ifp;
288
289	if (ifp != NULL) {
290
291		/* we are not running any more */
292		UE_LOCK(ue);
293		ifp->if_drv_flags &= ~IFF_DRV_RUNNING;
294		UE_UNLOCK(ue);
295
296		/* drain any callouts */
297		usb_callout_drain(&ue->ue_watchdog);
298
299		/* detach miibus */
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);
303			mtx_unlock(&Giant);
304		}
305
306		/* detach ethernet */
307		ether_ifdetach(ifp);
308
309		/* free interface instance */
310		if_free(ifp);
311
312		/* free sysctl */
313		sysctl_ctx_free(&ue->ue_sysctl_ctx);
314
315		/* free unit */
316		free_unr(ueunit, ue->ue_unit);
317	}
318
319	/* free taskqueue, if any */
320	usb_proc_free(&ue->ue_tq);
321}
322
323uint8_t
324uether_is_gone(struct usb_ether *ue)
325{
326	return (usb_proc_is_gone(&ue->ue_tq));
327}
328
329void
330uether_init(void *arg)
331{
332
333	ue_init(arg);
334}
335
336static void
337ue_init(void *arg)
338{
339	struct usb_ether *ue = arg;
340
341	UE_LOCK(ue);
342	ue_queue_command(ue, ue_start_task,
343	    &ue->ue_sync_task[0].hdr,
344	    &ue->ue_sync_task[1].hdr);
345	UE_UNLOCK(ue);
346}
347
348static void
349ue_start_task(struct usb_proc_msg *_task)
350{
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;
355
356	UE_LOCK_ASSERT(ue, MA_OWNED);
357
358	ue->ue_methods->ue_init(ue);
359
360	if ((ifp->if_drv_flags & IFF_DRV_RUNNING) == 0)
361		return;
362
363	if (ue->ue_methods->ue_tick != NULL)
364		usb_callout_reset(&ue->ue_watchdog, hz, ue_watchdog, ue);
365}
366
367static void
368ue_stop_task(struct usb_proc_msg *_task)
369{
370	struct usb_ether_cfg_task *task =
371	    (struct usb_ether_cfg_task *)_task;
372	struct usb_ether *ue = task->ue;
373
374	UE_LOCK_ASSERT(ue, MA_OWNED);
375
376	usb_callout_stop(&ue->ue_watchdog);
377
378	ue->ue_methods->ue_stop(ue);
379}
380
381void
382uether_start(struct ifnet *ifp)
383{
384
385	ue_start(ifp);
386}
387
388static void
389ue_start(struct ifnet *ifp)
390{
391	struct usb_ether *ue = ifp->if_softc;
392
393	if ((ifp->if_drv_flags & IFF_DRV_RUNNING) == 0)
394		return;
395
396	UE_LOCK(ue);
397	ue->ue_methods->ue_start(ue);
398	UE_UNLOCK(ue);
399}
400
401static void
402ue_promisc_task(struct usb_proc_msg *_task)
403{
404	struct usb_ether_cfg_task *task =
405	    (struct usb_ether_cfg_task *)_task;
406	struct usb_ether *ue = task->ue;
407
408	ue->ue_methods->ue_setpromisc(ue);
409}
410
411static void
412ue_setmulti_task(struct usb_proc_msg *_task)
413{
414	struct usb_ether_cfg_task *task =
415	    (struct usb_ether_cfg_task *)_task;
416	struct usb_ether *ue = task->ue;
417
418	ue->ue_methods->ue_setmulti(ue);
419}
420
421int
422uether_ifmedia_upd(struct ifnet *ifp)
423{
424
425	return (ue_ifmedia_upd(ifp));
426}
427
428static int
429ue_ifmedia_upd(struct ifnet *ifp)
430{
431	struct usb_ether *ue = ifp->if_softc;
432
433	/* Defer to process context */
434	UE_LOCK(ue);
435	ue_queue_command(ue, ue_ifmedia_task,
436	    &ue->ue_media_task[0].hdr,
437	    &ue->ue_media_task[1].hdr);
438	UE_UNLOCK(ue);
439
440	return (0);
441}
442
443static void
444ue_ifmedia_task(struct usb_proc_msg *_task)
445{
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;
450
451	ue->ue_methods->ue_mii_upd(ifp);
452}
453
454static void
455ue_watchdog(void *arg)
456{
457	struct usb_ether *ue = arg;
458	struct ifnet *ifp = ue->ue_ifp;
459
460	if ((ifp->if_drv_flags & IFF_DRV_RUNNING) == 0)
461		return;
462
463	ue_queue_command(ue, ue_tick_task,
464	    &ue->ue_tick_task[0].hdr,
465	    &ue->ue_tick_task[1].hdr);
466
467	usb_callout_reset(&ue->ue_watchdog, hz, ue_watchdog, ue);
468}
469
470static void
471ue_tick_task(struct usb_proc_msg *_task)
472{
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;
477
478	if ((ifp->if_drv_flags & IFF_DRV_RUNNING) == 0)
479		return;
480
481	ue->ue_methods->ue_tick(ue);
482}
483
484int
485uether_ioctl(struct ifnet *ifp, u_long command, caddr_t data)
486{
487	struct usb_ether *ue = ifp->if_softc;
488	struct ifreq *ifr = (struct ifreq *)data;
489	struct mii_data *mii;
490	int error = 0;
491
492	switch (command) {
493	case SIOCSIFFLAGS:
494		UE_LOCK(ue);
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);
500			else
501				ue_queue_command(ue, ue_start_task,
502				    &ue->ue_sync_task[0].hdr,
503				    &ue->ue_sync_task[1].hdr);
504		} else {
505			ue_queue_command(ue, ue_stop_task,
506			    &ue->ue_sync_task[0].hdr,
507			    &ue->ue_sync_task[1].hdr);
508		}
509		UE_UNLOCK(ue);
510		break;
511	case SIOCADDMULTI:
512	case SIOCDELMULTI:
513		UE_LOCK(ue);
514		ue_queue_command(ue, ue_setmulti_task,
515		    &ue->ue_multi_task[0].hdr,
516		    &ue->ue_multi_task[1].hdr);
517		UE_UNLOCK(ue);
518		break;
519	case SIOCGIFMEDIA:
520	case SIOCSIFMEDIA:
521		if (ue->ue_miibus != NULL) {
522			mii = device_get_softc(ue->ue_miibus);
523			error = ifmedia_ioctl(ifp, ifr, &mii->mii_media, command);
524		} else
525			error = ether_ioctl(ifp, command, data);
526		break;
527	default:
528		error = ether_ioctl(ifp, command, data);
529		break;
530	}
531	return (error);
532}
533
534static int
535uether_modevent(module_t mod, int type, void *data)
536{
537
538	switch (type) {
539	case MOD_LOAD:
540		ueunit = new_unrhdr(0, INT_MAX, NULL);
541		break;
542	case MOD_UNLOAD:
543		break;
544	default:
545		return (EOPNOTSUPP);
546	}
547	return (0);
548}
549static moduledata_t uether_mod = {
550	"uether",
551	uether_modevent,
552	0
553};
554
555struct mbuf *
556uether_newbuf(void)
557{
558	struct mbuf *m_new;
559
560	m_new = m_getcl(M_DONTWAIT, MT_DATA, M_PKTHDR);
561	if (m_new == NULL)
562		return (NULL);
563	m_new->m_len = m_new->m_pkthdr.len = MCLBYTES;
564
565	m_adj(m_new, ETHER_ALIGN);
566	return (m_new);
567}
568
569int
570uether_rxmbuf(struct usb_ether *ue, struct mbuf *m,
571    unsigned int len)
572{
573	struct ifnet *ifp = ue->ue_ifp;
574
575	UE_LOCK_ASSERT(ue, MA_OWNED);
576
577	/* finalize mbuf */
578	ifp->if_ipackets++;
579	m->m_pkthdr.rcvif = ifp;
580	m->m_pkthdr.len = m->m_len = len;
581
582	/* enqueue for later when the lock can be released */
583	_IF_ENQUEUE(&ue->ue_rxq, m);
584	return (0);
585}
586
587int
588uether_rxbuf(struct usb_ether *ue, struct usb_page_cache *pc,
589    unsigned int offset, unsigned int len)
590{
591	struct ifnet *ifp = ue->ue_ifp;
592	struct mbuf *m;
593
594	UE_LOCK_ASSERT(ue, MA_OWNED);
595
596	if (len < ETHER_HDR_LEN || len > MCLBYTES - ETHER_ALIGN)
597		return (1);
598
599	m = uether_newbuf();
600	if (m == NULL) {
601		ifp->if_iqdrops++;
602		return (ENOMEM);
603	}
604
605	usbd_copy_out(pc, offset, mtod(m, uint8_t *), len);
606
607	/* finalize mbuf */
608	ifp->if_ipackets++;
609	m->m_pkthdr.rcvif = ifp;
610	m->m_pkthdr.len = m->m_len = len;
611
612	/* enqueue for later when the lock can be released */
613	_IF_ENQUEUE(&ue->ue_rxq, m);
614	return (0);
615}
616
617void
618uether_rxflush(struct usb_ether *ue)
619{
620	struct ifnet *ifp = ue->ue_ifp;
621	struct mbuf *m;
622
623	UE_LOCK_ASSERT(ue, MA_OWNED);
624
625	for (;;) {
626		_IF_DEQUEUE(&ue->ue_rxq, m);
627		if (m == NULL)
628			break;
629
630		/*
631		 * The USB xfer has been resubmitted so its safe to unlock now.
632		 */
633		UE_UNLOCK(ue);
634		ifp->if_input(ifp, m);
635		UE_LOCK(ue);
636	}
637}
638
639DECLARE_MODULE(uether, uether_mod, SI_SUB_PSEUDO, SI_ORDER_ANY);
640MODULE_VERSION(uether, 1);
641