udbp.c revision 330897
1/*-
2 * SPDX-License-Identifier: BSD-3-Clause
3 *
4 * Copyright (c) 1996-2000 Whistle Communications, Inc.
5 * All rights reserved.
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 * 3. Neither the name of author nor the names of its
16 *    contributors may be used to endorse or promote products derived
17 *    from this software without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY NICK HIBMA AND CONTRIBUTORS
20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS
23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
30 *
31 */
32
33#include <sys/cdefs.h>
34__FBSDID("$FreeBSD: stable/11/sys/dev/usb/misc/udbp.c 330897 2018-03-14 03:19:51Z eadler $");
35
36/* Driver for arbitrary double bulk pipe devices.
37 * The driver assumes that there will be the same driver on the other side.
38 *
39 * XXX Some more information on what the framing of the IP packets looks like.
40 *
41 * To take full advantage of bulk transmission, packets should be chosen
42 * between 1k and 5k in size (1k to make sure the sending side starts
43 * streaming, and <5k to avoid overflowing the system with small TDs).
44 */
45
46
47/* probe/attach/detach:
48 *  Connect the driver to the hardware and netgraph
49 *
50 *  The reason we submit a bulk in transfer is that USB does not know about
51 *  interrupts. The bulk transfer continuously polls the device for data.
52 *  While the device has no data available, the device NAKs the TDs. As soon
53 *  as there is data, the transfer happens and the data comes flowing in.
54 *
55 *  In case you were wondering, interrupt transfers happen exactly that way.
56 *  It therefore doesn't make sense to use the interrupt pipe to signal
57 *  'data ready' and then schedule a bulk transfer to fetch it. That would
58 *  incur a 2ms delay at least, without reducing bandwidth requirements.
59 *
60 */
61
62#include <sys/stdint.h>
63#include <sys/stddef.h>
64#include <sys/param.h>
65#include <sys/queue.h>
66#include <sys/types.h>
67#include <sys/systm.h>
68#include <sys/kernel.h>
69#include <sys/bus.h>
70#include <sys/module.h>
71#include <sys/lock.h>
72#include <sys/mutex.h>
73#include <sys/condvar.h>
74#include <sys/sysctl.h>
75#include <sys/sx.h>
76#include <sys/unistd.h>
77#include <sys/callout.h>
78#include <sys/malloc.h>
79#include <sys/priv.h>
80
81#include <dev/usb/usb.h>
82#include <dev/usb/usbdi.h>
83#include <dev/usb/usbdi_util.h>
84#include "usbdevs.h"
85
86#define	USB_DEBUG_VAR udbp_debug
87#include <dev/usb/usb_debug.h>
88
89#include <sys/mbuf.h>
90
91#include <netgraph/ng_message.h>
92#include <netgraph/netgraph.h>
93#include <netgraph/ng_parse.h>
94#include <netgraph/bluetooth/include/ng_bluetooth.h>
95
96#include <dev/usb/misc/udbp.h>
97
98#ifdef USB_DEBUG
99static int udbp_debug = 0;
100
101static SYSCTL_NODE(_hw_usb, OID_AUTO, udbp, CTLFLAG_RW, 0, "USB udbp");
102SYSCTL_INT(_hw_usb_udbp, OID_AUTO, debug, CTLFLAG_RWTUN,
103    &udbp_debug, 0, "udbp debug level");
104#endif
105
106#define	UDBP_TIMEOUT	2000		/* timeout on outbound transfers, in
107					 * msecs */
108#define	UDBP_BUFFERSIZE	MCLBYTES	/* maximum number of bytes in one
109					 * transfer */
110#define	UDBP_T_WR       0
111#define	UDBP_T_RD       1
112#define	UDBP_T_WR_CS    2
113#define	UDBP_T_RD_CS    3
114#define	UDBP_T_MAX      4
115#define	UDBP_Q_MAXLEN   50
116
117struct udbp_softc {
118
119	struct mtx sc_mtx;
120	struct ng_bt_mbufq sc_xmitq_hipri;	/* hi-priority transmit queue */
121	struct ng_bt_mbufq sc_xmitq;	/* low-priority transmit queue */
122
123	struct usb_xfer *sc_xfer[UDBP_T_MAX];
124	node_p	sc_node;		/* back pointer to node */
125	hook_p	sc_hook;		/* pointer to the hook */
126	struct mbuf *sc_bulk_in_buffer;
127
128	uint32_t sc_packets_in;		/* packets in from downstream */
129	uint32_t sc_packets_out;	/* packets out towards downstream */
130
131	uint8_t	sc_flags;
132#define	UDBP_FLAG_READ_STALL    0x01	/* read transfer stalled */
133#define	UDBP_FLAG_WRITE_STALL   0x02	/* write transfer stalled */
134
135	uint8_t	sc_name[16];
136};
137
138/* prototypes */
139
140static int udbp_modload(module_t mod, int event, void *data);
141
142static device_probe_t udbp_probe;
143static device_attach_t udbp_attach;
144static device_detach_t udbp_detach;
145
146static usb_callback_t udbp_bulk_read_callback;
147static usb_callback_t udbp_bulk_read_clear_stall_callback;
148static usb_callback_t udbp_bulk_write_callback;
149static usb_callback_t udbp_bulk_write_clear_stall_callback;
150
151static void	udbp_bulk_read_complete(node_p, hook_p, void *, int);
152
153static ng_constructor_t	ng_udbp_constructor;
154static ng_rcvmsg_t	ng_udbp_rcvmsg;
155static ng_shutdown_t	ng_udbp_rmnode;
156static ng_newhook_t	ng_udbp_newhook;
157static ng_connect_t	ng_udbp_connect;
158static ng_rcvdata_t	ng_udbp_rcvdata;
159static ng_disconnect_t	ng_udbp_disconnect;
160
161/* Parse type for struct ngudbpstat */
162static const struct ng_parse_struct_field
163	ng_udbp_stat_type_fields[] = NG_UDBP_STATS_TYPE_INFO;
164
165static const struct ng_parse_type ng_udbp_stat_type = {
166	&ng_parse_struct_type,
167	&ng_udbp_stat_type_fields
168};
169
170/* List of commands and how to convert arguments to/from ASCII */
171static const struct ng_cmdlist ng_udbp_cmdlist[] = {
172	{
173		NGM_UDBP_COOKIE,
174		NGM_UDBP_GET_STATUS,
175		"getstatus",
176		NULL,
177		&ng_udbp_stat_type,
178	},
179	{
180		NGM_UDBP_COOKIE,
181		NGM_UDBP_SET_FLAG,
182		"setflag",
183		&ng_parse_int32_type,
184		NULL
185	},
186	{0}
187};
188
189/* Netgraph node type descriptor */
190static struct ng_type ng_udbp_typestruct = {
191	.version = NG_ABI_VERSION,
192	.name = NG_UDBP_NODE_TYPE,
193	.constructor = ng_udbp_constructor,
194	.rcvmsg = ng_udbp_rcvmsg,
195	.shutdown = ng_udbp_rmnode,
196	.newhook = ng_udbp_newhook,
197	.connect = ng_udbp_connect,
198	.rcvdata = ng_udbp_rcvdata,
199	.disconnect = ng_udbp_disconnect,
200	.cmdlist = ng_udbp_cmdlist,
201};
202
203/* USB config */
204static const struct usb_config udbp_config[UDBP_T_MAX] = {
205
206	[UDBP_T_WR] = {
207		.type = UE_BULK,
208		.endpoint = UE_ADDR_ANY,
209		.direction = UE_DIR_OUT,
210		.bufsize = UDBP_BUFFERSIZE,
211		.flags = {.pipe_bof = 1,.force_short_xfer = 1,},
212		.callback = &udbp_bulk_write_callback,
213		.timeout = UDBP_TIMEOUT,
214	},
215
216	[UDBP_T_RD] = {
217		.type = UE_BULK,
218		.endpoint = UE_ADDR_ANY,
219		.direction = UE_DIR_IN,
220		.bufsize = UDBP_BUFFERSIZE,
221		.flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
222		.callback = &udbp_bulk_read_callback,
223	},
224
225	[UDBP_T_WR_CS] = {
226		.type = UE_CONTROL,
227		.endpoint = 0x00,	/* Control pipe */
228		.direction = UE_DIR_ANY,
229		.bufsize = sizeof(struct usb_device_request),
230		.callback = &udbp_bulk_write_clear_stall_callback,
231		.timeout = 1000,	/* 1 second */
232		.interval = 50,	/* 50ms */
233	},
234
235	[UDBP_T_RD_CS] = {
236		.type = UE_CONTROL,
237		.endpoint = 0x00,	/* Control pipe */
238		.direction = UE_DIR_ANY,
239		.bufsize = sizeof(struct usb_device_request),
240		.callback = &udbp_bulk_read_clear_stall_callback,
241		.timeout = 1000,	/* 1 second */
242		.interval = 50,	/* 50ms */
243	},
244};
245
246static devclass_t udbp_devclass;
247
248static device_method_t udbp_methods[] = {
249	/* Device interface */
250	DEVMETHOD(device_probe, udbp_probe),
251	DEVMETHOD(device_attach, udbp_attach),
252	DEVMETHOD(device_detach, udbp_detach),
253
254	DEVMETHOD_END
255};
256
257static driver_t udbp_driver = {
258	.name = "udbp",
259	.methods = udbp_methods,
260	.size = sizeof(struct udbp_softc),
261};
262
263static const STRUCT_USB_HOST_ID udbp_devs[] = {
264	{USB_VPI(USB_VENDOR_NETCHIP, USB_PRODUCT_NETCHIP_TURBOCONNECT, 0)},
265	{USB_VPI(USB_VENDOR_NETCHIP, USB_PRODUCT_NETCHIP_GADGETZERO, 0)},
266	{USB_VPI(USB_VENDOR_PROLIFIC, USB_PRODUCT_PROLIFIC_PL2301, 0)},
267	{USB_VPI(USB_VENDOR_PROLIFIC, USB_PRODUCT_PROLIFIC_PL2302, 0)},
268	{USB_VPI(USB_VENDOR_ANCHOR, USB_PRODUCT_ANCHOR_EZLINK, 0)},
269	{USB_VPI(USB_VENDOR_GENESYS, USB_PRODUCT_GENESYS_GL620USB, 0)},
270};
271
272DRIVER_MODULE(udbp, uhub, udbp_driver, udbp_devclass, udbp_modload, 0);
273MODULE_DEPEND(udbp, netgraph, NG_ABI_VERSION, NG_ABI_VERSION, NG_ABI_VERSION);
274MODULE_DEPEND(udbp, usb, 1, 1, 1);
275MODULE_VERSION(udbp, 1);
276USB_PNP_HOST_INFO(udbp_devs);
277
278static int
279udbp_modload(module_t mod, int event, void *data)
280{
281	int error;
282
283	switch (event) {
284	case MOD_LOAD:
285		error = ng_newtype(&ng_udbp_typestruct);
286		if (error != 0) {
287			printf("%s: Could not register "
288			    "Netgraph node type, error=%d\n",
289			    NG_UDBP_NODE_TYPE, error);
290		}
291		break;
292
293	case MOD_UNLOAD:
294		error = ng_rmtype(&ng_udbp_typestruct);
295		break;
296
297	default:
298		error = EOPNOTSUPP;
299		break;
300	}
301	return (error);
302}
303
304static int
305udbp_probe(device_t dev)
306{
307	struct usb_attach_arg *uaa = device_get_ivars(dev);
308
309	if (uaa->usb_mode != USB_MODE_HOST)
310		return (ENXIO);
311	if (uaa->info.bConfigIndex != 0)
312		return (ENXIO);
313	if (uaa->info.bIfaceIndex != 0)
314		return (ENXIO);
315
316	return (usbd_lookup_id_by_uaa(udbp_devs, sizeof(udbp_devs), uaa));
317}
318
319static int
320udbp_attach(device_t dev)
321{
322	struct usb_attach_arg *uaa = device_get_ivars(dev);
323	struct udbp_softc *sc = device_get_softc(dev);
324	int error;
325
326	device_set_usb_desc(dev);
327
328	snprintf(sc->sc_name, sizeof(sc->sc_name),
329	    "%s", device_get_nameunit(dev));
330
331	mtx_init(&sc->sc_mtx, "udbp lock", NULL, MTX_DEF | MTX_RECURSE);
332
333	error = usbd_transfer_setup(uaa->device, &uaa->info.bIfaceIndex,
334	    sc->sc_xfer, udbp_config, UDBP_T_MAX, sc, &sc->sc_mtx);
335	if (error) {
336		DPRINTF("error=%s\n", usbd_errstr(error));
337		goto detach;
338	}
339	NG_BT_MBUFQ_INIT(&sc->sc_xmitq, UDBP_Q_MAXLEN);
340
341	NG_BT_MBUFQ_INIT(&sc->sc_xmitq_hipri, UDBP_Q_MAXLEN);
342
343	/* create Netgraph node */
344
345	if (ng_make_node_common(&ng_udbp_typestruct, &sc->sc_node) != 0) {
346		printf("%s: Could not create Netgraph node\n",
347		    sc->sc_name);
348		sc->sc_node = NULL;
349		goto detach;
350	}
351	/* name node */
352
353	if (ng_name_node(sc->sc_node, sc->sc_name) != 0) {
354		printf("%s: Could not name node\n",
355		    sc->sc_name);
356		NG_NODE_UNREF(sc->sc_node);
357		sc->sc_node = NULL;
358		goto detach;
359	}
360	NG_NODE_SET_PRIVATE(sc->sc_node, sc);
361
362	/* the device is now operational */
363
364	return (0);			/* success */
365
366detach:
367	udbp_detach(dev);
368	return (ENOMEM);		/* failure */
369}
370
371static int
372udbp_detach(device_t dev)
373{
374	struct udbp_softc *sc = device_get_softc(dev);
375
376	/* destroy Netgraph node */
377
378	if (sc->sc_node != NULL) {
379		NG_NODE_SET_PRIVATE(sc->sc_node, NULL);
380		ng_rmnode_self(sc->sc_node);
381		sc->sc_node = NULL;
382	}
383	/* free USB transfers, if any */
384
385	usbd_transfer_unsetup(sc->sc_xfer, UDBP_T_MAX);
386
387	mtx_destroy(&sc->sc_mtx);
388
389	/* destroy queues */
390
391	NG_BT_MBUFQ_DESTROY(&sc->sc_xmitq);
392	NG_BT_MBUFQ_DESTROY(&sc->sc_xmitq_hipri);
393
394	/* extra check */
395
396	if (sc->sc_bulk_in_buffer) {
397		m_freem(sc->sc_bulk_in_buffer);
398		sc->sc_bulk_in_buffer = NULL;
399	}
400	return (0);			/* success */
401}
402
403static void
404udbp_bulk_read_callback(struct usb_xfer *xfer, usb_error_t error)
405{
406	struct udbp_softc *sc = usbd_xfer_softc(xfer);
407	struct usb_page_cache *pc;
408	struct mbuf *m;
409	int actlen;
410
411	usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
412
413	switch (USB_GET_STATE(xfer)) {
414	case USB_ST_TRANSFERRED:
415
416		/* allocate new mbuf */
417
418		MGETHDR(m, M_NOWAIT, MT_DATA);
419
420		if (m == NULL) {
421			goto tr_setup;
422		}
423
424		if (!(MCLGET(m, M_NOWAIT))) {
425			m_freem(m);
426			goto tr_setup;
427		}
428		m->m_pkthdr.len = m->m_len = actlen;
429
430		pc = usbd_xfer_get_frame(xfer, 0);
431		usbd_copy_out(pc, 0, m->m_data, actlen);
432
433		sc->sc_bulk_in_buffer = m;
434
435		DPRINTF("received package %d bytes\n", actlen);
436
437	case USB_ST_SETUP:
438tr_setup:
439		if (sc->sc_bulk_in_buffer) {
440			ng_send_fn(sc->sc_node, NULL, &udbp_bulk_read_complete, NULL, 0);
441			return;
442		}
443		if (sc->sc_flags & UDBP_FLAG_READ_STALL) {
444			usbd_transfer_start(sc->sc_xfer[UDBP_T_RD_CS]);
445			return;
446		}
447		usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
448		usbd_transfer_submit(xfer);
449		return;
450
451	default:			/* Error */
452		if (error != USB_ERR_CANCELLED) {
453			/* try to clear stall first */
454			sc->sc_flags |= UDBP_FLAG_READ_STALL;
455			usbd_transfer_start(sc->sc_xfer[UDBP_T_RD_CS]);
456		}
457		return;
458
459	}
460}
461
462static void
463udbp_bulk_read_clear_stall_callback(struct usb_xfer *xfer, usb_error_t error)
464{
465	struct udbp_softc *sc = usbd_xfer_softc(xfer);
466	struct usb_xfer *xfer_other = sc->sc_xfer[UDBP_T_RD];
467
468	if (usbd_clear_stall_callback(xfer, xfer_other)) {
469		DPRINTF("stall cleared\n");
470		sc->sc_flags &= ~UDBP_FLAG_READ_STALL;
471		usbd_transfer_start(xfer_other);
472	}
473}
474
475static void
476udbp_bulk_read_complete(node_p node, hook_p hook, void *arg1, int arg2)
477{
478	struct udbp_softc *sc = NG_NODE_PRIVATE(node);
479	struct mbuf *m;
480	int error;
481
482	if (sc == NULL) {
483		return;
484	}
485	mtx_lock(&sc->sc_mtx);
486
487	m = sc->sc_bulk_in_buffer;
488
489	if (m) {
490
491		sc->sc_bulk_in_buffer = NULL;
492
493		if ((sc->sc_hook == NULL) ||
494		    NG_HOOK_NOT_VALID(sc->sc_hook)) {
495			DPRINTF("No upstream hook\n");
496			goto done;
497		}
498		sc->sc_packets_in++;
499
500		NG_SEND_DATA_ONLY(error, sc->sc_hook, m);
501
502		m = NULL;
503	}
504done:
505	if (m) {
506		m_freem(m);
507	}
508	/* start USB bulk-in transfer, if not already started */
509
510	usbd_transfer_start(sc->sc_xfer[UDBP_T_RD]);
511
512	mtx_unlock(&sc->sc_mtx);
513}
514
515static void
516udbp_bulk_write_callback(struct usb_xfer *xfer, usb_error_t error)
517{
518	struct udbp_softc *sc = usbd_xfer_softc(xfer);
519	struct usb_page_cache *pc;
520	struct mbuf *m;
521
522	switch (USB_GET_STATE(xfer)) {
523	case USB_ST_TRANSFERRED:
524
525		sc->sc_packets_out++;
526
527	case USB_ST_SETUP:
528		if (sc->sc_flags & UDBP_FLAG_WRITE_STALL) {
529			usbd_transfer_start(sc->sc_xfer[UDBP_T_WR_CS]);
530			return;
531		}
532		/* get next mbuf, if any */
533
534		NG_BT_MBUFQ_DEQUEUE(&sc->sc_xmitq_hipri, m);
535		if (m == NULL) {
536			NG_BT_MBUFQ_DEQUEUE(&sc->sc_xmitq, m);
537			if (m == NULL) {
538				DPRINTF("Data queue is empty\n");
539				return;
540			}
541		}
542		if (m->m_pkthdr.len > MCLBYTES) {
543			DPRINTF("truncating large packet "
544			    "from %d to %d bytes\n", m->m_pkthdr.len,
545			    MCLBYTES);
546			m->m_pkthdr.len = MCLBYTES;
547		}
548		pc = usbd_xfer_get_frame(xfer, 0);
549		usbd_m_copy_in(pc, 0, m, 0, m->m_pkthdr.len);
550
551		usbd_xfer_set_frame_len(xfer, 0, m->m_pkthdr.len);
552
553		DPRINTF("packet out: %d bytes\n", m->m_pkthdr.len);
554
555		m_freem(m);
556
557		usbd_transfer_submit(xfer);
558		return;
559
560	default:			/* Error */
561		if (error != USB_ERR_CANCELLED) {
562			/* try to clear stall first */
563			sc->sc_flags |= UDBP_FLAG_WRITE_STALL;
564			usbd_transfer_start(sc->sc_xfer[UDBP_T_WR_CS]);
565		}
566		return;
567
568	}
569}
570
571static void
572udbp_bulk_write_clear_stall_callback(struct usb_xfer *xfer, usb_error_t error)
573{
574	struct udbp_softc *sc = usbd_xfer_softc(xfer);
575	struct usb_xfer *xfer_other = sc->sc_xfer[UDBP_T_WR];
576
577	if (usbd_clear_stall_callback(xfer, xfer_other)) {
578		DPRINTF("stall cleared\n");
579		sc->sc_flags &= ~UDBP_FLAG_WRITE_STALL;
580		usbd_transfer_start(xfer_other);
581	}
582}
583
584/***********************************************************************
585 * Start of Netgraph methods
586 **********************************************************************/
587
588/*
589 * If this is a device node so this work is done in the attach()
590 * routine and the constructor will return EINVAL as you should not be able
591 * to create nodes that depend on hardware (unless you can add the hardware :)
592 */
593static int
594ng_udbp_constructor(node_p node)
595{
596	return (EINVAL);
597}
598
599/*
600 * Give our ok for a hook to be added...
601 * If we are not running this might kick a device into life.
602 * Possibly decode information out of the hook name.
603 * Add the hook's private info to the hook structure.
604 * (if we had some). In this example, we assume that there is a
605 * an array of structs, called 'channel' in the private info,
606 * one for each active channel. The private
607 * pointer of each hook points to the appropriate UDBP_hookinfo struct
608 * so that the source of an input packet is easily identified.
609 */
610static int
611ng_udbp_newhook(node_p node, hook_p hook, const char *name)
612{
613	struct udbp_softc *sc = NG_NODE_PRIVATE(node);
614	int32_t error = 0;
615
616	if (strcmp(name, NG_UDBP_HOOK_NAME)) {
617		return (EINVAL);
618	}
619	mtx_lock(&sc->sc_mtx);
620
621	if (sc->sc_hook != NULL) {
622		error = EISCONN;
623	} else {
624		sc->sc_hook = hook;
625		NG_HOOK_SET_PRIVATE(hook, NULL);
626	}
627
628	mtx_unlock(&sc->sc_mtx);
629
630	return (error);
631}
632
633/*
634 * Get a netgraph control message.
635 * Check it is one we understand. If needed, send a response.
636 * We could save the address for an async action later, but don't here.
637 * Always free the message.
638 * The response should be in a malloc'd region that the caller can 'free'.
639 * A response is not required.
640 * Theoretically you could respond defferently to old message types if
641 * the cookie in the header didn't match what we consider to be current
642 * (so that old userland programs could continue to work).
643 */
644static int
645ng_udbp_rcvmsg(node_p node, item_p item, hook_p lasthook)
646{
647	struct udbp_softc *sc = NG_NODE_PRIVATE(node);
648	struct ng_mesg *resp = NULL;
649	int error = 0;
650	struct ng_mesg *msg;
651
652	NGI_GET_MSG(item, msg);
653	/* Deal with message according to cookie and command */
654	switch (msg->header.typecookie) {
655	case NGM_UDBP_COOKIE:
656		switch (msg->header.cmd) {
657		case NGM_UDBP_GET_STATUS:
658			{
659				struct ngudbpstat *stats;
660
661				NG_MKRESPONSE(resp, msg, sizeof(*stats), M_NOWAIT);
662				if (!resp) {
663					error = ENOMEM;
664					break;
665				}
666				stats = (struct ngudbpstat *)resp->data;
667				mtx_lock(&sc->sc_mtx);
668				stats->packets_in = sc->sc_packets_in;
669				stats->packets_out = sc->sc_packets_out;
670				mtx_unlock(&sc->sc_mtx);
671				break;
672			}
673		case NGM_UDBP_SET_FLAG:
674			if (msg->header.arglen != sizeof(uint32_t)) {
675				error = EINVAL;
676				break;
677			}
678			DPRINTF("flags = 0x%08x\n",
679			    *((uint32_t *)msg->data));
680			break;
681		default:
682			error = EINVAL;	/* unknown command */
683			break;
684		}
685		break;
686	default:
687		error = EINVAL;		/* unknown cookie type */
688		break;
689	}
690
691	/* Take care of synchronous response, if any */
692	NG_RESPOND_MSG(error, node, item, resp);
693	NG_FREE_MSG(msg);
694	return (error);
695}
696
697/*
698 * Accept data from the hook and queue it for output.
699 */
700static int
701ng_udbp_rcvdata(hook_p hook, item_p item)
702{
703	struct udbp_softc *sc = NG_NODE_PRIVATE(NG_HOOK_NODE(hook));
704	struct ng_bt_mbufq *queue_ptr;
705	struct mbuf *m;
706	struct ng_tag_prio *ptag;
707	int error;
708
709	if (sc == NULL) {
710		NG_FREE_ITEM(item);
711		return (EHOSTDOWN);
712	}
713	NGI_GET_M(item, m);
714	NG_FREE_ITEM(item);
715
716	/*
717	 * Now queue the data for when it can be sent
718	 */
719	ptag = (void *)m_tag_locate(m, NGM_GENERIC_COOKIE,
720	    NG_TAG_PRIO, NULL);
721
722	if (ptag && (ptag->priority > NG_PRIO_CUTOFF))
723		queue_ptr = &sc->sc_xmitq_hipri;
724	else
725		queue_ptr = &sc->sc_xmitq;
726
727	mtx_lock(&sc->sc_mtx);
728
729	if (NG_BT_MBUFQ_FULL(queue_ptr)) {
730		NG_BT_MBUFQ_DROP(queue_ptr);
731		NG_FREE_M(m);
732		error = ENOBUFS;
733	} else {
734		NG_BT_MBUFQ_ENQUEUE(queue_ptr, m);
735		/*
736		 * start bulk-out transfer, if not already started:
737		 */
738		usbd_transfer_start(sc->sc_xfer[UDBP_T_WR]);
739		error = 0;
740	}
741
742	mtx_unlock(&sc->sc_mtx);
743
744	return (error);
745}
746
747/*
748 * Do local shutdown processing..
749 * We are a persistent device, we refuse to go away, and
750 * only remove our links and reset ourself.
751 */
752static int
753ng_udbp_rmnode(node_p node)
754{
755	struct udbp_softc *sc = NG_NODE_PRIVATE(node);
756
757	/* Let old node go */
758	NG_NODE_SET_PRIVATE(node, NULL);
759	NG_NODE_UNREF(node);		/* forget it ever existed */
760
761	if (sc == NULL) {
762		goto done;
763	}
764	/* Create Netgraph node */
765	if (ng_make_node_common(&ng_udbp_typestruct, &sc->sc_node) != 0) {
766		printf("%s: Could not create Netgraph node\n",
767		    sc->sc_name);
768		sc->sc_node = NULL;
769		goto done;
770	}
771	/* Name node */
772	if (ng_name_node(sc->sc_node, sc->sc_name) != 0) {
773		printf("%s: Could not name Netgraph node\n",
774		    sc->sc_name);
775		NG_NODE_UNREF(sc->sc_node);
776		sc->sc_node = NULL;
777		goto done;
778	}
779	NG_NODE_SET_PRIVATE(sc->sc_node, sc);
780
781done:
782	if (sc) {
783		mtx_unlock(&sc->sc_mtx);
784	}
785	return (0);
786}
787
788/*
789 * This is called once we've already connected a new hook to the other node.
790 * It gives us a chance to balk at the last minute.
791 */
792static int
793ng_udbp_connect(hook_p hook)
794{
795	struct udbp_softc *sc = NG_NODE_PRIVATE(NG_HOOK_NODE(hook));
796
797	/* probably not at splnet, force outward queueing */
798	NG_HOOK_FORCE_QUEUE(NG_HOOK_PEER(hook));
799
800	mtx_lock(&sc->sc_mtx);
801
802	sc->sc_flags |= (UDBP_FLAG_READ_STALL |
803	    UDBP_FLAG_WRITE_STALL);
804
805	/* start bulk-in transfer */
806	usbd_transfer_start(sc->sc_xfer[UDBP_T_RD]);
807
808	/* start bulk-out transfer */
809	usbd_transfer_start(sc->sc_xfer[UDBP_T_WR]);
810
811	mtx_unlock(&sc->sc_mtx);
812
813	return (0);
814}
815
816/*
817 * Dook disconnection
818 *
819 * For this type, removal of the last link destroys the node
820 */
821static int
822ng_udbp_disconnect(hook_p hook)
823{
824	struct udbp_softc *sc = NG_NODE_PRIVATE(NG_HOOK_NODE(hook));
825	int error = 0;
826
827	if (sc != NULL) {
828
829		mtx_lock(&sc->sc_mtx);
830
831		if (hook != sc->sc_hook) {
832			error = EINVAL;
833		} else {
834
835			/* stop bulk-in transfer */
836			usbd_transfer_stop(sc->sc_xfer[UDBP_T_RD_CS]);
837			usbd_transfer_stop(sc->sc_xfer[UDBP_T_RD]);
838
839			/* stop bulk-out transfer */
840			usbd_transfer_stop(sc->sc_xfer[UDBP_T_WR_CS]);
841			usbd_transfer_stop(sc->sc_xfer[UDBP_T_WR]);
842
843			/* cleanup queues */
844			NG_BT_MBUFQ_DRAIN(&sc->sc_xmitq);
845			NG_BT_MBUFQ_DRAIN(&sc->sc_xmitq_hipri);
846
847			if (sc->sc_bulk_in_buffer) {
848				m_freem(sc->sc_bulk_in_buffer);
849				sc->sc_bulk_in_buffer = NULL;
850			}
851			sc->sc_hook = NULL;
852		}
853
854		mtx_unlock(&sc->sc_mtx);
855	}
856	if ((NG_NODE_NUMHOOKS(NG_HOOK_NODE(hook)) == 0)
857	    && (NG_NODE_IS_VALID(NG_HOOK_NODE(hook))))
858		ng_rmnode_self(NG_HOOK_NODE(hook));
859
860	return (error);
861}
862