umodem.c revision 1.20
1 /* $NetBSD: umodem.c,v 1.20 2000/01/25 08:12:58 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 (augustss (at) carlstedt.se) 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 struct umodem_softc { 85 USBBASEDEVICE sc_dev; /* base device */ 86 87 usbd_device_handle sc_udev; /* USB device */ 88 89 int sc_ctl_iface_no; 90 usbd_interface_handle sc_ctl_iface; /* control interface */ 91 int sc_data_iface_no; 92 usbd_interface_handle sc_data_iface; /* data interface */ 93 94 int sc_cm_cap; /* CM capabilities */ 95 int sc_acm_cap; /* ACM capabilities */ 96 97 int sc_cm_over_data; 98 99 usb_cdc_line_state_t sc_line_state; /* current line state */ 100 u_char sc_dtr; /* current DTR state */ 101 u_char sc_rts; /* current RTS state */ 102 103 device_ptr_t sc_subdev; /* ucom device */ 104 105 u_char sc_opening; /* lock during open */ 106 u_char sc_dying; /* disconnecting */ 107 }; 108 109 static void *umodem_get_desc 110 __P((usbd_device_handle dev, int type, int subtype)); 111 static usbd_status umodem_set_comm_feature 112 __P((struct umodem_softc *sc, int feature, int state)); 113 static usbd_status umodem_set_line_coding 114 __P((struct umodem_softc *sc, usb_cdc_line_state_t *state)); 115 116 static void umodem_get_caps __P((usbd_device_handle, int *, int *)); 117 118 static void umodem_get_status 119 __P((void *, int portno, u_char *lsr, u_char *msr)); 120 static void umodem_set __P((void *, int, int, int)); 121 static void umodem_dtr __P((struct umodem_softc *, int)); 122 static void umodem_rts __P((struct umodem_softc *, int)); 123 static void umodem_break __P((struct umodem_softc *, int)); 124 static void umodem_set_line_state __P((struct umodem_softc *)); 125 static int umodem_param __P((void *, int, struct termios *)); 126 static int umodem_ioctl __P((void *, int, u_long, caddr_t, int, 127 struct proc *)); 128 129 static struct ucom_methods umodem_methods = { 130 umodem_get_status, 131 umodem_set, 132 umodem_param, 133 umodem_ioctl, 134 }; 135 136 USB_DECLARE_DRIVER(umodem); 137 138 USB_MATCH(umodem) 139 { 140 USB_MATCH_START(umodem, uaa); 141 usb_interface_descriptor_t *id; 142 int cm, acm; 143 144 if (uaa->iface == NULL) 145 return (UMATCH_NONE); 146 147 id = usbd_get_interface_descriptor(uaa->iface); 148 if (id == NULL || 149 id->bInterfaceClass != UCLASS_CDC || 150 id->bInterfaceSubClass != USUBCLASS_ABSTRACT_CONTROL_MODEL || 151 id->bInterfaceProtocol != UPROTO_CDC_AT) 152 return (UMATCH_NONE); 153 154 umodem_get_caps(uaa->device, &cm, &acm); 155 if (!(cm & USB_CDC_CM_DOES_CM) || 156 !(cm & USB_CDC_CM_OVER_DATA) || 157 !(acm & USB_CDC_ACM_HAS_LINE)) 158 return (UMATCH_NONE); 159 160 return (UMATCH_IFACECLASS_IFACESUBCLASS_IFACEPROTO); 161 } 162 163 USB_ATTACH(umodem) 164 { 165 USB_ATTACH_START(umodem, sc, uaa); 166 usbd_device_handle dev = uaa->device; 167 usb_interface_descriptor_t *id; 168 usb_endpoint_descriptor_t *ed; 169 usb_cdc_cm_descriptor_t *cmd; 170 char devinfo[1024]; 171 usbd_status err; 172 int data_ifcno; 173 int i; 174 struct ucom_attach_args uca; 175 176 usbd_devinfo(uaa->device, 0, devinfo); 177 USB_ATTACH_SETUP; 178 179 sc->sc_udev = dev; 180 sc->sc_ctl_iface = uaa->iface; 181 182 id = usbd_get_interface_descriptor(sc->sc_ctl_iface); 183 printf("%s: %s, iclass %d/%d\n", USBDEVNAME(sc->sc_dev), 184 devinfo, id->bInterfaceClass, id->bInterfaceSubClass); 185 sc->sc_ctl_iface_no = id->bInterfaceNumber; 186 187 umodem_get_caps(dev, &sc->sc_cm_cap, &sc->sc_acm_cap); 188 189 /* Get the data interface no. */ 190 cmd = umodem_get_desc(dev, UDESC_CS_INTERFACE, UDESCSUB_CDC_CM); 191 if (cmd == NULL) { 192 printf("%s: no CM descriptor\n", USBDEVNAME(sc->sc_dev)); 193 goto bad; 194 } 195 sc->sc_data_iface_no = data_ifcno = cmd->bDataInterface; 196 197 printf("%s: data interface %d, has %sCM over data, has %sbreak\n", 198 USBDEVNAME(sc->sc_dev), data_ifcno, 199 sc->sc_cm_cap & USB_CDC_CM_OVER_DATA ? "" : "no ", 200 sc->sc_acm_cap & USB_CDC_ACM_HAS_BREAK ? "" : "no "); 201 202 203 /* Get the data interface too. */ 204 for (i = 0; i < uaa->nifaces; i++) { 205 if (uaa->ifaces[i] != NULL) { 206 id = usbd_get_interface_descriptor(uaa->ifaces[i]); 207 if (id != NULL && id->bInterfaceNumber == data_ifcno) { 208 sc->sc_data_iface = uaa->ifaces[i]; 209 uaa->ifaces[i] = NULL; 210 } 211 } 212 } 213 if (sc->sc_data_iface == NULL) { 214 printf("%s: no data interface\n", USBDEVNAME(sc->sc_dev)); 215 goto bad; 216 } 217 218 /* 219 * Find the bulk endpoints. 220 * Iterate over all endpoints in the data interface and take note. 221 */ 222 uca.bulkin = uca.bulkout = -1; 223 224 id = usbd_get_interface_descriptor(sc->sc_data_iface); 225 for (i = 0; i < id->bNumEndpoints; i++) { 226 ed = usbd_interface2endpoint_descriptor(sc->sc_data_iface, i); 227 if (ed == NULL) { 228 printf("%s: no endpoint descriptor for %d\n", 229 USBDEVNAME(sc->sc_dev), i); 230 goto bad; 231 } 232 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN && 233 (ed->bmAttributes & UE_XFERTYPE) == UE_BULK) { 234 uca.bulkin = ed->bEndpointAddress; 235 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT && 236 (ed->bmAttributes & UE_XFERTYPE) == UE_BULK) { 237 uca.bulkout = ed->bEndpointAddress; 238 } 239 } 240 241 if (uca.bulkin == -1) { 242 printf("%s: Could not find data bulk in\n", 243 USBDEVNAME(sc->sc_dev)); 244 goto bad; 245 } 246 if (uca.bulkout == -1) { 247 printf("%s: Could not find data bulk out\n", 248 USBDEVNAME(sc->sc_dev)); 249 goto bad; 250 } 251 252 if (sc->sc_cm_cap & USB_CDC_CM_OVER_DATA) { 253 err = umodem_set_comm_feature(sc, UCDC_ABSTRACT_STATE, 254 UCDC_DATA_MULTIPLEXED); 255 if (err) { 256 printf("%s: could not set data multiplex mode\n", 257 USBDEVNAME(sc->sc_dev)); 258 goto bad; 259 } 260 sc->sc_cm_over_data = 1; 261 } 262 263 sc->sc_dtr = -1; 264 265 uca.portno = UCOM_UNK_PORTNO; 266 /* bulkin, bulkout set above */ 267 uca.device = sc->sc_udev; 268 uca.iface = sc->sc_data_iface; 269 uca.methods = &umodem_methods; 270 uca.arg = sc; 271 272 DPRINTF(("umodem_attach: sc=%p\n", sc)); 273 sc->sc_subdev = config_found_sm(self, &uca, ucomprint, ucomsubmatch); 274 275 USB_ATTACH_SUCCESS_RETURN; 276 277 bad: 278 sc->sc_dying = 1; 279 USB_ATTACH_ERROR_RETURN; 280 } 281 282 void 283 umodem_get_caps(dev, cm, acm) 284 usbd_device_handle dev; 285 int *cm, *acm; 286 { 287 usb_cdc_cm_descriptor_t *cmd; 288 usb_cdc_acm_descriptor_t *cad; 289 290 *cm = *acm = 0; 291 292 cmd = umodem_get_desc(dev, UDESC_CS_INTERFACE, UDESCSUB_CDC_CM); 293 if (cmd == NULL) { 294 DPRINTF(("umodem_get_desc: no CM desc\n")); 295 return; 296 } 297 *cm = cmd->bmCapabilities; 298 299 cad = umodem_get_desc(dev, UDESC_CS_INTERFACE, UDESCSUB_CDC_ACM); 300 if (cad == NULL) { 301 DPRINTF(("umodem_get_desc: no ACM desc\n")); 302 return; 303 } 304 *acm = cad->bmCapabilities; 305 } 306 307 void 308 umodem_get_status(addr, portno, lsr, msr) 309 void *addr; 310 int portno; 311 u_char *lsr, *msr; 312 { 313 DPRINTF(("umodem_get_status:\n")); 314 315 if (lsr != NULL) 316 *lsr = 0; /* XXX */ 317 if (msr != NULL) 318 *msr = 0; /* XXX */ 319 } 320 321 int 322 umodem_param(addr, portno, t) 323 void *addr; 324 int portno; 325 struct termios *t; 326 { 327 struct umodem_softc *sc = addr; 328 usbd_status err; 329 usb_cdc_line_state_t ls; 330 331 DPRINTF(("umodem_param: sc=%p\n", sc)); 332 333 USETDW(ls.dwDTERate, t->c_ospeed); 334 if (ISSET(t->c_cflag, CSTOPB)) 335 ls.bCharFormat = UCDC_STOP_BIT_2; 336 else 337 ls.bCharFormat = UCDC_STOP_BIT_1; 338 if (ISSET(t->c_cflag, PARENB)) { 339 if (ISSET(t->c_cflag, PARODD)) 340 ls.bParityType = UCDC_PARITY_ODD; 341 else 342 ls.bParityType = UCDC_PARITY_EVEN; 343 } else 344 ls.bParityType = UCDC_PARITY_NONE; 345 switch (ISSET(t->c_cflag, CSIZE)) { 346 case CS5: 347 ls.bDataBits = 5; 348 break; 349 case CS6: 350 ls.bDataBits = 6; 351 break; 352 case CS7: 353 ls.bDataBits = 7; 354 break; 355 case CS8: 356 ls.bDataBits = 8; 357 break; 358 } 359 360 err = umodem_set_line_coding(sc, &ls); 361 if (err) { 362 DPRINTF(("umodem_param: err=%s\n", usbd_errstr(err))); 363 return (1); 364 } 365 return (0); 366 } 367 368 int 369 umodem_ioctl(addr, portno, cmd, data, flag, p) 370 void *addr; 371 int portno; 372 u_long cmd; 373 caddr_t data; 374 int flag; 375 struct proc *p; 376 { 377 struct umodem_softc *sc = addr; 378 int error; 379 380 if (sc->sc_dying) 381 return (EIO); 382 383 DPRINTF(("umodemioctl: cmd=0x%08lx\n", cmd)); 384 385 switch (cmd) { 386 case USB_GET_CM_OVER_DATA: 387 *(int *)data = sc->sc_cm_over_data; 388 break; 389 390 case USB_SET_CM_OVER_DATA: 391 if (*(int *)data != sc->sc_cm_over_data) { 392 /* XXX change it */ 393 } 394 break; 395 396 default: 397 DPRINTF(("umodemioctl: unknown\n")); 398 error = ENOTTY; 399 break; 400 } 401 402 return (error); 403 } 404 405 void 406 umodem_dtr(sc, onoff) 407 struct umodem_softc *sc; 408 int onoff; 409 { 410 DPRINTF(("umodem_modem: onoff=%d\n", onoff)); 411 412 if (sc->sc_dtr == onoff) 413 return; 414 sc->sc_dtr = onoff; 415 416 umodem_set_line_state(sc); 417 } 418 419 void 420 umodem_rts(sc, onoff) 421 struct umodem_softc *sc; 422 int onoff; 423 { 424 DPRINTF(("umodem_modem: onoff=%d\n", onoff)); 425 426 if (sc->sc_rts == onoff) 427 return; 428 sc->sc_rts = onoff; 429 430 umodem_set_line_state(sc); 431 } 432 433 void 434 umodem_set_line_state(sc) 435 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(sc, onoff) 454 struct umodem_softc *sc; 455 int onoff; 456 { 457 usb_device_request_t req; 458 459 DPRINTF(("umodem_break: onoff=%d\n", onoff)); 460 461 if (!(sc->sc_acm_cap & USB_CDC_ACM_HAS_BREAK)) 462 return; 463 464 req.bmRequestType = UT_WRITE_CLASS_INTERFACE; 465 req.bRequest = UCDC_SEND_BREAK; 466 USETW(req.wValue, onoff ? UCDC_BREAK_ON : UCDC_BREAK_OFF); 467 USETW(req.wIndex, sc->sc_ctl_iface_no); 468 USETW(req.wLength, 0); 469 470 (void)usbd_do_request(sc->sc_udev, &req, 0); 471 } 472 473 void 474 umodem_set(addr, portno, reg, onoff) 475 void *addr; 476 int portno; 477 int onoff; 478 { 479 struct umodem_softc *sc = addr; 480 481 switch (reg) { 482 case UCOM_SET_DTR: 483 umodem_dtr(sc, onoff); 484 break; 485 case UCOM_SET_RTS: 486 umodem_rts(sc, onoff); 487 break; 488 case UCOM_SET_BREAK: 489 umodem_break(sc, onoff); 490 break; 491 default: 492 break; 493 } 494 } 495 496 usbd_status 497 umodem_set_line_coding(sc, state) 498 struct umodem_softc *sc; 499 usb_cdc_line_state_t *state; 500 { 501 usb_device_request_t req; 502 usbd_status err; 503 504 DPRINTF(("umodem_set_line_coding: rate=%d fmt=%d parity=%d bits=%d\n", 505 UGETDW(state->dwDTERate), state->bCharFormat, 506 state->bParityType, state->bDataBits)); 507 508 if (memcmp(state, &sc->sc_line_state, UCDC_LINE_STATE_LENGTH) == 0) { 509 DPRINTF(("umodem_set_line_coding: already set\n")); 510 return (USBD_NORMAL_COMPLETION); 511 } 512 513 req.bmRequestType = UT_WRITE_CLASS_INTERFACE; 514 req.bRequest = UCDC_SET_LINE_CODING; 515 USETW(req.wValue, 0); 516 USETW(req.wIndex, sc->sc_ctl_iface_no); 517 USETW(req.wLength, UCDC_LINE_STATE_LENGTH); 518 519 err = usbd_do_request(sc->sc_udev, &req, state); 520 if (err) { 521 DPRINTF(("umodem_set_line_coding: failed, err=%s\n", 522 usbd_errstr(err))); 523 return (err); 524 } 525 526 sc->sc_line_state = *state; 527 528 return (USBD_NORMAL_COMPLETION); 529 } 530 531 void * 532 umodem_get_desc(dev, type, subtype) 533 usbd_device_handle dev; 534 int type; 535 int subtype; 536 { 537 usb_descriptor_t *desc; 538 usb_config_descriptor_t *cd = usbd_get_config_descriptor(dev); 539 uByte *p = (uByte *)cd; 540 uByte *end = p + UGETW(cd->wTotalLength); 541 542 while (p < end) { 543 desc = (usb_descriptor_t *)p; 544 if (desc->bDescriptorType == type && 545 desc->bDescriptorSubtype == subtype) 546 return (desc); 547 p += desc->bLength; 548 } 549 550 return (0); 551 } 552 553 usbd_status 554 umodem_set_comm_feature(sc, feature, state) 555 struct umodem_softc *sc; 556 int feature; 557 int state; 558 { 559 usb_device_request_t req; 560 usbd_status err; 561 usb_cdc_abstract_state_t ast; 562 563 DPRINTF(("umodem_set_comm_feature: feature=%d state=%d\n", feature, 564 state)); 565 566 req.bmRequestType = UT_WRITE_CLASS_INTERFACE; 567 req.bRequest = UCDC_SET_COMM_FEATURE; 568 USETW(req.wValue, feature); 569 USETW(req.wIndex, sc->sc_ctl_iface_no); 570 USETW(req.wLength, UCDC_ABSTRACT_STATE_LENGTH); 571 USETW(ast.wState, state); 572 573 err = usbd_do_request(sc->sc_udev, &req, &ast); 574 if (err) { 575 DPRINTF(("umodem_set_comm_feature: feature=%d, err=%s\n", 576 feature, usbd_errstr(err))); 577 return (err); 578 } 579 580 return (USBD_NORMAL_COMPLETION); 581 } 582 583 int 584 umodem_activate(self, act) 585 device_ptr_t self; 586 enum devact act; 587 { 588 struct umodem_softc *sc = (struct umodem_softc *)self; 589 int rv = 0; 590 591 switch (act) { 592 case DVACT_ACTIVATE: 593 return (EOPNOTSUPP); 594 break; 595 596 case DVACT_DEACTIVATE: 597 sc->sc_dying = 1; 598 if (sc->sc_subdev) 599 rv = config_deactivate(sc->sc_subdev); 600 break; 601 } 602 return (rv); 603 } 604 605 int 606 umodem_detach(self, flags) 607 device_ptr_t self; 608 int flags; 609 { 610 struct umodem_softc *sc = (struct umodem_softc *)self; 611 int rv = 0; 612 613 DPRINTF(("umodem_detach: sc=%p flags=%d\n", sc, flags)); 614 615 sc->sc_dying = 1; 616 617 if (sc->sc_subdev != NULL) 618 rv = config_detach(sc->sc_subdev, flags); 619 620 return (rv); 621 } 622
Indexes created Thu Sep 25 15:09:46 GMT 2025