1 /* $NetBSD: umodem.c,v 1.45 2002/09/23 05:51:23 simonb Exp $ */
5 #define UFOMA_HANDSFREE
7 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD AND BSD-2-Clause-NetBSD
9 * Copyright (c) 2005, Takanori Watanabe All rights reserved.
10 * Copyright (c) 2003 M. Warner Losh <imp@FreeBSD.org>
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
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.
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
35 * Copyright (c) 1998 The NetBSD Foundation, Inc.
36 * All rights reserved.
38 * This code is derived from software contributed to The NetBSD Foundation
39 * by Lennart Augustsson (lennart@augustsson.net) at
40 * Carlstedt Research & Technology.
42 * Redistribution and use in source and binary forms, with or without
43 * modification, are permitted provided that the following conditions
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.
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.
65 * Comm Class spec: http://www.usb.org/developers/devclass_docs/usbccs10.pdf
66 * http://www.usb.org/developers/devclass_docs/usbcdc11.pdf
71 * - Implement a Call Device for modems without multiplexed commands.
75 * NOTE: all function names beginning like "ufoma_cfg_" can only
76 * be called from within the config thread function !
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>
87 #include <sys/module.h>
89 #include <sys/mutex.h>
90 #include <sys/condvar.h>
91 #include <sys/sysctl.h>
93 #include <sys/unistd.h>
94 #include <sys/callout.h>
95 #include <sys/malloc.h>
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>
105 #define USB_DEBUG_VAR usb_debug
106 #include <dev/usb/usb_debug.h>
107 #include <dev/usb/usb_process.h>
109 #include <dev/usb/serial/usb_serial.h>
111 typedef struct ufoma_mobile_acm_descriptor {
112 uint8_t bFunctionLength;
113 uint8_t bDescriptorType;
114 uint8_t bDescriptorSubtype;
117 } __packed usb_mcpc_acm_descriptor;
119 #define UISUBCLASS_MCPC 0x88
121 #define UDESC_VS_INTERFACE 0x44
122 #define UDESCSUB_MCPC_ACM 0x11
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
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
137 #define UMCPC_CM_MOBILE_ACM 0x0
139 #define UMCPC_ACTIVATE_MODE 0x60
140 #define UMCPC_GET_MODETABLE 0x61
141 #define UMCPC_SET_LINK 0x62
142 #define UMCPC_CLEAR_LINK 0x63
144 #define UMCPC_REQUEST_ACKNOWLEDGE 0x31
146 #define UFOMA_MAX_TIMEOUT 15 /* standard says 10 seconds */
147 #define UFOMA_CMD_BUF_SIZE 64 /* bytes */
149 #define UFOMA_BULK_BUF_SIZE 1024 /* bytes */
152 UFOMA_CTRL_ENDPT_INTR,
153 UFOMA_CTRL_ENDPT_READ,
154 UFOMA_CTRL_ENDPT_WRITE,
155 UFOMA_CTRL_ENDPT_MAX,
159 UFOMA_BULK_ENDPT_WRITE,
160 UFOMA_BULK_ENDPT_READ,
161 UFOMA_BULK_ENDPT_MAX,
165 struct ucom_super_softc sc_super_ucom;
166 struct ucom_softc sc_ucom;
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;
174 struct usb_device *sc_udev;
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;
190 uint8_t sc_modetoactivate;
191 uint8_t sc_currentmode;
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 *);
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;
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 *,
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);
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);
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,
245 [UFOMA_CTRL_ENDPT_READ] = {
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 */
255 [UFOMA_CTRL_ENDPT_WRITE] = {
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 */
265 static const struct usb_config
266 ufoma_bulk_config[UFOMA_BULK_ENDPT_MAX] = {
267 [UFOMA_BULK_ENDPT_WRITE] = {
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,
276 [UFOMA_BULK_ENDPT_READ] = {
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,
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,
303 static device_method_t ufoma_methods[] = {
305 DEVMETHOD(device_probe, ufoma_probe),
306 DEVMETHOD(device_attach, ufoma_attach),
307 DEVMETHOD(device_detach, ufoma_detach),
311 static devclass_t ufoma_devclass;
313 static driver_t ufoma_driver = {
315 .methods = ufoma_methods,
316 .size = sizeof(struct ufoma_softc),
319 static const STRUCT_USB_HOST_ID ufoma_devs[] = {
320 {USB_IFACE_CLASS(UICLASS_CDC),
321 USB_IFACE_SUBCLASS(UISUBCLASS_MCPC),},
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);
331 ufoma_probe(device_t dev)
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;
339 if (uaa->usb_mode != USB_MODE_HOST)
342 error = usbd_lookup_id_by_uaa(ufoma_devs, sizeof(ufoma_devs), uaa);
346 id = usbd_get_interface_descriptor(uaa->iface);
347 cd = usbd_get_config_descriptor(uaa->device);
349 if (id == NULL || cd == NULL)
352 mad = ufoma_get_intconf(cd, id, UDESC_VS_INTERFACE, UDESCSUB_MCPC_ACM);
356 #ifndef UFOMA_HANDSFREE
357 if ((mad->bType == UMCPC_ACM_TYPE_AB5) ||
358 (mad->bType == UMCPC_ACM_TYPE_AB6))
361 return (BUS_PROBE_GENERIC);
365 ufoma_attach(device_t dev)
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;
374 usb_mcpc_acm_descriptor *mad;
378 sc->sc_udev = uaa->device;
380 sc->sc_unit = device_get_unit(dev);
382 mtx_init(&sc->sc_mtx, "ufoma", NULL, MTX_DEF);
383 ucom_ref(&sc->sc_super_ucom);
384 cv_init(&sc->sc_cv, "CWAIT");
386 device_set_usb_desc(dev);
390 /* setup control transfers */
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;
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);
402 device_printf(dev, "allocating control USB "
403 "transfers failed\n");
406 mad = ufoma_get_intconf(cd, id, UDESC_VS_INTERFACE, UDESCSUB_MCPC_ACM);
410 if (mad->bFunctionLength < sizeof(*mad)) {
411 device_printf(dev, "invalid MAD descriptor\n");
414 if ((mad->bType == UMCPC_ACM_TYPE_AB5) ||
415 (mad->bType == UMCPC_ACM_TYPE_AB6)) {
419 if (ufoma_modem_setup(dev, sc, uaa)) {
424 elements = (mad->bFunctionLength - sizeof(*mad) + 1);
426 /* initialize mode variables */
428 sc->sc_modetable = malloc(elements + 1, M_USBDEV, M_WAITOK);
430 if (sc->sc_modetable == NULL) {
433 sc->sc_modetable[0] = (elements + 1);
434 memcpy(&sc->sc_modetable[1], mad->bMode, elements);
436 sc->sc_currentmode = UMCPC_ACM_MODE_UNLINKED;
437 sc->sc_modetoactivate = mad->bMode[0];
439 /* clear stall at first run, if any */
440 mtx_lock(&sc->sc_mtx);
441 usbd_xfer_set_stall(sc->sc_bulk_xfer[UFOMA_BULK_ENDPT_WRITE]);
442 usbd_xfer_set_stall(sc->sc_bulk_xfer[UFOMA_BULK_ENDPT_READ]);
443 mtx_unlock(&sc->sc_mtx);
445 error = ucom_attach(&sc->sc_super_ucom, &sc->sc_ucom, 1, sc,
446 &ufoma_callback, &sc->sc_mtx);
448 DPRINTF("ucom_attach failed\n");
451 ucom_set_pnpinfo_usb(&sc->sc_super_ucom, dev);
454 sctx = device_get_sysctl_ctx(dev);
455 soid = device_get_sysctl_tree(dev);
457 SYSCTL_ADD_PROC(sctx, SYSCTL_CHILDREN(soid), OID_AUTO, "supportmode",
458 CTLFLAG_RD | CTLTYPE_STRING | CTLFLAG_MPSAFE, sc, 0,
459 ufoma_sysctl_support, "A", "Supporting port role");
461 SYSCTL_ADD_PROC(sctx, SYSCTL_CHILDREN(soid), OID_AUTO, "currentmode",
462 CTLFLAG_RD | CTLTYPE_STRING | CTLFLAG_MPSAFE, sc, 0,
463 ufoma_sysctl_current, "A", "Current port role");
465 SYSCTL_ADD_PROC(sctx, SYSCTL_CHILDREN(soid), OID_AUTO, "openmode",
466 CTLFLAG_RW | CTLTYPE_STRING | CTLFLAG_MPSAFE, sc, 0,
467 ufoma_sysctl_open, "A", "Mode to transit when port is opened");
468 SYSCTL_ADD_UINT(sctx, SYSCTL_CHILDREN(soid), OID_AUTO, "comunit",
469 CTLFLAG_RD, &(sc->sc_super_ucom.sc_unit), 0,
470 "Unit number as USB serial");
472 return (0); /* success */
476 return (ENXIO); /* failure */
480 ufoma_detach(device_t dev)
482 struct ufoma_softc *sc = device_get_softc(dev);
484 ucom_detach(&sc->sc_super_ucom, &sc->sc_ucom);
485 usbd_transfer_unsetup(sc->sc_ctrl_xfer, UFOMA_CTRL_ENDPT_MAX);
486 usbd_transfer_unsetup(sc->sc_bulk_xfer, UFOMA_BULK_ENDPT_MAX);
488 if (sc->sc_modetable) {
489 free(sc->sc_modetable, M_USBDEV);
491 cv_destroy(&sc->sc_cv);
493 device_claim_softc(dev);
495 ufoma_free_softc(sc);
500 UCOM_UNLOAD_DRAIN(ufoma);
503 ufoma_free_softc(struct ufoma_softc *sc)
505 if (ucom_unref(&sc->sc_super_ucom)) {
506 mtx_destroy(&sc->sc_mtx);
507 device_free_softc(sc);
512 ufoma_free(struct ucom_softc *ucom)
514 ufoma_free_softc(ucom->sc_parent);
518 ufoma_get_intconf(struct usb_config_descriptor *cd, struct usb_interface_descriptor *id,
519 uint8_t type, uint8_t subtype)
521 struct usb_descriptor *desc = (void *)id;
523 while ((desc = usb_desc_foreach(cd, desc))) {
524 if (desc->bDescriptorType == UDESC_INTERFACE) {
527 if ((desc->bDescriptorType == type) &&
528 (desc->bDescriptorSubtype == subtype)) {
536 ufoma_cfg_link_state(struct ufoma_softc *sc)
538 struct usb_device_request req;
541 req.bmRequestType = UT_WRITE_VENDOR_INTERFACE;
542 req.bRequest = UMCPC_SET_LINK;
543 USETW(req.wValue, UMCPC_CM_MOBILE_ACM);
544 USETW(req.wIndex, sc->sc_ctrl_iface_no);
545 USETW(req.wLength, sc->sc_modetable[0]);
547 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
548 &req, sc->sc_modetable, 0, 1000);
550 error = cv_timedwait(&sc->sc_cv, &sc->sc_mtx, hz);
553 DPRINTF("NO response\n");
558 ufoma_cfg_activate_state(struct ufoma_softc *sc, uint16_t state)
560 struct usb_device_request req;
563 req.bmRequestType = UT_WRITE_VENDOR_INTERFACE;
564 req.bRequest = UMCPC_ACTIVATE_MODE;
565 USETW(req.wValue, state);
566 USETW(req.wIndex, sc->sc_ctrl_iface_no);
567 USETW(req.wLength, 0);
569 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
570 &req, NULL, 0, 1000);
572 error = cv_timedwait(&sc->sc_cv, &sc->sc_mtx,
573 (UFOMA_MAX_TIMEOUT * hz));
575 DPRINTF("No response\n");
580 ufoma_ctrl_read_callback(struct usb_xfer *xfer, usb_error_t error)
582 struct ufoma_softc *sc = usbd_xfer_softc(xfer);
583 struct usb_device_request req;
584 struct usb_page_cache *pc0, *pc1;
585 int len, aframes, nframes;
587 usbd_xfer_status(xfer, NULL, NULL, &aframes, &nframes);
589 switch (USB_GET_STATE(xfer)) {
590 case USB_ST_TRANSFERRED:
592 if (aframes != nframes)
594 pc1 = usbd_xfer_get_frame(xfer, 1);
595 len = usbd_xfer_frame_len(xfer, 1);
597 ucom_put_data(&sc->sc_ucom, pc1, 0, len);
601 if (sc->sc_num_msg) {
604 req.bmRequestType = UT_READ_CLASS_INTERFACE;
605 req.bRequest = UCDC_GET_ENCAPSULATED_RESPONSE;
606 USETW(req.wIndex, sc->sc_ctrl_iface_no);
607 USETW(req.wValue, 0);
608 USETW(req.wLength, UFOMA_CMD_BUF_SIZE);
610 pc0 = usbd_xfer_get_frame(xfer, 0);
611 usbd_copy_in(pc0, 0, &req, sizeof(req));
613 usbd_xfer_set_frame_len(xfer, 0, sizeof(req));
614 usbd_xfer_set_frame_len(xfer, 1, UFOMA_CMD_BUF_SIZE);
615 usbd_xfer_set_frames(xfer, 2);
616 usbd_transfer_submit(xfer);
621 DPRINTF("error = %s\n",
624 if (error == USB_ERR_CANCELLED) {
632 ufoma_ctrl_write_callback(struct usb_xfer *xfer, usb_error_t error)
634 struct ufoma_softc *sc = usbd_xfer_softc(xfer);
635 struct usb_device_request req;
636 struct usb_page_cache *pc;
639 switch (USB_GET_STATE(xfer)) {
640 case USB_ST_TRANSFERRED:
643 pc = usbd_xfer_get_frame(xfer, 1);
644 if (ucom_get_data(&sc->sc_ucom, pc, 0, 1, &actlen)) {
645 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
646 req.bRequest = UCDC_SEND_ENCAPSULATED_COMMAND;
647 USETW(req.wIndex, sc->sc_ctrl_iface_no);
648 USETW(req.wValue, 0);
649 USETW(req.wLength, 1);
651 pc = usbd_xfer_get_frame(xfer, 0);
652 usbd_copy_in(pc, 0, &req, sizeof(req));
654 usbd_xfer_set_frame_len(xfer, 0, sizeof(req));
655 usbd_xfer_set_frame_len(xfer, 1, 1);
656 usbd_xfer_set_frames(xfer, 2);
658 usbd_transfer_submit(xfer);
663 DPRINTF("error = %s\n", usbd_errstr(error));
665 if (error == USB_ERR_CANCELLED) {
673 ufoma_intr_callback(struct usb_xfer *xfer, usb_error_t error)
675 struct ufoma_softc *sc = usbd_xfer_softc(xfer);
676 struct usb_cdc_notification pkt;
677 struct usb_page_cache *pc;
683 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
685 switch (USB_GET_STATE(xfer)) {
686 case USB_ST_TRANSFERRED:
688 DPRINTF("too short message\n");
691 if (actlen > (int)sizeof(pkt)) {
692 DPRINTF("truncating message\n");
693 actlen = sizeof(pkt);
695 pc = usbd_xfer_get_frame(xfer, 0);
696 usbd_copy_out(pc, 0, &pkt, actlen);
700 wLen = UGETW(pkt.wLength);
704 if ((pkt.bmRequestType == UT_READ_VENDOR_INTERFACE) &&
705 (pkt.bNotification == UMCPC_REQUEST_ACKNOWLEDGE)) {
706 temp = UGETW(pkt.wValue);
707 sc->sc_currentmode = (temp >> 8);
708 if (!(temp & 0xff)) {
709 DPRINTF("Mode change failed!\n");
711 cv_signal(&sc->sc_cv);
713 if (pkt.bmRequestType != UCDC_NOTIFICATION) {
716 switch (pkt.bNotification) {
717 case UCDC_N_RESPONSE_AVAILABLE:
718 if (!(sc->sc_nobulk)) {
719 DPRINTF("Wrong serial state!\n");
722 if (sc->sc_num_msg != 0xFF) {
725 usbd_transfer_start(sc->sc_ctrl_xfer[UFOMA_CTRL_ENDPT_READ]);
728 case UCDC_N_SERIAL_STATE:
730 DPRINTF("Wrong serial state!\n");
734 * Set the serial state in ucom driver based on
735 * the bits from the notify message
738 DPRINTF("invalid notification "
739 "length, %d bytes!\n", actlen);
742 DPRINTF("notify bytes = 0x%02x, 0x%02x\n",
743 pkt.data[0], pkt.data[1]);
745 /* currently, lsr is always zero. */
749 mstatus = pkt.data[0];
751 if (mstatus & UCDC_N_SERIAL_RI) {
752 sc->sc_msr |= SER_RI;
754 if (mstatus & UCDC_N_SERIAL_DSR) {
755 sc->sc_msr |= SER_DSR;
757 if (mstatus & UCDC_N_SERIAL_DCD) {
758 sc->sc_msr |= SER_DCD;
760 ucom_status_change(&sc->sc_ucom);
769 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
770 usbd_transfer_submit(xfer);
774 if (error != USB_ERR_CANCELLED) {
775 /* try to clear stall first */
776 usbd_xfer_set_stall(xfer);
784 ufoma_bulk_write_callback(struct usb_xfer *xfer, usb_error_t error)
786 struct ufoma_softc *sc = usbd_xfer_softc(xfer);
787 struct usb_page_cache *pc;
790 switch (USB_GET_STATE(xfer)) {
792 case USB_ST_TRANSFERRED:
794 pc = usbd_xfer_get_frame(xfer, 0);
795 if (ucom_get_data(&sc->sc_ucom, pc, 0,
796 UFOMA_BULK_BUF_SIZE, &actlen)) {
797 usbd_xfer_set_frame_len(xfer, 0, actlen);
798 usbd_transfer_submit(xfer);
803 if (error != USB_ERR_CANCELLED) {
804 /* try to clear stall first */
805 usbd_xfer_set_stall(xfer);
813 ufoma_bulk_read_callback(struct usb_xfer *xfer, usb_error_t error)
815 struct ufoma_softc *sc = usbd_xfer_softc(xfer);
816 struct usb_page_cache *pc;
819 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
821 switch (USB_GET_STATE(xfer)) {
822 case USB_ST_TRANSFERRED:
823 pc = usbd_xfer_get_frame(xfer, 0);
824 ucom_put_data(&sc->sc_ucom, pc, 0, actlen);
828 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
829 usbd_transfer_submit(xfer);
833 if (error != USB_ERR_CANCELLED) {
834 /* try to clear stall first */
835 usbd_xfer_set_stall(xfer);
843 ufoma_cfg_open(struct ucom_softc *ucom)
845 struct ufoma_softc *sc = ucom->sc_parent;
847 /* empty input queue */
849 if (sc->sc_num_msg != 0xFF) {
852 if (sc->sc_currentmode == UMCPC_ACM_MODE_UNLINKED) {
853 ufoma_cfg_link_state(sc);
855 if (sc->sc_currentmode == UMCPC_ACM_MODE_DEACTIVATED) {
856 ufoma_cfg_activate_state(sc, sc->sc_modetoactivate);
861 ufoma_cfg_close(struct ucom_softc *ucom)
863 struct ufoma_softc *sc = ucom->sc_parent;
865 ufoma_cfg_activate_state(sc, UMCPC_ACM_MODE_DEACTIVATED);
869 ufoma_cfg_set_break(struct ucom_softc *ucom, uint8_t onoff)
871 struct ufoma_softc *sc = ucom->sc_parent;
872 struct usb_device_request req;
876 (sc->sc_currentmode == UMCPC_ACM_MODE_OBEX)) {
879 if (!(sc->sc_acm_cap & USB_CDC_ACM_HAS_BREAK)) {
882 wValue = onoff ? UCDC_BREAK_ON : UCDC_BREAK_OFF;
884 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
885 req.bRequest = UCDC_SEND_BREAK;
886 USETW(req.wValue, wValue);
887 req.wIndex[0] = sc->sc_ctrl_iface_no;
889 USETW(req.wLength, 0);
891 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
892 &req, NULL, 0, 1000);
896 ufoma_cfg_get_status(struct ucom_softc *ucom, uint8_t *lsr, uint8_t *msr)
898 struct ufoma_softc *sc = ucom->sc_parent;
900 /* XXX Note: sc_lsr is always zero */
906 ufoma_cfg_set_line_state(struct ufoma_softc *sc)
908 struct usb_device_request req;
910 /* Don't send line state emulation request for OBEX port */
911 if (sc->sc_currentmode == UMCPC_ACM_MODE_OBEX) {
914 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
915 req.bRequest = UCDC_SET_CONTROL_LINE_STATE;
916 USETW(req.wValue, sc->sc_line);
917 req.wIndex[0] = sc->sc_ctrl_iface_no;
919 USETW(req.wLength, 0);
921 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
922 &req, NULL, 0, 1000);
926 ufoma_cfg_set_dtr(struct ucom_softc *ucom, uint8_t onoff)
928 struct ufoma_softc *sc = ucom->sc_parent;
934 sc->sc_line |= UCDC_LINE_DTR;
936 sc->sc_line &= ~UCDC_LINE_DTR;
938 ufoma_cfg_set_line_state(sc);
942 ufoma_cfg_set_rts(struct ucom_softc *ucom, uint8_t onoff)
944 struct ufoma_softc *sc = ucom->sc_parent;
950 sc->sc_line |= UCDC_LINE_RTS;
952 sc->sc_line &= ~UCDC_LINE_RTS;
954 ufoma_cfg_set_line_state(sc);
958 ufoma_pre_param(struct ucom_softc *ucom, struct termios *t)
960 return (0); /* we accept anything */
964 ufoma_cfg_param(struct ucom_softc *ucom, struct termios *t)
966 struct ufoma_softc *sc = ucom->sc_parent;
967 struct usb_device_request req;
968 struct usb_cdc_line_state ls;
971 (sc->sc_currentmode == UMCPC_ACM_MODE_OBEX)) {
976 memset(&ls, 0, sizeof(ls));
978 USETDW(ls.dwDTERate, t->c_ospeed);
980 if (t->c_cflag & CSTOPB) {
981 ls.bCharFormat = UCDC_STOP_BIT_2;
983 ls.bCharFormat = UCDC_STOP_BIT_1;
986 if (t->c_cflag & PARENB) {
987 if (t->c_cflag & PARODD) {
988 ls.bParityType = UCDC_PARITY_ODD;
990 ls.bParityType = UCDC_PARITY_EVEN;
993 ls.bParityType = UCDC_PARITY_NONE;
996 switch (t->c_cflag & CSIZE) {
1011 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
1012 req.bRequest = UCDC_SET_LINE_CODING;
1013 USETW(req.wValue, 0);
1014 req.wIndex[0] = sc->sc_ctrl_iface_no;
1016 USETW(req.wLength, UCDC_LINE_STATE_LENGTH);
1018 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
1019 &req, &ls, 0, 1000);
1023 ufoma_modem_setup(device_t dev, struct ufoma_softc *sc,
1024 struct usb_attach_arg *uaa)
1026 struct usb_config_descriptor *cd;
1027 struct usb_cdc_acm_descriptor *acm;
1028 struct usb_cdc_cm_descriptor *cmd;
1029 struct usb_interface_descriptor *id;
1030 struct usb_interface *iface;
1034 cd = usbd_get_config_descriptor(uaa->device);
1035 id = usbd_get_interface_descriptor(uaa->iface);
1037 cmd = ufoma_get_intconf(cd, id, UDESC_CS_INTERFACE, UDESCSUB_CDC_CM);
1039 if ((cmd == NULL) ||
1040 (cmd->bLength < sizeof(*cmd))) {
1043 sc->sc_cm_cap = cmd->bmCapabilities;
1044 sc->sc_data_iface_no = cmd->bDataInterface;
1046 acm = ufoma_get_intconf(cd, id, UDESC_CS_INTERFACE, UDESCSUB_CDC_ACM);
1048 if ((acm == NULL) ||
1049 (acm->bLength < sizeof(*acm))) {
1052 sc->sc_acm_cap = acm->bmCapabilities;
1054 device_printf(dev, "data interface %d, has %sCM over data, "
1056 sc->sc_data_iface_no,
1057 sc->sc_cm_cap & USB_CDC_CM_OVER_DATA ? "" : "no ",
1058 sc->sc_acm_cap & USB_CDC_ACM_HAS_BREAK ? "" : "no ");
1060 /* get the data interface too */
1063 iface = usbd_get_iface(uaa->device, i);
1066 id = usbd_get_interface_descriptor(iface);
1068 if (id && (id->bInterfaceNumber == sc->sc_data_iface_no)) {
1069 sc->sc_data_iface_index = i;
1070 usbd_set_parent_iface(uaa->device, i, uaa->info.bIfaceIndex);
1074 device_printf(dev, "no data interface\n");
1079 error = usbd_transfer_setup(uaa->device,
1080 &sc->sc_data_iface_index, sc->sc_bulk_xfer,
1081 ufoma_bulk_config, UFOMA_BULK_ENDPT_MAX, sc, &sc->sc_mtx);
1084 device_printf(dev, "allocating BULK USB "
1085 "transfers failed\n");
1092 ufoma_start_read(struct ucom_softc *ucom)
1094 struct ufoma_softc *sc = ucom->sc_parent;
1096 /* start interrupt transfer */
1097 usbd_transfer_start(sc->sc_ctrl_xfer[UFOMA_CTRL_ENDPT_INTR]);
1099 /* start data transfer */
1100 if (sc->sc_nobulk) {
1101 usbd_transfer_start(sc->sc_ctrl_xfer[UFOMA_CTRL_ENDPT_READ]);
1103 usbd_transfer_start(sc->sc_bulk_xfer[UFOMA_BULK_ENDPT_READ]);
1108 ufoma_stop_read(struct ucom_softc *ucom)
1110 struct ufoma_softc *sc = ucom->sc_parent;
1112 /* stop interrupt transfer */
1113 usbd_transfer_stop(sc->sc_ctrl_xfer[UFOMA_CTRL_ENDPT_INTR]);
1115 /* stop data transfer */
1116 if (sc->sc_nobulk) {
1117 usbd_transfer_stop(sc->sc_ctrl_xfer[UFOMA_CTRL_ENDPT_READ]);
1119 usbd_transfer_stop(sc->sc_bulk_xfer[UFOMA_BULK_ENDPT_READ]);
1124 ufoma_start_write(struct ucom_softc *ucom)
1126 struct ufoma_softc *sc = ucom->sc_parent;
1128 if (sc->sc_nobulk) {
1129 usbd_transfer_start(sc->sc_ctrl_xfer[UFOMA_CTRL_ENDPT_WRITE]);
1131 usbd_transfer_start(sc->sc_bulk_xfer[UFOMA_BULK_ENDPT_WRITE]);
1136 ufoma_stop_write(struct ucom_softc *ucom)
1138 struct ufoma_softc *sc = ucom->sc_parent;
1140 if (sc->sc_nobulk) {
1141 usbd_transfer_stop(sc->sc_ctrl_xfer[UFOMA_CTRL_ENDPT_WRITE]);
1143 usbd_transfer_stop(sc->sc_bulk_xfer[UFOMA_BULK_ENDPT_WRITE]);
1147 static struct umcpc_modetostr_tab{
1150 }umcpc_modetostr_tab[]={
1151 {UMCPC_ACM_MODE_DEACTIVATED, "deactivated"},
1152 {UMCPC_ACM_MODE_MODEM, "modem"},
1153 {UMCPC_ACM_MODE_ATCOMMAND, "handsfree"},
1154 {UMCPC_ACM_MODE_OBEX, "obex"},
1155 {UMCPC_ACM_MODE_VENDOR1, "vendor1"},
1156 {UMCPC_ACM_MODE_VENDOR2, "vendor2"},
1157 {UMCPC_ACM_MODE_UNLINKED, "unlinked"},
1161 static char *ufoma_mode_to_str(int mode)
1164 for(i = 0 ;umcpc_modetostr_tab[i].str != NULL; i++){
1165 if(umcpc_modetostr_tab[i].mode == mode){
1166 return umcpc_modetostr_tab[i].str;
1172 static int ufoma_str_to_mode(char *str)
1175 for(i = 0 ;umcpc_modetostr_tab[i].str != NULL; i++){
1176 if(strcmp(str, umcpc_modetostr_tab[i].str)==0){
1177 return umcpc_modetostr_tab[i].mode;
1183 static int ufoma_sysctl_support(SYSCTL_HANDLER_ARGS)
1185 struct ufoma_softc *sc = (struct ufoma_softc *)oidp->oid_arg1;
1190 sbuf_new(&sb, NULL, 1, SBUF_AUTOEXTEND);
1191 for(i = 1; i < sc->sc_modetable[0]; i++){
1192 mode = ufoma_mode_to_str(sc->sc_modetable[i]);
1194 sbuf_cat(&sb, mode);
1196 sbuf_printf(&sb, "(%02x)", sc->sc_modetable[i]);
1198 if(i < (sc->sc_modetable[0]-1))
1203 sysctl_handle_string(oidp, sbuf_data(&sb), sbuf_len(&sb), req);
1208 static int ufoma_sysctl_current(SYSCTL_HANDLER_ARGS)
1210 struct ufoma_softc *sc = (struct ufoma_softc *)oidp->oid_arg1;
1212 char subbuf[]="(XXX)";
1213 mode = ufoma_mode_to_str(sc->sc_currentmode);
1216 snprintf(subbuf, sizeof(subbuf), "(%02x)", sc->sc_currentmode);
1218 sysctl_handle_string(oidp, mode, strlen(mode), req);
1223 static int ufoma_sysctl_open(SYSCTL_HANDLER_ARGS)
1225 struct ufoma_softc *sc = (struct ufoma_softc *)oidp->oid_arg1;
1232 mode = ufoma_mode_to_str(sc->sc_modetoactivate);
1234 strncpy(subbuf, mode, sizeof(subbuf));
1236 snprintf(subbuf, sizeof(subbuf), "(%02x)", sc->sc_modetoactivate);
1238 error = sysctl_handle_string(oidp, subbuf, sizeof(subbuf), req);
1239 if(error != 0 || req->newptr == NULL){
1243 if((newmode = ufoma_str_to_mode(subbuf)) == -1){
1247 for(i = 1 ; i < sc->sc_modetable[0] ; i++){
1248 if(sc->sc_modetable[i] == newmode){
1249 sc->sc_modetoactivate = newmode;
1258 ufoma_poll(struct ucom_softc *ucom)
1260 struct ufoma_softc *sc = ucom->sc_parent;
1261 usbd_transfer_poll(sc->sc_ctrl_xfer, UFOMA_CTRL_ENDPT_MAX);
1262 usbd_transfer_poll(sc->sc_bulk_xfer, UFOMA_BULK_ENDPT_MAX);