umct.c revision 1.29
1 /* $NetBSD: umct.c,v 1.29 2009/11/12 19:58:27 dyoung Exp $ */ 2 /* 3 * Copyright (c) 2001 The NetBSD Foundation, Inc. 4 * All rights reserved. 5 * 6 * This code is derived from software contributed to The NetBSD Foundation 7 * by Ichiro FUKUHARA (ichiro (at) ichiro.org). 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 * MCT USB-RS232 Interface Controller 33 * http://www.mct.com.tw/prod/rs232.html 34 * http://www.dlink.com/products/usb/dsbs25 35 */ 36 37 #include <sys/cdefs.h> 38 __KERNEL_RCSID(0, "$NetBSD: umct.c,v 1.29 2009/11/12 19:58:27 dyoung Exp $"); 39 40 #include <sys/param.h> 41 #include <sys/systm.h> 42 #include <sys/kernel.h> 43 #include <sys/malloc.h> 44 #include <sys/ioctl.h> 45 #include <sys/conf.h> 46 #include <sys/tty.h> 47 #include <sys/file.h> 48 #include <sys/select.h> 49 #include <sys/proc.h> 50 #include <sys/vnode.h> 51 #include <sys/device.h> 52 #include <sys/poll.h> 53 54 #include <dev/usb/usb.h> 55 #include <dev/usb/usbcdc.h> 56 57 #include <dev/usb/usbdi.h> 58 #include <dev/usb/usbdi_util.h> 59 #include <dev/usb/usbdevs.h> 60 #include <dev/usb/usb_quirks.h> 61 62 #include <dev/usb/ucomvar.h> 63 #include <dev/usb/umct.h> 64 65 #ifdef UMCT_DEBUG 66 #define DPRINTFN(n, x) if (umctdebug > (n)) logprintf x 67 int umctdebug = 0; 68 #else 69 #define DPRINTFN(n, x) 70 #endif 71 #define DPRINTF(x) DPRINTFN(0, x) 72 73 #define UMCT_CONFIG_INDEX 0 74 #define UMCT_IFACE_INDEX 0 75 76 struct umct_softc { 77 USBBASEDEVICE sc_dev; /* base device */ 78 usbd_device_handle sc_udev; /* USB device */ 79 usbd_interface_handle sc_iface; /* interface */ 80 int sc_iface_number; /* interface number */ 81 u_int16_t sc_product; 82 83 int sc_intr_number; /* interrupt number */ 84 usbd_pipe_handle sc_intr_pipe; /* interrupt pipe */ 85 u_char *sc_intr_buf; /* interrupt buffer */ 86 int sc_isize; 87 88 usb_cdc_line_state_t sc_line_state; /* current line state */ 89 u_char sc_dtr; /* current DTR state */ 90 u_char sc_rts; /* current RTS state */ 91 u_char sc_break; /* set break */ 92 93 u_char sc_status; 94 95 device_t sc_subdev; /* ucom device */ 96 97 u_char sc_dying; /* disconnecting */ 98 99 u_char sc_lsr; /* Local status register */ 100 u_char sc_msr; /* umct status register */ 101 102 u_int last_lcr; /* keep lcr register */ 103 }; 104 105 /* 106 * These are the maximum number of bytes transferred per frame. 107 * The output buffer size cannot be increased due to the size encoding. 108 */ 109 #define UMCTIBUFSIZE 256 110 #define UMCTOBUFSIZE 256 111 112 Static void umct_init(struct umct_softc *); 113 Static void umct_set_baudrate(struct umct_softc *, u_int); 114 Static void umct_set_lcr(struct umct_softc *, u_int); 115 Static void umct_intr(usbd_xfer_handle, usbd_private_handle, usbd_status); 116 117 Static void umct_set(void *, int, int, int); 118 Static void umct_dtr(struct umct_softc *, int); 119 Static void umct_rts(struct umct_softc *, int); 120 Static void umct_break(struct umct_softc *, int); 121 Static void umct_set_line_state(struct umct_softc *); 122 Static void umct_get_status(void *, int portno, u_char *lsr, u_char *msr); 123 Static int umct_param(void *, int, struct termios *); 124 Static int umct_open(void *, int); 125 Static void umct_close(void *, int); 126 127 struct ucom_methods umct_methods = { 128 umct_get_status, 129 umct_set, 130 umct_param, 131 NULL, 132 umct_open, 133 umct_close, 134 NULL, 135 NULL, 136 }; 137 138 static const struct usb_devno umct_devs[] = { 139 /* MCT USB-232 Interface Products */ 140 { USB_VENDOR_MCT, USB_PRODUCT_MCT_USB232 }, 141 /* Sitecom USB-232 Products */ 142 { USB_VENDOR_MCT, USB_PRODUCT_MCT_SITECOM_USB232 }, 143 /* D-Link DU-H3SP USB BAY Hub Products */ 144 { USB_VENDOR_MCT, USB_PRODUCT_MCT_DU_H3SP_USB232 }, 145 /* BELKIN F5U109 */ 146 { USB_VENDOR_BELKIN, USB_PRODUCT_BELKIN_F5U109 }, 147 }; 148 #define umct_lookup(v, p) usb_lookup(umct_devs, v, p) 149 150 int umct_match(device_t, cfdata_t, void *); 151 void umct_attach(device_t, device_t, void *); 152 void umct_childdet(device_t, device_t); 153 int umct_detach(device_t, int); 154 int umct_activate(device_t, enum devact); 155 extern struct cfdriver umct_cd; 156 CFATTACH_DECL2_NEW(umct, sizeof(struct umct_softc), umct_match, 157 umct_attach, umct_detach, umct_activate, NULL, umct_childdet); 158 159 USB_MATCH(umct) 160 { 161 USB_MATCH_START(umct, uaa); 162 163 return (umct_lookup(uaa->vendor, uaa->product) != NULL ? 164 UMATCH_VENDOR_PRODUCT : UMATCH_NONE); 165 } 166 167 USB_ATTACH(umct) 168 { 169 USB_ATTACH_START(umct, sc, uaa); 170 usbd_device_handle dev = uaa->device; 171 usb_config_descriptor_t *cdesc; 172 usb_interface_descriptor_t *id; 173 usb_endpoint_descriptor_t *ed; 174 175 char *devinfop; 176 usbd_status err; 177 int i; 178 struct ucom_attach_args uca; 179 180 sc->sc_dev = self; 181 182 aprint_naive("\n"); 183 aprint_normal("\n"); 184 185 devinfop = usbd_devinfo_alloc(dev, 0); 186 aprint_normal_dev(self, "%s\n", devinfop); 187 usbd_devinfo_free(devinfop); 188 189 sc->sc_udev = dev; 190 sc->sc_product = uaa->product; 191 192 DPRINTF(("\n\numct attach: sc=%p\n", sc)); 193 194 /* initialize endpoints */ 195 uca.bulkin = uca.bulkout = -1; 196 sc->sc_intr_number = -1; 197 sc->sc_intr_pipe = NULL; 198 199 /* Move the device into the configured state. */ 200 err = usbd_set_config_index(dev, UMCT_CONFIG_INDEX, 1); 201 if (err) { 202 aprint_error_dev(self, "failed to set configuration, err=%s\n", 203 usbd_errstr(err)); 204 sc->sc_dying = 1; 205 USB_ATTACH_ERROR_RETURN; 206 } 207 208 /* get the config descriptor */ 209 cdesc = usbd_get_config_descriptor(sc->sc_udev); 210 211 if (cdesc == NULL) { 212 aprint_error_dev(self, 213 "failed to get configuration descriptor\n"); 214 sc->sc_dying = 1; 215 USB_ATTACH_ERROR_RETURN; 216 } 217 218 /* get the interface */ 219 err = usbd_device2interface_handle(dev, UMCT_IFACE_INDEX, 220 &sc->sc_iface); 221 if (err) { 222 aprint_error_dev(self, "failed to get interface, err=%s\n", 223 usbd_errstr(err)); 224 sc->sc_dying = 1; 225 USB_ATTACH_ERROR_RETURN; 226 } 227 228 /* Find the bulk{in,out} and interrupt endpoints */ 229 230 id = usbd_get_interface_descriptor(sc->sc_iface); 231 sc->sc_iface_number = id->bInterfaceNumber; 232 233 for (i = 0; i < id->bNumEndpoints; i++) { 234 ed = usbd_interface2endpoint_descriptor(sc->sc_iface, i); 235 if (ed == NULL) { 236 aprint_error_dev(self, 237 "no endpoint descriptor for %d\n", i); 238 sc->sc_dying = 1; 239 USB_ATTACH_ERROR_RETURN; 240 } 241 242 /* 243 * The Bulkin endpoint is marked as an interrupt. Since 244 * we can't rely on the endpoint descriptor order, we'll 245 * check the wMaxPacketSize field to differentiate. 246 */ 247 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN && 248 UE_GET_XFERTYPE(ed->bmAttributes) == UE_INTERRUPT && 249 UGETW(ed->wMaxPacketSize) != 0x2) { 250 uca.bulkin = ed->bEndpointAddress; 251 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT && 252 UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) { 253 uca.bulkout = ed->bEndpointAddress; 254 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN && 255 UE_GET_XFERTYPE(ed->bmAttributes) == UE_INTERRUPT) { 256 sc->sc_intr_number = ed->bEndpointAddress; 257 sc->sc_isize = UGETW(ed->wMaxPacketSize); 258 } 259 } 260 261 if (uca.bulkin == -1) { 262 aprint_error_dev(self, "Could not find data bulk in\n"); 263 sc->sc_dying = 1; 264 USB_ATTACH_ERROR_RETURN; 265 } 266 267 if (uca.bulkout == -1) { 268 aprint_error_dev(self, "Could not find data bulk out\n"); 269 sc->sc_dying = 1; 270 USB_ATTACH_ERROR_RETURN; 271 } 272 273 if (sc->sc_intr_number== -1) { 274 aprint_error_dev(self, "Could not find interrupt in\n"); 275 sc->sc_dying = 1; 276 USB_ATTACH_ERROR_RETURN; 277 } 278 279 sc->sc_dtr = sc->sc_rts = 0; 280 uca.portno = UCOM_UNK_PORTNO; 281 /* bulkin, bulkout set above */ 282 uca.ibufsize = UMCTIBUFSIZE; 283 if (sc->sc_product == USB_PRODUCT_MCT_SITECOM_USB232) 284 uca.obufsize = 16; /* device is broken */ 285 else 286 uca.obufsize = UMCTOBUFSIZE; 287 uca.ibufsizepad = UMCTIBUFSIZE; 288 uca.opkthdrlen = 0; 289 uca.device = dev; 290 uca.iface = sc->sc_iface; 291 uca.methods = &umct_methods; 292 uca.arg = sc; 293 uca.info = NULL; 294 295 umct_init(sc); 296 297 usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev, 298 USBDEV(sc->sc_dev)); 299 300 DPRINTF(("umct: in=0x%x out=0x%x intr=0x%x\n", 301 uca.bulkin, uca.bulkout, sc->sc_intr_number )); 302 sc->sc_subdev = config_found_sm_loc(self, "ucombus", NULL, &uca, 303 ucomprint, ucomsubmatch); 304 305 USB_ATTACH_SUCCESS_RETURN; 306 } 307 308 void 309 umct_childdet(device_t self, device_t child) 310 { 311 struct umct_softc *sc = device_private(self); 312 313 KASSERT(sc->sc_subdev == child); 314 sc->sc_subdev = NULL; 315 } 316 317 USB_DETACH(umct) 318 { 319 USB_DETACH_START(umct, sc); 320 int rv = 0; 321 322 DPRINTF(("umct_detach: sc=%p flags=%d\n", sc, flags)); 323 324 if (sc->sc_intr_pipe != NULL) { 325 usbd_abort_pipe(sc->sc_intr_pipe); 326 usbd_close_pipe(sc->sc_intr_pipe); 327 free(sc->sc_intr_buf, M_USBDEV); 328 sc->sc_intr_pipe = NULL; 329 } 330 331 sc->sc_dying = 1; 332 if (sc->sc_subdev != NULL) 333 rv = config_detach(sc->sc_subdev, flags); 334 335 usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev, 336 USBDEV(sc->sc_dev)); 337 338 return (rv); 339 } 340 341 int 342 umct_activate(device_t self, enum devact act) 343 { 344 struct umct_softc *sc = device_private(self); 345 346 switch (act) { 347 case DVACT_DEACTIVATE: 348 sc->sc_dying = 1; 349 return 0; 350 default: 351 return EOPNOTSUPP; 352 } 353 } 354 355 void 356 umct_set_line_state(struct umct_softc *sc) 357 { 358 usb_device_request_t req; 359 uByte ls; 360 361 ls = (sc->sc_dtr ? MCR_DTR : 0) | 362 (sc->sc_rts ? MCR_RTS : 0); 363 364 DPRINTF(("umct_set_line_state: DTR=%d,RTS=%d,ls=%02x\n", 365 sc->sc_dtr, sc->sc_rts, ls)); 366 367 req.bmRequestType = UMCT_SET_REQUEST; 368 req.bRequest = REQ_SET_MCR; 369 USETW(req.wValue, 0); 370 USETW(req.wIndex, sc->sc_iface_number); 371 USETW(req.wLength, LENGTH_SET_MCR); 372 373 (void)usbd_do_request(sc->sc_udev, &req, &ls); 374 } 375 376 void 377 umct_set(void *addr, int portno, int reg, int onoff) 378 { 379 struct umct_softc *sc = addr; 380 381 switch (reg) { 382 case UCOM_SET_DTR: 383 umct_dtr(sc, onoff); 384 break; 385 case UCOM_SET_RTS: 386 umct_rts(sc, onoff); 387 break; 388 case UCOM_SET_BREAK: 389 umct_break(sc, onoff); 390 break; 391 default: 392 break; 393 } 394 } 395 396 void 397 umct_dtr(struct umct_softc *sc, int onoff) 398 { 399 400 DPRINTF(("umct_dtr: onoff=%d\n", onoff)); 401 402 if (sc->sc_dtr == onoff) 403 return; 404 sc->sc_dtr = onoff; 405 406 umct_set_line_state(sc); 407 } 408 409 void 410 umct_rts(struct umct_softc *sc, int onoff) 411 { 412 DPRINTF(("umct_rts: onoff=%d\n", onoff)); 413 414 if (sc->sc_rts == onoff) 415 return; 416 sc->sc_rts = onoff; 417 418 umct_set_line_state(sc); 419 } 420 421 void 422 umct_break(struct umct_softc *sc, int onoff) 423 { 424 DPRINTF(("umct_break: onoff=%d\n", onoff)); 425 426 umct_set_lcr(sc, onoff ? sc->last_lcr | LCR_SET_BREAK : 427 sc->last_lcr); 428 } 429 430 void 431 umct_set_lcr(struct umct_softc *sc, u_int data) 432 { 433 usb_device_request_t req; 434 uByte adata; 435 436 adata = data; 437 req.bmRequestType = UMCT_SET_REQUEST; 438 req.bRequest = REQ_SET_LCR; 439 USETW(req.wValue, 0); 440 USETW(req.wIndex, sc->sc_iface_number); 441 USETW(req.wLength, LENGTH_SET_LCR); 442 443 (void)usbd_do_request(sc->sc_udev, &req, &adata); /* XXX should check */ 444 } 445 446 void 447 umct_set_baudrate(struct umct_softc *sc, u_int rate) 448 { 449 usb_device_request_t req; 450 uDWord arate; 451 u_int val; 452 453 if (sc->sc_product == USB_PRODUCT_MCT_SITECOM_USB232 || 454 sc->sc_product == USB_PRODUCT_BELKIN_F5U109) { 455 switch (rate) { 456 case 300: val = 0x01; break; 457 case 600: val = 0x02; break; 458 case 1200: val = 0x03; break; 459 case 2400: val = 0x04; break; 460 case 4800: val = 0x06; break; 461 case 9600: val = 0x08; break; 462 case 19200: val = 0x09; break; 463 case 38400: val = 0x0a; break; 464 case 57600: val = 0x0b; break; 465 case 115200: val = 0x0c; break; 466 default: val = -1; break; 467 } 468 } else { 469 val = UMCT_BAUD_RATE(rate); 470 } 471 USETDW(arate, val); 472 473 req.bmRequestType = UMCT_SET_REQUEST; 474 req.bRequest = REQ_SET_BAUD_RATE; 475 USETW(req.wValue, 0); 476 USETW(req.wIndex, sc->sc_iface_number); 477 USETW(req.wLength, LENGTH_BAUD_RATE); 478 479 (void)usbd_do_request(sc->sc_udev, &req, arate); /* XXX should check */ 480 } 481 482 void 483 umct_init(struct umct_softc *sc) 484 { 485 umct_set_baudrate(sc, 9600); 486 umct_set_lcr(sc, LCR_DATA_BITS_8 | LCR_PARITY_NONE | LCR_STOP_BITS_1); 487 } 488 489 int 490 umct_param(void *addr, int portno, struct termios *t) 491 { 492 struct umct_softc *sc = addr; 493 u_int data = 0; 494 495 DPRINTF(("umct_param: sc=%p\n", sc)); 496 497 DPRINTF(("umct_param: BAUDRATE=%d\n", t->c_ospeed)); 498 499 if (ISSET(t->c_cflag, CSTOPB)) 500 data |= LCR_STOP_BITS_2; 501 else 502 data |= LCR_STOP_BITS_1; 503 if (ISSET(t->c_cflag, PARENB)) { 504 if (ISSET(t->c_cflag, PARODD)) 505 data |= LCR_PARITY_ODD; 506 else 507 data |= LCR_PARITY_EVEN; 508 } else 509 data |= LCR_PARITY_NONE; 510 switch (ISSET(t->c_cflag, CSIZE)) { 511 case CS5: 512 data |= LCR_DATA_BITS_5; 513 break; 514 case CS6: 515 data |= LCR_DATA_BITS_6; 516 break; 517 case CS7: 518 data |= LCR_DATA_BITS_7; 519 break; 520 case CS8: 521 data |= LCR_DATA_BITS_8; 522 break; 523 } 524 525 umct_set_baudrate(sc, t->c_ospeed); 526 527 sc->last_lcr = data; 528 umct_set_lcr(sc, data); 529 530 return (0); 531 } 532 533 int 534 umct_open(void *addr, int portno) 535 { 536 struct umct_softc *sc = addr; 537 int err, lcr_data; 538 539 if (sc->sc_dying) 540 return (EIO); 541 542 DPRINTF(("umct_open: sc=%p\n", sc)); 543 544 /* initialize LCR */ 545 lcr_data = LCR_DATA_BITS_8 | LCR_PARITY_NONE | 546 LCR_STOP_BITS_1; 547 umct_set_lcr(sc, lcr_data); 548 549 if (sc->sc_intr_number != -1 && sc->sc_intr_pipe == NULL) { 550 sc->sc_status = 0; /* clear status bit */ 551 sc->sc_intr_buf = malloc(sc->sc_isize, M_USBDEV, M_WAITOK); 552 err = usbd_open_pipe_intr(sc->sc_iface, sc->sc_intr_number, 553 USBD_SHORT_XFER_OK, &sc->sc_intr_pipe, sc, 554 sc->sc_intr_buf, sc->sc_isize, 555 umct_intr, USBD_DEFAULT_INTERVAL); 556 if (err) { 557 DPRINTF(("%s: cannot open interrupt pipe (addr %d)\n", 558 USBDEVNAME(sc->sc_dev), sc->sc_intr_number)); 559 return (EIO); 560 } 561 } 562 563 return (0); 564 } 565 566 void 567 umct_close(void *addr, int portno) 568 { 569 struct umct_softc *sc = addr; 570 int err; 571 572 if (sc->sc_dying) 573 return; 574 575 DPRINTF(("umct_close: close\n")); 576 577 if (sc->sc_intr_pipe != NULL) { 578 err = usbd_abort_pipe(sc->sc_intr_pipe); 579 if (err) 580 printf("%s: abort interrupt pipe failed: %s\n", 581 USBDEVNAME(sc->sc_dev), usbd_errstr(err)); 582 err = usbd_close_pipe(sc->sc_intr_pipe); 583 if (err) 584 printf("%s: close interrupt pipe failed: %s\n", 585 USBDEVNAME(sc->sc_dev), usbd_errstr(err)); 586 free(sc->sc_intr_buf, M_USBDEV); 587 sc->sc_intr_pipe = NULL; 588 } 589 } 590 591 void 592 umct_intr(usbd_xfer_handle xfer, usbd_private_handle priv, 593 usbd_status status) 594 { 595 struct umct_softc *sc = priv; 596 u_char *tbuf = sc->sc_intr_buf; 597 u_char mstatus; 598 599 if (sc->sc_dying) 600 return; 601 602 if (status != USBD_NORMAL_COMPLETION) { 603 if (status == USBD_NOT_STARTED || status == USBD_CANCELLED) 604 return; 605 606 DPRINTF(("%s: abnormal status: %s\n", USBDEVNAME(sc->sc_dev), 607 usbd_errstr(status))); 608 usbd_clear_endpoint_stall_async(sc->sc_intr_pipe); 609 return; 610 } 611 612 DPRINTF(("%s: umct status = MSR:%02x, LSR:%02x\n", 613 USBDEVNAME(sc->sc_dev), tbuf[0],tbuf[1])); 614 615 sc->sc_lsr = sc->sc_msr = 0; 616 mstatus = tbuf[0]; 617 if (ISSET(mstatus, MSR_DSR)) 618 sc->sc_msr |= UMSR_DSR; 619 if (ISSET(mstatus, MSR_DCD)) 620 sc->sc_msr |= UMSR_DCD; 621 ucom_status_change(device_private(sc->sc_subdev)); 622 } 623 624 void 625 umct_get_status(void *addr, int portno, u_char *lsr, u_char *msr) 626 { 627 struct umct_softc *sc = addr; 628 629 DPRINTF(("umct_get_status:\n")); 630 631 if (lsr != NULL) 632 *lsr = sc->sc_lsr; 633 if (msr != NULL) 634 *msr = sc->sc_msr; 635 } 636
Indexes created Fri Sep 26 08:10:20 GMT 2025