1 /* $NetBSD: umodem.c,v 1.45 2002/09/23 05:51:23 simonb Exp $ */
3 #define UFOMA_HANDSFREE
5 * Copyright (c) 2005, Takanori Watanabe
6 * Copyright (c) 2003, M. Warner Losh <imp@FreeBSD.org>.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * Copyright (c) 1998 The NetBSD Foundation, Inc.
33 * All rights reserved.
35 * This code is derived from software contributed to The NetBSD Foundation
36 * by Lennart Augustsson (lennart@augustsson.net) at
37 * Carlstedt Research & Technology.
39 * Redistribution and use in source and binary forms, with or without
40 * modification, are permitted provided that the following conditions
42 * 1. Redistributions of source code must retain the above copyright
43 * notice, this list of conditions and the following disclaimer.
44 * 2. Redistributions in binary form must reproduce the above copyright
45 * notice, this list of conditions and the following disclaimer in the
46 * documentation and/or other materials provided with the distribution.
47 * 3. All advertising materials mentioning features or use of this software
48 * must display the following acknowledgement:
49 * This product includes software developed by the NetBSD
50 * Foundation, Inc. and its contributors.
51 * 4. Neither the name of The NetBSD Foundation nor the names of its
52 * contributors may be used to endorse or promote products derived
53 * from this software without specific prior written permission.
55 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
56 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
57 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
58 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
59 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
60 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
61 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
62 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
63 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
64 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
65 * POSSIBILITY OF SUCH DAMAGE.
69 * Comm Class spec: http://www.usb.org/developers/devclass_docs/usbccs10.pdf
70 * http://www.usb.org/developers/devclass_docs/usbcdc11.pdf
75 * - Implement a Call Device for modems without multiplexed commands.
79 * NOTE: all function names beginning like "ufoma_cfg_" can only
80 * be called from within the config thread function !
83 #include <sys/stdint.h>
84 #include <sys/param.h>
85 #include <sys/queue.h>
86 #include <sys/types.h>
87 #include <sys/systm.h>
88 #include <sys/kernel.h>
90 #include <sys/module.h>
92 #include <sys/condvar.h>
93 #include <sys/sysctl.h>
94 #include <sys/unistd.h>
95 #include <sys/callout.h>
96 #include <sys/malloc.h>
100 #include <bus/u4b/usb.h>
101 #include <bus/u4b/usbdi.h>
102 #include <bus/u4b/usbdi_util.h>
103 #include <bus/u4b/usb_cdc.h>
104 #include <bus/u4b/usbdevs.h>
106 #define USB_DEBUG_VAR usb_debug
107 #include <bus/u4b/usb_debug.h>
108 #include <bus/u4b/usb_process.h>
110 #include <bus/u4b/serial/usb_serial.h>
112 typedef struct ufoma_mobile_acm_descriptor {
113 uint8_t bFunctionLength;
114 uint8_t bDescriptorType;
115 uint8_t bDescriptorSubtype;
118 } __packed usb_mcpc_acm_descriptor;
120 #define UISUBCLASS_MCPC 0x88
122 #define UDESC_VS_INTERFACE 0x44
123 #define UDESCSUB_MCPC_ACM 0x11
125 #define UMCPC_ACM_TYPE_AB1 0x1
126 #define UMCPC_ACM_TYPE_AB2 0x2
127 #define UMCPC_ACM_TYPE_AB5 0x5
128 #define UMCPC_ACM_TYPE_AB6 0x6
130 #define UMCPC_ACM_MODE_DEACTIVATED 0x0
131 #define UMCPC_ACM_MODE_MODEM 0x1
132 #define UMCPC_ACM_MODE_ATCOMMAND 0x2
133 #define UMCPC_ACM_MODE_OBEX 0x60
134 #define UMCPC_ACM_MODE_VENDOR1 0xc0
135 #define UMCPC_ACM_MODE_VENDOR2 0xfe
136 #define UMCPC_ACM_MODE_UNLINKED 0xff
138 #define UMCPC_CM_MOBILE_ACM 0x0
140 #define UMCPC_ACTIVATE_MODE 0x60
141 #define UMCPC_GET_MODETABLE 0x61
142 #define UMCPC_SET_LINK 0x62
143 #define UMCPC_CLEAR_LINK 0x63
145 #define UMCPC_REQUEST_ACKNOWLEDGE 0x31
147 #define UFOMA_MAX_TIMEOUT 15 /* standard says 10 seconds */
148 #define UFOMA_CMD_BUF_SIZE 64 /* bytes */
150 #define UFOMA_BULK_BUF_SIZE 1024 /* bytes */
153 UFOMA_CTRL_ENDPT_INTR,
154 UFOMA_CTRL_ENDPT_READ,
155 UFOMA_CTRL_ENDPT_WRITE,
156 UFOMA_CTRL_ENDPT_MAX,
160 UFOMA_BULK_ENDPT_WRITE,
161 UFOMA_BULK_ENDPT_READ,
162 UFOMA_BULK_ENDPT_MAX,
166 struct ucom_super_softc sc_super_ucom;
167 struct ucom_softc sc_ucom;
170 struct sysctl_ctx_list sc_sysctl_ctx;
171 struct sysctl_oid *sc_sysctl_tree;
173 struct usb_xfer *sc_ctrl_xfer[UFOMA_CTRL_ENDPT_MAX];
174 struct usb_xfer *sc_bulk_xfer[UFOMA_BULK_ENDPT_MAX];
175 uint8_t *sc_modetable;
177 struct usb_device *sc_udev;
185 uint8_t sc_ctrl_iface_no;
186 uint8_t sc_ctrl_iface_index;
187 uint8_t sc_data_iface_no;
188 uint8_t sc_data_iface_index;
193 uint8_t sc_modetoactivate;
194 uint8_t sc_currentmode;
200 static device_probe_t ufoma_probe;
201 static device_attach_t ufoma_attach;
202 static device_detach_t ufoma_detach;
204 static usb_callback_t ufoma_ctrl_read_callback;
205 static usb_callback_t ufoma_ctrl_write_callback;
206 static usb_callback_t ufoma_intr_callback;
207 static usb_callback_t ufoma_bulk_write_callback;
208 static usb_callback_t ufoma_bulk_read_callback;
210 static void *ufoma_get_intconf(struct usb_config_descriptor *,
211 struct usb_interface_descriptor *, uint8_t, uint8_t);
212 static void ufoma_cfg_link_state(struct ufoma_softc *);
213 static void ufoma_cfg_activate_state(struct ufoma_softc *, uint16_t);
214 static void ufoma_cfg_open(struct ucom_softc *);
215 static void ufoma_cfg_close(struct ucom_softc *);
216 static void ufoma_cfg_set_break(struct ucom_softc *, uint8_t);
217 static void ufoma_cfg_get_status(struct ucom_softc *, uint8_t *,
219 static void ufoma_cfg_set_dtr(struct ucom_softc *, uint8_t);
220 static void ufoma_cfg_set_rts(struct ucom_softc *, uint8_t);
221 static int ufoma_pre_param(struct ucom_softc *, struct termios *);
222 static void ufoma_cfg_param(struct ucom_softc *, struct termios *);
223 static int ufoma_modem_setup(device_t, struct ufoma_softc *,
224 struct usb_attach_arg *);
225 static void ufoma_start_read(struct ucom_softc *);
226 static void ufoma_stop_read(struct ucom_softc *);
227 static void ufoma_start_write(struct ucom_softc *);
228 static void ufoma_stop_write(struct ucom_softc *);
229 static void ufoma_poll(struct ucom_softc *ucom);
232 static int ufoma_sysctl_support(SYSCTL_HANDLER_ARGS);
233 static int ufoma_sysctl_current(SYSCTL_HANDLER_ARGS);
234 static int ufoma_sysctl_open(SYSCTL_HANDLER_ARGS);
236 static const struct usb_config
237 ufoma_ctrl_config[UFOMA_CTRL_ENDPT_MAX] = {
239 [UFOMA_CTRL_ENDPT_INTR] = {
240 .type = UE_INTERRUPT,
241 .endpoint = UE_ADDR_ANY,
242 .direction = UE_DIR_IN,
243 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
244 .bufsize = sizeof(struct usb_cdc_notification),
245 .callback = &ufoma_intr_callback,
248 [UFOMA_CTRL_ENDPT_READ] = {
250 .endpoint = 0x00, /* Control pipe */
251 .direction = UE_DIR_ANY,
252 .bufsize = (sizeof(struct usb_device_request) + UFOMA_CMD_BUF_SIZE),
253 .flags = {.short_xfer_ok = 1,},
254 .callback = &ufoma_ctrl_read_callback,
255 .timeout = 1000, /* 1 second */
258 [UFOMA_CTRL_ENDPT_WRITE] = {
260 .endpoint = 0x00, /* Control pipe */
261 .direction = UE_DIR_ANY,
262 .bufsize = (sizeof(struct usb_device_request) + 1),
263 .callback = &ufoma_ctrl_write_callback,
264 .timeout = 1000, /* 1 second */
268 static const struct usb_config
269 ufoma_bulk_config[UFOMA_BULK_ENDPT_MAX] = {
271 [UFOMA_BULK_ENDPT_WRITE] = {
273 .endpoint = UE_ADDR_ANY,
274 .direction = UE_DIR_OUT,
275 .bufsize = UFOMA_BULK_BUF_SIZE,
276 .flags = {.pipe_bof = 1,.force_short_xfer = 1,},
277 .callback = &ufoma_bulk_write_callback,
280 [UFOMA_BULK_ENDPT_READ] = {
282 .endpoint = UE_ADDR_ANY,
283 .direction = UE_DIR_IN,
284 .bufsize = UFOMA_BULK_BUF_SIZE,
285 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
286 .callback = &ufoma_bulk_read_callback,
290 static const struct ucom_callback ufoma_callback = {
291 .ucom_cfg_get_status = &ufoma_cfg_get_status,
292 .ucom_cfg_set_dtr = &ufoma_cfg_set_dtr,
293 .ucom_cfg_set_rts = &ufoma_cfg_set_rts,
294 .ucom_cfg_set_break = &ufoma_cfg_set_break,
295 .ucom_cfg_param = &ufoma_cfg_param,
296 .ucom_cfg_open = &ufoma_cfg_open,
297 .ucom_cfg_close = &ufoma_cfg_close,
298 .ucom_pre_param = &ufoma_pre_param,
299 .ucom_start_read = &ufoma_start_read,
300 .ucom_stop_read = &ufoma_stop_read,
301 .ucom_start_write = &ufoma_start_write,
302 .ucom_stop_write = &ufoma_stop_write,
303 .ucom_poll = &ufoma_poll,
306 static device_method_t ufoma_methods[] = {
308 DEVMETHOD(device_probe, ufoma_probe),
309 DEVMETHOD(device_attach, ufoma_attach),
310 DEVMETHOD(device_detach, ufoma_detach),
314 static devclass_t ufoma_devclass;
316 static driver_t ufoma_driver = {
318 .methods = ufoma_methods,
319 .size = sizeof(struct ufoma_softc),
322 DRIVER_MODULE(ufoma, uhub, ufoma_driver, ufoma_devclass, NULL, 0);
323 MODULE_DEPEND(ufoma, ucom, 1, 1, 1);
324 MODULE_DEPEND(ufoma, usb, 1, 1, 1);
325 MODULE_VERSION(ufoma, 1);
327 static const STRUCT_USB_HOST_ID ufoma_devs[] = {
328 {USB_IFACE_CLASS(UICLASS_CDC),
329 USB_IFACE_SUBCLASS(UISUBCLASS_MCPC),},
333 ufoma_probe(device_t dev)
335 struct usb_attach_arg *uaa = device_get_ivars(dev);
336 struct usb_interface_descriptor *id;
337 struct usb_config_descriptor *cd;
338 usb_mcpc_acm_descriptor *mad;
341 if (uaa->usb_mode != USB_MODE_HOST)
344 error = usbd_lookup_id_by_uaa(ufoma_devs, sizeof(ufoma_devs), uaa);
348 id = usbd_get_interface_descriptor(uaa->iface);
349 cd = usbd_get_config_descriptor(uaa->device);
351 if (id == NULL || cd == NULL)
354 mad = ufoma_get_intconf(cd, id, UDESC_VS_INTERFACE, UDESCSUB_MCPC_ACM);
358 #ifndef UFOMA_HANDSFREE
359 if ((mad->bType == UMCPC_ACM_TYPE_AB5) ||
360 (mad->bType == UMCPC_ACM_TYPE_AB6))
363 return (BUS_PROBE_GENERIC);
367 ufoma_attach(device_t dev)
369 struct usb_attach_arg *uaa = device_get_ivars(dev);
370 struct ufoma_softc *sc = device_get_softc(dev);
371 struct usb_config_descriptor *cd;
372 struct usb_interface_descriptor *id;
374 usb_mcpc_acm_descriptor *mad;
378 sc->sc_udev = uaa->device;
380 sc->sc_unit = device_get_unit(dev);
382 lockinit(&sc->sc_lock, "ufoma", 0, LK_CANRECURSE);
383 cv_init(&sc->sc_cv, "CWAIT");
385 device_set_usb_desc(dev);
387 ksnprintf(sc->sc_name, sizeof(sc->sc_name),
388 "%s", device_get_nameunit(dev));
392 /* setup control transfers */
394 cd = usbd_get_config_descriptor(uaa->device);
395 id = usbd_get_interface_descriptor(uaa->iface);
396 sc->sc_ctrl_iface_no = id->bInterfaceNumber;
397 sc->sc_ctrl_iface_index = uaa->info.bIfaceIndex;
399 error = usbd_transfer_setup(uaa->device,
400 &sc->sc_ctrl_iface_index, sc->sc_ctrl_xfer,
401 ufoma_ctrl_config, UFOMA_CTRL_ENDPT_MAX, sc, &sc->sc_lock);
404 device_printf(dev, "allocating control USB "
405 "transfers failed\n");
408 mad = ufoma_get_intconf(cd, id, UDESC_VS_INTERFACE, UDESCSUB_MCPC_ACM);
412 if (mad->bFunctionLength < sizeof(*mad)) {
413 device_printf(dev, "invalid MAD descriptor\n");
416 if ((mad->bType == UMCPC_ACM_TYPE_AB5) ||
417 (mad->bType == UMCPC_ACM_TYPE_AB6)) {
421 if (ufoma_modem_setup(dev, sc, uaa)) {
426 elements = (mad->bFunctionLength - sizeof(*mad) + 1);
428 /* initialize mode variables */
430 sc->sc_modetable = kmalloc(elements + 1, M_USBDEV, M_WAITOK);
432 if (sc->sc_modetable == NULL) {
435 sc->sc_modetable[0] = (elements + 1);
436 memcpy(&sc->sc_modetable[1], mad->bMode, elements);
438 sc->sc_currentmode = UMCPC_ACM_MODE_UNLINKED;
439 sc->sc_modetoactivate = mad->bMode[0];
441 /* clear stall at first run, if any */
442 lockmgr(&sc->sc_lock, LK_EXCLUSIVE);
443 usbd_xfer_set_stall(sc->sc_bulk_xfer[UFOMA_BULK_ENDPT_WRITE]);
444 usbd_xfer_set_stall(sc->sc_bulk_xfer[UFOMA_BULK_ENDPT_READ]);
445 lockmgr(&sc->sc_lock, LK_RELEASE);
447 error = ucom_attach(&sc->sc_super_ucom, &sc->sc_ucom, 1, sc,
448 &ufoma_callback, &sc->sc_lock);
450 DPRINTF("ucom_attach failed\n");
453 ucom_set_pnpinfo_usb(&sc->sc_super_ucom, dev);
456 sysctl_ctx_init(&sc->sc_sysctl_ctx);
457 sc->sc_sysctl_tree = SYSCTL_ADD_NODE(&sc->sc_sysctl_ctx,
458 SYSCTL_STATIC_CHILDREN(_hw), OID_AUTO,
459 device_get_nameunit(sc->sc_dev), CTLFLAG_RD, 0, "");
460 if (sc->sc_sysctl_tree == NULL) {
461 DPRINTF("can't add sysctl node\n");
465 SYSCTL_ADD_PROC(&sc->sc_sysctl_ctx,
466 SYSCTL_CHILDREN(sc->sc_sysctl_tree),
467 OID_AUTO, "supportmode",
468 CTLFLAG_RD|CTLTYPE_STRING, sc, 0, ufoma_sysctl_support,
469 "A", "Supporting port role");
471 SYSCTL_ADD_PROC(&sc->sc_sysctl_ctx,
472 SYSCTL_CHILDREN(sc->sc_sysctl_tree),
473 OID_AUTO, "currentmode",
474 CTLFLAG_RD|CTLTYPE_STRING, sc, 0, ufoma_sysctl_current,
475 "A", "Current port role");
477 SYSCTL_ADD_PROC(&sc->sc_sysctl_ctx,
478 SYSCTL_CHILDREN(sc->sc_sysctl_tree),
479 OID_AUTO, "openmode",
480 CTLFLAG_RW|CTLTYPE_STRING, sc, 0, ufoma_sysctl_open,
481 "A", "Mode to transit when port is opened");
482 SYSCTL_ADD_UINT(&sc->sc_sysctl_ctx,
483 SYSCTL_CHILDREN(sc->sc_sysctl_tree),
485 CTLFLAG_RD, &(sc->sc_super_ucom.sc_unit), 0,
486 "Unit number as USB serial");
488 return (0); /* success */
492 return (ENXIO); /* failure */
496 ufoma_detach(device_t dev)
498 struct ufoma_softc *sc = device_get_softc(dev);
500 ucom_detach(&sc->sc_super_ucom, &sc->sc_ucom);
501 usbd_transfer_unsetup(sc->sc_ctrl_xfer, UFOMA_CTRL_ENDPT_MAX);
502 usbd_transfer_unsetup(sc->sc_bulk_xfer, UFOMA_BULK_ENDPT_MAX);
504 if (sc->sc_modetable) {
505 kfree(sc->sc_modetable, M_USBDEV);
507 lockuninit(&sc->sc_lock);
508 cv_destroy(&sc->sc_cv);
509 sysctl_ctx_free(&sc->sc_sysctl_ctx);
515 ufoma_get_intconf(struct usb_config_descriptor *cd, struct usb_interface_descriptor *id,
516 uint8_t type, uint8_t subtype)
518 struct usb_descriptor *desc = (void *)id;
520 while ((desc = usb_desc_foreach(cd, desc))) {
522 if (desc->bDescriptorType == UDESC_INTERFACE) {
525 if ((desc->bDescriptorType == type) &&
526 (desc->bDescriptorSubtype == subtype)) {
534 ufoma_cfg_link_state(struct ufoma_softc *sc)
536 struct usb_device_request req;
539 req.bmRequestType = UT_WRITE_VENDOR_INTERFACE;
540 req.bRequest = UMCPC_SET_LINK;
541 USETW(req.wValue, UMCPC_CM_MOBILE_ACM);
542 USETW(req.wIndex, sc->sc_ctrl_iface_no);
543 USETW(req.wLength, sc->sc_modetable[0]);
545 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
546 &req, sc->sc_modetable, 0, 1000);
548 error = cv_timedwait(&sc->sc_cv, &sc->sc_lock, hz);
551 DPRINTF("NO response\n");
556 ufoma_cfg_activate_state(struct ufoma_softc *sc, uint16_t state)
558 struct usb_device_request req;
561 req.bmRequestType = UT_WRITE_VENDOR_INTERFACE;
562 req.bRequest = UMCPC_ACTIVATE_MODE;
563 USETW(req.wValue, state);
564 USETW(req.wIndex, sc->sc_ctrl_iface_no);
565 USETW(req.wLength, 0);
567 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
568 &req, NULL, 0, 1000);
570 error = cv_timedwait(&sc->sc_cv, &sc->sc_lock,
571 (UFOMA_MAX_TIMEOUT * hz));
573 DPRINTF("No response\n");
578 ufoma_ctrl_read_callback(struct usb_xfer *xfer, usb_error_t error)
580 struct ufoma_softc *sc = usbd_xfer_softc(xfer);
581 struct usb_device_request req;
582 struct usb_page_cache *pc0, *pc1;
583 int len, aframes, nframes;
585 usbd_xfer_status(xfer, NULL, NULL, &aframes, &nframes);
587 switch (USB_GET_STATE(xfer)) {
588 case USB_ST_TRANSFERRED:
590 if (aframes != nframes)
592 pc1 = usbd_xfer_get_frame(xfer, 1);
593 len = usbd_xfer_frame_len(xfer, 1);
595 ucom_put_data(&sc->sc_ucom, pc1, 0, len);
599 if (sc->sc_num_msg) {
602 req.bmRequestType = UT_READ_CLASS_INTERFACE;
603 req.bRequest = UCDC_GET_ENCAPSULATED_RESPONSE;
604 USETW(req.wIndex, sc->sc_ctrl_iface_no);
605 USETW(req.wValue, 0);
606 USETW(req.wLength, UFOMA_CMD_BUF_SIZE);
608 pc0 = usbd_xfer_get_frame(xfer, 0);
609 usbd_copy_in(pc0, 0, &req, sizeof(req));
611 usbd_xfer_set_frame_len(xfer, 0, sizeof(req));
612 usbd_xfer_set_frame_len(xfer, 1, UFOMA_CMD_BUF_SIZE);
613 usbd_xfer_set_frames(xfer, 2);
614 usbd_transfer_submit(xfer);
619 DPRINTF("error = %s\n",
622 if (error == USB_ERR_CANCELLED) {
633 ufoma_ctrl_write_callback(struct usb_xfer *xfer, usb_error_t error)
635 struct ufoma_softc *sc = usbd_xfer_softc(xfer);
636 struct usb_device_request req;
637 struct usb_page_cache *pc;
640 switch (USB_GET_STATE(xfer)) {
641 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) {
679 ufoma_intr_callback(struct usb_xfer *xfer, usb_error_t error)
681 struct ufoma_softc *sc = usbd_xfer_softc(xfer);
682 struct usb_cdc_notification pkt;
683 struct usb_page_cache *pc;
689 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
691 switch (USB_GET_STATE(xfer)) {
692 case USB_ST_TRANSFERRED:
694 DPRINTF("too short message\n");
697 if (actlen > sizeof(pkt)) {
698 DPRINTF("truncating message\n");
699 actlen = sizeof(pkt);
701 pc = usbd_xfer_get_frame(xfer, 0);
702 usbd_copy_out(pc, 0, &pkt, actlen);
706 wLen = UGETW(pkt.wLength);
710 if ((pkt.bmRequestType == UT_READ_VENDOR_INTERFACE) &&
711 (pkt.bNotification == UMCPC_REQUEST_ACKNOWLEDGE)) {
712 temp = UGETW(pkt.wValue);
713 sc->sc_currentmode = (temp >> 8);
714 if (!(temp & 0xff)) {
715 DPRINTF("Mode change failed!\n");
717 cv_signal(&sc->sc_cv);
719 if (pkt.bmRequestType != UCDC_NOTIFICATION) {
722 switch (pkt.bNotification) {
723 case UCDC_N_RESPONSE_AVAILABLE:
724 if (!(sc->sc_nobulk)) {
725 DPRINTF("Wrong serial state!\n");
728 if (sc->sc_num_msg != 0xFF) {
731 usbd_transfer_start(sc->sc_ctrl_xfer[UFOMA_CTRL_ENDPT_READ]);
734 case UCDC_N_SERIAL_STATE:
736 DPRINTF("Wrong serial state!\n");
740 * Set the serial state in ucom driver based on
741 * the bits from the notify message
744 DPRINTF("invalid notification "
745 "length, %d bytes!\n", actlen);
748 DPRINTF("notify bytes = 0x%02x, 0x%02x\n",
749 pkt.data[0], pkt.data[1]);
751 /* currently, lsr is always zero. */
755 mstatus = pkt.data[0];
757 if (mstatus & UCDC_N_SERIAL_RI) {
758 sc->sc_msr |= SER_RI;
760 if (mstatus & UCDC_N_SERIAL_DSR) {
761 sc->sc_msr |= SER_DSR;
763 if (mstatus & UCDC_N_SERIAL_DCD) {
764 sc->sc_msr |= SER_DCD;
766 ucom_status_change(&sc->sc_ucom);
775 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
776 usbd_transfer_submit(xfer);
780 if (error != USB_ERR_CANCELLED) {
781 /* try to clear stall first */
782 usbd_xfer_set_stall(xfer);
790 ufoma_bulk_write_callback(struct usb_xfer *xfer, usb_error_t error)
792 struct ufoma_softc *sc = usbd_xfer_softc(xfer);
793 struct usb_page_cache *pc;
796 switch (USB_GET_STATE(xfer)) {
798 case USB_ST_TRANSFERRED:
800 pc = usbd_xfer_get_frame(xfer, 0);
801 if (ucom_get_data(&sc->sc_ucom, pc, 0,
802 UFOMA_BULK_BUF_SIZE, &actlen)) {
803 usbd_xfer_set_frame_len(xfer, 0, actlen);
804 usbd_transfer_submit(xfer);
809 if (error != USB_ERR_CANCELLED) {
810 /* try to clear stall first */
811 usbd_xfer_set_stall(xfer);
819 ufoma_bulk_read_callback(struct usb_xfer *xfer, usb_error_t error)
821 struct ufoma_softc *sc = usbd_xfer_softc(xfer);
822 struct usb_page_cache *pc;
825 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
827 switch (USB_GET_STATE(xfer)) {
828 case USB_ST_TRANSFERRED:
829 pc = usbd_xfer_get_frame(xfer, 0);
830 ucom_put_data(&sc->sc_ucom, pc, 0, actlen);
834 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
835 usbd_transfer_submit(xfer);
839 if (error != USB_ERR_CANCELLED) {
840 /* try to clear stall first */
841 usbd_xfer_set_stall(xfer);
849 ufoma_cfg_open(struct ucom_softc *ucom)
851 struct ufoma_softc *sc = ucom->sc_parent;
853 /* empty input queue */
855 if (sc->sc_num_msg != 0xFF) {
858 if (sc->sc_currentmode == UMCPC_ACM_MODE_UNLINKED) {
859 ufoma_cfg_link_state(sc);
861 if (sc->sc_currentmode == UMCPC_ACM_MODE_DEACTIVATED) {
862 ufoma_cfg_activate_state(sc, sc->sc_modetoactivate);
867 ufoma_cfg_close(struct ucom_softc *ucom)
869 struct ufoma_softc *sc = ucom->sc_parent;
871 ufoma_cfg_activate_state(sc, UMCPC_ACM_MODE_DEACTIVATED);
875 ufoma_cfg_set_break(struct ucom_softc *ucom, uint8_t onoff)
877 struct ufoma_softc *sc = ucom->sc_parent;
878 struct usb_device_request req;
882 (sc->sc_currentmode == UMCPC_ACM_MODE_OBEX)) {
885 if (!(sc->sc_acm_cap & USB_CDC_ACM_HAS_BREAK)) {
888 wValue = onoff ? UCDC_BREAK_ON : UCDC_BREAK_OFF;
890 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
891 req.bRequest = UCDC_SEND_BREAK;
892 USETW(req.wValue, wValue);
893 req.wIndex[0] = sc->sc_ctrl_iface_no;
895 USETW(req.wLength, 0);
897 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
898 &req, NULL, 0, 1000);
902 ufoma_cfg_get_status(struct ucom_softc *ucom, uint8_t *lsr, uint8_t *msr)
904 struct ufoma_softc *sc = ucom->sc_parent;
911 ufoma_cfg_set_line_state(struct ufoma_softc *sc)
913 struct usb_device_request req;
915 /* Don't send line state emulation request for OBEX port */
916 if (sc->sc_currentmode == UMCPC_ACM_MODE_OBEX) {
919 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
920 req.bRequest = UCDC_SET_CONTROL_LINE_STATE;
921 USETW(req.wValue, sc->sc_line);
922 req.wIndex[0] = sc->sc_ctrl_iface_no;
924 USETW(req.wLength, 0);
926 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
927 &req, NULL, 0, 1000);
931 ufoma_cfg_set_dtr(struct ucom_softc *ucom, uint8_t onoff)
933 struct ufoma_softc *sc = ucom->sc_parent;
939 sc->sc_line |= UCDC_LINE_DTR;
941 sc->sc_line &= ~UCDC_LINE_DTR;
943 ufoma_cfg_set_line_state(sc);
947 ufoma_cfg_set_rts(struct ucom_softc *ucom, uint8_t onoff)
949 struct ufoma_softc *sc = ucom->sc_parent;
955 sc->sc_line |= UCDC_LINE_RTS;
957 sc->sc_line &= ~UCDC_LINE_RTS;
959 ufoma_cfg_set_line_state(sc);
963 ufoma_pre_param(struct ucom_softc *ucom, struct termios *t)
965 return (0); /* we accept anything */
969 ufoma_cfg_param(struct ucom_softc *ucom, struct termios *t)
971 struct ufoma_softc *sc = ucom->sc_parent;
972 struct usb_device_request req;
973 struct usb_cdc_line_state ls;
976 (sc->sc_currentmode == UMCPC_ACM_MODE_OBEX)) {
981 memset(&ls, 0, sizeof(ls));
983 USETDW(ls.dwDTERate, t->c_ospeed);
985 if (t->c_cflag & CSTOPB) {
986 ls.bCharFormat = UCDC_STOP_BIT_2;
988 ls.bCharFormat = UCDC_STOP_BIT_1;
991 if (t->c_cflag & PARENB) {
992 if (t->c_cflag & PARODD) {
993 ls.bParityType = UCDC_PARITY_ODD;
995 ls.bParityType = UCDC_PARITY_EVEN;
998 ls.bParityType = UCDC_PARITY_NONE;
1001 switch (t->c_cflag & CSIZE) {
1016 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
1017 req.bRequest = UCDC_SET_LINE_CODING;
1018 USETW(req.wValue, 0);
1019 req.wIndex[0] = sc->sc_ctrl_iface_no;
1021 USETW(req.wLength, UCDC_LINE_STATE_LENGTH);
1023 ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
1024 &req, &ls, 0, 1000);
1028 ufoma_modem_setup(device_t dev, struct ufoma_softc *sc,
1029 struct usb_attach_arg *uaa)
1031 struct usb_config_descriptor *cd;
1032 struct usb_cdc_acm_descriptor *acm;
1033 struct usb_cdc_cm_descriptor *cmd;
1034 struct usb_interface_descriptor *id;
1035 struct usb_interface *iface;
1039 cd = usbd_get_config_descriptor(uaa->device);
1040 id = usbd_get_interface_descriptor(uaa->iface);
1042 cmd = ufoma_get_intconf(cd, id, UDESC_CS_INTERFACE, UDESCSUB_CDC_CM);
1044 if ((cmd == NULL) ||
1045 (cmd->bLength < sizeof(*cmd))) {
1048 sc->sc_cm_cap = cmd->bmCapabilities;
1049 sc->sc_data_iface_no = cmd->bDataInterface;
1051 acm = ufoma_get_intconf(cd, id, UDESC_CS_INTERFACE, UDESCSUB_CDC_ACM);
1053 if ((acm == NULL) ||
1054 (acm->bLength < sizeof(*acm))) {
1057 sc->sc_acm_cap = acm->bmCapabilities;
1059 device_printf(dev, "data interface %d, has %sCM over data, "
1061 sc->sc_data_iface_no,
1062 sc->sc_cm_cap & USB_CDC_CM_OVER_DATA ? "" : "no ",
1063 sc->sc_acm_cap & USB_CDC_ACM_HAS_BREAK ? "" : "no ");
1065 /* get the data interface too */
1069 iface = usbd_get_iface(uaa->device, i);
1073 id = usbd_get_interface_descriptor(iface);
1075 if (id && (id->bInterfaceNumber == sc->sc_data_iface_no)) {
1076 sc->sc_data_iface_index = i;
1077 usbd_set_parent_iface(uaa->device, i, uaa->info.bIfaceIndex);
1081 device_printf(dev, "no data interface\n");
1086 error = usbd_transfer_setup(uaa->device,
1087 &sc->sc_data_iface_index, sc->sc_bulk_xfer,
1088 ufoma_bulk_config, UFOMA_BULK_ENDPT_MAX, sc, &sc->sc_lock);
1091 device_printf(dev, "allocating BULK USB "
1092 "transfers failed\n");
1099 ufoma_start_read(struct ucom_softc *ucom)
1101 struct ufoma_softc *sc = ucom->sc_parent;
1103 /* start interrupt transfer */
1104 usbd_transfer_start(sc->sc_ctrl_xfer[UFOMA_CTRL_ENDPT_INTR]);
1106 /* start data transfer */
1107 if (sc->sc_nobulk) {
1108 usbd_transfer_start(sc->sc_ctrl_xfer[UFOMA_CTRL_ENDPT_READ]);
1110 usbd_transfer_start(sc->sc_bulk_xfer[UFOMA_BULK_ENDPT_READ]);
1115 ufoma_stop_read(struct ucom_softc *ucom)
1117 struct ufoma_softc *sc = ucom->sc_parent;
1119 /* stop interrupt transfer */
1120 usbd_transfer_stop(sc->sc_ctrl_xfer[UFOMA_CTRL_ENDPT_INTR]);
1122 /* stop data transfer */
1123 if (sc->sc_nobulk) {
1124 usbd_transfer_stop(sc->sc_ctrl_xfer[UFOMA_CTRL_ENDPT_READ]);
1126 usbd_transfer_stop(sc->sc_bulk_xfer[UFOMA_BULK_ENDPT_READ]);
1131 ufoma_start_write(struct ucom_softc *ucom)
1133 struct ufoma_softc *sc = ucom->sc_parent;
1135 if (sc->sc_nobulk) {
1136 usbd_transfer_start(sc->sc_ctrl_xfer[UFOMA_CTRL_ENDPT_WRITE]);
1138 usbd_transfer_start(sc->sc_bulk_xfer[UFOMA_BULK_ENDPT_WRITE]);
1143 ufoma_stop_write(struct ucom_softc *ucom)
1145 struct ufoma_softc *sc = ucom->sc_parent;
1147 if (sc->sc_nobulk) {
1148 usbd_transfer_stop(sc->sc_ctrl_xfer[UFOMA_CTRL_ENDPT_WRITE]);
1150 usbd_transfer_stop(sc->sc_bulk_xfer[UFOMA_BULK_ENDPT_WRITE]);
1154 static struct umcpc_modetostr_tab{
1157 }umcpc_modetostr_tab[]={
1158 {UMCPC_ACM_MODE_DEACTIVATED, "deactivated"},
1159 {UMCPC_ACM_MODE_MODEM, "modem"},
1160 {UMCPC_ACM_MODE_ATCOMMAND, "handsfree"},
1161 {UMCPC_ACM_MODE_OBEX, "obex"},
1162 {UMCPC_ACM_MODE_VENDOR1, "vendor1"},
1163 {UMCPC_ACM_MODE_VENDOR2, "vendor2"},
1164 {UMCPC_ACM_MODE_UNLINKED, "unlinked"},
1168 static char *ufoma_mode_to_str(int mode)
1171 for(i = 0 ;umcpc_modetostr_tab[i].str != NULL; i++){
1172 if(umcpc_modetostr_tab[i].mode == mode){
1173 return umcpc_modetostr_tab[i].str;
1179 static int ufoma_str_to_mode(char *str)
1182 for(i = 0 ;umcpc_modetostr_tab[i].str != NULL; i++){
1183 if(strcmp(str, umcpc_modetostr_tab[i].str)==0){
1184 return umcpc_modetostr_tab[i].mode;
1190 static int ufoma_sysctl_support(SYSCTL_HANDLER_ARGS)
1192 struct ufoma_softc *sc = (struct ufoma_softc *)oidp->oid_arg1;
1197 sbuf_new(&sb, NULL, 1, SBUF_AUTOEXTEND);
1198 for(i = 1; i < sc->sc_modetable[0]; i++){
1199 mode = ufoma_mode_to_str(sc->sc_modetable[i]);
1201 sbuf_cat(&sb, mode);
1203 sbuf_printf(&sb, "(%02x)", sc->sc_modetable[i]);
1205 if(i < (sc->sc_modetable[0]-1))
1210 sysctl_handle_string(oidp, sbuf_data(&sb), sbuf_len(&sb), req);
1215 static int ufoma_sysctl_current(SYSCTL_HANDLER_ARGS)
1217 struct ufoma_softc *sc = (struct ufoma_softc *)oidp->oid_arg1;
1219 char subbuf[]="(XXX)";
1220 mode = ufoma_mode_to_str(sc->sc_currentmode);
1223 ksnprintf(subbuf, sizeof(subbuf), "(%02x)", sc->sc_currentmode);
1225 sysctl_handle_string(oidp, mode, strlen(mode), req);
1230 static int ufoma_sysctl_open(SYSCTL_HANDLER_ARGS)
1232 struct ufoma_softc *sc = (struct ufoma_softc *)oidp->oid_arg1;
1239 mode = ufoma_mode_to_str(sc->sc_modetoactivate);
1241 strncpy(subbuf, mode, sizeof(subbuf));
1243 ksnprintf(subbuf, sizeof(subbuf), "(%02x)", sc->sc_modetoactivate);
1245 error = sysctl_handle_string(oidp, subbuf, sizeof(subbuf), req);
1246 if(error != 0 || req->newptr == NULL){
1250 if((newmode = ufoma_str_to_mode(subbuf)) == -1){
1254 for(i = 1 ; i < sc->sc_modetable[0] ; i++){
1255 if(sc->sc_modetable[i] == newmode){
1256 sc->sc_modetoactivate = newmode;
1265 ufoma_poll(struct ucom_softc *ucom)
1267 struct ufoma_softc *sc = ucom->sc_parent;
1268 usbd_transfer_poll(sc->sc_ctrl_xfer, UFOMA_CTRL_ENDPT_MAX);
1269 usbd_transfer_poll(sc->sc_bulk_xfer, UFOMA_BULK_ENDPT_MAX);