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