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