1/* 2 * Prolific PL2303 USB to serial adaptor driver 3 * 4 * Copyright (C) 2001-2004 Greg Kroah-Hartman (greg@kroah.com) 5 * Copyright (C) 2003 IBM Corp. 6 * 7 * Original driver for 2.2.x by anonymous 8 * 9 * This program is free software; you can redistribute it and/or modify 10 * it under the terms of the GNU General Public License as published by 11 * the Free Software Foundation; either version 2 of the License. 12 * 13 * See Documentation/usb/usb-serial.txt for more information on using this driver 14 * 15 */ 16 17#include <linux/kernel.h> 18#include <linux/errno.h> 19#include <linux/init.h> 20#include <linux/slab.h> 21#include <linux/tty.h> 22#include <linux/tty_driver.h> 23#include <linux/tty_flip.h> 24#include <linux/serial.h> 25#include <linux/module.h> 26#include <linux/moduleparam.h> 27#include <linux/spinlock.h> 28#include <asm/uaccess.h> 29#include <linux/usb.h> 30#include <linux/usb/serial.h> 31#include "pl2303.h" 32 33/* 34 * Version Information 35 */ 36#define DRIVER_DESC "Prolific PL2303 USB to serial adaptor driver" 37 38static int debug; 39 40#define PL2303_CLOSING_WAIT (30*HZ) 41 42#define PL2303_BUF_SIZE 1024 43#define PL2303_TMP_BUF_SIZE 1024 44 45struct pl2303_buf { 46 unsigned int buf_size; 47 char *buf_buf; 48 char *buf_get; 49 char *buf_put; 50}; 51 52static struct usb_device_id id_table [] = { 53 { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID) }, 54 { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_RSAQ2) }, 55 { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_DCU11) }, 56 { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_RSAQ3) }, 57 { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_PHAROS) }, 58 { USB_DEVICE(IODATA_VENDOR_ID, IODATA_PRODUCT_ID) }, 59 { USB_DEVICE(ATEN_VENDOR_ID, ATEN_PRODUCT_ID) }, 60 { USB_DEVICE(ATEN_VENDOR_ID2, ATEN_PRODUCT_ID) }, 61 { USB_DEVICE(ELCOM_VENDOR_ID, ELCOM_PRODUCT_ID) }, 62 { USB_DEVICE(ELCOM_VENDOR_ID, ELCOM_PRODUCT_ID_UCSGT) }, 63 { USB_DEVICE(ITEGNO_VENDOR_ID, ITEGNO_PRODUCT_ID) }, 64 { USB_DEVICE(ITEGNO_VENDOR_ID, ITEGNO_PRODUCT_ID_2080) }, 65 { USB_DEVICE(MA620_VENDOR_ID, MA620_PRODUCT_ID) }, 66 { USB_DEVICE(RATOC_VENDOR_ID, RATOC_PRODUCT_ID) }, 67 { USB_DEVICE(TRIPP_VENDOR_ID, TRIPP_PRODUCT_ID) }, 68 { USB_DEVICE(RADIOSHACK_VENDOR_ID, RADIOSHACK_PRODUCT_ID) }, 69 { USB_DEVICE(DCU10_VENDOR_ID, DCU10_PRODUCT_ID) }, 70 { USB_DEVICE(SITECOM_VENDOR_ID, SITECOM_PRODUCT_ID) }, 71 { USB_DEVICE(ALCATEL_VENDOR_ID, ALCATEL_PRODUCT_ID) }, 72 { USB_DEVICE(SAMSUNG_VENDOR_ID, SAMSUNG_PRODUCT_ID) }, 73 { USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_SX1) }, 74 { USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_X65) }, 75 { USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_X75) }, 76 { USB_DEVICE(SYNTECH_VENDOR_ID, SYNTECH_PRODUCT_ID) }, 77 { USB_DEVICE(NOKIA_CA42_VENDOR_ID, NOKIA_CA42_PRODUCT_ID) }, 78 { USB_DEVICE(CA_42_CA42_VENDOR_ID, CA_42_CA42_PRODUCT_ID) }, 79 { USB_DEVICE(SAGEM_VENDOR_ID, SAGEM_PRODUCT_ID) }, 80 { USB_DEVICE(LEADTEK_VENDOR_ID, LEADTEK_9531_PRODUCT_ID) }, 81 { USB_DEVICE(SPEEDDRAGON_VENDOR_ID, SPEEDDRAGON_PRODUCT_ID) }, 82 { USB_DEVICE(DATAPILOT_U2_VENDOR_ID, DATAPILOT_U2_PRODUCT_ID) }, 83 { USB_DEVICE(BELKIN_VENDOR_ID, BELKIN_PRODUCT_ID) }, 84 { USB_DEVICE(ALCOR_VENDOR_ID, ALCOR_PRODUCT_ID) }, 85 { USB_DEVICE(HUAWEI_VENDOR_ID, HUAWEI_PRODUCT_ID) }, 86 { USB_DEVICE(WS002IN_VENDOR_ID, WS002IN_PRODUCT_ID) }, 87 { } /* Terminating entry */ 88}; 89 90MODULE_DEVICE_TABLE(usb, id_table); 91 92static struct usb_driver pl2303_driver = { 93 .name = "pl2303", 94 .probe = usb_serial_probe, 95 .disconnect = usb_serial_disconnect, 96 .id_table = id_table, 97 .no_dynamic_id = 1, 98}; 99 100#define SET_LINE_REQUEST_TYPE 0x21 101#define SET_LINE_REQUEST 0x20 102 103#define SET_CONTROL_REQUEST_TYPE 0x21 104#define SET_CONTROL_REQUEST 0x22 105#define CONTROL_DTR 0x01 106#define CONTROL_RTS 0x02 107 108#define BREAK_REQUEST_TYPE 0x21 109#define BREAK_REQUEST 0x23 110#define BREAK_ON 0xffff 111#define BREAK_OFF 0x0000 112 113#define GET_LINE_REQUEST_TYPE 0xa1 114#define GET_LINE_REQUEST 0x21 115 116#define VENDOR_WRITE_REQUEST_TYPE 0x40 117#define VENDOR_WRITE_REQUEST 0x01 118 119#define VENDOR_READ_REQUEST_TYPE 0xc0 120#define VENDOR_READ_REQUEST 0x01 121 122#define UART_STATE 0x08 123#define UART_STATE_TRANSIENT_MASK 0x74 124#define UART_DCD 0x01 125#define UART_DSR 0x02 126#define UART_BREAK_ERROR 0x04 127#define UART_RING 0x08 128#define UART_FRAME_ERROR 0x10 129#define UART_PARITY_ERROR 0x20 130#define UART_OVERRUN_ERROR 0x40 131#define UART_CTS 0x80 132 133 134enum pl2303_type { 135 type_0, /* don't know the difference between type 0 and */ 136 type_1, /* type 1, until someone from prolific tells us... */ 137 HX, /* HX version of the pl2303 chip */ 138}; 139 140struct pl2303_private { 141 spinlock_t lock; 142 struct pl2303_buf *buf; 143 int write_urb_in_use; 144 wait_queue_head_t delta_msr_wait; 145 u8 line_control; 146 u8 line_status; 147 u8 termios_initialized; 148 enum pl2303_type type; 149}; 150 151/* 152 * pl2303_buf_alloc 153 * 154 * Allocate a circular buffer and all associated memory. 155 */ 156static struct pl2303_buf *pl2303_buf_alloc(unsigned int size) 157{ 158 struct pl2303_buf *pb; 159 160 if (size == 0) 161 return NULL; 162 163 pb = kmalloc(sizeof(struct pl2303_buf), GFP_KERNEL); 164 if (pb == NULL) 165 return NULL; 166 167 pb->buf_buf = kmalloc(size, GFP_KERNEL); 168 if (pb->buf_buf == NULL) { 169 kfree(pb); 170 return NULL; 171 } 172 173 pb->buf_size = size; 174 pb->buf_get = pb->buf_put = pb->buf_buf; 175 176 return pb; 177} 178 179/* 180 * pl2303_buf_free 181 * 182 * Free the buffer and all associated memory. 183 */ 184static void pl2303_buf_free(struct pl2303_buf *pb) 185{ 186 if (pb) { 187 kfree(pb->buf_buf); 188 kfree(pb); 189 } 190} 191 192/* 193 * pl2303_buf_clear 194 * 195 * Clear out all data in the circular buffer. 196 */ 197static void pl2303_buf_clear(struct pl2303_buf *pb) 198{ 199 if (pb != NULL) 200 pb->buf_get = pb->buf_put; 201 /* equivalent to a get of all data available */ 202} 203 204/* 205 * pl2303_buf_data_avail 206 * 207 * Return the number of bytes of data available in the circular 208 * buffer. 209 */ 210static unsigned int pl2303_buf_data_avail(struct pl2303_buf *pb) 211{ 212 if (pb == NULL) 213 return 0; 214 215 return ((pb->buf_size + pb->buf_put - pb->buf_get) % pb->buf_size); 216} 217 218/* 219 * pl2303_buf_space_avail 220 * 221 * Return the number of bytes of space available in the circular 222 * buffer. 223 */ 224static unsigned int pl2303_buf_space_avail(struct pl2303_buf *pb) 225{ 226 if (pb == NULL) 227 return 0; 228 229 return ((pb->buf_size + pb->buf_get - pb->buf_put - 1) % pb->buf_size); 230} 231 232/* 233 * pl2303_buf_put 234 * 235 * Copy data data from a user buffer and put it into the circular buffer. 236 * Restrict to the amount of space available. 237 * 238 * Return the number of bytes copied. 239 */ 240static unsigned int pl2303_buf_put(struct pl2303_buf *pb, const char *buf, 241 unsigned int count) 242{ 243 unsigned int len; 244 245 if (pb == NULL) 246 return 0; 247 248 len = pl2303_buf_space_avail(pb); 249 if (count > len) 250 count = len; 251 252 if (count == 0) 253 return 0; 254 255 len = pb->buf_buf + pb->buf_size - pb->buf_put; 256 if (count > len) { 257 memcpy(pb->buf_put, buf, len); 258 memcpy(pb->buf_buf, buf+len, count - len); 259 pb->buf_put = pb->buf_buf + count - len; 260 } else { 261 memcpy(pb->buf_put, buf, count); 262 if (count < len) 263 pb->buf_put += count; 264 else /* count == len */ 265 pb->buf_put = pb->buf_buf; 266 } 267 268 return count; 269} 270 271/* 272 * pl2303_buf_get 273 * 274 * Get data from the circular buffer and copy to the given buffer. 275 * Restrict to the amount of data available. 276 * 277 * Return the number of bytes copied. 278 */ 279static unsigned int pl2303_buf_get(struct pl2303_buf *pb, char *buf, 280 unsigned int count) 281{ 282 unsigned int len; 283 284 if (pb == NULL) 285 return 0; 286 287 len = pl2303_buf_data_avail(pb); 288 if (count > len) 289 count = len; 290 291 if (count == 0) 292 return 0; 293 294 len = pb->buf_buf + pb->buf_size - pb->buf_get; 295 if (count > len) { 296 memcpy(buf, pb->buf_get, len); 297 memcpy(buf+len, pb->buf_buf, count - len); 298 pb->buf_get = pb->buf_buf + count - len; 299 } else { 300 memcpy(buf, pb->buf_get, count); 301 if (count < len) 302 pb->buf_get += count; 303 else /* count == len */ 304 pb->buf_get = pb->buf_buf; 305 } 306 307 return count; 308} 309 310static int pl2303_startup(struct usb_serial *serial) 311{ 312 struct pl2303_private *priv; 313 enum pl2303_type type = type_0; 314 int i; 315 316 if (serial->dev->descriptor.bDeviceClass == 0x02) 317 type = type_0; 318 else if (serial->dev->descriptor.bMaxPacketSize0 == 0x40) 319 type = HX; 320 else if (serial->dev->descriptor.bDeviceClass == 0x00) 321 type = type_1; 322 else if (serial->dev->descriptor.bDeviceClass == 0xFF) 323 type = type_1; 324 dbg("device type: %d", type); 325 326 for (i = 0; i < serial->num_ports; ++i) { 327 priv = kzalloc(sizeof(struct pl2303_private), GFP_KERNEL); 328 if (!priv) 329 goto cleanup; 330 spin_lock_init(&priv->lock); 331 priv->buf = pl2303_buf_alloc(PL2303_BUF_SIZE); 332 if (priv->buf == NULL) { 333 kfree(priv); 334 goto cleanup; 335 } 336 init_waitqueue_head(&priv->delta_msr_wait); 337 priv->type = type; 338 usb_set_serial_port_data(serial->port[i], priv); 339 } 340 return 0; 341 342cleanup: 343 for (--i; i>=0; --i) { 344 priv = usb_get_serial_port_data(serial->port[i]); 345 pl2303_buf_free(priv->buf); 346 kfree(priv); 347 usb_set_serial_port_data(serial->port[i], NULL); 348 } 349 return -ENOMEM; 350} 351 352static int set_control_lines(struct usb_device *dev, u8 value) 353{ 354 int retval; 355 356 retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0), 357 SET_CONTROL_REQUEST, SET_CONTROL_REQUEST_TYPE, 358 value, 0, NULL, 0, 100); 359 dbg("%s - value = %d, retval = %d", __FUNCTION__, value, retval); 360 return retval; 361} 362 363static void pl2303_send(struct usb_serial_port *port) 364{ 365 int count, result; 366 struct pl2303_private *priv = usb_get_serial_port_data(port); 367 unsigned long flags; 368 369 dbg("%s - port %d", __FUNCTION__, port->number); 370 371 spin_lock_irqsave(&priv->lock, flags); 372 373 if (priv->write_urb_in_use) { 374 spin_unlock_irqrestore(&priv->lock, flags); 375 return; 376 } 377 378 count = pl2303_buf_get(priv->buf, port->write_urb->transfer_buffer, 379 port->bulk_out_size); 380 381 if (count == 0) { 382 spin_unlock_irqrestore(&priv->lock, flags); 383 return; 384 } 385 386 priv->write_urb_in_use = 1; 387 388 spin_unlock_irqrestore(&priv->lock, flags); 389 390 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, count, 391 port->write_urb->transfer_buffer); 392 393 port->write_urb->transfer_buffer_length = count; 394 port->write_urb->dev = port->serial->dev; 395 result = usb_submit_urb(port->write_urb, GFP_ATOMIC); 396 if (result) { 397 dev_err(&port->dev, "%s - failed submitting write urb," 398 " error %d\n", __FUNCTION__, result); 399 priv->write_urb_in_use = 0; 400 // TODO: reschedule pl2303_send 401 } 402 403 usb_serial_port_softint(port); 404} 405 406static int pl2303_write(struct usb_serial_port *port, const unsigned char *buf, 407 int count) 408{ 409 struct pl2303_private *priv = usb_get_serial_port_data(port); 410 unsigned long flags; 411 412 dbg("%s - port %d, %d bytes", __FUNCTION__, port->number, count); 413 414 if (!count) 415 return count; 416 417 spin_lock_irqsave(&priv->lock, flags); 418 count = pl2303_buf_put(priv->buf, buf, count); 419 spin_unlock_irqrestore(&priv->lock, flags); 420 421 pl2303_send(port); 422 423 return count; 424} 425 426static int pl2303_write_room(struct usb_serial_port *port) 427{ 428 struct pl2303_private *priv = usb_get_serial_port_data(port); 429 int room = 0; 430 unsigned long flags; 431 432 dbg("%s - port %d", __FUNCTION__, port->number); 433 434 spin_lock_irqsave(&priv->lock, flags); 435 room = pl2303_buf_space_avail(priv->buf); 436 spin_unlock_irqrestore(&priv->lock, flags); 437 438 dbg("%s - returns %d", __FUNCTION__, room); 439 return room; 440} 441 442static int pl2303_chars_in_buffer(struct usb_serial_port *port) 443{ 444 struct pl2303_private *priv = usb_get_serial_port_data(port); 445 int chars = 0; 446 unsigned long flags; 447 448 dbg("%s - port %d", __FUNCTION__, port->number); 449 450 spin_lock_irqsave(&priv->lock, flags); 451 chars = pl2303_buf_data_avail(priv->buf); 452 spin_unlock_irqrestore(&priv->lock, flags); 453 454 dbg("%s - returns %d", __FUNCTION__, chars); 455 return chars; 456} 457 458static void pl2303_set_termios(struct usb_serial_port *port, 459 struct ktermios *old_termios) 460{ 461 struct usb_serial *serial = port->serial; 462 struct pl2303_private *priv = usb_get_serial_port_data(port); 463 unsigned long flags; 464 unsigned int cflag; 465 unsigned char *buf; 466 int baud; 467 int i; 468 u8 control; 469 470 dbg("%s - port %d", __FUNCTION__, port->number); 471 472 if ((!port->tty) || (!port->tty->termios)) { 473 dbg("%s - no tty structures", __FUNCTION__); 474 return; 475 } 476 477 spin_lock_irqsave(&priv->lock, flags); 478 if (!priv->termios_initialized) { 479 *(port->tty->termios) = tty_std_termios; 480 port->tty->termios->c_cflag = B9600 | CS8 | CREAD | 481 HUPCL | CLOCAL; 482 priv->termios_initialized = 1; 483 } 484 spin_unlock_irqrestore(&priv->lock, flags); 485 486 cflag = port->tty->termios->c_cflag; 487 /* check that they really want us to change something */ 488 if (old_termios) { 489 if ((cflag == old_termios->c_cflag) && 490 (RELEVANT_IFLAG(port->tty->termios->c_iflag) == 491 RELEVANT_IFLAG(old_termios->c_iflag))) { 492 dbg("%s - nothing to change...", __FUNCTION__); 493 return; 494 } 495 } 496 497 buf = kzalloc(7, GFP_KERNEL); 498 if (!buf) { 499 dev_err(&port->dev, "%s - out of memory.\n", __FUNCTION__); 500 return; 501 } 502 503 i = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0), 504 GET_LINE_REQUEST, GET_LINE_REQUEST_TYPE, 505 0, 0, buf, 7, 100); 506 dbg("0xa1:0x21:0:0 %d - %x %x %x %x %x %x %x", i, 507 buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6]); 508 509 if (cflag & CSIZE) { 510 switch (cflag & CSIZE) { 511 case CS5: buf[6] = 5; break; 512 case CS6: buf[6] = 6; break; 513 case CS7: buf[6] = 7; break; 514 default: 515 case CS8: buf[6] = 8; break; 516 } 517 dbg("%s - data bits = %d", __FUNCTION__, buf[6]); 518 } 519 520 baud = 0; 521 switch (cflag & CBAUD) { 522 case B0: baud = 0; break; 523 case B75: baud = 75; break; 524 case B150: baud = 150; break; 525 case B300: baud = 300; break; 526 case B600: baud = 600; break; 527 case B1200: baud = 1200; break; 528 case B1800: baud = 1800; break; 529 case B2400: baud = 2400; break; 530 case B4800: baud = 4800; break; 531 case B9600: baud = 9600; break; 532 case B19200: baud = 19200; break; 533 case B38400: baud = 38400; break; 534 case B57600: baud = 57600; break; 535 case B115200: baud = 115200; break; 536 case B230400: baud = 230400; break; 537 case B460800: baud = 460800; break; 538 default: 539 dev_err(&port->dev, "pl2303 driver does not support" 540 " the baudrate requested (fix it)\n"); 541 break; 542 } 543 dbg("%s - baud = %d", __FUNCTION__, baud); 544 if (baud) { 545 buf[0] = baud & 0xff; 546 buf[1] = (baud >> 8) & 0xff; 547 buf[2] = (baud >> 16) & 0xff; 548 buf[3] = (baud >> 24) & 0xff; 549 } 550 551 /* For reference buf[4]=0 is 1 stop bits */ 552 /* For reference buf[4]=1 is 1.5 stop bits */ 553 /* For reference buf[4]=2 is 2 stop bits */ 554 if (cflag & CSTOPB) { 555 buf[4] = 2; 556 dbg("%s - stop bits = 2", __FUNCTION__); 557 } else { 558 buf[4] = 0; 559 dbg("%s - stop bits = 1", __FUNCTION__); 560 } 561 562 if (cflag & PARENB) { 563 /* For reference buf[5]=0 is none parity */ 564 /* For reference buf[5]=1 is odd parity */ 565 /* For reference buf[5]=2 is even parity */ 566 /* For reference buf[5]=3 is mark parity */ 567 /* For reference buf[5]=4 is space parity */ 568 if (cflag & PARODD) { 569 buf[5] = 1; 570 dbg("%s - parity = odd", __FUNCTION__); 571 } else { 572 buf[5] = 2; 573 dbg("%s - parity = even", __FUNCTION__); 574 } 575 } else { 576 buf[5] = 0; 577 dbg("%s - parity = none", __FUNCTION__); 578 } 579 580 i = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0), 581 SET_LINE_REQUEST, SET_LINE_REQUEST_TYPE, 582 0, 0, buf, 7, 100); 583 dbg("0x21:0x20:0:0 %d", i); 584 585 /* change control lines if we are switching to or from B0 */ 586 spin_lock_irqsave(&priv->lock, flags); 587 control = priv->line_control; 588 if ((cflag & CBAUD) == B0) 589 priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS); 590 else 591 priv->line_control |= (CONTROL_DTR | CONTROL_RTS); 592 if (control != priv->line_control) { 593 control = priv->line_control; 594 spin_unlock_irqrestore(&priv->lock, flags); 595 set_control_lines(serial->dev, control); 596 } else { 597 spin_unlock_irqrestore(&priv->lock, flags); 598 } 599 600 buf[0] = buf[1] = buf[2] = buf[3] = buf[4] = buf[5] = buf[6] = 0; 601 602 i = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0), 603 GET_LINE_REQUEST, GET_LINE_REQUEST_TYPE, 604 0, 0, buf, 7, 100); 605 dbg("0xa1:0x21:0:0 %d - %x %x %x %x %x %x %x", i, 606 buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6]); 607 608 if (cflag & CRTSCTS) { 609 __u16 index; 610 if (priv->type == HX) 611 index = 0x61; 612 else 613 index = 0x41; 614 i = usb_control_msg(serial->dev, 615 usb_sndctrlpipe(serial->dev, 0), 616 VENDOR_WRITE_REQUEST, 617 VENDOR_WRITE_REQUEST_TYPE, 618 0x0, index, NULL, 0, 100); 619 dbg("0x40:0x1:0x0:0x%x %d", index, i); 620 } 621 622 kfree(buf); 623} 624 625static void pl2303_close(struct usb_serial_port *port, struct file *filp) 626{ 627 struct pl2303_private *priv = usb_get_serial_port_data(port); 628 unsigned long flags; 629 unsigned int c_cflag; 630 int bps; 631 long timeout; 632 wait_queue_t wait; 633 634 dbg("%s - port %d", __FUNCTION__, port->number); 635 636 /* wait for data to drain from the buffer */ 637 spin_lock_irqsave(&priv->lock, flags); 638 timeout = PL2303_CLOSING_WAIT; 639 init_waitqueue_entry(&wait, current); 640 add_wait_queue(&port->tty->write_wait, &wait); 641 for (;;) { 642 set_current_state(TASK_INTERRUPTIBLE); 643 if (pl2303_buf_data_avail(priv->buf) == 0 || 644 timeout == 0 || signal_pending(current) || 645 !usb_get_intfdata(port->serial->interface)) /* disconnect */ 646 break; 647 spin_unlock_irqrestore(&priv->lock, flags); 648 timeout = schedule_timeout(timeout); 649 spin_lock_irqsave(&priv->lock, flags); 650 } 651 set_current_state(TASK_RUNNING); 652 remove_wait_queue(&port->tty->write_wait, &wait); 653 /* clear out any remaining data in the buffer */ 654 pl2303_buf_clear(priv->buf); 655 spin_unlock_irqrestore(&priv->lock, flags); 656 657 /* wait for characters to drain from the device */ 658 /* (this is long enough for the entire 256 byte */ 659 /* pl2303 hardware buffer to drain with no flow */ 660 /* control for data rates of 1200 bps or more, */ 661 /* for lower rates we should really know how much */ 662 /* data is in the buffer to compute a delay */ 663 /* that is not unnecessarily long) */ 664 bps = tty_get_baud_rate(port->tty); 665 if (bps > 1200) 666 timeout = max((HZ*2560)/bps,HZ/10); 667 else 668 timeout = 2*HZ; 669 schedule_timeout_interruptible(timeout); 670 671 /* shutdown our urbs */ 672 dbg("%s - shutting down urbs", __FUNCTION__); 673 usb_kill_urb(port->write_urb); 674 usb_kill_urb(port->read_urb); 675 usb_kill_urb(port->interrupt_in_urb); 676 677 if (port->tty) { 678 c_cflag = port->tty->termios->c_cflag; 679 if (c_cflag & HUPCL) { 680 /* drop DTR and RTS */ 681 spin_lock_irqsave(&priv->lock, flags); 682 priv->line_control = 0; 683 spin_unlock_irqrestore(&priv->lock, flags); 684 set_control_lines(port->serial->dev, 0); 685 } 686 } 687} 688 689static int pl2303_open(struct usb_serial_port *port, struct file *filp) 690{ 691 struct ktermios tmp_termios; 692 struct usb_serial *serial = port->serial; 693 struct pl2303_private *priv = usb_get_serial_port_data(port); 694 unsigned char *buf; 695 int result; 696 697 dbg("%s - port %d", __FUNCTION__, port->number); 698 699 if (priv->type != HX) { 700 usb_clear_halt(serial->dev, port->write_urb->pipe); 701 usb_clear_halt(serial->dev, port->read_urb->pipe); 702 } 703 704 buf = kmalloc(10, GFP_KERNEL); 705 if (buf==NULL) 706 return -ENOMEM; 707 708#define FISH(a,b,c,d) \ 709 result=usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev,0), \ 710 b, a, c, d, buf, 1, 100); \ 711 dbg("0x%x:0x%x:0x%x:0x%x %d - %x",a,b,c,d,result,buf[0]); 712 713#define SOUP(a,b,c,d) \ 714 result=usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev,0), \ 715 b, a, c, d, NULL, 0, 100); \ 716 dbg("0x%x:0x%x:0x%x:0x%x %d",a,b,c,d,result); 717 718 FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8484, 0); 719 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 0x0404, 0); 720 FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8484, 0); 721 FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8383, 0); 722 FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8484, 0); 723 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 0x0404, 1); 724 FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8484, 0); 725 FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8383, 0); 726 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 0, 1); 727 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 1, 0); 728 729 if (priv->type == HX) { 730 /* HX chip */ 731 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 2, 0x44); 732 /* reset upstream data pipes */ 733 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 8, 0); 734 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 9, 0); 735 } else { 736 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 2, 0x24); 737 } 738 739 kfree(buf); 740 741 /* Setup termios */ 742 if (port->tty) { 743 pl2303_set_termios(port, &tmp_termios); 744 } 745 746 747 dbg("%s - submitting read urb", __FUNCTION__); 748 port->read_urb->dev = serial->dev; 749 result = usb_submit_urb(port->read_urb, GFP_KERNEL); 750 if (result) { 751 dev_err(&port->dev, "%s - failed submitting read urb," 752 " error %d\n", __FUNCTION__, result); 753 pl2303_close(port, NULL); 754 return -EPROTO; 755 } 756 757 dbg("%s - submitting interrupt urb", __FUNCTION__); 758 port->interrupt_in_urb->dev = serial->dev; 759 result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL); 760 if (result) { 761 dev_err(&port->dev, "%s - failed submitting interrupt urb," 762 " error %d\n", __FUNCTION__, result); 763 pl2303_close(port, NULL); 764 return -EPROTO; 765 } 766 return 0; 767} 768 769static int pl2303_tiocmset(struct usb_serial_port *port, struct file *file, 770 unsigned int set, unsigned int clear) 771{ 772 struct pl2303_private *priv = usb_get_serial_port_data(port); 773 unsigned long flags; 774 u8 control; 775 776 if (!usb_get_intfdata(port->serial->interface)) 777 return -ENODEV; 778 779 spin_lock_irqsave(&priv->lock, flags); 780 if (set & TIOCM_RTS) 781 priv->line_control |= CONTROL_RTS; 782 if (set & TIOCM_DTR) 783 priv->line_control |= CONTROL_DTR; 784 if (clear & TIOCM_RTS) 785 priv->line_control &= ~CONTROL_RTS; 786 if (clear & TIOCM_DTR) 787 priv->line_control &= ~CONTROL_DTR; 788 control = priv->line_control; 789 spin_unlock_irqrestore(&priv->lock, flags); 790 791 return set_control_lines(port->serial->dev, control); 792} 793 794static int pl2303_tiocmget(struct usb_serial_port *port, struct file *file) 795{ 796 struct pl2303_private *priv = usb_get_serial_port_data(port); 797 unsigned long flags; 798 unsigned int mcr; 799 unsigned int status; 800 unsigned int result; 801 802 dbg("%s (%d)", __FUNCTION__, port->number); 803 804 if (!usb_get_intfdata(port->serial->interface)) 805 return -ENODEV; 806 807 spin_lock_irqsave(&priv->lock, flags); 808 mcr = priv->line_control; 809 status = priv->line_status; 810 spin_unlock_irqrestore(&priv->lock, flags); 811 812 result = ((mcr & CONTROL_DTR) ? TIOCM_DTR : 0) 813 | ((mcr & CONTROL_RTS) ? TIOCM_RTS : 0) 814 | ((status & UART_CTS) ? TIOCM_CTS : 0) 815 | ((status & UART_DSR) ? TIOCM_DSR : 0) 816 | ((status & UART_RING) ? TIOCM_RI : 0) 817 | ((status & UART_DCD) ? TIOCM_CD : 0); 818 819 dbg("%s - result = %x", __FUNCTION__, result); 820 821 return result; 822} 823 824static int wait_modem_info(struct usb_serial_port *port, unsigned int arg) 825{ 826 struct pl2303_private *priv = usb_get_serial_port_data(port); 827 unsigned long flags; 828 unsigned int prevstatus; 829 unsigned int status; 830 unsigned int changed; 831 832 spin_lock_irqsave(&priv->lock, flags); 833 prevstatus = priv->line_status; 834 spin_unlock_irqrestore(&priv->lock, flags); 835 836 while (1) { 837 interruptible_sleep_on(&priv->delta_msr_wait); 838 /* see if a signal did it */ 839 if (signal_pending(current)) 840 return -ERESTARTSYS; 841 842 spin_lock_irqsave(&priv->lock, flags); 843 status = priv->line_status; 844 spin_unlock_irqrestore(&priv->lock, flags); 845 846 changed=prevstatus^status; 847 848 if (((arg & TIOCM_RNG) && (changed & UART_RING)) || 849 ((arg & TIOCM_DSR) && (changed & UART_DSR)) || 850 ((arg & TIOCM_CD) && (changed & UART_DCD)) || 851 ((arg & TIOCM_CTS) && (changed & UART_CTS)) ) { 852 return 0; 853 } 854 prevstatus = status; 855 } 856 /* NOTREACHED */ 857 return 0; 858} 859 860static int pl2303_ioctl(struct usb_serial_port *port, struct file *file, 861 unsigned int cmd, unsigned long arg) 862{ 863 dbg("%s (%d) cmd = 0x%04x", __FUNCTION__, port->number, cmd); 864 865 switch (cmd) { 866 case TIOCMIWAIT: 867 dbg("%s (%d) TIOCMIWAIT", __FUNCTION__, port->number); 868 return wait_modem_info(port, arg); 869 870 default: 871 dbg("%s not supported = 0x%04x", __FUNCTION__, cmd); 872 break; 873 } 874 875 return -ENOIOCTLCMD; 876} 877 878static void pl2303_break_ctl(struct usb_serial_port *port, int break_state) 879{ 880 struct usb_serial *serial = port->serial; 881 u16 state; 882 int result; 883 884 dbg("%s - port %d", __FUNCTION__, port->number); 885 886 if (break_state == 0) 887 state = BREAK_OFF; 888 else 889 state = BREAK_ON; 890 dbg("%s - turning break %s", __FUNCTION__, state==BREAK_OFF ? "off" : "on"); 891 892 result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0), 893 BREAK_REQUEST, BREAK_REQUEST_TYPE, state, 894 0, NULL, 0, 100); 895 if (result) 896 dbg("%s - error sending break = %d", __FUNCTION__, result); 897} 898 899static void pl2303_shutdown(struct usb_serial *serial) 900{ 901 int i; 902 struct pl2303_private *priv; 903 904 dbg("%s", __FUNCTION__); 905 906 for (i = 0; i < serial->num_ports; ++i) { 907 priv = usb_get_serial_port_data(serial->port[i]); 908 if (priv) { 909 pl2303_buf_free(priv->buf); 910 kfree(priv); 911 usb_set_serial_port_data(serial->port[i], NULL); 912 } 913 } 914} 915 916static void pl2303_update_line_status(struct usb_serial_port *port, 917 unsigned char *data, 918 unsigned int actual_length) 919{ 920 921 struct pl2303_private *priv = usb_get_serial_port_data(port); 922 unsigned long flags; 923 u8 status_idx = UART_STATE; 924 u8 length = UART_STATE + 1; 925 u16 idv, idp; 926 927 idv = le16_to_cpu(port->serial->dev->descriptor.idVendor); 928 idp = le16_to_cpu(port->serial->dev->descriptor.idProduct); 929 930 931 if (idv == SIEMENS_VENDOR_ID) { 932 if (idp == SIEMENS_PRODUCT_ID_X65 || 933 idp == SIEMENS_PRODUCT_ID_SX1 || 934 idp == SIEMENS_PRODUCT_ID_X75) { 935 936 length = 1; 937 status_idx = 0; 938 } 939 } 940 941 if (actual_length < length) 942 return; 943 944 /* Save off the uart status for others to look at */ 945 spin_lock_irqsave(&priv->lock, flags); 946 priv->line_status = data[status_idx]; 947 spin_unlock_irqrestore(&priv->lock, flags); 948 wake_up_interruptible(&priv->delta_msr_wait); 949} 950 951static void pl2303_read_int_callback(struct urb *urb) 952{ 953 struct usb_serial_port *port = (struct usb_serial_port *) urb->context; 954 unsigned char *data = urb->transfer_buffer; 955 unsigned int actual_length = urb->actual_length; 956 int status; 957 958 dbg("%s (%d)", __FUNCTION__, port->number); 959 960 switch (urb->status) { 961 case 0: 962 /* success */ 963 break; 964 case -ECONNRESET: 965 case -ENOENT: 966 case -ESHUTDOWN: 967 /* this urb is terminated, clean up */ 968 dbg("%s - urb shutting down with status: %d", __FUNCTION__, 969 urb->status); 970 return; 971 default: 972 dbg("%s - nonzero urb status received: %d", __FUNCTION__, 973 urb->status); 974 goto exit; 975 } 976 977 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, 978 urb->actual_length, urb->transfer_buffer); 979 980 pl2303_update_line_status(port, data, actual_length); 981 982exit: 983 status = usb_submit_urb(urb, GFP_ATOMIC); 984 if (status) 985 dev_err(&urb->dev->dev, 986 "%s - usb_submit_urb failed with result %d\n", 987 __FUNCTION__, status); 988} 989 990static void pl2303_read_bulk_callback(struct urb *urb) 991{ 992 struct usb_serial_port *port = (struct usb_serial_port *) urb->context; 993 struct pl2303_private *priv = usb_get_serial_port_data(port); 994 struct tty_struct *tty; 995 unsigned char *data = urb->transfer_buffer; 996 unsigned long flags; 997 int i; 998 int result; 999 u8 status; 1000 char tty_flag; 1001 1002 dbg("%s - port %d", __FUNCTION__, port->number); 1003 1004 if (urb->status) { 1005 dbg("%s - urb->status = %d", __FUNCTION__, urb->status); 1006 if (!port->open_count) { 1007 dbg("%s - port is closed, exiting.", __FUNCTION__); 1008 return; 1009 } 1010 if (urb->status == -EPROTO) { 1011 /* PL2303 mysteriously fails with -EPROTO reschedule 1012 * the read */ 1013 dbg("%s - caught -EPROTO, resubmitting the urb", 1014 __FUNCTION__); 1015 urb->status = 0; 1016 urb->dev = port->serial->dev; 1017 result = usb_submit_urb(urb, GFP_ATOMIC); 1018 if (result) 1019 dev_err(&urb->dev->dev, "%s - failed" 1020 " resubmitting read urb, error %d\n", 1021 __FUNCTION__, result); 1022 return; 1023 } 1024 dbg("%s - unable to handle the error, exiting.", __FUNCTION__); 1025 return; 1026 } 1027 1028 usb_serial_debug_data(debug, &port->dev, __FUNCTION__, 1029 urb->actual_length, data); 1030 1031 /* get tty_flag from status */ 1032 tty_flag = TTY_NORMAL; 1033 1034 spin_lock_irqsave(&priv->lock, flags); 1035 status = priv->line_status; 1036 priv->line_status &= ~UART_STATE_TRANSIENT_MASK; 1037 spin_unlock_irqrestore(&priv->lock, flags); 1038 wake_up_interruptible(&priv->delta_msr_wait); 1039 1040 /* break takes precedence over parity, */ 1041 /* which takes precedence over framing errors */ 1042 if (status & UART_BREAK_ERROR ) 1043 tty_flag = TTY_BREAK; 1044 else if (status & UART_PARITY_ERROR) 1045 tty_flag = TTY_PARITY; 1046 else if (status & UART_FRAME_ERROR) 1047 tty_flag = TTY_FRAME; 1048 dbg("%s - tty_flag = %d", __FUNCTION__, tty_flag); 1049 1050 tty = port->tty; 1051 if (tty && urb->actual_length) { 1052 tty_buffer_request_room(tty, urb->actual_length + 1); 1053 /* overrun is special, not associated with a char */ 1054 if (status & UART_OVERRUN_ERROR) 1055 tty_insert_flip_char(tty, 0, TTY_OVERRUN); 1056 for (i = 0; i < urb->actual_length; ++i) 1057 tty_insert_flip_char(tty, data[i], tty_flag); 1058 tty_flip_buffer_push(tty); 1059 } 1060 1061 /* Schedule the next read _if_ we are still open */ 1062 if (port->open_count) { 1063 urb->dev = port->serial->dev; 1064 result = usb_submit_urb(urb, GFP_ATOMIC); 1065 if (result) 1066 dev_err(&urb->dev->dev, "%s - failed resubmitting" 1067 " read urb, error %d\n", __FUNCTION__, result); 1068 } 1069 1070 return; 1071} 1072 1073static void pl2303_write_bulk_callback(struct urb *urb) 1074{ 1075 struct usb_serial_port *port = (struct usb_serial_port *) urb->context; 1076 struct pl2303_private *priv = usb_get_serial_port_data(port); 1077 int result; 1078 1079 dbg("%s - port %d", __FUNCTION__, port->number); 1080 1081 switch (urb->status) { 1082 case 0: 1083 /* success */ 1084 break; 1085 case -ECONNRESET: 1086 case -ENOENT: 1087 case -ESHUTDOWN: 1088 /* this urb is terminated, clean up */ 1089 dbg("%s - urb shutting down with status: %d", __FUNCTION__, 1090 urb->status); 1091 priv->write_urb_in_use = 0; 1092 return; 1093 default: 1094 /* error in the urb, so we have to resubmit it */ 1095 dbg("%s - Overflow in write", __FUNCTION__); 1096 dbg("%s - nonzero write bulk status received: %d", __FUNCTION__, 1097 urb->status); 1098 port->write_urb->transfer_buffer_length = 1; 1099 port->write_urb->dev = port->serial->dev; 1100 result = usb_submit_urb(port->write_urb, GFP_ATOMIC); 1101 if (result) 1102 dev_err(&urb->dev->dev, "%s - failed resubmitting write" 1103 " urb, error %d\n", __FUNCTION__, result); 1104 else 1105 return; 1106 } 1107 1108 priv->write_urb_in_use = 0; 1109 1110 /* send any buffered data */ 1111 pl2303_send(port); 1112} 1113 1114/* All of the device info needed for the PL2303 SIO serial converter */ 1115static struct usb_serial_driver pl2303_device = { 1116 .driver = { 1117 .owner = THIS_MODULE, 1118 .name = "pl2303", 1119 }, 1120 .id_table = id_table, 1121 .usb_driver = &pl2303_driver, 1122 .num_interrupt_in = NUM_DONT_CARE, 1123 .num_bulk_in = 1, 1124 .num_bulk_out = 1, 1125 .num_ports = 1, 1126 .open = pl2303_open, 1127 .close = pl2303_close, 1128 .write = pl2303_write, 1129 .ioctl = pl2303_ioctl, 1130 .break_ctl = pl2303_break_ctl, 1131 .set_termios = pl2303_set_termios, 1132 .tiocmget = pl2303_tiocmget, 1133 .tiocmset = pl2303_tiocmset, 1134 .read_bulk_callback = pl2303_read_bulk_callback, 1135 .read_int_callback = pl2303_read_int_callback, 1136 .write_bulk_callback = pl2303_write_bulk_callback, 1137 .write_room = pl2303_write_room, 1138 .chars_in_buffer = pl2303_chars_in_buffer, 1139 .attach = pl2303_startup, 1140 .shutdown = pl2303_shutdown, 1141}; 1142 1143static int __init pl2303_init(void) 1144{ 1145 int retval; 1146 1147 retval = usb_serial_register(&pl2303_device); 1148 if (retval) 1149 goto failed_usb_serial_register; 1150 retval = usb_register(&pl2303_driver); 1151 if (retval) 1152 goto failed_usb_register; 1153 info(DRIVER_DESC); 1154 return 0; 1155failed_usb_register: 1156 usb_serial_deregister(&pl2303_device); 1157failed_usb_serial_register: 1158 return retval; 1159} 1160 1161static void __exit pl2303_exit(void) 1162{ 1163 usb_deregister(&pl2303_driver); 1164 usb_serial_deregister(&pl2303_device); 1165} 1166 1167module_init(pl2303_init); 1168module_exit(pl2303_exit); 1169 1170MODULE_DESCRIPTION(DRIVER_DESC); 1171MODULE_LICENSE("GPL"); 1172 1173module_param(debug, bool, S_IRUGO | S_IWUSR); 1174MODULE_PARM_DESC(debug, "Debug enabled or not"); 1175