u3g.c revision 1.10
1 /* $NetBSD: u3g.c,v 1.10 2010/02/08 20:45:43 snj Exp $ */ 2 3 /*- 4 * Copyright (c) 2009 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 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. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 19 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 20 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 21 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 22 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 28 * POSSIBILITY OF SUCH DAMAGE. 29 */ 30 31 /* 32 * Copyright (c) 2008 AnyWi Technologies 33 * Author: Andrea Guzzo <aguzzo (at) anywi.com> 34 * * based on uark.c 1.1 2006/08/14 08:30:22 jsg * 35 * * parts from ubsa.c 183348 2008-09-25 12:00:56Z phk * 36 * 37 * Permission to use, copy, modify, and distribute this software for any 38 * purpose with or without fee is hereby granted, provided that the above 39 * copyright notice and this permission notice appear in all copies. 40 * 41 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 42 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 43 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 44 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 45 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 46 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 47 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 48 * 49 * $FreeBSD$ 50 */ 51 52 #include <sys/cdefs.h> 53 __KERNEL_RCSID(0, "$NetBSD: u3g.c,v 1.10 2010/02/08 20:45:43 snj Exp $"); 54 55 #include <sys/param.h> 56 #include <sys/systm.h> 57 #include <sys/kernel.h> 58 #include <sys/malloc.h> 59 #include <sys/bus.h> 60 #include <sys/conf.h> 61 #include <sys/tty.h> 62 63 #include <dev/usb/usb.h> 64 #include <dev/usb/usbdi.h> 65 #include <dev/usb/usbdivar.h> 66 #include <dev/usb/usbdi_util.h> 67 68 #include <dev/usb/ucomvar.h> 69 70 #include "usbdevs.h" 71 72 /* 73 * We read/write data from/to the device in 4KB chunks to maximise 74 * performance. 75 */ 76 #define U3G_BUFF_SIZE 4096 77 78 /* 79 * Some 3G devices (the Huawei E160/E220 springs to mind here) buffer up 80 * data internally even when the USB pipes are closed. So on first open, 81 * we can receive a large chunk of stale data. 82 * 83 * This causes a real problem because the default TTYDEF_LFLAG (applied 84 * on first open) has the ECHO flag set, resulting in all the stale data 85 * being echoed straight back to the device by the tty(4) layer. Some 86 * devices (again, the Huawei E160/E220 for example) react to this spew 87 * by going catatonic. 88 * 89 * All this happens before the application gets a chance to disable ECHO. 90 * 91 * We work around this by ignoring all data received from the device for 92 * a period of two seconds, or until the application starts sending data - 93 * whichever comes first. 94 */ 95 #define U3G_PURGE_SECS 2 96 97 /* 98 * Define bits for the virtual modem control pins. 99 * The input pin states are reported via the interrupt pipe on some devices. 100 */ 101 #define U3G_OUTPIN_DTR (1u << 0) 102 #define U3G_OUTPIN_RTS (1u << 1) 103 #define U3G_INPIN_DCD (1u << 0) 104 #define U3G_INPIN_DSR (1u << 1) 105 #define U3G_INPIN_RI (1u << 3) 106 107 /* 108 * USB request to set the output pin status 109 */ 110 #define U3G_SET_PIN 0x22 111 112 struct u3g_softc { 113 device_t sc_dev; 114 usbd_device_handle sc_udev; 115 bool sc_dying; /* We're going away */ 116 117 device_t sc_ucom; /* Child ucom(4) handle */ 118 int sc_ifaceno; /* Device interface number */ 119 120 bool sc_open; /* Device is in use */ 121 bool sc_purging; /* Purging stale data */ 122 struct timeval sc_purge_start; /* Control duration of purge */ 123 124 u_char sc_msr; /* Emulated 'msr' */ 125 uint16_t sc_outpins; /* Output pin state */ 126 127 usbd_pipe_handle sc_intr_pipe; /* Interrupt pipe */ 128 u_char *sc_intr_buff; /* Interrupt buffer */ 129 }; 130 131 /* 132 * The device driver has two personalities. The first uses the 'usbdevif' 133 * interface attribute so that a match will claim the entire USB device 134 * for itself. This is used for when a device needs to be mode-switched 135 * and ensures any other interfaces present cannot be claimed by other 136 * drivers while the mode-switch is in progress. 137 * 138 * The second personality uses the 'usbifif' interface attribute so that 139 * it can claim the 3G modem interfaces for itself, leaving others (such 140 * as the mass storage interfaces on some devices) for other drivers. 141 */ 142 static int u3ginit_match(device_t, cfdata_t, void *); 143 static void u3ginit_attach(device_t, device_t, void *); 144 static int u3ginit_detach(device_t, int); 145 146 CFATTACH_DECL2_NEW(u3ginit, 0, u3ginit_match, 147 u3ginit_attach, u3ginit_detach, NULL, NULL, NULL); 148 149 150 static int u3g_match(device_t, cfdata_t, void *); 151 static void u3g_attach(device_t, device_t, void *); 152 static int u3g_detach(device_t, int); 153 static int u3g_activate(device_t, enum devact); 154 static void u3g_childdet(device_t, device_t); 155 156 CFATTACH_DECL2_NEW(u3g, sizeof(struct u3g_softc), u3g_match, 157 u3g_attach, u3g_detach, u3g_activate, NULL, u3g_childdet); 158 159 160 static void u3g_intr(usbd_xfer_handle, usbd_private_handle, usbd_status); 161 static void u3g_get_status(void *, int, u_char *, u_char *); 162 static void u3g_set(void *, int, int, int); 163 static int u3g_open(void *, int); 164 static void u3g_close(void *, int); 165 static void u3g_read(void *, int, u_char **, uint32_t *); 166 static void u3g_write(void *, int, u_char *, u_char *, u_int32_t *); 167 168 struct ucom_methods u3g_methods = { 169 u3g_get_status, 170 u3g_set, 171 NULL, 172 NULL, 173 u3g_open, 174 u3g_close, 175 u3g_read, 176 u3g_write, 177 }; 178 179 /* 180 * Allegedly supported devices 181 */ 182 static const struct usb_devno u3g_devs[] = { 183 /* OEM: Option N.V. */ 184 { USB_VENDOR_OPTIONNV, USB_PRODUCT_OPTIONNV_QUADPLUSUMTS }, 185 { USB_VENDOR_OPTIONNV, USB_PRODUCT_OPTIONNV_HSDPA }, 186 { USB_VENDOR_OPTIONNV, USB_PRODUCT_OPTIONNV_GTMAXHSUPA }, 187 /* OEM: Qualcomm, Inc. */ 188 { USB_VENDOR_QUALCOMMINC, USB_PRODUCT_QUALCOMMINC_CDMA_MSM }, 189 { USB_VENDOR_QUALCOMMINC, USB_PRODUCT_QUALCOMMINC_ZTE_MF626 }, 190 /* OEM: Huawei */ 191 { USB_VENDOR_HUAWEI, USB_PRODUCT_HUAWEI_MOBILE }, 192 { USB_VENDOR_HUAWEI, USB_PRODUCT_HUAWEI_E220 }, 193 /* OEM: Novatel */ 194 { USB_VENDOR_NOVATEL2, USB_PRODUCT_NOVATEL2_MERLINV620 }, 195 { USB_VENDOR_NOVATEL2, USB_PRODUCT_NOVATEL2_ES620 }, 196 { USB_VENDOR_NOVATEL2, USB_PRODUCT_NOVATEL2_MC950D }, 197 { USB_VENDOR_NOVATEL2, USB_PRODUCT_NOVATEL2_U720 }, 198 { USB_VENDOR_NOVATEL2, USB_PRODUCT_NOVATEL2_U727 }, 199 { USB_VENDOR_NOVATEL2, USB_PRODUCT_NOVATEL2_MERLINU740 }, 200 { USB_VENDOR_NOVATEL2, USB_PRODUCT_NOVATEL2_U740_2 }, 201 { USB_VENDOR_NOVATEL2, USB_PRODUCT_NOVATEL2_U870 }, 202 { USB_VENDOR_NOVATEL2, USB_PRODUCT_NOVATEL2_MERLINV620 }, 203 { USB_VENDOR_NOVATEL2, USB_PRODUCT_NOVATEL2_S720 }, 204 { USB_VENDOR_NOVATEL2, USB_PRODUCT_NOVATEL2_V740 }, 205 { USB_VENDOR_NOVATEL2, USB_PRODUCT_NOVATEL2_X950D }, 206 { USB_VENDOR_NOVATEL2, USB_PRODUCT_NOVATEL2_XU870 }, 207 { USB_VENDOR_DELL, USB_PRODUCT_DELL_W5500 }, 208 #if 0 209 { USB_VENDOR_NOVATEL2, USB_PRODUCT_NOVATEL2_MC950D_DRIVER }, 210 #endif 211 /* OEM: Merlin */ 212 { USB_VENDOR_MERLIN, USB_PRODUCT_MERLIN_V620 }, 213 214 /* OEM: Sierra Wireless: */ 215 { USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AIRCARD580 }, 216 { USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AIRCARD595 }, 217 { USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AC595U }, 218 { USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AC597E }, 219 { USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_C597 }, 220 { USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AC880 }, 221 { USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AC880E }, 222 { USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AC880U }, 223 { USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AC881 }, 224 { USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AC881E }, 225 { USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AC881U }, 226 { USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_EM5625 }, 227 { USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC5720 }, 228 { USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC5720_2 }, 229 { USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC5725 }, 230 { USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MINI5725 }, 231 { USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AIRCARD875 }, 232 { USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC8755 }, 233 { USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC8755_2 }, 234 { USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC8755_3 }, 235 { USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC8765 }, 236 { USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_AC875U }, 237 { USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC8775_2 }, 238 { USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC8780 }, 239 { USB_VENDOR_SIERRA, USB_PRODUCT_SIERRA_MC8781 }, 240 }; 241 242 static int 243 u3g_novatel_reinit(usbd_device_handle dev) 244 { 245 unsigned char cmd[31]; 246 usbd_interface_handle iface; 247 usb_interface_descriptor_t *id; 248 usb_endpoint_descriptor_t *ed; 249 usbd_pipe_handle pipe; 250 usbd_xfer_handle xfer; 251 int err, i; 252 253 memset(cmd, 0, sizeof(cmd)); 254 /* Byte 0..3: Command Block Wrapper (CBW) signature */ 255 cmd[0] = 0x55; 256 cmd[1] = 0x53; 257 cmd[2] = 0x42; 258 cmd[3] = 0x43; 259 /* 4..7: CBW Tag, has to unique, but only a single transfer used. */ 260 cmd[4] = 0x01; 261 /* 8..11: CBW Transfer Length, no data here */ 262 /* 12: CBW Flag: output, so 0 */ 263 /* 13: CBW Lun: 0 */ 264 /* 14: CBW Length */ 265 cmd[14] = 0x06; 266 /* Rest is the SCSI payload */ 267 /* 0: SCSI START/STOP opcode */ 268 cmd[15] = 0x1b; 269 /* 1..3 unused */ 270 /* 4 Load/Eject command */ 271 cmd[19] = 0x02; 272 /* 5: unused */ 273 274 275 /* Move the device into the configured state. */ 276 err = usbd_set_config_index(dev, 0, 0); 277 if (err) { 278 aprint_error("u3g: failed to set configuration index\n"); 279 return UMATCH_NONE; 280 } 281 282 err = usbd_device2interface_handle(dev, 0, &iface); 283 if (err != 0) { 284 aprint_error("u3g: failed to get interface\n"); 285 return UMATCH_NONE; 286 } 287 288 id = usbd_get_interface_descriptor(iface); 289 ed = NULL; 290 for (i = 0 ; i < id->bNumEndpoints ; i++) { 291 ed = usbd_interface2endpoint_descriptor(iface, i); 292 if (ed == NULL) 293 continue; 294 if (UE_GET_DIR(ed->bEndpointAddress) != UE_DIR_OUT) 295 continue; 296 if ((ed->bmAttributes & UE_XFERTYPE) == UE_BULK) 297 break; 298 } 299 300 if (i == id->bNumEndpoints) 301 return UMATCH_NONE; 302 303 err = usbd_open_pipe(iface, ed->bEndpointAddress, USBD_EXCLUSIVE_USE, 304 &pipe); 305 if (err != 0) { 306 aprint_error("u3g: failed to open bulk transfer pipe %d\n", 307 ed->bEndpointAddress); 308 return UMATCH_NONE; 309 } 310 311 xfer = usbd_alloc_xfer(dev); 312 if (xfer != NULL) { 313 usbd_setup_xfer(xfer, pipe, NULL, cmd, sizeof(cmd), 314 USBD_SYNCHRONOUS, USBD_DEFAULT_TIMEOUT, NULL); 315 316 err = usbd_transfer(xfer); 317 if (err) 318 aprint_error("u3g: transfer failed\n"); 319 usbd_free_xfer(xfer); 320 } else { 321 aprint_error("u3g: failed to allocate xfer\n"); 322 err = USBD_NOMEM; 323 } 324 325 usbd_abort_pipe(pipe); 326 usbd_close_pipe(pipe); 327 328 return (err == USBD_NORMAL_COMPLETION ? UMATCH_HIGHEST : UMATCH_NONE); 329 } 330 331 static int 332 u3g_huawei_reinit(usbd_device_handle dev) 333 { 334 /* 335 * The Huawei device presents itself as a umass device with Windows 336 * drivers on it. After installation of the driver, it reinits into a 337 * 3G serial device. 338 */ 339 usb_device_request_t req; 340 usb_config_descriptor_t *cdesc; 341 342 /* Get the config descriptor */ 343 cdesc = usbd_get_config_descriptor(dev); 344 if (cdesc == NULL) { 345 usb_device_descriptor_t dd; 346 347 if (usbd_get_device_desc(dev, &dd) != 0) 348 return (UMATCH_NONE); 349 350 if (dd.bNumConfigurations != 1) 351 return (UMATCH_NONE); 352 353 if (usbd_set_config_index(dev, 0, 1) != 0) 354 return (UMATCH_NONE); 355 356 cdesc = usbd_get_config_descriptor(dev); 357 358 if (cdesc == NULL) 359 return (UMATCH_NONE); 360 } 361 362 /* 363 * One iface means umass mode, more than 1 (4 usually) means 3G mode. 364 * 365 * XXX: We should check the first interface's device class just to be 366 * sure. If it's a mass storage device, then we can be fairly certain 367 * it needs a mode-switch. 368 */ 369 if (cdesc->bNumInterface > 1) 370 return (UMATCH_NONE); 371 372 req.bmRequestType = UT_WRITE_DEVICE; 373 req.bRequest = UR_SET_FEATURE; 374 USETW(req.wValue, UF_DEVICE_REMOTE_WAKEUP); 375 USETW(req.wIndex, UHF_PORT_SUSPEND); 376 USETW(req.wLength, 0); 377 378 (void) usbd_do_request(dev, &req, 0); 379 380 return (UMATCH_HIGHEST); /* Match to prevent umass from attaching */ 381 } 382 383 static int 384 u3g_sierra_reinit(usbd_device_handle dev) 385 { 386 /* Some Sierra devices presents themselves as a umass device with 387 * Windows drivers on it. After installation of the driver, it 388 * reinits into a * 3G serial device. 389 */ 390 usb_device_request_t req; 391 392 req.bmRequestType = UT_VENDOR; 393 req.bRequest = UR_SET_INTERFACE; 394 USETW(req.wValue, UF_DEVICE_REMOTE_WAKEUP); 395 USETW(req.wIndex, UHF_PORT_CONNECTION); 396 USETW(req.wLength, 0); 397 398 (void) usbd_do_request(dev, &req, 0); 399 400 return (UMATCH_HIGHEST); /* Match to prevent umass from attaching */ 401 } 402 403 404 /* 405 * First personality: 406 * 407 * Claim the entire device if a mode-switch is required. 408 */ 409 410 static int 411 u3ginit_match(device_t parent, cfdata_t match, void *aux) 412 { 413 struct usb_attach_arg *uaa = aux; 414 415 if (uaa->vendor == USB_VENDOR_HUAWEI) 416 return u3g_huawei_reinit(uaa->device); 417 418 if (uaa->vendor == USB_VENDOR_NOVATEL2 && 419 uaa->product == USB_PRODUCT_NOVATEL2_MC950D_DRIVER) 420 return u3g_novatel_reinit(uaa->device); 421 422 if (uaa->vendor == USB_VENDOR_SIERRA && 423 uaa->product == USB_PRODUCT_SIERRA_INSTALLER) 424 return u3g_sierra_reinit(uaa->device); 425 426 return UMATCH_NONE; 427 } 428 429 static void 430 u3ginit_attach(device_t parent, device_t self, void *aux) 431 { 432 struct usb_attach_arg *uaa = aux; 433 434 aprint_naive("\n"); 435 aprint_normal(": Switching to 3G mode\n"); 436 437 if (uaa->vendor == USB_VENDOR_NOVATEL2 && 438 uaa->product == USB_PRODUCT_NOVATEL2_MC950D_DRIVER) { 439 /* About to disappear... */ 440 return; 441 } 442 443 /* Move the device into the configured state. */ 444 (void) usbd_set_config_index(uaa->device, 0, 1); 445 } 446 447 static int 448 u3ginit_detach(device_t self, int flags) 449 { 450 451 return (0); 452 } 453 454 455 /* 456 * Second personality: 457 * 458 * Claim only those interfaces required for 3G modem operation. 459 */ 460 461 static int 462 u3g_match(device_t parent, cfdata_t match, void *aux) 463 { 464 struct usbif_attach_arg *uaa = aux; 465 usbd_interface_handle iface; 466 usb_interface_descriptor_t *id; 467 usbd_status error; 468 469 if (!usb_lookup(u3g_devs, uaa->vendor, uaa->product)) 470 return (UMATCH_NONE); 471 472 error = usbd_device2interface_handle(uaa->device, uaa->ifaceno, &iface); 473 if (error) { 474 printf("u3g_match: failed to get interface, err=%s\n", 475 usbd_errstr(error)); 476 return (UMATCH_NONE); 477 } 478 479 id = usbd_get_interface_descriptor(iface); 480 if (id == NULL) { 481 printf("u3g_match: failed to get interface descriptor\n"); 482 return (UMATCH_NONE); 483 } 484 485 /* 486 * 3G modems generally report vendor-specific class 487 * 488 * XXX: this may be too generalised. 489 */ 490 return ((id->bInterfaceClass == UICLASS_VENDOR) ? 491 UMATCH_VENDOR_PRODUCT : UMATCH_NONE); 492 } 493 494 static void 495 u3g_attach(device_t parent, device_t self, void *aux) 496 { 497 struct u3g_softc *sc = device_private(self); 498 struct usbif_attach_arg *uaa = aux; 499 usbd_device_handle dev = uaa->device; 500 usbd_interface_handle iface; 501 usb_interface_descriptor_t *id; 502 usb_endpoint_descriptor_t *ed; 503 struct ucom_attach_args uca; 504 usbd_status error; 505 int n, intr_address, intr_size; 506 507 aprint_naive("\n"); 508 aprint_normal("\n"); 509 510 sc->sc_dev = self; 511 sc->sc_dying = false; 512 sc->sc_udev = dev; 513 514 error = usbd_device2interface_handle(dev, uaa->ifaceno, &iface); 515 if (error) { 516 aprint_error_dev(self, "failed to get interface, err=%s\n", 517 usbd_errstr(error)); 518 return; 519 } 520 521 id = usbd_get_interface_descriptor(iface); 522 523 uca.info = "3G Modem"; 524 uca.ibufsize = U3G_BUFF_SIZE; 525 uca.obufsize = U3G_BUFF_SIZE; 526 uca.ibufsizepad = U3G_BUFF_SIZE; 527 uca.portno = uaa->ifaceno; 528 uca.opkthdrlen = 0; 529 uca.device = dev; 530 uca.iface = iface; 531 uca.methods = &u3g_methods; 532 uca.arg = sc; 533 uca.bulkin = uca.bulkout = -1; 534 535 sc->sc_outpins = 0; 536 sc->sc_msr = UMSR_DSR | UMSR_CTS | UMSR_DCD; 537 sc->sc_ifaceno = uaa->ifaceno; 538 sc->sc_open = false; 539 sc->sc_purging = false; 540 541 intr_address = -1; 542 intr_size = 0; 543 544 for (n = 0; n < id->bNumEndpoints; n++) { 545 ed = usbd_interface2endpoint_descriptor(iface, n); 546 if (ed == NULL) { 547 aprint_error_dev(self, "no endpoint descriptor " 548 "for %d (interface: %d)\n", n, sc->sc_ifaceno); 549 sc->sc_dying = true; 550 return; 551 } 552 553 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN && 554 UE_GET_XFERTYPE(ed->bmAttributes) == UE_INTERRUPT) { 555 intr_address = ed->bEndpointAddress; 556 intr_size = UGETW(ed->wMaxPacketSize); 557 } else 558 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN && 559 UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) { 560 uca.bulkin = ed->bEndpointAddress; 561 } else 562 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT && 563 UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) { 564 uca.bulkout = ed->bEndpointAddress; 565 } 566 } 567 568 if (uca.bulkin == -1) { 569 aprint_error_dev(self, "Missing bulk in for interface %d\n", 570 sc->sc_ifaceno); 571 sc->sc_dying = true; 572 return; 573 } 574 575 if (uca.bulkout == -1) { 576 aprint_error_dev(self, "Missing bulk out for interface %d\n", 577 sc->sc_ifaceno); 578 sc->sc_dying = true; 579 return; 580 } 581 582 sc->sc_ucom = config_found_sm_loc(self, "ucombus", 583 NULL, &uca, ucomprint, ucomsubmatch); 584 585 /* 586 * If the interface has an interrupt pipe, open it immediately so 587 * that we can track input pin state changes regardless of whether 588 * the tty(4) device is open or not. 589 */ 590 if (intr_address != -1) { 591 sc->sc_intr_buff = malloc(intr_size, M_USBDEV, M_WAITOK); 592 error = usbd_open_pipe_intr(iface, intr_address, 593 USBD_SHORT_XFER_OK, &sc->sc_intr_pipe, sc, sc->sc_intr_buff, 594 intr_size, u3g_intr, 100); 595 if (error) { 596 aprint_error_dev(self, "cannot open interrupt pipe " 597 "(addr %d)\n", intr_address); 598 return; 599 } 600 } else { 601 sc->sc_intr_pipe = NULL; 602 sc->sc_intr_buff = NULL; 603 } 604 605 if (!pmf_device_register(self, NULL, NULL)) 606 aprint_error_dev(self, "couldn't establish power handler\n"); 607 } 608 609 static int 610 u3g_detach(device_t self, int flags) 611 { 612 struct u3g_softc *sc = device_private(self); 613 int rv; 614 615 if (sc->sc_dying) 616 return 0; 617 618 pmf_device_deregister(self); 619 620 if (sc->sc_ucom != NULL) { 621 rv = config_detach(sc->sc_ucom, flags); 622 if (rv != 0) { 623 aprint_verbose_dev(self, "Can't deallocate " 624 "port (%d)", rv); 625 } 626 } 627 628 if (sc->sc_intr_pipe != NULL) { 629 (void) usbd_abort_pipe(sc->sc_intr_pipe); 630 (void) usbd_close_pipe(sc->sc_intr_pipe); 631 sc->sc_intr_pipe = NULL; 632 } 633 if (sc->sc_intr_buff != NULL) { 634 free(sc->sc_intr_buff, M_USBDEV); 635 sc->sc_intr_buff = NULL; 636 } 637 638 return (0); 639 } 640 641 static void 642 u3g_childdet(device_t self, device_t child) 643 { 644 struct u3g_softc *sc = device_private(self); 645 646 if (sc->sc_ucom == child) 647 sc->sc_ucom = NULL; 648 } 649 650 static int 651 u3g_activate(device_t self, enum devact act) 652 { 653 struct u3g_softc *sc = device_private(self); 654 int rv; 655 656 switch (act) { 657 case DVACT_DEACTIVATE: 658 if (sc->sc_ucom != NULL && config_deactivate(sc->sc_ucom)) 659 rv = -1; 660 else 661 rv = 0; 662 break; 663 664 default: 665 rv = 0; 666 break; 667 } 668 669 return (rv); 670 } 671 672 static void 673 u3g_intr(usbd_xfer_handle xfer, usbd_private_handle priv, usbd_status status) 674 { 675 struct u3g_softc *sc = (struct u3g_softc *)priv; 676 u_char *buf; 677 678 if (sc->sc_dying) 679 return; 680 681 if (status != USBD_NORMAL_COMPLETION) { 682 if (status == USBD_NOT_STARTED || status == USBD_CANCELLED) 683 return; 684 usbd_clear_endpoint_stall_async(sc->sc_intr_pipe); 685 return; 686 } 687 688 buf = sc->sc_intr_buff; 689 if (buf[0] == 0xa1 && buf[1] == 0x20) { 690 u_char msr; 691 692 msr = sc->sc_msr & ~(UMSR_DCD | UMSR_DSR | UMSR_RI); 693 694 if (buf[8] & U3G_INPIN_DCD) 695 msr |= UMSR_DCD; 696 697 if (buf[8] & U3G_INPIN_DSR) 698 msr |= UMSR_DSR; 699 700 if (buf[8] & U3G_INPIN_RI) 701 msr |= UMSR_RI; 702 703 if (msr != sc->sc_msr) { 704 sc->sc_msr = msr; 705 if (sc->sc_open) 706 ucom_status_change(device_private(sc->sc_ucom)); 707 } 708 } 709 } 710 711 /*ARGSUSED*/ 712 static void 713 u3g_get_status(void *arg, int portno, u_char *lsr, u_char *msr) 714 { 715 struct u3g_softc *sc = arg; 716 717 if (lsr != NULL) 718 *lsr = 0; /* LSR isn't supported */ 719 if (msr != NULL) 720 *msr = sc->sc_msr; 721 } 722 723 /*ARGSUSED*/ 724 static void 725 u3g_set(void *arg, int portno, int reg, int onoff) 726 { 727 struct u3g_softc *sc = arg; 728 usb_device_request_t req; 729 uint16_t mask, new_state; 730 usbd_status err; 731 732 if (sc->sc_dying) 733 return; 734 735 switch (reg) { 736 case UCOM_SET_DTR: 737 mask = U3G_OUTPIN_DTR; 738 break; 739 case UCOM_SET_RTS: 740 mask = U3G_OUTPIN_RTS; 741 break; 742 default: 743 return; 744 } 745 746 new_state = sc->sc_outpins & ~mask; 747 if (onoff) 748 new_state |= mask; 749 750 if (new_state == sc->sc_outpins) 751 return; 752 753 sc->sc_outpins = new_state; 754 755 req.bmRequestType = UT_WRITE_CLASS_INTERFACE; 756 req.bRequest = U3G_SET_PIN; 757 USETW(req.wValue, new_state); 758 USETW(req.wIndex, sc->sc_ifaceno); 759 USETW(req.wLength, 0); 760 761 err = usbd_do_request(sc->sc_udev, &req, 0); 762 if (err == USBD_STALLED) 763 usbd_clear_endpoint_stall(sc->sc_udev->default_pipe); 764 } 765 766 /*ARGSUSED*/ 767 static int 768 u3g_open(void *arg, int portno) 769 { 770 struct u3g_softc *sc = arg; 771 usb_device_request_t req; 772 usb_endpoint_descriptor_t *ed; 773 usb_interface_descriptor_t *id; 774 usbd_interface_handle ih; 775 usbd_status err; 776 int i; 777 778 if (sc->sc_dying) 779 return (0); 780 781 err = usbd_device2interface_handle(sc->sc_udev, portno, &ih); 782 if (err) 783 return (EIO); 784 785 id = usbd_get_interface_descriptor(ih); 786 787 for (i = 0; i < id->bNumEndpoints; i++) { 788 ed = usbd_interface2endpoint_descriptor(ih, i); 789 if (ed == NULL) 790 return (EIO); 791 792 if (UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) { 793 /* Issue ENDPOINT_HALT request */ 794 req.bmRequestType = UT_WRITE_ENDPOINT; 795 req.bRequest = UR_CLEAR_FEATURE; 796 USETW(req.wValue, UF_ENDPOINT_HALT); 797 USETW(req.wIndex, ed->bEndpointAddress); 798 USETW(req.wLength, 0); 799 err = usbd_do_request(sc->sc_udev, &req, 0); 800 if (err) 801 return (EIO); 802 } 803 } 804 805 sc->sc_open = true; 806 sc->sc_purging = true; 807 getmicrotime(&sc->sc_purge_start); 808 809 return (0); 810 } 811 812 /*ARGSUSED*/ 813 static void 814 u3g_close(void *arg, int portno) 815 { 816 struct u3g_softc *sc = arg; 817 818 sc->sc_open = false; 819 } 820 821 /*ARGSUSED*/ 822 static void 823 u3g_read(void *arg, int portno, u_char **cpp, uint32_t *ccp) 824 { 825 struct u3g_softc *sc = arg; 826 struct timeval curr_tv, diff_tv; 827 828 /* 829 * If we're not purging input data following first open, do nothing. 830 */ 831 if (sc->sc_purging == false) 832 return; 833 834 /* 835 * Otherwise check if the purge timeout has expired 836 */ 837 getmicrotime(&curr_tv); 838 timersub(&curr_tv, &sc->sc_purge_start, &diff_tv); 839 840 if (diff_tv.tv_sec >= U3G_PURGE_SECS) { 841 /* Timeout expired. */ 842 sc->sc_purging = false; 843 } else { 844 /* Still purging. Adjust the caller's byte count. */ 845 *ccp = 0; 846 } 847 } 848 849 /*ARGSUSED*/ 850 static void 851 u3g_write(void *arg, int portno, u_char *to, u_char *from, u_int32_t *count) 852 { 853 struct u3g_softc *sc = arg; 854 855 /* 856 * Stop purging as soon as the first data is written to the device. 857 */ 858 sc->sc_purging = false; 859 memcpy(to, from, *count); 860 } 861
Indexes created Tue Oct 14 06:10:07 GMT 2025