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