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