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.
50 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
51 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
52 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
53 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
54 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
55 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
56 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
57 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
58 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
59 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
60 * POSSIBILITY OF SUCH DAMAGE.
64 * Comm Class spec: http://www.usb.org/developers/devclass_docs/usbccs10.pdf
65 * http://www.usb.org/developers/devclass_docs/usbcdc11.pdf
70 * - Implement a Call Device for modems without multiplexed commands.
74 * NOTE: all function names beginning like "ufoma_cfg_" can only
75 * be called from within the config thread function !
78 #include <sys/stdint.h>
79 #include <sys/stddef.h>
80 #include <sys/param.h>
81 #include <sys/queue.h>
82 #include <sys/types.h>
83 #include <sys/systm.h>
84 #include <sys/kernel.h>
86 #include <sys/module.h>
88 #include <sys/mutex.h>
89 #include <sys/condvar.h>
90 #include <sys/sysctl.h>
92 #include <sys/unistd.h>
93 #include <sys/callout.h>
94 #include <sys/malloc.h>
98 #include <dev/usb/usb.h>
99 #include <dev/usb/usbdi.h>
100 #include <dev/usb/usbdi_util.h>
101 #include <dev/usb/usb_cdc.h>
104 #define USB_DEBUG_VAR usb_debug
105 #include <dev/usb/usb_debug.h>
106 #include <dev/usb/usb_process.h>
108 #include <dev/usb/serial/usb_serial.h>
110 typedef struct ufoma_mobile_acm_descriptor {
111 uint8_t bFunctionLength;
112 uint8_t bDescriptorType;
113 uint8_t bDescriptorSubtype;
116 } __packed usb_mcpc_acm_descriptor;
118 #define UISUBCLASS_MCPC 0x88
120 #define UDESC_VS_INTERFACE 0x44
121 #define UDESCSUB_MCPC_ACM 0x11
123 #define UMCPC_ACM_TYPE_AB1 0x1
124 #define UMCPC_ACM_TYPE_AB2 0x2
125 #define UMCPC_ACM_TYPE_AB5 0x5
126 #define UMCPC_ACM_TYPE_AB6 0x6
128 #define UMCPC_ACM_MODE_DEACTIVATED 0x0
129 #define UMCPC_ACM_MODE_MODEM 0x1
130 #define UMCPC_ACM_MODE_ATCOMMAND 0x2
131 #define UMCPC_ACM_MODE_OBEX 0x60
132 #define UMCPC_ACM_MODE_VENDOR1 0xc0
133 #define UMCPC_ACM_MODE_VENDOR2 0xfe
134 #define UMCPC_ACM_MODE_UNLINKED 0xff
136 #define UMCPC_CM_MOBILE_ACM 0x0
138 #define UMCPC_ACTIVATE_MODE 0x60
139 #define UMCPC_GET_MODETABLE 0x61
140 #define UMCPC_SET_LINK 0x62
141 #define UMCPC_CLEAR_LINK 0x63
143 #define UMCPC_REQUEST_ACKNOWLEDGE 0x31
145 #define UFOMA_MAX_TIMEOUT 15 /* standard says 10 seconds */
146 #define UFOMA_CMD_BUF_SIZE 64 /* bytes */
148 #define UFOMA_BULK_BUF_SIZE 1024 /* bytes */
151 UFOMA_CTRL_ENDPT_INTR,
152 UFOMA_CTRL_ENDPT_READ,
153 UFOMA_CTRL_ENDPT_WRITE,
154 UFOMA_CTRL_ENDPT_MAX,
158 UFOMA_BULK_ENDPT_WRITE,
159 UFOMA_BULK_ENDPT_READ,
160 UFOMA_BULK_ENDPT_MAX,
164 struct ucom_super_softc sc_super_ucom;
165 struct ucom_softc sc_ucom;
169 struct usb_xfer *sc_ctrl_xfer[UFOMA_CTRL_ENDPT_MAX];
170 struct usb_xfer *sc_bulk_xfer[UFOMA_BULK_ENDPT_MAX];
171 uint8_t *sc_modetable;
173 struct usb_device *sc_udev;
181 uint8_t sc_ctrl_iface_no;
182 uint8_t sc_ctrl_iface_index;
183 uint8_t sc_data_iface_no;
184 uint8_t sc_data_iface_index;
189 uint8_t sc_modetoactivate;
190 uint8_t sc_currentmode;
195 static device_probe_t ufoma_probe;
196 static device_attach_t ufoma_attach;
197 static device_detach_t ufoma_detach;
198 static void ufoma_free_softc(struct ufoma_softc *);
200 static usb_callback_t ufoma_ctrl_read_callback;
201 static usb_callback_t ufoma_ctrl_write_callback;
202 static usb_callback_t ufoma_intr_callback;
203 static usb_callback_t ufoma_bulk_write_callback;
204 static usb_callback_t ufoma_bulk_read_callback;
206 static void *ufoma_get_intconf(struct usb_config_descriptor *,
207 struct usb_interface_descriptor *, uint8_t, uint8_t);
208 static void ufoma_cfg_link_state(struct ufoma_softc *);
209 static void ufoma_cfg_activate_state(struct ufoma_softc *, uint16_t);
210 static void ufoma_free(struct ucom_softc *);
211 static void ufoma_cfg_open(struct ucom_softc *);
212 static void ufoma_cfg_close(struct ucom_softc *);
213 static void ufoma_cfg_set_break(struct ucom_softc *, uint8_t);
214 static void ufoma_cfg_get_status(struct ucom_softc *, uint8_t *,
216 static void ufoma_cfg_set_dtr(struct ucom_softc *, uint8_t);
217 static void ufoma_cfg_set_rts(struct ucom_softc *, uint8_t);
218 static int ufoma_pre_param(struct ucom_softc *, struct termios *);
219 static void ufoma_cfg_param(struct ucom_softc *, struct termios *);
220 static int ufoma_modem_setup(device_t, struct ufoma_softc *,
221 struct usb_attach_arg *);
222 static void ufoma_start_read(struct ucom_softc *);
223 static void ufoma_stop_read(struct ucom_softc *);
224 static void ufoma_start_write(struct ucom_softc *);
225 static void ufoma_stop_write(struct ucom_softc *);
226 static void ufoma_poll(struct ucom_softc *ucom);
229 static int ufoma_sysctl_support(SYSCTL_HANDLER_ARGS);
230 static int ufoma_sysctl_current(SYSCTL_HANDLER_ARGS);
231 static int ufoma_sysctl_open(SYSCTL_HANDLER_ARGS);
233 static const struct usb_config
234 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] = {
268 [UFOMA_BULK_ENDPT_WRITE] = {
270 .endpoint = UE_ADDR_ANY,
271 .direction = UE_DIR_OUT,
272 .bufsize = UFOMA_BULK_BUF_SIZE,
273 .flags = {.pipe_bof = 1,.force_short_xfer = 1,},
274 .callback = &ufoma_bulk_write_callback,
277 [UFOMA_BULK_ENDPT_READ] = {
279 .endpoint = UE_ADDR_ANY,
280 .direction = UE_DIR_IN,
281 .bufsize = UFOMA_BULK_BUF_SIZE,
282 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
283 .callback = &ufoma_bulk_read_callback,
287 static const struct ucom_callback ufoma_callback = {
288 .ucom_cfg_get_status = &ufoma_cfg_get_status,
289 .ucom_cfg_set_dtr = &ufoma_cfg_set_dtr,
290 .ucom_cfg_set_rts = &ufoma_cfg_set_rts,
291 .ucom_cfg_set_break = &ufoma_cfg_set_break,
292 .ucom_cfg_param = &ufoma_cfg_param,
293 .ucom_cfg_open = &ufoma_cfg_open,
294 .ucom_cfg_close = &ufoma_cfg_close,
295 .ucom_pre_param = &ufoma_pre_param,
296 .ucom_start_read = &ufoma_start_read,
297 .ucom_stop_read = &ufoma_stop_read,
298 .ucom_start_write = &ufoma_start_write,
299 .ucom_stop_write = &ufoma_stop_write,
300 .ucom_poll = &ufoma_poll,
301 .ucom_free = &ufoma_free,
304 static device_method_t ufoma_methods[] = {
306 DEVMETHOD(device_probe, ufoma_probe),
307 DEVMETHOD(device_attach, ufoma_attach),
308 DEVMETHOD(device_detach, ufoma_detach),
312 static devclass_t ufoma_devclass;
314 static driver_t ufoma_driver = {
316 .methods = ufoma_methods,
317 .size = sizeof(struct ufoma_softc),
320 static const STRUCT_USB_HOST_ID ufoma_devs[] = {
321 {USB_IFACE_CLASS(UICLASS_CDC),
322 USB_IFACE_SUBCLASS(UISUBCLASS_MCPC),},
325 DRIVER_MODULE(ufoma, uhub, ufoma_driver, ufoma_devclass, NULL, 0);
326 MODULE_DEPEND(ufoma, ucom, 1, 1, 1);
327 MODULE_DEPEND(ufoma, usb, 1, 1, 1);
328 MODULE_VERSION(ufoma, 1);
329 USB_PNP_HOST_INFO(ufoma_devs);
332 ufoma_probe(device_t dev)
334 struct usb_attach_arg *uaa = device_get_ivars(dev);
335 struct usb_interface_descriptor *id;
336 struct usb_config_descriptor *cd;
337 usb_mcpc_acm_descriptor *mad;
340 if (uaa->usb_mode != USB_MODE_HOST)
343 error = usbd_lookup_id_by_uaa(ufoma_devs, sizeof(ufoma_devs), uaa);
347 id = usbd_get_interface_descriptor(uaa->iface);
348 cd = usbd_get_config_descriptor(uaa->device);
350 if (id == NULL || cd == NULL)
353 mad = ufoma_get_intconf(cd, id, UDESC_VS_INTERFACE, UDESCSUB_MCPC_ACM);
357 #ifndef UFOMA_HANDSFREE
358 if ((mad->bType == UMCPC_ACM_TYPE_AB5) ||
359 (mad->bType == UMCPC_ACM_TYPE_AB6))
362 return (BUS_PROBE_GENERIC);
366 ufoma_attach(device_t dev)
368 struct usb_attach_arg *uaa = device_get_ivars(dev);
369 struct ufoma_softc *sc = device_get_softc(dev);
370 struct usb_config_descriptor *cd;
371 struct usb_interface_descriptor *id;
372 struct sysctl_ctx_list *sctx;
373 struct sysctl_oid *soid;
375 usb_mcpc_acm_descriptor *mad;
379 sc->sc_udev = uaa->device;
381 sc->sc_unit = device_get_unit(dev);
383 mtx_init(&sc->sc_mtx, "ufoma", NULL, MTX_DEF);
384 ucom_ref(&sc->sc_super_ucom);
385 cv_init(&sc->sc_cv, "CWAIT");
387 device_set_usb_desc(dev);
391 /* setup control transfers */
393 cd = usbd_get_config_descriptor(uaa->device);
394 id = usbd_get_interface_descriptor(uaa->iface);
395 sc->sc_ctrl_iface_no = id->bInterfaceNumber;
396 sc->sc_ctrl_iface_index = uaa->info.bIfaceIndex;
398 error = usbd_transfer_setup(uaa->device,
399 &sc->sc_ctrl_iface_index, sc->sc_ctrl_xfer,
400 ufoma_ctrl_config, UFOMA_CTRL_ENDPT_MAX, sc, &sc->sc_mtx);
403 device_printf(dev, "allocating control USB "
404 "transfers failed\n");
407 mad = ufoma_get_intconf(cd, id, UDESC_VS_INTERFACE, UDESCSUB_MCPC_ACM);
411 if (mad->bFunctionLength < sizeof(*mad)) {
412 device_printf(dev, "invalid MAD descriptor\n");
415 if ((mad->bType == UMCPC_ACM_TYPE_AB5) ||
416 (mad->bType == UMCPC_ACM_TYPE_AB6)) {
420 if (ufoma_modem_setup(dev, sc, uaa)) {
425 elements = (mad->bFunctionLength - sizeof(*mad) + 1);
427 /* initialize mode variables */
429 sc->sc_modetable = malloc(elements + 1, M_USBDEV, M_WAITOK);
431 if (sc->sc_modetable == NULL) {
434 sc->sc_modetable[0] = (elements + 1);
435 memcpy(&sc->sc_modetable[1], mad->bMode, elements);
437 sc->sc_currentmode = UMCPC_ACM_MODE_UNLINKED;
438 sc->sc_modetoactivate = mad->bMode[0];
440 /* clear stall at first run, if any */
441 mtx_lock(&sc->sc_mtx);
442 usbd_xfer_set_stall(sc->sc_bulk_xfer[UFOMA_BULK_ENDPT_WRITE]);
443 usbd_xfer_set_stall(sc->sc_bulk_xfer[UFOMA_BULK_ENDPT_READ]);
444 mtx_unlock(&sc->sc_mtx);
446 error = ucom_attach(&sc->sc_super_ucom, &sc->sc_ucom, 1, sc,
447 &ufoma_callback, &sc->sc_mtx);
449 DPRINTF("ucom_attach failed\n");
452 ucom_set_pnpinfo_usb(&sc->sc_super_ucom, dev);
455 sctx = device_get_sysctl_ctx(dev);
456 soid = device_get_sysctl_tree(dev);
458 SYSCTL_ADD_PROC(sctx, SYSCTL_CHILDREN(soid), OID_AUTO, "supportmode",
459 CTLFLAG_RD|CTLTYPE_STRING, sc, 0, ufoma_sysctl_support,
460 "A", "Supporting port role");
462 SYSCTL_ADD_PROC(sctx, SYSCTL_CHILDREN(soid), OID_AUTO, "currentmode",
463 CTLFLAG_RD|CTLTYPE_STRING, sc, 0, ufoma_sysctl_current,
464 "A", "Current port role");
466 SYSCTL_ADD_PROC(sctx, SYSCTL_CHILDREN(soid), OID_AUTO, "openmode",
467 CTLFLAG_RW|CTLTYPE_STRING, sc, 0, ufoma_sysctl_open,
468 "A", "Mode to transit when port is opened");
469 SYSCTL_ADD_UINT(sctx, SYSCTL_CHILDREN(soid), OID_AUTO, "comunit",
470 CTLFLAG_RD, &(sc->sc_super_ucom.sc_unit), 0,
471 "Unit number as USB serial");
473 return (0); /* success */
477 return (ENXIO); /* failure */
481 ufoma_detach(device_t dev)
483 struct ufoma_softc *sc = device_get_softc(dev);
485 ucom_detach(&sc->sc_super_ucom, &sc->sc_ucom);
486 usbd_transfer_unsetup(sc->sc_ctrl_xfer, UFOMA_CTRL_ENDPT_MAX);
487 usbd_transfer_unsetup(sc->sc_bulk_xfer, UFOMA_BULK_ENDPT_MAX);
489 if (sc->sc_modetable) {
490 free(sc->sc_modetable, M_USBDEV);
492 cv_destroy(&sc->sc_cv);
494 device_claim_softc(dev);
496 ufoma_free_softc(sc);
501 UCOM_UNLOAD_DRAIN(ufoma);
504 ufoma_free_softc(struct ufoma_softc *sc)
506 if (ucom_unref(&sc->sc_super_ucom)) {
507 mtx_destroy(&sc->sc_mtx);
508 device_free_softc(sc);
513 ufoma_free(struct ucom_softc *ucom)
515 ufoma_free_softc(ucom->sc_parent);
519 ufoma_get_intconf(struct usb_config_descriptor *cd, struct usb_interface_descriptor *id,
520 uint8_t type, uint8_t subtype)
522 struct usb_descriptor *desc = (void *)id;
524 while ((desc = usb_desc_foreach(cd, desc))) {
526 if (desc->bDescriptorType == UDESC_INTERFACE) {
529 if ((desc->bDescriptorType == type) &&
530 (desc->bDescriptorSubtype == subtype)) {
538 ufoma_cfg_link_state(struct ufoma_softc *sc)
540 struct usb_device_request req;
543 req.bmRequestType = UT_WRITE_VENDOR_INTERFACE;
544 req.bRequest = UMCPC_SET_LINK;
545 USETW(req.wValue, UMCPC_CM_MOBILE_ACM);
546 USETW(req.wIndex, sc->sc_ctrl_iface_no);
547 USETW(req.wLength, sc->sc_modetable[0]);
549 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
550 &req, sc->sc_modetable, 0, 1000);
552 error = cv_timedwait(&sc->sc_cv, &sc->sc_mtx, hz);
555 DPRINTF("NO response\n");
560 ufoma_cfg_activate_state(struct ufoma_softc *sc, uint16_t state)
562 struct usb_device_request req;
565 req.bmRequestType = UT_WRITE_VENDOR_INTERFACE;
566 req.bRequest = UMCPC_ACTIVATE_MODE;
567 USETW(req.wValue, state);
568 USETW(req.wIndex, sc->sc_ctrl_iface_no);
569 USETW(req.wLength, 0);
571 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
572 &req, NULL, 0, 1000);
574 error = cv_timedwait(&sc->sc_cv, &sc->sc_mtx,
575 (UFOMA_MAX_TIMEOUT * hz));
577 DPRINTF("No response\n");
582 ufoma_ctrl_read_callback(struct usb_xfer *xfer, usb_error_t error)
584 struct ufoma_softc *sc = usbd_xfer_softc(xfer);
585 struct usb_device_request req;
586 struct usb_page_cache *pc0, *pc1;
587 int len, aframes, nframes;
589 usbd_xfer_status(xfer, NULL, NULL, &aframes, &nframes);
591 switch (USB_GET_STATE(xfer)) {
592 case USB_ST_TRANSFERRED:
594 if (aframes != nframes)
596 pc1 = usbd_xfer_get_frame(xfer, 1);
597 len = usbd_xfer_frame_len(xfer, 1);
599 ucom_put_data(&sc->sc_ucom, pc1, 0, len);
603 if (sc->sc_num_msg) {
606 req.bmRequestType = UT_READ_CLASS_INTERFACE;
607 req.bRequest = UCDC_GET_ENCAPSULATED_RESPONSE;
608 USETW(req.wIndex, sc->sc_ctrl_iface_no);
609 USETW(req.wValue, 0);
610 USETW(req.wLength, UFOMA_CMD_BUF_SIZE);
612 pc0 = usbd_xfer_get_frame(xfer, 0);
613 usbd_copy_in(pc0, 0, &req, sizeof(req));
615 usbd_xfer_set_frame_len(xfer, 0, sizeof(req));
616 usbd_xfer_set_frame_len(xfer, 1, UFOMA_CMD_BUF_SIZE);
617 usbd_xfer_set_frames(xfer, 2);
618 usbd_transfer_submit(xfer);
623 DPRINTF("error = %s\n",
626 if (error == USB_ERR_CANCELLED) {
634 ufoma_ctrl_write_callback(struct usb_xfer *xfer, usb_error_t error)
636 struct ufoma_softc *sc = usbd_xfer_softc(xfer);
637 struct usb_device_request req;
638 struct usb_page_cache *pc;
641 switch (USB_GET_STATE(xfer)) {
642 case USB_ST_TRANSFERRED:
645 pc = usbd_xfer_get_frame(xfer, 1);
646 if (ucom_get_data(&sc->sc_ucom, pc, 0, 1, &actlen)) {
648 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
649 req.bRequest = UCDC_SEND_ENCAPSULATED_COMMAND;
650 USETW(req.wIndex, sc->sc_ctrl_iface_no);
651 USETW(req.wValue, 0);
652 USETW(req.wLength, 1);
654 pc = usbd_xfer_get_frame(xfer, 0);
655 usbd_copy_in(pc, 0, &req, sizeof(req));
657 usbd_xfer_set_frame_len(xfer, 0, sizeof(req));
658 usbd_xfer_set_frame_len(xfer, 1, 1);
659 usbd_xfer_set_frames(xfer, 2);
661 usbd_transfer_submit(xfer);
666 DPRINTF("error = %s\n", usbd_errstr(error));
668 if (error == USB_ERR_CANCELLED) {
676 ufoma_intr_callback(struct usb_xfer *xfer, usb_error_t error)
678 struct ufoma_softc *sc = usbd_xfer_softc(xfer);
679 struct usb_cdc_notification pkt;
680 struct usb_page_cache *pc;
686 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
688 switch (USB_GET_STATE(xfer)) {
689 case USB_ST_TRANSFERRED:
691 DPRINTF("too short message\n");
694 if (actlen > (int)sizeof(pkt)) {
695 DPRINTF("truncating message\n");
696 actlen = sizeof(pkt);
698 pc = usbd_xfer_get_frame(xfer, 0);
699 usbd_copy_out(pc, 0, &pkt, actlen);
703 wLen = UGETW(pkt.wLength);
707 if ((pkt.bmRequestType == UT_READ_VENDOR_INTERFACE) &&
708 (pkt.bNotification == UMCPC_REQUEST_ACKNOWLEDGE)) {
709 temp = UGETW(pkt.wValue);
710 sc->sc_currentmode = (temp >> 8);
711 if (!(temp & 0xff)) {
712 DPRINTF("Mode change failed!\n");
714 cv_signal(&sc->sc_cv);
716 if (pkt.bmRequestType != UCDC_NOTIFICATION) {
719 switch (pkt.bNotification) {
720 case UCDC_N_RESPONSE_AVAILABLE:
721 if (!(sc->sc_nobulk)) {
722 DPRINTF("Wrong serial state!\n");
725 if (sc->sc_num_msg != 0xFF) {
728 usbd_transfer_start(sc->sc_ctrl_xfer[UFOMA_CTRL_ENDPT_READ]);
731 case UCDC_N_SERIAL_STATE:
733 DPRINTF("Wrong serial state!\n");
737 * Set the serial state in ucom driver based on
738 * the bits from the notify message
741 DPRINTF("invalid notification "
742 "length, %d bytes!\n", actlen);
745 DPRINTF("notify bytes = 0x%02x, 0x%02x\n",
746 pkt.data[0], pkt.data[1]);
748 /* currently, lsr is always zero. */
752 mstatus = pkt.data[0];
754 if (mstatus & UCDC_N_SERIAL_RI) {
755 sc->sc_msr |= SER_RI;
757 if (mstatus & UCDC_N_SERIAL_DSR) {
758 sc->sc_msr |= SER_DSR;
760 if (mstatus & UCDC_N_SERIAL_DCD) {
761 sc->sc_msr |= SER_DCD;
763 ucom_status_change(&sc->sc_ucom);
772 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
773 usbd_transfer_submit(xfer);
777 if (error != USB_ERR_CANCELLED) {
778 /* try to clear stall first */
779 usbd_xfer_set_stall(xfer);
787 ufoma_bulk_write_callback(struct usb_xfer *xfer, usb_error_t error)
789 struct ufoma_softc *sc = usbd_xfer_softc(xfer);
790 struct usb_page_cache *pc;
793 switch (USB_GET_STATE(xfer)) {
795 case USB_ST_TRANSFERRED:
797 pc = usbd_xfer_get_frame(xfer, 0);
798 if (ucom_get_data(&sc->sc_ucom, pc, 0,
799 UFOMA_BULK_BUF_SIZE, &actlen)) {
800 usbd_xfer_set_frame_len(xfer, 0, actlen);
801 usbd_transfer_submit(xfer);
806 if (error != USB_ERR_CANCELLED) {
807 /* try to clear stall first */
808 usbd_xfer_set_stall(xfer);
816 ufoma_bulk_read_callback(struct usb_xfer *xfer, usb_error_t error)
818 struct ufoma_softc *sc = usbd_xfer_softc(xfer);
819 struct usb_page_cache *pc;
822 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
824 switch (USB_GET_STATE(xfer)) {
825 case USB_ST_TRANSFERRED:
826 pc = usbd_xfer_get_frame(xfer, 0);
827 ucom_put_data(&sc->sc_ucom, pc, 0, actlen);
831 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
832 usbd_transfer_submit(xfer);
836 if (error != USB_ERR_CANCELLED) {
837 /* try to clear stall first */
838 usbd_xfer_set_stall(xfer);
846 ufoma_cfg_open(struct ucom_softc *ucom)
848 struct ufoma_softc *sc = ucom->sc_parent;
850 /* empty input queue */
852 if (sc->sc_num_msg != 0xFF) {
855 if (sc->sc_currentmode == UMCPC_ACM_MODE_UNLINKED) {
856 ufoma_cfg_link_state(sc);
858 if (sc->sc_currentmode == UMCPC_ACM_MODE_DEACTIVATED) {
859 ufoma_cfg_activate_state(sc, sc->sc_modetoactivate);
864 ufoma_cfg_close(struct ucom_softc *ucom)
866 struct ufoma_softc *sc = ucom->sc_parent;
868 ufoma_cfg_activate_state(sc, UMCPC_ACM_MODE_DEACTIVATED);
872 ufoma_cfg_set_break(struct ucom_softc *ucom, uint8_t onoff)
874 struct ufoma_softc *sc = ucom->sc_parent;
875 struct usb_device_request req;
879 (sc->sc_currentmode == UMCPC_ACM_MODE_OBEX)) {
882 if (!(sc->sc_acm_cap & USB_CDC_ACM_HAS_BREAK)) {
885 wValue = onoff ? UCDC_BREAK_ON : UCDC_BREAK_OFF;
887 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
888 req.bRequest = UCDC_SEND_BREAK;
889 USETW(req.wValue, wValue);
890 req.wIndex[0] = sc->sc_ctrl_iface_no;
892 USETW(req.wLength, 0);
894 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
895 &req, NULL, 0, 1000);
899 ufoma_cfg_get_status(struct ucom_softc *ucom, uint8_t *lsr, uint8_t *msr)
901 struct ufoma_softc *sc = ucom->sc_parent;
903 /* XXX Note: sc_lsr is always zero */
909 ufoma_cfg_set_line_state(struct ufoma_softc *sc)
911 struct usb_device_request req;
913 /* Don't send line state emulation request for OBEX port */
914 if (sc->sc_currentmode == UMCPC_ACM_MODE_OBEX) {
917 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
918 req.bRequest = UCDC_SET_CONTROL_LINE_STATE;
919 USETW(req.wValue, sc->sc_line);
920 req.wIndex[0] = sc->sc_ctrl_iface_no;
922 USETW(req.wLength, 0);
924 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
925 &req, NULL, 0, 1000);
929 ufoma_cfg_set_dtr(struct ucom_softc *ucom, uint8_t onoff)
931 struct ufoma_softc *sc = ucom->sc_parent;
937 sc->sc_line |= UCDC_LINE_DTR;
939 sc->sc_line &= ~UCDC_LINE_DTR;
941 ufoma_cfg_set_line_state(sc);
945 ufoma_cfg_set_rts(struct ucom_softc *ucom, uint8_t onoff)
947 struct ufoma_softc *sc = ucom->sc_parent;
953 sc->sc_line |= UCDC_LINE_RTS;
955 sc->sc_line &= ~UCDC_LINE_RTS;
957 ufoma_cfg_set_line_state(sc);
961 ufoma_pre_param(struct ucom_softc *ucom, struct termios *t)
963 return (0); /* we accept anything */
967 ufoma_cfg_param(struct ucom_softc *ucom, struct termios *t)
969 struct ufoma_softc *sc = ucom->sc_parent;
970 struct usb_device_request req;
971 struct usb_cdc_line_state ls;
974 (sc->sc_currentmode == UMCPC_ACM_MODE_OBEX)) {
979 memset(&ls, 0, sizeof(ls));
981 USETDW(ls.dwDTERate, t->c_ospeed);
983 if (t->c_cflag & CSTOPB) {
984 ls.bCharFormat = UCDC_STOP_BIT_2;
986 ls.bCharFormat = UCDC_STOP_BIT_1;
989 if (t->c_cflag & PARENB) {
990 if (t->c_cflag & PARODD) {
991 ls.bParityType = UCDC_PARITY_ODD;
993 ls.bParityType = UCDC_PARITY_EVEN;
996 ls.bParityType = UCDC_PARITY_NONE;
999 switch (t->c_cflag & CSIZE) {
1014 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
1015 req.bRequest = UCDC_SET_LINE_CODING;
1016 USETW(req.wValue, 0);
1017 req.wIndex[0] = sc->sc_ctrl_iface_no;
1019 USETW(req.wLength, UCDC_LINE_STATE_LENGTH);
1021 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
1022 &req, &ls, 0, 1000);
1026 ufoma_modem_setup(device_t dev, struct ufoma_softc *sc,
1027 struct usb_attach_arg *uaa)
1029 struct usb_config_descriptor *cd;
1030 struct usb_cdc_acm_descriptor *acm;
1031 struct usb_cdc_cm_descriptor *cmd;
1032 struct usb_interface_descriptor *id;
1033 struct usb_interface *iface;
1037 cd = usbd_get_config_descriptor(uaa->device);
1038 id = usbd_get_interface_descriptor(uaa->iface);
1040 cmd = ufoma_get_intconf(cd, id, UDESC_CS_INTERFACE, UDESCSUB_CDC_CM);
1042 if ((cmd == NULL) ||
1043 (cmd->bLength < sizeof(*cmd))) {
1046 sc->sc_cm_cap = cmd->bmCapabilities;
1047 sc->sc_data_iface_no = cmd->bDataInterface;
1049 acm = ufoma_get_intconf(cd, id, UDESC_CS_INTERFACE, UDESCSUB_CDC_ACM);
1051 if ((acm == NULL) ||
1052 (acm->bLength < sizeof(*acm))) {
1055 sc->sc_acm_cap = acm->bmCapabilities;
1057 device_printf(dev, "data interface %d, has %sCM over data, "
1059 sc->sc_data_iface_no,
1060 sc->sc_cm_cap & USB_CDC_CM_OVER_DATA ? "" : "no ",
1061 sc->sc_acm_cap & USB_CDC_ACM_HAS_BREAK ? "" : "no ");
1063 /* get the data interface too */
1067 iface = usbd_get_iface(uaa->device, i);
1071 id = usbd_get_interface_descriptor(iface);
1073 if (id && (id->bInterfaceNumber == sc->sc_data_iface_no)) {
1074 sc->sc_data_iface_index = i;
1075 usbd_set_parent_iface(uaa->device, i, uaa->info.bIfaceIndex);
1079 device_printf(dev, "no data interface\n");
1084 error = usbd_transfer_setup(uaa->device,
1085 &sc->sc_data_iface_index, sc->sc_bulk_xfer,
1086 ufoma_bulk_config, UFOMA_BULK_ENDPT_MAX, sc, &sc->sc_mtx);
1089 device_printf(dev, "allocating BULK USB "
1090 "transfers failed\n");
1097 ufoma_start_read(struct ucom_softc *ucom)
1099 struct ufoma_softc *sc = ucom->sc_parent;
1101 /* start interrupt transfer */
1102 usbd_transfer_start(sc->sc_ctrl_xfer[UFOMA_CTRL_ENDPT_INTR]);
1104 /* start data transfer */
1105 if (sc->sc_nobulk) {
1106 usbd_transfer_start(sc->sc_ctrl_xfer[UFOMA_CTRL_ENDPT_READ]);
1108 usbd_transfer_start(sc->sc_bulk_xfer[UFOMA_BULK_ENDPT_READ]);
1113 ufoma_stop_read(struct ucom_softc *ucom)
1115 struct ufoma_softc *sc = ucom->sc_parent;
1117 /* stop interrupt transfer */
1118 usbd_transfer_stop(sc->sc_ctrl_xfer[UFOMA_CTRL_ENDPT_INTR]);
1120 /* stop data transfer */
1121 if (sc->sc_nobulk) {
1122 usbd_transfer_stop(sc->sc_ctrl_xfer[UFOMA_CTRL_ENDPT_READ]);
1124 usbd_transfer_stop(sc->sc_bulk_xfer[UFOMA_BULK_ENDPT_READ]);
1129 ufoma_start_write(struct ucom_softc *ucom)
1131 struct ufoma_softc *sc = ucom->sc_parent;
1133 if (sc->sc_nobulk) {
1134 usbd_transfer_start(sc->sc_ctrl_xfer[UFOMA_CTRL_ENDPT_WRITE]);
1136 usbd_transfer_start(sc->sc_bulk_xfer[UFOMA_BULK_ENDPT_WRITE]);
1141 ufoma_stop_write(struct ucom_softc *ucom)
1143 struct ufoma_softc *sc = ucom->sc_parent;
1145 if (sc->sc_nobulk) {
1146 usbd_transfer_stop(sc->sc_ctrl_xfer[UFOMA_CTRL_ENDPT_WRITE]);
1148 usbd_transfer_stop(sc->sc_bulk_xfer[UFOMA_BULK_ENDPT_WRITE]);
1152 static struct umcpc_modetostr_tab{
1155 }umcpc_modetostr_tab[]={
1156 {UMCPC_ACM_MODE_DEACTIVATED, "deactivated"},
1157 {UMCPC_ACM_MODE_MODEM, "modem"},
1158 {UMCPC_ACM_MODE_ATCOMMAND, "handsfree"},
1159 {UMCPC_ACM_MODE_OBEX, "obex"},
1160 {UMCPC_ACM_MODE_VENDOR1, "vendor1"},
1161 {UMCPC_ACM_MODE_VENDOR2, "vendor2"},
1162 {UMCPC_ACM_MODE_UNLINKED, "unlinked"},
1166 static char *ufoma_mode_to_str(int mode)
1169 for(i = 0 ;umcpc_modetostr_tab[i].str != NULL; i++){
1170 if(umcpc_modetostr_tab[i].mode == mode){
1171 return umcpc_modetostr_tab[i].str;
1177 static int ufoma_str_to_mode(char *str)
1180 for(i = 0 ;umcpc_modetostr_tab[i].str != NULL; i++){
1181 if(strcmp(str, umcpc_modetostr_tab[i].str)==0){
1182 return umcpc_modetostr_tab[i].mode;
1188 static int ufoma_sysctl_support(SYSCTL_HANDLER_ARGS)
1190 struct ufoma_softc *sc = (struct ufoma_softc *)oidp->oid_arg1;
1195 sbuf_new(&sb, NULL, 1, SBUF_AUTOEXTEND);
1196 for(i = 1; i < sc->sc_modetable[0]; i++){
1197 mode = ufoma_mode_to_str(sc->sc_modetable[i]);
1199 sbuf_cat(&sb, mode);
1201 sbuf_printf(&sb, "(%02x)", sc->sc_modetable[i]);
1203 if(i < (sc->sc_modetable[0]-1))
1208 sysctl_handle_string(oidp, sbuf_data(&sb), sbuf_len(&sb), req);
1213 static int ufoma_sysctl_current(SYSCTL_HANDLER_ARGS)
1215 struct ufoma_softc *sc = (struct ufoma_softc *)oidp->oid_arg1;
1217 char subbuf[]="(XXX)";
1218 mode = ufoma_mode_to_str(sc->sc_currentmode);
1221 snprintf(subbuf, sizeof(subbuf), "(%02x)", sc->sc_currentmode);
1223 sysctl_handle_string(oidp, mode, strlen(mode), req);
1228 static int ufoma_sysctl_open(SYSCTL_HANDLER_ARGS)
1230 struct ufoma_softc *sc = (struct ufoma_softc *)oidp->oid_arg1;
1237 mode = ufoma_mode_to_str(sc->sc_modetoactivate);
1239 strncpy(subbuf, mode, sizeof(subbuf));
1241 snprintf(subbuf, sizeof(subbuf), "(%02x)", sc->sc_modetoactivate);
1243 error = sysctl_handle_string(oidp, subbuf, sizeof(subbuf), req);
1244 if(error != 0 || req->newptr == NULL){
1248 if((newmode = ufoma_str_to_mode(subbuf)) == -1){
1252 for(i = 1 ; i < sc->sc_modetable[0] ; i++){
1253 if(sc->sc_modetable[i] == newmode){
1254 sc->sc_modetoactivate = newmode;
1263 ufoma_poll(struct ucom_softc *ucom)
1265 struct ufoma_softc *sc = ucom->sc_parent;
1266 usbd_transfer_poll(sc->sc_ctrl_xfer, UFOMA_CTRL_ENDPT_MAX);
1267 usbd_transfer_poll(sc->sc_bulk_xfer, UFOMA_BULK_ENDPT_MAX);