xref: /freebsd/sys/dev/usb/serial/ufoma.c (revision dbaad75f2834f40bfe74ebe393d2101967052036)
1 /*	$NetBSD: umodem.c,v 1.45 2002/09/23 05:51:23 simonb Exp $	*/
2 
3 #include <sys/cdefs.h>
4 __FBSDID("$FreeBSD$");
5 #define UFOMA_HANDSFREE
6 /*-
7  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD AND BSD-2-Clause-NetBSD
8  *
9  * Copyright (c) 2005, Takanori Watanabe All rights reserved.
10  * Copyright (c) 2003 M. Warner Losh <imp@FreeBSD.org>
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
15  * 1. Redistributions of source code must retain the above copyright
16  *    notice, this list of conditions and the following disclaimer.
17  * 2. Redistributions in binary form must reproduce the above copyright
18  *    notice, this list of conditions and the following disclaimer in the
19  *    documentation and/or other materials provided with the distribution.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  */
33 
34 /*-
35  * Copyright (c) 1998 The NetBSD Foundation, Inc.
36  * All rights reserved.
37  *
38  * This code is derived from software contributed to The NetBSD Foundation
39  * by Lennart Augustsson (lennart@augustsson.net) at
40  * Carlstedt Research & Technology.
41  *
42  * Redistribution and use in source and binary forms, with or without
43  * modification, are permitted provided that the following conditions
44  * are met:
45  * 1. Redistributions of source code must retain the above copyright
46  *    notice, this list of conditions and the following disclaimer.
47  * 2. Redistributions in binary form must reproduce the above copyright
48  *    notice, this list of conditions and the following disclaimer in the
49  *    documentation and/or other materials provided with the distribution.
50  *
51  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
52  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
53  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
54  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
55  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
56  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
57  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
58  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
59  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
60  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
61  * POSSIBILITY OF SUCH DAMAGE.
62  */
63 
64 /*
65  * Comm Class spec:  http://www.usb.org/developers/devclass_docs/usbccs10.pdf
66  *                   http://www.usb.org/developers/devclass_docs/usbcdc11.pdf
67  */
68 
69 /*
70  * TODO:
71  * - Implement a Call Device for modems without multiplexed commands.
72  */
73 
74 /*
75  * NOTE: all function names beginning like "ufoma_cfg_" can only
76  * be called from within the config thread function !
77  */
78 
79 #include <sys/stdint.h>
80 #include <sys/stddef.h>
81 #include <sys/param.h>
82 #include <sys/queue.h>
83 #include <sys/types.h>
84 #include <sys/systm.h>
85 #include <sys/kernel.h>
86 #include <sys/bus.h>
87 #include <sys/module.h>
88 #include <sys/lock.h>
89 #include <sys/mutex.h>
90 #include <sys/condvar.h>
91 #include <sys/sysctl.h>
92 #include <sys/sx.h>
93 #include <sys/unistd.h>
94 #include <sys/callout.h>
95 #include <sys/malloc.h>
96 #include <sys/priv.h>
97 #include <sys/sbuf.h>
98 
99 #include <dev/usb/usb.h>
100 #include <dev/usb/usbdi.h>
101 #include <dev/usb/usbdi_util.h>
102 #include <dev/usb/usb_cdc.h>
103 #include "usbdevs.h"
104 
105 #define	USB_DEBUG_VAR usb_debug
106 #include <dev/usb/usb_debug.h>
107 #include <dev/usb/usb_process.h>
108 
109 #include <dev/usb/serial/usb_serial.h>
110 
111 typedef struct ufoma_mobile_acm_descriptor {
112 	uint8_t	bFunctionLength;
113 	uint8_t	bDescriptorType;
114 	uint8_t	bDescriptorSubtype;
115 	uint8_t	bType;
116 	uint8_t	bMode[1];
117 } __packed usb_mcpc_acm_descriptor;
118 
119 #define	UISUBCLASS_MCPC 0x88
120 
121 #define	UDESC_VS_INTERFACE 0x44
122 #define	UDESCSUB_MCPC_ACM  0x11
123 
124 #define	UMCPC_ACM_TYPE_AB1 0x1
125 #define	UMCPC_ACM_TYPE_AB2 0x2
126 #define	UMCPC_ACM_TYPE_AB5 0x5
127 #define	UMCPC_ACM_TYPE_AB6 0x6
128 
129 #define	UMCPC_ACM_MODE_DEACTIVATED 0x0
130 #define	UMCPC_ACM_MODE_MODEM 0x1
131 #define	UMCPC_ACM_MODE_ATCOMMAND 0x2
132 #define	UMCPC_ACM_MODE_OBEX 0x60
133 #define	UMCPC_ACM_MODE_VENDOR1 0xc0
134 #define	UMCPC_ACM_MODE_VENDOR2 0xfe
135 #define	UMCPC_ACM_MODE_UNLINKED 0xff
136 
137 #define	UMCPC_CM_MOBILE_ACM 0x0
138 
139 #define	UMCPC_ACTIVATE_MODE 0x60
140 #define	UMCPC_GET_MODETABLE 0x61
141 #define	UMCPC_SET_LINK 0x62
142 #define	UMCPC_CLEAR_LINK 0x63
143 
144 #define	UMCPC_REQUEST_ACKNOWLEDGE 0x31
145 
146 #define	UFOMA_MAX_TIMEOUT 15		/* standard says 10 seconds */
147 #define	UFOMA_CMD_BUF_SIZE 64		/* bytes */
148 
149 #define	UFOMA_BULK_BUF_SIZE 1024	/* bytes */
150 
151 enum {
152 	UFOMA_CTRL_ENDPT_INTR,
153 	UFOMA_CTRL_ENDPT_READ,
154 	UFOMA_CTRL_ENDPT_WRITE,
155 	UFOMA_CTRL_ENDPT_MAX,
156 };
157 
158 enum {
159 	UFOMA_BULK_ENDPT_WRITE,
160 	UFOMA_BULK_ENDPT_READ,
161 	UFOMA_BULK_ENDPT_MAX,
162 };
163 
164 struct ufoma_softc {
165 	struct ucom_super_softc sc_super_ucom;
166 	struct ucom_softc sc_ucom;
167 	struct cv sc_cv;
168 	struct mtx sc_mtx;
169 
170 	struct usb_xfer *sc_ctrl_xfer[UFOMA_CTRL_ENDPT_MAX];
171 	struct usb_xfer *sc_bulk_xfer[UFOMA_BULK_ENDPT_MAX];
172 	uint8_t *sc_modetable;
173 	device_t sc_dev;
174 	struct usb_device *sc_udev;
175 
176 	uint32_t sc_unit;
177 
178 	uint16_t sc_line;
179 
180 	uint8_t	sc_num_msg;
181 	uint8_t	sc_nobulk;
182 	uint8_t	sc_ctrl_iface_no;
183 	uint8_t	sc_ctrl_iface_index;
184 	uint8_t	sc_data_iface_no;
185 	uint8_t	sc_data_iface_index;
186 	uint8_t	sc_cm_cap;
187 	uint8_t	sc_acm_cap;
188 	uint8_t	sc_lsr;
189 	uint8_t	sc_msr;
190 	uint8_t	sc_modetoactivate;
191 	uint8_t	sc_currentmode;
192 };
193 
194 /* prototypes */
195 
196 static device_probe_t ufoma_probe;
197 static device_attach_t ufoma_attach;
198 static device_detach_t ufoma_detach;
199 static void ufoma_free_softc(struct ufoma_softc *);
200 
201 static usb_callback_t ufoma_ctrl_read_callback;
202 static usb_callback_t ufoma_ctrl_write_callback;
203 static usb_callback_t ufoma_intr_callback;
204 static usb_callback_t ufoma_bulk_write_callback;
205 static usb_callback_t ufoma_bulk_read_callback;
206 
207 static void	*ufoma_get_intconf(struct usb_config_descriptor *,
208 		    struct usb_interface_descriptor *, uint8_t, uint8_t);
209 static void	ufoma_cfg_link_state(struct ufoma_softc *);
210 static void	ufoma_cfg_activate_state(struct ufoma_softc *, uint16_t);
211 static void	ufoma_free(struct ucom_softc *);
212 static void	ufoma_cfg_open(struct ucom_softc *);
213 static void	ufoma_cfg_close(struct ucom_softc *);
214 static void	ufoma_cfg_set_break(struct ucom_softc *, uint8_t);
215 static void	ufoma_cfg_get_status(struct ucom_softc *, uint8_t *,
216 		    uint8_t *);
217 static void	ufoma_cfg_set_dtr(struct ucom_softc *, uint8_t);
218 static void	ufoma_cfg_set_rts(struct ucom_softc *, uint8_t);
219 static int	ufoma_pre_param(struct ucom_softc *, struct termios *);
220 static void	ufoma_cfg_param(struct ucom_softc *, struct termios *);
221 static int	ufoma_modem_setup(device_t, struct ufoma_softc *,
222 		    struct usb_attach_arg *);
223 static void	ufoma_start_read(struct ucom_softc *);
224 static void	ufoma_stop_read(struct ucom_softc *);
225 static void	ufoma_start_write(struct ucom_softc *);
226 static void	ufoma_stop_write(struct ucom_softc *);
227 static void	ufoma_poll(struct ucom_softc *ucom);
228 
229 /*sysctl stuff*/
230 static int ufoma_sysctl_support(SYSCTL_HANDLER_ARGS);
231 static int ufoma_sysctl_current(SYSCTL_HANDLER_ARGS);
232 static int ufoma_sysctl_open(SYSCTL_HANDLER_ARGS);
233 
234 static const struct usb_config
235 	ufoma_ctrl_config[UFOMA_CTRL_ENDPT_MAX] = {
236 	[UFOMA_CTRL_ENDPT_INTR] = {
237 		.type = UE_INTERRUPT,
238 		.endpoint = UE_ADDR_ANY,
239 		.direction = UE_DIR_IN,
240 		.flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
241 		.bufsize = sizeof(struct usb_cdc_notification),
242 		.callback = &ufoma_intr_callback,
243 	},
244 
245 	[UFOMA_CTRL_ENDPT_READ] = {
246 		.type = UE_CONTROL,
247 		.endpoint = 0x00,	/* Control pipe */
248 		.direction = UE_DIR_ANY,
249 		.bufsize = (sizeof(struct usb_device_request) + UFOMA_CMD_BUF_SIZE),
250 		.flags = {.short_xfer_ok = 1,},
251 		.callback = &ufoma_ctrl_read_callback,
252 		.timeout = 1000,	/* 1 second */
253 	},
254 
255 	[UFOMA_CTRL_ENDPT_WRITE] = {
256 		.type = UE_CONTROL,
257 		.endpoint = 0x00,	/* Control pipe */
258 		.direction = UE_DIR_ANY,
259 		.bufsize = (sizeof(struct usb_device_request) + 1),
260 		.callback = &ufoma_ctrl_write_callback,
261 		.timeout = 1000,	/* 1 second */
262 	},
263 };
264 
265 static const struct usb_config
266 	ufoma_bulk_config[UFOMA_BULK_ENDPT_MAX] = {
267 	[UFOMA_BULK_ENDPT_WRITE] = {
268 		.type = UE_BULK,
269 		.endpoint = UE_ADDR_ANY,
270 		.direction = UE_DIR_OUT,
271 		.bufsize = UFOMA_BULK_BUF_SIZE,
272 		.flags = {.pipe_bof = 1,.force_short_xfer = 1,},
273 		.callback = &ufoma_bulk_write_callback,
274 	},
275 
276 	[UFOMA_BULK_ENDPT_READ] = {
277 		.type = UE_BULK,
278 		.endpoint = UE_ADDR_ANY,
279 		.direction = UE_DIR_IN,
280 		.bufsize = UFOMA_BULK_BUF_SIZE,
281 		.flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
282 		.callback = &ufoma_bulk_read_callback,
283 	},
284 };
285 
286 static const struct ucom_callback ufoma_callback = {
287 	.ucom_cfg_get_status = &ufoma_cfg_get_status,
288 	.ucom_cfg_set_dtr = &ufoma_cfg_set_dtr,
289 	.ucom_cfg_set_rts = &ufoma_cfg_set_rts,
290 	.ucom_cfg_set_break = &ufoma_cfg_set_break,
291 	.ucom_cfg_param = &ufoma_cfg_param,
292 	.ucom_cfg_open = &ufoma_cfg_open,
293 	.ucom_cfg_close = &ufoma_cfg_close,
294 	.ucom_pre_param = &ufoma_pre_param,
295 	.ucom_start_read = &ufoma_start_read,
296 	.ucom_stop_read = &ufoma_stop_read,
297 	.ucom_start_write = &ufoma_start_write,
298 	.ucom_stop_write = &ufoma_stop_write,
299 	.ucom_poll = &ufoma_poll,
300 	.ucom_free = &ufoma_free,
301 };
302 
303 static device_method_t ufoma_methods[] = {
304 	/* Device methods */
305 	DEVMETHOD(device_probe, ufoma_probe),
306 	DEVMETHOD(device_attach, ufoma_attach),
307 	DEVMETHOD(device_detach, ufoma_detach),
308 	DEVMETHOD_END
309 };
310 
311 static devclass_t ufoma_devclass;
312 
313 static driver_t ufoma_driver = {
314 	.name = "ufoma",
315 	.methods = ufoma_methods,
316 	.size = sizeof(struct ufoma_softc),
317 };
318 
319 static const STRUCT_USB_HOST_ID ufoma_devs[] = {
320 	{USB_IFACE_CLASS(UICLASS_CDC),
321 	 USB_IFACE_SUBCLASS(UISUBCLASS_MCPC),},
322 };
323 
324 DRIVER_MODULE(ufoma, uhub, ufoma_driver, ufoma_devclass, NULL, 0);
325 MODULE_DEPEND(ufoma, ucom, 1, 1, 1);
326 MODULE_DEPEND(ufoma, usb, 1, 1, 1);
327 MODULE_VERSION(ufoma, 1);
328 USB_PNP_HOST_INFO(ufoma_devs);
329 
330 static int
331 ufoma_probe(device_t dev)
332 {
333 	struct usb_attach_arg *uaa = device_get_ivars(dev);
334 	struct usb_interface_descriptor *id;
335 	struct usb_config_descriptor *cd;
336 	usb_mcpc_acm_descriptor *mad;
337 	int error;
338 
339 	if (uaa->usb_mode != USB_MODE_HOST)
340 		return (ENXIO);
341 
342 	error = usbd_lookup_id_by_uaa(ufoma_devs, sizeof(ufoma_devs), uaa);
343 	if (error)
344 		return (error);
345 
346 	id = usbd_get_interface_descriptor(uaa->iface);
347 	cd = usbd_get_config_descriptor(uaa->device);
348 
349 	if (id == NULL || cd == NULL)
350 		return (ENXIO);
351 
352 	mad = ufoma_get_intconf(cd, id, UDESC_VS_INTERFACE, UDESCSUB_MCPC_ACM);
353 	if (mad == NULL)
354 		return (ENXIO);
355 
356 #ifndef UFOMA_HANDSFREE
357 	if ((mad->bType == UMCPC_ACM_TYPE_AB5) ||
358 	    (mad->bType == UMCPC_ACM_TYPE_AB6))
359 		return (ENXIO);
360 #endif
361 	return (BUS_PROBE_GENERIC);
362 }
363 
364 static int
365 ufoma_attach(device_t dev)
366 {
367 	struct usb_attach_arg *uaa = device_get_ivars(dev);
368 	struct ufoma_softc *sc = device_get_softc(dev);
369 	struct usb_config_descriptor *cd;
370 	struct usb_interface_descriptor *id;
371 	struct sysctl_ctx_list *sctx;
372 	struct sysctl_oid *soid;
373 
374 	usb_mcpc_acm_descriptor *mad;
375 	uint8_t elements;
376 	int32_t error;
377 
378 	sc->sc_udev = uaa->device;
379 	sc->sc_dev = dev;
380 	sc->sc_unit = device_get_unit(dev);
381 
382 	mtx_init(&sc->sc_mtx, "ufoma", NULL, MTX_DEF);
383 	ucom_ref(&sc->sc_super_ucom);
384 	cv_init(&sc->sc_cv, "CWAIT");
385 
386 	device_set_usb_desc(dev);
387 
388 	DPRINTF("\n");
389 
390 	/* setup control transfers */
391 
392 	cd = usbd_get_config_descriptor(uaa->device);
393 	id = usbd_get_interface_descriptor(uaa->iface);
394 	sc->sc_ctrl_iface_no = id->bInterfaceNumber;
395 	sc->sc_ctrl_iface_index = uaa->info.bIfaceIndex;
396 
397 	error = usbd_transfer_setup(uaa->device,
398 	    &sc->sc_ctrl_iface_index, sc->sc_ctrl_xfer,
399 	    ufoma_ctrl_config, UFOMA_CTRL_ENDPT_MAX, sc, &sc->sc_mtx);
400 
401 	if (error) {
402 		device_printf(dev, "allocating control USB "
403 		    "transfers failed\n");
404 		goto detach;
405 	}
406 	mad = ufoma_get_intconf(cd, id, UDESC_VS_INTERFACE, UDESCSUB_MCPC_ACM);
407 	if (mad == NULL) {
408 		goto detach;
409 	}
410 	if (mad->bFunctionLength < sizeof(*mad)) {
411 		device_printf(dev, "invalid MAD descriptor\n");
412 		goto detach;
413 	}
414 	if ((mad->bType == UMCPC_ACM_TYPE_AB5) ||
415 	    (mad->bType == UMCPC_ACM_TYPE_AB6)) {
416 		sc->sc_nobulk = 1;
417 	} else {
418 		sc->sc_nobulk = 0;
419 		if (ufoma_modem_setup(dev, sc, uaa)) {
420 			goto detach;
421 		}
422 	}
423 
424 	elements = (mad->bFunctionLength - sizeof(*mad) + 1);
425 
426 	/* initialize mode variables */
427 
428 	sc->sc_modetable = malloc(elements + 1, M_USBDEV, M_WAITOK);
429 
430 	if (sc->sc_modetable == NULL) {
431 		goto detach;
432 	}
433 	sc->sc_modetable[0] = (elements + 1);
434 	memcpy(&sc->sc_modetable[1], mad->bMode, elements);
435 
436 	sc->sc_currentmode = UMCPC_ACM_MODE_UNLINKED;
437 	sc->sc_modetoactivate = mad->bMode[0];
438 
439 	/* clear stall at first run, if any */
440 	mtx_lock(&sc->sc_mtx);
441 	usbd_xfer_set_zlp(sc->sc_bulk_xfer[UFOMA_BULK_ENDPT_WRITE]);
442 	mtx_unlock(&sc->sc_mtx);
443 
444 	error = ucom_attach(&sc->sc_super_ucom, &sc->sc_ucom, 1, sc,
445 	    &ufoma_callback, &sc->sc_mtx);
446 	if (error) {
447 		DPRINTF("ucom_attach failed\n");
448 		goto detach;
449 	}
450 	ucom_set_pnpinfo_usb(&sc->sc_super_ucom, dev);
451 
452 	/*Sysctls*/
453 	sctx = device_get_sysctl_ctx(dev);
454 	soid = device_get_sysctl_tree(dev);
455 
456 	SYSCTL_ADD_PROC(sctx, SYSCTL_CHILDREN(soid), OID_AUTO, "supportmode",
457 	    CTLFLAG_RD | CTLTYPE_STRING | CTLFLAG_MPSAFE, sc, 0,
458 	    ufoma_sysctl_support, "A", "Supporting port role");
459 
460 	SYSCTL_ADD_PROC(sctx, SYSCTL_CHILDREN(soid), OID_AUTO, "currentmode",
461 	CTLFLAG_RD | CTLTYPE_STRING | CTLFLAG_MPSAFE, sc, 0,
462 	ufoma_sysctl_current, "A", "Current port role");
463 
464 	SYSCTL_ADD_PROC(sctx, SYSCTL_CHILDREN(soid), OID_AUTO, "openmode",
465 	CTLFLAG_RW | CTLTYPE_STRING | CTLFLAG_MPSAFE, sc, 0,
466 	ufoma_sysctl_open, "A", "Mode to transit when port is opened");
467 	SYSCTL_ADD_UINT(sctx, SYSCTL_CHILDREN(soid), OID_AUTO, "comunit",
468 			CTLFLAG_RD, &(sc->sc_super_ucom.sc_unit), 0,
469 			"Unit number as USB serial");
470 
471 	return (0);			/* success */
472 
473 detach:
474 	ufoma_detach(dev);
475 	return (ENXIO);			/* failure */
476 }
477 
478 static int
479 ufoma_detach(device_t dev)
480 {
481 	struct ufoma_softc *sc = device_get_softc(dev);
482 
483 	ucom_detach(&sc->sc_super_ucom, &sc->sc_ucom);
484 	usbd_transfer_unsetup(sc->sc_ctrl_xfer, UFOMA_CTRL_ENDPT_MAX);
485 	usbd_transfer_unsetup(sc->sc_bulk_xfer, UFOMA_BULK_ENDPT_MAX);
486 
487 	if (sc->sc_modetable) {
488 		free(sc->sc_modetable, M_USBDEV);
489 	}
490 	cv_destroy(&sc->sc_cv);
491 
492 	device_claim_softc(dev);
493 
494 	ufoma_free_softc(sc);
495 
496 	return (0);
497 }
498 
499 UCOM_UNLOAD_DRAIN(ufoma);
500 
501 static void
502 ufoma_free_softc(struct ufoma_softc *sc)
503 {
504 	if (ucom_unref(&sc->sc_super_ucom)) {
505 		mtx_destroy(&sc->sc_mtx);
506 		device_free_softc(sc);
507 	}
508 }
509 
510 static void
511 ufoma_free(struct ucom_softc *ucom)
512 {
513 	ufoma_free_softc(ucom->sc_parent);
514 }
515 
516 static void *
517 ufoma_get_intconf(struct usb_config_descriptor *cd, struct usb_interface_descriptor *id,
518     uint8_t type, uint8_t subtype)
519 {
520 	struct usb_descriptor *desc = (void *)id;
521 
522 	while ((desc = usb_desc_foreach(cd, desc))) {
523 		if (desc->bDescriptorType == UDESC_INTERFACE) {
524 			return (NULL);
525 		}
526 		if ((desc->bDescriptorType == type) &&
527 		    (desc->bDescriptorSubtype == subtype)) {
528 			break;
529 		}
530 	}
531 	return (desc);
532 }
533 
534 static void
535 ufoma_cfg_link_state(struct ufoma_softc *sc)
536 {
537 	struct usb_device_request req;
538 	int32_t error;
539 
540 	req.bmRequestType = UT_WRITE_VENDOR_INTERFACE;
541 	req.bRequest = UMCPC_SET_LINK;
542 	USETW(req.wValue, UMCPC_CM_MOBILE_ACM);
543 	USETW(req.wIndex, sc->sc_ctrl_iface_no);
544 	USETW(req.wLength, sc->sc_modetable[0]);
545 
546 	ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
547 	    &req, sc->sc_modetable, 0, 1000);
548 
549 	error = cv_timedwait(&sc->sc_cv, &sc->sc_mtx, hz);
550 
551 	if (error) {
552 		DPRINTF("NO response\n");
553 	}
554 }
555 
556 static void
557 ufoma_cfg_activate_state(struct ufoma_softc *sc, uint16_t state)
558 {
559 	struct usb_device_request req;
560 	int32_t error;
561 
562 	req.bmRequestType = UT_WRITE_VENDOR_INTERFACE;
563 	req.bRequest = UMCPC_ACTIVATE_MODE;
564 	USETW(req.wValue, state);
565 	USETW(req.wIndex, sc->sc_ctrl_iface_no);
566 	USETW(req.wLength, 0);
567 
568 	ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
569 	    &req, NULL, 0, 1000);
570 
571 	error = cv_timedwait(&sc->sc_cv, &sc->sc_mtx,
572 	    (UFOMA_MAX_TIMEOUT * hz));
573 	if (error) {
574 		DPRINTF("No response\n");
575 	}
576 }
577 
578 static void
579 ufoma_ctrl_read_callback(struct usb_xfer *xfer, usb_error_t error)
580 {
581 	struct ufoma_softc *sc = usbd_xfer_softc(xfer);
582 	struct usb_device_request req;
583 	struct usb_page_cache *pc0, *pc1;
584 	int len, aframes, nframes;
585 
586 	usbd_xfer_status(xfer, NULL, NULL, &aframes, &nframes);
587 
588 	switch (USB_GET_STATE(xfer)) {
589 	case USB_ST_TRANSFERRED:
590 tr_transferred:
591 		if (aframes != nframes)
592 			goto tr_setup;
593 		pc1 = usbd_xfer_get_frame(xfer, 1);
594 		len = usbd_xfer_frame_len(xfer, 1);
595 		if (len > 0)
596 			ucom_put_data(&sc->sc_ucom, pc1, 0, len);
597 		/* FALLTHROUGH */
598 	case USB_ST_SETUP:
599 tr_setup:
600 		if (sc->sc_num_msg) {
601 			sc->sc_num_msg--;
602 
603 			req.bmRequestType = UT_READ_CLASS_INTERFACE;
604 			req.bRequest = UCDC_GET_ENCAPSULATED_RESPONSE;
605 			USETW(req.wIndex, sc->sc_ctrl_iface_no);
606 			USETW(req.wValue, 0);
607 			USETW(req.wLength, UFOMA_CMD_BUF_SIZE);
608 
609 			pc0 = usbd_xfer_get_frame(xfer, 0);
610 			usbd_copy_in(pc0, 0, &req, sizeof(req));
611 
612 			usbd_xfer_set_frame_len(xfer, 0, sizeof(req));
613 			usbd_xfer_set_frame_len(xfer, 1, UFOMA_CMD_BUF_SIZE);
614 			usbd_xfer_set_frames(xfer, 2);
615 			usbd_transfer_submit(xfer);
616 		}
617 		return;
618 
619 	default:			/* Error */
620 		DPRINTF("error = %s\n",
621 		    usbd_errstr(error));
622 
623 		if (error == USB_ERR_CANCELLED) {
624 			return;
625 		}
626 		goto tr_transferred;
627 	}
628 }
629 
630 static void
631 ufoma_ctrl_write_callback(struct usb_xfer *xfer, usb_error_t error)
632 {
633 	struct ufoma_softc *sc = usbd_xfer_softc(xfer);
634 	struct usb_device_request req;
635 	struct usb_page_cache *pc;
636 	uint32_t actlen;
637 
638 	switch (USB_GET_STATE(xfer)) {
639 	case USB_ST_TRANSFERRED:
640 tr_transferred:
641 	case USB_ST_SETUP:
642 		pc = usbd_xfer_get_frame(xfer, 1);
643 		if (ucom_get_data(&sc->sc_ucom, pc, 0, 1, &actlen)) {
644 			req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
645 			req.bRequest = UCDC_SEND_ENCAPSULATED_COMMAND;
646 			USETW(req.wIndex, sc->sc_ctrl_iface_no);
647 			USETW(req.wValue, 0);
648 			USETW(req.wLength, 1);
649 
650 			pc = usbd_xfer_get_frame(xfer, 0);
651 			usbd_copy_in(pc, 0, &req, sizeof(req));
652 
653 			usbd_xfer_set_frame_len(xfer, 0, sizeof(req));
654 			usbd_xfer_set_frame_len(xfer, 1, 1);
655 			usbd_xfer_set_frames(xfer, 2);
656 
657 			usbd_transfer_submit(xfer);
658 		}
659 		return;
660 
661 	default:			/* Error */
662 		DPRINTF("error = %s\n", usbd_errstr(error));
663 
664 		if (error == USB_ERR_CANCELLED) {
665 			return;
666 		}
667 		goto tr_transferred;
668 	}
669 }
670 
671 static void
672 ufoma_intr_callback(struct usb_xfer *xfer, usb_error_t error)
673 {
674 	struct ufoma_softc *sc = usbd_xfer_softc(xfer);
675 	struct usb_cdc_notification pkt;
676 	struct usb_page_cache *pc;
677 	uint16_t wLen;
678 	uint16_t temp;
679 	uint8_t mstatus;
680 	int actlen;
681 
682 	usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
683 
684 	switch (USB_GET_STATE(xfer)) {
685 	case USB_ST_TRANSFERRED:
686 		if (actlen < 8) {
687 			DPRINTF("too short message\n");
688 			goto tr_setup;
689 		}
690 		if (actlen > (int)sizeof(pkt)) {
691 			DPRINTF("truncating message\n");
692 			actlen = sizeof(pkt);
693 		}
694 		pc = usbd_xfer_get_frame(xfer, 0);
695 		usbd_copy_out(pc, 0, &pkt, actlen);
696 
697 		actlen -= 8;
698 
699 		wLen = UGETW(pkt.wLength);
700 		if (actlen > wLen) {
701 			actlen = wLen;
702 		}
703 		if ((pkt.bmRequestType == UT_READ_VENDOR_INTERFACE) &&
704 		    (pkt.bNotification == UMCPC_REQUEST_ACKNOWLEDGE)) {
705 			temp = UGETW(pkt.wValue);
706 			sc->sc_currentmode = (temp >> 8);
707 			if (!(temp & 0xff)) {
708 				DPRINTF("Mode change failed!\n");
709 			}
710 			cv_signal(&sc->sc_cv);
711 		}
712 		if (pkt.bmRequestType != UCDC_NOTIFICATION) {
713 			goto tr_setup;
714 		}
715 		switch (pkt.bNotification) {
716 		case UCDC_N_RESPONSE_AVAILABLE:
717 			if (!(sc->sc_nobulk)) {
718 				DPRINTF("Wrong serial state!\n");
719 				break;
720 			}
721 			if (sc->sc_num_msg != 0xFF) {
722 				sc->sc_num_msg++;
723 			}
724 			usbd_transfer_start(sc->sc_ctrl_xfer[UFOMA_CTRL_ENDPT_READ]);
725 			break;
726 
727 		case UCDC_N_SERIAL_STATE:
728 			if (sc->sc_nobulk) {
729 				DPRINTF("Wrong serial state!\n");
730 				break;
731 			}
732 			/*
733 		         * Set the serial state in ucom driver based on
734 		         * the bits from the notify message
735 		         */
736 			if (actlen < 2) {
737 				DPRINTF("invalid notification "
738 				    "length, %d bytes!\n", actlen);
739 				break;
740 			}
741 			DPRINTF("notify bytes = 0x%02x, 0x%02x\n",
742 			    pkt.data[0], pkt.data[1]);
743 
744 			/* currently, lsr is always zero. */
745 			sc->sc_lsr = 0;
746 			sc->sc_msr = 0;
747 
748 			mstatus = pkt.data[0];
749 
750 			if (mstatus & UCDC_N_SERIAL_RI) {
751 				sc->sc_msr |= SER_RI;
752 			}
753 			if (mstatus & UCDC_N_SERIAL_DSR) {
754 				sc->sc_msr |= SER_DSR;
755 			}
756 			if (mstatus & UCDC_N_SERIAL_DCD) {
757 				sc->sc_msr |= SER_DCD;
758 			}
759 			ucom_status_change(&sc->sc_ucom);
760 			break;
761 
762 		default:
763 			break;
764 		}
765 
766 	case USB_ST_SETUP:
767 tr_setup:
768 		usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
769 		usbd_transfer_submit(xfer);
770 		return;
771 
772 	default:			/* Error */
773 		if (error != USB_ERR_CANCELLED) {
774 			/* try to clear stall first */
775 			usbd_xfer_set_stall(xfer);
776 			goto tr_setup;
777 		}
778 		return;
779 	}
780 }
781 
782 static void
783 ufoma_bulk_write_callback(struct usb_xfer *xfer, usb_error_t error)
784 {
785 	struct ufoma_softc *sc = usbd_xfer_softc(xfer);
786 	struct usb_page_cache *pc;
787 	uint32_t actlen;
788 
789 	switch (USB_GET_STATE(xfer)) {
790 	case USB_ST_SETUP:
791 	case USB_ST_TRANSFERRED:
792 tr_setup:
793 		if (usbd_xfer_get_and_clr_zlp(xfer))
794 			break;
795 
796 		pc = usbd_xfer_get_frame(xfer, 0);
797 		if (ucom_get_data(&sc->sc_ucom, pc, 0,
798 		    UFOMA_BULK_BUF_SIZE, &actlen)) {
799 			usbd_xfer_set_frame_len(xfer, 0, actlen);
800 			usbd_transfer_submit(xfer);
801 		}
802 		break;
803 
804 	default:			/* Error */
805 		if (error != USB_ERR_CANCELLED) {
806 			/* try to clear stall first */
807 			usbd_xfer_set_stall(xfer);
808 			goto tr_setup;
809 		}
810 		break;
811 	}
812 }
813 
814 static void
815 ufoma_bulk_read_callback(struct usb_xfer *xfer, usb_error_t error)
816 {
817 	struct ufoma_softc *sc = usbd_xfer_softc(xfer);
818 	struct usb_page_cache *pc;
819 	int actlen;
820 
821 	usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
822 
823 	switch (USB_GET_STATE(xfer)) {
824 	case USB_ST_TRANSFERRED:
825 		pc = usbd_xfer_get_frame(xfer, 0);
826 		ucom_put_data(&sc->sc_ucom, pc, 0, actlen);
827 
828 	case USB_ST_SETUP:
829 tr_setup:
830 		usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
831 		usbd_transfer_submit(xfer);
832 		return;
833 
834 	default:			/* Error */
835 		if (error != USB_ERR_CANCELLED) {
836 			/* try to clear stall first */
837 			usbd_xfer_set_stall(xfer);
838 			goto tr_setup;
839 		}
840 		return;
841 	}
842 }
843 
844 static void
845 ufoma_cfg_open(struct ucom_softc *ucom)
846 {
847 	struct ufoma_softc *sc = ucom->sc_parent;
848 
849 	/* empty input queue */
850 
851 	if (sc->sc_num_msg != 0xFF) {
852 		sc->sc_num_msg++;
853 	}
854 	if (sc->sc_currentmode == UMCPC_ACM_MODE_UNLINKED) {
855 		ufoma_cfg_link_state(sc);
856 	}
857 	if (sc->sc_currentmode == UMCPC_ACM_MODE_DEACTIVATED) {
858 		ufoma_cfg_activate_state(sc, sc->sc_modetoactivate);
859 	}
860 }
861 
862 static void
863 ufoma_cfg_close(struct ucom_softc *ucom)
864 {
865 	struct ufoma_softc *sc = ucom->sc_parent;
866 
867 	ufoma_cfg_activate_state(sc, UMCPC_ACM_MODE_DEACTIVATED);
868 }
869 
870 static void
871 ufoma_cfg_set_break(struct ucom_softc *ucom, uint8_t onoff)
872 {
873 	struct ufoma_softc *sc = ucom->sc_parent;
874 	struct usb_device_request req;
875 	uint16_t wValue;
876 
877 	if (sc->sc_nobulk ||
878 	    (sc->sc_currentmode == UMCPC_ACM_MODE_OBEX)) {
879 		return;
880 	}
881 	if (!(sc->sc_acm_cap & USB_CDC_ACM_HAS_BREAK)) {
882 		return;
883 	}
884 	wValue = onoff ? UCDC_BREAK_ON : UCDC_BREAK_OFF;
885 
886 	req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
887 	req.bRequest = UCDC_SEND_BREAK;
888 	USETW(req.wValue, wValue);
889 	req.wIndex[0] = sc->sc_ctrl_iface_no;
890 	req.wIndex[1] = 0;
891 	USETW(req.wLength, 0);
892 
893 	ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
894 	    &req, NULL, 0, 1000);
895 }
896 
897 static void
898 ufoma_cfg_get_status(struct ucom_softc *ucom, uint8_t *lsr, uint8_t *msr)
899 {
900 	struct ufoma_softc *sc = ucom->sc_parent;
901 
902 	/* XXX Note: sc_lsr is always zero */
903 	*lsr = sc->sc_lsr;
904 	*msr = sc->sc_msr;
905 }
906 
907 static void
908 ufoma_cfg_set_line_state(struct ufoma_softc *sc)
909 {
910 	struct usb_device_request req;
911 
912 	/* Don't send line state emulation request for OBEX port */
913 	if (sc->sc_currentmode == UMCPC_ACM_MODE_OBEX) {
914 		return;
915 	}
916 	req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
917 	req.bRequest = UCDC_SET_CONTROL_LINE_STATE;
918 	USETW(req.wValue, sc->sc_line);
919 	req.wIndex[0] = sc->sc_ctrl_iface_no;
920 	req.wIndex[1] = 0;
921 	USETW(req.wLength, 0);
922 
923 	ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
924 	    &req, NULL, 0, 1000);
925 }
926 
927 static void
928 ufoma_cfg_set_dtr(struct ucom_softc *ucom, uint8_t onoff)
929 {
930 	struct ufoma_softc *sc = ucom->sc_parent;
931 
932 	if (sc->sc_nobulk) {
933 		return;
934 	}
935 	if (onoff)
936 		sc->sc_line |= UCDC_LINE_DTR;
937 	else
938 		sc->sc_line &= ~UCDC_LINE_DTR;
939 
940 	ufoma_cfg_set_line_state(sc);
941 }
942 
943 static void
944 ufoma_cfg_set_rts(struct ucom_softc *ucom, uint8_t onoff)
945 {
946 	struct ufoma_softc *sc = ucom->sc_parent;
947 
948 	if (sc->sc_nobulk) {
949 		return;
950 	}
951 	if (onoff)
952 		sc->sc_line |= UCDC_LINE_RTS;
953 	else
954 		sc->sc_line &= ~UCDC_LINE_RTS;
955 
956 	ufoma_cfg_set_line_state(sc);
957 }
958 
959 static int
960 ufoma_pre_param(struct ucom_softc *ucom, struct termios *t)
961 {
962 	return (0);			/* we accept anything */
963 }
964 
965 static void
966 ufoma_cfg_param(struct ucom_softc *ucom, struct termios *t)
967 {
968 	struct ufoma_softc *sc = ucom->sc_parent;
969 	struct usb_device_request req;
970 	struct usb_cdc_line_state ls;
971 
972 	if (sc->sc_nobulk ||
973 	    (sc->sc_currentmode == UMCPC_ACM_MODE_OBEX)) {
974 		return;
975 	}
976 	DPRINTF("\n");
977 
978 	memset(&ls, 0, sizeof(ls));
979 
980 	USETDW(ls.dwDTERate, t->c_ospeed);
981 
982 	if (t->c_cflag & CSTOPB) {
983 		ls.bCharFormat = UCDC_STOP_BIT_2;
984 	} else {
985 		ls.bCharFormat = UCDC_STOP_BIT_1;
986 	}
987 
988 	if (t->c_cflag & PARENB) {
989 		if (t->c_cflag & PARODD) {
990 			ls.bParityType = UCDC_PARITY_ODD;
991 		} else {
992 			ls.bParityType = UCDC_PARITY_EVEN;
993 		}
994 	} else {
995 		ls.bParityType = UCDC_PARITY_NONE;
996 	}
997 
998 	switch (t->c_cflag & CSIZE) {
999 	case CS5:
1000 		ls.bDataBits = 5;
1001 		break;
1002 	case CS6:
1003 		ls.bDataBits = 6;
1004 		break;
1005 	case CS7:
1006 		ls.bDataBits = 7;
1007 		break;
1008 	case CS8:
1009 		ls.bDataBits = 8;
1010 		break;
1011 	}
1012 
1013 	req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
1014 	req.bRequest = UCDC_SET_LINE_CODING;
1015 	USETW(req.wValue, 0);
1016 	req.wIndex[0] = sc->sc_ctrl_iface_no;
1017 	req.wIndex[1] = 0;
1018 	USETW(req.wLength, UCDC_LINE_STATE_LENGTH);
1019 
1020 	ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
1021 	    &req, &ls, 0, 1000);
1022 }
1023 
1024 static int
1025 ufoma_modem_setup(device_t dev, struct ufoma_softc *sc,
1026     struct usb_attach_arg *uaa)
1027 {
1028 	struct usb_config_descriptor *cd;
1029 	struct usb_cdc_acm_descriptor *acm;
1030 	struct usb_cdc_cm_descriptor *cmd;
1031 	struct usb_interface_descriptor *id;
1032 	struct usb_interface *iface;
1033 	uint8_t i;
1034 	int32_t error;
1035 
1036 	cd = usbd_get_config_descriptor(uaa->device);
1037 	id = usbd_get_interface_descriptor(uaa->iface);
1038 
1039 	cmd = ufoma_get_intconf(cd, id, UDESC_CS_INTERFACE, UDESCSUB_CDC_CM);
1040 
1041 	if ((cmd == NULL) ||
1042 	    (cmd->bLength < sizeof(*cmd))) {
1043 		return (EINVAL);
1044 	}
1045 	sc->sc_cm_cap = cmd->bmCapabilities;
1046 	sc->sc_data_iface_no = cmd->bDataInterface;
1047 
1048 	acm = ufoma_get_intconf(cd, id, UDESC_CS_INTERFACE, UDESCSUB_CDC_ACM);
1049 
1050 	if ((acm == NULL) ||
1051 	    (acm->bLength < sizeof(*acm))) {
1052 		return (EINVAL);
1053 	}
1054 	sc->sc_acm_cap = acm->bmCapabilities;
1055 
1056 	device_printf(dev, "data interface %d, has %sCM over data, "
1057 	    "has %sbreak\n",
1058 	    sc->sc_data_iface_no,
1059 	    sc->sc_cm_cap & USB_CDC_CM_OVER_DATA ? "" : "no ",
1060 	    sc->sc_acm_cap & USB_CDC_ACM_HAS_BREAK ? "" : "no ");
1061 
1062 	/* get the data interface too */
1063 
1064 	for (i = 0;; i++) {
1065 		iface = usbd_get_iface(uaa->device, i);
1066 
1067 		if (iface) {
1068 			id = usbd_get_interface_descriptor(iface);
1069 
1070 			if (id && (id->bInterfaceNumber == sc->sc_data_iface_no)) {
1071 				sc->sc_data_iface_index = i;
1072 				usbd_set_parent_iface(uaa->device, i, uaa->info.bIfaceIndex);
1073 				break;
1074 			}
1075 		} else {
1076 			device_printf(dev, "no data interface\n");
1077 			return (EINVAL);
1078 		}
1079 	}
1080 
1081 	error = usbd_transfer_setup(uaa->device,
1082 	    &sc->sc_data_iface_index, sc->sc_bulk_xfer,
1083 	    ufoma_bulk_config, UFOMA_BULK_ENDPT_MAX, sc, &sc->sc_mtx);
1084 
1085 	if (error) {
1086 		device_printf(dev, "allocating BULK USB "
1087 		    "transfers failed\n");
1088 		return (EINVAL);
1089 	}
1090 	return (0);
1091 }
1092 
1093 static void
1094 ufoma_start_read(struct ucom_softc *ucom)
1095 {
1096 	struct ufoma_softc *sc = ucom->sc_parent;
1097 
1098 	/* start interrupt transfer */
1099 	usbd_transfer_start(sc->sc_ctrl_xfer[UFOMA_CTRL_ENDPT_INTR]);
1100 
1101 	/* start data transfer */
1102 	if (sc->sc_nobulk) {
1103 		usbd_transfer_start(sc->sc_ctrl_xfer[UFOMA_CTRL_ENDPT_READ]);
1104 	} else {
1105 		usbd_transfer_start(sc->sc_bulk_xfer[UFOMA_BULK_ENDPT_READ]);
1106 	}
1107 }
1108 
1109 static void
1110 ufoma_stop_read(struct ucom_softc *ucom)
1111 {
1112 	struct ufoma_softc *sc = ucom->sc_parent;
1113 
1114 	/* stop interrupt transfer */
1115 	usbd_transfer_stop(sc->sc_ctrl_xfer[UFOMA_CTRL_ENDPT_INTR]);
1116 
1117 	/* stop data transfer */
1118 	if (sc->sc_nobulk) {
1119 		usbd_transfer_stop(sc->sc_ctrl_xfer[UFOMA_CTRL_ENDPT_READ]);
1120 	} else {
1121 		usbd_transfer_stop(sc->sc_bulk_xfer[UFOMA_BULK_ENDPT_READ]);
1122 	}
1123 }
1124 
1125 static void
1126 ufoma_start_write(struct ucom_softc *ucom)
1127 {
1128 	struct ufoma_softc *sc = ucom->sc_parent;
1129 
1130 	if (sc->sc_nobulk) {
1131 		usbd_transfer_start(sc->sc_ctrl_xfer[UFOMA_CTRL_ENDPT_WRITE]);
1132 	} else {
1133 		usbd_transfer_start(sc->sc_bulk_xfer[UFOMA_BULK_ENDPT_WRITE]);
1134 	}
1135 }
1136 
1137 static void
1138 ufoma_stop_write(struct ucom_softc *ucom)
1139 {
1140 	struct ufoma_softc *sc = ucom->sc_parent;
1141 
1142 	if (sc->sc_nobulk) {
1143 		usbd_transfer_stop(sc->sc_ctrl_xfer[UFOMA_CTRL_ENDPT_WRITE]);
1144 	} else {
1145 		usbd_transfer_stop(sc->sc_bulk_xfer[UFOMA_BULK_ENDPT_WRITE]);
1146 	}
1147 }
1148 
1149 static struct umcpc_modetostr_tab{
1150 	int mode;
1151 	char *str;
1152 }umcpc_modetostr_tab[]={
1153 	{UMCPC_ACM_MODE_DEACTIVATED, "deactivated"},
1154 	{UMCPC_ACM_MODE_MODEM, "modem"},
1155 	{UMCPC_ACM_MODE_ATCOMMAND, "handsfree"},
1156 	{UMCPC_ACM_MODE_OBEX, "obex"},
1157 	{UMCPC_ACM_MODE_VENDOR1, "vendor1"},
1158 	{UMCPC_ACM_MODE_VENDOR2, "vendor2"},
1159 	{UMCPC_ACM_MODE_UNLINKED, "unlinked"},
1160 	{0, NULL}
1161 };
1162 
1163 static char *ufoma_mode_to_str(int mode)
1164 {
1165 	int i;
1166 	for(i = 0 ;umcpc_modetostr_tab[i].str != NULL; i++){
1167 		if(umcpc_modetostr_tab[i].mode == mode){
1168 			return umcpc_modetostr_tab[i].str;
1169 		}
1170 	}
1171 	return NULL;
1172 }
1173 
1174 static int ufoma_str_to_mode(char *str)
1175 {
1176 	int i;
1177 	for(i = 0 ;umcpc_modetostr_tab[i].str != NULL; i++){
1178 		if(strcmp(str, umcpc_modetostr_tab[i].str)==0){
1179 			return umcpc_modetostr_tab[i].mode;
1180 		}
1181 	}
1182 	return -1;
1183 }
1184 
1185 static int ufoma_sysctl_support(SYSCTL_HANDLER_ARGS)
1186 {
1187 	struct ufoma_softc *sc = (struct ufoma_softc *)oidp->oid_arg1;
1188 	struct sbuf sb;
1189 	int i;
1190 	char *mode;
1191 
1192 	sbuf_new(&sb, NULL, 1, SBUF_AUTOEXTEND);
1193 	for(i = 1; i < sc->sc_modetable[0]; i++){
1194 		mode = ufoma_mode_to_str(sc->sc_modetable[i]);
1195 		if(mode !=NULL){
1196 			sbuf_cat(&sb, mode);
1197 		}else{
1198 			sbuf_printf(&sb, "(%02x)", sc->sc_modetable[i]);
1199 		}
1200 		if(i < (sc->sc_modetable[0]-1))
1201 			sbuf_cat(&sb, ",");
1202 	}
1203 	sbuf_trim(&sb);
1204 	sbuf_finish(&sb);
1205 	sysctl_handle_string(oidp, sbuf_data(&sb), sbuf_len(&sb), req);
1206 	sbuf_delete(&sb);
1207 
1208 	return 0;
1209 }
1210 static int ufoma_sysctl_current(SYSCTL_HANDLER_ARGS)
1211 {
1212 	struct ufoma_softc *sc = (struct ufoma_softc *)oidp->oid_arg1;
1213 	char *mode;
1214 	char subbuf[]="(XXX)";
1215 	mode = ufoma_mode_to_str(sc->sc_currentmode);
1216 	if(!mode){
1217 		mode = subbuf;
1218 		snprintf(subbuf, sizeof(subbuf), "(%02x)", sc->sc_currentmode);
1219 	}
1220 	sysctl_handle_string(oidp, mode, strlen(mode), req);
1221 
1222 	return 0;
1223 
1224 }
1225 static int ufoma_sysctl_open(SYSCTL_HANDLER_ARGS)
1226 {
1227 	struct ufoma_softc *sc = (struct ufoma_softc *)oidp->oid_arg1;
1228 	char *mode;
1229 	char subbuf[40];
1230 	int newmode;
1231 	int error;
1232 	int i;
1233 
1234 	mode = ufoma_mode_to_str(sc->sc_modetoactivate);
1235 	if(mode){
1236 		strncpy(subbuf, mode, sizeof(subbuf));
1237 	}else{
1238 		snprintf(subbuf, sizeof(subbuf), "(%02x)", sc->sc_modetoactivate);
1239 	}
1240 	error = sysctl_handle_string(oidp, subbuf, sizeof(subbuf), req);
1241 	if(error != 0 || req->newptr == NULL){
1242 		return error;
1243 	}
1244 
1245 	if((newmode = ufoma_str_to_mode(subbuf)) == -1){
1246 		return EINVAL;
1247 	}
1248 
1249 	for(i = 1 ; i < sc->sc_modetable[0] ; i++){
1250 		if(sc->sc_modetable[i] == newmode){
1251 			sc->sc_modetoactivate = newmode;
1252 			return 0;
1253 		}
1254 	}
1255 
1256 	return EINVAL;
1257 }
1258 
1259 static void
1260 ufoma_poll(struct ucom_softc *ucom)
1261 {
1262 	struct ufoma_softc *sc = ucom->sc_parent;
1263 	usbd_transfer_poll(sc->sc_ctrl_xfer, UFOMA_CTRL_ENDPT_MAX);
1264 	usbd_transfer_poll(sc->sc_bulk_xfer, UFOMA_BULK_ENDPT_MAX);
1265 }
1266