1 /* $NetBSD: umodem.c,v 1.45 2002/09/23 05:51:23 simonb Exp $ */
5 #define UFOMA_HANDSFREE
7 * Copyright (c) 2005, Takanori Watanabe
8 * Copyright (c) 2003, M. Warner Losh <imp@FreeBSD.org>.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * Copyright (c) 1998 The NetBSD Foundation, Inc.
35 * All rights reserved.
37 * This code is derived from software contributed to The NetBSD Foundation
38 * by Lennart Augustsson (lennart@augustsson.net) at
39 * Carlstedt Research & Technology.
41 * Redistribution and use in source and binary forms, with or without
42 * modification, are permitted provided that the following conditions
44 * 1. Redistributions of source code must retain the above copyright
45 * notice, this list of conditions and the following disclaimer.
46 * 2. Redistributions in binary form must reproduce the above copyright
47 * notice, this list of conditions and the following disclaimer in the
48 * documentation and/or other materials provided with the distribution.
49 * 3. All advertising materials mentioning features or use of this software
50 * must display the following acknowledgement:
51 * This product includes software developed by the NetBSD
52 * Foundation, Inc. and its contributors.
53 * 4. Neither the name of The NetBSD Foundation nor the names of its
54 * contributors may be used to endorse or promote products derived
55 * from this software without specific prior written permission.
57 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
58 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
59 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
60 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
61 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
62 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
63 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
64 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
65 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
66 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
67 * POSSIBILITY OF SUCH DAMAGE.
71 * Comm Class spec: http://www.usb.org/developers/devclass_docs/usbccs10.pdf
72 * http://www.usb.org/developers/devclass_docs/usbcdc11.pdf
77 * - Implement a Call Device for modems without multiplexed commands.
81 * NOTE: all function names beginning like "ufoma_cfg_" can only
82 * be called from within the config thread function !
85 #include <sys/stdint.h>
86 #include <sys/stddef.h>
87 #include <sys/param.h>
88 #include <sys/queue.h>
89 #include <sys/types.h>
90 #include <sys/systm.h>
91 #include <sys/kernel.h>
93 #include <sys/module.h>
95 #include <sys/mutex.h>
96 #include <sys/condvar.h>
97 #include <sys/sysctl.h>
99 #include <sys/unistd.h>
100 #include <sys/callout.h>
101 #include <sys/malloc.h>
102 #include <sys/priv.h>
103 #include <sys/sbuf.h>
105 #include <dev/usb/usb.h>
106 #include <dev/usb/usbdi.h>
107 #include <dev/usb/usbdi_util.h>
108 #include <dev/usb/usb_cdc.h>
111 #define USB_DEBUG_VAR usb_debug
112 #include <dev/usb/usb_debug.h>
113 #include <dev/usb/usb_process.h>
115 #include <dev/usb/serial/usb_serial.h>
117 typedef struct ufoma_mobile_acm_descriptor {
118 uint8_t bFunctionLength;
119 uint8_t bDescriptorType;
120 uint8_t bDescriptorSubtype;
123 } __packed usb_mcpc_acm_descriptor;
125 #define UISUBCLASS_MCPC 0x88
127 #define UDESC_VS_INTERFACE 0x44
128 #define UDESCSUB_MCPC_ACM 0x11
130 #define UMCPC_ACM_TYPE_AB1 0x1
131 #define UMCPC_ACM_TYPE_AB2 0x2
132 #define UMCPC_ACM_TYPE_AB5 0x5
133 #define UMCPC_ACM_TYPE_AB6 0x6
135 #define UMCPC_ACM_MODE_DEACTIVATED 0x0
136 #define UMCPC_ACM_MODE_MODEM 0x1
137 #define UMCPC_ACM_MODE_ATCOMMAND 0x2
138 #define UMCPC_ACM_MODE_OBEX 0x60
139 #define UMCPC_ACM_MODE_VENDOR1 0xc0
140 #define UMCPC_ACM_MODE_VENDOR2 0xfe
141 #define UMCPC_ACM_MODE_UNLINKED 0xff
143 #define UMCPC_CM_MOBILE_ACM 0x0
145 #define UMCPC_ACTIVATE_MODE 0x60
146 #define UMCPC_GET_MODETABLE 0x61
147 #define UMCPC_SET_LINK 0x62
148 #define UMCPC_CLEAR_LINK 0x63
150 #define UMCPC_REQUEST_ACKNOWLEDGE 0x31
152 #define UFOMA_MAX_TIMEOUT 15 /* standard says 10 seconds */
153 #define UFOMA_CMD_BUF_SIZE 64 /* bytes */
155 #define UFOMA_BULK_BUF_SIZE 1024 /* bytes */
158 UFOMA_CTRL_ENDPT_INTR,
159 UFOMA_CTRL_ENDPT_READ,
160 UFOMA_CTRL_ENDPT_WRITE,
161 UFOMA_CTRL_ENDPT_MAX,
165 UFOMA_BULK_ENDPT_WRITE,
166 UFOMA_BULK_ENDPT_READ,
167 UFOMA_BULK_ENDPT_MAX,
171 struct ucom_super_softc sc_super_ucom;
172 struct ucom_softc sc_ucom;
176 struct usb_xfer *sc_ctrl_xfer[UFOMA_CTRL_ENDPT_MAX];
177 struct usb_xfer *sc_bulk_xfer[UFOMA_BULK_ENDPT_MAX];
178 uint8_t *sc_modetable;
180 struct usb_device *sc_udev;
188 uint8_t sc_ctrl_iface_no;
189 uint8_t sc_ctrl_iface_index;
190 uint8_t sc_data_iface_no;
191 uint8_t sc_data_iface_index;
196 uint8_t sc_modetoactivate;
197 uint8_t sc_currentmode;
202 static device_probe_t ufoma_probe;
203 static device_attach_t ufoma_attach;
204 static device_detach_t ufoma_detach;
205 static void ufoma_free_softc(struct ufoma_softc *);
207 static usb_callback_t ufoma_ctrl_read_callback;
208 static usb_callback_t ufoma_ctrl_write_callback;
209 static usb_callback_t ufoma_intr_callback;
210 static usb_callback_t ufoma_bulk_write_callback;
211 static usb_callback_t ufoma_bulk_read_callback;
213 static void *ufoma_get_intconf(struct usb_config_descriptor *,
214 struct usb_interface_descriptor *, uint8_t, uint8_t);
215 static void ufoma_cfg_link_state(struct ufoma_softc *);
216 static void ufoma_cfg_activate_state(struct ufoma_softc *, uint16_t);
217 static void ufoma_free(struct ucom_softc *);
218 static void ufoma_cfg_open(struct ucom_softc *);
219 static void ufoma_cfg_close(struct ucom_softc *);
220 static void ufoma_cfg_set_break(struct ucom_softc *, uint8_t);
221 static void ufoma_cfg_get_status(struct ucom_softc *, uint8_t *,
223 static void ufoma_cfg_set_dtr(struct ucom_softc *, uint8_t);
224 static void ufoma_cfg_set_rts(struct ucom_softc *, uint8_t);
225 static int ufoma_pre_param(struct ucom_softc *, struct termios *);
226 static void ufoma_cfg_param(struct ucom_softc *, struct termios *);
227 static int ufoma_modem_setup(device_t, struct ufoma_softc *,
228 struct usb_attach_arg *);
229 static void ufoma_start_read(struct ucom_softc *);
230 static void ufoma_stop_read(struct ucom_softc *);
231 static void ufoma_start_write(struct ucom_softc *);
232 static void ufoma_stop_write(struct ucom_softc *);
233 static void ufoma_poll(struct ucom_softc *ucom);
236 static int ufoma_sysctl_support(SYSCTL_HANDLER_ARGS);
237 static int ufoma_sysctl_current(SYSCTL_HANDLER_ARGS);
238 static int ufoma_sysctl_open(SYSCTL_HANDLER_ARGS);
240 static const struct usb_config
241 ufoma_ctrl_config[UFOMA_CTRL_ENDPT_MAX] = {
243 [UFOMA_CTRL_ENDPT_INTR] = {
244 .type = UE_INTERRUPT,
245 .endpoint = UE_ADDR_ANY,
246 .direction = UE_DIR_IN,
247 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
248 .bufsize = sizeof(struct usb_cdc_notification),
249 .callback = &ufoma_intr_callback,
252 [UFOMA_CTRL_ENDPT_READ] = {
254 .endpoint = 0x00, /* Control pipe */
255 .direction = UE_DIR_ANY,
256 .bufsize = (sizeof(struct usb_device_request) + UFOMA_CMD_BUF_SIZE),
257 .flags = {.short_xfer_ok = 1,},
258 .callback = &ufoma_ctrl_read_callback,
259 .timeout = 1000, /* 1 second */
262 [UFOMA_CTRL_ENDPT_WRITE] = {
264 .endpoint = 0x00, /* Control pipe */
265 .direction = UE_DIR_ANY,
266 .bufsize = (sizeof(struct usb_device_request) + 1),
267 .callback = &ufoma_ctrl_write_callback,
268 .timeout = 1000, /* 1 second */
272 static const struct usb_config
273 ufoma_bulk_config[UFOMA_BULK_ENDPT_MAX] = {
275 [UFOMA_BULK_ENDPT_WRITE] = {
277 .endpoint = UE_ADDR_ANY,
278 .direction = UE_DIR_OUT,
279 .bufsize = UFOMA_BULK_BUF_SIZE,
280 .flags = {.pipe_bof = 1,.force_short_xfer = 1,},
281 .callback = &ufoma_bulk_write_callback,
284 [UFOMA_BULK_ENDPT_READ] = {
286 .endpoint = UE_ADDR_ANY,
287 .direction = UE_DIR_IN,
288 .bufsize = UFOMA_BULK_BUF_SIZE,
289 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
290 .callback = &ufoma_bulk_read_callback,
294 static const struct ucom_callback ufoma_callback = {
295 .ucom_cfg_get_status = &ufoma_cfg_get_status,
296 .ucom_cfg_set_dtr = &ufoma_cfg_set_dtr,
297 .ucom_cfg_set_rts = &ufoma_cfg_set_rts,
298 .ucom_cfg_set_break = &ufoma_cfg_set_break,
299 .ucom_cfg_param = &ufoma_cfg_param,
300 .ucom_cfg_open = &ufoma_cfg_open,
301 .ucom_cfg_close = &ufoma_cfg_close,
302 .ucom_pre_param = &ufoma_pre_param,
303 .ucom_start_read = &ufoma_start_read,
304 .ucom_stop_read = &ufoma_stop_read,
305 .ucom_start_write = &ufoma_start_write,
306 .ucom_stop_write = &ufoma_stop_write,
307 .ucom_poll = &ufoma_poll,
308 .ucom_free = &ufoma_free,
311 static device_method_t ufoma_methods[] = {
313 DEVMETHOD(device_probe, ufoma_probe),
314 DEVMETHOD(device_attach, ufoma_attach),
315 DEVMETHOD(device_detach, ufoma_detach),
319 static devclass_t ufoma_devclass;
321 static driver_t ufoma_driver = {
323 .methods = ufoma_methods,
324 .size = sizeof(struct ufoma_softc),
327 DRIVER_MODULE(ufoma, uhub, ufoma_driver, ufoma_devclass, NULL, 0);
328 MODULE_DEPEND(ufoma, ucom, 1, 1, 1);
329 MODULE_DEPEND(ufoma, usb, 1, 1, 1);
330 MODULE_VERSION(ufoma, 1);
332 static const STRUCT_USB_HOST_ID ufoma_devs[] = {
333 {USB_IFACE_CLASS(UICLASS_CDC),
334 USB_IFACE_SUBCLASS(UISUBCLASS_MCPC),},
338 ufoma_probe(device_t dev)
340 struct usb_attach_arg *uaa = device_get_ivars(dev);
341 struct usb_interface_descriptor *id;
342 struct usb_config_descriptor *cd;
343 usb_mcpc_acm_descriptor *mad;
346 if (uaa->usb_mode != USB_MODE_HOST)
349 error = usbd_lookup_id_by_uaa(ufoma_devs, sizeof(ufoma_devs), uaa);
353 id = usbd_get_interface_descriptor(uaa->iface);
354 cd = usbd_get_config_descriptor(uaa->device);
356 if (id == NULL || cd == NULL)
359 mad = ufoma_get_intconf(cd, id, UDESC_VS_INTERFACE, UDESCSUB_MCPC_ACM);
363 #ifndef UFOMA_HANDSFREE
364 if ((mad->bType == UMCPC_ACM_TYPE_AB5) ||
365 (mad->bType == UMCPC_ACM_TYPE_AB6))
368 return (BUS_PROBE_GENERIC);
372 ufoma_attach(device_t dev)
374 struct usb_attach_arg *uaa = device_get_ivars(dev);
375 struct ufoma_softc *sc = device_get_softc(dev);
376 struct usb_config_descriptor *cd;
377 struct usb_interface_descriptor *id;
378 struct sysctl_ctx_list *sctx;
379 struct sysctl_oid *soid;
381 usb_mcpc_acm_descriptor *mad;
385 sc->sc_udev = uaa->device;
387 sc->sc_unit = device_get_unit(dev);
389 mtx_init(&sc->sc_mtx, "ufoma", NULL, MTX_DEF);
390 ucom_ref(&sc->sc_super_ucom);
391 cv_init(&sc->sc_cv, "CWAIT");
393 device_set_usb_desc(dev);
397 /* setup control transfers */
399 cd = usbd_get_config_descriptor(uaa->device);
400 id = usbd_get_interface_descriptor(uaa->iface);
401 sc->sc_ctrl_iface_no = id->bInterfaceNumber;
402 sc->sc_ctrl_iface_index = uaa->info.bIfaceIndex;
404 error = usbd_transfer_setup(uaa->device,
405 &sc->sc_ctrl_iface_index, sc->sc_ctrl_xfer,
406 ufoma_ctrl_config, UFOMA_CTRL_ENDPT_MAX, sc, &sc->sc_mtx);
409 device_printf(dev, "allocating control USB "
410 "transfers failed\n");
413 mad = ufoma_get_intconf(cd, id, UDESC_VS_INTERFACE, UDESCSUB_MCPC_ACM);
417 if (mad->bFunctionLength < sizeof(*mad)) {
418 device_printf(dev, "invalid MAD descriptor\n");
421 if ((mad->bType == UMCPC_ACM_TYPE_AB5) ||
422 (mad->bType == UMCPC_ACM_TYPE_AB6)) {
426 if (ufoma_modem_setup(dev, sc, uaa)) {
431 elements = (mad->bFunctionLength - sizeof(*mad) + 1);
433 /* initialize mode variables */
435 sc->sc_modetable = malloc(elements + 1, M_USBDEV, M_WAITOK);
437 if (sc->sc_modetable == NULL) {
440 sc->sc_modetable[0] = (elements + 1);
441 memcpy(&sc->sc_modetable[1], mad->bMode, elements);
443 sc->sc_currentmode = UMCPC_ACM_MODE_UNLINKED;
444 sc->sc_modetoactivate = mad->bMode[0];
446 /* clear stall at first run, if any */
447 mtx_lock(&sc->sc_mtx);
448 usbd_xfer_set_stall(sc->sc_bulk_xfer[UFOMA_BULK_ENDPT_WRITE]);
449 usbd_xfer_set_stall(sc->sc_bulk_xfer[UFOMA_BULK_ENDPT_READ]);
450 mtx_unlock(&sc->sc_mtx);
452 error = ucom_attach(&sc->sc_super_ucom, &sc->sc_ucom, 1, sc,
453 &ufoma_callback, &sc->sc_mtx);
455 DPRINTF("ucom_attach failed\n");
458 ucom_set_pnpinfo_usb(&sc->sc_super_ucom, dev);
461 sctx = device_get_sysctl_ctx(dev);
462 soid = device_get_sysctl_tree(dev);
464 SYSCTL_ADD_PROC(sctx, SYSCTL_CHILDREN(soid), OID_AUTO, "supportmode",
465 CTLFLAG_RD|CTLTYPE_STRING, sc, 0, ufoma_sysctl_support,
466 "A", "Supporting port role");
468 SYSCTL_ADD_PROC(sctx, SYSCTL_CHILDREN(soid), OID_AUTO, "currentmode",
469 CTLFLAG_RD|CTLTYPE_STRING, sc, 0, ufoma_sysctl_current,
470 "A", "Current port role");
472 SYSCTL_ADD_PROC(sctx, SYSCTL_CHILDREN(soid), OID_AUTO, "openmode",
473 CTLFLAG_RW|CTLTYPE_STRING, sc, 0, ufoma_sysctl_open,
474 "A", "Mode to transit when port is opened");
475 SYSCTL_ADD_UINT(sctx, SYSCTL_CHILDREN(soid), OID_AUTO, "comunit",
476 CTLFLAG_RD, &(sc->sc_super_ucom.sc_unit), 0,
477 "Unit number as USB serial");
479 return (0); /* success */
483 return (ENXIO); /* failure */
487 ufoma_detach(device_t dev)
489 struct ufoma_softc *sc = device_get_softc(dev);
491 ucom_detach(&sc->sc_super_ucom, &sc->sc_ucom);
492 usbd_transfer_unsetup(sc->sc_ctrl_xfer, UFOMA_CTRL_ENDPT_MAX);
493 usbd_transfer_unsetup(sc->sc_bulk_xfer, UFOMA_BULK_ENDPT_MAX);
495 if (sc->sc_modetable) {
496 free(sc->sc_modetable, M_USBDEV);
498 cv_destroy(&sc->sc_cv);
500 device_claim_softc(dev);
502 ufoma_free_softc(sc);
507 UCOM_UNLOAD_DRAIN(ufoma);
510 ufoma_free_softc(struct ufoma_softc *sc)
512 if (ucom_unref(&sc->sc_super_ucom)) {
513 mtx_destroy(&sc->sc_mtx);
514 device_free_softc(sc);
519 ufoma_free(struct ucom_softc *ucom)
521 ufoma_free_softc(ucom->sc_parent);
525 ufoma_get_intconf(struct usb_config_descriptor *cd, struct usb_interface_descriptor *id,
526 uint8_t type, uint8_t subtype)
528 struct usb_descriptor *desc = (void *)id;
530 while ((desc = usb_desc_foreach(cd, desc))) {
532 if (desc->bDescriptorType == UDESC_INTERFACE) {
535 if ((desc->bDescriptorType == type) &&
536 (desc->bDescriptorSubtype == subtype)) {
544 ufoma_cfg_link_state(struct ufoma_softc *sc)
546 struct usb_device_request req;
549 req.bmRequestType = UT_WRITE_VENDOR_INTERFACE;
550 req.bRequest = UMCPC_SET_LINK;
551 USETW(req.wValue, UMCPC_CM_MOBILE_ACM);
552 USETW(req.wIndex, sc->sc_ctrl_iface_no);
553 USETW(req.wLength, sc->sc_modetable[0]);
555 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
556 &req, sc->sc_modetable, 0, 1000);
558 error = cv_timedwait(&sc->sc_cv, &sc->sc_mtx, hz);
561 DPRINTF("NO response\n");
566 ufoma_cfg_activate_state(struct ufoma_softc *sc, uint16_t state)
568 struct usb_device_request req;
571 req.bmRequestType = UT_WRITE_VENDOR_INTERFACE;
572 req.bRequest = UMCPC_ACTIVATE_MODE;
573 USETW(req.wValue, state);
574 USETW(req.wIndex, sc->sc_ctrl_iface_no);
575 USETW(req.wLength, 0);
577 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
578 &req, NULL, 0, 1000);
580 error = cv_timedwait(&sc->sc_cv, &sc->sc_mtx,
581 (UFOMA_MAX_TIMEOUT * hz));
583 DPRINTF("No response\n");
588 ufoma_ctrl_read_callback(struct usb_xfer *xfer, usb_error_t error)
590 struct ufoma_softc *sc = usbd_xfer_softc(xfer);
591 struct usb_device_request req;
592 struct usb_page_cache *pc0, *pc1;
593 int len, aframes, nframes;
595 usbd_xfer_status(xfer, NULL, NULL, &aframes, &nframes);
597 switch (USB_GET_STATE(xfer)) {
598 case USB_ST_TRANSFERRED:
600 if (aframes != nframes)
602 pc1 = usbd_xfer_get_frame(xfer, 1);
603 len = usbd_xfer_frame_len(xfer, 1);
605 ucom_put_data(&sc->sc_ucom, pc1, 0, len);
609 if (sc->sc_num_msg) {
612 req.bmRequestType = UT_READ_CLASS_INTERFACE;
613 req.bRequest = UCDC_GET_ENCAPSULATED_RESPONSE;
614 USETW(req.wIndex, sc->sc_ctrl_iface_no);
615 USETW(req.wValue, 0);
616 USETW(req.wLength, UFOMA_CMD_BUF_SIZE);
618 pc0 = usbd_xfer_get_frame(xfer, 0);
619 usbd_copy_in(pc0, 0, &req, sizeof(req));
621 usbd_xfer_set_frame_len(xfer, 0, sizeof(req));
622 usbd_xfer_set_frame_len(xfer, 1, UFOMA_CMD_BUF_SIZE);
623 usbd_xfer_set_frames(xfer, 2);
624 usbd_transfer_submit(xfer);
629 DPRINTF("error = %s\n",
632 if (error == USB_ERR_CANCELLED) {
640 ufoma_ctrl_write_callback(struct usb_xfer *xfer, usb_error_t error)
642 struct ufoma_softc *sc = usbd_xfer_softc(xfer);
643 struct usb_device_request req;
644 struct usb_page_cache *pc;
647 switch (USB_GET_STATE(xfer)) {
648 case USB_ST_TRANSFERRED:
651 pc = usbd_xfer_get_frame(xfer, 1);
652 if (ucom_get_data(&sc->sc_ucom, pc, 0, 1, &actlen)) {
654 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
655 req.bRequest = UCDC_SEND_ENCAPSULATED_COMMAND;
656 USETW(req.wIndex, sc->sc_ctrl_iface_no);
657 USETW(req.wValue, 0);
658 USETW(req.wLength, 1);
660 pc = usbd_xfer_get_frame(xfer, 0);
661 usbd_copy_in(pc, 0, &req, sizeof(req));
663 usbd_xfer_set_frame_len(xfer, 0, sizeof(req));
664 usbd_xfer_set_frame_len(xfer, 1, 1);
665 usbd_xfer_set_frames(xfer, 2);
667 usbd_transfer_submit(xfer);
672 DPRINTF("error = %s\n", usbd_errstr(error));
674 if (error == USB_ERR_CANCELLED) {
682 ufoma_intr_callback(struct usb_xfer *xfer, usb_error_t error)
684 struct ufoma_softc *sc = usbd_xfer_softc(xfer);
685 struct usb_cdc_notification pkt;
686 struct usb_page_cache *pc;
692 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
694 switch (USB_GET_STATE(xfer)) {
695 case USB_ST_TRANSFERRED:
697 DPRINTF("too short message\n");
700 if (actlen > (int)sizeof(pkt)) {
701 DPRINTF("truncating message\n");
702 actlen = sizeof(pkt);
704 pc = usbd_xfer_get_frame(xfer, 0);
705 usbd_copy_out(pc, 0, &pkt, actlen);
709 wLen = UGETW(pkt.wLength);
713 if ((pkt.bmRequestType == UT_READ_VENDOR_INTERFACE) &&
714 (pkt.bNotification == UMCPC_REQUEST_ACKNOWLEDGE)) {
715 temp = UGETW(pkt.wValue);
716 sc->sc_currentmode = (temp >> 8);
717 if (!(temp & 0xff)) {
718 DPRINTF("Mode change failed!\n");
720 cv_signal(&sc->sc_cv);
722 if (pkt.bmRequestType != UCDC_NOTIFICATION) {
725 switch (pkt.bNotification) {
726 case UCDC_N_RESPONSE_AVAILABLE:
727 if (!(sc->sc_nobulk)) {
728 DPRINTF("Wrong serial state!\n");
731 if (sc->sc_num_msg != 0xFF) {
734 usbd_transfer_start(sc->sc_ctrl_xfer[UFOMA_CTRL_ENDPT_READ]);
737 case UCDC_N_SERIAL_STATE:
739 DPRINTF("Wrong serial state!\n");
743 * Set the serial state in ucom driver based on
744 * the bits from the notify message
747 DPRINTF("invalid notification "
748 "length, %d bytes!\n", actlen);
751 DPRINTF("notify bytes = 0x%02x, 0x%02x\n",
752 pkt.data[0], pkt.data[1]);
754 /* currently, lsr is always zero. */
758 mstatus = pkt.data[0];
760 if (mstatus & UCDC_N_SERIAL_RI) {
761 sc->sc_msr |= SER_RI;
763 if (mstatus & UCDC_N_SERIAL_DSR) {
764 sc->sc_msr |= SER_DSR;
766 if (mstatus & UCDC_N_SERIAL_DCD) {
767 sc->sc_msr |= SER_DCD;
769 ucom_status_change(&sc->sc_ucom);
778 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
779 usbd_transfer_submit(xfer);
783 if (error != USB_ERR_CANCELLED) {
784 /* try to clear stall first */
785 usbd_xfer_set_stall(xfer);
793 ufoma_bulk_write_callback(struct usb_xfer *xfer, usb_error_t error)
795 struct ufoma_softc *sc = usbd_xfer_softc(xfer);
796 struct usb_page_cache *pc;
799 switch (USB_GET_STATE(xfer)) {
801 case USB_ST_TRANSFERRED:
803 pc = usbd_xfer_get_frame(xfer, 0);
804 if (ucom_get_data(&sc->sc_ucom, pc, 0,
805 UFOMA_BULK_BUF_SIZE, &actlen)) {
806 usbd_xfer_set_frame_len(xfer, 0, actlen);
807 usbd_transfer_submit(xfer);
812 if (error != USB_ERR_CANCELLED) {
813 /* try to clear stall first */
814 usbd_xfer_set_stall(xfer);
822 ufoma_bulk_read_callback(struct usb_xfer *xfer, usb_error_t error)
824 struct ufoma_softc *sc = usbd_xfer_softc(xfer);
825 struct usb_page_cache *pc;
828 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
830 switch (USB_GET_STATE(xfer)) {
831 case USB_ST_TRANSFERRED:
832 pc = usbd_xfer_get_frame(xfer, 0);
833 ucom_put_data(&sc->sc_ucom, pc, 0, actlen);
837 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
838 usbd_transfer_submit(xfer);
842 if (error != USB_ERR_CANCELLED) {
843 /* try to clear stall first */
844 usbd_xfer_set_stall(xfer);
852 ufoma_cfg_open(struct ucom_softc *ucom)
854 struct ufoma_softc *sc = ucom->sc_parent;
856 /* empty input queue */
858 if (sc->sc_num_msg != 0xFF) {
861 if (sc->sc_currentmode == UMCPC_ACM_MODE_UNLINKED) {
862 ufoma_cfg_link_state(sc);
864 if (sc->sc_currentmode == UMCPC_ACM_MODE_DEACTIVATED) {
865 ufoma_cfg_activate_state(sc, sc->sc_modetoactivate);
870 ufoma_cfg_close(struct ucom_softc *ucom)
872 struct ufoma_softc *sc = ucom->sc_parent;
874 ufoma_cfg_activate_state(sc, UMCPC_ACM_MODE_DEACTIVATED);
878 ufoma_cfg_set_break(struct ucom_softc *ucom, uint8_t onoff)
880 struct ufoma_softc *sc = ucom->sc_parent;
881 struct usb_device_request req;
885 (sc->sc_currentmode == UMCPC_ACM_MODE_OBEX)) {
888 if (!(sc->sc_acm_cap & USB_CDC_ACM_HAS_BREAK)) {
891 wValue = onoff ? UCDC_BREAK_ON : UCDC_BREAK_OFF;
893 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
894 req.bRequest = UCDC_SEND_BREAK;
895 USETW(req.wValue, wValue);
896 req.wIndex[0] = sc->sc_ctrl_iface_no;
898 USETW(req.wLength, 0);
900 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
901 &req, NULL, 0, 1000);
905 ufoma_cfg_get_status(struct ucom_softc *ucom, uint8_t *lsr, uint8_t *msr)
907 struct ufoma_softc *sc = ucom->sc_parent;
914 ufoma_cfg_set_line_state(struct ufoma_softc *sc)
916 struct usb_device_request req;
918 /* Don't send line state emulation request for OBEX port */
919 if (sc->sc_currentmode == UMCPC_ACM_MODE_OBEX) {
922 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
923 req.bRequest = UCDC_SET_CONTROL_LINE_STATE;
924 USETW(req.wValue, sc->sc_line);
925 req.wIndex[0] = sc->sc_ctrl_iface_no;
927 USETW(req.wLength, 0);
929 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
930 &req, NULL, 0, 1000);
934 ufoma_cfg_set_dtr(struct ucom_softc *ucom, uint8_t onoff)
936 struct ufoma_softc *sc = ucom->sc_parent;
942 sc->sc_line |= UCDC_LINE_DTR;
944 sc->sc_line &= ~UCDC_LINE_DTR;
946 ufoma_cfg_set_line_state(sc);
950 ufoma_cfg_set_rts(struct ucom_softc *ucom, uint8_t onoff)
952 struct ufoma_softc *sc = ucom->sc_parent;
958 sc->sc_line |= UCDC_LINE_RTS;
960 sc->sc_line &= ~UCDC_LINE_RTS;
962 ufoma_cfg_set_line_state(sc);
966 ufoma_pre_param(struct ucom_softc *ucom, struct termios *t)
968 return (0); /* we accept anything */
972 ufoma_cfg_param(struct ucom_softc *ucom, struct termios *t)
974 struct ufoma_softc *sc = ucom->sc_parent;
975 struct usb_device_request req;
976 struct usb_cdc_line_state ls;
979 (sc->sc_currentmode == UMCPC_ACM_MODE_OBEX)) {
984 memset(&ls, 0, sizeof(ls));
986 USETDW(ls.dwDTERate, t->c_ospeed);
988 if (t->c_cflag & CSTOPB) {
989 ls.bCharFormat = UCDC_STOP_BIT_2;
991 ls.bCharFormat = UCDC_STOP_BIT_1;
994 if (t->c_cflag & PARENB) {
995 if (t->c_cflag & PARODD) {
996 ls.bParityType = UCDC_PARITY_ODD;
998 ls.bParityType = UCDC_PARITY_EVEN;
1001 ls.bParityType = UCDC_PARITY_NONE;
1004 switch (t->c_cflag & CSIZE) {
1019 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
1020 req.bRequest = UCDC_SET_LINE_CODING;
1021 USETW(req.wValue, 0);
1022 req.wIndex[0] = sc->sc_ctrl_iface_no;
1024 USETW(req.wLength, UCDC_LINE_STATE_LENGTH);
1026 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
1027 &req, &ls, 0, 1000);
1031 ufoma_modem_setup(device_t dev, struct ufoma_softc *sc,
1032 struct usb_attach_arg *uaa)
1034 struct usb_config_descriptor *cd;
1035 struct usb_cdc_acm_descriptor *acm;
1036 struct usb_cdc_cm_descriptor *cmd;
1037 struct usb_interface_descriptor *id;
1038 struct usb_interface *iface;
1042 cd = usbd_get_config_descriptor(uaa->device);
1043 id = usbd_get_interface_descriptor(uaa->iface);
1045 cmd = ufoma_get_intconf(cd, id, UDESC_CS_INTERFACE, UDESCSUB_CDC_CM);
1047 if ((cmd == NULL) ||
1048 (cmd->bLength < sizeof(*cmd))) {
1051 sc->sc_cm_cap = cmd->bmCapabilities;
1052 sc->sc_data_iface_no = cmd->bDataInterface;
1054 acm = ufoma_get_intconf(cd, id, UDESC_CS_INTERFACE, UDESCSUB_CDC_ACM);
1056 if ((acm == NULL) ||
1057 (acm->bLength < sizeof(*acm))) {
1060 sc->sc_acm_cap = acm->bmCapabilities;
1062 device_printf(dev, "data interface %d, has %sCM over data, "
1064 sc->sc_data_iface_no,
1065 sc->sc_cm_cap & USB_CDC_CM_OVER_DATA ? "" : "no ",
1066 sc->sc_acm_cap & USB_CDC_ACM_HAS_BREAK ? "" : "no ");
1068 /* get the data interface too */
1072 iface = usbd_get_iface(uaa->device, i);
1076 id = usbd_get_interface_descriptor(iface);
1078 if (id && (id->bInterfaceNumber == sc->sc_data_iface_no)) {
1079 sc->sc_data_iface_index = i;
1080 usbd_set_parent_iface(uaa->device, i, uaa->info.bIfaceIndex);
1084 device_printf(dev, "no data interface\n");
1089 error = usbd_transfer_setup(uaa->device,
1090 &sc->sc_data_iface_index, sc->sc_bulk_xfer,
1091 ufoma_bulk_config, UFOMA_BULK_ENDPT_MAX, sc, &sc->sc_mtx);
1094 device_printf(dev, "allocating BULK USB "
1095 "transfers failed\n");
1102 ufoma_start_read(struct ucom_softc *ucom)
1104 struct ufoma_softc *sc = ucom->sc_parent;
1106 /* start interrupt transfer */
1107 usbd_transfer_start(sc->sc_ctrl_xfer[UFOMA_CTRL_ENDPT_INTR]);
1109 /* start data transfer */
1110 if (sc->sc_nobulk) {
1111 usbd_transfer_start(sc->sc_ctrl_xfer[UFOMA_CTRL_ENDPT_READ]);
1113 usbd_transfer_start(sc->sc_bulk_xfer[UFOMA_BULK_ENDPT_READ]);
1118 ufoma_stop_read(struct ucom_softc *ucom)
1120 struct ufoma_softc *sc = ucom->sc_parent;
1122 /* stop interrupt transfer */
1123 usbd_transfer_stop(sc->sc_ctrl_xfer[UFOMA_CTRL_ENDPT_INTR]);
1125 /* stop data transfer */
1126 if (sc->sc_nobulk) {
1127 usbd_transfer_stop(sc->sc_ctrl_xfer[UFOMA_CTRL_ENDPT_READ]);
1129 usbd_transfer_stop(sc->sc_bulk_xfer[UFOMA_BULK_ENDPT_READ]);
1134 ufoma_start_write(struct ucom_softc *ucom)
1136 struct ufoma_softc *sc = ucom->sc_parent;
1138 if (sc->sc_nobulk) {
1139 usbd_transfer_start(sc->sc_ctrl_xfer[UFOMA_CTRL_ENDPT_WRITE]);
1141 usbd_transfer_start(sc->sc_bulk_xfer[UFOMA_BULK_ENDPT_WRITE]);
1146 ufoma_stop_write(struct ucom_softc *ucom)
1148 struct ufoma_softc *sc = ucom->sc_parent;
1150 if (sc->sc_nobulk) {
1151 usbd_transfer_stop(sc->sc_ctrl_xfer[UFOMA_CTRL_ENDPT_WRITE]);
1153 usbd_transfer_stop(sc->sc_bulk_xfer[UFOMA_BULK_ENDPT_WRITE]);
1157 static struct umcpc_modetostr_tab{
1160 }umcpc_modetostr_tab[]={
1161 {UMCPC_ACM_MODE_DEACTIVATED, "deactivated"},
1162 {UMCPC_ACM_MODE_MODEM, "modem"},
1163 {UMCPC_ACM_MODE_ATCOMMAND, "handsfree"},
1164 {UMCPC_ACM_MODE_OBEX, "obex"},
1165 {UMCPC_ACM_MODE_VENDOR1, "vendor1"},
1166 {UMCPC_ACM_MODE_VENDOR2, "vendor2"},
1167 {UMCPC_ACM_MODE_UNLINKED, "unlinked"},
1171 static char *ufoma_mode_to_str(int mode)
1174 for(i = 0 ;umcpc_modetostr_tab[i].str != NULL; i++){
1175 if(umcpc_modetostr_tab[i].mode == mode){
1176 return umcpc_modetostr_tab[i].str;
1182 static int ufoma_str_to_mode(char *str)
1185 for(i = 0 ;umcpc_modetostr_tab[i].str != NULL; i++){
1186 if(strcmp(str, umcpc_modetostr_tab[i].str)==0){
1187 return umcpc_modetostr_tab[i].mode;
1193 static int ufoma_sysctl_support(SYSCTL_HANDLER_ARGS)
1195 struct ufoma_softc *sc = (struct ufoma_softc *)oidp->oid_arg1;
1200 sbuf_new(&sb, NULL, 1, SBUF_AUTOEXTEND);
1201 for(i = 1; i < sc->sc_modetable[0]; i++){
1202 mode = ufoma_mode_to_str(sc->sc_modetable[i]);
1204 sbuf_cat(&sb, mode);
1206 sbuf_printf(&sb, "(%02x)", sc->sc_modetable[i]);
1208 if(i < (sc->sc_modetable[0]-1))
1213 sysctl_handle_string(oidp, sbuf_data(&sb), sbuf_len(&sb), req);
1218 static int ufoma_sysctl_current(SYSCTL_HANDLER_ARGS)
1220 struct ufoma_softc *sc = (struct ufoma_softc *)oidp->oid_arg1;
1222 char subbuf[]="(XXX)";
1223 mode = ufoma_mode_to_str(sc->sc_currentmode);
1226 snprintf(subbuf, sizeof(subbuf), "(%02x)", sc->sc_currentmode);
1228 sysctl_handle_string(oidp, mode, strlen(mode), req);
1233 static int ufoma_sysctl_open(SYSCTL_HANDLER_ARGS)
1235 struct ufoma_softc *sc = (struct ufoma_softc *)oidp->oid_arg1;
1242 mode = ufoma_mode_to_str(sc->sc_modetoactivate);
1244 strncpy(subbuf, mode, sizeof(subbuf));
1246 snprintf(subbuf, sizeof(subbuf), "(%02x)", sc->sc_modetoactivate);
1248 error = sysctl_handle_string(oidp, subbuf, sizeof(subbuf), req);
1249 if(error != 0 || req->newptr == NULL){
1253 if((newmode = ufoma_str_to_mode(subbuf)) == -1){
1257 for(i = 1 ; i < sc->sc_modetable[0] ; i++){
1258 if(sc->sc_modetable[i] == newmode){
1259 sc->sc_modetoactivate = newmode;
1268 ufoma_poll(struct ucom_softc *ucom)
1270 struct ufoma_softc *sc = ucom->sc_parent;
1271 usbd_transfer_poll(sc->sc_ctrl_xfer, UFOMA_CTRL_ENDPT_MAX);
1272 usbd_transfer_poll(sc->sc_bulk_xfer, UFOMA_BULK_ENDPT_MAX);