1/*	$NetBSD: u3g.c,v 1.44 2023/02/13 14:05:26 manu 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.44 2023/02/13 14:05:26 manu 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
112struct 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	struct usbd_interface	*sc_iface;	/* Device interface */
118
119	struct u3g_com {
120		device_t	c_dev;		/* Child ucom(4) handle */
121
122		bool		c_open;		/* Device is in use */
123		bool		c_purging;	/* Purging stale data */
124		struct timeval	c_purge_start;	/* Control duration of purge */
125
126		u_char		c_msr;		/* Emulated 'msr' */
127		uint16_t	c_outpins;	/* Output pin state */
128	} sc_com[10];
129	size_t			sc_ncom;
130
131	struct usbd_pipe *	sc_intr_pipe;	/* Interrupt pipe */
132	u_char			*sc_intr_buff;	/* Interrupt buffer */
133	size_t			sc_intr_size;	/* buffer size */
134};
135
136/*
137 * The device driver has two personalities. The first uses the 'usbdevif'
138 * interface attribute so that a match will claim the entire USB device
139 * for itself. This is used for when a device needs to be mode-switched
140 * and ensures any other interfaces present cannot be claimed by other
141 * drivers while the mode-switch is in progress. This is implemented by
142 * the umodeswitch driver.
143 *
144 * The second personality uses the 'usbifif' interface attribute so that
145 * it can claim the 3G modem interfaces for itself, leaving others (such
146 * as the mass storage interfaces on some devices) for other drivers.
147 */
148
149static int u3g_match(device_t, cfdata_t, void *);
150static void u3g_attach(device_t, device_t, void *);
151static int u3g_detach(device_t, int);
152static void u3g_childdet(device_t, device_t);
153
154CFATTACH_DECL2_NEW(u3g, sizeof(struct u3g_softc), u3g_match,
155    u3g_attach, u3g_detach, NULL, NULL, u3g_childdet);
156
157
158static void u3g_intr(struct usbd_xfer *, void *, usbd_status);
159static void u3g_get_status(void *, int, u_char *, u_char *);
160static void u3g_set(void *, int, int, int);
161static int  u3g_open(void *, int);
162static void u3g_close(void *, int);
163static void u3g_read(void *, int, u_char **, uint32_t *);
164static void u3g_write(void *, int, u_char *, u_char *, uint32_t *);
165
166static const struct ucom_methods u3g_methods = {
167	.ucom_get_status = u3g_get_status,
168	.ucom_set = u3g_set,
169	.ucom_open = u3g_open,
170	.ucom_close = u3g_close,
171	.ucom_read = u3g_read,
172	.ucom_write = u3g_write,
173};
174
175/*
176 * Allegedly supported devices
177 */
178static const struct usb_devno u3g_devs[] = {
179	{ USB_VENDOR_DELL, USB_PRODUCT_DELL_W5500 },
180	{ USB_VENDOR_HP, USB_PRODUCT_HP_UN2430 },
181	/* OEM: Huawei */
182	{ USB_VENDOR_HUAWEI, USB_PRODUCT_HUAWEI_E1750 },
183	{ USB_VENDOR_HUAWEI, USB_PRODUCT_HUAWEI_E1820 },
184	{ USB_VENDOR_HUAWEI, USB_PRODUCT_HUAWEI_E220 },
185	{ USB_VENDOR_HUAWEI, USB_PRODUCT_HUAWEI_EM770W },
186	{ USB_VENDOR_HUAWEI, USB_PRODUCT_HUAWEI_K3765 },
187	{ USB_VENDOR_HUAWEI, USB_PRODUCT_HUAWEI_MOBILE },
188	{ USB_VENDOR_HUAWEI, USB_PRODUCT_HUAWEI_E171 },
189	{ USB_VENDOR_HUAWEI, USB_PRODUCT_HUAWEI_E353 },
190	/* LG Electronics */
191	{ USB_VENDOR_LG, USB_PRODUCT_LG_NTT_DOCOMO_L02C_MODEM },
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
219	/* OEM: Sierra Wireless: */
220	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AC595U },
221	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AC597E },
222	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AC875U },
223	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AC880 },
224	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AC880E },
225	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AC880U },
226	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AC881 },
227	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AC881E },
228	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AC881U },
229	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AIRCARD580 },
230	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AIRCARD595 },
231	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AIRCARD875 },
232	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_C597 },
233	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_EM5625 },
234	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC5720 },
235	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC5720_2 },
236	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC5725 },
237	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC8755 },
238	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC8755_2 },
239	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC8755_3 },
240	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC8765 },
241	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC8775_2 },
242	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC8780 },
243	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC8781 },
244	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MINI5725 },
245	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_USB305 },
246	{ USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_250U },
247	/* Toshiba */
248	{ USB_VENDOR_TOSHIBA, USB_PRODUCT_TOSHIBA_HSDPA_MODEM_EU870DT1 },
249
250	/* ZTE */
251	{ USB_VENDOR_ZTE, USB_PRODUCT_ZTE_MF622 },
252	{ USB_VENDOR_ZTE, USB_PRODUCT_ZTE_MF626 },
253	{ USB_VENDOR_ZTE, USB_PRODUCT_ZTE_MF628 },
254	{ USB_VENDOR_ZTE, USB_PRODUCT_ZTE_MF820D },
255	{ USB_VENDOR_ZTE, USB_PRODUCT_ZTE_MF112 },
256
257	/* 4G Systems */
258	{ USB_VENDOR_LONGCHEER, USB_PRODUCT_LONGCHEER_XSSTICK_P14 },
259	{ USB_VENDOR_LONGCHEER, USB_PRODUCT_LONGCHEER_XSSTICK_W14 },
260
261	/* DLink */
262	{ USB_VENDOR_DLINK, USB_PRODUCT_DLINK_DWM157 },
263	{ USB_VENDOR_DLINK, USB_PRODUCT_DLINK_DWM157E },
264	{ USB_VENDOR_DLINK, USB_PRODUCT_DLINK_DWM222 },
265};
266
267/*
268 * Second personality:
269 *
270 * Claim only those interfaces required for 3G modem operation.
271 */
272
273static int
274u3g_match(device_t parent, cfdata_t match, void *aux)
275{
276	struct usbif_attach_arg *uiaa = aux;
277	struct usbd_interface *iface = uiaa->uiaa_iface;
278	usb_interface_descriptor_t *id;
279
280	if (!usb_lookup(u3g_devs, uiaa->uiaa_vendor, uiaa->uiaa_product))
281		return UMATCH_NONE;
282
283	id = usbd_get_interface_descriptor(iface);
284	if (id == NULL) {
285		printf("u3g_match: failed to get interface descriptor\n");
286		return UMATCH_NONE;
287	}
288
289	/*
290	 * Huawei modems use the vendor-specific class for all interfaces,
291	 * both tty and CDC NCM, which we should avoid attaching to.
292	 */
293	if (uiaa->uiaa_vendor == USB_VENDOR_HUAWEI &&
294	    id->bInterfaceSubClass == 2 &&
295	    (id->bInterfaceProtocol & 0xf) == 6)	/* 0x16, 0x46, 0x76 */
296		return UMATCH_NONE;
297
298	/*
299	 * Sierra Wireless modems use the vendor-specific class also for
300	 * Direct IP or QMI interfaces, which we should avoid attaching to.
301	 */
302	if (uiaa->uiaa_vendor == USB_VENDOR_SIERRA &&
303	    id->bInterfaceClass == UICLASS_VENDOR &&
304	    uiaa->uiaa_product == USB_PRODUCT_SIERRA_USB305 &&
305	     uiaa->uiaa_ifaceno >= 7)
306		return UMATCH_NONE;
307
308	/*
309	 * 3G modems generally report vendor-specific class
310	 *
311	 * XXX: this may be too generalised.
312	 */
313	return id->bInterfaceClass == UICLASS_VENDOR ?
314	    UMATCH_VENDOR_PRODUCT : UMATCH_NONE;
315}
316
317static void
318u3g_attach(device_t parent, device_t self, void *aux)
319{
320	struct u3g_softc *sc = device_private(self);
321	struct usbif_attach_arg *uiaa = aux;
322	struct usbd_device *dev = uiaa->uiaa_device;
323	struct usbd_interface *iface = uiaa->uiaa_iface;
324	usb_interface_descriptor_t *id;
325	usb_endpoint_descriptor_t *ed;
326	struct ucom_attach_args ucaa;
327	usbd_status error;
328	int n, intr_address, intr_size;
329
330	aprint_naive("\n");
331	aprint_normal("\n");
332
333	sc->sc_dev = self;
334	sc->sc_dying = false;
335	sc->sc_udev = dev;
336
337	id = usbd_get_interface_descriptor(iface);
338
339	ucaa.ucaa_info = "3G Modem";
340	ucaa.ucaa_ibufsize = U3G_BUFF_SIZE;
341	ucaa.ucaa_obufsize = U3G_BUFF_SIZE;
342	ucaa.ucaa_ibufsizepad = U3G_BUFF_SIZE;
343	ucaa.ucaa_opkthdrlen = 0;
344	ucaa.ucaa_device = dev;
345	ucaa.ucaa_iface = iface;
346	ucaa.ucaa_methods = &u3g_methods;
347	ucaa.ucaa_arg = sc;
348	ucaa.ucaa_portno = -1;
349	ucaa.ucaa_bulkin = ucaa.ucaa_bulkout = -1;
350
351	sc->sc_ifaceno = uiaa->uiaa_ifaceno;
352	sc->sc_iface = uiaa->uiaa_iface;
353	intr_address = -1;
354	intr_size = 0;
355
356	for (n = 0; n < id->bNumEndpoints; n++) {
357		ed = usbd_interface2endpoint_descriptor(iface, n);
358		if (ed == NULL) {
359			aprint_error_dev(self, "no endpoint descriptor "
360			    "for %d (interface: %d)\n", n, sc->sc_ifaceno);
361			sc->sc_dying = true;
362			return;
363		}
364
365		if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
366		    UE_GET_XFERTYPE(ed->bmAttributes) == UE_INTERRUPT) {
367			intr_address = ed->bEndpointAddress;
368			intr_size = UGETW(ed->wMaxPacketSize);
369		} else
370		if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
371		    UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
372			ucaa.ucaa_bulkin = ed->bEndpointAddress;
373		} else
374		if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT &&
375		    UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
376			ucaa.ucaa_bulkout = ed->bEndpointAddress;
377		}
378		if (ucaa.ucaa_bulkin != -1 && ucaa.ucaa_bulkout != -1) {
379			struct u3g_com *com;
380			if (sc->sc_ncom == __arraycount(sc->sc_com)) {
381				aprint_error_dev(self, "Need to configure "
382				    "more than %zu ttys", sc->sc_ncom);
383				continue;
384			}
385			ucaa.ucaa_portno = sc->sc_ncom++;
386			com = &sc->sc_com[ucaa.ucaa_portno];
387			com->c_outpins = 0;
388			com->c_msr = UMSR_DSR | UMSR_CTS | UMSR_DCD;
389			com->c_open = false;
390			com->c_purging = false;
391			com->c_dev = config_found(self, &ucaa, ucomprint,
392			    CFARGS(.submatch = ucomsubmatch));
393			ucaa.ucaa_bulkin = -1;
394			ucaa.ucaa_bulkout = -1;
395		}
396	}
397
398	if (sc->sc_ncom == 0) {
399		aprint_error_dev(self, "Missing bulk in/out for interface %d\n",
400		    sc->sc_ifaceno);
401		sc->sc_dying = true;
402		return;
403	}
404
405	/*
406	 * If the interface has an interrupt pipe, open it immediately so
407	 * that we can track input pin state changes regardless of whether
408	 * the tty(4) device is open or not.
409	 */
410	if (intr_address != -1) {
411		sc->sc_intr_size = intr_size;
412		sc->sc_intr_buff = kmem_alloc(intr_size, KM_SLEEP);
413		error = usbd_open_pipe_intr(iface, intr_address,
414		    USBD_SHORT_XFER_OK, &sc->sc_intr_pipe, sc, sc->sc_intr_buff,
415		    intr_size, u3g_intr, 100);
416		if (error) {
417			aprint_error_dev(self, "cannot open interrupt pipe "
418			    "(addr %d)\n", intr_address);
419			return;
420		}
421	} else {
422		sc->sc_intr_pipe = NULL;
423		sc->sc_intr_buff = NULL;
424	}
425
426	if (!pmf_device_register(self, NULL, NULL))
427		aprint_error_dev(self, "couldn't establish power handler\n");
428}
429
430static int
431u3g_detach(device_t self, int flags)
432{
433	struct u3g_softc *sc = device_private(self);
434	int rv = 0;
435
436	sc->sc_dying = true;
437
438	if (sc->sc_intr_pipe != NULL) {
439		usbd_abort_pipe(sc->sc_intr_pipe);
440		usbd_close_pipe(sc->sc_intr_pipe);
441		sc->sc_intr_pipe = NULL;
442	}
443	if (sc->sc_intr_buff != NULL) {
444		kmem_free(sc->sc_intr_buff, sc->sc_intr_size);
445		sc->sc_intr_buff = NULL;
446	}
447
448	for (size_t i = 0; i < sc->sc_ncom; i++)
449		if (sc->sc_com[i].c_dev != NULL) {
450			int port_rv;
451
452			port_rv = config_detach(sc->sc_com[i].c_dev, flags);
453			if (port_rv != 0) {
454				aprint_verbose_dev(self, "Can't deallocate "
455				    "port (%d)", port_rv);
456			}
457			rv |= port_rv;
458			sc->sc_com[i].c_dev = NULL;
459		}
460
461	pmf_device_deregister(self);
462
463	return rv;
464}
465
466static void
467u3g_childdet(device_t self, device_t child)
468{
469	struct u3g_softc *sc = device_private(self);
470
471	for (size_t i = 0; i < sc->sc_ncom; i++)
472		    if (sc->sc_com[i].c_dev == child)
473			    sc->sc_com[i].c_dev = NULL;
474}
475
476static void
477u3g_intr(struct usbd_xfer *xfer, void *priv, usbd_status status)
478{
479	struct u3g_softc *sc = (struct u3g_softc *)priv;
480	u_char *buf;
481	int portno = 0;	/* XXX */
482	struct u3g_com *com = &sc->sc_com[portno];
483
484	if (sc->sc_dying)
485		return;
486
487	if (status != USBD_NORMAL_COMPLETION) {
488		if (status == USBD_NOT_STARTED || status == USBD_CANCELLED)
489			return;
490		usbd_clear_endpoint_stall_async(sc->sc_intr_pipe);
491		return;
492	}
493
494	buf = sc->sc_intr_buff;
495	if (buf[0] == 0xa1 && buf[1] == 0x20) {
496		u_char msr;
497
498		msr = com->c_msr & ~(UMSR_DCD | UMSR_DSR | UMSR_RI);
499
500		if (buf[8] & U3G_INPIN_DCD)
501			msr |= UMSR_DCD;
502
503		if (buf[8] & U3G_INPIN_DSR)
504			msr |= UMSR_DSR;
505
506		if (buf[8] & U3G_INPIN_RI)
507			msr |= UMSR_RI;
508
509		if (msr != com->c_msr) {
510			com->c_msr = msr;
511			if (com->c_open)
512				ucom_status_change(device_private(com->c_dev));
513		}
514	}
515}
516
517/*ARGSUSED*/
518static void
519u3g_get_status(void *arg, int portno, u_char *lsr, u_char *msr)
520{
521	struct u3g_softc *sc = arg;
522
523	*lsr = 0;	/* LSR isn't supported */
524	*msr = sc->sc_com[portno].c_msr;
525}
526
527/*ARGSUSED*/
528static void
529u3g_set(void *arg, int portno, int reg, int onoff)
530{
531	struct u3g_softc *sc = arg;
532	usb_device_request_t req;
533	uint16_t mask, new_state;
534	usbd_status err;
535	struct u3g_com *com = &sc->sc_com[portno];
536
537	if (sc->sc_dying)
538		return;
539
540	switch (reg) {
541	case UCOM_SET_DTR:
542		mask = U3G_OUTPIN_DTR;
543		break;
544	case UCOM_SET_RTS:
545		mask = U3G_OUTPIN_RTS;
546		break;
547	default:
548		return;
549	}
550
551	new_state = com->c_outpins & ~mask;
552	if (onoff)
553		new_state |= mask;
554
555	if (new_state == com->c_outpins)
556		return;
557
558	com->c_outpins = new_state;
559
560	req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
561	req.bRequest = U3G_SET_PIN;
562	USETW(req.wValue, new_state);
563	USETW(req.wIndex, sc->sc_ifaceno);
564	USETW(req.wLength, 0);
565
566	err = usbd_do_request(sc->sc_udev, &req, 0);
567	if (err == USBD_STALLED)
568		usbd_clear_endpoint_stall(sc->sc_udev->ud_pipe0);
569}
570
571/*ARGSUSED*/
572static int
573u3g_open(void *arg, int portno)
574{
575	struct u3g_softc *sc = arg;
576	usb_endpoint_descriptor_t *ed;
577	usb_interface_descriptor_t *id;
578	usbd_status err;
579	struct u3g_com *com = &sc->sc_com[portno];
580	int i, nin;
581
582	if (sc->sc_dying)
583 		return EIO;
584
585	id = usbd_get_interface_descriptor(sc->sc_iface);
586
587	for (nin = i = 0; i < id->bNumEndpoints; i++) {
588		ed = usbd_interface2endpoint_descriptor(sc->sc_iface, i);
589		if (ed == NULL)
590			return EIO;
591
592		if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
593		    UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK &&
594		    nin++ == portno) {
595			err = usbd_clear_endpoint_feature(sc->sc_udev,
596			    ed->bEndpointAddress, UF_ENDPOINT_HALT);
597			if (err)
598				return EIO;
599		}
600	}
601
602	com->c_open = true;
603	com->c_purging = true;
604	getmicrotime(&com->c_purge_start);
605
606	return 0;
607}
608
609/*ARGSUSED*/
610static void
611u3g_close(void *arg, int portno)
612{
613	struct u3g_softc *sc = arg;
614	struct u3g_com *com = &sc->sc_com[portno];
615
616	com->c_open = false;
617}
618
619/*ARGSUSED*/
620static void
621u3g_read(void *arg, int portno, u_char **cpp, uint32_t *ccp)
622{
623	struct u3g_softc *sc = arg;
624	struct timeval curr_tv, diff_tv;
625	struct u3g_com *com = &sc->sc_com[portno];
626
627	/*
628	 * If we're not purging input data following first open, do nothing.
629	 */
630	if (com->c_purging == false)
631		return;
632
633	/*
634	 * Otherwise check if the purge timeout has expired
635	 */
636	getmicrotime(&curr_tv);
637	timersub(&curr_tv, &com->c_purge_start, &diff_tv);
638
639	if (diff_tv.tv_sec >= U3G_PURGE_SECS) {
640		/* Timeout expired. */
641		com->c_purging = false;
642	} else {
643		/* Still purging. Adjust the caller's byte count. */
644		*ccp = 0;
645	}
646}
647
648/*ARGSUSED*/
649static void
650u3g_write(void *arg, int portno, u_char *to, u_char *from, uint32_t *count)
651{
652	struct u3g_softc *sc = arg;
653	struct u3g_com *com = &sc->sc_com[portno];
654
655	/*
656	 * Stop purging as soon as the first data is written to the device.
657	 */
658	com->c_purging = false;
659	memcpy(to, from, *count);
660}
661