xref: /netbsd-src/sys/dev/usb/u3g.c (revision bdc22b2e01993381dcefeff2bc9b56ca75a4235c)
1 /*	$NetBSD: u3g.c,v 1.34 2017/05/24 20:23:58 christos Exp $	*/
2 
3 /*-
4  * Copyright (c) 2009 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGE.
29  */
30 
31 /*
32  * Copyright (c) 2008 AnyWi Technologies
33  *   Author: Andrea Guzzo <aguzzo@anywi.com>
34  *   * based on uark.c 1.1 2006/08/14 08:30:22 jsg *
35  *   * parts from ubsa.c 183348 2008-09-25 12:00:56Z phk *
36  *
37  * Permission to use, copy, modify, and distribute this software for any
38  * purpose with or without fee is hereby granted, provided that the above
39  * copyright notice and this permission notice appear in all copies.
40  *
41  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
42  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
43  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
44  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
45  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
46  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
47  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
48  *
49  * $FreeBSD$
50  */
51 
52 #include <sys/cdefs.h>
53 __KERNEL_RCSID(0, "$NetBSD: u3g.c,v 1.34 2017/05/24 20:23:58 christos Exp $");
54 
55 #include <sys/param.h>
56 #include <sys/systm.h>
57 #include <sys/kernel.h>
58 #include <sys/kmem.h>
59 #include <sys/bus.h>
60 #include <sys/conf.h>
61 #include <sys/tty.h>
62 
63 #include <dev/usb/usb.h>
64 #include <dev/usb/usbdi.h>
65 #include <dev/usb/usbdivar.h>
66 #include <dev/usb/usbdi_util.h>
67 
68 #include <dev/usb/ucomvar.h>
69 
70 #include "usbdevs.h"
71 
72 /*
73  * We read/write data from/to the device in 4KB chunks to maximise
74  * performance.
75  */
76 #define U3G_BUFF_SIZE	4096
77 
78 /*
79  * Some 3G devices (the Huawei E160/E220 springs to mind here) buffer up
80  * data internally even when the USB pipes are closed. So on first open,
81  * we can receive a large chunk of stale data.
82  *
83  * This causes a real problem because the default TTYDEF_LFLAG (applied
84  * on first open) has the ECHO flag set, resulting in all the stale data
85  * being echoed straight back to the device by the tty(4) layer. Some
86  * devices (again, the Huawei E160/E220 for example) react to this spew
87  * by going catatonic.
88  *
89  * All this happens before the application gets a chance to disable ECHO.
90  *
91  * We work around this by ignoring all data received from the device for
92  * a period of two seconds, or until the application starts sending data -
93  * whichever comes first.
94  */
95 #define	U3G_PURGE_SECS	2
96 
97 /*
98  * Define bits for the virtual modem control pins.
99  * The input pin states are reported via the interrupt pipe on some devices.
100  */
101 #define	U3G_OUTPIN_DTR	(1u << 0)
102 #define	U3G_OUTPIN_RTS	(1u << 1)
103 #define	U3G_INPIN_DCD	(1u << 0)
104 #define	U3G_INPIN_DSR	(1u << 1)
105 #define	U3G_INPIN_RI	(1u << 3)
106 
107 /*
108  * USB request to set the output pin status
109  */
110 #define	U3G_SET_PIN	0x22
111 
112 struct u3g_softc {
113 	device_t		sc_dev;
114 	struct usbd_device *	sc_udev;
115 	bool			sc_dying;	/* We're going away */
116 	int			sc_ifaceno;	/* Device interface number */
117 
118 	struct u3g_com {
119 		device_t	c_dev;		/* Child ucom(4) handle */
120 
121 		bool		c_open;		/* Device is in use */
122 		bool		c_purging;	/* Purging stale data */
123 		struct timeval	c_purge_start;	/* Control duration of purge */
124 
125 		u_char		c_msr;		/* Emulated 'msr' */
126 		uint16_t	c_outpins;	/* Output pin state */
127 	} sc_com[10];
128 	size_t			sc_ncom;
129 
130 	struct usbd_pipe *	sc_intr_pipe;	/* Interrupt pipe */
131 	u_char			*sc_intr_buff;	/* Interrupt buffer */
132 	size_t			sc_intr_size;	/* buffer size */
133 };
134 
135 /*
136  * The device driver has two personalities. The first uses the 'usbdevif'
137  * interface attribute so that a match will claim the entire USB device
138  * for itself. This is used for when a device needs to be mode-switched
139  * and ensures any other interfaces present cannot be claimed by other
140  * drivers while the mode-switch is in progress. This is implemented by
141  * the umodeswitch driver.
142  *
143  * The second personality uses the 'usbifif' interface attribute so that
144  * it can claim the 3G modem interfaces for itself, leaving others (such
145  * as the mass storage interfaces on some devices) for other drivers.
146  */
147 
148 static int u3g_match(device_t, cfdata_t, void *);
149 static void u3g_attach(device_t, device_t, void *);
150 static int u3g_detach(device_t, int);
151 static int u3g_activate(device_t, enum devact);
152 static void u3g_childdet(device_t, device_t);
153 
154 CFATTACH_DECL2_NEW(u3g, sizeof(struct u3g_softc), u3g_match,
155     u3g_attach, u3g_detach, u3g_activate, NULL, u3g_childdet);
156 
157 
158 static void u3g_intr(struct usbd_xfer *, void *, usbd_status);
159 static void u3g_get_status(void *, int, u_char *, u_char *);
160 static void u3g_set(void *, int, int, int);
161 static int  u3g_open(void *, int);
162 static void u3g_close(void *, int);
163 static void u3g_read(void *, int, u_char **, uint32_t *);
164 static void u3g_write(void *, int, u_char *, u_char *, uint32_t *);
165 
166 struct ucom_methods u3g_methods = {
167 	.ucom_get_status = u3g_get_status,
168 	.ucom_set = u3g_set,
169 	.ucom_param = NULL,
170 	.ucom_ioctl = NULL,
171 	.ucom_open = u3g_open,
172 	.ucom_close = u3g_close,
173 	.ucom_read = u3g_read,
174 	.ucom_write = u3g_write,
175 };
176 
177 /*
178  * Allegedly supported devices
179  */
180 static const struct usb_devno u3g_devs[] = {
181 	{ USB_VENDOR_DELL, USB_PRODUCT_DELL_W5500 },
182 	{ USB_VENDOR_HP, USB_PRODUCT_HP_UN2430 },
183 	/* OEM: Huawei */
184 	{ USB_VENDOR_HUAWEI, USB_PRODUCT_HUAWEI_E1750 },
185 	{ USB_VENDOR_HUAWEI, USB_PRODUCT_HUAWEI_E1820 },
186 	{ USB_VENDOR_HUAWEI, USB_PRODUCT_HUAWEI_E220 },
187 	{ USB_VENDOR_HUAWEI, USB_PRODUCT_HUAWEI_EM770W },
188 	{ USB_VENDOR_HUAWEI, USB_PRODUCT_HUAWEI_K3765 },
189 	{ USB_VENDOR_HUAWEI, USB_PRODUCT_HUAWEI_MOBILE },
190 	{ USB_VENDOR_HUAWEI, USB_PRODUCT_HUAWEI_E171 },
191 	{ USB_VENDOR_HUAWEI, USB_PRODUCT_HUAWEI_E353 },
192 	/* OEM: Merlin */
193 	{ USB_VENDOR_MERLIN, USB_PRODUCT_MERLIN_V620 },
194 	/* OEM: Novatel */
195 	{ USB_VENDOR_NOVATEL2, USB_PRODUCT_NOVATEL2_ES620 },
196 	{ USB_VENDOR_NOVATEL2, USB_PRODUCT_NOVATEL2_EU8X0D },
197 	{ USB_VENDOR_NOVATEL2, USB_PRODUCT_NOVATEL2_MC950D },
198 #if 0
199 	/* These are matched in u3ginit_match() */
200 	{ USB_VENDOR_NOVATEL2, USB_PRODUCT_NOVATEL2_MC950D_DRIVER },
201 	{ USB_VENDOR_NOVATEL2, USB_PRODUCT_NOVATEL2_U760_DRIVER },
202 #endif
203 	{ USB_VENDOR_NOVATEL2, USB_PRODUCT_NOVATEL2_MERLINU740 },
204 	{ USB_VENDOR_NOVATEL2, USB_PRODUCT_NOVATEL2_MERLINV620 },
205 	{ USB_VENDOR_NOVATEL2, USB_PRODUCT_NOVATEL2_S720 },
206 	{ USB_VENDOR_NOVATEL2, USB_PRODUCT_NOVATEL2_U720 },
207 	{ USB_VENDOR_NOVATEL2, USB_PRODUCT_NOVATEL2_U727 },
208 	{ USB_VENDOR_NOVATEL2, USB_PRODUCT_NOVATEL2_U740_2 },
209 	{ USB_VENDOR_NOVATEL2, USB_PRODUCT_NOVATEL2_U760 },
210 	{ USB_VENDOR_NOVATEL2, USB_PRODUCT_NOVATEL2_U870 },
211 	{ USB_VENDOR_NOVATEL2, USB_PRODUCT_NOVATEL2_V740 },
212 	{ USB_VENDOR_NOVATEL2, USB_PRODUCT_NOVATEL2_X950D },
213 	{ USB_VENDOR_NOVATEL2, USB_PRODUCT_NOVATEL2_XU870 },
214 	/* OEM: Option N.V. */
215 	{ USB_VENDOR_OPTIONNV, USB_PRODUCT_OPTIONNV_QUADPLUSUMTS },
216 	{ USB_VENDOR_OPTIONNV, USB_PRODUCT_OPTIONNV_HSDPA },
217 	{ USB_VENDOR_OPTIONNV, USB_PRODUCT_OPTIONNV_GTMAXHSUPA },
218 	/* OEM: Qualcomm, Inc. */
219 	{ USB_VENDOR_QUALCOMM, USB_PRODUCT_QUALCOMM_NTT_DOCOMO_L02C_MODEM },
220 
221 	/* OEM: Sierra Wireless: */
222 	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AC595U },
223 	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AC597E },
224 	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AC875U },
225 	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AC880 },
226 	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AC880E },
227 	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AC880U },
228 	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AC881 },
229 	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AC881E },
230 	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AC881U },
231 	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AIRCARD580 },
232 	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AIRCARD595 },
233 	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AIRCARD875 },
234 	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_C597 },
235 	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_EM5625 },
236 	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC5720 },
237 	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC5720_2 },
238 	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC5725 },
239 	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC8755 },
240 	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC8755_2 },
241 	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC8755_3 },
242 	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC8765 },
243 	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC8775_2 },
244 	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC8780 },
245 	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC8781 },
246 	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MINI5725 },
247 	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_USB305 },
248 	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_250U },
249 	/* Toshiba */
250 	{ USB_VENDOR_TOSHIBA, USB_PRODUCT_TOSHIBA_HSDPA_MODEM_EU870DT1 },
251 
252 	/* ZTE */
253 	{ USB_VENDOR_ZTE, USB_PRODUCT_ZTE_MF622 },
254 	{ USB_VENDOR_ZTE, USB_PRODUCT_ZTE_MF626 },
255 	{ USB_VENDOR_ZTE, USB_PRODUCT_ZTE_MF628 },
256 	{ USB_VENDOR_ZTE, USB_PRODUCT_ZTE_MF820D },
257 
258 	/* 4G Systems */
259 	{ USB_VENDOR_4GSYSTEMS, USB_PRODUCT_4GSYSTEMS_XSSTICK_P14 },
260 	{ USB_VENDOR_4GSYSTEMS, USB_PRODUCT_4GSYSTEMS_XSSTICK_W14 },
261 };
262 
263 /*
264  * Second personality:
265  *
266  * Claim only those interfaces required for 3G modem operation.
267  */
268 
269 static int
270 u3g_match(device_t parent, cfdata_t match, void *aux)
271 {
272 	struct usbif_attach_arg *uiaa = aux;
273 	struct usbd_interface *iface;
274 	usb_interface_descriptor_t *id;
275 	usbd_status error;
276 
277 	if (!usb_lookup(u3g_devs, uiaa->uiaa_vendor, uiaa->uiaa_product))
278 		return UMATCH_NONE;
279 
280 	error = usbd_device2interface_handle(uiaa->uiaa_device,
281 	    uiaa->uiaa_ifaceno, &iface);
282 	if (error) {
283 		printf("u3g_match: failed to get interface, err=%s\n",
284 		    usbd_errstr(error));
285 		return UMATCH_NONE;
286 	}
287 
288 	id = usbd_get_interface_descriptor(iface);
289 	if (id == NULL) {
290 		printf("u3g_match: failed to get interface descriptor\n");
291 		return UMATCH_NONE;
292 	}
293 
294 	/*
295 	 * Huawei modems use the vendor-specific class for all interfaces,
296 	 * both tty and CDC NCM, which we should avoid attaching to.
297 	 */
298 	if (uiaa->uiaa_vendor == USB_VENDOR_HUAWEI &&
299 	    id->bInterfaceSubClass == 2 &&
300 	    (id->bInterfaceProtocol & 0xf) == 6)	/* 0x16, 0x46, 0x76 */
301 		return UMATCH_NONE;
302 
303 	/*
304 	 * 3G modems generally report vendor-specific class
305 	 *
306 	 * XXX: this may be too generalised.
307 	 */
308 	return id->bInterfaceClass == UICLASS_VENDOR ?
309 	    UMATCH_VENDOR_PRODUCT : UMATCH_NONE;
310 }
311 
312 static void
313 u3g_attach(device_t parent, device_t self, void *aux)
314 {
315 	struct u3g_softc *sc = device_private(self);
316 	struct usbif_attach_arg *uiaa = aux;
317 	struct usbd_device *dev = uiaa->uiaa_device;
318 	struct usbd_interface *iface;
319 	usb_interface_descriptor_t *id;
320 	usb_endpoint_descriptor_t *ed;
321 	struct ucom_attach_args ucaa;
322 	usbd_status error;
323 	int n, intr_address, intr_size;
324 
325 	aprint_naive("\n");
326 	aprint_normal("\n");
327 
328 	sc->sc_dev = self;
329 	sc->sc_dying = false;
330 	sc->sc_udev = dev;
331 
332 	error = usbd_device2interface_handle(dev, uiaa->uiaa_ifaceno, &iface);
333 	if (error) {
334 		aprint_error_dev(self, "failed to get interface, err=%s\n",
335 		    usbd_errstr(error));
336 		return;
337 	}
338 
339 	id = usbd_get_interface_descriptor(iface);
340 
341 	ucaa.ucaa_info = "3G Modem";
342 	ucaa.ucaa_ibufsize = U3G_BUFF_SIZE;
343 	ucaa.ucaa_obufsize = U3G_BUFF_SIZE;
344 	ucaa.ucaa_ibufsizepad = U3G_BUFF_SIZE;
345 	ucaa.ucaa_opkthdrlen = 0;
346 	ucaa.ucaa_device = dev;
347 	ucaa.ucaa_iface = iface;
348 	ucaa.ucaa_methods = &u3g_methods;
349 	ucaa.ucaa_arg = sc;
350 	ucaa.ucaa_portno = -1;
351 	ucaa.ucaa_bulkin = ucaa.ucaa_bulkout = -1;
352 
353 
354 	sc->sc_ifaceno = uiaa->uiaa_ifaceno;
355 	intr_address = -1;
356 	intr_size = 0;
357 
358 	for (n = 0; n < id->bNumEndpoints; n++) {
359 		ed = usbd_interface2endpoint_descriptor(iface, n);
360 		if (ed == NULL) {
361 			aprint_error_dev(self, "no endpoint descriptor "
362 			    "for %d (interface: %d)\n", n, sc->sc_ifaceno);
363 			sc->sc_dying = true;
364 			return;
365 		}
366 
367 		if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
368 		    UE_GET_XFERTYPE(ed->bmAttributes) == UE_INTERRUPT) {
369 			intr_address = ed->bEndpointAddress;
370 			intr_size = UGETW(ed->wMaxPacketSize);
371 		} else
372 		if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
373 		    UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
374 			ucaa.ucaa_bulkin = ed->bEndpointAddress;
375 		} else
376 		if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT &&
377 		    UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
378 			ucaa.ucaa_bulkout = ed->bEndpointAddress;
379 		}
380 		if (ucaa.ucaa_bulkin != -1 && ucaa.ucaa_bulkout != -1) {
381 			struct u3g_com *com;
382 			if (sc->sc_ncom == __arraycount(sc->sc_com)) {
383 				aprint_error_dev(self, "Need to configure "
384 				    "more than %zu ttys", sc->sc_ncom);
385 				continue;
386 			}
387 			ucaa.ucaa_portno = sc->sc_ncom++;
388 			com = &sc->sc_com[ucaa.ucaa_portno];
389 			com->c_outpins = 0;
390 			com->c_msr = UMSR_DSR | UMSR_CTS | UMSR_DCD;
391 			com->c_open = false;
392 			com->c_purging = false;
393 			com->c_dev = config_found_sm_loc(self, "ucombus",
394 				NULL, &ucaa, ucomprint, ucomsubmatch);
395 			ucaa.ucaa_bulkin = -1;
396 			ucaa.ucaa_bulkout = -1;
397 		}
398 	}
399 
400 	if (sc->sc_ncom == 0) {
401 		aprint_error_dev(self, "Missing bulk in/out for interface %d\n",
402 		    sc->sc_ifaceno);
403 		sc->sc_dying = true;
404 		return;
405 	}
406 
407 	/*
408 	 * If the interface has an interrupt pipe, open it immediately so
409 	 * that we can track input pin state changes regardless of whether
410 	 * the tty(4) device is open or not.
411 	 */
412 	if (intr_address != -1) {
413 		sc->sc_intr_size = intr_size;
414 		sc->sc_intr_buff = kmem_alloc(intr_size, KM_SLEEP);
415 		error = usbd_open_pipe_intr(iface, intr_address,
416 		    USBD_SHORT_XFER_OK, &sc->sc_intr_pipe, sc, sc->sc_intr_buff,
417 		    intr_size, u3g_intr, 100);
418 		if (error) {
419 			aprint_error_dev(self, "cannot open interrupt pipe "
420 			    "(addr %d)\n", intr_address);
421 			return;
422 		}
423 	} else {
424 		sc->sc_intr_pipe = NULL;
425 		sc->sc_intr_buff = NULL;
426 	}
427 
428 	if (!pmf_device_register(self, NULL, NULL))
429 		aprint_error_dev(self, "couldn't establish power handler\n");
430 }
431 
432 static int
433 u3g_detach(device_t self, int flags)
434 {
435 	struct u3g_softc *sc = device_private(self);
436 	int rv;
437 
438 	if (sc->sc_dying)
439 		return 0;
440 
441 	pmf_device_deregister(self);
442 
443 	for (size_t i = 0; i < sc->sc_ncom; i++)
444 		if (sc->sc_com[i].c_dev != NULL) {
445 			rv = config_detach(sc->sc_com[i].c_dev, flags);
446 			if (rv != 0) {
447 				aprint_verbose_dev(self, "Can't deallocate "
448 				    "port (%d)", rv);
449 			}
450 		}
451 
452 	if (sc->sc_intr_pipe != NULL) {
453 		(void) usbd_abort_pipe(sc->sc_intr_pipe);
454 		(void) usbd_close_pipe(sc->sc_intr_pipe);
455 		sc->sc_intr_pipe = NULL;
456 	}
457 	if (sc->sc_intr_buff != NULL) {
458 		kmem_free(sc->sc_intr_buff, sc->sc_intr_size);
459 		sc->sc_intr_buff = NULL;
460 	}
461 
462 	return 0;
463 }
464 
465 static void
466 u3g_childdet(device_t self, device_t child)
467 {
468 	struct u3g_softc *sc = device_private(self);
469 
470 	for (size_t i = 0; i < sc->sc_ncom; i++)
471 		    if (sc->sc_com[i].c_dev == child)
472 			    sc->sc_com[i].c_dev = NULL;
473 }
474 
475 static int
476 u3g_activate(device_t self, enum devact act)
477 {
478 	struct u3g_softc *sc = device_private(self);
479 	int rv = 0;
480 
481 	switch (act) {
482 	case DVACT_DEACTIVATE:
483 		for (size_t i = 0; i < sc->sc_ncom; i++)
484 			if (sc->sc_com[i].c_dev != NULL &&
485 			    config_deactivate(sc->sc_com[i].c_dev) && rv == 0)
486 			rv = -1;
487 		else
488 			rv = 0;
489 		break;
490 
491 	default:
492 		break;
493 	}
494 
495 	return rv;
496 }
497 
498 static void
499 u3g_intr(struct usbd_xfer *xfer, void *priv, usbd_status status)
500 {
501 	struct u3g_softc *sc = (struct u3g_softc *)priv;
502 	u_char *buf;
503 	int portno = 0;	/* XXX */
504 	struct u3g_com *com = &sc->sc_com[portno];
505 
506 	if (sc->sc_dying)
507 		return;
508 
509 	if (status != USBD_NORMAL_COMPLETION) {
510 		if (status == USBD_NOT_STARTED || status == USBD_CANCELLED)
511 			return;
512 		usbd_clear_endpoint_stall_async(sc->sc_intr_pipe);
513 		return;
514 	}
515 
516 	buf = sc->sc_intr_buff;
517 	if (buf[0] == 0xa1 && buf[1] == 0x20) {
518 		u_char msr;
519 
520 		msr = com->c_msr & ~(UMSR_DCD | UMSR_DSR | UMSR_RI);
521 
522 		if (buf[8] & U3G_INPIN_DCD)
523 			msr |= UMSR_DCD;
524 
525 		if (buf[8] & U3G_INPIN_DSR)
526 			msr |= UMSR_DSR;
527 
528 		if (buf[8] & U3G_INPIN_RI)
529 			msr |= UMSR_RI;
530 
531 		if (msr != com->c_msr) {
532 			com->c_msr = msr;
533 			if (com->c_open)
534 				ucom_status_change(device_private(com->c_dev));
535 		}
536 	}
537 }
538 
539 /*ARGSUSED*/
540 static void
541 u3g_get_status(void *arg, int portno, u_char *lsr, u_char *msr)
542 {
543 	struct u3g_softc *sc = arg;
544 
545 	if (lsr != NULL)
546 		*lsr = 0;	/* LSR isn't supported */
547 	if (msr != NULL)
548 		*msr = sc->sc_com[portno].c_msr;
549 }
550 
551 /*ARGSUSED*/
552 static void
553 u3g_set(void *arg, int portno, int reg, int onoff)
554 {
555 	struct u3g_softc *sc = arg;
556 	usb_device_request_t req;
557 	uint16_t mask, new_state;
558 	usbd_status err;
559 	struct u3g_com *com = &sc->sc_com[portno];
560 
561 	if (sc->sc_dying)
562 		return;
563 
564 	switch (reg) {
565 	case UCOM_SET_DTR:
566 		mask = U3G_OUTPIN_DTR;
567 		break;
568 	case UCOM_SET_RTS:
569 		mask = U3G_OUTPIN_RTS;
570 		break;
571 	default:
572 		return;
573 	}
574 
575 	new_state = com->c_outpins & ~mask;
576 	if (onoff)
577 		new_state |= mask;
578 
579 	if (new_state == com->c_outpins)
580 		return;
581 
582 	com->c_outpins = new_state;
583 
584 	req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
585 	req.bRequest = U3G_SET_PIN;
586 	USETW(req.wValue, new_state);
587 	USETW(req.wIndex, sc->sc_ifaceno);
588 	USETW(req.wLength, 0);
589 
590 	err = usbd_do_request(sc->sc_udev, &req, 0);
591 	if (err == USBD_STALLED)
592 		usbd_clear_endpoint_stall(sc->sc_udev->ud_pipe0);
593 }
594 
595 /*ARGSUSED*/
596 static int
597 u3g_open(void *arg, int portno)
598 {
599 	struct u3g_softc *sc = arg;
600 	usb_device_request_t req;
601 	usb_endpoint_descriptor_t *ed;
602 	usb_interface_descriptor_t *id;
603 	struct usbd_interface *ih;
604 	usbd_status err;
605 	struct u3g_com *com = &sc->sc_com[portno];
606 	int i, nin;
607 
608 	if (sc->sc_dying)
609 		return 0;
610 
611 	err = usbd_device2interface_handle(sc->sc_udev, sc->sc_ifaceno, &ih);
612 	if (err)
613 		return EIO;
614 
615 	id = usbd_get_interface_descriptor(ih);
616 
617 	for (nin = i = 0; i < id->bNumEndpoints; i++) {
618 		ed = usbd_interface2endpoint_descriptor(ih, i);
619 		if (ed == NULL)
620 			return EIO;
621 
622 		if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
623 		    UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK &&
624 		    nin++ == portno) {
625 			/* Issue ENDPOINT_HALT request */
626 			req.bmRequestType = UT_WRITE_ENDPOINT;
627 			req.bRequest = UR_CLEAR_FEATURE;
628 			USETW(req.wValue, UF_ENDPOINT_HALT);
629 			USETW(req.wIndex, ed->bEndpointAddress);
630 			USETW(req.wLength, 0);
631 			err = usbd_do_request(sc->sc_udev, &req, 0);
632 			if (err)
633 				return EIO;
634 		}
635 	}
636 
637 	com->c_open = true;
638 	com->c_purging = true;
639 	getmicrotime(&com->c_purge_start);
640 
641 	return 0;
642 }
643 
644 /*ARGSUSED*/
645 static void
646 u3g_close(void *arg, int portno)
647 {
648 	struct u3g_softc *sc = arg;
649 	struct u3g_com *com = &sc->sc_com[portno];
650 
651 	com->c_open = false;
652 }
653 
654 /*ARGSUSED*/
655 static void
656 u3g_read(void *arg, int portno, u_char **cpp, uint32_t *ccp)
657 {
658 	struct u3g_softc *sc = arg;
659 	struct timeval curr_tv, diff_tv;
660 	struct u3g_com *com = &sc->sc_com[portno];
661 
662 	/*
663 	 * If we're not purging input data following first open, do nothing.
664 	 */
665 	if (com->c_purging == false)
666 		return;
667 
668 	/*
669 	 * Otherwise check if the purge timeout has expired
670 	 */
671 	getmicrotime(&curr_tv);
672 	timersub(&curr_tv, &com->c_purge_start, &diff_tv);
673 
674 	if (diff_tv.tv_sec >= U3G_PURGE_SECS) {
675 		/* Timeout expired. */
676 		com->c_purging = false;
677 	} else {
678 		/* Still purging. Adjust the caller's byte count. */
679 		*ccp = 0;
680 	}
681 }
682 
683 /*ARGSUSED*/
684 static void
685 u3g_write(void *arg, int portno, u_char *to, u_char *from, uint32_t *count)
686 {
687 	struct u3g_softc *sc = arg;
688 	struct u3g_com *com = &sc->sc_com[portno];
689 
690 	/*
691 	 * Stop purging as soon as the first data is written to the device.
692 	 */
693 	com->c_purging = false;
694 	memcpy(to, from, *count);
695 }
696