drivers/usb/serial/pl2303.c

   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
  38 static 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
  45 struct pl2303_buf {
  46         unsigned int    buf_size;
  47         char            *buf_buf;
  48         char            *buf_get;
  49         char            *buf_put;
  50 };
  51
  52 static 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         { }                                     /* Terminating entry */
  87 };
  88
  89 MODULE_DEVICE_TABLE(usb, id_table);
  90
  91 static struct usb_driver pl2303_driver = {
  92         .name =         "pl2303",
  93         .probe =        usb_serial_probe,
  94         .disconnect =   usb_serial_disconnect,
  95         .id_table =     id_table,
  96         .no_dynamic_id =        1,
  97 };
  98
  99 #define SET_LINE_REQUEST_TYPE           0x21
 100 #define SET_LINE_REQUEST                0x20
 101
 102 #define SET_CONTROL_REQUEST_TYPE        0x21
 103 #define SET_CONTROL_REQUEST             0x22
 104 #define CONTROL_DTR                     0x01
 105 #define CONTROL_RTS                     0x02
 106
 107 #define BREAK_REQUEST_TYPE              0x21
 108 #define BREAK_REQUEST                   0x23
 109 #define BREAK_ON                        0xffff
 110 #define BREAK_OFF                       0x0000
 111
 112 #define GET_LINE_REQUEST_TYPE           0xa1
 113 #define GET_LINE_REQUEST                0x21
 114
 115 #define VENDOR_WRITE_REQUEST_TYPE       0x40
 116 #define VENDOR_WRITE_REQUEST            0x01
 117
 118 #define VENDOR_READ_REQUEST_TYPE        0xc0
 119 #define VENDOR_READ_REQUEST             0x01
 120
 121 #define UART_STATE                      0x08
 122 #define UART_STATE_TRANSIENT_MASK       0x74
 123 #define UART_DCD                        0x01
 124 #define UART_DSR                        0x02
 125 #define UART_BREAK_ERROR                0x04
 126 #define UART_RING                       0x08
 127 #define UART_FRAME_ERROR                0x10
 128 #define UART_PARITY_ERROR               0x20
 129 #define UART_OVERRUN_ERROR              0x40
 130 #define UART_CTS                        0x80
 131
 132
 133 enum pl2303_type {
 134         type_0,         /* don't know the difference between type 0 and */
 135         type_1,         /* type 1, until someone from prolific tells us... */
 136         HX,             /* HX version of the pl2303 chip */
 137 };
 138
 139 struct pl2303_private {
 140         spinlock_t lock;
 141         struct pl2303_buf *buf;
 142         int write_urb_in_use;
 143         wait_queue_head_t delta_msr_wait;
 144         u8 line_control;
 145         u8 line_status;
 146         u8 termios_initialized;
 147         enum pl2303_type type;
 148 };
 149
 150 /*
 151  * pl2303_buf_alloc
 152  *
 153  * Allocate a circular buffer and all associated memory.
 154  */
 155 static struct pl2303_buf *pl2303_buf_alloc(unsigned int size)
 156 {
 157         struct pl2303_buf *pb;
 158
 159         if (size == 0)
 160                 return NULL;
 161
 162         pb = (struct pl2303_buf *)kmalloc(sizeof(struct pl2303_buf), GFP_KERNEL);
 163         if (pb == NULL)
 164                 return NULL;
 165
 166         pb->buf_buf = kmalloc(size, GFP_KERNEL);
 167         if (pb->buf_buf == NULL) {
 168                 kfree(pb);
 169                 return NULL;
 170         }
 171
 172         pb->buf_size = size;
 173         pb->buf_get = pb->buf_put = pb->buf_buf;
 174
 175         return pb;
 176 }
 177
 178 /*
 179  * pl2303_buf_free
 180  *
 181  * Free the buffer and all associated memory.
 182  */
 183 static void pl2303_buf_free(struct pl2303_buf *pb)
 184 {
 185         if (pb) {
 186                 kfree(pb->buf_buf);
 187                 kfree(pb);
 188         }
 189 }
 190
 191 /*
 192  * pl2303_buf_clear
 193  *
 194  * Clear out all data in the circular buffer.
 195  */
 196 static void pl2303_buf_clear(struct pl2303_buf *pb)
 197 {
 198         if (pb != NULL)
 199                 pb->buf_get = pb->buf_put;
 200                 /* equivalent to a get of all data available */
 201 }
 202
 203 /*
 204  * pl2303_buf_data_avail
 205  *
 206  * Return the number of bytes of data available in the circular
 207  * buffer.
 208  */
 209 static unsigned int pl2303_buf_data_avail(struct pl2303_buf *pb)
 210 {
 211         if (pb == NULL)
 212                 return 0;
 213
 214         return ((pb->buf_size + pb->buf_put - pb->buf_get) % pb->buf_size);
 215 }
 216
 217 /*
 218  * pl2303_buf_space_avail
 219  *
 220  * Return the number of bytes of space available in the circular
 221  * buffer.
 222  */
 223 static unsigned int pl2303_buf_space_avail(struct pl2303_buf *pb)
 224 {
 225         if (pb == NULL)
 226                 return 0;
 227
 228         return ((pb->buf_size + pb->buf_get - pb->buf_put - 1) % pb->buf_size);
 229 }
 230
 231 /*
 232  * pl2303_buf_put
 233  *
 234  * Copy data data from a user buffer and put it into the circular buffer.
 235  * Restrict to the amount of space available.
 236  *
 237  * Return the number of bytes copied.
 238  */
 239 static unsigned int pl2303_buf_put(struct pl2303_buf *pb, const char *buf,
 240                                    unsigned int count)
 241 {
 242         unsigned int len;
 243
 244         if (pb == NULL)
 245                 return 0;
 246
 247         len  = pl2303_buf_space_avail(pb);
 248         if (count > len)
 249                 count = len;
 250
 251         if (count == 0)
 252                 return 0;
 253
 254         len = pb->buf_buf + pb->buf_size - pb->buf_put;
 255         if (count > len) {
 256                 memcpy(pb->buf_put, buf, len);
 257                 memcpy(pb->buf_buf, buf+len, count - len);
 258                 pb->buf_put = pb->buf_buf + count - len;
 259         } else {
 260                 memcpy(pb->buf_put, buf, count);
 261                 if (count < len)
 262                         pb->buf_put += count;
 263                 else /* count == len */
 264                         pb->buf_put = pb->buf_buf;
 265         }
 266
 267         return count;
 268 }
 269
 270 /*
 271  * pl2303_buf_get
 272  *
 273  * Get data from the circular buffer and copy to the given buffer.
 274  * Restrict to the amount of data available.
 275  *
 276  * Return the number of bytes copied.
 277  */
 278 static unsigned int pl2303_buf_get(struct pl2303_buf *pb, char *buf,
 279                                    unsigned int count)
 280 {
 281         unsigned int len;
 282
 283         if (pb == NULL)
 284                 return 0;
 285
 286         len = pl2303_buf_data_avail(pb);
 287         if (count > len)
 288                 count = len;
 289
 290         if (count == 0)
 291                 return 0;
 292
 293         len = pb->buf_buf + pb->buf_size - pb->buf_get;
 294         if (count > len) {
 295                 memcpy(buf, pb->buf_get, len);
 296                 memcpy(buf+len, pb->buf_buf, count - len);
 297                 pb->buf_get = pb->buf_buf + count - len;
 298         } else {
 299                 memcpy(buf, pb->buf_get, count);
 300                 if (count < len)
 301                         pb->buf_get += count;
 302                 else /* count == len */
 303                         pb->buf_get = pb->buf_buf;
 304         }
 305
 306         return count;
 307 }
 308
 309 static int pl2303_startup(struct usb_serial *serial)
 310 {
 311         struct pl2303_private *priv;
 312         enum pl2303_type type = type_0;
 313         int i;
 314
 315         if (serial->dev->descriptor.bDeviceClass == 0x02)
 316                 type = type_0;
 317         else if (serial->dev->descriptor.bMaxPacketSize0 == 0x40)
 318                 type = HX;
 319         else if (serial->dev->descriptor.bDeviceClass == 0x00)
 320                 type = type_1;
 321         else if (serial->dev->descriptor.bDeviceClass == 0xFF)
 322                 type = type_1;
 323         dbg("device type: %d", type);
 324
 325         for (i = 0; i < serial->num_ports; ++i) {
 326                 priv = kzalloc(sizeof(struct pl2303_private), GFP_KERNEL);
 327                 if (!priv)
 328                         goto cleanup;
 329                 spin_lock_init(&priv->lock);
 330                 priv->buf = pl2303_buf_alloc(PL2303_BUF_SIZE);
 331                 if (priv->buf == NULL) {
 332                         kfree(priv);
 333                         goto cleanup;
 334                 }
 335                 init_waitqueue_head(&priv->delta_msr_wait);
 336                 priv->type = type;
 337                 usb_set_serial_port_data(serial->port[i], priv);
 338         }
 339         return 0;
 340
 341 cleanup:
 342         for (--i; i>=0; --i) {
 343                 priv = usb_get_serial_port_data(serial->port[i]);
 344                 pl2303_buf_free(priv->buf);
 345                 kfree(priv);
 346                 usb_set_serial_port_data(serial->port[i], NULL);
 347         }
 348         return -ENOMEM;
 349 }
 350
 351 static int set_control_lines(struct usb_device *dev, u8 value)
 352 {
 353         int retval;
 354
 355         retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 356                                  SET_CONTROL_REQUEST, SET_CONTROL_REQUEST_TYPE,
 357                                  value, 0, NULL, 0, 100);
 358         dbg("%s - value = %d, retval = %d", __FUNCTION__, value, retval);
 359         return retval;
 360 }
 361
 362 static void pl2303_send(struct usb_serial_port *port)
 363 {
 364         int count, result;
 365         struct pl2303_private *priv = usb_get_serial_port_data(port);
 366         unsigned long flags;
 367
 368         dbg("%s - port %d", __FUNCTION__, port->number);
 369
 370         spin_lock_irqsave(&priv->lock, flags);
 371
 372         if (priv->write_urb_in_use) {
 373                 spin_unlock_irqrestore(&priv->lock, flags);
 374                 return;
 375         }
 376
 377         count = pl2303_buf_get(priv->buf, port->write_urb->transfer_buffer,
 378                                port->bulk_out_size);
 379
 380         if (count == 0) {
 381                 spin_unlock_irqrestore(&priv->lock, flags);
 382                 return;
 383         }
 384
 385         priv->write_urb_in_use = 1;
 386
 387         spin_unlock_irqrestore(&priv->lock, flags);
 388
 389         usb_serial_debug_data(debug, &port->dev, __FUNCTION__, count,
 390                               port->write_urb->transfer_buffer);
 391
 392         port->write_urb->transfer_buffer_length = count;
 393         port->write_urb->dev = port->serial->dev;
 394         result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
 395         if (result) {
 396                 dev_err(&port->dev, "%s - failed submitting write urb,"
 397                         " error %d\n", __FUNCTION__, result);
 398                 priv->write_urb_in_use = 0;
 399                 // TODO: reschedule pl2303_send
 400         }
 401
 402         usb_serial_port_softint(port);
 403 }
 404
 405 static int pl2303_write(struct usb_serial_port *port, const unsigned char *buf,
 406                         int count)
 407 {
 408         struct pl2303_private *priv = usb_get_serial_port_data(port);
 409         unsigned long flags;
 410
 411         dbg("%s - port %d, %d bytes", __FUNCTION__, port->number, count);
 412
 413         if (!count)
 414                 return count;
 415
 416         spin_lock_irqsave(&priv->lock, flags);
 417         count = pl2303_buf_put(priv->buf, buf, count);
 418         spin_unlock_irqrestore(&priv->lock, flags);
 419
 420         pl2303_send(port);
 421
 422         return count;
 423 }
 424
 425 static int pl2303_write_room(struct usb_serial_port *port)
 426 {
 427         struct pl2303_private *priv = usb_get_serial_port_data(port);
 428         int room = 0;
 429         unsigned long flags;
 430
 431         dbg("%s - port %d", __FUNCTION__, port->number);
 432
 433         spin_lock_irqsave(&priv->lock, flags);
 434         room = pl2303_buf_space_avail(priv->buf);
 435         spin_unlock_irqrestore(&priv->lock, flags);
 436
 437         dbg("%s - returns %d", __FUNCTION__, room);
 438         return room;
 439 }
 440
 441 static int pl2303_chars_in_buffer(struct usb_serial_port *port)
 442 {
 443         struct pl2303_private *priv = usb_get_serial_port_data(port);
 444         int chars = 0;
 445         unsigned long flags;
 446
 447         dbg("%s - port %d", __FUNCTION__, port->number);
 448
 449         spin_lock_irqsave(&priv->lock, flags);
 450         chars = pl2303_buf_data_avail(priv->buf);
 451         spin_unlock_irqrestore(&priv->lock, flags);
 452
 453         dbg("%s - returns %d", __FUNCTION__, chars);
 454         return chars;
 455 }
 456
 457 static void pl2303_set_termios(struct usb_serial_port *port,
 458                                struct termios *old_termios)
 459 {
 460         struct usb_serial *serial = port->serial;
 461         struct pl2303_private *priv = usb_get_serial_port_data(port);
 462         unsigned long flags;
 463         unsigned int cflag;
 464         unsigned char *buf;
 465         int baud;
 466         int i;
 467         u8 control;
 468
 469         dbg("%s -  port %d", __FUNCTION__, port->number);
 470
 471         if ((!port->tty) || (!port->tty->termios)) {
 472                 dbg("%s - no tty structures", __FUNCTION__);
 473                 return;
 474         }
 475
 476         spin_lock_irqsave(&priv->lock, flags);
 477         if (!priv->termios_initialized) {
 478                 *(port->tty->termios) = tty_std_termios;
 479                 port->tty->termios->c_cflag = B9600 | CS8 | CREAD |
 480                                               HUPCL | CLOCAL;
 481                 priv->termios_initialized = 1;
 482         }
 483         spin_unlock_irqrestore(&priv->lock, flags);
 484
 485         cflag = port->tty->termios->c_cflag;
 486         /* check that they really want us to change something */
 487         if (old_termios) {
 488                 if ((cflag == old_termios->c_cflag) &&
 489                     (RELEVANT_IFLAG(port->tty->termios->c_iflag) ==
 490                      RELEVANT_IFLAG(old_termios->c_iflag))) {
 491                         dbg("%s - nothing to change...", __FUNCTION__);
 492                         return;
 493                 }
 494         }
 495
 496         buf = kzalloc(7, GFP_KERNEL);
 497         if (!buf) {
 498                 dev_err(&port->dev, "%s - out of memory.\n", __FUNCTION__);
 499                 return;
 500         }
 501
 502         i = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
 503                             GET_LINE_REQUEST, GET_LINE_REQUEST_TYPE,
 504                             0, 0, buf, 7, 100);
 505         dbg("0xa1:0x21:0:0  %d - %x %x %x %x %x %x %x", i,
 506             buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6]);
 507
 508         if (cflag & CSIZE) {
 509                 switch (cflag & CSIZE) {
 510                         case CS5:       buf[6] = 5;     break;
 511                         case CS6:       buf[6] = 6;     break;
 512                         case CS7:       buf[6] = 7;     break;
 513                         default:
 514                         case CS8:       buf[6] = 8;     break;
 515                 }
 516                 dbg("%s - data bits = %d", __FUNCTION__, buf[6]);
 517         }
 518
 519         baud = 0;
 520         switch (cflag & CBAUD) {
 521                 case B0:        baud = 0;       break;
 522                 case B75:       baud = 75;      break;
 523                 case B150:      baud = 150;     break;
 524                 case B300:      baud = 300;     break;
 525                 case B600:      baud = 600;     break;
 526                 case B1200:     baud = 1200;    break;
 527                 case B1800:     baud = 1800;    break;
 528                 case B2400:     baud = 2400;    break;
 529                 case B4800:     baud = 4800;    break;
 530                 case B9600:     baud = 9600;    break;
 531                 case B19200:    baud = 19200;   break;
 532                 case B38400:    baud = 38400;   break;
 533                 case B57600:    baud = 57600;   break;
 534                 case B115200:   baud = 115200;  break;
 535                 case B230400:   baud = 230400;  break;
 536                 case B460800:   baud = 460800;  break;
 537                 default:
 538                         dev_err(&port->dev, "pl2303 driver does not support"
 539                                 " the baudrate requested (fix it)\n");
 540                         break;
 541         }
 542         dbg("%s - baud = %d", __FUNCTION__, baud);
 543         if (baud) {
 544                 buf[0] = baud & 0xff;
 545                 buf[1] = (baud >> 8) & 0xff;
 546                 buf[2] = (baud >> 16) & 0xff;
 547                 buf[3] = (baud >> 24) & 0xff;
 548         }
 549
 550         /* For reference buf[4]=0 is 1 stop bits */
 551         /* For reference buf[4]=1 is 1.5 stop bits */
 552         /* For reference buf[4]=2 is 2 stop bits */
 553         if (cflag & CSTOPB) {
 554                 buf[4] = 2;
 555                 dbg("%s - stop bits = 2", __FUNCTION__);
 556         } else {
 557                 buf[4] = 0;
 558                 dbg("%s - stop bits = 1", __FUNCTION__);
 559         }
 560
 561         if (cflag & PARENB) {
 562                 /* For reference buf[5]=0 is none parity */
 563                 /* For reference buf[5]=1 is odd parity */
 564                 /* For reference buf[5]=2 is even parity */
 565                 /* For reference buf[5]=3 is mark parity */
 566                 /* For reference buf[5]=4 is space parity */
 567                 if (cflag & PARODD) {
 568                         buf[5] = 1;
 569                         dbg("%s - parity = odd", __FUNCTION__);
 570                 } else {
 571                         buf[5] = 2;
 572                         dbg("%s - parity = even", __FUNCTION__);
 573                 }
 574         } else {
 575                 buf[5] = 0;
 576                 dbg("%s - parity = none", __FUNCTION__);
 577         }
 578
 579         i = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
 580                             SET_LINE_REQUEST, SET_LINE_REQUEST_TYPE,
 581                             0, 0, buf, 7, 100);
 582         dbg("0x21:0x20:0:0  %d", i);
 583
 584         /* change control lines if we are switching to or from B0 */
 585         spin_lock_irqsave(&priv->lock, flags);
 586         control = priv->line_control;
 587         if ((cflag & CBAUD) == B0)
 588                 priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
 589         else
 590                 priv->line_control |= (CONTROL_DTR | CONTROL_RTS);
 591         if (control != priv->line_control) {
 592                 control = priv->line_control;
 593                 spin_unlock_irqrestore(&priv->lock, flags);
 594                 set_control_lines(serial->dev, control);
 595         } else {
 596                 spin_unlock_irqrestore(&priv->lock, flags);
 597         }
 598
 599         buf[0] = buf[1] = buf[2] = buf[3] = buf[4] = buf[5] = buf[6] = 0;
 600
 601         i = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
 602                             GET_LINE_REQUEST, GET_LINE_REQUEST_TYPE,
 603                             0, 0, buf, 7, 100);
 604         dbg("0xa1:0x21:0:0  %d - %x %x %x %x %x %x %x", i,
 605              buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6]);
 606
 607         if (cflag & CRTSCTS) {
 608                 __u16 index;
 609                 if (priv->type == HX)
 610                         index = 0x61;
 611                 else
 612                         index = 0x41;
 613                 i = usb_control_msg(serial->dev,
 614                                     usb_sndctrlpipe(serial->dev, 0),
 615                                     VENDOR_WRITE_REQUEST,
 616                                     VENDOR_WRITE_REQUEST_TYPE,
 617                                     0x0, index, NULL, 0, 100);
 618                 dbg("0x40:0x1:0x0:0x%x  %d", index, i);
 619         }
 620
 621         kfree(buf);
 622 }
 623
 624 static void pl2303_close(struct usb_serial_port *port, struct file *filp)
 625 {
 626         struct pl2303_private *priv = usb_get_serial_port_data(port);
 627         unsigned long flags;
 628         unsigned int c_cflag;
 629         int bps;
 630         long timeout;
 631         wait_queue_t wait;
 632
 633         dbg("%s - port %d", __FUNCTION__, port->number);
 634
 635         /* wait for data to drain from the buffer */
 636         spin_lock_irqsave(&priv->lock, flags);
 637         timeout = PL2303_CLOSING_WAIT;
 638         init_waitqueue_entry(&wait, current);
 639         add_wait_queue(&port->tty->write_wait, &wait);
 640         for (;;) {
 641                 set_current_state(TASK_INTERRUPTIBLE);
 642                 if (pl2303_buf_data_avail(priv->buf) == 0 ||
 643                     timeout == 0 || signal_pending(current) ||
 644                     !usb_get_intfdata(port->serial->interface)) /* disconnect */
 645                         break;
 646                 spin_unlock_irqrestore(&priv->lock, flags);
 647                 timeout = schedule_timeout(timeout);
 648                 spin_lock_irqsave(&priv->lock, flags);
 649         }
 650         set_current_state(TASK_RUNNING);
 651         remove_wait_queue(&port->tty->write_wait, &wait);
 652         /* clear out any remaining data in the buffer */
 653         pl2303_buf_clear(priv->buf);
 654         spin_unlock_irqrestore(&priv->lock, flags);
 655
 656         /* wait for characters to drain from the device */
 657         /* (this is long enough for the entire 256 byte */
 658         /* pl2303 hardware buffer to drain with no flow */
 659         /* control for data rates of 1200 bps or more, */
 660         /* for lower rates we should really know how much */
 661         /* data is in the buffer to compute a delay */
 662         /* that is not unnecessarily long) */
 663         bps = tty_get_baud_rate(port->tty);
 664         if (bps > 1200)
 665                 timeout = max((HZ*2560)/bps,HZ/10);
 666         else
 667                 timeout = 2*HZ;
 668         schedule_timeout_interruptible(timeout);
 669
 670         /* shutdown our urbs */
 671         dbg("%s - shutting down urbs", __FUNCTION__);
 672         usb_kill_urb(port->write_urb);
 673         usb_kill_urb(port->read_urb);
 674         usb_kill_urb(port->interrupt_in_urb);
 675
 676         if (port->tty) {
 677                 c_cflag = port->tty->termios->c_cflag;
 678                 if (c_cflag & HUPCL) {
 679                         /* drop DTR and RTS */
 680                         spin_lock_irqsave(&priv->lock, flags);
 681                         priv->line_control = 0;
 682                         spin_unlock_irqrestore(&priv->lock, flags);
 683                         set_control_lines(port->serial->dev, 0);
 684                 }
 685         }
 686 }
 687
 688 static int pl2303_open(struct usb_serial_port *port, struct file *filp)
 689 {
 690         struct termios tmp_termios;
 691         struct usb_serial *serial = port->serial;
 692         struct pl2303_private *priv = usb_get_serial_port_data(port);
 693         unsigned char *buf;
 694         int result;
 695
 696         dbg("%s -  port %d", __FUNCTION__, port->number);
 697
 698         if (priv->type != HX) {
 699                 usb_clear_halt(serial->dev, port->write_urb->pipe);
 700                 usb_clear_halt(serial->dev, port->read_urb->pipe);
 701         }
 702
 703         buf = kmalloc(10, GFP_KERNEL);
 704         if (buf==NULL)
 705                 return -ENOMEM;
 706
 707 #define FISH(a,b,c,d)                                                           \
 708         result=usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev,0),     \
 709                                b, a, c, d, buf, 1, 100);                        \
 710         dbg("0x%x:0x%x:0x%x:0x%x  %d - %x",a,b,c,d,result,buf[0]);
 711
 712 #define SOUP(a,b,c,d)                                                           \
 713         result=usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev,0),     \
 714                                b, a, c, d, NULL, 0, 100);                       \
 715         dbg("0x%x:0x%x:0x%x:0x%x  %d",a,b,c,d,result);
 716
 717         FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8484, 0);
 718         SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 0x0404, 0);
 719         FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8484, 0);
 720         FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8383, 0);
 721         FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8484, 0);
 722         SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 0x0404, 1);
 723         FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8484, 0);
 724         FISH (VENDOR_READ_REQUEST_TYPE, VENDOR_READ_REQUEST, 0x8383, 0);
 725         SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 0, 1);
 726         SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 1, 0);
 727
 728         if (priv->type == HX) {
 729                 /* HX chip */
 730                 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 2, 0x44);
 731                 /* reset upstream data pipes */
 732                 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 8, 0);
 733                 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 9, 0);
 734         } else {
 735                 SOUP (VENDOR_WRITE_REQUEST_TYPE, VENDOR_WRITE_REQUEST, 2, 0x24);
 736         }
 737
 738         kfree(buf);
 739
 740         /* Setup termios */
 741         if (port->tty) {
 742                 pl2303_set_termios(port, &tmp_termios);
 743         }
 744
 745         //FIXME: need to assert RTS and DTR if CRTSCTS off
 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
 769 static 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
 794 static 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
 824 static 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
 860 static 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
 878 static 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
 899 static 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
 916 static 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
 951 static 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
 982 exit:
 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
 990 static 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
1073 static 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 */
1115 static struct usb_serial_driver pl2303_device = {
1116         .driver = {
1117                 .owner =        THIS_MODULE,
1118                 .name =         "pl2303",
1119         },
1120         .id_table =             id_table,
1121         .num_interrupt_in =     NUM_DONT_CARE,
1122         .num_bulk_in =          1,
1123         .num_bulk_out =         1,
1124         .num_ports =            1,
1125         .open =                 pl2303_open,
1126         .close =                pl2303_close,
1127         .write =                pl2303_write,
1128         .ioctl =                pl2303_ioctl,
1129         .break_ctl =            pl2303_break_ctl,
1130         .set_termios =          pl2303_set_termios,
1131         .tiocmget =             pl2303_tiocmget,
1132         .tiocmset =             pl2303_tiocmset,
1133         .read_bulk_callback =   pl2303_read_bulk_callback,
1134         .read_int_callback =    pl2303_read_int_callback,
1135         .write_bulk_callback =  pl2303_write_bulk_callback,
1136         .write_room =           pl2303_write_room,
1137         .chars_in_buffer =      pl2303_chars_in_buffer,
1138         .attach =               pl2303_startup,
1139         .shutdown =             pl2303_shutdown,
1140 };
1141
1142 static int __init pl2303_init(void)
1143 {
1144         int retval;
1145
1146         retval = usb_serial_register(&pl2303_device);
1147         if (retval)
1148                 goto failed_usb_serial_register;
1149         retval = usb_register(&pl2303_driver);
1150         if (retval)
1151                 goto failed_usb_register;
1152         info(DRIVER_DESC);
1153         return 0;
1154 failed_usb_register:
1155         usb_serial_deregister(&pl2303_device);
1156 failed_usb_serial_register:
1157         return retval;
1158 }
1159
1160 static void __exit pl2303_exit(void)
1161 {
1162         usb_deregister(&pl2303_driver);
1163         usb_serial_deregister(&pl2303_device);
1164 }
1165
1166 module_init(pl2303_init);
1167 module_exit(pl2303_exit);
1168
1169 MODULE_DESCRIPTION(DRIVER_DESC);
1170 MODULE_LICENSE("GPL");
1171
1172 module_param(debug, bool, S_IRUGO | S_IWUSR);
1173 MODULE_PARM_DESC(debug, "Debug enabled or not");
1174