1 /* $NetBSD: umodem.c,v 1.29 2000/06/01 14:29:01 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/usbcdc11.pdf 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 err = umodem_set_comm_feature(sc, UCDC_ABSTRACT_STATE, 263 UCDC_DATA_MULTIPLEXED); 264 if (err) { 265 printf("%s: could not set data multiplex mode\n", 266 USBDEVNAME(sc->sc_dev)); 267 goto bad; 268 } 269 sc->sc_cm_over_data = 1; 270 } 271 272 sc->sc_dtr = -1; 273 274 uca.portno = UCOM_UNK_PORTNO; 275 /* bulkin, bulkout set above */ 276 uca.ibufsize = UMODEMIBUFSIZE; 277 uca.obufsize = UMODEMOBUFSIZE; 278 uca.ibufsizepad = UMODEMIBUFSIZE; 279 uca.obufsizepad = UMODEMOBUFSIZE; 280 uca.device = sc->sc_udev; 281 uca.iface = sc->sc_data_iface; 282 uca.methods = &umodem_methods; 283 uca.arg = sc; 284 285 DPRINTF(("umodem_attach: sc=%p\n", sc)); 286 sc->sc_subdev = config_found_sm(self, &uca, ucomprint, ucomsubmatch); 287 288 usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev, 289 USBDEV(sc->sc_dev)); 290 291 USB_ATTACH_SUCCESS_RETURN; 292 293 bad: 294 sc->sc_dying = 1; 295 USB_ATTACH_ERROR_RETURN; 296 } 297 298 void 299 umodem_get_caps(usbd_device_handle dev, int *cm, int *acm) 300 { 301 usb_cdc_cm_descriptor_t *cmd; 302 usb_cdc_acm_descriptor_t *cad; 303 304 *cm = *acm = 0; 305 306 cmd = umodem_get_desc(dev, UDESC_CS_INTERFACE, UDESCSUB_CDC_CM); 307 if (cmd == NULL) { 308 DPRINTF(("umodem_get_desc: no CM desc\n")); 309 return; 310 } 311 *cm = cmd->bmCapabilities; 312 313 cad = umodem_get_desc(dev, UDESC_CS_INTERFACE, UDESCSUB_CDC_ACM); 314 if (cad == NULL) { 315 DPRINTF(("umodem_get_desc: no ACM desc\n")); 316 return; 317 } 318 *acm = cad->bmCapabilities; 319 } 320 321 void 322 umodem_get_status(void *addr, int portno, u_char *lsr, u_char *msr) 323 { 324 DPRINTF(("umodem_get_status:\n")); 325 326 if (lsr != NULL) 327 *lsr = 0; /* XXX */ 328 if (msr != NULL) 329 *msr = 0; /* XXX */ 330 } 331 332 int 333 umodem_param(void *addr, int portno, struct termios *t) 334 { 335 struct umodem_softc *sc = addr; 336 usbd_status err; 337 usb_cdc_line_state_t ls; 338 339 DPRINTF(("umodem_param: sc=%p\n", sc)); 340 341 USETDW(ls.dwDTERate, t->c_ospeed); 342 if (ISSET(t->c_cflag, CSTOPB)) 343 ls.bCharFormat = UCDC_STOP_BIT_2; 344 else 345 ls.bCharFormat = UCDC_STOP_BIT_1; 346 if (ISSET(t->c_cflag, PARENB)) { 347 if (ISSET(t->c_cflag, PARODD)) 348 ls.bParityType = UCDC_PARITY_ODD; 349 else 350 ls.bParityType = UCDC_PARITY_EVEN; 351 } else 352 ls.bParityType = UCDC_PARITY_NONE; 353 switch (ISSET(t->c_cflag, CSIZE)) { 354 case CS5: 355 ls.bDataBits = 5; 356 break; 357 case CS6: 358 ls.bDataBits = 6; 359 break; 360 case CS7: 361 ls.bDataBits = 7; 362 break; 363 case CS8: 364 ls.bDataBits = 8; 365 break; 366 } 367 368 err = umodem_set_line_coding(sc, &ls); 369 if (err) { 370 DPRINTF(("umodem_param: err=%s\n", usbd_errstr(err))); 371 return (1); 372 } 373 return (0); 374 } 375 376 int 377 umodem_ioctl(void *addr, int portno, u_long cmd, caddr_t data, int flag, 378 struct proc *p) 379 { 380 struct umodem_softc *sc = addr; 381 int error = 0; 382 383 if (sc->sc_dying) 384 return (EIO); 385 386 DPRINTF(("umodemioctl: cmd=0x%08lx\n", cmd)); 387 388 switch (cmd) { 389 case USB_GET_CM_OVER_DATA: 390 *(int *)data = sc->sc_cm_over_data; 391 break; 392 393 case USB_SET_CM_OVER_DATA: 394 if (*(int *)data != sc->sc_cm_over_data) { 395 /* XXX change it */ 396 } 397 break; 398 399 default: 400 DPRINTF(("umodemioctl: unknown\n")); 401 error = ENOTTY; 402 break; 403 } 404 405 return (error); 406 } 407 408 void 409 umodem_dtr(struct umodem_softc *sc, int onoff) 410 { 411 DPRINTF(("umodem_modem: onoff=%d\n", onoff)); 412 413 if (sc->sc_dtr == onoff) 414 return; 415 sc->sc_dtr = onoff; 416 417 umodem_set_line_state(sc); 418 } 419 420 void 421 umodem_rts(struct umodem_softc *sc, int onoff) 422 { 423 DPRINTF(("umodem_modem: onoff=%d\n", onoff)); 424 425 if (sc->sc_rts == onoff) 426 return; 427 sc->sc_rts = onoff; 428 429 umodem_set_line_state(sc); 430 } 431 432 void 433 umodem_set_line_state(struct umodem_softc *sc) 434 { 435 usb_device_request_t req; 436 int ls; 437 438 ls = (sc->sc_dtr ? UCDC_LINE_DTR : 0) | 439 (sc->sc_rts ? UCDC_LINE_RTS : 0); 440 req.bmRequestType = UT_WRITE_CLASS_INTERFACE; 441 req.bRequest = UCDC_SET_CONTROL_LINE_STATE; 442 USETW(req.wValue, ls); 443 USETW(req.wIndex, sc->sc_ctl_iface_no); 444 USETW(req.wLength, 0); 445 446 (void)usbd_do_request(sc->sc_udev, &req, 0); 447 448 } 449 450 void 451 umodem_break(struct umodem_softc *sc, int onoff) 452 { 453 usb_device_request_t req; 454 455 DPRINTF(("umodem_break: onoff=%d\n", onoff)); 456 457 if (!(sc->sc_acm_cap & USB_CDC_ACM_HAS_BREAK)) 458 return; 459 460 req.bmRequestType = UT_WRITE_CLASS_INTERFACE; 461 req.bRequest = UCDC_SEND_BREAK; 462 USETW(req.wValue, onoff ? UCDC_BREAK_ON : UCDC_BREAK_OFF); 463 USETW(req.wIndex, sc->sc_ctl_iface_no); 464 USETW(req.wLength, 0); 465 466 (void)usbd_do_request(sc->sc_udev, &req, 0); 467 } 468 469 void 470 umodem_set(void *addr, int portno, int reg, int onoff) 471 { 472 struct umodem_softc *sc = addr; 473 474 switch (reg) { 475 case UCOM_SET_DTR: 476 umodem_dtr(sc, onoff); 477 break; 478 case UCOM_SET_RTS: 479 umodem_rts(sc, onoff); 480 break; 481 case UCOM_SET_BREAK: 482 umodem_break(sc, onoff); 483 break; 484 default: 485 break; 486 } 487 } 488 489 usbd_status 490 umodem_set_line_coding(struct umodem_softc *sc, usb_cdc_line_state_t *state) 491 { 492 usb_device_request_t req; 493 usbd_status err; 494 495 DPRINTF(("umodem_set_line_coding: rate=%d fmt=%d parity=%d bits=%d\n", 496 UGETDW(state->dwDTERate), state->bCharFormat, 497 state->bParityType, state->bDataBits)); 498 499 if (memcmp(state, &sc->sc_line_state, UCDC_LINE_STATE_LENGTH) == 0) { 500 DPRINTF(("umodem_set_line_coding: already set\n")); 501 return (USBD_NORMAL_COMPLETION); 502 } 503 504 req.bmRequestType = UT_WRITE_CLASS_INTERFACE; 505 req.bRequest = UCDC_SET_LINE_CODING; 506 USETW(req.wValue, 0); 507 USETW(req.wIndex, sc->sc_ctl_iface_no); 508 USETW(req.wLength, UCDC_LINE_STATE_LENGTH); 509 510 err = usbd_do_request(sc->sc_udev, &req, state); 511 if (err) { 512 DPRINTF(("umodem_set_line_coding: failed, err=%s\n", 513 usbd_errstr(err))); 514 return (err); 515 } 516 517 sc->sc_line_state = *state; 518 519 return (USBD_NORMAL_COMPLETION); 520 } 521 522 void * 523 umodem_get_desc(usbd_device_handle dev, int type, int subtype) 524 { 525 usb_descriptor_t *desc; 526 usb_config_descriptor_t *cd = usbd_get_config_descriptor(dev); 527 uByte *p = (uByte *)cd; 528 uByte *end = p + UGETW(cd->wTotalLength); 529 530 while (p < end) { 531 desc = (usb_descriptor_t *)p; 532 if (desc->bDescriptorType == type && 533 desc->bDescriptorSubtype == subtype) 534 return (desc); 535 p += desc->bLength; 536 } 537 538 return (0); 539 } 540 541 usbd_status 542 umodem_set_comm_feature(struct umodem_softc *sc, int feature, int state) 543 { 544 usb_device_request_t req; 545 usbd_status err; 546 usb_cdc_abstract_state_t ast; 547 548 DPRINTF(("umodem_set_comm_feature: feature=%d state=%d\n", feature, 549 state)); 550 551 req.bmRequestType = UT_WRITE_CLASS_INTERFACE; 552 req.bRequest = UCDC_SET_COMM_FEATURE; 553 USETW(req.wValue, feature); 554 USETW(req.wIndex, sc->sc_ctl_iface_no); 555 USETW(req.wLength, UCDC_ABSTRACT_STATE_LENGTH); 556 USETW(ast.wState, state); 557 558 err = usbd_do_request(sc->sc_udev, &req, &ast); 559 if (err) { 560 DPRINTF(("umodem_set_comm_feature: feature=%d, err=%s\n", 561 feature, usbd_errstr(err))); 562 return (err); 563 } 564 565 return (USBD_NORMAL_COMPLETION); 566 } 567 568 int 569 umodem_activate(device_ptr_t self, enum devact act) 570 { 571 struct umodem_softc *sc = (struct umodem_softc *)self; 572 int rv = 0; 573 574 switch (act) { 575 case DVACT_ACTIVATE: 576 return (EOPNOTSUPP); 577 break; 578 579 case DVACT_DEACTIVATE: 580 sc->sc_dying = 1; 581 if (sc->sc_subdev) 582 rv = config_deactivate(sc->sc_subdev); 583 break; 584 } 585 return (rv); 586 } 587 588 USB_DETACH(umodem) 589 { 590 USB_DETACH_START(umodem, sc); 591 int rv = 0; 592 593 DPRINTF(("umodem_detach: sc=%p flags=%d\n", sc, flags)); 594 595 sc->sc_dying = 1; 596 597 if (sc->sc_subdev != NULL) 598 rv = config_detach(sc->sc_subdev, flags); 599 600 usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev, 601 USBDEV(sc->sc_dev)); 602 603 return (rv); 604 } 605