1 /* $NetBSD: umodem.c,v 1.34 2000/12/11 05:41:00 augustss Exp $ */ 2 3 /* 4 * Copyright (c) 1998 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Lennart Augustsson (lennart@augustsson.net) at 9 * Carlstedt Research & Technology. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 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. 19 * 3. All advertising materials mentioning features or use of this software 20 * must display the following acknowledgement: 21 * This product includes software developed by the NetBSD 22 * Foundation, Inc. and its contributors. 23 * 4. Neither the name of The NetBSD Foundation nor the names of its 24 * contributors may be used to endorse or promote products derived 25 * from this software without specific prior written permission. 26 * 27 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 28 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 29 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 30 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 31 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 32 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 33 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 34 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 35 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 36 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 37 * POSSIBILITY OF SUCH DAMAGE. 38 */ 39 40 /* 41 * Comm Class spec: http://www.usb.org/developers/data/usbspec.zip 42 */ 43 44 /* 45 * TODO: 46 * - Add error recovery in various places; the big problem is what 47 * to do in a callback if there is an error. 48 * - Implement a Call Device for modems without multiplexed commands. 49 * 50 */ 51 52 #include <sys/param.h> 53 #include <sys/systm.h> 54 #include <sys/kernel.h> 55 #include <sys/ioctl.h> 56 #include <sys/conf.h> 57 #include <sys/tty.h> 58 #include <sys/file.h> 59 #include <sys/select.h> 60 #include <sys/proc.h> 61 #include <sys/vnode.h> 62 #include <sys/device.h> 63 #include <sys/poll.h> 64 65 #include <dev/usb/usb.h> 66 #include <dev/usb/usbcdc.h> 67 68 #include <dev/usb/usbdi.h> 69 #include <dev/usb/usbdi_util.h> 70 #include <dev/usb/usbdevs.h> 71 #include <dev/usb/usb_quirks.h> 72 73 #include <dev/usb/usbdevs.h> 74 #include <dev/usb/ucomvar.h> 75 76 #ifdef UMODEM_DEBUG 77 #define DPRINTFN(n, x) if (umodemdebug > (n)) logprintf x 78 int umodemdebug = 0; 79 #else 80 #define DPRINTFN(n, x) 81 #endif 82 #define DPRINTF(x) DPRINTFN(0, x) 83 84 /* 85 * These are the maximum number of bytes transferred per frame. 86 * If some really high speed devices should use this driver they 87 * may need to be increased, but this is good enough for normal modems. 88 */ 89 #define UMODEMIBUFSIZE 64 90 #define UMODEMOBUFSIZE 256 91 92 struct umodem_softc { 93 USBBASEDEVICE sc_dev; /* base device */ 94 95 usbd_device_handle sc_udev; /* USB device */ 96 97 int sc_ctl_iface_no; 98 usbd_interface_handle sc_ctl_iface; /* control interface */ 99 int sc_data_iface_no; 100 usbd_interface_handle sc_data_iface; /* data interface */ 101 102 int sc_cm_cap; /* CM capabilities */ 103 int sc_acm_cap; /* ACM capabilities */ 104 105 int sc_cm_over_data; 106 107 usb_cdc_line_state_t sc_line_state; /* current line state */ 108 u_char sc_dtr; /* current DTR state */ 109 u_char sc_rts; /* current RTS state */ 110 111 device_ptr_t sc_subdev; /* ucom device */ 112 113 u_char sc_opening; /* lock during open */ 114 u_char sc_dying; /* disconnecting */ 115 }; 116 117 Static void *umodem_get_desc(usbd_device_handle dev, int type, int subtype); 118 Static usbd_status umodem_set_comm_feature(struct umodem_softc *sc, 119 int feature, int state); 120 Static usbd_status umodem_set_line_coding(struct umodem_softc *sc, 121 usb_cdc_line_state_t *state); 122 123 Static void umodem_get_caps(usbd_device_handle, int *, int *); 124 125 Static void umodem_get_status(void *, int portno, u_char *lsr, u_char *msr); 126 Static void umodem_set(void *, int, int, int); 127 Static void umodem_dtr(struct umodem_softc *, int); 128 Static void umodem_rts(struct umodem_softc *, int); 129 Static void umodem_break(struct umodem_softc *, int); 130 Static void umodem_set_line_state(struct umodem_softc *); 131 Static int umodem_param(void *, int, struct termios *); 132 Static int umodem_ioctl(void *, int, u_long, caddr_t, int, struct proc *); 133 134 Static struct ucom_methods umodem_methods = { 135 umodem_get_status, 136 umodem_set, 137 umodem_param, 138 umodem_ioctl, 139 NULL, 140 NULL, 141 NULL, 142 NULL, 143 }; 144 145 USB_DECLARE_DRIVER(umodem); 146 147 USB_MATCH(umodem) 148 { 149 USB_MATCH_START(umodem, uaa); 150 usb_interface_descriptor_t *id; 151 int cm, acm; 152 153 if (uaa->iface == NULL) 154 return (UMATCH_NONE); 155 156 id = usbd_get_interface_descriptor(uaa->iface); 157 if (id == NULL || 158 id->bInterfaceClass != UICLASS_CDC || 159 id->bInterfaceSubClass != UISUBCLASS_ABSTRACT_CONTROL_MODEL || 160 id->bInterfaceProtocol != UIPROTO_CDC_AT) 161 return (UMATCH_NONE); 162 163 umodem_get_caps(uaa->device, &cm, &acm); 164 if (!(cm & USB_CDC_CM_DOES_CM) || 165 !(cm & USB_CDC_CM_OVER_DATA) || 166 !(acm & USB_CDC_ACM_HAS_LINE)) 167 return (UMATCH_NONE); 168 169 return (UMATCH_IFACECLASS_IFACESUBCLASS_IFACEPROTO); 170 } 171 172 USB_ATTACH(umodem) 173 { 174 USB_ATTACH_START(umodem, sc, uaa); 175 usbd_device_handle dev = uaa->device; 176 usb_interface_descriptor_t *id; 177 usb_endpoint_descriptor_t *ed; 178 usb_cdc_cm_descriptor_t *cmd; 179 char devinfo[1024]; 180 usbd_status err; 181 int data_ifcno; 182 int i; 183 struct ucom_attach_args uca; 184 185 usbd_devinfo(uaa->device, 0, devinfo); 186 USB_ATTACH_SETUP; 187 188 sc->sc_udev = dev; 189 sc->sc_ctl_iface = uaa->iface; 190 191 id = usbd_get_interface_descriptor(sc->sc_ctl_iface); 192 printf("%s: %s, iclass %d/%d\n", USBDEVNAME(sc->sc_dev), 193 devinfo, id->bInterfaceClass, id->bInterfaceSubClass); 194 sc->sc_ctl_iface_no = id->bInterfaceNumber; 195 196 umodem_get_caps(dev, &sc->sc_cm_cap, &sc->sc_acm_cap); 197 198 /* Get the data interface no. */ 199 cmd = umodem_get_desc(dev, UDESC_CS_INTERFACE, UDESCSUB_CDC_CM); 200 if (cmd == NULL) { 201 printf("%s: no CM descriptor\n", USBDEVNAME(sc->sc_dev)); 202 goto bad; 203 } 204 sc->sc_data_iface_no = data_ifcno = cmd->bDataInterface; 205 206 printf("%s: data interface %d, has %sCM over data, has %sbreak\n", 207 USBDEVNAME(sc->sc_dev), data_ifcno, 208 sc->sc_cm_cap & USB_CDC_CM_OVER_DATA ? "" : "no ", 209 sc->sc_acm_cap & USB_CDC_ACM_HAS_BREAK ? "" : "no "); 210 211 212 /* Get the data interface too. */ 213 for (i = 0; i < uaa->nifaces; i++) { 214 if (uaa->ifaces[i] != NULL) { 215 id = usbd_get_interface_descriptor(uaa->ifaces[i]); 216 if (id != NULL && id->bInterfaceNumber == data_ifcno) { 217 sc->sc_data_iface = uaa->ifaces[i]; 218 uaa->ifaces[i] = NULL; 219 } 220 } 221 } 222 if (sc->sc_data_iface == NULL) { 223 printf("%s: no data interface\n", USBDEVNAME(sc->sc_dev)); 224 goto bad; 225 } 226 227 /* 228 * Find the bulk endpoints. 229 * Iterate over all endpoints in the data interface and take note. 230 */ 231 uca.bulkin = uca.bulkout = -1; 232 233 id = usbd_get_interface_descriptor(sc->sc_data_iface); 234 for (i = 0; i < id->bNumEndpoints; i++) { 235 ed = usbd_interface2endpoint_descriptor(sc->sc_data_iface, i); 236 if (ed == NULL) { 237 printf("%s: no endpoint descriptor for %d\n", 238 USBDEVNAME(sc->sc_dev), i); 239 goto bad; 240 } 241 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN && 242 (ed->bmAttributes & UE_XFERTYPE) == UE_BULK) { 243 uca.bulkin = ed->bEndpointAddress; 244 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT && 245 (ed->bmAttributes & UE_XFERTYPE) == UE_BULK) { 246 uca.bulkout = ed->bEndpointAddress; 247 } 248 } 249 250 if (uca.bulkin == -1) { 251 printf("%s: Could not find data bulk in\n", 252 USBDEVNAME(sc->sc_dev)); 253 goto bad; 254 } 255 if (uca.bulkout == -1) { 256 printf("%s: Could not find data bulk out\n", 257 USBDEVNAME(sc->sc_dev)); 258 goto bad; 259 } 260 261 if (sc->sc_cm_cap & USB_CDC_CM_OVER_DATA) { 262 if (sc->sc_acm_cap & USB_CDC_ACM_HAS_FEATURE) 263 err = umodem_set_comm_feature(sc, 264 UCDC_ABSTRACT_STATE, UCDC_DATA_MULTIPLEXED); 265 else 266 err = 0; 267 if (err) { 268 printf("%s: could not set data multiplex mode\n", 269 USBDEVNAME(sc->sc_dev)); 270 goto bad; 271 } 272 sc->sc_cm_over_data = 1; 273 } 274 sc->sc_dtr = -1; 275 276 uca.portno = UCOM_UNK_PORTNO; 277 /* bulkin, bulkout set above */ 278 uca.ibufsize = UMODEMIBUFSIZE; 279 uca.obufsize = UMODEMOBUFSIZE; 280 uca.ibufsizepad = UMODEMIBUFSIZE; 281 uca.opkthdrlen = 0; 282 uca.device = sc->sc_udev; 283 uca.iface = sc->sc_data_iface; 284 uca.methods = &umodem_methods; 285 uca.arg = sc; 286 287 DPRINTF(("umodem_attach: sc=%p\n", sc)); 288 sc->sc_subdev = config_found_sm(self, &uca, ucomprint, ucomsubmatch); 289 290 usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev, 291 USBDEV(sc->sc_dev)); 292 293 USB_ATTACH_SUCCESS_RETURN; 294 295 bad: 296 sc->sc_dying = 1; 297 USB_ATTACH_ERROR_RETURN; 298 } 299 300 void 301 umodem_get_caps(usbd_device_handle dev, int *cm, int *acm) 302 { 303 usb_cdc_cm_descriptor_t *cmd; 304 usb_cdc_acm_descriptor_t *cad; 305 306 *cm = *acm = 0; 307 308 cmd = umodem_get_desc(dev, UDESC_CS_INTERFACE, UDESCSUB_CDC_CM); 309 if (cmd == NULL) { 310 DPRINTF(("umodem_get_desc: no CM desc\n")); 311 return; 312 } 313 *cm = cmd->bmCapabilities; 314 315 cad = umodem_get_desc(dev, UDESC_CS_INTERFACE, UDESCSUB_CDC_ACM); 316 if (cad == NULL) { 317 DPRINTF(("umodem_get_desc: no ACM desc\n")); 318 return; 319 } 320 *acm = cad->bmCapabilities; 321 } 322 323 void 324 umodem_get_status(void *addr, int portno, u_char *lsr, u_char *msr) 325 { 326 DPRINTF(("umodem_get_status:\n")); 327 328 if (lsr != NULL) 329 *lsr = 0; /* XXX */ 330 if (msr != NULL) 331 *msr = 0; /* XXX */ 332 } 333 334 int 335 umodem_param(void *addr, int portno, struct termios *t) 336 { 337 struct umodem_softc *sc = addr; 338 usbd_status err; 339 usb_cdc_line_state_t ls; 340 341 DPRINTF(("umodem_param: sc=%p\n", sc)); 342 343 USETDW(ls.dwDTERate, t->c_ospeed); 344 if (ISSET(t->c_cflag, CSTOPB)) 345 ls.bCharFormat = UCDC_STOP_BIT_2; 346 else 347 ls.bCharFormat = UCDC_STOP_BIT_1; 348 if (ISSET(t->c_cflag, PARENB)) { 349 if (ISSET(t->c_cflag, PARODD)) 350 ls.bParityType = UCDC_PARITY_ODD; 351 else 352 ls.bParityType = UCDC_PARITY_EVEN; 353 } else 354 ls.bParityType = UCDC_PARITY_NONE; 355 switch (ISSET(t->c_cflag, CSIZE)) { 356 case CS5: 357 ls.bDataBits = 5; 358 break; 359 case CS6: 360 ls.bDataBits = 6; 361 break; 362 case CS7: 363 ls.bDataBits = 7; 364 break; 365 case CS8: 366 ls.bDataBits = 8; 367 break; 368 } 369 370 err = umodem_set_line_coding(sc, &ls); 371 if (err) { 372 DPRINTF(("umodem_param: err=%s\n", usbd_errstr(err))); 373 return (1); 374 } 375 return (0); 376 } 377 378 int 379 umodem_ioctl(void *addr, int portno, u_long cmd, caddr_t data, int flag, 380 struct proc *p) 381 { 382 struct umodem_softc *sc = addr; 383 int error = 0; 384 385 if (sc->sc_dying) 386 return (EIO); 387 388 DPRINTF(("umodemioctl: cmd=0x%08lx\n", cmd)); 389 390 switch (cmd) { 391 case USB_GET_CM_OVER_DATA: 392 *(int *)data = sc->sc_cm_over_data; 393 break; 394 395 case USB_SET_CM_OVER_DATA: 396 if (*(int *)data != sc->sc_cm_over_data) { 397 /* XXX change it */ 398 } 399 break; 400 401 default: 402 DPRINTF(("umodemioctl: unknown\n")); 403 error = ENOTTY; 404 break; 405 } 406 407 return (error); 408 } 409 410 void 411 umodem_dtr(struct umodem_softc *sc, int onoff) 412 { 413 DPRINTF(("umodem_modem: onoff=%d\n", onoff)); 414 415 if (sc->sc_dtr == onoff) 416 return; 417 sc->sc_dtr = onoff; 418 419 umodem_set_line_state(sc); 420 } 421 422 void 423 umodem_rts(struct umodem_softc *sc, int onoff) 424 { 425 DPRINTF(("umodem_modem: onoff=%d\n", onoff)); 426 427 if (sc->sc_rts == onoff) 428 return; 429 sc->sc_rts = onoff; 430 431 umodem_set_line_state(sc); 432 } 433 434 void 435 umodem_set_line_state(struct umodem_softc *sc) 436 { 437 usb_device_request_t req; 438 int ls; 439 440 ls = (sc->sc_dtr ? UCDC_LINE_DTR : 0) | 441 (sc->sc_rts ? UCDC_LINE_RTS : 0); 442 req.bmRequestType = UT_WRITE_CLASS_INTERFACE; 443 req.bRequest = UCDC_SET_CONTROL_LINE_STATE; 444 USETW(req.wValue, ls); 445 USETW(req.wIndex, sc->sc_ctl_iface_no); 446 USETW(req.wLength, 0); 447 448 (void)usbd_do_request(sc->sc_udev, &req, 0); 449 450 } 451 452 void 453 umodem_break(struct umodem_softc *sc, int onoff) 454 { 455 usb_device_request_t req; 456 457 DPRINTF(("umodem_break: onoff=%d\n", onoff)); 458 459 if (!(sc->sc_acm_cap & USB_CDC_ACM_HAS_BREAK)) 460 return; 461 462 req.bmRequestType = UT_WRITE_CLASS_INTERFACE; 463 req.bRequest = UCDC_SEND_BREAK; 464 USETW(req.wValue, onoff ? UCDC_BREAK_ON : UCDC_BREAK_OFF); 465 USETW(req.wIndex, sc->sc_ctl_iface_no); 466 USETW(req.wLength, 0); 467 468 (void)usbd_do_request(sc->sc_udev, &req, 0); 469 } 470 471 void 472 umodem_set(void *addr, int portno, int reg, int onoff) 473 { 474 struct umodem_softc *sc = addr; 475 476 switch (reg) { 477 case UCOM_SET_DTR: 478 umodem_dtr(sc, onoff); 479 break; 480 case UCOM_SET_RTS: 481 umodem_rts(sc, onoff); 482 break; 483 case UCOM_SET_BREAK: 484 umodem_break(sc, onoff); 485 break; 486 default: 487 break; 488 } 489 } 490 491 usbd_status 492 umodem_set_line_coding(struct umodem_softc *sc, usb_cdc_line_state_t *state) 493 { 494 usb_device_request_t req; 495 usbd_status err; 496 497 DPRINTF(("umodem_set_line_coding: rate=%d fmt=%d parity=%d bits=%d\n", 498 UGETDW(state->dwDTERate), state->bCharFormat, 499 state->bParityType, state->bDataBits)); 500 501 if (memcmp(state, &sc->sc_line_state, UCDC_LINE_STATE_LENGTH) == 0) { 502 DPRINTF(("umodem_set_line_coding: already set\n")); 503 return (USBD_NORMAL_COMPLETION); 504 } 505 506 req.bmRequestType = UT_WRITE_CLASS_INTERFACE; 507 req.bRequest = UCDC_SET_LINE_CODING; 508 USETW(req.wValue, 0); 509 USETW(req.wIndex, sc->sc_ctl_iface_no); 510 USETW(req.wLength, UCDC_LINE_STATE_LENGTH); 511 512 err = usbd_do_request(sc->sc_udev, &req, state); 513 if (err) { 514 DPRINTF(("umodem_set_line_coding: failed, err=%s\n", 515 usbd_errstr(err))); 516 return (err); 517 } 518 519 sc->sc_line_state = *state; 520 521 return (USBD_NORMAL_COMPLETION); 522 } 523 524 void * 525 umodem_get_desc(usbd_device_handle dev, int type, int subtype) 526 { 527 usb_descriptor_t *desc; 528 usb_config_descriptor_t *cd = usbd_get_config_descriptor(dev); 529 uByte *p = (uByte *)cd; 530 uByte *end = p + UGETW(cd->wTotalLength); 531 532 while (p < end) { 533 desc = (usb_descriptor_t *)p; 534 if (desc->bDescriptorType == type && 535 desc->bDescriptorSubtype == subtype) 536 return (desc); 537 p += desc->bLength; 538 } 539 540 return (0); 541 } 542 543 usbd_status 544 umodem_set_comm_feature(struct umodem_softc *sc, int feature, int state) 545 { 546 usb_device_request_t req; 547 usbd_status err; 548 usb_cdc_abstract_state_t ast; 549 550 DPRINTF(("umodem_set_comm_feature: feature=%d state=%d\n", feature, 551 state)); 552 553 req.bmRequestType = UT_WRITE_CLASS_INTERFACE; 554 req.bRequest = UCDC_SET_COMM_FEATURE; 555 USETW(req.wValue, feature); 556 USETW(req.wIndex, sc->sc_ctl_iface_no); 557 USETW(req.wLength, UCDC_ABSTRACT_STATE_LENGTH); 558 USETW(ast.wState, state); 559 560 err = usbd_do_request(sc->sc_udev, &req, &ast); 561 if (err) { 562 DPRINTF(("umodem_set_comm_feature: feature=%d, err=%s\n", 563 feature, usbd_errstr(err))); 564 return (err); 565 } 566 567 return (USBD_NORMAL_COMPLETION); 568 } 569 570 int 571 umodem_activate(device_ptr_t self, enum devact act) 572 { 573 struct umodem_softc *sc = (struct umodem_softc *)self; 574 int rv = 0; 575 576 switch (act) { 577 case DVACT_ACTIVATE: 578 return (EOPNOTSUPP); 579 break; 580 581 case DVACT_DEACTIVATE: 582 sc->sc_dying = 1; 583 if (sc->sc_subdev) 584 rv = config_deactivate(sc->sc_subdev); 585 break; 586 } 587 return (rv); 588 } 589 590 USB_DETACH(umodem) 591 { 592 USB_DETACH_START(umodem, sc); 593 int rv = 0; 594 595 DPRINTF(("umodem_detach: sc=%p flags=%d\n", sc, flags)); 596 597 sc->sc_dying = 1; 598 599 if (sc->sc_subdev != NULL) 600 rv = config_detach(sc->sc_subdev, flags); 601 602 usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev, 603 USBDEV(sc->sc_dev)); 604 605 return (rv); 606 } 607